include/babeltrace2-ctf-writer/event-types.h

   1 #ifndef BABELTRACE2_CTF_WRITER_EVENT_TYPES_H
   2 #define BABELTRACE2_CTF_WRITER_EVENT_TYPES_H
   3
   4 /*
   5  * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
   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 <babeltrace2-ctf-writer/object.h>
  27 #include <babeltrace2-ctf-writer/field-types.h>
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /*
  34  * bt_ctf_field_type_get and bt_ctf_field_type_put: increment and decrement
  35  * the field type's reference count.
  36  *
  37  * You may also use bt_ctf_object_get_ref() and bt_ctf_object_put_ref() with field type objects.
  38  *
  39  * These functions ensure that the field type won't be destroyed while it
  40  * is in use. The same number of get and put (plus one extra put to
  41  * release the initial reference done at creation) have to be done to
  42  * destroy a field type.
  43  *
  44  * When the field type's reference count is decremented to 0 by a
  45  * bt_ctf_field_type_put, the field type is freed.
  46  *
  47  * @param type Field type.
  48  */
  49
  50 /* Pre-2.0 CTF writer compatibility */
  51 static inline
  52 void bt_ctf_field_type_get(struct bt_ctf_field_type *type)
  53 {
  54         bt_ctf_object_get_ref(type);
  55 }
  56
  57 /* Pre-2.0 CTF writer compatibility */
  58 static inline
  59 void bt_ctf_field_type_put(struct bt_ctf_field_type *type)
  60 {
  61         bt_ctf_object_put_ref(type);
  62 }
  63
  64 #ifdef __cplusplus
  65 }
  66 #endif
  67
  68 #endif /* BABELTRACE2_CTF_WRITER_EVENT_TYPES_H */