Suyu/dynarmic
1
0
Fork 0
mirror of https://git.suyu.dev/suyu/dynarmic.git synced 2026-01-03 13:14:42 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

externals: Add zycore

Browse source 
Merge commit '80d62f2249' as 'externals/zycore'
This commit is contained in:
MerryMage 2021-05-25 21:28:55 +01:00
commit eed33f255d
44 changed files with 12994 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

134
externals/zycore/include/Zycore/API/Memory.h vendored Normal file
View file

@ -0,0 +1,134 @@
/***************************************************************************************************
Zyan Core Library (Zycore-C)
Original Author : Florian Bernd
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
***************************************************************************************************/
/**
* @file
* @brief
*/
#ifndef ZYCORE_API_MEMORY_H
#define ZYCORE_API_MEMORY_H
#include <ZycoreExportConfig.h>
#include <Zycore/Defines.h>
#include <Zycore/Status.h>
#include <Zycore/Types.h>
#if defined(ZYAN_WINDOWS)
# include <windows.h>
#elif defined(ZYAN_POSIX)
# include <sys/mman.h>
#else
# error "Unsupported platform detected"
#endif
/* ============================================================================================== */
/* Enums and types */
/* ============================================================================================== */
/**
* Defines the `ZyanMemoryPageProtection` enum.
*/
typedef enum ZyanMemoryPageProtection_
{
#if defined(ZYAN_WINDOWS)
ZYAN_PAGE_READONLY = PAGE_READONLY,
ZYAN_PAGE_READWRITE = PAGE_READWRITE,
ZYAN_PAGE_EXECUTE = PAGE_EXECUTE,
ZYAN_PAGE_EXECUTE_READ = PAGE_EXECUTE_READ,
ZYAN_PAGE_EXECUTE_READWRITE = PAGE_EXECUTE_READWRITE
#elif defined(ZYAN_POSIX)
ZYAN_PAGE_READONLY = PROT_READ,
ZYAN_PAGE_READWRITE = PROT_READ | PROT_WRITE,
ZYAN_PAGE_EXECUTE = PROT_EXEC,
ZYAN_PAGE_EXECUTE_READ = PROT_EXEC | PROT_READ,
ZYAN_PAGE_EXECUTE_READWRITE = PROT_EXEC | PROT_READ | PROT_WRITE
#endif
} ZyanMemoryPageProtection;
/* ============================================================================================== */
/* Exported functions */
/* ============================================================================================== */
/* ---------------------------------------------------------------------------------------------- */
/* General */
/* ---------------------------------------------------------------------------------------------- */
/**
* Returns the system page size.
*
* @return The system page size.
*/
ZYCORE_EXPORT ZyanU32 ZyanMemoryGetSystemPageSize();
/**
* Returns the system allocation granularity.
*
* The system allocation granularity specifies the minimum amount of bytes which can be allocated
* at a specific address by a single call of `ZyanMemoryVirtualAlloc`.
*
* This value is typically 64KiB on Windows systems and equal to the page size on most POSIX
* platforms.
*
* @return The system allocation granularity.
*/
ZYCORE_EXPORT ZyanU32 ZyanMemoryGetSystemAllocationGranularity();
/* ---------------------------------------------------------------------------------------------- */
/* Memory management */
/* ---------------------------------------------------------------------------------------------- */
/**
* Changes the memory protection value of one or more pages.
*
* @param address The start address aligned to a page boundary.
* @param size The size.
* @param protection The new page protection value.
*
* @return A zyan status code.
*/
ZYCORE_EXPORT ZyanStatus ZyanMemoryVirtualProtect(void* address, ZyanUSize size,
ZyanMemoryPageProtection protection);
/**
* Releases one or more memory pages starting at the given address.
*
* @param address The start address aligned to a page boundary.
* @param size The size.
*
* @return A zyan status code.
*/
ZYCORE_EXPORT ZyanStatus ZyanMemoryVirtualFree(void* address, ZyanUSize size);
/* ---------------------------------------------------------------------------------------------- */
/* ============================================================================================== */
#endif /* ZYCORE_API_MEMORY_H */

67
externals/zycore/include/Zycore/API/Process.h vendored Normal file
View file

@ -0,0 +1,67 @@
/***************************************************************************************************
Zyan Core Library (Zycore-C)
Original Author : Florian Bernd
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
***************************************************************************************************/
/**
* @file
* @brief
*/
#ifndef ZYCORE_API_PROCESS_H
#define ZYCORE_API_PROCESS_H
#include <ZycoreExportConfig.h>
#include <Zycore/Status.h>
#include <Zycore/Types.h>
/* ============================================================================================== */
/* Enums and types */
/* ============================================================================================== */
/* ============================================================================================== */
/* Exported functions */
/* ============================================================================================== */
/* ---------------------------------------------------------------------------------------------- */
/* General */
/* ---------------------------------------------------------------------------------------------- */
/**
* @brief Flushes the process instruction cache.
*
* @param address The address.
* @param size The size.
*
* @return A zyan status code.
*/
ZYCORE_EXPORT ZyanStatus ZyanProcessFlushInstructionCache(void* address, ZyanUSize size);
/* ---------------------------------------------------------------------------------------------- */
/* ============================================================================================== */
#endif /* ZYCORE_API_PROCESS_H */

133
externals/zycore/include/Zycore/API/Synchronization.h vendored Normal file
View file

@ -0,0 +1,133 @@
/***************************************************************************************************
Zyan Core Library (Zycore-C)
Original Author : Florian Bernd
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
***************************************************************************************************/
/**
* @file
* @brief
*/
#ifndef ZYCORE_API_SYNCHRONIZATION_H
#define ZYCORE_API_SYNCHRONIZATION_H
#ifndef ZYAN_NO_LIBC
#include <ZycoreExportConfig.h>
#include <Zycore/Defines.h>
#include <Zycore/Status.h>
#ifdef __cplusplus
extern "C" {
#endif
/* ============================================================================================== */
/* Enums and types */
/* ============================================================================================== */
#if defined(ZYAN_POSIX)
#include <pthread.h>
/* ---------------------------------------------------------------------------------------------- */
/* Critical Section */
/* ---------------------------------------------------------------------------------------------- */
typedef pthread_mutex_t ZyanCriticalSection;
/* ---------------------------------------------------------------------------------------------- */
#elif defined(ZYAN_WINDOWS)
#include <windows.h>
/* ---------------------------------------------------------------------------------------------- */
/* Critical Section */
/* ---------------------------------------------------------------------------------------------- */
typedef CRITICAL_SECTION ZyanCriticalSection;
/* ---------------------------------------------------------------------------------------------- */
#else
# error "Unsupported platform detected"
#endif
/* ============================================================================================== */
/* Exported functions */
/* ============================================================================================== */
/* ---------------------------------------------------------------------------------------------- */
/* Critical Section */
/* ---------------------------------------------------------------------------------------------- */
/**
* Initializes a critical section.
*
* @param critical_section A pointer to the `ZyanCriticalSection` struct.
*/
ZYCORE_EXPORT ZyanStatus ZyanCriticalSectionInitialize(ZyanCriticalSection* critical_section);
/**
* Enters a critical section.
*
* @param critical_section A pointer to the `ZyanCriticalSection` struct.
*/
ZYCORE_EXPORT ZyanStatus ZyanCriticalSectionEnter(ZyanCriticalSection* critical_section);
/**
* Tries to enter a critical section.
*
* @param critical_section A pointer to the `ZyanCriticalSection` struct.
*
* @return Returns `ZYAN_TRUE` if the critical section was successfully entered or `ZYAN_FALSE`,
* if not.
*/
ZYCORE_EXPORT ZyanBool ZyanCriticalSectionTryEnter(ZyanCriticalSection* critical_section);
/**
* Leaves a critical section.
*
* @param critical_section A pointer to the `ZyanCriticalSection` struct.
*/
ZYCORE_EXPORT ZyanStatus ZyanCriticalSectionLeave(ZyanCriticalSection* critical_section);
/**
* Deletes a critical section.
*
* @param critical_section A pointer to the `ZyanCriticalSection` struct.
*/
ZYCORE_EXPORT ZyanStatus ZyanCriticalSectionDelete(ZyanCriticalSection* critical_section);
/* ---------------------------------------------------------------------------------------------- */
/* ============================================================================================== */
#ifdef __cplusplus
}
#endif
#endif /* ZYAN_NO_LIBC */
#endif /* ZYCORE_API_SYNCHRONIZATION_H */

163
externals/zycore/include/Zycore/API/Terminal.h vendored Normal file
View file

@ -0,0 +1,163 @@
/***************************************************************************************************
Zyan Core Library (Zycore-C)
Original Author : Florian Bernd
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
***************************************************************************************************/
/**
* @file Provides cross-platform terminal helper functions.
* @brief
*/
#ifndef ZYCORE_API_TERMINAL_H
#define ZYCORE_API_TERMINAL_H
#include <ZycoreExportConfig.h>
#include <Zycore/LibC.h>
#include <Zycore/Status.h>
#ifdef __cplusplus
extern "C" {
#endif
#ifndef ZYAN_NO_LIBC
/* ============================================================================================== */
/* VT100 CSI SGR sequences */
/* ============================================================================================== */
/* ---------------------------------------------------------------------------------------------- */
/* General */
/* ---------------------------------------------------------------------------------------------- */
#define ZYAN_VT100SGR_RESET "\033[0m"
/* ---------------------------------------------------------------------------------------------- */
/* Foreground colors */
/* ---------------------------------------------------------------------------------------------- */
#define ZYAN_VT100SGR_FG_DEFAULT "\033[39m"
#define ZYAN_VT100SGR_FG_BLACK "\033[30m"
#define ZYAN_VT100SGR_FG_RED "\033[31m"
#define ZYAN_VT100SGR_FG_GREEN "\033[32m"
#define ZYAN_VT100SGR_FG_YELLOW "\033[33m"
#define ZYAN_VT100SGR_FG_BLUE "\033[34m"
#define ZYAN_VT100SGR_FG_MAGENTA "\033[35m"
#define ZYAN_VT100SGR_FG_CYAN "\033[36m"
#define ZYAN_VT100SGR_FG_WHITE "\033[37m"
#define ZYAN_VT100SGR_FG_BRIGHT_BLACK "\033[90m"
#define ZYAN_VT100SGR_FG_BRIGHT_RED "\033[91m"
#define ZYAN_VT100SGR_FG_BRIGHT_GREEN "\033[92m"
#define ZYAN_VT100SGR_FG_BRIGHT_YELLOW "\033[93m"
#define ZYAN_VT100SGR_FG_BRIGHT_BLUE "\033[94m"
#define ZYAN_VT100SGR_FG_BRIGHT_MAGENTA "\033[95m"
#define ZYAN_VT100SGR_FG_BRIGHT_CYAN "\033[96m"
#define ZYAN_VT100SGR_FG_BRIGHT_WHITE "\033[97m"
/* ---------------------------------------------------------------------------------------------- */
/* Background color */
/* ---------------------------------------------------------------------------------------------- */
#define ZYAN_VT100SGR_BG_DEFAULT "\033[49m"
#define ZYAN_VT100SGR_BG_BLACK "\033[40m"
#define ZYAN_VT100SGR_BG_RED "\033[41m"
#define ZYAN_VT100SGR_BG_GREEN "\033[42m"
#define ZYAN_VT100SGR_BG_YELLOW "\033[43m"
#define ZYAN_VT100SGR_BG_BLUE "\033[44m"
#define ZYAN_VT100SGR_BG_MAGENTA "\033[45m"
#define ZYAN_VT100SGR_BG_CYAN "\033[46m"
#define ZYAN_VT100SGR_BG_WHITE "\033[47m"
#define ZYAN_VT100SGR_BG_BRIGHT_BLACK "\033[100m"
#define ZYAN_VT100SGR_BG_BRIGHT_RED "\033[101m"
#define ZYAN_VT100SGR_BG_BRIGHT_GREEN "\033[102m"
#define ZYAN_VT100SGR_BG_BRIGHT_YELLOW "\033[103m"
#define ZYAN_VT100SGR_BG_BRIGHT_BLUE "\033[104m"
#define ZYAN_VT100SGR_BG_BRIGHT_MAGENTA "\033[105m"
#define ZYAN_VT100SGR_BG_BRIGHT_CYAN "\033[106m"
#define ZYAN_VT100SGR_BG_BRIGHT_WHITE "\033[107m"
/* ---------------------------------------------------------------------------------------------- */
/* ============================================================================================== */
/* Enums and types */
/* ============================================================================================== */
/**
* Declares the `ZyanStandardStream` enum.
*/
typedef enum ZyanStandardStream_
{
/**
* The default input stream.
*/
ZYAN_STDSTREAM_IN,
/**
* The default output stream.
*/
ZYAN_STDSTREAM_OUT,
/**
* The default error stream.
*/
ZYAN_STDSTREAM_ERR
} ZyanStandardStream;
/* ============================================================================================== */
/* Exported functions */
/* ============================================================================================== */
/**
* Enables VT100 ansi escape codes for the given stream.
*
* @param stream Either `ZYAN_STDSTREAM_OUT` or `ZYAN_STDSTREAM_ERR`.
*
* @return A zyan status code.
*
* This functions returns `ZYAN_STATUS_SUCCESS` on all non-Windows systems without performing any
* operations, assuming that VT100 is supported by default.
*
* On Windows systems, VT100 functionality is only supported on Windows 10 build 1607 (anniversary
* update) and later.
*/
ZYCORE_EXPORT ZyanStatus ZyanTerminalEnableVT100(ZyanStandardStream stream);
/**
* Checks, if the given standard stream reads from or writes to a terminal.
*
* @param stream The standard stream to check.
*
* @return `ZYAN_STATUS_TRUE`, if the stream is bound to a terminal, `ZYAN_STATUS_FALSE` if not,
* or another zyan status code if an error occured.
*/
ZYCORE_EXPORT ZyanStatus ZyanTerminalIsTTY(ZyanStandardStream stream);
/* ============================================================================================== */
#endif // ZYAN_NO_LIBC
#ifdef __cplusplus
}
#endif
#endif /* ZYCORE_API_TERMINAL_H */

244
externals/zycore/include/Zycore/API/Thread.h vendored Normal file
View file

@ -0,0 +1,244 @@
/***************************************************************************************************
Zyan Core Library (Zycore-C)
Original Author : Florian Bernd
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
***************************************************************************************************/
/**
* @file
* @brief
*/
#ifndef ZYCORE_API_THREAD_H
#define ZYCORE_API_THREAD_H
#ifndef ZYAN_NO_LIBC
#include <ZycoreExportConfig.h>
#include <Zycore/Defines.h>
#include <Zycore/Status.h>
#ifdef __cplusplus
extern "C" {
#endif
/* ============================================================================================== */
/* Enums and types */
/* ============================================================================================== */
#if defined(ZYAN_POSIX)
#include <pthread.h>
/* ---------------------------------------------------------------------------------------------- */
/* General */
/* ---------------------------------------------------------------------------------------------- */
/**
* Defines the `ZyanThread` data-type.
*/
typedef pthread_t ZyanThread;
/**
* Defines the `ZyanThreadId` data-type.
*/
typedef ZyanU64 ZyanThreadId;
/* ---------------------------------------------------------------------------------------------- */
/* Thread Local Storage (TLS) */
/* ---------------------------------------------------------------------------------------------- */
/**
* Defines the `ZyanThreadTlsIndex` data-type.
*/
typedef pthread_key_t ZyanThreadTlsIndex;
/**
* Defines the `ZyanThreadTlsCallback` function prototype.
*/
typedef void(*ZyanThreadTlsCallback)(void* data);
/**
* Declares a Thread Local Storage (TLS) callback function.
*
* @param name The callback function name.
* @param param_type The callback data parameter type.
* @param param_name The callback data parameter name.
*/
#define ZYAN_THREAD_DECLARE_TLS_CALLBACK(name, param_type, param_name) \
void name(param_type* param_name)
/* ---------------------------------------------------------------------------------------------- */
#elif defined(ZYAN_WINDOWS)
#include <windows.h>
/* ---------------------------------------------------------------------------------------------- */
/* General */
/* ---------------------------------------------------------------------------------------------- */
/**
* Defines the `ZyanThread` data-type.
*/
typedef HANDLE ZyanThread;
/**
* Defines the `ZyanThreadId` data-type.
*/
typedef DWORD ZyanThreadId;
/* ---------------------------------------------------------------------------------------------- */
/* Thread Local Storage (TLS) */
/* ---------------------------------------------------------------------------------------------- */
/**
* Defines the `ZyanThreadTlsIndex` data-type.
*/
typedef DWORD ZyanThreadTlsIndex;
/**
* Defines the `ZyanThreadTlsCallback` function prototype.
*/
typedef PFLS_CALLBACK_FUNCTION ZyanThreadTlsCallback;
/**
* Declares a Thread Local Storage (TLS) callback function.
*
* @param name The callback function name.
* @param param_type The callback data parameter type.
* @param param_name The callback data parameter name.
*/
#define ZYAN_THREAD_DECLARE_TLS_CALLBACK(name, param_type, param_name) \
VOID NTAPI name(param_type* param_name)
/* ---------------------------------------------------------------------------------------------- */
#else
# error "Unsupported platform detected"
#endif
/* ============================================================================================== */
/* Exported functions */
/* ============================================================================================== */
/* ---------------------------------------------------------------------------------------------- */
/* General */
/* ---------------------------------------------------------------------------------------------- */
/**
* Returns the handle of the current thread.
*
* @param thread Receives the handle of the current thread.
*
* @return A zyan status code.
*/
ZYCORE_EXPORT ZyanStatus ZyanThreadGetCurrentThread(ZyanThread* thread);
/**
* Returns the unique id of the current thread.
*
* @param thread_id Receives the unique id of the current thread.
*
* @return A zyan status code.
*/
ZYCORE_EXPORT ZyanStatus ZyanThreadGetCurrentThreadId(ZyanThreadId* thread_id);
/* ---------------------------------------------------------------------------------------------- */
/* Thread Local Storage (TLS) */
/* ---------------------------------------------------------------------------------------------- */
/**
* Allocates a new Thread Local Storage (TLS) slot.
*
* @param index Receives the TLS slot index.
* @param destructor A pointer to a destructor callback which is invoked to finalize the data
* in the TLS slot or `ZYAN_NULL`, if not needed.
*
* The maximum available number of TLS slots is implementation specific and different on each
* platform:
* - Windows
* - A total amount of 128 slots per process are guaranteed
* - POSIX
* - A total amount of 128 slots per process are guaranteed
* - Some systems guarantee larger amounts like e.g. 1024 slots per process
*
* Note that the invocation rules for the destructor callback are implementation specific and
* different on each platform:
* - Windows
* - The callback is invoked when a thread exits
* - The callback is invoked when the process exits
* - The callback is invoked when the TLS slot is released
* - POSIX
* - The callback is invoked when a thread exits and the stored value is not null
* - The callback is NOT invoked when the process exits
* - The callback is NOT invoked when the TLS slot is released
*
* @return A zyan status code.
*/
ZYCORE_EXPORT ZyanStatus ZyanThreadTlsAlloc(ZyanThreadTlsIndex* index,
ZyanThreadTlsCallback destructor);
/**
* Releases a Thread Local Storage (TLS) slot.
*
* @param index The TLS slot index.
*
* @return A zyan status code.
*/
ZYCORE_EXPORT ZyanStatus ZyanThreadTlsFree(ZyanThreadTlsIndex index);
/**
* Returns the value inside the given Thread Local Storage (TLS) slot for the
* calling thread.
*
* @param index The TLS slot index.
* @param data Receives the value inside the given Thread Local Storage
* (TLS) slot for the calling thread.
*
* @return A zyan status code.
*/
ZYCORE_EXPORT ZyanStatus ZyanThreadTlsGetValue(ZyanThreadTlsIndex index, void** data);
/**
* Set the value of the given Thread Local Storage (TLS) slot for the calling thread.
*
* @param index The TLS slot index.
* @param data The value to store inside the given Thread Local Storage (TLS) slot for the
* calling thread
*
* @return A zyan status code.
*/
ZYCORE_EXPORT ZyanStatus ZyanThreadTlsSetValue(ZyanThreadTlsIndex index, void* data);
/* ---------------------------------------------------------------------------------------------- */
/* ============================================================================================== */
#ifdef __cplusplus
}
#endif
#endif /* ZYAN_NO_LIBC */
#endif /* ZYCORE_API_THREAD_H */