Implement capturing payload on event notifiers
[lttng-ust.git] / include / ust-comm.h
CommitLineData
b35d179d
MD
1#ifndef _LTTNG_UST_COMM_H
2#define _LTTNG_UST_COMM_H
67c5b804
MD
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 *
15f672f9
MD
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,
67c5b804 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15f672f9
MD
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
67c5b804
MD
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
fb31eb73 29#include <stdint.h>
67c5b804 30#include <limits.h>
57773204 31#include <unistd.h>
4318ae1b 32#include <lttng/ust-abi.h>
7bc53e94 33#include <lttng/ust-error.h>
b3f60bbf 34#include <lttng/ust-compiler.h>
c785c634 35#include <lttng/ust-ctl.h>
67c5b804 36
db56acaf
MD
37#ifndef LTTNG_PACKED
38#error "LTTNG_PACKED should be defined"
39#endif
40
11ff9c7d 41/*
cf12a773
MD
42 * Default timeout the application waits for the sessiond to send its
43 * "register done" command. Can be overridden with the environment
69400ac4 44 * variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not
cf12a773 45 * found, the application proceeds directly without any delay.
11ff9c7d 46 */
2b4444ce 47#define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS CONFIG_LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS
11ff9c7d 48
751d4e91 49#define LTTNG_DEFAULT_RUNDIR LTTNG_SYSTEM_RUNDIR
32ce8569 50#define LTTNG_DEFAULT_HOME_RUNDIR ".lttng"
7fc90dca 51
67c5b804 52/* Queue size of listen(2) */
32ce8569
MD
53#define LTTNG_UST_COMM_MAX_LISTEN 10
54#define LTTNG_UST_COMM_REG_MSG_PADDING 64
55
56struct lttng_event_field;
83e43212 57struct lttng_ctx_field;
c785c634
MD
58struct lttng_enum_entry;
59struct lttng_integer_type;
60struct lttng_session;
32ce8569
MD
61
62struct ustctl_reg_msg {
63 uint32_t magic;
64 uint32_t major;
65 uint32_t minor;
66 uint32_t pid;
67 uint32_t ppid;
68 uint32_t uid;
69 uint32_t gid;
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];
79} LTTNG_PACKED;
67c5b804 80
67c5b804 81/*
e7723462 82 * Data structure for the commands sent from sessiond to UST.
67c5b804 83 */
32ce8569
MD
84#define USTCOMM_MSG_PADDING1 32
85#define USTCOMM_MSG_PADDING2 32
57773204 86struct ustcomm_ust_msg {
1ece9766 87 uint32_t handle;
46050b1a 88 uint32_t cmd;
32ce8569 89 char padding[USTCOMM_MSG_PADDING1];
67c5b804 90 union {
d8d2416d 91 struct lttng_ust_event_notifier event_notifier;
1ece9766 92 struct lttng_ust_channel channel;
381c0f1e 93 struct lttng_ust_stream stream;
1ece9766
MD
94 struct lttng_ust_event event;
95 struct lttng_ust_context context;
57773204 96 struct lttng_ust_tracer_version version;
cbef6901 97 struct lttng_ust_tracepoint_iter tracepoint;
2d78951a 98 struct {
2734ca65
CB
99 uint32_t data_size; /* following filter data */
100 uint32_t reloc_offset;
3f6fd224 101 uint64_t seqnum;
b3f60bbf 102 } LTTNG_PACKED filter;
75582b3a
JI
103 struct {
104 uint32_t count; /* how many names follow */
105 } LTTNG_PACKED exclusion;
d37ecb3f
FD
106 struct {
107 uint32_t data_size; /* following capture data */
108 uint32_t reloc_offset;
109 uint64_t seqnum;
110 } LTTNG_PACKED capture;
32ce8569 111 char padding[USTCOMM_MSG_PADDING2];
67c5b804 112 } u;
b3f60bbf 113} LTTNG_PACKED;
67c5b804 114
9eb62b9c
MD
115/*
116 * Data structure for the response from UST to the session daemon.
117 * cmd_type is sent back in the reply for validation.
118 */
32ce8569
MD
119#define USTCOMM_REPLY_PADDING1 32
120#define USTCOMM_REPLY_PADDING2 32
57773204 121struct ustcomm_ust_reply {
46050b1a
MD
122 uint32_t handle;
123 uint32_t cmd;
7f2348b8 124 int32_t ret_code; /* enum ustcomm_return_code */
1ece9766 125 uint32_t ret_val; /* return value */
32ce8569 126 char padding[USTCOMM_REPLY_PADDING1];
9eb62b9c 127 union {
193183fb
MD
128 struct {
129 uint64_t memory_map_size;
b3f60bbf 130 } LTTNG_PACKED channel;
381c0f1e
MD
131 struct {
132 uint64_t memory_map_size;
b3f60bbf 133 } LTTNG_PACKED stream;
57773204 134 struct lttng_ust_tracer_version version;
cbef6901 135 struct lttng_ust_tracepoint_iter tracepoint;
32ce8569 136 char padding[USTCOMM_REPLY_PADDING2];
9eb62b9c 137 } u;
b3f60bbf 138} LTTNG_PACKED;
9eb62b9c 139
32ce8569
MD
140struct ustcomm_notify_hdr {
141 uint32_t notify_cmd;
142} LTTNG_PACKED;
143
144#define USTCOMM_NOTIFY_EVENT_MSG_PADDING 32
145struct ustcomm_notify_event_msg {
146 uint32_t session_objd;
147 uint32_t channel_objd;
148 char event_name[LTTNG_UST_SYM_NAME_LEN];
149 int32_t loglevel;
150 uint32_t signature_len;
151 uint32_t fields_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 */
155} LTTNG_PACKED;
156
157#define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
158struct ustcomm_notify_event_reply {
159 int32_t ret_code; /* 0: ok, negative: error code */
160 uint32_t event_id;
161 char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING];
162} LTTNG_PACKED;
163
c785c634
MD
164#define USTCOMM_NOTIFY_ENUM_MSG_PADDING 32
165struct 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 */
171} LTTNG_PACKED;
172
173#define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
174struct ustcomm_notify_enum_reply {
175 int32_t ret_code; /* 0: ok, negative: error code */
176 uint64_t enum_id;
177 char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING];
178} LTTNG_PACKED;
179
32ce8569
MD
180#define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32
181struct 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 */
187} LTTNG_PACKED;
188
189#define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32
190struct ustcomm_notify_channel_reply {
191 int32_t ret_code; /* 0: ok, negative: error code */
192 uint32_t chan_id;
193 uint32_t header_type; /* enum ustctl_channel_header */
194 char padding[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING];
195} LTTNG_PACKED;
196
40003310
MD
197/*
198 * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
199 * struct lttng_ust_field_iter field.
200 */
201
57773204 202extern int ustcomm_create_unix_sock(const char *pathname);
451d66b2
MD
203extern int ustcomm_connect_unix_sock(const char *pathname,
204 long timeout);
57773204
MD
205extern int ustcomm_accept_unix_sock(int sock);
206extern int ustcomm_listen_unix_sock(int sock);
207extern int ustcomm_close_unix_sock(int sock);
74d81a6c 208
57773204 209extern ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len);
32ce8569 210extern ssize_t ustcomm_send_unix_sock(int sock, const void *buf, size_t len);
74d81a6c
MD
211extern ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
212extern ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);
213
57773204
MD
214extern const char *ustcomm_get_readable_code(int code);
215extern int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum);
216extern int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur,
217 uint32_t expected_handle, uint32_t expected_cmd);
218extern int ustcomm_send_app_cmd(int sock,
219 struct ustcomm_ust_msg *lum,
220 struct ustcomm_ust_reply *lur);
221int ustcomm_recv_fd(int sock);
67c5b804 222
74d81a6c 223ssize_t ustcomm_recv_channel_from_sessiond(int sock,
ff0f5728 224 void **chan_data, uint64_t len, int *wakeup_fd);
74d81a6c
MD
225int ustcomm_recv_stream_from_sessiond(int sock,
226 uint64_t *memory_map_size,
227 int *shm_fd, int *wakeup_fd);
d8d2416d
FD
228ssize_t ustcomm_recv_event_notifier_notif_fd_from_sessiond(int sock,
229 int *event_notifier_notif_fd);
74d81a6c 230
32ce8569
MD
231/*
232 * Returns 0 on success, negative error value on error.
233 * Returns -EPIPE or -ECONNRESET if other end has hung up.
234 */
235int 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);
243
244/*
245 * Returns 0 on success, negative error value on error.
246 * Returns -EPIPE or -ECONNRESET if other end has hung up.
247 */
248int ustcomm_register_event(int sock,
c785c634 249 struct lttng_session *session,
32ce8569
MD
250 int session_objd, /* session descriptor */
251 int channel_objd, /* channel descriptor */
252 const char *event_name, /* event name (input) */
253 int loglevel,
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) */
259
c785c634
MD
260/*
261 * Returns 0 on success, negative error value on error.
262 * Returns -EPIPE or -ECONNRESET if other end has hung up.
263 */
264int 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) */
270
32ce8569
MD
271/*
272 * Returns 0 on success, negative error value on error.
273 * Returns -EPIPE or -ECONNRESET if other end has hung up.
274 */
275int ustcomm_register_channel(int sock,
53569322 276 struct lttng_session *session,
32ce8569
MD
277 int session_objd, /* session descriptor */
278 int channel_objd, /* channel descriptor */
279 size_t nr_ctx_fields,
83e43212 280 const struct lttng_ctx_field *ctx_fields,
32ce8569
MD
281 uint32_t *chan_id, /* channel id (output) */
282 int *header_type); /* header type (output) */
283
ff517991
MD
284int ustcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
285int ustcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
286
b35d179d 287#endif /* _LTTNG_UST_COMM_H */
This page took 0.044365 seconds and 4 git commands to generate.