Commit | Line | Data |
---|---|---|
67c5b804 MD |
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 | ||
e7723462 | 48 | enum lttcomm_ust_command { |
1ece9766 MD |
49 | LTTNG_UST_CREATE_SESSION, |
50 | LTTNG_UST_RELEASE_SESSION, | |
51 | LTTNG_UST_VERSION, | |
52 | LTTNG_UST_LIST_TRACEPOINTS, | |
53 | LTTNG_UST_WAIT_QUIESCENT, | |
54 | LTTNG_UST_CALIBRATE, | |
55 | ||
56 | /* Apply on session handle */ | |
57 | LTTNG_UST_METADATA, /* release with LTTNG_UST_RELEASE_CHANNEL */ | |
58 | LTTNG_UST_CHANNEL, | |
59 | LTTNG_UST_RELEASE_CHANNEL, | |
60 | LTTNG_UST_SESSION_START, | |
61 | LTTNG_UST_SESSION_STOP, | |
62 | ||
63 | /* Apply on channel handle */ | |
64 | LTTNG_UST_STREAM, | |
65 | LTTNG_UST_RELEASE_STREAM, | |
66 | LTTNG_UST_EVENT, | |
67 | LTTNG_UST_RELEASE_EVENT, | |
68 | ||
69 | /* Apply on event and channel handle */ | |
70 | LTTNG_UST_CONTEXT, | |
71 | LTTNG_UST_RELEASE_CONTEXT, | |
72 | ||
73 | /* Apply on event, channel and session handle */ | |
74 | LTTNG_UST_ENABLE, | |
75 | LTTNG_UST_DISABLE, | |
67c5b804 MD |
76 | }; |
77 | ||
78 | /* | |
79 | * lttcomm error code. | |
80 | */ | |
81 | enum lttcomm_return_code { | |
82 | LTTCOMM_OK = 1000, /* Ok */ | |
83 | LTTCOMM_ERR, /* Unknown Error */ | |
84 | LTTCOMM_UND, /* Undefine command */ | |
85 | LTTCOMM_NOT_IMPLEMENTED, /* Command not implemented */ | |
86 | LTTCOMM_UNKNOWN_DOMAIN, /* Tracing domain not known */ | |
87 | LTTCOMM_ALLOC_FAIL, /* Trace allocation fail */ | |
88 | LTTCOMM_NO_SESSION, /* No session found */ | |
89 | LTTCOMM_CREATE_FAIL, /* Create trace fail */ | |
90 | LTTCOMM_SESSION_FAIL, /* Create session fail */ | |
91 | LTTCOMM_START_FAIL, /* Start tracing fail */ | |
92 | LTTCOMM_STOP_FAIL, /* Stop tracing fail */ | |
93 | LTTCOMM_LIST_FAIL, /* Listing apps fail */ | |
94 | LTTCOMM_NO_APPS, /* No traceable application */ | |
95 | LTTCOMM_SESS_NOT_FOUND, /* Session name not found */ | |
96 | LTTCOMM_NO_TRACE, /* No trace exist */ | |
97 | LTTCOMM_FATAL, /* Session daemon had a fatal error */ | |
98 | LTTCOMM_NO_TRACEABLE, /* Error for non traceable app */ | |
99 | LTTCOMM_SELECT_SESS, /* Must select a session */ | |
100 | LTTCOMM_EXIST_SESS, /* Session name already exist */ | |
101 | LTTCOMM_NO_EVENT, /* No event found */ | |
102 | LTTCOMM_KERN_NA, /* Kernel tracer unavalable */ | |
103 | LTTCOMM_KERN_EVENT_EXIST, /* Kernel event already exists */ | |
104 | LTTCOMM_KERN_SESS_FAIL, /* Kernel create session failed */ | |
105 | LTTCOMM_KERN_CHAN_FAIL, /* Kernel create channel failed */ | |
106 | LTTCOMM_KERN_CHAN_NOT_FOUND, /* Kernel channel not found */ | |
107 | LTTCOMM_KERN_CHAN_DISABLE_FAIL, /* Kernel disable channel failed */ | |
108 | LTTCOMM_KERN_CHAN_ENABLE_FAIL, /* Kernel enable channel failed */ | |
109 | LTTCOMM_KERN_CONTEXT_FAIL, /* Kernel add context failed */ | |
110 | LTTCOMM_KERN_ENABLE_FAIL, /* Kernel enable event failed */ | |
111 | LTTCOMM_KERN_DISABLE_FAIL, /* Kernel disable event failed */ | |
112 | LTTCOMM_KERN_META_FAIL, /* Kernel open metadata failed */ | |
113 | LTTCOMM_KERN_START_FAIL, /* Kernel start trace failed */ | |
114 | LTTCOMM_KERN_STOP_FAIL, /* Kernel stop trace failed */ | |
115 | LTTCOMM_KERN_CONSUMER_FAIL, /* Kernel consumer start failed */ | |
116 | LTTCOMM_KERN_STREAM_FAIL, /* Kernel create stream failed */ | |
117 | LTTCOMM_KERN_DIR_FAIL, /* Kernel trace directory creation failed */ | |
118 | LTTCOMM_KERN_DIR_EXIST, /* Kernel trace directory exist */ | |
119 | LTTCOMM_KERN_NO_SESSION, /* No kernel session found */ | |
120 | LTTCOMM_KERN_LIST_FAIL, /* Kernel listing events failed */ | |
121 | KCONSUMERD_COMMAND_SOCK_READY, /* when kconsumerd command socket ready */ | |
122 | KCONSUMERD_SUCCESS_RECV_FD, /* success on receiving fds */ | |
123 | KCONSUMERD_ERROR_RECV_FD, /* error on receiving fds */ | |
124 | KCONSUMERD_POLL_ERROR, /* Error in polling thread in kconsumerd */ | |
125 | KCONSUMERD_POLL_NVAL, /* Poll on closed fd */ | |
126 | KCONSUMERD_POLL_HUP, /* All fds have hungup */ | |
127 | KCONSUMERD_EXIT_SUCCESS, /* kconsumerd exiting normally */ | |
128 | KCONSUMERD_EXIT_FAILURE, /* kconsumerd exiting on error */ | |
129 | KCONSUMERD_OUTFD_ERROR, /* error opening the tracefile */ | |
130 | KCONSUMERD_SPLICE_EBADF, /* EBADF from splice(2) */ | |
131 | KCONSUMERD_SPLICE_EINVAL, /* EINVAL from splice(2) */ | |
132 | KCONSUMERD_SPLICE_ENOMEM, /* ENOMEM from splice(2) */ | |
133 | KCONSUMERD_SPLICE_ESPIPE, /* ESPIPE from splice(2) */ | |
134 | /* MUST be last element */ | |
135 | LTTCOMM_NR, /* Last element */ | |
136 | }; | |
137 | ||
1ece9766 MD |
138 | #define LTTNG_SYM_NAME_LEN 128 |
139 | ||
140 | enum lttng_ust_instrumentation { | |
141 | LTTNG_UST_TRACEPOINT = 0, | |
142 | LTTNG_UST_PROBE = 1, | |
143 | LTTNG_UST_FUNCTION = 2, | |
144 | }; | |
145 | ||
146 | enum lttng_ust_output { | |
147 | LTTNG_UST_MMAP = 0, | |
148 | }; | |
149 | ||
150 | struct lttng_ust_tracer_version { | |
151 | uint32_t version; | |
152 | uint32_t patchlevel; | |
153 | uint32_t sublevel; | |
154 | }; | |
155 | ||
156 | struct lttng_ust_channel { | |
157 | int overwrite; /* 1: overwrite, 0: discard */ | |
158 | uint64_t subbuf_size; /* in bytes */ | |
159 | uint64_t num_subbuf; | |
160 | unsigned int switch_timer_interval; /* usecs */ | |
161 | unsigned int read_timer_interval; /* usecs */ | |
162 | enum lttng_ust_output output; /* output mode */ | |
163 | }; | |
164 | ||
165 | struct lttng_ust_event { | |
166 | char name[LTTNG_SYM_NAME_LEN]; /* event name */ | |
167 | enum lttng_ust_instrumentation instrumentation; | |
168 | /* Per instrumentation type configuration */ | |
169 | union { | |
170 | } u; | |
171 | }; | |
172 | ||
173 | enum lttng_ust_context_type { | |
174 | LTTNG_KERNEL_CONTEXT_VTID = 0, | |
175 | }; | |
176 | ||
177 | struct lttng_ust_context { | |
178 | enum lttng_ust_context_type ctx; | |
179 | union { | |
180 | } u; | |
181 | }; | |
182 | ||
67c5b804 | 183 | /* |
e7723462 | 184 | * Data structure for the commands sent from sessiond to UST. |
67c5b804 | 185 | */ |
e7723462 MD |
186 | struct lttcomm_ust_msg { |
187 | uint32_t cmd_type; /* enum lttcomm_ust_command */ | |
1ece9766 | 188 | uint32_t handle; |
67c5b804 | 189 | union { |
1ece9766 MD |
190 | struct lttng_ust_tracer_version version; |
191 | struct lttng_ust_channel channel; | |
192 | struct lttng_ust_event event; | |
193 | struct lttng_ust_context context; | |
67c5b804 MD |
194 | } u; |
195 | }; | |
196 | ||
9eb62b9c MD |
197 | /* |
198 | * Data structure for the response from UST to the session daemon. | |
199 | * cmd_type is sent back in the reply for validation. | |
200 | */ | |
e7723462 | 201 | struct lttcomm_ust_reply { |
9eb62b9c MD |
202 | uint32_t cmd_type; /* enum lttcomm_sessiond_command */ |
203 | uint32_t ret_code; /* enum enum lttcomm_return_code */ | |
1ece9766 | 204 | uint32_t ret_val; /* return value */ |
9eb62b9c | 205 | union { |
9eb62b9c MD |
206 | } u; |
207 | }; | |
208 | ||
67c5b804 MD |
209 | extern int lttcomm_create_unix_sock(const char *pathname); |
210 | extern int lttcomm_connect_unix_sock(const char *pathname); | |
211 | extern int lttcomm_accept_unix_sock(int sock); | |
212 | extern int lttcomm_listen_unix_sock(int sock); | |
213 | extern int lttcomm_close_unix_sock(int sock); | |
214 | /* Send fd(s) over a unix socket. */ | |
215 | extern ssize_t lttcomm_send_fds_unix_sock(int sock, void *buf, int *fds, | |
216 | size_t nb_fd, size_t len); | |
217 | extern ssize_t lttcomm_recv_unix_sock(int sock, void *buf, size_t len); | |
218 | extern ssize_t lttcomm_send_unix_sock(int sock, void *buf, size_t len); | |
219 | extern const char *lttcomm_get_readable_code(enum lttcomm_return_code code); | |
220 | ||
221 | #endif /* _LTTNG_SESSIOND_COMM_H */ |