Skip to content
charmOS docs

Queued Spinlock (MCS-based 4-byte qspinlock)

include/sync/qspinlock.h View source View on GitHub

Structs

Section titled “Structs”

qspinlock

Section titled “qspinlock”
struct qspinlock {
    _Atomic uint32_t  val;
};

Enums

Section titled “Enums”

qspinlock_level

Section titled “qspinlock_level”
enum qspinlock_level {
    QSPINLOCK_LEVEL_NORMAL,
    QSPINLOCK_LEVEL_IRQ,
    QSPINLOCK_LEVEL_NMI,
    QSPINLOCK_LEVEL_MAX,
};

Functions

Section titled “Functions”

qspinlock_init_chk_internal

Section titled “qspinlock_init_chk_internal”
void qspinlock_init_chk_internal(struct qspinlock *lock, const struct lock_chk_class *class, enum lock_chk_flags flags);

qspin_is_locked

Section titled “qspin_is_locked”
bool qspin_is_locked(const struct qspinlock *lock);

qspinlock_policy_init_internal

Section titled “qspinlock_policy_init_internal”
void qspinlock_policy_init_internal(struct qspinlock *lock, enum lock_chk_flags flags);

qspinlock_map_init_internal

Section titled “qspinlock_map_init_internal”
void qspinlock_map_init_internal(struct qspinlock *lock, const struct lock_chk_class *class, enum lock_chk_flags flags);

qspinlock_shallow_init_internal

Section titled “qspinlock_shallow_init_internal”
void qspinlock_shallow_init_internal(struct qspinlock *lock);

qspinlock_set_chk_flags

Section titled “qspinlock_set_chk_flags”
void qspinlock_set_chk_flags(struct qspinlock *lock, enum lock_chk_flags flags);

qspinlock_reinit_chk

Section titled “qspinlock_reinit_chk”
void qspinlock_reinit_chk(struct qspinlock *lock, const struct lock_chk_class *class, enum lock_chk_flags flags);

qspinlock_note_use

Section titled “qspinlock_note_use”
void qspinlock_note_use(struct qspinlock *lock, bool raw_operation);

qspinlock_order_checked

Section titled “qspinlock_order_checked”
bool qspinlock_order_checked(struct qspinlock *lock);

qspinlock_classify

Section titled “qspinlock_classify”
void qspinlock_classify(struct qspinlock *lock, enum lock_debug_irq_usage usage, const struct lock_chk_site *site);

qspinlock_deep_checked

Section titled “qspinlock_deep_checked”
bool qspinlock_deep_checked(struct qspinlock *lock);

qspinlock_chk_acquire_request

Section titled “qspinlock_chk_acquire_request”
struct lock_chk_acquire_request qspinlock_chk_acquire_request(struct qspinlock *lock, const struct lock_chk_site *site, enum lock_chk_wait_kind wait_kind, uint8_t subclass, bool raw_operation, bool irq_safe);

qspinlock_chk_release_request

Section titled “qspinlock_chk_release_request”
struct lock_chk_release_request qspinlock_chk_release_request(struct qspinlock *lock, const struct lock_chk_site *site);

qspinlock_policy_init_internal

Section titled “qspinlock_policy_init_internal”
void qspinlock_policy_init_internal(struct qspinlock *lock, enum lock_chk_flags flags);

qspinlock_map_init_internal

Section titled “qspinlock_map_init_internal”
void qspinlock_map_init_internal(struct qspinlock *lock, const struct lock_chk_class *class, enum lock_chk_flags flags);

qspinlock_shallow_init_internal

Section titled “qspinlock_shallow_init_internal”
void qspinlock_shallow_init_internal(struct qspinlock *lock);

qspinlock_set_chk_flags

Section titled “qspinlock_set_chk_flags”
void qspinlock_set_chk_flags(struct qspinlock *lock, enum lock_chk_flags flags);

qspinlock_reinit_chk

Section titled “qspinlock_reinit_chk”
void qspinlock_reinit_chk(struct qspinlock *lock, const struct lock_chk_class *class, enum lock_chk_flags flags);

qspinlock_note_use

Section titled “qspinlock_note_use”
void qspinlock_note_use(struct qspinlock *lock, bool raw_operation);

qspinlock_order_checked

Section titled “qspinlock_order_checked”
bool qspinlock_order_checked(struct qspinlock *lock);

qspinlock_classify

Section titled “qspinlock_classify”
void qspinlock_classify(struct qspinlock *lock, enum lock_debug_irq_usage usage, const struct lock_chk_site *site);

qspinlock_deep_checked

Section titled “qspinlock_deep_checked”
bool qspinlock_deep_checked(struct qspinlock *lock);

qspinlock_init_chk_internal

Section titled “qspinlock_init_chk_internal”
void qspinlock_init_chk_internal(struct qspinlock *lock, const struct lock_chk_class *class, enum lock_chk_flags flags);

qspin_trylock_physical

Section titled “qspin_trylock_physical”
bool qspin_trylock_physical(struct qspinlock *lock);

qspin_lock_slowpath

Section titled “qspin_lock_slowpath”
void qspin_lock_slowpath(struct qspinlock *lock, uint32_t val);

qspin_lock_physical

Section titled “qspin_lock_physical”
void qspin_lock_physical(struct qspinlock *lock);

qspin_unlock_physical

Section titled “qspin_unlock_physical”
void qspin_unlock_physical(struct qspinlock *lock);

qspin_is_locked

Section titled “qspin_is_locked”
bool qspin_is_locked(const struct qspinlock *lock);

qspin_trylock_raw_internal

Section titled “qspin_trylock_raw_internal”
bool qspin_trylock_raw_internal(struct qspinlock *lock, const struct lock_chk_site *site);

qspin_lock_raw_internal

Section titled “qspin_lock_raw_internal”
void qspin_lock_raw_internal(struct qspinlock *lock, const struct lock_chk_site *site);

qspin_unlock_raw_internal

Section titled “qspin_unlock_raw_internal”
void qspin_unlock_raw_internal(struct qspinlock *lock, const struct lock_chk_site *site);

qspin_unlock_internal

Section titled “qspin_unlock_internal”
void qspin_unlock_internal(struct qspinlock *lock, enum irql old_irql, const struct lock_chk_site *site);

qspin_lock_subclass_internal

Section titled “qspin_lock_subclass_internal”
enum irql qspin_lock_subclass_internal(struct qspinlock *lock, uint8_t subclass, const struct lock_chk_site *site);

qspin_lock_internal

Section titled “qspin_lock_internal”
enum irql qspin_lock_internal(struct qspinlock *lock, const struct lock_chk_site *site);

qspin_lock_irq_disable_internal

Section titled “qspin_lock_irq_disable_internal”
enum irql qspin_lock_irq_disable_internal(struct qspinlock *lock, const struct lock_chk_site *site);

qspin_trylock_internal

Section titled “qspin_trylock_internal”
bool qspin_trylock_internal(struct qspinlock *lock, enum irql *out, const struct lock_chk_site *site);

qspin_trylock_irq_disable_internal

Section titled “qspin_trylock_irq_disable_internal”
bool qspin_trylock_irq_disable_internal(struct qspinlock *lock, enum irql *out, const struct lock_chk_site *site);

qspin_assert_held_internal

Section titled “qspin_assert_held_internal”
void qspin_assert_held_internal(struct qspinlock *lock, const struct lock_chk_site *site);

qspin_assert_not_held_internal

Section titled “qspin_assert_not_held_internal”
void qspin_assert_not_held_internal(struct qspinlock *lock, const struct lock_chk_site *site);

Macros

Section titled “Macros”

Q_SPIN_LOCKED_OFFSET

Section titled “Q_SPIN_LOCKED_OFFSET”
#define Q_SPIN_LOCKED_OFFSET 0

Q_SPIN_LOCKED_BITS

Section titled “Q_SPIN_LOCKED_BITS”
#define Q_SPIN_LOCKED_BITS 8

Q_SPIN_LOCKED_MASK

Section titled “Q_SPIN_LOCKED_MASK”
#define Q_SPIN_LOCKED_MASK 0x000000FFU

Q_SPIN_LOCKED_VAL

Section titled “Q_SPIN_LOCKED_VAL”
#define Q_SPIN_LOCKED_VAL 0x00000001U

Q_SPIN_PENDING_OFFSET

Section titled “Q_SPIN_PENDING_OFFSET”
#define Q_SPIN_PENDING_OFFSET 8

Q_SPIN_PENDING_BITS

Section titled “Q_SPIN_PENDING_BITS”
#define Q_SPIN_PENDING_BITS 1

Q_SPIN_PENDING_MASK

Section titled “Q_SPIN_PENDING_MASK”
#define Q_SPIN_PENDING_MASK 0x00000100U

Q_SPIN_PENDING_VAL

Section titled “Q_SPIN_PENDING_VAL”
#define Q_SPIN_PENDING_VAL 0x00000100U

Q_SPIN_LOCKED_PENDING_MASK

Section titled “Q_SPIN_LOCKED_PENDING_MASK”
#define Q_SPIN_LOCKED_PENDING_MASK (Q_SPIN_LOCKED_MASK | Q_SPIN_PENDING_MASK)

Q_SPIN_TAIL_LVL_OFFSET

Section titled “Q_SPIN_TAIL_LVL_OFFSET”
#define Q_SPIN_TAIL_LVL_OFFSET 9

Q_SPIN_TAIL_LVL_BITS

Section titled “Q_SPIN_TAIL_LVL_BITS”
#define Q_SPIN_TAIL_LVL_BITS 2

Q_SPIN_TAIL_LVL_MASK

Section titled “Q_SPIN_TAIL_LVL_MASK”
#define Q_SPIN_TAIL_LVL_MASK 0x00000600U

Q_SPIN_TAIL_CPU_OFFSET

Section titled “Q_SPIN_TAIL_CPU_OFFSET”
#define Q_SPIN_TAIL_CPU_OFFSET 16

Q_SPIN_TAIL_CPU_BITS

Section titled “Q_SPIN_TAIL_CPU_BITS”
#define Q_SPIN_TAIL_CPU_BITS 16

Q_SPIN_TAIL_CPU_MASK

Section titled “Q_SPIN_TAIL_CPU_MASK”
#define Q_SPIN_TAIL_CPU_MASK 0xFFFF0000U

Q_SPIN_TAIL_MASK

Section titled “Q_SPIN_TAIL_MASK”
#define Q_SPIN_TAIL_MASK (Q_SPIN_TAIL_LVL_MASK | Q_SPIN_TAIL_CPU_MASK)

QSPINLOCK_INIT

Section titled “QSPINLOCK_INIT”
#define QSPINLOCK_INIT QSPINLOCK_INIT_CHK(NULL, LOCK_CHKD_FULL)

QSPINLOCK_DEFINE

Section titled “QSPINLOCK_DEFINE”
#define QSPINLOCK_DEFINE(id) struct qspinlock id = QSPINLOCK_INIT

QSPINLOCK_DEFINE_CHK

Section titled “QSPINLOCK_DEFINE_CHK”
#define QSPINLOCK_DEFINE_CHK(id, class_, flags_) \
    struct qspinlock id = QSPINLOCK_INIT_CHK((class_), (flags_))

__QSPINLOCK_SHALLOW_VALUE_INIT

Section titled “__QSPINLOCK_SHALLOW_VALUE_INIT”
#define __QSPINLOCK_SHALLOW_VALUE_INIT \
    , .irq_usage = ATOMIC_VAR_INIT(LOCK_DEBUG_IRQ_NONE)

__QSPINLOCK_LOCK_CHK_VALUE_INIT

Section titled “__QSPINLOCK_LOCK_CHK_VALUE_INIT”
#define __QSPINLOCK_LOCK_CHK_VALUE_INIT(class_, flags_) \
    , .chk = LOCK_CHK_LOCK_VALUE_INIT((class_), (flags_))

QSPINLOCK_INIT_CHK

Section titled “QSPINLOCK_INIT_CHK”
#define QSPINLOCK_INIT_CHK(class_, flags_) \
    ((struct qspinlock) { \
        .val = ATOMIC_VAR_INIT(0) __QSPINLOCK_LOCK_CHK_VALUE_INIT( \
            (class_), (flags_)) __QSPINLOCK_SHALLOW_VALUE_INIT})

qspinlock_init_chk

Section titled “qspinlock_init_chk”
#define qspinlock_init_chk(lock_, class_, flags_) \
    qspinlock_init_chk_internal((lock_), (class_), (flags_))

qspinlock_init_auto_internal

Section titled “qspinlock_init_auto_internal”
#define qspinlock_init_auto_internal(lock_, flags_) \
    do { \
        static const struct lock_chk_class __auto_class = { \
            .name = #lock_, \
            .file = __RELFILE__, \
            .line = __LINE__, \
        }; \
        qspinlock_init_chk_internal((lock_), &__auto_class, (flags_)); \
    } while (0)

__QSPINLOCK_SHALLOW_VALUE_INIT

Section titled “__QSPINLOCK_SHALLOW_VALUE_INIT”
#define __QSPINLOCK_SHALLOW_VALUE_INIT

__QSPINLOCK_LOCK_CHK_VALUE_INIT

Section titled “__QSPINLOCK_LOCK_CHK_VALUE_INIT”
#define __QSPINLOCK_LOCK_CHK_VALUE_INIT(class_, flags_)

QSPINLOCK_INIT_CHK

Section titled “QSPINLOCK_INIT_CHK”
#define QSPINLOCK_INIT_CHK(class_, flags_) \
    ((struct qspinlock) {.val = ATOMIC_VAR_INIT(0)})

qspinlock_init_chk

Section titled “qspinlock_init_chk”
#define qspinlock_init_chk(lock_, class_, flags_) \
    qspinlock_init_chk_internal((lock_), NULL, LOCK_UNCHKD)

qspinlock_init_auto_internal

Section titled “qspinlock_init_auto_internal”
#define qspinlock_init_auto_internal(lock_, flags_) \
    qspinlock_init_chk_internal((lock_), NULL, LOCK_UNCHKD)

qspinlock_init_1

Section titled “qspinlock_init_1”
#define qspinlock_init_1(lock_) \
    qspinlock_init_auto_internal((lock_), LOCK_CHKD_FULL)

qspinlock_init_2

Section titled “qspinlock_init_2”
#define qspinlock_init_2(lock_, flags_) \
    qspinlock_init_auto_internal((lock_), (flags_))

qspinlock_init

Section titled “qspinlock_init”
#define qspinlock_init(...) \
    _DISPATCH(qspinlock_init, PP_NARG(__VA_ARGS__))(__VA_ARGS__)

qspin_init

Section titled “qspin_init”
#define qspin_init(...) qspinlock_init(__VA_ARGS__)

qspin_init_chk

Section titled “qspin_init_chk”
#define qspin_init_chk(...) qspinlock_init_chk(__VA_ARGS__)

QSPINLOCK_ASSERT_LOCKED

Section titled “QSPINLOCK_ASSERT_LOCKED”
#define QSPINLOCK_ASSERT_LOCKED(l) \
    kassert(qspin_is_locked(l), "qspinlock not locked")

qspin_lock

Section titled “qspin_lock”
#define qspin_lock(lock_) qspin_lock_internal((lock_), LOCK_CHK_SITE_HERE())

qspin_lock_subclass

Section titled “qspin_lock_subclass”
#define qspin_lock_subclass(lock_, subclass_) \
    qspin_lock_subclass_internal((lock_), (subclass_), LOCK_CHK_SITE_HERE())

qspin_lock_irq_disable

Section titled “qspin_lock_irq_disable”
#define qspin_lock_irq_disable(lock_) \
    qspin_lock_irq_disable_internal((lock_), LOCK_CHK_SITE_HERE())

qspin_unlock

Section titled “qspin_unlock”
#define qspin_unlock(lock_, old_) \
    qspin_unlock_internal((lock_), (old_), LOCK_CHK_SITE_HERE())

qspin_unlock_irq_restore

Section titled “qspin_unlock_irq_restore”
#define qspin_unlock_irq_restore(lock_, old_) \
    qspin_unlock_internal((lock_), (old_), LOCK_CHK_SITE_HERE())

qspin_trylock

Section titled “qspin_trylock”
#define qspin_trylock(lock_, out_) \
    qspin_trylock_internal((lock_), (out_), LOCK_CHK_SITE_HERE())

qspin_trylock_irq_disable

Section titled “qspin_trylock_irq_disable”
#define qspin_trylock_irq_disable(lock_, out_) \
    qspin_trylock_irq_disable_internal((lock_), (out_), LOCK_CHK_SITE_HERE())

qspin_lock_raw

Section titled “qspin_lock_raw”
#define qspin_lock_raw(lock_) \
    qspin_lock_raw_internal((lock_), LOCK_CHK_SITE_HERE())

qspin_trylock_raw

Section titled “qspin_trylock_raw”
#define qspin_trylock_raw(lock_) \
    qspin_trylock_raw_internal((lock_), LOCK_CHK_SITE_HERE())

qspin_unlock_raw

Section titled “qspin_unlock_raw”
#define qspin_unlock_raw(lock_) \
    qspin_unlock_raw_internal((lock_), LOCK_CHK_SITE_HERE())

QSPINLOCK_ASSERT_HELD

Section titled “QSPINLOCK_ASSERT_HELD”
#define QSPINLOCK_ASSERT_HELD(l) \
    qspin_assert_held_internal((l), LOCK_CHK_SITE_HERE())

QSPINLOCK_ASSERT_NOT_HELD

Section titled “QSPINLOCK_ASSERT_NOT_HELD”
#define QSPINLOCK_ASSERT_NOT_HELD(l) \
    qspin_assert_not_held_internal((l), LOCK_CHK_SITE_HERE())