gallium: added comment for pipe_reference() return value
[mesa.git] / src / gallium / include / pipe / p_refcnt.h
1 /**************************************************************************
2 *
3 * Copyright 2009 VMware, Inc.
4 * All Rights Reserved.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25 *
26 **************************************************************************/
27
28 #ifndef P_REFCNT_H
29 #define P_REFCNT_H
30
31
32 #include "p_defines.h"
33 #include "p_atomic.h"
34
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40
41 struct pipe_reference
42 {
43 struct pipe_atomic count;
44 };
45
46
47 static INLINE void
48 pipe_reference_init(struct pipe_reference *reference, unsigned count)
49 {
50 p_atomic_set(&reference->count, count);
51 }
52
53
54 static INLINE boolean
55 pipe_is_referenced(struct pipe_reference *reference)
56 {
57 return p_atomic_read(&reference->count) != 0;
58 }
59
60
61 /**
62 * Update reference counting.
63 * The old thing pointed to, if any, will be unreferenced.
64 * Both 'ptr' and 'reference' may be NULL.
65 * \return TRUE if the object's refcount hits zero and should be destroyed.
66 */
67 static INLINE boolean
68 pipe_reference(struct pipe_reference *ptr, struct pipe_reference *reference)
69 {
70 boolean destroy = FALSE;
71
72 if(ptr != reference) {
73 /* bump the reference.count first */
74 if (reference) {
75 assert(pipe_is_referenced(reference));
76 p_atomic_inc(&reference->count);
77 }
78
79 if (ptr) {
80 assert(pipe_is_referenced(ptr));
81 if (p_atomic_dec_zero(&ptr->count)) {
82 destroy = TRUE;
83 }
84 }
85 }
86
87 return destroy;
88 }
89
90
91 #ifdef __cplusplus
92 }
93 #endif
94
95 #endif /* P_REFCNT_H */