1 #ifndef BABELTRACE_REF_H
2 #define BABELTRACE_REF_H
5 * BabelTrace: common reference counting
7 * Copyright (c) 2015 EfficiOS Inc. and Linux Foundation
8 * Copyright (c) 2015 Philippe Proulx <pproulx@efficios.com>
9 * Copyright (c) 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
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
35 * BT_PUT: calls bt_put() with a variable, then sets this variable to NULL.
37 * A common action with Babeltrace objects is to create or get one, perform
38 * an action with it, and then put it. To avoid putting it a second time
39 * later (if an error occurs, for example), the variable is often reset
40 * to NULL after putting the object it points to. Since this is so
41 * common, the BT_PUT() macro can be used to do just that.
43 * It is safe to call this function with a variable containing NULL.
45 * @param obj Variable pointing to a Babeltrace object.
47 #define BT_PUT(_obj) \
54 * BT_MOVE: transfers the ownership of an object, setting the old owner to NULL.
56 * This macro sets the variable _dst to the value of the variable _src,
57 * then sets _src to NULL, effectively moving the ownership of an
58 * object from one variable to the other.
60 * Before assigning _src to _dst, it puts _dst. Therefore it is not safe to
61 * call this function with an uninitialized value of _dst.
63 * @param _dst Destination variable pointing to a Babeltrace object.
64 * @param _src Source variable pointing to a Babeltrace object.
66 #define BT_MOVE(_dst, _src) \
74 * bt_get: increments the reference count of a Babeltrace object.
76 * The same number of bt_get() and bt_put() (plus one extra bt_put() to release
77 * the initial reference acquired at creation) have to be performed to destroy a
80 * It is safe to call this function with a NULL object.
82 * @param obj Babeltrace object.
86 void *bt_get(void *obj
);
89 * bt_put: decrements the reference count of a Babeltrace object.
91 * The same number of bt_get() and bt_put() (plus one extra bt_put() to release
92 * bt_put() to release the initial reference done at creation) have to be
93 * performed to destroy a Babeltrace object.
95 * The object is freed when its reference count is decremented to 0 by a call to
98 * It is safe to call this function with a NULL object.
100 * @param obj Babeltrace object.
102 void bt_put(void *obj
);
108 #endif /* BABELTRACE_REF_H */
This page took 0.041434 seconds and 5 git commands to generate.