2 * OS specific functions
3 * Copyright (c) 2005-2009, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
12 typedef long os_time_t;
15 * os_sleep - Sleep (sec, usec)
16 * @sec: Number of seconds to sleep
17 * @usec: Number of microseconds to sleep
19 void os_sleep(os_time_t sec, os_time_t usec);
32 * os_get_time - Get current time (sec, usec)
33 * @t: Pointer to buffer for the time
34 * Returns: 0 on success, -1 on failure
36 int os_get_time(struct os_time *t);
39 * os_get_reltime - Get relative time (sec, usec)
40 * @t: Pointer to buffer for the time
41 * Returns: 0 on success, -1 on failure
43 int os_get_reltime(struct os_reltime *t);
46 /* Helpers for handling struct os_time */
48 static inline int os_time_before(struct os_time *a, struct os_time *b)
50 return (a->sec < b->sec) ||
51 (a->sec == b->sec && a->usec < b->usec);
55 static inline void os_time_sub(struct os_time *a, struct os_time *b,
58 res->sec = a->sec - b->sec;
59 res->usec = a->usec - b->usec;
67 /* Helpers for handling struct os_reltime */
69 static inline int os_reltime_before(struct os_reltime *a,
72 return (a->sec < b->sec) ||
73 (a->sec == b->sec && a->usec < b->usec);
77 static inline void os_reltime_sub(struct os_reltime *a, struct os_reltime *b,
78 struct os_reltime *res)
80 res->sec = a->sec - b->sec;
81 res->usec = a->usec - b->usec;
89 static inline void os_reltime_age(struct os_reltime *start,
90 struct os_reltime *age)
92 struct os_reltime now;
95 os_reltime_sub(&now, start, age);
99 static inline int os_reltime_expired(struct os_reltime *now,
100 struct os_reltime *ts,
101 os_time_t timeout_secs)
103 struct os_reltime age;
105 os_reltime_sub(now, ts, &age);
106 return (age.sec > timeout_secs) ||
107 (age.sec == timeout_secs && age.usec > 0);
111 static inline int os_reltime_initialized(struct os_reltime *t)
113 return t->sec != 0 || t->usec != 0;
118 * os_mktime - Convert broken-down time into seconds since 1970-01-01
119 * @year: Four digit year
120 * @month: Month (1 .. 12)
121 * @day: Day of month (1 .. 31)
122 * @hour: Hour (0 .. 23)
123 * @min: Minute (0 .. 59)
124 * @sec: Second (0 .. 60)
125 * @t: Buffer for returning calendar time representation (seconds since
126 * 1970-01-01 00:00:00)
127 * Returns: 0 on success, -1 on failure
129 * Note: The result is in seconds from Epoch, i.e., in UTC, not in local time
130 * which is used by POSIX mktime().
132 int os_mktime(int year, int month, int day, int hour, int min, int sec,
136 int sec; /* 0..59 or 60 for leap seconds */
138 int hour; /* 0..23 */
140 int month; /* 1..12 */
141 int year; /* Four digit year */
144 int os_gmtime(os_time_t t, struct os_tm *tm);
147 * os_daemonize - Run in the background (detach from the controlling terminal)
148 * @pid_file: File name to write the process ID to or %NULL to skip this
149 * Returns: 0 on success, -1 on failure
151 int os_daemonize(const char *pid_file);
154 * os_daemonize_terminate - Stop running in the background (remove pid file)
155 * @pid_file: File name to write the process ID to or %NULL to skip this
157 void os_daemonize_terminate(const char *pid_file);
160 * os_get_random - Get cryptographically strong pseudo random data
161 * @buf: Buffer for pseudo random data
162 * @len: Length of the buffer
163 * Returns: 0 on success, -1 on failure
165 int os_get_random(unsigned char *buf, size_t len);
168 * os_random - Get pseudo random value (not necessarily very strong)
169 * Returns: Pseudo random value
171 unsigned long os_random(void);
174 * os_rel2abs_path - Get an absolute path for a file
175 * @rel_path: Relative path to a file
176 * Returns: Absolute path for the file or %NULL on failure
178 * This function tries to convert a relative path of a file to an absolute path
179 * in order for the file to be found even if current working directory has
180 * changed. The returned value is allocated and caller is responsible for
181 * freeing it. It is acceptable to just return the same path in an allocated
182 * buffer, e.g., return strdup(rel_path). This function is only used to find
183 * configuration files when os_daemonize() may have changed the current working
184 * directory and relative path would be pointing to a different location.
186 char * os_rel2abs_path(const char *rel_path);
189 * os_program_init - Program initialization (called at start)
190 * Returns: 0 on success, -1 on failure
192 * This function is called when a programs starts. If there are any OS specific
193 * processing that is needed, it can be placed here. It is also acceptable to
194 * just return 0 if not special processing is needed.
196 int os_program_init(void);
199 * os_program_deinit - Program deinitialization (called just before exit)
201 * This function is called just before a program exists. If there are any OS
202 * specific processing, e.g., freeing resourced allocated in os_program_init(),
203 * it should be done here. It is also acceptable for this function to do
206 void os_program_deinit(void);
209 * os_setenv - Set environment variable
210 * @name: Name of the variable
211 * @value: Value to set to the variable
212 * @overwrite: Whether existing variable should be overwritten
213 * Returns: 0 on success, -1 on error
215 * This function is only used for wpa_cli action scripts. OS wrapper does not
216 * need to implement this if such functionality is not needed.
218 int os_setenv(const char *name, const char *value, int overwrite);
221 * os_unsetenv - Delete environent variable
222 * @name: Name of the variable
223 * Returns: 0 on success, -1 on error
225 * This function is only used for wpa_cli action scripts. OS wrapper does not
226 * need to implement this if such functionality is not needed.
228 int os_unsetenv(const char *name);
231 * os_readfile - Read a file to an allocated memory buffer
232 * @name: Name of the file to read
233 * @len: For returning the length of the allocated buffer
234 * Returns: Pointer to the allocated buffer or %NULL on failure
236 * This function allocates memory and reads the given file to this buffer. Both
237 * binary and text files can be read with this function. The caller is
238 * responsible for freeing the returned buffer with os_free().
240 char * os_readfile(const char *name, size_t *len);
243 * os_file_exists - Check whether the specified file exists
244 * @fname: Path and name of the file
245 * Returns: 1 if the file exists or 0 if not
247 int os_file_exists(const char *fname);
250 * os_fdatasync - Sync a file's (for a given stream) state with storage device
251 * @stream: the stream to be flushed
252 * Returns: 0 if the operation succeeded or -1 on failure
254 int os_fdatasync(FILE *stream);
257 * os_zalloc - Allocate and zero memory
258 * @size: Number of bytes to allocate
259 * Returns: Pointer to allocated and zeroed memory or %NULL on failure
261 * Caller is responsible for freeing the returned buffer with os_free().
263 void * os_zalloc(size_t size);
266 * os_calloc - Allocate and zero memory for an array
267 * @nmemb: Number of members in the array
268 * @size: Number of bytes in each member
269 * Returns: Pointer to allocated and zeroed memory or %NULL on failure
271 * This function can be used as a wrapper for os_zalloc(nmemb * size) when an
272 * allocation is used for an array. The main benefit over os_zalloc() is in
273 * having an extra check to catch integer overflows in multiplication.
275 * Caller is responsible for freeing the returned buffer with os_free().
277 static inline void * os_calloc(size_t nmemb, size_t size)
279 if (size && nmemb > (~(size_t) 0) / size)
281 return os_zalloc(nmemb * size);
286 * The following functions are wrapper for standard ANSI C or POSIX functions.
287 * By default, they are just defined to use the standard function name and no
288 * os_*.c implementation is needed for them. This avoids extra function calls
289 * by allowing the C pre-processor take care of the function name mapping.
291 * If the target system uses a C library that does not provide these functions,
292 * build_config.h can be used to define the wrappers to use a different
293 * function name. This can be done on function-by-function basis since the
294 * defines here are only used if build_config.h does not define the os_* name.
295 * If needed, os_*.c file can be used to implement the functions that are not
296 * included in the C library on the target system. Alternatively,
297 * OS_NO_C_LIB_DEFINES can be defined to skip all defines here in which case
298 * these functions need to be implemented in os_*.c file for the target system.
301 #ifdef OS_NO_C_LIB_DEFINES
304 * os_malloc - Allocate dynamic memory
305 * @size: Size of the buffer to allocate
306 * Returns: Allocated buffer or %NULL on failure
308 * Caller is responsible for freeing the returned buffer with os_free().
310 void * os_malloc(size_t size);
313 * os_realloc - Re-allocate dynamic memory
314 * @ptr: Old buffer from os_malloc() or os_realloc()
315 * @size: Size of the new buffer
316 * Returns: Allocated buffer or %NULL on failure
318 * Caller is responsible for freeing the returned buffer with os_free().
319 * If re-allocation fails, %NULL is returned and the original buffer (ptr) is
320 * not freed and caller is still responsible for freeing it.
322 void * os_realloc(void *ptr, size_t size);
325 * os_free - Free dynamic memory
326 * @ptr: Old buffer from os_malloc() or os_realloc(); can be %NULL
328 void os_free(void *ptr);
331 * os_memcpy - Copy memory area
334 * @n: Number of bytes to copy
337 * The memory areas src and dst must not overlap. os_memmove() can be used with
338 * overlapping memory.
340 void * os_memcpy(void *dest, const void *src, size_t n);
343 * os_memmove - Copy memory area
346 * @n: Number of bytes to copy
349 * The memory areas src and dst may overlap.
351 void * os_memmove(void *dest, const void *src, size_t n);
354 * os_memset - Fill memory with a constant byte
355 * @s: Memory area to be filled
357 * @n: Number of bytes started from s to fill with c
360 void * os_memset(void *s, int c, size_t n);
363 * os_memcmp - Compare memory areas
366 * @n: Maximum numbers of octets to compare
367 * Returns: An integer less than, equal to, or greater than zero if s1 is
368 * found to be less than, to match, or be greater than s2. Only first n
369 * characters will be compared.
371 int os_memcmp(const void *s1, const void *s2, size_t n);
374 * os_strdup - Duplicate a string
376 * Returns: Allocated buffer with the string copied into it or %NULL on failure
378 * Caller is responsible for freeing the returned buffer with os_free().
380 char * os_strdup(const char *s);
383 * os_strlen - Calculate the length of a string
384 * @s: '\0' terminated string
385 * Returns: Number of characters in s (not counting the '\0' terminator)
387 size_t os_strlen(const char *s);
390 * os_strcasecmp - Compare two strings ignoring case
393 * Returns: An integer less than, equal to, or greater than zero if s1 is
394 * found to be less than, to match, or be greatred than s2
396 int os_strcasecmp(const char *s1, const char *s2);
399 * os_strncasecmp - Compare two strings ignoring case
402 * @n: Maximum numbers of characters to compare
403 * Returns: An integer less than, equal to, or greater than zero if s1 is
404 * found to be less than, to match, or be greater than s2. Only first n
405 * characters will be compared.
407 int os_strncasecmp(const char *s1, const char *s2, size_t n);
410 * os_strchr - Locate the first occurrence of a character in string
412 * @c: Character to search for
413 * Returns: Pointer to the matched character or %NULL if not found
415 char * os_strchr(const char *s, int c);
418 * os_strrchr - Locate the last occurrence of a character in string
420 * @c: Character to search for
421 * Returns: Pointer to the matched character or %NULL if not found
423 char * os_strrchr(const char *s, int c);
426 * os_strcmp - Compare two strings
429 * Returns: An integer less than, equal to, or greater than zero if s1 is
430 * found to be less than, to match, or be greatred than s2
432 int os_strcmp(const char *s1, const char *s2);
435 * os_strncmp - Compare two strings
438 * @n: Maximum numbers of characters to compare
439 * Returns: An integer less than, equal to, or greater than zero if s1 is
440 * found to be less than, to match, or be greater than s2. Only first n
441 * characters will be compared.
443 int os_strncmp(const char *s1, const char *s2, size_t n);
446 * os_strstr - Locate a substring
447 * @haystack: String (haystack) to search from
448 * @needle: Needle to search from haystack
449 * Returns: Pointer to the beginning of the substring or %NULL if not found
451 char * os_strstr(const char *haystack, const char *needle);
454 * os_snprintf - Print to a memory buffer
455 * @str: Memory buffer to print into
456 * @size: Maximum length of the str buffer
457 * @format: printf format
458 * Returns: Number of characters printed (not including trailing '\0').
460 * If the output buffer is truncated, number of characters which would have
461 * been written is returned. Since some C libraries return -1 in such a case,
462 * the caller must be prepared on that value, too, to indicate truncation.
464 * Note: Some C library implementations of snprintf() may not guarantee null
465 * termination in case the output is truncated. The OS wrapper function of
466 * os_snprintf() should provide this guarantee, i.e., to null terminate the
467 * output buffer if a C library version of the function is used and if that
468 * function does not guarantee null termination.
470 * If the target system does not include snprintf(), see, e.g.,
471 * http://www.ijs.si/software/snprintf/ for an example of a portable
472 * implementation of snprintf.
474 int os_snprintf(char *str, size_t size, const char *format, ...);
476 #else /* OS_NO_C_LIB_DEFINES */
479 void * os_malloc(size_t size);
480 void * os_realloc(void *ptr, size_t size);
481 void os_free(void *ptr);
482 char * os_strdup(const char *s);
483 #else /* WPA_TRACE */
485 #define os_malloc(s) malloc((s))
488 #define os_realloc(p, s) realloc((p), (s))
491 #define os_free(p) free((p))
495 #define os_strdup(s) _strdup(s)
497 #define os_strdup(s) strdup(s)
500 #endif /* WPA_TRACE */
503 #define os_memcpy(d, s, n) memcpy((d), (s), (n))
506 #define os_memmove(d, s, n) memmove((d), (s), (n))
509 #define os_memset(s, c, n) memset(s, c, n)
512 #define os_memcmp(s1, s2, n) memcmp((s1), (s2), (n))
516 #define os_strlen(s) strlen(s)
518 #ifndef os_strcasecmp
520 #define os_strcasecmp(s1, s2) _stricmp((s1), (s2))
522 #define os_strcasecmp(s1, s2) strcasecmp((s1), (s2))
525 #ifndef os_strncasecmp
527 #define os_strncasecmp(s1, s2, n) _strnicmp((s1), (s2), (n))
529 #define os_strncasecmp(s1, s2, n) strncasecmp((s1), (s2), (n))
533 #define os_strchr(s, c) strchr((s), (c))
536 #define os_strcmp(s1, s2) strcmp((s1), (s2))
539 #define os_strncmp(s1, s2, n) strncmp((s1), (s2), (n))
542 #define os_strrchr(s, c) strrchr((s), (c))
545 #define os_strstr(h, n) strstr((h), (n))
550 #define os_snprintf _snprintf
552 #define os_snprintf snprintf
556 #endif /* OS_NO_C_LIB_DEFINES */
559 static inline int os_snprintf_error(size_t size, int res)
561 return res < 0 || (unsigned int) res >= size;
565 static inline void * os_realloc_array(void *ptr, size_t nmemb, size_t size)
567 if (size && nmemb > (~(size_t) 0) / size)
569 return os_realloc(ptr, nmemb * size);
573 * os_remove_in_array - Remove a member from an array by index
574 * @ptr: Pointer to the array
575 * @nmemb: Current member count of the array
576 * @size: The size per member of the array
577 * @idx: Index of the member to be removed
579 static inline void os_remove_in_array(void *ptr, size_t nmemb, size_t size,
583 os_memmove(((unsigned char *) ptr) + idx * size,
584 ((unsigned char *) ptr) + (idx + 1) * size,
585 (nmemb - idx - 1) * size);
589 * os_strlcpy - Copy a string with size bound and NUL-termination
592 * @siz: Size of the target buffer
593 * Returns: Total length of the target string (length of src) (not including
596 * This function matches in behavior with the strlcpy(3) function in OpenBSD.
598 size_t os_strlcpy(char *dest, const char *src, size_t siz);
601 * os_memcmp_const - Constant time memory comparison
602 * @a: First buffer to compare
603 * @b: Second buffer to compare
604 * @len: Number of octets to compare
605 * Returns: 0 if buffers are equal, non-zero if not
607 * This function is meant for comparing passwords or hash values where
608 * difference in execution time could provide external observer information
609 * about the location of the difference in the memory buffers. The return value
610 * does not behave like os_memcmp(), i.e., os_memcmp_const() cannot be used to
611 * sort items into a defined order. Unlike os_memcmp(), execution time of
612 * os_memcmp_const() does not depend on the contents of the compared memory
613 * buffers, but only on the total compared length.
615 int os_memcmp_const(const void *a, const void *b, size_t len);
618 * os_exec - Execute an external program
619 * @program: Path to the program
620 * @arg: Command line argument string
621 * @wait_completion: Whether to wait until the program execution completes
622 * Returns: 0 on success, -1 on error
624 int os_exec(const char *program, const char *arg, int wait_completion);
627 #ifdef OS_REJECT_C_LIB_FUNCTIONS
628 #define malloc OS_DO_NOT_USE_malloc
629 #define realloc OS_DO_NOT_USE_realloc
630 #define free OS_DO_NOT_USE_free
631 #define memcpy OS_DO_NOT_USE_memcpy
632 #define memmove OS_DO_NOT_USE_memmove
633 #define memset OS_DO_NOT_USE_memset
634 #define memcmp OS_DO_NOT_USE_memcmp
636 #define strdup OS_DO_NOT_USE_strdup
637 #define strlen OS_DO_NOT_USE_strlen
638 #define strcasecmp OS_DO_NOT_USE_strcasecmp
639 #define strncasecmp OS_DO_NOT_USE_strncasecmp
641 #define strchr OS_DO_NOT_USE_strchr
643 #define strcmp OS_DO_NOT_USE_strcmp
645 #define strncmp OS_DO_NOT_USE_strncmp
647 #define strncpy OS_DO_NOT_USE_strncpy
648 #define strrchr OS_DO_NOT_USE_strrchr
649 #define strstr OS_DO_NOT_USE_strstr
651 #define snprintf OS_DO_NOT_USE_snprintf
653 #define strcpy OS_DO_NOT_USE_strcpy
654 #endif /* OS_REJECT_C_LIB_FUNCTIONS */
657 #if defined(WPA_TRACE_BFD) && defined(CONFIG_TESTING_OPTIONS)
658 #define TEST_FAIL() testing_test_fail()
659 int testing_test_fail(void);
661 #define TEST_FAIL() 0