wpa_supplicant/hostapd / Internal implementation of OS specific functions More...
#include "includes.h"
#include "os.h"
Go to the source code of this file.
Functions | |
void | os_sleep (os_time_t sec, os_time_t usec) |
Sleep (sec, usec). | |
int | os_get_time (struct os_time *t) |
Get current time (sec, usec). | |
int | os_mktime (int year, int month, int day, int hour, int min, int sec, os_time_t *t) |
Convert broken-down time into seconds since 1970-01-01. | |
int | os_daemonize (const char *pid_file) |
Run in the background (detach from the controlling terminal). | |
void | os_daemonize_terminate (const char *pid_file) |
Stop running in the background (remove pid file). | |
int | os_get_random (unsigned char *buf, size_t len) |
Get cryptographically strong pseudo random data. | |
unsigned long | os_random (void) |
Get pseudo random value (not necessarily very strong). | |
char * | os_rel2abs_path (const char *rel_path) |
Get an absolute path for a file. | |
int | os_program_init (void) |
Program initialization (called at start). | |
void | os_program_deinit (void) |
Program deinitialization (called just before exit). | |
int | os_setenv (const char *name, const char *value, int overwrite) |
Set environment variable. | |
int | os_unsetenv (const char *name) |
Delete environent variable. | |
char * | os_readfile (const char *name, size_t *len) |
Read a file to an allocated memory buffer. | |
void * | os_zalloc (size_t size) |
Allocate and zero memory. | |
void * | os_malloc (size_t size) |
void * | os_realloc (void *ptr, size_t size) |
void | os_free (void *ptr) |
void * | os_memcpy (void *dest, const void *src, size_t n) |
void * | os_memmove (void *dest, const void *src, size_t n) |
void * | os_memset (void *s, int c, size_t n) |
int | os_memcmp (const void *s1, const void *s2, size_t n) |
char * | os_strdup (const char *s) |
size_t | os_strlen (const char *s) |
int | os_strcasecmp (const char *s1, const char *s2) |
int | os_strncasecmp (const char *s1, const char *s2, size_t n) |
char * | os_strchr (const char *s, int c) |
char * | os_strrchr (const char *s, int c) |
int | os_strcmp (const char *s1, const char *s2) |
int | os_strncmp (const char *s1, const char *s2, size_t n) |
char * | os_strncpy (char *dest, const char *src, size_t n) |
size_t | os_strlcpy (char *dest, const char *src, size_t siz) |
Copy a string with size bound and NUL-termination. | |
char * | os_strstr (const char *haystack, const char *needle) |
int | os_snprintf (char *str, size_t size, const char *format,...) |
wpa_supplicant/hostapd / Internal implementation of OS specific functions
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.
Alternatively, this software may be distributed under the terms of BSD license.
See README and COPYING for more details.
This file is an example of operating system specific wrapper functions. This version implements many of the functions internally, so it can be used to fill in missing functions from the target system C libraries.
Some of the functions are using standard C library calls in order to keep this file in working condition to allow the functions to be tested on a Linux target. Please note that OS_NO_C_LIB_DEFINES needs to be defined for this file to work correctly. Note that these implementations are only examples and are not optimized for speed.
Definition in file os_internal.c.
int os_daemonize | ( | const char * | pid_file | ) |
Run in the background (detach from the controlling terminal).
pid_file | File name to write the process ID to or NULL to skip this |
Definition at line 74 of file os_internal.c.
void os_daemonize_terminate | ( | const char * | pid_file | ) |
Stop running in the background (remove pid file).
pid_file | File name to write the process ID to or NULL to skip this |
Definition at line 93 of file os_internal.c.
int os_get_random | ( | unsigned char * | buf, | |
size_t | len | |||
) |
Get cryptographically strong pseudo random data.
buf | Buffer for pseudo random data | |
len | Length of the buffer |
Definition at line 100 of file os_internal.c.
int os_get_time | ( | struct os_time * | t | ) |
Get current time (sec, usec).
t | Pointer to buffer for the time |
Definition at line 40 of file os_internal.c.
int os_mktime | ( | int | year, | |
int | month, | |||
int | day, | |||
int | hour, | |||
int | min, | |||
int | sec, | |||
os_time_t * | t | |||
) |
Convert broken-down time into seconds since 1970-01-01.
year | Four digit year | |
month | Month (1 .. 12) | |
day | Day of month (1 .. 31) | |
hour | Hour (0 .. 23) | |
min | Minute (0 .. 59) | |
sec | Second (0 .. 60) | |
t | Buffer for returning calendar time representation (seconds since 1970-01-01 00:00:00) |
Note: The result is in seconds from Epoch, i.e., in UTC, not in local time which is used by POSIX mktime().
Definition at line 51 of file os_internal.c.
void os_program_deinit | ( | void | ) |
Program deinitialization (called just before exit).
This function is called just before a program exists. If there are any OS specific processing, e.g., freeing resourced allocated in os_program_init(), it should be done here. It is also acceptable for this function to do nothing.
Definition at line 169 of file os_internal.c.
int os_program_init | ( | void | ) |
Program initialization (called at start).
This function is called when a programs starts. If there are any OS specific processing that is needed, it can be placed here. It is also acceptable to just return 0 if not special processing is needed.
Definition at line 163 of file os_internal.c.
unsigned long os_random | ( | void | ) |
Get pseudo random value (not necessarily very strong).
Definition at line 118 of file os_internal.c.
char* os_readfile | ( | const char * | name, | |
size_t * | len | |||
) |
Read a file to an allocated memory buffer.
name | Name of the file to read | |
len | For returning the length of the allocated buffer |
This function allocates memory and reads the given file to this buffer. Both binary and text files can be read with this function. The caller is responsible for freeing the returned buffer with os_free().
Definition at line 191 of file os_internal.c.
char* os_rel2abs_path | ( | const char * | rel_path | ) |
Get an absolute path for a file.
rel_path | Relative path to a file |
This function tries to convert a relative path of a file to an absolute path in order for the file to be found even if current working directory has changed. The returned value is allocated and caller is responsible for freeing it. It is acceptable to just return the same path in an allocated buffer, e.g., return strdup(rel_path). This function is only used to find configuration files when os_daemonize() may have changed the current working directory and relative path would be pointing to a different location.
Definition at line 124 of file os_internal.c.
int os_setenv | ( | const char * | name, | |
const char * | value, | |||
int | overwrite | |||
) |
Set environment variable.
name | Name of the variable | |
value | Value to set to the variable | |
overwrite | Whether existing variable should be overwritten |
This function is only used for wpa_cli action scripts. OS wrapper does not need to implement this if such functionality is not needed.
Definition at line 174 of file os_internal.c.
void os_sleep | ( | os_time_t | sec, | |
os_time_t | usec | |||
) |
Sleep (sec, usec).
sec | Number of seconds to sleep | |
usec | Number of microseconds to sleep |
Definition at line 31 of file os_internal.c.
size_t os_strlcpy | ( | char * | dest, | |
const char * | src, | |||
size_t | siz | |||
) |
Copy a string with size bound and NUL-termination.
dest | Destination | |
src | Source | |
siz | Size of the target buffer |
This function matches in behavior with the strlcpy(3) function in OpenBSD.
Definition at line 414 of file os_internal.c.
int os_unsetenv | ( | const char * | name | ) |
Delete environent variable.
name | Name of the variable |
This function is only used for wpa_cli action scripts. OS wrapper does not need to implement this if such functionality is not needed.
Definition at line 180 of file os_internal.c.
void* os_zalloc | ( | size_t | size | ) |
Allocate and zero memory.
size | Number of bytes to allocate |
Caller is responsible for freeing the returned buffer with os_free().
Definition at line 217 of file os_internal.c.