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 #define LTTNG_RUNDIR                                            "/var/run/lttng"
  30
  31 /* Default unix socket path */
  32 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK         LTTNG_RUNDIR "/client-ltt-sessiond"
  33 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK           LTTNG_RUNDIR "/apps-ltt-sessiond"
  34 #define DEFAULT_HOME_APPS_UNIX_SOCK                     "%s/.apps-ltt-sessiond"
  35 #define DEFAULT_HOME_CLIENT_UNIX_SOCK           "%s/.client-ltt-sessiond"
  36
  37 /* Kernel consumer path */
  38 #define KCONSUMERD_PATH                                         LTTNG_RUNDIR "/kconsumerd"
  39 #define KCONSUMERD_CMD_SOCK_PATH                        KCONSUMERD_PATH "/command"
  40 #define KCONSUMERD_ERR_SOCK_PATH                        KCONSUMERD_PATH "/error"
  41
  42 /* Queue size of listen(2) */
  43 #define MAX_LISTEN 10
  44
  45 /* Get the error code index from 0 since
  46  * LTTCOMM_OK start at 1000
  47  */
  48 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
  49
  50 enum lttcomm_sessiond_command {
  51         KERNEL_CREATE_CHANNEL,
  52         KERNEL_CREATE_SESSION,
  53         KERNEL_DISABLE_EVENT,
  54         KERNEL_ENABLE_EVENT,
  55         KERNEL_START_TRACE,
  56         KERNEL_STOP_TRACE,
  57         LTTNG_CREATE_SESSION,
  58         LTTNG_DESTROY_SESSION,
  59         LTTNG_FORCE_SUBBUF_SWITCH,
  60         LTTNG_GET_ALL_SESSION,
  61         LTTNG_GET_SOCK_PATH,
  62         LTTNG_GET_SUBBUF_NUM_SIZE,
  63         LTTNG_LIST_MARKERS,
  64         LTTNG_LIST_SESSIONS,
  65         LTTNG_LIST_TRACES,
  66         LTTNG_LIST_TRACE_EVENTS,
  67         LTTNG_SETUP_TRACE,
  68         LTTNG_SET_SOCK_PATH,
  69         LTTNG_SET_SUBBUF_NUM,
  70         LTTNG_SET_SUBBUF_SIZE,
  71         UST_ALLOC_TRACE,
  72         UST_CREATE_TRACE,
  73         UST_DESTROY_TRACE,
  74         UST_DISABLE_MARKER,
  75         UST_ENABLE_MARKER,
  76         UST_LIST_APPS,
  77         UST_START_TRACE,
  78         UST_STOP_TRACE,
  79 };
  80
  81 /*
  82  * lttcomm error code.
  83  */
  84 enum lttcomm_return_code {
  85         LTTCOMM_OK = 1000,                              /* Ok */
  86         LTTCOMM_ERR,                                    /* Unknown Error */
  87         LTTCOMM_UND,                                    /* Undefine command */
  88         LTTCOMM_ALLOC_FAIL,                             /* Trace allocation fail */
  89         LTTCOMM_NO_SESSION,                             /* No session found */
  90         LTTCOMM_CREATE_FAIL,                    /* Create trace fail */
  91         LTTCOMM_SESSION_FAIL,                   /* Create session fail */
  92         LTTCOMM_START_FAIL,                             /* Start tracing fail */
  93         LTTCOMM_STOP_FAIL,                              /* Stop tracing fail */
  94         LTTCOMM_LIST_FAIL,                              /* Listing apps fail */
  95         LTTCOMM_NO_APPS,                                /* No traceable application */
  96         LTTCOMM_NO_SESS,                                /* No sessions available */
  97         LTTCOMM_NO_TRACE,                               /* No trace exist */
  98         LTTCOMM_FATAL,                                  /* Session daemon had a fatal error */
  99         LTTCOMM_NO_TRACEABLE,                   /* Error for non traceable app */
 100         LTTCOMM_SELECT_SESS,                    /* Must select a session */
 101         LTTCOMM_EXIST_SESS,                             /* Session name already exist */
 102         LTTCOMM_NO_EVENT,                               /* No event found */
 103         LTTCOMM_KERN_NA,                                /* Kernel tracer unavalable */
 104         LTTCOMM_KERN_SESS_FAIL,                 /* Kernel create session failed */
 105         LTTCOMM_KERN_CHAN_FAIL,                 /* Kernel create channel failed */
 106         KCONSUMERD_COMMAND_SOCK_READY,  /* when kconsumerd command socket ready */
 107         KCONSUMERD_SUCCESS_RECV_FD,             /* success on receiving fds */
 108         KCONSUMERD_ERROR_RECV_FD,               /* error on receiving fds */
 109         KCONSUMERD_POLL_ERROR,                  /* Error in polling thread in kconsumerd */
 110         KCONSUMERD_POLL_NVAL,                   /* Poll on closed fd */
 111         KCONSUMERD_POLL_HUP,                    /* All fds have hungup */
 112         KCONSUMERD_EXIT_SUCCESS,                /* kconsumerd exiting normally */
 113         KCONSUMERD_EXIT_FAILURE,                /* kconsumerd exiting on error */
 114         KCONSUMERD_OUTFD_ERROR,                 /* error opening the tracefile */
 115         /* MUST be last element */
 116         LTTCOMM_NR,                                             /* Last element */
 117 };
 118
 119 /* commands for kconsumerd */
 120 enum lttcomm_consumerd_command {
 121         LTTCOMM_ADD_STREAM = 1100,
 122         LTTCOMM_UPDATE_STREAM, /* pause, delete, start depending on fd state */
 123         LTTCOMM_STOP, /* delete all */
 124 };
 125
 126 /* state of each fd in consumerd */
 127 enum lttcomm_kconsumerd_fd_state {
 128         ACTIVE_FD,
 129         PAUSE_FD,
 130         DELETE_FD,
 131 };
 132
 133 /*
 134  * Data structure received from lttng client to session daemon.
 135  */
 136 struct lttcomm_session_msg {
 137         u32 cmd_type;    /* enum lttcomm_sessiond_command */
 138         uuid_t session_uuid;
 139         char trace_name[NAME_MAX];
 140         char session_name[NAME_MAX];
 141         u32 pid;    /* pid_t */
 142         union {
 143                 struct {
 144                         int auto_session;
 145                 } create_session;
 146                 /* Marker data */
 147                 struct {
 148                         char event_name[NAME_MAX];
 149                 } event;
 150         } u;
 151 };
 152
 153 /*
 154  * Data structure for the response from sessiond to the lttng client.
 155  */
 156 struct lttcomm_lttng_msg {
 157         u32 cmd_type;   /* enum lttcomm_sessiond_command */
 158         u32 ret_code;   /* enum lttcomm_return_code */
 159         u32 pid;        /* pid_t */
 160         u32 trace_name_offset;
 161         u32 data_size;
 162         uuid_t session_uuid;
 163         /* Contains: trace_name + data */
 164         char payload[];
 165 };
 166
 167 /*
 168  * Data structures for the kconsumerd communications
 169  *
 170  * The header structure is sent to the kconsumerd daemon to inform
 171  * how many lttcomm_kconsumerd_msg it is about to receive
 172  */
 173 struct lttcomm_kconsumerd_header {
 174         u32 payload_size;
 175         u32 cmd_type;   /* enum lttcomm_consumerd_command */
 176         u32 ret_code;   /* enum lttcomm_return_code */
 177 };
 178
 179 /* lttcomm_kconsumerd_msg represents a file descriptor to consume the
 180  * data and a path name to write it
 181  */
 182 struct lttcomm_kconsumerd_msg {
 183         char path_name[PATH_MAX];
 184         int fd;
 185         u32 state;    /* enum lttcomm_kconsumerd_fd_state */
 186         unsigned long max_sb_size; /* the subbuffer size for this channel */
 187 };
 188
 189 extern int lttcomm_create_unix_sock(const char *pathname);
 190 extern int lttcomm_connect_unix_sock(const char *pathname);
 191 extern int lttcomm_accept_unix_sock(int sock);
 192 extern int lttcomm_listen_unix_sock(int sock);
 193 extern int lttcomm_close_unix_sock(int sock);
 194 extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
 195 extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
 196 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
 197
 198 #endif  /* _LIBLTTSESSIONDCOMM_H */