X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=liblttngctl%2Fliblttngctl.c;h=2464bce3b2d1eb30ab0252a2fc4f224a5a85b0c0;hp=a586b34f53a61d2ba6dd630204325d1f71a31835;hb=7d8234d9e6f162ee642cdbec911f46c29b012c3d;hpb=df0da1392bb6c77fff7fc65be518dce7de457ed7 diff --git a/liblttngctl/liblttngctl.c b/liblttngctl/liblttngctl.c index a586b34f5..2464bce3b 100644 --- a/liblttngctl/liblttngctl.c +++ b/liblttngctl/liblttngctl.c @@ -1,19 +1,23 @@ /* + * liblttngctl.c + * + * Linux Trace Toolkit Control Library + * * Copyright (C) 2011 David Goulet * - * This program is free software; you can redistribute it and/or - * modify it under the terms of the GNU General Public License - * as published by the Free Software Foundation; either version 2 - * of the License, or (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License as published by the Free Software Foundation; only + * version 2.1 of the License. + * + * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ #define _GNU_SOURCE @@ -24,10 +28,11 @@ #include #include -#include +#include #include "liblttsessiondcomm.h" #include "lttngerr.h" +#include "lttng-share.h" /* Socket to session daemon for communication */ static int sessiond_socket; @@ -37,13 +42,6 @@ static char sessiond_sock_path[PATH_MAX]; static struct lttcomm_session_msg lsm; static struct lttcomm_lttng_msg llm; -/* Prototypes */ -static int check_tracing_group(const char *grp_name); -static int ask_sessiond(enum lttcomm_command_type lct, void **buf); -static int recv_data_sessiond(void *buf, size_t len); -static int send_data_sessiond(void); -static int set_session_daemon_path(void); - /* Variables */ static char *tracing_group; static int connected; @@ -89,28 +87,153 @@ static int recv_data_sessiond(void *buf, size_t len) } ret = lttcomm_recv_unix_sock(sessiond_socket, buf, len); - if (ret < 0) { + +end: + return ret; +} + +/* + * Check if the specified group name exist. + * + * If yes return 0, else return -1. + */ +static int check_tracing_group(const char *grp_name) +{ + struct group *grp_tracing; /* no free(). See getgrnam(3) */ + gid_t *grp_list; + int grp_list_size, grp_id, i; + int ret = -1; + + /* Get GID of group 'tracing' */ + grp_tracing = getgrnam(grp_name); + if (grp_tracing == NULL) { + /* NULL means not found also. getgrnam(3) */ + if (errno != 0) { + perror("getgrnam"); + } + goto end; + } + + /* Get number of supplementary group IDs */ + grp_list_size = getgroups(0, NULL); + if (grp_list_size < 0) { + perror("getgroups"); goto end; } + /* Alloc group list of the right size */ + grp_list = malloc(grp_list_size * sizeof(gid_t)); + grp_id = getgroups(grp_list_size, grp_list); + if (grp_id < -1) { + perror("getgroups"); + goto free_list; + } + + for (i = 0; i < grp_list_size; i++) { + if (grp_list[i] == grp_tracing->gr_gid) { + ret = 0; + break; + } + } + +free_list: + free(grp_list); + end: return ret; } +/* + * Set sessiond socket path by putting it in the global sessiond_sock_path + * variable. + */ +static int set_session_daemon_path(void) +{ + int ret; + + /* Are we in the tracing group ? */ + ret = check_tracing_group(tracing_group); + if (ret < 0 && getuid() != 0) { + if (sprintf(sessiond_sock_path, DEFAULT_HOME_CLIENT_UNIX_SOCK, + getenv("HOME")) < 0) { + return -ENOMEM; + } + } else { + strncpy(sessiond_sock_path, DEFAULT_GLOBAL_CLIENT_UNIX_SOCK, + sizeof(DEFAULT_GLOBAL_CLIENT_UNIX_SOCK)); + } + + return 0; +} + +/* + * Connect to the LTTng session daemon. + * + * On success, return 0. On error, return -1. + */ +static int connect_sessiond(void) +{ + int ret; + + ret = set_session_daemon_path(); + if (ret < 0) { + return ret; + } + + /* Connect to the sesssion daemon */ + ret = lttcomm_connect_unix_sock(sessiond_sock_path); + if (ret < 0) { + return ret; + } + + sessiond_socket = ret; + connected = 1; + + return 0; +} + +/* + * Clean disconnect the session daemon. + */ +static int disconnect_sessiond(void) +{ + int ret = 0; + + if (connected) { + ret = lttcomm_close_unix_sock(sessiond_socket); + sessiond_socket = 0; + connected = 0; + } + + return ret; +} + +/* + * Reset the session message structure. + */ +static void reset_session_msg(void) +{ + memset(&lsm, 0, sizeof(struct lttcomm_session_msg)); +} + /* * ask_sessiond * - * Ask the session daemon a specific command - * and put the data into buf. + * Ask the session daemon a specific command and put the data into buf. * * Return size of data (only payload, not header). */ -static int ask_sessiond(enum lttcomm_command_type lct, void **buf) +static int ask_sessiond(enum lttcomm_sessiond_command lct, void **buf) { int ret; size_t size; void *data = NULL; + ret = connect_sessiond(); + if (ret < 0) { + goto end; + } + lsm.cmd_type = lct; /* Send command to session daemon */ @@ -131,8 +254,9 @@ static int ask_sessiond(enum lttcomm_command_type lct, void **buf) goto end; } - size = llm.size_payload; + size = llm.data_size; if (size == 0) { + ret = 0; goto end; } @@ -141,6 +265,7 @@ static int ask_sessiond(enum lttcomm_command_type lct, void **buf) /* Get payload data */ ret = recv_data_sessiond(data, size); if (ret < 0) { + free(data); goto end; } @@ -148,108 +273,212 @@ static int ask_sessiond(enum lttcomm_command_type lct, void **buf) ret = size; end: - /* Reset lsm data struct */ - memset(&lsm, 0, sizeof(lsm)); + disconnect_sessiond(); + reset_session_msg(); return ret; } /* - * lttng_get_readable_code - * - * Return a human readable string of code + * Copy domain to lttcomm_session_msg domain. If unknown domain, default domain + * will be the kernel. */ -const char *lttng_get_readable_code(int code) +static void copy_lttng_domain(struct lttng_domain *dom) { - if (code > -LTTCOMM_OK) { - return "Ended with errors"; + if (dom) { + switch (dom->type) { + case LTTNG_DOMAIN_KERNEL: + case LTTNG_DOMAIN_UST: + case LTTNG_DOMAIN_UST_EXEC_NAME: + case LTTNG_DOMAIN_UST_PID: + case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN: + memcpy(&lsm.domain, dom, sizeof(struct lttng_domain)); + break; + default: + lsm.domain.type = LTTNG_DOMAIN_KERNEL; + break; + } } - - return lttcomm_get_readable_code(code); } /* - * lttng_ust_create_trace - * - * Request a trace creation for pid. + * Copy string from src to dst and enforce null terminated byte. */ -int lttng_ust_create_trace(pid_t pid) +static void copy_string(char *dst, const char *src, size_t len) { - int ret; + if (src && dst) { + strncpy(dst, src, len); + /* Enforce the NULL terminated byte */ + dst[len - 1] = '\0'; + } +} - lsm.pid = pid; - ret = ask_sessiond(UST_CREATE_TRACE, NULL); +/* + * Start tracing for all trace of the session. + */ +int lttng_start_tracing(const char *session_name) +{ + copy_string(lsm.session.name, session_name, NAME_MAX); + return ask_sessiond(LTTNG_START_TRACE, NULL); +} - return ret; +/* + * Stop tracing for all trace of the session. + */ +int lttng_stop_tracing(const char *session_name) +{ + copy_string(lsm.session.name, session_name, NAME_MAX); + return ask_sessiond(LTTNG_STOP_TRACE, NULL); } /* - * lttng_ust_list_apps - * - * Ask the session daemon for all UST traceable - * applications. - * - * Return the number of pids. - * On error, return negative value. + * lttng_add_context */ -int lttng_ust_list_apps(pid_t **pids) +int lttng_add_context(struct lttng_domain *domain, + struct lttng_event_context *ctx, const char *event_name, + const char *channel_name) { - int ret; + copy_string(lsm.u.context.channel_name, channel_name, NAME_MAX); + copy_string(lsm.u.context.event_name, event_name, NAME_MAX); + copy_lttng_domain(domain); - ret = ask_sessiond(UST_LIST_APPS, (void**) pids); - if (ret < 0) { - return ret; + if (ctx) { + memcpy(&lsm.u.context.ctx, ctx, sizeof(struct lttng_event_context)); } - return ret / sizeof(pid_t); + return ask_sessiond(LTTNG_ADD_CONTEXT, NULL); } /* - * lttng_create_session - * - * Create a brand new session using name. Allocate - * the session_id param pointing to the UUID. + * lttng_enable_event */ -int lttng_create_session(char *name, uuid_t *session_id) +int lttng_enable_event(struct lttng_domain *domain, + struct lttng_event *ev, const char *channel_name) { int ret; - strncpy(lsm.session_name, name, sizeof(lsm.session_name)); - lsm.session_name[sizeof(lsm.session_name) - 1] = '\0'; + if (channel_name == NULL) { + copy_string(lsm.u.enable.channel_name, DEFAULT_CHANNEL_NAME, NAME_MAX); + } else { + copy_string(lsm.u.enable.channel_name, channel_name, NAME_MAX); + } - ret = ask_sessiond(LTTNG_CREATE_SESSION, NULL); - if (ret < 0) { - goto end; + copy_lttng_domain(domain); + + if (ev == NULL) { + ret = ask_sessiond(LTTNG_ENABLE_ALL_EVENT, NULL); + } else { + memcpy(&lsm.u.enable.event, ev, sizeof(struct lttng_event)); + ret = ask_sessiond(LTTNG_ENABLE_EVENT, NULL); } - uuid_copy(*session_id, llm.session_id); + return ret; +} + +/* + * Disable event of a channel and domain. + */ +int lttng_disable_event(struct lttng_domain *domain, const char *name, + const char *channel_name) +{ + int ret = -1; + + if (channel_name == NULL) { + copy_string(lsm.u.disable.channel_name, DEFAULT_CHANNEL_NAME, NAME_MAX); + } else { + copy_string(lsm.u.disable.channel_name, channel_name, NAME_MAX); + } + + copy_lttng_domain(domain); + + if (name == NULL) { + ret = ask_sessiond(LTTNG_DISABLE_ALL_EVENT, NULL); + } else { + copy_string(lsm.u.disable.name, name, NAME_MAX); + ret = ask_sessiond(LTTNG_DISABLE_EVENT, NULL); + } -end: return ret; } /* - * lttng_destroy_session + * Enable channel per domain + */ +int lttng_enable_channel(struct lttng_domain *domain, + struct lttng_channel *chan) +{ + if (chan) { + memcpy(&lsm.u.channel.chan, chan, sizeof(struct lttng_channel)); + } + + copy_lttng_domain(domain); + + return ask_sessiond(LTTNG_ENABLE_CHANNEL, NULL); +} + +/* + * All tracing will be stopped for registered events of the channel. + */ +int lttng_disable_channel(struct lttng_domain *domain, const char *name) +{ + copy_string(lsm.u.disable.channel_name, name, NAME_MAX); + copy_lttng_domain(domain); + + return ask_sessiond(LTTNG_DISABLE_CHANNEL, NULL); +} + +/* + * List all available tracepoints of domain. * - * Destroy session using name. + * Return the size (bytes) of the list and set the events array. + * On error, return negative value. */ -int lttng_destroy_session(uuid_t *uuid) +int lttng_list_tracepoints(struct lttng_domain *domain, + struct lttng_event **events) { int ret; - uuid_copy(lsm.session_id, *uuid); + copy_lttng_domain(domain); - ret = ask_sessiond(LTTNG_DESTROY_SESSION, NULL); + ret = ask_sessiond(LTTNG_LIST_TRACEPOINTS, (void **) events); if (ret < 0) { - goto end; + return ret; } -end: - return ret; + return ret / sizeof(struct lttng_event); +} + +/* + * Return a human readable string of code + */ +const char *lttng_get_readable_code(int code) +{ + if (code > -LTTCOMM_OK) { + return "Ended with errors"; + } + + return lttcomm_get_readable_code(code); +} + +/* + * Create a brand new session using name. + */ +int lttng_create_session(const char *name, const char *path) +{ + copy_string(lsm.session.name, name, NAME_MAX); + copy_string(lsm.session.path, path, PATH_MAX); + return ask_sessiond(LTTNG_CREATE_SESSION, NULL); +} + +/* + * Destroy session using name. + */ +int lttng_destroy_session(const char *name) +{ + copy_string(lsm.session.name, name, NAME_MAX); + return ask_sessiond(LTTNG_DESTROY_SESSION, NULL); } /* - * lttng_list_sessions - * * Ask the session daemon for all available sessions. * * Return number of session. @@ -268,59 +497,67 @@ int lttng_list_sessions(struct lttng_session **sessions) } /* - * lttng_connect_sessiond - * - * Connect to the LTTng session daemon. - * On success, return 0 - * On error, return a negative value + * List domain of a session. */ -int lttng_connect_sessiond(void) +int lttng_list_domains(const char *session_name, struct lttng_domain **domains) { int ret; - ret = set_session_daemon_path(); + copy_string(lsm.session.name, session_name, NAME_MAX); + ret = ask_sessiond(LTTNG_LIST_DOMAINS, (void**) domains); if (ret < 0) { return ret; } - /* Connect to the sesssion daemon */ - ret = lttcomm_connect_unix_sock(sessiond_sock_path); + return ret / sizeof(struct lttng_domain); +} + +/* + * List channels of a session + */ +int lttng_list_channels(struct lttng_domain *domain, + const char *session_name, struct lttng_channel **channels) +{ + int ret; + + copy_string(lsm.session.name, session_name, NAME_MAX); + copy_lttng_domain(domain); + + ret = ask_sessiond(LTTNG_LIST_CHANNELS, (void**) channels); if (ret < 0) { return ret; } - sessiond_socket = ret; - connected = 1; - - return 0; + return ret / sizeof(struct lttng_channel); } /* - * lttng_disconnect_sessiond - * - * Clean disconnect the session daemon. + * List events of a session channel. */ -int lttng_disconnect_sessiond(void) +int lttng_list_events(struct lttng_domain *domain, + const char *session_name, const char *channel_name, + struct lttng_event **events) { - int ret = 0; + int ret; - if (connected) { - ret = lttcomm_close_unix_sock(sessiond_socket); - sessiond_socket = 0; - connected = 0; + copy_string(lsm.session.name, session_name, NAME_MAX); + copy_string(lsm.u.list.channel_name, channel_name, NAME_MAX); + copy_lttng_domain(domain); + + ret = ask_sessiond(LTTNG_LIST_EVENTS, (void**) events); + if (ret < 0) { + return ret; } - return ret; + return ret / sizeof(struct lttng_event); } /* - * lttng_set_current_session_uuid - * - * Set the session uuid for current lsm. + * Set session name for the current lsm. */ -void lttng_set_current_session_uuid(char *uuid) +void lttng_set_session_name(const char *name) { - uuid_parse(uuid, lsm.session_id); + copy_string(lsm.session.name, name, NAME_MAX); } /* @@ -339,104 +576,56 @@ int lttng_set_tracing_group(const char *name) } /* - * lttng_check_session_daemon - * - * Return 0 if a sesssion daemon is available - * else return -1 + * lttng_calibrate */ -int lttng_check_session_daemon(void) +int lttng_calibrate(struct lttng_domain *domain, + struct lttng_calibrate *calibrate) { int ret; - ret = set_session_daemon_path(); - if (ret < 0) { - return ret; - } + copy_lttng_domain(domain); - /* If socket exist, we consider the daemon started */ - ret = access(sessiond_sock_path, F_OK); - if (ret < 0) { - return ret; - } + memcpy(&lsm.u.calibrate, calibrate, sizeof(struct lttng_calibrate)); + ret = ask_sessiond(LTTNG_CALIBRATE, NULL); - return 0; + return ret; } /* - * set_session_daemon_path + * lttng_check_session_daemon * - * Set sessiond socket path by putting it in - * the global sessiond_sock_path variable. + * Yes, return 1 + * No, return 0 + * Error, return negative value */ -static int set_session_daemon_path(void) +int lttng_session_daemon_alive(void) { int ret; - /* Are we in the tracing group ? */ - ret = check_tracing_group(tracing_group); + ret = set_session_daemon_path(); if (ret < 0) { - if (sprintf(sessiond_sock_path, DEFAULT_HOME_CLIENT_UNIX_SOCK, - getenv("HOME")) < 0) { - return -ENOMEM; - } - } else { - strncpy(sessiond_sock_path, DEFAULT_GLOBAL_CLIENT_UNIX_SOCK, - sizeof(DEFAULT_GLOBAL_CLIENT_UNIX_SOCK)); - } - - return 0; -} - -/* - * check_tracing_group - * - * Check if the specified group name exist. - * If yes, 0, else -1 - */ -static int check_tracing_group(const char *grp_name) -{ - struct group *grp_tracing; /* no free(). See getgrnam(3) */ - gid_t *grp_list; - int grp_list_size, grp_id, i; - int ret = -1; - - /* Get GID of group 'tracing' */ - grp_tracing = getgrnam(grp_name); - if (grp_tracing == NULL) { - /* NULL means not found also. getgrnam(3) */ - if (errno != 0) { - perror("getgrnam"); - } - goto end; - } - - /* Get number of supplementary group IDs */ - grp_list_size = getgroups(0, NULL); - if (grp_list_size < 0) { - perror("getgroups"); - goto end; + /* Error */ + return ret; } - /* Alloc group list of the right size */ - grp_list = malloc(grp_list_size * sizeof(gid_t)); - grp_id = getgroups(grp_list_size, grp_list); - if (grp_id < -1) { - perror("getgroups"); - goto free_list; + /* If socket exist, we check if the daemon listens to connect. */ + ret = access(sessiond_sock_path, F_OK); + if (ret < 0) { + /* Not alive */ + return 0; } - for (i = 0; i < grp_list_size; i++) { - if (grp_list[i] == grp_tracing->gr_gid) { - ret = 0; - break; - } + ret = lttcomm_connect_unix_sock(sessiond_sock_path); + if (ret < 0) { + /* Not alive */ + return 0; } + ret = lttcomm_close_unix_sock(ret); + if (ret < 0) + perror("lttcomm_close_unix_sock"); -free_list: - free(grp_list); - -end: - return ret; + /* Is alive */ + return 1; } /* @@ -445,5 +634,5 @@ end: static void __attribute__((constructor)) init() { /* Set default session group */ - lttng_set_tracing_group(DEFAULT_TRACING_GROUP); + lttng_set_tracing_group(LTTNG_DEFAULT_TRACING_GROUP); }