1 | /* $Id: fs-nt.cpp 98103 2023-01-17 14:15:46Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * IPRT - File System, Native NT.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
---|
8 | *
|
---|
9 | * This file is part of VirtualBox base platform packages, as
|
---|
10 | * available from https://www.virtualbox.org.
|
---|
11 | *
|
---|
12 | * This program is free software; you can redistribute it and/or
|
---|
13 | * modify it under the terms of the GNU General Public License
|
---|
14 | * as published by the Free Software Foundation, in version 3 of the
|
---|
15 | * License.
|
---|
16 | *
|
---|
17 | * This program is distributed in the hope that it will be useful, but
|
---|
18 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
---|
19 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
---|
20 | * General Public License for more details.
|
---|
21 | *
|
---|
22 | * You should have received a copy of the GNU General Public License
|
---|
23 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
---|
24 | *
|
---|
25 | * The contents of this file may alternatively be used under the terms
|
---|
26 | * of the Common Development and Distribution License Version 1.0
|
---|
27 | * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
---|
28 | * in the VirtualBox distribution, in which case the provisions of the
|
---|
29 | * CDDL are applicable instead of those of the GPL.
|
---|
30 | *
|
---|
31 | * You may elect to license modified versions of this file under the
|
---|
32 | * terms and conditions of either the GPL or the CDDL or both.
|
---|
33 | *
|
---|
34 | * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
---|
35 | */
|
---|
36 |
|
---|
37 |
|
---|
38 | /*********************************************************************************************************************************
|
---|
39 | * Header Files *
|
---|
40 | *********************************************************************************************************************************/
|
---|
41 | #define LOG_GROUP RTLOGGROUP_FS
|
---|
42 | #include "internal-r3-nt.h"
|
---|
43 |
|
---|
44 | #include <iprt/fs.h>
|
---|
45 | #include <iprt/file.h>
|
---|
46 | #include <iprt/path.h>
|
---|
47 | #include <iprt/string.h>
|
---|
48 | #include <iprt/param.h>
|
---|
49 | #include <iprt/errcore.h>
|
---|
50 | #include <iprt/log.h>
|
---|
51 | #include <iprt/assert.h>
|
---|
52 | #include "internal/fs.h"
|
---|
53 |
|
---|
54 |
|
---|
55 |
|
---|
56 |
|
---|
57 | RTR3DECL(int) RTFsQuerySizes(const char *pszFsPath, RTFOFF *pcbTotal, RTFOFF *pcbFree,
|
---|
58 | uint32_t *pcbBlock, uint32_t *pcbSector)
|
---|
59 | {
|
---|
60 | AssertPtrReturn(pszFsPath, VERR_INVALID_POINTER);
|
---|
61 |
|
---|
62 | /*
|
---|
63 | * Open the file/dir/whatever.
|
---|
64 | */
|
---|
65 | HANDLE hFile;
|
---|
66 | int rc = RTNtPathOpen(pszFsPath,
|
---|
67 | GENERIC_READ,
|
---|
68 | FILE_ATTRIBUTE_NORMAL,
|
---|
69 | FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
|
---|
70 | FILE_OPEN,
|
---|
71 | FILE_OPEN_FOR_BACKUP_INTENT,
|
---|
72 | OBJ_CASE_INSENSITIVE,
|
---|
73 | &hFile,
|
---|
74 | NULL);
|
---|
75 | if (RT_SUCCESS(rc))
|
---|
76 | {
|
---|
77 | RTFILE hIprtFile = NIL_RTFILE;
|
---|
78 | rc = RTFileFromNative(&hIprtFile, (RTHCINTPTR)hFile);
|
---|
79 | AssertRC(rc);
|
---|
80 | if (RT_SUCCESS(rc))
|
---|
81 | rc = RTFileQueryFsSizes(hIprtFile, pcbTotal, pcbFree, pcbBlock, pcbSector);
|
---|
82 |
|
---|
83 | RTNtPathClose(hFile);
|
---|
84 | }
|
---|
85 | return rc;
|
---|
86 | }
|
---|
87 |
|
---|
88 |
|
---|
89 | RTR3DECL(int) RTFsQuerySerial(const char *pszFsPath, uint32_t *pu32Serial)
|
---|
90 | {
|
---|
91 | /*
|
---|
92 | * Validate & get valid root path.
|
---|
93 | */
|
---|
94 | AssertPtrReturn(pszFsPath, VERR_INVALID_POINTER);
|
---|
95 | AssertPtrReturn(pu32Serial, VERR_INVALID_POINTER);
|
---|
96 |
|
---|
97 | /*
|
---|
98 | * Open the file/dir/whatever.
|
---|
99 | */
|
---|
100 | HANDLE hFile;
|
---|
101 | int rc = RTNtPathOpen(pszFsPath,
|
---|
102 | GENERIC_READ,
|
---|
103 | FILE_ATTRIBUTE_NORMAL,
|
---|
104 | FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
|
---|
105 | FILE_OPEN,
|
---|
106 | FILE_OPEN_FOR_BACKUP_INTENT,
|
---|
107 | OBJ_CASE_INSENSITIVE,
|
---|
108 | &hFile,
|
---|
109 | NULL);
|
---|
110 | if (RT_SUCCESS(rc))
|
---|
111 | {
|
---|
112 | /*
|
---|
113 | * Get the volume information.
|
---|
114 | */
|
---|
115 | union
|
---|
116 | {
|
---|
117 | FILE_FS_VOLUME_INFORMATION FsVolInfo;
|
---|
118 | uint8_t abBuf[sizeof(FILE_FS_VOLUME_INFORMATION) + 4096];
|
---|
119 | } u;
|
---|
120 | IO_STATUS_BLOCK Ios = RTNT_IO_STATUS_BLOCK_INITIALIZER;
|
---|
121 | NTSTATUS rcNt = NtQueryVolumeInformationFile(hFile, &Ios, &u, sizeof(u), FileFsVolumeInformation);
|
---|
122 | if (NT_SUCCESS(rcNt))
|
---|
123 | *pu32Serial = u.FsVolInfo.VolumeSerialNumber;
|
---|
124 | else
|
---|
125 | rc = RTErrConvertFromNtStatus(rcNt);
|
---|
126 |
|
---|
127 | RTNtPathClose(hFile);
|
---|
128 | }
|
---|
129 | return rc;
|
---|
130 | }
|
---|
131 |
|
---|
132 |
|
---|
133 | RTR3DECL(int) RTFsQueryProperties(const char *pszFsPath, PRTFSPROPERTIES pProperties)
|
---|
134 | {
|
---|
135 | /*
|
---|
136 | * Validate & get valid root path.
|
---|
137 | */
|
---|
138 | AssertPtrReturn(pszFsPath, VERR_INVALID_POINTER);
|
---|
139 | AssertPtrReturn(pProperties, VERR_INVALID_POINTER);
|
---|
140 |
|
---|
141 | /*
|
---|
142 | * Open the file/dir/whatever.
|
---|
143 | */
|
---|
144 | HANDLE hFile;
|
---|
145 | int rc = RTNtPathOpen(pszFsPath,
|
---|
146 | GENERIC_READ,
|
---|
147 | FILE_ATTRIBUTE_NORMAL,
|
---|
148 | FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
|
---|
149 | FILE_OPEN,
|
---|
150 | FILE_OPEN_FOR_BACKUP_INTENT,
|
---|
151 | OBJ_CASE_INSENSITIVE,
|
---|
152 | &hFile,
|
---|
153 | NULL);
|
---|
154 | if (RT_SUCCESS(rc))
|
---|
155 | {
|
---|
156 | /*
|
---|
157 | * Get the volume information.
|
---|
158 | */
|
---|
159 | union
|
---|
160 | {
|
---|
161 | FILE_FS_ATTRIBUTE_INFORMATION FsAttrInfo;
|
---|
162 | uint8_t abBuf[sizeof(FILE_FS_ATTRIBUTE_INFORMATION) + 4096];
|
---|
163 | } u;
|
---|
164 | IO_STATUS_BLOCK Ios = RTNT_IO_STATUS_BLOCK_INITIALIZER;
|
---|
165 | NTSTATUS rcNt = NtQueryVolumeInformationFile(hFile, &Ios, &u, sizeof(u), FileFsAttributeInformation);
|
---|
166 | if (NT_SUCCESS(rcNt))
|
---|
167 | {
|
---|
168 | FILE_FS_DEVICE_INFORMATION FsDevInfo;
|
---|
169 | rcNt = NtQueryVolumeInformationFile(hFile, &Ios, &FsDevInfo, sizeof(FsDevInfo), FileFsDeviceInformation);
|
---|
170 | if (NT_SUCCESS(rcNt))
|
---|
171 | {
|
---|
172 | /*
|
---|
173 | * Fill in the return structure.
|
---|
174 | */
|
---|
175 | memset(pProperties, 0, sizeof(*pProperties));
|
---|
176 | pProperties->cbMaxComponent = u.FsAttrInfo.MaximumComponentNameLength;
|
---|
177 | pProperties->fFileCompression = !!(u.FsAttrInfo.FileSystemAttributes & FILE_FILE_COMPRESSION);
|
---|
178 | pProperties->fCompressed = !!(u.FsAttrInfo.FileSystemAttributes & FILE_VOLUME_IS_COMPRESSED);
|
---|
179 | pProperties->fReadOnly = !!(u.FsAttrInfo.FileSystemAttributes & FILE_READ_ONLY_VOLUME);
|
---|
180 | pProperties->fSupportsUnicode = !!(u.FsAttrInfo.FileSystemAttributes & FILE_UNICODE_ON_DISK);
|
---|
181 | pProperties->fCaseSensitive = false; /* win32 is case preserving only */
|
---|
182 | /** @todo r=bird: What about FILE_CASE_SENSITIVE_SEARCH ? Is this set for NTFS
|
---|
183 | * as well perchance? If so, better mention it instead of just setting
|
---|
184 | * fCaseSensitive to false. */
|
---|
185 |
|
---|
186 | /* figure the remote stuff */
|
---|
187 | pProperties->fRemote = RT_BOOL(FsDevInfo.Characteristics & FILE_REMOTE_DEVICE);
|
---|
188 | }
|
---|
189 | else
|
---|
190 | rc = RTErrConvertFromNtStatus(rcNt);
|
---|
191 | }
|
---|
192 | else
|
---|
193 | rc = RTErrConvertFromNtStatus(rcNt);
|
---|
194 |
|
---|
195 | RTNtPathClose(hFile);
|
---|
196 | }
|
---|
197 | return rc;
|
---|
198 | }
|
---|
199 |
|
---|
200 |
|
---|
201 | RTR3DECL(bool) RTFsIsCaseSensitive(const char *pszFsPath)
|
---|
202 | {
|
---|
203 | RT_NOREF_PV(pszFsPath);
|
---|
204 | return false;
|
---|
205 | }
|
---|
206 |
|
---|
207 |
|
---|
208 | int rtNtQueryFsType(HANDLE hHandle, PRTFSTYPE penmType)
|
---|
209 | {
|
---|
210 | /*
|
---|
211 | * Get the file system name.
|
---|
212 | */
|
---|
213 | union
|
---|
214 | {
|
---|
215 | FILE_FS_ATTRIBUTE_INFORMATION FsAttrInfo;
|
---|
216 | uint8_t abBuf[sizeof(FILE_FS_ATTRIBUTE_INFORMATION) + 4096];
|
---|
217 | } u;
|
---|
218 | IO_STATUS_BLOCK Ios = RTNT_IO_STATUS_BLOCK_INITIALIZER;
|
---|
219 | NTSTATUS rcNt = NtQueryVolumeInformationFile(hHandle, &Ios, &u, sizeof(u), FileFsAttributeInformation);
|
---|
220 | if (NT_SUCCESS(rcNt))
|
---|
221 | {
|
---|
222 | #define IS_FS(a_szName) rtNtCompWideStrAndAscii(u.FsAttrInfo.FileSystemName, u.FsAttrInfo.FileSystemNameLength, RT_STR_TUPLE(a_szName))
|
---|
223 | if (IS_FS("NTFS"))
|
---|
224 | *penmType = RTFSTYPE_NTFS;
|
---|
225 | else if (IS_FS("FAT"))
|
---|
226 | *penmType = RTFSTYPE_FAT;
|
---|
227 | else if (IS_FS("FAT32"))
|
---|
228 | *penmType = RTFSTYPE_FAT;
|
---|
229 | else if (IS_FS("exFAT"))
|
---|
230 | *penmType = RTFSTYPE_EXFAT;
|
---|
231 | else if (IS_FS("UDF"))
|
---|
232 | *penmType = RTFSTYPE_UDF;
|
---|
233 | else if (IS_FS("CDFS"))
|
---|
234 | *penmType = RTFSTYPE_ISO9660;
|
---|
235 | else if (IS_FS("HPFS"))
|
---|
236 | *penmType = RTFSTYPE_HPFS;
|
---|
237 | else if (IS_FS("ReFS")) /** @todo verify ReFS signature. */
|
---|
238 | *penmType = RTFSTYPE_REFS;
|
---|
239 | else if (IS_FS("VBoxSharedFolderFS"))
|
---|
240 | *penmType = RTFSTYPE_VBOXSHF;
|
---|
241 | #undef IS_FS
|
---|
242 | return VINF_SUCCESS;
|
---|
243 | }
|
---|
244 |
|
---|
245 | *penmType = RTFSTYPE_UNKNOWN;
|
---|
246 | return RTErrConvertFromNtStatus(rcNt);
|
---|
247 | }
|
---|
248 |
|
---|
249 |
|
---|
250 | RTR3DECL(int) RTFsQueryType(const char *pszFsPath, PRTFSTYPE penmType)
|
---|
251 | {
|
---|
252 | /*
|
---|
253 | * Validate input.
|
---|
254 | */
|
---|
255 | *penmType = RTFSTYPE_UNKNOWN;
|
---|
256 | AssertPtrReturn(pszFsPath, VERR_INVALID_POINTER);
|
---|
257 | AssertReturn(*pszFsPath, VERR_INVALID_PARAMETER);
|
---|
258 |
|
---|
259 | /*
|
---|
260 | * Open the file/dir/whatever.
|
---|
261 | */
|
---|
262 | HANDLE hFile;
|
---|
263 | int rc = RTNtPathOpen(pszFsPath,
|
---|
264 | GENERIC_READ,
|
---|
265 | FILE_ATTRIBUTE_NORMAL,
|
---|
266 | FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
|
---|
267 | FILE_OPEN,
|
---|
268 | FILE_OPEN_FOR_BACKUP_INTENT,
|
---|
269 | OBJ_CASE_INSENSITIVE,
|
---|
270 | &hFile,
|
---|
271 | NULL);
|
---|
272 | if (RT_SUCCESS(rc))
|
---|
273 | {
|
---|
274 | rc = rtNtQueryFsType(hFile, penmType);
|
---|
275 | RTNtPathClose(hFile);
|
---|
276 | }
|
---|
277 | return rc;
|
---|
278 | }
|
---|
279 |
|
---|