Open SCAP Library
util.h
1 /*
2  * Copyright 2009 Red Hat Inc., Durham, North Carolina.
3  * All Rights Reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Authors:
20  * Lukas Kuklinek <lkuklinek@redhat.com>
21  */
22 
23 
24 #ifndef OSCAP_UTIL_H_
25 #define OSCAP_UTIL_H_
26 
27 #include <stdbool.h>
28 #include <assert.h>
29 #include "public/oscap.h"
30 #include "alloc.h"
31 
32 #define __attribute__nonnull__(x) assert((x) != NULL)
33 
34 /*
35  * Start a list of declarations that should not be available from outside the
36  * library. Must be matched with OSCAP_HIDDEN_END.
37  */
38 #define OSCAP_HIDDEN_START _Pragma("GCC visibility push(hidden)")
39 
40 /*
41  * Start a list of declarations that should not be available from outside the
42  * library started by OSCAP_HIDDEN_END.
43  */
44 #define OSCAP_HIDDEN_END _Pragma("GCC visibility pop")
45 
46 OSCAP_HIDDEN_START
47 
51 typedef void (*oscap_destruct_func) (void *);
52 
56 typedef void* (*oscap_clone_func) (void *);
57 
61 typedef void (*oscap_consumer_func) (void *, void *);
62 
73 #define OSCAP_GENERIC_GETTER_CONV(RTYPE,CONV,SNAME,MNAME,MEXP) \
74  RTYPE SNAME##_get_##MNAME(const struct SNAME* item) { return (CONV(item->MEXP)); }
75 
84 #define OSCAP_GENERIC_GETTER(RTYPE,SNAME,MNAME,MEXP) \
85  OSCAP_GENERIC_GETTER_CONV(RTYPE,,SNAME,MNAME,MEXP)
86 
95 #define OSCAP_GENERIC_GETTER_FORCE(RTYPE,SNAME,MNAME,MEXP) \
96  OSCAP_GENERIC_GETTER_CONV(RTYPE,(RTYPE),SNAME,MNAME,MEXP)
97 
106 #define OSCAP_GETTER_FORCE(RTYPE,SNAME,MNAME) \
107  OSCAP_GENERIC_GETTER_FORCE(RTYPE,SNAME,MNAME,MNAME)
108 
117 #define OSCAP_GETTER(RTYPE,SNAME,MNAME) \
118  OSCAP_GENERIC_GETTER(RTYPE,SNAME,MNAME,MNAME)
119 
120 #define ITERATOR_CAST(x) ((struct oscap_iterator*)(x))
121 #define OSCAP_ITERATOR(n) struct n##_iterator*
122 #define OSCAP_ITERATOR_FWD(n) struct n##_iterator;
123 #define OSCAP_ITERATOR_HAS_MORE(n) bool n##_iterator_has_more(OSCAP_ITERATOR(n) it) { return oscap_iterator_has_more(ITERATOR_CAST(it)); }
124 #define OSCAP_ITERATOR_NEXT(t,n) t n##_iterator_next(OSCAP_ITERATOR(n) it) { return oscap_iterator_next(ITERATOR_CAST(it)); }
125 #define OSCAP_ITERATOR_FREE(n) void n##_iterator_free(OSCAP_ITERATOR(n) it) { oscap_iterator_free(ITERATOR_CAST(it)); }
126 #define OSCAP_ITERATOR_RESET(n) void n##_iterator_reset(OSCAP_ITERATOR(n) it) { oscap_iterator_reset(ITERATOR_CAST(it)); }
127 #define OSCAP_ITERATOR_DETACH(t,n) t n##_iterator_detach(OSCAP_ITERATOR(n) it) { return oscap_iterator_detach(ITERATOR_CAST(it)); }
128 #define OSCAP_ITERATOR_GEN_T(t,n) OSCAP_ITERATOR_FWD(n) OSCAP_ITERATOR_HAS_MORE(n) OSCAP_ITERATOR_RESET(n) OSCAP_ITERATOR_NEXT(t,n) OSCAP_ITERATOR_FREE(n)
129 #define OSCAP_ITERATOR_GEN(n) OSCAP_ITERATOR_GEN_T(struct n*,n)
130 
131 #define OSCAP_ITERATOR_REMOVE_T(t,n,destructor) \
132  void n##_iterator_remove(OSCAP_ITERATOR(n) it) { destructor(oscap_iterator_detach(ITERATOR_CAST(it))); }
133 #define OSCAP_ITERATOR_REMOVE(n,destructor) OSCAP_ITERATOR_REMOVE_T(struct n*,n,destructor)
134 #define OSCAP_ITERATOR_REMOVE_F(n) OSCAP_ITERATOR_REMOVE(n, n##_free)
135 
136 
146 #define OSCAP_IGETTER_CONV(ITYPE,SNAME,MNAME,CONV) \
147  struct ITYPE##_iterator* SNAME##_get_##MNAME(const struct SNAME* item) \
148  { return oscap_iterator_new((CONV(item))->MNAME); }
149 
158 #define OSCAP_IGETTER(ITYPE,SNAME,MNAME) OSCAP_IGETTER_CONV(ITYPE,SNAME,MNAME,)
159 
165 #define OSCAP_IGETTER_GEN(ITYPE,SNAME,MNAME) OSCAP_IGETTER(ITYPE,SNAME,MNAME) OSCAP_ITERATOR_GEN(ITYPE)
166 
176 #define OSCAP_HGETTER_EXP(RTYPE,SNAME,MNAME,MEXP) \
177  RTYPE SNAME##_get_##MNAME(const struct SNAME* item, const char* key) \
178  { return oscap_htable_get(item->MEXP, key); }
179 
188 #define OSCAP_HGETTER(RTYPE,SNAME,MNAME) OSCAP_HGETTER_EXP(RTYPE,SNAME,MNAME,MNAME)
189 
198 #define OSCAP_HGETTER_STRUCT(RTYPE,SNAME,MNAME) OSCAP_HGETTER_EXP(struct RTYPE*,SNAME,MNAME,MNAME)
199 
200 #define OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) bool SNAME##_set_##MNAME(struct SNAME *obj, MTYPE newval)
201 
213 #define OSCAP_SETTER_GENERIC_CHECK(SNAME, MTYPE, MNAME, CHECK, DELETER, ASSIGNER) \
214  OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) \
215  { if (!(CHECK)) return false; DELETER(obj->MNAME); obj->MNAME = ASSIGNER(newval); return true; }
216 
221 #define OSCAP_SETTER_GENERIC(SNAME, MTYPE, MNAME, DELETER, ASSIGNER) \
222  OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) \
223  { DELETER(obj->MNAME); obj->MNAME = ASSIGNER(newval); return true; }
224 
229 #define OSCAP_SETTER_GENERIC_NODELETE(SNAME, MTYPE, MNAME, ASSIGNER) \
230  OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) \
231  { obj->MNAME = ASSIGNER(newval); return true; }
232 
237 #define OSCAP_SETTER_SIMPLE(SNAME, MTYPE, MNAME) \
238  OSCAP_SETTER_GENERIC_NODELETE(SNAME, MTYPE, MNAME, )
239 
245 #define OSCAP_SETTER_STRING(SNAME, MNAME) \
246  OSCAP_SETTER_GENERIC(SNAME, const char *, MNAME, free, oscap_strdup)
247 
251 #define OSCAP_ACCESSOR_STRING(SNAME, MNAME) \
252  OSCAP_GETTER(const char*, SNAME, MNAME) OSCAP_SETTER_STRING(SNAME, MNAME)
253 
257 #define OSCAP_ACCESSOR_TEXT(SNAME, MNAME) \
258  OSCAP_GETTER(struct oscap_text *, SNAME, MNAME) \
259  OSCAP_SETTER_GENERIC(SNAME, struct oscap_text*, MNAME, oscap_text_free, )
260 
264 #define OSCAP_ACCESSOR_SIMPLE(MTYPE, SNAME, MNAME) \
265  OSCAP_GETTER(MTYPE, SNAME, MNAME) OSCAP_SETTER_SIMPLE(SNAME, MTYPE, MNAME)
266 
271 #define OSCAP_ACCESSOR_EXP(MTYPE, SNAME, MNAME, MEXP) \
272  OSCAP_GENERIC_GETTER(MTYPE, SNAME, MNAME, MEXP) \
273  OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) { obj->MEXP = newval; return true; }
274 
284 #define OSCAP_INSERTER(SNAME, FNAME, MTYPE, MNAME) \
285  bool SNAME##_add_##FNAME(struct SNAME *obj, struct MTYPE *item) \
286  { oscap_list_add(obj->MNAME, item); return true; }
287 
288 /* Generate iterator getter and list inserter */
289 #define OSCAP_IGETINS(ITYPE, SNAME, MNAME, FNAME) \
290  OSCAP_IGETTER(ITYPE, SNAME, MNAME) OSCAP_INSERTER(SNAME, FNAME, ITYPE, MNAME)
291 /* Generate iterator getter, list inserter, and iterator manipulation functions. */
292 #define OSCAP_IGETINS_GEN(ITYPE, SNAME, MNAME, FNAME) \
293  OSCAP_IGETTER_GEN(ITYPE, SNAME, MNAME) OSCAP_INSERTER(SNAME, FNAME, ITYPE, MNAME)
294 
303  int value; /* integer/enum value */
304  const char *string; /* string representation of the value */
305 };
306 
313 int oscap_string_to_enum(const struct oscap_string_map *map, const char *str);
314 
321 const char *oscap_enum_to_string(const struct oscap_string_map *map, int val);
322 
327 char *oscap_strdup(const char *str);
328 
335 float oscap_strtol(const char *str, char **endptr, int base);
336 
345 char **oscap_split(char *str, const char *delim);
346 
347 
349 int oscap_strcmp(const char *s1, const char *s2);
351 bool oscap_streq(const char *s1, const char *s2);
353 char *oscap_trim(char *str);
355 char *oscap_vsprintf(const char *fmt, va_list ap);
357 char *oscap_sprintf(const char *fmt, ...);
359 const char *oscap_strlist_find_value(char ** const kvalues, const char *key);
361 char *oscap_rtrim(char *str, char ch);
363 void oscap_strtoupper(char *str);
364 
365 // check pointer equality
366 bool oscap_ptr_cmp(void *node1, void *node2);
367 
372 int oscap_validate_xml(const char *xmlfile, const char *schemafile, oscap_reporter reporter, void *arg);
373 
381 char *oscap_find_file(const char *filename, int mode, const char *pathvar, const char *path);
382 
383 
384 #ifndef OSCAP_CONCAT
385 # define OSCAP_CONCAT1(a,b) a ## b
386 # define OSCAP_CONCAT(a,b) OSCAP_CONCAT1(a,b)
387 #endif
388 
389 #define OSCAP_GSYM(s) OSCAP_CONCAT(___G_, s)
390 
391 #define protect_errno \
392  for (int OSCAP_CONCAT(__e,__LINE__)=errno, OSCAP_CONCAT(__s,__LINE__)=1; OSCAP_CONCAT(__s,__LINE__)--; errno=OSCAP_CONCAT(__e,__LINE__))
393 
394 OSCAP_HIDDEN_END;
395 
396 #endif /* OSCAP_UTIL_H_ */