fileio-win.cpp@ 24889

Last change on this file since 24889 was 24889, checked in by vboxsync, 15 years ago
IPRT: Added RTFileQueryFsSizes.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 28.0 KB

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

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

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

Download in other formats: