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 <common/macros.h>
  22 #include <common/dynamic-buffer.h>
  23 #include <lttng/constant.h>
  24 #include <lttng/tracker.h>
  25 #include <stdbool.h>
  26
  27 struct lttng_tracker_id {
  28         enum lttng_tracker_id_type type;
  29         int value;
  30         char *string;
  31 };
  32
  33 struct lttng_tracker_ids {
  34         struct lttng_tracker_id *id_array;
  35         unsigned int count;
  36 };
  37
  38 LTTNG_HIDDEN
  39 bool lttng_tracker_id_is_equal(const struct lttng_tracker_id *left,
  40                 const struct lttng_tracker_id *right);
  41
  42 /*
  43  * A copy acts like memcpy. It does not allocate new memory.
  44  */
  45 LTTNG_HIDDEN
  46 int lttng_tracker_id_copy(struct lttng_tracker_id *dest,
  47                 const struct lttng_tracker_id *src);
  48
  49 /*
  50  * Duplicate an lttng_tracker_id.
  51  * The returned object must be freed via lttng_tracker_id_destroy.
  52  */
  53 LTTNG_HIDDEN
  54 struct lttng_tracker_id *lttng_tracker_id_duplicate(
  55                 const struct lttng_tracker_id *src);
  56
  57 /*
  58  * Allocate a new list of lttng_tracker_id.
  59  * The returned object must be freed via lttng_tracker_ids_destroy.
  60  */
  61 LTTNG_HIDDEN
  62 struct lttng_tracker_ids *lttng_tracker_ids_create(unsigned int base_count);
  63
  64 /*
  65  * Return the non-const pointer of an element at index "index" of a
  66  * lttng_tracker_ids.
  67  *
  68  * The ownership of the lttng_tracker_id element is NOT transfered.
  69  * The returned object can NOT be freed via lttng_tracker_id_destroy.
  70  */
  71 LTTNG_HIDDEN
  72 struct lttng_tracker_id *lttng_tracker_ids_get_pointer_of_index(
  73                 const struct lttng_tracker_ids *list, unsigned int index);
  74
  75 /*
  76  * Serialize a ids collection to a lttng_dynamic_buffer.
  77  * Return LTTNG_OK on success, negative lttng error code on error.
  78  */
  79 LTTNG_HIDDEN
  80 int lttng_tracker_ids_serialize(const struct lttng_tracker_ids *ids,
  81                 struct lttng_dynamic_buffer *buffer);
  82
  83 #endif /* LTTNG_TRACKER_INTERNAL_H */