mutex.h

Go to the documentation of this file.

/*
BSD 3-Clause License
 
Copyright (c) 2025, Szymon Turno
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
 
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products derived from
   this software without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
 
#ifndef ST_OS_MUTEX_H
#define ST_OS_MUTEX_H
 
#include "st/bits.h"
#include <stdbool.h>
 
#define ST_MUTEX_BF(attr, opt) ST_BITFIELD(ST_MUTEX_##attr##_MASK, (opt))
 
/* clang-format off */
#define ST_MUTEX_POLICY_MASK ST_BITMASK(2, 0)  
#define ST_MUTEX_TYPE_MASK   ST_BITMASK(6, 3)  
#define ST_MUTEX_UNUSED_MASK ST_BITMASK(31, 7) 
#define ST_MUTEX_POLICY_NONE         ST_MUTEX_BF(POLICY, 0) 
#define ST_MUTEX_POLICY_PRIO_INHERIT ST_MUTEX_BF(POLICY, 1) 
#define ST_MUTEX_POLICY_DELIM        ST_MUTEX_BF(POLICY, 8) 
#define ST_MUTEX_TYPE_NONE      ST_MUTEX_BF(TYPE, 0)  
#define ST_MUTEX_TYPE_RECURSIVE ST_MUTEX_BF(TYPE, 1)  
#define ST_MUTEX_TYPE_DELIM     ST_MUTEX_BF(TYPE, 16) 
/* clang-format on */
 
typedef struct StMutex StMutex;
 
StMutex* st_mutex_create(StBits args);
 
void st_mutex_destroy(StMutex* mutex);
 
void st_mutex_lock(StMutex* mutex);
 
bool st_mutex_trylock(StMutex* mutex);
 
void st_mutex_unlock(StMutex* mutex);
 
#endif /* ST_OS_MUTEX_H */