os.h File Reference

This graph shows which files directly or indirectly include this file:

Classes
struct	os_time
Defines
#define	os_time_before(a, b)
#define	os_time_sub(a, b, res)
Typedefs
typedef long	os_time_t
Functions
int	os_daemonize (const char *pid_file)
void	os_daemonize_terminate (const char *pid_file)
int	os_get_random (unsigned char *buf, size_t len)
int	os_get_time (struct os_time *t)
int	os_mktime (int year, int month, int day, int hour, int min, int sec, os_time_t *t)
void	os_program_deinit (void)
int	os_program_init (void)
unsigned long	os_random (void)
char *	os_rel2abs_path (const char *rel_path)
void	os_sleep (os_time_t sec, os_time_t usec)
: Name of the variable
os_unsetenv - Delete environent variable Returns: 0 on success, -1 on error This function is only used for wpa_cli action scripts. OS wrapper does not need to implement this if such functionality is not needed.
int	os_setenv (const char name, const char value, int overwrite)
int	os_unsetenv (const char *name)
: Name of the file to read
os_readfile - Read a file to an allocated memory buffer : For returning the length of the allocated buffer Returns: Pointer to the allocated buffer or NULL on failure 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().
#define	os_free(p) free((p))
#define	os_malloc(s) malloc((s))
#define	os_memcmp(s1, s2, n) memcmp((s1), (s2), (n))
#define	os_memcpy(d, s, n) memcpy((d), (s), (n))
#define	os_memmove(d, s, n) memmove((d), (s), (n))
#define	os_memset(s, c, n) memset(s, c, n)
#define	os_realloc(p, s) realloc((p), (s))
#define	os_snprintf snprintf
#define	os_strcasecmp(s1, s2) strcasecmp((s1), (s2))
#define	os_strchr(s, c) strchr((s), (c))
#define	os_strcmp(s1, s2) strcmp((s1), (s2))
#define	os_strdup(s) strdup(s)
#define	os_strlen(s) strlen(s)
#define	os_strncasecmp(s1, s2, n) strncasecmp((s1), (s2), (n))
#define	os_strncmp(s1, s2, n) strncmp((s1), (s2), (n))
#define	os_strncpy(d, s, n) strncpy((d), (s), (n))
#define	os_strrchr(s, c) strrchr((s), (c))
#define	os_strstr(h, n) strstr((h), (n))
char *	os_readfile (const char name, size_t len)
size_t	os_strlcpy (char dest, const char src, size_t siz)
void *	os_zalloc (size_t size)

Define Documentation

#define os_free ( p ) free((p))

Definition at line 395 of file os.h.

#define os_malloc ( s ) malloc((s))

Definition at line 389 of file os.h.

#define os_memcmp	(	s1,
		s2,
		n	)	memcmp((s1), (s2), (n))

Definition at line 416 of file os.h.

#define os_memcpy	(	d,
		s,
		n	)	memcpy((d), (s), (n))

Definition at line 407 of file os.h.

#define os_memmove	(	d,
		s,
		n	)	memmove((d), (s), (n))

Definition at line 410 of file os.h.

#define os_memset	(	s,
		c,
		n	)	memset(s, c, n)

Definition at line 413 of file os.h.

#define os_realloc	(	p,
		s		)	realloc((p), (s))

Definition at line 392 of file os.h.

#define os_snprintf snprintf

Definition at line 459 of file os.h.

#define os_strcasecmp	(	s1,
		s2		)	strcasecmp((s1), (s2))

Definition at line 426 of file os.h.

#define os_strchr	(	s,
		c		)	strchr((s), (c))

Definition at line 437 of file os.h.

#define os_strcmp	(	s1,
		s2		)	strcmp((s1), (s2))

Definition at line 440 of file os.h.

#define os_strdup ( s ) strdup(s)

Definition at line 401 of file os.h.

#define os_strlen ( s ) strlen(s)

Definition at line 420 of file os.h.

#define os_strncasecmp	(	s1,
		s2,
		n	)	strncasecmp((s1), (s2), (n))

Definition at line 433 of file os.h.

#define os_strncmp	(	s1,
		s2,
		n	)	strncmp((s1), (s2), (n))

Definition at line 443 of file os.h.

#define os_strncpy	(	d,
		s,
		n	)	strncpy((d), (s), (n))

Definition at line 446 of file os.h.

#define os_strrchr	(	s,
		c		)	strrchr((s), (c))

Definition at line 449 of file os.h.

#define os_strstr	(	h,
		n		)	strstr((h), (n))

Definition at line 452 of file os.h.

#define os_time_before	(	a,
		b		)

Value:

((a)->sec < (b)->sec || \
         ((a)->sec == (b)->sec && (a)->usec < (b)->usec))

Definition at line 42 of file os.h.

#define os_time_sub	(	a,
		b,
		res	)

Value:

do { \
        (res)->sec = (a)->sec - (b)->sec; \
        (res)->usec = (a)->usec - (b)->usec; \
        if ((res)->usec < 0) { \
                (res)->sec--; \
                (res)->usec += 1000000; \
        } \
} while (0)

Definition at line 46 of file os.h.

Typedef Documentation

typedef long os_time_t

Definition at line 18 of file os.h.

Function Documentation

int os_daemonize ( const char * pid_file )

os_daemonize - Run in the background (detach from the controlling terminal) : File name to write the process ID to or NULL to skip this Returns: 0 on success, -1 on failure

Definition at line 73 of file os_internal.c.

void os_daemonize_terminate ( const char * pid_file )

os_daemonize_terminate - Stop running in the background (remove pid file) : File name to write the process ID to or NULL to skip this

Definition at line 92 of file os_internal.c.

int os_get_random	(	unsigned char *	buf,
		size_t	len
	)

os_get_random - Get cryptographically strong pseudo random data : Buffer for pseudo random data : Length of the buffer Returns: 0 on success, -1 on failure

Definition at line 99 of file os_internal.c.

int os_get_time ( struct os_time * t )

os_get_time - Get current time (sec, usec) : Pointer to buffer for the time Returns: 0 on success, -1 on failure

Definition at line 39 of file os_internal.c.

int os_mktime	(	int	year,
		int	month,
		int	day,
		int	hour,
		int	min,
		int	sec,
		os_time_t *	t
	)

os_mktime - Convert broken-down time into seconds since 1970-01-01 : Four digit year : Month (1 .. 12) : Day of month (1 .. 31) : Hour (0 .. 23) : Minute (0 .. 59) : Second (0 .. 60) : Buffer for returning calendar time representation (seconds since 1970-01-01 00:00:00) Returns: 0 on success, -1 on failure

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 50 of file os_internal.c.

void os_program_deinit ( void )

os_program_deinit - 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 168 of file os_internal.c.

int os_program_init ( void )

os_program_init - Program initialization (called at start) Returns: 0 on success, -1 on failure

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 162 of file os_internal.c.

unsigned long os_random ( void )

os_random - Get pseudo random value (not necessarily very strong) Returns: Pseudo random value

Definition at line 117 of file os_internal.c.

char* os_readfile	(	const char *	name,
		size_t *	len
	)

Definition at line 190 of file os_internal.c.

char* os_rel2abs_path ( const char * rel_path )

os_rel2abs_path - Get an absolute path for a file : Relative path to a file Returns: Absolute path for the file or NULL on failure

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 123 of file os_internal.c.

int os_setenv	(	const char *	name,
		const char *	value,
		int	overwrite
	)

Definition at line 173 of file os_internal.c.

void os_sleep	(	os_time_t	sec,
		os_time_t	usec
	)

os_sleep - Sleep (sec, usec) : Number of seconds to sleep : Number of microseconds to sleep

Definition at line 30 of file os_internal.c.

size_t os_strlcpy	(	char *	dest,
		const char *	src,
		size_t	siz
	)

os_strlcpy - Copy a string with size bound and NUL-termination : Destination : Source : Size of the target buffer Returns: Total length of the target string (length of src) (not including NUL-termination)

This function matches in behavior with the strlcpy(3) function in OpenBSD.

Definition at line 418 of file os_internal.c.

int os_unsetenv ( const char * name )

Definition at line 179 of file os_internal.c.

void* os_zalloc ( size_t size )

os_zalloc - Allocate and zero memory : Number of bytes to allocate Returns: Pointer to allocated and zeroed memory or NULL on failure

Caller is responsible for freeing the returned buffer with os_free().

Definition at line 221 of file os_internal.c.

os.h File Reference

Classes

Defines

Typedefs

Functions

: Name of the file to read

Define Documentation

Typedef Documentation

Function Documentation