1 #ifndef __MONO_COUNTERS_H__
2 #define __MONO_COUNTERS_H__
5 #include <mono/utils/mono-publib.h>
8 /* Counter type, bits 0-7. */
9 MONO_COUNTER_INT, /* 32 bit int */
10 MONO_COUNTER_UINT, /* 32 bit uint */
11 MONO_COUNTER_WORD, /* pointer-sized int */
12 MONO_COUNTER_LONG, /* 64 bit int */
13 MONO_COUNTER_ULONG, /* 64 bit uint */
15 MONO_COUNTER_STRING, /* char* */
16 MONO_COUNTER_TIME_INTERVAL, /* 64 bits signed int holding usecs. */
17 MONO_COUNTER_TYPE_MASK = 0xf,
18 MONO_COUNTER_CALLBACK = 128, /* ORed with the other values */
19 MONO_COUNTER_SECTION_MASK = 0x00ffff00,
20 /* Sections, bits 8-23 (16 bits) */
21 MONO_COUNTER_JIT = 1 << 8,
22 MONO_COUNTER_GC = 1 << 9,
23 MONO_COUNTER_METADATA = 1 << 10,
24 MONO_COUNTER_GENERICS = 1 << 11,
25 MONO_COUNTER_SECURITY = 1 << 12,
26 MONO_COUNTER_RUNTIME = 1 << 13,
27 MONO_COUNTER_SYSTEM = 1 << 14,
28 MONO_COUNTER_LAST_SECTION,
30 /* Unit, bits 24-27 (4 bits) */
31 MONO_COUNTER_UNIT_SHIFT = 24,
32 MONO_COUNTER_UNIT_MASK = 0xFu << MONO_COUNTER_UNIT_SHIFT,
33 MONO_COUNTER_RAW = 0 << 24, /* Raw value */
34 MONO_COUNTER_BYTES = 1 << 24, /* Quantity of bytes. RSS, active heap, etc */
35 MONO_COUNTER_TIME = 2 << 24, /* Time interval in 100ns units. Minor pause, JIT compilation*/
36 MONO_COUNTER_COUNT = 3 << 24, /* Number of things (threads, queued jobs) or Number of events triggered (Major collections, Compiled methods).*/
37 MONO_COUNTER_PERCENTAGE = 4 << 24, /* [0-1] Fraction Percentage of something. Load average. */
39 /* Monotonicity, bits 28-31 (4 bits) */
40 MONO_COUNTER_VARIANCE_SHIFT = 28,
41 MONO_COUNTER_VARIANCE_MASK = 0xFu << MONO_COUNTER_VARIANCE_SHIFT,
42 MONO_COUNTER_MONOTONIC = 1 << 28, /* This counter value always increase/decreases over time. Reported by --stat. */
43 MONO_COUNTER_CONSTANT = 1 << 29, /* Fixed value. Used by configuration data. */
44 MONO_COUNTER_VARIABLE = 1 << 30, /* This counter value can be anything on each sampling. Only interesting when sampling. */
47 typedef struct _MonoCounter MonoCounter;
50 MONO_API void mono_counters_enable (int section_mask);
53 * register addr as the address of a counter of type type.
54 * It may be a function pointer if MONO_COUNTER_CALLBACK is specified:
55 * the function should return the value and take no arguments.
57 MONO_API void mono_counters_register (const char* descr, int type, void *addr);
58 MONO_API void mono_counters_register_with_size (const char *name, int type, void *addr, int size);
61 * Create a readable dump of the counters for section_mask sections (ORed section values)
63 MONO_API void mono_counters_dump (int section_mask, FILE *outfile);
65 MONO_API void mono_counters_cleanup (void);
67 typedef mono_bool (*CountersEnumCallback) (MonoCounter *counter, void *user_data);
69 MONO_API void mono_counters_foreach (CountersEnumCallback cb, void *user_data);
71 MONO_API int mono_counters_sample (MonoCounter *counter, void *buffer, int buffer_size);
73 MONO_API const char* mono_counter_get_name (MonoCounter *name);
74 MONO_API int mono_counter_get_type (MonoCounter *counter);
75 MONO_API int mono_counter_get_section (MonoCounter *counter);
76 MONO_API int mono_counter_get_unit (MonoCounter *counter);
77 MONO_API int mono_counter_get_variance (MonoCounter *counter);
78 MONO_API size_t mono_counter_get_size (MonoCounter *counter);
81 MONO_RESOURCE_JIT_CODE, /* bytes */
82 MONO_RESOURCE_METADATA, /* bytes */
83 MONO_RESOURCE_GC_HEAP, /* bytes */
84 MONO_RESOURCE_COUNT /* non-ABI value */
87 typedef void (*MonoResourceCallback) (int resource_type, uintptr_t value, int is_soft);
89 MONO_API int mono_runtime_resource_limit (int resource_type, uintptr_t soft_limit, uintptr_t hard_limit);
90 MONO_API void mono_runtime_resource_set_callback (MonoResourceCallback callback);
91 MONO_API void mono_runtime_resource_check_limit (int resource_type, uintptr_t value);
93 #endif /* __MONO_COUNTERS_H__ */