includes/hlx/api.h

Go to the documentation of this file.

/*
** Copyright 2009-2011, helixis.org
** 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 helixis.org 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 HOLDER 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.
*/

#ifndef __HLX_API_H__
# define __HLX_API_H__

#ifdef __cplusplus
extern "C"      {
#endif

/*
** TYPES
*/

typedef void*                   (*hlx_malloc_entry_addr)(unsigned int);
typedef void                    (*hlx_free_entry_addr)(void *);
typedef void*                   (*hlx_aligned_malloc_entry_addr)(unsigned int size, unsigned int align);
typedef void                    (*hlx_aligned_free_entry_addr)(void *);
typedef atom_t          (*hlx_atomic_incr_entry_addr)(atom_t *);
typedef atom_t                  (*hlx_atomic_decr_entry_addr)(atom_t *);
typedef atom_t                  (*hlx_atomic_cas_entry_addr)(volatile atom_t* dest, atom_t exchange, atom_t compare);
typedef unsigned char   (*hlx_atomic_dcas_entry_addr)(volatile atom_t *dest, atom_t* exchange, atom_t* compare);
typedef unsigned int    (*hlx_get_cpu_count_entry_addr)(void);
typedef void*                   (*hlx_memcpy_entry_addr)(void*, const void*, unsigned int);

/* Thread API */

typedef struct _hlx_thread           hlx_thread;
typedef void                         (*hlx_thread_func)(hlx_thread*, void*);

typedef struct _hlx_thread_param hlx_thread_param;
struct         _hlx_thread_param
{
        hlx_thread*     thread;
        void*           data;
};

typedef enum
{
        HLX_THREAD_PAUSED = 0,
        HLX_THREAD_LOCKED = 1,
        HLX_THREAD_RUNNING = 2
}       hlx_thread_status;

struct _hlx_thread
{
        hlx_thread_func thread_func;
        hlx_thread_param param;
        hlx_thread_status status;
        void  *user1;
        void  *user2;
};

typedef void (*hlx_thread_construct)(hlx_thread *);
typedef void (*hlx_thread_destruct)(hlx_thread *);
typedef void (*hlx_thread_execute)(hlx_thread *, hlx_thread_func, void *);
typedef void (*hlx_thread_suspend)(hlx_thread *);
typedef void (*hlx_thread_resume)(hlx_thread *);
typedef void (*hlx_thread_wait_for)(hlx_thread *);
typedef void (*hlx_thread_pause_if_needed)(hlx_thread *);
typedef void (*hlx_thread_yield)(void);

typedef struct
{
        hlx_thread_construct thread_construct;
        hlx_thread_destruct thread_destruct;
        hlx_thread_execute thread_execute;
        hlx_thread_suspend thread_suspend;
        hlx_thread_resume thread_resume;
        hlx_thread_wait_for thread_wait_for;
        hlx_thread_pause_if_needed thread_pause_if_needed;
        hlx_thread_yield thread_yield;
}    hlx_thread_api;

/* Helixis core API */
typedef struct
{
        hlx_malloc_entry_addr           malloc_entry;
        hlx_free_entry_addr             free_entry;
        /* PARALLEL THREADING only */
        hlx_aligned_malloc_entry_addr   aligned_malloc_entry;
        hlx_aligned_free_entry_addr     aligned_free_entry;
        hlx_atomic_incr_entry_addr      atomic_incr_entry;
        hlx_atomic_decr_entry_addr      atomic_decr_entry;
        hlx_atomic_cas_entry_addr       atomic_cas_entry;
        hlx_atomic_dcas_entry_addr      atomic_dcas_entry;
        hlx_thread_api                  thread_api;
                /* OPTIONNAL */
        hlx_get_cpu_count_entry_addr    get_cpu_count_entry;
                hlx_memcpy_entry_addr                   memcpy_entry;
}                                               hlx_api;

/*
** FUNCTIONS
*/

hlx_api*      hlx_get_api_entries(void);

#ifdef __cplusplus
}
#endif

#endif /* !__HLX_API_H__ */

/*
** END OF FILE
*/