src/lib/lttng-ctl/event.c

   1 /*
   2  * event.c
   3  *
   4  * Linux Trace Toolkit Control Library
   5  *
   6  * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   8  * This library is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU Lesser General Public License, version 2.1 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public License
  18  * along with this library; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #define _LGPL_SOURCE
  23 #include <assert.h>
  24 #include <stddef.h>
  25
  26 #include <common/error.h>
  27 #include <common/sessiond-comm/sessiond-comm.h>
  28 #include <lttng/event-internal.h>
  29 #include <lttng/event.h>
  30 #include <lttng/lttng-error.h>
  31 #include <lttng/userspace-probe-internal.h>
  32
  33 struct lttng_event *lttng_event_create(void)
  34 {
  35         struct lttng_event *event;
  36         struct lttng_event_extended *event_extended;
  37
  38         event = zmalloc(sizeof(*event));
  39         if (!event) {
  40                 PERROR("Error allocating event structure");
  41                 goto end;
  42         }
  43
  44         event_extended = zmalloc(sizeof(*event_extended));
  45         if (!event_extended) {
  46                 PERROR("Error allocating event extended structure");
  47                 goto error;
  48         }
  49         event->extended.ptr = event_extended;
  50 end:
  51         return event;
  52 error:
  53         free(event);
  54         event = NULL;
  55         goto end;
  56 }
  57
  58 void lttng_event_destroy(struct lttng_event *event)
  59 {
  60         struct lttng_event_extended *event_extended;
  61
  62         if (!event) {
  63                 return;
  64         }
  65
  66         event_extended = (struct lttng_event_extended *) event->extended.ptr;
  67
  68         if (event_extended) {
  69                 if (event_extended->probe_location) {
  70                         lttng_userspace_probe_location_destroy(
  71                                 event_extended->probe_location);
  72                 }
  73                 free(event_extended);
  74         }
  75         free(event);
  76 }
  77
  78 int lttng_event_get_filter_expression(struct lttng_event *event,
  79         const char **filter_expression)
  80 {
  81         int ret = 0;
  82         struct lttng_event_extended *event_extended;
  83
  84         if (!event || !filter_expression) {
  85                 ret = -LTTNG_ERR_INVALID;
  86                 goto end;
  87         }
  88
  89         event_extended = (struct lttng_event_extended *) event->extended.ptr;
  90         if (!event_extended) {
  91                 /*
  92                  * This can happen since the lttng_event structure is
  93                  * used for other tasks where this pointer is never set.
  94                  */
  95                 *filter_expression = NULL;
  96                 goto end;
  97         }
  98
  99         *filter_expression = event_extended->filter_expression;
 100 end:
 101         return ret;
 102 }
 103
 104 int lttng_event_get_exclusion_name_count(struct lttng_event *event)
 105 {
 106         int ret = 0;
 107         struct lttng_event_extended *event_extended;
 108
 109         if (!event) {
 110                 ret = -LTTNG_ERR_INVALID;
 111                 goto end;
 112         }
 113
 114         event_extended = (struct lttng_event_extended *) event->extended.ptr;
 115         if (!event_extended) {
 116                 /*
 117                  * This can happen since the lttng_event structure is
 118                  * used for other tasks where this pointer is never set.
 119                  */
 120                 goto end;
 121         }
 122
 123         if (event_extended->exclusions.count > INT_MAX) {
 124                 ret = -LTTNG_ERR_OVERFLOW;
 125                 goto end;
 126         }
 127         ret = (int) event_extended->exclusions.count;
 128 end:
 129         return ret;
 130 }
 131
 132 int lttng_event_get_exclusion_name(struct lttng_event *event,
 133                 size_t index, const char **exclusion_name)
 134 {
 135         int ret = 0;
 136         struct lttng_event_extended *event_extended;
 137
 138         if (!event || !exclusion_name) {
 139                 ret = -LTTNG_ERR_INVALID;
 140                 goto end;
 141         }
 142
 143         if (index > UINT_MAX) {
 144                 ret = -LTTNG_ERR_OVERFLOW;
 145                 goto end;
 146         }
 147
 148         event_extended = (struct lttng_event_extended *) event->extended.ptr;
 149         if (!event_extended) {
 150                 /*
 151                  * This can happen since the lttng_event structure is
 152                  * used for other tasks where this pointer is never set.
 153                  */
 154                 ret = -LTTNG_ERR_INVALID;
 155                 goto end;
 156         }
 157
 158         if (index >= event_extended->exclusions.count) {
 159                 ret = -LTTNG_ERR_INVALID;
 160                 goto end;
 161         }
 162
 163         *exclusion_name = event_extended->exclusions.strings +
 164                 (index * LTTNG_SYMBOL_NAME_LEN);
 165 end:
 166         return ret;
 167 }
 168
 169 const struct lttng_userspace_probe_location *
 170 lttng_event_get_userspace_probe_location(const struct lttng_event *event)
 171 {
 172         struct lttng_userspace_probe_location *probe_location = NULL;
 173         struct lttng_event_extended *event_extended;
 174
 175         if (!event) {
 176                 goto end;
 177         }
 178
 179         event_extended = (struct lttng_event_extended *) event->extended.ptr;
 180         if (!event_extended) {
 181                 goto end;
 182         }
 183         probe_location = event_extended->probe_location;
 184 end:
 185         return probe_location;
 186 }
 187
 188 int lttng_event_set_userspace_probe_location(struct lttng_event *event,
 189                 struct lttng_userspace_probe_location *probe_location)
 190 {
 191         int ret = 0;
 192         struct lttng_event_extended *event_extended;
 193
 194         if (!event || !probe_location) {
 195                 ret = -LTTNG_ERR_INVALID;
 196                 goto end;
 197         }
 198
 199         event_extended = (struct lttng_event_extended *) event->extended.ptr;
 200         assert(event_extended);
 201         if (event_extended->probe_location) {
 202                 lttng_userspace_probe_location_destroy(
 203                         event_extended->probe_location);
 204         }
 205         event_extended->probe_location = probe_location;
 206 end:
 207         return ret;
 208 }