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_event_notifier event_notifier
;
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 char padding
[USTCOMM_MSG_PADDING2
];
116 * Data structure for the response from UST to the session daemon.
117 * cmd_type is sent back in the reply for validation.
119 #define USTCOMM_REPLY_PADDING1 32
120 #define USTCOMM_REPLY_PADDING2 32
121 struct ustcomm_ust_reply
{
124 int32_t ret_code
; /* enum ustcomm_return_code */
125 uint32_t ret_val
; /* return value */
126 char padding
[USTCOMM_REPLY_PADDING1
];
129 uint64_t memory_map_size
;
130 } LTTNG_PACKED channel
;
132 uint64_t memory_map_size
;
133 } LTTNG_PACKED stream
;
134 struct lttng_ust_tracer_version version
;
135 struct lttng_ust_tracepoint_iter tracepoint
;
136 char padding
[USTCOMM_REPLY_PADDING2
];
140 struct ustcomm_notify_hdr
{
144 #define USTCOMM_NOTIFY_EVENT_MSG_PADDING 32
145 struct ustcomm_notify_event_msg
{
146 uint32_t session_objd
;
147 uint32_t channel_objd
;
148 char event_name
[LTTNG_UST_SYM_NAME_LEN
];
150 uint32_t signature_len
;
152 uint32_t model_emf_uri_len
;
153 char padding
[USTCOMM_NOTIFY_EVENT_MSG_PADDING
];
154 /* followed by signature, fields, and model_emf_uri */
157 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
158 struct ustcomm_notify_event_reply
{
159 int32_t ret_code
; /* 0: ok, negative: error code */
161 char padding
[USTCOMM_NOTIFY_EVENT_REPLY_PADDING
];
164 #define USTCOMM_NOTIFY_ENUM_MSG_PADDING 32
165 struct ustcomm_notify_enum_msg
{
166 uint32_t session_objd
;
167 char enum_name
[LTTNG_UST_SYM_NAME_LEN
];
168 uint32_t entries_len
;
169 char padding
[USTCOMM_NOTIFY_ENUM_MSG_PADDING
];
170 /* followed by enum entries */
173 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
174 struct ustcomm_notify_enum_reply
{
175 int32_t ret_code
; /* 0: ok, negative: error code */
177 char padding
[USTCOMM_NOTIFY_EVENT_REPLY_PADDING
];
180 #define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32
181 struct ustcomm_notify_channel_msg
{
182 uint32_t session_objd
;
183 uint32_t channel_objd
;
184 uint32_t ctx_fields_len
;
185 char padding
[USTCOMM_NOTIFY_CHANNEL_MSG_PADDING
];
186 /* followed by context fields */
189 #define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32
190 struct ustcomm_notify_channel_reply
{
191 int32_t ret_code
; /* 0: ok, negative: error code */
193 uint32_t header_type
; /* enum ustctl_channel_header */
194 char padding
[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING
];
198 * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
199 * struct lttng_ust_field_iter field.
202 extern int ustcomm_create_unix_sock(const char *pathname
);
203 extern int ustcomm_connect_unix_sock(const char *pathname
,
205 extern int ustcomm_accept_unix_sock(int sock
);
206 extern int ustcomm_listen_unix_sock(int sock
);
207 extern int ustcomm_close_unix_sock(int sock
);
209 extern ssize_t
ustcomm_recv_unix_sock(int sock
, void *buf
, size_t len
);
210 extern ssize_t
ustcomm_send_unix_sock(int sock
, const void *buf
, size_t len
);
211 extern ssize_t
ustcomm_send_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
212 extern ssize_t
ustcomm_recv_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
214 extern const char *ustcomm_get_readable_code(int code
);
215 extern int ustcomm_send_app_msg(int sock
, struct ustcomm_ust_msg
*lum
);
216 extern int ustcomm_recv_app_reply(int sock
, struct ustcomm_ust_reply
*lur
,
217 uint32_t expected_handle
, uint32_t expected_cmd
);
218 extern int ustcomm_send_app_cmd(int sock
,
219 struct ustcomm_ust_msg
*lum
,
220 struct ustcomm_ust_reply
*lur
);
221 int ustcomm_recv_fd(int sock
);
223 ssize_t
ustcomm_recv_channel_from_sessiond(int sock
,
224 void **chan_data
, uint64_t len
, int *wakeup_fd
);
225 int ustcomm_recv_stream_from_sessiond(int sock
,
226 uint64_t *memory_map_size
,
227 int *shm_fd
, int *wakeup_fd
);
228 ssize_t
ustcomm_recv_event_notifier_notif_fd_from_sessiond(int sock
,
229 int *event_notifier_notif_fd
);
232 * Returns 0 on success, negative error value on error.
233 * Returns -EPIPE or -ECONNRESET if other end has hung up.
235 int ustcomm_send_reg_msg(int sock
,
236 enum ustctl_socket_type type
,
237 uint32_t bits_per_long
,
238 uint32_t uint8_t_alignment
,
239 uint32_t uint16_t_alignment
,
240 uint32_t uint32_t_alignment
,
241 uint32_t uint64_t_alignment
,
242 uint32_t long_alignment
);
245 * Returns 0 on success, negative error value on error.
246 * Returns -EPIPE or -ECONNRESET if other end has hung up.
248 int ustcomm_register_event(int sock
,
249 struct lttng_session
*session
,
250 int session_objd
, /* session descriptor */
251 int channel_objd
, /* channel descriptor */
252 const char *event_name
, /* event name (input) */
254 const char *signature
, /* event signature (input) */
255 size_t nr_fields
, /* fields */
256 const struct lttng_event_field
*fields
,
257 const char *model_emf_uri
,
258 uint32_t *id
); /* event id (output) */
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_enum(int sock
,
265 int session_objd
, /* session descriptor */
266 const char *enum_name
, /* enum name (input) */
267 size_t nr_entries
, /* entries */
268 const struct lttng_enum_entry
*entries
,
269 uint64_t *id
); /* enum id (output) */
272 * Returns 0 on success, negative error value on error.
273 * Returns -EPIPE or -ECONNRESET if other end has hung up.
275 int ustcomm_register_channel(int sock
,
276 struct lttng_session
*session
,
277 int session_objd
, /* session descriptor */
278 int channel_objd
, /* channel descriptor */
279 size_t nr_ctx_fields
,
280 const struct lttng_ctx_field
*ctx_fields
,
281 uint32_t *chan_id
, /* channel id (output) */
282 int *header_type
); /* header type (output) */
284 int ustcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
285 int ustcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
287 #endif /* _LTTNG_UST_COMM_H */