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