Fix: stream fd leaks on error
[lttng-ust.git] / liblttng-ust / lttng-ust-abi.c
index f26ab5c42907f6a71aab27620e7ecbea10465e07..77bb90db02d24d42ccdf6c996a3d1c82e9266e70 100644 (file)
  *     - Takes instrumentation source specific arguments.
  */
 
-#include <lttng/ust-abi.h>
-#include <lttng/ust-error.h>
+#define _LGPL_SOURCE
+#include <fcntl.h>
+#include <stdint.h>
+#include <unistd.h>
+
 #include <urcu/compiler.h>
 #include <urcu/list.h>
+
+#include <helper.h>
+#include <lttng/tracepoint.h>
+#include <lttng/ust-abi.h>
+#include <lttng/ust-error.h>
 #include <lttng/ust-events.h>
 #include <lttng/ust-version.h>
-#include <lttng/tracepoint.h>
-#include "tracepoint-internal.h"
+#include <ust-fd.h>
 #include <usterr-signal-safe.h>
-#include <helper.h>
-#include "lttng-tracer.h"
-#include "../libringbuffer/shm.h"
+
 #include "../libringbuffer/frontend_types.h"
+#include "../libringbuffer/shm.h"
+#include "../libcounter/counter.h"
+#include "tracepoint-internal.h"
+#include "lttng-tracer.h"
+#include "string-utils.h"
+#include "ust-events-internal.h"
 
 #define OBJ_NAME_LEN   16
 
@@ -185,6 +196,7 @@ static
 void objd_ref(int id)
 {
        struct lttng_ust_obj *obj = _objd_get(id);
+       assert(obj != NULL);
        obj->u.s.f_count++;
 }
 
@@ -207,7 +219,7 @@ int lttng_ust_objd_unref(int id, int is_owner)
        }
        if ((--obj->u.s.f_count) == 1) {
                const struct lttng_ust_objd_ops *ops = objd_ops(id);
-               
+
                if (ops->release)
                        ops->release(id);
                objd_free(id);
@@ -271,9 +283,11 @@ void lttng_ust_objd_table_owner_cleanup(void *owner)
  */
 
 static const struct lttng_ust_objd_ops lttng_ops;
+static const struct lttng_ust_objd_ops lttng_event_notifier_group_ops;
 static const struct lttng_ust_objd_ops lttng_session_ops;
 static const struct lttng_ust_objd_ops lttng_channel_ops;
-static const struct lttng_ust_objd_ops lttng_enabler_ops;
+static const struct lttng_ust_objd_ops lttng_event_enabler_ops;
+static const struct lttng_ust_objd_ops lttng_event_notifier_enabler_ops;
 static const struct lttng_ust_objd_ops lttng_tracepoint_list_ops;
 static const struct lttng_ust_objd_ops lttng_tracepoint_field_list_ops;
 
@@ -331,12 +345,60 @@ long lttng_abi_tracer_version(int objd,
        return 0;
 }
 
+static
+int lttng_abi_event_notifier_send_fd(void *owner, int event_notifier_notif_fd)
+{
+       struct lttng_event_notifier_group *event_notifier_group;
+       int event_notifier_group_objd, ret, fd_flag, close_ret;
+
+       event_notifier_group = lttng_event_notifier_group_create();
+       if (!event_notifier_group)
+               return -ENOMEM;
+
+       /*
+        * Set this file descriptor as NON-BLOCKING.
+        */
+       fd_flag = fcntl(event_notifier_notif_fd, F_GETFL);
+
+       fd_flag |= O_NONBLOCK;
+
+       ret = fcntl(event_notifier_notif_fd, F_SETFL, fd_flag);
+       if (ret) {
+               ret = -errno;
+               goto fd_error;
+       }
+
+       event_notifier_group_objd = objd_alloc(event_notifier_group,
+               &lttng_event_notifier_group_ops, owner, "event_notifier_group");
+       if (event_notifier_group_objd < 0) {
+               ret = event_notifier_group_objd;
+               goto objd_error;
+       }
+
+       event_notifier_group->objd = event_notifier_group_objd;
+       event_notifier_group->owner = owner;
+       event_notifier_group->notification_fd = event_notifier_notif_fd;
+
+       return event_notifier_group_objd;
+
+objd_error:
+       lttng_event_notifier_group_destroy(event_notifier_group);
+fd_error:
+       close_ret = close(event_notifier_notif_fd);
+       if (close_ret) {
+               PERROR("close");
+       }
+
+       return ret;
+}
+
 static
 long lttng_abi_add_context(int objd,
        struct lttng_ust_context *context_param,
+       union ust_args *uargs,
        struct lttng_ctx **ctx, struct lttng_session *session)
 {
-       return lttng_attach_context(context_param, ctx, session);
+       return lttng_attach_context(context_param, uargs, ctx, session);
 }
 
 /**
@@ -377,8 +439,11 @@ long lttng_cmd(int objd, unsigned int cmd, unsigned long arg,
        case LTTNG_UST_TRACEPOINT_FIELD_LIST:
                return lttng_abi_tracepoint_field_list(owner);
        case LTTNG_UST_WAIT_QUIESCENT:
-               synchronize_trace();
+               lttng_ust_synchronize_trace();
                return 0;
+       case LTTNG_UST_EVENT_NOTIFIER_GROUP_CREATE:
+               return lttng_abi_event_notifier_send_fd(owner,
+                       uargs->event_notifier_handle.event_notifier_notif_fd);
        default:
                return -EINVAL;
        }
@@ -388,6 +453,7 @@ static const struct lttng_ust_objd_ops lttng_ops = {
        .cmd = lttng_cmd,
 };
 
+static
 int lttng_abi_map_channel(int session_objd,
                struct lttng_ust_channel *ust_chan,
                union ust_args *uargs,
@@ -432,6 +498,10 @@ int lttng_abi_map_channel(int session_objd,
                goto handle_error;
        }
 
+       /* Ownership of chan_data and wakeup_fd taken by channel handle. */
+       uargs->channel.chan_data = NULL;
+       uargs->channel.wakeup_fd = -1;
+
        chan = shmp(channel_handle, channel_handle->chan);
        assert(chan);
        chan->handle = channel_handle;
@@ -446,8 +516,19 @@ int lttng_abi_map_channel(int session_objd,
        switch (type) {
        case LTTNG_UST_CHAN_PER_CPU:
                if (config->output == RING_BUFFER_MMAP) {
-                       transport_name = config->mode == RING_BUFFER_OVERWRITE ?
-                               "relay-overwrite-mmap" : "relay-discard-mmap";
+                       if (config->mode == RING_BUFFER_OVERWRITE) {
+                               if (config->wakeup == RING_BUFFER_WAKEUP_BY_WRITER) {
+                                       transport_name = "relay-overwrite-mmap";
+                               } else {
+                                       transport_name = "relay-overwrite-rt-mmap";
+                               }
+                       } else {
+                               if (config->wakeup == RING_BUFFER_WAKEUP_BY_WRITER) {
+                                       transport_name = "relay-discard-mmap";
+                               } else {
+                                       transport_name = "relay-discard-rt-mmap";
+                               }
+                       }
                } else {
                        ret = -EINVAL;
                        goto notransport;
@@ -455,8 +536,6 @@ int lttng_abi_map_channel(int session_objd,
                chan_name = "channel";
                break;
        default:
-               transport_name = "<unknown>";
-               chan_name = "<unknown>";
                ret = -EINVAL;
                goto notransport;
        }
@@ -502,27 +581,13 @@ int lttng_abi_map_channel(int session_objd,
        /* error path after channel was created */
 objd_error:
 notransport:
-       free(lttng_chan);
 alloc_error:
        channel_destroy(chan, channel_handle, 0);
        return ret;
 
-       /*
-        * error path before channel creation (owning chan_data and
-        * wakeup_fd).
-        */
 handle_error:
 active:
 invalid:
-       {
-               int close_ret;
-
-               close_ret = close(wakeup_fd);
-               if (close_ret) {
-                       PERROR("close");
-               }
-       }
-       free(chan_data);
        return ret;
 }
 
@@ -562,6 +627,13 @@ long lttng_session_cmd(int objd, unsigned int cmd, unsigned long arg,
        case LTTNG_UST_SESSION_STOP:
        case LTTNG_UST_DISABLE:
                return lttng_session_disable(session);
+       case LTTNG_UST_SESSION_STATEDUMP:
+               return lttng_session_statedump(session);
+       case LTTNG_UST_COUNTER:
+       case LTTNG_UST_COUNTER_GLOBAL:
+       case LTTNG_UST_COUNTER_CPU:
+               /* Not implemented yet. */
+               return -EINVAL;
        default:
                return -EINVAL;
        }
@@ -593,6 +665,276 @@ static const struct lttng_ust_objd_ops lttng_session_ops = {
        .cmd = lttng_session_cmd,
 };
 
+static int lttng_ust_event_notifier_enabler_create(int event_notifier_group_obj,
+               void *owner, struct lttng_ust_event_notifier *event_notifier_param,
+               enum lttng_enabler_format_type type)
+{
+       struct lttng_event_notifier_group *event_notifier_group =
+               objd_private(event_notifier_group_obj);
+       struct lttng_event_notifier_enabler *event_notifier_enabler;
+       int event_notifier_objd, ret;
+
+       event_notifier_param->event.name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
+       event_notifier_objd = objd_alloc(NULL, &lttng_event_notifier_enabler_ops, owner,
+               "event_notifier enabler");
+       if (event_notifier_objd < 0) {
+               ret = event_notifier_objd;
+               goto objd_error;
+       }
+
+       event_notifier_enabler = lttng_event_notifier_enabler_create(
+               event_notifier_group, type, event_notifier_param);
+       if (!event_notifier_enabler) {
+               ret = -ENOMEM;
+               goto event_notifier_error;
+       }
+
+       objd_set_private(event_notifier_objd, event_notifier_enabler);
+       /* The event_notifier holds a reference on the event_notifier group. */
+       objd_ref(event_notifier_enabler->group->objd);
+
+       return event_notifier_objd;
+
+event_notifier_error:
+       {
+               int err;
+
+               err = lttng_ust_objd_unref(event_notifier_objd, 1);
+               assert(!err);
+       }
+objd_error:
+       return ret;
+}
+
+static
+long lttng_event_notifier_enabler_cmd(int objd, unsigned int cmd, unsigned long arg,
+               union ust_args *uargs, void *owner)
+{
+       struct lttng_event_notifier_enabler *event_notifier_enabler = objd_private(objd);
+       switch (cmd) {
+       case LTTNG_UST_FILTER:
+               return lttng_event_notifier_enabler_attach_filter_bytecode(
+                       event_notifier_enabler,
+                       (struct lttng_ust_bytecode_node *) arg);
+       case LTTNG_UST_EXCLUSION:
+               return lttng_event_notifier_enabler_attach_exclusion(event_notifier_enabler,
+                       (struct lttng_ust_excluder_node *) arg);
+       case LTTNG_UST_CAPTURE:
+               return lttng_event_notifier_enabler_attach_capture_bytecode(
+                       event_notifier_enabler,
+                       (struct lttng_ust_bytecode_node *) arg);
+       case LTTNG_UST_ENABLE:
+               return lttng_event_notifier_enabler_enable(event_notifier_enabler);
+       case LTTNG_UST_DISABLE:
+               return lttng_event_notifier_enabler_disable(event_notifier_enabler);
+       default:
+               return -EINVAL;
+       }
+}
+
+/**
+ *     lttng_event_notifier_group_error_counter_cmd - lttng event_notifier group error counter object command
+ *
+ *     @obj: the object
+ *     @cmd: the command
+ *     @arg: command arg
+ *     @uargs: UST arguments (internal)
+ *     @owner: objd owner
+ *
+ *     This descriptor implements lttng commands:
+ *      LTTNG_UST_COUNTER_GLOBAL
+ *        Return negative error code on error, 0 on success.
+ *      LTTNG_UST_COUNTER_CPU
+ *        Return negative error code on error, 0 on success.
+ */
+static
+long lttng_event_notifier_group_error_counter_cmd(int objd, unsigned int cmd, unsigned long arg,
+       union ust_args *uargs, void *owner)
+{
+       struct lttng_counter *counter = objd_private(objd);
+
+       switch (cmd) {
+       case LTTNG_UST_COUNTER_GLOBAL:
+               return -EINVAL;         /* Unimplemented. */
+       case LTTNG_UST_COUNTER_CPU:
+       {
+               struct lttng_ust_counter_cpu *counter_cpu =
+                       (struct lttng_ust_counter_cpu *)arg;
+               return lttng_counter_set_cpu_shm(counter->counter,
+                       counter_cpu->cpu_nr, uargs->counter_shm.shm_fd);
+       }
+       default:
+               return -EINVAL;
+       }
+}
+
+int lttng_release_event_notifier_group_error_counter(int objd)
+{
+       struct lttng_counter *counter = objd_private(objd);
+
+       if (counter) {
+               return lttng_ust_objd_unref(counter->event_notifier_group->objd, 0);
+       } else {
+               return -EINVAL;
+       }
+}
+
+static const struct lttng_ust_objd_ops lttng_event_notifier_group_error_counter_ops = {
+       .release = lttng_release_event_notifier_group_error_counter,
+       .cmd = lttng_event_notifier_group_error_counter_cmd,
+};
+
+static
+int lttng_ust_event_notifier_group_create_error_counter(int event_notifier_group_objd, void *owner,
+               struct lttng_ust_counter_conf *error_counter_conf)
+{
+       const char *counter_transport_name;
+       struct lttng_event_notifier_group *event_notifier_group =
+               objd_private(event_notifier_group_objd);
+       struct lttng_counter *counter;
+       int counter_objd, ret;
+       struct lttng_counter_dimension dimensions[1];
+       size_t counter_len;
+
+       if (event_notifier_group->error_counter)
+               return -EBUSY;
+
+       if (error_counter_conf->arithmetic != LTTNG_UST_COUNTER_ARITHMETIC_MODULAR)
+               return -EINVAL;
+
+       if (error_counter_conf->number_dimensions != 1)
+               return -EINVAL;
+
+       switch (error_counter_conf->bitness) {
+       case LTTNG_UST_COUNTER_BITNESS_64:
+               counter_transport_name = "counter-per-cpu-64-modular";
+               break;
+       case LTTNG_UST_COUNTER_BITNESS_32:
+               counter_transport_name = "counter-per-cpu-32-modular";
+               break;
+       default:
+               return -EINVAL;
+       }
+
+       counter_objd = objd_alloc(NULL, &lttng_event_notifier_group_error_counter_ops, owner,
+               "event_notifier group error counter");
+       if (counter_objd < 0) {
+               ret = counter_objd;
+               goto objd_error;
+       }
+
+       counter_len = error_counter_conf->dimensions[0].size;
+       dimensions[0].size = counter_len;
+       dimensions[0].underflow_index = 0;
+       dimensions[0].overflow_index = 0;
+       dimensions[0].has_underflow = 0;
+       dimensions[0].has_overflow = 0;
+
+       counter = lttng_ust_counter_create(counter_transport_name, 1, dimensions);
+       if (!counter) {
+               ret = -EINVAL;
+               goto create_error;
+       }
+
+       event_notifier_group->error_counter_len = counter_len;
+       /*
+        * store-release to publish error counter matches load-acquire
+        * in record_error. Ensures the counter is created and the
+        * error_counter_len is set before they are used.
+        * Currently a full memory barrier is used, which could be
+        * turned into acquire-release barriers.
+        */
+       cmm_smp_mb();
+       CMM_STORE_SHARED(event_notifier_group->error_counter, counter);
+
+       counter->objd = counter_objd;
+       counter->event_notifier_group = event_notifier_group;   /* owner */
+
+       objd_set_private(counter_objd, counter);
+       /* The error counter holds a reference on the event_notifier group. */
+       objd_ref(event_notifier_group->objd);
+
+       return counter_objd;
+
+create_error:
+       {
+               int err;
+
+               err = lttng_ust_objd_unref(counter_objd, 1);
+               assert(!err);
+       }
+objd_error:
+       return ret;
+}
+
+static
+long lttng_event_notifier_group_cmd(int objd, unsigned int cmd, unsigned long arg,
+               union ust_args *uargs, void *owner)
+{
+       switch (cmd) {
+       case LTTNG_UST_EVENT_NOTIFIER_CREATE:
+       {
+               struct lttng_ust_event_notifier *event_notifier_param =
+                       (struct lttng_ust_event_notifier *) arg;
+               if (strutils_is_star_glob_pattern(event_notifier_param->event.name)) {
+                       /*
+                        * If the event name is a star globbing pattern,
+                        * we create the special star globbing enabler.
+                        */
+                       return lttng_ust_event_notifier_enabler_create(objd,
+                                       owner, event_notifier_param,
+                                       LTTNG_ENABLER_FORMAT_STAR_GLOB);
+               } else {
+                       return lttng_ust_event_notifier_enabler_create(objd,
+                                       owner, event_notifier_param,
+                                       LTTNG_ENABLER_FORMAT_EVENT);
+               }
+       }
+       case LTTNG_UST_COUNTER:
+       {
+               struct lttng_ust_counter_conf *counter_conf =
+                       (struct lttng_ust_counter_conf *) uargs->counter.counter_data;
+               return lttng_ust_event_notifier_group_create_error_counter(
+                               objd, owner, counter_conf);
+       }
+       default:
+               return -EINVAL;
+       }
+}
+
+static
+int lttng_event_notifier_enabler_release(int objd)
+{
+       struct lttng_event_notifier_enabler *event_notifier_enabler = objd_private(objd);
+
+       if (event_notifier_enabler)
+               return lttng_ust_objd_unref(event_notifier_enabler->group->objd, 0);
+       return 0;
+}
+
+static const struct lttng_ust_objd_ops lttng_event_notifier_enabler_ops = {
+       .release = lttng_event_notifier_enabler_release,
+       .cmd = lttng_event_notifier_enabler_cmd,
+};
+
+static
+int lttng_release_event_notifier_group(int objd)
+{
+       struct lttng_event_notifier_group *event_notifier_group = objd_private(objd);
+
+       if (event_notifier_group) {
+               lttng_event_notifier_group_destroy(event_notifier_group);
+               return 0;
+       } else {
+               return -EINVAL;
+       }
+}
+
+static const struct lttng_ust_objd_ops lttng_event_notifier_group_ops = {
+       .release = lttng_release_event_notifier_group,
+       .cmd = lttng_event_notifier_group_cmd,
+};
+
 static
 long lttng_tracepoint_list_cmd(int objd, unsigned int cmd, unsigned long arg,
        union ust_args *uargs, void *owner)
@@ -765,6 +1107,9 @@ int lttng_abi_map_stream(int channel_objd, struct lttng_ust_stream *info,
                info->stream_nr, info->len);
        if (ret)
                goto error_add_stream;
+       /* Take ownership of shm_fd and wakeup_fd. */
+       uargs->stream.shm_fd = -1;
+       uargs->stream.wakeup_fd = -1;
 
        return 0;
 
@@ -773,17 +1118,18 @@ error_add_stream:
 }
 
 static
-int lttng_abi_create_enabler(int channel_objd,
+int lttng_abi_create_event_enabler(int channel_objd,
                           struct lttng_ust_event *event_param,
                           void *owner,
-                          enum lttng_enabler_type type)
+                          enum lttng_enabler_format_type format_type)
 {
        struct lttng_channel *channel = objd_private(channel_objd);
-       struct lttng_enabler *enabler;
+       struct lttng_event_enabler *enabler;
        int event_objd, ret;
 
        event_param->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
-       event_objd = objd_alloc(NULL, &lttng_enabler_ops, owner, "enabler");
+       event_objd = objd_alloc(NULL, &lttng_event_enabler_ops, owner,
+               "event enabler");
        if (event_objd < 0) {
                ret = event_objd;
                goto objd_error;
@@ -792,7 +1138,7 @@ int lttng_abi_create_enabler(int channel_objd,
         * We tolerate no failure path after event creation. It will stay
         * invariant for the rest of the session.
         */
-       enabler = lttng_enabler_create(type, event_param, channel);
+       enabler = lttng_event_enabler_create(format_type, event_param, channel);
        if (!enabler) {
                ret = -ENOMEM;
                goto event_error;
@@ -864,18 +1210,22 @@ long lttng_channel_cmd(int objd, unsigned int cmd, unsigned long arg,
        {
                struct lttng_ust_event *event_param =
                        (struct lttng_ust_event *) arg;
-               if (event_param->name[strlen(event_param->name) - 1] == '*') {
-                       /* If ends with wildcard, create wildcard. */
-                       return lttng_abi_create_enabler(objd, event_param,
-                                       owner, LTTNG_ENABLER_WILDCARD);
+
+               if (strutils_is_star_glob_pattern(event_param->name)) {
+                       /*
+                        * If the event name is a star globbing pattern,
+                        * we create the special star globbing enabler.
+                        */
+                       return lttng_abi_create_event_enabler(objd, event_param,
+                                       owner, LTTNG_ENABLER_FORMAT_STAR_GLOB);
                } else {
-                       return lttng_abi_create_enabler(objd, event_param,
-                                       owner, LTTNG_ENABLER_EVENT);
+                       return lttng_abi_create_event_enabler(objd, event_param,
+                                       owner, LTTNG_ENABLER_FORMAT_EVENT);
                }
        }
        case LTTNG_UST_CONTEXT:
                return lttng_abi_add_context(objd,
-                               (struct lttng_ust_context *) arg,
+                               (struct lttng_ust_context *) arg, uargs,
                                &channel->ctx, channel->session);
        case LTTNG_UST_ENABLE:
                return lttng_channel_enable(channel);
@@ -922,54 +1272,64 @@ static const struct lttng_ust_objd_ops lttng_channel_ops = {
  *             Disable recording for this enabler
  *     LTTNG_UST_FILTER
  *             Attach a filter to an enabler.
+ *     LTTNG_UST_EXCLUSION
+ *             Attach exclusions to an enabler.
  */
 static
-long lttng_enabler_cmd(int objd, unsigned int cmd, unsigned long arg,
+long lttng_event_enabler_cmd(int objd, unsigned int cmd, unsigned long arg,
        union ust_args *uargs, void *owner)
 {
-       struct lttng_enabler *enabler = objd_private(objd);
+       struct lttng_event_enabler *enabler = objd_private(objd);
 
        switch (cmd) {
        case LTTNG_UST_CONTEXT:
-               return lttng_enabler_attach_context(enabler,
+               return lttng_event_enabler_attach_context(enabler,
                                (struct lttng_ust_context *) arg);
        case LTTNG_UST_ENABLE:
-               return lttng_enabler_enable(enabler);
+               return lttng_event_enabler_enable(enabler);
        case LTTNG_UST_DISABLE:
-               return lttng_enabler_disable(enabler);
+               return lttng_event_enabler_disable(enabler);
        case LTTNG_UST_FILTER:
        {
                int ret;
 
-               ret = lttng_enabler_attach_bytecode(enabler,
-                               (struct lttng_ust_filter_bytecode_node *) arg);
+               ret = lttng_event_enabler_attach_filter_bytecode(enabler,
+                               (struct lttng_ust_bytecode_node *) arg);
                if (ret)
                        return ret;
                return 0;
        }
+       case LTTNG_UST_EXCLUSION:
+       {
+               return lttng_event_enabler_attach_exclusion(enabler,
+                               (struct lttng_ust_excluder_node *) arg);
+       }
        default:
                return -EINVAL;
        }
 }
 
 static
-int lttng_enabler_release(int objd)
+int lttng_event_enabler_release(int objd)
 {
-       struct lttng_enabler *enabler = objd_private(objd);
+       struct lttng_event_enabler *event_enabler = objd_private(objd);
+
+       if (event_enabler)
+               return lttng_ust_objd_unref(event_enabler->chan->objd, 0);
 
-       if (enabler)
-               return lttng_ust_objd_unref(enabler->chan->objd, 0);
        return 0;
 }
 
-static const struct lttng_ust_objd_ops lttng_enabler_ops = {
-       .release = lttng_enabler_release,
-       .cmd = lttng_enabler_cmd,
+static const struct lttng_ust_objd_ops lttng_event_enabler_ops = {
+       .release = lttng_event_enabler_release,
+       .cmd = lttng_event_enabler_cmd,
 };
 
 void lttng_ust_abi_exit(void)
 {
        lttng_ust_abi_close_in_progress = 1;
+       ust_lock_nocheck();
        objd_table_destroy();
+       ust_unlock();
        lttng_ust_abi_close_in_progress = 0;
 }
This page took 0.030729 seconds and 4 git commands to generate.