os.h

Go to the documentation of this file.

#ifndef OS_H
#define OS_H

typedef long os_time_t;

void os_sleep(os_time_t sec, os_time_t usec);

struct os_time {
        os_time_t sec;
        os_time_t usec;
};

struct os_reltime {
        os_time_t sec;
        os_time_t usec;
};

int os_get_time(struct os_time *t);

int os_get_reltime(struct os_reltime *t);


/* Helpers for handling struct os_time */

static inline int os_time_before(struct os_time *a, struct os_time *b)
{
        return (a->sec < b->sec) ||
               (a->sec == b->sec && a->usec < b->usec);
}


static inline void os_time_sub(struct os_time *a, struct os_time *b,
                               struct os_time *res)
{
        res->sec = a->sec - b->sec;
        res->usec = a->usec - b->usec;
        if (res->usec < 0) {
                res->sec--;
                res->usec += 1000000;
        }
}


/* Helpers for handling struct os_reltime */

static inline int os_reltime_before(struct os_reltime *a,
                                    struct os_reltime *b)
{
        return (a->sec < b->sec) ||
               (a->sec == b->sec && a->usec < b->usec);
}


static inline void os_reltime_sub(struct os_reltime *a, struct os_reltime *b,
                                  struct os_reltime *res)
{
        res->sec = a->sec - b->sec;
        res->usec = a->usec - b->usec;
        if (res->usec < 0) {
                res->sec--;
                res->usec += 1000000;
        }
}


static inline void os_reltime_age(struct os_reltime *start,
                                  struct os_reltime *age)
{
        struct os_reltime now;

        os_get_reltime(&now);
        os_reltime_sub(&now, start, age);
}


static inline int os_reltime_expired(struct os_reltime *now,
                                     struct os_reltime *ts,
                                     os_time_t timeout_secs)
{
        struct os_reltime age;

        os_reltime_sub(now, ts, &age);
        return (age.sec > timeout_secs) ||
               (age.sec == timeout_secs && age.usec > 0);
}


static inline int os_reltime_initialized(struct os_reltime *t)
{
        return t->sec != 0 || t->usec != 0;
}


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

struct os_tm {
        int sec; /* 0..59 or 60 for leap seconds */
        int min; /* 0..59 */
        int hour; /* 0..23 */
        int day; /* 1..31 */
        int month; /* 1..12 */
        int year; /* Four digit year */
};

int os_gmtime(os_time_t t, struct os_tm *tm);

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);

unsigned long os_random(void);

char * os_rel2abs_path(const char *rel_path);

int os_program_init(void);

void os_program_deinit(void);

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

int os_unsetenv(const char *name);

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

int os_file_exists(const char *fname);

int os_fdatasync(FILE *stream);

void * os_zalloc(size_t size);

static inline void * os_calloc(size_t nmemb, size_t size)
{
        if (size && nmemb > (~(size_t) 0) / size)
                return NULL;
        return os_zalloc(nmemb * size);
}


/*
 * The following functions are wrapper for standard ANSI C or POSIX functions.
 * By default, they are just defined to use the standard function name and no
 * os_*.c implementation is needed for them. This avoids extra function calls
 * by allowing the C pre-processor take care of the function name mapping.
 *
 * If the target system uses a C library that does not provide these functions,
 * build_config.h can be used to define the wrappers to use a different
 * function name. This can be done on function-by-function basis since the
 * defines here are only used if build_config.h does not define the os_* name.
 * If needed, os_*.c file can be used to implement the functions that are not
 * included in the C library on the target system. Alternatively,
 * OS_NO_C_LIB_DEFINES can be defined to skip all defines here in which case
 * these functions need to be implemented in os_*.c file for the target system.
 */

#ifdef OS_NO_C_LIB_DEFINES

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_strstr(const char *haystack, const char *needle);

int os_snprintf(char *str, size_t size, const char *format, ...);

#else /* OS_NO_C_LIB_DEFINES */

#ifdef WPA_TRACE
void * os_malloc(size_t size);
void * os_realloc(void *ptr, size_t size);
void os_free(void *ptr);
char * os_strdup(const char *s);
#else /* WPA_TRACE */
#ifndef os_malloc
#define os_malloc(s) malloc((s))
#endif
#ifndef os_realloc
#define os_realloc(p, s) realloc((p), (s))
#endif
#ifndef os_free
#define os_free(p) free((p))
#endif
#ifndef os_strdup
#ifdef _MSC_VER
#define os_strdup(s) _strdup(s)
#else
#define os_strdup(s) strdup(s)
#endif
#endif
#endif /* WPA_TRACE */

#ifndef os_memcpy
#define os_memcpy(d, s, n) memcpy((d), (s), (n))
#endif
#ifndef os_memmove
#define os_memmove(d, s, n) memmove((d), (s), (n))
#endif
#ifndef os_memset
#define os_memset(s, c, n) memset(s, c, n)
#endif
#ifndef os_memcmp
#define os_memcmp(s1, s2, n) memcmp((s1), (s2), (n))
#endif

#ifndef os_strlen
#define os_strlen(s) strlen(s)
#endif
#ifndef os_strcasecmp
#ifdef _MSC_VER
#define os_strcasecmp(s1, s2) _stricmp((s1), (s2))
#else
#define os_strcasecmp(s1, s2) strcasecmp((s1), (s2))
#endif
#endif
#ifndef os_strncasecmp
#ifdef _MSC_VER
#define os_strncasecmp(s1, s2, n) _strnicmp((s1), (s2), (n))
#else
#define os_strncasecmp(s1, s2, n) strncasecmp((s1), (s2), (n))
#endif
#endif
#ifndef os_strchr
#define os_strchr(s, c) strchr((s), (c))
#endif
#ifndef os_strcmp
#define os_strcmp(s1, s2) strcmp((s1), (s2))
#endif
#ifndef os_strncmp
#define os_strncmp(s1, s2, n) strncmp((s1), (s2), (n))
#endif
#ifndef os_strrchr
#define os_strrchr(s, c) strrchr((s), (c))
#endif
#ifndef os_strstr
#define os_strstr(h, n) strstr((h), (n))
#endif

#ifndef os_snprintf
#ifdef _MSC_VER
#define os_snprintf _snprintf
#else
#define os_snprintf snprintf
#endif
#endif

#endif /* OS_NO_C_LIB_DEFINES */


static inline int os_snprintf_error(size_t size, int res)
{
        return res < 0 || (unsigned int) res >= size;
}


static inline void * os_realloc_array(void *ptr, size_t nmemb, size_t size)
{
        if (size && nmemb > (~(size_t) 0) / size)
                return NULL;
        return os_realloc(ptr, nmemb * size);
}

static inline void os_remove_in_array(void *ptr, size_t nmemb, size_t size,
                                      size_t idx)
{
        if (idx < nmemb - 1)
                os_memmove(((unsigned char *) ptr) + idx * size,
                           ((unsigned char *) ptr) + (idx + 1) * size,
                           (nmemb - idx - 1) * size);
}

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

int os_memcmp_const(const void *a, const void *b, size_t len);

int os_exec(const char *program, const char *arg, int wait_completion);


#ifdef OS_REJECT_C_LIB_FUNCTIONS
#define malloc OS_DO_NOT_USE_malloc
#define realloc OS_DO_NOT_USE_realloc
#define free OS_DO_NOT_USE_free
#define memcpy OS_DO_NOT_USE_memcpy
#define memmove OS_DO_NOT_USE_memmove
#define memset OS_DO_NOT_USE_memset
#define memcmp OS_DO_NOT_USE_memcmp
#undef strdup
#define strdup OS_DO_NOT_USE_strdup
#define strlen OS_DO_NOT_USE_strlen
#define strcasecmp OS_DO_NOT_USE_strcasecmp
#define strncasecmp OS_DO_NOT_USE_strncasecmp
#undef strchr
#define strchr OS_DO_NOT_USE_strchr
#undef strcmp
#define strcmp OS_DO_NOT_USE_strcmp
#undef strncmp
#define strncmp OS_DO_NOT_USE_strncmp
#undef strncpy
#define strncpy OS_DO_NOT_USE_strncpy
#define strrchr OS_DO_NOT_USE_strrchr
#define strstr OS_DO_NOT_USE_strstr
#undef snprintf
#define snprintf OS_DO_NOT_USE_snprintf

#define strcpy OS_DO_NOT_USE_strcpy
#endif /* OS_REJECT_C_LIB_FUNCTIONS */


#if defined(WPA_TRACE_BFD) && defined(CONFIG_TESTING_OPTIONS)
#define TEST_FAIL() testing_test_fail()
int testing_test_fail(void);
#else
#define TEST_FAIL() 0
#endif

#endif /* OS_H */