include/lttng/tracker-internal.h

   1 /*
   2  * Copyright (C) 2019 - Jonathan Rajotte-Julien <jonathan.rajotte-julien@efficios.com>
   3  *
   4  * This library is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU Lesser General Public License, version 2.1 only,
   6  * as published by the Free Software Foundation.
   7  *
   8  * This library is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
  11  * for more details.
  12  *
  13  * You should have received a copy of the GNU Lesser General Public License
  14  * along with this library; if not, write to the Free Software Foundation,
  15  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  16  */
  17
  18 #ifndef LTTNG_TRACKER_INTERNAL_H
  19 #define LTTNG_TRACKER_INTERNAL_H
  20
  21 #include <lttng/constant.h>
  22 #include <common/macros.h>
  23 #include <lttng/tracker.h>
  24 #include <stdbool.h>
  25
  26 struct lttng_tracker_id {
  27         enum lttng_tracker_id_type type;
  28         int value;
  29         char *string;
  30 };
  31
  32 struct lttng_tracker_ids {
  33         struct lttng_tracker_id *id_array;
  34         unsigned int count;
  35 };
  36
  37 LTTNG_HIDDEN
  38 bool lttng_tracker_id_is_equal(const struct lttng_tracker_id *left,
  39                 const struct lttng_tracker_id *right);
  40
  41 /*
  42  * A copy acts like memcpy. It does not allocate new memory.
  43  */
  44 LTTNG_HIDDEN
  45 int lttng_tracker_id_copy(struct lttng_tracker_id *dest,
  46                 const struct lttng_tracker_id *src);
  47
  48 /*
  49  * Duplicate an lttng_tracker_id.
  50  * The returned object must be freed via lttng_tracker_id_destroy.
  51  */
  52 LTTNG_HIDDEN
  53 struct lttng_tracker_id *lttng_tracker_id_duplicate(
  54                 const struct lttng_tracker_id *src);
  55
  56 /*
  57  * Allocate a new list of lttng_tracker_id.
  58  * The returned object must be freed via lttng_tracker_ids_destroy.
  59  */
  60 LTTNG_HIDDEN
  61 struct lttng_tracker_ids *lttng_tracker_ids_create(unsigned int base_count);
  62
  63 /*
  64  * Return the non-const pointer of an element at index "index" of a
  65  * lttng_tracker_ids.
  66  *
  67  * The ownership of the lttng_tracker_id element is NOT transfered.
  68  * The returned object can NOT be freed via lttng_tracker_id_destroy.
  69  */
  70 LTTNG_HIDDEN
  71 struct lttng_tracker_id *lttng_tracker_ids_get_pointer_of_index(
  72                 const struct lttng_tracker_ids *list, unsigned int index);
  73
  74 #endif /* LTTNG_TRACKER_INTERNAL_H */