async.h

Go to the documentation of this file.

/* 2020-2026 Quantum Resistant Cryptographic Solutions Corporation
 * All Rights Reserved.
 *
 * NOTICE:
 * This software and all accompanying materials are the exclusive property of
 * Quantum Resistant Cryptographic Solutions Corporation (QRCS). The intellectual
 * and technical concepts contained herein are proprietary to QRCS and are
 * protected under applicable Canadian, U.S., and international copyright,
 * patent, and trade secret laws.
 *
 * CRYPTOGRAPHIC ALGORITHMS AND IMPLEMENTATIONS:
 * - This software includes implementations of cryptographic primitives and
 *   algorithms that are standardized or in the public domain, such as AES
 *   and SHA-3, which are not proprietary to QRCS.
 * - This software also includes cryptographic primitives, constructions, and
 *   algorithms designed by QRCS, including but not limited to RCS, SCB, CSX, QMAC, and
 *   related components, which are proprietary to QRCS.
 * - All source code, implementations, protocol compositions, optimizations,
 *   parameter selections, and engineering work contained in this software are
 *   original works of QRCS and are protected under this license.
 *
 * LICENSE AND USE RESTRICTIONS:
 * - This software is licensed under the Quantum Resistant Cryptographic Solutions
 *   Public Research and Evaluation License (QRCS-PREL), 2025-2026.
 * - Permission is granted solely for non-commercial evaluation, academic research,
 *   cryptographic analysis, interoperability testing, and feasibility assessment.
 * - Commercial use, production deployment, commercial redistribution, or
 *   integration into products or services is strictly prohibited without a
 *   separate written license agreement executed with QRCS.
 * - Licensing and authorized distribution are solely at the discretion of QRCS.
 *
 * EXPERIMENTAL CRYPTOGRAPHY NOTICE:
 * Portions of this software may include experimental, novel, or evolving
 * cryptographic designs. Use of this software is entirely at the user's risk.
 *
 * DISCLAIMER:
 * THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE, SECURITY, OR NON-INFRINGEMENT. QRCS DISCLAIMS ALL
 * LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING FROM THE USE OR MISUSE OF THIS SOFTWARE.
 *
 * FULL LICENSE:
 * This software is subject to the Quantum Resistant Cryptographic Solutions
 * Public Research and Evaluation License (QRCS-PREL), 2025-2026. The complete license terms
 * are provided in the accompanying LICENSE file or at https://www.qrcscorp.ca.
 *
 * Written by: John G. Underhill
 * Contact: contact@qrcscorp.ca
 */
 
#ifndef QSC_THREADS_H
#define QSC_THREADS_H
 
#include "qsccommon.h"
#include <stdarg.h>
 
#if defined(QSC_SYSTEM_OS_WINDOWS)
    typedef void* qsc_mutex;
    typedef void* qsc_thread;
#elif defined(QSC_SYSTEM_OS_POSIX)
#   ifndef _XOPEN_SOURCE
#       define _XOPEN_SOURCE 700
#   endif
#   ifndef _DARWIN_C_SOURCE
#       define _DARWIN_C_SOURCE
#   endif
#   include <pthread.h>
    typedef pthread_mutex_t* qsc_mutex;
    typedef pthread_t qsc_thread;
#else
#   error your operating system is not supported!
#endif
 
QSC_CPLUSPLUS_ENABLED_START


#define QSC_ASYNC_PARALLEL_MAX 128ULL

QSC_EXPORT_API bool qsc_async_atomic_bool_load(volatile bool* target);

QSC_EXPORT_API void qsc_async_atomic_bool_store(volatile bool* target, bool value);

QSC_EXPORT_API bool qsc_async_atomic_bool_exchange(volatile bool* target, bool value);

QSC_EXPORT_API bool qsc_async_atomic_bool_compare_exchange(volatile bool* target, bool expected, bool desired);

QSC_EXPORT_API int32_t qsc_async_atomic_int32_load(volatile int32_t* target);

QSC_EXPORT_API void qsc_async_atomic_int32_store(volatile int32_t* target, int32_t value);

QSC_EXPORT_API int32_t qsc_async_atomic_int32_exchange(volatile int32_t* target, int32_t value);

QSC_EXPORT_API bool qsc_async_atomic_int32_compare_exchange(volatile int32_t* target, int32_t expected, int32_t desired);

QSC_EXPORT_API int32_t qsc_async_atomic_int32_add(volatile int32_t* target, int32_t value);

QSC_EXPORT_API int32_t qsc_async_atomic_int32_subtract(volatile int32_t* target, int32_t value);

QSC_EXPORT_API int32_t qsc_async_atomic_int32_increment(volatile int32_t* target);

QSC_EXPORT_API int32_t qsc_async_atomic_int32_decrement(volatile int32_t* target);

QSC_EXPORT_API void qsc_async_launch_thread(void (*func)(void*), void* state);

QSC_EXPORT_API void qsc_async_launch_parallel_threads(void (*func)(void*), size_t count, ...);

QSC_EXPORT_API qsc_mutex qsc_async_mutex_create(void);

QSC_EXPORT_API bool qsc_async_mutex_destroy(qsc_mutex mtx);

QSC_EXPORT_API void qsc_async_mutex_lock(qsc_mutex mtx);

QSC_EXPORT_API qsc_mutex qsc_async_mutex_lock_ex(void);

QSC_EXPORT_API void qsc_async_mutex_unlock(qsc_mutex mtx);

QSC_EXPORT_API void qsc_async_mutex_unlock_ex(qsc_mutex mtx);

QSC_EXPORT_API size_t qsc_async_processor_count(void);

QSC_EXPORT_API qsc_thread qsc_async_thread_create(void (*func)(void*), void* state);

QSC_EXPORT_API qsc_thread qsc_async_thread_create_ex(void (*func)(void**), void** args);

QSC_EXPORT_API qsc_thread qsc_async_thread_create_noargs(void (*func)(void));

QSC_EXPORT_API int32_t qsc_async_thread_resume(qsc_thread handle);

QSC_EXPORT_API void qsc_async_thread_sleep(uint32_t msec);

QSC_EXPORT_API int32_t qsc_async_thread_suspend(qsc_thread handle);

QSC_EXPORT_API bool qsc_async_thread_terminate(qsc_thread handle);

QSC_EXPORT_API void qsc_async_thread_wait(qsc_thread handle);

QSC_EXPORT_API void qsc_async_thread_wait_time(qsc_thread handle, uint32_t msec);

QSC_EXPORT_API void qsc_async_thread_wait_all(qsc_thread* handles, size_t count);
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif