include/lttng-ust-comm.h

   1 #ifndef _LTTNG_UST_COMM_H
   2 #define _LTTNG_UST_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 #include <ust/lttng-ust-abi.h>
  32
  33 /*
  34  * Default timeout the application waits for the sessiond to send its
  35  * "register done" command. Can be overridden with the environment
  36  * variable "UST_REGISTER_TIMEOUT". Note that if the sessiond is not
  37  * found, the application proceeds directly without any delay.
  38  */
  39 #define LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS        3000
  40
  41 #define LTTNG_RUNDIR                        "/var/run/lttng"
  42
  43 /* Default unix socket path */
  44 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK     LTTNG_RUNDIR "/client-ltt-sessiond"
  45 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK       LTTNG_RUNDIR "/apps-ltt-sessiond"
  46 #define DEFAULT_HOME_APPS_UNIX_SOCK         "%s/.apps-ltt-sessiond"
  47 #define DEFAULT_HOME_CLIENT_UNIX_SOCK       "%s/.client-ltt-sessiond"
  48
  49 #define DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH   "/lttng-ust-apps-wait"
  50 #define DEFAULT_HOME_APPS_WAIT_SHM_PATH     "/lttng-ust-apps-wait-%u"
  51
  52 /* Queue size of listen(2) */
  53 #define MAX_LISTEN 10
  54
  55 /* Get the error code index from 0 since
  56  * LTTCOMM_OK start at 1000
  57  */
  58 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
  59
  60 /*
  61  * lttcomm error code.
  62  */
  63 enum lttcomm_return_code {
  64         LTTCOMM_OK = 1000,                              /* Ok */
  65         LTTCOMM_ERR,                                    /* Unknown Error */
  66         LTTCOMM_UND,                                    /* Undefine command */
  67         LTTCOMM_NOT_IMPLEMENTED,        /* Command not implemented */
  68         LTTCOMM_UNKNOWN_DOMAIN,         /* Tracing domain not known */
  69         LTTCOMM_ALLOC_FAIL,                             /* Trace allocation fail */
  70         LTTCOMM_NO_SESSION,                             /* No session found */
  71         LTTCOMM_CREATE_FAIL,                    /* Create trace fail */
  72         LTTCOMM_SESSION_FAIL,                   /* Create session fail */
  73         LTTCOMM_START_FAIL,                             /* Start tracing fail */
  74         LTTCOMM_STOP_FAIL,                              /* Stop tracing fail */
  75         LTTCOMM_LIST_FAIL,                              /* Listing apps fail */
  76         LTTCOMM_NO_APPS,                                /* No traceable application */
  77         LTTCOMM_SESS_NOT_FOUND,                 /* Session name not found */
  78         LTTCOMM_NO_TRACE,                               /* No trace exist */
  79         LTTCOMM_FATAL,                                  /* Session daemon had a fatal error */
  80         LTTCOMM_NO_TRACEABLE,                   /* Error for non traceable app */
  81         LTTCOMM_SELECT_SESS,                    /* Must select a session */
  82         LTTCOMM_EXIST_SESS,                             /* Session name already exist */
  83         LTTCOMM_NO_EVENT,                               /* No event found */
  84         LTTCOMM_KERN_NA,                                /* Kernel tracer unavalable */
  85         LTTCOMM_KERN_EVENT_EXIST,       /* Kernel event already exists */
  86         LTTCOMM_KERN_SESS_FAIL,                 /* Kernel create session failed */
  87         LTTCOMM_KERN_CHAN_FAIL,                 /* Kernel create channel failed */
  88         LTTCOMM_KERN_CHAN_NOT_FOUND,    /* Kernel channel not found */
  89         LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
  90         LTTCOMM_KERN_CHAN_ENABLE_FAIL,  /* Kernel enable channel failed */
  91         LTTCOMM_KERN_CONTEXT_FAIL,      /* Kernel add context failed */
  92         LTTCOMM_KERN_ENABLE_FAIL,               /* Kernel enable event failed */
  93         LTTCOMM_KERN_DISABLE_FAIL,              /* Kernel disable event failed */
  94         LTTCOMM_KERN_META_FAIL,                 /* Kernel open metadata failed */
  95         LTTCOMM_KERN_START_FAIL,                /* Kernel start trace failed */
  96         LTTCOMM_KERN_STOP_FAIL,                 /* Kernel stop trace failed */
  97         LTTCOMM_KERN_CONSUMER_FAIL,             /* Kernel consumer start failed */
  98         LTTCOMM_KERN_STREAM_FAIL,               /* Kernel create stream failed */
  99         LTTCOMM_KERN_DIR_FAIL,                  /* Kernel trace directory creation failed */
 100         LTTCOMM_KERN_DIR_EXIST,                 /* Kernel trace directory exist */
 101         LTTCOMM_KERN_NO_SESSION,                /* No kernel session found */
 102         LTTCOMM_KERN_LIST_FAIL,                 /* Kernel listing events failed */
 103         KCONSUMERD_COMMAND_SOCK_READY,  /* when kconsumerd command socket ready */
 104         KCONSUMERD_SUCCESS_RECV_FD,             /* success on receiving fds */
 105         KCONSUMERD_ERROR_RECV_FD,               /* error on receiving fds */
 106         KCONSUMERD_POLL_ERROR,                  /* Error in polling thread in kconsumerd */
 107         KCONSUMERD_POLL_NVAL,                   /* Poll on closed fd */
 108         KCONSUMERD_POLL_HUP,                    /* All fds have hungup */
 109         KCONSUMERD_EXIT_SUCCESS,                /* kconsumerd exiting normally */
 110         KCONSUMERD_EXIT_FAILURE,                /* kconsumerd exiting on error */
 111         KCONSUMERD_OUTFD_ERROR,                 /* error opening the tracefile */
 112         KCONSUMERD_SPLICE_EBADF,                /* EBADF from splice(2) */
 113         KCONSUMERD_SPLICE_EINVAL,               /* EINVAL from splice(2) */
 114         KCONSUMERD_SPLICE_ENOMEM,               /* ENOMEM from splice(2) */
 115         KCONSUMERD_SPLICE_ESPIPE,               /* ESPIPE from splice(2) */
 116         /* MUST be last element */
 117         LTTCOMM_NR,                                             /* Last element */
 118 };
 119
 120 /*
 121  * Data structure for the commands sent from sessiond to UST.
 122  */
 123 struct lttcomm_ust_msg {
 124         uint32_t handle;
 125         uint32_t cmd;
 126         union {
 127                 struct lttng_ust_tracer_version version;
 128                 struct lttng_ust_channel channel;
 129                 struct lttng_ust_stream stream;
 130                 struct lttng_ust_event event;
 131                 struct lttng_ust_context context;
 132         } u;
 133 };
 134
 135 /*
 136  * Data structure for the response from UST to the session daemon.
 137  * cmd_type is sent back in the reply for validation.
 138  */
 139 struct lttcomm_ust_reply {
 140         uint32_t handle;
 141         uint32_t cmd;
 142         uint32_t ret_code;      /* enum enum lttcomm_return_code */
 143         uint32_t ret_val;       /* return value */
 144         union {
 145                 struct {
 146                         uint64_t memory_map_size;
 147                 } channel;
 148                 struct {
 149                         uint64_t memory_map_size;
 150                 } stream;
 151         } u;
 152 };
 153
 154 extern int lttcomm_create_unix_sock(const char *pathname);
 155 extern int lttcomm_connect_unix_sock(const char *pathname);
 156 extern int lttcomm_accept_unix_sock(int sock);
 157 extern int lttcomm_listen_unix_sock(int sock);
 158 extern int lttcomm_close_unix_sock(int sock);
 159 /* Send fd(s) over a unix socket. */
 160 extern ssize_t lttcomm_send_fds_unix_sock(int sock, void *buf, int *fds,
 161                 size_t nb_fd, size_t len);
 162 extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
 163 extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
 164 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
 165
 166 #endif  /* _LTTNG_UST_COMM_H */