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