| 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 | #define LTTNG_RUNDIR "/var/run/lttng" |
| 33 | |
| 34 | /* Default unix socket path */ |
| 35 | #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-lttng-sessiond" |
| 36 | #define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-lttng-sessiond" |
| 37 | #define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-lttng-sessiond" |
| 38 | #define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-lttng-sessiond" |
| 39 | |
| 40 | /* Queue size of listen(2) */ |
| 41 | #define LTTNG_SESSIOND_COMM_MAX_LISTEN 64 |
| 42 | |
| 43 | /* |
| 44 | * Get the error code index from 0 since LTTCOMM_OK start at 1000 |
| 45 | */ |
| 46 | #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK) |
| 47 | |
| 48 | enum lttcomm_sessiond_command { |
| 49 | /* Tracer command */ |
| 50 | LTTNG_ADD_CONTEXT, |
| 51 | LTTNG_CALIBRATE, |
| 52 | LTTNG_DISABLE_CHANNEL, |
| 53 | LTTNG_DISABLE_EVENT, |
| 54 | LTTNG_DISABLE_ALL_EVENT, |
| 55 | LTTNG_ENABLE_CHANNEL, |
| 56 | LTTNG_ENABLE_EVENT, |
| 57 | LTTNG_ENABLE_ALL_EVENT, |
| 58 | /* Session daemon command */ |
| 59 | LTTNG_CREATE_SESSION, |
| 60 | LTTNG_DESTROY_SESSION, |
| 61 | LTTNG_LIST_CHANNELS, |
| 62 | LTTNG_LIST_DOMAINS, |
| 63 | LTTNG_LIST_EVENTS, |
| 64 | LTTNG_LIST_SESSIONS, |
| 65 | LTTNG_LIST_TRACEPOINTS, |
| 66 | LTTNG_REGISTER_CONSUMER, |
| 67 | LTTNG_START_TRACE, |
| 68 | LTTNG_STOP_TRACE, |
| 69 | }; |
| 70 | |
| 71 | /* |
| 72 | * lttcomm error code. |
| 73 | */ |
| 74 | enum lttcomm_return_code { |
| 75 | LTTCOMM_OK = 1000, /* Ok */ |
| 76 | LTTCOMM_ERR, /* Unknown Error */ |
| 77 | LTTCOMM_UND, /* Undefine command */ |
| 78 | LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */ |
| 79 | LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */ |
| 80 | LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */ |
| 81 | LTTCOMM_NO_SESSION, /* No session found */ |
| 82 | LTTCOMM_CREATE_FAIL, /* Create trace fail */ |
| 83 | LTTCOMM_SESSION_FAIL, /* Create session fail */ |
| 84 | LTTCOMM_START_FAIL, /* Start tracing fail */ |
| 85 | LTTCOMM_STOP_FAIL, /* Stop tracing fail */ |
| 86 | LTTCOMM_LIST_FAIL, /* Listing apps fail */ |
| 87 | LTTCOMM_NO_APPS, /* No traceable application */ |
| 88 | LTTCOMM_SESS_NOT_FOUND, /* Session name not found */ |
| 89 | LTTCOMM_NO_TRACE, /* No trace exist */ |
| 90 | LTTCOMM_FATAL, /* Session daemon had a fatal error */ |
| 91 | LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */ |
| 92 | LTTCOMM_SELECT_SESS, /* Must select a session */ |
| 93 | LTTCOMM_EXIST_SESS, /* Session name already exist */ |
| 94 | LTTCOMM_NO_EVENT, /* No event found */ |
| 95 | LTTCOMM_CONNECT_FAIL, /* Unable to connect to unix socket */ |
| 96 | LTTCOMM_APP_NOT_FOUND, /* App not found in traceable app list */ |
| 97 | LTTCOMM_KERN_NA, /* Kernel tracer unavalable */ |
| 98 | LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */ |
| 99 | LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */ |
| 100 | LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */ |
| 101 | LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */ |
| 102 | LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */ |
| 103 | LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */ |
| 104 | LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */ |
| 105 | LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */ |
| 106 | LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */ |
| 107 | LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */ |
| 108 | LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */ |
| 109 | LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */ |
| 110 | LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */ |
| 111 | LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */ |
| 112 | LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */ |
| 113 | LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */ |
| 114 | LTTCOMM_KERN_NO_SESSION, /* No kernel session found */ |
| 115 | LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */ |
| 116 | LTTCOMM_UST_SESS_FAIL, /* UST create session failed */ |
| 117 | LTTCOMM_UST_CHAN_EXIST, /* UST channel already exist */ |
| 118 | LTTCOMM_UST_CHAN_FAIL, /* UST create channel failed */ |
| 119 | LTTCOMM_UST_CHAN_NOT_FOUND, /* UST channel not found */ |
| 120 | LTTCOMM_UST_CHAN_DISABLE_FAIL, /* UST disable channel failed */ |
| 121 | LTTCOMM_UST_CHAN_ENABLE_FAIL, /* UST enable channel failed */ |
| 122 | LTTCOMM_UST_CONTEXT_FAIL, /* UST add context failed */ |
| 123 | LTTCOMM_UST_ENABLE_FAIL, /* UST enable event failed */ |
| 124 | LTTCOMM_UST_DISABLE_FAIL, /* UST disable event failed */ |
| 125 | LTTCOMM_UST_META_FAIL, /* UST open metadata failed */ |
| 126 | LTTCOMM_UST_START_FAIL, /* UST start trace failed */ |
| 127 | LTTCOMM_UST_STOP_FAIL, /* UST stop trace failed */ |
| 128 | LTTCOMM_UST_CONSUMER_FAIL, /* UST consumer start failed */ |
| 129 | LTTCOMM_UST_STREAM_FAIL, /* UST create stream failed */ |
| 130 | LTTCOMM_UST_DIR_FAIL, /* UST trace directory creation failed */ |
| 131 | LTTCOMM_UST_DIR_EXIST, /* UST trace directory exist */ |
| 132 | LTTCOMM_UST_NO_SESSION, /* No UST session found */ |
| 133 | LTTCOMM_UST_LIST_FAIL, /* UST listing events failed */ |
| 134 | |
| 135 | CONSUMERD_COMMAND_SOCK_READY, /* when consumerd command socket ready */ |
| 136 | CONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */ |
| 137 | CONSUMERD_ERROR_RECV_FD, /* error on receiving fds */ |
| 138 | CONSUMERD_ERROR_RECV_CMD, /* error on receiving command */ |
| 139 | CONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */ |
| 140 | CONSUMERD_POLL_NVAL, /* Poll on closed fd */ |
| 141 | CONSUMERD_POLL_HUP, /* All fds have hungup */ |
| 142 | CONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */ |
| 143 | CONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */ |
| 144 | CONSUMERD_OUTFD_ERROR, /* error opening the tracefile */ |
| 145 | CONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */ |
| 146 | CONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */ |
| 147 | CONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */ |
| 148 | CONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */ |
| 149 | /* MUST be last element */ |
| 150 | LTTCOMM_NR, /* Last element */ |
| 151 | }; |
| 152 | |
| 153 | /* |
| 154 | * Data structure received from lttng client to session daemon. |
| 155 | */ |
| 156 | struct lttcomm_session_msg { |
| 157 | uint32_t cmd_type; /* enum lttcomm_sessiond_command */ |
| 158 | struct lttng_session session; |
| 159 | struct lttng_domain domain; |
| 160 | union { |
| 161 | struct { |
| 162 | char channel_name[NAME_MAX]; |
| 163 | char name[NAME_MAX]; |
| 164 | } disable; |
| 165 | /* Event data */ |
| 166 | struct { |
| 167 | char channel_name[NAME_MAX]; |
| 168 | struct lttng_event event; |
| 169 | } enable; |
| 170 | /* Create channel */ |
| 171 | struct { |
| 172 | struct lttng_channel chan; |
| 173 | } channel; |
| 174 | /* Context */ |
| 175 | struct { |
| 176 | char channel_name[NAME_MAX]; |
| 177 | char event_name[NAME_MAX]; |
| 178 | struct lttng_event_context ctx; |
| 179 | } context; |
| 180 | /* Use by register_consumer */ |
| 181 | struct { |
| 182 | char path[PATH_MAX]; |
| 183 | } reg; |
| 184 | /* List */ |
| 185 | struct { |
| 186 | char channel_name[NAME_MAX]; |
| 187 | } list; |
| 188 | struct lttng_calibrate calibrate; |
| 189 | } u; |
| 190 | }; |
| 191 | |
| 192 | /* |
| 193 | * Data structure for the response from sessiond to the lttng client. |
| 194 | */ |
| 195 | struct lttcomm_lttng_msg { |
| 196 | uint32_t cmd_type; /* enum lttcomm_sessiond_command */ |
| 197 | uint32_t ret_code; /* enum lttcomm_return_code */ |
| 198 | uint32_t pid; /* pid_t */ |
| 199 | uint32_t data_size; |
| 200 | /* Contains: trace_name + data */ |
| 201 | char payload[]; |
| 202 | }; |
| 203 | |
| 204 | /* |
| 205 | * lttcomm_consumer_msg is the message sent from sessiond to consumerd |
| 206 | * to either add a channel, add a stream, update a stream, or stop |
| 207 | * operation. |
| 208 | */ |
| 209 | struct lttcomm_consumer_msg { |
| 210 | uint32_t cmd_type; /* enum consumerd_command */ |
| 211 | union { |
| 212 | struct { |
| 213 | int channel_key; |
| 214 | uint64_t max_sb_size; /* the subbuffer size for this channel */ |
| 215 | /* shm_fd and wait_fd are sent as ancillary data */ |
| 216 | uint64_t mmap_len; |
| 217 | } channel; |
| 218 | struct { |
| 219 | int channel_key; |
| 220 | int stream_key; |
| 221 | /* shm_fd and wait_fd are sent as ancillary data */ |
| 222 | uint32_t state; /* enum lttcomm_consumer_fd_state */ |
| 223 | enum lttng_event_output output; /* use splice or mmap to consume this fd */ |
| 224 | uint64_t mmap_len; |
| 225 | char path_name[PATH_MAX]; |
| 226 | } stream; |
| 227 | } u; |
| 228 | }; |
| 229 | |
| 230 | #ifdef CONFIG_LTTNG_TOOLS_HAVE_UST |
| 231 | |
| 232 | #include <lttng/ust-abi.h> |
| 233 | |
| 234 | /* |
| 235 | * Data structure for the commands sent from sessiond to UST. |
| 236 | */ |
| 237 | struct lttcomm_ust_msg { |
| 238 | uint32_t handle; |
| 239 | uint32_t cmd; |
| 240 | union { |
| 241 | struct lttng_ust_channel channel; |
| 242 | struct lttng_ust_stream stream; |
| 243 | struct lttng_ust_event event; |
| 244 | struct lttng_ust_context context; |
| 245 | struct lttng_ust_tracer_version version; |
| 246 | } u; |
| 247 | }; |
| 248 | |
| 249 | /* |
| 250 | * Data structure for the response from UST to the session daemon. |
| 251 | * cmd_type is sent back in the reply for validation. |
| 252 | */ |
| 253 | struct lttcomm_ust_reply { |
| 254 | uint32_t handle; |
| 255 | uint32_t cmd; |
| 256 | uint32_t ret_code; /* enum lttcomm_return_code */ |
| 257 | uint32_t ret_val; /* return value */ |
| 258 | union { |
| 259 | struct { |
| 260 | uint64_t memory_map_size; |
| 261 | } channel; |
| 262 | struct { |
| 263 | uint64_t memory_map_size; |
| 264 | } stream; |
| 265 | struct lttng_ust_tracer_version version; |
| 266 | } u; |
| 267 | }; |
| 268 | |
| 269 | #endif /* CONFIG_LTTNG_TOOLS_HAVE_UST */ |
| 270 | |
| 271 | extern int lttcomm_create_unix_sock(const char *pathname); |
| 272 | extern int lttcomm_connect_unix_sock(const char *pathname); |
| 273 | extern int lttcomm_accept_unix_sock(int sock); |
| 274 | extern int lttcomm_listen_unix_sock(int sock); |
| 275 | extern int lttcomm_close_unix_sock(int sock); |
| 276 | |
| 277 | #define LTTCOMM_MAX_SEND_FDS 4 |
| 278 | /* Send a message accompanied by fd(s) over a unix socket. */ |
| 279 | extern ssize_t lttcomm_send_fds_unix_sock(int sock, int *fds, size_t nb_fd); |
| 280 | /* Recv a message accompanied by fd(s) from a unix socket */ |
| 281 | extern ssize_t lttcomm_recv_fds_unix_sock(int sock, int *fds, size_t nb_fd); |
| 282 | |
| 283 | extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len); |
| 284 | extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len); |
| 285 | extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code); |
| 286 | |
| 287 | #endif /* _LTTNG_SESSIOND_COMM_H */ |