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 "oscap_platforms.h"
28 #include <stdlib.h>
29 #include <stdbool.h>
30 #include <assert.h>
31 #include "public/oscap.h"
32 #include <stdarg.h>
33 #include <string.h>
34 #include "oscap_export.h"
35 
36 #ifndef __attribute__nonnull__
37 #define __attribute__nonnull__(x) assert((x) != NULL)
38 #endif
39 
43 typedef void (*oscap_destruct_func) (void *);
44 
48 typedef void* (*oscap_clone_func) (void *);
49 
53 typedef void (*oscap_consumer_func) (void *, void *);
54 
65 #define OSCAP_GENERIC_GETTER_CONV(RTYPE,CONV,SNAME,MNAME,MEXP) \
66  RTYPE SNAME##_get_##MNAME(const struct SNAME* item) { return (CONV(item->MEXP)); }
67 
76 #define OSCAP_GENERIC_GETTER(RTYPE,SNAME,MNAME,MEXP) \
77  OSCAP_GENERIC_GETTER_CONV(RTYPE,,SNAME,MNAME,MEXP)
78 
87 #define OSCAP_GENERIC_GETTER_FORCE(RTYPE,SNAME,MNAME,MEXP) \
88  OSCAP_GENERIC_GETTER_CONV(RTYPE,(RTYPE),SNAME,MNAME,MEXP)
89 
98 #define OSCAP_GETTER_FORCE(RTYPE,SNAME,MNAME) \
99  OSCAP_GENERIC_GETTER_FORCE(RTYPE,SNAME,MNAME,MNAME)
100 
109 #define OSCAP_GETTER(RTYPE,SNAME,MNAME) \
110  OSCAP_GENERIC_GETTER(RTYPE,SNAME,MNAME,MNAME)
111 
112 #define ITERATOR_CAST(x) ((struct oscap_iterator*)(x))
113 #define OSCAP_ITERATOR(n) struct n##_iterator*
114 #define OSCAP_ITERATOR_FWD(n) struct n##_iterator;
115 #define OSCAP_ITERATOR_HAS_MORE(n) bool n##_iterator_has_more(OSCAP_ITERATOR(n) it) { return oscap_iterator_has_more(ITERATOR_CAST(it)); }
116 #define OSCAP_ITERATOR_NEXT(t,n) t n##_iterator_next(OSCAP_ITERATOR(n) it) { return oscap_iterator_next(ITERATOR_CAST(it)); }
117 #define OSCAP_ITERATOR_FREE(n) void n##_iterator_free(OSCAP_ITERATOR(n) it) { oscap_iterator_free(ITERATOR_CAST(it)); }
118 #define OSCAP_ITERATOR_RESET(n) void n##_iterator_reset(OSCAP_ITERATOR(n) it) { oscap_iterator_reset(ITERATOR_CAST(it)); }
119 #define OSCAP_ITERATOR_DETACH(t,n) t n##_iterator_detach(OSCAP_ITERATOR(n) it) { return oscap_iterator_detach(ITERATOR_CAST(it)); }
120 #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)
121 #define OSCAP_ITERATOR_GEN(n) OSCAP_ITERATOR_GEN_T(struct n*,n)
122 
123 #define OSCAP_ITERATOR_REMOVE_T(t,n,destructor) \
124  void n##_iterator_remove(OSCAP_ITERATOR(n) it) { destructor(oscap_iterator_detach(ITERATOR_CAST(it))); }
125 #define OSCAP_ITERATOR_REMOVE(n,destructor) OSCAP_ITERATOR_REMOVE_T(struct n*,n,destructor)
126 #define OSCAP_ITERATOR_REMOVE_F(n) OSCAP_ITERATOR_REMOVE(n, n##_free)
127 
128 
138 #define OSCAP_IGETTER_CONV(ITYPE,SNAME,MNAME,CONV) \
139  struct ITYPE##_iterator* SNAME##_get_##MNAME(const struct SNAME* item) \
140  { return oscap_iterator_new((CONV(item))->MNAME); }
141 
150 #define OSCAP_IGETTER(ITYPE,SNAME,MNAME) OSCAP_IGETTER_CONV(ITYPE,SNAME,MNAME,)
151 
157 #define OSCAP_IGETTER_GEN(ITYPE,SNAME,MNAME) OSCAP_IGETTER(ITYPE,SNAME,MNAME) OSCAP_ITERATOR_GEN(ITYPE)
158 
168 #define OSCAP_HGETTER_EXP(RTYPE,SNAME,MNAME,MEXP) \
169  RTYPE SNAME##_get_##MNAME(const struct SNAME* item, const char* key) \
170  { return oscap_htable_get(item->MEXP, key); }
171 
180 #define OSCAP_HGETTER(RTYPE,SNAME,MNAME) OSCAP_HGETTER_EXP(RTYPE,SNAME,MNAME,MNAME)
181 
190 #define OSCAP_HGETTER_STRUCT(RTYPE,SNAME,MNAME) OSCAP_HGETTER_EXP(struct RTYPE*,SNAME,MNAME,MNAME)
191 
192 #define OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) bool SNAME##_set_##MNAME(struct SNAME *obj, MTYPE newval)
193 
205 #define OSCAP_SETTER_GENERIC_CHECK(SNAME, MTYPE, MNAME, CHECK, DELETER, ASSIGNER) \
206  OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) \
207  { if (!(CHECK)) return false; DELETER(obj->MNAME); obj->MNAME = ASSIGNER(newval); return true; }
208 
213 #define OSCAP_SETTER_GENERIC(SNAME, MTYPE, MNAME, DELETER, ASSIGNER) \
214  OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) \
215  { DELETER(obj->MNAME); obj->MNAME = ASSIGNER(newval); return true; }
216 
221 #define OSCAP_SETTER_GENERIC_NODELETE(SNAME, MTYPE, MNAME, ASSIGNER) \
222  OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) \
223  { obj->MNAME = ASSIGNER(newval); return true; }
224 
229 #define OSCAP_SETTER_SIMPLE(SNAME, MTYPE, MNAME) \
230  OSCAP_SETTER_GENERIC_NODELETE(SNAME, MTYPE, MNAME, )
231 
237 #define OSCAP_SETTER_STRING(SNAME, MNAME) \
238  OSCAP_SETTER_GENERIC(SNAME, const char *, MNAME, free, oscap_strdup)
239 
243 #define OSCAP_ACCESSOR_STRING(SNAME, MNAME) \
244  OSCAP_GETTER(const char*, SNAME, MNAME) OSCAP_SETTER_STRING(SNAME, MNAME)
245 
249 #define OSCAP_ACCESSOR_TEXT(SNAME, MNAME) \
250  OSCAP_GETTER(struct oscap_text *, SNAME, MNAME) \
251  OSCAP_SETTER_GENERIC(SNAME, struct oscap_text*, MNAME, oscap_text_free, )
252 
256 #define OSCAP_ACCESSOR_SIMPLE(MTYPE, SNAME, MNAME) \
257  OSCAP_GETTER(MTYPE, SNAME, MNAME) OSCAP_SETTER_SIMPLE(SNAME, MTYPE, MNAME)
258 
263 #define OSCAP_ACCESSOR_EXP(MTYPE, SNAME, MNAME, MEXP) \
264  OSCAP_GENERIC_GETTER(MTYPE, SNAME, MNAME, MEXP) \
265  OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) { obj->MEXP = newval; return true; }
266 
276 #define OSCAP_INSERTER(SNAME, FNAME, MTYPE, MNAME) \
277  bool SNAME##_add_##FNAME(struct SNAME *obj, struct MTYPE *item) \
278  { oscap_list_add(obj->MNAME, item); return true; }
279 
280 /* Generate iterator getter and list inserter */
281 #define OSCAP_IGETINS(ITYPE, SNAME, MNAME, FNAME) \
282  OSCAP_IGETTER(ITYPE, SNAME, MNAME) OSCAP_INSERTER(SNAME, FNAME, ITYPE, MNAME)
283 /* Generate iterator getter, list inserter, and iterator manipulation functions. */
284 #define OSCAP_IGETINS_GEN(ITYPE, SNAME, MNAME, FNAME) \
285  OSCAP_IGETTER_GEN(ITYPE, SNAME, MNAME) OSCAP_INSERTER(SNAME, FNAME, ITYPE, MNAME)
286 
295  const int value; /* integer/enum value */
296  const char *string; /* string representation of the value */
297 };
298 
303 static inline char *oscap_strdup(const char *str) {
304  if (str == NULL)
305  return NULL;
306 
307 #ifdef _MSC_VER
308  return _strdup(str);
309 #else
310  return strdup(str);
311 #endif
312 }
313 
315 static inline int oscap_strcmp(const char *s1, const char *s2) {
316  if (s1 == NULL) s1 = "";
317  if (s2 == NULL) s2 = "";
318  return strcmp(s1, s2);
319 }
320 
322 static inline bool oscap_streq(const char *s1, const char *s2) {
323  return oscap_strcmp(s1, s2) == 0;
324 }
325 
327 static inline bool oscap_str_startswith(const char *str, const char *prefix) {
328  return strncmp(str, prefix, strlen(prefix)) == 0;
329 }
330 
332 static inline bool oscap_str_endswith(const char *str, const char *suffix) {
333  const size_t str_len = strlen(str);
334  const size_t suffix_len = strlen(suffix);
335  if (suffix_len > str_len)
336  return false;
337  return strncmp(str + str_len - suffix_len, suffix, suffix_len) == 0;
338 }
339 
341 static inline void *oscap_aligned_malloc(size_t size, size_t alignment) {
342 #ifdef WIN32
343  return _aligned_malloc(size, alignment);
344 #else
345  void *ptr = NULL;
346  posix_memalign(&ptr, alignment, size);
347  return ptr;
348 #endif
349 }
350 
352 static inline void oscap_aligned_free(void *memblock) {
353 #ifdef WIN32
354  _aligned_free(memblock);
355 #else
356  free(memblock);
357 #endif
358 }
359 
361 char *oscap_trim(char *str);
363 char *oscap_vsprintf(const char *fmt, va_list ap);
364 
374 char *oscap_path_join(const char *path1, const char *path2);
375 
377 const char *oscap_strlist_find_value(char ** const kvalues, const char *key);
379 char *oscap_rtrim(char *str, char ch);
381 void oscap_strtoupper(char *str);
382 
383 // check pointer equality
384 bool oscap_ptr_cmp(void *node1, void *node2);
385 
397 char *oscap_expand_ipv6(const char *input);
398 
399 #ifndef OSCAP_CONCAT
400 # define OSCAP_CONCAT1(a,b) a ## b
401 # define OSCAP_CONCAT(a,b) OSCAP_CONCAT1(a,b)
402 #endif
403 
410 #define OSCAP_GSYM(s) OSCAP_CONCAT(___G_, s)
411 
412 #define protect_errno \
413  for (int OSCAP_CONCAT(__e,__LINE__)=errno, OSCAP_CONCAT(__s,__LINE__)=1; OSCAP_CONCAT(__s,__LINE__)--; errno=OSCAP_CONCAT(__e,__LINE__))
414 
421 int oscap_string_to_enum(const struct oscap_string_map *map, const char *str);
422 
429 const char *oscap_enum_to_string(const struct oscap_string_map *map, int val);
430 
439 char **oscap_split(char *str, const char *delim);
440 
449 int oscap_strcasecmp(const char *s1, const char *s2);
450 
460 int oscap_strncasecmp(const char *s1, const char *s2, size_t n);
461 
468 char *oscap_strerror_r(int errnum, char *buf, size_t buflen);
469 
470 #ifdef OS_WINDOWS
471 
478 char *oscap_windows_wstr_to_str(const wchar_t *wstr);
479 
487 wchar_t *oscap_windows_str_to_wstr(const char *str);
488 
496 char *oscap_windows_error_message(unsigned long error_code);
497 #endif
498 
499 #endif /* OSCAP_UTIL_H_ */
General OpenScap functions and types.
Define mapping between symbolic constant and its string representation.
Definition: util.h:294
int oscap_string_to_enum(const struct oscap_string_map *map, const char *str)
Convert a string to an enumeration constant.
Definition: util.c:49
const char * oscap_enum_to_string(const struct oscap_string_map *map, int val)
Convert an enumeration constant to its corresponding string representation.
Definition: util.c:58