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

Classes
struct	_ARBITER_ALTERNATIVE

struct	_ARBITER_ALLOCATION_STATE

struct	_ARBITER_ORDERING

struct	_ARBITER_ORDERING_LIST

struct	_ARBITER_INSTANCE

Macros
#define	TAG_ARBITER 'ibrA'

#define	ARBITER_PRIORITY_NULL 0x00000000

#define	ARBITER_PRIORITY_PREFERRED_RESERVED 0x7FFFFFFD

#define	ARBITER_PRIORITY_RESERVED 0x7FFFFFFE

#define	ARBITER_PRIORITY_EXHAUSTED 0x7FFFFFFF

#define	ARBITER_ALTERNATIVE_FLAG_FIXED 0x00000001

#define	ARBITER_ALTERNATIVE_FLAG_SHARED 0x00000002

#define	ARBITER_RANGE_SHARED_DRIVER 0x0

#define	ARBITER_RANGE_BOOT_ALLOCATED 0x04

#define	ARBITER_STATE_FLAG_NULL_CONFLICT_OK 0x0001

Typedefs
typedef struct _ARBITER_ALTERNATIVE	ARBITER_ALTERNATIVE

typedef struct _ARBITER_ALTERNATIVE *	PARBITER_ALTERNATIVE

typedef struct _ARBITER_ALLOCATION_STATE	ARBITER_ALLOCATION_STATE

typedef struct _ARBITER_ALLOCATION_STATE *	PARBITER_ALLOCATION_STATE

typedef struct _ARBITER_ORDERING	ARBITER_ORDERING

typedef struct _ARBITER_ORDERING *	PARBITER_ORDERING

typedef struct _ARBITER_ORDERING_LIST	ARBITER_ORDERING_LIST

typedef struct _ARBITER_ORDERING_LIST *	PARBITER_ORDERING_LIST

typedef struct _ARBITER_INSTANCE *	PARBITER_INSTANCE

typedef NTSTATUS(NTAPI *	PARB_UNPACK_REQUIREMENT) (_In_ PIO_RESOURCE_DESCRIPTOR IoDescriptor, _Out_ PUINT64 OutMinimumAddress, _Out_ PUINT64 OutMaximumAddress, _Out_ PUINT64 OutLength, _Out_ PUINT64 OutAlignment)

typedef NTSTATUS(NTAPI *	PARB_PACK_RESOURCE) (_In_ PIO_RESOURCE_DESCRIPTOR IoDescriptor, _In_ UINT64 Start, _Out_ PCM_PARTIAL_RESOURCE_DESCRIPTOR CmDescriptor)

typedef NTSTATUS(NTAPI *	PARB_UNPACK_RESOURCE) (_In_ PCM_PARTIAL_RESOURCE_DESCRIPTOR CmDescriptor, _Out_ PUINT64 Start, _Out_ PUINT64 OutLength)

typedef INT32(NTAPI *	PARB_SCORE_REQUIREMENT) (_In_ PIO_RESOURCE_DESCRIPTOR IoDescriptor)

typedef NTSTATUS(NTAPI *	PARB_TEST_ALLOCATION) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_TEST_ALLOCATION_PARAMETERS Parameters)

typedef NTSTATUS(NTAPI *	PARB_RETEST_ALLOCATION) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_RETEST_ALLOCATION_PARAMETERS Parameters)

typedef NTSTATUS(NTAPI *	PARB_BOOT_ALLOCATION) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_BOOT_ALLOCATION_PARAMETERS Parameters)

typedef NTSTATUS(NTAPI *	PARB_QUERY_ARBITRATE) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_QUERY_ARBITRATE_PARAMETERS Parameters)

typedef NTSTATUS(NTAPI *	PARB_QUERY_CONFLICT) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_QUERY_CONFLICT_PARAMETERS Parameters)

typedef NTSTATUS(NTAPI *	PARB_ADD_RESERVED) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ADD_RESERVED_PARAMETERS Parameters)

typedef NTSTATUS(NTAPI *	PARB_COMMIT_ALLOCATION) (_In_ PARBITER_INSTANCE Arbiter)

typedef NTSTATUS(NTAPI *	PARB_ROLLBACK_ALLOCATION) (_In_ PARBITER_INSTANCE Arbiter)

typedef NTSTATUS(NTAPI *	PARB_START_ARBITER) (_In_ PARBITER_INSTANCE Arbiter, _In_ PCM_RESOURCE_LIST StartResources)

typedef NTSTATUS(NTAPI *	PARB_PREPROCESS_ENTRY) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)

typedef NTSTATUS(NTAPI *	PARB_ALLOCATE_ENTRY) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)

typedef BOOLEAN(NTAPI *	PARB_GET_NEXT_ALLOCATION_RANGE) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)

typedef BOOLEAN(NTAPI *	PARB_FIND_SUITABLE_RANGE) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)

typedef VOID(NTAPI *	PARB_ADD_ALLOCATION) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)

typedef VOID(NTAPI *	PARB_BACKTRACK_ALLOCATION) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)

typedef BOOLEAN(NTAPI *	PARB_OVERRIDE_CONFLICT) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)

typedef NTSTATUS(NTAPI *	PARB_TRANSLATE_ORDERING) (_Out_ PIO_RESOURCE_DESCRIPTOR OutIoDescriptor, _In_ PIO_RESOURCE_DESCRIPTOR IoDescriptor)

typedef NTSTATUS(NTAPI *	PARB_INITIALIZE_RANGE_LIST) (_In_ PARBITER_INSTANCE Arbiter, _In_ ULONG DescriptorCount, _In_ PCM_PARTIAL_RESOURCE_DESCRIPTOR Descriptors, _Inout_ PRTL_RANGE_LIST RangeList)

typedef struct _ARBITER_INSTANCE	ARBITER_INSTANCE

Functions
NTSTATUS NTAPI	ArbiterLibInitializeInstance (_Inout_ PARBITER_INSTANCE Arbiter, _In_ PDEVICE_OBJECT BusDeviceObject, _In_ CM_RESOURCE_TYPE ResourceType, _In_ PCWSTR ArbiterName, _In_ PCWSTR OrderName, _In_ PARB_TRANSLATE_ORDERING TranslateOrderingFunction)

VOID NTAPI	ArbiterLibDeleteInstance (_In_ PARBITER_INSTANCE Arbiter)

VOID NTAPI	ArbiterLibFreeOrderingList (_Inout_ PARBITER_ORDERING_LIST OrderingList)

NTSTATUS NTAPI	ArbiterLibAddOrdering (_Inout_ PARBITER_ORDERING_LIST OrderingList, _In_ UINT64 Start, _In_ UINT64 End)

NTSTATUS NTAPI	ArbiterLibDefaultAssignmentOrdering (_Inout_ PARBITER_INSTANCE Arbiter, _In_ PCWSTR AllocationOrderName, _In_ PCWSTR ReservedResourcesName, _In_opt_ PARB_TRANSLATE_ORDERING TranslateOrderingFunction)

NTSTATUS NTAPI	ArbiterLibHandler (_In_ PVOID Context, _In_ ARBITER_ACTION Action, _Inout_ PARBITER_PARAMETERS Parameters)

NTSTATUS NTAPI	ArbiterLibTestAllocation (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_TEST_ALLOCATION_PARAMETERS Parameters)

NTSTATUS NTAPI	ArbiterLibRetestAllocation (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_RETEST_ALLOCATION_PARAMETERS Parameters)

NTSTATUS NTAPI	ArbiterLibBootAllocation (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_BOOT_ALLOCATION_PARAMETERS Parameters)

NTSTATUS NTAPI	ArbiterLibQueryConflict (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_QUERY_CONFLICT_PARAMETERS Parameters)

NTSTATUS NTAPI	ArbiterLibCommitAllocation (_In_ PARBITER_INSTANCE Arbiter)

NTSTATUS NTAPI	ArbiterLibRollbackAllocation (_In_ PARBITER_INSTANCE Arbiter)

BOOLEAN NTAPI	ArbiterLibGetNextAllocationRange (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)
	Moves the working window to the next candidate range, walking the entry's alternatives in priority order across the arbiter's ordering list.

BOOLEAN NTAPI	ArbiterLibFindSuitableRange (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)
	Finds a free range of the current candidate window in the arbiter's tentative allocation list.

VOID NTAPI	ArbiterLibAddAllocation (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)
	Records the chosen placement in the arbiter's tentative allocation list, owned by the requesting device.

VOID NTAPI	ArbiterLibBacktrackAllocation (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)
	Undoes the last AddAllocation performed for this entry.

Macro Definition Documentation

◆ ARBITER_ALTERNATIVE_FLAG_FIXED

#define ARBITER_ALTERNATIVE_FLAG_FIXED 0x00000001

Definition at line 28 of file arbiter.h.

◆ ARBITER_ALTERNATIVE_FLAG_SHARED

#define ARBITER_ALTERNATIVE_FLAG_SHARED 0x00000002

Definition at line 29 of file arbiter.h.

◆ ARBITER_PRIORITY_EXHAUSTED

#define ARBITER_PRIORITY_EXHAUSTED 0x7FFFFFFF

Definition at line 25 of file arbiter.h.

◆ ARBITER_PRIORITY_NULL

#define ARBITER_PRIORITY_NULL 0x00000000

Definition at line 22 of file arbiter.h.

◆ ARBITER_PRIORITY_PREFERRED_RESERVED

#define ARBITER_PRIORITY_PREFERRED_RESERVED 0x7FFFFFFD

Definition at line 23 of file arbiter.h.

◆ ARBITER_PRIORITY_RESERVED

#define ARBITER_PRIORITY_RESERVED 0x7FFFFFFE

Definition at line 24 of file arbiter.h.

◆ ARBITER_RANGE_BOOT_ALLOCATED

#define ARBITER_RANGE_BOOT_ALLOCATED 0x04

Definition at line 41 of file arbiter.h.

◆ ARBITER_RANGE_SHARED_DRIVER

#define ARBITER_RANGE_SHARED_DRIVER 0x0

Definition at line 40 of file arbiter.h.

◆ ARBITER_STATE_FLAG_NULL_CONFLICT_OK

#define ARBITER_STATE_FLAG_NULL_CONFLICT_OK 0x0001

Definition at line 44 of file arbiter.h.

◆ TAG_ARBITER

#define TAG_ARBITER 'ibrA'

Definition at line 10 of file arbiter.h.

Typedef Documentation

◆ ARBITER_ALLOCATION_STATE

typedef struct _ARBITER_ALLOCATION_STATE ARBITER_ALLOCATION_STATE

◆ ARBITER_ALTERNATIVE

typedef struct _ARBITER_ALTERNATIVE ARBITER_ALTERNATIVE

◆ ARBITER_INSTANCE

typedef struct _ARBITER_INSTANCE ARBITER_INSTANCE

◆ ARBITER_ORDERING

typedef struct _ARBITER_ORDERING ARBITER_ORDERING

◆ ARBITER_ORDERING_LIST

typedef struct _ARBITER_ORDERING_LIST ARBITER_ORDERING_LIST

◆ PARB_ADD_ALLOCATION

typedef VOID(NTAPI * PARB_ADD_ALLOCATION) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)

Definition at line 241 of file arbiter.h.

◆ PARB_ADD_RESERVED

typedef NTSTATUS(NTAPI * PARB_ADD_RESERVED) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ADD_RESERVED_PARAMETERS Parameters)

Definition at line 153 of file arbiter.h.

◆ PARB_ALLOCATE_ENTRY

typedef NTSTATUS(NTAPI * PARB_ALLOCATE_ENTRY) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)

Definition at line 223 of file arbiter.h.

◆ PARB_BACKTRACK_ALLOCATION

typedef VOID(NTAPI * PARB_BACKTRACK_ALLOCATION) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)

Definition at line 247 of file arbiter.h.

◆ PARB_BOOT_ALLOCATION

typedef NTSTATUS(NTAPI * PARB_BOOT_ALLOCATION) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_BOOT_ALLOCATION_PARAMETERS Parameters)

Definition at line 135 of file arbiter.h.

◆ PARB_COMMIT_ALLOCATION

typedef NTSTATUS(NTAPI * PARB_COMMIT_ALLOCATION) (_In_ PARBITER_INSTANCE Arbiter)

Definition at line 201 of file arbiter.h.

◆ PARB_FIND_SUITABLE_RANGE

typedef BOOLEAN(NTAPI * PARB_FIND_SUITABLE_RANGE) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)

Definition at line 235 of file arbiter.h.

◆ PARB_GET_NEXT_ALLOCATION_RANGE

typedef BOOLEAN(NTAPI * PARB_GET_NEXT_ALLOCATION_RANGE) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)

Definition at line 229 of file arbiter.h.

◆ PARB_INITIALIZE_RANGE_LIST

typedef NTSTATUS(NTAPI * PARB_INITIALIZE_RANGE_LIST) (_In_ PARBITER_INSTANCE Arbiter, _In_ ULONG DescriptorCount, _In_ PCM_PARTIAL_RESOURCE_DESCRIPTOR Descriptors, _Inout_ PRTL_RANGE_LIST RangeList)

Definition at line 266 of file arbiter.h.

◆ PARB_OVERRIDE_CONFLICT

typedef BOOLEAN(NTAPI * PARB_OVERRIDE_CONFLICT) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)

Definition at line 253 of file arbiter.h.

◆ PARB_PACK_RESOURCE

typedef NTSTATUS(NTAPI * PARB_PACK_RESOURCE) (_In_ PIO_RESOURCE_DESCRIPTOR IoDescriptor, _In_ UINT64 Start, _Out_ PCM_PARTIAL_RESOURCE_DESCRIPTOR CmDescriptor)

Definition at line 103 of file arbiter.h.

◆ PARB_PREPROCESS_ENTRY

typedef NTSTATUS(NTAPI * PARB_PREPROCESS_ENTRY) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)

Definition at line 217 of file arbiter.h.

◆ PARB_QUERY_ARBITRATE

typedef NTSTATUS(NTAPI * PARB_QUERY_ARBITRATE) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_QUERY_ARBITRATE_PARAMETERS Parameters)

Definition at line 141 of file arbiter.h.

◆ PARB_QUERY_CONFLICT

typedef NTSTATUS(NTAPI * PARB_QUERY_CONFLICT) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_QUERY_CONFLICT_PARAMETERS Parameters)

Definition at line 147 of file arbiter.h.

◆ PARB_RETEST_ALLOCATION

typedef NTSTATUS(NTAPI * PARB_RETEST_ALLOCATION) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_RETEST_ALLOCATION_PARAMETERS Parameters)

Definition at line 129 of file arbiter.h.

◆ PARB_ROLLBACK_ALLOCATION

typedef NTSTATUS(NTAPI * PARB_ROLLBACK_ALLOCATION) (_In_ PARBITER_INSTANCE Arbiter)

Definition at line 206 of file arbiter.h.

◆ PARB_SCORE_REQUIREMENT

typedef INT32(NTAPI * PARB_SCORE_REQUIREMENT) (_In_ PIO_RESOURCE_DESCRIPTOR IoDescriptor)

Definition at line 117 of file arbiter.h.

◆ PARB_START_ARBITER

typedef NTSTATUS(NTAPI * PARB_START_ARBITER) (_In_ PARBITER_INSTANCE Arbiter, _In_ PCM_RESOURCE_LIST StartResources)

Definition at line 211 of file arbiter.h.

◆ PARB_TEST_ALLOCATION

typedef NTSTATUS(NTAPI * PARB_TEST_ALLOCATION) (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_TEST_ALLOCATION_PARAMETERS Parameters)

Definition at line 123 of file arbiter.h.

◆ PARB_TRANSLATE_ORDERING

typedef NTSTATUS(NTAPI * PARB_TRANSLATE_ORDERING) (_Out_ PIO_RESOURCE_DESCRIPTOR OutIoDescriptor, _In_ PIO_RESOURCE_DESCRIPTOR IoDescriptor)

Definition at line 259 of file arbiter.h.

◆ PARB_UNPACK_REQUIREMENT

typedef NTSTATUS(NTAPI * PARB_UNPACK_REQUIREMENT) (_In_ PIO_RESOURCE_DESCRIPTOR IoDescriptor, _Out_ PUINT64 OutMinimumAddress, _Out_ PUINT64 OutMaximumAddress, _Out_ PUINT64 OutLength, _Out_ PUINT64 OutAlignment)

Definition at line 94 of file arbiter.h.

◆ PARB_UNPACK_RESOURCE

typedef NTSTATUS(NTAPI * PARB_UNPACK_RESOURCE) (_In_ PCM_PARTIAL_RESOURCE_DESCRIPTOR CmDescriptor, _Out_ PUINT64 Start, _Out_ PUINT64 OutLength)

Definition at line 110 of file arbiter.h.

◆ PARBITER_ALLOCATION_STATE

typedef struct _ARBITER_ALLOCATION_STATE * PARBITER_ALLOCATION_STATE

◆ PARBITER_ALTERNATIVE

typedef struct _ARBITER_ALTERNATIVE * PARBITER_ALTERNATIVE

◆ PARBITER_INSTANCE

typedef struct _ARBITER_INSTANCE * PARBITER_INSTANCE

Definition at line 92 of file arbiter.h.

◆ PARBITER_ORDERING

typedef struct _ARBITER_ORDERING * PARBITER_ORDERING

◆ PARBITER_ORDERING_LIST

typedef struct _ARBITER_ORDERING_LIST * PARBITER_ORDERING_LIST

Function Documentation

◆ ArbiterLibAddAllocation()

VOID NTAPI ArbiterLibAddAllocation	(	_In_ PARBITER_INSTANCE	Arbiter,
		_Inout_ PARBITER_ALLOCATION_STATE	ArbState
	)

Records the chosen placement in the arbiter's tentative allocation list, owned by the requesting device.

Parameters

[in]	Arbiter	The arbiter instance whose PossibleAllocation list receives the range.
[in,out]	ArbState	The allocation state whose Start, End and RangeAttributes describe the placement. The range is owned by the entry's physical device object.

Remarks: ADD_IF_CONFLICT is required because override solutions intentionally overlap existing ranges.

Definition at line 618 of file range.c.

{
    ULONG Flags = RTL_RANGE_LIST_ADD_IF_CONFLICT;
 
    PAGED_CODE();
 
    if (ArbState->CurrentAlternative != NULL &&
        (ArbState->CurrentAlternative->Flags & ARBITER_ALTERNATIVE_FLAG_SHARED))
    {
        Flags |= RTL_RANGE_LIST_ADD_SHARED;
    }
 
    RtlAddRange(Arbiter->PossibleAllocation,
                ArbState->Start,
                ArbState->End,
                ArbState->RangeAttributes,
                Flags,
                NULL,
                ArbState->Entry ? ArbState->Entry->PhysicalDeviceObject : NULL);
}

Referenced by ArbiterLibInitializeInstance().

◆ ArbiterLibAddOrdering()

NTSTATUS NTAPI ArbiterLibAddOrdering	(	_Inout_ PARBITER_ORDERING_LIST	OrderingList,
		_In_ UINT64	Start,
		_In_ UINT64	End
	)

Definition at line 70 of file ordering.c.

{
    PAGED_CODE();
 
    if (End < Start)
        return STATUS_INVALID_PARAMETER;
 
    /* Double the array capacity when it fills up, up to the sanity cap. */
    if (OrderingList->Count == OrderingList->Maximum)
    {
        ULONG NewMaximum;
        PARBITER_ORDERING NewArray;
 
        NewMaximum = OrderingList->Maximum ? (ULONG)OrderingList->Maximum * 2
                                           : ARBITER_ORDERING_GRANULARITY;
        if (NewMaximum > ARBITER_ORDERING_LIMIT)
            return STATUS_INSUFFICIENT_RESOURCES;
 
        NewArray = ExAllocatePoolWithTag(PagedPool,
                                         NewMaximum * sizeof(ARBITER_ORDERING),
                                         TAG_ARBITER);
        if (NewArray == NULL)
            return STATUS_INSUFFICIENT_RESOURCES;
 
        if (OrderingList->Orderings != NULL)
        {
            RtlCopyMemory(NewArray, OrderingList->Orderings,
                          OrderingList->Count * sizeof(ARBITER_ORDERING));
            ExFreePoolWithTag(OrderingList->Orderings, TAG_ARBITER);
        }
 
        OrderingList->Maximum = (UINT16)NewMaximum;
        OrderingList->Orderings = NewArray;
    }
 
    OrderingList->Orderings[OrderingList->Count].Start = Start;
    OrderingList->Orderings[OrderingList->Count].End = End;
    OrderingList->Count++;
    return STATUS_SUCCESS;
}

Referenced by ArbiterLibDefaultAssignmentOrdering(), and ArbpAddOrderingCallback().

◆ ArbiterLibBacktrackAllocation()

VOID NTAPI ArbiterLibBacktrackAllocation	(	_In_ PARBITER_INSTANCE	Arbiter,
		_Inout_ PARBITER_ALLOCATION_STATE	ArbState
	)

Undoes the last AddAllocation performed for this entry.

Parameters

[in]	Arbiter	The arbiter instance whose PossibleAllocation list the tentative range is deleted from.
[in,out]	ArbState	The allocation state whose Start and End describe the placement being removed sanity checked by the entry's physical device object.

Definition at line 656 of file range.c.

{
    PAGED_CODE();
 
    RtlDeleteRange(Arbiter->PossibleAllocation,
                   ArbState->Start,
                   ArbState->End,
                   ArbState->Entry ? ArbState->Entry->PhysicalDeviceObject : NULL);
}

Referenced by ArbiterLibInitializeInstance().

◆ ArbiterLibBootAllocation()

NTSTATUS NTAPI ArbiterLibBootAllocation	(	_In_ PARBITER_INSTANCE	Arbiter,
		_Inout_ PARBITER_BOOT_ALLOCATION_PARAMETERS	Parameters
	)

Definition at line 61 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbiterLibInitializeInstance().

◆ ArbiterLibCommitAllocation()

NTSTATUS NTAPI ArbiterLibCommitAllocation ( _In_ PARBITER_INSTANCE Arbiter )

Definition at line 138 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbiterLibInitializeInstance().

◆ ArbiterLibDefaultAssignmentOrdering()

NTSTATUS NTAPI ArbiterLibDefaultAssignmentOrdering	(	_Inout_ PARBITER_INSTANCE	Arbiter,
		_In_ PCWSTR	AllocationOrderName,
		_In_ PCWSTR	ReservedResourcesName,
		_In_opt_ PARB_TRANSLATE_ORDERING	TranslateOrderingFunction
	)

Definition at line 328 of file ordering.c.

{
    NTSTATUS Status;
 
    PAGED_CODE();
 
    UNREFERENCED_PARAMETER(ReservedResourcesName);
    UNREFERENCED_PARAMETER(TranslateOrderingFunction);
 
    ArbiterLibFreeOrderingList(&Arbiter->OrderingList);
    ArbiterLibFreeOrderingList(&Arbiter->ReservedList);
 
    Status = ArbpCreateOrderingList(&Arbiter->OrderingList);
    if (!NT_SUCCESS(Status))
        return Status;
    Status = ArbpCreateOrderingList(&Arbiter->ReservedList);
    if (!NT_SUCCESS(Status))
    {
        ArbiterLibFreeOrderingList(&Arbiter->OrderingList);
        return Status;
    }
 
    ArbpForEachRegistryRange(Arbiter, L"AllocationOrder", AllocationOrderName,
                             ArbpAddOrderingCallback, NULL);
 
    return ArbiterLibAddOrdering(&Arbiter->OrderingList, 0, 0xFFFFFFFFFFFFFFFFULL);
}

Referenced by ArbiterLibInitializeInstance(), and ario_ApplyBrokenVideoHack().

◆ ArbiterLibDeleteInstance()

VOID NTAPI ArbiterLibDeleteInstance ( _In_ PARBITER_INSTANCE Arbiter )

Definition at line 252 of file arbiter.c.

{
    PAGED_CODE();
 
    if (Arbiter->PossibleAllocation)
    {
        RtlFreeRangeList(Arbiter->PossibleAllocation);
        ExFreePoolWithTag(Arbiter->PossibleAllocation, TAG_ARBITER);
        Arbiter->PossibleAllocation = NULL;
    }
 
    if (Arbiter->Allocation)
    {
        RtlFreeRangeList(Arbiter->Allocation);
        ExFreePoolWithTag(Arbiter->Allocation, TAG_ARBITER);
        Arbiter->Allocation = NULL;
    }
 
    if (Arbiter->AllocationStack)
    {
        ExFreePoolWithTag(Arbiter->AllocationStack, TAG_ARBITER);
        Arbiter->AllocationStack = NULL;
        Arbiter->AllocationStackMaxSize = 0;
    }
 
    ArbiterLibFreeOrderingList(&Arbiter->OrderingList);
    ArbiterLibFreeOrderingList(&Arbiter->ReservedList);
 
#if (NTDDI_VERSION >= NTDDI_VISTA)
    if (Arbiter->TransactionEvent)
    {
        ExFreePoolWithTag(Arbiter->TransactionEvent, TAG_ARBITER);
        Arbiter->TransactionEvent = NULL;
    }
#endif
 
    if (Arbiter->MutexEvent)
    {
        ExFreePoolWithTag(Arbiter->MutexEvent, TAG_ARBITER);
        Arbiter->MutexEvent = NULL;
    }
}

Referenced by ArbiterLibInitializeInstance().

◆ ArbiterLibFindSuitableRange()

BOOLEAN NTAPI ArbiterLibFindSuitableRange	(	_In_ PARBITER_INSTANCE	Arbiter,
		_Inout_ PARBITER_ALLOCATION_STATE	ArbState
	)

Finds a free range of the current candidate window in the arbiter's tentative allocation list.

Parameters

[in]	Arbiter	The arbiter instance whose PossibleAllocation list is searched.
[in,out]	ArbState	The allocation state of the entry being placed. On success, Start and End receive the chosen window.

Returns: Returns TRUE if a placement was found,FALSE if the window cannot satisfy the requirement.

Remarks: Legacy requests treat boot-allocated ranges as available. When RtlFindRange reports a conflict, a driver-exclusive requirement may still share the range (ArbpShareDriverExclusive), and failing that the arbiter's OverrideConflict callback gets a last-chance override. this is how a device is re-assigned its own boot configuration.

Definition at line 520 of file range.c.

{
    PARBITER_ALTERNATIVE Alternative = ArbState->CurrentAlternative;
    ULONG Flags = 0;
    NTSTATUS Status;
 
    PAGED_CODE();
 
    if (Alternative == NULL)
        return FALSE;
 
    if (ArbState->CurrentMinimum > ArbState->CurrentMaximum)
        return FALSE;
 
    if (Alternative->Length == 0)
    {
        ArbState->Start = ArbState->CurrentMinimum;
        ArbState->End = ArbState->CurrentMinimum;
        return TRUE;
    }
 
    /*
     * Interrupt retention: give the device back its firmware-routed vector rather
     * than letting the top-down search pick an untranslatable one
     */
    if (ArbpReuseOwnedInterrupt(Arbiter, ArbState))
        return TRUE;
 
    /* Legacy requests consider preallocated (boot) ranges available. */
    if (ArbState->Entry != NULL &&
        (ArbState->Entry->RequestSource == ArbiterRequestLegacyReported ||
         ArbState->Entry->RequestSource == ArbiterRequestLegacyAssigned))
    {
        ArbState->RangeAvailableAttributes |= ARBITER_RANGE_BOOT_ALLOCATED;
    }
 
    if (ArbState->Flags & ARBITER_STATE_FLAG_NULL_CONFLICT_OK)
        Flags |= RTL_RANGE_LIST_NULL_CONFLICT_OK;
    if (Alternative->Flags & ARBITER_ALTERNATIVE_FLAG_SHARED)
        Flags |= RTL_RANGE_LIST_SHARED_OK;
 
    Status = RtlFindRange(Arbiter->PossibleAllocation,
                          ArbState->CurrentMinimum,
                          ArbState->CurrentMaximum,
                          (ULONG)Alternative->Length,
                          (ULONG)(Alternative->Alignment ? Alternative->Alignment : 1),
                          Flags,
                          ArbState->RangeAvailableAttributes,
                          Arbiter->ConflictCallbackContext,
                          Arbiter->ConflictCallback,
                          &ArbState->Start);
    if (!NT_SUCCESS(Status))
    {
        /*
         * The window is occupied.  A CmResourceShareDriverExclusive requirement
         * can still succeed by sharing the conflicting range with the same driver
         * or another root-enumerated device
         *
         * This matters a lot because HAL reverses quite a bit and marks it this.
         * This mechanism is how Windows "internally allows this".
         */
        if (ArbpShareDriverExclusive(Arbiter, ArbState))
            return TRUE;
        if (Arbiter->OverrideConflict != NULL &&
            Arbiter->OverrideConflict(Arbiter, ArbState))
        {
            return TRUE;
        }
        return FALSE;
    }
 
    ArbState->End = ArbState->Start + Alternative->Length - 1;
    return TRUE;
}

Referenced by ArbiterLibInitializeInstance().

◆ ArbiterLibFreeOrderingList()

VOID NTAPI ArbiterLibFreeOrderingList ( _Inout_ PARBITER_ORDERING_LIST OrderingList )

Definition at line 52 of file ordering.c.

{
    PAGED_CODE();
 
    if (OrderingList->Orderings != NULL)
        ExFreePoolWithTag(OrderingList->Orderings, TAG_ARBITER);
 
    OrderingList->Orderings = NULL;
    OrderingList->Count = 0;
    OrderingList->Maximum = 0;
}

Referenced by ArbiterLibDefaultAssignmentOrdering(), ArbiterLibDeleteInstance(), and ario_ApplyBrokenVideoHack().

◆ ArbiterLibGetNextAllocationRange()

BOOLEAN NTAPI ArbiterLibGetNextAllocationRange	(	_In_ PARBITER_INSTANCE	Arbiter,
		_Inout_ PARBITER_ALLOCATION_STATE	ArbState
	)

Moves the working window to the next candidate range, walking the entry's alternatives in priority order across the arbiter's ordering list.

Parameters

[in]	Arbiter	The arbiter instance whose ordering list supplies the candidate windows.
[in,out]	ArbState	The allocation state of the entry being placed. On success, CurrentMinimum, CurrentMaximum and CurrentAlternative describe the next window to search; the window is pre-trimmed so an aligned allocation of the required length fits inside it.

Returns: Returns TRUE if a new candidate window was produced, FALSE once every alternative is exhausted.

Definition at line 379 of file range.c.

{
    PARBITER_ALTERNATIVE Alternative;
    PARBITER_ALTERNATIVE Lowest;
    UINT64 Minimum, Maximum;
 
    PAGED_CODE();
 
    if (ArbState->AlternativeCount == 0)
        return FALSE;
 
    for (;;)
    {
        /* Advance the alternative we last worked on, or seed all on first entry. */
        if (ArbState->CurrentAlternative != NULL)
        {
            ArbpWritePriority(Arbiter, ArbState->CurrentAlternative);
        }
        else
        {
            for (Alternative = ArbState->Alternatives;
                 Alternative < &ArbState->Alternatives[ArbState->AlternativeCount];
                 ++Alternative)
            {
                Alternative->Priority = ARBITER_PRIORITY_NULL;
                ArbpWritePriority(Arbiter, Alternative);
            }
        }
 
        /* Pick the best (lowest-priority) alternative. */
        Lowest = ArbState->Alternatives;
        for (Alternative = ArbState->Alternatives + 1;
             Alternative < &ArbState->Alternatives[ArbState->AlternativeCount];
             ++Alternative)
        {
            if (Alternative->Priority < Lowest->Priority)
                Lowest = Alternative;
        }
 
        if (Lowest->Priority == ARBITER_PRIORITY_EXHAUSTED)
            return FALSE;
 
        if (Lowest->Priority == ARBITER_PRIORITY_RESERVED ||
            Lowest->Priority == ARBITER_PRIORITY_PREFERRED_RESERVED)
        {
            /* Final pass: the whole requirement window. */
            Minimum = Lowest->Minimum;
            Maximum = Lowest->Maximum;
        }
        else
        {
            PARBITER_ORDERING Ordering;
            ULONG Index = (Lowest->Priority < 0) ? (ULONG)(-(Lowest->Priority + 1))
                                                 : (ULONG)(Lowest->Priority - 1);
            if (Index >= Arbiter->OrderingList.Count)
            {
                Lowest->Priority = ARBITER_PRIORITY_EXHAUSTED;
                continue;
            }
            Ordering = &Arbiter->OrderingList.Orderings[Index];
            Minimum = max(Lowest->Minimum, Ordering->Start);
            Maximum = min(Lowest->Maximum, Ordering->End);
        }
 
        /*
         * Trim the window so an aligned allocation of the required length is
         * possible; skip the window entirely if it cannot hold one.
         */
        if (Lowest->Length != 0)
        {
            UINT64 Alignment = Lowest->Alignment ? Lowest->Alignment : 1;
            UINT64 LengthMinusOne = Lowest->Length - 1;
            UINT64 AlignedMax;
 
            Minimum += Alignment - 1;
            Minimum -= Minimum % Alignment;
 
            if (Minimum > Maximum || LengthMinusOne > Maximum - Minimum)
            {
                ArbState->CurrentAlternative = Lowest;  /* consume this priority */
                continue;
            }
 
            AlignedMax = Maximum - LengthMinusOne;
            AlignedMax -= AlignedMax % Alignment;
            if (AlignedMax < Minimum)
            {
                ArbState->CurrentAlternative = Lowest;  /* no aligned start fits */
                continue;
            }
            Maximum = AlignedMax + LengthMinusOne;
        }
        else
        {
            Minimum = Lowest->Minimum;
            Maximum = Lowest->Maximum;
        }
 
        if (Minimum != ArbState->CurrentMinimum ||
            Maximum != ArbState->CurrentMaximum ||
            ArbState->CurrentAlternative != Lowest)
        {
            ArbState->CurrentMinimum = Minimum;
            ArbState->CurrentMaximum = Maximum;
            ArbState->CurrentAlternative = Lowest;
            return TRUE;
        }
 
        ArbState->CurrentAlternative = Lowest;
    }
}

Referenced by ArbiterLibInitializeInstance().

◆ ArbiterLibHandler()

NTSTATUS NTAPI ArbiterLibHandler	(	_In_ PVOID	Context,
		_In_ ARBITER_ACTION	Action,
		_Inout_ PARBITER_PARAMETERS	Parameters
	)

Definition at line 238 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

◆ ArbiterLibInitializeInstance()

NTSTATUS NTAPI ArbiterLibInitializeInstance	(	_Inout_ PARBITER_INSTANCE	Arbiter,
		_In_ PDEVICE_OBJECT	BusDeviceObject,
		_In_ CM_RESOURCE_TYPE	ResourceType,
		_In_ PCWSTR	ArbiterName,
		_In_ PCWSTR	OrderName,
		_In_ PARB_TRANSLATE_ORDERING	TranslateOrderingFunction
	)

Definition at line 299 of file arbiter.c.

{
    NTSTATUS Status;
 
    PAGED_CODE();
 
    DPRINT("ArbiterLibInitializeInstance: '%S'\n", ArbiterName);
 
    ASSERT(Arbiter->UnpackRequirement != NULL);
    ASSERT(Arbiter->PackResource != NULL);
    ASSERT(Arbiter->UnpackResource != NULL);
    ASSERT(Arbiter->MutexEvent == NULL);
    ASSERT(Arbiter->Allocation == NULL);
    ASSERT(Arbiter->PossibleAllocation == NULL);
    ASSERT(Arbiter->AllocationStack == NULL);
 
    Arbiter->Signature = ARBITER_SIG;
    Arbiter->BusDeviceObject = BusDeviceObject;
    Arbiter->Name = ArbiterName;
    Arbiter->ResourceType = ResourceType;
    Arbiter->TransactionInProgress = FALSE;
#if (NTDDI_VERSION >= NTDDI_VISTA)
    Arbiter->OrderingName = OrderName;
#endif
 
    /* The per-instance lock: a signaled synchronization event used as a mutex. */
    Arbiter->MutexEvent = ExAllocatePoolWithTag(NonPagedPool, sizeof(KEVENT), TAG_ARBITER);
    if (!Arbiter->MutexEvent)
    {
        Status = STATUS_INSUFFICIENT_RESOURCES;
        goto Failure;
    }
    KeInitializeEvent(Arbiter->MutexEvent, SynchronizationEvent, TRUE);
 
#if (NTDDI_VERSION >= NTDDI_VISTA)
    /* Vista+: a notification event exposing whether a Test is outstanding. */
    Arbiter->TransactionEvent = ExAllocatePoolWithTag(NonPagedPool, sizeof(KEVENT), TAG_ARBITER);
    if (!Arbiter->TransactionEvent)
    {
        Status = STATUS_INSUFFICIENT_RESOURCES;
        goto Failure;
    }
    KeInitializeEvent(Arbiter->TransactionEvent, NotificationEvent, TRUE);
#endif
 
    Arbiter->AllocationStack = ExAllocatePoolWithTag(PagedPool, PAGE_SIZE, TAG_ARBITER);
    if (!Arbiter->AllocationStack)
    {
        Status = STATUS_INSUFFICIENT_RESOURCES;
        goto Failure;
    }
    Arbiter->AllocationStackMaxSize = PAGE_SIZE;
    Arbiter->Allocation = ExAllocatePoolWithTag(PagedPool, sizeof(RTL_RANGE_LIST), TAG_ARBITER);
    if (!Arbiter->Allocation)
    {
        Status = STATUS_INSUFFICIENT_RESOURCES;
        goto Failure;
    }
    RtlInitializeRangeList(Arbiter->Allocation);
 
    Arbiter->PossibleAllocation = ExAllocatePoolWithTag(PagedPool, sizeof(RTL_RANGE_LIST), TAG_ARBITER);
    if (!Arbiter->PossibleAllocation)
    {
        Status = STATUS_INSUFFICIENT_RESOURCES;
        goto Failure;
    }
    RtlInitializeRangeList(Arbiter->PossibleAllocation);
 
    if (!Arbiter->TestAllocation)
        Arbiter->TestAllocation = ArbiterLibTestAllocation;
    if (!Arbiter->RetestAllocation)
        Arbiter->RetestAllocation = ArbiterLibRetestAllocation;
    if (!Arbiter->CommitAllocation)
        Arbiter->CommitAllocation = ArbiterLibCommitAllocation;
    if (!Arbiter->RollbackAllocation)
        Arbiter->RollbackAllocation = ArbiterLibRollbackAllocation;
    if (!Arbiter->BootAllocation)
        Arbiter->BootAllocation = ArbiterLibBootAllocation;
    if (!Arbiter->AddReserved)
        Arbiter->AddReserved = ArbiterLibAddReserved;
    if (!Arbiter->QueryConflict)
        Arbiter->QueryConflict = ArbiterLibQueryConflict;
    if (!Arbiter->StartArbiter)
        Arbiter->StartArbiter = ArbiterLibStartArbiter;
    if (!Arbiter->PreprocessEntry)
        Arbiter->PreprocessEntry = ArbiterLibPreprocessEntry;
    if (!Arbiter->AllocateEntry)
        Arbiter->AllocateEntry = ArbiterLibAllocateEntry;
    if (!Arbiter->GetNextAllocationRange)
        Arbiter->GetNextAllocationRange = ArbiterLibGetNextAllocationRange;
    if (!Arbiter->FindSuitableRange)
        Arbiter->FindSuitableRange = ArbiterLibFindSuitableRange;
    if (!Arbiter->AddAllocation)
        Arbiter->AddAllocation = ArbiterLibAddAllocation;
    if (!Arbiter->BacktrackAllocation)
        Arbiter->BacktrackAllocation = ArbiterLibBacktrackAllocation;
    if (!Arbiter->OverrideConflict)
        Arbiter->OverrideConflict = ArbiterLibOverrideConflict;
#if (NTDDI_VERSION >= NTDDI_VISTA)
    if (!Arbiter->InitializeRangeList)
        Arbiter->InitializeRangeList = ArbiterLibInitializeRangeList;
#endif
 
    Status = ArbiterLibDefaultAssignmentOrdering(Arbiter, OrderName, OrderName, TranslateOrderingFunction);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("ArbiterLibInitializeInstance: ArbiterLibDefaultAssignmentOrdering failed, Status %X\n", Status);
        goto Failure;
    }
 
    return STATUS_SUCCESS;
 
Failure:
    DPRINT1("ArbiterLibInitializeInstance: '%S' failed, Status %X\n", ArbiterName, Status);
    ArbiterLibDeleteInstance(Arbiter);
    return Status;
}

Referenced by arbusno_Initializer(), IopArbBusNumberInitialize(), IopArbDmaInitialize(), IopArbIrqInitialize(), IopArbMemInitialize(), and IopArbPortInitialize().

◆ ArbiterLibQueryConflict()

NTSTATUS NTAPI ArbiterLibQueryConflict	(	_In_ PARBITER_INSTANCE	Arbiter,
		_Inout_ PARBITER_QUERY_CONFLICT_PARAMETERS	Parameters
	)

Definition at line 100 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbiterLibInitializeInstance().

◆ ArbiterLibRetestAllocation()

NTSTATUS NTAPI ArbiterLibRetestAllocation	(	_In_ PARBITER_INSTANCE	Arbiter,
		_Inout_ PARBITER_RETEST_ALLOCATION_PARAMETERS	Parameters
	)

Definition at line 42 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbiterLibInitializeInstance().

◆ ArbiterLibRollbackAllocation()

NTSTATUS NTAPI ArbiterLibRollbackAllocation ( _In_ PARBITER_INSTANCE Arbiter )

Definition at line 150 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbiterLibInitializeInstance().

◆ ArbiterLibTestAllocation()

NTSTATUS NTAPI ArbiterLibTestAllocation	(	_In_ PARBITER_INSTANCE	Arbiter,
		_Inout_ PARBITER_TEST_ALLOCATION_PARAMETERS	Parameters
	)

Definition at line 23 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbiterLibInitializeInstance().

Classes

Macros

Typedefs

Functions

Macro Definition Documentation

◆ ARBITER_ALTERNATIVE_FLAG_FIXED

◆ ARBITER_ALTERNATIVE_FLAG_SHARED

◆ ARBITER_PRIORITY_EXHAUSTED

◆ ARBITER_PRIORITY_NULL

◆ ARBITER_PRIORITY_PREFERRED_RESERVED

◆ ARBITER_PRIORITY_RESERVED

◆ ARBITER_RANGE_BOOT_ALLOCATED

◆ ARBITER_RANGE_SHARED_DRIVER

◆ ARBITER_STATE_FLAG_NULL_CONFLICT_OK

◆ TAG_ARBITER

Typedef Documentation

◆ ARBITER_ALLOCATION_STATE

◆ ARBITER_ALTERNATIVE

◆ ARBITER_INSTANCE

◆ ARBITER_ORDERING

◆ ARBITER_ORDERING_LIST

◆ PARB_ADD_ALLOCATION

◆ PARB_ADD_RESERVED

◆ PARB_ALLOCATE_ENTRY

◆ PARB_BACKTRACK_ALLOCATION

◆ PARB_BOOT_ALLOCATION

◆ PARB_COMMIT_ALLOCATION

◆ PARB_FIND_SUITABLE_RANGE

◆ PARB_GET_NEXT_ALLOCATION_RANGE

◆ PARB_INITIALIZE_RANGE_LIST

◆ PARB_OVERRIDE_CONFLICT

◆ PARB_PACK_RESOURCE

◆ PARB_PREPROCESS_ENTRY

◆ PARB_QUERY_ARBITRATE

◆ PARB_QUERY_CONFLICT

◆ PARB_RETEST_ALLOCATION

◆ PARB_ROLLBACK_ALLOCATION

◆ PARB_SCORE_REQUIREMENT

◆ PARB_START_ARBITER

◆ PARB_TEST_ALLOCATION

◆ PARB_TRANSLATE_ORDERING

◆ PARB_UNPACK_REQUIREMENT

◆ PARB_UNPACK_RESOURCE

◆ PARBITER_ALLOCATION_STATE

◆ PARBITER_ALTERNATIVE

◆ PARBITER_INSTANCE

◆ PARBITER_ORDERING

◆ PARBITER_ORDERING_LIST

Function Documentation

◆ ArbiterLibAddAllocation()

◆ ArbiterLibAddOrdering()

◆ ArbiterLibBacktrackAllocation()

◆ ArbiterLibBootAllocation()

◆ ArbiterLibCommitAllocation()

◆ ArbiterLibDefaultAssignmentOrdering()

◆ ArbiterLibDeleteInstance()

◆ ArbiterLibFindSuitableRange()

◆ ArbiterLibFreeOrderingList()

◆ ArbiterLibGetNextAllocationRange()

◆ ArbiterLibHandler()

◆ ArbiterLibInitializeInstance()

◆ ArbiterLibQueryConflict()

◆ ArbiterLibRetestAllocation()

◆ ArbiterLibRollbackAllocation()

◆ ArbiterLibTestAllocation()