arbiter.c File Reference

#include <ntifs.h>
#include <ndk/rtlfuncs.h>
#include "arbiter.h"
#include <debug.h>

Include dependency graph for arbiter.c:

Go to the source code of this file.

Macros
#define	NDEBUG
#define	ARBITER_SIG   'sbrA'
#define	TAG_ARBITER   'ibrA'

Functions
NTSTATUS NTAPI	ArbTestAllocation (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PLIST_ENTRY ArbitrationList)
NTSTATUS NTAPI	ArbRetestAllocation (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PLIST_ENTRY ArbitrationList)
NTSTATUS NTAPI	ArbBootAllocation (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PLIST_ENTRY ArbitrationList)
NTSTATUS NTAPI	ArbAddReserved (_In_ PARBITER_INSTANCE Arbiter, _In_opt_ PIO_RESOURCE_DESCRIPTOR Requirement, _In_opt_ PCM_PARTIAL_RESOURCE_DESCRIPTOR Resource)
NTSTATUS NTAPI	ArbQueryConflict (_In_ PARBITER_INSTANCE Arbiter, _In_ PDEVICE_OBJECT PhysicalDeviceObject, _In_ PIO_RESOURCE_DESCRIPTOR ConflictingResource, _Out_ PULONG ConflictCount, _Out_ PARBITER_CONFLICT_INFO *Conflicts)
NTSTATUS NTAPI	ArbInitializeRangeList (_In_ PARBITER_INSTANCE Arbiter, _In_ ULONG ResourceCount, _In_ PCM_PARTIAL_RESOURCE_DESCRIPTOR Resources, _Inout_ PRTL_RANGE_LIST RangeList)
NTSTATUS NTAPI	ArbCommitAllocation (_In_ PARBITER_INSTANCE Arbiter)
NTSTATUS NTAPI	ArbRollbackAllocation (_In_ PARBITER_INSTANCE Arbiter)
NTSTATUS NTAPI	ArbStartArbiter (_In_ PARBITER_INSTANCE Arbiter, _In_ PCM_RESOURCE_LIST StartResources)
NTSTATUS NTAPI	ArbPreprocessEntry (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)
NTSTATUS NTAPI	ArbAllocateEntry (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)
NTSTATUS NTAPI	ArbSortArbitrationList (_Inout_ PLIST_ENTRY ArbitrationList)
BOOLEAN NTAPI	ArbGetNextAllocationRange (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)
BOOLEAN NTAPI	ArbFindSuitableRange (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)
VOID NTAPI	ArbAddAllocation (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)
VOID NTAPI	ArbBacktrackAllocation (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)
VOID NTAPI	ArbConfirmAllocation (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)
BOOLEAN NTAPI	ArbOverrideConflict (_In_ PARBITER_INSTANCE Arbiter, _Inout_ PARBITER_ALLOCATION_STATE ArbState)
NTSTATUS NTAPI	ArbArbiterHandler (_In_ PVOID Context, _In_ ARBITER_ACTION Action, _Inout_ PARBITER_PARAMETERS Parameters)
NTSTATUS NTAPI	ArbInitializeOrderingList (_Out_ PARBITER_ORDERING_LIST OrderingList)
VOID NTAPI	ArbFreeOrderingList (_Inout_ PARBITER_ORDERING_LIST OrderingList)
NTSTATUS NTAPI	ArbCopyOrderingList (_Out_ PARBITER_ORDERING_LIST Destination, _In_ PARBITER_ORDERING_LIST Source)
NTSTATUS NTAPI	ArbAddOrdering (_Inout_ PARBITER_ORDERING_LIST OrderingList, _In_ UINT64 Start, _In_ UINT64 End)
NTSTATUS NTAPI	ArbPruneOrdering (_Inout_ PARBITER_ORDERING_LIST OrderingList, _In_ UINT64 Start, _In_ UINT64 End)
NTSTATUS NTAPI	ArbBuildAssignmentOrdering (_Inout_ PARBITER_INSTANCE Arbiter, _In_ PCWSTR AllocationOrderName, _In_ PCWSTR ReservedResourcesName, _In_opt_ PARB_TRANSLATE_ORDERING TranslateOrderingFunction)
VOID NTAPI	ArbDeleteArbiterInstance (_In_ PARBITER_INSTANCE Arbiter)
NTSTATUS NTAPI	ArbInitializeArbiterInstance (_Inout_ PARBITER_INSTANCE Arbiter, _In_ PDEVICE_OBJECT BusDeviceObject, _In_ CM_RESOURCE_TYPE ResourceType, _In_ PCWSTR ArbiterName, _In_ PCWSTR OrderName, _In_ PARB_TRANSLATE_ORDERING TranslateOrderingFunction)

Macro Definition Documentation

ARBITER_SIG

#define ARBITER_SIG   'sbrA'

Definition at line 17 of file arbiter.c.

NDEBUG

#define NDEBUG

Definition at line 14 of file arbiter.c.

TAG_ARBITER

#define TAG_ARBITER   'ibrA'

Definition at line 18 of file arbiter.c.

Function Documentation

ArbAddAllocation()

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

Definition at line 214 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
}

Referenced by ArbInitializeArbiterInstance().

ArbAddOrdering()

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

Definition at line 313 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

ArbAddReserved()

NTSTATUS NTAPI ArbAddReserved	(	_In_ PARBITER_INSTANCE	Arbiter,
		_In_opt_ PIO_RESOURCE_DESCRIPTOR	Requirement,
		_In_opt_ PCM_PARTIAL_RESOURCE_DESCRIPTOR	Resource
	)

Definition at line 66 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbInitializeArbiterInstance().

ArbAllocateEntry()

NTSTATUS NTAPI ArbAllocateEntry	(	_In_ PARBITER_INSTANCE	Arbiter,
		_Inout_ PARBITER_ALLOCATION_STATE	ArbState
	)

Definition at line 163 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbInitializeArbiterInstance().

ArbArbiterHandler()

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

Definition at line 263 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

ArbBacktrackAllocation()

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

Definition at line 226 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
}

Referenced by ArbInitializeArbiterInstance().

ArbBootAllocation()

NTSTATUS NTAPI ArbBootAllocation	(	_In_ PARBITER_INSTANCE	Arbiter,
		_Inout_ PLIST_ENTRY	ArbitrationList
	)

Definition at line 53 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbInitializeArbiterInstance().

ArbBuildAssignmentOrdering()

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

Definition at line 341 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_SUCCESS;
}

Referenced by ArbInitializeArbiterInstance(), and ario_ApplyBrokenVideoHack().

ArbCommitAllocation()

NTSTATUS NTAPI ArbCommitAllocation

(

_In_ PARBITER_INSTANCE

Arbiter

)

Definition at line 113 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbInitializeArbiterInstance().

ArbConfirmAllocation()

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

Definition at line 238 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
}

ArbCopyOrderingList()

NTSTATUS NTAPI ArbCopyOrderingList	(	_Out_ PARBITER_ORDERING_LIST	Destination,
		_In_ PARBITER_ORDERING_LIST	Source
	)

Definition at line 300 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

ArbDeleteArbiterInstance()

VOID NTAPI ArbDeleteArbiterInstance

(

_In_ PARBITER_INSTANCE

Arbiter

)

Definition at line 356 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;
    }
 
#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 ArbInitializeArbiterInstance().

ArbFindSuitableRange()

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

Definition at line 201 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return FALSE;
}

Referenced by ArbInitializeArbiterInstance().

ArbFreeOrderingList()

VOID NTAPI ArbFreeOrderingList

(

_Inout_ PARBITER_ORDERING_LIST

OrderingList

)

Definition at line 289 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
}

Referenced by ario_ApplyBrokenVideoHack().

ArbGetNextAllocationRange()

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

Definition at line 188 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return FALSE;
}

Referenced by ArbInitializeArbiterInstance().

ArbInitializeArbiterInstance()

NTSTATUS NTAPI ArbInitializeArbiterInstance	(	_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 400 of file arbiter.c.

{
    NTSTATUS Status;
 
    PAGED_CODE();
 
    DPRINT("ArbInitializeArbiterInstance: '%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 = ArbTestAllocation;
    if (!Arbiter->RetestAllocation)
        Arbiter->RetestAllocation = ArbRetestAllocation;
    if (!Arbiter->CommitAllocation)
        Arbiter->CommitAllocation = ArbCommitAllocation;
    if (!Arbiter->RollbackAllocation)
        Arbiter->RollbackAllocation = ArbRollbackAllocation;
    if (!Arbiter->BootAllocation)
        Arbiter->BootAllocation = ArbBootAllocation;
    if (!Arbiter->AddReserved)
        Arbiter->AddReserved = ArbAddReserved;
    if (!Arbiter->QueryConflict)
        Arbiter->QueryConflict = ArbQueryConflict;
    if (!Arbiter->StartArbiter)
        Arbiter->StartArbiter = ArbStartArbiter;
    if (!Arbiter->PreprocessEntry)
        Arbiter->PreprocessEntry = ArbPreprocessEntry;
    if (!Arbiter->AllocateEntry)
        Arbiter->AllocateEntry = ArbAllocateEntry;
    if (!Arbiter->GetNextAllocationRange)
        Arbiter->GetNextAllocationRange = ArbGetNextAllocationRange;
    if (!Arbiter->FindSuitableRange)
        Arbiter->FindSuitableRange = ArbFindSuitableRange;
    if (!Arbiter->AddAllocation)
        Arbiter->AddAllocation = ArbAddAllocation;
    if (!Arbiter->BacktrackAllocation)
        Arbiter->BacktrackAllocation = ArbBacktrackAllocation;
    if (!Arbiter->OverrideConflict)
        Arbiter->OverrideConflict = ArbOverrideConflict;
#if (NTDDI_VERSION >= NTDDI_VISTA)
    if (!Arbiter->InitializeRangeList)
        Arbiter->InitializeRangeList = ArbInitializeRangeList;
#endif
 
    Status = ArbBuildAssignmentOrdering(Arbiter, OrderName, OrderName, TranslateOrderingFunction);
    if (!NT_SUCCESS(Status))
    {
        DPRINT1("ArbInitializeArbiterInstance: ArbBuildAssignmentOrdering failed, Status %X\n", Status);
        goto Failure;
    }
 
    return STATUS_SUCCESS;
 
Failure:
    DPRINT1("ArbInitializeArbiterInstance: '%S' failed, Status %X\n", ArbiterName, Status);
    ArbDeleteArbiterInstance(Arbiter);
    return Status;
}

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

ArbInitializeOrderingList()

NTSTATUS NTAPI ArbInitializeOrderingList

(

_Out_ PARBITER_ORDERING_LIST

OrderingList

)

Definition at line 277 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

ArbInitializeRangeList()

NTSTATUS NTAPI ArbInitializeRangeList	(	_In_ PARBITER_INSTANCE	Arbiter,
		_In_ ULONG	ResourceCount,
		_In_ PCM_PARTIAL_RESOURCE_DESCRIPTOR	Resources,
		_Inout_ PRTL_RANGE_LIST	RangeList
	)

Definition at line 97 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbInitializeArbiterInstance().

ArbOverrideConflict()

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

Definition at line 250 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return FALSE;
}

Referenced by ArbInitializeArbiterInstance().

ArbPreprocessEntry()

NTSTATUS NTAPI ArbPreprocessEntry	(	_In_ PARBITER_INSTANCE	Arbiter,
		_Inout_ PARBITER_ALLOCATION_STATE	ArbState
	)

Definition at line 150 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_SUCCESS;
}

Referenced by ArbInitializeArbiterInstance().

ArbPruneOrdering()

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

Definition at line 327 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

ArbQueryConflict()

NTSTATUS NTAPI ArbQueryConflict	(	_In_ PARBITER_INSTANCE	Arbiter,
		_In_ PDEVICE_OBJECT	PhysicalDeviceObject,
		_In_ PIO_RESOURCE_DESCRIPTOR	ConflictingResource,
		_Out_ PULONG	ConflictCount,
		_Out_ PARBITER_CONFLICT_INFO *	Conflicts
	)

Definition at line 80 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbInitializeArbiterInstance().

ArbRetestAllocation()

NTSTATUS NTAPI ArbRetestAllocation	(	_In_ PARBITER_INSTANCE	Arbiter,
		_Inout_ PLIST_ENTRY	ArbitrationList
	)

Definition at line 40 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbInitializeArbiterInstance().

ArbRollbackAllocation()

NTSTATUS NTAPI ArbRollbackAllocation

(

_In_ PARBITER_INSTANCE

Arbiter

)

Definition at line 125 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbInitializeArbiterInstance().

ArbSortArbitrationList()

NTSTATUS NTAPI ArbSortArbitrationList

(

_Inout_ PLIST_ENTRY

ArbitrationList

)

Definition at line 176 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

ArbStartArbiter()

NTSTATUS NTAPI ArbStartArbiter	(	_In_ PARBITER_INSTANCE	Arbiter,
		_In_ PCM_RESOURCE_LIST	StartResources
	)

Definition at line 137 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbInitializeArbiterInstance().

ArbTestAllocation()

NTSTATUS NTAPI ArbTestAllocation	(	_In_ PARBITER_INSTANCE	Arbiter,
		_Inout_ PLIST_ENTRY	ArbitrationList
	)

Definition at line 27 of file arbiter.c.

{
    PAGED_CODE();
 
    UNIMPLEMENTED;
    return STATUS_NOT_IMPLEMENTED;
}

Referenced by ArbInitializeArbiterInstance().