src/common/ustcomm.h

   1 /*
   2  * SPDX-License-Identifier: LGPL-2.1-only
   3  *
   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>
   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
  14 #ifndef _UST_COMMON_UST_COMM_H
  15 #define _UST_COMMON_UST_COMM_H
  16
  17 #include <stdint.h>
  18 #include <limits.h>
  19 #include <unistd.h>
  20 #include <lttng/ust-abi.h>
  21 #include <lttng/ust-error.h>
  22 #include <lttng/ust-compiler.h>
  23 #include <lttng/ust-ctl.h>
  24
  25 /*
  26  * Default timeout the application waits for the sessiond to send its
  27  * "register done" command. Can be overridden with the environment
  28  * variable "LTTNG_UST_REGISTER_TIMEOUT". Note that if the sessiond is not
  29  * found, the application proceeds directly without any delay.
  30  */
  31 #define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS        3000
  32
  33 #define LTTNG_DEFAULT_RUNDIR                            LTTNG_SYSTEM_RUNDIR
  34 #define LTTNG_DEFAULT_HOME_RUNDIR                       ".lttng"
  35
  36 /* Queue size of listen(2) */
  37 #define LTTNG_UST_COMM_MAX_LISTEN                       10
  38 #define LTTNG_UST_COMM_REG_MSG_PADDING                  64
  39
  40 struct lttng_ust_event_field;
  41 struct lttng_ust_ctx_field;
  42 struct lttng_ust_enum_entry;
  43 struct lttng_integer_type;
  44 struct lttng_ust_session;
  45
  46 struct lttng_ust_ctl_reg_msg {
  47         uint32_t magic;
  48         uint32_t major;
  49         uint32_t minor;
  50         uint32_t pid;
  51         uint32_t ppid;
  52         uint32_t uid;
  53         uint32_t gid;
  54         uint32_t bits_per_long;
  55         uint32_t uint8_t_alignment;
  56         uint32_t uint16_t_alignment;
  57         uint32_t uint32_t_alignment;
  58         uint32_t uint64_t_alignment;
  59         uint32_t long_alignment;
  60         uint32_t socket_type;                   /* enum lttng_ust_ctl_socket_type */
  61         char name[LTTNG_UST_ABI_PROCNAME_LEN];  /* process name */
  62         char padding[LTTNG_UST_COMM_REG_MSG_PADDING];
  63 } __attribute__((packed));
  64
  65 /*
  66  * Data structure for the commands sent from sessiond to UST.
  67  */
  68 #define USTCOMM_MSG_PADDING1            32
  69 #define USTCOMM_MSG_PADDING2            32
  70 struct ustcomm_ust_msg {
  71         uint32_t handle;
  72         uint32_t cmd;
  73         char padding[USTCOMM_MSG_PADDING1];
  74         union {
  75                 struct lttng_ust_abi_channel channel;
  76                 struct lttng_ust_abi_stream stream;
  77                 struct lttng_ust_abi_event event;
  78                 struct lttng_ust_abi_context context;
  79                 struct lttng_ust_abi_tracer_version version;
  80                 struct lttng_ust_abi_tracepoint_iter tracepoint;
  81                 struct {
  82                         uint32_t data_size;     /* following filter data */
  83                         uint32_t reloc_offset;
  84                         uint64_t seqnum;
  85                 } __attribute__((packed)) filter;
  86                 struct {
  87                         uint32_t count; /* how many names follow */
  88                 } __attribute__((packed)) exclusion;
  89                 struct {
  90                         uint32_t data_size;     /* following capture data */
  91                         uint32_t reloc_offset;
  92                         uint64_t seqnum;
  93                 } __attribute__((packed)) capture;
  94                 struct lttng_ust_abi_counter counter;
  95                 struct lttng_ust_abi_counter_global counter_global;
  96                 struct lttng_ust_abi_counter_cpu counter_cpu;
  97                 /*
  98                  * For lttng_ust_abi_EVENT_NOTIFIER_CREATE, a struct
  99                  * lttng_ust_abi_event_notifier implicitly follows struct
 100                  * ustcomm_ust_msg.
 101                  */
 102                 struct {
 103                         /* Length of struct lttng_ust_abi_event_notifier */
 104                         uint32_t len;
 105                 } event_notifier;
 106                 char padding[USTCOMM_MSG_PADDING2];
 107         } u;
 108 } __attribute__((packed));
 109
 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  */
 114 #define USTCOMM_REPLY_PADDING1          32
 115 #define USTCOMM_REPLY_PADDING2          32
 116 struct ustcomm_ust_reply {
 117         uint32_t handle;
 118         uint32_t cmd;
 119         int32_t ret_code;       /* enum ustcomm_return_code */
 120         uint32_t ret_val;       /* return value */
 121         char padding[USTCOMM_REPLY_PADDING1];
 122         union {
 123                 struct {
 124                         uint64_t memory_map_size;
 125                 } __attribute__((packed)) channel;
 126                 struct {
 127                         uint64_t memory_map_size;
 128                 } __attribute__((packed)) stream;
 129                 struct lttng_ust_abi_tracer_version version;
 130                 struct lttng_ust_abi_tracepoint_iter tracepoint;
 131                 char padding[USTCOMM_REPLY_PADDING2];
 132         } u;
 133 } __attribute__((packed));
 134
 135 struct ustcomm_notify_hdr {
 136         uint32_t notify_cmd;
 137 } __attribute__((packed));
 138
 139 #define USTCOMM_NOTIFY_EVENT_MSG_PADDING        32
 140 struct ustcomm_notify_event_msg {
 141         uint32_t session_objd;
 142         uint32_t channel_objd;
 143         char event_name[LTTNG_UST_ABI_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 } __attribute__((packed));
 151
 152 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING      32
 153 struct 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 } __attribute__((packed));
 158
 159 #define USTCOMM_NOTIFY_ENUM_MSG_PADDING         32
 160 struct ustcomm_notify_enum_msg {
 161         uint32_t session_objd;
 162         char enum_name[LTTNG_UST_ABI_SYM_NAME_LEN];
 163         uint32_t entries_len;
 164         char padding[USTCOMM_NOTIFY_ENUM_MSG_PADDING];
 165         /* followed by enum entries */
 166 } __attribute__((packed));
 167
 168 #define USTCOMM_NOTIFY_EVENT_REPLY_PADDING      32
 169 struct 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 } __attribute__((packed));
 174
 175 #define USTCOMM_NOTIFY_CHANNEL_MSG_PADDING      32
 176 struct 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 } __attribute__((packed));
 183
 184 #define USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING    32
 185 struct 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 lttng_ust_ctl_channel_header */
 189         char padding[USTCOMM_NOTIFY_CHANNEL_REPLY_PADDING];
 190 } __attribute__((packed));
 191
 192 /*
 193  * LTTNG_UST_TRACEPOINT_FIELD_LIST reply is followed by a
 194  * struct lttng_ust_field_iter field.
 195  */
 196
 197 int ustcomm_create_unix_sock(const char *pathname)
 198         __attribute__((visibility("hidden")));
 199
 200 int ustcomm_connect_unix_sock(const char *pathname,
 201         long timeout)
 202         __attribute__((visibility("hidden")));
 203
 204 int ustcomm_accept_unix_sock(int sock)
 205         __attribute__((visibility("hidden")));
 206
 207 int ustcomm_listen_unix_sock(int sock)
 208         __attribute__((visibility("hidden")));
 209
 210 int ustcomm_close_unix_sock(int sock)
 211         __attribute__((visibility("hidden")));
 212
 213 ssize_t ustcomm_recv_unix_sock(int sock, void *buf, size_t len)
 214         __attribute__((visibility("hidden")));
 215
 216 ssize_t ustcomm_send_unix_sock(int sock, const void *buf, size_t len)
 217         __attribute__((visibility("hidden")));
 218
 219 ssize_t ustcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd)
 220         __attribute__((visibility("hidden")));
 221
 222 ssize_t ustcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd)
 223         __attribute__((visibility("hidden")));
 224
 225 const char *ustcomm_get_readable_code(int code)
 226         __attribute__((visibility("hidden")));
 227
 228 int ustcomm_send_app_msg(int sock, struct ustcomm_ust_msg *lum)
 229         __attribute__((visibility("hidden")));
 230
 231 int ustcomm_recv_app_reply(int sock, struct ustcomm_ust_reply *lur,
 232         uint32_t expected_handle, uint32_t expected_cmd)
 233         __attribute__((visibility("hidden")));
 234
 235 int ustcomm_send_app_cmd(int sock,
 236                 struct ustcomm_ust_msg *lum,
 237                 struct ustcomm_ust_reply *lur)
 238         __attribute__((visibility("hidden")));
 239
 240 int ustcomm_recv_fd(int sock)
 241         __attribute__((visibility("hidden")));
 242
 243 ssize_t ustcomm_recv_channel_from_sessiond(int sock,
 244                 void **chan_data, uint64_t len, int *wakeup_fd)
 245         __attribute__((visibility("hidden")));
 246
 247 int ustcomm_recv_stream_from_sessiond(int sock,
 248                 uint64_t *memory_map_size,
 249                 int *shm_fd, int *wakeup_fd)
 250         __attribute__((visibility("hidden")));
 251
 252 ssize_t ustcomm_recv_event_notifier_notif_fd_from_sessiond(int sock,
 253                 int *event_notifier_notif_fd)
 254         __attribute__((visibility("hidden")));
 255
 256 ssize_t ustcomm_recv_counter_from_sessiond(int sock,
 257                 void **counter_data, uint64_t len)
 258         __attribute__((visibility("hidden")));
 259
 260 int ustcomm_recv_counter_shm_from_sessiond(int sock,
 261                 int *shm_fd)
 262         __attribute__((visibility("hidden")));
 263
 264 /*
 265  * Returns 0 on success, negative error value on error.
 266  * Returns -EPIPE or -ECONNRESET if other end has hung up.
 267  */
 268 int ustcomm_send_reg_msg(int sock,
 269                 enum lttng_ust_ctl_socket_type type,
 270                 uint32_t bits_per_long,
 271                 uint32_t uint8_t_alignment,
 272                 uint32_t uint16_t_alignment,
 273                 uint32_t uint32_t_alignment,
 274                 uint32_t uint64_t_alignment,
 275                 uint32_t long_alignment)
 276         __attribute__((visibility("hidden")));
 277
 278 /*
 279  * Returns 0 on success, negative error value on error.
 280  * Returns -EPIPE or -ECONNRESET if other end has hung up.
 281  */
 282 int ustcomm_register_event(int sock,
 283         struct lttng_ust_session *session,
 284         int session_objd,               /* session descriptor */
 285         int channel_objd,               /* channel descriptor */
 286         const char *event_name,         /* event name (input) */
 287         int loglevel,
 288         const char *signature,          /* event signature (input) */
 289         size_t nr_fields,               /* fields */
 290         const struct lttng_ust_event_field * const *fields,
 291         const char *model_emf_uri,
 292         uint32_t *id)                   /* event id (output) */
 293         __attribute__((visibility("hidden")));
 294
 295 /*
 296  * Returns 0 on success, negative error value on error.
 297  * Returns -EPIPE or -ECONNRESET if other end has hung up.
 298  */
 299 int ustcomm_register_enum(int sock,
 300         int session_objd,               /* session descriptor */
 301         const char *enum_name,          /* enum name (input) */
 302         size_t nr_entries,              /* entries */
 303         const struct lttng_ust_enum_entry * const *entries,
 304         uint64_t *id)                   /* enum id (output) */
 305         __attribute__((visibility("hidden")));
 306
 307 /*
 308  * Returns 0 on success, negative error value on error.
 309  * Returns -EPIPE or -ECONNRESET if other end has hung up.
 310  */
 311 int ustcomm_register_channel(int sock,
 312         struct lttng_ust_session *session,
 313         int session_objd,               /* session descriptor */
 314         int channel_objd,               /* channel descriptor */
 315         size_t nr_ctx_fields,
 316         struct lttng_ust_ctx_field *ctx_fields,
 317         uint32_t *chan_id,              /* channel id (output) */
 318         int *header_type)               /* header type (output) */
 319         __attribute__((visibility("hidden")));
 320
 321 int ustcomm_setsockopt_rcv_timeout(int sock, unsigned int msec)
 322         __attribute__((visibility("hidden")));
 323
 324 int ustcomm_setsockopt_snd_timeout(int sock, unsigned int msec)
 325         __attribute__((visibility("hidden")));
 326
 327 #endif  /* _UST_COMMON_UST_COMM_H */