async.h

Go to the documentation of this file.

/*
 * 2025 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 within this implementation 
 * are proprietary to QRCS and its authorized licensors and are protected under 
 * applicable U.S. and international copyright, patent, and trade secret laws.
 *
 * CRYPTOGRAPHIC STANDARDS:
 * - This software includes implementations of cryptographic algorithms such as 
 *   SHA3, AES, and others. These algorithms are public domain or standardized 
 *   by organizations such as NIST and are NOT the property of QRCS.
 * - However, all source code, optimizations, and implementations in this library 
 *   are original works of QRCS and are protected under this license.
 *
 * RESTRICTIONS:
 * - Redistribution, modification, or unauthorized distribution of this software, 
 *   in whole or in part, is strictly prohibited.
 * - This software is provided for non-commercial, educational, and research 
 *   purposes only. Commercial use in any form is expressly forbidden.
 * - Licensing and authorized distribution are solely at the discretion of QRCS.
 * - Any use of this software implies acceptance of these restrictions.
 *
 * DISCLAIMER:
 * This software is provided "as is," without warranty of any kind, express or 
 * implied, including but not limited to warranties of merchantability or fitness 
 * for a particular purpose. QRCS disclaims all liability for any direct, indirect, 
 * incidental, or consequential damages resulting from the use or misuse of this software.
 *
 * FULL LICENSE:
 * This software is subject to the Quantum Resistant Cryptographic Solutions 
 * Proprietary License (QRCS-PL). The complete license terms are included 
 * in the LICENSE.txt file distributed with this software.
 *
 * Written by: John G. Underhill
 * Contact: john.underhill@protonmail.com
 */
 
#ifndef QSC_THREADS_H
#define QSC_THREADS_H
 
#include "common.h"
#include <stdarg.h>
 
#if defined(QSC_SYSTEM_OS_WINDOWS)
    /* Windows-specific thread and mutex definitions */
    QSC_SYSTEM_CONDITION_IGNORE(5105)
    #include <process.h>
    #include <Windows.h>
    typedef HANDLE qsc_mutex;
    typedef HANDLE qsc_thread;
#elif defined(QSC_SYSTEM_OS_POSIX)
    #include <sys/types.h>
    #include <unistd.h>
    #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
 
/* Function Declarations */

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 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