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