include/lttng/lttng-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 #include <limits.h>
  30 #include <lttng/lttng.h>
  31
  32 /* Default unix socket path */
  33 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK         LTTNG_RUNDIR "/client-ltt-sessiond"
  34 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK           LTTNG_RUNDIR "/apps-ltt-sessiond"
  35 #define DEFAULT_HOME_APPS_UNIX_SOCK                     "%s/.apps-ltt-sessiond"
  36 #define DEFAULT_HOME_CLIENT_UNIX_SOCK           "%s/.client-ltt-sessiond"
  37
  38 /* Queue size of listen(2) */
  39 #define MAX_LISTEN 10
  40
  41 /* Get the error code index from 0 since
  42  * 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_DISABLE_CHANNEL,
  50         LTTNG_DISABLE_EVENT,
  51         LTTNG_DISABLE_ALL_EVENT,
  52         LTTNG_ENABLE_CHANNEL,
  53         LTTNG_ENABLE_EVENT,
  54         LTTNG_ENABLE_ALL_EVENT,
  55         /* Session daemon command */
  56         LTTNG_CREATE_SESSION,
  57         LTTNG_DESTROY_SESSION,
  58         LTTNG_LIST_CHANNELS,
  59         LTTNG_LIST_DOMAINS,
  60         LTTNG_LIST_EVENTS,
  61         LTTNG_LIST_SESSIONS,
  62         LTTNG_LIST_TRACEPOINTS,
  63         LTTNG_START_TRACE,
  64         LTTNG_STOP_TRACE,
  65         LTTNG_CALIBRATE,
  66 };
  67
  68 /*
  69  * lttcomm error code.
  70  */
  71 enum lttcomm_return_code {
  72         LTTCOMM_OK = 1000,                              /* 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_FAIL,                    /* Create trace 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_KERN_NA,                                /* Kernel tracer unavalable */
  93         LTTCOMM_KERN_EVENT_EXIST,       /* Kernel event already exists */
  94         LTTCOMM_KERN_SESS_FAIL,                 /* Kernel create session failed */
  95         LTTCOMM_KERN_CHAN_FAIL,                 /* Kernel create channel failed */
  96         LTTCOMM_KERN_CHAN_NOT_FOUND,    /* Kernel channel not found */
  97         LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
  98         LTTCOMM_KERN_CHAN_ENABLE_FAIL,  /* Kernel enable channel failed */
  99         LTTCOMM_KERN_CONTEXT_FAIL,      /* Kernel add context failed */
 100         LTTCOMM_KERN_ENABLE_FAIL,               /* Kernel enable event failed */
 101         LTTCOMM_KERN_DISABLE_FAIL,              /* Kernel disable event failed */
 102         LTTCOMM_KERN_META_FAIL,                 /* Kernel open metadata failed */
 103         LTTCOMM_KERN_START_FAIL,                /* Kernel start trace failed */
 104         LTTCOMM_KERN_STOP_FAIL,                 /* Kernel stop trace failed */
 105         LTTCOMM_KERN_CONSUMER_FAIL,             /* Kernel consumer start failed */
 106         LTTCOMM_KERN_STREAM_FAIL,               /* Kernel create stream failed */
 107         LTTCOMM_KERN_DIR_FAIL,                  /* Kernel trace directory creation failed */
 108         LTTCOMM_KERN_DIR_EXIST,                 /* Kernel trace directory exist */
 109         LTTCOMM_KERN_NO_SESSION,                /* No kernel session found */
 110         LTTCOMM_KERN_LIST_FAIL,                 /* Kernel listing events failed */
 111         KCONSUMERD_COMMAND_SOCK_READY,  /* when kconsumerd command socket ready */
 112         KCONSUMERD_SUCCESS_RECV_FD,             /* success on receiving fds */
 113         KCONSUMERD_ERROR_RECV_FD,               /* error on receiving fds */
 114         KCONSUMERD_POLL_ERROR,                  /* Error in polling thread in kconsumerd */
 115         KCONSUMERD_POLL_NVAL,                   /* Poll on closed fd */
 116         KCONSUMERD_POLL_HUP,                    /* All fds have hungup */
 117         KCONSUMERD_EXIT_SUCCESS,                /* kconsumerd exiting normally */
 118         KCONSUMERD_EXIT_FAILURE,                /* kconsumerd exiting on error */
 119         KCONSUMERD_OUTFD_ERROR,                 /* error opening the tracefile */
 120         KCONSUMERD_SPLICE_EBADF,                /* EBADF from splice(2) */
 121         KCONSUMERD_SPLICE_EINVAL,               /* EINVAL from splice(2) */
 122         KCONSUMERD_SPLICE_ENOMEM,               /* ENOMEM from splice(2) */
 123         KCONSUMERD_SPLICE_ESPIPE,               /* ESPIPE from splice(2) */
 124         /* MUST be last element */
 125         LTTCOMM_NR,                                             /* Last element */
 126 };
 127
 128 /*
 129  * Data structure received from lttng client to session daemon.
 130  */
 131 struct lttcomm_session_msg {
 132         uint32_t cmd_type;    /* enum lttcomm_sessiond_command */
 133         struct lttng_session session;
 134         struct lttng_domain domain;
 135         union {
 136                 struct {
 137                         char channel_name[NAME_MAX];
 138                         char name[NAME_MAX];
 139                 } disable;
 140                 /* Event data */
 141                 struct {
 142                         char channel_name[NAME_MAX];
 143                         struct lttng_event event;
 144                 } enable;
 145                 /* Create channel */
 146                 struct {
 147                         struct lttng_channel chan;
 148                 } channel;
 149                 /* Context */
 150                 struct {
 151                         char channel_name[NAME_MAX];
 152                         char event_name[NAME_MAX];
 153                         struct lttng_event_context ctx;
 154                 } context;
 155                 /* List */
 156                 struct {
 157                         char channel_name[NAME_MAX];
 158                 } list;
 159                 struct lttng_calibrate calibrate;
 160         } u;
 161 };
 162
 163 /*
 164  * Data structure for the response from sessiond to the lttng client.
 165  */
 166 struct lttcomm_lttng_msg {
 167         uint32_t cmd_type;   /* enum lttcomm_sessiond_command */
 168         uint32_t ret_code;   /* enum lttcomm_return_code */
 169         uint32_t pid;        /* pid_t */
 170         uint32_t data_size;
 171         /* Contains: trace_name + data */
 172         char payload[];
 173 };
 174
 175 /*
 176  * Data structures for the kconsumerd communications
 177  *
 178  * The header structure is sent to the kconsumerd daemon to inform
 179  * how many lttcomm_kconsumerd_msg it is about to receive
 180  */
 181 struct lttcomm_kconsumerd_header {
 182         uint32_t payload_size;
 183         uint32_t cmd_type;      /* enum kconsumerd_command */
 184 };
 185
 186 /* lttcomm_kconsumerd_msg represents a file descriptor to consume the
 187  * data and a path name to write it
 188  */
 189 struct lttcomm_kconsumerd_msg {
 190         char path_name[PATH_MAX];
 191         int fd;
 192         uint32_t state;    /* enum lttcomm_kconsumerd_fd_state */
 193         unsigned long max_sb_size; /* the subbuffer size for this channel */
 194 };
 195
 196 extern int lttcomm_create_unix_sock(const char *pathname);
 197 extern int lttcomm_connect_unix_sock(const char *pathname);
 198 extern int lttcomm_accept_unix_sock(int sock);
 199 extern int lttcomm_listen_unix_sock(int sock);
 200 extern int lttcomm_close_unix_sock(int sock);
 201 extern ssize_t lttcomm_send_fds_unix_sock(int sock, void *buf, int *fds,
 202                                           size_t nb_fd, size_t len);
 203 extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
 204 extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
 205 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
 206
 207 #endif  /* _LTTNG_SESSIOND_COMM_H */