Lock Validation

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

Structs

lock_chk_site

struct lock_chk_site (3 fields) source

§ const char *file

§ const char *func

§ uint32_t line

lock_chk_class

struct lock_chk_class (3 fields) source

§ const char *name

§ const char *file

§ uint32_t line

Enums

lock_chk_flags

enum lock_chk_flags : uint8_t (4 variants) source

§ LOCK_UNCHKD = 0

§ LOCK_CHKD_ORDER = 1 << 0

§ LOCK_CHKD_THREAD = 1 << 1

§ LOCK_CHKD_FULL = LOCK_CHKD_ORDER | LOCK_CHKD_THREAD

lock_chk_type

enum lock_chk_type : uint8_t (5 variants) source

§ LOCK_CHK_TYPE_SPIN

§ LOCK_CHK_TYPE_QSPIN

§ LOCK_CHK_TYPE_MUTEX

§ LOCK_CHK_TYPE_MUTEX_SIMPLE

§ LOCK_CHK_TYPE_RWLOCK

lock_chk_mode

enum lock_chk_mode : uint8_t (3 variants) source

§ LOCK_CHK_MODE_IGNORED

§ LOCK_CHK_MODE_SHARED

§ LOCK_CHK_MODE_EXCLUSIVE

lock_chk_engine_state

enum lock_chk_engine_state : uint8_t (3 variants) source

§ LOCK_CHK_INACTIVE

§ LOCK_CHK_ACTIVE

§ LOCK_CHK_DEGRADED

lock_op_flags

enum lock_op_flags : uint8_t (6 variants) source

§ LOCK_OP_IRQ_NONE = 0

§ LOCK_OP_IRQ_DISPATCH = 1

§ LOCK_OP_IRQ_HIGH = 2

§ LOCK_OP_RAW = 1 << 2

§ LOCK_OP_KIND_BLOCKING = 1 << 3

These are represented NOT as a single bit so a missing KIND can trip an assertion instead of assuming a state

§ LOCK_OP_KIND_TRY = 2 << 3

Functions

lock_debug_spin_classify

void lock_debug_spin_classify(
    atomic(enum lock_op_flags) * usage,
    enum lock_op_flags requested,
    struct lock_chk_lock *lock,
    const struct lock_chk_site *site
)

source

lock_debug_spin_push

bool lock_debug_spin_push(
    struct lock_chk_lock *lock,
    enum irql prev_irql,
    const struct lock_chk_site *site
)

source

lock_debug_spin_validate_top

void lock_debug_spin_validate_top(
    struct lock_chk_lock *lock,
    enum irql prev_irql,
    const struct lock_chk_site *site
)

source

lock_debug_spin_pop

void lock_debug_spin_pop(struct lock_chk_lock *lock)

source

lock_chk_note_use

void lock_chk_note_use(
    struct lock_chk_lock *lock,
    enum lock_op_flags flags
)

source

lock_chk_assert_schedulable

void lock_chk_assert_schedulable(const struct lock_chk_site *site)

source

lock_chk_note_lock_use

void lock_chk_note_lock_use(
    struct lock_chk_lock *lock,
    bool manages_irql,
    bool raw_operation
)

source

lock_chk_assert_schedulable

void lock_chk_assert_schedulable(const struct lock_chk_site *site)

source

lock_chk_init

void lock_chk_init(void)

source

lock_chk_tracking_active

bool lock_chk_tracking_active(void)

source

Macros

LOCK_OP_IRQ_MASK

#define LOCK_OP_IRQ_MASK 0x3

source

LOCK_OP_KIND_MASK

#define LOCK_OP_KIND_MASK 0x18

source

LOCK_CHK_SITE_HERE

#define LOCK_CHK_SITE_HERE()

source

Expansion

#define LOCK_CHK_SITE_HERE() \
    ({ \
        static const struct lock_chk_site __site = { \
            .file = __RELFILE__, \
            .func = __func__, \
            .line = __LINE__, \
        }; \
        &__site; \
    })

LOCK_CHK_CLASS

#define LOCK_CHK_CLASS(id)

source

Expansion

#define LOCK_CHK_CLASS(id) (&__lock_chk_class_##id)

LOCK_CHK_CLASS_DEFINE

#define LOCK_CHK_CLASS_DEFINE(id)

source

Expansion

#define LOCK_CHK_CLASS_DEFINE(id) \
    extern const struct lock_chk_class __lock_chk_class_##id; \
    const struct lock_chk_class __lock_chk_class_##id = { \
        .name = #id, \
        .file = __RELFILE__, \
        .line = __LINE__, \
    }

LOCK_CHK_CLASS_DEFINE_LOCAL

#define LOCK_CHK_CLASS_DEFINE_LOCAL(id)

source

Expansion

#define LOCK_CHK_CLASS_DEFINE_LOCAL(id) \
    static const struct lock_chk_class __lock_chk_class_##id = { \
        .name = #id, \
        .file = __RELFILE__, \
        .line = __LINE__, \
    }

LOCK_CHK_CLASS_EXTERN

#define LOCK_CHK_CLASS_EXTERN(id)

source

Expansion

#define LOCK_CHK_CLASS_EXTERN(id) \
    extern const struct lock_chk_class __lock_chk_class_##id

LOCK_CHK_SITE_HERE

#define LOCK_CHK_SITE_HERE()

source

Expansion

#define LOCK_CHK_SITE_HERE() ((const struct lock_chk_site *) NULL)

LOCK_CHK_CLASS

#define LOCK_CHK_CLASS(id)

source

Expansion

#define LOCK_CHK_CLASS(id) ((const struct lock_chk_class *) NULL)

LOCK_CHK_CLASS_DEFINE

#define LOCK_CHK_CLASS_DEFINE(id)

source

Expansion

#define LOCK_CHK_CLASS_DEFINE(id)

LOCK_CHK_CLASS_DEFINE_LOCAL

#define LOCK_CHK_CLASS_DEFINE_LOCAL(id)

source

Expansion

#define LOCK_CHK_CLASS_DEFINE_LOCAL(id)

LOCK_CHK_CLASS_EXTERN

#define LOCK_CHK_CLASS_EXTERN(id)

source

Expansion

#define LOCK_CHK_CLASS_EXTERN(id)