VirtualBox

source: vbox/trunk/src/VBox/Runtime/r3/win/fileio-win.cpp@ 76902

Last change on this file since 76902 was 76902, checked in by vboxsync, 6 years ago

IPRT/RTFileRead: Set pcbRead when returning immediately on a zero byte read. bugref:9172

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 38.2 KB
Line 
1/* $Id: fileio-win.cpp 76902 2019-01-19 14:25:38Z vboxsync $ */
2/** @file
3 * IPRT - File I/O, native implementation for the Windows host platform.
4 */
5
6/*
7 * Copyright (C) 2006-2019 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.215389.xyz. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27
28/*********************************************************************************************************************************
29* Header Files *
30*********************************************************************************************************************************/
31#define LOG_GROUP RTLOGGROUP_DIR
32#ifndef _WIN32_WINNT
33# define _WIN32_WINNT 0x0500
34#endif
35#include <iprt/nt/nt-and-windows.h>
36
37#include <iprt/file.h>
38
39#include <iprt/asm.h>
40#include <iprt/assert.h>
41#include <iprt/path.h>
42#include <iprt/string.h>
43#include <iprt/err.h>
44#include <iprt/ldr.h>
45#include <iprt/log.h>
46#include "internal/file.h"
47#include "internal/fs.h"
48#include "internal/path.h"
49#include "internal-r3-win.h" /* For g_enmWinVer + kRTWinOSType_XXX */
50
51
52/*********************************************************************************************************************************
53* Defined Constants And Macros *
54*********************************************************************************************************************************/
55typedef BOOL WINAPI FNVERIFYCONSOLEIOHANDLE(HANDLE);
56typedef FNVERIFYCONSOLEIOHANDLE *PFNVERIFYCONSOLEIOHANDLE; /* No, nobody fell on the keyboard, really! */
57
58/**
59 * This is wrapper around the ugly SetFilePointer api.
60 *
61 * It's equivalent to SetFilePointerEx which we so unfortunately cannot use because of
62 * it not being present in NT4 GA.
63 *
64 * @returns Success indicator. Extended error information obtainable using GetLastError().
65 * @param hFile Filehandle.
66 * @param offSeek Offset to seek.
67 * @param poffNew Where to store the new file offset. NULL allowed.
68 * @param uMethod Seek method. (The windows one!)
69 */
70DECLINLINE(bool) MySetFilePointer(RTFILE hFile, uint64_t offSeek, uint64_t *poffNew, unsigned uMethod)
71{
72 bool fRc;
73 LARGE_INTEGER off;
74
75 off.QuadPart = offSeek;
76#if 1
77 if (off.LowPart != INVALID_SET_FILE_POINTER)
78 {
79 off.LowPart = SetFilePointer((HANDLE)RTFileToNative(hFile), off.LowPart, &off.HighPart, uMethod);
80 fRc = off.LowPart != INVALID_SET_FILE_POINTER;
81 }
82 else
83 {
84 SetLastError(NO_ERROR);
85 off.LowPart = SetFilePointer((HANDLE)RTFileToNative(hFile), off.LowPart, &off.HighPart, uMethod);
86 fRc = GetLastError() == NO_ERROR;
87 }
88#else
89 fRc = SetFilePointerEx((HANDLE)RTFileToNative(hFile), off, &off, uMethod);
90#endif
91 if (fRc && poffNew)
92 *poffNew = off.QuadPart;
93 return fRc;
94}
95
96
97/**
98 * This is a helper to check if an attempt was made to grow a file beyond the
99 * limit of the filesystem.
100 *
101 * @returns true for file size limit exceeded.
102 * @param hFile Filehandle.
103 * @param offSeek Offset to seek.
104 * @param uMethod The seek method.
105 */
106DECLINLINE(bool) IsBeyondLimit(RTFILE hFile, uint64_t offSeek, unsigned uMethod)
107{
108 bool fIsBeyondLimit = false;
109
110 /*
111 * Get the current file position and try set the new one.
112 * If it fails with a seek error it's because we hit the file system limit.
113 */
114/** @todo r=bird: I'd be very interested to know on which versions of windows and on which file systems
115 * this supposedly works. The fastfat sources in the latest WDK makes no limit checks during
116 * file seeking, only at the time of writing (and some other odd ones we cannot make use of). */
117 uint64_t offCurrent;
118 if (MySetFilePointer(hFile, 0, &offCurrent, FILE_CURRENT))
119 {
120 if (!MySetFilePointer(hFile, offSeek, NULL, uMethod))
121 fIsBeyondLimit = GetLastError() == ERROR_SEEK;
122 else /* Restore file pointer on success. */
123 MySetFilePointer(hFile, offCurrent, NULL, FILE_BEGIN);
124 }
125
126 return fIsBeyondLimit;
127}
128
129
130RTR3DECL(int) RTFileFromNative(PRTFILE pFile, RTHCINTPTR uNative)
131{
132 HANDLE h = (HANDLE)uNative;
133 AssertCompile(sizeof(h) == sizeof(uNative));
134 if (h == INVALID_HANDLE_VALUE)
135 {
136 AssertMsgFailed(("%p\n", uNative));
137 *pFile = NIL_RTFILE;
138 return VERR_INVALID_HANDLE;
139 }
140 *pFile = (RTFILE)h;
141 return VINF_SUCCESS;
142}
143
144
145RTR3DECL(RTHCINTPTR) RTFileToNative(RTFILE hFile)
146{
147 AssertReturn(hFile != NIL_RTFILE, (RTHCINTPTR)INVALID_HANDLE_VALUE);
148 return (RTHCINTPTR)hFile;
149}
150
151
152RTR3DECL(int) RTFileOpen(PRTFILE pFile, const char *pszFilename, uint64_t fOpen)
153{
154 /*
155 * Validate input.
156 */
157 if (!pFile)
158 {
159 AssertMsgFailed(("Invalid pFile\n"));
160 return VERR_INVALID_PARAMETER;
161 }
162 *pFile = NIL_RTFILE;
163 if (!pszFilename)
164 {
165 AssertMsgFailed(("Invalid pszFilename\n"));
166 return VERR_INVALID_PARAMETER;
167 }
168
169 /*
170 * Merge forced open flags and validate them.
171 */
172 int rc = rtFileRecalcAndValidateFlags(&fOpen);
173 if (RT_FAILURE(rc))
174 return rc;
175
176 /*
177 * Determine disposition, access, share mode, creation flags, and security attributes
178 * for the CreateFile API call.
179 */
180 DWORD dwCreationDisposition;
181 switch (fOpen & RTFILE_O_ACTION_MASK)
182 {
183 case RTFILE_O_OPEN:
184 dwCreationDisposition = fOpen & RTFILE_O_TRUNCATE ? TRUNCATE_EXISTING : OPEN_EXISTING;
185 break;
186 case RTFILE_O_OPEN_CREATE:
187 dwCreationDisposition = OPEN_ALWAYS;
188 break;
189 case RTFILE_O_CREATE:
190 dwCreationDisposition = CREATE_NEW;
191 break;
192 case RTFILE_O_CREATE_REPLACE:
193 dwCreationDisposition = CREATE_ALWAYS;
194 break;
195 default:
196 AssertMsgFailed(("Impossible fOpen=%#llx\n", fOpen));
197 return VERR_INVALID_PARAMETER;
198 }
199
200 DWORD dwDesiredAccess;
201 switch (fOpen & RTFILE_O_ACCESS_MASK)
202 {
203 case RTFILE_O_READ:
204 dwDesiredAccess = FILE_GENERIC_READ; /* RTFILE_O_APPEND is ignored. */
205 break;
206 case RTFILE_O_WRITE:
207 dwDesiredAccess = fOpen & RTFILE_O_APPEND
208 ? FILE_GENERIC_WRITE & ~FILE_WRITE_DATA
209 : FILE_GENERIC_WRITE;
210 break;
211 case RTFILE_O_READWRITE:
212 dwDesiredAccess = fOpen & RTFILE_O_APPEND
213 ? FILE_GENERIC_READ | (FILE_GENERIC_WRITE & ~FILE_WRITE_DATA)
214 : FILE_GENERIC_READ | FILE_GENERIC_WRITE;
215 break;
216 case RTFILE_O_ATTR_ONLY:
217 if (fOpen & RTFILE_O_ACCESS_ATTR_MASK)
218 {
219 dwDesiredAccess = 0;
220 break;
221 }
222 RT_FALL_THRU();
223 default:
224 AssertMsgFailed(("Impossible fOpen=%#llx\n", fOpen));
225 return VERR_INVALID_PARAMETER;
226 }
227 if (dwCreationDisposition == TRUNCATE_EXISTING)
228 /* Required for truncating the file (see MSDN), it is *NOT* part of FILE_GENERIC_WRITE. */
229 dwDesiredAccess |= GENERIC_WRITE;
230
231 /* RTFileSetMode needs following rights as well. */
232 switch (fOpen & RTFILE_O_ACCESS_ATTR_MASK)
233 {
234 case RTFILE_O_ACCESS_ATTR_READ: dwDesiredAccess |= FILE_READ_ATTRIBUTES | SYNCHRONIZE; break;
235 case RTFILE_O_ACCESS_ATTR_WRITE: dwDesiredAccess |= FILE_WRITE_ATTRIBUTES | SYNCHRONIZE; break;
236 case RTFILE_O_ACCESS_ATTR_READWRITE: dwDesiredAccess |= FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | SYNCHRONIZE; break;
237 default:
238 /* Attributes access is the same as the file access. */
239 switch (fOpen & RTFILE_O_ACCESS_MASK)
240 {
241 case RTFILE_O_READ: dwDesiredAccess |= FILE_READ_ATTRIBUTES | SYNCHRONIZE; break;
242 case RTFILE_O_WRITE: dwDesiredAccess |= FILE_WRITE_ATTRIBUTES | SYNCHRONIZE; break;
243 case RTFILE_O_READWRITE: dwDesiredAccess |= FILE_READ_ATTRIBUTES | FILE_WRITE_ATTRIBUTES | SYNCHRONIZE; break;
244 default:
245 AssertMsgFailed(("Impossible fOpen=%#llx\n", fOpen));
246 return VERR_INVALID_PARAMETER;
247 }
248 }
249
250 DWORD dwShareMode;
251 switch (fOpen & RTFILE_O_DENY_MASK)
252 {
253 case RTFILE_O_DENY_NONE: dwShareMode = FILE_SHARE_READ | FILE_SHARE_WRITE; break;
254 case RTFILE_O_DENY_READ: dwShareMode = FILE_SHARE_WRITE; break;
255 case RTFILE_O_DENY_WRITE: dwShareMode = FILE_SHARE_READ; break;
256 case RTFILE_O_DENY_READWRITE: dwShareMode = 0; break;
257
258 case RTFILE_O_DENY_NOT_DELETE: dwShareMode = FILE_SHARE_DELETE | FILE_SHARE_READ | FILE_SHARE_WRITE; break;
259 case RTFILE_O_DENY_NOT_DELETE | RTFILE_O_DENY_READ: dwShareMode = FILE_SHARE_DELETE | FILE_SHARE_WRITE; break;
260 case RTFILE_O_DENY_NOT_DELETE | RTFILE_O_DENY_WRITE: dwShareMode = FILE_SHARE_DELETE | FILE_SHARE_READ; break;
261 case RTFILE_O_DENY_NOT_DELETE | RTFILE_O_DENY_READWRITE:dwShareMode = FILE_SHARE_DELETE; break;
262 default:
263 AssertMsgFailed(("Impossible fOpen=%#llx\n", fOpen));
264 return VERR_INVALID_PARAMETER;
265 }
266
267 SECURITY_ATTRIBUTES SecurityAttributes;
268 PSECURITY_ATTRIBUTES pSecurityAttributes = NULL;
269 if (fOpen & RTFILE_O_INHERIT)
270 {
271 SecurityAttributes.nLength = sizeof(SecurityAttributes);
272 SecurityAttributes.lpSecurityDescriptor = NULL;
273 SecurityAttributes.bInheritHandle = TRUE;
274 pSecurityAttributes = &SecurityAttributes;
275 }
276
277 DWORD dwFlagsAndAttributes;
278 dwFlagsAndAttributes = FILE_ATTRIBUTE_NORMAL;
279 if (fOpen & RTFILE_O_WRITE_THROUGH)
280 dwFlagsAndAttributes |= FILE_FLAG_WRITE_THROUGH;
281 if (fOpen & RTFILE_O_ASYNC_IO)
282 dwFlagsAndAttributes |= FILE_FLAG_OVERLAPPED;
283 if (fOpen & RTFILE_O_NO_CACHE)
284 {
285 dwFlagsAndAttributes |= FILE_FLAG_NO_BUFFERING;
286 dwDesiredAccess &= ~FILE_APPEND_DATA;
287 }
288
289 /*
290 * Open/Create the file.
291 */
292 PRTUTF16 pwszFilename;
293 rc = RTPathWinFromUtf8(&pwszFilename, pszFilename, 0 /*fFlags*/);
294 if (RT_SUCCESS(rc))
295 {
296 HANDLE hFile = CreateFileW(pwszFilename,
297 dwDesiredAccess,
298 dwShareMode,
299 pSecurityAttributes,
300 dwCreationDisposition,
301 dwFlagsAndAttributes,
302 NULL);
303 if (hFile != INVALID_HANDLE_VALUE)
304 {
305 bool fCreated = dwCreationDisposition == CREATE_ALWAYS
306 || dwCreationDisposition == CREATE_NEW
307 || (dwCreationDisposition == OPEN_ALWAYS && GetLastError() == 0);
308
309 /*
310 * Turn off indexing of directory through Windows Indexing Service.
311 */
312 if ( fCreated
313 && (fOpen & RTFILE_O_NOT_CONTENT_INDEXED))
314 {
315 if (!SetFileAttributesW(pwszFilename, FILE_ATTRIBUTE_NOT_CONTENT_INDEXED))
316 rc = RTErrConvertFromWin32(GetLastError());
317 }
318 /*
319 * Do we need to truncate the file?
320 */
321 else if ( !fCreated
322 && (fOpen & (RTFILE_O_TRUNCATE | RTFILE_O_ACTION_MASK))
323 == (RTFILE_O_TRUNCATE | RTFILE_O_OPEN_CREATE))
324 {
325 if (!SetEndOfFile(hFile))
326 rc = RTErrConvertFromWin32(GetLastError());
327 }
328 if (RT_SUCCESS(rc))
329 {
330 *pFile = (RTFILE)hFile;
331 Assert((HANDLE)*pFile == hFile);
332 RTPathWinFree(pwszFilename);
333 return VINF_SUCCESS;
334 }
335
336 CloseHandle(hFile);
337 }
338 else
339 rc = RTErrConvertFromWin32(GetLastError());
340 RTPathWinFree(pwszFilename);
341 }
342 return rc;
343}
344
345
346RTR3DECL(int) RTFileOpenBitBucket(PRTFILE phFile, uint64_t fAccess)
347{
348 AssertReturn( fAccess == RTFILE_O_READ
349 || fAccess == RTFILE_O_WRITE
350 || fAccess == RTFILE_O_READWRITE,
351 VERR_INVALID_PARAMETER);
352 return RTFileOpen(phFile, "NUL", fAccess | RTFILE_O_DENY_NONE | RTFILE_O_OPEN);
353}
354
355
356RTR3DECL(int) RTFileClose(RTFILE hFile)
357{
358 if (hFile == NIL_RTFILE)
359 return VINF_SUCCESS;
360 if (CloseHandle((HANDLE)RTFileToNative(hFile)))
361 return VINF_SUCCESS;
362 return RTErrConvertFromWin32(GetLastError());
363}
364
365
366RTFILE rtFileGetStandard(RTHANDLESTD enmStdHandle)
367{
368 DWORD dwStdHandle;
369 switch (enmStdHandle)
370 {
371 case RTHANDLESTD_INPUT: dwStdHandle = STD_INPUT_HANDLE; break;
372 case RTHANDLESTD_OUTPUT: dwStdHandle = STD_OUTPUT_HANDLE; break;
373 case RTHANDLESTD_ERROR: dwStdHandle = STD_ERROR_HANDLE; break;
374 default:
375 AssertFailedReturn(NIL_RTFILE);
376 }
377
378 HANDLE hNative = GetStdHandle(dwStdHandle);
379 if (hNative == INVALID_HANDLE_VALUE)
380 return NIL_RTFILE;
381
382 RTFILE hFile = (RTFILE)(uintptr_t)hNative;
383 AssertReturn((HANDLE)(uintptr_t)hFile == hNative, NIL_RTFILE);
384 return hFile;
385}
386
387
388RTR3DECL(int) RTFileSeek(RTFILE hFile, int64_t offSeek, unsigned uMethod, uint64_t *poffActual)
389{
390 static ULONG aulSeekRecode[] =
391 {
392 FILE_BEGIN,
393 FILE_CURRENT,
394 FILE_END,
395 };
396
397 /*
398 * Validate input.
399 */
400 if (uMethod > RTFILE_SEEK_END)
401 {
402 AssertMsgFailed(("Invalid uMethod=%d\n", uMethod));
403 return VERR_INVALID_PARAMETER;
404 }
405
406 /*
407 * Execute the seek.
408 */
409 if (MySetFilePointer(hFile, offSeek, poffActual, aulSeekRecode[uMethod]))
410 return VINF_SUCCESS;
411 return RTErrConvertFromWin32(GetLastError());
412}
413
414
415RTR3DECL(int) RTFileRead(RTFILE hFile, void *pvBuf, size_t cbToRead, size_t *pcbRead)
416{
417 if (cbToRead <= 0)
418 {
419 if (pcbRead)
420 *pcbRead = 0;
421 return VINF_SUCCESS;
422 }
423 ULONG cbToReadAdj = (ULONG)cbToRead;
424 AssertReturn(cbToReadAdj == cbToRead, VERR_NUMBER_TOO_BIG);
425
426 ULONG cbRead = 0;
427 if (ReadFile((HANDLE)RTFileToNative(hFile), pvBuf, cbToReadAdj, &cbRead, NULL))
428 {
429 if (pcbRead)
430 /* Caller can handle partial reads. */
431 *pcbRead = cbRead;
432 else
433 {
434 /* Caller expects everything to be read. */
435 while (cbToReadAdj > cbRead)
436 {
437 ULONG cbReadPart = 0;
438 if (!ReadFile((HANDLE)RTFileToNative(hFile), (char*)pvBuf + cbRead, cbToReadAdj - cbRead, &cbReadPart, NULL))
439 return RTErrConvertFromWin32(GetLastError());
440 if (cbReadPart == 0)
441 return VERR_EOF;
442 cbRead += cbReadPart;
443 }
444 }
445 return VINF_SUCCESS;
446 }
447
448 /*
449 * If it's a console, we might bump into out of memory conditions in the
450 * ReadConsole call.
451 */
452 DWORD dwErr = GetLastError();
453 if (dwErr == ERROR_NOT_ENOUGH_MEMORY)
454 {
455 ULONG cbChunk = cbToReadAdj / 2;
456 if (cbChunk > 16*_1K)
457 cbChunk = 16*_1K;
458 else
459 cbChunk = RT_ALIGN_32(cbChunk, 256);
460
461 cbRead = 0;
462 while (cbToReadAdj > cbRead)
463 {
464 ULONG cbToRead = RT_MIN(cbChunk, cbToReadAdj - cbRead);
465 ULONG cbReadPart = 0;
466 if (!ReadFile((HANDLE)RTFileToNative(hFile), (char *)pvBuf + cbRead, cbToRead, &cbReadPart, NULL))
467 {
468 /* If we failed because the buffer is too big, shrink it and
469 try again. */
470 dwErr = GetLastError();
471 if ( dwErr == ERROR_NOT_ENOUGH_MEMORY
472 && cbChunk > 8)
473 {
474 cbChunk /= 2;
475 continue;
476 }
477 return RTErrConvertFromWin32(dwErr);
478 }
479 cbRead += cbReadPart;
480
481 /* Return if the caller can handle partial reads, otherwise try
482 fill the buffer all the way up. */
483 if (pcbRead)
484 {
485 *pcbRead = cbRead;
486 break;
487 }
488 if (cbReadPart == 0)
489 return VERR_EOF;
490 }
491 return VINF_SUCCESS;
492 }
493
494 return RTErrConvertFromWin32(dwErr);
495}
496
497
498RTR3DECL(int) RTFileWrite(RTFILE hFile, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten)
499{
500 if (cbToWrite <= 0)
501 return VINF_SUCCESS;
502 ULONG const cbToWriteAdj = (ULONG)cbToWrite;
503 AssertReturn(cbToWriteAdj == cbToWrite, VERR_NUMBER_TOO_BIG);
504
505 ULONG cbWritten = 0;
506 if (WriteFile((HANDLE)RTFileToNative(hFile), pvBuf, cbToWriteAdj, &cbWritten, NULL))
507 {
508 if (pcbWritten)
509 /* Caller can handle partial writes. */
510 *pcbWritten = RT_MIN(cbWritten, cbToWriteAdj); /* paranoia^3 */
511 else
512 {
513 /* Caller expects everything to be written. */
514 while (cbWritten < cbToWriteAdj)
515 {
516 ULONG cbWrittenPart = 0;
517 if (!WriteFile((HANDLE)RTFileToNative(hFile), (char*)pvBuf + cbWritten,
518 cbToWriteAdj - cbWritten, &cbWrittenPart, NULL))
519 {
520 int rc = RTErrConvertFromWin32(GetLastError());
521 if ( rc == VERR_DISK_FULL
522 && IsBeyondLimit(hFile, cbToWriteAdj - cbWritten, FILE_CURRENT)
523 )
524 rc = VERR_FILE_TOO_BIG;
525 return rc;
526 }
527 if (cbWrittenPart == 0)
528 return VERR_WRITE_ERROR;
529 cbWritten += cbWrittenPart;
530 }
531 }
532 return VINF_SUCCESS;
533 }
534
535 /*
536 * If it's a console, we might bump into out of memory conditions in the
537 * WriteConsole call.
538 */
539 DWORD dwErr = GetLastError();
540 if (dwErr == ERROR_NOT_ENOUGH_MEMORY)
541 {
542 ULONG cbChunk = cbToWriteAdj / 2;
543 if (cbChunk > _32K)
544 cbChunk = _32K;
545 else
546 cbChunk = RT_ALIGN_32(cbChunk, 256);
547
548 cbWritten = 0;
549 while (cbWritten < cbToWriteAdj)
550 {
551 ULONG cbToWrite = RT_MIN(cbChunk, cbToWriteAdj - cbWritten);
552 ULONG cbWrittenPart = 0;
553 if (!WriteFile((HANDLE)RTFileToNative(hFile), (const char *)pvBuf + cbWritten, cbToWrite, &cbWrittenPart, NULL))
554 {
555 /* If we failed because the buffer is too big, shrink it and
556 try again. */
557 dwErr = GetLastError();
558 if ( dwErr == ERROR_NOT_ENOUGH_MEMORY
559 && cbChunk > 8)
560 {
561 cbChunk /= 2;
562 continue;
563 }
564 int rc = RTErrConvertFromWin32(dwErr);
565 if ( rc == VERR_DISK_FULL
566 && IsBeyondLimit(hFile, cbToWriteAdj - cbWritten, FILE_CURRENT))
567 rc = VERR_FILE_TOO_BIG;
568 return rc;
569 }
570 cbWritten += cbWrittenPart;
571
572 /* Return if the caller can handle partial writes, otherwise try
573 write out everything. */
574 if (pcbWritten)
575 {
576 *pcbWritten = RT_MIN(cbWritten, cbToWriteAdj); /* paranoia^3 */
577 break;
578 }
579 if (cbWrittenPart == 0)
580 return VERR_WRITE_ERROR;
581 }
582 return VINF_SUCCESS;
583 }
584
585 int rc = RTErrConvertFromWin32(dwErr);
586 if ( rc == VERR_DISK_FULL
587 && IsBeyondLimit(hFile, cbToWriteAdj - cbWritten, FILE_CURRENT))
588 rc = VERR_FILE_TOO_BIG;
589 return rc;
590}
591
592
593RTR3DECL(int) RTFileFlush(RTFILE hFile)
594{
595 if (!FlushFileBuffers((HANDLE)RTFileToNative(hFile)))
596 {
597 int rc = GetLastError();
598 Log(("FlushFileBuffers failed with %d\n", rc));
599 return RTErrConvertFromWin32(rc);
600 }
601 return VINF_SUCCESS;
602}
603
604
605RTR3DECL(int) RTFileSetSize(RTFILE hFile, uint64_t cbSize)
606{
607 /*
608 * Get current file pointer.
609 */
610 int rc;
611 uint64_t offCurrent;
612 if (MySetFilePointer(hFile, 0, &offCurrent, FILE_CURRENT))
613 {
614 /*
615 * Set new file pointer.
616 */
617 if (MySetFilePointer(hFile, cbSize, NULL, FILE_BEGIN))
618 {
619 /* set file pointer */
620 if (SetEndOfFile((HANDLE)RTFileToNative(hFile)))
621 {
622 /*
623 * Restore file pointer and return.
624 * If the old pointer was beyond the new file end, ignore failure.
625 */
626 if ( MySetFilePointer(hFile, offCurrent, NULL, FILE_BEGIN)
627 || offCurrent > cbSize)
628 return VINF_SUCCESS;
629 }
630
631 /*
632 * Failed, try restoring the file pointer.
633 */
634 rc = GetLastError();
635 MySetFilePointer(hFile, offCurrent, NULL, FILE_BEGIN);
636 }
637 else
638 rc = GetLastError();
639 }
640 else
641 rc = GetLastError();
642
643 return RTErrConvertFromWin32(rc);
644}
645
646
647RTR3DECL(int) RTFileGetSize(RTFILE hFile, uint64_t *pcbSize)
648{
649 /*
650 * GetFileSize works for most handles.
651 */
652 ULARGE_INTEGER Size;
653 Size.LowPart = GetFileSize((HANDLE)RTFileToNative(hFile), &Size.HighPart);
654 if (Size.LowPart != INVALID_FILE_SIZE)
655 {
656 *pcbSize = Size.QuadPart;
657 return VINF_SUCCESS;
658 }
659 int rc = RTErrConvertFromWin32(GetLastError());
660
661 /*
662 * Could it be a volume or a disk?
663 */
664 DISK_GEOMETRY DriveGeo;
665 DWORD cbDriveGeo;
666 if (DeviceIoControl((HANDLE)RTFileToNative(hFile),
667 IOCTL_DISK_GET_DRIVE_GEOMETRY, NULL, 0,
668 &DriveGeo, sizeof(DriveGeo), &cbDriveGeo, NULL))
669 {
670 if ( DriveGeo.MediaType == FixedMedia
671 || DriveGeo.MediaType == RemovableMedia)
672 {
673 *pcbSize = DriveGeo.Cylinders.QuadPart
674 * DriveGeo.TracksPerCylinder
675 * DriveGeo.SectorsPerTrack
676 * DriveGeo.BytesPerSector;
677
678 GET_LENGTH_INFORMATION DiskLenInfo;
679 DWORD Ignored;
680 if (DeviceIoControl((HANDLE)RTFileToNative(hFile),
681 IOCTL_DISK_GET_LENGTH_INFO, NULL, 0,
682 &DiskLenInfo, sizeof(DiskLenInfo), &Ignored, (LPOVERLAPPED)NULL))
683 {
684 /* IOCTL_DISK_GET_LENGTH_INFO is supported -- override cbSize. */
685 *pcbSize = DiskLenInfo.Length.QuadPart;
686 }
687 return VINF_SUCCESS;
688 }
689 }
690
691 /*
692 * Return the GetFileSize result if not a volume/disk.
693 */
694 return rc;
695}
696
697
698RTR3DECL(int) RTFileGetMaxSizeEx(RTFILE hFile, PRTFOFF pcbMax)
699{
700 /** @todo r=bird:
701 * We might have to make this code OS version specific... In the worse
702 * case, we'll have to try GetVolumeInformationByHandle on vista and fall
703 * back on NtQueryVolumeInformationFile(,,,, FileFsAttributeInformation)
704 * else where, and check for known file system names. (For LAN shares we'll
705 * have to figure out the remote file system.) */
706 RT_NOREF_PV(hFile); RT_NOREF_PV(pcbMax);
707 return VERR_NOT_IMPLEMENTED;
708}
709
710
711RTR3DECL(bool) RTFileIsValid(RTFILE hFile)
712{
713 if (hFile != NIL_RTFILE)
714 {
715 DWORD dwType = GetFileType((HANDLE)RTFileToNative(hFile));
716 switch (dwType)
717 {
718 case FILE_TYPE_CHAR:
719 case FILE_TYPE_DISK:
720 case FILE_TYPE_PIPE:
721 case FILE_TYPE_REMOTE:
722 return true;
723
724 case FILE_TYPE_UNKNOWN:
725 if (GetLastError() == NO_ERROR)
726 return true;
727 break;
728
729 default:
730 break;
731 }
732 }
733 return false;
734}
735
736
737#define LOW_DWORD(u64) ((DWORD)u64)
738#define HIGH_DWORD(u64) (((DWORD *)&u64)[1])
739
740RTR3DECL(int) RTFileLock(RTFILE hFile, unsigned fLock, int64_t offLock, uint64_t cbLock)
741{
742 Assert(offLock >= 0);
743
744 /* Check arguments. */
745 if (fLock & ~RTFILE_LOCK_MASK)
746 {
747 AssertMsgFailed(("Invalid fLock=%08X\n", fLock));
748 return VERR_INVALID_PARAMETER;
749 }
750
751 /* Prepare flags. */
752 Assert(RTFILE_LOCK_WRITE);
753 DWORD dwFlags = (fLock & RTFILE_LOCK_WRITE) ? LOCKFILE_EXCLUSIVE_LOCK : 0;
754 Assert(RTFILE_LOCK_WAIT);
755 if (!(fLock & RTFILE_LOCK_WAIT))
756 dwFlags |= LOCKFILE_FAIL_IMMEDIATELY;
757
758 /* Windows structure. */
759 OVERLAPPED Overlapped;
760 memset(&Overlapped, 0, sizeof(Overlapped));
761 Overlapped.Offset = LOW_DWORD(offLock);
762 Overlapped.OffsetHigh = HIGH_DWORD(offLock);
763
764 /* Note: according to Microsoft, LockFileEx API call is available starting from NT 3.5 */
765 if (LockFileEx((HANDLE)RTFileToNative(hFile), dwFlags, 0, LOW_DWORD(cbLock), HIGH_DWORD(cbLock), &Overlapped))
766 return VINF_SUCCESS;
767
768 return RTErrConvertFromWin32(GetLastError());
769}
770
771
772RTR3DECL(int) RTFileChangeLock(RTFILE hFile, unsigned fLock, int64_t offLock, uint64_t cbLock)
773{
774 Assert(offLock >= 0);
775
776 /* Check arguments. */
777 if (fLock & ~RTFILE_LOCK_MASK)
778 {
779 AssertMsgFailed(("Invalid fLock=%08X\n", fLock));
780 return VERR_INVALID_PARAMETER;
781 }
782
783 /* Remove old lock. */
784 int rc = RTFileUnlock(hFile, offLock, cbLock);
785 if (RT_FAILURE(rc))
786 return rc;
787
788 /* Set new lock. */
789 rc = RTFileLock(hFile, fLock, offLock, cbLock);
790 if (RT_SUCCESS(rc))
791 return rc;
792
793 /* Try to restore old lock. */
794 unsigned fLockOld = (fLock & RTFILE_LOCK_WRITE) ? fLock & ~RTFILE_LOCK_WRITE : fLock | RTFILE_LOCK_WRITE;
795 rc = RTFileLock(hFile, fLockOld, offLock, cbLock);
796 if (RT_SUCCESS(rc))
797 return VERR_FILE_LOCK_VIOLATION;
798 else
799 return VERR_FILE_LOCK_LOST;
800}
801
802
803RTR3DECL(int) RTFileUnlock(RTFILE hFile, int64_t offLock, uint64_t cbLock)
804{
805 Assert(offLock >= 0);
806
807 if (UnlockFile((HANDLE)RTFileToNative(hFile),
808 LOW_DWORD(offLock), HIGH_DWORD(offLock),
809 LOW_DWORD(cbLock), HIGH_DWORD(cbLock)))
810 return VINF_SUCCESS;
811
812 return RTErrConvertFromWin32(GetLastError());
813}
814
815
816
817RTR3DECL(int) RTFileQueryInfo(RTFILE hFile, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAdditionalAttribs)
818{
819 /*
820 * Validate input.
821 */
822 if (hFile == NIL_RTFILE)
823 {
824 AssertMsgFailed(("Invalid hFile=%RTfile\n", hFile));
825 return VERR_INVALID_PARAMETER;
826 }
827 if (!pObjInfo)
828 {
829 AssertMsgFailed(("Invalid pObjInfo=%p\n", pObjInfo));
830 return VERR_INVALID_PARAMETER;
831 }
832 if ( enmAdditionalAttribs < RTFSOBJATTRADD_NOTHING
833 || enmAdditionalAttribs > RTFSOBJATTRADD_LAST)
834 {
835 AssertMsgFailed(("Invalid enmAdditionalAttribs=%p\n", enmAdditionalAttribs));
836 return VERR_INVALID_PARAMETER;
837 }
838
839 /*
840 * Query file info.
841 */
842 HANDLE hHandle = (HANDLE)RTFileToNative(hFile);
843#if 1
844 uint64_t auBuf[168 / sizeof(uint64_t)]; /* Missing FILE_ALL_INFORMATION here. */
845 int rc = rtPathNtQueryInfoFromHandle(hFile, auBuf, sizeof(auBuf), pObjInfo, enmAdditionalAttribs, NULL, 0);
846 if (RT_SUCCESS(rc))
847 return rc;
848
849 /*
850 * Console I/O handles make trouble here. On older windows versions they
851 * end up with ERROR_INVALID_HANDLE when handed to the above API, while on
852 * more recent ones they cause different errors to appear.
853 *
854 * Thus, we must ignore the latter and doubly verify invalid handle claims.
855 * We use the undocumented VerifyConsoleIoHandle to do this, falling back on
856 * GetFileType should it not be there.
857 */
858 if ( rc == VERR_INVALID_HANDLE
859 || rc == VERR_ACCESS_DENIED
860 || rc == VERR_UNEXPECTED_FS_OBJ_TYPE)
861 {
862 static PFNVERIFYCONSOLEIOHANDLE s_pfnVerifyConsoleIoHandle = NULL;
863 static bool volatile s_fInitialized = false;
864 PFNVERIFYCONSOLEIOHANDLE pfnVerifyConsoleIoHandle;
865 if (s_fInitialized)
866 pfnVerifyConsoleIoHandle = s_pfnVerifyConsoleIoHandle;
867 else
868 {
869 pfnVerifyConsoleIoHandle = (PFNVERIFYCONSOLEIOHANDLE)RTLdrGetSystemSymbol("kernel32.dll", "VerifyConsoleIoHandle");
870 ASMAtomicWriteBool(&s_fInitialized, true);
871 }
872 if ( pfnVerifyConsoleIoHandle
873 ? !pfnVerifyConsoleIoHandle(hHandle)
874 : GetFileType(hHandle) == FILE_TYPE_UNKNOWN && GetLastError() != NO_ERROR)
875 return VERR_INVALID_HANDLE;
876 }
877 /*
878 * On Windows 10 and (hopefully) 8.1 we get ERROR_INVALID_FUNCTION with console
879 * I/O handles and null device handles. We must ignore these just like the
880 * above invalid handle error.
881 */
882 else if (rc != VERR_INVALID_FUNCTION && rc != VERR_IO_BAD_COMMAND)
883 return rc;
884
885 RT_ZERO(*pObjInfo);
886 pObjInfo->Attr.enmAdditional = enmAdditionalAttribs;
887 pObjInfo->Attr.fMode = rtFsModeFromDos(RTFS_DOS_NT_DEVICE, "", 0, 0);
888 return VINF_SUCCESS;
889#else
890
891 BY_HANDLE_FILE_INFORMATION Data;
892 if (!GetFileInformationByHandle(hHandle, &Data))
893 {
894 /*
895 * Console I/O handles make trouble here. On older windows versions they
896 * end up with ERROR_INVALID_HANDLE when handed to the above API, while on
897 * more recent ones they cause different errors to appear.
898 *
899 * Thus, we must ignore the latter and doubly verify invalid handle claims.
900 * We use the undocumented VerifyConsoleIoHandle to do this, falling back on
901 * GetFileType should it not be there.
902 */
903 DWORD dwErr = GetLastError();
904 if (dwErr == ERROR_INVALID_HANDLE)
905 {
906 static PFNVERIFYCONSOLEIOHANDLE s_pfnVerifyConsoleIoHandle = NULL;
907 static bool volatile s_fInitialized = false;
908 PFNVERIFYCONSOLEIOHANDLE pfnVerifyConsoleIoHandle;
909 if (s_fInitialized)
910 pfnVerifyConsoleIoHandle = s_pfnVerifyConsoleIoHandle;
911 else
912 {
913 pfnVerifyConsoleIoHandle = (PFNVERIFYCONSOLEIOHANDLE)RTLdrGetSystemSymbol("kernel32.dll", "VerifyConsoleIoHandle");
914 ASMAtomicWriteBool(&s_fInitialized, true);
915 }
916 if ( pfnVerifyConsoleIoHandle
917 ? !pfnVerifyConsoleIoHandle(hHandle)
918 : GetFileType(hHandle) == FILE_TYPE_UNKNOWN && GetLastError() != NO_ERROR)
919 return VERR_INVALID_HANDLE;
920 }
921 /*
922 * On Windows 10 and (hopefully) 8.1 we get ERROR_INVALID_FUNCTION with console I/O
923 * handles. We must ignore these just like the above invalid handle error.
924 */
925 else if (dwErr != ERROR_INVALID_FUNCTION)
926 return RTErrConvertFromWin32(dwErr);
927
928 RT_ZERO(Data);
929 Data.dwFileAttributes = RTFS_DOS_NT_DEVICE;
930 }
931
932 /*
933 * Setup the returned data.
934 */
935 pObjInfo->cbObject = ((uint64_t)Data.nFileSizeHigh << 32)
936 | (uint64_t)Data.nFileSizeLow;
937 pObjInfo->cbAllocated = pObjInfo->cbObject;
938
939 Assert(sizeof(uint64_t) == sizeof(Data.ftCreationTime));
940 RTTimeSpecSetNtTime(&pObjInfo->BirthTime, *(uint64_t *)&Data.ftCreationTime);
941 RTTimeSpecSetNtTime(&pObjInfo->AccessTime, *(uint64_t *)&Data.ftLastAccessTime);
942 RTTimeSpecSetNtTime(&pObjInfo->ModificationTime, *(uint64_t *)&Data.ftLastWriteTime);
943 pObjInfo->ChangeTime = pObjInfo->ModificationTime;
944
945 pObjInfo->Attr.fMode = rtFsModeFromDos((Data.dwFileAttributes << RTFS_DOS_SHIFT) & RTFS_DOS_MASK_NT, "", 0,
946 RTFSMODE_SYMLINK_REPARSE_TAG /* (symlink or not, doesn't usually matter here) */);
947
948 /*
949 * Requested attributes (we cannot provide anything actually).
950 */
951 switch (enmAdditionalAttribs)
952 {
953 case RTFSOBJATTRADD_NOTHING:
954 pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_NOTHING;
955 break;
956
957 case RTFSOBJATTRADD_UNIX:
958 pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_UNIX;
959 pObjInfo->Attr.u.Unix.uid = ~0U;
960 pObjInfo->Attr.u.Unix.gid = ~0U;
961 pObjInfo->Attr.u.Unix.cHardlinks = Data.nNumberOfLinks ? Data.nNumberOfLinks : 1;
962 pObjInfo->Attr.u.Unix.INodeIdDevice = Data.dwVolumeSerialNumber;
963 pObjInfo->Attr.u.Unix.INodeId = RT_MAKE_U64(Data.nFileIndexLow, Data.nFileIndexHigh);
964 pObjInfo->Attr.u.Unix.fFlags = 0;
965 pObjInfo->Attr.u.Unix.GenerationId = 0;
966 pObjInfo->Attr.u.Unix.Device = 0;
967 break;
968
969 case RTFSOBJATTRADD_UNIX_OWNER:
970 pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_UNIX_OWNER;
971 pObjInfo->Attr.u.UnixOwner.uid = ~0U;
972 pObjInfo->Attr.u.UnixOwner.szName[0] = '\0'; /** @todo return something sensible here. */
973 break;
974
975 case RTFSOBJATTRADD_UNIX_GROUP:
976 pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_UNIX_GROUP;
977 pObjInfo->Attr.u.UnixGroup.gid = ~0U;
978 pObjInfo->Attr.u.UnixGroup.szName[0] = '\0';
979 break;
980
981 case RTFSOBJATTRADD_EASIZE:
982 pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_EASIZE;
983 pObjInfo->Attr.u.EASize.cb = 0;
984 break;
985
986 default:
987 AssertMsgFailed(("Impossible!\n"));
988 return VERR_INTERNAL_ERROR;
989 }
990
991 return VINF_SUCCESS;
992#endif
993}
994
995
996RTR3DECL(int) RTFileSetTimes(RTFILE hFile, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
997 PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime)
998{
999 RT_NOREF_PV(pChangeTime); /* Not exposed thru the windows API we're using. */
1000
1001 if (!pAccessTime && !pModificationTime && !pBirthTime)
1002 return VINF_SUCCESS; /* NOP */
1003
1004 FILETIME CreationTimeFT;
1005 PFILETIME pCreationTimeFT = NULL;
1006 if (pBirthTime)
1007 pCreationTimeFT = RTTimeSpecGetNtFileTime(pBirthTime, &CreationTimeFT);
1008
1009 FILETIME LastAccessTimeFT;
1010 PFILETIME pLastAccessTimeFT = NULL;
1011 if (pAccessTime)
1012 pLastAccessTimeFT = RTTimeSpecGetNtFileTime(pAccessTime, &LastAccessTimeFT);
1013
1014 FILETIME LastWriteTimeFT;
1015 PFILETIME pLastWriteTimeFT = NULL;
1016 if (pModificationTime)
1017 pLastWriteTimeFT = RTTimeSpecGetNtFileTime(pModificationTime, &LastWriteTimeFT);
1018
1019 int rc = VINF_SUCCESS;
1020 if (!SetFileTime((HANDLE)RTFileToNative(hFile), pCreationTimeFT, pLastAccessTimeFT, pLastWriteTimeFT))
1021 {
1022 DWORD Err = GetLastError();
1023 rc = RTErrConvertFromWin32(Err);
1024 Log(("RTFileSetTimes(%RTfile, %p, %p, %p, %p): SetFileTime failed with lasterr %d (%Rrc)\n",
1025 hFile, pAccessTime, pModificationTime, pChangeTime, pBirthTime, Err, rc));
1026 }
1027 return rc;
1028}
1029
1030
1031#if 0 /* RTFileSetMode is implemented by RTFileSetMode-r3-nt.cpp */
1032/* This comes from a source file with a different set of system headers (DDK)
1033 * so it can't be declared in a common header, like internal/file.h.
1034 */
1035extern int rtFileNativeSetAttributes(HANDLE FileHandle, ULONG FileAttributes);
1036
1037
1038RTR3DECL(int) RTFileSetMode(RTFILE hFile, RTFMODE fMode)
1039{
1040 /*
1041 * Normalize the mode and call the API.
1042 */
1043 fMode = rtFsModeNormalize(fMode, NULL, 0);
1044 if (!rtFsModeIsValid(fMode))
1045 return VERR_INVALID_PARAMETER;
1046
1047 ULONG FileAttributes = (fMode & RTFS_DOS_MASK) >> RTFS_DOS_SHIFT;
1048 int Err = rtFileNativeSetAttributes((HANDLE)hFile, FileAttributes);
1049 if (Err != ERROR_SUCCESS)
1050 {
1051 int rc = RTErrConvertFromWin32(Err);
1052 Log(("RTFileSetMode(%RTfile, %RTfmode): rtFileNativeSetAttributes (0x%08X) failed with err %d (%Rrc)\n",
1053 hFile, fMode, FileAttributes, Err, rc));
1054 return rc;
1055 }
1056 return VINF_SUCCESS;
1057}
1058#endif
1059
1060
1061/* RTFileQueryFsSizes is implemented by ../nt/RTFileQueryFsSizes-nt.cpp */
1062
1063
1064RTR3DECL(int) RTFileDelete(const char *pszFilename)
1065{
1066 PRTUTF16 pwszFilename;
1067 int rc = RTPathWinFromUtf8(&pwszFilename, pszFilename, 0 /*fFlags*/);
1068 if (RT_SUCCESS(rc))
1069 {
1070 if (!DeleteFileW(pwszFilename))
1071 rc = RTErrConvertFromWin32(GetLastError());
1072 RTPathWinFree(pwszFilename);
1073 }
1074
1075 return rc;
1076}
1077
1078
1079RTDECL(int) RTFileRename(const char *pszSrc, const char *pszDst, unsigned fRename)
1080{
1081 /*
1082 * Validate input.
1083 */
1084 AssertMsgReturn(VALID_PTR(pszSrc), ("%p\n", pszSrc), VERR_INVALID_POINTER);
1085 AssertMsgReturn(VALID_PTR(pszDst), ("%p\n", pszDst), VERR_INVALID_POINTER);
1086 AssertMsgReturn(!(fRename & ~RTPATHRENAME_FLAGS_REPLACE), ("%#x\n", fRename), VERR_INVALID_PARAMETER);
1087
1088 /*
1089 * Hand it on to the worker.
1090 */
1091 int rc = rtPathWin32MoveRename(pszSrc, pszDst,
1092 fRename & RTPATHRENAME_FLAGS_REPLACE ? MOVEFILE_REPLACE_EXISTING : 0,
1093 RTFS_TYPE_FILE);
1094
1095 LogFlow(("RTFileMove(%p:{%s}, %p:{%s}, %#x): returns %Rrc\n",
1096 pszSrc, pszSrc, pszDst, pszDst, fRename, rc));
1097 return rc;
1098
1099}
1100
1101
1102RTDECL(int) RTFileMove(const char *pszSrc, const char *pszDst, unsigned fMove)
1103{
1104 /*
1105 * Validate input.
1106 */
1107 AssertMsgReturn(VALID_PTR(pszSrc), ("%p\n", pszSrc), VERR_INVALID_POINTER);
1108 AssertMsgReturn(VALID_PTR(pszDst), ("%p\n", pszDst), VERR_INVALID_POINTER);
1109 AssertMsgReturn(!(fMove & ~RTFILEMOVE_FLAGS_REPLACE), ("%#x\n", fMove), VERR_INVALID_PARAMETER);
1110
1111 /*
1112 * Hand it on to the worker.
1113 */
1114 int rc = rtPathWin32MoveRename(pszSrc, pszDst,
1115 fMove & RTFILEMOVE_FLAGS_REPLACE
1116 ? MOVEFILE_COPY_ALLOWED | MOVEFILE_REPLACE_EXISTING
1117 : MOVEFILE_COPY_ALLOWED,
1118 RTFS_TYPE_FILE);
1119
1120 LogFlow(("RTFileMove(%p:{%s}, %p:{%s}, %#x): returns %Rrc\n",
1121 pszSrc, pszSrc, pszDst, pszDst, fMove, rc));
1122 return rc;
1123}
1124
Note: See TracBrowser for help on using the repository browser.

© 2025 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette