fileio-win.cpp@ 34801

Last change on this file since 34801 was 34579, checked in by vboxsync, 14 years ago
Completed the extension pack renaming. Some bugfixes.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 27.9 KB

Line
1	/* $Id: fileio-win.cpp 34579 2010-12-01 15:45:02Z 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	return RTErrConvertFromWin32(GetLastError());
407	}
408
409
410	RTR3DECL(int) RTFileWrite(RTFILE File, const void pvBuf, size_t cbToWrite, size_t pcbWritten)
411	{
412	if (cbToWrite <= 0)
413	return VINF_SUCCESS;
414	ULONG cbToWriteAdj = (ULONG)cbToWrite;
415	AssertReturn(cbToWriteAdj == cbToWrite, VERR_NUMBER_TOO_BIG);
416
417	ULONG cbWritten = 0;
418	if (WriteFile((HANDLE)File, pvBuf, cbToWriteAdj, &cbWritten, NULL))
419	{
420	if (pcbWritten)
421	/* Caller can handle partial writes. */
422	*pcbWritten = cbWritten;
423	else
424	{
425	/* Caller expects everything to be written. */
426	while (cbToWriteAdj > cbWritten)
427	{
428	ULONG cbWrittenPart = 0;
429	if (!WriteFile((HANDLE)File, (char*)pvBuf + cbWritten, cbToWriteAdj - cbWritten, &cbWrittenPart, NULL))
430	{
431	int rc = RTErrConvertFromWin32(GetLastError());
432	if ( rc == VERR_DISK_FULL
433	&& IsBeyondLimit(File, cbToWriteAdj - cbWritten, FILE_CURRENT)
434	)
435	rc = VERR_FILE_TOO_BIG;
436	return rc;
437	}
438	if (cbWrittenPart == 0)
439	return VERR_WRITE_ERROR;
440	cbWritten += cbWrittenPart;
441	}
442	}
443	return VINF_SUCCESS;
444	}
445	int rc = RTErrConvertFromWin32(GetLastError());
446	if ( rc == VERR_DISK_FULL
447	&& IsBeyondLimit(File, cbToWriteAdj - cbWritten, FILE_CURRENT))
448	rc = VERR_FILE_TOO_BIG;
449	return rc;
450	}
451
452
453	RTR3DECL(int) RTFileFlush(RTFILE File)
454	{
455	if (!FlushFileBuffers((HANDLE)File))
456	{
457	int rc = GetLastError();
458	Log(("FlushFileBuffers failed with %d\n", rc));
459	return RTErrConvertFromWin32(rc);
460	}
461	return VINF_SUCCESS;
462	}
463
464
465	RTR3DECL(int) RTFileSetSize(RTFILE File, uint64_t cbSize)
466	{
467	/*
468	* Get current file pointer.
469	*/
470	int rc;
471	uint64_t offCurrent;
472	if (MySetFilePointer(File, 0, &offCurrent, FILE_CURRENT))
473	{
474	/*
475	* Set new file pointer.
476	*/
477	if (MySetFilePointer(File, cbSize, NULL, FILE_BEGIN))
478	{
479	/* set file pointer */
480	if (SetEndOfFile((HANDLE)File))
481	{
482	/*
483	* Restore file pointer and return.
484	* If the old pointer was beyond the new file end, ignore failure.
485	*/
486	if ( MySetFilePointer(File, offCurrent, NULL, FILE_BEGIN)
487	\|\| offCurrent > cbSize)
488	return VINF_SUCCESS;
489	}
490
491	/*
492	* Failed, try restoring the file pointer.
493	*/
494	rc = GetLastError();
495	MySetFilePointer(File, offCurrent, NULL, FILE_BEGIN);
496	}
497	else
498	rc = GetLastError();
499	}
500	else
501	rc = GetLastError();
502
503	return RTErrConvertFromWin32(rc);
504	}
505
506
507	RTR3DECL(int) RTFileGetSize(RTFILE File, uint64_t *pcbSize)
508	{
509	ULARGE_INTEGER Size;
510	Size.LowPart = GetFileSize((HANDLE)File, &Size.HighPart);
511	if (Size.LowPart != INVALID_FILE_SIZE)
512	{
513	*pcbSize = Size.QuadPart;
514	return VINF_SUCCESS;
515	}
516
517	/* error exit */
518	return RTErrConvertFromWin32(GetLastError());
519	}
520
521
522	RTR3DECL(int) RTFileGetMaxSizeEx(RTFILE File, PRTFOFF pcbMax)
523	{
524	/** @todo r=bird:
525	* We might have to make this code OS specific...
526	* In the worse case, we'll have to try GetVolumeInformationByHandle on vista and fall
527	* back on NtQueryVolumeInformationFile(,,,, FileFsAttributeInformation) else where, and
528	* check for known file system names. (For LAN shares we'll have to figure out the remote
529	* file system.) */
530	return VERR_NOT_IMPLEMENTED;
531	}
532
533
534	RTR3DECL(bool) RTFileIsValid(RTFILE File)
535	{
536	if (File != NIL_RTFILE)
537	{
538	DWORD dwType = GetFileType((HANDLE)File);
539	switch (dwType)
540	{
541	case FILE_TYPE_CHAR:
542	case FILE_TYPE_DISK:
543	case FILE_TYPE_PIPE:
544	case FILE_TYPE_REMOTE:
545	return true;
546
547	case FILE_TYPE_UNKNOWN:
548	if (GetLastError() == NO_ERROR)
549	return true;
550	break;
551	}
552	}
553	return false;
554	}
555
556
557	#define LOW_DWORD(u64) ((DWORD)u64)
558	#define HIGH_DWORD(u64) (((DWORD *)&u64)[1])
559
560	RTR3DECL(int) RTFileLock(RTFILE File, unsigned fLock, int64_t offLock, uint64_t cbLock)
561	{
562	Assert(offLock >= 0);
563
564	/* Check arguments. */
565	if (fLock & ~RTFILE_LOCK_MASK)
566	{
567	AssertMsgFailed(("Invalid fLock=%08X\n", fLock));
568	return VERR_INVALID_PARAMETER;
569	}
570
571	/* Prepare flags. */
572	Assert(RTFILE_LOCK_WRITE);
573	DWORD dwFlags = (fLock & RTFILE_LOCK_WRITE) ? LOCKFILE_EXCLUSIVE_LOCK : 0;
574	Assert(RTFILE_LOCK_WAIT);
575	if (!(fLock & RTFILE_LOCK_WAIT))
576	dwFlags \|= LOCKFILE_FAIL_IMMEDIATELY;
577
578	/* Windows structure. */
579	OVERLAPPED Overlapped;
580	memset(&Overlapped, 0, sizeof(Overlapped));
581	Overlapped.Offset = LOW_DWORD(offLock);
582	Overlapped.OffsetHigh = HIGH_DWORD(offLock);
583
584	/* Note: according to Microsoft, LockFileEx API call is available starting from NT 3.5 */
585	if (LockFileEx((HANDLE)File, dwFlags, 0, LOW_DWORD(cbLock), HIGH_DWORD(cbLock), &Overlapped))
586	return VINF_SUCCESS;
587
588	return RTErrConvertFromWin32(GetLastError());
589	}
590
591
592	RTR3DECL(int) RTFileChangeLock(RTFILE File, unsigned fLock, int64_t offLock, uint64_t cbLock)
593	{
594	Assert(offLock >= 0);
595
596	/* Check arguments. */
597	if (fLock & ~RTFILE_LOCK_MASK)
598	{
599	AssertMsgFailed(("Invalid fLock=%08X\n", fLock));
600	return VERR_INVALID_PARAMETER;
601	}
602
603	/* Remove old lock. */
604	int rc = RTFileUnlock(File, offLock, cbLock);
605	if (RT_FAILURE(rc))
606	return rc;
607
608	/* Set new lock. */
609	rc = RTFileLock(File, fLock, offLock, cbLock);
610	if (RT_SUCCESS(rc))
611	return rc;
612
613	/* Try to restore old lock. */
614	unsigned fLockOld = (fLock & RTFILE_LOCK_WRITE) ? fLock & ~RTFILE_LOCK_WRITE : fLock \| RTFILE_LOCK_WRITE;
615	rc = RTFileLock(File, fLockOld, offLock, cbLock);
616	if (RT_SUCCESS(rc))
617	return VERR_FILE_LOCK_VIOLATION;
618	else
619	return VERR_FILE_LOCK_LOST;
620	}
621
622
623	RTR3DECL(int) RTFileUnlock(RTFILE File, int64_t offLock, uint64_t cbLock)
624	{
625	Assert(offLock >= 0);
626
627	if (UnlockFile((HANDLE)File, LOW_DWORD(offLock), HIGH_DWORD(offLock), LOW_DWORD(cbLock), HIGH_DWORD(cbLock)))
628	return VINF_SUCCESS;
629
630	return RTErrConvertFromWin32(GetLastError());
631	}
632
633
634
635	RTR3DECL(int) RTFileQueryInfo(RTFILE File, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAdditionalAttribs)
636	{
637	/*
638	* Validate input.
639	*/
640	if (File == NIL_RTFILE)
641	{
642	AssertMsgFailed(("Invalid File=%RTfile\n", File));
643	return VERR_INVALID_PARAMETER;
644	}
645	if (!pObjInfo)
646	{
647	AssertMsgFailed(("Invalid pObjInfo=%p\n", pObjInfo));
648	return VERR_INVALID_PARAMETER;
649	}
650	if ( enmAdditionalAttribs < RTFSOBJATTRADD_NOTHING
651	\|\| enmAdditionalAttribs > RTFSOBJATTRADD_LAST)
652	{
653	AssertMsgFailed(("Invalid enmAdditionalAttribs=%p\n", enmAdditionalAttribs));
654	return VERR_INVALID_PARAMETER;
655	}
656
657	/*
658	* Query file info.
659	*/
660	BY_HANDLE_FILE_INFORMATION Data;
661	if (!GetFileInformationByHandle((HANDLE)File, &Data))
662	return RTErrConvertFromWin32(GetLastError());
663
664	/*
665	* Setup the returned data.
666	*/
667	pObjInfo->cbObject = ((uint64_t)Data.nFileSizeHigh << 32)
668	\| (uint64_t)Data.nFileSizeLow;
669	pObjInfo->cbAllocated = pObjInfo->cbObject;
670
671	Assert(sizeof(uint64_t) == sizeof(Data.ftCreationTime));
672	RTTimeSpecSetNtTime(&pObjInfo->BirthTime, (uint64_t )&Data.ftCreationTime);
673	RTTimeSpecSetNtTime(&pObjInfo->AccessTime, (uint64_t )&Data.ftLastAccessTime);
674	RTTimeSpecSetNtTime(&pObjInfo->ModificationTime, (uint64_t )&Data.ftLastWriteTime);
675	pObjInfo->ChangeTime = pObjInfo->ModificationTime;
676
677	pObjInfo->Attr.fMode = rtFsModeFromDos((Data.dwFileAttributes << RTFS_DOS_SHIFT) & RTFS_DOS_MASK_NT, "", 0);
678
679	/*
680	* Requested attributes (we cannot provide anything actually).
681	*/
682	switch (enmAdditionalAttribs)
683	{
684	case RTFSOBJATTRADD_NOTHING:
685	pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_NOTHING;
686	break;
687
688	case RTFSOBJATTRADD_UNIX:
689	pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_UNIX;
690	pObjInfo->Attr.u.Unix.uid = ~0U;
691	pObjInfo->Attr.u.Unix.gid = ~0U;
692	pObjInfo->Attr.u.Unix.cHardlinks = Data.nNumberOfLinks ? Data.nNumberOfLinks : 1;
693	pObjInfo->Attr.u.Unix.INodeIdDevice = 0; /** @todo Use the volume serial number (see GetFileInformationByHandle). */
694	pObjInfo->Attr.u.Unix.INodeId = 0; /** @todo Use the fileid (see GetFileInformationByHandle). */
695	pObjInfo->Attr.u.Unix.fFlags = 0;
696	pObjInfo->Attr.u.Unix.GenerationId = 0;
697	pObjInfo->Attr.u.Unix.Device = 0;
698	break;
699
700	case RTFSOBJATTRADD_UNIX_OWNER:
701	pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_UNIX_OWNER;
702	pObjInfo->Attr.u.UnixOwner.uid = ~0U;
703	pObjInfo->Attr.u.UnixOwner.szName[0] = '\0'; /** @todo return something sensible here. */
704	break;
705
706	case RTFSOBJATTRADD_UNIX_GROUP:
707	pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_UNIX_GROUP;
708	pObjInfo->Attr.u.UnixGroup.gid = ~0U;
709	pObjInfo->Attr.u.UnixGroup.szName[0] = '\0';
710	break;
711
712	case RTFSOBJATTRADD_EASIZE:
713	pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_EASIZE;
714	pObjInfo->Attr.u.EASize.cb = 0;
715	break;
716
717	default:
718	AssertMsgFailed(("Impossible!\n"));
719	return VERR_INTERNAL_ERROR;
720	}
721
722	return VINF_SUCCESS;
723	}
724
725
726	RTR3DECL(int) RTFileSetTimes(RTFILE File, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
727	PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime)
728	{
729	if (!pAccessTime && !pModificationTime && !pBirthTime)
730	return VINF_SUCCESS; /* NOP */
731
732	FILETIME CreationTimeFT;
733	PFILETIME pCreationTimeFT = NULL;
734	if (pBirthTime)
735	pCreationTimeFT = RTTimeSpecGetNtFileTime(pBirthTime, &CreationTimeFT);
736
737	FILETIME LastAccessTimeFT;
738	PFILETIME pLastAccessTimeFT = NULL;
739	if (pAccessTime)
740	pLastAccessTimeFT = RTTimeSpecGetNtFileTime(pAccessTime, &LastAccessTimeFT);
741
742	FILETIME LastWriteTimeFT;
743	PFILETIME pLastWriteTimeFT = NULL;
744	if (pModificationTime)
745	pLastWriteTimeFT = RTTimeSpecGetNtFileTime(pModificationTime, &LastWriteTimeFT);
746
747	int rc = VINF_SUCCESS;
748	if (!SetFileTime((HANDLE)File, pCreationTimeFT, pLastAccessTimeFT, pLastWriteTimeFT))
749	{
750	DWORD Err = GetLastError();
751	rc = RTErrConvertFromWin32(Err);
752	Log(("RTFileSetTimes(%RTfile, %p, %p, %p, %p): SetFileTime failed with lasterr %d (%Rrc)\n",
753	File, pAccessTime, pModificationTime, pChangeTime, pBirthTime, Err, rc));
754	}
755	return rc;
756	}
757
758
759	/* This comes from a source file with a different set of system headers (DDK)
760	* so it can't be declared in a common header, like internal/file.h.
761	*/
762	extern int rtFileNativeSetAttributes(HANDLE FileHandle, ULONG FileAttributes);
763
764
765	RTR3DECL(int) RTFileSetMode(RTFILE File, RTFMODE fMode)
766	{
767	/*
768	* Normalize the mode and call the API.
769	*/
770	fMode = rtFsModeNormalize(fMode, NULL, 0);
771	if (!rtFsModeIsValid(fMode))
772	return VERR_INVALID_PARAMETER;
773
774	ULONG FileAttributes = (fMode & RTFS_DOS_MASK) >> RTFS_DOS_SHIFT;
775	int Err = rtFileNativeSetAttributes((HANDLE)File, FileAttributes);
776	if (Err != ERROR_SUCCESS)
777	{
778	int rc = RTErrConvertFromWin32(Err);
779	Log(("RTFileSetMode(%RTfile, %RTfmode): rtFileNativeSetAttributes (0x%08X) failed with err %d (%Rrc)\n",
780	File, fMode, FileAttributes, Err, rc));
781	return rc;
782	}
783	return VINF_SUCCESS;
784	}
785
786
787	RTR3DECL(int) RTFileQueryFsSizes(RTFILE hFile, PRTFOFF pcbTotal, RTFOFF *pcbFree,
788	uint32_t pcbBlock, uint32_t pcbSector)
789	{
790	/** @todo implement this using NtQueryVolumeInformationFile(hFile,,,,
791	* FileFsSizeInformation). */
792	return VERR_NOT_SUPPORTED;
793	}
794
795
796	RTR3DECL(int) RTFileDelete(const char *pszFilename)
797	{
798	PRTUTF16 pwszFilename;
799	int rc = RTStrToUtf16(pszFilename, &pwszFilename);
800	if (RT_SUCCESS(rc))
801	{
802	if (!DeleteFileW(pwszFilename))
803	rc = RTErrConvertFromWin32(GetLastError());
804	RTUtf16Free(pwszFilename);
805	}
806
807	return rc;
808	}
809
810
811	RTDECL(int) RTFileRename(const char pszSrc, const char pszDst, unsigned fRename)
812	{
813	/*
814	* Validate input.
815	*/
816	AssertMsgReturn(VALID_PTR(pszSrc), ("%p\n", pszSrc), VERR_INVALID_POINTER);
817	AssertMsgReturn(VALID_PTR(pszDst), ("%p\n", pszDst), VERR_INVALID_POINTER);
818	AssertMsgReturn(!(fRename & ~RTPATHRENAME_FLAGS_REPLACE), ("%#x\n", fRename), VERR_INVALID_PARAMETER);
819
820	/*
821	* Hand it on to the worker.
822	*/
823	int rc = rtPathWin32MoveRename(pszSrc, pszDst,
824	fRename & RTPATHRENAME_FLAGS_REPLACE ? MOVEFILE_REPLACE_EXISTING : 0,
825	RTFS_TYPE_FILE);
826
827	LogFlow(("RTFileMove(%p:{%s}, %p:{%s}, %#x): returns %Rrc\n",
828	pszSrc, pszSrc, pszDst, pszDst, fRename, rc));
829	return rc;
830
831	}
832
833
834	RTDECL(int) RTFileMove(const char pszSrc, const char pszDst, unsigned fMove)
835	{
836	/*
837	* Validate input.
838	*/
839	AssertMsgReturn(VALID_PTR(pszSrc), ("%p\n", pszSrc), VERR_INVALID_POINTER);
840	AssertMsgReturn(VALID_PTR(pszDst), ("%p\n", pszDst), VERR_INVALID_POINTER);
841	AssertMsgReturn(!(fMove & ~RTFILEMOVE_FLAGS_REPLACE), ("%#x\n", fMove), VERR_INVALID_PARAMETER);
842
843	/*
844	* Hand it on to the worker.
845	*/
846	int rc = rtPathWin32MoveRename(pszSrc, pszDst,
847	fMove & RTFILEMOVE_FLAGS_REPLACE
848	? MOVEFILE_COPY_ALLOWED \| MOVEFILE_REPLACE_EXISTING
849	: MOVEFILE_COPY_ALLOWED,
850	RTFS_TYPE_FILE);
851
852	LogFlow(("RTFileMove(%p:{%s}, %p:{%s}, %#x): returns %Rrc\n",
853	pszSrc, pszSrc, pszDst, pszDst, fMove, rc));
854	return rc;
855	}
856

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

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

Download in other formats: