Lock Validation

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

Structs

lock_chk_site

struct lock_chk_site {
    const char  *file;
    const char  *func;
    uint32_t    line;
};

lock_chk_class

struct lock_chk_class {
    const char  *name;
    const char  *file;
    uint32_t    line;
};

Enums

lock_chk_flags

enum lock_chk_flags : uint8_t {
    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 {
    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 {
    LOCK_CHK_MODE_IGNORED,
    LOCK_CHK_MODE_SHARED,
    LOCK_CHK_MODE_EXCLUSIVE,
};

lock_chk_wait_kind

enum lock_chk_wait_kind : uint8_t {
    LOCK_CHK_WAIT_BLOCKING,
    LOCK_CHK_WAIT_TRY,
};

lock_chk_engine_state

enum lock_chk_engine_state : uint8_t {
    LOCK_CHK_INACTIVE,
    LOCK_CHK_ACTIVE,
    LOCK_CHK_DEGRADED,
};

lock_debug_irq_usage

enum lock_debug_irq_usage : uint8_t {
    LOCK_DEBUG_IRQ_NONE,
    LOCK_DEBUG_IRQ_DISPATCH,
    LOCK_DEBUG_IRQ_HIGH,
};

Functions

lock_debug_spin_classify

void lock_debug_spin_classify(_Atomic uint8_t *usage, enum lock_debug_irq_usage requested, struct lock_chk_lock *lock, const struct lock_chk_site *site);

lock_debug_spin_push

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

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

lock_debug_spin_pop

void lock_debug_spin_pop(struct lock_chk_lock *lock);

lock_chk_note_lock_use

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

lock_chk_assert_schedulable

void lock_chk_assert_schedulable(const struct lock_chk_site *site);

lock_debug_spin_classify

void lock_debug_spin_classify(_Atomic uint8_t *usage, enum lock_debug_irq_usage requested, void *instance, enum lock_chk_type type, const struct lock_chk_site *site);

lock_debug_spin_push

bool lock_debug_spin_push(void *instance, enum lock_chk_type type, enum irql prev_irql, const struct lock_chk_site *site);

lock_debug_spin_validate_top

void lock_debug_spin_validate_top(void *instance, enum lock_chk_type type, enum irql prev_irql, const struct lock_chk_site *site);

lock_debug_spin_pop

void lock_debug_spin_pop(void *instance, enum lock_chk_type type);

lock_chk_note_lock_use

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

lock_chk_assert_schedulable

void lock_chk_assert_schedulable(const struct lock_chk_site *site);

lock_chk_init

void lock_chk_init(void);

lock_chk_tracking_active

bool lock_chk_tracking_active(void);

Macros

LOCK_CHK_SITE_HERE

#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) (&__lock_chk_class_##id)

LOCK_CHK_CLASS_DECLARE

#define LOCK_CHK_CLASS_DECLARE(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_DECLARE_LOCAL

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

LOCK_CHK_CLASS_DEFINE

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

LOCK_CHK_SITE_HERE

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

LOCK_CHK_CLASS

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

LOCK_CHK_CLASS_DECLARE

#define LOCK_CHK_CLASS_DECLARE(id)

LOCK_CHK_CLASS_DECLARE_LOCAL

#define LOCK_CHK_CLASS_DECLARE_LOCAL(id)

LOCK_CHK_CLASS_DEFINE

#define LOCK_CHK_CLASS_DEFINE(id)

---