[project] Rename dev_ext variables to dev
authorShao Miller <Shao.Miller@yrdsb.edu.on.ca>
Tue, 18 May 2010 14:25:47 +0000 (10:25 -0400)
committerShao Miller <Shao.Miller@yrdsb.edu.on.ca>
Tue, 18 May 2010 14:26:06 +0000 (10:26 -0400)
Just cosmetic.  I am trying to hide the details of
Windows DEVICE_OBJECTs with their DeviceExtension.

src/aoe/driver.c
src/include/bus.h
src/include/disk.h
src/include/driver.h
src/include/filedisk.h
src/include/ramdisk.h
src/winvblock/bus/bus.c
src/winvblock/disk/disk.c
src/winvblock/disk/scsi.c
src/winvblock/filedisk.c
src/winvblock/ramdisk/ramdisk.c

index 41eb236..174cd71 100644 (file)
@@ -213,13 +213,13 @@ static irp__handling handling_table[] = {
 };
 
 /*
- * Establish a pointer into the AoE disk device's extension space.
+ * Establish a pointer to the AoE disk.
  * Since the device extension is the first member of the disk
  * member of an AoE disk, and the disk structure is itself the
  * first member of an AoE disk structure, a simple cast will suffice
  */
-#define get_aoe_disk_ptr( dev_ext_ptr ) \
-  ( ( aoe_disk_type_ptr ) dev_ext_ptr )
+#define get_aoe_disk_ptr( dev_ptr ) \
+  ( ( aoe_disk_type_ptr ) dev_ptr )
 
 static winvblock__bool STDCALL
 setup_reg (
@@ -1351,10 +1351,10 @@ disk__io_decl (
   aoe_disk_type_ptr aoe_disk_ptr;
 
   /*
-   * Establish pointers into the disk device's extension space
+   * Establish pointers to the disk and AoE disk
    */
-  disk_ptr = get_disk_ptr ( dev_ext_ptr );
-  aoe_disk_ptr = get_aoe_disk_ptr ( dev_ext_ptr );
+  disk_ptr = get_disk_ptr ( dev_ptr );
+  aoe_disk_ptr = get_aoe_disk_ptr ( dev_ptr );
 
   if ( AoE_Globals_Stop )
     {
@@ -1441,7 +1441,7 @@ disk__io_decl (
       RtlZeroMemory ( tag, sizeof ( work_tag ) );
       tag->type = tag_type_io;
       tag->request_ptr = request_ptr;
-      tag->DeviceExtension = dev_ext_ptr;
+      tag->DeviceExtension = dev_ptr;
       request_ptr->TagCount++;
       tag->Id = 0;
       tag->BufferOffset = i * disk_ptr->SectorSize;
@@ -1727,7 +1727,7 @@ aoe__reply (
   KeReleaseSpinLock ( &AoE_Globals_SpinLock, Irql );
 
   /*
-   * Establish pointers into the disk device's extension space
+   * Establish pointers to the disk device and AoE disk
    */
   disk_ptr = get_disk_ptr ( tag->DeviceExtension );
   aoe_disk_ptr = get_aoe_disk_ptr ( tag->DeviceExtension );
@@ -1957,7 +1957,7 @@ thread (
       while ( tag != NULL )
        {
          /*
-          * Establish pointers into the disk device's extension space
+          * Establish pointers to the disk and AoE disk
           */
          disk_ptr = get_disk_ptr ( tag->DeviceExtension );
          aoe_disk_ptr = get_aoe_disk_ptr ( tag->DeviceExtension );
index f463901..9d9b56f 100644 (file)
@@ -55,12 +55,12 @@ extern NTSTATUS STDCALL Bus_GetDeviceCapabilities (
 /**
  * Add a child node to the bus
  *
- * @v dev_ext_ptr     The details for the child device to add
+ * @v dev_ptr           The details for the child device to add
  *
  * Returns TRUE for success, FALSE for failure
  */
 extern winvblock__lib_func winvblock__bool STDCALL bus__add_child (
-  IN device__type_ptr dev_ext_ptr
+  IN device__type_ptr dev_ptr
  );
 
 /**
@@ -73,11 +73,11 @@ extern winvblock__lib_func bus__type_ptr STDCALL bus__dev (
  );
 
 /*
- * Establish a pointer into the bus device's extension space.
+ * Establish a pointer to the bus.
  * Since the device extension is the first member of a bus
  * structure, a simple cast will suffice
  */
-#  define get_bus_ptr( dev_ext_ptr ) \
-  ( ( bus__type_ptr ) dev_ext_ptr )
+#  define get_bus_ptr( dev_ptr ) \
+  ( ( bus__type_ptr ) dev_ptr )
 
 #endif                         /* _BUS_H */
index 213e055..7d7f796 100644 (file)
@@ -55,18 +55,18 @@ winvblock__def_struct ( disk__type );
 /**
  * I/O Request
  *
- * @v dev_ext_ptr     The device extension space
- * @v mode            Read / write mode
- * @v start_sector    First sector for request
- * @v sector_count    Number of sectors to work with
- * @v buffer          Buffer to read / write sectors to / from
- * @v irp             Interrupt request packet for this request
+ * @v dev_ptr           The device extension space
+ * @v mode              Read / write mode
+ * @v start_sector      First sector for request
+ * @v sector_count      Number of sectors to work with
+ * @v buffer            Buffer to read / write sectors to / from
+ * @v irp               Interrupt request packet for this request
  */
 #  define disk__io_decl( x ) \
 \
 NTSTATUS \
 x ( \
-  IN device__type_ptr dev_ext_ptr, \
+  IN device__type_ptr dev_ptr, \
   IN disk__io_mode mode, \
   IN LONGLONG start_sector, \
   IN winvblock__uint32 sector_count, \
@@ -209,12 +209,12 @@ extern winvblock__lib_func driver__dev_ops_ptr disk__get_ops (
  );
 
 /*
- * Establish a pointer into the child disk device's extension space.
+ * Establish a pointer to the child disk.
  * Since the device extension is the first member of a disk
  * structure, a simple cast will suffice
  */
-#  define get_disk_ptr( dev_ext_ptr ) \
-  ( ( disk__type_ptr ) dev_ext_ptr )
+#  define get_disk_ptr( dev_ptr ) \
+  ( ( disk__type_ptr ) dev_ptr )
 
 __inline
 disk__io_decl (
@@ -224,12 +224,12 @@ disk__io_decl (
   disk__type_ptr disk_ptr;
 
   /*
-   * Establish a pointer into the disk device's extension space
+   * Establish a pointer to the disk
    */
-  disk_ptr = get_disk_ptr ( dev_ext_ptr );
+  disk_ptr = get_disk_ptr ( dev_ptr );
 
-  return disk_ptr->ops->io ( dev_ext_ptr, mode, start_sector, sector_count,
-                            buffer, irp );
+  return disk_ptr->ops->io ( dev_ptr, mode, start_sector, sector_count, buffer,
+                            irp );
 }
 
 __inline
index d29728a..107ebac 100644 (file)
@@ -68,7 +68,7 @@ winvblock__def_struct ( device__type );
 \
 PDEVICE_OBJECT STDCALL \
 x ( \
-  IN device__type_ptr dev_ext_ptr \
+  IN device__type_ptr dev_ptr \
  )
 /*
  * Function pointer for a device initialization routine.
@@ -81,13 +81,13 @@ typedef driver__dev_create_pdo_decl (
 /**
  * Device initialization routine
  *
- * @v dev_ext_ptr     The device being initialized
+ * @v dev_ptr           The device being initialized
  */
 #  define driver__dev_init_decl( x ) \
 \
 winvblock__bool STDCALL \
 x ( \
-  IN device__type_ptr dev_ext_ptr \
+  IN device__type_ptr dev_ptr \
  )
 /*
  * Function pointer for a device initialization routine.
@@ -100,13 +100,13 @@ typedef driver__dev_init_decl (
 /**
  * Device close routine
  *
- * @v dev_ext_ptr     The device being closed
+ * @v dev_ptr           The device being closed
  */
 #  define driver__dev_close_decl( x ) \
 \
 void STDCALL \
 x ( \
-  IN device__type_ptr dev_ext_ptr \
+  IN device__type_ptr dev_ptr \
  )
 /*
  * Function pointer for a device close routine.
index c6a52c5..ed20456 100644 (file)
@@ -1,5 +1,5 @@
 /**
- * Copyright (C) 2009, Shao Miller <shao.miller@yrdsb.edu.on.ca>.
+ * Copyright (C) 2009-2010, Shao Miller <shao.miller@yrdsb.edu.on.ca>.
  *
  * This file is part of WinVBlock, derived from WinAoE.
  *
@@ -34,13 +34,13 @@ winvblock__def_struct ( filedisk__type )
 };
 
 /*
- * Establish a pointer into the file-backed disk device's extension space.
+ * Establish a pointer to the file-backed disk.
  * Since the device extension is the first member of the disk
  * member of a file-backed disk, and the disk structure is itself the
  * first member of a file-backed disk structure, a simple cast will suffice
  */
-#  define filedisk__get_ptr( dev_ext_ptr ) \
-  ( ( filedisk__type_ptr ) dev_ext_ptr )
+#  define filedisk__get_ptr( dev_ptr ) \
+  ( ( filedisk__type_ptr ) dev_ptr )
 
 extern irp__handler_decl (
   filedisk__attach
index f94f089..df64ca4 100644 (file)
@@ -1,5 +1,5 @@
 /**
- * Copyright (C) 2009, Shao Miller <shao.miller@yrdsb.edu.on.ca>.
+ * Copyright (C) 2009-2010, Shao Miller <shao.miller@yrdsb.edu.on.ca>.
  *
  * This file is part of WinVBlock, derived from WinAoE.
  *
@@ -36,12 +36,12 @@ winvblock__def_struct ( ramdisk__type )
 extern disk__ops ramdisk__default_ops;
 
 /*
- * Establish a pointer into the RAM disk device's extension space.
+ * Establish a pointer to the RAM disk.
  * Since the device extension is the first member of the disk
  * member of an AoE disk, and the disk structure is itself the
  * first member of an AoE disk structure, a simple cast will suffice
  */
-#  define ramdisk__get_ptr( dev_ext_ptr ) \
-  ( ( ramdisk__type_ptr ) dev_ext_ptr )
+#  define ramdisk__get_ptr( dev_ptr ) \
+  ( ( ramdisk__type_ptr ) dev_ptr )
 
 #endif                         /* _ramdisk_h */
index 9ef1de1..a366bda 100644 (file)
@@ -57,13 +57,13 @@ Bus_Stop (
 /**
  * Add a child node to the bus
  *
- * @v dev_ext_ptr     The details for the child device to add
+ * @v dev_ptr           The details for the child device to add
  *
  * Returns TRUE for success, FALSE for failure
  */
 winvblock__lib_func winvblock__bool STDCALL
 bus__add_child (
-  IN device__type_ptr dev_ext_ptr
+  IN device__type_ptr dev_ptr
  )
 {
   /**
@@ -76,19 +76,19 @@ bus__add_child (
   device__type_ptr walker;
 
   DBG ( "Entry\n" );
-  /*
-   * Establish a pointer into the bus device's extension space
-   */
   if ( !bus_fdo )
     {
       DBG ( "No bus device!\n" );
       return FALSE;
     }
+  /*
+   * Establish a pointer to the bus
+   */
   bus_ptr = get_bus_ptr ( bus_fdo->DeviceExtension );
   /*
    * Create the child device
    */
-  dev_obj_ptr = dev_ext_ptr->ops->create_pdo ( dev_ext_ptr );
+  dev_obj_ptr = dev_ptr->ops->create_pdo ( dev_ptr );
   if ( !dev_obj_ptr )
     {
       DBG ( "bus__add_child() failed!\n" );
@@ -96,31 +96,31 @@ bus__add_child (
     }
 
   /*
-   * Re-purpose dev_ext_ptr to point into the PDO's device
+   * Re-purpose dev_ptr to point into the PDO's device
    * extension space.  We don't need the original details anymore
    */
-  dev_ext_ptr = dev_obj_ptr->DeviceExtension;
-  dev_ext_ptr->Parent = bus_fdo;
-  dev_ext_ptr->next_sibling_ptr = NULL;
+  dev_ptr = dev_obj_ptr->DeviceExtension;
+  dev_ptr->Parent = bus_fdo;
+  dev_ptr->next_sibling_ptr = NULL;
   /*
    * Initialize the device.  For disks, this routine is responsible for
    * determining the disk's geometry appropriately for AoE/RAM/file disks
    */
-  dev_ext_ptr->ops->init ( dev_ext_ptr );
+  dev_ptr->ops->init ( dev_ptr );
   dev_obj_ptr->Flags &= ~DO_DEVICE_INITIALIZING;
   /*
    * Add the new device's extension to the bus' list of children
    */
   if ( bus_ptr->first_child_ptr == NULL )
     {
-      bus_ptr->first_child_ptr = ( winvblock__uint8_ptr ) dev_ext_ptr;
+      bus_ptr->first_child_ptr = ( winvblock__uint8_ptr ) dev_ptr;
     }
   else
     {
       walker = ( device__type_ptr ) bus_ptr->first_child_ptr;
       while ( walker->next_sibling_ptr != NULL )
        walker = walker->next_sibling_ptr;
-      walker->next_sibling_ptr = dev_ext_ptr;
+      walker->next_sibling_ptr = dev_ptr;
     }
   bus_ptr->Children++;
   if ( bus_ptr->PhysicalDeviceObject != NULL )
@@ -234,7 +234,7 @@ Bus_AddDevice (
   NTSTATUS Status;
   UNICODE_STRING DeviceName,
    DosDeviceName;
-  device__type_ptr bus_dev_ext_ptr;
+  device__type_ptr bus_dev_ptr;
   bus__type_ptr bus_ptr;
 
   DBG ( "Entry\n" );
@@ -261,27 +261,27 @@ Bus_AddDevice (
   /*
    * Set some default parameters for a bus
    */
-  bus_dev_ext_ptr = ( device__type_ptr ) bus_fdo->DeviceExtension;
-  RtlZeroMemory ( bus_dev_ext_ptr, sizeof ( bus__type ) );
-  bus_dev_ext_ptr->IsBus = TRUE;
-  bus_dev_ext_ptr->size = sizeof ( bus__type );
-  bus_dev_ext_ptr->DriverObject = DriverObject;
-  bus_dev_ext_ptr->Self = bus_fdo;
-  bus_dev_ext_ptr->State = NotStarted;
-  bus_dev_ext_ptr->OldState = NotStarted;
+  bus_dev_ptr = ( device__type_ptr ) bus_fdo->DeviceExtension;
+  RtlZeroMemory ( bus_dev_ptr, sizeof ( bus__type ) );
+  bus_dev_ptr->IsBus = TRUE;
+  bus_dev_ptr->size = sizeof ( bus__type );
+  bus_dev_ptr->DriverObject = DriverObject;
+  bus_dev_ptr->Self = bus_fdo;
+  bus_dev_ptr->State = NotStarted;
+  bus_dev_ptr->OldState = NotStarted;
   /*
    * Register the default driver IRP handling table
    */
-  irp__reg_table_s ( &bus_dev_ext_ptr->irp_handler_chain,
-                    driver__handling_table, driver__handling_table_size );
+  irp__reg_table_s ( &bus_dev_ptr->irp_handler_chain, driver__handling_table,
+                    driver__handling_table_size );
   /*
    * Register the default bus IRP handling table
    */
-  irp__reg_table ( &bus_dev_ext_ptr->irp_handler_chain, handling_table );
+  irp__reg_table ( &bus_dev_ptr->irp_handler_chain, handling_table );
   /*
-   * Establish a pointer into the bus device's extension space
+   * Establish a pointer to the bus
    */
-  bus_ptr = get_bus_ptr ( bus_dev_ext_ptr );
+  bus_ptr = get_bus_ptr ( bus_dev_ptr );
   bus_ptr->PhysicalDeviceObject = PhysicalDeviceObject;
   bus_ptr->Children = 0;
   bus_ptr->first_child_ptr = NULL;
@@ -305,7 +305,7 @@ Bus_AddDevice (
     }
   bus_fdo->Flags &= ~DO_DEVICE_INITIALIZING;
 #ifdef RIS
-  bus_dev_ext_ptr->State = Started;
+  bus_dev_ptr->State = Started;
 #endif
   DBG ( "Exit\n" );
   return STATUS_SUCCESS;
index be253eb..bad6d11 100644 (file)
@@ -64,7 +64,7 @@ driver__dev_init_decl (
   init
  )
 {
-  disk__type_ptr disk_ptr = get_disk_ptr ( dev_ext_ptr );
+  disk__type_ptr disk_ptr = get_disk_ptr ( dev_ptr );
   return disk_ptr->ops->init ( disk_ptr );
 }
 
@@ -78,7 +78,7 @@ driver__dev_close_decl (
   close
  )
 {
-  disk__type_ptr disk_ptr = get_disk_ptr ( dev_ext_ptr );
+  disk__type_ptr disk_ptr = get_disk_ptr ( dev_ptr );
   disk_ptr->ops->close ( disk_ptr );
   return;
 }
@@ -142,7 +142,7 @@ static irp__handling handling_table[] = {
 /**
  * Create a disk PDO filled with the given disk parameters
  *
- * @v dev_ext_ptr     Populate PDO dev. ext. space from these details
+ * @v dev_ptr           Populate PDO dev. ext. space from these details
  *
  * Returns a Physical Device Object pointer on success, NULL for failure.
  */
@@ -173,7 +173,7 @@ driver__dev_create_pdo_decl (
   /*
    * Point to the disk details provided
    */
-  disk_ptr = get_disk_ptr ( dev_ext_ptr );
+  disk_ptr = get_disk_ptr ( dev_ptr );
   /*
    * Create the disk device.  Whoever calls us should have set
    * the device extension space size requirement appropriately
@@ -189,40 +189,40 @@ driver__dev_create_pdo_decl (
       return NULL;
     }
   /*
-   * Re-purpose dev_ext_ptr to point into the PDO's device
+   * Re-purpose dev_ptr to point into the PDO's device
    * extension space.  We have disk_ptr still for original details
    */
-  dev_ext_ptr = dev_obj_ptr->DeviceExtension;
+  dev_ptr = dev_obj_ptr->DeviceExtension;
   /*
    * Clear the extension space and establish parameters
    */
-  RtlZeroMemory ( dev_ext_ptr, disk_ptr->dev_ext.size );
+  RtlZeroMemory ( dev_ptr, disk_ptr->dev_ext.size );
   /*
    * Copy the provided disk parameters into the disk extension space
    */
-  RtlCopyMemory ( dev_ext_ptr, &disk_ptr->dev_ext, disk_ptr->dev_ext.size );
+  RtlCopyMemory ( dev_ptr, &disk_ptr->dev_ext, disk_ptr->dev_ext.size );
   /*
    * Universal disk properties the caller needn't bother with
    */
-  dev_ext_ptr->IsBus = FALSE;
-  dev_ext_ptr->Self = dev_obj_ptr;
-  dev_ext_ptr->DriverObject = driver__obj_ptr;
-  dev_ext_ptr->State = NotStarted;
-  dev_ext_ptr->OldState = NotStarted;
-  dev_ext_ptr->irp_handler_chain = NULL;
+  dev_ptr->IsBus = FALSE;
+  dev_ptr->Self = dev_obj_ptr;
+  dev_ptr->DriverObject = driver__obj_ptr;
+  dev_ptr->State = NotStarted;
+  dev_ptr->OldState = NotStarted;
+  dev_ptr->irp_handler_chain = NULL;
   /*
    * Register the default driver IRP handling table
    */
-  irp__reg_table_s ( &dev_ext_ptr->irp_handler_chain, driver__handling_table,
+  irp__reg_table_s ( &dev_ptr->irp_handler_chain, driver__handling_table,
                     driver__handling_table_size );
   /*
    * Register the default disk IRP handling table
    */
-  irp__reg_table ( &dev_ext_ptr->irp_handler_chain, handling_table );
+  irp__reg_table ( &dev_ptr->irp_handler_chain, handling_table );
   /*
-   * Establish a pointer into the disk device's extension space
+   * Establish a pointer to the disk
    */
-  disk_ptr = get_disk_ptr ( dev_ext_ptr );
+  disk_ptr = get_disk_ptr ( dev_ptr );
   KeInitializeEvent ( &disk_ptr->SearchEvent, SynchronizationEvent, FALSE );
   KeInitializeSpinLock ( &disk_ptr->SpinLock );
   disk_ptr->Unmount = FALSE;
index 77a7be6..990140f 100644 (file)
@@ -357,7 +357,7 @@ irp__handler_decl ( disk_scsi__dispatch )
   winvblock__bool completion = FALSE;
 
   /*
-   * Establish a pointer into the disk device's extension space
+   * Establish a pointer to the disk
    */
   disk_ptr = get_disk_ptr ( DeviceExtension );
 
index bb4b8e8..367ac75 100644 (file)
@@ -1,5 +1,5 @@
 /**
- * Copyright (C) 2009, Shao Miller <shao.miller@yrdsb.edu.on.ca>.
+ * Copyright (C) 2009-2010, Shao Miller <shao.miller@yrdsb.edu.on.ca>.
  *
  * This file is part of WinVBlock, derived from WinAoE.
  *
@@ -49,10 +49,10 @@ disk__io_decl (
   IO_STATUS_BLOCK io_status;
 
   /*
-   * Establish pointers into the disk device's extension space
+   * Establish pointers to the disk and filedisk
    */
-  disk_ptr = get_disk_ptr ( dev_ext_ptr );
-  filedisk_ptr = filedisk__get_ptr ( dev_ext_ptr );
+  disk_ptr = get_disk_ptr ( dev_ptr );
+  filedisk_ptr = filedisk__get_ptr ( dev_ptr );
 
   if ( sector_count < 1 )
     {
index eba2cb5..6377b26 100644 (file)
@@ -1,5 +1,5 @@
 /**
- * Copyright (C) 2009, Shao Miller <shao.miller@yrdsb.edu.on.ca>.
+ * Copyright (C) 2009-2010, Shao Miller <shao.miller@yrdsb.edu.on.ca>.
  *
  * This file is part of WinVBlock, derived from WinAoE.
  *
@@ -57,10 +57,10 @@ disk__io_decl (
   ramdisk__type_ptr ramdisk_ptr;
 
   /*
-   * Establish pointers into the disk device's extension space
+   * Establish pointers to the disk and RAM disk
    */
-  disk_ptr = get_disk_ptr ( dev_ext_ptr );
-  ramdisk_ptr = ramdisk__get_ptr ( dev_ext_ptr );
+  disk_ptr = get_disk_ptr ( dev_ptr );
+  ramdisk_ptr = ramdisk__get_ptr ( dev_ptr );
 
   if ( sector_count < 1 )
     {