prop_array.c revision 1.14 1 1.14 xtraeme /* $NetBSD: prop_array.c,v 1.14 2008/05/06 22:57:26 xtraeme Exp $ */
2 1.1 thorpej
3 1.1 thorpej /*-
4 1.10 joerg * Copyright (c) 2006, 2007 The NetBSD Foundation, Inc.
5 1.1 thorpej * All rights reserved.
6 1.1 thorpej *
7 1.1 thorpej * This code is derived from software contributed to The NetBSD Foundation
8 1.1 thorpej * by Jason R. Thorpe.
9 1.1 thorpej *
10 1.1 thorpej * Redistribution and use in source and binary forms, with or without
11 1.1 thorpej * modification, are permitted provided that the following conditions
12 1.1 thorpej * are met:
13 1.1 thorpej * 1. Redistributions of source code must retain the above copyright
14 1.1 thorpej * notice, this list of conditions and the following disclaimer.
15 1.1 thorpej * 2. Redistributions in binary form must reproduce the above copyright
16 1.1 thorpej * notice, this list of conditions and the following disclaimer in the
17 1.1 thorpej * documentation and/or other materials provided with the distribution.
18 1.1 thorpej *
19 1.1 thorpej * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 1.1 thorpej * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 1.1 thorpej * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 1.1 thorpej * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 1.1 thorpej * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 1.1 thorpej * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 1.1 thorpej * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 1.1 thorpej * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 1.1 thorpej * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 1.1 thorpej * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 1.1 thorpej * POSSIBILITY OF SUCH DAMAGE.
30 1.1 thorpej */
31 1.1 thorpej
32 1.1 thorpej #include <prop/prop_array.h>
33 1.1 thorpej #include "prop_object_impl.h"
34 1.1 thorpej
35 1.4 thorpej #if !defined(_KERNEL) && !defined(_STANDALONE)
36 1.4 thorpej #include <errno.h>
37 1.4 thorpej #endif
38 1.4 thorpej
39 1.1 thorpej struct _prop_array {
40 1.1 thorpej struct _prop_object pa_obj;
41 1.7 thorpej _PROP_RWLOCK_DECL(pa_rwlock)
42 1.1 thorpej prop_object_t * pa_array;
43 1.1 thorpej unsigned int pa_capacity;
44 1.1 thorpej unsigned int pa_count;
45 1.1 thorpej int pa_flags;
46 1.1 thorpej
47 1.1 thorpej uint32_t pa_version;
48 1.1 thorpej };
49 1.1 thorpej
50 1.1 thorpej #define PA_F_IMMUTABLE 0x01 /* array is immutable */
51 1.1 thorpej
52 1.1 thorpej _PROP_POOL_INIT(_prop_array_pool, sizeof(struct _prop_array), "proparay")
53 1.1 thorpej _PROP_MALLOC_DEFINE(M_PROP_ARRAY, "prop array",
54 1.1 thorpej "property array container object")
55 1.1 thorpej
56 1.10 joerg static int _prop_array_free(prop_stack_t, prop_object_t *);
57 1.10 joerg static void _prop_array_emergency_free(prop_object_t);
58 1.9 thorpej static bool _prop_array_externalize(
59 1.2 thorpej struct _prop_object_externalize_context *,
60 1.2 thorpej void *);
61 1.11 joerg static bool _prop_array_equals(prop_object_t, prop_object_t,
62 1.11 joerg void **, void **,
63 1.11 joerg prop_object_t *, prop_object_t *);
64 1.11 joerg static void _prop_array_equals_finish(prop_object_t, prop_object_t);
65 1.2 thorpej
66 1.2 thorpej static const struct _prop_object_type _prop_object_type_array = {
67 1.10 joerg .pot_type = PROP_TYPE_ARRAY,
68 1.10 joerg .pot_free = _prop_array_free,
69 1.10 joerg .pot_emergency_free = _prop_array_emergency_free,
70 1.10 joerg .pot_extern = _prop_array_externalize,
71 1.10 joerg .pot_equals = _prop_array_equals,
72 1.11 joerg .pot_equals_finish = _prop_array_equals_finish,
73 1.2 thorpej };
74 1.2 thorpej
75 1.2 thorpej #define prop_object_is_array(x) \
76 1.6 thorpej ((x) != NULL && (x)->pa_obj.po_type == &_prop_object_type_array)
77 1.1 thorpej
78 1.1 thorpej #define prop_array_is_immutable(x) (((x)->pa_flags & PA_F_IMMUTABLE) != 0)
79 1.1 thorpej
80 1.1 thorpej struct _prop_array_iterator {
81 1.1 thorpej struct _prop_object_iterator pai_base;
82 1.1 thorpej unsigned int pai_index;
83 1.1 thorpej };
84 1.1 thorpej
85 1.1 thorpej #define EXPAND_STEP 16
86 1.1 thorpej
87 1.10 joerg static int
88 1.10 joerg _prop_array_free(prop_stack_t stack, prop_object_t *obj)
89 1.1 thorpej {
90 1.10 joerg prop_array_t pa = *obj;
91 1.1 thorpej prop_object_t po;
92 1.1 thorpej
93 1.1 thorpej _PROP_ASSERT(pa->pa_count <= pa->pa_capacity);
94 1.1 thorpej _PROP_ASSERT((pa->pa_capacity == 0 && pa->pa_array == NULL) ||
95 1.1 thorpej (pa->pa_capacity != 0 && pa->pa_array != NULL));
96 1.1 thorpej
97 1.10 joerg /* The easy case is an empty array, just free and return. */
98 1.10 joerg if (pa->pa_count == 0) {
99 1.10 joerg if (pa->pa_array != NULL)
100 1.10 joerg _PROP_FREE(pa->pa_array, M_PROP_ARRAY);
101 1.10 joerg
102 1.10 joerg _PROP_RWLOCK_DESTROY(pa->pa_rwlock);
103 1.10 joerg
104 1.10 joerg _PROP_POOL_PUT(_prop_array_pool, pa);
105 1.10 joerg
106 1.10 joerg return (_PROP_OBJECT_FREE_DONE);
107 1.1 thorpej }
108 1.1 thorpej
109 1.10 joerg po = pa->pa_array[pa->pa_count - 1];
110 1.10 joerg _PROP_ASSERT(po != NULL);
111 1.1 thorpej
112 1.10 joerg if (stack == NULL) {
113 1.10 joerg /*
114 1.10 joerg * If we are in emergency release mode,
115 1.10 joerg * just let caller recurse down.
116 1.10 joerg */
117 1.10 joerg *obj = po;
118 1.10 joerg return (_PROP_OBJECT_FREE_FAILED);
119 1.10 joerg }
120 1.10 joerg
121 1.10 joerg /* Otherwise, try to push the current object on the stack. */
122 1.11 joerg if (!_prop_stack_push(stack, pa, NULL, NULL, NULL)) {
123 1.10 joerg /* Push failed, entering emergency release mode. */
124 1.10 joerg return (_PROP_OBJECT_FREE_FAILED);
125 1.10 joerg }
126 1.10 joerg /* Object pushed on stack, caller will release it. */
127 1.10 joerg --pa->pa_count;
128 1.10 joerg *obj = po;
129 1.10 joerg return (_PROP_OBJECT_FREE_RECURSE);
130 1.10 joerg }
131 1.7 thorpej
132 1.10 joerg static void
133 1.10 joerg _prop_array_emergency_free(prop_object_t obj)
134 1.10 joerg {
135 1.10 joerg prop_array_t pa = obj;
136 1.10 joerg
137 1.10 joerg _PROP_ASSERT(pa->pa_count != 0);
138 1.10 joerg --pa->pa_count;
139 1.1 thorpej }
140 1.1 thorpej
141 1.9 thorpej static bool
142 1.1 thorpej _prop_array_externalize(struct _prop_object_externalize_context *ctx,
143 1.1 thorpej void *v)
144 1.1 thorpej {
145 1.1 thorpej prop_array_t pa = v;
146 1.1 thorpej struct _prop_object *po;
147 1.1 thorpej prop_object_iterator_t pi;
148 1.1 thorpej unsigned int i;
149 1.9 thorpej bool rv = false;
150 1.7 thorpej
151 1.7 thorpej _PROP_RWLOCK_RDLOCK(pa->pa_rwlock);
152 1.1 thorpej
153 1.7 thorpej if (pa->pa_count == 0) {
154 1.7 thorpej _PROP_RWLOCK_UNLOCK(pa->pa_rwlock);
155 1.1 thorpej return (_prop_object_externalize_empty_tag(ctx, "array"));
156 1.7 thorpej }
157 1.1 thorpej
158 1.1 thorpej /* XXXJRT Hint "count" for the internalize step? */
159 1.9 thorpej if (_prop_object_externalize_start_tag(ctx, "array") == false ||
160 1.9 thorpej _prop_object_externalize_append_char(ctx, '\n') == false)
161 1.7 thorpej goto out;
162 1.1 thorpej
163 1.1 thorpej pi = prop_array_iterator(pa);
164 1.1 thorpej if (pi == NULL)
165 1.7 thorpej goto out;
166 1.1 thorpej
167 1.1 thorpej ctx->poec_depth++;
168 1.1 thorpej _PROP_ASSERT(ctx->poec_depth != 0);
169 1.1 thorpej
170 1.1 thorpej while ((po = prop_object_iterator_next(pi)) != NULL) {
171 1.9 thorpej if ((*po->po_type->pot_extern)(ctx, po) == false) {
172 1.1 thorpej prop_object_iterator_release(pi);
173 1.7 thorpej goto out;
174 1.1 thorpej }
175 1.1 thorpej }
176 1.1 thorpej
177 1.1 thorpej prop_object_iterator_release(pi);
178 1.1 thorpej
179 1.1 thorpej ctx->poec_depth--;
180 1.1 thorpej for (i = 0; i < ctx->poec_depth; i++) {
181 1.9 thorpej if (_prop_object_externalize_append_char(ctx, '\t') == false)
182 1.7 thorpej goto out;
183 1.1 thorpej }
184 1.9 thorpej if (_prop_object_externalize_end_tag(ctx, "array") == false)
185 1.7 thorpej goto out;
186 1.7 thorpej
187 1.9 thorpej rv = true;
188 1.1 thorpej
189 1.7 thorpej out:
190 1.7 thorpej _PROP_RWLOCK_UNLOCK(pa->pa_rwlock);
191 1.7 thorpej return (rv);
192 1.1 thorpej }
193 1.1 thorpej
194 1.11 joerg /* ARGSUSED */
195 1.9 thorpej static bool
196 1.11 joerg _prop_array_equals(prop_object_t v1, prop_object_t v2,
197 1.11 joerg void **stored_pointer1, void **stored_pointer2,
198 1.11 joerg prop_object_t *next_obj1, prop_object_t *next_obj2)
199 1.2 thorpej {
200 1.2 thorpej prop_array_t array1 = v1;
201 1.2 thorpej prop_array_t array2 = v2;
202 1.11 joerg uintptr_t idx;
203 1.11 joerg bool rv = _PROP_OBJECT_EQUALS_FALSE;
204 1.2 thorpej
205 1.11 joerg if (array1 == array2)
206 1.11 joerg return (_PROP_OBJECT_EQUALS_TRUE);
207 1.2 thorpej
208 1.11 joerg _PROP_ASSERT(*stored_pointer1 == *stored_pointer2);
209 1.11 joerg idx = (uintptr_t)*stored_pointer1;
210 1.7 thorpej
211 1.11 joerg /* For the first iteration, lock the objects. */
212 1.11 joerg if (idx == 0) {
213 1.11 joerg if ((uintptr_t)array1 < (uintptr_t)array2) {
214 1.11 joerg _PROP_RWLOCK_RDLOCK(array1->pa_rwlock);
215 1.11 joerg _PROP_RWLOCK_RDLOCK(array2->pa_rwlock);
216 1.11 joerg } else {
217 1.11 joerg _PROP_RWLOCK_RDLOCK(array2->pa_rwlock);
218 1.11 joerg _PROP_RWLOCK_RDLOCK(array1->pa_rwlock);
219 1.11 joerg }
220 1.7 thorpej }
221 1.7 thorpej
222 1.2 thorpej if (array1->pa_count != array2->pa_count)
223 1.7 thorpej goto out;
224 1.11 joerg if (idx == array1->pa_count) {
225 1.11 joerg rv = true;
226 1.11 joerg goto out;
227 1.11 joerg }
228 1.11 joerg _PROP_ASSERT(idx < array1->pa_count);
229 1.11 joerg
230 1.11 joerg *stored_pointer1 = (void *)(idx + 1);
231 1.11 joerg *stored_pointer2 = (void *)(idx + 1);
232 1.2 thorpej
233 1.11 joerg *next_obj1 = array1->pa_array[idx];
234 1.11 joerg *next_obj2 = array2->pa_array[idx];
235 1.2 thorpej
236 1.11 joerg return (_PROP_OBJECT_EQUALS_RECURSE);
237 1.7 thorpej
238 1.7 thorpej out:
239 1.7 thorpej _PROP_RWLOCK_UNLOCK(array1->pa_rwlock);
240 1.7 thorpej _PROP_RWLOCK_UNLOCK(array2->pa_rwlock);
241 1.7 thorpej return (rv);
242 1.2 thorpej }
243 1.2 thorpej
244 1.11 joerg static void
245 1.11 joerg _prop_array_equals_finish(prop_object_t v1, prop_object_t v2)
246 1.11 joerg {
247 1.11 joerg _PROP_RWLOCK_UNLOCK(((prop_array_t)v1)->pa_rwlock);
248 1.11 joerg _PROP_RWLOCK_UNLOCK(((prop_array_t)v2)->pa_rwlock);
249 1.11 joerg }
250 1.11 joerg
251 1.1 thorpej static prop_array_t
252 1.1 thorpej _prop_array_alloc(unsigned int capacity)
253 1.1 thorpej {
254 1.1 thorpej prop_array_t pa;
255 1.1 thorpej prop_object_t *array;
256 1.1 thorpej
257 1.1 thorpej if (capacity != 0) {
258 1.1 thorpej array = _PROP_CALLOC(capacity * sizeof(prop_object_t),
259 1.1 thorpej M_PROP_ARRAY);
260 1.1 thorpej if (array == NULL)
261 1.1 thorpej return (NULL);
262 1.1 thorpej } else
263 1.1 thorpej array = NULL;
264 1.1 thorpej
265 1.1 thorpej
266 1.1 thorpej pa = _PROP_POOL_GET(_prop_array_pool);
267 1.1 thorpej if (pa != NULL) {
268 1.2 thorpej _prop_object_init(&pa->pa_obj, &_prop_object_type_array);
269 1.2 thorpej pa->pa_obj.po_type = &_prop_object_type_array;
270 1.1 thorpej
271 1.7 thorpej _PROP_RWLOCK_INIT(pa->pa_rwlock);
272 1.1 thorpej pa->pa_array = array;
273 1.1 thorpej pa->pa_capacity = capacity;
274 1.1 thorpej pa->pa_count = 0;
275 1.1 thorpej pa->pa_flags = 0;
276 1.1 thorpej
277 1.1 thorpej pa->pa_version = 0;
278 1.1 thorpej } else if (array != NULL)
279 1.1 thorpej _PROP_FREE(array, M_PROP_ARRAY);
280 1.1 thorpej
281 1.1 thorpej return (pa);
282 1.1 thorpej }
283 1.1 thorpej
284 1.9 thorpej static bool
285 1.1 thorpej _prop_array_expand(prop_array_t pa, unsigned int capacity)
286 1.1 thorpej {
287 1.1 thorpej prop_object_t *array, *oarray;
288 1.1 thorpej
289 1.7 thorpej /*
290 1.7 thorpej * Array must be WRITE-LOCKED.
291 1.7 thorpej */
292 1.7 thorpej
293 1.1 thorpej oarray = pa->pa_array;
294 1.1 thorpej
295 1.3 thorpej array = _PROP_CALLOC(capacity * sizeof(*array), M_PROP_ARRAY);
296 1.1 thorpej if (array == NULL)
297 1.9 thorpej return (false);
298 1.1 thorpej if (oarray != NULL)
299 1.3 thorpej memcpy(array, oarray, pa->pa_capacity * sizeof(*array));
300 1.1 thorpej pa->pa_array = array;
301 1.1 thorpej pa->pa_capacity = capacity;
302 1.1 thorpej
303 1.1 thorpej if (oarray != NULL)
304 1.1 thorpej _PROP_FREE(oarray, M_PROP_ARRAY);
305 1.1 thorpej
306 1.9 thorpej return (true);
307 1.1 thorpej }
308 1.1 thorpej
309 1.1 thorpej static prop_object_t
310 1.1 thorpej _prop_array_iterator_next_object(void *v)
311 1.1 thorpej {
312 1.1 thorpej struct _prop_array_iterator *pai = v;
313 1.1 thorpej prop_array_t pa = pai->pai_base.pi_obj;
314 1.7 thorpej prop_object_t po = NULL;
315 1.14 xtraeme bool acquired;
316 1.1 thorpej
317 1.1 thorpej _PROP_ASSERT(prop_object_is_array(pa));
318 1.14 xtraeme acquired = _prop_rwlock_tryrdlock(&pa->pa_rwlock);
319 1.14 xtraeme _PROP_RWLOCK_OWNED(pa->pa_rwlock);
320 1.7 thorpej
321 1.1 thorpej if (pa->pa_version != pai->pai_base.pi_version)
322 1.7 thorpej goto out; /* array changed during iteration */
323 1.1 thorpej
324 1.1 thorpej _PROP_ASSERT(pai->pai_index <= pa->pa_count);
325 1.1 thorpej
326 1.1 thorpej if (pai->pai_index == pa->pa_count)
327 1.7 thorpej goto out; /* we've iterated all objects */
328 1.1 thorpej
329 1.1 thorpej po = pa->pa_array[pai->pai_index];
330 1.1 thorpej pai->pai_index++;
331 1.1 thorpej
332 1.7 thorpej out:
333 1.14 xtraeme if (acquired) {
334 1.14 xtraeme _PROP_RWLOCK_UNLOCK(pa->pa_rwlock);
335 1.14 xtraeme }
336 1.1 thorpej return (po);
337 1.1 thorpej }
338 1.1 thorpej
339 1.1 thorpej static void
340 1.1 thorpej _prop_array_iterator_reset(void *v)
341 1.1 thorpej {
342 1.1 thorpej struct _prop_array_iterator *pai = v;
343 1.1 thorpej prop_array_t pa = pai->pai_base.pi_obj;
344 1.14 xtraeme bool acquired;
345 1.1 thorpej
346 1.1 thorpej _PROP_ASSERT(prop_object_is_array(pa));
347 1.14 xtraeme acquired = _prop_rwlock_tryrdlock(&pa->pa_rwlock);
348 1.13 xtraeme _PROP_RWLOCK_OWNED(pa->pa_rwlock);
349 1.7 thorpej
350 1.1 thorpej pai->pai_index = 0;
351 1.1 thorpej pai->pai_base.pi_version = pa->pa_version;
352 1.14 xtraeme
353 1.14 xtraeme if (acquired) {
354 1.14 xtraeme _PROP_RWLOCK_UNLOCK(pa->pa_rwlock);
355 1.14 xtraeme }
356 1.1 thorpej }
357 1.1 thorpej
358 1.1 thorpej /*
359 1.1 thorpej * prop_array_create --
360 1.1 thorpej * Create an empty array.
361 1.1 thorpej */
362 1.1 thorpej prop_array_t
363 1.1 thorpej prop_array_create(void)
364 1.1 thorpej {
365 1.1 thorpej
366 1.1 thorpej return (_prop_array_alloc(0));
367 1.1 thorpej }
368 1.1 thorpej
369 1.1 thorpej /*
370 1.1 thorpej * prop_array_create_with_capacity --
371 1.1 thorpej * Create an array with the capacity to store N objects.
372 1.1 thorpej */
373 1.1 thorpej prop_array_t
374 1.1 thorpej prop_array_create_with_capacity(unsigned int capacity)
375 1.1 thorpej {
376 1.1 thorpej
377 1.1 thorpej return (_prop_array_alloc(capacity));
378 1.1 thorpej }
379 1.1 thorpej
380 1.1 thorpej /*
381 1.1 thorpej * prop_array_copy --
382 1.1 thorpej * Copy an array. The new array has an initial capacity equal to
383 1.1 thorpej * the number of objects stored in the original array. The new
384 1.1 thorpej * array contains references to the original array's objects, not
385 1.1 thorpej * copies of those objects (i.e. a shallow copy).
386 1.1 thorpej */
387 1.1 thorpej prop_array_t
388 1.1 thorpej prop_array_copy(prop_array_t opa)
389 1.1 thorpej {
390 1.1 thorpej prop_array_t pa;
391 1.1 thorpej prop_object_t po;
392 1.1 thorpej unsigned int idx;
393 1.1 thorpej
394 1.4 thorpej if (! prop_object_is_array(opa))
395 1.4 thorpej return (NULL);
396 1.1 thorpej
397 1.7 thorpej _PROP_RWLOCK_RDLOCK(opa->pa_rwlock);
398 1.7 thorpej
399 1.1 thorpej pa = _prop_array_alloc(opa->pa_count);
400 1.1 thorpej if (pa != NULL) {
401 1.1 thorpej for (idx = 0; idx < opa->pa_count; idx++) {
402 1.1 thorpej po = opa->pa_array[idx];
403 1.1 thorpej prop_object_retain(po);
404 1.1 thorpej pa->pa_array[idx] = po;
405 1.1 thorpej }
406 1.1 thorpej pa->pa_count = opa->pa_count;
407 1.1 thorpej pa->pa_flags = opa->pa_flags;
408 1.1 thorpej }
409 1.7 thorpej _PROP_RWLOCK_UNLOCK(opa->pa_rwlock);
410 1.1 thorpej return (pa);
411 1.1 thorpej }
412 1.1 thorpej
413 1.1 thorpej /*
414 1.1 thorpej * prop_array_copy_mutable --
415 1.1 thorpej * Like prop_array_copy(), but the resulting array is mutable.
416 1.1 thorpej */
417 1.1 thorpej prop_array_t
418 1.1 thorpej prop_array_copy_mutable(prop_array_t opa)
419 1.1 thorpej {
420 1.1 thorpej prop_array_t pa;
421 1.1 thorpej
422 1.1 thorpej pa = prop_array_copy(opa);
423 1.1 thorpej if (pa != NULL)
424 1.1 thorpej pa->pa_flags &= ~PA_F_IMMUTABLE;
425 1.1 thorpej
426 1.1 thorpej return (pa);
427 1.1 thorpej }
428 1.1 thorpej
429 1.1 thorpej /*
430 1.1 thorpej * prop_array_capacity --
431 1.1 thorpej * Return the capacity of the array.
432 1.1 thorpej */
433 1.1 thorpej unsigned int
434 1.1 thorpej prop_array_capacity(prop_array_t pa)
435 1.1 thorpej {
436 1.7 thorpej unsigned int rv;
437 1.1 thorpej
438 1.4 thorpej if (! prop_object_is_array(pa))
439 1.4 thorpej return (0);
440 1.4 thorpej
441 1.7 thorpej _PROP_RWLOCK_RDLOCK(pa->pa_rwlock);
442 1.7 thorpej rv = pa->pa_capacity;
443 1.7 thorpej _PROP_RWLOCK_UNLOCK(pa->pa_rwlock);
444 1.7 thorpej
445 1.7 thorpej return (rv);
446 1.1 thorpej }
447 1.1 thorpej
448 1.1 thorpej /*
449 1.1 thorpej * prop_array_count --
450 1.1 thorpej * Return the number of objects stored in the array.
451 1.1 thorpej */
452 1.1 thorpej unsigned int
453 1.1 thorpej prop_array_count(prop_array_t pa)
454 1.1 thorpej {
455 1.7 thorpej unsigned int rv;
456 1.1 thorpej
457 1.4 thorpej if (! prop_object_is_array(pa))
458 1.4 thorpej return (0);
459 1.4 thorpej
460 1.7 thorpej _PROP_RWLOCK_RDLOCK(pa->pa_rwlock);
461 1.7 thorpej rv = pa->pa_count;
462 1.7 thorpej _PROP_RWLOCK_UNLOCK(pa->pa_rwlock);
463 1.7 thorpej
464 1.7 thorpej return (rv);
465 1.1 thorpej }
466 1.1 thorpej
467 1.1 thorpej /*
468 1.1 thorpej * prop_array_ensure_capacity --
469 1.1 thorpej * Ensure that the array has the capacity to store the specified
470 1.1 thorpej * total number of objects (inluding the objects already stored
471 1.1 thorpej * in the array).
472 1.1 thorpej */
473 1.9 thorpej bool
474 1.1 thorpej prop_array_ensure_capacity(prop_array_t pa, unsigned int capacity)
475 1.1 thorpej {
476 1.9 thorpej bool rv;
477 1.1 thorpej
478 1.4 thorpej if (! prop_object_is_array(pa))
479 1.9 thorpej return (false);
480 1.4 thorpej
481 1.7 thorpej _PROP_RWLOCK_WRLOCK(pa->pa_rwlock);
482 1.1 thorpej if (capacity > pa->pa_capacity)
483 1.7 thorpej rv = _prop_array_expand(pa, capacity);
484 1.7 thorpej else
485 1.9 thorpej rv = true;
486 1.7 thorpej _PROP_RWLOCK_UNLOCK(pa->pa_rwlock);
487 1.7 thorpej
488 1.7 thorpej return (rv);
489 1.1 thorpej }
490 1.1 thorpej
491 1.1 thorpej /*
492 1.1 thorpej * prop_array_iterator --
493 1.1 thorpej * Return an iterator for the array. The array is retained by
494 1.1 thorpej * the iterator.
495 1.1 thorpej */
496 1.1 thorpej prop_object_iterator_t
497 1.1 thorpej prop_array_iterator(prop_array_t pa)
498 1.1 thorpej {
499 1.1 thorpej struct _prop_array_iterator *pai;
500 1.1 thorpej
501 1.4 thorpej if (! prop_object_is_array(pa))
502 1.4 thorpej return (NULL);
503 1.1 thorpej
504 1.1 thorpej pai = _PROP_CALLOC(sizeof(*pai), M_TEMP);
505 1.1 thorpej if (pai == NULL)
506 1.1 thorpej return (NULL);
507 1.1 thorpej pai->pai_base.pi_next_object = _prop_array_iterator_next_object;
508 1.1 thorpej pai->pai_base.pi_reset = _prop_array_iterator_reset;
509 1.1 thorpej prop_object_retain(pa);
510 1.1 thorpej pai->pai_base.pi_obj = pa;
511 1.13 xtraeme _PROP_RWLOCK_RDLOCK(pa->pa_rwlock);
512 1.1 thorpej _prop_array_iterator_reset(pai);
513 1.13 xtraeme _PROP_RWLOCK_UNLOCK(pa->pa_rwlock);
514 1.1 thorpej
515 1.1 thorpej return (&pai->pai_base);
516 1.1 thorpej }
517 1.1 thorpej
518 1.1 thorpej /*
519 1.1 thorpej * prop_array_make_immutable --
520 1.1 thorpej * Make the array immutable.
521 1.1 thorpej */
522 1.1 thorpej void
523 1.1 thorpej prop_array_make_immutable(prop_array_t pa)
524 1.1 thorpej {
525 1.1 thorpej
526 1.7 thorpej _PROP_RWLOCK_WRLOCK(pa->pa_rwlock);
527 1.9 thorpej if (prop_array_is_immutable(pa) == false)
528 1.1 thorpej pa->pa_flags |= PA_F_IMMUTABLE;
529 1.7 thorpej _PROP_RWLOCK_UNLOCK(pa->pa_rwlock);
530 1.1 thorpej }
531 1.1 thorpej
532 1.1 thorpej /*
533 1.1 thorpej * prop_array_mutable --
534 1.9 thorpej * Returns true if the array is mutable.
535 1.1 thorpej */
536 1.9 thorpej bool
537 1.1 thorpej prop_array_mutable(prop_array_t pa)
538 1.1 thorpej {
539 1.9 thorpej bool rv;
540 1.1 thorpej
541 1.7 thorpej _PROP_RWLOCK_RDLOCK(pa->pa_rwlock);
542 1.9 thorpej rv = prop_array_is_immutable(pa) == false;
543 1.7 thorpej _PROP_RWLOCK_UNLOCK(pa->pa_rwlock);
544 1.7 thorpej
545 1.7 thorpej return (rv);
546 1.1 thorpej }
547 1.1 thorpej
548 1.1 thorpej /*
549 1.1 thorpej * prop_array_get --
550 1.1 thorpej * Return the object stored at the specified array index.
551 1.1 thorpej */
552 1.1 thorpej prop_object_t
553 1.1 thorpej prop_array_get(prop_array_t pa, unsigned int idx)
554 1.1 thorpej {
555 1.7 thorpej prop_object_t po = NULL;
556 1.1 thorpej
557 1.4 thorpej if (! prop_object_is_array(pa))
558 1.4 thorpej return (NULL);
559 1.4 thorpej
560 1.7 thorpej _PROP_RWLOCK_RDLOCK(pa->pa_rwlock);
561 1.1 thorpej if (idx >= pa->pa_count)
562 1.7 thorpej goto out;
563 1.1 thorpej po = pa->pa_array[idx];
564 1.1 thorpej _PROP_ASSERT(po != NULL);
565 1.7 thorpej out:
566 1.7 thorpej _PROP_RWLOCK_UNLOCK(pa->pa_rwlock);
567 1.1 thorpej return (po);
568 1.1 thorpej }
569 1.1 thorpej
570 1.9 thorpej static bool
571 1.7 thorpej _prop_array_add(prop_array_t pa, prop_object_t po)
572 1.7 thorpej {
573 1.7 thorpej
574 1.7 thorpej /*
575 1.7 thorpej * Array must be WRITE-LOCKED.
576 1.7 thorpej */
577 1.7 thorpej
578 1.7 thorpej _PROP_ASSERT(pa->pa_count <= pa->pa_capacity);
579 1.7 thorpej
580 1.7 thorpej if (prop_array_is_immutable(pa) ||
581 1.7 thorpej (pa->pa_count == pa->pa_capacity &&
582 1.9 thorpej _prop_array_expand(pa, pa->pa_capacity + EXPAND_STEP) == false))
583 1.9 thorpej return (false);
584 1.7 thorpej
585 1.7 thorpej prop_object_retain(po);
586 1.7 thorpej pa->pa_array[pa->pa_count++] = po;
587 1.7 thorpej pa->pa_version++;
588 1.7 thorpej
589 1.9 thorpej return (true);
590 1.7 thorpej }
591 1.7 thorpej
592 1.1 thorpej /*
593 1.1 thorpej * prop_array_set --
594 1.1 thorpej * Store a reference to an object at the specified array index.
595 1.1 thorpej * This method is not allowed to create holes in the array; the
596 1.1 thorpej * caller must either be setting the object just beyond the existing
597 1.1 thorpej * count or replacing an already existing object reference.
598 1.1 thorpej */
599 1.9 thorpej bool
600 1.1 thorpej prop_array_set(prop_array_t pa, unsigned int idx, prop_object_t po)
601 1.1 thorpej {
602 1.1 thorpej prop_object_t opo;
603 1.9 thorpej bool rv = false;
604 1.1 thorpej
605 1.4 thorpej if (! prop_object_is_array(pa))
606 1.9 thorpej return (false);
607 1.1 thorpej
608 1.7 thorpej _PROP_RWLOCK_WRLOCK(pa->pa_rwlock);
609 1.7 thorpej
610 1.1 thorpej if (prop_array_is_immutable(pa))
611 1.7 thorpej goto out;
612 1.1 thorpej
613 1.7 thorpej if (idx == pa->pa_count) {
614 1.7 thorpej rv = _prop_array_add(pa, po);
615 1.7 thorpej goto out;
616 1.7 thorpej }
617 1.1 thorpej
618 1.1 thorpej _PROP_ASSERT(idx < pa->pa_count);
619 1.1 thorpej
620 1.1 thorpej opo = pa->pa_array[idx];
621 1.1 thorpej _PROP_ASSERT(opo != NULL);
622 1.1 thorpej
623 1.1 thorpej prop_object_retain(po);
624 1.1 thorpej pa->pa_array[idx] = po;
625 1.1 thorpej pa->pa_version++;
626 1.1 thorpej
627 1.1 thorpej prop_object_release(opo);
628 1.1 thorpej
629 1.9 thorpej rv = true;
630 1.7 thorpej
631 1.7 thorpej out:
632 1.7 thorpej _PROP_RWLOCK_UNLOCK(pa->pa_rwlock);
633 1.7 thorpej return (rv);
634 1.1 thorpej }
635 1.1 thorpej
636 1.1 thorpej /*
637 1.1 thorpej * prop_array_add --
638 1.1 thorpej * Add a refrerence to an object to the specified array, appending
639 1.1 thorpej * to the end and growing the array's capacity, if necessary.
640 1.1 thorpej */
641 1.9 thorpej bool
642 1.1 thorpej prop_array_add(prop_array_t pa, prop_object_t po)
643 1.1 thorpej {
644 1.9 thorpej bool rv;
645 1.1 thorpej
646 1.4 thorpej if (! prop_object_is_array(pa))
647 1.9 thorpej return (false);
648 1.4 thorpej
649 1.7 thorpej _PROP_RWLOCK_WRLOCK(pa->pa_rwlock);
650 1.7 thorpej rv = _prop_array_add(pa, po);
651 1.7 thorpej _PROP_RWLOCK_UNLOCK(pa->pa_rwlock);
652 1.1 thorpej
653 1.7 thorpej return (rv);
654 1.1 thorpej }
655 1.1 thorpej
656 1.1 thorpej /*
657 1.1 thorpej * prop_array_remove --
658 1.1 thorpej * Remove the reference to an object from an array at the specified
659 1.1 thorpej * index. The array will be compacted following the removal.
660 1.1 thorpej */
661 1.1 thorpej void
662 1.1 thorpej prop_array_remove(prop_array_t pa, unsigned int idx)
663 1.1 thorpej {
664 1.1 thorpej prop_object_t po;
665 1.1 thorpej
666 1.4 thorpej if (! prop_object_is_array(pa))
667 1.4 thorpej return;
668 1.4 thorpej
669 1.7 thorpej _PROP_RWLOCK_WRLOCK(pa->pa_rwlock);
670 1.7 thorpej
671 1.1 thorpej _PROP_ASSERT(idx < pa->pa_count);
672 1.1 thorpej
673 1.1 thorpej /* XXX Should this be a _PROP_ASSERT()? */
674 1.7 thorpej if (prop_array_is_immutable(pa)) {
675 1.7 thorpej _PROP_RWLOCK_UNLOCK(pa->pa_rwlock);
676 1.1 thorpej return;
677 1.7 thorpej }
678 1.1 thorpej
679 1.1 thorpej po = pa->pa_array[idx];
680 1.1 thorpej _PROP_ASSERT(po != NULL);
681 1.1 thorpej
682 1.1 thorpej for (++idx; idx < pa->pa_count; idx++)
683 1.1 thorpej pa->pa_array[idx - 1] = pa->pa_array[idx];
684 1.1 thorpej pa->pa_count--;
685 1.1 thorpej pa->pa_version++;
686 1.7 thorpej
687 1.7 thorpej _PROP_RWLOCK_UNLOCK(pa->pa_rwlock);
688 1.1 thorpej
689 1.1 thorpej prop_object_release(po);
690 1.1 thorpej }
691 1.1 thorpej
692 1.1 thorpej /*
693 1.2 thorpej * prop_array_equals --
694 1.9 thorpej * Return true if the two arrays are equivalent. Note we do a
695 1.2 thorpej * by-value comparison of the objects in the array.
696 1.2 thorpej */
697 1.9 thorpej bool
698 1.2 thorpej prop_array_equals(prop_array_t array1, prop_array_t array2)
699 1.2 thorpej {
700 1.11 joerg if (!prop_object_is_array(array1) || !prop_object_is_array(array2))
701 1.11 joerg return (false);
702 1.2 thorpej
703 1.11 joerg return (prop_object_equals(array1, array2));
704 1.2 thorpej }
705 1.2 thorpej
706 1.2 thorpej /*
707 1.4 thorpej * prop_array_externalize --
708 1.4 thorpej * Externalize an array, return a NUL-terminated buffer
709 1.4 thorpej * containing the XML-style representation. The buffer is allocated
710 1.4 thorpej * with the M_TEMP memory type.
711 1.4 thorpej */
712 1.4 thorpej char *
713 1.4 thorpej prop_array_externalize(prop_array_t pa)
714 1.4 thorpej {
715 1.4 thorpej struct _prop_object_externalize_context *ctx;
716 1.4 thorpej char *cp;
717 1.4 thorpej
718 1.4 thorpej ctx = _prop_object_externalize_context_alloc();
719 1.4 thorpej if (ctx == NULL)
720 1.4 thorpej return (NULL);
721 1.4 thorpej
722 1.9 thorpej if (_prop_object_externalize_header(ctx) == false ||
723 1.9 thorpej (*pa->pa_obj.po_type->pot_extern)(ctx, pa) == false ||
724 1.9 thorpej _prop_object_externalize_footer(ctx) == false) {
725 1.4 thorpej /* We are responsible for releasing the buffer. */
726 1.4 thorpej _PROP_FREE(ctx->poec_buf, M_TEMP);
727 1.4 thorpej _prop_object_externalize_context_free(ctx);
728 1.4 thorpej return (NULL);
729 1.4 thorpej }
730 1.4 thorpej
731 1.4 thorpej cp = ctx->poec_buf;
732 1.4 thorpej _prop_object_externalize_context_free(ctx);
733 1.4 thorpej
734 1.4 thorpej return (cp);
735 1.4 thorpej }
736 1.4 thorpej
737 1.4 thorpej /*
738 1.1 thorpej * _prop_array_internalize --
739 1.1 thorpej * Parse an <array>...</array> and return the object created from the
740 1.1 thorpej * external representation.
741 1.1 thorpej */
742 1.10 joerg static bool _prop_array_internalize_body(prop_stack_t, prop_object_t *,
743 1.10 joerg struct _prop_object_internalize_context *);
744 1.10 joerg
745 1.10 joerg bool
746 1.10 joerg _prop_array_internalize(prop_stack_t stack, prop_object_t *obj,
747 1.10 joerg struct _prop_object_internalize_context *ctx)
748 1.1 thorpej {
749 1.1 thorpej /* We don't currently understand any attributes. */
750 1.1 thorpej if (ctx->poic_tagattr != NULL)
751 1.10 joerg return (true);
752 1.1 thorpej
753 1.10 joerg *obj = prop_array_create();
754 1.10 joerg /*
755 1.10 joerg * We are done if the create failed or no child elements exist.
756 1.10 joerg */
757 1.10 joerg if (*obj == NULL || ctx->poic_is_empty_element)
758 1.10 joerg return (true);
759 1.10 joerg
760 1.10 joerg /*
761 1.10 joerg * Opening tag is found, now continue to the first element.
762 1.10 joerg */
763 1.10 joerg return (_prop_array_internalize_body(stack, obj, ctx));
764 1.10 joerg }
765 1.10 joerg
766 1.10 joerg static bool
767 1.10 joerg _prop_array_internalize_continue(prop_stack_t stack,
768 1.10 joerg prop_object_t *obj,
769 1.10 joerg struct _prop_object_internalize_context *ctx,
770 1.10 joerg void *data, prop_object_t child)
771 1.10 joerg {
772 1.10 joerg prop_array_t array;
773 1.10 joerg
774 1.10 joerg _PROP_ASSERT(data == NULL);
775 1.10 joerg
776 1.10 joerg if (child == NULL)
777 1.10 joerg goto bad; /* Element could not be parsed. */
778 1.10 joerg
779 1.10 joerg array = *obj;
780 1.10 joerg
781 1.10 joerg if (prop_array_add(array, child) == false) {
782 1.10 joerg prop_object_release(child);
783 1.10 joerg goto bad;
784 1.10 joerg }
785 1.10 joerg prop_object_release(child);
786 1.10 joerg
787 1.10 joerg /*
788 1.10 joerg * Current element is processed and added, look for next.
789 1.10 joerg */
790 1.10 joerg return (_prop_array_internalize_body(stack, obj, ctx));
791 1.10 joerg
792 1.10 joerg bad:
793 1.10 joerg prop_object_release(*obj);
794 1.10 joerg *obj = NULL;
795 1.10 joerg return (true);
796 1.10 joerg }
797 1.10 joerg
798 1.10 joerg static bool
799 1.10 joerg _prop_array_internalize_body(prop_stack_t stack, prop_object_t *obj,
800 1.10 joerg struct _prop_object_internalize_context *ctx)
801 1.10 joerg {
802 1.10 joerg prop_array_t array = *obj;
803 1.10 joerg
804 1.10 joerg _PROP_ASSERT(array != NULL);
805 1.10 joerg
806 1.10 joerg /* Fetch the next tag. */
807 1.10 joerg if (_prop_object_internalize_find_tag(ctx, NULL,
808 1.10 joerg _PROP_TAG_TYPE_EITHER) == false)
809 1.10 joerg goto bad;
810 1.10 joerg
811 1.10 joerg /* Check to see if this is the end of the array. */
812 1.10 joerg if (_PROP_TAG_MATCH(ctx, "array") &&
813 1.10 joerg ctx->poic_tag_type == _PROP_TAG_TYPE_END) {
814 1.10 joerg /* It is, so don't iterate any further. */
815 1.10 joerg return (true);
816 1.1 thorpej }
817 1.1 thorpej
818 1.11 joerg if (_prop_stack_push(stack, array,
819 1.11 joerg _prop_array_internalize_continue, NULL, NULL))
820 1.10 joerg return (false);
821 1.1 thorpej
822 1.1 thorpej bad:
823 1.1 thorpej prop_object_release(array);
824 1.10 joerg *obj = NULL;
825 1.10 joerg return (true);
826 1.1 thorpej }
827 1.4 thorpej
828 1.4 thorpej /*
829 1.4 thorpej * prop_array_internalize --
830 1.4 thorpej * Create an array by parsing the XML-style representation.
831 1.4 thorpej */
832 1.4 thorpej prop_array_t
833 1.4 thorpej prop_array_internalize(const char *xml)
834 1.4 thorpej {
835 1.8 joerg return _prop_generic_internalize(xml, "array");
836 1.4 thorpej }
837 1.4 thorpej
838 1.4 thorpej #if !defined(_KERNEL) && !defined(_STANDALONE)
839 1.4 thorpej /*
840 1.4 thorpej * prop_array_externalize_to_file --
841 1.4 thorpej * Externalize an array to the specified file.
842 1.4 thorpej */
843 1.9 thorpej bool
844 1.4 thorpej prop_array_externalize_to_file(prop_array_t array, const char *fname)
845 1.4 thorpej {
846 1.4 thorpej char *xml;
847 1.9 thorpej bool rv;
848 1.5 he int save_errno = 0; /* XXXGCC -Wuninitialized [mips, ...] */
849 1.4 thorpej
850 1.4 thorpej xml = prop_array_externalize(array);
851 1.4 thorpej if (xml == NULL)
852 1.9 thorpej return (false);
853 1.4 thorpej rv = _prop_object_externalize_write_file(fname, xml, strlen(xml));
854 1.9 thorpej if (rv == false)
855 1.4 thorpej save_errno = errno;
856 1.4 thorpej _PROP_FREE(xml, M_TEMP);
857 1.9 thorpej if (rv == false)
858 1.4 thorpej errno = save_errno;
859 1.4 thorpej
860 1.4 thorpej return (rv);
861 1.4 thorpej }
862 1.4 thorpej
863 1.4 thorpej /*
864 1.4 thorpej * prop_array_internalize_from_file --
865 1.4 thorpej * Internalize an array from a file.
866 1.4 thorpej */
867 1.4 thorpej prop_array_t
868 1.4 thorpej prop_array_internalize_from_file(const char *fname)
869 1.4 thorpej {
870 1.4 thorpej struct _prop_object_internalize_mapped_file *mf;
871 1.4 thorpej prop_array_t array;
872 1.4 thorpej
873 1.4 thorpej mf = _prop_object_internalize_map_file(fname);
874 1.4 thorpej if (mf == NULL)
875 1.4 thorpej return (NULL);
876 1.4 thorpej array = prop_array_internalize(mf->poimf_xml);
877 1.4 thorpej _prop_object_internalize_unmap_file(mf);
878 1.4 thorpej
879 1.4 thorpej return (array);
880 1.4 thorpej }
881 1.4 thorpej #endif /* _KERNEL && !_STANDALONE */
882