1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
/*
* virobject.h: libvirt reference counted object
*
* Copyright (C) 2012-2014 Red Hat, Inc.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library. If not, see
* <http://www.gnu.org/licenses/>.
*
*/
#pragma once
#include "internal.h"
#include "virthread.h"
#include <glib-object.h>
typedef struct _virClass virClass;
typedef struct _virObject virObject;
typedef struct _virObjectLockable virObjectLockable;
typedef struct _virObjectRWLockable virObjectRWLockable;
typedef void (*virObjectDisposeCallback)(void *obj);
#define VIR_TYPE_OBJECT vir_object_get_type()
G_DECLARE_DERIVABLE_TYPE(virObject, vir_object, VIR, OBJECT, GObject);
struct _virObjectClass {
GObjectClass parent;
};
struct _virObjectLockable {
virObject parent;
virMutex lock;
};
struct _virObjectRWLockable {
virObject parent;
virRWLock lock;
};
virClass *virClassForObject(void);
virClass *virClassForObjectLockable(void);
virClass *virClassForObjectRWLockable(void);
#ifndef VIR_PARENT_REQUIRED
# define VIR_PARENT_REQUIRED ATTRIBUTE_NONNULL(1)
#endif
/* Assign the class description nameClass to represent struct @name
* (which must have an object-based 'parent' member at offset 0), and
* with parent class @prnt. nameDispose must exist as either a
* function or as a macro defined to NULL.
*/
#define VIR_CLASS_NEW(name, prnt) \
(G_STATIC_ASSERT_EXPR(offsetof(name, parent) == 0), \
(name##Class = virClassNew(prnt, #name, sizeof(name),\
sizeof(((name *)NULL)->parent), \
name##Dispose)))
virClass *
virClassNew(virClass *parent,
const char *name,
size_t objectSize,
size_t parentSize,
virObjectDisposeCallback dispose)
VIR_PARENT_REQUIRED ATTRIBUTE_NONNULL(2);
const char *
virClassName(virClass *klass)
ATTRIBUTE_NONNULL(1);
bool
virClassIsDerivedFrom(virClass *klass,
virClass *parent)
ATTRIBUTE_NONNULL(1) ATTRIBUTE_NONNULL(2);
void *
virObjectNew(virClass *klass)
ATTRIBUTE_NONNULL(1);
void
virObjectUnref(void *obj);
void *
virObjectRef(void *obj);
bool
virObjectIsClass(void *obj,
virClass *klass)
ATTRIBUTE_NONNULL(2);
void *
virObjectLockableNew(virClass *klass)
ATTRIBUTE_NONNULL(1);
void *
virObjectRWLockableNew(virClass *klass)
ATTRIBUTE_NONNULL(1);
virLockGuard
virObjectLockGuard(void *lockableobj)
ATTRIBUTE_NONNULL(1) G_GNUC_WARN_UNUSED_RESULT;
void
virObjectLock(void *lockableobj)
ATTRIBUTE_NONNULL(1);
void
virObjectRWLockRead(void *lockableobj)
ATTRIBUTE_NONNULL(1);
void
virObjectRWLockWrite(void *lockableobj)
ATTRIBUTE_NONNULL(1);
void
virObjectUnlock(void *lockableobj)
ATTRIBUTE_NONNULL(1);
void
virObjectRWUnlock(void *lockableobj)
ATTRIBUTE_NONNULL(1);
void
virObjectListFree(void *list);
void
virObjectListFreeCount(void *list,
size_t count);
#define VIR_WITH_OBJECT_LOCK_GUARD_(o, name) \
for (g_auto(virLockGuard) name = virObjectLockGuard(o); name.mutex; \
name.mutex = (virLockGuardUnlock(&name), NULL))
/**
* VIR_WITH_OBJECT_LOCK_GUARD:
*
* This macro defines a lock scope such that entering the scope takes the lock
* and leaving the scope releases the lock. Return statements are allowed
* within the scope and release the lock. Break and continue statements leave
* the scope early and release the lock.
*
* virObjectLockable *lockable = ...;
*
* VIR_WITH_OBJECT_LOCK_GUARD(lockable) {
* // `lockable` is locked, and released automatically on scope exit
* ...
* }
*/
#define VIR_WITH_OBJECT_LOCK_GUARD(o) \
VIR_WITH_OBJECT_LOCK_GUARD_(o, CONCAT(var, __COUNTER__))
|
