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>
39 #error "LTTNG_PACKED should be defined"
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.
48 #define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS CONFIG_LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS
50 #define LTTNG_DEFAULT_RUNDIR LTTNG_SYSTEM_RUNDIR
51 #define LTTNG_DEFAULT_HOME_RUNDIR ".lttng"
53 /* Queue size of listen(2) */
54 #define LTTNG_UST_COMM_MAX_LISTEN 10
55 #define LTTNG_UST_COMM_REG_MSG_PADDING 64
57 struct lttng_event_field
;
58 struct lttng_ctx_field
;
59 struct lttng_enum_entry
;
60 struct lttng_integer_type
;
63 struct ustctl_reg_msg
{
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
];
83 * Data structure for the commands sent from sessiond to UST.
85 #define USTCOMM_MSG_PADDING1 32
86 #define USTCOMM_MSG_PADDING2 32
87 struct ustcomm_ust_msg
{
90 char padding
[USTCOMM_MSG_PADDING1
];
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
;
99 uint32_t data_size
; /* following filter data */
100 uint32_t reloc_offset
;
102 } LTTNG_PACKED filter
;
104 uint32_t count
; /* how many names follow */
105 } LTTNG_PACKED exclusion
;
107 uint32_t data_size
; /* following capture data */
108 uint32_t reloc_offset
;
110 } LTTNG_PACKED capture
;
111 struct lttng_ust_counter counter
;
112 struct lttng_ust_counter_global counter_global
;
113 struct lttng_ust_counter_cpu counter_cpu
;
115 * For LTTNG_UST_EVENT_NOTIFIER_CREATE, a struct
116 * lttng_ust_event_notifier implicitly follows struct
120 /* Length of struct lttng_ust_event_notifier */
123 char padding
[USTCOMM_MSG_PADDING2
];
128 * Data structure for the response from UST to the session daemon.
129 * cmd_type is sent back in the reply for validation.
131 #define USTCOMM_REPLY_PADDING1 32
132 #define USTCOMM_REPLY_PADDING2 32
133 struct ustcomm_ust_reply
{
136 int32_t ret_code
; /* enum ustcomm_return_code */
137 uint32_t ret_val
; /* return value */
138 char padding
[USTCOMM_REPLY_PADDING1
];
141 uint64_t memory_map_size
;
142 } LTTNG_PACKED channel
;
144 uint64_t memory_map_size
;
145 } LTTNG_PACKED stream
;
146 struct lttng_ust_tracer_version version
;
147 struct lttng_ust_tracepoint_iter tracepoint
;
148 char padding
[USTCOMM_REPLY_PADDING2
];
152 struct ustcomm_notify_hdr
{
156 #define USTCOMM_NOTIFY_EVENT_MSG_PADDING 32
157 struct ustcomm_notify_event_msg
{
158 uint32_t session_objd
;
159 uint32_t channel_objd
;
160 char event_name
[LTTNG_UST_SYM_NAME_LEN
];
162 uint32_t signature_len
;
164 uint32_t model_emf_uri_len
;
165 char padding
[USTCOMM_NOTIFY_EVENT_MSG_PADDING
];
166 /* followed by signature, fields, and model_emf_uri */
169 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
170 struct ustcomm_notify_event_reply
{
171 int32_t ret_code
; /* 0: ok, negative: error code */
173 char padding
[USTCOMM_NOTIFY_EVENT_REPLY_PADDING
];
176 #define USTCOMM_NOTIFY_ENUM_MSG_PADDING 32
177 struct ustcomm_notify_enum_msg
{
178 uint32_t session_objd
;
179 char enum_name
[LTTNG_UST_SYM_NAME_LEN
];
180 uint32_t entries_len
;
181 char padding
[USTCOMM_NOTIFY_ENUM_MSG_PADDING
];
182 /* followed by enum entries */
185 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
186 struct ustcomm_notify_enum_reply
{
187 int32_t ret_code
; /* 0: ok, negative: error code */
189 char padding
[USTCOMM_NOTIFY_EVENT_REPLY_PADDING
];
192 #define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32
193 struct ustcomm_notify_channel_msg
{
194 uint32_t session_objd
;
195 uint32_t channel_objd
;
196 uint32_t ctx_fields_len
;
197 char padding
[USTCOMM_NOTIFY_CHANNEL_MSG_PADDING
];
198 /* followed by context fields */
201 #define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32
202 struct ustcomm_notify_channel_reply
{
203 int32_t ret_code
; /* 0: ok, negative: error code */
205 uint32_t header_type
; /* enum ustctl_channel_header */
206 char padding
[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING
];
210 * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
211 * struct lttng_ust_field_iter field.
214 extern int ustcomm_create_unix_sock(const char *pathname
);
215 extern int ustcomm_connect_unix_sock(const char *pathname
,
217 extern int ustcomm_accept_unix_sock(int sock
);
218 extern int ustcomm_listen_unix_sock(int sock
);
219 extern int ustcomm_close_unix_sock(int sock
);
221 extern ssize_t
ustcomm_recv_unix_sock(int sock
, void *buf
, size_t len
);
222 extern ssize_t
ustcomm_send_unix_sock(int sock
, const void *buf
, size_t len
);
223 extern ssize_t
ustcomm_send_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
224 extern ssize_t
ustcomm_recv_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
226 extern const char *ustcomm_get_readable_code(int code
);
227 extern int ustcomm_send_app_msg(int sock
, struct ustcomm_ust_msg
*lum
);
228 extern int ustcomm_recv_app_reply(int sock
, struct ustcomm_ust_reply
*lur
,
229 uint32_t expected_handle
, uint32_t expected_cmd
);
230 extern int ustcomm_send_app_cmd(int sock
,
231 struct ustcomm_ust_msg
*lum
,
232 struct ustcomm_ust_reply
*lur
);
233 int ustcomm_recv_fd(int sock
);
235 ssize_t
ustcomm_recv_channel_from_sessiond(int sock
,
236 void **chan_data
, uint64_t len
, int *wakeup_fd
);
237 int ustcomm_recv_stream_from_sessiond(int sock
,
238 uint64_t *memory_map_size
,
239 int *shm_fd
, int *wakeup_fd
);
241 ssize_t
ustcomm_recv_event_notifier_notif_fd_from_sessiond(int sock
,
242 int *event_notifier_notif_fd
);
245 ssize_t
ustcomm_recv_counter_from_sessiond(int sock
,
246 void **counter_data
, uint64_t len
);
248 int ustcomm_recv_counter_shm_from_sessiond(int sock
,
252 * Returns 0 on success, negative error value on error.
253 * Returns -EPIPE or -ECONNRESET if other end has hung up.
255 int ustcomm_send_reg_msg(int sock
,
256 enum ustctl_socket_type type
,
257 uint32_t bits_per_long
,
258 uint32_t uint8_t_alignment
,
259 uint32_t uint16_t_alignment
,
260 uint32_t uint32_t_alignment
,
261 uint32_t uint64_t_alignment
,
262 uint32_t long_alignment
);
265 * Returns 0 on success, negative error value on error.
266 * Returns -EPIPE or -ECONNRESET if other end has hung up.
268 int ustcomm_register_event(int sock
,
269 struct lttng_session
*session
,
270 int session_objd
, /* session descriptor */
271 int channel_objd
, /* channel descriptor */
272 const char *event_name
, /* event name (input) */
274 const char *signature
, /* event signature (input) */
275 size_t nr_fields
, /* fields */
276 const struct lttng_event_field
*fields
,
277 const char *model_emf_uri
,
278 uint32_t *id
); /* event id (output) */
281 * Returns 0 on success, negative error value on error.
282 * Returns -EPIPE or -ECONNRESET if other end has hung up.
284 int ustcomm_register_enum(int sock
,
285 int session_objd
, /* session descriptor */
286 const char *enum_name
, /* enum name (input) */
287 size_t nr_entries
, /* entries */
288 const struct lttng_enum_entry
*entries
,
289 uint64_t *id
); /* enum id (output) */
292 * Returns 0 on success, negative error value on error.
293 * Returns -EPIPE or -ECONNRESET if other end has hung up.
295 int ustcomm_register_channel(int sock
,
296 struct lttng_session
*session
,
297 int session_objd
, /* session descriptor */
298 int channel_objd
, /* channel descriptor */
299 size_t nr_ctx_fields
,
300 const struct lttng_ctx_field
*ctx_fields
,
301 uint32_t *chan_id
, /* channel id (output) */
302 int *header_type
); /* header type (output) */
304 int ustcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
305 int ustcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
307 #endif /* _LTTNG_UST_COMM_H */