liblttsessiondcomm/liblttsessiondcomm.h

   1 /* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   2  *
   3  * This program is free software; you can redistribute it and/or
   4  * modify it under the terms of the GNU General Public License
   5  * as published by the Free Software Foundation; either version 2
   6  * of the License, or (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  16  *
  17  */
  18
  19 #ifndef _LIBLTTSESSIONDCOMM_H
  20 #define _LIBLTTSESSIONDCOMM_H
  21
  22 #include <limits.h>
  23 #include <uuid/uuid.h>
  24
  25 /* Default unix socket path */
  26 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK         "/tmp/client-ltt-sessiond"
  27 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK           "/tmp/apps-ltt-sessiond"
  28 #define DEFAULT_HOME_APPS_UNIX_SOCK                     "%s/.apps-ltt-sessiond"
  29 #define DEFAULT_HOME_CLIENT_UNIX_SOCK           "%s/.client-ltt-sessiond"
  30
  31 /* Queue size of listen(2) */
  32 #define MAX_LISTEN 10
  33
  34 /* Get the error code index from 0 since
  35  * LTTCOMM_OK start at 1000
  36  */
  37 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
  38
  39 enum lttcomm_command_type {
  40         LTTNG_CREATE_SESSION,
  41         LTTNG_DESTROY_SESSION,
  42         LTTNG_FORCE_SUBBUF_SWITCH,
  43         LTTNG_GET_ALL_SESSION,
  44         LTTNG_GET_SOCK_PATH,
  45         LTTNG_GET_SUBBUF_NUM_SIZE,
  46         LTTNG_LIST_MARKERS,
  47         LTTNG_LIST_SESSIONS,
  48         LTTNG_LIST_TRACES,
  49         LTTNG_LIST_TRACE_EVENTS,
  50         LTTNG_SETUP_TRACE,
  51         LTTNG_SET_SOCK_PATH,
  52         LTTNG_SET_SUBBUF_NUM,
  53         LTTNG_SET_SUBBUF_SIZE,
  54         UST_ALLOC_TRACE,
  55         UST_CREATE_TRACE,
  56         UST_DESTROY_TRACE,
  57         UST_DISABLE_MARKER,
  58         UST_ENABLE_MARKER,
  59         UST_LIST_APPS,
  60         UST_START_TRACE,
  61         UST_STOP_TRACE,
  62 };
  63
  64 /*
  65  * lttcomm error code.
  66  */
  67 enum lttcomm_return_code {
  68         LTTCOMM_OK = 1000,              /* Ok */
  69         LTTCOMM_ERR,                    /* Unknown Error */
  70         LTTCOMM_UND,                    /* Undefine command */
  71         LTTCOMM_ALLOC_FAIL,             /* Trace allocation fail */
  72         LTTCOMM_NO_SESSION,             /* No session found */
  73         LTTCOMM_CREATE_FAIL,    /* Create trace fail */
  74         LTTCOMM_SESSION_FAIL,   /* Create session fail */
  75         LTTCOMM_START_FAIL,             /* Start tracing fail */
  76         LTTCOMM_LIST_FAIL,              /* Listing apps fail */
  77         LTTCOMM_NO_APPS,                /* No traceable application */
  78         LTTCOMM_NO_SESS,                /* No sessions available */
  79         LTTCOMM_NO_TRACE,               /* No trace exist */
  80         LTTCOMM_FATAL,                  /* Session daemon had a fatal error */
  81         LTTCOMM_NO_TRACEABLE,   /* Error for non traceable app */
  82         LTTCOMM_SELECT_SESS,    /* Must select a session */
  83         LTTCOMM_EXIST_SESS,             /* Session name already exist */
  84         LTTCOMM_NR,                             /* Last element */
  85 };
  86
  87 /*
  88  * Data structure for ltt-session received message
  89  */
  90 struct lttcomm_session_msg {
  91         /* Common data to almost all command */
  92         enum lttcomm_command_type cmd_type;
  93         uuid_t session_id;
  94         char trace_name[NAME_MAX];
  95         char session_name[NAME_MAX];
  96         pid_t pid;
  97         union {
  98                 struct {
  99                         int auto_session;
 100                 } create_session;
 101                 /* Marker data */
 102                 struct {
 103                         char channel[NAME_MAX];
 104                         char marker[NAME_MAX];
 105                 } marker;
 106                 /* SET_SOCK_PATH */
 107                 struct {
 108                         char sock_path[PATH_MAX];
 109                 } sock_path;
 110                 /* SET_SUBBUF_NUM */
 111                 struct {
 112                         unsigned int subbuf_num;
 113                         char channel[NAME_MAX];
 114                 } subbuf_num;
 115                 /* SET_SUBBUF_SIZE */
 116                 struct {
 117                         unsigned int subbuf_size;
 118                         char channel[NAME_MAX];
 119                 } subbuf_size;
 120         } u;
 121 };
 122
 123 /*
 124  * Data structure for the lttng client response.
 125  *
 126  * This data structure is the control struct use in
 127  * the header of the transmission. NEVER put variable
 128  * size data in here.
 129  */
 130 struct lttcomm_lttng_msg {
 131         enum lttcomm_command_type cmd_type;
 132         enum lttcomm_return_code ret_code;
 133         uuid_t session_id;
 134         pid_t pid;
 135         char trace_name[NAME_MAX];
 136         unsigned int size_payload;
 137 };
 138
 139 extern int lttcomm_create_unix_sock(const char *pathname);
 140 extern int lttcomm_connect_unix_sock(const char *pathname);
 141 extern int lttcomm_accept_unix_sock(int sock);
 142 extern int lttcomm_listen_unix_sock(int sock);
 143 extern int lttcomm_close_unix_sock(int sock);
 144 extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
 145 extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
 146 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
 147
 148 #endif  /* _LIBLTTSESSIONDCOMM_H */