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