019f92ec51d6ec62a7e610cb40a3a32fea3f4429
[lttng-tools.git] / include / lttng-sessiond-comm.h
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-ltt-sessiond"
36 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-ltt-sessiond"
37 #define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-ltt-sessiond"
38 #define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-ltt-sessiond"
39
40 /* Queue size of listen(2) */
41 #define MAX_LISTEN 10
42
43 /* Get the error code index from 0 since
44 * 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_KERN_NA, /* Kernel tracer unavalable */
97 LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
98 LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
99 LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
100 LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
101 LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
102 LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
103 LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
104 LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
105 LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
106 LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
107 LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
108 LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
109 LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
110 LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
111 LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
112 LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
113 LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
114 LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
115 KCONSUMERD_COMMAND_SOCK_READY, /* when kconsumerd command socket ready */
116 KCONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
117 KCONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
118 KCONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
119 KCONSUMERD_POLL_NVAL, /* Poll on closed fd */
120 KCONSUMERD_POLL_HUP, /* All fds have hungup */
121 KCONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
122 KCONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
123 KCONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
124 KCONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
125 KCONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
126 KCONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
127 KCONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
128 /* MUST be last element */
129 LTTCOMM_NR, /* Last element */
130 };
131
132 /*
133 * Data structure received from lttng client to session daemon.
134 */
135 struct lttcomm_session_msg {
136 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
137 struct lttng_session session;
138 struct lttng_domain domain;
139 union {
140 struct {
141 char channel_name[NAME_MAX];
142 char name[NAME_MAX];
143 } disable;
144 /* Event data */
145 struct {
146 char channel_name[NAME_MAX];
147 struct lttng_event event;
148 } enable;
149 /* Create channel */
150 struct {
151 struct lttng_channel chan;
152 } channel;
153 /* Context */
154 struct {
155 char channel_name[NAME_MAX];
156 char event_name[NAME_MAX];
157 struct lttng_event_context ctx;
158 } context;
159 /* Use by register_consumer */
160 struct {
161 char path[PATH_MAX];
162 } reg;
163 /* List */
164 struct {
165 char channel_name[NAME_MAX];
166 } list;
167 struct lttng_calibrate calibrate;
168 } u;
169 };
170
171 /*
172 * Data structure for the response from sessiond to the lttng client.
173 */
174 struct lttcomm_lttng_msg {
175 uint32_t cmd_type; /* enum lttcomm_sessiond_command */
176 uint32_t ret_code; /* enum lttcomm_return_code */
177 uint32_t pid; /* pid_t */
178 uint32_t data_size;
179 /* Contains: trace_name + data */
180 char payload[];
181 };
182
183 /*
184 * Data structures for the kconsumerd communications
185 *
186 * The header structure is sent to the kconsumerd daemon to inform
187 * how many lttcomm_kconsumerd_msg it is about to receive
188 */
189 struct lttcomm_kconsumerd_header {
190 uint32_t payload_size;
191 uint32_t cmd_type; /* enum kconsumerd_command */
192 };
193
194 /* lttcomm_kconsumerd_msg represents a file descriptor to consume the
195 * data and a path name to write it
196 */
197 struct lttcomm_kconsumerd_msg {
198 char path_name[PATH_MAX];
199 int fd;
200 uint32_t state; /* enum lttcomm_kconsumerd_fd_state */
201 unsigned long max_sb_size; /* the subbuffer size for this channel */
202 enum lttng_event_output output; /* use splice or mmap to consume this fd */
203 };
204
205 extern int lttcomm_create_unix_sock(const char *pathname);
206 extern int lttcomm_connect_unix_sock(const char *pathname);
207 extern int lttcomm_accept_unix_sock(int sock);
208 extern int lttcomm_listen_unix_sock(int sock);
209 extern int lttcomm_close_unix_sock(int sock);
210 /* Send fd(s) over a unix socket. */
211 extern ssize_t lttcomm_send_fds_unix_sock(int sock, void *buf, int *fds,
212 size_t nb_fd, size_t len);
213 extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
214 extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
215 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
216
217 #endif /* _LTTNG_SESSIOND_COMM_H */
This page took 0.048405 seconds and 3 git commands to generate.