src/common/sessiond-comm/sessiond-comm.h

   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 /* Queue size of listen(2) */
  34 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
  35
  36 /* Maximum number of FDs that can be sent over a Unix socket */
  37 #define LTTCOMM_MAX_SEND_FDS           4
  38
  39 /*
  40  * Get the error code index from 0 since LTTCOMM_OK start at 1000
  41  */
  42 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
  43
  44 enum lttcomm_sessiond_command {
  45         /* Tracer command */
  46         LTTNG_ADD_CONTEXT,
  47         LTTNG_CALIBRATE,
  48         LTTNG_DISABLE_CHANNEL,
  49         LTTNG_DISABLE_EVENT,
  50         LTTNG_DISABLE_ALL_EVENT,
  51         LTTNG_ENABLE_CHANNEL,
  52         LTTNG_ENABLE_EVENT,
  53         LTTNG_ENABLE_ALL_EVENT,
  54         /* Session daemon command */
  55         LTTNG_CREATE_SESSION,
  56         LTTNG_DESTROY_SESSION,
  57         LTTNG_LIST_CHANNELS,
  58         LTTNG_LIST_DOMAINS,
  59         LTTNG_LIST_EVENTS,
  60         LTTNG_LIST_SESSIONS,
  61         LTTNG_LIST_TRACEPOINTS,
  62         LTTNG_REGISTER_CONSUMER,
  63         LTTNG_START_TRACE,
  64         LTTNG_STOP_TRACE,
  65         LTTNG_LIST_TRACEPOINT_FIELDS,
  66 };
  67
  68 /*
  69  * lttcomm error code.
  70  */
  71 enum lttcomm_return_code {
  72         LTTCOMM_OK = 10,                                /* Ok */
  73         LTTCOMM_ERR,                                    /* Unknown Error */
  74         LTTCOMM_UND,                                    /* Undefine command */
  75         LTTCOMM_NOT_IMPLEMENTED,        /* Command not implemented */
  76         LTTCOMM_UNKNOWN_DOMAIN,         /* Tracing domain not known */
  77         LTTCOMM_ALLOC_FAIL,                             /* Trace allocation fail */
  78         LTTCOMM_NO_SESSION,                             /* No session found */
  79         LTTCOMM_CREATE_DIR_FAIL,        /* Create directory fail */
  80         LTTCOMM_SESSION_FAIL,                   /* Create session fail */
  81         LTTCOMM_START_FAIL,                             /* Start tracing fail */
  82         LTTCOMM_STOP_FAIL,                              /* Stop tracing fail */
  83         LTTCOMM_LIST_FAIL,                              /* Listing apps fail */
  84         LTTCOMM_NO_APPS,                                /* No traceable application */
  85         LTTCOMM_SESS_NOT_FOUND,                 /* Session name not found */
  86         LTTCOMM_NO_TRACE,                               /* No trace exist */
  87         LTTCOMM_FATAL,                                  /* Session daemon had a fatal error */
  88         LTTCOMM_NO_TRACEABLE,                   /* Error for non traceable app */
  89         LTTCOMM_SELECT_SESS,                    /* Must select a session */
  90         LTTCOMM_EXIST_SESS,                             /* Session name already exist */
  91         LTTCOMM_NO_EVENT,                               /* No event found */
  92         LTTCOMM_CONNECT_FAIL,           /* Unable to connect to unix socket */
  93         LTTCOMM_APP_NOT_FOUND,          /* App not found in traceable app list */
  94         LTTCOMM_EPERM,                  /* Permission denied */
  95         LTTCOMM_KERN_NA,                                /* Kernel tracer unavalable */
  96         LTTCOMM_KERN_VERSION,           /* Kernel tracer version is not compatible */
  97         LTTCOMM_KERN_EVENT_EXIST,       /* Kernel event already exists */
  98         LTTCOMM_KERN_SESS_FAIL,                 /* Kernel create session failed */
  99         LTTCOMM_KERN_CHAN_EXIST,        /* Kernel channel already exists */
 100         LTTCOMM_KERN_CHAN_FAIL,                 /* Kernel create channel failed */
 101         LTTCOMM_KERN_CHAN_NOT_FOUND,    /* Kernel channel not found */
 102         LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
 103         LTTCOMM_KERN_CHAN_ENABLE_FAIL,  /* Kernel enable channel failed */
 104         LTTCOMM_KERN_CONTEXT_FAIL,      /* Kernel add context failed */
 105         LTTCOMM_KERN_ENABLE_FAIL,               /* Kernel enable event failed */
 106         LTTCOMM_KERN_DISABLE_FAIL,              /* Kernel disable event failed */
 107         LTTCOMM_KERN_META_FAIL,                 /* Kernel open metadata failed */
 108         LTTCOMM_KERN_START_FAIL,                /* Kernel start trace failed */
 109         LTTCOMM_KERN_STOP_FAIL,                 /* Kernel stop trace failed */
 110         LTTCOMM_KERN_CONSUMER_FAIL,             /* Kernel consumer start failed */
 111         LTTCOMM_KERN_STREAM_FAIL,               /* Kernel create stream failed */
 112         LTTCOMM_KERN_DIR_FAIL,                  /* Kernel trace directory creation failed */
 113         LTTCOMM_KERN_DIR_EXIST,                 /* Kernel trace directory exist */
 114         LTTCOMM_KERN_NO_SESSION,                /* No kernel session found */
 115         LTTCOMM_KERN_LIST_FAIL,                 /* Kernel listing events failed */
 116         LTTCOMM_UST_CALIBRATE_FAIL,     /* UST calibration failed */
 117         LTTCOMM_UST_VERSION,            /* UST tracer version is not compatible */
 118         LTTCOMM_UST_SESS_FAIL,                  /* UST create session failed */
 119         LTTCOMM_UST_CHAN_EXIST,         /* UST channel already exist */
 120         LTTCOMM_UST_CHAN_FAIL,                  /* UST create channel failed */
 121         LTTCOMM_UST_CHAN_NOT_FOUND,     /* UST channel not found */
 122         LTTCOMM_UST_CHAN_DISABLE_FAIL, /* UST disable channel failed */
 123         LTTCOMM_UST_CHAN_ENABLE_FAIL,  /* UST enable channel failed */
 124         LTTCOMM_UST_CONTEXT_FAIL,      /* UST add context failed */
 125         LTTCOMM_UST_ENABLE_FAIL,                /* UST enable event failed */
 126         LTTCOMM_UST_DISABLE_FAIL,               /* UST disable event failed */
 127         LTTCOMM_UST_META_FAIL,                  /* UST open metadata failed */
 128         LTTCOMM_UST_START_FAIL,         /* UST start trace failed */
 129         LTTCOMM_UST_STOP_FAIL,                  /* UST stop trace failed */
 130         LTTCOMM_UST_CONSUMER64_FAIL,            /* 64-bit UST consumer start failed */
 131         LTTCOMM_UST_CONSUMER32_FAIL,            /* 32-bit UST consumer start failed */
 132         LTTCOMM_UST_STREAM_FAIL,                /* UST create stream failed */
 133         LTTCOMM_UST_DIR_FAIL,                   /* UST trace directory creation failed */
 134         LTTCOMM_UST_DIR_EXIST,                  /* UST trace directory exist */
 135         LTTCOMM_UST_NO_SESSION,         /* No UST session found */
 136         LTTCOMM_UST_LIST_FAIL,                  /* UST listing events failed */
 137         LTTCOMM_UST_EVENT_EXIST,        /* UST event exist */
 138         LTTCOMM_UST_EVENT_NOT_FOUND,    /* UST event not found */
 139         LTTCOMM_UST_CONTEXT_EXIST,      /* UST context exist */
 140         LTTCOMM_UST_CONTEXT_INVAL,      /* UST context invalid */
 141         LTTCOMM_NEED_ROOT_SESSIOND,             /* root sessiond is needed */
 142         LTTCOMM_TRACE_ALREADY_STARTED,  /* Tracing already started */
 143         LTTCOMM_TRACE_ALREADY_STOPPED,  /* Tracing already stopped */
 144         LTTCOMM_KERN_EVENT_ENOSYS,      /* Kernel event type not supported */
 145
 146         CONSUMERD_COMMAND_SOCK_READY,           /* when consumerd command socket ready */
 147         CONSUMERD_SUCCESS_RECV_FD,              /* success on receiving fds */
 148         CONSUMERD_ERROR_RECV_FD,                /* error on receiving fds */
 149         CONSUMERD_ERROR_RECV_CMD,               /* error on receiving command */
 150         CONSUMERD_POLL_ERROR,                   /* Error in polling thread in kconsumerd */
 151         CONSUMERD_POLL_NVAL,                    /* Poll on closed fd */
 152         CONSUMERD_POLL_HUP,                     /* All fds have hungup */
 153         CONSUMERD_EXIT_SUCCESS,                 /* kconsumerd exiting normally */
 154         CONSUMERD_EXIT_FAILURE,                 /* kconsumerd exiting on error */
 155         CONSUMERD_OUTFD_ERROR,                  /* error opening the tracefile */
 156         CONSUMERD_SPLICE_EBADF,                 /* EBADF from splice(2) */
 157         CONSUMERD_SPLICE_EINVAL,                /* EINVAL from splice(2) */
 158         CONSUMERD_SPLICE_ENOMEM,                /* ENOMEM from splice(2) */
 159         CONSUMERD_SPLICE_ESPIPE,                /* ESPIPE from splice(2) */
 160         LTTCOMM_INVALID,                        /* Invalid parameter */
 161         LTTCOMM_NO_USTCONSUMERD,        /* No UST consumer detected */
 162         LTTCOMM_NO_KERNCONSUMERD,       /* No Kernel consumer detected */
 163
 164         /* MUST be last element */
 165         LTTCOMM_NR,                                             /* Last element */
 166 };
 167
 168 /*
 169  * Data structure received from lttng client to session daemon.
 170  */
 171 struct lttcomm_session_msg {
 172         uint32_t cmd_type;    /* enum lttcomm_sessiond_command */
 173         struct lttng_session session;
 174         struct lttng_domain domain;
 175         union {
 176                 struct {
 177                         char channel_name[NAME_MAX];
 178                         char name[NAME_MAX];
 179                 } disable;
 180                 /* Event data */
 181                 struct {
 182                         char channel_name[NAME_MAX];
 183                         struct lttng_event event;
 184                 } enable;
 185                 /* Create channel */
 186                 struct {
 187                         struct lttng_channel chan;
 188                 } channel;
 189                 /* Context */
 190                 struct {
 191                         char channel_name[NAME_MAX];
 192                         char event_name[NAME_MAX];
 193                         struct lttng_event_context ctx;
 194                 } context;
 195                 /* Use by register_consumer */
 196                 struct {
 197                         char path[PATH_MAX];
 198                 } reg;
 199                 /* List */
 200                 struct {
 201                         char channel_name[NAME_MAX];
 202                 } list;
 203                 struct lttng_calibrate calibrate;
 204         } u;
 205 };
 206
 207 /*
 208  * Data structure for the response from sessiond to the lttng client.
 209  */
 210 struct lttcomm_lttng_msg {
 211         uint32_t cmd_type;   /* enum lttcomm_sessiond_command */
 212         uint32_t ret_code;   /* enum lttcomm_return_code */
 213         uint32_t pid;        /* pid_t */
 214         uint32_t data_size;
 215         /* Contains: trace_name + data */
 216         char payload[];
 217 };
 218
 219 /*
 220  * lttcomm_consumer_msg is the message sent from sessiond to consumerd
 221  * to either add a channel, add a stream, update a stream, or stop
 222  * operation.
 223  */
 224 struct lttcomm_consumer_msg {
 225         uint32_t cmd_type;      /* enum consumerd_command */
 226         union {
 227                 struct {
 228                         int channel_key;
 229                         uint64_t max_sb_size; /* the subbuffer size for this channel */
 230                         /* shm_fd and wait_fd are sent as ancillary data */
 231                         uint64_t mmap_len;
 232                 } channel;
 233                 struct {
 234                         int channel_key;
 235                         int stream_key;
 236                         /* shm_fd and wait_fd are sent as ancillary data */
 237                         uint32_t state;    /* enum lttcomm_consumer_fd_state */
 238                         enum lttng_event_output output; /* use splice or mmap to consume this fd */
 239                         uint64_t mmap_len;
 240                         uid_t uid;         /* User ID owning the session */
 241                         gid_t gid;         /* Group ID owning the session */
 242                         char path_name[PATH_MAX];
 243                 } stream;
 244         } u;
 245 };
 246
 247 #ifdef HAVE_LIBLTTNG_UST_CTL
 248
 249 #include <lttng/ust-abi.h>
 250
 251 /*
 252  * Data structure for the commands sent from sessiond to UST.
 253  */
 254 struct lttcomm_ust_msg {
 255         uint32_t handle;
 256         uint32_t cmd;
 257         union {
 258                 struct lttng_ust_channel channel;
 259                 struct lttng_ust_stream stream;
 260                 struct lttng_ust_event event;
 261                 struct lttng_ust_context context;
 262                 struct lttng_ust_tracer_version version;
 263         } u;
 264 };
 265
 266 /*
 267  * Data structure for the response from UST to the session daemon.
 268  * cmd_type is sent back in the reply for validation.
 269  */
 270 struct lttcomm_ust_reply {
 271         uint32_t handle;
 272         uint32_t cmd;
 273         uint32_t ret_code;      /* enum lttcomm_return_code */
 274         uint32_t ret_val;       /* return value */
 275         union {
 276                 struct {
 277                         uint64_t memory_map_size;
 278                 } channel;
 279                 struct {
 280                         uint64_t memory_map_size;
 281                 } stream;
 282                 struct lttng_ust_tracer_version version;
 283         } u;
 284 };
 285
 286 #endif /* HAVE_LIBLTTNG_UST_CTL */
 287
 288 extern int lttcomm_create_unix_sock(const char *pathname);
 289 extern int lttcomm_connect_unix_sock(const char *pathname);
 290 extern int lttcomm_accept_unix_sock(int sock);
 291 extern int lttcomm_listen_unix_sock(int sock);
 292 extern int lttcomm_close_unix_sock(int sock);
 293
 294 /* Send a message accompanied by fd(s) over a unix socket. */
 295 extern ssize_t lttcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
 296 /* Recv a message accompanied by fd(s) from a unix socket */
 297 extern ssize_t lttcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);
 298
 299 extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
 300 extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
 301
 302 extern ssize_t lttcomm_send_creds_unix_sock(int sock, void *buf, size_t len);
 303 extern ssize_t lttcomm_recv_creds_unix_sock(int sock, void *buf, size_t len,
 304                 lttng_sock_cred *creds);
 305
 306 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
 307 extern int lttcomm_setsockopt_creds_unix_sock(int sock);
 308
 309 #endif  /* _LTTNG_SESSIOND_COMM_H */