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);
27 * os_get_time - Get current time (sec, usec)
28 * @t: Pointer to buffer for the time
29 * Returns: 0 on success, -1 on failure
31 int os_get_time(struct os_time *t);
34 /* Helper macros for handling struct os_time */
36 #define os_time_before(a, b) \
37 ((a)->sec < (b)->sec || \
38 ((a)->sec == (b)->sec && (a)->usec < (b)->usec))
40 #define os_time_sub(a, b, res) do { \
41 (res)->sec = (a)->sec - (b)->sec; \
42 (res)->usec = (a)->usec - (b)->usec; \
43 if ((res)->usec < 0) { \
45 (res)->usec += 1000000; \
50 * os_mktime - Convert broken-down time into seconds since 1970-01-01
51 * @year: Four digit year
52 * @month: Month (1 .. 12)
53 * @day: Day of month (1 .. 31)
54 * @hour: Hour (0 .. 23)
55 * @min: Minute (0 .. 59)
56 * @sec: Second (0 .. 60)
57 * @t: Buffer for returning calendar time representation (seconds since
58 * 1970-01-01 00:00:00)
59 * Returns: 0 on success, -1 on failure
61 * Note: The result is in seconds from Epoch, i.e., in UTC, not in local time
62 * which is used by POSIX mktime().
64 int os_mktime(int year, int month, int day, int hour, int min, int sec,
68 int sec; /* 0..59 or 60 for leap seconds */
72 int month; /* 1..12 */
73 int year; /* Four digit year */
76 int os_gmtime(os_time_t t, struct os_tm *tm);
79 * os_daemonize - Run in the background (detach from the controlling terminal)
80 * @pid_file: File name to write the process ID to or %NULL to skip this
81 * Returns: 0 on success, -1 on failure
83 int os_daemonize(const char *pid_file);
86 * os_daemonize_terminate - Stop running in the background (remove pid file)
87 * @pid_file: File name to write the process ID to or %NULL to skip this
89 void os_daemonize_terminate(const char *pid_file);
92 * os_get_random - Get cryptographically strong pseudo random data
93 * @buf: Buffer for pseudo random data
94 * @len: Length of the buffer
95 * Returns: 0 on success, -1 on failure
97 int os_get_random(unsigned char *buf, size_t len);
100 * os_random - Get pseudo random value (not necessarily very strong)
101 * Returns: Pseudo random value
103 unsigned long os_random(void);
106 * os_rel2abs_path - Get an absolute path for a file
107 * @rel_path: Relative path to a file
108 * Returns: Absolute path for the file or %NULL on failure
110 * This function tries to convert a relative path of a file to an absolute path
111 * in order for the file to be found even if current working directory has
112 * changed. The returned value is allocated and caller is responsible for
113 * freeing it. It is acceptable to just return the same path in an allocated
114 * buffer, e.g., return strdup(rel_path). This function is only used to find
115 * configuration files when os_daemonize() may have changed the current working
116 * directory and relative path would be pointing to a different location.
118 char * os_rel2abs_path(const char *rel_path);
121 * os_program_init - Program initialization (called at start)
122 * Returns: 0 on success, -1 on failure
124 * This function is called when a programs starts. If there are any OS specific
125 * processing that is needed, it can be placed here. It is also acceptable to
126 * just return 0 if not special processing is needed.
128 int os_program_init(void);
131 * os_program_deinit - Program deinitialization (called just before exit)
133 * This function is called just before a program exists. If there are any OS
134 * specific processing, e.g., freeing resourced allocated in os_program_init(),
135 * it should be done here. It is also acceptable for this function to do
138 void os_program_deinit(void);
141 * os_setenv - Set environment variable
142 * @name: Name of the variable
143 * @value: Value to set to the variable
144 * @overwrite: Whether existing variable should be overwritten
145 * Returns: 0 on success, -1 on error
147 * This function is only used for wpa_cli action scripts. OS wrapper does not
148 * need to implement this if such functionality is not needed.
150 int os_setenv(const char *name, const char *value, int overwrite);
153 * os_unsetenv - Delete environent variable
154 * @name: Name of the variable
155 * Returns: 0 on success, -1 on error
157 * This function is only used for wpa_cli action scripts. OS wrapper does not
158 * need to implement this if such functionality is not needed.
160 int os_unsetenv(const char *name);
163 * os_readfile - Read a file to an allocated memory buffer
164 * @name: Name of the file to read
165 * @len: For returning the length of the allocated buffer
166 * Returns: Pointer to the allocated buffer or %NULL on failure
168 * This function allocates memory and reads the given file to this buffer. Both
169 * binary and text files can be read with this function. The caller is
170 * responsible for freeing the returned buffer with os_free().
172 char * os_readfile(const char *name, size_t *len);
175 * os_zalloc - Allocate and zero memory
176 * @size: Number of bytes to allocate
177 * Returns: Pointer to allocated and zeroed memory or %NULL on failure
179 * Caller is responsible for freeing the returned buffer with os_free().
181 void * os_zalloc(size_t size);
184 * os_calloc - Allocate and zero memory for an array
185 * @nmemb: Number of members in the array
186 * @size: Number of bytes in each member
187 * Returns: Pointer to allocated and zeroed memory or %NULL on failure
189 * This function can be used as a wrapper for os_zalloc(nmemb * size) when an
190 * allocation is used for an array. The main benefit over os_zalloc() is in
191 * having an extra check to catch integer overflows in multiplication.
193 * Caller is responsible for freeing the returned buffer with os_free().
195 static inline void * os_calloc(size_t nmemb, size_t size)
197 if (size && nmemb > (~(size_t) 0) / size)
199 return os_zalloc(nmemb * size);
204 * The following functions are wrapper for standard ANSI C or POSIX functions.
205 * By default, they are just defined to use the standard function name and no
206 * os_*.c implementation is needed for them. This avoids extra function calls
207 * by allowing the C pre-processor take care of the function name mapping.
209 * If the target system uses a C library that does not provide these functions,
210 * build_config.h can be used to define the wrappers to use a different
211 * function name. This can be done on function-by-function basis since the
212 * defines here are only used if build_config.h does not define the os_* name.
213 * If needed, os_*.c file can be used to implement the functions that are not
214 * included in the C library on the target system. Alternatively,
215 * OS_NO_C_LIB_DEFINES can be defined to skip all defines here in which case
216 * these functions need to be implemented in os_*.c file for the target system.
219 #ifdef OS_NO_C_LIB_DEFINES
222 * os_malloc - Allocate dynamic memory
223 * @size: Size of the buffer to allocate
224 * Returns: Allocated buffer or %NULL on failure
226 * Caller is responsible for freeing the returned buffer with os_free().
228 void * os_malloc(size_t size);
231 * os_realloc - Re-allocate dynamic memory
232 * @ptr: Old buffer from os_malloc() or os_realloc()
233 * @size: Size of the new buffer
234 * Returns: Allocated buffer or %NULL on failure
236 * Caller is responsible for freeing the returned buffer with os_free().
237 * If re-allocation fails, %NULL is returned and the original buffer (ptr) is
238 * not freed and caller is still responsible for freeing it.
240 void * os_realloc(void *ptr, size_t size);
243 * os_free - Free dynamic memory
244 * @ptr: Old buffer from os_malloc() or os_realloc(); can be %NULL
246 void os_free(void *ptr);
249 * os_memcpy - Copy memory area
252 * @n: Number of bytes to copy
255 * The memory areas src and dst must not overlap. os_memmove() can be used with
256 * overlapping memory.
258 void * os_memcpy(void *dest, const void *src, size_t n);
261 * os_memmove - Copy memory area
264 * @n: Number of bytes to copy
267 * The memory areas src and dst may overlap.
269 void * os_memmove(void *dest, const void *src, size_t n);
272 * os_memset - Fill memory with a constant byte
273 * @s: Memory area to be filled
275 * @n: Number of bytes started from s to fill with c
278 void * os_memset(void *s, int c, size_t n);
281 * os_memcmp - Compare memory areas
284 * @n: Maximum numbers of octets to compare
285 * Returns: An integer less than, equal to, or greater than zero if s1 is
286 * found to be less than, to match, or be greater than s2. Only first n
287 * characters will be compared.
289 int os_memcmp(const void *s1, const void *s2, size_t n);
292 * os_strdup - Duplicate a string
294 * Returns: Allocated buffer with the string copied into it or %NULL on failure
296 * Caller is responsible for freeing the returned buffer with os_free().
298 char * os_strdup(const char *s);
301 * os_strlen - Calculate the length of a string
302 * @s: '\0' terminated string
303 * Returns: Number of characters in s (not counting the '\0' terminator)
305 size_t os_strlen(const char *s);
308 * os_strcasecmp - Compare two strings ignoring case
311 * Returns: An integer less than, equal to, or greater than zero if s1 is
312 * found to be less than, to match, or be greatred than s2
314 int os_strcasecmp(const char *s1, const char *s2);
317 * os_strncasecmp - Compare two strings ignoring case
320 * @n: Maximum numbers of characters to compare
321 * Returns: An integer less than, equal to, or greater than zero if s1 is
322 * found to be less than, to match, or be greater than s2. Only first n
323 * characters will be compared.
325 int os_strncasecmp(const char *s1, const char *s2, size_t n);
328 * os_strchr - Locate the first occurrence of a character in string
330 * @c: Character to search for
331 * Returns: Pointer to the matched character or %NULL if not found
333 char * os_strchr(const char *s, int c);
336 * os_strrchr - Locate the last occurrence of a character in string
338 * @c: Character to search for
339 * Returns: Pointer to the matched character or %NULL if not found
341 char * os_strrchr(const char *s, int c);
344 * os_strcmp - Compare two strings
347 * Returns: An integer less than, equal to, or greater than zero if s1 is
348 * found to be less than, to match, or be greatred than s2
350 int os_strcmp(const char *s1, const char *s2);
353 * os_strncmp - Compare two strings
356 * @n: Maximum numbers of characters to compare
357 * Returns: An integer less than, equal to, or greater than zero if s1 is
358 * found to be less than, to match, or be greater than s2. Only first n
359 * characters will be compared.
361 int os_strncmp(const char *s1, const char *s2, size_t n);
364 * os_strncpy - Copy a string
367 * @n: Maximum number of characters to copy
370 char * os_strncpy(char *dest, const char *src, size_t n);
373 * os_strstr - Locate a substring
374 * @haystack: String (haystack) to search from
375 * @needle: Needle to search from haystack
376 * Returns: Pointer to the beginning of the substring or %NULL if not found
378 char * os_strstr(const char *haystack, const char *needle);
381 * os_snprintf - Print to a memory buffer
382 * @str: Memory buffer to print into
383 * @size: Maximum length of the str buffer
384 * @format: printf format
385 * Returns: Number of characters printed (not including trailing '\0').
387 * If the output buffer is truncated, number of characters which would have
388 * been written is returned. Since some C libraries return -1 in such a case,
389 * the caller must be prepared on that value, too, to indicate truncation.
391 * Note: Some C library implementations of snprintf() may not guarantee null
392 * termination in case the output is truncated. The OS wrapper function of
393 * os_snprintf() should provide this guarantee, i.e., to null terminate the
394 * output buffer if a C library version of the function is used and if that
395 * function does not guarantee null termination.
397 * If the target system does not include snprintf(), see, e.g.,
398 * http://www.ijs.si/software/snprintf/ for an example of a portable
399 * implementation of snprintf.
401 int os_snprintf(char *str, size_t size, const char *format, ...);
403 #else /* OS_NO_C_LIB_DEFINES */
406 void * os_malloc(size_t size);
407 void * os_realloc(void *ptr, size_t size);
408 void os_free(void *ptr);
409 char * os_strdup(const char *s);
410 #else /* WPA_TRACE */
412 #define os_malloc(s) malloc((s))
415 #define os_realloc(p, s) realloc((p), (s))
418 #define os_free(p) free((p))
422 #define os_strdup(s) _strdup(s)
424 #define os_strdup(s) strdup(s)
427 #endif /* WPA_TRACE */
430 #define os_memcpy(d, s, n) memcpy((d), (s), (n))
433 #define os_memmove(d, s, n) memmove((d), (s), (n))
436 #define os_memset(s, c, n) memset(s, c, n)
439 #define os_memcmp(s1, s2, n) memcmp((s1), (s2), (n))
443 #define os_strlen(s) strlen(s)
445 #ifndef os_strcasecmp
447 #define os_strcasecmp(s1, s2) _stricmp((s1), (s2))
449 #define os_strcasecmp(s1, s2) strcasecmp((s1), (s2))
452 #ifndef os_strncasecmp
454 #define os_strncasecmp(s1, s2, n) _strnicmp((s1), (s2), (n))
456 #define os_strncasecmp(s1, s2, n) strncasecmp((s1), (s2), (n))
460 #define os_strchr(s, c) strchr((s), (c))
463 #define os_strcmp(s1, s2) strcmp((s1), (s2))
466 #define os_strncmp(s1, s2, n) strncmp((s1), (s2), (n))
469 #define os_strncpy(d, s, n) strncpy((d), (s), (n))
472 #define os_strrchr(s, c) strrchr((s), (c))
475 #define os_strstr(h, n) strstr((h), (n))
480 #define os_snprintf _snprintf
482 #define os_snprintf snprintf
486 #endif /* OS_NO_C_LIB_DEFINES */
489 static inline void * os_realloc_array(void *ptr, size_t nmemb, size_t size)
491 if (size && nmemb > (~(size_t) 0) / size)
493 return os_realloc(ptr, nmemb * size);
498 * os_strlcpy - Copy a string with size bound and NUL-termination
501 * @siz: Size of the target buffer
502 * Returns: Total length of the target string (length of src) (not including
505 * This function matches in behavior with the strlcpy(3) function in OpenBSD.
507 size_t os_strlcpy(char *dest, const char *src, size_t siz);
510 #ifdef OS_REJECT_C_LIB_FUNCTIONS
511 #define malloc OS_DO_NOT_USE_malloc
512 #define realloc OS_DO_NOT_USE_realloc
513 #define free OS_DO_NOT_USE_free
514 #define memcpy OS_DO_NOT_USE_memcpy
515 #define memmove OS_DO_NOT_USE_memmove
516 #define memset OS_DO_NOT_USE_memset
517 #define memcmp OS_DO_NOT_USE_memcmp
519 #define strdup OS_DO_NOT_USE_strdup
520 #define strlen OS_DO_NOT_USE_strlen
521 #define strcasecmp OS_DO_NOT_USE_strcasecmp
522 #define strncasecmp OS_DO_NOT_USE_strncasecmp
524 #define strchr OS_DO_NOT_USE_strchr
526 #define strcmp OS_DO_NOT_USE_strcmp
528 #define strncmp OS_DO_NOT_USE_strncmp
530 #define strncpy OS_DO_NOT_USE_strncpy
531 #define strrchr OS_DO_NOT_USE_strrchr
532 #define strstr OS_DO_NOT_USE_strstr
534 #define snprintf OS_DO_NOT_USE_snprintf
536 #define strcpy OS_DO_NOT_USE_strcpy
537 #endif /* OS_REJECT_C_LIB_FUNCTIONS */