Cleanup: apply `include-what-you-use` guideline for `uint*_t`
[lttng-ust.git] / include / ust-comm.h
1 #ifndef _LTTNG_UST_COMM_H
2 #define _LTTNG_UST_COMM_H
3
4 /*
5 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
6 * Julien Desfossez <julien.desfossez@polymtl.ca>
7 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 *
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; only
12 * version 2.1 of the License.
13 *
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
24 /*
25 * This header is meant for liblttng and libust internal use ONLY.
26 * These declarations should NOT be considered stable API.
27 */
28
29 #include <stdint.h>
30 #include <limits.h>
31 #include <unistd.h>
32 #include <lttng/ust-abi.h>
33 #include <lttng/ust-error.h>
34 #include <lttng/ust-compiler.h>
35 #include <lttng/ust-ctl.h>
36 #include <config.h>
37
38 #ifndef LTTNG_PACKED
39 #error "LTTNG_PACKED should be defined"
40 #endif
41
42 /*
43 * Default timeout the application waits for the sessiond to send its
44 * "register done" command. Can be overridden with the environment
45 * variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not
46 * found, the application proceeds directly without any delay.
47 */
48 #define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS CONFIG_LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS
49
50 #define LTTNG_DEFAULT_RUNDIR LTTNG_SYSTEM_RUNDIR
51 #define LTTNG_DEFAULT_HOME_RUNDIR ".lttng"
52
53 /* Queue size of listen(2) */
54 #define LTTNG_UST_COMM_MAX_LISTEN 10
55 #define LTTNG_UST_COMM_REG_MSG_PADDING 64
56
57 struct lttng_event_field;
58 struct lttng_ctx_field;
59 struct lttng_enum_entry;
60 struct lttng_integer_type;
61 struct lttng_session;
62
63 struct ustctl_reg_msg {
64 uint32_t magic;
65 uint32_t major;
66 uint32_t minor;
67 uint32_t pid;
68 uint32_t ppid;
69 uint32_t uid;
70 uint32_t gid;
71 uint32_t bits_per_long;
72 uint32_t uint8_t_alignment;
73 uint32_t uint16_t_alignment;
74 uint32_t uint32_t_alignment;
75 uint32_t uint64_t_alignment;
76 uint32_t long_alignment;
77 uint32_t socket_type; /* enum ustctl_socket_type */
78 char name[LTTNG_UST_ABI_PROCNAME_LEN]; /* process name */
79 char padding[LTTNG_UST_COMM_REG_MSG_PADDING];
80 } LTTNG_PACKED;
81
82 /*
83 * Data structure for the commands sent from sessiond to UST.
84 */
85 #define USTCOMM_MSG_PADDING1 32
86 #define USTCOMM_MSG_PADDING2 32
87 struct ustcomm_ust_msg {
88 uint32_t handle;
89 uint32_t cmd;
90 char padding[USTCOMM_MSG_PADDING1];
91 union {
92 struct lttng_ust_channel channel;
93 struct lttng_ust_stream stream;
94 struct lttng_ust_event event;
95 struct lttng_ust_context context;
96 struct lttng_ust_tracer_version version;
97 struct lttng_ust_tracepoint_iter tracepoint;
98 struct {
99 uint32_t data_size; /* following filter data */
100 uint32_t reloc_offset;
101 uint64_t seqnum;
102 } LTTNG_PACKED filter;
103 struct {
104 uint32_t count; /* how many names follow */
105 } LTTNG_PACKED exclusion;
106 char padding[USTCOMM_MSG_PADDING2];
107 } u;
108 } LTTNG_PACKED;
109
110 /*
111 * Data structure for the response from UST to the session daemon.
112 * cmd_type is sent back in the reply for validation.
113 */
114 #define USTCOMM_REPLY_PADDING1 32
115 #define USTCOMM_REPLY_PADDING2 32
116 struct ustcomm_ust_reply {
117 uint32_t handle;
118 uint32_t cmd;
119 int32_t ret_code; /* enum ustcomm_return_code */
120 uint32_t ret_val; /* return value */
121 char padding[USTCOMM_REPLY_PADDING1];
122 union {
123 struct {
124 uint64_t memory_map_size;
125 } LTTNG_PACKED channel;
126 struct {
127 uint64_t memory_map_size;
128 } LTTNG_PACKED stream;
129 struct lttng_ust_tracer_version version;
130 struct lttng_ust_tracepoint_iter tracepoint;
131 char padding[USTCOMM_REPLY_PADDING2];
132 } u;
133 } LTTNG_PACKED;
134
135 struct ustcomm_notify_hdr {
136 uint32_t notify_cmd;
137 } LTTNG_PACKED;
138
139 #define USTCOMM_NOTIFY_EVENT_MSG_PADDING 32
140 struct ustcomm_notify_event_msg {
141 uint32_t session_objd;
142 uint32_t channel_objd;
143 char event_name[LTTNG_UST_SYM_NAME_LEN];
144 int32_t loglevel;
145 uint32_t signature_len;
146 uint32_t fields_len;
147 uint32_t model_emf_uri_len;
148 char padding[USTCOMM_NOTIFY_EVENT_MSG_PADDING];
149 /* followed by signature, fields, and model_emf_uri */
150 } LTTNG_PACKED;
151
152 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
153 struct ustcomm_notify_event_reply {
154 int32_t ret_code; /* 0: ok, negative: error code */
155 uint32_t event_id;
156 char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING];
157 } LTTNG_PACKED;
158
159 #define USTCOMM_NOTIFY_ENUM_MSG_PADDING 32
160 struct ustcomm_notify_enum_msg {
161 uint32_t session_objd;
162 char enum_name[LTTNG_UST_SYM_NAME_LEN];
163 uint32_t entries_len;
164 char padding[USTCOMM_NOTIFY_ENUM_MSG_PADDING];
165 /* followed by enum entries */
166 } LTTNG_PACKED;
167
168 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
169 struct ustcomm_notify_enum_reply {
170 int32_t ret_code; /* 0: ok, negative: error code */
171 uint64_t enum_id;
172 char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING];
173 } LTTNG_PACKED;
174
175 #define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32
176 struct ustcomm_notify_channel_msg {
177 uint32_t session_objd;
178 uint32_t channel_objd;
179 uint32_t ctx_fields_len;
180 char padding[USTCOMM_NOTIFY_CHANNEL_MSG_PADDING];
181 /* followed by context fields */
182 } LTTNG_PACKED;
183
184 #define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32
185 struct ustcomm_notify_channel_reply {
186 int32_t ret_code; /* 0: ok, negative: error code */
187 uint32_t chan_id;
188 uint32_t header_type; /* enum ustctl_channel_header */
189 char padding[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING];
190 } LTTNG_PACKED;
191
192 /*
193 * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
194 * struct lttng_ust_field_iter field.
195 */
196
197 extern int ustcomm_create_unix_sock(const char *pathname);
198 extern int ustcomm_connect_unix_sock(const char *pathname,
199 long timeout);
200 extern int ustcomm_accept_unix_sock(int sock);
201 extern int ustcomm_listen_unix_sock(int sock);
202 extern int ustcomm_close_unix_sock(int sock);
203
204 extern ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len);
205 extern ssize_t ustcomm_send_unix_sock(int sock, const void *buf, size_t len);
206 extern ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
207 extern ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);
208
209 extern const char *ustcomm_get_readable_code(int code);
210 extern int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum);
211 extern int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur,
212 uint32_t expected_handle, uint32_t expected_cmd);
213 extern int ustcomm_send_app_cmd(int sock,
214 struct ustcomm_ust_msg *lum,
215 struct ustcomm_ust_reply *lur);
216 int ustcomm_recv_fd(int sock);
217
218 ssize_t ustcomm_recv_channel_from_sessiond(int sock,
219 void **chan_data, uint64_t len, int *wakeup_fd);
220 int ustcomm_recv_stream_from_sessiond(int sock,
221 uint64_t *memory_map_size,
222 int *shm_fd, int *wakeup_fd);
223
224 /*
225 * Returns 0 on success, negative error value on error.
226 * Returns -EPIPE or -ECONNRESET if other end has hung up.
227 */
228 int ustcomm_send_reg_msg(int sock,
229 enum ustctl_socket_type type,
230 uint32_t bits_per_long,
231 uint32_t uint8_t_alignment,
232 uint32_t uint16_t_alignment,
233 uint32_t uint32_t_alignment,
234 uint32_t uint64_t_alignment,
235 uint32_t long_alignment);
236
237 /*
238 * Returns 0 on success, negative error value on error.
239 * Returns -EPIPE or -ECONNRESET if other end has hung up.
240 */
241 int ustcomm_register_event(int sock,
242 struct lttng_session *session,
243 int session_objd, /* session descriptor */
244 int channel_objd, /* channel descriptor */
245 const char *event_name, /* event name (input) */
246 int loglevel,
247 const char *signature, /* event signature (input) */
248 size_t nr_fields, /* fields */
249 const struct lttng_event_field *fields,
250 const char *model_emf_uri,
251 uint32_t *id); /* event id (output) */
252
253 /*
254 * Returns 0 on success, negative error value on error.
255 * Returns -EPIPE or -ECONNRESET if other end has hung up.
256 */
257 int ustcomm_register_enum(int sock,
258 int session_objd, /* session descriptor */
259 const char *enum_name, /* enum name (input) */
260 size_t nr_entries, /* entries */
261 const struct lttng_enum_entry *entries,
262 uint64_t *id); /* enum id (output) */
263
264 /*
265 * Returns 0 on success, negative error value on error.
266 * Returns -EPIPE or -ECONNRESET if other end has hung up.
267 */
268 int ustcomm_register_channel(int sock,
269 struct lttng_session *session,
270 int session_objd, /* session descriptor */
271 int channel_objd, /* channel descriptor */
272 size_t nr_ctx_fields,
273 const struct lttng_ctx_field *ctx_fields,
274 uint32_t *chan_id, /* channel id (output) */
275 int *header_type); /* header type (output) */
276
277 int ustcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
278 int ustcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
279
280 #endif /* _LTTNG_UST_COMM_H */
This page took 0.033945 seconds and 4 git commands to generate.