1/* $NetBSD: prop_object.h,v 1.9 2025/04/23 02:58:52 thorpej Exp $ */
2
3/*-
4 * Copyright (c) 2006, 2025 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe.
9 *
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
12 * are met:
13 * 1. Redistributions of source code must retain the above copyright
14 * notice, this list of conditions and the following disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 * POSSIBILITY OF SUCH DAMAGE.
30 */
31
32#ifndef _PROPLIB_PROP_OBJECT_H_
33#define _PROPLIB_PROP_OBJECT_H_
34
35#include <sys/types.h>
36
37#if !defined(_KERNEL) && !defined(_STANDALONE)
38#include <stdbool.h>
39#endif /* ! _KERNEL && ! _STANDALONE */
40
41typedef void *prop_object_t;
42
43typedef enum {
44 PROP_TYPE_UNKNOWN = 0x00000000,
45#ifndef _PROPLIB_ZFS_CONFLICT
46 PROP_TYPE_BOOL = 0x626f6f6c, /* 'bool' */
47 PROP_TYPE_NUMBER = 0x6e6d6272, /* 'nmbr' */
48 PROP_TYPE_STRING = 0x73746e67, /* 'stng' */
49 PROP_TYPE_DATA = 0x64617461, /* 'data' */
50 PROP_TYPE_ARRAY = 0x61726179, /* 'aray' */
51 PROP_TYPE_DICTIONARY = 0x64696374, /* 'dict' */
52 PROP_TYPE_DICT_KEYSYM = 0x646b6579 /* 'dkey' */
53#endif /* !_PROPLIB_ZFS_CONFLICT */
54} prop_type_t;
55
56typedef enum {
57 PROP_FORMAT_XML = 0,
58 PROP_FORMAT_JSON = 1
59} prop_format_t;
60
61__BEGIN_DECLS
62void prop_object_retain(prop_object_t);
63void prop_object_release(prop_object_t);
64
65prop_type_t prop_object_type(prop_object_t);
66
67bool prop_object_equals(prop_object_t, prop_object_t);
68bool prop_object_equals_with_error(prop_object_t, prop_object_t,
69 bool *);
70
71typedef struct _prop_object_iterator *prop_object_iterator_t;
72
73prop_object_t prop_object_iterator_next(prop_object_iterator_t);
74void prop_object_iterator_reset(prop_object_iterator_t);
75void prop_object_iterator_release(prop_object_iterator_t);
76
77char * prop_object_externalize(prop_object_t);
78char * prop_object_externalize_with_format(prop_object_t,
79 prop_format_t);
80bool prop_object_externalize_to_file(prop_object_t, const char *);
81bool prop_object_externalize_to_file_with_format(prop_object_t,
82 const char *, prop_format_t);
83
84prop_object_t prop_object_internalize(const char *);
85prop_object_t prop_object_internalize_from_file(const char *);
86
87#if defined(__NetBSD__)
88struct plistref;
89
90#if !defined(_KERNEL) && !defined(_STANDALONE)
91int prop_object_send_ioctl(prop_object_t, int,
92 unsigned long);
93int prop_object_recv_ioctl(int, unsigned long,
94 prop_object_t *);
95int prop_object_sendrecv_ioctl(prop_object_t, int,
96 unsigned long, prop_object_t *);
97int prop_object_send_syscall(prop_object_t,
98 struct plistref *);
99int prop_object_recv_syscall(const struct plistref *,
100 prop_object_t *);
101#elif defined(_KERNEL)
102int prop_object_copyin(const struct plistref *,
103 prop_object_t *);
104int prop_object_copyin_size(const struct plistref *,
105 prop_object_t *, size_t);
106int prop_object_copyout(struct plistref *, prop_object_t);
107int prop_object_copyin_ioctl(const struct plistref *,
108 const u_long, prop_object_t *);
109int prop_object_copyin_ioctl_size(const struct plistref *,
110 const u_long, prop_object_t *, size_t);
111int prop_object_copyout_ioctl(struct plistref *, const u_long,
112 prop_object_t);
113#endif
114#endif /* __NetBSD__ */
115__END_DECLS
116
117#endif /* _PROPLIB_PROP_OBJECT_H_ */