Alexandre Bouvier cd2ede593a Squashed 'externals/zycore/' changes from 0c372cde..1401fb85
1401fb85 Fix `a label can only be part of a statement` warning (#61)
5f650a18 CMake: Enable `CMAKE_MSVC_RUNTIME_LIBRARY` (MSVC)
6c958cfe Fix no-libc build on "other" platforms (#58)
59819206 Bump version to v1.4.0
4bc563f6 Fix build-system to better work with vcpkg (#56)
4a8b5e2a CMake: rename target `doc` -> `ZycoreDoc`
a754e112 Bump version to 1.3.0
3e95307d Add support for ppc(64) and riscv64 (#52)
8f39333a build: only enable CXX if needed
7bd75696 build: add doc target
7c33e13e Fix `ZYAN_TRUE`/`ZYAN_FALSE` signedness
a0feec7f Fix warning `C4668`
bdbd3ff4 Bump version to v1.2
60b6ef1c Fix for dynamic libraries too
310f362c Adding ARCHIVE DESTINATION to fix CMake error
b01063b8 Improved logic for enabling LTO
c58d7fb5 Don't enable C11 for MSVC
ee784564 Switch minimum C standard supported to C11
5c341bf1 Implement an initial set of cross-compiler atomic operations
b4949ccc Minor fixes
9a305f6a Add CI workflow
dd2211a0 Get rid of CMake export headers
f0fb3f78 Fix `ZYAN_VECTOR_FOREACH_MUTABLE` macro
3f263290 format: handle encoding on wasm
95d7fb6c format: handle hex encoding on wasm
0d37fc54 defines: add wasm/wasi detection
8983325b build: use -pthread when possible
3de49d41 build: use system GTest when available
8d46cb58 test: make tests runnable with ctest
636bb299 Remove `float`s from the project (kernel mode compatibility) (#36)
e2b37b10 Assert to ensure sane growth factors
94185407 Added limits for integer types
767719d9 build(cmake): export and install zyan_* functions (#33)
6c93d9a3 build(cmake): add version and soversion to the library
fc2798d4 build(cmake): fix PUBLIC include dir of installed lib
22ce9c2d Add `ZYAN_FORCE_ASSERTS` CMake option
9a301424 Remove disabling source files in no-libc mode in CMake
3be54fca Thread.c: add missing SDK prototypes for old versions of Windows
d7fc85fd Exclude API/Memory.c and API/Process.c from compilation in no-libc mode
8da0001a Add back #ifdef guards to "API" headers/sources for no-libc mode
f6a48866 Fix cmake config files (#27)
4f3746fa Merge pull request #26 from Tsn0w/master
a9bb54ad Replace fallthrough attribute to __fallthrough__
99a74acb Add `ZYDIS_NOINLINE` macro

git-subtree-dir: externals/zycore
git-subtree-split: 1401fb85ac313f6605ec795c52bf99ea3f292a69
2022-11-20 21:49:18 +01:00

244 lines
8.6 KiB
C

/***************************************************************************************************
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
#include <Zycore/Defines.h>
#include <Zycore/Status.h>
#ifndef ZYAN_NO_LIBC
#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 */