cm_x.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	GET_HASH_KEY(ConvKey)    ((CMP_HASH_IRRATIONAL * (ConvKey)) % CMP_HASH_PRIME)
#define	COMPUTE_HASH_CHAR(ConvKey, Char)    (37 * ConvKey + RtlUpcaseUnicodeChar(Char))
#define	GET_HASH_INDEX(ConvKey)    (GET_HASH_KEY(ConvKey) % CmpHashTableSize)
#define	GET_HASH_ENTRY(Table, ConvKey)    (&Table[GET_HASH_INDEX(ConvKey)])
#define	ASSERT_VALID_HASH(h)    ASSERT_KCB_VALID(CONTAINING_RECORD((h), CM_KEY_CONTROL_BLOCK, KeyHash))
#define	CMP_IS_CELL_CACHED(c)    (((c) & HCELL_CACHED) && ((c) != HCELL_NIL))
#define	CMP_GET_CACHED_CELL(c)    (ULONG_PTR)((c) & ~HCELL_CACHED)
#define	CMP_GET_CACHED_DATA(c)    (&(((PCM_CACHED_VALUE_INDEX)(CMP_GET_CACHED_CELL(c)))->Data.CellData))
#define	CMP_GET_CACHED_INDEX(c)    (&(((PCM_CACHED_ENTRY)(CMP_GET_CACHED_CELL(c)))->CellIndex))
#define	CMP_GET_CACHED_VALUE(c)    (&(((PCM_CACHED_VALUE)(CMP_GET_CACHED_CELL(c)))->KeyValue))
#define	CMP_ASSERT_REGISTRY_LOCK()
#define	CMP_ASSERT_REGISTRY_LOCK_OR_LOADING(h)
#define	CMP_ASSERT_EXCLUSIVE_REGISTRY_LOCK()
#define	CMP_ASSERT_EXCLUSIVE_REGISTRY_LOCK_OR_LOADING(h)
#define	ASSERT_KCB_VALID(k)    ASSERT((k)->Signature == CM_KCB_SIGNATURE)
#define	CmpIsKcbLockedExclusive(k)
#define	CmpAcquireKcbLockSharedByIndex(i)
#define	CmpAcquireKcbLockShared(k)
#define	CmpAcquireNcbLockExclusive(n)
#define	CmpAcquireNcbLockExclusiveByKey(k)
#define	CmpReleaseNcbLock(k)
#define	CmpReleaseNcbLockByKey(k)
#define	CMP_ASSERT_HASH_ENTRY_LOCK(k)
#define	CMP_ASSERT_KCB_LOCK(k)
#define	CmpGetAllocPageFromKcb(k)    (PCM_ALLOC_PAGE)(((ULONG_PTR)(k)) & ~(PAGE_SIZE - 1))
#define	CmpGetAllocPageFromDelayAlloc(a)    (PCM_ALLOC_PAGE)(((ULONG_PTR)(a)) & ~(PAGE_SIZE - 1))
#define	CMP_ASSERT_FLUSH_LOCK(h)

Functions
FORCEINLINE VOID	CmpAcquireKcbLockExclusiveByIndex (ULONG Index)
FORCEINLINE VOID	CmpAcquireKcbLockExclusive (PCM_KEY_CONTROL_BLOCK Kcb)
FORCEINLINE VOID	CmpAcquireKcbLockExclusiveByKey (IN ULONG ConvKey)
FORCEINLINE VOID	CmpAcquireKcbLockSharedByKey (_In_ ULONG ConvKey)
FORCEINLINE BOOLEAN	CmpTryToConvertKcbSharedToExclusive (IN PCM_KEY_CONTROL_BLOCK k)
FORCEINLINE VOID	CmpReleaseKcbLockByIndex (ULONG Index)
FORCEINLINE VOID	CmpReleaseKcbLock (PCM_KEY_CONTROL_BLOCK Kcb)
FORCEINLINE VOID	CmpReleaseKcbLockByKey (ULONG ConvKey)
FORCEINLINE VOID	CmpConvertKcbSharedToExclusive (IN PCM_KEY_CONTROL_BLOCK k)

Macro Definition Documentation

ASSERT_KCB_VALID

#define ASSERT_KCB_VALID

(

k

)

ASSERT((k)->Signature == CM_KCB_SIGNATURE)

Definition at line 95 of file cm_x.h.

ASSERT_VALID_HASH

#define ASSERT_VALID_HASH

(

h

)

ASSERT_KCB_VALID(CONTAINING_RECORD((h), CM_KEY_CONTROL_BLOCK, KeyHash))

Definition at line 41 of file cm_x.h.

CMP_ASSERT_EXCLUSIVE_REGISTRY_LOCK

#define CMP_ASSERT_EXCLUSIVE_REGISTRY_LOCK

(

)

Value:

    ASSERT((CmpSpecialBootCondition == TRUE) ||                     \
           (CmpTestRegistryLockExclusive() == TRUE))

Definition at line 80 of file cm_x.h.

CMP_ASSERT_EXCLUSIVE_REGISTRY_LOCK_OR_LOADING

#define CMP_ASSERT_EXCLUSIVE_REGISTRY_LOCK_OR_LOADING

(

h

)

Value:

    ASSERT((CmpSpecialBootCondition == TRUE) ||                     \
           (((PCMHIVE)h)->HiveIsLoading == TRUE) ||                 \
           (CmpTestRegistryLockExclusive() == TRUE))

Definition at line 87 of file cm_x.h.

CMP_ASSERT_FLUSH_LOCK

#define CMP_ASSERT_FLUSH_LOCK

(

h

)

Value:

    ASSERT((CmpSpecialBootCondition == TRUE) ||                     \
           (((PCMHIVE)h)->HiveIsLoading == TRUE) ||                 \
           (CmpTestHiveFlusherLockShared((PCMHIVE)h) == TRUE) ||    \
           (CmpTestHiveFlusherLockExclusive((PCMHIVE)h) == TRUE) || \
           (CmpTestRegistryLockExclusive() == TRUE));

Definition at line 299 of file cm_x.h.

CMP_ASSERT_HASH_ENTRY_LOCK

#define CMP_ASSERT_HASH_ENTRY_LOCK

(

k

)

Value:

{                                                                   \
    ASSERT(((GET_HASH_ENTRY(CmpCacheTable, k)->Owner ==              \
            KeGetCurrentThread())) ||                               \
           (CmpTestRegistryLockExclusive() == TRUE));               \
}

Definition at line 268 of file cm_x.h.

CMP_ASSERT_KCB_LOCK

#define CMP_ASSERT_KCB_LOCK

(

k

)

Value:

{                                                                   \
    ASSERT((CmpIsKcbLockedExclusive(k) == TRUE) ||                  \
           (CmpTestRegistryLockExclusive() == TRUE));               \
}

Definition at line 278 of file cm_x.h.

CMP_ASSERT_REGISTRY_LOCK

#define CMP_ASSERT_REGISTRY_LOCK

(

)

Value:

    ASSERT((CmpSpecialBootCondition == TRUE) ||                     \
           (CmpTestRegistryLock() == TRUE))

Definition at line 65 of file cm_x.h.

CMP_ASSERT_REGISTRY_LOCK_OR_LOADING

#define CMP_ASSERT_REGISTRY_LOCK_OR_LOADING

(

h

)

Value:

    ASSERT((CmpSpecialBootCondition == TRUE) ||                     \
           (((PCMHIVE)h)->HiveIsLoading == TRUE) ||                 \
           (CmpTestRegistryLock() == TRUE))

Definition at line 72 of file cm_x.h.

CMP_GET_CACHED_CELL

#define CMP_GET_CACHED_CELL

(

c

)

(ULONG_PTR)((c) & ~HCELL_CACHED)

Definition at line 53 of file cm_x.h.

CMP_GET_CACHED_DATA

#define CMP_GET_CACHED_DATA

(

c

)

(&(((PCM_CACHED_VALUE_INDEX)(CMP_GET_CACHED_CELL(c)))->Data.CellData))

Definition at line 55 of file cm_x.h.

CMP_GET_CACHED_INDEX

#define CMP_GET_CACHED_INDEX

(

c

)

(&(((PCM_CACHED_ENTRY)(CMP_GET_CACHED_CELL(c)))->CellIndex))

Definition at line 57 of file cm_x.h.

CMP_GET_CACHED_VALUE

#define CMP_GET_CACHED_VALUE

(

c

)

(&(((PCM_CACHED_VALUE)(CMP_GET_CACHED_CELL(c)))->KeyValue))

Definition at line 59 of file cm_x.h.

CMP_IS_CELL_CACHED

#define CMP_IS_CELL_CACHED

(

c

)

(((c) & HCELL_CACHED) && ((c) != HCELL_NIL))

Definition at line 47 of file cm_x.h.

CmpAcquireKcbLockShared

#define CmpAcquireKcbLockShared

(

k

)

Value:

{                                                                   \
    ExAcquirePushLockShared(&GET_HASH_ENTRY(CmpCacheTable,          \
                                            (k)->ConvKey)->Lock);    \
}

Definition at line 162 of file cm_x.h.

CmpAcquireKcbLockSharedByIndex

#define CmpAcquireKcbLockSharedByIndex

(

i

)

Value:

{                                                                   \
    ExAcquirePushLockShared(&CmpCacheTable[(i)].Lock);              \
}

Definition at line 108 of file cm_x.h.

CmpAcquireNcbLockExclusive

#define CmpAcquireNcbLockExclusive

(

n

)

Value:

{                                                                   \
    ExAcquirePushLockExclusive(&GET_HASH_ENTRY(CmpNameCacheTable,   \
                                              (n)->ConvKey)->Lock);  \
}

Definition at line 232 of file cm_x.h.

CmpAcquireNcbLockExclusiveByKey

#define CmpAcquireNcbLockExclusiveByKey

(

k

)

Value:

{                                                                   \
    ExAcquirePushLockExclusive(&GET_HASH_ENTRY(CmpNameCacheTable,   \
                                               (k))->Lock);          \
}

Definition at line 241 of file cm_x.h.

CmpGetAllocPageFromDelayAlloc

#define CmpGetAllocPageFromDelayAlloc

(

a

)

(PCM_ALLOC_PAGE)(((ULONG_PTR)(a)) & ~(PAGE_SIZE - 1))

Definition at line 293 of file cm_x.h.

CmpGetAllocPageFromKcb

#define CmpGetAllocPageFromKcb

(

k

)

(PCM_ALLOC_PAGE)(((ULONG_PTR)(k)) & ~(PAGE_SIZE - 1))

Definition at line 287 of file cm_x.h.

CmpIsKcbLockedExclusive

#define CmpIsKcbLockedExclusive

(

k

)

Value:

    (GET_HASH_ENTRY(CmpCacheTable,                                  \
                    (k)->ConvKey)->Owner == KeGetCurrentThread())

Definition at line 101 of file cm_x.h.

CmpReleaseNcbLock

#define CmpReleaseNcbLock

(

k

)

Value:

{                                                                   \
    ExReleasePushLock(&GET_HASH_ENTRY(CmpNameCacheTable,            \
                                     (k)->ConvKey)->Lock);           \
}

Definition at line 250 of file cm_x.h.

CmpReleaseNcbLockByKey

#define CmpReleaseNcbLockByKey

(

k

)

Value:

{                                                                   \
    ExReleasePushLock(&GET_HASH_ENTRY(CmpNameCacheTable,            \
                                      (k))->Lock);                   \
}

Definition at line 259 of file cm_x.h.

COMPUTE_HASH_CHAR

#define COMPUTE_HASH_CHAR	(		ConvKey,
			Char
	)		(37 * ConvKey + RtlUpcaseUnicodeChar(Char))

Definition at line 31 of file cm_x.h.

GET_HASH_ENTRY

#define GET_HASH_ENTRY	(		Table,
			ConvKey
	)		(&Table[GET_HASH_INDEX(ConvKey)])

Definition at line 39 of file cm_x.h.

GET_HASH_INDEX

#define GET_HASH_INDEX

(

ConvKey

)

(GET_HASH_KEY(ConvKey) % CmpHashTableSize)

Definition at line 37 of file cm_x.h.

GET_HASH_KEY

#define GET_HASH_KEY

(

ConvKey

)

((CMP_HASH_IRRATIONAL * (ConvKey)) % CMP_HASH_PRIME)

Definition at line 25 of file cm_x.h.

Function Documentation

CmpAcquireKcbLockExclusive()

FORCEINLINE VOID CmpAcquireKcbLockExclusive

(

PCM_KEY_CONTROL_BLOCK

Kcb

)

Definition at line 133 of file cm_x.h.

{
    CmpAcquireKcbLockExclusiveByIndex(GET_HASH_INDEX(Kcb->ConvKey));
}

Referenced by CmDeleteValueKey(), CmpConvertKcbSharedToExclusive(), CmpCreateKeyControlBlock(), CmpDereferenceKeyControlBlock(), CmpSecurityMethod(), DelistKeyBodyFromKCB(), and EnlistKeyBodyWithKCB().

CmpAcquireKcbLockExclusiveByIndex()

FORCEINLINE VOID CmpAcquireKcbLockExclusiveByIndex

(

ULONG

Index

)

Definition at line 118 of file cm_x.h.

{
    ASSERT(CmpCacheTable[Index].Owner != KeGetCurrentThread());
    ExAcquirePushLockExclusive(&CmpCacheTable[Index].Lock);
    CmpCacheTable[Index].Owner = KeGetCurrentThread();
#if DBG
    CmpCaptureLockBackTraceByIndex(Index);
#endif
}

Referenced by CmpAcquireKcbLockExclusive(), CmpAcquireKcbLockExclusiveByKey(), CmpDoOpen(), and CmpLockKcbArray().

CmpAcquireKcbLockExclusiveByKey()

FORCEINLINE VOID CmpAcquireKcbLockExclusiveByKey

(

IN ULONG

ConvKey

)

Definition at line 143 of file cm_x.h.

{
    CmpAcquireKcbLockExclusiveByIndex(GET_HASH_INDEX(ConvKey));
}

Referenced by _Function_class_(), and CmpAcquireTwoKcbLocksExclusiveByKey().

CmpAcquireKcbLockSharedByKey()

FORCEINLINE VOID CmpAcquireKcbLockSharedByKey

(

_In_ ULONG

ConvKey

)

Definition at line 153 of file cm_x.h.

{
    CmpAcquireKcbLockSharedByIndex(GET_HASH_INDEX(ConvKey));
}

CmpConvertKcbSharedToExclusive()

FORCEINLINE VOID CmpConvertKcbSharedToExclusive

(

IN PCM_KEY_CONTROL_BLOCK

k

)

Definition at line 222 of file cm_x.h.

{
    ASSERT(CmpIsKcbLockedExclusive(k) == FALSE);
    CmpReleaseKcbLock(k);
    CmpAcquireKcbLockExclusive(k);
}

Referenced by CmEnumerateValueKey(), CmpReferenceKeyControlBlock(), CmQueryValueKey(), and CmSetValueKey().

CmpReleaseKcbLock()

FORCEINLINE VOID CmpReleaseKcbLock

(

PCM_KEY_CONTROL_BLOCK

Kcb

)

Definition at line 202 of file cm_x.h.

{
    CmpReleaseKcbLockByIndex(GET_HASH_INDEX(Kcb->ConvKey));
}

Referenced by CmDeleteValueKey(), CmEnumerateKey(), CmEnumerateValueKey(), CmpConvertKcbSharedToExclusive(), CmpQueryKeyName(), CmpSecurityMethod(), CmQueryKey(), CmQueryValueKey(), CmSaveKey(), CmSaveMergedKeys(), CmSetValueKey(), DelistKeyBodyFromKCB(), EnlistKeyBodyWithKCB(), and NtFlushKey().

CmpReleaseKcbLockByIndex()

FORCEINLINE VOID CmpReleaseKcbLockByIndex

(

ULONG

Index

)

Definition at line 191 of file cm_x.h.

{
    CmpCacheTable[Index].Owner = NULL;
    ExReleasePushLock(&CmpCacheTable[Index].Lock);
}

Referenced by CmpReleaseKcbLock(), CmpReleaseKcbLockByKey(), and CmpUnLockKcbArray().

CmpReleaseKcbLockByKey()

FORCEINLINE VOID CmpReleaseKcbLockByKey

(

ULONG

ConvKey

)

Definition at line 212 of file cm_x.h.

{
    CmpReleaseKcbLockByIndex(GET_HASH_INDEX(ConvKey));
}

Referenced by _Function_class_(), CmpCreateKeyControlBlock(), CmpDereferenceKeyControlBlock(), and CmpReleaseTwoKcbLockByKey().

CmpTryToConvertKcbSharedToExclusive()

FORCEINLINE BOOLEAN CmpTryToConvertKcbSharedToExclusive

(

IN PCM_KEY_CONTROL_BLOCK

k

)

Definition at line 173 of file cm_x.h.

{
    ASSERT(CmpIsKcbLockedExclusive(k) == FALSE);
    if (ExConvertPushLockSharedToExclusive(
            &GET_HASH_ENTRY(CmpCacheTable, k->ConvKey)->Lock))
    {
        GET_HASH_ENTRY(CmpCacheTable,
                       k->ConvKey)->Owner = KeGetCurrentThread();
        return TRUE;
    }
    return FALSE;
}

Referenced by CmpCompareNewValueDataAgainstKCBCache(), CmpGetValueListFromCache(), CmpReferenceKeyControlBlock(), and CmSetValueKey().