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

   1 #ifndef _LTTNG_SESSIOND_COMM_H
   2 #define _LTTNG_SESSIOND_COMM_H
   3
   4 /*
   5  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   6  *                      Julien Desfossez <julien.desfossez@polymtl.ca>
   7  *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * as published by the Free Software Foundation; only version 2
  12  * of the License.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  22  */
  23
  24 /*
  25  * This header is meant for liblttng and libust internal use ONLY.
  26  * These declarations should NOT be considered stable API.
  27  */
  28
  29 #define _GNU_SOURCE
  30 #include <limits.h>
  31 #include <lttng/lttng.h>
  32 #include <sys/socket.h>
  33
  34 #define LTTNG_RUNDIR                        "/var/run/lttng"
  35 #define LTTNG_HOME_RUNDIR                   "%s/.lttng"
  36
  37 /* Default unix socket path */
  38 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK     LTTNG_RUNDIR "/client-lttng-sessiond"
  39 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK       LTTNG_RUNDIR "/apps-lttng-sessiond"
  40 #define DEFAULT_HOME_APPS_UNIX_SOCK         LTTNG_HOME_RUNDIR "/apps-lttng-sessiond"
  41 #define DEFAULT_HOME_CLIENT_UNIX_SOCK       LTTNG_HOME_RUNDIR "/client-lttng-sessiond"
  42
  43 /* Queue size of listen(2) */
  44 #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64
  45
  46 /*
  47  * Get the error code index from 0 since LTTCOMM_OK start at 1000
  48  */
  49 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
  50
  51 enum lttcomm_sessiond_command {
  52         /* Tracer command */
  53         LTTNG_ADD_CONTEXT,
  54         LTTNG_CALIBRATE,
  55         LTTNG_DISABLE_CHANNEL,
  56         LTTNG_DISABLE_EVENT,
  57         LTTNG_DISABLE_ALL_EVENT,
  58         LTTNG_ENABLE_CHANNEL,
  59         LTTNG_ENABLE_EVENT,
  60         LTTNG_ENABLE_ALL_EVENT,
  61         /* Session daemon command */
  62         LTTNG_CREATE_SESSION,
  63         LTTNG_DESTROY_SESSION,
  64         LTTNG_LIST_CHANNELS,
  65         LTTNG_LIST_DOMAINS,
  66         LTTNG_LIST_EVENTS,
  67         LTTNG_LIST_SESSIONS,
  68         LTTNG_LIST_TRACEPOINTS,
  69         LTTNG_REGISTER_CONSUMER,
  70         LTTNG_START_TRACE,
  71         LTTNG_STOP_TRACE,
  72 };
  73
  74 /*
  75  * lttcomm error code.
  76  */
  77 enum lttcomm_return_code {
  78         LTTCOMM_OK = 1000,                              /* Ok */
  79         LTTCOMM_ERR,                                    /* Unknown Error */
  80         LTTCOMM_UND,                                    /* Undefine command */
  81         LTTCOMM_NOT_IMPLEMENTED,        /* Command not implemented */
  82         LTTCOMM_UNKNOWN_DOMAIN,         /* Tracing domain not known */
  83         LTTCOMM_ALLOC_FAIL,                             /* Trace allocation fail */
  84         LTTCOMM_NO_SESSION,                             /* No session found */
  85         LTTCOMM_CREATE_FAIL,                    /* Create trace fail */
  86         LTTCOMM_SESSION_FAIL,                   /* Create session fail */
  87         LTTCOMM_START_FAIL,                             /* Start tracing fail */
  88         LTTCOMM_STOP_FAIL,                              /* Stop tracing fail */
  89         LTTCOMM_LIST_FAIL,                              /* Listing apps fail */
  90         LTTCOMM_NO_APPS,                                /* No traceable application */
  91         LTTCOMM_SESS_NOT_FOUND,                 /* Session name not found */
  92         LTTCOMM_NO_TRACE,                               /* No trace exist */
  93         LTTCOMM_FATAL,                                  /* Session daemon had a fatal error */
  94         LTTCOMM_NO_TRACEABLE,                   /* Error for non traceable app */
  95         LTTCOMM_SELECT_SESS,                    /* Must select a session */
  96         LTTCOMM_EXIST_SESS,                             /* Session name already exist */
  97         LTTCOMM_NO_EVENT,                               /* No event found */
  98         LTTCOMM_CONNECT_FAIL,           /* Unable to connect to unix socket */
  99         LTTCOMM_APP_NOT_FOUND,          /* App not found in traceable app list */
 100         LTTCOMM_EPERM,                  /* Permission denied */
 101         LTTCOMM_KERN_NA,                                /* Kernel tracer unavalable */
 102         LTTCOMM_KERN_EVENT_EXIST,       /* Kernel event already exists */
 103         LTTCOMM_KERN_SESS_FAIL,                 /* Kernel create session failed */
 104         LTTCOMM_KERN_CHAN_FAIL,                 /* Kernel create channel failed */
 105         LTTCOMM_KERN_CHAN_NOT_FOUND,    /* Kernel channel not found */
 106         LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
 107         LTTCOMM_KERN_CHAN_ENABLE_FAIL,  /* Kernel enable channel failed */
 108         LTTCOMM_KERN_CONTEXT_FAIL,      /* Kernel add context failed */
 109         LTTCOMM_KERN_ENABLE_FAIL,               /* Kernel enable event failed */
 110         LTTCOMM_KERN_DISABLE_FAIL,              /* Kernel disable event failed */
 111         LTTCOMM_KERN_META_FAIL,                 /* Kernel open metadata failed */
 112         LTTCOMM_KERN_START_FAIL,                /* Kernel start trace failed */
 113         LTTCOMM_KERN_STOP_FAIL,                 /* Kernel stop trace failed */
 114         LTTCOMM_KERN_CONSUMER_FAIL,             /* Kernel consumer start failed */
 115         LTTCOMM_KERN_STREAM_FAIL,               /* Kernel create stream failed */
 116         LTTCOMM_KERN_DIR_FAIL,                  /* Kernel trace directory creation failed */
 117         LTTCOMM_KERN_DIR_EXIST,                 /* Kernel trace directory exist */
 118         LTTCOMM_KERN_NO_SESSION,                /* No kernel session found */
 119         LTTCOMM_KERN_LIST_FAIL,                 /* Kernel listing events failed */
 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
 143         CONSUMERD_COMMAND_SOCK_READY,           /* when consumerd command socket ready */
 144         CONSUMERD_SUCCESS_RECV_FD,              /* success on receiving fds */
 145         CONSUMERD_ERROR_RECV_FD,                /* error on receiving fds */
 146         CONSUMERD_ERROR_RECV_CMD,               /* error on receiving command */
 147         CONSUMERD_POLL_ERROR,                   /* Error in polling thread in kconsumerd */
 148         CONSUMERD_POLL_NVAL,                    /* Poll on closed fd */
 149         CONSUMERD_POLL_HUP,                     /* All fds have hungup */
 150         CONSUMERD_EXIT_SUCCESS,                 /* kconsumerd exiting normally */
 151         CONSUMERD_EXIT_FAILURE,                 /* kconsumerd exiting on error */
 152         CONSUMERD_OUTFD_ERROR,                  /* error opening the tracefile */
 153         CONSUMERD_SPLICE_EBADF,                 /* EBADF from splice(2) */
 154         CONSUMERD_SPLICE_EINVAL,                /* EINVAL from splice(2) */
 155         CONSUMERD_SPLICE_ENOMEM,                /* ENOMEM from splice(2) */
 156         CONSUMERD_SPLICE_ESPIPE,                /* ESPIPE from splice(2) */
 157         /* MUST be last element */
 158         LTTCOMM_NR,                                             /* Last element */
 159 };
 160
 161 /*
 162  * Data structure received from lttng client to session daemon.
 163  */
 164 struct lttcomm_session_msg {
 165         uint32_t cmd_type;    /* enum lttcomm_sessiond_command */
 166         struct lttng_session session;
 167         struct lttng_domain domain;
 168         union {
 169                 struct {
 170                         char channel_name[NAME_MAX];
 171                         char name[NAME_MAX];
 172                 } disable;
 173                 /* Event data */
 174                 struct {
 175                         char channel_name[NAME_MAX];
 176                         struct lttng_event event;
 177                 } enable;
 178                 /* Create channel */
 179                 struct {
 180                         struct lttng_channel chan;
 181                 } channel;
 182                 /* Context */
 183                 struct {
 184                         char channel_name[NAME_MAX];
 185                         char event_name[NAME_MAX];
 186                         struct lttng_event_context ctx;
 187                 } context;
 188                 /* Use by register_consumer */
 189                 struct {
 190                         char path[PATH_MAX];
 191                 } reg;
 192                 /* List */
 193                 struct {
 194                         char channel_name[NAME_MAX];
 195                 } list;
 196                 struct lttng_calibrate calibrate;
 197         } u;
 198 };
 199
 200 /*
 201  * Data structure for the response from sessiond to the lttng client.
 202  */
 203 struct lttcomm_lttng_msg {
 204         uint32_t cmd_type;   /* enum lttcomm_sessiond_command */
 205         uint32_t ret_code;   /* enum lttcomm_return_code */
 206         uint32_t pid;        /* pid_t */
 207         uint32_t data_size;
 208         /* Contains: trace_name + data */
 209         char payload[];
 210 };
 211
 212 /*
 213  * lttcomm_consumer_msg is the message sent from sessiond to consumerd
 214  * to either add a channel, add a stream, update a stream, or stop
 215  * operation.
 216  */
 217 struct lttcomm_consumer_msg {
 218         uint32_t cmd_type;      /* enum consumerd_command */
 219         union {
 220                 struct {
 221                         int channel_key;
 222                         uint64_t max_sb_size; /* the subbuffer size for this channel */
 223                         /* shm_fd and wait_fd are sent as ancillary data */
 224                         uint64_t mmap_len;
 225                 } channel;
 226                 struct {
 227                         int channel_key;
 228                         int stream_key;
 229                         /* shm_fd and wait_fd are sent as ancillary data */
 230                         uint32_t state;    /* enum lttcomm_consumer_fd_state */
 231                         enum lttng_event_output output; /* use splice or mmap to consume this fd */
 232                         uint64_t mmap_len;
 233                         uid_t uid;         /* User ID owning the session */
 234                         gid_t gid;         /* Group ID owning the session */
 235                         char path_name[PATH_MAX];
 236                 } stream;
 237         } u;
 238 };
 239
 240 #ifdef HAVE_LIBLTTNG_UST_CTL
 241
 242 #include <lttng/ust-abi.h>
 243
 244 /*
 245  * Data structure for the commands sent from sessiond to UST.
 246  */
 247 struct lttcomm_ust_msg {
 248         uint32_t handle;
 249         uint32_t cmd;
 250         union {
 251                 struct lttng_ust_channel channel;
 252                 struct lttng_ust_stream stream;
 253                 struct lttng_ust_event event;
 254                 struct lttng_ust_context context;
 255                 struct lttng_ust_tracer_version version;
 256         } u;
 257 };
 258
 259 /*
 260  * Data structure for the response from UST to the session daemon.
 261  * cmd_type is sent back in the reply for validation.
 262  */
 263 struct lttcomm_ust_reply {
 264         uint32_t handle;
 265         uint32_t cmd;
 266         uint32_t ret_code;      /* enum lttcomm_return_code */
 267         uint32_t ret_val;       /* return value */
 268         union {
 269                 struct {
 270                         uint64_t memory_map_size;
 271                 } channel;
 272                 struct {
 273                         uint64_t memory_map_size;
 274                 } stream;
 275                 struct lttng_ust_tracer_version version;
 276         } u;
 277 };
 278
 279 #endif /* HAVE_LIBLTTNG_UST_CTL */
 280
 281 extern int lttcomm_create_unix_sock(const char *pathname);
 282 extern int lttcomm_connect_unix_sock(const char *pathname);
 283 extern int lttcomm_accept_unix_sock(int sock);
 284 extern int lttcomm_listen_unix_sock(int sock);
 285 extern int lttcomm_close_unix_sock(int sock);
 286
 287 #define LTTCOMM_MAX_SEND_FDS    4
 288 /* Send a message accompanied by fd(s) over a unix socket. */
 289 extern ssize_t lttcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd);
 290 /* Recv a message accompanied by fd(s) from a unix socket */
 291 extern ssize_t lttcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd);
 292
 293 extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
 294 extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
 295
 296 extern ssize_t lttcomm_send_creds_unix_sock(int sock, void *buf, size_t len);
 297 extern ssize_t lttcomm_recv_creds_unix_sock(int sock, void *buf, size_t len,
 298                 struct ucred *creds);
 299
 300 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
 301 extern int lttcomm_setsockopt_creds_unix_sock(int sock);
 302
 303 #endif  /* _LTTNG_SESSIOND_COMM_H */