Update version to 2.0-pre3
[lttng-tools.git] / liblttsessiondcomm / liblttsessiondcomm.h
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Julien Desfossez <julien.desfossez@polymtl.ca>
4 *
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; only version 2
8 * of the License.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 *
19 */
20
21 #ifndef _LIBLTTSESSIONDCOMM_H
22 #define _LIBLTTSESSIONDCOMM_H
23
24 #include <limits.h>
25
26 #include <lttng/lttng.h>
27 #include "lttng-share.h"
28
29 /* Default unix socket path */
30 #define DEFAULT_GLOBAL_CLIENT_UNIX_SOCK LTTNG_RUNDIR "/client-ltt-sessiond"
31 #define DEFAULT_GLOBAL_APPS_UNIX_SOCK LTTNG_RUNDIR "/apps-ltt-sessiond"
32 #define DEFAULT_HOME_APPS_UNIX_SOCK "%s/.apps-ltt-sessiond"
33 #define DEFAULT_HOME_CLIENT_UNIX_SOCK "%s/.client-ltt-sessiond"
34
35 /* Queue size of listen(2) */
36 #define MAX_LISTEN 10
37
38 /* Get the error code index from 0 since
39 * LTTCOMM_OK start at 1000
40 */
41 #define LTTCOMM_ERR_INDEX(code) (code - LTTCOMM_OK)
42
43 enum lttcomm_sessiond_command {
44 /* Tracer context command */
45 LTTNG_KERNEL_ADD_CONTEXT,
46 LTTNG_KERNEL_DISABLE_CHANNEL,
47 LTTNG_KERNEL_DISABLE_EVENT,
48 LTTNG_KERNEL_DISABLE_ALL_EVENT,
49 LTTNG_KERNEL_ENABLE_CHANNEL,
50 LTTNG_KERNEL_ENABLE_EVENT,
51 LTTNG_KERNEL_ENABLE_ALL_EVENT,
52 LTTNG_KERNEL_LIST_EVENTS,
53 /* Session daemon context command */
54 LTTNG_CREATE_SESSION,
55 LTTNG_DESTROY_SESSION,
56 LTTNG_LIST_SESSIONS,
57 LTTNG_LIST_TRACES,
58 LTTNG_LIST_EVENTS,
59 LTTNG_LIST_TRACEABLE_APPS,
60 LTTNG_START_TRACE,
61 LTTNG_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_NOT_IMPLEMENTED, /* Command not implemented */
72 LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */
73 LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */
74 LTTCOMM_NO_SESSION, /* No session found */
75 LTTCOMM_CREATE_FAIL, /* Create trace fail */
76 LTTCOMM_SESSION_FAIL, /* Create session fail */
77 LTTCOMM_START_FAIL, /* Start tracing fail */
78 LTTCOMM_STOP_FAIL, /* Stop tracing fail */
79 LTTCOMM_LIST_FAIL, /* Listing apps fail */
80 LTTCOMM_NO_APPS, /* No traceable application */
81 LTTCOMM_SESS_NOT_FOUND, /* Session name not found */
82 LTTCOMM_NO_TRACE, /* No trace exist */
83 LTTCOMM_FATAL, /* Session daemon had a fatal error */
84 LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */
85 LTTCOMM_SELECT_SESS, /* Must select a session */
86 LTTCOMM_EXIST_SESS, /* Session name already exist */
87 LTTCOMM_NO_EVENT, /* No event found */
88 LTTCOMM_KERN_NA, /* Kernel tracer unavalable */
89 LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */
90 LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */
91 LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */
92 LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */
93 LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */
94 LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */
95 LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */
96 LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */
97 LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */
98 LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */
99 LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */
100 LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */
101 LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */
102 LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */
103 LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */
104 LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */
105 LTTCOMM_KERN_NO_SESSION, /* No kernel session found */
106 LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */
107 KCONSUMERD_COMMAND_SOCK_READY, /* when kconsumerd command socket ready */
108 KCONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */
109 KCONSUMERD_ERROR_RECV_FD, /* error on receiving fds */
110 KCONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */
111 KCONSUMERD_POLL_NVAL, /* Poll on closed fd */
112 KCONSUMERD_POLL_HUP, /* All fds have hungup */
113 KCONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */
114 KCONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */
115 KCONSUMERD_OUTFD_ERROR, /* error opening the tracefile */
116 KCONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */
117 KCONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */
118 KCONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */
119 KCONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */
120 /* MUST be last element */
121 LTTCOMM_NR, /* Last element */
122 };
123
124 /*
125 * Data structure received from lttng client to session daemon.
126 */
127 struct lttcomm_session_msg {
128 u32 cmd_type; /* enum lttcomm_sessiond_command */
129 char session_name[NAME_MAX];
130 char path[PATH_MAX];
131 pid_t pid;
132 union {
133 struct {
134 char channel_name[NAME_MAX];
135 char name[NAME_MAX];
136 } disable;
137 /* Event data */
138 struct {
139 char channel_name[NAME_MAX];
140 struct lttng_event event;
141 } enable;
142 /* Create channel */
143 struct {
144 struct lttng_channel chan;
145 } channel;
146 /* Context */
147 struct {
148 char channel_name[NAME_MAX];
149 char event_name[NAME_MAX];
150 struct lttng_event_context ctx;
151 } context;
152 } u;
153 };
154
155 /*
156 * Data structure for the response from sessiond to the lttng client.
157 */
158 struct lttcomm_lttng_msg {
159 u32 cmd_type; /* enum lttcomm_sessiond_command */
160 u32 ret_code; /* enum lttcomm_return_code */
161 u32 pid; /* pid_t */
162 u32 data_size;
163 /* Contains: trace_name + data */
164 char payload[];
165 };
166
167 /*
168 * Data structures for the kconsumerd communications
169 *
170 * The header structure is sent to the kconsumerd daemon to inform
171 * how many lttcomm_kconsumerd_msg it is about to receive
172 */
173 struct lttcomm_kconsumerd_header {
174 u32 payload_size;
175 u32 cmd_type; /* enum kconsumerd_command */
176 };
177
178 /* lttcomm_kconsumerd_msg represents a file descriptor to consume the
179 * data and a path name to write it
180 */
181 struct lttcomm_kconsumerd_msg {
182 char path_name[PATH_MAX];
183 int fd;
184 u32 state; /* enum lttcomm_kconsumerd_fd_state */
185 unsigned long max_sb_size; /* the subbuffer size for this channel */
186 };
187
188 extern int lttcomm_create_unix_sock(const char *pathname);
189 extern int lttcomm_connect_unix_sock(const char *pathname);
190 extern int lttcomm_accept_unix_sock(int sock);
191 extern int lttcomm_listen_unix_sock(int sock);
192 extern int lttcomm_close_unix_sock(int sock);
193 extern ssize_t lttcomm_send_fds_unix_sock(int sock, void *buf, int *fds, size_t nb_fd, size_t len);
194 extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len);
195 extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len);
196 extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code);
197
198 #endif /* _LIBLTTSESSIONDCOMM_H */
This page took 0.048284 seconds and 4 git commands to generate.