3 * Copyright (C) 2008, 2014 ReactOS Team
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
19 * COPYRIGHT: See COPYING in the top level directory
20 * PROJECT: ReactOS kernel
21 * FILE: drivers/filesystem/ntfs/misc.c
22 * PURPOSE: NTFS filesystem driver
23 * PROGRAMMER: Pierre Schweitzer
27 /* INCLUDES *****************************************************************/
34 /* FUNCTIONS ****************************************************************/
37 * FUNCTION: Used with IRP to set them to TopLevelIrp field
39 * Irp = The IRP to set
40 * RETURNS: TRUE if top level was null, else FALSE
43 NtfsIsIrpTopLevel(PIRP Irp
)
45 BOOLEAN ReturnCode
= FALSE
;
47 TRACE_(NTFS
, "NtfsIsIrpTopLevel()\n");
49 if (IoGetTopLevelIrp() == NULL
)
51 IoSetTopLevelIrp(Irp
);
59 * FUNCTION: Allocate and fill an NTFS_IRP_CONTEXT struct in order to use it for IRP
61 * DeviceObject = Used to fill in struct
62 * Irp = The IRP that need IRP_CONTEXT struct
63 * RETURNS: NULL or PNTFS_IRP_CONTEXT
66 NtfsAllocateIrpContext(PDEVICE_OBJECT DeviceObject
,
69 PNTFS_IRP_CONTEXT IrpContext
;
71 TRACE_(NTFS
, "NtfsAllocateIrpContext()\n");
73 IrpContext
= (PNTFS_IRP_CONTEXT
)ExAllocateFromNPagedLookasideList(&NtfsGlobalData
->IrpContextLookasideList
);
74 if (IrpContext
== NULL
)
77 RtlZeroMemory(IrpContext
, sizeof(NTFS_IRP_CONTEXT
));
79 IrpContext
->Identifier
.Type
= NTFS_TYPE_IRP_CONTEXT
;
80 IrpContext
->Identifier
.Size
= sizeof(NTFS_IRP_CONTEXT
);
81 IrpContext
->Irp
= Irp
;
82 IrpContext
->DeviceObject
= DeviceObject
;
83 IrpContext
->Stack
= IoGetCurrentIrpStackLocation(Irp
);
84 IrpContext
->MajorFunction
= IrpContext
->Stack
->MajorFunction
;
85 IrpContext
->MinorFunction
= IrpContext
->Stack
->MinorFunction
;
86 IrpContext
->FileObject
= IrpContext
->Stack
->FileObject
;
87 IrpContext
->IsTopLevel
= (IoGetTopLevelIrp() == Irp
);
88 IrpContext
->PriorityBoost
= IO_NO_INCREMENT
;
89 IrpContext
->Flags
= IRPCONTEXT_COMPLETE
;
91 if (IrpContext
->MajorFunction
== IRP_MJ_FILE_SYSTEM_CONTROL
||
92 IrpContext
->MajorFunction
== IRP_MJ_DEVICE_CONTROL
||
93 IrpContext
->MajorFunction
== IRP_MJ_SHUTDOWN
||
94 (IrpContext
->MajorFunction
!= IRP_MJ_CLEANUP
&&
95 IrpContext
->MajorFunction
!= IRP_MJ_CLOSE
&&
96 IoIsOperationSynchronous(Irp
)))
98 IrpContext
->Flags
|= IRPCONTEXT_CANWAIT
;
105 NtfsFileFlagsToAttributes(ULONG NtfsAttributes
,
106 PULONG FileAttributes
)
108 *FileAttributes
= NtfsAttributes
;
109 if ((NtfsAttributes
& NTFS_FILE_TYPE_DIRECTORY
) == NTFS_FILE_TYPE_DIRECTORY
)
111 *FileAttributes
= NtfsAttributes
& ~NTFS_FILE_TYPE_DIRECTORY
;
112 *FileAttributes
|= FILE_ATTRIBUTE_DIRECTORY
;
115 if (NtfsAttributes
== 0)
116 *FileAttributes
= FILE_ATTRIBUTE_NORMAL
;
120 NtfsGetUserBuffer(PIRP Irp
,
123 if (Irp
->MdlAddress
!= NULL
)
125 return MmGetSystemAddressForMdlSafe(Irp
->MdlAddress
, (Paging
? HighPagePriority
: NormalPagePriority
));
129 return Irp
->UserBuffer
;
134 * @name NtfsLockUserBuffer
137 * Ensures the IRP has an MDL Address.
140 * Irp with the UserBuffer that needs locking
143 * Size of the Irp->UserBuffer, in bytes
146 * What kind of access does the driver need to the buffer. Set to
147 * IoReadAccess, IoWriteAccess, or IoModifyAccess.
150 * STATUS_SUCCESS in case of success, STATUS_INSUFFICIENT_RESOURCES
151 * or an exception code otherwise.
153 * @remarks Trevor Thompson shamelessly ripped this from
154 * VfatLockUserBuffer(). Only the name was changed.
158 NtfsLockUserBuffer(IN PIRP Irp
,
160 IN LOCK_OPERATION Operation
)
166 return STATUS_SUCCESS
;
169 IoAllocateMdl(Irp
->UserBuffer
, Length
, FALSE
, FALSE
, Irp
);
171 if (!Irp
->MdlAddress
)
173 return STATUS_INSUFFICIENT_RESOURCES
;
178 MmProbeAndLockPages(Irp
->MdlAddress
, Irp
->RequestorMode
, Operation
);
180 _SEH2_EXCEPT(EXCEPTION_EXECUTE_HANDLER
)
182 IoFreeMdl(Irp
->MdlAddress
);
183 Irp
->MdlAddress
= NULL
;
184 _SEH2_YIELD(return _SEH2_GetExceptionCode());
188 return STATUS_SUCCESS
;