fileio-win.cpp@ 36555

Last change on this file since 36555 was 36367, checked in by vboxsync, 14 years ago
fileio-win.cpp: Handle ERROR_NOT_ENOUGH_MEMORY conditions occuring when console handles are pased to RTFileWrite and RTFileRead.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 31.2 KB

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

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

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

Download in other formats: