| 1 | /* |
| 2 | * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca> |
| 3 | * Julien Desfossez <julien.desfossez@polymtl.ca> |
| 4 | * Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License, version 2 only, |
| 8 | * as published by the Free Software Foundation. |
| 9 | * |
| 10 | * This program is distributed in the hope that it will be useful, but WITHOUT |
| 11 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 12 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for |
| 13 | * more details. |
| 14 | * |
| 15 | * You should have received a copy of the GNU General Public License along |
| 16 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 17 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 18 | */ |
| 19 | |
| 20 | /* |
| 21 | * This header is meant for liblttng and libust internal use ONLY. These |
| 22 | * declarations should NOT be considered stable API. |
| 23 | */ |
| 24 | |
| 25 | #ifndef _LTTNG_SESSIOND_COMM_H |
| 26 | #define _LTTNG_SESSIOND_COMM_H |
| 27 | |
| 28 | #define _GNU_SOURCE |
| 29 | #include <limits.h> |
| 30 | #include <lttng/lttng.h> |
| 31 | #include <common/compat/socket.h> |
| 32 | |
| 33 | #include <arpa/inet.h> |
| 34 | #include <netinet/in.h> |
| 35 | #include <sys/un.h> |
| 36 | |
| 37 | #include "inet.h" |
| 38 | #include "inet6.h" |
| 39 | #include "unix.h" |
| 40 | |
| 41 | /* Queue size of listen(2) */ |
| 42 | #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64 |
| 43 | |
| 44 | /* Maximum number of FDs that can be sent over a Unix socket */ |
| 45 | #define LTTCOMM_MAX_SEND_FDS 4 |
| 46 | |
| 47 | /* |
| 48 | * Get the error code index from 0 since LTTCOMM_OK start at 1000 |
| 49 | */ |
| 50 | #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK) |
| 51 | |
| 52 | enum lttcomm_sessiond_command { |
| 53 | /* Tracer command */ |
| 54 | LTTNG_ADD_CONTEXT, |
| 55 | LTTNG_CALIBRATE, |
| 56 | LTTNG_DISABLE_CHANNEL, |
| 57 | LTTNG_DISABLE_EVENT, |
| 58 | LTTNG_DISABLE_ALL_EVENT, |
| 59 | LTTNG_ENABLE_CHANNEL, |
| 60 | LTTNG_ENABLE_EVENT, |
| 61 | LTTNG_ENABLE_ALL_EVENT, |
| 62 | /* Session daemon command */ |
| 63 | LTTNG_CREATE_SESSION, |
| 64 | LTTNG_CREATE_SESSION_URI, |
| 65 | LTTNG_DESTROY_SESSION, |
| 66 | LTTNG_LIST_CHANNELS, |
| 67 | LTTNG_LIST_DOMAINS, |
| 68 | LTTNG_LIST_EVENTS, |
| 69 | LTTNG_LIST_SESSIONS, |
| 70 | LTTNG_LIST_TRACEPOINTS, |
| 71 | LTTNG_REGISTER_CONSUMER, |
| 72 | LTTNG_START_TRACE, |
| 73 | LTTNG_STOP_TRACE, |
| 74 | LTTNG_LIST_TRACEPOINT_FIELDS, |
| 75 | |
| 76 | /* Consumer */ |
| 77 | LTTNG_DISABLE_CONSUMER, |
| 78 | LTTNG_ENABLE_CONSUMER, |
| 79 | LTTNG_SET_CONSUMER_URI, |
| 80 | /* Relay daemon */ |
| 81 | RELAYD_ADD_STREAM, |
| 82 | RELAYD_CREATE_SESSION, |
| 83 | RELAYD_START_DATA, |
| 84 | RELAYD_UPDATE_SYNC_INFO, |
| 85 | RELAYD_VERSION, |
| 86 | RELAYD_SEND_METADATA, |
| 87 | |
| 88 | /* Other tracer commands */ |
| 89 | LTTNG_SET_FILTER, |
| 90 | }; |
| 91 | |
| 92 | /* |
| 93 | * lttcomm error code. |
| 94 | */ |
| 95 | enum lttcomm_return_code { |
| 96 | LTTCOMM_OK = 10, /* Ok */ |
| 97 | LTTCOMM_ERR, /* Unknown Error */ |
| 98 | LTTCOMM_UND, /* Undefine command */ |
| 99 | LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */ |
| 100 | LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */ |
| 101 | LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */ |
| 102 | LTTCOMM_NO_SESSION, /* No session found */ |
| 103 | LTTCOMM_CREATE_DIR_FAIL, /* Create directory fail */ |
| 104 | LTTCOMM_SESSION_FAIL, /* Create session fail */ |
| 105 | LTTCOMM_START_FAIL, /* Start tracing fail */ |
| 106 | LTTCOMM_STOP_FAIL, /* Stop tracing fail */ |
| 107 | LTTCOMM_LIST_FAIL, /* Listing apps fail */ |
| 108 | LTTCOMM_NO_APPS, /* No traceable application */ |
| 109 | LTTCOMM_SESS_NOT_FOUND, /* Session name not found */ |
| 110 | LTTCOMM_NO_TRACE, /* No trace exist */ |
| 111 | LTTCOMM_FATAL, /* Session daemon had a fatal error */ |
| 112 | LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */ |
| 113 | LTTCOMM_SELECT_SESS, /* Must select a session */ |
| 114 | LTTCOMM_EXIST_SESS, /* Session name already exist */ |
| 115 | LTTCOMM_NO_EVENT, /* No event found */ |
| 116 | LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */ |
| 117 | LTTCOMM_APP_NOT_FOUND, /* App not found in traceable app list */ |
| 118 | LTTCOMM_EPERM, /* Permission denied */ |
| 119 | LTTCOMM_KERN_NA, /* Kernel tracer unavalable */ |
| 120 | LTTCOMM_KERN_VERSION, /* Kernel tracer version is not compatible */ |
| 121 | LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */ |
| 122 | LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */ |
| 123 | LTTCOMM_KERN_CHAN_EXIST, /* Kernel channel already exists */ |
| 124 | LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */ |
| 125 | LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */ |
| 126 | LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */ |
| 127 | LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */ |
| 128 | LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */ |
| 129 | LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */ |
| 130 | LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */ |
| 131 | LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */ |
| 132 | LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */ |
| 133 | LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */ |
| 134 | LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */ |
| 135 | LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */ |
| 136 | LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */ |
| 137 | LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */ |
| 138 | LTTCOMM_KERN_NO_SESSION, /* No kernel session found */ |
| 139 | LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */ |
| 140 | LTTCOMM_UST_CALIBRATE_FAIL, /* UST calibration failed */ |
| 141 | LTTCOMM_UST_VERSION, /* UST tracer version is not compatible */ |
| 142 | LTTCOMM_UST_SESS_FAIL, /* UST create session failed */ |
| 143 | LTTCOMM_UST_CHAN_EXIST, /* UST channel already exist */ |
| 144 | LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */ |
| 145 | LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */ |
| 146 | LTTCOMM_UST_CHAN_DISABLE_FAIL, /* UST disable channel failed */ |
| 147 | LTTCOMM_UST_CHAN_ENABLE_FAIL, /* UST enable channel failed */ |
| 148 | LTTCOMM_UST_CONTEXT_FAIL, /* UST add context failed */ |
| 149 | LTTCOMM_UST_ENABLE_FAIL, /* UST enable event failed */ |
| 150 | LTTCOMM_UST_DISABLE_FAIL, /* UST disable event failed */ |
| 151 | LTTCOMM_UST_META_FAIL, /* UST open metadata failed */ |
| 152 | LTTCOMM_UST_START_FAIL, /* UST start trace failed */ |
| 153 | LTTCOMM_UST_STOP_FAIL, /* UST stop trace failed */ |
| 154 | LTTCOMM_UST_CONSUMER64_FAIL, /* 64-bit UST consumer start failed */ |
| 155 | LTTCOMM_UST_CONSUMER32_FAIL, /* 32-bit UST consumer start failed */ |
| 156 | LTTCOMM_UST_STREAM_FAIL, /* UST create stream failed */ |
| 157 | LTTCOMM_UST_DIR_FAIL, /* UST trace directory creation failed */ |
| 158 | LTTCOMM_UST_DIR_EXIST, /* UST trace directory exist */ |
| 159 | LTTCOMM_UST_NO_SESSION, /* No UST session found */ |
| 160 | LTTCOMM_UST_LIST_FAIL, /* UST listing events failed */ |
| 161 | LTTCOMM_UST_EVENT_EXIST, /* UST event exist */ |
| 162 | LTTCOMM_UST_EVENT_NOT_FOUND, /* UST event not found */ |
| 163 | LTTCOMM_UST_CONTEXT_EXIST, /* UST context exist */ |
| 164 | LTTCOMM_UST_CONTEXT_INVAL, /* UST context invalid */ |
| 165 | LTTCOMM_NEED_ROOT_SESSIOND, /* root sessiond is needed */ |
| 166 | LTTCOMM_TRACE_ALREADY_STARTED, /* Tracing already started */ |
| 167 | LTTCOMM_TRACE_ALREADY_STOPPED, /* Tracing already stopped */ |
| 168 | LTTCOMM_KERN_EVENT_ENOSYS, /* Kernel event type not supported */ |
| 169 | |
| 170 | CONSUMERD_COMMAND_SOCK_READY, /* when consumerd command socket ready */ |
| 171 | CONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */ |
| 172 | CONSUMERD_ERROR_RECV_FD, /* error on receiving fds */ |
| 173 | CONSUMERD_ERROR_RECV_CMD, /* error on receiving command */ |
| 174 | CONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */ |
| 175 | CONSUMERD_POLL_NVAL, /* Poll on closed fd */ |
| 176 | CONSUMERD_POLL_HUP, /* All fds have hungup */ |
| 177 | CONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */ |
| 178 | CONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */ |
| 179 | CONSUMERD_OUTFD_ERROR, /* error opening the tracefile */ |
| 180 | CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */ |
| 181 | CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */ |
| 182 | CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */ |
| 183 | CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */ |
| 184 | LTTCOMM_INVALID, /* Invalid parameter */ |
| 185 | LTTCOMM_NO_USTCONSUMERD, /* No UST consumer detected */ |
| 186 | LTTCOMM_NO_KERNCONSUMERD, /* No Kernel consumer detected */ |
| 187 | LTTCOMM_EVENT_EXIST_LOGLEVEL, /* Event already enabled with different loglevel */ |
| 188 | LTTCOMM_URI_DATA_MISS, /* Missing network data URI */ |
| 189 | LTTCOMM_URI_CTRL_MISS, /* Missing network control URI */ |
| 190 | LTTCOMM_ENABLE_CONSUMER_FAIL, /* Enabling consumer failed */ |
| 191 | LTTCOMM_RELAYD_SESSION_FAIL, /* lttng-relayd create session failed */ |
| 192 | LTTCOMM_RELAYD_VERSION_FAIL, /* lttng-relayd not compatible */ |
| 193 | LTTCOMM_FILTER_INVAL, /* Invalid filter bytecode */ |
| 194 | LTTCOMM_FILTER_NOMEM, /* Lack of memory for filter bytecode */ |
| 195 | LTTCOMM_FILTER_EXIST, /* Filter already exist */ |
| 196 | |
| 197 | /* MUST be last element */ |
| 198 | LTTCOMM_NR, /* Last element */ |
| 199 | }; |
| 200 | |
| 201 | /* lttng socket protocol. */ |
| 202 | enum lttcomm_sock_proto { |
| 203 | LTTCOMM_SOCK_UDP, |
| 204 | LTTCOMM_SOCK_TCP, |
| 205 | }; |
| 206 | |
| 207 | /* |
| 208 | * Index in the net_families array below. Please keep in sync! |
| 209 | */ |
| 210 | enum lttcomm_sock_domain { |
| 211 | LTTCOMM_INET = 1, |
| 212 | LTTCOMM_INET6 = 2, |
| 213 | }; |
| 214 | |
| 215 | struct lttcomm_sockaddr { |
| 216 | enum lttcomm_sock_domain type; |
| 217 | union { |
| 218 | struct sockaddr_in sin; |
| 219 | struct sockaddr_in6 sin6; |
| 220 | } addr; |
| 221 | }; |
| 222 | |
| 223 | struct lttcomm_sock { |
| 224 | int fd; |
| 225 | enum lttcomm_sock_proto proto; |
| 226 | struct lttcomm_sockaddr sockaddr; |
| 227 | const struct lttcomm_proto_ops *ops; |
| 228 | }; |
| 229 | |
| 230 | struct lttcomm_net_family { |
| 231 | int family; |
| 232 | int (*create) (struct lttcomm_sock *sock, int type, int proto); |
| 233 | }; |
| 234 | |
| 235 | struct lttcomm_proto_ops { |
| 236 | int (*bind) (struct lttcomm_sock *sock); |
| 237 | int (*close) (struct lttcomm_sock *sock); |
| 238 | int (*connect) (struct lttcomm_sock *sock); |
| 239 | struct lttcomm_sock *(*accept) (struct lttcomm_sock *sock); |
| 240 | int (*listen) (struct lttcomm_sock *sock, int backlog); |
| 241 | ssize_t (*recvmsg) (struct lttcomm_sock *sock, void *buf, size_t len, |
| 242 | int flags); |
| 243 | ssize_t (*sendmsg) (struct lttcomm_sock *sock, void *buf, size_t len, |
| 244 | int flags); |
| 245 | }; |
| 246 | |
| 247 | /* |
| 248 | * Data structure received from lttng client to session daemon. |
| 249 | */ |
| 250 | struct lttcomm_session_msg { |
| 251 | uint32_t cmd_type; /* enum lttcomm_sessiond_command */ |
| 252 | struct lttng_session session; |
| 253 | struct lttng_domain domain; |
| 254 | union { |
| 255 | struct { |
| 256 | char channel_name[NAME_MAX]; |
| 257 | char name[NAME_MAX]; |
| 258 | } disable; |
| 259 | /* Event data */ |
| 260 | struct { |
| 261 | char channel_name[NAME_MAX]; |
| 262 | struct lttng_event event; |
| 263 | } enable; |
| 264 | /* Create channel */ |
| 265 | struct { |
| 266 | struct lttng_channel chan; |
| 267 | } channel; |
| 268 | /* Context */ |
| 269 | struct { |
| 270 | char channel_name[NAME_MAX]; |
| 271 | char event_name[NAME_MAX]; |
| 272 | struct lttng_event_context ctx; |
| 273 | } context; |
| 274 | /* Use by register_consumer */ |
| 275 | struct { |
| 276 | char path[PATH_MAX]; |
| 277 | } reg; |
| 278 | /* List */ |
| 279 | struct { |
| 280 | char channel_name[NAME_MAX]; |
| 281 | } list; |
| 282 | struct lttng_calibrate calibrate; |
| 283 | /* Used by the set_consumer_uri call */ |
| 284 | struct lttng_uri uri; |
| 285 | struct { |
| 286 | uint32_t enable_consumer; |
| 287 | struct lttng_uri ctrl_uri; |
| 288 | struct lttng_uri data_uri; |
| 289 | } create_uri; |
| 290 | struct { |
| 291 | char channel_name[NAME_MAX]; |
| 292 | char event_name[NAME_MAX]; |
| 293 | /* Length of following bytecode */ |
| 294 | uint32_t bytecode_len; |
| 295 | } filter; |
| 296 | } u; |
| 297 | }; |
| 298 | |
| 299 | #define LTTNG_FILTER_MAX_LEN 65336 |
| 300 | |
| 301 | /* |
| 302 | * Filter bytecode data. The reloc table is located at the end of the |
| 303 | * bytecode. It is made of tuples: (uint16_t, var. len. string). It |
| 304 | * starts at reloc_table_offset. |
| 305 | */ |
| 306 | struct lttng_filter_bytecode { |
| 307 | uint16_t len; /* len of data */ |
| 308 | uint16_t reloc_table_offset; |
| 309 | char data[0]; |
| 310 | }; |
| 311 | |
| 312 | /* |
| 313 | * Data structure for the response from sessiond to the lttng client. |
| 314 | */ |
| 315 | struct lttcomm_lttng_msg { |
| 316 | uint32_t cmd_type; /* enum lttcomm_sessiond_command */ |
| 317 | uint32_t ret_code; /* enum lttcomm_return_code */ |
| 318 | uint32_t pid; /* pid_t */ |
| 319 | uint32_t data_size; |
| 320 | /* Contains: trace_name + data */ |
| 321 | char payload[]; |
| 322 | }; |
| 323 | |
| 324 | /* |
| 325 | * lttcomm_consumer_msg is the message sent from sessiond to consumerd |
| 326 | * to either add a channel, add a stream, update a stream, or stop |
| 327 | * operation. |
| 328 | */ |
| 329 | struct lttcomm_consumer_msg { |
| 330 | uint32_t cmd_type; /* enum consumerd_command */ |
| 331 | union { |
| 332 | struct { |
| 333 | int channel_key; |
| 334 | uint64_t max_sb_size; /* the subbuffer size for this channel */ |
| 335 | /* shm_fd and wait_fd are sent as ancillary data */ |
| 336 | uint64_t mmap_len; |
| 337 | char name[LTTNG_SYMBOL_NAME_LEN]; |
| 338 | } channel; |
| 339 | struct { |
| 340 | int channel_key; |
| 341 | int stream_key; |
| 342 | /* shm_fd and wait_fd are sent as ancillary data */ |
| 343 | uint32_t state; /* enum lttcomm_consumer_fd_state */ |
| 344 | enum lttng_event_output output; /* use splice or mmap to consume this fd */ |
| 345 | uint64_t mmap_len; |
| 346 | uid_t uid; /* User ID owning the session */ |
| 347 | gid_t gid; /* Group ID owning the session */ |
| 348 | char path_name[PATH_MAX]; |
| 349 | int net_index; |
| 350 | unsigned int metadata_flag; |
| 351 | char name[LTTNG_SYMBOL_NAME_LEN]; /* Name string of the stream */ |
| 352 | } stream; |
| 353 | struct { |
| 354 | int net_index; |
| 355 | enum lttng_stream_type type; |
| 356 | /* Open socket to the relayd */ |
| 357 | struct lttcomm_sock sock; |
| 358 | } relayd_sock; |
| 359 | } u; |
| 360 | }; |
| 361 | |
| 362 | #ifdef HAVE_LIBLTTNG_UST_CTL |
| 363 | |
| 364 | #include <lttng/ust-abi.h> |
| 365 | |
| 366 | /* |
| 367 | * Data structure for the commands sent from sessiond to UST. |
| 368 | */ |
| 369 | struct lttcomm_ust_msg { |
| 370 | uint32_t handle; |
| 371 | uint32_t cmd; |
| 372 | union { |
| 373 | struct lttng_ust_channel channel; |
| 374 | struct lttng_ust_stream stream; |
| 375 | struct lttng_ust_event event; |
| 376 | struct lttng_ust_context context; |
| 377 | struct lttng_ust_tracer_version version; |
| 378 | } u; |
| 379 | }; |
| 380 | |
| 381 | /* |
| 382 | * Data structure for the response from UST to the session daemon. |
| 383 | * cmd_type is sent back in the reply for validation. |
| 384 | */ |
| 385 | struct lttcomm_ust_reply { |
| 386 | uint32_t handle; |
| 387 | uint32_t cmd; |
| 388 | uint32_t ret_code; /* enum lttcomm_return_code */ |
| 389 | uint32_t ret_val; /* return value */ |
| 390 | union { |
| 391 | struct { |
| 392 | uint64_t memory_map_size; |
| 393 | } channel; |
| 394 | struct { |
| 395 | uint64_t memory_map_size; |
| 396 | } stream; |
| 397 | struct lttng_ust_tracer_version version; |
| 398 | } u; |
| 399 | }; |
| 400 | |
| 401 | #endif /* HAVE_LIBLTTNG_UST_CTL */ |
| 402 | |
| 403 | extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code); |
| 404 | |
| 405 | extern int lttcomm_init_inet_sockaddr(struct lttcomm_sockaddr *sockaddr, |
| 406 | const char *ip, unsigned int port); |
| 407 | extern int lttcomm_init_inet6_sockaddr(struct lttcomm_sockaddr *sockaddr, |
| 408 | const char *ip, unsigned int port); |
| 409 | |
| 410 | extern struct lttcomm_sock *lttcomm_alloc_sock(enum lttcomm_sock_proto proto); |
| 411 | extern int lttcomm_create_sock(struct lttcomm_sock *sock); |
| 412 | extern struct lttcomm_sock *lttcomm_alloc_sock_from_uri(struct lttng_uri *uri); |
| 413 | extern void lttcomm_destroy_sock(struct lttcomm_sock *sock); |
| 414 | extern struct lttcomm_sock *lttcomm_alloc_copy_sock(struct lttcomm_sock *src); |
| 415 | extern void lttcomm_copy_sock(struct lttcomm_sock *dst, |
| 416 | struct lttcomm_sock *src); |
| 417 | |
| 418 | #endif /* _LTTNG_SESSIOND_COMM_H */ |