3 Subroutines that support the generic object. */
6 * Copyright (c) 2004-2017 by Internet Systems Consortium, Inc. ("ISC")
7 * Copyright (c) 1999-2003 by Internet Software Consortium
9 * This Source Code Form is subject to the terms of the Mozilla Public
10 * License, v. 2.0. If a copy of the MPL was not distributed with this
11 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
13 * THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES
14 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
15 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR
16 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
17 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
18 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
19 * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
21 * Internet Systems Consortium, Inc.
23 * Newmarket, NH 03857 USA
25 * https://www.isc.org/
31 #include <omapip/omapip_p.h>
33 OMAPI_OBJECT_ALLOC (omapi_generic
,
34 omapi_generic_object_t
, omapi_type_generic
)
36 isc_result_t
omapi_generic_new (omapi_object_t
**gen
,
37 const char *file
, int line
)
39 /* Backwards compatibility. */
40 return omapi_generic_allocate ((omapi_generic_object_t
**)gen
,
44 isc_result_t
omapi_generic_set_value (omapi_object_t
*h
,
46 omapi_data_string_t
*name
,
47 omapi_typed_data_t
*value
)
49 omapi_generic_object_t
*g
;
57 if (h
-> type
!= omapi_type_generic
)
58 return DHCP_R_INVALIDARG
;
59 g
= (omapi_generic_object_t
*)h
;
61 /* See if there's already a value with this name attached to
62 the generic object, and if so, replace the current value
64 for (i
= 0; i
< g
-> nvalues
; i
++) {
68 if (!omapi_data_string_cmp (name
, g
-> values
[i
] -> name
)) {
69 /* There's an inconsistency here: the standard
70 behaviour of a set_values method when
71 passed a matching name and a null value is
72 to delete the value associated with that
73 name (where possible). In the generic
74 object, we remember the name/null pair,
75 because generic objects are generally used
76 to pass messages around, and this is the
77 way that remote entities delete values from
78 local objects. If the get_value method of
79 a generic object is called for a name that
80 maps to a name/null pair, ISC_R_NOTFOUND is
82 new = (omapi_value_t
*)0;
83 status
= (omapi_value_new (&new, MDL
));
84 if (status
!= ISC_R_SUCCESS
)
86 omapi_data_string_reference (&new -> name
, name
, MDL
);
88 omapi_typed_data_reference (&new -> value
,
91 omapi_value_dereference (&(g
-> values
[i
]), MDL
);
92 status
= (omapi_value_reference
93 (&(g
-> values
[i
]), new, MDL
));
94 omapi_value_dereference (&new, MDL
);
98 /* Notice a free slot if we pass one. */
99 else if (vfree
== -1 && !g
-> values
[i
])
103 /* If the name isn't already attached to this object, see if an
104 inner object has it. */
105 if (h
-> inner
&& h
-> inner
-> type
-> set_value
) {
106 status
= ((*(h
-> inner
-> type
-> set_value
))
107 (h
-> inner
, id
, name
, value
));
108 if (status
!= ISC_R_NOTFOUND
)
112 /* Okay, so it's a value that no inner object knows about, and
113 (implicitly, since the outer object set_value method would
114 have called this object's set_value method) it's an object that
115 no outer object knows about, it's this object's responsibility
116 to remember it - that's what generic objects do. */
118 /* Arrange for there to be space for the pointer to the new
119 name/value pair if necessary: */
121 vfree
= g
-> nvalues
;
122 if (vfree
== g
-> va_max
) {
124 vm_new
= 2 * g
-> va_max
;
127 va
= dmalloc (vm_new
* sizeof *va
, MDL
);
129 return ISC_R_NOMEMORY
;
130 ca
= dmalloc (vm_new
* sizeof *ca
, MDL
);
133 return ISC_R_NOMEMORY
;
136 memcpy (va
, g
-> values
,
137 g
-> va_max
* sizeof *va
);
138 memcpy (ca
, g
-> changed
,
139 g
-> va_max
* sizeof *ca
);
141 memset (va
+ g
-> va_max
, 0,
142 (vm_new
- g
-> va_max
) * sizeof *va
);
143 memset (ca
+ g
-> va_max
, 0,
144 (vm_new
- g
-> va_max
) * sizeof *ca
);
146 dfree (g
-> values
, MDL
);
148 dfree (g
-> changed
, MDL
);
151 g
-> va_max
= vm_new
;
154 status
= omapi_value_new (&g
-> values
[vfree
], MDL
);
155 if (status
!= ISC_R_SUCCESS
)
157 omapi_data_string_reference (&g
-> values
[vfree
] -> name
,
160 omapi_typed_data_reference
161 (&g
-> values
[vfree
] -> value
, value
, MDL
);
162 g
-> changed
[vfree
] = 1;
163 if (vfree
== g
-> nvalues
)
165 return ISC_R_SUCCESS
;
168 isc_result_t
omapi_generic_get_value (omapi_object_t
*h
,
170 omapi_data_string_t
*name
,
171 omapi_value_t
**value
)
174 omapi_generic_object_t
*g
;
176 if (h
-> type
!= omapi_type_generic
)
177 return DHCP_R_INVALIDARG
;
178 g
= (omapi_generic_object_t
*)h
;
180 /* Look up the specified name in our list of objects. */
181 for (i
= 0; i
< g
-> nvalues
; i
++) {
184 if (!omapi_data_string_cmp (name
, g
-> values
[i
] -> name
)) {
185 /* If this is a name/null value pair, this is the
186 same as if there were no value that matched
187 the specified name, so return ISC_R_NOTFOUND. */
188 if (!g
-> values
[i
] -> value
)
189 return ISC_R_NOTFOUND
;
190 /* Otherwise, return the name/value pair. */
191 return omapi_value_reference (value
,
192 g
-> values
[i
], MDL
);
196 if (h
-> inner
&& h
-> inner
-> type
-> get_value
)
197 return (*(h
-> inner
-> type
-> get_value
))
198 (h
-> inner
, id
, name
, value
);
199 return ISC_R_NOTFOUND
;
202 isc_result_t
omapi_generic_destroy (omapi_object_t
*h
,
203 const char *file
, int line
)
205 omapi_generic_object_t
*g
;
208 if (h
-> type
!= omapi_type_generic
)
209 return ISC_R_UNEXPECTED
;
210 g
= (omapi_generic_object_t
*)h
;
213 for (i
= 0; i
< g
-> nvalues
; i
++) {
215 omapi_value_dereference (&g
-> values
[i
],
218 dfree (g
-> values
, file
, line
);
219 dfree (g
-> changed
, file
, line
);
220 g
-> values
= (omapi_value_t
**)0;
221 g
-> changed
= (u_int8_t
*)0;
225 return ISC_R_SUCCESS
;
228 isc_result_t
omapi_generic_signal_handler (omapi_object_t
*h
,
229 const char *name
, va_list ap
)
231 if (h
-> type
!= omapi_type_generic
)
232 return DHCP_R_INVALIDARG
;
234 if (h
-> inner
&& h
-> inner
-> type
-> signal_handler
)
235 return (*(h
-> inner
-> type
-> signal_handler
)) (h
-> inner
,
237 return ISC_R_NOTFOUND
;
240 /* Write all the published values associated with the object through the
241 specified connection. */
243 isc_result_t
omapi_generic_stuff_values (omapi_object_t
*c
,
247 omapi_generic_object_t
*src
;
251 if (g
-> type
!= omapi_type_generic
)
252 return DHCP_R_INVALIDARG
;
253 src
= (omapi_generic_object_t
*)g
;
255 for (i
= 0; i
< src
-> nvalues
; i
++) {
256 if (src
-> values
[i
] && src
-> values
[i
] -> name
-> len
&&
257 src
-> changed
[i
]) {
258 status
= (omapi_connection_put_uint16
259 (c
, src
-> values
[i
] -> name
-> len
));
260 if (status
!= ISC_R_SUCCESS
)
262 status
= (omapi_connection_copyin
263 (c
, src
-> values
[i
] -> name
-> value
,
264 src
-> values
[i
] -> name
-> len
));
265 if (status
!= ISC_R_SUCCESS
)
268 status
= (omapi_connection_write_typed_data
269 (c
, src
-> values
[i
] -> value
));
270 if (status
!= ISC_R_SUCCESS
)
275 if (g
-> inner
&& g
-> inner
-> type
-> stuff_values
)
276 return (*(g
-> inner
-> type
-> stuff_values
)) (c
, id
,
278 return ISC_R_SUCCESS
;
281 /* Clear the changed flags on the object. This has the effect that if
282 generic_stuff is called, any attributes that still have a cleared changed
283 flag aren't sent to the peer. This also deletes any values that are
284 null, presuming that these have now been properly handled. */
286 isc_result_t
omapi_generic_clear_flags (omapi_object_t
*o
)
289 omapi_generic_object_t
*g
;
291 if (o
-> type
!= omapi_type_generic
)
292 return DHCP_R_INVALIDARG
;
293 g
= (omapi_generic_object_t
*)o
;
295 for (i
= 0; i
< g
-> nvalues
; i
++) {
296 g
-> changed
[i
] = 0;
297 if (g
-> values
[i
] &&
298 !g
-> values
[i
] -> value
)
299 omapi_value_dereference (&g
-> values
[i
], MDL
);
301 return ISC_R_SUCCESS
;