Commit | Line | Data |
---|---|---|
826d496d MD |
1 | /* |
2 | * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca> | |
fac6795d DG |
3 | * |
4 | * This program is free software; you can redistribute it and/or | |
5 | * modify it under the terms of the GNU General Public License | |
6 | * as published by the Free Software Foundation; either version 2 | |
7 | * of the License, or (at your option) any later version. | |
8 | * | |
9 | * This program is distributed in the hope that it will be useful, | |
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
12 | * GNU General Public License for more details. | |
13 | * | |
14 | * You should have received a copy of the GNU General Public License | |
15 | * along with this program; if not, write to the Free Software | |
16 | * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. | |
fac6795d DG |
17 | */ |
18 | ||
19 | #define _GNU_SOURCE | |
20 | #include <errno.h> | |
21 | #include <grp.h> | |
22 | #include <stdio.h> | |
23 | #include <stdlib.h> | |
24 | #include <string.h> | |
25 | #include <unistd.h> | |
26 | ||
5b97ec60 | 27 | #include <lttng/lttng.h> |
fac6795d DG |
28 | |
29 | #include "liblttsessiondcomm.h" | |
30 | #include "lttngerr.h" | |
31 | ||
32 | /* Socket to session daemon for communication */ | |
33 | static int sessiond_socket; | |
34 | static char sessiond_sock_path[PATH_MAX]; | |
35 | ||
36 | /* Communication structure to ltt-sessiond */ | |
fac6795d | 37 | static struct lttcomm_session_msg lsm; |
5461b305 | 38 | static struct lttcomm_lttng_msg llm; |
fac6795d | 39 | |
fac6795d DG |
40 | /* Variables */ |
41 | static char *tracing_group; | |
42 | static int connected; | |
43 | ||
44 | /* | |
ca95a216 | 45 | * send_data_sessiond |
fac6795d | 46 | * |
e065084a | 47 | * Send lttcomm_session_msg to the session daemon. |
fac6795d DG |
48 | * |
49 | * On success, return 0 | |
50 | * On error, return error code | |
51 | */ | |
ca95a216 | 52 | static int send_data_sessiond(void) |
fac6795d DG |
53 | { |
54 | int ret; | |
55 | ||
56 | if (!connected) { | |
e065084a DG |
57 | ret = -ENOTCONN; |
58 | goto end; | |
fac6795d DG |
59 | } |
60 | ||
61 | ret = lttcomm_send_unix_sock(sessiond_socket, &lsm, sizeof(lsm)); | |
e065084a DG |
62 | |
63 | end: | |
64 | return ret; | |
65 | } | |
66 | ||
67 | /* | |
ca95a216 | 68 | * recv_data_sessiond |
e065084a DG |
69 | * |
70 | * Receive data from the sessiond socket. | |
71 | * | |
72 | * On success, return 0 | |
73 | * On error, return recv() error code | |
74 | */ | |
ca95a216 | 75 | static int recv_data_sessiond(void *buf, size_t len) |
e065084a DG |
76 | { |
77 | int ret; | |
78 | ||
79 | if (!connected) { | |
80 | ret = -ENOTCONN; | |
81 | goto end; | |
fac6795d DG |
82 | } |
83 | ||
ca95a216 | 84 | ret = lttcomm_recv_unix_sock(sessiond_socket, buf, len); |
fac6795d | 85 | |
e065084a | 86 | end: |
fac6795d DG |
87 | return ret; |
88 | } | |
89 | ||
90 | /* | |
ca95a216 | 91 | * ask_sessiond |
fac6795d | 92 | * |
947308c4 | 93 | * Ask the session daemon a specific command and put the data into buf. |
ca95a216 DG |
94 | * |
95 | * Return size of data (only payload, not header). | |
fac6795d | 96 | */ |
6abb15de | 97 | static int ask_sessiond(enum lttcomm_sessiond_command lct, void **buf) |
fac6795d | 98 | { |
ca95a216 DG |
99 | int ret; |
100 | size_t size; | |
101 | void *data = NULL; | |
ca95a216 | 102 | |
7442b2ba DG |
103 | ret = lttng_connect_sessiond(); |
104 | if (ret < 0) { | |
105 | goto end; | |
106 | } | |
107 | ||
ca95a216 DG |
108 | lsm.cmd_type = lct; |
109 | ||
110 | /* Send command to session daemon */ | |
111 | ret = send_data_sessiond(); | |
112 | if (ret < 0) { | |
113 | goto end; | |
fac6795d DG |
114 | } |
115 | ||
ca95a216 | 116 | /* Get header from data transmission */ |
5461b305 | 117 | ret = recv_data_sessiond(&llm, sizeof(llm)); |
ca95a216 DG |
118 | if (ret < 0) { |
119 | goto end; | |
120 | } | |
fac6795d | 121 | |
ca95a216 | 122 | /* Check error code if OK */ |
5461b305 DG |
123 | if (llm.ret_code != LTTCOMM_OK) { |
124 | ret = -llm.ret_code; | |
ca95a216 DG |
125 | goto end; |
126 | } | |
fac6795d | 127 | |
5461b305 | 128 | size = llm.trace_name_offset + llm.data_size; |
ca95a216 DG |
129 | if (size == 0) { |
130 | goto end; | |
fac6795d DG |
131 | } |
132 | ||
ca95a216 DG |
133 | data = (void*) malloc(size); |
134 | ||
135 | /* Get payload data */ | |
136 | ret = recv_data_sessiond(data, size); | |
fac6795d | 137 | if (ret < 0) { |
947308c4 | 138 | free(data); |
fac6795d DG |
139 | goto end; |
140 | } | |
141 | ||
ca95a216 DG |
142 | *buf = data; |
143 | ret = size; | |
fac6795d DG |
144 | |
145 | end: | |
7442b2ba | 146 | lttng_disconnect_sessiond(); |
fac6795d DG |
147 | return ret; |
148 | } | |
149 | ||
947308c4 DG |
150 | /* |
151 | * check_tracing_group | |
152 | * | |
153 | * Check if the specified group name exist. | |
154 | * If yes, 0, else -1 | |
155 | */ | |
156 | static int check_tracing_group(const char *grp_name) | |
157 | { | |
158 | struct group *grp_tracing; /* no free(). See getgrnam(3) */ | |
159 | gid_t *grp_list; | |
160 | int grp_list_size, grp_id, i; | |
161 | int ret = -1; | |
162 | ||
163 | /* Get GID of group 'tracing' */ | |
164 | grp_tracing = getgrnam(grp_name); | |
165 | if (grp_tracing == NULL) { | |
166 | /* NULL means not found also. getgrnam(3) */ | |
167 | if (errno != 0) { | |
168 | perror("getgrnam"); | |
169 | } | |
170 | goto end; | |
171 | } | |
172 | ||
173 | /* Get number of supplementary group IDs */ | |
174 | grp_list_size = getgroups(0, NULL); | |
175 | if (grp_list_size < 0) { | |
176 | perror("getgroups"); | |
177 | goto end; | |
178 | } | |
179 | ||
180 | /* Alloc group list of the right size */ | |
181 | grp_list = malloc(grp_list_size * sizeof(gid_t)); | |
182 | grp_id = getgroups(grp_list_size, grp_list); | |
183 | if (grp_id < -1) { | |
184 | perror("getgroups"); | |
185 | goto free_list; | |
186 | } | |
187 | ||
188 | for (i = 0; i < grp_list_size; i++) { | |
189 | if (grp_list[i] == grp_tracing->gr_gid) { | |
190 | ret = 0; | |
191 | break; | |
192 | } | |
193 | } | |
194 | ||
195 | free_list: | |
196 | free(grp_list); | |
197 | ||
198 | end: | |
199 | return ret; | |
200 | } | |
201 | ||
202 | /* | |
203 | * set_session_daemon_path | |
204 | * | |
205 | * Set sessiond socket path by putting it in | |
206 | * the global sessiond_sock_path variable. | |
207 | */ | |
208 | static int set_session_daemon_path(void) | |
209 | { | |
210 | int ret; | |
211 | ||
212 | /* Are we in the tracing group ? */ | |
213 | ret = check_tracing_group(tracing_group); | |
214 | if (ret < 0 && getuid() != 0) { | |
215 | if (sprintf(sessiond_sock_path, DEFAULT_HOME_CLIENT_UNIX_SOCK, | |
216 | getenv("HOME")) < 0) { | |
217 | return -ENOMEM; | |
218 | } | |
219 | } else { | |
220 | strncpy(sessiond_sock_path, DEFAULT_GLOBAL_CLIENT_UNIX_SOCK, | |
221 | sizeof(DEFAULT_GLOBAL_CLIENT_UNIX_SOCK)); | |
222 | } | |
223 | ||
224 | return 0; | |
225 | } | |
226 | ||
1df4dedd DG |
227 | /* |
228 | * BEGIN KERNEL CONTROL | |
229 | */ | |
230 | ||
231 | /* | |
232 | * lttng_kernel_enable_event | |
233 | * | |
234 | * Enable an event in the kernel tracer. | |
235 | */ | |
236 | int lttng_kernel_enable_event(char *event_name) | |
237 | { | |
238 | strncpy(lsm.u.event.event_name, event_name, NAME_MAX); | |
239 | return ask_sessiond(KERNEL_ENABLE_EVENT, NULL); | |
240 | } | |
241 | ||
242 | /* | |
243 | * lttng_kernel_disable_event | |
244 | * | |
245 | * Disable an event in the kernel tracer. | |
246 | */ | |
247 | int lttng_kernel_disable_event(char *event_name) | |
248 | { | |
249 | strncpy(lsm.u.event.event_name, event_name, NAME_MAX); | |
250 | return ask_sessiond(KERNEL_DISABLE_EVENT, NULL); | |
251 | } | |
252 | ||
253 | /* | |
254 | * lttng_kernel_create_session | |
255 | * | |
256 | * Create a session in the kernel tracer. | |
257 | */ | |
258 | int lttng_kernel_create_session(void) | |
259 | { | |
260 | return ask_sessiond(KERNEL_CREATE_SESSION, NULL); | |
261 | } | |
262 | ||
263 | /* | |
264 | * lttng_kernel_create_channel | |
265 | * | |
266 | * Create a channel in the kernel tracer. | |
267 | */ | |
20fe2104 | 268 | int lttng_kernel_create_channel(void) |
1df4dedd | 269 | { |
1df4dedd DG |
270 | return ask_sessiond(KERNEL_CREATE_CHANNEL, NULL); |
271 | } | |
a5c5a2bd DG |
272 | |
273 | /* | |
274 | * lttng_kernel_open_metadata | |
275 | * | |
276 | * Open metadata in the kernel tracer. | |
277 | */ | |
278 | int lttng_kernel_open_metadata(void) | |
279 | { | |
280 | return ask_sessiond(KERNEL_OPEN_METADATA, NULL); | |
281 | } | |
8c0faa1d DG |
282 | |
283 | /* | |
284 | * lttng_kernel_create_stream | |
285 | * | |
286 | * Create stream in the kernel tracer. | |
287 | */ | |
288 | int lttng_kernel_create_stream(void) | |
289 | { | |
290 | return ask_sessiond(KERNEL_CREATE_STREAM, NULL); | |
291 | } | |
1df4dedd | 292 | |
2ef84c95 DG |
293 | /* |
294 | * lttng_kernel_list_events | |
295 | * | |
296 | * List all available events in the kernel. | |
297 | * | |
298 | * Return the size (bytes) of the list and set the event_list array. | |
299 | * On error, return negative value. | |
300 | */ | |
301 | int lttng_kernel_list_events(char **event_list) | |
302 | { | |
303 | return ask_sessiond(KERNEL_LIST_EVENTS, (void **) event_list); | |
304 | } | |
305 | ||
1df4dedd DG |
306 | /* |
307 | * lttng_kernel_start_tracing | |
308 | * | |
309 | * Start kernel tracing. | |
310 | */ | |
311 | int lttng_kernel_start_tracing(void) | |
312 | { | |
313 | return ask_sessiond(KERNEL_START_TRACE, NULL); | |
314 | } | |
315 | ||
316 | /* | |
317 | * lttng_kernel_stop_tracing | |
318 | * | |
319 | * Stop kernel tracing. | |
320 | */ | |
321 | int lttng_kernel_stop_tracing(void) | |
322 | { | |
323 | return ask_sessiond(KERNEL_STOP_TRACE, NULL); | |
324 | } | |
325 | ||
326 | /* | |
327 | * END KERNEL CONTROL | |
328 | */ | |
329 | ||
ca95a216 DG |
330 | /* |
331 | * lttng_get_readable_code | |
332 | * | |
333 | * Return a human readable string of code | |
334 | */ | |
335 | const char *lttng_get_readable_code(int code) | |
336 | { | |
337 | if (code > -LTTCOMM_OK) { | |
338 | return "Ended with errors"; | |
339 | } | |
340 | ||
341 | return lttcomm_get_readable_code(code); | |
342 | } | |
343 | ||
ce3d728c DG |
344 | /* |
345 | * lttng_ust_start_trace | |
346 | * | |
347 | * Request a trace start for pid. | |
348 | */ | |
349 | int lttng_ust_start_trace(pid_t pid) | |
350 | { | |
ce3d728c | 351 | lsm.pid = pid; |
947308c4 | 352 | return ask_sessiond(UST_START_TRACE, NULL); |
ce3d728c DG |
353 | } |
354 | ||
520ff687 DG |
355 | /* |
356 | * lttng_ust_stop_trace | |
357 | * | |
358 | * Request a trace stop for pid. | |
359 | */ | |
360 | int lttng_ust_stop_trace(pid_t pid) | |
361 | { | |
520ff687 | 362 | lsm.pid = pid; |
947308c4 | 363 | return ask_sessiond(UST_STOP_TRACE, NULL); |
520ff687 DG |
364 | } |
365 | ||
df0da139 DG |
366 | /* |
367 | * lttng_ust_create_trace | |
368 | * | |
369 | * Request a trace creation for pid. | |
370 | */ | |
371 | int lttng_ust_create_trace(pid_t pid) | |
372 | { | |
df0da139 | 373 | lsm.pid = pid; |
947308c4 | 374 | return ask_sessiond(UST_CREATE_TRACE, NULL); |
df0da139 DG |
375 | } |
376 | ||
fac6795d DG |
377 | /* |
378 | * lttng_ust_list_apps | |
379 | * | |
947308c4 | 380 | * Ask the session daemon for all UST traceable applications. |
fac6795d | 381 | * |
ca95a216 DG |
382 | * Return the number of pids. |
383 | * On error, return negative value. | |
fac6795d | 384 | */ |
ca95a216 | 385 | int lttng_ust_list_apps(pid_t **pids) |
fac6795d | 386 | { |
ca95a216 | 387 | int ret; |
fac6795d | 388 | |
ca95a216 | 389 | ret = ask_sessiond(UST_LIST_APPS, (void**) pids); |
fac6795d | 390 | if (ret < 0) { |
ca95a216 | 391 | return ret; |
fac6795d DG |
392 | } |
393 | ||
ca95a216 | 394 | return ret / sizeof(pid_t); |
fac6795d DG |
395 | } |
396 | ||
1657e9bb DG |
397 | /* |
398 | * lttng_list_traces | |
399 | * | |
947308c4 DG |
400 | * Ask the session daemon for all traces (kernel and ust) for the session |
401 | * identified by uuid. | |
1657e9bb DG |
402 | * |
403 | * Return the number of traces. | |
947308c4 | 404 | * On error, return negative value. |
1657e9bb DG |
405 | */ |
406 | int lttng_list_traces(uuid_t *uuid, struct lttng_trace **traces) | |
407 | { | |
408 | int ret; | |
409 | ||
5461b305 | 410 | uuid_copy(lsm.session_uuid, *uuid); |
1657e9bb DG |
411 | |
412 | ret = ask_sessiond(LTTNG_LIST_TRACES, (void **) traces); | |
413 | if (ret < 0) { | |
414 | return ret; | |
415 | } | |
416 | ||
417 | return ret / sizeof(struct lttng_trace); | |
418 | } | |
419 | ||
aaf97519 DG |
420 | /* |
421 | * lttng_create_session | |
422 | * | |
894be886 | 423 | * Create a brand new session using name. |
aaf97519 | 424 | */ |
894be886 | 425 | int lttng_create_session(char *name) |
aaf97519 | 426 | { |
947308c4 DG |
427 | strncpy(lsm.session_name, name, NAME_MAX); |
428 | return ask_sessiond(LTTNG_CREATE_SESSION, NULL); | |
8028d920 DG |
429 | } |
430 | ||
431 | /* | |
432 | * lttng_destroy_session | |
433 | * | |
434 | * Destroy session using name. | |
435 | */ | |
436 | int lttng_destroy_session(uuid_t *uuid) | |
437 | { | |
5461b305 | 438 | uuid_copy(lsm.session_uuid, *uuid); |
947308c4 | 439 | return ask_sessiond(LTTNG_DESTROY_SESSION, NULL); |
aaf97519 DG |
440 | } |
441 | ||
57167058 DG |
442 | /* |
443 | * lttng_list_sessions | |
444 | * | |
445 | * Ask the session daemon for all available sessions. | |
446 | * | |
ca95a216 DG |
447 | * Return number of session. |
448 | * On error, return negative value. | |
57167058 | 449 | */ |
ca95a216 | 450 | int lttng_list_sessions(struct lttng_session **sessions) |
57167058 | 451 | { |
ca95a216 | 452 | int ret; |
57167058 | 453 | |
ca95a216 | 454 | ret = ask_sessiond(LTTNG_LIST_SESSIONS, (void**) sessions); |
57167058 | 455 | if (ret < 0) { |
ca95a216 | 456 | return ret; |
57167058 DG |
457 | } |
458 | ||
ca95a216 | 459 | return ret / sizeof(struct lttng_session); |
57167058 DG |
460 | } |
461 | ||
fac6795d DG |
462 | /* |
463 | * lttng_connect_sessiond | |
464 | * | |
465 | * Connect to the LTTng session daemon. | |
466 | * On success, return 0 | |
467 | * On error, return a negative value | |
468 | */ | |
469 | int lttng_connect_sessiond(void) | |
470 | { | |
471 | int ret; | |
472 | ||
473 | ret = set_session_daemon_path(); | |
474 | if (ret < 0) { | |
475 | return ret; | |
476 | } | |
477 | ||
478 | /* Connect to the sesssion daemon */ | |
479 | ret = lttcomm_connect_unix_sock(sessiond_sock_path); | |
480 | if (ret < 0) { | |
481 | return ret; | |
482 | } | |
483 | ||
484 | sessiond_socket = ret; | |
485 | connected = 1; | |
486 | ||
487 | return 0; | |
488 | } | |
489 | ||
87378cf5 DG |
490 | /* |
491 | * lttng_disconnect_sessiond | |
492 | * | |
493 | * Clean disconnect the session daemon. | |
494 | */ | |
495 | int lttng_disconnect_sessiond(void) | |
496 | { | |
497 | int ret = 0; | |
498 | ||
499 | if (connected) { | |
500 | ret = lttcomm_close_unix_sock(sessiond_socket); | |
501 | sessiond_socket = 0; | |
502 | connected = 0; | |
503 | } | |
504 | ||
505 | return ret; | |
506 | } | |
507 | ||
e8be5f4f DG |
508 | /* |
509 | * lttng_set_current_session_uuid | |
510 | * | |
511 | * Set the session uuid for current lsm. | |
512 | */ | |
96243366 | 513 | void lttng_set_current_session_uuid(uuid_t *uuid) |
e8be5f4f | 514 | { |
5461b305 | 515 | uuid_copy(lsm.session_uuid, *uuid); |
e8be5f4f DG |
516 | } |
517 | ||
fac6795d DG |
518 | /* |
519 | * lttng_set_tracing_group | |
520 | * | |
521 | * Set tracing group variable with name. This function | |
522 | * allocate memory pointed by tracing_group. | |
523 | */ | |
524 | int lttng_set_tracing_group(const char *name) | |
525 | { | |
526 | if (asprintf(&tracing_group, "%s", name) < 0) { | |
527 | return -ENOMEM; | |
528 | } | |
529 | ||
530 | return 0; | |
531 | } | |
532 | ||
533 | /* | |
534 | * lttng_check_session_daemon | |
535 | * | |
947308c4 DG |
536 | * Yes, return 1 |
537 | * No, return 0 | |
538 | * Error, return negative value | |
fac6795d | 539 | */ |
947308c4 | 540 | int lttng_session_daemon_alive(void) |
fac6795d DG |
541 | { |
542 | int ret; | |
543 | ||
544 | ret = set_session_daemon_path(); | |
545 | if (ret < 0) { | |
947308c4 | 546 | /* Error */ |
fac6795d DG |
547 | return ret; |
548 | } | |
549 | ||
550 | /* If socket exist, we consider the daemon started */ | |
551 | ret = access(sessiond_sock_path, F_OK); | |
552 | if (ret < 0) { | |
947308c4 DG |
553 | /* Not alive */ |
554 | return 0; | |
fac6795d DG |
555 | } |
556 | ||
947308c4 DG |
557 | /* Is alive */ |
558 | return 1; | |
fac6795d DG |
559 | } |
560 | ||
561 | /* | |
562 | * lib constructor | |
563 | */ | |
564 | static void __attribute__((constructor)) init() | |
565 | { | |
566 | /* Set default session group */ | |
64a23ac4 | 567 | lttng_set_tracing_group(LTTNG_DEFAULT_TRACING_GROUP); |
fac6795d | 568 | } |