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