Implement event notifier
[deliverable/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;
32ce8569 106 char padding[USTCOMM_MSG_PADDING2];
67c5b804 107 } u;
b3f60bbf 108} LTTNG_PACKED;
67c5b804 109
9eb62b9c
MD
110/*
111 * Data structure for the response from UST to the session daemon.
112 * cmd_type is sent back in the reply for validation.
113 */
32ce8569
MD
114#define USTCOMM_REPLY_PADDING1 32
115#define USTCOMM_REPLY_PADDING2 32
57773204 116struct ustcomm_ust_reply {
46050b1a
MD
117 uint32_t handle;
118 uint32_t cmd;
7f2348b8 119 int32_t ret_code; /* enum ustcomm_return_code */
1ece9766 120 uint32_t ret_val; /* return value */
32ce8569 121 char padding[USTCOMM_REPLY_PADDING1];
9eb62b9c 122 union {
193183fb
MD
123 struct {
124 uint64_t memory_map_size;
b3f60bbf 125 } LTTNG_PACKED channel;
381c0f1e
MD
126 struct {
127 uint64_t memory_map_size;
b3f60bbf 128 } LTTNG_PACKED stream;
57773204 129 struct lttng_ust_tracer_version version;
cbef6901 130 struct lttng_ust_tracepoint_iter tracepoint;
32ce8569 131 char padding[USTCOMM_REPLY_PADDING2];
9eb62b9c 132 } u;
b3f60bbf 133} LTTNG_PACKED;
9eb62b9c 134
32ce8569
MD
135struct ustcomm_notify_hdr {
136 uint32_t notify_cmd;
137} LTTNG_PACKED;
138
139#define USTCOMM_NOTIFY_EVENT_MSG_PADDING 32
140struct ustcomm_notify_event_msg {
141 uint32_t session_objd;
142 uint32_t channel_objd;
143 char event_name[LTTNG_UST_SYM_NAME_LEN];
144 int32_t loglevel;
145 uint32_t signature_len;
146 uint32_t fields_len;
147 uint32_t model_emf_uri_len;
148 char padding[USTCOMM_NOTIFY_EVENT_MSG_PADDING];
149 /* followed by signature, fields, and model_emf_uri */
150} LTTNG_PACKED;
151
152#define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
153struct ustcomm_notify_event_reply {
154 int32_t ret_code; /* 0: ok, negative: error code */
155 uint32_t event_id;
156 char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING];
157} LTTNG_PACKED;
158
c785c634
MD
159#define USTCOMM_NOTIFY_ENUM_MSG_PADDING 32
160struct ustcomm_notify_enum_msg {
161 uint32_t session_objd;
162 char enum_name[LTTNG_UST_SYM_NAME_LEN];
163 uint32_t entries_len;
164 char padding[USTCOMM_NOTIFY_ENUM_MSG_PADDING];
165 /* followed by enum entries */
166} LTTNG_PACKED;
167
168#define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
169struct ustcomm_notify_enum_reply {
170 int32_t ret_code; /* 0: ok, negative: error code */
171 uint64_t enum_id;
172 char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING];
173} LTTNG_PACKED;
174
32ce8569
MD
175#define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32
176struct ustcomm_notify_channel_msg {
177 uint32_t session_objd;
178 uint32_t channel_objd;
179 uint32_t ctx_fields_len;
180 char padding[USTCOMM_NOTIFY_CHANNEL_MSG_PADDING];
181 /* followed by context fields */
182} LTTNG_PACKED;
183
184#define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32
185struct ustcomm_notify_channel_reply {
186 int32_t ret_code; /* 0: ok, negative: error code */
187 uint32_t chan_id;
188 uint32_t header_type; /* enum ustctl_channel_header */
189 char padding[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING];
190} LTTNG_PACKED;
191
40003310
MD
192/*
193 * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
194 * struct lttng_ust_field_iter field.
195 */
196
57773204 197extern int ustcomm_create_unix_sock(const char *pathname);
451d66b2
MD
198extern int ustcomm_connect_unix_sock(const char *pathname,
199 long timeout);
57773204
MD
200extern int ustcomm_accept_unix_sock(int sock);
201extern int ustcomm_listen_unix_sock(int sock);
202extern int ustcomm_close_unix_sock(int sock);
74d81a6c 203
57773204 204extern ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len);
32ce8569 205extern ssize_t ustcomm_send_unix_sock(int sock, const void *buf, size_t len);
74d81a6c
MD
206extern ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
207extern ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);
208
57773204
MD
209extern const char *ustcomm_get_readable_code(int code);
210extern int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum);
211extern int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur,
212 uint32_t expected_handle, uint32_t expected_cmd);
213extern int ustcomm_send_app_cmd(int sock,
214 struct ustcomm_ust_msg *lum,
215 struct ustcomm_ust_reply *lur);
216int ustcomm_recv_fd(int sock);
67c5b804 217
74d81a6c 218ssize_t ustcomm_recv_channel_from_sessiond(int sock,
ff0f5728 219 void **chan_data, uint64_t len, int *wakeup_fd);
74d81a6c
MD
220int ustcomm_recv_stream_from_sessiond(int sock,
221 uint64_t *memory_map_size,
222 int *shm_fd, int *wakeup_fd);
d8d2416d
FD
223ssize_t ustcomm_recv_event_notifier_notif_fd_from_sessiond(int sock,
224 int *event_notifier_notif_fd);
74d81a6c 225
32ce8569
MD
226/*
227 * Returns 0 on success, negative error value on error.
228 * Returns -EPIPE or -ECONNRESET if other end has hung up.
229 */
230int ustcomm_send_reg_msg(int sock,
231 enum ustctl_socket_type type,
232 uint32_t bits_per_long,
233 uint32_t uint8_t_alignment,
234 uint32_t uint16_t_alignment,
235 uint32_t uint32_t_alignment,
236 uint32_t uint64_t_alignment,
237 uint32_t long_alignment);
238
239/*
240 * Returns 0 on success, negative error value on error.
241 * Returns -EPIPE or -ECONNRESET if other end has hung up.
242 */
243int ustcomm_register_event(int sock,
c785c634 244 struct lttng_session *session,
32ce8569
MD
245 int session_objd, /* session descriptor */
246 int channel_objd, /* channel descriptor */
247 const char *event_name, /* event name (input) */
248 int loglevel,
249 const char *signature, /* event signature (input) */
250 size_t nr_fields, /* fields */
251 const struct lttng_event_field *fields,
252 const char *model_emf_uri,
253 uint32_t *id); /* event id (output) */
254
c785c634
MD
255/*
256 * Returns 0 on success, negative error value on error.
257 * Returns -EPIPE or -ECONNRESET if other end has hung up.
258 */
259int ustcomm_register_enum(int sock,
260 int session_objd, /* session descriptor */
261 const char *enum_name, /* enum name (input) */
262 size_t nr_entries, /* entries */
263 const struct lttng_enum_entry *entries,
264 uint64_t *id); /* enum id (output) */
265
32ce8569
MD
266/*
267 * Returns 0 on success, negative error value on error.
268 * Returns -EPIPE or -ECONNRESET if other end has hung up.
269 */
270int ustcomm_register_channel(int sock,
53569322 271 struct lttng_session *session,
32ce8569
MD
272 int session_objd, /* session descriptor */
273 int channel_objd, /* channel descriptor */
274 size_t nr_ctx_fields,
83e43212 275 const struct lttng_ctx_field *ctx_fields,
32ce8569
MD
276 uint32_t *chan_id, /* channel id (output) */
277 int *header_type); /* header type (output) */
278
ff517991
MD
279int ustcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
280int ustcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
281
b35d179d 282#endif /* _LTTNG_UST_COMM_H */
This page took 0.051505 seconds and 5 git commands to generate.