misc.c File Reference

#include "ndissys.h"

Include dependency graph for misc.c:

Go to the source code of this file.

Classes
struct	_NDIS_HANDLE_OBJECT

Typedefs
typedef struct _NDIS_HANDLE_OBJECT	NDIS_HANDLE_OBJECT
typedef struct _NDIS_HANDLE_OBJECT *	PNDIS_HANDLE_OBJECT

Functions
VOID EXPORT	NdisInterlockedAddUlong (IN PULONG Addend, IN ULONG Increment, IN PNDIS_SPIN_LOCK SpinLock)
VOID EXPORT	NdisInterlockedAddLargeInteger (IN PLARGE_INTEGER Addend, IN LARGE_INTEGER Increment, IN PNDIS_SPIN_LOCK SpinLock)
LONG EXPORT	NdisCompareAnsiString (IN PNDIS_ANSI_STRING String1, IN PNDIS_ANSI_STRING String2, BOOLEAN CaseInSensitive)
LONG EXPORT	NdisCompareUnicodeString (IN PNDIS_STRING String1, IN PNDIS_STRING String2, IN BOOLEAN CaseInSensitive)
PLIST_ENTRY EXPORT	NdisInterlockedInsertHeadList (IN PLIST_ENTRY ListHead, IN PLIST_ENTRY ListEntry, IN PNDIS_SPIN_LOCK SpinLock)
PLIST_ENTRY EXPORT	NdisInterlockedInsertTailList (IN PLIST_ENTRY ListHead, IN PLIST_ENTRY ListEntry, IN PNDIS_SPIN_LOCK SpinLock)
PLIST_ENTRY EXPORT	NdisInterlockedRemoveHeadList (IN PLIST_ENTRY ListHead, IN PNDIS_SPIN_LOCK SpinLock)
FORCEINLINE PNDIS_HANDLE_OBJECT	NDIS_HANDLE_TO_POBJECT (NDIS_HANDLE handle)
FORCEINLINE NDIS_HANDLE	NDIS_POBJECT_TO_HANDLE (PNDIS_HANDLE_OBJECT obj)
VOID EXPORT	NdisMapFile (OUT PNDIS_STATUS Status, OUT PVOID *MappedBuffer, IN NDIS_HANDLE FileHandle)
VOID EXPORT	NdisUnmapFile (IN NDIS_HANDLE FileHandle)
VOID EXPORT	NdisCloseFile (IN NDIS_HANDLE FileHandle)
VOID EXPORT	NdisOpenFile (OUT PNDIS_STATUS Status, OUT PNDIS_HANDLE FileHandle, OUT PUINT FileLength, IN PNDIS_STRING FileName, IN NDIS_PHYSICAL_ADDRESS HighestAcceptableAddress)
CCHAR EXPORT	NdisSystemProcessorCount (VOID)
VOID EXPORT	NdisGetCurrentProcessorCounts (OUT PULONG pIdleCount, OUT PULONG pKernelAndUser, OUT PULONG pIndex)
VOID EXPORT	NdisGetSystemUpTime (OUT PULONG pSystemUpTime)
LONG EXPORT	NdisInterlockedDecrement (IN PLONG Addend)
LONG EXPORT	NdisInterlockedIncrement (IN PLONG Addend)
PSINGLE_LIST_ENTRY EXPORT	NdisInterlockedPopEntrySList (IN PSLIST_HEADER ListHead, IN PKSPIN_LOCK Lock)
PSINGLE_LIST_ENTRY EXPORT	NdisInterlockedPushEntrySList (IN PSLIST_HEADER ListHead, IN PSINGLE_LIST_ENTRY ListEntry, IN PKSPIN_LOCK Lock)
VOID NTAPI	ndisProcWorkItemHandler (PVOID pContext)
NDIS_STATUS EXPORT	NdisScheduleWorkItem (IN PNDIS_WORK_ITEM pWorkItem)
VOID EXPORT	NdisGetCurrentProcessorCpuUsage (PULONG pCpuUsage)
ULONG EXPORT	NdisGetSharedDataAlignment (VOID)
UINT EXPORT	NdisGetVersion (VOID)
UCHAR EXPORT	NdisGeneratePartialCancelId (VOID)

Variables
LONG	CancelId
static const WCHAR	NDIS_FILE_FOLDER [] = L"\\SystemRoot\\System32\\Drivers\\"

Typedef Documentation

NDIS_HANDLE_OBJECT

typedef struct _NDIS_HANDLE_OBJECT NDIS_HANDLE_OBJECT

PNDIS_HANDLE_OBJECT

typedef struct _NDIS_HANDLE_OBJECT * PNDIS_HANDLE_OBJECT

Function Documentation

NDIS_HANDLE_TO_POBJECT()

FORCEINLINE PNDIS_HANDLE_OBJECT NDIS_HANDLE_TO_POBJECT

(

NDIS_HANDLE

handle

)

Definition at line 130 of file misc.c.

{
  return (PNDIS_HANDLE_OBJECT)handle;
}

Referenced by NdisCloseFile().

NDIS_POBJECT_TO_HANDLE()

FORCEINLINE NDIS_HANDLE NDIS_POBJECT_TO_HANDLE

(

PNDIS_HANDLE_OBJECT

obj

)

Definition at line 137 of file misc.c.

{
  return (NDIS_HANDLE)obj;
}

Referenced by NdisOpenFile().

NdisCloseFile()

VOID EXPORT NdisCloseFile

(

IN NDIS_HANDLE

FileHandle

)

Definition at line 193 of file misc.c.

{
  PNDIS_HANDLE_OBJECT FileHandleObject;

  ASSERT_IRQL(PASSIVE_LEVEL);

  NDIS_DbgPrint(MAX_TRACE, ("Called.\n"));

  ASSERT ( FileHandle );

  FileHandleObject = NDIS_HANDLE_TO_POBJECT(FileHandle);

  ASSERT ( FileHandleObject->FileHandle );

  if ( FileHandleObject->Mapped )
    NdisUnmapFile ( FileHandle );

  ZwClose ( FileHandleObject->FileHandle );

  memset ( FileHandleObject, 0, sizeof(NDIS_HANDLE_OBJECT) );

  ExFreePool ( FileHandleObject );
}

NdisCompareAnsiString()

LONG EXPORT NdisCompareAnsiString	(	IN PNDIS_ANSI_STRING	String1,
		IN PNDIS_ANSI_STRING	String2,
		BOOLEAN	CaseInSensitive
	)

Definition at line 49 of file misc.c.

{
    /* This one needs to be verified also. See the
     * comment in NdisInterlockedAddLargeInteger
     */

    return RtlCompareString(String1, String2, CaseInSensitive);
}

NdisCompareUnicodeString()

LONG EXPORT NdisCompareUnicodeString	(	IN PNDIS_STRING	String1,
		IN PNDIS_STRING	String2,
		IN BOOLEAN	CaseInSensitive
	)

Definition at line 66 of file misc.c.

{
    /* This one needs to be verified also. See the
     * comment in NdisInterlockedAddLargeInteger
     */

    return RtlCompareUnicodeString(String1, String2, CaseInSensitive);
}

NdisGeneratePartialCancelId()

UCHAR EXPORT NdisGeneratePartialCancelId

(

VOID

)

Definition at line 526 of file misc.c.

{
    UCHAR PartialCancelId;

    PartialCancelId = (UCHAR)InterlockedIncrement(&CancelId);

    NDIS_DbgPrint(MAX_TRACE, ("Cancel ID %u\n", PartialCancelId));

    return PartialCancelId;
}

NdisGetCurrentProcessorCounts()

VOID EXPORT NdisGetCurrentProcessorCounts	(	OUT PULONG	pIdleCount,
		OUT PULONG	pKernelAndUser,
		OUT PULONG	pIndex
	)

Definition at line 336 of file misc.c.

{
    NDIS_DbgPrint(MAX_TRACE, ("Called.\n"));

    ExGetCurrentProcessorCounts( (PULONG) pIdleCount, (PULONG) pKernelAndUser, (PULONG) pIndex);
}

NdisGetCurrentProcessorCpuUsage()

VOID EXPORT NdisGetCurrentProcessorCpuUsage

(

PULONG

pCpuUsage

)

Definition at line 484 of file misc.c.

{
    NDIS_DbgPrint(MAX_TRACE, ("Called.\n"));

    ExGetCurrentProcessorCpuUsage(pCpuUsage);
}

NdisGetSharedDataAlignment()

ULONG EXPORT NdisGetSharedDataAlignment

(

VOID

)

Definition at line 502 of file misc.c.

{
    NDIS_DbgPrint(MAX_TRACE, ("Called.\n"));

    return KeGetRecommendedSharedDataAlignment();
}

NdisGetSystemUpTime()

VOID EXPORT NdisGetSystemUpTime

(

OUT PULONG

pSystemUpTime

)

Definition at line 358 of file misc.c.

{
    ULONG Increment;
    LARGE_INTEGER TickCount;

    NDIS_DbgPrint(MAX_TRACE, ("Called.\n"));

    /* Get the increment and current tick count */
    Increment = KeQueryTimeIncrement();
    KeQueryTickCount(&TickCount);

    /* Convert to milliseconds and return */
    TickCount.QuadPart *= Increment;
    TickCount.QuadPart /= (10 * 1000);
    *pSystemUpTime = TickCount.LowPart;
}

NdisGetVersion()

UINT EXPORT NdisGetVersion

(

VOID

)

Definition at line 514 of file misc.c.

{
    NDIS_DbgPrint(MAX_TRACE, ("Called.\n"));

    return NDIS_VERSION;
}

NdisInterlockedAddLargeInteger()

VOID EXPORT NdisInterlockedAddLargeInteger	(	IN PLARGE_INTEGER	Addend,
		IN LARGE_INTEGER	Increment,
		IN PNDIS_SPIN_LOCK	SpinLock
	)

Definition at line 30 of file misc.c.

{
    /* This needs to be verified. The documentation
     * seems to be missing but it is exported by
     * NDIS 5.1 so I'm implementing it like the other
     * interlocked routines
     */

    ExInterlockedAddLargeInteger(Addend, Increment, &SpinLock->SpinLock);
}

NdisInterlockedAddUlong()

VOID EXPORT NdisInterlockedAddUlong	(	IN PULONG	Addend,
		IN ULONG	Increment,
		IN PNDIS_SPIN_LOCK	SpinLock
	)

Definition at line 17 of file misc.c.

{
   ExInterlockedAddUlong ( Addend, Increment, &SpinLock->SpinLock );
}

NdisInterlockedDecrement()

LONG EXPORT NdisInterlockedDecrement

(

IN PLONG

Addend

)

Definition at line 381 of file misc.c.

{
  return InterlockedDecrement ( Addend );
}

Referenced by CompletePacket().

NdisInterlockedIncrement()

LONG EXPORT NdisInterlockedIncrement

(

IN PLONG

Addend

)

Definition at line 400 of file misc.c.

{
  return InterlockedIncrement ( Addend );
}

Referenced by ParaNdis5_Initialize(), and ParaNdis5_SendPackets().

NdisInterlockedInsertHeadList()

PLIST_ENTRY EXPORT NdisInterlockedInsertHeadList	(	IN PLIST_ENTRY	ListHead,
		IN PLIST_ENTRY	ListEntry,
		IN PNDIS_SPIN_LOCK	SpinLock
	)

Definition at line 84 of file misc.c.

{
  return ExInterlockedInsertHeadList ( ListHead, ListEntry, &SpinLock->SpinLock );
}

NdisInterlockedInsertTailList()

PLIST_ENTRY EXPORT NdisInterlockedInsertTailList	(	IN PLIST_ENTRY	ListHead,
		IN PLIST_ENTRY	ListEntry,
		IN PNDIS_SPIN_LOCK	SpinLock
	)

Definition at line 98 of file misc.c.

{
  return ExInterlockedInsertTailList ( ListHead, ListEntry, &SpinLock->SpinLock );
}

NdisInterlockedPopEntrySList()

PSINGLE_LIST_ENTRY EXPORT NdisInterlockedPopEntrySList	(	IN PSLIST_HEADER	ListHead,
		IN PKSPIN_LOCK	Lock
	)

Definition at line 419 of file misc.c.

{
  return (PSINGLE_LIST_ENTRY)ExInterlockedPopEntrySList ( ListHead, Lock );
}

NdisInterlockedPushEntrySList()

PSINGLE_LIST_ENTRY EXPORT NdisInterlockedPushEntrySList	(	IN PSLIST_HEADER	ListHead,
		IN PSINGLE_LIST_ENTRY	ListEntry,
		IN PKSPIN_LOCK	Lock
	)

Definition at line 439 of file misc.c.

{
  return (PSINGLE_LIST_ENTRY)ExInterlockedPushEntrySList ( ListHead, (PSLIST_ENTRY)ListEntry, Lock );
}

NdisInterlockedRemoveHeadList()

PLIST_ENTRY EXPORT NdisInterlockedRemoveHeadList	(	IN PLIST_ENTRY	ListHead,
		IN PNDIS_SPIN_LOCK	SpinLock
	)

Definition at line 113 of file misc.c.

{
  return ExInterlockedRemoveHeadList ( ListHead, &SpinLock->SpinLock );
}

NdisMapFile()

VOID EXPORT NdisMapFile	(	OUT PNDIS_STATUS	Status,
		OUT PVOID *	MappedBuffer,
		IN NDIS_HANDLE	FileHandle
	)

Definition at line 149 of file misc.c.

{
  PNDIS_HANDLE_OBJECT HandleObject = (PNDIS_HANDLE_OBJECT) FileHandle;

  NDIS_DbgPrint(MAX_TRACE, ("called: FileHandle 0x%x\n", FileHandle));

  if (HandleObject->Mapped)
  {
      /* If a file already mapped we will return an error code */
      NDIS_DbgPrint(MIN_TRACE, ("File already mapped\n"));
      *Status = NDIS_STATUS_ALREADY_MAPPED;
      return;
  }

  HandleObject->Mapped = TRUE;
  *MappedBuffer = HandleObject->MapBuffer;

  /* Set returned status */
  *Status = STATUS_SUCCESS;
}

NdisOpenFile()

VOID EXPORT NdisOpenFile	(	OUT PNDIS_STATUS	Status,
		OUT PNDIS_HANDLE	FileHandle,
		OUT PUINT	FileLength,
		IN PNDIS_STRING	FileName,
		IN NDIS_PHYSICAL_ADDRESS	HighestAcceptableAddress
	)

Definition at line 224 of file misc.c.

{
  NDIS_STRING FullFileName;
  OBJECT_ATTRIBUTES ObjectAttributes;
  PNDIS_HANDLE_OBJECT FileHandleObject = NULL;
  IO_STATUS_BLOCK IoStatusBlock;

  ASSERT_IRQL(PASSIVE_LEVEL);

  NDIS_DbgPrint(MAX_TRACE, ("Called.\n"));

  ASSERT ( Status && FileName );

  *Status = NDIS_STATUS_SUCCESS;
  FullFileName.Buffer = NULL;

  FullFileName.Length = sizeof(NDIS_FILE_FOLDER) - sizeof(UNICODE_NULL);
  FullFileName.MaximumLength = FileName->MaximumLength + FullFileName.Length;
  FullFileName.Buffer = ExAllocatePool ( NonPagedPool, FullFileName.MaximumLength );

  if ( !FullFileName.Buffer )
  {
    NDIS_DbgPrint(MIN_TRACE, ("Insufficient resources\n"));
    *Status = NDIS_STATUS_RESOURCES;
    goto cleanup;
  }

  FileHandleObject = ExAllocatePool ( NonPagedPool, sizeof(NDIS_HANDLE_OBJECT) );
  if ( !FileHandleObject )
  {
    NDIS_DbgPrint(MIN_TRACE, ("Insufficient resources\n"));
    *Status = NDIS_STATUS_RESOURCES;
    goto cleanup;
  }
  memset ( FileHandleObject, 0, sizeof(NDIS_HANDLE_OBJECT) );

  memmove ( FullFileName.Buffer, NDIS_FILE_FOLDER, FullFileName.Length );
  *Status = RtlAppendUnicodeStringToString ( &FullFileName, FileName );
  if ( !NT_SUCCESS(*Status) )
  {
    NDIS_DbgPrint(MIN_TRACE, ("RtlAppendUnicodeStringToString failed (%x)\n", *Status));
    *Status = NDIS_STATUS_FAILURE;
    goto cleanup;
  }

  InitializeObjectAttributes ( &ObjectAttributes,
    &FullFileName,
    OBJ_CASE_INSENSITIVE|OBJ_KERNEL_HANDLE,
    NULL,
    NULL );

  *Status = ZwCreateFile (
    &FileHandleObject->FileHandle,
    FILE_READ_DATA|SYNCHRONIZE,
    &ObjectAttributes,
    &IoStatusBlock,
    NULL, // PLARGE_INTEGER AllocationSize
    0, // ULONG FileAttributes
    FILE_SHARE_READ, // ULONG ShareAccess
    FILE_OPEN, // ULONG CreateDisposition
    FILE_SYNCHRONOUS_IO_NONALERT, // ULONG CreateOptions
    0, // PVOID EaBuffer
    0 ); // ULONG EaLength

  if ( !NT_SUCCESS(*Status) )
  {
    NDIS_DbgPrint(MIN_TRACE, ("ZwCreateFile failed (%x) Name %wZ\n", *Status, FileName));
    *Status = NDIS_STATUS_FAILURE;
  }

cleanup:
  if ( FullFileName.Buffer != NULL )
  {
    ExFreePool ( FullFileName.Buffer );
    FullFileName.Buffer = NULL;
  }
  if ( !NT_SUCCESS(*Status) )
  {
    if( FileHandleObject ) {
    ExFreePool ( FileHandleObject );
    FileHandleObject = NULL;
    }
    *FileHandle = NULL;
  }
  else
    *FileHandle = NDIS_POBJECT_TO_HANDLE(FileHandleObject);

  return;
}

ndisProcWorkItemHandler()

VOID NTAPI ndisProcWorkItemHandler

(

PVOID

pContext

)

Definition at line 456 of file misc.c.

{
    PNDIS_WORK_ITEM pNdisItem = (PNDIS_WORK_ITEM)pContext;

    NDIS_DbgPrint(MAX_TRACE, ("Called.\n"));

    pNdisItem->Routine(pNdisItem, pNdisItem->Context);
}

Referenced by NdisScheduleWorkItem().

NdisScheduleWorkItem()

NDIS_STATUS EXPORT NdisScheduleWorkItem

(

IN PNDIS_WORK_ITEM

pWorkItem

)

Definition at line 467 of file misc.c.

{
    PWORK_QUEUE_ITEM pntWorkItem = (PWORK_QUEUE_ITEM)pWorkItem->WrapperReserved;

    NDIS_DbgPrint(MAX_TRACE, ("Called.\n"));

    ExInitializeWorkItem(pntWorkItem, ndisProcWorkItemHandler, pWorkItem);
    ExQueueWorkItem(pntWorkItem, DelayedWorkQueue);
    return NDIS_STATUS_SUCCESS;
}

Referenced by ParaNdis5_Reset(), and ParaNdis_OnSetPower().

NdisSystemProcessorCount()

CCHAR EXPORT NdisSystemProcessorCount

(

VOID

)

Definition at line 324 of file misc.c.

{
    return KeNumberProcessors;
}

NdisUnmapFile()

VOID EXPORT NdisUnmapFile

(

IN NDIS_HANDLE

FileHandle

)

Definition at line 178 of file misc.c.

{
  PNDIS_HANDLE_OBJECT HandleObject = (PNDIS_HANDLE_OBJECT) FileHandle;

  NDIS_DbgPrint(MAX_TRACE, ("Called.\n"));

  HandleObject->Mapped = FALSE;
}

Referenced by NdisCloseFile().

Variable Documentation

CancelId

LONG CancelId

Definition at line 23 of file main.c.

Referenced by DriverEntry(), NdisCancelSendPackets(), NdisGeneratePartialCancelId(), NdisSetPacketCancelId(), and ParaNdis5_CancelSendPackets().

NDIS_FILE_FOLDER

const WCHAR NDIS_FILE_FOLDER[] = L"\\SystemRoot\\System32\\Drivers\\"

static

Definition at line 142 of file misc.c.

Referenced by NdisOpenFile().