fileio-win.cpp@ 23302

Last change on this file since 23302 was 23302, checked in by vboxsync, 16 years ago
IPRT: r52791 repated for RTFileExists.
Property svn:eol-style set to `native` Property svn:keywords set to `Id`
File size: 27.7 KB

Line
1	/* $Id: fileio-win.cpp 23302 2009-09-24 17:00:38Z 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, unsigned 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
222	/* RTFileSetMode needs following rights as well. */
223	switch (fOpen & RTFILE_O_ACCESS_ATTR_MASK)
224	{
225	case RTFILE_O_ACCESS_ATTR_READ: dwDesiredAccess \|= FILE_READ_ATTRIBUTES \| SYNCHRONIZE; break;
226	case RTFILE_O_ACCESS_ATTR_WRITE: dwDesiredAccess \|= FILE_WRITE_ATTRIBUTES \| SYNCHRONIZE; break;
227	case RTFILE_O_ACCESS_ATTR_READWRITE: dwDesiredAccess \|= FILE_READ_ATTRIBUTES \| FILE_WRITE_ATTRIBUTES \| SYNCHRONIZE; break;
228	default:
229	/* Attributes access is the same as the file access. */
230	switch (fOpen & RTFILE_O_ACCESS_MASK)
231	{
232	case RTFILE_O_READ: dwDesiredAccess \|= FILE_READ_ATTRIBUTES \| SYNCHRONIZE; break;
233	case RTFILE_O_WRITE: dwDesiredAccess \|= FILE_WRITE_ATTRIBUTES \| SYNCHRONIZE; break;
234	case RTFILE_O_READWRITE: dwDesiredAccess \|= FILE_READ_ATTRIBUTES \| FILE_WRITE_ATTRIBUTES \| SYNCHRONIZE; break;
235	default:
236	AssertMsgFailed(("Impossible fOpen=%#x\n", fOpen));
237	return VERR_INVALID_PARAMETER;
238	}
239	}
240
241	DWORD dwShareMode;
242	Assert(RTFILE_O_DENY_READWRITE == RTFILE_O_DENY_ALL && !RTFILE_O_DENY_NONE);
243	switch (fOpen & RTFILE_O_DENY_MASK)
244	{
245	case RTFILE_O_DENY_NONE: dwShareMode = FILE_SHARE_READ \| FILE_SHARE_WRITE; break;
246	case RTFILE_O_DENY_READ: dwShareMode = FILE_SHARE_WRITE; break;
247	case RTFILE_O_DENY_WRITE: dwShareMode = FILE_SHARE_READ; break;
248	case RTFILE_O_DENY_READWRITE: dwShareMode = 0; break;
249
250	case RTFILE_O_DENY_NOT_DELETE \| RTFILE_O_DENY_NONE: dwShareMode = FILE_SHARE_DELETE \| FILE_SHARE_READ \| FILE_SHARE_WRITE; break;
251	case RTFILE_O_DENY_NOT_DELETE \| RTFILE_O_DENY_READ: dwShareMode = FILE_SHARE_DELETE \| FILE_SHARE_WRITE; break;
252	case RTFILE_O_DENY_NOT_DELETE \| RTFILE_O_DENY_WRITE: dwShareMode = FILE_SHARE_DELETE \| FILE_SHARE_READ; break;
253	case RTFILE_O_DENY_NOT_DELETE \| RTFILE_O_DENY_READWRITE:dwShareMode = FILE_SHARE_DELETE; break;
254	default:
255	AssertMsgFailed(("Impossible fOpen=%#x\n", fOpen));
256	return VERR_INVALID_PARAMETER;
257	}
258
259	SECURITY_ATTRIBUTES SecurityAttributes;
260	PSECURITY_ATTRIBUTES pSecurityAttributes = NULL;
261	if (fOpen & RTFILE_O_INHERIT)
262	{
263	SecurityAttributes.nLength = sizeof(SecurityAttributes);
264	SecurityAttributes.lpSecurityDescriptor = NULL;
265	SecurityAttributes.bInheritHandle = TRUE;
266	pSecurityAttributes = &SecurityAttributes;
267	}
268
269	DWORD dwFlagsAndAttributes;
270	dwFlagsAndAttributes = FILE_ATTRIBUTE_NORMAL;
271	if (fOpen & RTFILE_O_WRITE_THROUGH)
272	dwFlagsAndAttributes \|= FILE_FLAG_WRITE_THROUGH;
273	if (fOpen & RTFILE_O_ASYNC_IO)
274	dwFlagsAndAttributes \|= FILE_FLAG_OVERLAPPED;
275	if (fOpen & RTFILE_O_NO_CACHE)
276	{
277	dwFlagsAndAttributes \|= FILE_FLAG_NO_BUFFERING;
278	dwDesiredAccess &= ~FILE_APPEND_DATA;
279	}
280
281	/*
282	* Open/Create the file.
283	*/
284	#ifdef RT_DONT_CONVERT_FILENAMES
285	HANDLE hFile = CreateFile(pszFilename,
286	dwDesiredAccess,
287	dwShareMode,
288	pSecurityAttributes,
289	dwCreationDisposition,
290	dwFlagsAndAttributes,
291	NULL);
292	#else
293	PRTUTF16 pwszFilename;
294	rc = RTStrToUtf16(pszFilename, &pwszFilename);
295	if (RT_FAILURE(rc))
296	return rc;
297
298	HANDLE hFile = CreateFileW(pwszFilename,
299	dwDesiredAccess,
300	dwShareMode,
301	pSecurityAttributes,
302	dwCreationDisposition,
303	dwFlagsAndAttributes,
304	NULL);
305	#endif
306	if (hFile != INVALID_HANDLE_VALUE)
307	{
308	bool fCreated = dwCreationDisposition == CREATE_ALWAYS
309	\|\| dwCreationDisposition == CREATE_NEW
310	\|\| (dwCreationDisposition == OPEN_ALWAYS && GetLastError() == 0);
311
312	/*
313	* Turn off indexing of directory through Windows Indexing Service.
314	*/
315	if ( fCreated
316	&& (fOpen & RTFILE_O_NOT_CONTENT_INDEXED))
317	{
318	#ifdef RT_DONT_CONVERT_FILENAMES
319	if (!SetFileAttributes(pszFilename, FILE_ATTRIBUTE_NOT_CONTENT_INDEXED))
320	#else
321	if (!SetFileAttributesW(pwszFilename, FILE_ATTRIBUTE_NOT_CONTENT_INDEXED))
322	#endif
323	rc = RTErrConvertFromWin32(GetLastError());
324	}
325	/*
326	* Do we need to truncate the file?
327	*/
328	else if ( !fCreated
329	&& (fOpen & (RTFILE_O_TRUNCATE \| RTFILE_O_ACTION_MASK))
330	== (RTFILE_O_TRUNCATE \| RTFILE_O_OPEN_CREATE))
331	{
332	if (!SetEndOfFile(hFile))
333	rc = RTErrConvertFromWin32(GetLastError());
334	}
335	if (RT_SUCCESS(rc))
336	{
337	*pFile = (RTFILE)hFile;
338	Assert((HANDLE)*pFile == hFile);
339	#ifndef RT_DONT_CONVERT_FILENAMES
340	RTUtf16Free(pwszFilename);
341	#endif
342	return VINF_SUCCESS;
343	}
344
345	CloseHandle(hFile);
346	}
347	else
348	rc = RTErrConvertFromWin32(GetLastError());
349	#ifndef RT_DONT_CONVERT_FILENAMES
350	RTUtf16Free(pwszFilename);
351	#endif
352	return rc;
353	}
354
355
356	RTR3DECL(int) RTFileClose(RTFILE File)
357	{
358	if (CloseHandle((HANDLE)File))
359	return VINF_SUCCESS;
360	return RTErrConvertFromWin32(GetLastError());
361	}
362
363
364	RTR3DECL(int) RTFileSeek(RTFILE File, int64_t offSeek, unsigned uMethod, uint64_t *poffActual)
365	{
366	static ULONG aulSeekRecode[] =
367	{
368	FILE_BEGIN,
369	FILE_CURRENT,
370	FILE_END,
371	};
372
373	/*
374	* Validate input.
375	*/
376	if (uMethod > RTFILE_SEEK_END)
377	{
378	AssertMsgFailed(("Invalid uMethod=%d\n", uMethod));
379	return VERR_INVALID_PARAMETER;
380	}
381
382	/*
383	* Execute the seek.
384	*/
385	if (MySetFilePointer(File, offSeek, poffActual, aulSeekRecode[uMethod]))
386	return VINF_SUCCESS;
387	return RTErrConvertFromWin32(GetLastError());
388	}
389
390
391	RTR3DECL(int) RTFileRead(RTFILE File, void pvBuf, size_t cbToRead, size_t pcbRead)
392	{
393	if (cbToRead <= 0)
394	return VINF_SUCCESS;
395	ULONG cbToReadAdj = (ULONG)cbToRead;
396	AssertReturn(cbToReadAdj == cbToRead, VERR_NUMBER_TOO_BIG);
397
398	ULONG cbRead = 0;
399	if (ReadFile((HANDLE)File, pvBuf, cbToReadAdj, &cbRead, NULL))
400	{
401	if (pcbRead)
402	/* Caller can handle partial reads. */
403	*pcbRead = cbRead;
404	else
405	{
406	/* Caller expects everything to be read. */
407	while (cbToReadAdj > cbRead)
408	{
409	ULONG cbReadPart = 0;
410	if (!ReadFile((HANDLE)File, (char*)pvBuf + cbRead, cbToReadAdj - cbRead, &cbReadPart, NULL))
411	return RTErrConvertFromWin32(GetLastError());
412	if (cbReadPart == 0)
413	return VERR_EOF;
414	cbRead += cbReadPart;
415	}
416	}
417	return VINF_SUCCESS;
418	}
419	return RTErrConvertFromWin32(GetLastError());
420	}
421
422
423	RTR3DECL(int) RTFileWrite(RTFILE File, const void pvBuf, size_t cbToWrite, size_t pcbWritten)
424	{
425	if (cbToWrite <= 0)
426	return VINF_SUCCESS;
427	ULONG cbToWriteAdj = (ULONG)cbToWrite;
428	AssertReturn(cbToWriteAdj == cbToWrite, VERR_NUMBER_TOO_BIG);
429
430	ULONG cbWritten = 0;
431	if (WriteFile((HANDLE)File, pvBuf, cbToWriteAdj, &cbWritten, NULL))
432	{
433	if (pcbWritten)
434	/* Caller can handle partial writes. */
435	*pcbWritten = cbWritten;
436	else
437	{
438	/* Caller expects everything to be written. */
439	while (cbToWriteAdj > cbWritten)
440	{
441	ULONG cbWrittenPart = 0;
442	if (!WriteFile((HANDLE)File, (char*)pvBuf + cbWritten, cbToWriteAdj - cbWritten, &cbWrittenPart, NULL))
443	{
444	int rc = RTErrConvertFromWin32(GetLastError());
445	if ( rc == VERR_DISK_FULL
446	&& IsBeyondLimit(File, cbToWriteAdj - cbWritten, FILE_CURRENT)
447	)
448	rc = VERR_FILE_TOO_BIG;
449	return rc;
450	}
451	if (cbWrittenPart == 0)
452	return VERR_WRITE_ERROR;
453	cbWritten += cbWrittenPart;
454	}
455	}
456	return VINF_SUCCESS;
457	}
458	int rc = RTErrConvertFromWin32(GetLastError());
459	if ( rc == VERR_DISK_FULL
460	&& IsBeyondLimit(File, cbToWriteAdj - cbWritten, FILE_CURRENT))
461	rc = VERR_FILE_TOO_BIG;
462	return rc;
463	}
464
465
466	RTR3DECL(int) RTFileFlush(RTFILE File)
467	{
468	int rc;
469
470	if (FlushFileBuffers((HANDLE)File) == FALSE)
471	{
472	rc = GetLastError();
473	Log(("FlushFileBuffers failed with %d\n", rc));
474	return RTErrConvertFromWin32(rc);
475	}
476	return VINF_SUCCESS;
477	}
478
479
480	RTR3DECL(int) RTFileSetSize(RTFILE File, uint64_t cbSize)
481	{
482	/*
483	* Get current file pointer.
484	*/
485	int rc;
486	uint64_t offCurrent;
487	if (MySetFilePointer(File, 0, &offCurrent, FILE_CURRENT))
488	{
489	/*
490	* Set new file pointer.
491	*/
492	if (MySetFilePointer(File, cbSize, NULL, FILE_BEGIN))
493	{
494	/* file pointer setted */
495	if (SetEndOfFile((HANDLE)File))
496	{
497	/*
498	* Restore file pointer and return.
499	* If the old pointer was beyond the new file end, ignore failure.
500	*/
501	if ( MySetFilePointer(File, offCurrent, NULL, FILE_BEGIN)
502	\|\| offCurrent > cbSize)
503	return VINF_SUCCESS;
504	}
505
506	/*
507	* Failed, try restore file pointer.
508	*/
509	rc = GetLastError();
510	MySetFilePointer(File, offCurrent, NULL, FILE_BEGIN);
511	}
512	else
513	rc = GetLastError();
514	}
515	else
516	rc = GetLastError();
517
518	return RTErrConvertFromWin32(rc);
519	}
520
521
522	RTR3DECL(int) RTFileGetSize(RTFILE File, uint64_t *pcbSize)
523	{
524	ULARGE_INTEGER Size;
525	Size.LowPart = GetFileSize((HANDLE)File, &Size.HighPart);
526	if (Size.LowPart != INVALID_FILE_SIZE)
527	{
528	*pcbSize = Size.QuadPart;
529	return VINF_SUCCESS;
530	}
531
532	/* error exit */
533	return RTErrConvertFromWin32(GetLastError());
534	}
535
536
537	RTR3DECL(int) RTFileGetMaxSizeEx(RTFILE File, PRTFOFF pcbMax)
538	{
539	/** @todo r=bird:
540	* We might have to make this code OS specific...
541	* In the worse case, we'll have to try GetVolumeInformationByHandle on vista and fall
542	* back on NtQueryVolumeInformationFile(,,,, FileFsAttributeInformation) else where, and
543	* check for known file system names. (For LAN shares we'll have to figure out the remote
544	* file system.) */
545	return VERR_NOT_IMPLEMENTED;
546	}
547
548
549	RTR3DECL(bool) RTFileIsValid(RTFILE File)
550	{
551	if (File != NIL_RTFILE)
552	{
553	DWORD dwType = GetFileType((HANDLE)File);
554	switch (dwType)
555	{
556	case FILE_TYPE_CHAR:
557	case FILE_TYPE_DISK:
558	case FILE_TYPE_PIPE:
559	case FILE_TYPE_REMOTE:
560	return true;
561
562	case FILE_TYPE_UNKNOWN:
563	if (GetLastError() == NO_ERROR)
564	return true;
565	break;
566	}
567	}
568	return false;
569	}
570
571
572	#define LOW_DWORD(u64) ((DWORD)u64)
573	#define HIGH_DWORD(u64) (((DWORD *)&u64)[1])
574
575	RTR3DECL(int) RTFileLock(RTFILE File, unsigned fLock, int64_t offLock, uint64_t cbLock)
576	{
577	Assert(offLock >= 0);
578
579	/* Check arguments. */
580	if (fLock & ~RTFILE_LOCK_MASK)
581	{
582	AssertMsgFailed(("Invalid fLock=%08X\n", fLock));
583	return VERR_INVALID_PARAMETER;
584	}
585
586	/* Prepare flags. */
587	Assert(RTFILE_LOCK_WRITE);
588	DWORD dwFlags = (fLock & RTFILE_LOCK_WRITE) ? LOCKFILE_EXCLUSIVE_LOCK : 0;
589	Assert(RTFILE_LOCK_WAIT);
590	if (!(fLock & RTFILE_LOCK_WAIT))
591	dwFlags \|= LOCKFILE_FAIL_IMMEDIATELY;
592
593	/* Windows structure. */
594	OVERLAPPED Overlapped;
595	memset(&Overlapped, 0, sizeof(Overlapped));
596	Overlapped.Offset = LOW_DWORD(offLock);
597	Overlapped.OffsetHigh = HIGH_DWORD(offLock);
598
599	/* Note: according to Microsoft, LockFileEx API call is available starting from NT 3.5 */
600	if (LockFileEx((HANDLE)File, dwFlags, 0, LOW_DWORD(cbLock), HIGH_DWORD(cbLock), &Overlapped))
601	return VINF_SUCCESS;
602
603	return RTErrConvertFromWin32(GetLastError());
604	}
605
606
607	RTR3DECL(int) RTFileChangeLock(RTFILE File, unsigned fLock, int64_t offLock, uint64_t cbLock)
608	{
609	Assert(offLock >= 0);
610
611	/* Check arguments. */
612	if (fLock & ~RTFILE_LOCK_MASK)
613	{
614	AssertMsgFailed(("Invalid fLock=%08X\n", fLock));
615	return VERR_INVALID_PARAMETER;
616	}
617
618	/* Remove old lock. */
619	int rc = RTFileUnlock(File, offLock, cbLock);
620	if (RT_FAILURE(rc))
621	return rc;
622
623	/* Set new lock. */
624	rc = RTFileLock(File, fLock, offLock, cbLock);
625	if (RT_SUCCESS(rc))
626	return rc;
627
628	/* Try to restore old lock. */
629	unsigned fLockOld = (fLock & RTFILE_LOCK_WRITE) ? fLock & ~RTFILE_LOCK_WRITE : fLock \| RTFILE_LOCK_WRITE;
630	rc = RTFileLock(File, fLockOld, offLock, cbLock);
631	if (RT_SUCCESS(rc))
632	return VERR_FILE_LOCK_VIOLATION;
633	else
634	return VERR_FILE_LOCK_LOST;
635	}
636
637
638	RTR3DECL(int) RTFileUnlock(RTFILE File, int64_t offLock, uint64_t cbLock)
639	{
640	Assert(offLock >= 0);
641
642	if (UnlockFile((HANDLE)File, LOW_DWORD(offLock), HIGH_DWORD(offLock), LOW_DWORD(cbLock), HIGH_DWORD(cbLock)))
643	return VINF_SUCCESS;
644
645	return RTErrConvertFromWin32(GetLastError());
646	}
647
648
649
650	RTR3DECL(int) RTFileQueryInfo(RTFILE File, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAdditionalAttribs)
651	{
652	/*
653	* Validate input.
654	*/
655	if (File == NIL_RTFILE)
656	{
657	AssertMsgFailed(("Invalid File=%RTfile\n", File));
658	return VERR_INVALID_PARAMETER;
659	}
660	if (!pObjInfo)
661	{
662	AssertMsgFailed(("Invalid pObjInfo=%p\n", pObjInfo));
663	return VERR_INVALID_PARAMETER;
664	}
665	if ( enmAdditionalAttribs < RTFSOBJATTRADD_NOTHING
666	\|\| enmAdditionalAttribs > RTFSOBJATTRADD_LAST)
667	{
668	AssertMsgFailed(("Invalid enmAdditionalAttribs=%p\n", enmAdditionalAttribs));
669	return VERR_INVALID_PARAMETER;
670	}
671
672	/*
673	* Query file info.
674	*/
675	BY_HANDLE_FILE_INFORMATION Data;
676	if (!GetFileInformationByHandle((HANDLE)File, &Data))
677	return RTErrConvertFromWin32(GetLastError());
678
679	/*
680	* Setup the returned data.
681	*/
682	pObjInfo->cbObject = ((uint64_t)Data.nFileSizeHigh << 32)
683	\| (uint64_t)Data.nFileSizeLow;
684	pObjInfo->cbAllocated = pObjInfo->cbObject;
685
686	Assert(sizeof(uint64_t) == sizeof(Data.ftCreationTime));
687	RTTimeSpecSetNtTime(&pObjInfo->BirthTime, (uint64_t )&Data.ftCreationTime);
688	RTTimeSpecSetNtTime(&pObjInfo->AccessTime, (uint64_t )&Data.ftLastAccessTime);
689	RTTimeSpecSetNtTime(&pObjInfo->ModificationTime, (uint64_t )&Data.ftLastWriteTime);
690	pObjInfo->ChangeTime = pObjInfo->ModificationTime;
691
692	pObjInfo->Attr.fMode = rtFsModeFromDos((Data.dwFileAttributes << RTFS_DOS_SHIFT) & RTFS_DOS_MASK_NT, "", 0);
693
694	/*
695	* Requested attributes (we cannot provide anything actually).
696	*/
697	switch (enmAdditionalAttribs)
698	{
699	case RTFSOBJATTRADD_EASIZE:
700	pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_EASIZE;
701	pObjInfo->Attr.u.EASize.cb = 0;
702	break;
703
704	case RTFSOBJATTRADD_UNIX:
705	pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_UNIX;
706	pObjInfo->Attr.u.Unix.uid = ~0U;
707	pObjInfo->Attr.u.Unix.gid = ~0U;
708	pObjInfo->Attr.u.Unix.cHardlinks = Data.nNumberOfLinks ? Data.nNumberOfLinks : 1;
709	pObjInfo->Attr.u.Unix.INodeIdDevice = 0; /** @todo Use the volume serial number (see GetFileInformationByHandle). */
710	pObjInfo->Attr.u.Unix.INodeId = 0; /** @todo Use the fileid (see GetFileInformationByHandle). */
711	pObjInfo->Attr.u.Unix.fFlags = 0;
712	pObjInfo->Attr.u.Unix.GenerationId = 0;
713	pObjInfo->Attr.u.Unix.Device = 0;
714	break;
715
716	case RTFSOBJATTRADD_NOTHING:
717	pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_NOTHING;
718	break;
719
720	default:
721	AssertMsgFailed(("Impossible!\n"));
722	return VERR_INTERNAL_ERROR;
723	}
724
725	return VINF_SUCCESS;
726	}
727
728
729	RTR3DECL(int) RTFileSetTimes(RTFILE File, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
730	PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime)
731	{
732	if (!pAccessTime && !pModificationTime && !pBirthTime)
733	return VINF_SUCCESS; /* NOP */
734
735	FILETIME CreationTimeFT;
736	PFILETIME pCreationTimeFT = NULL;
737	if (pBirthTime)
738	pCreationTimeFT = RTTimeSpecGetNtFileTime(pBirthTime, &CreationTimeFT);
739
740	FILETIME LastAccessTimeFT;
741	PFILETIME pLastAccessTimeFT = NULL;
742	if (pAccessTime)
743	pLastAccessTimeFT = RTTimeSpecGetNtFileTime(pAccessTime, &LastAccessTimeFT);
744
745	FILETIME LastWriteTimeFT;
746	PFILETIME pLastWriteTimeFT = NULL;
747	if (pModificationTime)
748	pLastWriteTimeFT = RTTimeSpecGetNtFileTime(pModificationTime, &LastWriteTimeFT);
749
750	int rc = VINF_SUCCESS;
751	if (!SetFileTime((HANDLE)File, pCreationTimeFT, pLastAccessTimeFT, pLastWriteTimeFT))
752	{
753	DWORD Err = GetLastError();
754	rc = RTErrConvertFromWin32(Err);
755	Log(("RTFileSetTimes(%RTfile, %p, %p, %p, %p): SetFileTime failed with lasterr %d (%Rrc)\n",
756	File, pAccessTime, pModificationTime, pChangeTime, pBirthTime, Err, rc));
757	}
758	return rc;
759	}
760
761
762	/* This comes from a source file with a different set of system headers (DDK)
763	* so it can't be declared in a common header, like internal/file.h.
764	*/
765	extern int rtFileNativeSetAttributes(HANDLE FileHandle, ULONG FileAttributes);
766
767
768	RTR3DECL(int) RTFileSetMode(RTFILE File, RTFMODE fMode)
769	{
770	/*
771	* Normalize the mode and call the API.
772	*/
773	fMode = rtFsModeNormalize(fMode, NULL, 0);
774	if (!rtFsModeIsValid(fMode))
775	return VERR_INVALID_PARAMETER;
776
777	ULONG FileAttributes = (fMode & RTFS_DOS_MASK) >> RTFS_DOS_SHIFT;
778	int Err = rtFileNativeSetAttributes((HANDLE)File, FileAttributes);
779	if (Err != ERROR_SUCCESS)
780	{
781	int rc = RTErrConvertFromWin32(Err);
782	Log(("RTFileSetMode(%RTfile, %RTfmode): rtFileNativeSetAttributes (0x%08X) failed with err %d (%Rrc)\n",
783	File, fMode, FileAttributes, Err, rc));
784	return rc;
785	}
786	return VINF_SUCCESS;
787	}
788
789
790	RTR3DECL(int) RTFileDelete(const char *pszFilename)
791	{
792	#ifdef RT_DONT_CONVERT_FILENAMES
793	if (DeleteFile(pszFilename))
794	return VINF_SUCCESS;
795	return RTErrConvertFromWin32(GetLastError());
796
797	#else
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	#endif
809	}
810
811
812	RTDECL(int) RTFileRename(const char pszSrc, const char pszDst, unsigned fRename)
813	{
814	/*
815	* Validate input.
816	*/
817	AssertMsgReturn(VALID_PTR(pszSrc), ("%p\n", pszSrc), VERR_INVALID_POINTER);
818	AssertMsgReturn(VALID_PTR(pszDst), ("%p\n", pszDst), VERR_INVALID_POINTER);
819	AssertMsgReturn(!(fRename & ~RTPATHRENAME_FLAGS_REPLACE), ("%#x\n", fRename), VERR_INVALID_PARAMETER);
820
821	/*
822	* Hand it on to the worker.
823	*/
824	int rc = rtPathWin32MoveRename(pszSrc, pszDst,
825	fRename & RTPATHRENAME_FLAGS_REPLACE ? MOVEFILE_REPLACE_EXISTING : 0,
826	RTFS_TYPE_FILE);
827
828	LogFlow(("RTFileMove(%p:{%s}, %p:{%s}, %#x): returns %Rrc\n",
829	pszSrc, pszSrc, pszDst, pszDst, fRename, rc));
830	return rc;
831
832	}
833
834
835	RTDECL(int) RTFileMove(const char pszSrc, const char pszDst, unsigned fMove)
836	{
837	/*
838	* Validate input.
839	*/
840	AssertMsgReturn(VALID_PTR(pszSrc), ("%p\n", pszSrc), VERR_INVALID_POINTER);
841	AssertMsgReturn(VALID_PTR(pszDst), ("%p\n", pszDst), VERR_INVALID_POINTER);
842	AssertMsgReturn(!(fMove & ~RTFILEMOVE_FLAGS_REPLACE), ("%#x\n", fMove), VERR_INVALID_PARAMETER);
843
844	/*
845	* Hand it on to the worker.
846	*/
847	int rc = rtPathWin32MoveRename(pszSrc, pszDst,
848	fMove & RTFILEMOVE_FLAGS_REPLACE
849	? MOVEFILE_COPY_ALLOWED \| MOVEFILE_REPLACE_EXISTING
850	: MOVEFILE_COPY_ALLOWED,
851	RTFS_TYPE_FILE);
852
853	LogFlow(("RTFileMove(%p:{%s}, %p:{%s}, %#x): returns %Rrc\n",
854	pszSrc, pszSrc, pszDst, pszDst, fMove, rc));
855	return rc;
856	}
857

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

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

Download in other formats: