/*

 *  Copyright (c) 2009 Nokia Corporation

 *  All rights reserved.

 * 

 *  Redistribution and use in source and binary forms, with or without

 *  modification, are permitted provided that the following conditions are

 *  met:

 * 

 *  * Redistributions of source code must retain the above copyright

 *    notice, this list of conditions and the following disclaimer.

 *  * Redistributions in binary form must reproduce the above copyright

 *    notice, this list of conditions and the following disclaimer in the

 *    documentation and/or other materials provided with the distribution.

 *  * Neither the name of the Nokia Corporation nor the names of its

 *    contributors may be used to endorse or promote products derived from

 *    this software without specific prior written permission.

 * 

 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS

 *  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED

 *  TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A

 *  PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER

 *  OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,

 *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,

 *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR

 *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF

 *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING

 *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

 *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 *

 * Author(s): Mikko Hurskainen, Ville Kankainen

 */

#ifndef __PLATFORM_H__

#define __PLATFORM_H__

#include "utils.h" /* some useful macros, such as h_assert and byteswapping */

#ifdef HAVE_STRING_H

#include <string.h> /* for memset and memcpy */

#endif

#ifdef HAVE_STDLIB_H

#include <stdlib.h> /* for size_t */

#else

#ifndef _SIZE_T_DECLARED

typedef unsigned int size_t;

#endif

#endif

#include <time.h> /* for time_t */

/* Declarations */

struct nota_lock;

typedef struct nota_lock nota_lock_t;

struct nota_thread;

typedef struct nota_thread nota_thread_t;

struct nota_semaphore;

typedef struct nota_semaphore nota_semaphore_t;

/*

 * for now these are macros... are there any platforms that

 * do not support these?

 */

#ifndef nota_memset

#define nota_memset(x,y,z)    memset((x),(y),(z))

#endif

#ifndef nota_memcpy

#define nota_memcpy(x,y,z)    memcpy((x),(y),(z))

#endif

/* Function pointer declaration */

typedef void* (*nota_thread_func)(void* arg);

#ifdef __cplusplus

extern "C" {

#endif

  /* Functions */

  /* Allocates a new lock */

  int nota_lock_alloc(nota_lock_t** lock);

  /* Frees a lock */

  int nota_lock_free(nota_lock_t** lock);

  /* Acquires the lock (exclusivity). Blocks if the lock is not free */

  int nota_lock_get(nota_lock_t* lock);

  /* Releases the lock */

  int nota_lock_release(nota_lock_t* lock);

  /* Creates a thread */

  int nota_thread_create(nota_thread_t** thread, nota_thread_func func, void* arg);

  /* Joins a thread. Blocks until other thread exits */

  int nota_thread_join(nota_thread_t** thread);

  /* Allocates a semaphore with initial count value */

  int nota_semaphore_alloc(nota_semaphore_t** semaphore, int initial_value);

  /* Frees a semaphore */

  int nota_semaphore_free(nota_semaphore_t** semaphore);

  /* Increments semaphore */

  int nota_semaphore_up(nota_semaphore_t* semaphore);

  /* Decrements the semaphore. If the count is zero, will block */

  int nota_semaphore_down(nota_semaphore_t* semaphore);

  /* Thread sleep for milliseconds */

  int nota_sleep_msec(unsigned int milliseconds);

  /* Thread sleep for milliseconds */

  int nota_sleep_usec(unsigned int microseconds);

  /* Gets current time in seconds */

  time_t nota_get_time_in_sec(void);

  /* Allocates memory */

  void* nota_malloc(size_t size);

  /* Reallocates memory */

  void* nota_mrealloc(void* ptr, size_t new_size);

  /* frees memory */

  void nota_free(void* ptr);

  /* sets errno for H_IF api */

  void h_if_errno_set(int error_status);

/* BELOW: remove these from l_in, use the ones above instead */

#include <pthread.h>

typedef pthread_mutex_t llock_t;

typedef pthread_cond_t lcond_t;

#define llock(lock)            pthread_mutex_lock(lock)

#define lunlock(lock)          pthread_mutex_unlock(lock)

#define lcond_broadcast(cond)  pthread_cond_broadcast(cond)

#define lcond_wait(cond, lock) pthread_cond_wait(cond, lock)

#define llock_init(lock)       pthread_mutex_init(lock, NULL)

#define llock_destroy(lock)    pthread_mutex_destroy(lock)

#define lcond_init(cond)       pthread_cond_init(cond, NULL)

#define lcond_destroy(cond)    pthread_cond_destroy(cond)

/*

 * Unhandled:

 *   clock_gettime(&ts)

 *   getenv

 */

#ifdef __cplusplus

};

#endif

#endif /*__PLATFORM_H__*/