src/plugins/text/details/obj-lifetime-mgmt.h

   1 #ifndef BABELTRACE_PLUGINS_TEXT_DETAILS_OBJ_LIFETIME_MGMT_H
   2 #define BABELTRACE_PLUGINS_TEXT_DETAILS_OBJ_LIFETIME_MGMT_H
   3
   4 /*
   5  * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #include <glib.h>
  27 #include <babeltrace2/babeltrace.h>
  28 #include <stdbool.h>
  29
  30 #include "details.h"
  31 #include "write.h"
  32
  33 /*
  34  * Returns whether or not stream class or event class `obj`, which
  35  * belongs to `tc`, needs to be written.
  36  */
  37 BT_HIDDEN
  38 bool details_need_to_write_meta_object(struct details_write_ctx *ctx,
  39                 const bt_trace_class *tc, const void *obj);
  40
  41 /*
  42  * Marks stream class or event class `obj`, which belongs to `tc`, as
  43  * written.
  44  */
  45 BT_HIDDEN
  46 void details_did_write_meta_object(struct details_write_ctx *ctx,
  47                 const bt_trace_class *tc, const void *obj);
  48
  49 /*
  50  * Returns whether or not trace class `tc` needs to be written.
  51  */
  52 BT_HIDDEN
  53 bool details_need_to_write_trace_class(struct details_write_ctx *ctx,
  54                 const bt_trace_class *tc);
  55
  56 /*
  57  * Marks trace class `tc` as written.
  58  */
  59 BT_HIDDEN
  60 int details_did_write_trace_class(struct details_write_ctx *ctx,
  61                 const bt_trace_class *tc);
  62
  63 /*
  64  * Writes the unique trace ID of `trace` to `*unique_id`, allocating a
  65  * new unique ID if none exists.
  66  */
  67 BT_HIDDEN
  68 int details_trace_unique_id(struct details_write_ctx *ctx,
  69                 const bt_trace *trace, uint64_t *unique_id);
  70
  71 #endif /* BABELTRACE_PLUGINS_TEXT_DETAILS_OBJ_LIFETIME_MGMT_H */