X-Git-Url: https://git.liburcu.org/?a=blobdiff_plain;f=src%2Flib%2Flttng-ctl%2Flttng-ctl.c;h=ad4974a1395cd4d284a3c56b3ac10bf4178c0381;hb=55fb8091d6b72decba72edf53034b05764cc8dac;hp=b57be223a73afce55723c858c66a5aedfa245b24;hpb=2c2de71ef6dae09fa1a61f02051b68f60b0a1750;p=lttng-tools.git diff --git a/src/lib/lttng-ctl/lttng-ctl.c b/src/lib/lttng-ctl/lttng-ctl.c index b57be223a..ad4974a13 100644 --- a/src/lib/lttng-ctl/lttng-ctl.c +++ b/src/lib/lttng-ctl/lttng-ctl.c @@ -43,6 +43,9 @@ #include #include #include +#include +#include +#include #include "filter/filter-ast.h" #include "filter/filter-parser.h" @@ -64,9 +67,16 @@ do { \ } while (0) #endif +#define COPY_DOMAIN_PACKED(dst, src) \ +do { \ + struct lttng_domain _tmp_domain; \ + \ + lttng_ctl_copy_lttng_domain(&_tmp_domain, &src); \ + dst = _tmp_domain; \ +} while (0) /* Socket to session daemon for communication */ -static int sessiond_socket; +static int sessiond_socket = -1; static char sessiond_sock_path[PATH_MAX]; /* Variables */ @@ -84,21 +94,6 @@ int lttng_opt_quiet; int lttng_opt_verbose; int lttng_opt_mi; -/* - * Copy string from src to dst and enforce null terminated byte. - */ -LTTNG_HIDDEN -void lttng_ctl_copy_string(char *dst, const char *src, size_t len) -{ - if (src && dst) { - strncpy(dst, src, len); - /* Enforce the NULL terminated byte */ - dst[len - 1] = '\0'; - } else if (dst) { - dst[0] = '\0'; - } -} - /* * Copy domain to lttcomm_session_msg domain. * @@ -241,15 +236,13 @@ end: LTTNG_HIDDEN int lttng_check_tracing_group(void) { - struct group *grp_tracing; /* no free(). See getgrnam(3) */ - gid_t *grp_list; + gid_t *grp_list, tracing_gid; int grp_list_size, grp_id, i; int ret = -1; const char *grp_name = tracing_group; /* Get GID of group 'tracing' */ - grp_tracing = getgrnam(grp_name); - if (!grp_tracing) { + if (utils_get_group_id(grp_name, false, &tracing_gid)) { /* If grp_tracing is NULL, the group does not exist. */ goto end; } @@ -274,7 +267,7 @@ int lttng_check_tracing_group(void) } for (i = 0; i < grp_list_size; i++) { - if (grp_list[i] == grp_tracing->gr_gid) { + if (grp_list[i] == tracing_gid) { ret = 1; break; } @@ -287,6 +280,50 @@ end: return ret; } +static int check_enough_available_memory(size_t num_bytes_requested_per_cpu) +{ + int ret; + long num_cpu; + size_t best_mem_info; + size_t num_bytes_requested_total; + + /* + * Get the number of CPU currently online to compute the amount of + * memory needed to create a buffer for every CPU. + */ + num_cpu = sysconf(_SC_NPROCESSORS_ONLN); + if (num_cpu == -1) { + goto error; + } + + num_bytes_requested_total = num_bytes_requested_per_cpu * num_cpu; + + /* + * Try to get the `MemAvail` field of `/proc/meminfo`. This is the most + * reliable estimate we can get but it is only exposed by the kernel + * since 3.14. (See Linux kernel commit: + * 34e431b0ae398fc54ea69ff85ec700722c9da773) + */ + ret = utils_get_memory_available(&best_mem_info); + if (ret >= 0) { + goto success; + } + + /* + * As a backup plan, use `MemTotal` field of `/proc/meminfo`. This + * is a sanity check for obvious user error. + */ + ret = utils_get_memory_total(&best_mem_info); + if (ret >= 0) { + goto success; + } + +error: + return -1; +success: + return best_mem_info >= num_bytes_requested_total; +} + /* * Try connect to session daemon with sock_path. * @@ -340,8 +377,13 @@ static int set_session_daemon_path(void) } if ((uid == 0) || in_tgroup) { - lttng_ctl_copy_string(sessiond_sock_path, - DEFAULT_GLOBAL_CLIENT_UNIX_SOCK, sizeof(sessiond_sock_path)); + const int ret = lttng_strncpy(sessiond_sock_path, + DEFAULT_GLOBAL_CLIENT_UNIX_SOCK, + sizeof(sessiond_sock_path)); + + if (ret) { + goto error; + } } if (uid != 0) { @@ -379,17 +421,12 @@ error: /* * Connect to the LTTng session daemon. * - * On success, return 0. On error, return -1. + * On success, return the socket's file descriptor. On error, return -1. */ -static int connect_sessiond(void) +LTTNG_HIDDEN int connect_sessiond(void) { int ret; - /* Don't try to connect if already connected. */ - if (connected) { - return 0; - } - ret = set_session_daemon_path(); if (ret < 0) { goto error; @@ -401,15 +438,18 @@ static int connect_sessiond(void) goto error; } - sessiond_socket = ret; - connected = 1; - - return 0; + return ret; error: return -1; } +static void reset_global_sessiond_connection_state(void) +{ + sessiond_socket = -1; + connected = 0; +} + /* * Clean disconnect from the session daemon. * @@ -421,8 +461,7 @@ static int disconnect_sessiond(void) if (connected) { ret = lttcomm_close_unix_sock(sessiond_socket); - sessiond_socket = 0; - connected = 0; + reset_global_sessiond_connection_state(); } return ret; @@ -497,6 +536,9 @@ int lttng_ctl_ask_sessiond_fds_varlen(struct lttcomm_session_msg *lsm, if (ret < 0) { ret = -LTTNG_ERR_NO_SESSIOND; goto end; + } else { + sessiond_socket = ret; + connected = 1; } /* Send command to session daemon */ @@ -561,6 +603,7 @@ end: struct lttng_handle *lttng_create_handle(const char *session_name, struct lttng_domain *domain) { + int ret; struct lttng_handle *handle = NULL; handle = zmalloc(sizeof(struct lttng_handle)); @@ -570,8 +613,11 @@ struct lttng_handle *lttng_create_handle(const char *session_name, } /* Copy session name */ - lttng_ctl_copy_string(handle->session_name, session_name, - sizeof(handle->session_name)); + ret = lttng_strncpy(handle->session_name, session_name ? : "", + sizeof(handle->session_name)); + if (ret) { + goto error; + } /* Copy lttng domain or leave initialized to 0. */ if (domain) { @@ -580,6 +626,9 @@ struct lttng_handle *lttng_create_handle(const char *session_name, end: return handle; +error: + free(handle); + return NULL; } /* @@ -598,22 +647,35 @@ void lttng_destroy_handle(struct lttng_handle *handle) int lttng_register_consumer(struct lttng_handle *handle, const char *socket_path) { + int ret; struct lttcomm_session_msg lsm; if (handle == NULL || socket_path == NULL) { - return -LTTNG_ERR_INVALID; + ret = -LTTNG_ERR_INVALID; + goto end; } memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_REGISTER_CONSUMER; - lttng_ctl_copy_string(lsm.session.name, handle->session_name, + ret = lttng_strncpy(lsm.session.name, handle->session_name, sizeof(lsm.session.name)); - lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + + COPY_DOMAIN_PACKED(lsm.domain, handle->domain); - lttng_ctl_copy_string(lsm.u.reg.path, socket_path, - sizeof(lsm.u.reg.path)); + ret = lttng_strncpy(lsm.u.reg.path, socket_path, + sizeof(lsm.u.reg.path)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } - return lttng_ctl_ask_sessiond(&lsm, NULL); + ret = lttng_ctl_ask_sessiond(&lsm, NULL); +end: + return ret; } /* @@ -623,19 +685,27 @@ int lttng_register_consumer(struct lttng_handle *handle, */ int lttng_start_tracing(const char *session_name) { + int ret; struct lttcomm_session_msg lsm; if (session_name == NULL) { - return -LTTNG_ERR_INVALID; + ret = -LTTNG_ERR_INVALID; + goto end; } memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_START_TRACE; - lttng_ctl_copy_string(lsm.session.name, session_name, - sizeof(lsm.session.name)); + ret = lttng_strncpy(lsm.session.name, session_name, + sizeof(lsm.session.name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } - return lttng_ctl_ask_sessiond(&lsm, NULL); + ret = lttng_ctl_ask_sessiond(&lsm, NULL); +end: + return ret; } /* @@ -647,14 +717,19 @@ static int _lttng_stop_tracing(const char *session_name, int wait) struct lttcomm_session_msg lsm; if (session_name == NULL) { - return -LTTNG_ERR_INVALID; + ret = -LTTNG_ERR_INVALID; + goto error; } memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_STOP_TRACE; - lttng_ctl_copy_string(lsm.session.name, session_name, - sizeof(lsm.session.name)); + ret = lttng_strncpy(lsm.session.name, session_name, + sizeof(lsm.session.name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto error; + } ret = lttng_ctl_ask_sessiond(&lsm, NULL); if (ret < 0 && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) { @@ -679,7 +754,7 @@ static int _lttng_stop_tracing(const char *session_name, int wait) * call returned value indicates availability. */ if (data_ret) { - usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME); + usleep(DEFAULT_DATA_AVAILABILITY_WAIT_TIME_US); } } while (data_ret != 0); @@ -731,17 +806,20 @@ int lttng_add_context(struct lttng_handle *handle, lsm.cmd_type = LTTNG_ADD_CONTEXT; /* If no channel name, send empty string. */ - if (channel_name == NULL) { - lttng_ctl_copy_string(lsm.u.context.channel_name, "", - sizeof(lsm.u.context.channel_name)); - } else { - lttng_ctl_copy_string(lsm.u.context.channel_name, channel_name, - sizeof(lsm.u.context.channel_name)); + ret = lttng_strncpy(lsm.u.context.channel_name, channel_name ?: "", + sizeof(lsm.u.context.channel_name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; } - lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); - lttng_ctl_copy_string(lsm.session.name, handle->session_name, + COPY_DOMAIN_PACKED(lsm.domain, handle->domain); + ret = lttng_strncpy(lsm.session.name, handle->session_name, sizeof(lsm.session.name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } if (ctx->ctx == LTTNG_EVENT_CONTEXT_APP_CONTEXT) { size_t provider_len, ctx_len; @@ -1034,7 +1112,11 @@ int lttng_enable_event_with_exclusions(struct lttng_handle *handle, unsigned int free_filter_expression = 0; struct filter_parser_ctx *ctx = NULL; - memset(&send_buffer, 0, sizeof(send_buffer)); + /* + * We have either a filter or some exclusions, so we need to set up + * a variable-length memory block from where to send the data. + */ + lttng_dynamic_buffer_init(&send_buffer); /* * Cast as non-const since we may replace the filter expression @@ -1061,35 +1143,33 @@ int lttng_enable_event_with_exclusions(struct lttng_handle *handle, memset(&lsm, 0, sizeof(lsm)); /* If no channel name, send empty string. */ - if (channel_name == NULL) { - lttng_ctl_copy_string(lsm.u.enable.channel_name, "", - sizeof(lsm.u.enable.channel_name)); - } else { - lttng_ctl_copy_string(lsm.u.enable.channel_name, channel_name, - sizeof(lsm.u.enable.channel_name)); + ret = lttng_strncpy(lsm.u.enable.channel_name, channel_name ?: "", + sizeof(lsm.u.enable.channel_name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto error; } lsm.cmd_type = LTTNG_ENABLE_EVENT; if (ev->name[0] == '\0') { - /* Enable all events */ - lttng_ctl_copy_string(ev->name, "*", sizeof(ev->name)); + /* Enable all events. */ + ret = lttng_strncpy(ev->name, "*", sizeof(ev->name)); + assert(ret == 0); } - lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); - /* FIXME: copying non-packed struct to packed struct. */ + COPY_DOMAIN_PACKED(lsm.domain, handle->domain); memcpy(&lsm.u.enable.event, ev, sizeof(lsm.u.enable.event)); - lttng_ctl_copy_string(lsm.session.name, handle->session_name, + ret = lttng_strncpy(lsm.session.name, handle->session_name, sizeof(lsm.session.name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto error; + } + lsm.u.enable.exclusion_count = exclusion_count; lsm.u.enable.bytecode_len = 0; - /* - * We have either a filter or some exclusions, so we need to set up - * a variable-length memory block from where to send the data. - */ - lttng_dynamic_buffer_init(&send_buffer); - /* Parse filter expression. */ if (filter_expression != NULL || handle->domain.type == LTTNG_DOMAIN_JUL || handle->domain.type == LTTNG_DOMAIN_LOG4J @@ -1265,22 +1345,25 @@ int lttng_disable_event_ext(struct lttng_handle *handle, memset(&lsm, 0, sizeof(lsm)); /* If no channel name, send empty string. */ - if (channel_name == NULL) { - lttng_ctl_copy_string(lsm.u.disable.channel_name, "", - sizeof(lsm.u.disable.channel_name)); - } else { - lttng_ctl_copy_string(lsm.u.disable.channel_name, channel_name, - sizeof(lsm.u.disable.channel_name)); + ret = lttng_strncpy(lsm.u.disable.channel_name, channel_name ?: "", + sizeof(lsm.u.disable.channel_name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto error; } lsm.cmd_type = LTTNG_DISABLE_EVENT; - lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); - /* FIXME: copying non-packed struct to packed struct. */ + COPY_DOMAIN_PACKED(lsm.domain, handle->domain); memcpy(&lsm.u.disable.event, ev, sizeof(lsm.u.disable.event)); - lttng_ctl_copy_string(lsm.session.name, handle->session_name, + ret = lttng_strncpy(lsm.session.name, handle->session_name, sizeof(lsm.session.name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto error; + } + lsm.u.disable.bytecode_len = 0; /* @@ -1397,13 +1480,21 @@ ask_sessiond: int lttng_disable_event(struct lttng_handle *handle, const char *name, const char *channel_name) { + int ret; struct lttng_event ev; memset(&ev, 0, sizeof(ev)); ev.loglevel = -1; ev.type = LTTNG_EVENT_ALL; - lttng_ctl_copy_string(ev.name, name, sizeof(ev.name)); - return lttng_disable_event_ext(handle, &ev, channel_name, NULL); + ret = lttng_strncpy(ev.name, name ?: "", sizeof(ev.name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + + ret = lttng_disable_event_ext(handle, &ev, channel_name, NULL); +end: + return ret; } struct lttng_channel *lttng_channel_create(struct lttng_domain *domain) @@ -1474,7 +1565,9 @@ void lttng_channel_destroy(struct lttng_channel *channel) int lttng_enable_channel(struct lttng_handle *handle, struct lttng_channel *in_chan) { + int ret; struct lttcomm_session_msg lsm; + size_t total_buffer_size_needed_per_cpu = 0; /* NULL arguments are forbidden. No default values. */ if (handle == NULL || in_chan == NULL) { @@ -1510,13 +1603,29 @@ int lttng_enable_channel(struct lttng_handle *handle, memcpy(&lsm.u.channel.extended, extended, sizeof(*extended)); } + /* + * Verify that the amount of memory required to create the requested + * buffer is available on the system at the moment. + */ + total_buffer_size_needed_per_cpu = lsm.u.channel.chan.attr.num_subbuf * + lsm.u.channel.chan.attr.subbuf_size; + if (!check_enough_available_memory(total_buffer_size_needed_per_cpu)) { + return -LTTNG_ERR_NOMEM; + } + lsm.cmd_type = LTTNG_ENABLE_CHANNEL; - lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + COPY_DOMAIN_PACKED(lsm.domain, handle->domain); - lttng_ctl_copy_string(lsm.session.name, handle->session_name, - sizeof(lsm.session.name)); + ret = lttng_strncpy(lsm.session.name, handle->session_name, + sizeof(lsm.session.name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } - return lttng_ctl_ask_sessiond(&lsm, NULL); + ret = lttng_ctl_ask_sessiond(&lsm, NULL); +end: + return ret; } /* @@ -1525,6 +1634,7 @@ int lttng_enable_channel(struct lttng_handle *handle, */ int lttng_disable_channel(struct lttng_handle *handle, const char *name) { + int ret; struct lttcomm_session_msg lsm; /* Safety check. Both are mandatory. */ @@ -1536,15 +1646,25 @@ int lttng_disable_channel(struct lttng_handle *handle, const char *name) lsm.cmd_type = LTTNG_DISABLE_CHANNEL; - lttng_ctl_copy_string(lsm.u.disable.channel_name, name, + ret = lttng_strncpy(lsm.u.disable.channel_name, name, sizeof(lsm.u.disable.channel_name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } - lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + COPY_DOMAIN_PACKED(lsm.domain, handle->domain); - lttng_ctl_copy_string(lsm.session.name, handle->session_name, - sizeof(lsm.session.name)); + ret = lttng_strncpy(lsm.session.name, handle->session_name, + sizeof(lsm.session.name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } - return lttng_ctl_ask_sessiond(&lsm, NULL); + ret = lttng_ctl_ask_sessiond(&lsm, NULL); +end: + return ret; } /* @@ -1553,6 +1673,7 @@ int lttng_disable_channel(struct lttng_handle *handle, const char *name) */ int lttng_track_pid(struct lttng_handle *handle, int pid) { + int ret; struct lttcomm_session_msg lsm; /* NULL arguments are forbidden. No default values. */ @@ -1565,12 +1686,18 @@ int lttng_track_pid(struct lttng_handle *handle, int pid) lsm.cmd_type = LTTNG_TRACK_PID; lsm.u.pid_tracker.pid = pid; - lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + COPY_DOMAIN_PACKED(lsm.domain, handle->domain); - lttng_ctl_copy_string(lsm.session.name, handle->session_name, + ret = lttng_strncpy(lsm.session.name, handle->session_name, sizeof(lsm.session.name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } - return lttng_ctl_ask_sessiond(&lsm, NULL); + ret = lttng_ctl_ask_sessiond(&lsm, NULL); +end: + return ret; } /* @@ -1579,6 +1706,7 @@ int lttng_track_pid(struct lttng_handle *handle, int pid) */ int lttng_untrack_pid(struct lttng_handle *handle, int pid) { + int ret; struct lttcomm_session_msg lsm; /* NULL arguments are forbidden. No default values. */ @@ -1591,12 +1719,18 @@ int lttng_untrack_pid(struct lttng_handle *handle, int pid) lsm.cmd_type = LTTNG_UNTRACK_PID; lsm.u.pid_tracker.pid = pid; - lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + COPY_DOMAIN_PACKED(lsm.domain, handle->domain); - lttng_ctl_copy_string(lsm.session.name, handle->session_name, - sizeof(lsm.session.name)); + ret = lttng_strncpy(lsm.session.name, handle->session_name, + sizeof(lsm.session.name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } - return lttng_ctl_ask_sessiond(&lsm, NULL); + ret = lttng_ctl_ask_sessiond(&lsm, NULL); +end: + return ret; } /* @@ -1617,7 +1751,7 @@ int lttng_list_tracepoints(struct lttng_handle *handle, memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_LIST_TRACEPOINTS; - lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + COPY_DOMAIN_PACKED(lsm.domain, handle->domain); ret = lttng_ctl_ask_sessiond(&lsm, (void **) events); if (ret < 0) { @@ -1645,7 +1779,7 @@ int lttng_list_tracepoint_fields(struct lttng_handle *handle, memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_LIST_TRACEPOINT_FIELDS; - lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + COPY_DOMAIN_PACKED(lsm.domain, handle->domain); ret = lttng_ctl_ask_sessiond(&lsm, (void **) fields); if (ret < 0) { @@ -1693,130 +1827,388 @@ const char *lttng_strerror(int code) return error_get_str(code); } -/* - * Create a brand new session using name and url for destination. - * - * Returns LTTNG_OK on success or a negative error code. - */ -int lttng_create_session(const char *name, const char *url) +enum lttng_error_code lttng_create_session_ext( + struct lttng_session_descriptor *session_descriptor) { + enum lttng_error_code ret_code; + struct lttcomm_session_msg lsm = { + .cmd_type = LTTNG_CREATE_SESSION_EXT, + }; + void *reply = NULL; + struct lttng_buffer_view reply_view; + int reply_ret; + bool sessiond_must_generate_ouput; + struct lttng_dynamic_buffer payload; int ret; - ssize_t size; - struct lttcomm_session_msg lsm; - struct lttng_uri *uris = NULL; + size_t descriptor_size; + struct lttng_session_descriptor *descriptor_reply = NULL; - if (name == NULL) { - return -LTTNG_ERR_INVALID; + lttng_dynamic_buffer_init(&payload); + if (!session_descriptor) { + ret_code = LTTNG_ERR_INVALID; + goto end; } - memset(&lsm, 0, sizeof(lsm)); + sessiond_must_generate_ouput = + !lttng_session_descriptor_is_output_destination_initialized( + session_descriptor); + if (sessiond_must_generate_ouput) { + const char *home_dir = utils_get_home_dir(); + size_t home_dir_len = home_dir ? strlen(home_dir) + 1 : 0; - lsm.cmd_type = LTTNG_CREATE_SESSION; - lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name)); + if (!home_dir || home_dir_len > LTTNG_PATH_MAX) { + ret_code = LTTNG_ERR_FATAL; + goto end; + } - /* There should never be a data URL */ - size = uri_parse_str_urls(url, NULL, &uris); - if (size < 0) { - return -LTTNG_ERR_INVALID; + lsm.u.create_session.home_dir_size = (uint16_t) home_dir_len; + ret = lttng_dynamic_buffer_append(&payload, home_dir, + home_dir_len); + if (ret) { + ret_code = LTTNG_ERR_NOMEM; + goto end; + } } - lsm.u.uri.size = size; - - ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, uris, - sizeof(struct lttng_uri) * size, NULL); - - free(uris); - return ret; -} - -/* - * Destroy session using name. - * Returns size of returned session payload data or a negative error code. - */ -static -int _lttng_destroy_session(const char *session_name) -{ - struct lttcomm_session_msg lsm; - - if (session_name == NULL) { - return -LTTNG_ERR_INVALID; + descriptor_size = payload.size; + ret = lttng_session_descriptor_serialize(session_descriptor, + &payload); + if (ret) { + ret_code = LTTNG_ERR_INVALID; + goto end; } + descriptor_size = payload.size - descriptor_size; + lsm.u.create_session.session_descriptor_size = descriptor_size; - memset(&lsm, 0, sizeof(lsm)); - lsm.cmd_type = LTTNG_DESTROY_SESSION; - - lttng_ctl_copy_string(lsm.session.name, session_name, - sizeof(lsm.session.name)); - - return lttng_ctl_ask_sessiond(&lsm, NULL); -} - -/* - * Stop the session and wait for the data before destroying it - */ -int lttng_destroy_session(const char *session_name) -{ - int ret; - - /* - * Stop the tracing and wait for the data. - */ - ret = _lttng_stop_tracing(session_name, 1); - if (ret && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) { + /* Command returns a session descriptor on success. */ + reply_ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, payload.data, + payload.size, &reply); + if (reply_ret < 0) { + ret_code = -reply_ret; + goto end; + } else if (reply_ret == 0) { + /* Socket unexpectedly closed by the session daemon. */ + ret_code = LTTNG_ERR_FATAL; goto end; } - ret = _lttng_destroy_session(session_name); + reply_view = lttng_buffer_view_init(reply, 0, reply_ret); + ret = lttng_session_descriptor_create_from_buffer(&reply_view, + &descriptor_reply); + if (ret < 0) { + ret_code = LTTNG_ERR_FATAL; + goto end; + } + ret_code = LTTNG_OK; + lttng_session_descriptor_assign(session_descriptor, descriptor_reply); end: - return ret; + free(reply); + lttng_dynamic_buffer_reset(&payload); + lttng_session_descriptor_destroy(descriptor_reply); + return ret_code; } /* - * Destroy the session without waiting for the data. + * Create a new session using name and url for destination. + * + * Return 0 on success else a negative LTTng error code. */ -int lttng_destroy_session_no_wait(const char *session_name) +int lttng_create_session(const char *name, const char *url) { int ret; + ssize_t size; + struct lttng_uri *uris = NULL; + struct lttng_session_descriptor *descriptor = NULL; + enum lttng_error_code ret_code; - /* - * Stop the tracing without waiting for the data. - * The session might already have been stopped, so just - * skip this error. - */ - ret = _lttng_stop_tracing(session_name, 0); - if (ret && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) { + if (!name) { + ret = -LTTNG_ERR_INVALID; goto end; } - ret = _lttng_destroy_session(session_name); -end: - return ret; -} - -/* - * Ask the session daemon for all available sessions. - * Sets the contents of the sessions array. + size = uri_parse_str_urls(url, NULL, &uris); + if (size < 0) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + switch (size) { + case 0: + descriptor = lttng_session_descriptor_create(name); + break; + case 1: + if (uris[0].dtype != LTTNG_DST_PATH) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + descriptor = lttng_session_descriptor_local_create(name, + uris[0].dst.path); + break; + case 2: + descriptor = lttng_session_descriptor_network_create(name, url, + NULL); + break; + default: + ret = -LTTNG_ERR_INVALID; + goto end; + } + if (!descriptor) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + ret_code = lttng_create_session_ext(descriptor); + ret = ret_code == LTTNG_OK ? 0 : -ret_code; +end: + lttng_session_descriptor_destroy(descriptor); + free(uris); + return ret; +} + +/* + * Create a session exclusively used for snapshot. + * + * Return 0 on success else a negative LTTng error code. + */ +int lttng_create_session_snapshot(const char *name, const char *snapshot_url) +{ + int ret; + enum lttng_error_code ret_code; + ssize_t size; + struct lttng_uri *uris = NULL; + struct lttng_session_descriptor *descriptor = NULL; + + if (!name) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + + size = uri_parse_str_urls(snapshot_url, NULL, &uris); + if (size < 0) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + /* + * If the user does not specify a custom subdir, use the session name. + */ + if (size > 0 && uris[0].dtype != LTTNG_DST_PATH && + strlen(uris[0].subdir) == 0) { + ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s", + name); + if (ret < 0) { + PERROR("Failed to set session name as network destination sub-directory"); + ret = -LTTNG_ERR_FATAL; + goto end; + } else if (ret >= sizeof(uris[0].subdir)) { + /* Truncated output. */ + ret = -LTTNG_ERR_INVALID; + goto end; + } + } + + switch (size) { + case 0: + descriptor = lttng_session_descriptor_snapshot_create(name); + break; + case 1: + if (uris[0].dtype != LTTNG_DST_PATH) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + descriptor = lttng_session_descriptor_snapshot_local_create( + name, + uris[0].dst.path); + break; + case 2: + descriptor = lttng_session_descriptor_snapshot_network_create( + name, + snapshot_url, + NULL); + break; + default: + ret = -LTTNG_ERR_INVALID; + goto end; + } + if (!descriptor) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + ret_code = lttng_create_session_ext(descriptor); + ret = ret_code == LTTNG_OK ? 0 : -ret_code; +end: + lttng_session_descriptor_destroy(descriptor); + free(uris); + return ret; +} + +/* + * Create a session exclusively used for live. + * + * Return 0 on success else a negative LTTng error code. + */ +int lttng_create_session_live(const char *name, const char *url, + unsigned int timer_interval) +{ + int ret; + enum lttng_error_code ret_code; + struct lttng_session_descriptor *descriptor = NULL; + + if (!name) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + + if (url) { + descriptor = lttng_session_descriptor_live_network_create( + name, url, NULL, timer_interval); + } else { + descriptor = lttng_session_descriptor_live_create( + name, timer_interval); + } + if (!descriptor) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + ret_code = lttng_create_session_ext(descriptor); + ret = ret_code == LTTNG_OK ? 0 : -ret_code; +end: + lttng_session_descriptor_destroy(descriptor); + return ret; +} + +/* + * Stop the session and wait for the data before destroying it + * + * Return 0 on success else a negative LTTng error code. + */ +int lttng_destroy_session(const char *session_name) +{ + int ret; + enum lttng_error_code ret_code; + enum lttng_destruction_handle_status status; + struct lttng_destruction_handle *handle = NULL; + + /* + * Stop the tracing and wait for the data to be + * consumed. + */ + ret = _lttng_stop_tracing(session_name, 1); + if (ret && ret != -LTTNG_ERR_TRACE_ALREADY_STOPPED) { + goto end; + } + + ret_code = lttng_destroy_session_ext(session_name, &handle); + if (ret_code != LTTNG_OK) { + ret = (int) -ret_code; + goto end; + } + assert(handle); + + /* Block until the completion of the destruction of the session. */ + status = lttng_destruction_handle_wait_for_completion(handle, -1); + if (status != LTTNG_DESTRUCTION_HANDLE_STATUS_COMPLETED) { + ret = -LTTNG_ERR_UNK; + goto end; + } + + status = lttng_destruction_handle_get_result(handle, &ret_code); + if (status != LTTNG_DESTRUCTION_HANDLE_STATUS_OK) { + ret = -LTTNG_ERR_UNK; + goto end; + } + ret = ret_code == LTTNG_OK ? 0 : -ret_code; +end: + lttng_destruction_handle_destroy(handle); + return ret; +} + +/* + * Destroy the session without waiting for the data. + */ +int lttng_destroy_session_no_wait(const char *session_name) +{ + enum lttng_error_code ret_code; + + ret_code = lttng_destroy_session_ext(session_name, NULL); + return ret_code == LTTNG_OK ? ret_code : -ret_code; +} + +/* + * Ask the session daemon for all available sessions. + * Sets the contents of the sessions array. * Returns the number of lttng_session entries in sessions; * on error, returns a negative value. */ -int lttng_list_sessions(struct lttng_session **sessions) +int lttng_list_sessions(struct lttng_session **out_sessions) { int ret; struct lttcomm_session_msg lsm; + const size_t session_size = sizeof(struct lttng_session) + + sizeof(struct lttng_session_extended); + size_t session_count, i; + struct lttng_session_extended *sessions_extended_begin; + struct lttng_session *sessions = NULL; memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_LIST_SESSIONS; - ret = lttng_ctl_ask_sessiond(&lsm, (void**) sessions); - if (ret < 0) { - return ret; + ret = lttng_ctl_ask_sessiond(&lsm, (void**) &sessions); + if (ret <= 0) { + goto end; + } + if (!sessions) { + ret = -LTTNG_ERR_FATAL; + goto end; + } + + if (ret % session_size) { + ret = -LTTNG_ERR_UNK; + free(sessions); + *out_sessions = NULL; + goto end; } + session_count = (size_t) ret / session_size; + sessions_extended_begin = (struct lttng_session_extended *) + (&sessions[session_count]); + + /* Set extended session info pointers. */ + for (i = 0; i < session_count; i++) { + struct lttng_session *session = &sessions[i]; + struct lttng_session_extended *extended = + &(sessions_extended_begin[i]); - return ret / sizeof(struct lttng_session); + session->extended.ptr = extended; + } + + ret = (int) session_count; + *out_sessions = sessions; +end: + return ret; +} + +enum lttng_error_code lttng_session_get_creation_time( + const struct lttng_session *session, uint64_t *creation_time) +{ + enum lttng_error_code ret = LTTNG_OK; + struct lttng_session_extended *extended; + + if (!session || !creation_time || !session->extended.ptr) { + ret = LTTNG_ERR_INVALID; + goto end; + } + + extended = session->extended.ptr; + if (!extended->creation_time.is_set) { + /* Not created on the session daemon yet. */ + ret = LTTNG_ERR_SESSION_NOT_EXIST; + goto end; + } + *creation_time = extended->creation_time.value; +end: + return ret; } int lttng_set_session_shm_path(const char *session_name, const char *shm_path) { + int ret; struct lttcomm_session_msg lsm; if (session_name == NULL) { @@ -1826,12 +2218,23 @@ int lttng_set_session_shm_path(const char *session_name, memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_SET_SESSION_SHM_PATH; - lttng_ctl_copy_string(lsm.session.name, session_name, + ret = lttng_strncpy(lsm.session.name, session_name, sizeof(lsm.session.name)); - lttng_ctl_copy_string(lsm.u.set_shm_path.shm_path, shm_path, + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + + ret = lttng_strncpy(lsm.u.set_shm_path.shm_path, shm_path ?: "", sizeof(lsm.u.set_shm_path.shm_path)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } - return lttng_ctl_ask_sessiond(&lsm, NULL); + ret = lttng_ctl_ask_sessiond(&lsm, NULL); +end: + return ret; } /* @@ -1847,21 +2250,28 @@ int lttng_list_domains(const char *session_name, struct lttcomm_session_msg lsm; if (session_name == NULL) { - return -LTTNG_ERR_INVALID; + ret = -LTTNG_ERR_INVALID; + goto error; } memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_LIST_DOMAINS; - lttng_ctl_copy_string(lsm.session.name, session_name, + ret = lttng_strncpy(lsm.session.name, session_name, sizeof(lsm.session.name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto error; + } ret = lttng_ctl_ask_sessiond(&lsm, (void**) domains); if (ret < 0) { - return ret; + goto error; } return ret / sizeof(struct lttng_domain); +error: + return ret; } /* @@ -1887,10 +2297,14 @@ int lttng_list_channels(struct lttng_handle *handle, memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_LIST_CHANNELS; - lttng_ctl_copy_string(lsm.session.name, handle->session_name, + ret = lttng_strncpy(lsm.session.name, handle->session_name, sizeof(lsm.session.name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } - lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + COPY_DOMAIN_PACKED(lsm.domain, handle->domain); ret = lttng_ctl_ask_sessiond(&lsm, (void**) channels); if (ret < 0) { @@ -1946,11 +2360,21 @@ int lttng_list_events(struct lttng_handle *handle, memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_LIST_EVENTS; - lttng_ctl_copy_string(lsm.session.name, handle->session_name, + ret = lttng_strncpy(lsm.session.name, handle->session_name, sizeof(lsm.session.name)); - lttng_ctl_copy_string(lsm.u.list.channel_name, channel_name, + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + + ret = lttng_strncpy(lsm.u.list.channel_name, channel_name, sizeof(lsm.u.list.channel_name)); - lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } + + COPY_DOMAIN_PACKED(lsm.domain, handle->domain); ret = lttng_ctl_ask_sessiond_fds_varlen(&lsm, NULL, 0, NULL, 0, (void **) &reception_buffer, (void **) &cmd_header, @@ -2468,20 +2892,27 @@ int lttng_set_consumer_url(struct lttng_handle *handle, struct lttng_uri *uris = NULL; if (handle == NULL || (control_url == NULL && data_url == NULL)) { - return -LTTNG_ERR_INVALID; + ret = -LTTNG_ERR_INVALID; + goto error; } memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_SET_CONSUMER_URI; - lttng_ctl_copy_string(lsm.session.name, handle->session_name, + ret = lttng_strncpy(lsm.session.name, handle->session_name, sizeof(lsm.session.name)); - lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto error; + } + + COPY_DOMAIN_PACKED(lsm.domain, handle->domain); size = uri_parse_str_urls(control_url, data_url, &uris); if (size < 0) { - return -LTTNG_ERR_INVALID; + ret = -LTTNG_ERR_INVALID; + goto error; } lsm.u.uri.size = size; @@ -2490,6 +2921,7 @@ int lttng_set_consumer_url(struct lttng_handle *handle, sizeof(struct lttng_uri) * size, NULL); free(uris); +error: return ret; } @@ -2510,71 +2942,12 @@ int lttng_disable_consumer(struct lttng_handle *handle) } /* - * This is an extension of create session that is ONLY and SHOULD only be used - * by the lttng command line program. It exists to avoid using URI parsing in - * the lttng client. - * - * We need the date and time for the trace path subdirectory for the case where - * the user does NOT define one using either -o or -U. Using the normal - * lttng_create_session API call, we have no clue on the session daemon side if - * the URL was generated automatically by the client or define by the user. - * - * So this function "wrapper" is hidden from the public API, takes the datetime - * string and appends it if necessary to the URI subdirectory before sending it - * to the session daemon. - * - * With this extra function, the lttng_create_session call behavior is not - * changed and the timestamp is appended to the URI on the session daemon side - * if necessary. + * [OBSOLETE] */ int _lttng_create_session_ext(const char *name, const char *url, const char *datetime) { - int ret; - ssize_t size; - struct lttcomm_session_msg lsm; - struct lttng_uri *uris = NULL; - - if (name == NULL || datetime == NULL) { - return -LTTNG_ERR_INVALID; - } - - memset(&lsm, 0, sizeof(lsm)); - - lsm.cmd_type = LTTNG_CREATE_SESSION; - lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name)); - - /* There should never be a data URL. */ - size = uri_parse_str_urls(url, NULL, &uris); - if (size < 0) { - ret = -LTTNG_ERR_INVALID; - goto error; - } - - lsm.u.uri.size = size; - - if (size > 0 && uris[0].dtype != LTTNG_DST_PATH && strlen(uris[0].subdir) == 0) { - /* Don't append datetime if the name was automatically created. */ - if (strncmp(name, DEFAULT_SESSION_NAME "-", - strlen(DEFAULT_SESSION_NAME) + 1)) { - ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s-%s", - name, datetime); - } else { - ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s", name); - } - if (ret < 0) { - PERROR("snprintf uri subdir"); - ret = -LTTNG_ERR_FATAL; - goto error; - } - } - - ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, uris, - sizeof(struct lttng_uri) * size, NULL); - -error: - free(uris); - return ret; + return -ENOSYS; } /* @@ -2595,8 +2968,12 @@ int lttng_data_pending(const char *session_name) memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_DATA_PENDING; - lttng_ctl_copy_string(lsm.session.name, session_name, + ret = lttng_strncpy(lsm.session.name, session_name, sizeof(lsm.session.name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } ret = lttng_ctl_ask_sessiond(&lsm, (void **) &pending); if (ret < 0) { @@ -2605,6 +2982,10 @@ int lttng_data_pending(const char *session_name) /* Unexpected payload size */ ret = -LTTNG_ERR_INVALID; goto end; + } else if (!pending) { + /* Internal error. */ + ret = -LTTNG_ERR_UNK; + goto end; } ret = (int) *pending; @@ -2613,103 +2994,6 @@ end: return ret; } -/* - * Create a session exclusively used for snapshot. - * - * Returns LTTNG_OK on success or a negative error code. - */ -int lttng_create_session_snapshot(const char *name, const char *snapshot_url) -{ - int ret; - ssize_t size; - struct lttcomm_session_msg lsm; - struct lttng_uri *uris = NULL; - - if (name == NULL) { - return -LTTNG_ERR_INVALID; - } - - memset(&lsm, 0, sizeof(lsm)); - - lsm.cmd_type = LTTNG_CREATE_SESSION_SNAPSHOT; - lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name)); - - size = uri_parse_str_urls(snapshot_url, NULL, &uris); - if (size < 0) { - return -LTTNG_ERR_INVALID; - } - - lsm.u.uri.size = size; - - /* - * If the user does not specify a custom subdir, use the session name. - */ - if (size > 0 && uris[0].dtype != LTTNG_DST_PATH && strlen(uris[0].subdir) == 0) { - ret = snprintf(uris[0].subdir, sizeof(uris[0].subdir), "%s", name); - if (ret < 0) { - PERROR("snprintf uri subdir"); - ret = -LTTNG_ERR_FATAL; - goto error; - } - } - - ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, uris, - sizeof(struct lttng_uri) * size, NULL); - -error: - free(uris); - return ret; -} - -/* - * Create a session exclusively used for live. - * - * Returns LTTNG_OK on success or a negative error code. - */ -int lttng_create_session_live(const char *name, const char *url, - unsigned int timer_interval) -{ - int ret; - ssize_t size; - struct lttcomm_session_msg lsm; - struct lttng_uri *uris = NULL; - - if (name == NULL || timer_interval == 0) { - return -LTTNG_ERR_INVALID; - } - - memset(&lsm, 0, sizeof(lsm)); - - lsm.cmd_type = LTTNG_CREATE_SESSION_LIVE; - lttng_ctl_copy_string(lsm.session.name, name, sizeof(lsm.session.name)); - - if (url) { - size = uri_parse_str_urls(url, NULL, &uris); - if (size <= 0) { - ret = -LTTNG_ERR_INVALID; - goto end; - } - - /* file:// is not accepted for live session. */ - if (uris[0].dtype == LTTNG_DST_PATH) { - ret = -LTTNG_ERR_INVALID; - goto end; - } - } else { - size = 0; - } - - lsm.u.session_live.nb_uri = size; - lsm.u.session_live.timer_interval = timer_interval; - - ret = lttng_ctl_ask_sessiond_varlen_no_cmd_header(&lsm, uris, - sizeof(struct lttng_uri) * size, NULL); - -end: - free(uris); - return ret; -} - /* * List PIDs in the tracker. * @@ -2735,9 +3019,12 @@ int lttng_list_tracker_pids(struct lttng_handle *handle, memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_LIST_TRACKER_PIDS; - lttng_ctl_copy_string(lsm.session.name, handle->session_name, + ret = lttng_strncpy(lsm.session.name, handle->session_name, sizeof(lsm.session.name)); - lttng_ctl_copy_lttng_domain(&lsm.domain, &handle->domain); + if (ret) { + return -LTTNG_ERR_INVALID; + } + COPY_DOMAIN_PACKED(lsm.domain, handle->domain); ret = lttng_ctl_ask_sessiond(&lsm, (void **) &pids); if (ret < 0) { @@ -2776,8 +3063,12 @@ int lttng_regenerate_metadata(const char *session_name) memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_REGENERATE_METADATA; - lttng_ctl_copy_string(lsm.session.name, session_name, + ret = lttng_strncpy(lsm.session.name, session_name, sizeof(lsm.session.name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } ret = lttng_ctl_ask_sessiond(&lsm, NULL); if (ret < 0) { @@ -2814,8 +3105,12 @@ int lttng_regenerate_statedump(const char *session_name) memset(&lsm, 0, sizeof(lsm)); lsm.cmd_type = LTTNG_REGENERATE_STATEDUMP; - lttng_ctl_copy_string(lsm.session.name, session_name, + ret = lttng_strncpy(lsm.session.name, session_name, sizeof(lsm.session.name)); + if (ret) { + ret = -LTTNG_ERR_INVALID; + goto end; + } ret = lttng_ctl_ask_sessiond(&lsm, NULL); if (ret < 0) {