fileio-win.cpp@ 37528

Last change on this file since 37528 was 36601, checked in by vboxsync, 14 years ago
build fix
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 31.8 KB

Line
1	/* $Id: fileio-win.cpp 36601 2011-04-06 20:07:12Z 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	RTFILE rtFileGetStandard(RTHANDLESTD enmStdHandle)
352	{
353	DWORD dwStdHandle;
354	switch (enmStdHandle)
355	{
356	case RTHANDLESTD_INPUT: dwStdHandle = STD_INPUT_HANDLE; break;
357	case RTHANDLESTD_OUTPUT: dwStdHandle = STD_OUTPUT_HANDLE; break;
358	case RTHANDLESTD_ERROR: dwStdHandle = STD_ERROR_HANDLE; break;
359	break;
360	default:
361	AssertFailedReturn(NIL_RTFILE);
362	}
363
364	HANDLE hNative = GetStdHandle(dwStdHandle);
365	if (hNative == INVALID_HANDLE_VALUE)
366	return NIL_RTFILE;
367
368	RTFILE hFile = (RTFILE)(uintptr_t)hNative;
369	AssertReturn((HANDLE)(uintptr_t)hFile == hNative, NIL_RTFILE);
370	return hFile;
371	}
372
373
374	RTR3DECL(int) RTFileSeek(RTFILE File, int64_t offSeek, unsigned uMethod, uint64_t *poffActual)
375	{
376	static ULONG aulSeekRecode[] =
377	{
378	FILE_BEGIN,
379	FILE_CURRENT,
380	FILE_END,
381	};
382
383	/*
384	* Validate input.
385	*/
386	if (uMethod > RTFILE_SEEK_END)
387	{
388	AssertMsgFailed(("Invalid uMethod=%d\n", uMethod));
389	return VERR_INVALID_PARAMETER;
390	}
391
392	/*
393	* Execute the seek.
394	*/
395	if (MySetFilePointer(File, offSeek, poffActual, aulSeekRecode[uMethod]))
396	return VINF_SUCCESS;
397	return RTErrConvertFromWin32(GetLastError());
398	}
399
400
401	RTR3DECL(int) RTFileRead(RTFILE File, void pvBuf, size_t cbToRead, size_t pcbRead)
402	{
403	if (cbToRead <= 0)
404	return VINF_SUCCESS;
405	ULONG cbToReadAdj = (ULONG)cbToRead;
406	AssertReturn(cbToReadAdj == cbToRead, VERR_NUMBER_TOO_BIG);
407
408	ULONG cbRead = 0;
409	if (ReadFile((HANDLE)File, pvBuf, cbToReadAdj, &cbRead, NULL))
410	{
411	if (pcbRead)
412	/* Caller can handle partial reads. */
413	*pcbRead = cbRead;
414	else
415	{
416	/* Caller expects everything to be read. */
417	while (cbToReadAdj > cbRead)
418	{
419	ULONG cbReadPart = 0;
420	if (!ReadFile((HANDLE)File, (char*)pvBuf + cbRead, cbToReadAdj - cbRead, &cbReadPart, NULL))
421	return RTErrConvertFromWin32(GetLastError());
422	if (cbReadPart == 0)
423	return VERR_EOF;
424	cbRead += cbReadPart;
425	}
426	}
427	return VINF_SUCCESS;
428	}
429
430	/*
431	* If it's a console, we might bump into out of memory conditions in the
432	* ReadConsole call.
433	*/
434	DWORD dwErr = GetLastError();
435	if (dwErr == ERROR_NOT_ENOUGH_MEMORY)
436	{
437	ULONG cbChunk = cbToReadAdj / 2;
438	if (cbChunk > 16*_1K)
439	cbChunk = 16*_1K;
440	else
441	cbChunk = RT_ALIGN_32(cbChunk, 256);
442
443	cbRead = 0;
444	while (cbToReadAdj > cbRead)
445	{
446	ULONG cbToRead = RT_MIN(cbChunk, cbToReadAdj - cbRead);
447	ULONG cbReadPart = 0;
448	if (!ReadFile((HANDLE)File, (char *)pvBuf + cbRead, cbToRead, &cbReadPart, NULL))
449	{
450	/* If we failed because the buffer is too big, shrink it and
451	try again. */
452	dwErr = GetLastError();
453	if ( dwErr == ERROR_NOT_ENOUGH_MEMORY
454	&& cbChunk > 8)
455	{
456	cbChunk /= 2;
457	continue;
458	}
459	return RTErrConvertFromWin32(dwErr);
460	}
461	cbRead += cbReadPart;
462
463	/* Return if the caller can handle partial reads, otherwise try
464	fill the buffer all the way up. */
465	if (pcbRead)
466	{
467	*pcbRead = cbRead;
468	break;
469	}
470	if (cbReadPart == 0)
471	return VERR_EOF;
472	}
473	return VINF_SUCCESS;
474	}
475
476	return RTErrConvertFromWin32(dwErr);
477	}
478
479
480	RTR3DECL(int) RTFileWrite(RTFILE File, const void pvBuf, size_t cbToWrite, size_t pcbWritten)
481	{
482	if (cbToWrite <= 0)
483	return VINF_SUCCESS;
484	ULONG cbToWriteAdj = (ULONG)cbToWrite;
485	AssertReturn(cbToWriteAdj == cbToWrite, VERR_NUMBER_TOO_BIG);
486
487	ULONG cbWritten = 0;
488	if (WriteFile((HANDLE)File, pvBuf, cbToWriteAdj, &cbWritten, NULL))
489	{
490	if (pcbWritten)
491	/* Caller can handle partial writes. */
492	*pcbWritten = cbWritten;
493	else
494	{
495	/* Caller expects everything to be written. */
496	while (cbToWriteAdj > cbWritten)
497	{
498	ULONG cbWrittenPart = 0;
499	if (!WriteFile((HANDLE)File, (char*)pvBuf + cbWritten, cbToWriteAdj - cbWritten, &cbWrittenPart, NULL))
500	{
501	int rc = RTErrConvertFromWin32(GetLastError());
502	if ( rc == VERR_DISK_FULL
503	&& IsBeyondLimit(File, cbToWriteAdj - cbWritten, FILE_CURRENT)
504	)
505	rc = VERR_FILE_TOO_BIG;
506	return rc;
507	}
508	if (cbWrittenPart == 0)
509	return VERR_WRITE_ERROR;
510	cbWritten += cbWrittenPart;
511	}
512	}
513	return VINF_SUCCESS;
514	}
515
516	/*
517	* If it's a console, we might bump into out of memory conditions in the
518	* WriteConsole call.
519	*/
520	DWORD dwErr = GetLastError();
521	if (dwErr == ERROR_NOT_ENOUGH_MEMORY)
522	{
523	ULONG cbChunk = cbToWriteAdj / 2;
524	if (cbChunk > _32K)
525	cbChunk = _32K;
526	else
527	cbChunk = RT_ALIGN_32(cbChunk, 256);
528
529	cbWritten = 0;
530	while (cbToWriteAdj > cbWritten)
531	{
532	ULONG cbToWrite = RT_MIN(cbChunk, cbToWriteAdj - cbWritten);
533	ULONG cbWrittenPart = 0;
534	if (!WriteFile((HANDLE)File, (const char *)pvBuf + cbWritten, cbToWrite, &cbWrittenPart, NULL))
535	{
536	/* If we failed because the buffer is too big, shrink it and
537	try again. */
538	dwErr = GetLastError();
539	if ( dwErr == ERROR_NOT_ENOUGH_MEMORY
540	&& cbChunk > 8)
541	{
542	cbChunk /= 2;
543	continue;
544	}
545	int rc = RTErrConvertFromWin32(dwErr);
546	if ( rc == VERR_DISK_FULL
547	&& IsBeyondLimit(File, cbToWriteAdj - cbWritten, FILE_CURRENT))
548	rc = VERR_FILE_TOO_BIG;
549	return rc;
550	}
551	cbWritten += cbWrittenPart;
552
553	/* Return if the caller can handle partial writes, otherwise try
554	write out everything. */
555	if (pcbWritten)
556	{
557	*pcbWritten = cbWritten;
558	break;
559	}
560	if (cbWrittenPart == 0)
561	return VERR_WRITE_ERROR;
562	}
563	return VINF_SUCCESS;
564	}
565
566	int rc = RTErrConvertFromWin32(dwErr);
567	if ( rc == VERR_DISK_FULL
568	&& IsBeyondLimit(File, cbToWriteAdj - cbWritten, FILE_CURRENT))
569	rc = VERR_FILE_TOO_BIG;
570	return rc;
571	}
572
573
574	RTR3DECL(int) RTFileFlush(RTFILE File)
575	{
576	if (!FlushFileBuffers((HANDLE)File))
577	{
578	int rc = GetLastError();
579	Log(("FlushFileBuffers failed with %d\n", rc));
580	return RTErrConvertFromWin32(rc);
581	}
582	return VINF_SUCCESS;
583	}
584
585
586	RTR3DECL(int) RTFileSetSize(RTFILE File, uint64_t cbSize)
587	{
588	/*
589	* Get current file pointer.
590	*/
591	int rc;
592	uint64_t offCurrent;
593	if (MySetFilePointer(File, 0, &offCurrent, FILE_CURRENT))
594	{
595	/*
596	* Set new file pointer.
597	*/
598	if (MySetFilePointer(File, cbSize, NULL, FILE_BEGIN))
599	{
600	/* set file pointer */
601	if (SetEndOfFile((HANDLE)File))
602	{
603	/*
604	* Restore file pointer and return.
605	* If the old pointer was beyond the new file end, ignore failure.
606	*/
607	if ( MySetFilePointer(File, offCurrent, NULL, FILE_BEGIN)
608	\|\| offCurrent > cbSize)
609	return VINF_SUCCESS;
610	}
611
612	/*
613	* Failed, try restoring the file pointer.
614	*/
615	rc = GetLastError();
616	MySetFilePointer(File, offCurrent, NULL, FILE_BEGIN);
617	}
618	else
619	rc = GetLastError();
620	}
621	else
622	rc = GetLastError();
623
624	return RTErrConvertFromWin32(rc);
625	}
626
627
628	RTR3DECL(int) RTFileGetSize(RTFILE File, uint64_t *pcbSize)
629	{
630	ULARGE_INTEGER Size;
631	Size.LowPart = GetFileSize((HANDLE)File, &Size.HighPart);
632	if (Size.LowPart != INVALID_FILE_SIZE)
633	{
634	*pcbSize = Size.QuadPart;
635	return VINF_SUCCESS;
636	}
637
638	/* error exit */
639	return RTErrConvertFromWin32(GetLastError());
640	}
641
642
643	RTR3DECL(int) RTFileGetMaxSizeEx(RTFILE File, PRTFOFF pcbMax)
644	{
645	/** @todo r=bird:
646	* We might have to make this code OS specific...
647	* In the worse case, we'll have to try GetVolumeInformationByHandle on vista and fall
648	* back on NtQueryVolumeInformationFile(,,,, FileFsAttributeInformation) else where, and
649	* check for known file system names. (For LAN shares we'll have to figure out the remote
650	* file system.) */
651	return VERR_NOT_IMPLEMENTED;
652	}
653
654
655	RTR3DECL(bool) RTFileIsValid(RTFILE File)
656	{
657	if (File != NIL_RTFILE)
658	{
659	DWORD dwType = GetFileType((HANDLE)File);
660	switch (dwType)
661	{
662	case FILE_TYPE_CHAR:
663	case FILE_TYPE_DISK:
664	case FILE_TYPE_PIPE:
665	case FILE_TYPE_REMOTE:
666	return true;
667
668	case FILE_TYPE_UNKNOWN:
669	if (GetLastError() == NO_ERROR)
670	return true;
671	break;
672	}
673	}
674	return false;
675	}
676
677
678	#define LOW_DWORD(u64) ((DWORD)u64)
679	#define HIGH_DWORD(u64) (((DWORD *)&u64)[1])
680
681	RTR3DECL(int) RTFileLock(RTFILE File, unsigned fLock, int64_t offLock, uint64_t cbLock)
682	{
683	Assert(offLock >= 0);
684
685	/* Check arguments. */
686	if (fLock & ~RTFILE_LOCK_MASK)
687	{
688	AssertMsgFailed(("Invalid fLock=%08X\n", fLock));
689	return VERR_INVALID_PARAMETER;
690	}
691
692	/* Prepare flags. */
693	Assert(RTFILE_LOCK_WRITE);
694	DWORD dwFlags = (fLock & RTFILE_LOCK_WRITE) ? LOCKFILE_EXCLUSIVE_LOCK : 0;
695	Assert(RTFILE_LOCK_WAIT);
696	if (!(fLock & RTFILE_LOCK_WAIT))
697	dwFlags \|= LOCKFILE_FAIL_IMMEDIATELY;
698
699	/* Windows structure. */
700	OVERLAPPED Overlapped;
701	memset(&Overlapped, 0, sizeof(Overlapped));
702	Overlapped.Offset = LOW_DWORD(offLock);
703	Overlapped.OffsetHigh = HIGH_DWORD(offLock);
704
705	/* Note: according to Microsoft, LockFileEx API call is available starting from NT 3.5 */
706	if (LockFileEx((HANDLE)File, dwFlags, 0, LOW_DWORD(cbLock), HIGH_DWORD(cbLock), &Overlapped))
707	return VINF_SUCCESS;
708
709	return RTErrConvertFromWin32(GetLastError());
710	}
711
712
713	RTR3DECL(int) RTFileChangeLock(RTFILE File, unsigned fLock, int64_t offLock, uint64_t cbLock)
714	{
715	Assert(offLock >= 0);
716
717	/* Check arguments. */
718	if (fLock & ~RTFILE_LOCK_MASK)
719	{
720	AssertMsgFailed(("Invalid fLock=%08X\n", fLock));
721	return VERR_INVALID_PARAMETER;
722	}
723
724	/* Remove old lock. */
725	int rc = RTFileUnlock(File, offLock, cbLock);
726	if (RT_FAILURE(rc))
727	return rc;
728
729	/* Set new lock. */
730	rc = RTFileLock(File, fLock, offLock, cbLock);
731	if (RT_SUCCESS(rc))
732	return rc;
733
734	/* Try to restore old lock. */
735	unsigned fLockOld = (fLock & RTFILE_LOCK_WRITE) ? fLock & ~RTFILE_LOCK_WRITE : fLock \| RTFILE_LOCK_WRITE;
736	rc = RTFileLock(File, fLockOld, offLock, cbLock);
737	if (RT_SUCCESS(rc))
738	return VERR_FILE_LOCK_VIOLATION;
739	else
740	return VERR_FILE_LOCK_LOST;
741	}
742
743
744	RTR3DECL(int) RTFileUnlock(RTFILE File, int64_t offLock, uint64_t cbLock)
745	{
746	Assert(offLock >= 0);
747
748	if (UnlockFile((HANDLE)File, LOW_DWORD(offLock), HIGH_DWORD(offLock), LOW_DWORD(cbLock), HIGH_DWORD(cbLock)))
749	return VINF_SUCCESS;
750
751	return RTErrConvertFromWin32(GetLastError());
752	}
753
754
755
756	RTR3DECL(int) RTFileQueryInfo(RTFILE File, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAdditionalAttribs)
757	{
758	/*
759	* Validate input.
760	*/
761	if (File == NIL_RTFILE)
762	{
763	AssertMsgFailed(("Invalid File=%RTfile\n", File));
764	return VERR_INVALID_PARAMETER;
765	}
766	if (!pObjInfo)
767	{
768	AssertMsgFailed(("Invalid pObjInfo=%p\n", pObjInfo));
769	return VERR_INVALID_PARAMETER;
770	}
771	if ( enmAdditionalAttribs < RTFSOBJATTRADD_NOTHING
772	\|\| enmAdditionalAttribs > RTFSOBJATTRADD_LAST)
773	{
774	AssertMsgFailed(("Invalid enmAdditionalAttribs=%p\n", enmAdditionalAttribs));
775	return VERR_INVALID_PARAMETER;
776	}
777
778	/*
779	* Query file info.
780	*/
781	BY_HANDLE_FILE_INFORMATION Data;
782	if (!GetFileInformationByHandle((HANDLE)File, &Data))
783	{
784	DWORD dwErr = GetLastError();
785	/* Only return if we really don't have a valid handle value,
786	* everything else is fine here ... */
787	if (dwErr != ERROR_INVALID_HANDLE)
788	return RTErrConvertFromWin32(dwErr);
789	}
790
791	/*
792	* Setup the returned data.
793	*/
794	pObjInfo->cbObject = ((uint64_t)Data.nFileSizeHigh << 32)
795	\| (uint64_t)Data.nFileSizeLow;
796	pObjInfo->cbAllocated = pObjInfo->cbObject;
797
798	Assert(sizeof(uint64_t) == sizeof(Data.ftCreationTime));
799	RTTimeSpecSetNtTime(&pObjInfo->BirthTime, (uint64_t )&Data.ftCreationTime);
800	RTTimeSpecSetNtTime(&pObjInfo->AccessTime, (uint64_t )&Data.ftLastAccessTime);
801	RTTimeSpecSetNtTime(&pObjInfo->ModificationTime, (uint64_t )&Data.ftLastWriteTime);
802	pObjInfo->ChangeTime = pObjInfo->ModificationTime;
803
804	pObjInfo->Attr.fMode = rtFsModeFromDos((Data.dwFileAttributes << RTFS_DOS_SHIFT) & RTFS_DOS_MASK_NT, "", 0);
805
806	/*
807	* Requested attributes (we cannot provide anything actually).
808	*/
809	switch (enmAdditionalAttribs)
810	{
811	case RTFSOBJATTRADD_NOTHING:
812	pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_NOTHING;
813	break;
814
815	case RTFSOBJATTRADD_UNIX:
816	pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_UNIX;
817	pObjInfo->Attr.u.Unix.uid = ~0U;
818	pObjInfo->Attr.u.Unix.gid = ~0U;
819	pObjInfo->Attr.u.Unix.cHardlinks = Data.nNumberOfLinks ? Data.nNumberOfLinks : 1;
820	pObjInfo->Attr.u.Unix.INodeIdDevice = 0; /** @todo Use the volume serial number (see GetFileInformationByHandle). */
821	pObjInfo->Attr.u.Unix.INodeId = 0; /** @todo Use the fileid (see GetFileInformationByHandle). */
822	pObjInfo->Attr.u.Unix.fFlags = 0;
823	pObjInfo->Attr.u.Unix.GenerationId = 0;
824	pObjInfo->Attr.u.Unix.Device = 0;
825	break;
826
827	case RTFSOBJATTRADD_UNIX_OWNER:
828	pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_UNIX_OWNER;
829	pObjInfo->Attr.u.UnixOwner.uid = ~0U;
830	pObjInfo->Attr.u.UnixOwner.szName[0] = '\0'; /** @todo return something sensible here. */
831	break;
832
833	case RTFSOBJATTRADD_UNIX_GROUP:
834	pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_UNIX_GROUP;
835	pObjInfo->Attr.u.UnixGroup.gid = ~0U;
836	pObjInfo->Attr.u.UnixGroup.szName[0] = '\0';
837	break;
838
839	case RTFSOBJATTRADD_EASIZE:
840	pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_EASIZE;
841	pObjInfo->Attr.u.EASize.cb = 0;
842	break;
843
844	default:
845	AssertMsgFailed(("Impossible!\n"));
846	return VERR_INTERNAL_ERROR;
847	}
848
849	return VINF_SUCCESS;
850	}
851
852
853	RTR3DECL(int) RTFileSetTimes(RTFILE File, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
854	PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime)
855	{
856	if (!pAccessTime && !pModificationTime && !pBirthTime)
857	return VINF_SUCCESS; /* NOP */
858
859	FILETIME CreationTimeFT;
860	PFILETIME pCreationTimeFT = NULL;
861	if (pBirthTime)
862	pCreationTimeFT = RTTimeSpecGetNtFileTime(pBirthTime, &CreationTimeFT);
863
864	FILETIME LastAccessTimeFT;
865	PFILETIME pLastAccessTimeFT = NULL;
866	if (pAccessTime)
867	pLastAccessTimeFT = RTTimeSpecGetNtFileTime(pAccessTime, &LastAccessTimeFT);
868
869	FILETIME LastWriteTimeFT;
870	PFILETIME pLastWriteTimeFT = NULL;
871	if (pModificationTime)
872	pLastWriteTimeFT = RTTimeSpecGetNtFileTime(pModificationTime, &LastWriteTimeFT);
873
874	int rc = VINF_SUCCESS;
875	if (!SetFileTime((HANDLE)File, pCreationTimeFT, pLastAccessTimeFT, pLastWriteTimeFT))
876	{
877	DWORD Err = GetLastError();
878	rc = RTErrConvertFromWin32(Err);
879	Log(("RTFileSetTimes(%RTfile, %p, %p, %p, %p): SetFileTime failed with lasterr %d (%Rrc)\n",
880	File, pAccessTime, pModificationTime, pChangeTime, pBirthTime, Err, rc));
881	}
882	return rc;
883	}
884
885
886	/* This comes from a source file with a different set of system headers (DDK)
887	* so it can't be declared in a common header, like internal/file.h.
888	*/
889	extern int rtFileNativeSetAttributes(HANDLE FileHandle, ULONG FileAttributes);
890
891
892	RTR3DECL(int) RTFileSetMode(RTFILE File, RTFMODE fMode)
893	{
894	/*
895	* Normalize the mode and call the API.
896	*/
897	fMode = rtFsModeNormalize(fMode, NULL, 0);
898	if (!rtFsModeIsValid(fMode))
899	return VERR_INVALID_PARAMETER;
900
901	ULONG FileAttributes = (fMode & RTFS_DOS_MASK) >> RTFS_DOS_SHIFT;
902	int Err = rtFileNativeSetAttributes((HANDLE)File, FileAttributes);
903	if (Err != ERROR_SUCCESS)
904	{
905	int rc = RTErrConvertFromWin32(Err);
906	Log(("RTFileSetMode(%RTfile, %RTfmode): rtFileNativeSetAttributes (0x%08X) failed with err %d (%Rrc)\n",
907	File, fMode, FileAttributes, Err, rc));
908	return rc;
909	}
910	return VINF_SUCCESS;
911	}
912
913
914	RTR3DECL(int) RTFileQueryFsSizes(RTFILE hFile, PRTFOFF pcbTotal, RTFOFF *pcbFree,
915	uint32_t pcbBlock, uint32_t pcbSector)
916	{
917	/** @todo implement this using NtQueryVolumeInformationFile(hFile,,,,
918	* FileFsSizeInformation). */
919	return VERR_NOT_SUPPORTED;
920	}
921
922
923	RTR3DECL(int) RTFileDelete(const char *pszFilename)
924	{
925	PRTUTF16 pwszFilename;
926	int rc = RTStrToUtf16(pszFilename, &pwszFilename);
927	if (RT_SUCCESS(rc))
928	{
929	if (!DeleteFileW(pwszFilename))
930	rc = RTErrConvertFromWin32(GetLastError());
931	RTUtf16Free(pwszFilename);
932	}
933
934	return rc;
935	}
936
937
938	RTDECL(int) RTFileRename(const char pszSrc, const char pszDst, unsigned fRename)
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(!(fRename & ~RTPATHRENAME_FLAGS_REPLACE), ("%#x\n", fRename), VERR_INVALID_PARAMETER);
946
947	/*
948	* Hand it on to the worker.
949	*/
950	int rc = rtPathWin32MoveRename(pszSrc, pszDst,
951	fRename & RTPATHRENAME_FLAGS_REPLACE ? MOVEFILE_REPLACE_EXISTING : 0,
952	RTFS_TYPE_FILE);
953
954	LogFlow(("RTFileMove(%p:{%s}, %p:{%s}, %#x): returns %Rrc\n",
955	pszSrc, pszSrc, pszDst, pszDst, fRename, rc));
956	return rc;
957
958	}
959
960
961	RTDECL(int) RTFileMove(const char pszSrc, const char pszDst, unsigned fMove)
962	{
963	/*
964	* Validate input.
965	*/
966	AssertMsgReturn(VALID_PTR(pszSrc), ("%p\n", pszSrc), VERR_INVALID_POINTER);
967	AssertMsgReturn(VALID_PTR(pszDst), ("%p\n", pszDst), VERR_INVALID_POINTER);
968	AssertMsgReturn(!(fMove & ~RTFILEMOVE_FLAGS_REPLACE), ("%#x\n", fMove), VERR_INVALID_PARAMETER);
969
970	/*
971	* Hand it on to the worker.
972	*/
973	int rc = rtPathWin32MoveRename(pszSrc, pszDst,
974	fMove & RTFILEMOVE_FLAGS_REPLACE
975	? MOVEFILE_COPY_ALLOWED \| MOVEFILE_REPLACE_EXISTING
976	: MOVEFILE_COPY_ALLOWED,
977	RTFS_TYPE_FILE);
978
979	LogFlow(("RTFileMove(%p:{%s}, %p:{%s}, %#x): returns %Rrc\n",
980	pszSrc, pszSrc, pszDst, pszDst, fMove, rc));
981	return rc;
982	}
983

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

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

Download in other formats: