liblttsessiondcomm/liblttsessiondcomm.h

   1 /*
   2  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   3  *                      Julien Desfossez <julien.desfossez@polymtl.ca>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18  *
  19  */
  20
  21 #ifndef _LIBLTTSESSIONDCOMM_H
  22 #define _LIBLTTSESSIONDCOMM_H
  23
  24 #include <limits.h>
  25 #include <uuid/uuid.h>
  26
  27 #include "lttng-share.h"
  28
  29 /* Default unix socket path */
  30 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK         LTTNG_RUNDIR "/client-ltt-sessiond"
  31 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK           LTTNG_RUNDIR "/apps-ltt-sessiond"
  32 #define DEFAULT_HOME_APPS_UNIX_SOCK                     "%s/.apps-ltt-sessiond"
  33 #define DEFAULT_HOME_CLIENT_UNIX_SOCK           "%s/.client-ltt-sessiond"
  34
  35 /* Queue size of listen(2) */
  36 #define MAX_LISTEN 10
  37
  38 /* Get the error code index from 0 since
  39  * LTTCOMM_OK start at 1000
  40  */
  41 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
  42
  43 enum lttcomm_sessiond_command {
  44         KERNEL_CREATE_CHANNEL,
  45         KERNEL_CREATE_SESSION,
  46         KERNEL_CREATE_STREAM,
  47         KERNEL_DISABLE_EVENT,
  48         KERNEL_ENABLE_EVENT,
  49         KERNEL_LIST_EVENTS,
  50         KERNEL_OPEN_METADATA,
  51         KERNEL_START_TRACE,
  52         KERNEL_STOP_TRACE,
  53         LTTNG_CREATE_SESSION,
  54         LTTNG_DESTROY_SESSION,
  55         LTTNG_FORCE_SUBBUF_SWITCH,
  56         LTTNG_GET_ALL_SESSION,
  57         LTTNG_GET_SOCK_PATH,
  58         LTTNG_GET_SUBBUF_NUM_SIZE,
  59         LTTNG_LIST_MARKERS,
  60         LTTNG_LIST_SESSIONS,
  61         LTTNG_LIST_TRACES,
  62         LTTNG_LIST_TRACE_EVENTS,
  63         LTTNG_SETUP_TRACE,
  64         LTTNG_SET_SOCK_PATH,
  65         LTTNG_SET_SUBBUF_NUM,
  66         LTTNG_SET_SUBBUF_SIZE,
  67         UST_ALLOC_TRACE,
  68         UST_CREATE_TRACE,
  69         UST_DESTROY_TRACE,
  70         UST_DISABLE_MARKER,
  71         UST_ENABLE_MARKER,
  72         UST_LIST_APPS,
  73         UST_START_TRACE,
  74         UST_STOP_TRACE,
  75 };
  76
  77 /*
  78  * lttcomm error code.
  79  */
  80 enum lttcomm_return_code {
  81         LTTCOMM_OK = 1000,                              /* Ok */
  82         LTTCOMM_ERR,                                    /* Unknown Error */
  83         LTTCOMM_UND,                                    /* Undefine command */
  84         LTTCOMM_ALLOC_FAIL,                             /* Trace allocation fail */
  85         LTTCOMM_NO_SESSION,                             /* No session found */
  86         LTTCOMM_CREATE_FAIL,                    /* Create trace fail */
  87         LTTCOMM_SESSION_FAIL,                   /* Create session fail */
  88         LTTCOMM_START_FAIL,                             /* Start tracing fail */
  89         LTTCOMM_STOP_FAIL,                              /* Stop tracing fail */
  90         LTTCOMM_LIST_FAIL,                              /* Listing apps fail */
  91         LTTCOMM_NO_APPS,                                /* No traceable application */
  92         LTTCOMM_NO_SESS,                                /* No sessions available */
  93         LTTCOMM_NO_TRACE,                               /* No trace exist */
  94         LTTCOMM_FATAL,                                  /* Session daemon had a fatal error */
  95         LTTCOMM_NO_TRACEABLE,                   /* Error for non traceable app */
  96         LTTCOMM_SELECT_SESS,                    /* Must select a session */
  97         LTTCOMM_EXIST_SESS,                             /* Session name already exist */
  98         LTTCOMM_NO_EVENT,                               /* No event found */
  99         LTTCOMM_KERN_NA,                                /* Kernel tracer unavalable */
 100         LTTCOMM_KERN_SESS_FAIL,                 /* Kernel create session failed */
 101         LTTCOMM_KERN_CHAN_FAIL,                 /* Kernel create channel failed */
 102         LTTCOMM_KERN_ENABLE_FAIL,               /* Kernel enable event failed */
 103         LTTCOMM_KERN_DISABLE_FAIL,              /* Kernel disable event failed */
 104         LTTCOMM_KERN_META_FAIL,                 /* Kernel open metadata failed */
 105         LTTCOMM_KERN_START_FAIL,                /* Kernel start trace failed */
 106         LTTCOMM_KERN_STOP_FAIL,                 /* Kernel stop trace failed */
 107         LTTCOMM_KERN_CONSUMER_FAIL,             /* Kernel consumer start failed */
 108         LTTCOMM_KERN_STREAM_FAIL,               /* Kernel create stream failed */
 109         LTTCOMM_KERN_DIR_FAIL,                  /* Kernel trace directory creation failed */
 110         LTTCOMM_KERN_DIR_EXIST,                 /* Kernel trace directory exist */
 111         LTTCOMM_KERN_NO_SESSION,                /* No kernel session found */
 112         LTTCOMM_KERN_LIST_FAIL,                 /* Kernel listing events failed */
 113         KCONSUMERD_COMMAND_SOCK_READY,  /* when kconsumerd command socket ready */
 114         KCONSUMERD_SUCCESS_RECV_FD,             /* success on receiving fds */
 115         KCONSUMERD_ERROR_RECV_FD,               /* error on receiving fds */
 116         KCONSUMERD_POLL_ERROR,                  /* Error in polling thread in kconsumerd */
 117         KCONSUMERD_POLL_NVAL,                   /* Poll on closed fd */
 118         KCONSUMERD_POLL_HUP,                    /* All fds have hungup */
 119         KCONSUMERD_EXIT_SUCCESS,                /* kconsumerd exiting normally */
 120         KCONSUMERD_EXIT_FAILURE,                /* kconsumerd exiting on error */
 121         KCONSUMERD_OUTFD_ERROR,                 /* error opening the tracefile */
 122         KCONSUMERD_SPLICE_EBADF,                /* EBADF from splice(2) */
 123         KCONSUMERD_SPLICE_EINVAL,               /* EINVAL from splice(2) */
 124         KCONSUMERD_SPLICE_ENOMEM,               /* ENOMEM from splice(2) */
 125         KCONSUMERD_SPLICE_ESPIPE,               /* ESPIPE from splice(2) */
 126         /* MUST be last element */
 127         LTTCOMM_NR,                                             /* Last element */
 128 };
 129
 130 /*
 131  * Data structure received from lttng client to session daemon.
 132  */
 133 struct lttcomm_session_msg {
 134         u32 cmd_type;    /* enum lttcomm_sessiond_command */
 135         uuid_t session_uuid;
 136         char trace_name[NAME_MAX];
 137         char session_name[NAME_MAX];
 138         u32 pid;    /* pid_t */
 139         union {
 140                 struct {
 141                         int auto_session;
 142                 } create_session;
 143                 /* Marker data */
 144                 struct {
 145                         char event_name[NAME_MAX];
 146                 } event;
 147         } u;
 148 };
 149
 150 /*
 151  * Data structure for the response from sessiond to the lttng client.
 152  */
 153 struct lttcomm_lttng_msg {
 154         u32 cmd_type;   /* enum lttcomm_sessiond_command */
 155         u32 ret_code;   /* enum lttcomm_return_code */
 156         u32 pid;        /* pid_t */
 157         u32 trace_name_offset;
 158         u32 data_size;
 159         uuid_t session_uuid;
 160         /* Contains: trace_name + data */
 161         char payload[];
 162 };
 163
 164 /*
 165  * Data structures for the kconsumerd communications
 166  *
 167  * The header structure is sent to the kconsumerd daemon to inform
 168  * how many lttcomm_kconsumerd_msg it is about to receive
 169  */
 170 struct lttcomm_kconsumerd_header {
 171         u32 payload_size;
 172         u32 cmd_type;   /* enum kconsumerd_command */
 173 };
 174
 175 /* lttcomm_kconsumerd_msg represents a file descriptor to consume the
 176  * data and a path name to write it
 177  */
 178 struct lttcomm_kconsumerd_msg {
 179         char path_name[PATH_MAX];
 180         int fd;
 181         u32 state;    /* enum lttcomm_kconsumerd_fd_state */
 182         unsigned long max_sb_size; /* the subbuffer size for this channel */
 183 };
 184
 185 extern int lttcomm_create_unix_sock(const char *pathname);
 186 extern int lttcomm_connect_unix_sock(const char *pathname);
 187 extern int lttcomm_accept_unix_sock(int sock);
 188 extern int lttcomm_listen_unix_sock(int sock);
 189 extern int lttcomm_close_unix_sock(int sock);
 190 extern ssize_t lttcomm_send_fds_unix_sock(int sock, void *buf, int *fds, size_t nb_fd, size_t len);
 191 extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
 192 extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
 193 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
 194
 195 #endif  /* _LIBLTTSESSIONDCOMM_H */