OsAbstractionLayer.h

Go to the documentation of this file.

#ifndef ZFORCE_OSABSTRACTIONLAYER_H
#define ZFORCE_OSABSTRACTIONLAYER_H

#ifndef ZFORCECOMMON_H
    #error Please include "zForceCommon.h" before this file.
#endif // ZFORCECOMMON_H

typedef void zForceMutex;     
typedef void zForceSemaphore; 
typedef void zForceThread;    

typedef struct zForceThreadWrapper zForceThreadWrapper;
struct zForceThreadWrapper
{
    zForceThread * zForceThread;        
    void       ( * EntryPoint)(void *); 
    void         * Arguments;           
};

typedef struct OsAbstractionLayer OsAbstractionLayer;
struct OsAbstractionLayer
{
    void   * ( * Malloc)(size_t size);

    void     ( * Free)(void * memoryPointer);

    void   * ( * Realloc)(void * memoryPointer, size_t size);

    void   * ( * MallocWithPattern)(size_t size, uint8_t pattern);

    bool     ( * InitializeMutex)(zForceMutex ** zForceMutex);

    bool     ( * LockMutex)(zForceMutex * zForceMutex);

    bool     ( * UnlockMutex)(zForceMutex * zForceMutex);

    bool     ( * DestroyMutex)(zForceMutex * zForceMutex);

    bool     ( * InitializeSemaphore)
                 (zForceSemaphore ** zForceSemaphore, uint32_t initialValue);

    bool     ( * WaitForSemaphore)(zForceSemaphore * zForceSemaphore,
                                 uint32_t timeoutMs);

    bool     ( * IncrementSemaphore)(zForceSemaphore * zForceSemaphore);

    bool     ( * DestroySemaphore)(zForceSemaphore * zForceSemaphore);

    uint64_t ( * GetTimeMilliSeconds)(void);

    bool     ( * CreateThread)(zForceThread ** zForceThread,
                               void ( * entryPoint)(void *),
                               void * arguments);

    bool     ( * WaitForThreadExit)(zForceThread * zForceThread);

    void     ( * Sleep)(uint32_t milliSeconds);
};

DLLINTERNAL bool OsAbstractionLayer_Initialize (
                     OsAbstractionLayer * osAbstractionLayer,
                     OsAbstractionLayer * userSuppliedOsAbstractionLayer);

DLLINTERNAL void OsAbstractionLayer_ThreadWrapper (
                     zForceThreadWrapper * wrapper);

#endif // ZFORCE_OSABSTRACTIONLAYER_H