Distinguish UST return codes from transport return codes
[lttng-ust.git] / liblttng-ust / lttng-ust-abi.c
index 716a2cc9d1a13efe8d8e943a6c41ad6c98395413..bbbcd062e1bd19026820f20ed64046009d021a14 100644 (file)
@@ -1,10 +1,25 @@
 /*
  * lttng-ust-abi.c
  *
- * Copyright 2010-2011 (c) - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
- *
  * LTTng UST ABI
  *
+ * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ *
+ * 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
+ * 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
+ *
+ *
  * Mimic system calls for:
  * - session creation, returns an object descriptor or failure.
  *   - channel creation, returns an object descriptor or failure.
  *     - Takes an instrumentation source as parameter
  *       - e.g. tracepoints, dynamic_probes...
  *     - Takes instrumentation source specific arguments.
- *
- * Dual LGPL v2.1/GPL v2 license.
  */
 
 #include <lttng/ust-abi.h>
+#include <lttng/ust-error.h>
 #include <urcu/compiler.h>
 #include <urcu/list.h>
 #include <lttng/ust-events.h>
 #include <lttng/ust-version.h>
+#include <lttng/tracepoint.h>
+#include "tracepoint-internal.h"
 #include <usterr-signal-safe.h>
 #include <helper.h>
 #include "ltt-tracer.h"
-#include "tracepoint-internal.h"
 
 static int lttng_ust_abi_close_in_progress;
 
 static
 int lttng_abi_tracepoint_list(void);
+static
+int lttng_abi_tracepoint_field_list(void);
 
 /*
  * Object descriptor table. Should be protected from concurrent access
@@ -203,10 +220,10 @@ 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_metadata_ops;
 static const struct lttng_ust_objd_ops lttng_event_ops;
-static const struct lttng_ust_objd_ops lttng_loglevel_ops;
 static const struct lttng_ust_objd_ops lttng_wildcard_ops;
 static const struct lttng_ust_objd_ops lib_ring_buffer_objd_ops;
 static const struct lttng_ust_objd_ops lttng_tracepoint_list_ops;
+static const struct lttng_ust_objd_ops lttng_tracepoint_field_list_ops;
 
 enum channel_type {
        PER_CPU_CHANNEL,
@@ -247,9 +264,9 @@ static
 long lttng_abi_tracer_version(int objd,
        struct lttng_ust_tracer_version *v)
 {
-       v->major = LTTNG_UST_MAJOR_VERSION;
-       v->minor = LTTNG_UST_MINOR_VERSION;
-       v->patchlevel = LTTNG_UST_PATCHLEVEL_VERSION;
+       v->major = LTTNG_UST_INTERNAL_MAJOR_VERSION;
+       v->minor = LTTNG_UST_INTERNAL_MINOR_VERSION;
+       v->patchlevel = LTTNG_UST_INTERNAL_PATCHLEVEL_VERSION;
        return 0;
 }
 
@@ -281,6 +298,7 @@ long lttng_abi_add_context(int objd,
  *     @objd: the object descriptor
  *     @cmd: the command
  *     @arg: command arg
+ *     @uargs: UST arguments (internal)
  *
  *     This descriptor implements lttng commands:
  *     LTTNG_UST_SESSION
@@ -289,13 +307,16 @@ long lttng_abi_add_context(int objd,
  *             Returns the LTTng kernel tracer version
  *     LTTNG_UST_TRACEPOINT_LIST
  *             Returns a file descriptor listing available tracepoints
+ *     LTTNG_UST_TRACEPOINT_FIELD_LIST
+ *             Returns a file descriptor listing available tracepoint fields
  *     LTTNG_UST_WAIT_QUIESCENT
  *             Returns after all previously running probes have completed
  *
  * The returned session will be deleted when its file descriptor is closed.
  */
 static
-long lttng_cmd(int objd, unsigned int cmd, unsigned long arg)
+long lttng_cmd(int objd, unsigned int cmd, unsigned long arg,
+       union ust_args *uargs)
 {
        switch (cmd) {
        case LTTNG_UST_SESSION:
@@ -305,6 +326,8 @@ long lttng_cmd(int objd, unsigned int cmd, unsigned long arg)
                                (struct lttng_ust_tracer_version *) arg);
        case LTTNG_UST_TRACEPOINT_LIST:
                return lttng_abi_tracepoint_list();
+       case LTTNG_UST_TRACEPOINT_FIELD_LIST:
+               return lttng_abi_tracepoint_field_list();
        case LTTNG_UST_WAIT_QUIESCENT:
                synchronize_trace();
                return 0;
@@ -329,6 +352,8 @@ void lttng_metadata_create_events(int channel_objd)
        static struct lttng_ust_event metadata_params = {
                .instrumentation = LTTNG_UST_TRACEPOINT,
                .name = "lttng_ust:metadata",
+               .loglevel_type = LTTNG_UST_LOGLEVEL_ALL,
+               .loglevel = TRACE_DEFAULT,
        };
        struct ltt_event *event;
        int ret;
@@ -337,7 +362,7 @@ void lttng_metadata_create_events(int channel_objd)
         * We tolerate no failure path after event creation. It will stay
         * invariant for the rest of the session.
         */
-       ret = ltt_event_create(channel, &metadata_params, NULL, &event);
+       ret = ltt_event_create(channel, &metadata_params, &event);
        if (ret < 0) {
                goto create_error;
        }
@@ -350,7 +375,8 @@ create_error:
 
 int lttng_abi_create_channel(int session_objd,
                             struct lttng_ust_channel *chan_param,
-                            enum channel_type channel_type)
+                            enum channel_type channel_type,
+                            union ust_args *uargs)
 {
        struct ltt_session *session = objd_private(session_objd);
        const struct lttng_ust_objd_ops *ops;
@@ -399,9 +425,9 @@ int lttng_abi_create_channel(int session_objd,
                                  chan_param->num_subbuf,
                                  chan_param->switch_timer_interval,
                                  chan_param->read_timer_interval,
-                                 &chan_param->shm_fd,
-                                 &chan_param->wait_fd,
-                                 &chan_param->memory_map_size,
+                                 &uargs->channel.shm_fd,
+                                 &uargs->channel.wait_fd,
+                                 &uargs->channel.memory_map_size,
                                  &chan_priv_init);
        if (!chan) {
                ret = -EINVAL;
@@ -435,6 +461,7 @@ objd_error:
  *     @obj: the object
  *     @cmd: the command
  *     @arg: command arg
+ *     @uargs: UST arguments (internal)
  *
  *     This descriptor implements lttng commands:
  *     LTTNG_UST_CHANNEL
@@ -449,7 +476,8 @@ objd_error:
  * The returned channel will be deleted when its file descriptor is closed.
  */
 static
-long lttng_session_cmd(int objd, unsigned int cmd, unsigned long arg)
+long lttng_session_cmd(int objd, unsigned int cmd, unsigned long arg,
+       union ust_args *uargs)
 {
        struct ltt_session *session = objd_private(objd);
 
@@ -457,7 +485,7 @@ long lttng_session_cmd(int objd, unsigned int cmd, unsigned long arg)
        case LTTNG_UST_CHANNEL:
                return lttng_abi_create_channel(objd,
                                (struct lttng_ust_channel *) arg,
-                               PER_CPU_CHANNEL);
+                               PER_CPU_CHANNEL, uargs);
        case LTTNG_UST_SESSION_START:
        case LTTNG_UST_ENABLE:
                return ltt_session_enable(session);
@@ -467,7 +495,7 @@ long lttng_session_cmd(int objd, unsigned int cmd, unsigned long arg)
        case LTTNG_UST_METADATA:
                return lttng_abi_create_channel(objd,
                                (struct lttng_ust_channel *) arg,
-                               METADATA_CHANNEL);
+                               METADATA_CHANNEL, uargs);
        default:
                return -EINVAL;
        }
@@ -500,7 +528,8 @@ static const struct lttng_ust_objd_ops lttng_session_ops = {
 };
 
 static
-long lttng_tracepoint_list_cmd(int objd, unsigned int cmd, unsigned long arg)
+long lttng_tracepoint_list_cmd(int objd, unsigned int cmd, unsigned long arg,
+       union ust_args *uargs)
 {
        struct lttng_ust_tracepoint_list *list = objd_private(objd);
        struct lttng_ust_tracepoint_iter *tp =
@@ -513,7 +542,7 @@ long lttng_tracepoint_list_cmd(int objd, unsigned int cmd, unsigned long arg)
        retry:
                iter = lttng_ust_tracepoint_list_get_iter_next(list);
                if (!iter)
-                       return -ENOENT;
+                       return -LTTNG_UST_ERR_NOENT;
                if (!strcmp(iter->name, "lttng_ust:metadata"))
                        goto retry;
                memcpy(tp, iter, sizeof(*tp));
@@ -581,13 +610,96 @@ static const struct lttng_ust_objd_ops lttng_tracepoint_list_ops = {
        .cmd = lttng_tracepoint_list_cmd,
 };
 
+static
+long lttng_tracepoint_field_list_cmd(int objd, unsigned int cmd,
+       unsigned long arg, union ust_args *uargs)
+{
+       struct lttng_ust_field_list *list = objd_private(objd);
+       struct lttng_ust_field_iter *tp = &uargs->field_list.entry;
+       struct lttng_ust_field_iter *iter;
+
+       switch (cmd) {
+       case LTTNG_UST_TRACEPOINT_FIELD_LIST_GET:
+       {
+       retry:
+               iter = lttng_ust_field_list_get_iter_next(list);
+               if (!iter)
+                       return -LTTNG_UST_ERR_NOENT;
+               if (!strcmp(iter->event_name, "lttng_ust:metadata"))
+                       goto retry;
+               memcpy(tp, iter, sizeof(*tp));
+               return 0;
+       }
+       default:
+               return -EINVAL;
+       }
+}
+
+static
+int lttng_abi_tracepoint_field_list(void)
+{
+       int list_objd, ret;
+       struct lttng_ust_field_list *list;
+
+       list_objd = objd_alloc(NULL, &lttng_tracepoint_field_list_ops);
+       if (list_objd < 0) {
+               ret = list_objd;
+               goto objd_error;
+       }
+       list = zmalloc(sizeof(*list));
+       if (!list) {
+               ret = -ENOMEM;
+               goto alloc_error;
+       }
+       objd_set_private(list_objd, list);
+
+       /* populate list by walking on all registered probes. */
+       ret = ltt_probes_get_field_list(list);
+       if (ret) {
+               goto list_error;
+       }
+       return list_objd;
+
+list_error:
+       free(list);
+alloc_error:
+       {
+               int err;
+
+               err = lttng_ust_objd_unref(list_objd);
+               assert(!err);
+       }
+objd_error:
+       return ret;
+}
+
+static
+int lttng_release_tracepoint_field_list(int objd)
+{
+       struct lttng_ust_field_list *list = objd_private(objd);
+
+       if (list) {
+               ltt_probes_prune_field_list(list);
+               free(list);
+               return 0;
+       } else {
+               return -EINVAL;
+       }
+}
+
+static const struct lttng_ust_objd_ops lttng_tracepoint_field_list_ops = {
+       .release = lttng_release_tracepoint_field_list,
+       .cmd = lttng_tracepoint_field_list_cmd,
+};
+
 struct stream_priv_data {
        struct lttng_ust_lib_ring_buffer *buf;
        struct ltt_channel *ltt_chan;
 };
 
 static
-int lttng_abi_open_stream(int channel_objd, struct lttng_ust_stream *info)
+int lttng_abi_open_stream(int channel_objd, struct lttng_ust_stream *info,
+               union ust_args *uargs)
 {
        struct ltt_channel *channel = objd_private(channel_objd);
        struct lttng_ust_lib_ring_buffer *buf;
@@ -595,7 +707,9 @@ int lttng_abi_open_stream(int channel_objd, struct lttng_ust_stream *info)
        int stream_objd, ret;
 
        buf = channel->ops->buffer_read_open(channel->chan, channel->handle,
-                       &info->shm_fd, &info->wait_fd, &info->memory_map_size);
+                       &uargs->stream.shm_fd,
+                       &uargs->stream.wait_fd,
+                       &uargs->stream.memory_map_size);
        if (!buf)
                return -ENOENT;
 
@@ -640,7 +754,7 @@ int lttng_abi_create_event(int channel_objd,
         * We tolerate no failure path after event creation. It will stay
         * invariant for the rest of the session.
         */
-       ret = ltt_event_create(channel, event_param, NULL, &event);
+       ret = ltt_event_create(channel, event_param, &event);
        if (ret < 0) {
                goto event_error;
        }
@@ -660,44 +774,6 @@ objd_error:
        return ret;
 }
 
-static
-int lttng_abi_create_loglevel(int channel_objd,
-                             struct lttng_ust_event *event_param)
-{
-       struct ltt_channel *channel = objd_private(channel_objd);
-       struct session_loglevel *loglevel;
-       int loglevel_objd, ret;
-
-       event_param->name[LTTNG_UST_SYM_NAME_LEN - 1] = '\0';
-       loglevel_objd = objd_alloc(NULL, &lttng_loglevel_ops);
-       if (loglevel_objd < 0) {
-               ret = loglevel_objd;
-               goto objd_error;
-       }
-       /*
-        * We tolerate no failure path after loglevel creation. It will
-        * stay invariant for the rest of the session.
-        */
-       ret = ltt_loglevel_create(channel, event_param, &loglevel);
-       if (ret < 0) {
-               goto loglevel_error;
-       }
-       objd_set_private(loglevel_objd, loglevel);
-       /* The loglevel holds a reference on the channel */
-       objd_ref(channel_objd);
-       return loglevel_objd;
-
-loglevel_error:
-       {
-               int err;
-
-               err = lttng_ust_objd_unref(loglevel_objd);
-               assert(!err);
-       }
-objd_error:
-       return ret;
-}
-
 static
 int lttng_abi_create_wildcard(int channel_objd,
                              struct lttng_ust_event *event_param)
@@ -742,6 +818,7 @@ objd_error:
  *     @objd: the object descriptor
  *     @cmd: the command
  *     @arg: command arg
+ *     @uargs: UST arguments (internal)
  *
  *     This object descriptor implements lttng commands:
  *      LTTNG_UST_STREAM
@@ -759,7 +836,8 @@ objd_error:
  * Channel and event file descriptors also hold a reference on the session.
  */
 static
-long lttng_channel_cmd(int objd, unsigned int cmd, unsigned long arg)
+long lttng_channel_cmd(int objd, unsigned int cmd, unsigned long arg,
+       union ust_args *uargs)
 {
        struct ltt_channel *channel = objd_private(objd);
 
@@ -770,21 +848,17 @@ long lttng_channel_cmd(int objd, unsigned int cmd, unsigned long arg)
 
                stream = (struct lttng_ust_stream *) arg;
                /* stream used as output */
-               return lttng_abi_open_stream(objd, stream);
+               return lttng_abi_open_stream(objd, stream, uargs);
        }
        case LTTNG_UST_EVENT:
        {
                struct lttng_ust_event *event_param =
                        (struct lttng_ust_event *) arg;
-               if (event_param->instrumentation == LTTNG_UST_TRACEPOINT_LOGLEVEL) {
-                       return lttng_abi_create_loglevel(objd, event_param);
+               if (event_param->name[strlen(event_param->name) - 1] == '*') {
+                       /* If ends with wildcard, create wildcard. */
+                       return lttng_abi_create_wildcard(objd, event_param);
                } else {
-                       if (event_param->name[strlen(event_param->name) - 1] == '*') {
-                               /* If ends with wildcard, create wildcard. */
-                               return lttng_abi_create_wildcard(objd, event_param);
-                       } else {
-                               return lttng_abi_create_event(objd, event_param);
-                       }
+                       return lttng_abi_create_event(objd, event_param);
                }
        }
        case LTTNG_UST_CONTEXT:
@@ -808,6 +882,7 @@ long lttng_channel_cmd(int objd, unsigned int cmd, unsigned long arg)
  *     @objd: the object descriptor
  *     @cmd: the command
  *     @arg: command arg
+ *     @uargs: UST arguments (internal)
  *
  *     This object descriptor implements lttng commands:
  *      LTTNG_UST_STREAM
@@ -816,7 +891,8 @@ long lttng_channel_cmd(int objd, unsigned int cmd, unsigned long arg)
  * Channel and event file descriptors also hold a reference on the session.
  */
 static
-long lttng_metadata_cmd(int objd, unsigned int cmd, unsigned long arg)
+long lttng_metadata_cmd(int objd, unsigned int cmd, unsigned long arg,
+       union ust_args *uargs)
 {
        struct ltt_channel *channel = objd_private(objd);
 
@@ -827,7 +903,7 @@ long lttng_metadata_cmd(int objd, unsigned int cmd, unsigned long arg)
 
                stream = (struct lttng_ust_stream *) arg;
                /* stream used as output */
-               return lttng_abi_open_stream(objd, stream);
+               return lttng_abi_open_stream(objd, stream, uargs);
        }
        case LTTNG_UST_FLUSH_BUFFER:
                return channel->ops->flush_buffer(channel->chan, channel->handle);
@@ -893,12 +969,14 @@ static const struct lttng_ust_objd_ops lttng_metadata_ops = {
  *     @objd: the object descriptor
  *     @cmd: the command
  *     @arg: command arg
+ *     @uargs: UST arguments (internal)
  *
  *     This object descriptor implements lttng commands:
  *             (None for now. Access is done directly though shm.)
  */
 static
-long lttng_rb_cmd(int objd, unsigned int cmd, unsigned long arg)
+long lttng_rb_cmd(int objd, unsigned int cmd, unsigned long arg,
+       union ust_args *uargs)
 {
        switch (cmd) {
        default:
@@ -949,6 +1027,7 @@ static const struct lttng_ust_objd_ops lib_ring_buffer_objd_ops = {
  *     @objd: the object descriptor
  *     @cmd: the command
  *     @arg: command arg
+ *     @uargs: UST arguments (internal)
  *
  *     This object descriptor implements lttng commands:
  *     LTTNG_UST_CONTEXT
@@ -957,9 +1036,12 @@ static const struct lttng_ust_objd_ops lib_ring_buffer_objd_ops = {
  *             Enable recording for this event (weak enable)
  *     LTTNG_UST_DISABLE
  *             Disable recording for this event (strong disable)
+ *     LTTNG_UST_FILTER
+ *             Attach a filter to an event.
  */
 static
-long lttng_event_cmd(int objd, unsigned int cmd, unsigned long arg)
+long lttng_event_cmd(int objd, unsigned int cmd, unsigned long arg,
+       union ust_args *uargs)
 {
        struct ltt_event *event = objd_private(objd);
 
@@ -972,6 +1054,17 @@ long lttng_event_cmd(int objd, unsigned int cmd, unsigned long arg)
                return ltt_event_enable(event);
        case LTTNG_UST_DISABLE:
                return ltt_event_disable(event);
+       case LTTNG_UST_FILTER:
+       {
+               int ret;
+               ret = lttng_filter_event_attach_bytecode(event,
+                               (struct lttng_ust_filter_bytecode *) arg);
+               if (ret)
+                       return ret;
+               lttng_filter_event_link_bytecode(event,
+                               event->filter_bytecode);
+               return 0;
+       }
        default:
                return -EINVAL;
        }
@@ -993,66 +1086,13 @@ static const struct lttng_ust_objd_ops lttng_event_ops = {
        .cmd = lttng_event_cmd,
 };
 
-/**
- *     lttng_loglevel_cmd - lttng control through object descriptors
- *
- *     @objd: the object descriptor
- *     @cmd: the command
- *     @arg: command arg
- *
- *     This object descriptor implements lttng commands:
- *     LTTNG_UST_CONTEXT
- *             Prepend a context field to each record of events of this
- *             loglevel.
- *     LTTNG_UST_ENABLE
- *             Enable recording for these loglevel events (weak enable)
- *     LTTNG_UST_DISABLE
- *             Disable recording for these loglevel events (strong disable)
- */
-static
-long lttng_loglevel_cmd(int objd, unsigned int cmd, unsigned long arg)
-{
-       struct session_loglevel *loglevel = objd_private(objd);
-
-       switch (cmd) {
-       case LTTNG_UST_CONTEXT:
-               return -ENOSYS; /* not implemented yet */
-#if 0
-               return lttng_abi_add_context(objd,
-                               (struct lttng_ust_context *) arg,
-                               &loglevel->ctx, loglevel->chan->session);
-#endif
-       case LTTNG_UST_ENABLE:
-               return ltt_loglevel_enable(loglevel);
-       case LTTNG_UST_DISABLE:
-               return ltt_loglevel_disable(loglevel);
-       default:
-               return -EINVAL;
-       }
-}
-
-static
-int lttng_loglevel_release(int objd)
-{
-       struct session_loglevel *loglevel = objd_private(objd);
-
-       if (loglevel)
-               return lttng_ust_objd_unref(loglevel->chan->objd);
-       return 0;
-}
-
-/* TODO: filter control ioctl */
-static const struct lttng_ust_objd_ops lttng_loglevel_ops = {
-       .release = lttng_loglevel_release,
-       .cmd = lttng_loglevel_cmd,
-};
-
 /**
  *     lttng_wildcard_cmd - lttng control through object descriptors
  *
  *     @objd: the object descriptor
  *     @cmd: the command
  *     @arg: command arg
+ *     @uargs: UST arguments (internal)
  *
  *     This object descriptor implements lttng commands:
  *     LTTNG_UST_CONTEXT
@@ -1062,9 +1102,12 @@ static const struct lttng_ust_objd_ops lttng_loglevel_ops = {
  *             Enable recording for these wildcard events (weak enable)
  *     LTTNG_UST_DISABLE
  *             Disable recording for these wildcard events (strong disable)
+ *     LTTNG_UST_FILTER
+ *             Attach a filter to a wildcard.
  */
 static
-long lttng_wildcard_cmd(int objd, unsigned int cmd, unsigned long arg)
+long lttng_wildcard_cmd(int objd, unsigned int cmd, unsigned long arg,
+       union ust_args *uargs)
 {
        struct session_wildcard *wildcard = objd_private(objd);
 
@@ -1080,6 +1123,17 @@ long lttng_wildcard_cmd(int objd, unsigned int cmd, unsigned long arg)
                return ltt_wildcard_enable(wildcard);
        case LTTNG_UST_DISABLE:
                return ltt_wildcard_disable(wildcard);
+       case LTTNG_UST_FILTER:
+       {
+               int ret;
+
+               ret = lttng_filter_wildcard_attach_bytecode(wildcard,
+                               (struct lttng_ust_filter_bytecode *) arg);
+               if (ret)
+                       return ret;
+               lttng_filter_wildcard_link_bytecode(wildcard);
+               return 0;
+       }
        default:
                return -EINVAL;
        }
This page took 0.030768 seconds and 4 git commands to generate.