2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
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.
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.
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.
27 #include <lttng/lttng.h>
29 #include "liblttsessiondcomm.h"
31 #include "lttng-share.h"
33 /* Socket to session daemon for communication */
34 static int sessiond_socket
;
35 static char sessiond_sock_path
[PATH_MAX
];
37 /* Communication structure to ltt-sessiond */
38 static struct lttcomm_session_msg lsm
;
39 static struct lttcomm_lttng_msg llm
;
42 static char *tracing_group
;
48 * Send lttcomm_session_msg to the session daemon.
50 * On success, return 0
51 * On error, return error code
53 static int send_data_sessiond(void)
62 ret
= lttcomm_send_unix_sock(sessiond_socket
, &lsm
, sizeof(lsm
));
71 * Receive data from the sessiond socket.
73 * On success, return 0
74 * On error, return recv() error code
76 static int recv_data_sessiond(void *buf
, size_t len
)
85 ret
= lttcomm_recv_unix_sock(sessiond_socket
, buf
, len
);
94 * Ask the session daemon a specific command and put the data into buf.
96 * Return size of data (only payload, not header).
98 static int ask_sessiond(enum lttcomm_sessiond_command lct
, void **buf
)
104 ret
= lttng_connect_sessiond();
111 /* Send command to session daemon */
112 ret
= send_data_sessiond();
117 /* Get header from data transmission */
118 ret
= recv_data_sessiond(&llm
, sizeof(llm
));
123 /* Check error code if OK */
124 if (llm
.ret_code
!= LTTCOMM_OK
) {
129 size
= llm
.data_size
;
134 data
= (void*) malloc(size
);
136 /* Get payload data */
137 ret
= recv_data_sessiond(data
, size
);
147 lttng_disconnect_sessiond();
152 * check_tracing_group
154 * Check if the specified group name exist.
157 static int check_tracing_group(const char *grp_name
)
159 struct group
*grp_tracing
; /* no free(). See getgrnam(3) */
161 int grp_list_size
, grp_id
, i
;
164 /* Get GID of group 'tracing' */
165 grp_tracing
= getgrnam(grp_name
);
166 if (grp_tracing
== NULL
) {
167 /* NULL means not found also. getgrnam(3) */
174 /* Get number of supplementary group IDs */
175 grp_list_size
= getgroups(0, NULL
);
176 if (grp_list_size
< 0) {
181 /* Alloc group list of the right size */
182 grp_list
= malloc(grp_list_size
* sizeof(gid_t
));
183 grp_id
= getgroups(grp_list_size
, grp_list
);
189 for (i
= 0; i
< grp_list_size
; i
++) {
190 if (grp_list
[i
] == grp_tracing
->gr_gid
) {
204 * set_session_daemon_path
206 * Set sessiond socket path by putting it in
207 * the global sessiond_sock_path variable.
209 static int set_session_daemon_path(void)
213 /* Are we in the tracing group ? */
214 ret
= check_tracing_group(tracing_group
);
215 if (ret
< 0 && getuid() != 0) {
216 if (sprintf(sessiond_sock_path
, DEFAULT_HOME_CLIENT_UNIX_SOCK
,
217 getenv("HOME")) < 0) {
221 strncpy(sessiond_sock_path
, DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
,
222 sizeof(DEFAULT_GLOBAL_CLIENT_UNIX_SOCK
));
229 * lttng_start_tracing
231 * Start tracing for all trace of the session.
233 int lttng_start_tracing(char *session_name
)
235 strncpy(lsm
.session_name
, session_name
, NAME_MAX
);
236 return ask_sessiond(LTTNG_START_TRACE
, NULL
);
242 * Stop tracing for all trace of the session.
244 int lttng_stop_tracing(char *session_name
)
246 strncpy(lsm
.session_name
, session_name
, NAME_MAX
);
247 return ask_sessiond(LTTNG_STOP_TRACE
, NULL
);
251 * BEGIN Kernel control API
255 * lttng_kernel_enable_event
257 int lttng_kernel_enable_event(struct lttng_event
*ev
, char *channel_name
)
261 if (strlen(channel_name
) == 0) {
262 strncpy(lsm
.u
.enable
.channel_name
, DEFAULT_CHANNEL_NAME
, NAME_MAX
);
264 strncpy(lsm
.u
.enable
.channel_name
, channel_name
, NAME_MAX
);
268 ret
= ask_sessiond(LTTNG_KERNEL_ENABLE_ALL_EVENT
, NULL
);
270 memcpy(&lsm
.u
.enable
.event
, ev
, sizeof(struct lttng_event
));
271 ret
= ask_sessiond(LTTNG_KERNEL_ENABLE_EVENT
, NULL
);
278 * lttng_kernel_disable_event
280 * Disable an event in the kernel tracer.
282 int lttng_kernel_disable_event(char *name
, char *channel_name
)
286 if (strlen(channel_name
) == 0) {
287 strncpy(lsm
.u
.disable
.channel_name
, DEFAULT_CHANNEL_NAME
, NAME_MAX
);
289 strncpy(lsm
.u
.disable
.channel_name
, channel_name
, NAME_MAX
);
293 ret
= ask_sessiond(LTTNG_KERNEL_DISABLE_ALL_EVENT
, NULL
);
295 strncpy(lsm
.u
.disable
.name
, name
, NAME_MAX
);
296 ret
= ask_sessiond(LTTNG_KERNEL_DISABLE_EVENT
, NULL
);
303 * lttng_kernel_enable_channel
305 * Enable recording for a channel for the kernel tracer.
307 int lttng_kernel_enable_channel(char *name
)
309 strncpy(lsm
.u
.enable
.channel_name
, name
, NAME_MAX
);
310 return ask_sessiond(LTTNG_KERNEL_ENABLE_CHANNEL
, NULL
);
314 * lttng_kernel_disable_channel
316 * Disable recording for the channel for the kernel tracer.
318 int lttng_kernel_disable_channel(char *name
)
320 strncpy(lsm
.u
.disable
.channel_name
, name
, NAME_MAX
);
321 return ask_sessiond(LTTNG_KERNEL_DISABLE_CHANNEL
, NULL
);
325 * lttng_kernel_create_channel
327 * Create a channel in the kernel tracer.
329 int lttng_kernel_create_channel(struct lttng_channel
*chan
)
331 memcpy(&lsm
.u
.channel
.chan
, chan
, sizeof(struct lttng_channel
));
332 return ask_sessiond(LTTNG_KERNEL_CREATE_CHANNEL
, NULL
);
338 * List all available events in the kernel.
340 * Return the size (bytes) of the list and set the event_list array.
341 * On error, return negative value.
343 int lttng_kernel_list_events(char **event_list
)
345 return ask_sessiond(LTTNG_KERNEL_LIST_EVENTS
, (void **) event_list
);
349 * END Kernel control API
353 * lttng_get_readable_code
355 * Return a human readable string of code
357 const char *lttng_get_readable_code(int code
)
359 if (code
> -LTTCOMM_OK
) {
360 return "Ended with errors";
363 return lttcomm_get_readable_code(code
);
367 * lttng_ust_list_apps
369 * Ask the session daemon for all UST traceable applications.
371 * Return the number of pids.
372 * On error, return negative value.
374 int lttng_ust_list_traceable_apps(pid_t
**pids
)
378 ret
= ask_sessiond(LTTNG_LIST_TRACEABLE_APPS
, (void**) pids
);
383 return ret
/ sizeof(pid_t
);
389 * Ask the session daemon for all traces (kernel and ust) for the session
390 * identified by name.
392 * Return the number of traces.
393 * On error, return negative value.
396 int lttng_list_traces(char *session_name, struct lttng_trace **traces)
400 strncpy(lsm.session_name, session_name, NAME_MAX);
402 ret = ask_sessiond(LTTNG_LIST_TRACES, (void **) traces);
407 return ret / sizeof(struct lttng_trace);
412 * lttng_create_session
414 * Create a brand new session using name.
416 int lttng_create_session(char *name
, char *path
)
418 strncpy(lsm
.session_name
, name
, NAME_MAX
);
419 strncpy(lsm
.path
, path
, PATH_MAX
);
420 return ask_sessiond(LTTNG_CREATE_SESSION
, NULL
);
424 * lttng_destroy_session
426 * Destroy session using name.
428 int lttng_destroy_session(char *name
)
430 strncpy(lsm
.session_name
, name
, NAME_MAX
);
431 return ask_sessiond(LTTNG_DESTROY_SESSION
, NULL
);
435 * lttng_list_sessions
437 * Ask the session daemon for all available sessions.
439 * Return number of session.
440 * On error, return negative value.
442 int lttng_list_sessions(struct lttng_session
**sessions
)
446 ret
= ask_sessiond(LTTNG_LIST_SESSIONS
, (void**) sessions
);
451 return ret
/ sizeof(struct lttng_session
);
455 * lttng_connect_sessiond
457 * Connect to the LTTng session daemon.
458 * On success, return 0
459 * On error, return a negative value
461 int lttng_connect_sessiond(void)
465 ret
= set_session_daemon_path();
470 /* Connect to the sesssion daemon */
471 ret
= lttcomm_connect_unix_sock(sessiond_sock_path
);
476 sessiond_socket
= ret
;
483 * lttng_disconnect_sessiond
485 * Clean disconnect the session daemon.
487 int lttng_disconnect_sessiond(void)
492 ret
= lttcomm_close_unix_sock(sessiond_socket
);
500 void lttng_set_session_name(char *name
)
502 strncpy(lsm
.session_name
, name
, NAME_MAX
);
506 * lttng_set_tracing_group
508 * Set tracing group variable with name. This function
509 * allocate memory pointed by tracing_group.
511 int lttng_set_tracing_group(const char *name
)
513 if (asprintf(&tracing_group
, "%s", name
) < 0) {
521 * lttng_check_session_daemon
525 * Error, return negative value
527 int lttng_session_daemon_alive(void)
531 ret
= set_session_daemon_path();
537 /* If socket exist, we consider the daemon started */
538 ret
= access(sessiond_sock_path
, F_OK
);
551 static void __attribute__((constructor
)) init()
553 /* Set default session group */
554 lttng_set_tracing_group(LTTNG_DEFAULT_TRACING_GROUP
);