Fix: allocate ts_end in ringbuffer shared memory
[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
11ff9c7d 37/*
cf12a773
MD
38 * Default timeout the application waits for the sessiond to send its
39 * "register done" command. Can be overridden with the environment
69400ac4 40 * variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not
cf12a773 41 * found, the application proceeds directly without any delay.
11ff9c7d 42 */
2b4444ce 43#define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS CONFIG_LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS
11ff9c7d 44
751d4e91 45#define LTTNG_DEFAULT_RUNDIR LTTNG_SYSTEM_RUNDIR
32ce8569 46#define LTTNG_DEFAULT_HOME_RUNDIR ".lttng"
7fc90dca 47
67c5b804 48/* Queue size of listen(2) */
32ce8569
MD
49#define LTTNG_UST_COMM_MAX_LISTEN 10
50#define LTTNG_UST_COMM_REG_MSG_PADDING 64
51
52struct lttng_event_field;
83e43212 53struct lttng_ctx_field;
c785c634
MD
54struct lttng_enum_entry;
55struct lttng_integer_type;
56struct lttng_session;
32ce8569
MD
57
58struct ustctl_reg_msg {
59 uint32_t magic;
60 uint32_t major;
61 uint32_t minor;
62 uint32_t pid;
63 uint32_t ppid;
64 uint32_t uid;
65 uint32_t gid;
66 uint32_t bits_per_long;
67 uint32_t uint8_t_alignment;
68 uint32_t uint16_t_alignment;
69 uint32_t uint32_t_alignment;
70 uint32_t uint64_t_alignment;
71 uint32_t long_alignment;
72 uint32_t socket_type; /* enum ustctl_socket_type */
73 char name[LTTNG_UST_ABI_PROCNAME_LEN]; /* process name */
74 char padding[LTTNG_UST_COMM_REG_MSG_PADDING];
75} LTTNG_PACKED;
67c5b804 76
67c5b804 77/*
e7723462 78 * Data structure for the commands sent from sessiond to UST.
67c5b804 79 */
32ce8569
MD
80#define USTCOMM_MSG_PADDING1 32
81#define USTCOMM_MSG_PADDING2 32
57773204 82struct ustcomm_ust_msg {
1ece9766 83 uint32_t handle;
46050b1a 84 uint32_t cmd;
32ce8569 85 char padding[USTCOMM_MSG_PADDING1];
67c5b804 86 union {
1ece9766 87 struct lttng_ust_channel channel;
381c0f1e 88 struct lttng_ust_stream stream;
1ece9766
MD
89 struct lttng_ust_event event;
90 struct lttng_ust_context context;
57773204 91 struct lttng_ust_tracer_version version;
cbef6901 92 struct lttng_ust_tracepoint_iter tracepoint;
2d78951a 93 struct {
2734ca65
CB
94 uint32_t data_size; /* following filter data */
95 uint32_t reloc_offset;
3f6fd224 96 uint64_t seqnum;
b3f60bbf 97 } LTTNG_PACKED filter;
75582b3a
JI
98 struct {
99 uint32_t count; /* how many names follow */
100 } LTTNG_PACKED exclusion;
32ce8569 101 char padding[USTCOMM_MSG_PADDING2];
67c5b804 102 } u;
b3f60bbf 103} LTTNG_PACKED;
67c5b804 104
9eb62b9c
MD
105/*
106 * Data structure for the response from UST to the session daemon.
107 * cmd_type is sent back in the reply for validation.
108 */
32ce8569
MD
109#define USTCOMM_REPLY_PADDING1 32
110#define USTCOMM_REPLY_PADDING2 32
57773204 111struct ustcomm_ust_reply {
46050b1a
MD
112 uint32_t handle;
113 uint32_t cmd;
7f2348b8 114 int32_t ret_code; /* enum ustcomm_return_code */
1ece9766 115 uint32_t ret_val; /* return value */
32ce8569 116 char padding[USTCOMM_REPLY_PADDING1];
9eb62b9c 117 union {
193183fb
MD
118 struct {
119 uint64_t memory_map_size;
b3f60bbf 120 } LTTNG_PACKED channel;
381c0f1e
MD
121 struct {
122 uint64_t memory_map_size;
b3f60bbf 123 } LTTNG_PACKED stream;
57773204 124 struct lttng_ust_tracer_version version;
cbef6901 125 struct lttng_ust_tracepoint_iter tracepoint;
32ce8569 126 char padding[USTCOMM_REPLY_PADDING2];
9eb62b9c 127 } u;
b3f60bbf 128} LTTNG_PACKED;
9eb62b9c 129
32ce8569
MD
130struct ustcomm_notify_hdr {
131 uint32_t notify_cmd;
132} LTTNG_PACKED;
133
134#define USTCOMM_NOTIFY_EVENT_MSG_PADDING 32
135struct ustcomm_notify_event_msg {
136 uint32_t session_objd;
137 uint32_t channel_objd;
138 char event_name[LTTNG_UST_SYM_NAME_LEN];
139 int32_t loglevel;
140 uint32_t signature_len;
141 uint32_t fields_len;
142 uint32_t model_emf_uri_len;
143 char padding[USTCOMM_NOTIFY_EVENT_MSG_PADDING];
144 /* followed by signature, fields, and model_emf_uri */
145} LTTNG_PACKED;
146
147#define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
148struct ustcomm_notify_event_reply {
149 int32_t ret_code; /* 0: ok, negative: error code */
150 uint32_t event_id;
151 char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING];
152} LTTNG_PACKED;
153
c785c634
MD
154#define USTCOMM_NOTIFY_ENUM_MSG_PADDING 32
155struct ustcomm_notify_enum_msg {
156 uint32_t session_objd;
157 char enum_name[LTTNG_UST_SYM_NAME_LEN];
158 uint32_t entries_len;
159 char padding[USTCOMM_NOTIFY_ENUM_MSG_PADDING];
160 /* followed by enum entries */
161} LTTNG_PACKED;
162
163#define USTCOMM_NOTIFY_EVENT_REPLY_PADDING 32
164struct ustcomm_notify_enum_reply {
165 int32_t ret_code; /* 0: ok, negative: error code */
166 uint64_t enum_id;
167 char padding[USTCOMM_NOTIFY_EVENT_REPLY_PADDING];
168} LTTNG_PACKED;
169
32ce8569
MD
170#define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING 32
171struct ustcomm_notify_channel_msg {
172 uint32_t session_objd;
173 uint32_t channel_objd;
174 uint32_t ctx_fields_len;
175 char padding[USTCOMM_NOTIFY_CHANNEL_MSG_PADDING];
176 /* followed by context fields */
177} LTTNG_PACKED;
178
179#define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING 32
180struct ustcomm_notify_channel_reply {
181 int32_t ret_code; /* 0: ok, negative: error code */
182 uint32_t chan_id;
183 uint32_t header_type; /* enum ustctl_channel_header */
184 char padding[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING];
185} LTTNG_PACKED;
186
40003310
MD
187/*
188 * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
189 * struct lttng_ust_field_iter field.
190 */
191
57773204 192extern int ustcomm_create_unix_sock(const char *pathname);
451d66b2
MD
193extern int ustcomm_connect_unix_sock(const char *pathname,
194 long timeout);
57773204
MD
195extern int ustcomm_accept_unix_sock(int sock);
196extern int ustcomm_listen_unix_sock(int sock);
197extern int ustcomm_close_unix_sock(int sock);
74d81a6c 198
57773204 199extern ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len);
32ce8569 200extern ssize_t ustcomm_send_unix_sock(int sock, const void *buf, size_t len);
74d81a6c
MD
201extern ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
202extern ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);
203
57773204
MD
204extern const char *ustcomm_get_readable_code(int code);
205extern int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum);
206extern int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur,
207 uint32_t expected_handle, uint32_t expected_cmd);
208extern int ustcomm_send_app_cmd(int sock,
209 struct ustcomm_ust_msg *lum,
210 struct ustcomm_ust_reply *lur);
211int ustcomm_recv_fd(int sock);
67c5b804 212
74d81a6c 213ssize_t ustcomm_recv_channel_from_sessiond(int sock,
ff0f5728 214 void **chan_data, uint64_t len, int *wakeup_fd);
74d81a6c
MD
215int ustcomm_recv_stream_from_sessiond(int sock,
216 uint64_t *memory_map_size,
217 int *shm_fd, int *wakeup_fd);
218
32ce8569
MD
219/*
220 * Returns 0 on success, negative error value on error.
221 * Returns -EPIPE or -ECONNRESET if other end has hung up.
222 */
223int ustcomm_send_reg_msg(int sock,
224 enum ustctl_socket_type type,
225 uint32_t bits_per_long,
226 uint32_t uint8_t_alignment,
227 uint32_t uint16_t_alignment,
228 uint32_t uint32_t_alignment,
229 uint32_t uint64_t_alignment,
230 uint32_t long_alignment);
231
232/*
233 * Returns 0 on success, negative error value on error.
234 * Returns -EPIPE or -ECONNRESET if other end has hung up.
235 */
236int ustcomm_register_event(int sock,
c785c634 237 struct lttng_session *session,
32ce8569
MD
238 int session_objd, /* session descriptor */
239 int channel_objd, /* channel descriptor */
240 const char *event_name, /* event name (input) */
241 int loglevel,
242 const char *signature, /* event signature (input) */
243 size_t nr_fields, /* fields */
244 const struct lttng_event_field *fields,
245 const char *model_emf_uri,
246 uint32_t *id); /* event id (output) */
247
c785c634
MD
248/*
249 * Returns 0 on success, negative error value on error.
250 * Returns -EPIPE or -ECONNRESET if other end has hung up.
251 */
252int ustcomm_register_enum(int sock,
253 int session_objd, /* session descriptor */
254 const char *enum_name, /* enum name (input) */
255 size_t nr_entries, /* entries */
256 const struct lttng_enum_entry *entries,
257 uint64_t *id); /* enum id (output) */
258
32ce8569
MD
259/*
260 * Returns 0 on success, negative error value on error.
261 * Returns -EPIPE or -ECONNRESET if other end has hung up.
262 */
263int ustcomm_register_channel(int sock,
53569322 264 struct lttng_session *session,
32ce8569
MD
265 int session_objd, /* session descriptor */
266 int channel_objd, /* channel descriptor */
267 size_t nr_ctx_fields,
83e43212 268 const struct lttng_ctx_field *ctx_fields,
32ce8569
MD
269 uint32_t *chan_id, /* channel id (output) */
270 int *header_type); /* header type (output) */
271
ff517991
MD
272int ustcomm_setsockopt_rcv_timeout(int sock, unsigned int msec);
273int ustcomm_setsockopt_snd_timeout(int sock, unsigned int msec);
274
b35d179d 275#endif /* _LTTNG_UST_COMM_H */
This page took 0.04522 seconds and 4 git commands to generate.