os.h

Go to the documentation of this file.

/* $Id: os.h 3664 2011-07-19 03:42:28Z nanang $ */
/* 
 * Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 */
#ifndef __PJ_OS_H__
#define __PJ_OS_H__

#include <pj/types.h>

PJ_BEGIN_DECL

/* **************************************************************************/
typedef enum pj_sys_info_flag
{
    PJ_SYS_HAS_IOS_BG = 1

} pj_sys_info_flag;


typedef struct pj_sys_info
{
    pj_str_t    machine;

    pj_str_t    os_name;

    pj_uint32_t os_ver;

    pj_str_t    sdk_name;

    pj_uint32_t sdk_ver;

    pj_str_t    info;

    pj_uint32_t flags;

} pj_sys_info;


PJ_DECL(const pj_sys_info*) pj_get_sys_info(void);

/*
 * @}
 */

/* **************************************************************************/
typedef enum pj_thread_create_flags
{
    PJ_THREAD_SUSPENDED = 1
} pj_thread_create_flags;


typedef int (PJ_THREAD_FUNC pj_thread_proc)(void*);

#if !defined(PJ_THREAD_DESC_SIZE)
#   define PJ_THREAD_DESC_SIZE      (64)
#endif

typedef long pj_thread_desc[PJ_THREAD_DESC_SIZE];

PJ_DECL(pj_uint32_t) pj_getpid(void);

PJ_DECL(pj_status_t) pj_thread_create(  pj_pool_t *pool, 
                                        const char *thread_name,
                                        pj_thread_proc *proc, 
                                        void *arg,
                                        pj_size_t stack_size, 
                                        unsigned flags,
                                        pj_thread_t **thread );

PJ_DECL(pj_status_t) pj_thread_register ( const char *thread_name,
                                          pj_thread_desc desc,
                                          pj_thread_t **thread);

PJ_DECL(pj_bool_t) pj_thread_is_registered(void);


PJ_DECL(int) pj_thread_get_prio(pj_thread_t *thread);


PJ_DECL(pj_status_t) pj_thread_set_prio(pj_thread_t *thread,  int prio);

PJ_DECL(int) pj_thread_get_prio_min(pj_thread_t *thread);


PJ_DECL(int) pj_thread_get_prio_max(pj_thread_t *thread);


PJ_DECL(void*) pj_thread_get_os_handle(pj_thread_t *thread);

PJ_DECL(const char*) pj_thread_get_name(pj_thread_t *thread);

PJ_DECL(pj_status_t) pj_thread_resume(pj_thread_t *thread);

PJ_DECL(pj_thread_t*) pj_thread_this(void);

PJ_DECL(pj_status_t) pj_thread_join(pj_thread_t *thread);


PJ_DECL(pj_status_t) pj_thread_destroy(pj_thread_t *thread);


PJ_DECL(pj_status_t) pj_thread_sleep(unsigned msec);

#if defined(PJ_OS_HAS_CHECK_STACK) && PJ_OS_HAS_CHECK_STACK!=0

#  define PJ_CHECK_STACK() pj_thread_check_stack(__FILE__, __LINE__)

PJ_DECL(void) pj_thread_check_stack(const char *file, int line);

PJ_DECL(pj_uint32_t) pj_thread_get_stack_max_usage(pj_thread_t *thread);

PJ_DECL(pj_status_t) pj_thread_get_stack_info(pj_thread_t *thread,
                                              const char **file,
                                              int *line);
#else

#  define PJ_CHECK_STACK()

#  define pj_thread_get_stack_max_usage(thread)     0

#  define pj_thread_get_stack_info(thread,f,l)      (*(f)="",*(l)=0)
#endif  /* PJ_OS_HAS_CHECK_STACK */

/* **************************************************************************/
PJ_DECL(pj_bool_t) pj_symbianos_poll(int priority, int ms_timeout);


typedef struct pj_symbianos_params 
{
    void        *rsocketserv;
    
    void        *rconnection;
    
    void        *rhostresolver;
     
    void        *rhostresolver6;
     
} pj_symbianos_params;

PJ_DECL(pj_status_t) pj_symbianos_set_params(pj_symbianos_params *prm);

PJ_DECL(void) pj_symbianos_set_connection_status(pj_bool_t up);

/* **************************************************************************/
PJ_DECL(pj_status_t) pj_thread_local_alloc(long *index);

PJ_DECL(void) pj_thread_local_free(long index);

PJ_DECL(pj_status_t) pj_thread_local_set(long index, void *value);

PJ_DECL(void*) pj_thread_local_get(long index);


/* **************************************************************************/
PJ_DECL(pj_status_t) pj_atomic_create( pj_pool_t *pool, 
                                       pj_atomic_value_t initial,
                                       pj_atomic_t **atomic );

PJ_DECL(pj_status_t) pj_atomic_destroy( pj_atomic_t *atomic_var );

PJ_DECL(void) pj_atomic_set( pj_atomic_t *atomic_var, 
                             pj_atomic_value_t value);

PJ_DECL(pj_atomic_value_t) pj_atomic_get(pj_atomic_t *atomic_var);

PJ_DECL(void) pj_atomic_inc(pj_atomic_t *atomic_var);

PJ_DECL(pj_atomic_value_t) pj_atomic_inc_and_get(pj_atomic_t *atomic_var);

PJ_DECL(void) pj_atomic_dec(pj_atomic_t *atomic_var);

PJ_DECL(pj_atomic_value_t) pj_atomic_dec_and_get(pj_atomic_t *atomic_var);

PJ_DECL(void) pj_atomic_add( pj_atomic_t *atomic_var,
                             pj_atomic_value_t value);

PJ_DECL(pj_atomic_value_t) pj_atomic_add_and_get( pj_atomic_t *atomic_var,
                                                  pj_atomic_value_t value);

/* **************************************************************************/
typedef enum pj_mutex_type_e
{
    PJ_MUTEX_DEFAULT,
    PJ_MUTEX_SIMPLE,
    PJ_MUTEX_RECURSE
} pj_mutex_type_e;


PJ_DECL(pj_status_t) pj_mutex_create(pj_pool_t *pool, 
                                     const char *name,
                                     int type, 
                                     pj_mutex_t **mutex);

PJ_DECL(pj_status_t) pj_mutex_create_simple( pj_pool_t *pool, const char *name,
                                             pj_mutex_t **mutex );

PJ_DECL(pj_status_t) pj_mutex_create_recursive( pj_pool_t *pool,
                                                const char *name,
                                                pj_mutex_t **mutex );

PJ_DECL(pj_status_t) pj_mutex_lock(pj_mutex_t *mutex);

PJ_DECL(pj_status_t) pj_mutex_unlock(pj_mutex_t *mutex);

PJ_DECL(pj_status_t) pj_mutex_trylock(pj_mutex_t *mutex);

PJ_DECL(pj_status_t) pj_mutex_destroy(pj_mutex_t *mutex);

PJ_DECL(pj_bool_t) pj_mutex_is_locked(pj_mutex_t *mutex);

/* **************************************************************************/
typedef struct pj_rwmutex_t pj_rwmutex_t;

PJ_DECL(pj_status_t) pj_rwmutex_create(pj_pool_t *pool, const char *name,
                                       pj_rwmutex_t **mutex);

PJ_DECL(pj_status_t) pj_rwmutex_lock_read(pj_rwmutex_t *mutex);

PJ_DECL(pj_status_t) pj_rwmutex_lock_write(pj_rwmutex_t *mutex);

PJ_DECL(pj_status_t) pj_rwmutex_unlock_read(pj_rwmutex_t *mutex);

PJ_DECL(pj_status_t) pj_rwmutex_unlock_write(pj_rwmutex_t *mutex);

PJ_DECL(pj_status_t) pj_rwmutex_destroy(pj_rwmutex_t *mutex);


/* **************************************************************************/
PJ_DECL(void) pj_enter_critical_section(void);

PJ_DECL(void) pj_leave_critical_section(void);

/* **************************************************************************/
#if defined(PJ_HAS_SEMAPHORE) && PJ_HAS_SEMAPHORE != 0

PJ_DECL(pj_status_t) pj_sem_create( pj_pool_t *pool, 
                                    const char *name,
                                    unsigned initial, 
                                    unsigned max,
                                    pj_sem_t **sem);

PJ_DECL(pj_status_t) pj_sem_wait(pj_sem_t *sem);

PJ_DECL(pj_status_t) pj_sem_trywait(pj_sem_t *sem);

PJ_DECL(pj_status_t) pj_sem_post(pj_sem_t *sem);

PJ_DECL(pj_status_t) pj_sem_destroy(pj_sem_t *sem);

#endif  /* PJ_HAS_SEMAPHORE */


/* **************************************************************************/
#if defined(PJ_HAS_EVENT_OBJ) && PJ_HAS_EVENT_OBJ != 0

PJ_DECL(pj_status_t) pj_event_create(pj_pool_t *pool, const char *name,
                                     pj_bool_t manual_reset, pj_bool_t initial,
                                     pj_event_t **event);

PJ_DECL(pj_status_t) pj_event_wait(pj_event_t *event);

PJ_DECL(pj_status_t) pj_event_trywait(pj_event_t *event);

PJ_DECL(pj_status_t) pj_event_set(pj_event_t *event);

PJ_DECL(pj_status_t) pj_event_pulse(pj_event_t *event);

PJ_DECL(pj_status_t) pj_event_reset(pj_event_t *event);

PJ_DECL(pj_status_t) pj_event_destroy(pj_event_t *event);

#endif  /* PJ_HAS_EVENT_OBJ */

/* **************************************************************************/
PJ_DECL(pj_status_t) pj_gettimeofday(pj_time_val *tv);


PJ_DECL(pj_status_t) pj_time_decode(const pj_time_val *tv, pj_parsed_time *pt);

PJ_DECL(pj_status_t) pj_time_encode(const pj_parsed_time *pt, pj_time_val *tv);

PJ_DECL(pj_status_t) pj_time_local_to_gmt(pj_time_val *tv);

PJ_DECL(pj_status_t) pj_time_gmt_to_local(pj_time_val *tv);

/* **************************************************************************/
#if defined(PJ_TERM_HAS_COLOR) && PJ_TERM_HAS_COLOR != 0

PJ_DECL(pj_status_t) pj_term_set_color(pj_color_t color);

PJ_DECL(pj_color_t) pj_term_get_color(void);

#endif  /* PJ_TERM_HAS_COLOR */

/* **************************************************************************/
/*
 * High resolution timer.
 */
#if defined(PJ_HAS_HIGH_RES_TIMER) && PJ_HAS_HIGH_RES_TIMER != 0

PJ_DECL(pj_status_t) pj_gettickcount(pj_time_val *tv);

PJ_DECL(pj_status_t) pj_get_timestamp(pj_timestamp *ts);

PJ_DECL(pj_status_t) pj_get_timestamp_freq(pj_timestamp *freq);

PJ_INLINE(void) pj_set_timestamp32(pj_timestamp *t, pj_uint32_t hi,
                                   pj_uint32_t lo)
{
    t->u32.hi = hi;
    t->u32.lo = lo;
}


PJ_INLINE(int) pj_cmp_timestamp(const pj_timestamp *t1, const pj_timestamp *t2)
{
#if PJ_HAS_INT64
    if (t1->u64 < t2->u64)
        return -1;
    else if (t1->u64 > t2->u64)
        return 1;
    else
        return 0;
#else
    if (t1->u32.hi < t2->u32.hi ||
        (t1->u32.hi == t2->u32.hi && t1->u32.lo < t2->u32.lo))
        return -1;
    else if (t1->u32.hi > t2->u32.hi ||
             (t1->u32.hi == t2->u32.hi && t1->u32.lo > t2->u32.lo))
        return 1;
    else
        return 0;
#endif
}


PJ_INLINE(void) pj_add_timestamp(pj_timestamp *t1, const pj_timestamp *t2)
{
#if PJ_HAS_INT64
    t1->u64 += t2->u64;
#else
    pj_uint32_t old = t1->u32.lo;
    t1->u32.hi += t2->u32.hi;
    t1->u32.lo += t2->u32.lo;
    if (t1->u32.lo < old)
        ++t1->u32.hi;
#endif
}

PJ_INLINE(void) pj_add_timestamp32(pj_timestamp *t1, pj_uint32_t t2)
{
#if PJ_HAS_INT64
    t1->u64 += t2;
#else
    pj_uint32_t old = t1->u32.lo;
    t1->u32.lo += t2;
    if (t1->u32.lo < old)
        ++t1->u32.hi;
#endif
}

PJ_INLINE(void) pj_sub_timestamp(pj_timestamp *t1, const pj_timestamp *t2)
{
#if PJ_HAS_INT64
    t1->u64 -= t2->u64;
#else
    t1->u32.hi -= t2->u32.hi;
    if (t1->u32.lo >= t2->u32.lo)
        t1->u32.lo -= t2->u32.lo;
    else {
        t1->u32.lo -= t2->u32.lo;
        --t1->u32.hi;
    }
#endif
}

PJ_INLINE(void) pj_sub_timestamp32(pj_timestamp *t1, pj_uint32_t t2)
{
#if PJ_HAS_INT64
    t1->u64 -= t2;
#else
    if (t1->u32.lo >= t2)
        t1->u32.lo -= t2;
    else {
        t1->u32.lo -= t2;
        --t1->u32.hi;
    }
#endif
}

PJ_INLINE(pj_int32_t) pj_timestamp_diff32(const pj_timestamp *t1,
                                          const pj_timestamp *t2)
{
    /* Be careful with the signess (I think!) */
#if PJ_HAS_INT64
    pj_int64_t diff = t2->u64 - t1->u64;
    return (pj_int32_t) diff;
#else
    pj_int32 diff = t2->u32.lo - t1->u32.lo;
    return diff;
#endif
}


PJ_DECL(pj_time_val) pj_elapsed_time( const pj_timestamp *start,
                                      const pj_timestamp *stop );

PJ_DECL(pj_uint32_t) pj_elapsed_msec( const pj_timestamp *start,
                                      const pj_timestamp *stop );

PJ_DECL(pj_uint64_t) pj_elapsed_msec64(const pj_timestamp *start,
                                       const pj_timestamp *stop );

PJ_DECL(pj_uint32_t) pj_elapsed_usec( const pj_timestamp *start,
                                      const pj_timestamp *stop );

PJ_DECL(pj_uint32_t) pj_elapsed_nanosec( const pj_timestamp *start,
                                         const pj_timestamp *stop );

PJ_DECL(pj_uint32_t) pj_elapsed_cycle( const pj_timestamp *start,
                                       const pj_timestamp *stop );


#endif  /* PJ_HAS_HIGH_RES_TIMER */

/* **************************************************************************/
/* Type for main function. */
typedef int (*pj_main_func_ptr)(int argc, char *argv[]);

int pj_run_app(pj_main_func_ptr main_func, int argc, char *argv[],
               unsigned flags);

/* **************************************************************************/
pj_status_t pj_thread_init(void);


PJ_END_DECL

#endif  /* __PJ_OS_H__ */