1 #ifndef _LTTNG_UST_COMM_H
2 #define _LTTNG_UST_COMM_H
5 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
6 * Julien Desfossez <julien.desfossez@polymtl.ca>
7 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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.
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.
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
25 * This header is meant for liblttng and libust internal use ONLY.
26 * These declarations should NOT be considered stable API.
32 #include <lttng/ust-abi.h>
33 #include <lttng/ust-error.h>
34 #include <lttng/ust-compiler.h>
35 #include <lttng/ust-ctl.h>
38 #error "LTTNG_PACKED should be defined"
42 * Default timeout the application waits for the sessiond to send its
43 * "register done" command. Can be overridden with the environment
44 * variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not
45 * found, the application proceeds directly without any delay.
47 #define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS CONFIG_LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS
49 #define LTTNG_DEFAULT_RUNDIR LTTNG_SYSTEM_RUNDIR
50 #define LTTNG_DEFAULT_HOME_RUNDIR ".lttng"
52 /* Queue size of listen(2) */
53 #define LTTNG_UST_COMM_MAX_LISTEN 10
54 #define LTTNG_UST_COMM_REG_MSG_PADDING 64
56 struct lttng_event_field
;
57 struct lttng_ctx_field
;
58 struct lttng_enum_entry
;
59 struct lttng_integer_type
;
62 struct ustctl_reg_msg
{
70 uint32_t bits_per_long
;
71 uint32_t uint8_t_alignment
;
72 uint32_t uint16_t_alignment
;
73 uint32_t uint32_t_alignment
;
74 uint32_t uint64_t_alignment
;
75 uint32_t long_alignment
;
76 uint32_t socket_type
; /* enum ustctl_socket_type */
77 char name
[LTTNG_UST_ABI_PROCNAME_LEN
]; /* process name */
78 char padding
[LTTNG_UST_COMM_REG_MSG_PADDING
];
82 * Data structure for the commands sent from sessiond to UST.
84 #define USTCOMM_MSG_PADDING1 32
85 #define USTCOMM_MSG_PADDING2 32
86 struct ustcomm_ust_msg
{
89 char padding
[USTCOMM_MSG_PADDING1
];
91 struct lttng_ust_channel channel
;
92 struct lttng_ust_stream stream
;
93 struct lttng_ust_event event
;
94 struct lttng_ust_context context
;
95 struct lttng_ust_tracer_version version
;
96 struct lttng_ust_tracepoint_iter tracepoint
;
98 uint32_t data_size
; /* following filter data */
99 uint32_t reloc_offset
;
101 } LTTNG_PACKED filter
;
103 uint32_t count
; /* how many names follow */
104 } LTTNG_PACKED exclusion
;
106 uint32_t data_size
; /* following capture data */
107 uint32_t reloc_offset
;
109 } LTTNG_PACKED capture
;
110 struct lttng_ust_counter counter
;
111 struct lttng_ust_counter_global counter_global
;
112 struct lttng_ust_counter_cpu counter_cpu
;
114 * For LTTNG_UST_EVENT_NOTIFIER_CREATE, a struct
115 * lttng_ust_event_notifier implicitly follows struct
119 /* Length of struct lttng_ust_event_notifier */
122 char padding
[USTCOMM_MSG_PADDING2
];
127 * Data structure for the response from UST to the session daemon.
128 * cmd_type is sent back in the reply for validation.
130 #define USTCOMM_REPLY_PADDING1 32
131 #define USTCOMM_REPLY_PADDING2 32
132 struct ustcomm_ust_reply
{
135 int32_t ret_code
; /* enum ustcomm_return_code */
136 uint32_t ret_val
; /* return value */
137 char padding
[USTCOMM_REPLY_PADDING1
];
140 uint64_t memory_map_size
;
141 } LTTNG_PACKED channel
;
143 uint64_t memory_map_size
;
144 } LTTNG_PACKED stream
;
145 struct lttng_ust_tracer_version version
;
146 struct lttng_ust_tracepoint_iter tracepoint
;
147 char padding
[USTCOMM_REPLY_PADDING2
];
151 struct ustcomm_notify_hdr
{
155 #define USTCOMM_NOTIFY_EVENT_MSG_PADDING 32
156 struct ustcomm_notify_event_msg
{
157 uint32_t session_objd
;
158 uint32_t channel_objd
;
159 char event_name
[LTTNG_UST_SYM_NAME_LEN
];
161 uint32_t signature_len
;
163 uint32_t model_emf_uri_len
;
164 char padding
[USTCOMM_NOTIFY_EVENT_MSG_PADDING
];
165 /* followed by signature, fields, and model_emf_uri */
168 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
169 struct ustcomm_notify_event_reply
{
170 int32_t ret_code
; /* 0: ok, negative: error code */
172 char padding
[USTCOMM_NOTIFY_EVENT_REPLY_PADDING
];
175 #define USTCOMM_NOTIFY_ENUM_MSG_PADDING 32
176 struct ustcomm_notify_enum_msg
{
177 uint32_t session_objd
;
178 char enum_name
[LTTNG_UST_SYM_NAME_LEN
];
179 uint32_t entries_len
;
180 char padding
[USTCOMM_NOTIFY_ENUM_MSG_PADDING
];
181 /* followed by enum entries */
184 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
185 struct ustcomm_notify_enum_reply
{
186 int32_t ret_code
; /* 0: ok, negative: error code */
188 char padding
[USTCOMM_NOTIFY_EVENT_REPLY_PADDING
];
191 #define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32
192 struct ustcomm_notify_channel_msg
{
193 uint32_t session_objd
;
194 uint32_t channel_objd
;
195 uint32_t ctx_fields_len
;
196 char padding
[USTCOMM_NOTIFY_CHANNEL_MSG_PADDING
];
197 /* followed by context fields */
200 #define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32
201 struct ustcomm_notify_channel_reply
{
202 int32_t ret_code
; /* 0: ok, negative: error code */
204 uint32_t header_type
; /* enum ustctl_channel_header */
205 char padding
[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING
];
209 * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
210 * struct lttng_ust_field_iter field.
213 extern int ustcomm_create_unix_sock(const char *pathname
);
214 extern int ustcomm_connect_unix_sock(const char *pathname
,
216 extern int ustcomm_accept_unix_sock(int sock
);
217 extern int ustcomm_listen_unix_sock(int sock
);
218 extern int ustcomm_close_unix_sock(int sock
);
220 extern ssize_t
ustcomm_recv_unix_sock(int sock
, void *buf
, size_t len
);
221 extern ssize_t
ustcomm_send_unix_sock(int sock
, const void *buf
, size_t len
);
222 extern ssize_t
ustcomm_send_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
223 extern ssize_t
ustcomm_recv_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
225 extern const char *ustcomm_get_readable_code(int code
);
226 extern int ustcomm_send_app_msg(int sock
, struct ustcomm_ust_msg
*lum
);
227 extern int ustcomm_recv_app_reply(int sock
, struct ustcomm_ust_reply
*lur
,
228 uint32_t expected_handle
, uint32_t expected_cmd
);
229 extern int ustcomm_send_app_cmd(int sock
,
230 struct ustcomm_ust_msg
*lum
,
231 struct ustcomm_ust_reply
*lur
);
232 int ustcomm_recv_fd(int sock
);
234 ssize_t
ustcomm_recv_channel_from_sessiond(int sock
,
235 void **chan_data
, uint64_t len
, int *wakeup_fd
);
236 int ustcomm_recv_stream_from_sessiond(int sock
,
237 uint64_t *memory_map_size
,
238 int *shm_fd
, int *wakeup_fd
);
239 ssize_t
ustcomm_recv_event_notifier_notif_fd_from_sessiond(int sock
,
240 int *event_notifier_notif_fd
);
242 ssize_t
ustcomm_recv_counter_from_sessiond(int sock
,
243 void **counter_data
, uint64_t len
);
244 int ustcomm_recv_counter_shm_from_sessiond(int sock
,
248 * Returns 0 on success, negative error value on error.
249 * Returns -EPIPE or -ECONNRESET if other end has hung up.
251 int ustcomm_send_reg_msg(int sock
,
252 enum ustctl_socket_type type
,
253 uint32_t bits_per_long
,
254 uint32_t uint8_t_alignment
,
255 uint32_t uint16_t_alignment
,
256 uint32_t uint32_t_alignment
,
257 uint32_t uint64_t_alignment
,
258 uint32_t long_alignment
);
261 * Returns 0 on success, negative error value on error.
262 * Returns -EPIPE or -ECONNRESET if other end has hung up.
264 int ustcomm_register_event(int sock
,
265 struct lttng_session
*session
,
266 int session_objd
, /* session descriptor */
267 int channel_objd
, /* channel descriptor */
268 const char *event_name
, /* event name (input) */
270 const char *signature
, /* event signature (input) */
271 size_t nr_fields
, /* fields */
272 const struct lttng_event_field
*fields
,
273 const char *model_emf_uri
,
274 uint32_t *id
); /* event id (output) */
277 * Returns 0 on success, negative error value on error.
278 * Returns -EPIPE or -ECONNRESET if other end has hung up.
280 int ustcomm_register_enum(int sock
,
281 int session_objd
, /* session descriptor */
282 const char *enum_name
, /* enum name (input) */
283 size_t nr_entries
, /* entries */
284 const struct lttng_enum_entry
*entries
,
285 uint64_t *id
); /* enum id (output) */
288 * Returns 0 on success, negative error value on error.
289 * Returns -EPIPE or -ECONNRESET if other end has hung up.
291 int ustcomm_register_channel(int sock
,
292 struct lttng_session
*session
,
293 int session_objd
, /* session descriptor */
294 int channel_objd
, /* channel descriptor */
295 size_t nr_ctx_fields
,
296 const struct lttng_ctx_field
*ctx_fields
,
297 uint32_t *chan_id
, /* channel id (output) */
298 int *header_type
); /* header type (output) */
300 int ustcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
301 int ustcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
303 #endif /* _LTTNG_UST_COMM_H */