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

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