[runtime] Updates comments.
[mono.git] / mono / utils / mono-proclib.h
1 #ifndef __MONO_PROC_LIB_H__
2 #define __MONO_PROC_LIB_H__
3 /*
4  * Utility functions to access processes information and other info about the system.
5  */
6
7 #include <glib.h>
8 #include <mono/utils/mono-compiler.h>
9
10 /* never remove or reorder these enums values: they are used in corlib/System */
11
12 typedef enum {
13         MONO_PROCESS_NUM_THREADS,
14         MONO_PROCESS_USER_TIME, /* milliseconds */
15         MONO_PROCESS_SYSTEM_TIME, /* milliseconds */
16         MONO_PROCESS_TOTAL_TIME, /* milliseconds */
17         MONO_PROCESS_WORKING_SET,
18         MONO_PROCESS_WORKING_SET_PEAK, /* 5 */
19         MONO_PROCESS_PRIVATE_BYTES,
20         MONO_PROCESS_VIRTUAL_BYTES,
21         MONO_PROCESS_VIRTUAL_BYTES_PEAK,
22         MONO_PROCESS_FAULTS,
23         MONO_PROCESS_ELAPSED, /* 10 */
24         MONO_PROCESS_PPID,
25         MONO_PROCESS_PAGED_BYTES,
26         MONO_PROCESS_END
27 } MonoProcessData;
28
29 typedef enum {
30         MONO_CPU_USER_TIME,
31         MONO_CPU_PRIV_TIME,
32         MONO_CPU_INTR_TIME,
33         MONO_CPU_DCP_TIME,
34         MONO_CPU_IDLE_TIME,
35         MONO_CPU_END
36 } MonoCpuData;
37
38 typedef enum {
39         MONO_PROCESS_ERROR_NONE, /* no error happened */
40         MONO_PROCESS_ERROR_NOT_FOUND, /* process not found */
41         MONO_PROCESS_ERROR_OTHER
42 } MonoProcessError;
43
44 gpointer* mono_process_list     (int *size);
45
46 void      mono_process_get_times (gpointer pid, gint64 *start_time, gint64 *user_time, gint64 *kernel_time);
47
48 char*     mono_process_get_name (gpointer pid, char *buf, int len);
49
50 gint64    mono_process_get_data (gpointer pid, MonoProcessData data);
51 gint64    mono_process_get_data_with_error (gpointer pid, MonoProcessData data, MonoProcessError *error);
52
53 int       mono_process_current_pid (void);
54
55 int       mono_cpu_count    (void);
56 gint64    mono_cpu_get_data (int cpu_id, MonoCpuData data, MonoProcessError *error);
57
58 int       mono_atexit (void (*func)(void));
59
60 #endif /* __MONO_PROC_LIB_H__ */
61