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