fileio-win.cpp@ 61009

Last change on this file since 61009 was 58768, checked in by vboxsync, 9 years ago
RTFileOpen: Introduced RTFILE_O_ATTR_ONLY for windows only.
Property svn:eol-style set to `native` Property svn:keywords set to `Id Revision`
File size: 35.8 KB

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

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: