hamon-in / cpslib Goto Github PK

How are we going to handle cross-platform builds?
I don't think that make is really suited for this task.
So we have to basically chose between CMake and Autotools. I already know CMake and libgit2 is using it as well(they're doing a good job at supporting a lot of platforms and bindings)

Things like DiskPartitionInfo exist just to hold the count of partitions. cpslib is a low level library so it should be fine to have two functions get_partition_count and then get_partition_info to get the list of paritions and the information. This will allow us to drop one struct.

The structs are named inconsistently. Fix it.

This looks like good advice https://spin.atomicobject.com/2016/08/26/makefile-c-projects/

Ref: nibrahim@bdeafd8

1. Need to get rid of Linux specific fields in APIs.
2. Writer platform aware tests, so that they don't need to be changed for each platform.

The following APIs currently have get_ prefixed in their names. This is both inconsistent with psutil and with rest of the APIs. Consider renaming.

Process *get_process(unsigned int);
unsigned long int get_boot_time();
UsersInfo *get_users();

The CPU times available change based on the Kernel version. Psutils does this properly. We use a static structure and need some way of changing this when the library is compiled.

We can't prefetch all the properties for the user. We shouldn't be inconsistent if a property is prefetched or up-to-date. Hence we have to return always an up-to-date value.
The Process should be an opaque data type and we should provide the following methods to fetch the relevant property.

• process_pid
• process_ppid
• process_name
• process_exe
• process_cmdline
• process_create_time
• process_parent
• process_cwd
• process_username
• process_uids
• process_gids
• process_terminal
• process_nice
• process_ionice
• process_rlimit
• process_io_counters
• process_num_ctx_switches
• process_num_fds
• process_num_handles
• process_num_threads
• process_threads
• process_cpu_times
• process_cpu_percent
• process_cpu_affinity
• process_memory_info
• process_memory_info_ex
• process_memory_percent
• process_memory_maps
• process_children
• process_open_files
• process_connections
• process_is_running
• process_send_signal
• process_suspend
• process_resume
• process_terminate
• process_kill
• process_wait

Notes:

• Cut a "mac" branch for the actual work.
• Also need to clean up the headers and build scripts so that it works properly on both platforms.

I will try and fix this.

I noticed a few places where int types are used when standard system typedefs are available which would be more appropriate.

Examples.

1. fields pid, ppid in struct Process. Should be pid_t instead of "unsigned int".
2. field uid etc - Should be uid_t.
3. field create_time - Should be time_t (I think).

Most of these are available in <sys/types.h> and we should use them wherever possible.

Generated Makefile doesn't have these CFLAGS anymore.

It might be a good idea to set up a test infrastructure such that we could verify compatibility of each API's result with corresponding psutil API's.

Unit testing will also, of course, help prevent future breaking changes.

If I add -pedantic/-Wpedantic to the Makefile, I receive the following errors:

$ make
cc -fPIC -Wall -Werror -Wunused -Wextra -Wpedantic -O0 -g -std=c11 -fprofile-arcs -ftest-coverage   -c -o common.o common.c
In file included from common.c:5:
./common.h:36:14: error: token pasting of ',' and __VA_ARGS__ is a GNU extension [-Werror,-Wgnu-zero-variadic-macro-arguments]
    log_err(M, ##__VA_ARGS__);                                                 \
             ^
./common.h:25:55: error: token pasting of ',' and __VA_ARGS__ is a GNU extension [-Werror,-Wgnu-zero-variadic-macro-arguments]
          __LINE__, __FUNCTION__, errno, clean_errno(), ##__VA_ARGS__)
                                                      ^
./common.h:36:14: error: token pasting of ',' and __VA_ARGS__ is a GNU extension [-Werror,-Wgnu-zero-variadic-macro-arguments]
    log_err(M, ##__VA_ARGS__);                                                 \
             ^
./common.h:25:55: error: token pasting of ',' and __VA_ARGS__ is a GNU extension [-Werror,-Wgnu-zero-variadic-macro-arguments]
          __LINE__, __FUNCTION__, errno, clean_errno(), ##__VA_ARGS__)
                                                      ^
4 errors generated.
make: *** [common.o] Error 1

No clean solution exists. See: https://stackoverflow.com/questions/5588855/standard-alternative-to-gccs-va-args-trick

OSX port already uses clang-format style, most of the rest of the code doesn't. See section on Formatting at How to C in 2016

We could perhaps use the following style (allowing short fns on single line and keeping indent width as 2):

clang-format -style="{BasedOnStyle: llvm, IndentWidth: 2, KeepEmptyLinesAtTheStartOfBlocks: false}"

Open for discussion.

Different Linux Kernels provide different CPU times and this should be taken into account when returning the CPU times and other CPU related information (percentages etc.).

Tracking at https://trello.com/c/yxWEg8kd/2-finish-mac-os-x-port

It would be nice to be able to build a .so with a single make shared or something similar.

Currently, pslib_linux.c is being used for OS X as well.

Currently we need to execute something like the following to obtain coverage information:

$ gcov pslib_osx.c
File 'pslib_osx.c'
Lines executed:73.56% of 696
pslib_osx.c:creating 'pslib_osx.c.gcov'

It will be good to have this automatically printed at the end of make test.

See Types section in How to C in 2016

See also: #13