From c488949022b741cb20f9677730a9f1f6e115ea52 Mon Sep 17 00:00:00 2001 From: Bill Zissimopoulos Date: Mon, 18 Jan 2016 12:38:37 -0800 Subject: [PATCH] sys: rename retain/release to reference/dereference --- src/sys/close.c | 2 +- src/sys/create.c | 6 +++--- src/sys/device.c | 26 +++++++++++++------------- src/sys/driver.h | 18 +++++++++--------- src/sys/iop.c | 8 ++++---- src/sys/node.c | 10 +++++----- src/sys/volume.c | 26 +++++++++++++------------- 7 files changed, 48 insertions(+), 48 deletions(-) diff --git a/src/sys/close.c b/src/sys/close.c index 1dc926f9..f07920aa 100644 --- a/src/sys/close.c +++ b/src/sys/close.c @@ -59,7 +59,7 @@ static NTSTATUS FspFsvolClose( FSP_FSCTL_TRANSACT_REQ *Request; /* dereference the FileNode (and delete if no more references) */ - FspFileNodeRelease(FileNode); + FspFileNodeDereference(FileNode); /* create the user-mode file system request; MustSucceed because IRP_MJ_CLOSE cannot fail */ FspIopCreateRequestMustSucceed(0, FileNameRequired ? &FileNode->FileName : 0, 0, &Request); diff --git a/src/sys/create.c b/src/sys/create.c index ae818762..44ffa442 100644 --- a/src/sys/create.c +++ b/src/sys/create.c @@ -267,7 +267,7 @@ static NTSTATUS FspFsvolCreate( FspFsvolCreateRequestFini, &Request); if (!NT_SUCCESS(Result)) { - FspFileNodeRelease(FileNode); + FspFileNodeDereference(FileNode); return Result; } @@ -680,7 +680,7 @@ static VOID FspFsvolCreateRequestFini(PVOID Context[3]) if (0 != Context[RequestFileNode]) { - FspFileNodeRelease(Context[RequestFileNode]); + FspFileNodeDereference(Context[RequestFileNode]); Context[RequestFileNode] = 0; } @@ -728,7 +728,7 @@ static VOID FspFsvolCreateOverwriteRequestFini(PVOID Context[3]) FspFileNodeClose(FileNode, FileObject, 0); } - FspFileNodeRelease(FileNode); + FspFileNodeDereference(FileNode); Context[RequestFileObject] = 0; Context[RequestFileNode] = 0; diff --git a/src/sys/device.c b/src/sys/device.c index 29ec9036..b2e07552 100644 --- a/src/sys/device.c +++ b/src/sys/device.c @@ -15,12 +15,12 @@ NTSTATUS FspDeviceCreate(UINT32 Kind, ULONG ExtraSize, PDEVICE_OBJECT *PDeviceObject); NTSTATUS FspDeviceInitialize(PDEVICE_OBJECT DeviceObject); VOID FspDeviceDelete(PDEVICE_OBJECT DeviceObject); -BOOLEAN FspDeviceRetain(PDEVICE_OBJECT DeviceObject); -VOID FspDeviceRelease(PDEVICE_OBJECT DeviceObject); +BOOLEAN FspDeviceReference(PDEVICE_OBJECT DeviceObject); +VOID FspDeviceDereference(PDEVICE_OBJECT DeviceObject); _IRQL_requires_(DISPATCH_LEVEL) -static BOOLEAN FspDeviceRetainAtDpcLevel(PDEVICE_OBJECT DeviceObject); +static BOOLEAN FspDeviceReferenceAtDpcLevel(PDEVICE_OBJECT DeviceObject); _IRQL_requires_(DISPATCH_LEVEL) -static VOID FspDeviceReleaseFromDpcLevel(PDEVICE_OBJECT DeviceObject); +static VOID FspDeviceDereferenceFromDpcLevel(PDEVICE_OBJECT DeviceObject); static NTSTATUS FspFsvolDeviceInit(PDEVICE_OBJECT DeviceObject); static VOID FspFsvolDeviceFini(PDEVICE_OBJECT DeviceObject); static IO_TIMER_ROUTINE FspFsvolDeviceTimerRoutine; @@ -171,7 +171,7 @@ VOID FspDeviceDelete(PDEVICE_OBJECT DeviceObject) IoDeleteDevice(DeviceObject); } -BOOLEAN FspDeviceRetain(PDEVICE_OBJECT DeviceObject) +BOOLEAN FspDeviceReference(PDEVICE_OBJECT DeviceObject) { // !PAGED_CODE(); @@ -189,7 +189,7 @@ BOOLEAN FspDeviceRetain(PDEVICE_OBJECT DeviceObject) return Result; } -VOID FspDeviceRelease(PDEVICE_OBJECT DeviceObject) +VOID FspDeviceDereference(PDEVICE_OBJECT DeviceObject) { // !PAGED_CODE(); @@ -211,7 +211,7 @@ VOID FspDeviceRelease(PDEVICE_OBJECT DeviceObject) } _IRQL_requires_(DISPATCH_LEVEL) -static BOOLEAN FspDeviceRetainAtDpcLevel(PDEVICE_OBJECT DeviceObject) +static BOOLEAN FspDeviceReferenceAtDpcLevel(PDEVICE_OBJECT DeviceObject) { // !PAGED_CODE(); @@ -229,7 +229,7 @@ static BOOLEAN FspDeviceRetainAtDpcLevel(PDEVICE_OBJECT DeviceObject) } _IRQL_requires_(DISPATCH_LEVEL) -static VOID FspDeviceReleaseFromDpcLevel(PDEVICE_OBJECT DeviceObject) +static VOID FspDeviceDereferenceFromDpcLevel(PDEVICE_OBJECT DeviceObject) { // !PAGED_CODE(); @@ -321,7 +321,7 @@ static VOID FspFsvolDeviceFini(PDEVICE_OBJECT DeviceObject) * * Our IoTimer routine will NOT be called again after IoStopTimer() returns. * However a work item may be in flight. For this reason our IoTimer routine - * retains our DeviceObject before queueing work items. + * references our DeviceObject before queueing work items. */ if (FsvolDeviceExtension->InitDoneTimer) IoStopTimer(DeviceObject); @@ -366,14 +366,14 @@ static VOID FspFsvolDeviceTimerRoutine(PDEVICE_OBJECT DeviceObject, PVOID Contex // !PAGED_CODE(); /* - * This routine runs at DPC level. Retain our DeviceObject and queue a work item + * This routine runs at DPC level. Reference our DeviceObject and queue a work item * so that we can do our processing at Passive level. Only do so if the work item * is not already in flight (otherwise we could requeue the same work item). */ ASSERT(KeGetCurrentIrql() == DISPATCH_LEVEL); - if (!FspDeviceRetainAtDpcLevel(DeviceObject)) + if (!FspDeviceReferenceAtDpcLevel(DeviceObject)) return; BOOLEAN ExpirationInProgress; @@ -389,7 +389,7 @@ static VOID FspFsvolDeviceTimerRoutine(PDEVICE_OBJECT DeviceObject, PVOID Contex KeReleaseSpinLockFromDpcLevel(&FsvolDeviceExtension->ExpirationLock); if (ExpirationInProgress) - FspDeviceReleaseFromDpcLevel(DeviceObject); + FspDeviceDereferenceFromDpcLevel(DeviceObject); } static VOID FspFsvolDeviceExpirationRoutine(PVOID Context) @@ -406,7 +406,7 @@ static VOID FspFsvolDeviceExpirationRoutine(PVOID Context) FsvolDeviceExtension->ExpirationInProgress = FALSE; KeReleaseSpinLock(&FsvolDeviceExtension->ExpirationLock, Irql); - FspDeviceRelease(DeviceObject); + FspDeviceDereference(DeviceObject); } VOID FspFsvolDeviceLockContextTable(PDEVICE_OBJECT DeviceObject) diff --git a/src/sys/driver.h b/src/sys/driver.h index 28aca674..3ae214df 100644 --- a/src/sys/driver.h +++ b/src/sys/driver.h @@ -103,16 +103,16 @@ extern __declspec(selectany) int fsp_bp = 1; #define FSP_ENTER_MJ(...) \ NTSTATUS Result = STATUS_SUCCESS; \ PIO_STACK_LOCATION IrpSp = IoGetCurrentIrpStackLocation(Irp);\ - BOOLEAN fsp_device_release = FALSE; \ + BOOLEAN fsp_device_deref = FALSE; \ FSP_ENTER_(__VA_ARGS__); \ do \ { \ - if (!FspDeviceRetain(IrpSp->DeviceObject))\ + if (!FspDeviceReference(IrpSp->DeviceObject))\ { \ Result = STATUS_CANCELLED; \ goto fsp_leave_label; \ } \ - fsp_device_release = TRUE; \ + fsp_device_deref = TRUE; \ } while (0,0) #define FSP_LEAVE_MJ(fmt, ...) \ FSP_LEAVE_( \ @@ -141,7 +141,7 @@ extern __declspec(selectany) int fsp_bp = 1; }\ } \ else \ - FspIopCompleteIrpEx(Irp, Result, fsp_device_release);\ + FspIopCompleteIrpEx(Irp, Result, fsp_device_deref);\ } \ ); \ return Result @@ -403,7 +403,7 @@ VOID FspIopDeleteRequest(FSP_FSCTL_TRANSACT_REQ *Request); PVOID *FspIopRequestContextAddress(FSP_FSCTL_TRANSACT_REQ *Request, ULONG I); NTSTATUS FspIopPostWorkRequestFunnel(PDEVICE_OBJECT DeviceObject, FSP_FSCTL_TRANSACT_REQ *Request, BOOLEAN BestEffort); -VOID FspIopCompleteIrpEx(PIRP Irp, NTSTATUS Result, BOOLEAN DeviceRelease); +VOID FspIopCompleteIrpEx(PIRP Irp, NTSTATUS Result, BOOLEAN DeviceDereference); VOID FspIopCompleteCanceledIrp(PIRP Irp); NTSTATUS FspIopDispatchPrepare(PIRP Irp, FSP_FSCTL_TRANSACT_REQ *Request); VOID FspIopDispatchComplete(PIRP Irp, const FSP_FSCTL_TRANSACT_RSP *Response); @@ -473,8 +473,8 @@ NTSTATUS FspDeviceCreate(UINT32 Kind, ULONG ExtraSize, PDEVICE_OBJECT *PDeviceObject); NTSTATUS FspDeviceInitialize(PDEVICE_OBJECT DeviceObject); VOID FspDeviceDelete(PDEVICE_OBJECT DeviceObject); -BOOLEAN FspDeviceRetain(PDEVICE_OBJECT DeviceObject); -VOID FspDeviceRelease(PDEVICE_OBJECT DeviceObject); +BOOLEAN FspDeviceReference(PDEVICE_OBJECT DeviceObject); +VOID FspDeviceDereference(PDEVICE_OBJECT DeviceObject); VOID FspFsvolDeviceLockContextTable(PDEVICE_OBJECT DeviceObject); VOID FspFsvolDeviceUnlockContextTable(PDEVICE_OBJECT DeviceObject); PVOID FspFsvolDeviceLookupContext(PDEVICE_OBJECT DeviceObject, UINT64 Identifier); @@ -549,12 +549,12 @@ FSP_FILE_NODE *FspFileNodeOpen(FSP_FILE_NODE *FileNode, PFILE_OBJECT FileObject, VOID FspFileNodeClose(FSP_FILE_NODE *FileNode, PFILE_OBJECT FileObject, PBOOLEAN PDeletePending); static inline -VOID FspFileNodeRetain(FSP_FILE_NODE *FileNode) +VOID FspFileNodeReference(FSP_FILE_NODE *FileNode) { InterlockedIncrement(&FileNode->RefCount); } static inline -VOID FspFileNodeRelease(FSP_FILE_NODE *FileNode) +VOID FspFileNodeDereference(FSP_FILE_NODE *FileNode) { LONG RefCount = InterlockedDecrement(&FileNode->RefCount); if (0 == RefCount) diff --git a/src/sys/iop.c b/src/sys/iop.c index 819727cd..04a3f869 100644 --- a/src/sys/iop.c +++ b/src/sys/iop.c @@ -15,7 +15,7 @@ PVOID *FspIopRequestContextAddress(FSP_FSCTL_TRANSACT_REQ *Request, ULONG I); NTSTATUS FspIopPostWorkRequestFunnel(PDEVICE_OBJECT DeviceObject, FSP_FSCTL_TRANSACT_REQ *Request, BOOLEAN AllocateIrpMustSucceed); static IO_COMPLETION_ROUTINE FspIopPostWorkRequestCompletion; -VOID FspIopCompleteIrpEx(PIRP Irp, NTSTATUS Result, BOOLEAN DeviceRelease); +VOID FspIopCompleteIrpEx(PIRP Irp, NTSTATUS Result, BOOLEAN DeviceDereference); VOID FspIopCompleteCanceledIrp(PIRP Irp); NTSTATUS FspIopDispatchPrepare(PIRP Irp, FSP_FSCTL_TRANSACT_REQ *Request); VOID FspIopDispatchComplete(PIRP Irp, const FSP_FSCTL_TRANSACT_RSP *Response); @@ -209,7 +209,7 @@ static NTSTATUS FspIopPostWorkRequestCompletion( return STATUS_MORE_PROCESSING_REQUIRED; } -VOID FspIopCompleteIrpEx(PIRP Irp, NTSTATUS Result, BOOLEAN DeviceRelease) +VOID FspIopCompleteIrpEx(PIRP Irp, NTSTATUS Result, BOOLEAN DeviceDereference) { PAGED_CODE(); @@ -230,8 +230,8 @@ VOID FspIopCompleteIrpEx(PIRP Irp, NTSTATUS Result, BOOLEAN DeviceRelease) Irp->IoStatus.Status = Result; IoCompleteRequest(Irp, FSP_IO_INCREMENT); - if (DeviceRelease) - FspDeviceRelease(DeviceObject); + if (DeviceDereference) + FspDeviceDereference(DeviceObject); } VOID FspIopCompleteCanceledIrp(PIRP Irp) diff --git a/src/sys/node.c b/src/sys/node.c index a4f0921c..d1b59b8c 100644 --- a/src/sys/node.c +++ b/src/sys/node.c @@ -56,7 +56,7 @@ NTSTATUS FspFileNodeCreate(PDEVICE_OBJECT DeviceObject, FileNode->NonPaged = NonPaged; FileNode->RefCount = 1; FileNode->FsvolDeviceObject = DeviceObject; - FspDeviceRetain(FileNode->FsvolDeviceObject); + FspDeviceReference(FileNode->FsvolDeviceObject); RtlInitEmptyUnicodeString(&FileNode->FileName, FileNode->FileNameBuf, (USHORT)ExtraSize); *PFileNode = FileNode; @@ -70,7 +70,7 @@ VOID FspFileNodeDelete(FSP_FILE_NODE *FileNode) FsRtlTeardownPerStreamContexts(&FileNode->Header); - FspDeviceRelease(FileNode->FsvolDeviceObject); + FspDeviceDereference(FileNode->FsvolDeviceObject); ExDeleteResourceLite(&FileNode->NonPaged->PagingIoResource); ExDeleteResourceLite(&FileNode->NonPaged->Resource); @@ -105,7 +105,7 @@ FSP_FILE_NODE *FspFileNodeOpen(FSP_FILE_NODE *FileNode, PFILE_OBJECT FileObject, { /* * The new FileNode was inserted into the Context table. Set its share access - * and retain and open it. There should be (at least) two references to this + * and reference and open it. There should be (at least) two references to this * FileNode, one from our caller and one from the Context table. */ ASSERT(OpenedFileNode == FileNode); @@ -160,7 +160,7 @@ FSP_FILE_NODE *FspFileNodeOpen(FSP_FILE_NODE *FileNode, PFILE_OBJECT FileObject, if (0 != OpenedFileNode) { - FspFileNodeRetain(OpenedFileNode); + FspFileNodeReference(OpenedFileNode); OpenedFileNode->OpenCount++; if (DeleteOnClose) @@ -198,7 +198,7 @@ VOID FspFileNodeClose(FSP_FILE_NODE *FileNode, PFILE_OBJECT FileObject, FspFsvolDeviceUnlockContextTable(FsvolDeviceObject); if (Deleted) - FspFileNodeRelease(FileNode); + FspFileNodeDereference(FileNode); if (0 != PDeletePending) *PDeletePending = Deleted && DeletePending; diff --git a/src/sys/volume.c b/src/sys/volume.c index 6833247d..81f5dcc7 100644 --- a/src/sys/volume.c +++ b/src/sys/volume.c @@ -141,7 +141,7 @@ NTSTATUS FspVolumeCreate( &FsvrtDeviceObject); if (!NT_SUCCESS(Result)) { - FspDeviceRelease(FsvolDeviceObject); + FspDeviceDereference(FsvolDeviceObject); return Result; } #pragma prefast(suppress:28175, "We are a filesystem: ok to access SectorSize") @@ -167,8 +167,8 @@ NTSTATUS FspVolumeCreate( if (!NT_SUCCESS(Result)) { if (0 != FsvrtDeviceObject) - FspDeviceRelease(FsvrtDeviceObject); - FspDeviceRelease(FsvolDeviceObject); + FspDeviceDereference(FsvrtDeviceObject); + FspDeviceDereference(FsvolDeviceObject); } /* do we need to register with MUP? */ @@ -189,7 +189,7 @@ NTSTATUS FspVolumeCreate( Result = RegisterMupWorkItem.Result; if (!NT_SUCCESS(Result)) { - FspDeviceRelease(FsvolDeviceObject); + FspDeviceDereference(FsvolDeviceObject); return Result; } } @@ -264,7 +264,7 @@ VOID FspVolumeDelete( * Release the virtual disk object. This is safe to do here because the volume device * keeps an extra reference to the virtual disk object using ObReferenceObject. */ - FspDeviceRelease(FsvrtDeviceObject); + FspDeviceDereference(FsvrtDeviceObject); if (DeleteVpb) { @@ -277,7 +277,7 @@ VOID FspVolumeDelete( /* there is only the reference from FspVolumeMount; release it! */ FspFreeExternal(OldVpb); FsvolDeviceExtension->SwapVpb = 0; - FspDeviceRelease(FsvolDeviceObject); + FspDeviceDereference(FsvolDeviceObject); } else { @@ -299,7 +299,7 @@ VOID FspVolumeDelete( ExReleaseResourceLite(&FsvolDeviceExtension->DeleteResource); /* release the volume device object */ - FspDeviceRelease(FsvolDeviceObject); + FspDeviceDereference(FsvolDeviceObject); } static VOID FspVolumeDeleteDelayed(PVOID Context) @@ -322,7 +322,7 @@ static VOID FspVolumeDeleteDelayed(PVOID Context) { FspFreeExternal(FsvolDeviceExtension->SwapVpb); FsvolDeviceExtension->SwapVpb = 0; - FspDeviceRelease(FsvolDeviceObject); + FspDeviceDereference(FsvolDeviceObject); } else { @@ -354,7 +354,7 @@ NTSTATUS FspVolumeMount( { Result = STATUS_UNRECOGNIZED_VOLUME; for (ULONG i = 0; DeviceObjectCount > i; i++) - if (FspDeviceRetain(DeviceObjects[i])) + if (FspDeviceReference(DeviceObjects[i])) { if (FspFsvolDeviceExtensionKind == FspDeviceExtension(DeviceObjects[i])->Kind) { @@ -366,13 +366,13 @@ NTSTATUS FspVolumeMount( if (!FspIoqStopped(FsvolDeviceExtension->Ioq)) { Result = STATUS_SUCCESS; - /* break out of the loop without FspDeviceRelease or DeleteResource release! */ + /* break out of the loop without FspDeviceDereference or DeleteResource release! */ break; } ExReleaseResourceLite(&FsvolDeviceExtension->DeleteResource); } } - FspDeviceRelease(DeviceObjects[i]); + FspDeviceDereference(DeviceObjects[i]); } FspDeviceDeleteList(DeviceObjects, DeviceObjectCount); } @@ -381,10 +381,10 @@ NTSTATUS FspVolumeMount( /* * At this point the volume device object we are going to use in the VPB - * has been FspDeviceRetain'ed and the volume DeleteResource has been acquired. + * has been FspDeviceReference'ed and the volume DeleteResource has been acquired. * We will increment the VPB's ReferenceCount so that we can do a delayed delete * of the volume device later on. Once done with the VPB we can release the - * DeleteResource. [The volume device remains FspDeviceRetain'ed!] + * DeleteResource. [The volume device remains FspDeviceReference'ed!] */ ASSERT(0 != FsvolDeviceObject && 0 != FsvolDeviceExtension); IoAcquireVpbSpinLock(&Irql);