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 struct lttng_ust_counter counter
;
112 struct lttng_ust_counter_global counter_global
;
113 struct lttng_ust_counter_cpu counter_cpu
;
114 char padding
[USTCOMM_MSG_PADDING2
];
119 * Data structure for the response from UST to the session daemon.
120 * cmd_type is sent back in the reply for validation.
122 #define USTCOMM_REPLY_PADDING1 32
123 #define USTCOMM_REPLY_PADDING2 32
124 struct ustcomm_ust_reply
{
127 int32_t ret_code
; /* enum ustcomm_return_code */
128 uint32_t ret_val
; /* return value */
129 char padding
[USTCOMM_REPLY_PADDING1
];
132 uint64_t memory_map_size
;
133 } LTTNG_PACKED channel
;
135 uint64_t memory_map_size
;
136 } LTTNG_PACKED stream
;
137 struct lttng_ust_tracer_version version
;
138 struct lttng_ust_tracepoint_iter tracepoint
;
139 char padding
[USTCOMM_REPLY_PADDING2
];
143 struct ustcomm_notify_hdr
{
147 #define USTCOMM_NOTIFY_EVENT_MSG_PADDING 32
148 struct ustcomm_notify_event_msg
{
149 uint32_t session_objd
;
150 uint32_t channel_objd
;
151 char event_name
[LTTNG_UST_SYM_NAME_LEN
];
153 uint32_t signature_len
;
155 uint32_t model_emf_uri_len
;
156 char padding
[USTCOMM_NOTIFY_EVENT_MSG_PADDING
];
157 /* followed by signature, fields, and model_emf_uri */
160 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
161 struct ustcomm_notify_event_reply
{
162 int32_t ret_code
; /* 0: ok, negative: error code */
164 char padding
[USTCOMM_NOTIFY_EVENT_REPLY_PADDING
];
167 #define USTCOMM_NOTIFY_ENUM_MSG_PADDING 32
168 struct ustcomm_notify_enum_msg
{
169 uint32_t session_objd
;
170 char enum_name
[LTTNG_UST_SYM_NAME_LEN
];
171 uint32_t entries_len
;
172 char padding
[USTCOMM_NOTIFY_ENUM_MSG_PADDING
];
173 /* followed by enum entries */
176 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
177 struct ustcomm_notify_enum_reply
{
178 int32_t ret_code
; /* 0: ok, negative: error code */
180 char padding
[USTCOMM_NOTIFY_EVENT_REPLY_PADDING
];
183 #define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32
184 struct ustcomm_notify_channel_msg
{
185 uint32_t session_objd
;
186 uint32_t channel_objd
;
187 uint32_t ctx_fields_len
;
188 char padding
[USTCOMM_NOTIFY_CHANNEL_MSG_PADDING
];
189 /* followed by context fields */
192 #define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32
193 struct ustcomm_notify_channel_reply
{
194 int32_t ret_code
; /* 0: ok, negative: error code */
196 uint32_t header_type
; /* enum ustctl_channel_header */
197 char padding
[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING
];
201 * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
202 * struct lttng_ust_field_iter field.
205 extern int ustcomm_create_unix_sock(const char *pathname
);
206 extern int ustcomm_connect_unix_sock(const char *pathname
,
208 extern int ustcomm_accept_unix_sock(int sock
);
209 extern int ustcomm_listen_unix_sock(int sock
);
210 extern int ustcomm_close_unix_sock(int sock
);
212 extern ssize_t
ustcomm_recv_unix_sock(int sock
, void *buf
, size_t len
);
213 extern ssize_t
ustcomm_send_unix_sock(int sock
, const void *buf
, size_t len
);
214 extern ssize_t
ustcomm_send_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
215 extern ssize_t
ustcomm_recv_fds_unix_sock(int sock
, int *fds
, size_t nb_fd
);
217 extern const char *ustcomm_get_readable_code(int code
);
218 extern int ustcomm_send_app_msg(int sock
, struct ustcomm_ust_msg
*lum
);
219 extern int ustcomm_recv_app_reply(int sock
, struct ustcomm_ust_reply
*lur
,
220 uint32_t expected_handle
, uint32_t expected_cmd
);
221 extern int ustcomm_send_app_cmd(int sock
,
222 struct ustcomm_ust_msg
*lum
,
223 struct ustcomm_ust_reply
*lur
);
224 int ustcomm_recv_fd(int sock
);
226 ssize_t
ustcomm_recv_channel_from_sessiond(int sock
,
227 void **chan_data
, uint64_t len
, int *wakeup_fd
);
228 int ustcomm_recv_stream_from_sessiond(int sock
,
229 uint64_t *memory_map_size
,
230 int *shm_fd
, int *wakeup_fd
);
231 ssize_t
ustcomm_recv_event_notifier_notif_fd_from_sessiond(int sock
,
232 int *event_notifier_notif_fd
);
234 ssize_t
ustcomm_recv_counter_from_sessiond(int sock
,
235 void **counter_data
, uint64_t len
);
236 int ustcomm_recv_counter_shm_from_sessiond(int sock
,
240 * Returns 0 on success, negative error value on error.
241 * Returns -EPIPE or -ECONNRESET if other end has hung up.
243 int ustcomm_send_reg_msg(int sock
,
244 enum ustctl_socket_type type
,
245 uint32_t bits_per_long
,
246 uint32_t uint8_t_alignment
,
247 uint32_t uint16_t_alignment
,
248 uint32_t uint32_t_alignment
,
249 uint32_t uint64_t_alignment
,
250 uint32_t long_alignment
);
253 * Returns 0 on success, negative error value on error.
254 * Returns -EPIPE or -ECONNRESET if other end has hung up.
256 int ustcomm_register_event(int sock
,
257 struct lttng_session
*session
,
258 int session_objd
, /* session descriptor */
259 int channel_objd
, /* channel descriptor */
260 const char *event_name
, /* event name (input) */
262 const char *signature
, /* event signature (input) */
263 size_t nr_fields
, /* fields */
264 const struct lttng_event_field
*fields
,
265 const char *model_emf_uri
,
266 uint32_t *id
); /* event id (output) */
269 * Returns 0 on success, negative error value on error.
270 * Returns -EPIPE or -ECONNRESET if other end has hung up.
272 int ustcomm_register_enum(int sock
,
273 int session_objd
, /* session descriptor */
274 const char *enum_name
, /* enum name (input) */
275 size_t nr_entries
, /* entries */
276 const struct lttng_enum_entry
*entries
,
277 uint64_t *id
); /* enum id (output) */
280 * Returns 0 on success, negative error value on error.
281 * Returns -EPIPE or -ECONNRESET if other end has hung up.
283 int ustcomm_register_channel(int sock
,
284 struct lttng_session
*session
,
285 int session_objd
, /* session descriptor */
286 int channel_objd
, /* channel descriptor */
287 size_t nr_ctx_fields
,
288 const struct lttng_ctx_field
*ctx_fields
,
289 uint32_t *chan_id
, /* channel id (output) */
290 int *header_type
); /* header type (output) */
292 int ustcomm_setsockopt_rcv_timeout(int sock
, unsigned int msec
);
293 int ustcomm_setsockopt_snd_timeout(int sock
, unsigned int msec
);
295 #endif /* _LTTNG_UST_COMM_H */