libamxc  1.10.3
C Generic Data Containers
variant_fd.c
Go to the documentation of this file.
1 /****************************************************************************
2 **
3 ** SPDX-License-Identifier: BSD-2-Clause-Patent
4 **
5 ** SPDX-FileCopyrightText: Copyright (c) 2023 SoftAtHome
6 **
7 ** Redistribution and use in source and binary forms, with or without modification,
8 ** are permitted provided that the following conditions are met:
9 **
10 ** 1. Redistributions of source code must retain the above copyright notice,
11 ** this list of conditions and the following disclaimer.
12 **
13 ** 2. Redistributions in binary form must reproduce the above copyright notice,
14 ** this list of conditions and the following disclaimer in the documentation
15 ** and/or other materials provided with the distribution.
16 **
17 ** Subject to the terms and conditions of this license, each copyright holder
18 ** and contributor hereby grants to those receiving rights under this license
19 ** a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
20 ** (except for failure to satisfy the conditions of this license) patent license
21 ** to make, have made, use, offer to sell, sell, import, and otherwise transfer
22 ** this software, where such license applies only to those patent claims, already
23 ** acquired or hereafter acquired, licensable by such copyright holder or contributor
24 ** that are necessarily infringed by:
25 **
26 ** (a) their Contribution(s) (the licensed copyrights of copyright holders and
27 ** non-copyrightable additions of contributors, in source or binary form) alone;
28 ** or
29 **
30 ** (b) combination of their Contribution(s) with the work of authorship to which
31 ** such Contribution(s) was added by such copyright holder or contributor, if,
32 ** at the time the Contribution is added, such addition causes such combination
33 ** to be necessarily infringed. The patent license shall not apply to any other
34 ** combinations which include the Contribution.
35 **
36 ** Except as expressly stated above, no rights or licenses from any copyright
37 ** holder or contributor is granted under this license, whether expressly, by
38 ** implication, estoppel or otherwise.
39 **
40 ** DISCLAIMER
41 **
42 ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
43 ** AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
44 ** IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
45 ** ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
46 ** LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
47 ** DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
48 ** SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
49 ** CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 ** OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
51 ** USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
52 **
53 ****************************************************************************/
54 
55 #include <sys/resource.h>
56 
57 #include <stdlib.h>
58 #include <stdio.h>
59 #include <fcntl.h>
60 
61 #include <amxc_variant_priv.h>
62 
63 static int variant_fd_to_string(amxc_var_t* const dest,
64  const amxc_var_t* const src) {
65  int retval = -1;
66  int check = 0;
67  int size_needed = snprintf(NULL, 0, "%" PRId32, src->data.fd);
68  dest->data.s = (char*) calloc(size_needed + 1, sizeof(char));
69 
70  when_null(dest->data.s, exit);
71 
72  check = snprintf(dest->data.s, size_needed + 1, "%" PRId32, src->data.fd);
73  if(check < 0) {
74  free(dest->data.s);
75  dest->data.s = NULL;
76  goto exit;
77  }
78 
79  retval = 0;
80 
81 exit:
82  return retval;
83 }
84 
85 static int variant_fd_to_int8(amxc_var_t* const dest,
86  const amxc_var_t* const src) {
87  int retval = -1;
88 
89  /* verify overflow or underflow */
90  when_true(src->data.fd > INT8_MAX || src->data.fd < INT8_MIN, exit);
91 
92  dest->data.i8 = (int8_t) src->data.fd;
93  retval = 0;
94 
95 exit:
96  return retval;
97 }
98 
99 static int variant_fd_to_int16(amxc_var_t* const dest,
100  const amxc_var_t* const src) {
101  int retval = -1;
102 
103  /* verify overflow or underflow */
104  when_true(src->data.fd > INT16_MAX || src->data.fd < INT16_MIN, exit);
105 
106  dest->data.i16 = (int16_t) src->data.fd;
107  retval = 0;
108 
109 exit:
110  return retval;
111 }
112 
113 static int variant_fd_to_int32(amxc_var_t* const dest,
114  const amxc_var_t* const src) {
115  int retval = -1;
116 
117  /* verify overflow or underflow */
118  when_true(src->data.fd > INT32_MAX || src->data.fd < INT32_MIN, exit);
119 
120  dest->data.i32 = (int32_t) src->data.fd;
121  retval = 0;
122 
123 exit:
124  return retval;
125 }
126 
127 static int variant_fd_to_int64(amxc_var_t* const dest,
128  const amxc_var_t* const src) {
129  int retval = -1;
130 
131  dest->data.i64 = (int64_t) src->data.fd;
132  retval = 0;
133 
134  return retval;
135 }
136 
137 static int variant_fd_to_uint8(amxc_var_t* const dest,
138  const amxc_var_t* const src) {
139  int retval = -1;
140 
141  /* verify overflow or underflow */
142  when_true(src->data.fd == INT32_MIN || llabs(src->data.fd) > UINT8_MAX, exit);
143 
144  dest->data.ui8 = (uint8_t) llabs(src->data.fd);
145  retval = 0;
146 
147 exit:
148  return retval;
149 }
150 
151 static int variant_fd_to_uint16(amxc_var_t* const dest,
152  const amxc_var_t* const src) {
153  int retval = -1;
154 
155  /* verify overflow or underflow */
156  when_true(src->data.fd == INT32_MIN || llabs(src->data.fd) > UINT16_MAX, exit);
157 
158  dest->data.ui16 = (uint16_t) llabs(src->data.fd);
159  retval = 0;
160 
161 exit:
162  return retval;
163 }
164 
165 static int variant_fd_to_uint32(amxc_var_t* const dest,
166  const amxc_var_t* const src) {
167  int retval = -1;
168 
169  /* verify overflow or underflow */
170  when_true(src->data.fd == INT32_MIN || llabs(src->data.fd) > UINT32_MAX, exit);
171 
172  dest->data.ui32 = (uint32_t) llabs(src->data.fd);
173  retval = 0;
174 
175 exit:
176  return retval;
177 }
178 
179 static int variant_fd_to_uint64(amxc_var_t* const dest,
180  const amxc_var_t* const src) {
181  dest->data.ui64 = llabs(src->data.fd);
182  return 0;
183 }
184 
185 
186 static int variant_fd_to_float(amxc_var_t* const dest,
187  const amxc_var_t* const src) {
188  dest->data.f = (float) src->data.fd;
189  return 0;
190 }
191 
192 static int variant_fd_to_double(amxc_var_t* const dest,
193  const amxc_var_t* const src) {
194  dest->data.d = (double) src->data.fd;
195  return 0;
196 }
197 
198 static int variant_fd_to_bool(amxc_var_t* const dest,
199  const amxc_var_t* const src) {
200 
201  dest->data.b = fcntl((int) llabs(src->data.fd), F_GETFD) != 0 ? false : true;
202  return 0;
203 }
204 
205 static int variant_fd_convert_to(amxc_var_t* const dest,
206  const amxc_var_t* const src) {
207  int retval = -1;
208 
226  NULL,
230  };
231 
232  if(dest->type_id >= AMXC_VAR_ID_CUSTOM_BASE) {
233  goto exit;
234  }
235 
236  if(convfn[dest->type_id] != NULL) {
237  if(dest->type_id == AMXC_VAR_ID_ANY) {
239  }
240  retval = convfn[dest->type_id](dest, src);
241  }
242 
243 exit:
244  return retval;
245 }
246 
247 static int variant_fd_compare(const amxc_var_t* const lval,
248  const amxc_var_t* const rval,
249  int* const result) {
250  if(lval->data.fd == rval->data.fd) {
251  *result = 0;
252  } else if(lval->data.fd > rval->data.fd) {
253  *result = 1;
254  } else {
255  *result = -1;
256  }
257  return 0;
258 }
259 
261  .init = NULL,
262  .del = NULL,
263  .copy = amxc_var_default_copy,
264  .move = amxc_var_default_move,
265  .convert_from = NULL,
266  .convert_to = variant_fd_convert_to,
267  .compare = variant_fd_compare,
268  .get_key = NULL,
269  .set_key = NULL,
270  .get_index = NULL,
271  .set_index = NULL,
272  .type_id = 0,
273  .hit = { .ait = NULL, .key = NULL, .next = NULL },
274  .name = AMXC_VAR_NAME_FD
275 };
276 
277 CONSTRUCTOR static void amxc_var_fd_init(void) {
279 }
280 
281 DESTRUCTOR static void amxc_var_fd_cleanup(void) {
283 }
284 
286  int retval = -1;
287  struct rlimit nofile = { 0, 0 };
288  when_null(var, exit);
289 
290  when_failed(getrlimit(RLIMIT_NOFILE, &nofile), exit);
291 
292  when_true(val < 0 || (rlim_t) llabs(val) > nofile.rlim_max, exit);
294 
295  var->data.fd = (int) llabs(val);
296 
297  retval = 0;
298 
299 exit:
300  return retval;
301 }
302 
304  int64_t retval = 0;
305  amxc_var_t variant;
306  when_null(var, exit);
307 
308  amxc_var_init(&variant);
309  when_failed(amxc_var_convert(&variant, var, AMXC_VAR_ID_FD), exit);
310  retval = variant.data.fd;
311  amxc_var_clean(&variant);
312 
313 exit:
314  return retval;
315 }
316 
318  fd_t retval = -1;
319  when_null(var, exit);
320  when_true(var->type_id != AMXC_VAR_ID_FD, exit);
321 
322  retval = var->data.fd;
323 
324 exit:
325  return retval;
326 }
327 
329  amxc_var_t* subvar = NULL;
330 
331  when_null(var, exit);
332  subvar = amxc_var_add_new(var);
333  when_null(subvar, exit);
334 
335  if(amxc_var_set_fd_t(subvar, val) != 0) {
336  amxc_var_delete(&subvar);
337  }
338 
339 exit:
340  return subvar;
341 }
342 
343 amxc_var_t* amxc_var_add_new_key_fd_t(amxc_var_t* const var, const char* key, int val) {
344  amxc_var_t* subvar = NULL;
345 
346  when_null(var, exit);
347  subvar = amxc_var_add_new_key(var, key);
348  when_null(subvar, exit);
349 
350  if(amxc_var_set_fd_t(subvar, val) != 0) {
351  amxc_var_delete(&subvar);
352  }
353 
354 exit:
355  return subvar;
356 }
#define when_failed(x, l)
Definition: amxc_macros.h:142
#define when_true(x, l)
Definition: amxc_macros.h:134
#define CONSTRUCTOR
Definition: amxc_macros.h:86
#define when_null(x, l)
Definition: amxc_macros.h:126
#define DESTRUCTOR
Definition: amxc_macros.h:90
#define fd_t
Convenience macro.
Definition: amxc_variant.h:600
int PRIVATE amxc_var_default_convert_to_null(amxc_var_t *const dest, const amxc_var_t *const src)
int PRIVATE amxc_var_default_move(amxc_var_t *const dest, amxc_var_t *const src)
Definition: amxc_variant.c:142
uint32_t PRIVATE amxc_var_add_type(amxc_var_type_t *const type, const uint32_t index)
int PRIVATE amxc_var_default_convert_to_htable(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: amxc_variant.c:174
int PRIVATE amxc_var_default_copy(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: amxc_variant.c:136
int PRIVATE amxc_var_remove_type(amxc_var_type_t *const type)
int PRIVATE amxc_var_default_convert_to_list(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: amxc_variant.c:155
fd_t amxc_var_get_fd_t(const amxc_var_t *var)
Conversion helper function.
Definition: variant_fd.c:303
int amxc_var_set_fd_t(amxc_var_t *var, int val)
Setter helper function.
Definition: variant_fd.c:285
amxc_var_t * amxc_var_add_new_key_fd_t(amxc_var_t *const var, const char *key, int val)
Conversion helper function.
Definition: variant_fd.c:343
fd_t amxc_var_get_const_fd_t(const amxc_var_t *const var)
Conversion helper function.
Definition: variant_fd.c:317
amxc_var_t * amxc_var_add_new_fd_t(amxc_var_t *const var, int val)
Conversion helper function.
Definition: variant_fd.c:328
#define AMXC_VAR_ID_CUSTOM_BASE
Base variant id for custom variants.
Definition: amxc_variant.h:257
#define AMXC_VAR_ID_FD
File descriptor variant id.
Definition: amxc_variant.h:218
#define AMXC_VAR_NAME_FD
Provides a name for variant id AMXC_VAR_ID_FD.
Definition: amxc_variant.h:360
#define AMXC_VAR_ID_ANY
Special variant id, typically used in cast or conversion functions.
Definition: amxc_variant.h:247
#define AMXC_VAR_ID_INT64
Signed 64 bit integer variant id.
Definition: amxc_variant.h:158
int(* amxc_var_convert_fn_t)(amxc_var_t *const dest, const amxc_var_t *const src)
Variant type callback function prototype for dynamically converting one type to another.
int amxc_var_set_type(amxc_var_t *const var, const uint32_t type)
Change the variant data type.
Definition: amxc_variant.c:261
int amxc_var_init(amxc_var_t *const var)
Initializes a variant.
Definition: amxc_variant.c:223
amxc_var_t * amxc_var_add_new(amxc_var_t *const var)
Adds a new variant to a composite variant.
Definition: amxc_variant.c:551
void amxc_var_clean(amxc_var_t *const var)
Clean-up and reset variant.
Definition: amxc_variant.c:237
void amxc_var_delete(amxc_var_t **var)
Frees the previously allocated variant.
Definition: amxc_variant.c:207
amxc_var_t * amxc_var_add_new_key(amxc_var_t *const var, const char *key)
Adds a new variant with a key to a composite variant.
Definition: amxc_variant.c:526
int amxc_var_convert(amxc_var_t *const dest, const amxc_var_t *src, const uint32_t type_id)
Converts one variant (source) to another variant(destination) using the specified variant type id.
Definition: amxc_variant.c:333
A variant type structure.
amxc_var_new_fn_t init
The variant struct definition.
Definition: amxc_variant.h:861
void * data
Definition: amxc_variant.h:883
uint32_t type_id
Definition: amxc_variant.h:864
static amxc_var_t * var
Definition: test_issue_58.c:77
static int variant_fd_to_uint8(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: variant_fd.c:137
static int variant_fd_to_int32(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: variant_fd.c:113
static int variant_fd_to_int8(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: variant_fd.c:85
static int variant_fd_to_string(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: variant_fd.c:63
static int variant_fd_to_uint64(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: variant_fd.c:179
static int variant_fd_convert_to(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: variant_fd.c:205
static int variant_fd_to_int64(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: variant_fd.c:127
static int variant_fd_to_double(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: variant_fd.c:192
static amxc_var_type_t amxc_variant_fd
Definition: variant_fd.c:260
static int variant_fd_compare(const amxc_var_t *const lval, const amxc_var_t *const rval, int *const result)
Definition: variant_fd.c:247
static DESTRUCTOR void amxc_var_fd_cleanup(void)
Definition: variant_fd.c:281
static int variant_fd_to_bool(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: variant_fd.c:198
static int variant_fd_to_int16(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: variant_fd.c:99
static CONSTRUCTOR void amxc_var_fd_init(void)
Definition: variant_fd.c:277
static int variant_fd_to_float(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: variant_fd.c:186
static int variant_fd_to_uint16(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: variant_fd.c:151
static int variant_fd_to_uint32(amxc_var_t *const dest, const amxc_var_t *const src)
Definition: variant_fd.c:165