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 <stdlib.h>
28 #include <stdbool.h>
29 #include <assert.h>
30 #include "public/oscap.h"
31 #include <stdarg.h>
32 #include <string.h>
33 #include "oscap_export.h"
34 
35 #ifndef __attribute__nonnull__
36 #define __attribute__nonnull__(x) assert((x) != NULL)
37 #endif
38 
42 typedef void (*oscap_destruct_func) (void *);
43 
47 typedef void* (*oscap_clone_func) (void *);
48 
52 typedef void (*oscap_consumer_func) (void *, void *);
53 
64 #define OSCAP_GENERIC_GETTER_CONV(RTYPE,CONV,SNAME,MNAME,MEXP) \
65  RTYPE SNAME##_get_##MNAME(const struct SNAME* item) { return (CONV(item->MEXP)); }
66 
75 #define OSCAP_GENERIC_GETTER(RTYPE,SNAME,MNAME,MEXP) \
76  OSCAP_GENERIC_GETTER_CONV(RTYPE,,SNAME,MNAME,MEXP)
77 
86 #define OSCAP_GENERIC_GETTER_FORCE(RTYPE,SNAME,MNAME,MEXP) \
87  OSCAP_GENERIC_GETTER_CONV(RTYPE,(RTYPE),SNAME,MNAME,MEXP)
88 
97 #define OSCAP_GETTER_FORCE(RTYPE,SNAME,MNAME) \
98  OSCAP_GENERIC_GETTER_FORCE(RTYPE,SNAME,MNAME,MNAME)
99 
108 #define OSCAP_GETTER(RTYPE,SNAME,MNAME) \
109  OSCAP_GENERIC_GETTER(RTYPE,SNAME,MNAME,MNAME)
110 
111 #define ITERATOR_CAST(x) ((struct oscap_iterator*)(x))
112 #define OSCAP_ITERATOR(n) struct n##_iterator*
113 #define OSCAP_ITERATOR_FWD(n) struct n##_iterator;
114 #define OSCAP_ITERATOR_HAS_MORE(n) bool n##_iterator_has_more(OSCAP_ITERATOR(n) it) { return oscap_iterator_has_more(ITERATOR_CAST(it)); }
115 #define OSCAP_ITERATOR_NEXT(t,n) t n##_iterator_next(OSCAP_ITERATOR(n) it) { return oscap_iterator_next(ITERATOR_CAST(it)); }
116 #define OSCAP_ITERATOR_FREE(n) void n##_iterator_free(OSCAP_ITERATOR(n) it) { oscap_iterator_free(ITERATOR_CAST(it)); }
117 #define OSCAP_ITERATOR_RESET(n) void n##_iterator_reset(OSCAP_ITERATOR(n) it) { oscap_iterator_reset(ITERATOR_CAST(it)); }
118 #define OSCAP_ITERATOR_DETACH(t,n) t n##_iterator_detach(OSCAP_ITERATOR(n) it) { return oscap_iterator_detach(ITERATOR_CAST(it)); }
119 #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)
120 #define OSCAP_ITERATOR_GEN(n) OSCAP_ITERATOR_GEN_T(struct n*,n)
121 
122 #define OSCAP_ITERATOR_REMOVE_T(t,n,destructor) \
123  void n##_iterator_remove(OSCAP_ITERATOR(n) it) { destructor(oscap_iterator_detach(ITERATOR_CAST(it))); }
124 #define OSCAP_ITERATOR_REMOVE(n,destructor) OSCAP_ITERATOR_REMOVE_T(struct n*,n,destructor)
125 #define OSCAP_ITERATOR_REMOVE_F(n) OSCAP_ITERATOR_REMOVE(n, n##_free)
126 
127 
137 #define OSCAP_IGETTER_CONV(ITYPE,SNAME,MNAME,CONV) \
138  struct ITYPE##_iterator* SNAME##_get_##MNAME(const struct SNAME* item) \
139  { return oscap_iterator_new((CONV(item))->MNAME); }
140 
149 #define OSCAP_IGETTER(ITYPE,SNAME,MNAME) OSCAP_IGETTER_CONV(ITYPE,SNAME,MNAME,)
150 
156 #define OSCAP_IGETTER_GEN(ITYPE,SNAME,MNAME) OSCAP_IGETTER(ITYPE,SNAME,MNAME) OSCAP_ITERATOR_GEN(ITYPE)
157 
167 #define OSCAP_HGETTER_EXP(RTYPE,SNAME,MNAME,MEXP) \
168  RTYPE SNAME##_get_##MNAME(const struct SNAME* item, const char* key) \
169  { return oscap_htable_get(item->MEXP, key); }
170 
179 #define OSCAP_HGETTER(RTYPE,SNAME,MNAME) OSCAP_HGETTER_EXP(RTYPE,SNAME,MNAME,MNAME)
180 
189 #define OSCAP_HGETTER_STRUCT(RTYPE,SNAME,MNAME) OSCAP_HGETTER_EXP(struct RTYPE*,SNAME,MNAME,MNAME)
190 
191 #define OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) bool SNAME##_set_##MNAME(struct SNAME *obj, MTYPE newval)
192 
204 #define OSCAP_SETTER_GENERIC_CHECK(SNAME, MTYPE, MNAME, CHECK, DELETER, ASSIGNER) \
205  OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) \
206  { if (!(CHECK)) return false; DELETER(obj->MNAME); obj->MNAME = ASSIGNER(newval); return true; }
207 
212 #define OSCAP_SETTER_GENERIC(SNAME, MTYPE, MNAME, DELETER, ASSIGNER) \
213  OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) \
214  { DELETER(obj->MNAME); obj->MNAME = ASSIGNER(newval); return true; }
215 
220 #define OSCAP_SETTER_GENERIC_NODELETE(SNAME, MTYPE, MNAME, ASSIGNER) \
221  OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) \
222  { obj->MNAME = ASSIGNER(newval); return true; }
223 
228 #define OSCAP_SETTER_SIMPLE(SNAME, MTYPE, MNAME) \
229  OSCAP_SETTER_GENERIC_NODELETE(SNAME, MTYPE, MNAME, )
230 
236 #define OSCAP_SETTER_STRING(SNAME, MNAME) \
237  OSCAP_SETTER_GENERIC(SNAME, const char *, MNAME, free, oscap_strdup)
238 
242 #define OSCAP_ACCESSOR_STRING(SNAME, MNAME) \
243  OSCAP_GETTER(const char*, SNAME, MNAME) OSCAP_SETTER_STRING(SNAME, MNAME)
244 
248 #define OSCAP_ACCESSOR_TEXT(SNAME, MNAME) \
249  OSCAP_GETTER(struct oscap_text *, SNAME, MNAME) \
250  OSCAP_SETTER_GENERIC(SNAME, struct oscap_text*, MNAME, oscap_text_free, )
251 
255 #define OSCAP_ACCESSOR_SIMPLE(MTYPE, SNAME, MNAME) \
256  OSCAP_GETTER(MTYPE, SNAME, MNAME) OSCAP_SETTER_SIMPLE(SNAME, MTYPE, MNAME)
257 
262 #define OSCAP_ACCESSOR_EXP(MTYPE, SNAME, MNAME, MEXP) \
263  OSCAP_GENERIC_GETTER(MTYPE, SNAME, MNAME, MEXP) \
264  OSCAP_SETTER_HEADER(SNAME, MTYPE, MNAME) { obj->MEXP = newval; return true; }
265 
275 #define OSCAP_INSERTER(SNAME, FNAME, MTYPE, MNAME) \
276  bool SNAME##_add_##FNAME(struct SNAME *obj, struct MTYPE *item) \
277  { oscap_list_add(obj->MNAME, item); return true; }
278 
279 /* Generate iterator getter and list inserter */
280 #define OSCAP_IGETINS(ITYPE, SNAME, MNAME, FNAME) \
281  OSCAP_IGETTER(ITYPE, SNAME, MNAME) OSCAP_INSERTER(SNAME, FNAME, ITYPE, MNAME)
282 /* Generate iterator getter, list inserter, and iterator manipulation functions. */
283 #define OSCAP_IGETINS_GEN(ITYPE, SNAME, MNAME, FNAME) \
284  OSCAP_IGETTER_GEN(ITYPE, SNAME, MNAME) OSCAP_INSERTER(SNAME, FNAME, ITYPE, MNAME)
285 
294  const int value; /* integer/enum value */
295  const char *string; /* string representation of the value */
296 };
297 
302 static inline char *oscap_strdup(const char *str) {
303  if (str == NULL)
304  return NULL;
305 
306 #ifdef _MSC_VER
307  return _strdup(str);
308 #else
309  return strdup(str);
310 #endif
311 }
312 
314 static inline int oscap_strcmp(const char *s1, const char *s2) {
315  if (s1 == NULL) s1 = "";
316  if (s2 == NULL) s2 = "";
317  return strcmp(s1, s2);
318 }
319 
321 static inline bool oscap_streq(const char *s1, const char *s2) {
322  return oscap_strcmp(s1, s2) == 0;
323 }
324 
326 static inline bool oscap_str_startswith(const char *str, const char *prefix) {
327  return strncmp(str, prefix, strlen(prefix)) == 0;
328 }
329 
331 static inline bool oscap_str_endswith(const char *str, const char *suffix) {
332  const size_t str_len = strlen(str);
333  const size_t suffix_len = strlen(suffix);
334  if (suffix_len > str_len)
335  return false;
336  return strncmp(str + str_len - suffix_len, suffix, suffix_len) == 0;
337 }
338 
340 static inline void *oscap_aligned_malloc(size_t size, size_t alignment) {
341 #ifdef WIN32
342  return _aligned_malloc(size, alignment);
343 #else
344  void *ptr = NULL;
345  posix_memalign(&ptr, alignment, size);
346  return ptr;
347 #endif
348 }
349 
351 static inline void oscap_aligned_free(void *memblock) {
352 #ifdef WIN32
353  _aligned_free(memblock);
354 #else
355  free(memblock);
356 #endif
357 }
358 
360 char *oscap_trim(char *str);
362 char *oscap_vsprintf(const char *fmt, va_list ap);
363 
364 // FIXME: This is there because of the SCE engine using this particular function
365 
367 OSCAP_API char *oscap_sprintf(const char *fmt, ...);
368 
378 char *oscap_path_join(const char *path1, const char *path2);
379 
381 const char *oscap_strlist_find_value(char ** const kvalues, const char *key);
383 char *oscap_rtrim(char *str, char ch);
385 void oscap_strtoupper(char *str);
386 
387 // check pointer equality
388 bool oscap_ptr_cmp(void *node1, void *node2);
389 
401 char *oscap_expand_ipv6(const char *input);
402 
403 #ifndef OSCAP_CONCAT
404 # define OSCAP_CONCAT1(a,b) a ## b
405 # define OSCAP_CONCAT(a,b) OSCAP_CONCAT1(a,b)
406 #endif
407 
414 #define OSCAP_GSYM(s) OSCAP_CONCAT(___G_, s)
415 
416 #define protect_errno \
417  for (int OSCAP_CONCAT(__e,__LINE__)=errno, OSCAP_CONCAT(__s,__LINE__)=1; OSCAP_CONCAT(__s,__LINE__)--; errno=OSCAP_CONCAT(__e,__LINE__))
418 
419 
420 /* The following functions aren't hidden, because they're used by some probes. */
421 
428 OSCAP_API int oscap_string_to_enum(const struct oscap_string_map *map, const char *str);
429 
436 OSCAP_API const char *oscap_enum_to_string(const struct oscap_string_map *map, int val);
437 
446 OSCAP_API char **oscap_split(char *str, const char *delim);
447 
454 OSCAP_API char *oscap_realpath(const char *path, char *resolved_path);
455 
463 OSCAP_API char *oscap_basename(char *path);
464 
472 OSCAP_API char *oscap_dirname(char *path);
473 
482 OSCAP_API int oscap_strcasecmp(const char *s1, const char *s2);
483 
493 OSCAP_API int oscap_strncasecmp(const char *s1, const char *s2, size_t n);
494 
502 OSCAP_API char *oscap_strtok_r(char *str, const char *delim, char **saveptr);
503 
510 OSCAP_API char *oscap_strerror_r(int errnum, char *buf, size_t buflen);
511 
512 #ifdef _WIN32
513 
520 char *oscap_windows_wstr_to_str(const wchar_t *wstr);
521 
529 wchar_t *oscap_windows_str_to_wstr(const char *str);
530 
538 char *oscap_windows_error_message(unsigned long error_code);
539 #endif
540 
541 #endif /* OSCAP_UTIL_H_ */
General OpenScap functions and types.
Define mapping between symbolic constant and its string representation.
Definition: util.h:293
OSCAP_API 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:57
OSCAP_API int oscap_string_to_enum(const struct oscap_string_map *map, const char *str)
Convert a string to an enumeration constant.
Definition: util.c:48