Commit | Line | Data |
---|---|---|
9f3fdbc6 MD |
1 | #ifndef _LTTNG_UST_ABI_H |
2 | #define _LTTNG_UST_ABI_H | |
3 | ||
4 | /* | |
4318ae1b | 5 | * lttng/ust-abi.h |
9f3fdbc6 MD |
6 | * |
7 | * Copyright 2010-2011 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
8 | * | |
9 | * LTTng-UST ABI header | |
10 | * | |
a60d70e6 MD |
11 | * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED |
12 | * OR IMPLIED. ANY USE IS AT YOUR OWN RISK. | |
13 | * | |
14 | * Permission is hereby granted to use or copy this program | |
15 | * for any purpose, provided the above notices are retained on all copies. | |
16 | * Permission to modify the code and to distribute modified code is granted, | |
17 | * provided the above notices are retained, and a notice that the code was | |
18 | * modified is included with the above copyright notice. | |
9f3fdbc6 MD |
19 | */ |
20 | ||
0a42beb6 MD |
21 | #include <stdint.h> |
22 | ||
f56cd1d5 | 23 | #define LTTNG_UST_SYM_NAME_LEN 256 |
9f3fdbc6 | 24 | |
b35d179d MD |
25 | #define LTTNG_UST_COMM_VERSION_MAJOR 0 |
26 | #define LTTNG_UST_COMM_VERSION_MINOR 1 | |
27 | ||
9f3fdbc6 | 28 | enum lttng_ust_instrumentation { |
df854e41 MD |
29 | LTTNG_UST_TRACEPOINT = 0, |
30 | LTTNG_UST_PROBE = 1, | |
31 | LTTNG_UST_FUNCTION = 2, | |
32 | LTTNG_UST_TRACEPOINT_LOGLEVEL = 3, | |
9f3fdbc6 MD |
33 | }; |
34 | ||
9f3fdbc6 | 35 | enum lttng_ust_output { |
b35d179d | 36 | LTTNG_UST_MMAP = 0, |
9f3fdbc6 MD |
37 | }; |
38 | ||
b35d179d | 39 | struct lttng_ust_tracer_version { |
b728d87e MD |
40 | uint32_t major; |
41 | uint32_t minor; | |
b35d179d | 42 | uint32_t patchlevel; |
b35d179d | 43 | }; |
9f3fdbc6 MD |
44 | |
45 | struct lttng_ust_channel { | |
46 | int overwrite; /* 1: overwrite, 0: discard */ | |
47 | uint64_t subbuf_size; /* in bytes */ | |
48 | uint64_t num_subbuf; | |
49 | unsigned int switch_timer_interval; /* usecs */ | |
50 | unsigned int read_timer_interval; /* usecs */ | |
b35d179d | 51 | enum lttng_ust_output output; /* output mode */ |
193183fb MD |
52 | /* The following fields are used internally within UST. */ |
53 | int shm_fd; | |
54 | int wait_fd; | |
55 | uint64_t memory_map_size; | |
9f3fdbc6 MD |
56 | }; |
57 | ||
381c0f1e MD |
58 | /* |
59 | * This structure is only used internally within UST. It is not per-se | |
60 | * part of the communication between sessiond and UST. | |
61 | */ | |
62 | struct lttng_ust_stream { | |
63 | int shm_fd; | |
64 | int wait_fd; | |
65 | uint64_t memory_map_size; | |
66 | }; | |
67 | ||
9f3fdbc6 MD |
68 | struct lttng_ust_event { |
69 | char name[LTTNG_UST_SYM_NAME_LEN]; /* event name */ | |
70 | enum lttng_ust_instrumentation instrumentation; | |
71 | /* Per instrumentation type configuration */ | |
72 | union { | |
73 | } u; | |
74 | }; | |
75 | ||
9f3fdbc6 | 76 | enum lttng_ust_context_type { |
3b402b40 | 77 | LTTNG_UST_CONTEXT_VTID = 0, |
c1ef86f0 MD |
78 | LTTNG_UST_CONTEXT_VPID = 1, |
79 | LTTNG_UST_CONTEXT_PTHREAD_ID = 2, | |
4847e9bb | 80 | LTTNG_UST_CONTEXT_PROCNAME = 3, |
9f3fdbc6 MD |
81 | }; |
82 | ||
83 | struct lttng_ust_context { | |
84 | enum lttng_ust_context_type ctx; | |
85 | union { | |
86 | } u; | |
87 | }; | |
88 | ||
92462b01 MD |
89 | /* |
90 | * Tracer channel attributes. | |
91 | */ | |
92 | struct lttng_ust_channel_attr { | |
93 | int overwrite; /* 1: overwrite, 0: discard */ | |
94 | uint64_t subbuf_size; /* bytes */ | |
95 | uint64_t num_subbuf; /* power of 2 */ | |
96 | unsigned int switch_timer_interval; /* usec */ | |
97 | unsigned int read_timer_interval; /* usec */ | |
98 | enum lttng_ust_output output; /* splice, mmap */ | |
99 | }; | |
100 | ||
cbef6901 MD |
101 | struct lttng_ust_tracepoint_iter { |
102 | char name[LTTNG_UST_SYM_NAME_LEN]; /* provider:name */ | |
103 | char loglevel[LTTNG_UST_SYM_NAME_LEN]; /* loglevel */ | |
104 | int64_t loglevel_value; | |
105 | }; | |
106 | ||
92462b01 MD |
107 | struct lttng_ust_object_data { |
108 | int handle; | |
109 | int shm_fd; | |
110 | int wait_fd; | |
111 | uint64_t memory_map_size; | |
112 | }; | |
113 | ||
9f3fdbc6 MD |
114 | #define _UST_CMD(minor) (minor) |
115 | #define _UST_CMDR(minor, type) (minor) | |
116 | #define _UST_CMDW(minor, type) (minor) | |
117 | ||
46050b1a MD |
118 | /* Handled by object descriptor */ |
119 | #define LTTNG_UST_RELEASE _UST_CMD(0x1) | |
120 | ||
121 | /* Handled by object cmd */ | |
122 | ||
9f3fdbc6 MD |
123 | /* LTTng-UST commands */ |
124 | #define LTTNG_UST_SESSION _UST_CMD(0x40) | |
125 | #define LTTNG_UST_TRACER_VERSION \ | |
126 | _UST_CMDR(0x41, struct lttng_ust_tracer_version) | |
127 | #define LTTNG_UST_TRACEPOINT_LIST _UST_CMD(0x42) | |
128 | #define LTTNG_UST_WAIT_QUIESCENT _UST_CMD(0x43) | |
11ff9c7d | 129 | #define LTTNG_UST_REGISTER_DONE _UST_CMD(0x44) |
9f3fdbc6 | 130 | |
46050b1a | 131 | /* Session FD commands */ |
9f3fdbc6 MD |
132 | #define LTTNG_UST_METADATA \ |
133 | _UST_CMDW(0x50, struct lttng_ust_channel) | |
134 | #define LTTNG_UST_CHANNEL \ | |
135 | _UST_CMDW(0x51, struct lttng_ust_channel) | |
136 | #define LTTNG_UST_SESSION_START _UST_CMD(0x52) | |
137 | #define LTTNG_UST_SESSION_STOP _UST_CMD(0x53) | |
138 | ||
46050b1a | 139 | /* Channel FD commands */ |
9f3fdbc6 MD |
140 | #define LTTNG_UST_STREAM _UST_CMD(0x60) |
141 | #define LTTNG_UST_EVENT \ | |
142 | _UST_CMDW(0x61, struct lttng_ust_event) | |
143 | ||
46050b1a | 144 | /* Event and Channel FD commands */ |
9f3fdbc6 MD |
145 | #define LTTNG_UST_CONTEXT \ |
146 | _UST_CMDW(0x70, struct lttng_ust_context) | |
43d330a4 | 147 | #define LTTNG_UST_FLUSH_BUFFER \ |
43861eab | 148 | _UST_CMD(0x71) |
9f3fdbc6 | 149 | |
46050b1a | 150 | /* Event, Channel and Session commands */ |
9f3fdbc6 MD |
151 | #define LTTNG_UST_ENABLE _UST_CMD(0x80) |
152 | #define LTTNG_UST_DISABLE _UST_CMD(0x81) | |
153 | ||
51489cad MD |
154 | /* Tracepoint list commands */ |
155 | #define LTTNG_UST_TRACEPOINT_LIST_GET _UST_CMD(0x90) | |
156 | ||
46050b1a MD |
157 | #define LTTNG_UST_ROOT_HANDLE 0 |
158 | ||
b61ce3b2 | 159 | struct lttng_ust_obj; |
46050b1a | 160 | |
b61ce3b2 | 161 | struct lttng_ust_objd_ops { |
46050b1a MD |
162 | long (*cmd)(int objd, unsigned int cmd, unsigned long arg); |
163 | int (*release)(int objd); | |
164 | }; | |
165 | ||
166 | /* Create root handle. Always ID 0. */ | |
167 | int lttng_abi_create_root_handle(void); | |
168 | ||
b61ce3b2 | 169 | const struct lttng_ust_objd_ops *objd_ops(int id); |
d4419b81 | 170 | int lttng_ust_objd_unref(int id); |
46050b1a MD |
171 | |
172 | void lttng_ust_abi_exit(void); | |
003fedf4 | 173 | void lttng_ust_events_exit(void); |
b35d179d | 174 | |
9f3fdbc6 | 175 | #endif /* _LTTNG_UST_ABI_H */ |