Skip to content
charmOS docs

spinlock

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

Structs

Section titled “Structs”

spinlock

Section titled “spinlock”
struct spinlock {
    struct raw_spinlock  raw;
};

Functions

Section titled “Functions”

spinlock_init_chk_internal

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

spinlock_policy_init_internal

Section titled “spinlock_policy_init_internal”
void spinlock_policy_init_internal(struct spinlock *lock, enum lock_chk_flags flags);

spinlock_shallow_init_internal

Section titled “spinlock_shallow_init_internal”
void spinlock_shallow_init_internal(struct spinlock *lock);

spinlock_map_init_internal

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

spinlock_note_use

Section titled “spinlock_note_use”
void spinlock_note_use(struct spinlock *lock, bool raw_operation);

spinlock_order_checked

Section titled “spinlock_order_checked”
bool spinlock_order_checked(struct spinlock *lock);

spinlock_classify

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

spinlock_deep_checked

Section titled “spinlock_deep_checked”
bool spinlock_deep_checked(struct spinlock *lock);

spinlock_chk_acquire_request

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

spinlock_chk_release_request

Section titled “spinlock_chk_release_request”
struct lock_chk_release_request spinlock_chk_release_request(struct spinlock *lock, const struct lock_chk_site *site);

spinlock_policy_init_internal

Section titled “spinlock_policy_init_internal”
void spinlock_policy_init_internal(struct spinlock *lock, enum lock_chk_flags flags);

spinlock_shallow_init_internal

Section titled “spinlock_shallow_init_internal”
void spinlock_shallow_init_internal(struct spinlock *lock);

spinlock_map_init_internal

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

spinlock_note_use

Section titled “spinlock_note_use”
void spinlock_note_use(struct spinlock *lock, bool raw_operation);

spinlock_order_checked

Section titled “spinlock_order_checked”
bool spinlock_order_checked(struct spinlock *lock);

spinlock_classify

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

spinlock_deep_checked

Section titled “spinlock_deep_checked”
bool spinlock_deep_checked(struct spinlock *lock);

spin_trylock_physical

Section titled “spin_trylock_physical”
bool spin_trylock_physical(struct spinlock *lock);

spin_lock_physical

Section titled “spin_lock_physical”
void spin_lock_physical(struct spinlock *lock);

spin_unlock_physical

Section titled “spin_unlock_physical”
void spin_unlock_physical(struct spinlock *lock);

spinlock_init_chk_internal

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

spinlock_restore_interrupts

Section titled “spinlock_restore_interrupts”
void spinlock_restore_interrupts(bool enabled);

spin_trylock_raw_internal

Section titled “spin_trylock_raw_internal”
bool spin_trylock_raw_internal(struct spinlock *lock, const struct lock_chk_site *site);

spin_lock_raw_internal

Section titled “spin_lock_raw_internal”
void spin_lock_raw_internal(struct spinlock *lock, const struct lock_chk_site *site);

spin_unlock_raw_internal

Section titled “spin_unlock_raw_internal”
void spin_unlock_raw_internal(struct spinlock *lock, const struct lock_chk_site *site);

spin_unlock_internal

Section titled “spin_unlock_internal”
void spin_unlock_internal(struct spinlock *lock, enum irql old, const struct lock_chk_site *site);

spin_lock_subclass_internal

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

spin_lock_internal

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

spin_lock_irq_disable_internal

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

spin_trylock_internal

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

spin_trylock_irq_disable_internal

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

spinlock_locked

Section titled “spinlock_locked”
bool spinlock_locked(struct spinlock *lock);

spinlock_set_chk_flags

Section titled “spinlock_set_chk_flags”
void spinlock_set_chk_flags(struct spinlock *lock, enum lock_chk_flags flags);

spinlock_reinit_chk

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

spinlock_assert_held_internal

Section titled “spinlock_assert_held_internal”
void spinlock_assert_held_internal(struct spinlock *lock, const struct lock_chk_site *site);

spinlock_assert_not_held_internal

Section titled “spinlock_assert_not_held_internal”
void spinlock_assert_not_held_internal(struct spinlock *lock, const struct lock_chk_site *site);

Macros

Section titled “Macros”

SPINLOCK_INIT

Section titled “SPINLOCK_INIT”
#define SPINLOCK_INIT SPINLOCK_INIT_CHK(NULL, LOCK_CHKD_FULL)

SPINLOCK_DEFINE

Section titled “SPINLOCK_DEFINE”
#define SPINLOCK_DEFINE(id) struct spinlock id = SPINLOCK_INIT

SPINLOCK_DEFINE_CHK

Section titled “SPINLOCK_DEFINE_CHK”
#define SPINLOCK_DEFINE_CHK(id, class_, flags_) \
    struct spinlock id = SPINLOCK_INIT_CHK((class_), (flags_))

spinlock_init_1

Section titled “spinlock_init_1”
#define spinlock_init_1(lock_) \
    spinlock_init_auto_internal((lock_), LOCK_CHKD_FULL)

spinlock_init_2

Section titled “spinlock_init_2”
#define spinlock_init_2(lock_, flags_) \
    spinlock_init_auto_internal((lock_), (flags_))

spinlock_init

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

__SPINLOCK_SHALLOW_VALUE_INIT

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

__SPINLOCK_LOCK_CHK_VALUE_INIT

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

SPINLOCK_INIT_CHK

Section titled “SPINLOCK_INIT_CHK”
#define SPINLOCK_INIT_CHK(class_, flags_) \
    ((struct spinlock) { \
        .raw = RAW_SPINLOCK_INIT __SPINLOCK_LOCK_CHK_VALUE_INIT( \
            (class_), (flags_)) __SPINLOCK_SHALLOW_VALUE_INIT})

spinlock_init_chk

Section titled “spinlock_init_chk”
#define spinlock_init_chk(lock_, class_, flags_) \
    spinlock_init_chk_internal((lock_), (class_), (flags_))

spinlock_init_auto_internal

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

__SPINLOCK_SHALLOW_VALUE_INIT

Section titled “__SPINLOCK_SHALLOW_VALUE_INIT”
#define __SPINLOCK_SHALLOW_VALUE_INIT

__SPINLOCK_LOCK_CHK_VALUE_INIT

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

SPINLOCK_INIT_CHK

Section titled “SPINLOCK_INIT_CHK”
#define SPINLOCK_INIT_CHK(class_, flags_) \
    ((struct spinlock) {.raw = RAW_SPINLOCK_INIT})

spinlock_init_chk

Section titled “spinlock_init_chk”
#define spinlock_init_chk(lock_, class_, flags_) \
    spinlock_init_chk_internal((lock_), NULL, LOCK_UNCHKD)

spinlock_init_auto_internal

Section titled “spinlock_init_auto_internal”
#define spinlock_init_auto_internal(lock_, flags_) \
    spinlock_init_chk_internal((lock_), NULL, LOCK_UNCHKD)

spin_lock

Section titled “spin_lock”
#define spin_lock(lock_) spin_lock_internal((lock_), LOCK_CHK_SITE_HERE())

spin_lock_subclass

Section titled “spin_lock_subclass”
#define spin_lock_subclass(lock_, subclass_) \
    spin_lock_subclass_internal((lock_), (subclass_), LOCK_CHK_SITE_HERE())

spin_lock_irq_disable

Section titled “spin_lock_irq_disable”
#define spin_lock_irq_disable(lock_) \
    spin_lock_irq_disable_internal((lock_), LOCK_CHK_SITE_HERE())

spin_trylock

Section titled “spin_trylock”
#define spin_trylock(lock_, out_) \
    spin_trylock_internal((lock_), (out_), LOCK_CHK_SITE_HERE())

spin_trylock_irq_disable

Section titled “spin_trylock_irq_disable”
#define spin_trylock_irq_disable(lock_, out_) \
    spin_trylock_irq_disable_internal((lock_), (out_), LOCK_CHK_SITE_HERE())

spin_unlock

Section titled “spin_unlock”
#define spin_unlock(lock_, old_) \
    spin_unlock_internal((lock_), (old_), LOCK_CHK_SITE_HERE())

spin_lock_raw

Section titled “spin_lock_raw”
#define spin_lock_raw(lock_) \
    spin_lock_raw_internal((lock_), LOCK_CHK_SITE_HERE())

spin_trylock_raw

Section titled “spin_trylock_raw”
#define spin_trylock_raw(lock_) \
    spin_trylock_raw_internal((lock_), LOCK_CHK_SITE_HERE())

spin_unlock_raw

Section titled “spin_unlock_raw”
#define spin_unlock_raw(lock_) \
    spin_unlock_raw_internal((lock_), LOCK_CHK_SITE_HERE())

SPINLOCK_ASSERT_LOCKED

Section titled “SPINLOCK_ASSERT_LOCKED”
#define SPINLOCK_ASSERT_LOCKED(l) \
    kassert(spinlock_locked(l), "spinlock not locked")

SPINLOCK_ASSERT_HELD

Section titled “SPINLOCK_ASSERT_HELD”
#define SPINLOCK_ASSERT_HELD(l) \
    spinlock_assert_held_internal((l), LOCK_CHK_SITE_HERE())

SPINLOCK_ASSERT_NOT_HELD

Section titled “SPINLOCK_ASSERT_NOT_HELD”
#define SPINLOCK_ASSERT_NOT_HELD(l) \
    spinlock_assert_not_held_internal((l), LOCK_CHK_SITE_HERE())