X-Git-Url: https://git.lttng.org/?p=lttng-tools.git;a=blobdiff_plain;f=src%2Fbin%2Flttng-sessiond%2Fchannel.c;h=46256208d58d11fcd2fc2524be97f2a2cbccded8;hp=54345d9c94bfa96a70ab9cd0ab6ffb925a9d4953;hb=4b5ab17b3aec396cfa096ecac1b990242072d644;hpb=1ab1ea0b77d5fc71765e06b5c84431e403e8bd2e diff --git a/src/bin/lttng-sessiond/channel.c b/src/bin/lttng-sessiond/channel.c index 54345d9c9..46256208d 100644 --- a/src/bin/lttng-sessiond/channel.c +++ b/src/bin/lttng-sessiond/channel.c @@ -1,21 +1,23 @@ /* * Copyright (C) 2011 - David Goulet + * Copyright (C) 2016 - Jérémie Galarneau * - * 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; only version 2 of the License. + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License, version 2 only, + * as published by the Free Software Foundation. * - * This program 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. + * This program 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. + * 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., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ -#define _GNU_SOURCE +#define _LGPL_SOURCE +#include #include #include @@ -24,17 +26,23 @@ #include #include "channel.h" +#include "lttng-sessiond.h" #include "kernel.h" -#include "ust-ctl.h" +#include "lttng-ust-ctl.h" +#include "lttng-ust-error.h" #include "utils.h" #include "ust-app.h" +#include "agent.h" /* * Return allocated channel attributes. */ -struct lttng_channel *channel_new_default_attr(int dom) +struct lttng_channel *channel_new_default_attr(int dom, + enum lttng_buffer_type type) { struct lttng_channel *chan; + const char *channel_name = DEFAULT_CHANNEL_NAME; + struct lttng_channel_extended *extended_attr = NULL; chan = zmalloc(sizeof(struct lttng_channel)); if (chan == NULL) { @@ -42,44 +50,103 @@ struct lttng_channel *channel_new_default_attr(int dom) goto error_alloc; } - if (snprintf(chan->name, sizeof(chan->name), "%s", - DEFAULT_CHANNEL_NAME) < 0) { - PERROR("snprintf default channel name"); + extended_attr = zmalloc(sizeof(struct lttng_channel_extended)); + if (!extended_attr) { + PERROR("zmalloc channel extended init"); goto error; } + chan->attr.extended.ptr = extended_attr; + + /* Same for all domains. */ chan->attr.overwrite = DEFAULT_CHANNEL_OVERWRITE; - chan->attr.switch_timer_interval = DEFAULT_CHANNEL_SWITCH_TIMER; - chan->attr.read_timer_interval = DEFAULT_CHANNEL_READ_TIMER; + chan->attr.tracefile_size = DEFAULT_CHANNEL_TRACEFILE_SIZE; + chan->attr.tracefile_count = DEFAULT_CHANNEL_TRACEFILE_COUNT; switch (dom) { case LTTNG_DOMAIN_KERNEL: - chan->attr.subbuf_size = DEFAULT_KERNEL_CHANNEL_SUBBUF_SIZE; + assert(type == LTTNG_BUFFER_GLOBAL); + chan->attr.subbuf_size = + default_get_kernel_channel_subbuf_size(); chan->attr.num_subbuf = DEFAULT_KERNEL_CHANNEL_SUBBUF_NUM; chan->attr.output = DEFAULT_KERNEL_CHANNEL_OUTPUT; + chan->attr.switch_timer_interval = DEFAULT_KERNEL_CHANNEL_SWITCH_TIMER; + chan->attr.read_timer_interval = DEFAULT_KERNEL_CHANNEL_READ_TIMER; + chan->attr.live_timer_interval = DEFAULT_KERNEL_CHANNEL_LIVE_TIMER; + extended_attr->blocking_timeout = DEFAULT_KERNEL_CHANNEL_BLOCKING_TIMEOUT; + extended_attr->monitor_timer_interval = + DEFAULT_KERNEL_CHANNEL_MONITOR_TIMER; break; + case LTTNG_DOMAIN_JUL: + channel_name = DEFAULT_JUL_CHANNEL_NAME; + goto common_ust; + case LTTNG_DOMAIN_LOG4J: + channel_name = DEFAULT_LOG4J_CHANNEL_NAME; + goto common_ust; + case LTTNG_DOMAIN_PYTHON: + channel_name = DEFAULT_PYTHON_CHANNEL_NAME; + goto common_ust; case LTTNG_DOMAIN_UST: -#if 0 - case LTTNG_DOMAIN_UST_PID: - case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN: - case LTTNG_DOMAIN_UST_EXEC_NAME: -#endif - chan->attr.subbuf_size = DEFAULT_UST_CHANNEL_SUBBUF_SIZE; - chan->attr.num_subbuf = DEFAULT_UST_CHANNEL_SUBBUF_NUM; - chan->attr.output = DEFAULT_UST_CHANNEL_OUTPUT; +common_ust: + switch (type) { + case LTTNG_BUFFER_PER_UID: + chan->attr.subbuf_size = default_get_ust_uid_channel_subbuf_size(); + chan->attr.num_subbuf = DEFAULT_UST_UID_CHANNEL_SUBBUF_NUM; + chan->attr.output = DEFAULT_UST_UID_CHANNEL_OUTPUT; + chan->attr.switch_timer_interval = + DEFAULT_UST_UID_CHANNEL_SWITCH_TIMER; + chan->attr.read_timer_interval = + DEFAULT_UST_UID_CHANNEL_READ_TIMER; + chan->attr.live_timer_interval = + DEFAULT_UST_UID_CHANNEL_LIVE_TIMER; + extended_attr->blocking_timeout = DEFAULT_UST_UID_CHANNEL_BLOCKING_TIMEOUT; + extended_attr->monitor_timer_interval = + DEFAULT_UST_UID_CHANNEL_MONITOR_TIMER; + break; + case LTTNG_BUFFER_PER_PID: + default: + chan->attr.subbuf_size = default_get_ust_pid_channel_subbuf_size(); + chan->attr.num_subbuf = DEFAULT_UST_PID_CHANNEL_SUBBUF_NUM; + chan->attr.output = DEFAULT_UST_PID_CHANNEL_OUTPUT; + chan->attr.switch_timer_interval = + DEFAULT_UST_PID_CHANNEL_SWITCH_TIMER; + chan->attr.read_timer_interval = + DEFAULT_UST_PID_CHANNEL_READ_TIMER; + chan->attr.live_timer_interval = + DEFAULT_UST_PID_CHANNEL_LIVE_TIMER; + extended_attr->blocking_timeout = DEFAULT_UST_PID_CHANNEL_BLOCKING_TIMEOUT; + extended_attr->monitor_timer_interval = + DEFAULT_UST_PID_CHANNEL_MONITOR_TIMER; + break; + } break; default: goto error; /* Not implemented */ } + if (snprintf(chan->name, sizeof(chan->name), "%s", + channel_name) < 0) { + PERROR("snprintf default channel name"); + goto error; + } return chan; error: + free(extended_attr); free(chan); error_alloc: return NULL; } +void channel_attr_destroy(struct lttng_channel *channel) +{ + if (!channel) { + return; + } + free(channel->attr.extended.ptr); + free(channel); +} + /* * Disable kernel channel of the kernel session. */ @@ -89,19 +156,25 @@ int channel_kernel_disable(struct ltt_kernel_session *ksession, int ret; struct ltt_kernel_channel *kchan; + assert(ksession); + assert(channel_name); + kchan = trace_kernel_get_channel_by_name(channel_name, ksession); if (kchan == NULL) { - ret = LTTCOMM_KERN_CHAN_NOT_FOUND; + ret = LTTNG_ERR_KERN_CHAN_NOT_FOUND; goto error; - } else if (kchan->enabled == 1) { + } + + /* Only if channel is enabled disable it. */ + if (kchan->enabled == 1) { ret = kernel_disable_channel(kchan); if (ret < 0 && ret != -EEXIST) { - ret = LTTCOMM_KERN_CHAN_DISABLE_FAIL; + ret = LTTNG_ERR_KERN_CHAN_DISABLE_FAIL; goto error; } } - ret = LTTCOMM_OK; + ret = LTTNG_OK; error: return ret; @@ -115,20 +188,48 @@ int channel_kernel_enable(struct ltt_kernel_session *ksession, { int ret; + assert(ksession); + assert(kchan); + if (kchan->enabled == 0) { ret = kernel_enable_channel(kchan); if (ret < 0) { - ret = LTTCOMM_KERN_CHAN_ENABLE_FAIL; + ret = LTTNG_ERR_KERN_CHAN_ENABLE_FAIL; goto error; } + } else { + ret = LTTNG_ERR_KERN_CHAN_EXIST; + goto error; } - ret = LTTCOMM_OK; + ret = LTTNG_OK; error: return ret; } +static int channel_validate(struct lttng_channel *attr) +{ + /* + * The ringbuffer (both in user space and kernel) behaves badly + * in overwrite mode and with less than 2 subbuffers so block it + * right away and send back an invalid attribute error. + */ + if (attr->attr.overwrite && attr->attr.num_subbuf < 2) { + return -1; + } + return 0; +} + +static int channel_validate_kernel(struct lttng_channel *attr) +{ + /* Kernel channels do not support blocking timeout. */ + if (((struct lttng_channel_extended *)attr->attr.extended.ptr)->blocking_timeout) { + return -1; + } + return 0; +} + /* * Create kernel channel of the kernel session and notify kernel thread. */ @@ -138,187 +239,308 @@ int channel_kernel_create(struct ltt_kernel_session *ksession, int ret; struct lttng_channel *defattr = NULL; + assert(ksession); + /* Creating channel attributes if needed */ if (attr == NULL) { - defattr = channel_new_default_attr(LTTNG_DOMAIN_KERNEL); + defattr = channel_new_default_attr(LTTNG_DOMAIN_KERNEL, + LTTNG_BUFFER_GLOBAL); if (defattr == NULL) { - ret = LTTCOMM_FATAL; + ret = LTTNG_ERR_FATAL; goto error; } attr = defattr; } + /* + * Set the overwrite mode for this channel based on the session + * type unless the client explicitly overrides the channel mode. + */ + if (attr->attr.overwrite == DEFAULT_CHANNEL_OVERWRITE) { + attr->attr.overwrite = !!ksession->snapshot_mode; + } + + /* Validate common channel properties. */ + if (channel_validate(attr) < 0) { + ret = LTTNG_ERR_INVALID; + goto error; + } + + if (channel_validate_kernel(attr) < 0) { + ret = LTTNG_ERR_INVALID; + goto error; + } + /* Channel not found, creating it */ - ret = kernel_create_channel(ksession, attr, ksession->trace_path); + ret = kernel_create_channel(ksession, attr); if (ret < 0) { - ret = LTTCOMM_KERN_CHAN_FAIL; + ret = LTTNG_ERR_KERN_CHAN_FAIL; goto error; } /* Notify kernel thread that there is a new channel */ ret = notify_thread_pipe(kernel_pipe); if (ret < 0) { - ret = LTTCOMM_FATAL; + ret = LTTNG_ERR_FATAL; goto error; } - ret = LTTCOMM_OK; + ret = LTTNG_OK; error: - free(defattr); + channel_attr_destroy(defattr); return ret; } /* * Enable UST channel for session and domain. */ -int channel_ust_enable(struct ltt_ust_session *usess, int domain, +int channel_ust_enable(struct ltt_ust_session *usess, struct ltt_ust_channel *uchan) { - int ret = LTTCOMM_OK; + int ret = LTTNG_OK; + + assert(usess); + assert(uchan); /* If already enabled, everything is OK */ if (uchan->enabled) { DBG3("Channel %s already enabled. Skipping", uchan->name); + ret = LTTNG_ERR_UST_CHAN_EXIST; goto end; + } else { + uchan->enabled = 1; + DBG2("Channel %s enabled successfully", uchan->name); } - switch (domain) { - case LTTNG_DOMAIN_UST: - DBG2("Channel %s being enabled in UST global domain", uchan->name); - /* Enable channel for global domain */ - ret = ust_app_enable_channel_glb(usess, uchan); - break; -#if 0 - case LTTNG_DOMAIN_UST_PID: - case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN: - case LTTNG_DOMAIN_UST_EXEC_NAME: -#endif - default: - ret = LTTCOMM_UND; - goto error; + if (!usess->active) { + /* + * The channel will be activated against the apps + * when the session is started as part of the + * application channel "synchronize" operation. + */ + goto end; } - if (ret < 0) { - if (ret != -EEXIST) { - ret = LTTCOMM_UST_CHAN_ENABLE_FAIL; - goto error; - } else { - ret = LTTCOMM_OK; - } - } + DBG2("Channel %s being enabled in UST domain", uchan->name); + + /* + * Enable channel for UST global domain on all applications. Ignore return + * value here since whatever error we got, it means that the channel was + * not created on one or many registered applications and we can not report + * this to the user yet. However, at this stage, the channel was + * successfully created on the session daemon side so the enable-channel + * command is a success. + */ + (void) ust_app_enable_channel_glb(usess, uchan); - uchan->enabled = 1; - DBG2("Channel %s enabled successfully", uchan->name); end: -error: return ret; } /* * Create UST channel for session and domain. */ -int channel_ust_create(struct ltt_ust_session *usess, int domain, - struct lttng_channel *attr) +int channel_ust_create(struct ltt_ust_session *usess, + struct lttng_channel *attr, enum lttng_buffer_type type) { - int ret = LTTCOMM_OK; + int ret = LTTNG_OK; struct ltt_ust_channel *uchan = NULL; struct lttng_channel *defattr = NULL; + enum lttng_domain_type domain = LTTNG_DOMAIN_UST; + bool chan_published = false; + + assert(usess); /* Creating channel attributes if needed */ if (attr == NULL) { - defattr = channel_new_default_attr(domain); + defattr = channel_new_default_attr(LTTNG_DOMAIN_UST, type); if (defattr == NULL) { - ret = LTTCOMM_FATAL; + ret = LTTNG_ERR_FATAL; goto error; } attr = defattr; + } else { + /* + * HACK: Set the channel's subdomain (JUL, Log4j, Python, etc.) + * based on the default name. + */ + if (!strcmp(attr->name, DEFAULT_JUL_CHANNEL_NAME)) { + domain = LTTNG_DOMAIN_JUL; + } else if (!strcmp(attr->name, DEFAULT_LOG4J_CHANNEL_NAME)) { + domain = LTTNG_DOMAIN_LOG4J; + } else if (!strcmp(attr->name, DEFAULT_PYTHON_CHANNEL_NAME)) { + domain = LTTNG_DOMAIN_PYTHON; + } } - /* Create UST channel */ - uchan = trace_ust_create_channel(attr, usess->pathname); - if (uchan == NULL) { - ret = LTTCOMM_FATAL; + /* + * Set the overwrite mode for this channel based on the session + * type unless the client explicitly overrides the channel mode. + */ + if (attr->attr.overwrite == DEFAULT_CHANNEL_OVERWRITE) { + attr->attr.overwrite = !!usess->snapshot_mode; + } + + /* Enforce mmap output for snapshot sessions. */ + if (usess->snapshot_mode) { + attr->attr.output = LTTNG_EVENT_MMAP; + } + + /* Validate common channel properties. */ + if (channel_validate(attr) < 0) { + ret = LTTNG_ERR_INVALID; goto error; } - uchan->enabled = 1; - switch (domain) { - case LTTNG_DOMAIN_UST: - DBG2("Channel %s being created in UST global domain", uchan->name); + /* + * Validate UST buffer size and number of buffers: must both be power of 2 + * and nonzero. We validate right here for UST, because applications will + * not report the error to the user (unlike kernel tracing). + */ + if (!attr->attr.subbuf_size || + (attr->attr.subbuf_size & (attr->attr.subbuf_size - 1))) { + ret = LTTNG_ERR_INVALID; + goto error; + } + + /* + * Invalid subbuffer size if it's lower then the page size. + */ + if (attr->attr.subbuf_size < page_size) { + ret = LTTNG_ERR_INVALID; + goto error; + } + + if (!attr->attr.num_subbuf || + (attr->attr.num_subbuf & (attr->attr.num_subbuf - 1))) { + ret = LTTNG_ERR_INVALID; + goto error; + } + + if (attr->attr.output != LTTNG_EVENT_MMAP) { + ret = LTTNG_ERR_NOT_SUPPORTED; + goto error; + } + + /* + * The tracefile_size should not be < to the subbuf_size, otherwise + * we won't be able to write the packets on disk + */ + if ((attr->attr.tracefile_size > 0) && + (attr->attr.tracefile_size < attr->attr.subbuf_size)) { + ret = LTTNG_ERR_INVALID; + goto error; + } - /* Enable channel for global domain */ - ret = ust_app_create_channel_glb(usess, uchan); + /* Validate buffer type. */ + switch (type) { + case LTTNG_BUFFER_PER_PID: + break; + case LTTNG_BUFFER_PER_UID: break; -#if 0 - case LTTNG_DOMAIN_UST_PID: - case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN: - case LTTNG_DOMAIN_UST_EXEC_NAME: -#endif default: - ret = LTTCOMM_UND; - goto error_free_chan; + ret = LTTNG_ERR_BUFFER_NOT_SUPPORTED; + goto error; + } + + /* Create UST channel */ + uchan = trace_ust_create_channel(attr, domain); + if (uchan == NULL) { + ret = LTTNG_ERR_FATAL; + goto error; } - if (ret < 0 && ret != -EEXIST) { - ret = LTTCOMM_UST_CHAN_ENABLE_FAIL; + uchan->enabled = 1; + if (trace_ust_is_max_id(usess->used_channel_id)) { + ret = LTTNG_ERR_UST_CHAN_FAIL; + goto error; + } + uchan->id = trace_ust_get_next_chan_id(usess); + + DBG2("Channel %s is being created for UST with buffer %d and id %" PRIu64, + uchan->name, type, uchan->id); + + /* Flag session buffer type. */ + if (!usess->buffer_type_changed) { + usess->buffer_type = type; + usess->buffer_type_changed = 1; + } else if (usess->buffer_type != type) { + /* Buffer type was already set. Refuse to create channel. */ + ret = LTTNG_ERR_BUFFER_TYPE_MISMATCH; goto error_free_chan; } /* Adding the channel to the channel hash table. */ rcu_read_lock(); - lttng_ht_add_unique_str(usess->domain_global.channels, &uchan->node); + if (strncmp(uchan->name, DEFAULT_METADATA_NAME, + sizeof(uchan->name))) { + lttng_ht_add_unique_str(usess->domain_global.channels, &uchan->node); + chan_published = true; + } else { + /* + * Copy channel attribute to session if this is metadata so if NO + * application exists we can access that data in the shadow copy during + * the global update of newly registered application. + */ + memcpy(&usess->metadata_attr, &uchan->attr, + sizeof(usess->metadata_attr)); + } rcu_read_unlock(); DBG2("Channel %s created successfully", uchan->name); + if (domain != LTTNG_DOMAIN_UST) { + struct agent *agt = trace_ust_find_agent(usess, domain); + + if (!agt) { + agt = agent_create(domain); + if (!agt) { + ret = LTTNG_ERR_NOMEM; + goto error_remove_chan; + } + agent_add(agt, usess->agents); + } + } - free(defattr); - return LTTCOMM_OK; + channel_attr_destroy(defattr); + return LTTNG_OK; +error_remove_chan: + if (chan_published) { + trace_ust_delete_channel(usess->domain_global.channels, uchan); + } error_free_chan: - /* - * No need to remove the channel from the hash table because at this point - * it was not added hence the direct call and no call_rcu(). - */ trace_ust_destroy_channel(uchan); error: - free(defattr); + channel_attr_destroy(defattr); return ret; } /* * Disable UST channel for session and domain. */ -int channel_ust_disable(struct ltt_ust_session *usess, int domain, +int channel_ust_disable(struct ltt_ust_session *usess, struct ltt_ust_channel *uchan) { - int ret = LTTCOMM_OK; + int ret = LTTNG_OK; + + assert(usess); + assert(uchan); /* Already disabled */ if (uchan->enabled == 0) { DBG2("Channel UST %s already disabled", uchan->name); goto end; } - - /* Get the right channel's hashtable */ - switch (domain) { - case LTTNG_DOMAIN_UST: - DBG2("Channel %s being disabled in UST global domain", uchan->name); - /* Disable channel for global domain */ - ret = ust_app_disable_channel_glb(usess, uchan); - break; -#if 0 - case LTTNG_DOMAIN_UST_PID_FOLLOW_CHILDREN: - case LTTNG_DOMAIN_UST_EXEC_NAME: - case LTTNG_DOMAIN_UST_PID: -#endif - default: - ret = LTTCOMM_UND; - goto error; + if (!usess->active) { + goto end; } - if (ret < 0 && ret != -EEXIST) { - ret = LTTCOMM_UST_DISABLE_FAIL; + DBG2("Channel %s being disabled in UST global domain", uchan->name); + /* Disable channel for global domain */ + ret = ust_app_disable_channel_glb(usess, uchan); + if (ret < 0 && ret != -LTTNG_UST_ERR_EXIST) { + ret = LTTNG_ERR_UST_CHAN_DISABLE_FAIL; goto error; } @@ -326,7 +548,7 @@ int channel_ust_disable(struct ltt_ust_session *usess, int domain, DBG2("Channel %s disabled successfully", uchan->name); - return LTTCOMM_OK; + return LTTNG_OK; end: error: