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

   1 #ifndef BABELTRACE_CTF_WRITER_EVENT_TYPES_H
   2 #define BABELTRACE_CTF_WRITER_EVENT_TYPES_H
   3
   4 /*
   5  * BabelTrace - CTF Writer: Event Types
   6  *
   7  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The Common Trace Format (CTF) Specification is available at
  30  * http://www.efficios.com/ctf
  31  */
  32
  33 #include <babeltrace/ref.h>
  34 #include <babeltrace/ctf-ir/field-types.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 /*
  41  * bt_ctf_field_type_get and bt_ctf_field_type_put: increment and decrement
  42  * the field type's reference count.
  43  *
  44  * You may also use bt_get() and bt_put() with field type objects.
  45  *
  46  * These functions ensure that the field type won't be destroyed while it
  47  * is in use. The same number of get and put (plus one extra put to
  48  * release the initial reference done at creation) have to be done to
  49  * destroy a field type.
  50  *
  51  * When the field type's reference count is decremented to 0 by a
  52  * bt_ctf_field_type_put, the field type is freed.
  53  *
  54  * @param type Field type.
  55  */
  56
  57 /* Pre-2.0 CTF writer compatibility */
  58 static inline
  59 void bt_ctf_field_type_get(struct bt_field_type *type)
  60 {
  61         bt_get(type);
  62 }
  63
  64 /* Pre-2.0 CTF writer compatibility */
  65 static inline
  66 void bt_ctf_field_type_put(struct bt_field_type *type)
  67 {
  68         bt_put(type);
  69 }
  70
  71 #ifdef __cplusplus
  72 }
  73 #endif
  74
  75 #endif /* BABELTRACE_CTF_WRITER_EVENT_TYPES_H */