VirtualBox

source: vbox/trunk/src/VBox/Runtime/r3/fileio.cpp@ 37043

Last change on this file since 37043 was 33540, checked in by vboxsync, 14 years ago

*: spelling fixes, thanks Timeless!
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 15.8 KB
Line 
1/* $Id: fileio.cpp 33540 2010-10-28 09:27:05Z vboxsync $ */
2/** @file
3 * IPRT - File I/O.
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* Header Files *
29*******************************************************************************/
30#include <iprt/file.h>
31#include <iprt/alloc.h>
32#include <iprt/assert.h>
33#include <iprt/alloca.h>
34#include <iprt/err.h>
35#include "internal/file.h"
36
37
38/*******************************************************************************
39* Global Variables *
40*******************************************************************************/
41/** Set of forced set open flags for files opened read-only. */
42static unsigned g_fOpenReadSet = 0;
43
44/** Set of forced cleared open flags for files opened read-only. */
45static unsigned g_fOpenReadMask = 0;
46
47/** Set of forced set open flags for files opened write-only. */
48static unsigned g_fOpenWriteSet = 0;
49
50/** Set of forced cleared open flags for files opened write-only. */
51static unsigned g_fOpenWriteMask = 0;
52
53/** Set of forced set open flags for files opened read-write. */
54static unsigned g_fOpenReadWriteSet = 0;
55
56/** Set of forced cleared open flags for files opened read-write. */
57static unsigned g_fOpenReadWriteMask = 0;
58
59
60/**
61 * Force the use of open flags for all files opened after the setting is
62 * changed. The caller is responsible for not causing races with RTFileOpen().
63 *
64 * @returns iprt status code.
65 * @param fOpenForAccess Access mode to which the set/mask settings apply.
66 * @param fSet Open flags to be forced set.
67 * @param fMask Open flags to be masked out.
68 */
69RTR3DECL(int) RTFileSetForceFlags(unsigned fOpenForAccess, unsigned fSet, unsigned fMask)
70{
71 /*
72 * For now allow only RTFILE_O_WRITE_THROUGH. The other flags either
73 * make no sense in this context or are not useful to apply to all files.
74 */
75 if ((fSet | fMask) & ~RTFILE_O_WRITE_THROUGH)
76 return VERR_INVALID_PARAMETER;
77 switch (fOpenForAccess)
78 {
79 case RTFILE_O_READ:
80 g_fOpenReadSet = fSet;
81 g_fOpenReadMask = fMask;
82 break;
83 case RTFILE_O_WRITE:
84 g_fOpenWriteSet = fSet;
85 g_fOpenWriteMask = fMask;
86 break;
87 case RTFILE_O_READWRITE:
88 g_fOpenReadWriteSet = fSet;
89 g_fOpenReadWriteMask = fMask;
90 break;
91 default:
92 AssertMsgFailed(("Invalid access mode %d\n", fOpenForAccess));
93 return VERR_INVALID_PARAMETER;
94 }
95 return VINF_SUCCESS;
96}
97
98
99/**
100 * Adjusts and validates the flags.
101 *
102 * The adjustments are made according to the wishes specified using the RTFileSetForceFlags API.
103 *
104 * @returns IPRT status code.
105 * @param pfOpen Pointer to the user specified flags on input.
106 * Updated on successful return.
107 * @internal
108 */
109int rtFileRecalcAndValidateFlags(uint32_t *pfOpen)
110{
111 /*
112 * Recalc.
113 */
114 uint32_t fOpen = *pfOpen;
115 switch (fOpen & RTFILE_O_ACCESS_MASK)
116 {
117 case RTFILE_O_READ:
118 fOpen |= g_fOpenReadSet;
119 fOpen &= ~g_fOpenReadMask;
120 break;
121 case RTFILE_O_WRITE:
122 fOpen |= g_fOpenWriteSet;
123 fOpen &= ~g_fOpenWriteMask;
124 break;
125 case RTFILE_O_READWRITE:
126 fOpen |= g_fOpenReadWriteSet;
127 fOpen &= ~g_fOpenReadWriteMask;
128 break;
129 default:
130 AssertMsgFailed(("Invalid RW value, fOpen=%#x\n", fOpen));
131 return VERR_INVALID_PARAMETER;
132 }
133
134 /*
135 * Validate .
136 */
137 AssertMsgReturn(fOpen & RTFILE_O_ACCESS_MASK, ("Missing RTFILE_O_READ/WRITE: fOpen=%#x\n", fOpen), VERR_INVALID_PARAMETER);
138#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
139 AssertMsgReturn(!(fOpen & (~RTFILE_O_VALID_MASK | RTFILE_O_NON_BLOCK)), ("%#x\n", fOpen), VERR_INVALID_PARAMETER);
140#else
141 AssertMsgReturn(!(fOpen & ~RTFILE_O_VALID_MASK), ("%#x\n", fOpen), VERR_INVALID_PARAMETER);
142#endif
143 AssertMsgReturn((fOpen & (RTFILE_O_TRUNCATE | RTFILE_O_WRITE)) != RTFILE_O_TRUNCATE, ("%#x\n", fOpen), VERR_INVALID_PARAMETER);
144
145 switch (fOpen & RTFILE_O_ACTION_MASK)
146 {
147 case 0: /* temporarily */
148 AssertMsgFailed(("Missing RTFILE_O_OPEN/CREATE*! (continuable assertion)\n"));
149 fOpen |= RTFILE_O_OPEN;
150 break;
151 case RTFILE_O_OPEN:
152 AssertMsgReturn(!(RTFILE_O_NOT_CONTENT_INDEXED & fOpen), ("%#x\n", fOpen), VERR_INVALID_PARAMETER);
153 case RTFILE_O_OPEN_CREATE:
154 case RTFILE_O_CREATE:
155 case RTFILE_O_CREATE_REPLACE:
156 break;
157 default:
158 AssertMsgFailed(("Invalid action value: fOpen=%#x\n", fOpen));
159 return VERR_INVALID_PARAMETER;
160 }
161
162 switch (fOpen & RTFILE_O_DENY_MASK)
163 {
164 case 0: /* temporarily */
165 AssertMsgFailed(("Missing RTFILE_O_DENY_*! (continuable assertion)\n"));
166 fOpen |= RTFILE_O_DENY_NONE;
167 break;
168 case RTFILE_O_DENY_NONE:
169 case RTFILE_O_DENY_READ:
170 case RTFILE_O_DENY_WRITE:
171 case RTFILE_O_DENY_WRITE | RTFILE_O_DENY_READ:
172 case RTFILE_O_DENY_NOT_DELETE:
173 case RTFILE_O_DENY_NOT_DELETE | RTFILE_O_DENY_READ:
174 case RTFILE_O_DENY_NOT_DELETE | RTFILE_O_DENY_WRITE:
175 case RTFILE_O_DENY_NOT_DELETE | RTFILE_O_DENY_WRITE | RTFILE_O_DENY_READ:
176 break;
177 default:
178 AssertMsgFailed(("Invalid deny value: fOpen=%#x\n", fOpen));
179 return VERR_INVALID_PARAMETER;
180 }
181
182 /* done */
183 *pfOpen = fOpen;
184 return VINF_SUCCESS;
185}
186
187
188
189/**
190 * Read bytes from a file at a given offset.
191 * This function may modify the file position.
192 *
193 * @returns iprt status code.
194 * @param File Handle to the file.
195 * @param off Where to read.
196 * @param pvBuf Where to put the bytes we read.
197 * @param cbToRead How much to read.
198 * @param *pcbRead How much we actually read.
199 * If NULL an error will be returned for a partial read.
200 */
201RTR3DECL(int) RTFileReadAt(RTFILE File, RTFOFF off, void *pvBuf, size_t cbToRead, size_t *pcbRead)
202{
203 int rc = RTFileSeek(File, off, RTFILE_SEEK_BEGIN, NULL);
204 if (RT_SUCCESS(rc))
205 rc = RTFileRead(File, pvBuf, cbToRead, pcbRead);
206 return rc;
207}
208
209
210/**
211 * Write bytes to a file at a given offset.
212 * This function may modify the file position.
213 *
214 * @returns iprt status code.
215 * @param File Handle to the file.
216 * @param off Where to write.
217 * @param pvBuf What to write.
218 * @param cbToWrite How much to write.
219 * @param *pcbWritten How much we actually wrote.
220 * If NULL an error will be returned for a partial write.
221 */
222RTR3DECL(int) RTFileWriteAt(RTFILE File, RTFOFF off, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten)
223{
224 int rc = RTFileSeek(File, off, RTFILE_SEEK_BEGIN, NULL);
225 if (RT_SUCCESS(rc))
226 rc = RTFileWrite(File, pvBuf, cbToWrite, pcbWritten);
227 return rc;
228}
229
230
231/**
232 * Gets the current file position.
233 *
234 * @returns File offset.
235 * @returns ~0UUL on failure.
236 * @param File File handle.
237 */
238RTR3DECL(uint64_t) RTFileTell(RTFILE File)
239{
240 /*
241 * Call the seek api to query the stuff.
242 */
243 uint64_t off = 0;
244 int rc = RTFileSeek(File, 0, RTFILE_SEEK_CURRENT, &off);
245 if (RT_SUCCESS(rc))
246 return off;
247 AssertMsgFailed(("RTFileSeek(%d) -> %d\n", File, rc));
248 return ~0ULL;
249}
250
251
252/**
253 * Determine the maximum file size.
254 *
255 * @returns The max size of the file.
256 * -1 on failure, the file position is undefined.
257 * @param File Handle to the file.
258 * @see RTFileGetMaxSizeEx.
259 */
260RTR3DECL(RTFOFF) RTFileGetMaxSize(RTFILE File)
261{
262 RTFOFF cbMax;
263 int rc = RTFileGetMaxSizeEx(File, &cbMax);
264 return RT_SUCCESS(rc) ? cbMax : -1;
265}
266
267
268/**
269 * Copies a file given the handles to both files.
270 *
271 * @returns VBox Status code.
272 *
273 * @param FileSrc The source file. The file position is unaltered.
274 * @param FileDst The destination file.
275 * On successful returns the file position is at the end of the file.
276 * On failures the file position and size is undefined.
277 */
278RTDECL(int) RTFileCopyByHandles(RTFILE FileSrc, RTFILE FileDst)
279{
280 return RTFileCopyByHandlesEx(FileSrc, FileDst, NULL, NULL);
281}
282
283
284/**
285 * Copies a file.
286 *
287 * @returns VERR_ALREADY_EXISTS if the destination file exists.
288 * @returns VBox Status code.
289 *
290 * @param pszSrc The path to the source file.
291 * @param pszDst The path to the destination file.
292 * This file will be created.
293 * @param fFlags Flags, any of the RTFILECOPY_FLAGS_ \#defines.
294 * @param pfnProgress Pointer to callback function for reporting progress.
295 * @param pvUser User argument to pass to pfnProgress along with the completion percentage.
296 */
297RTDECL(int) RTFileCopyEx(const char *pszSrc, const char *pszDst, uint32_t fFlags, PFNRTPROGRESS pfnProgress, void *pvUser)
298{
299 /*
300 * Validate input.
301 */
302 AssertMsgReturn(VALID_PTR(pszSrc), ("pszSrc=%p\n", pszSrc), VERR_INVALID_PARAMETER);
303 AssertMsgReturn(*pszSrc, ("pszSrc=%p\n", pszSrc), VERR_INVALID_PARAMETER);
304 AssertMsgReturn(VALID_PTR(pszDst), ("pszDst=%p\n", pszDst), VERR_INVALID_PARAMETER);
305 AssertMsgReturn(*pszDst, ("pszDst=%p\n", pszDst), VERR_INVALID_PARAMETER);
306 AssertMsgReturn(!pfnProgress || VALID_PTR(pfnProgress), ("pfnProgress=%p\n", pfnProgress), VERR_INVALID_PARAMETER);
307 AssertMsgReturn(!(fFlags & ~RTFILECOPY_FLAGS_MASK), ("%#x\n", fFlags), VERR_INVALID_PARAMETER);
308
309 /*
310 * Open the files.
311 */
312 RTFILE FileSrc;
313 int rc = RTFileOpen(&FileSrc, pszSrc,
314 RTFILE_O_READ | RTFILE_O_OPEN
315 | (fFlags & RTFILECOPY_FLAGS_NO_SRC_DENY_WRITE ? RTFILE_O_DENY_NONE : RTFILE_O_DENY_WRITE));
316 if (RT_SUCCESS(rc))
317 {
318 RTFILE FileDst;
319 rc = RTFileOpen(&FileDst, pszDst,
320 RTFILE_O_WRITE | RTFILE_O_CREATE
321 | (fFlags & RTFILECOPY_FLAGS_NO_DST_DENY_WRITE ? RTFILE_O_DENY_NONE : RTFILE_O_DENY_WRITE));
322 if (RT_SUCCESS(rc))
323 {
324 /*
325 * Call the ByHandles version and let it do the job.
326 */
327 rc = RTFileCopyByHandlesEx(FileSrc, FileDst, pfnProgress, pvUser);
328
329 /*
330 * Close the files regardless of the result.
331 * Don't bother cleaning up or anything like that.
332 */
333 int rc2 = RTFileClose(FileDst);
334 AssertRC(rc2);
335 if (RT_FAILURE(rc2) && RT_SUCCESS(rc))
336 rc = rc2;
337 }
338
339 int rc2 = RTFileClose(FileSrc);
340 AssertRC(rc2);
341 if (RT_FAILURE(rc2) && RT_SUCCESS(rc))
342 rc = rc2;
343 }
344 return rc;
345}
346
347
348/**
349 * Copies a file given the handles to both files and
350 * provide progress callbacks.
351 *
352 * @returns VBox Status code.
353 *
354 * @param FileSrc The source file. The file position is unaltered.
355 * @param FileDst The destination file.
356 * On successful returns the file position is at the end of the file.
357 * On failures the file position and size is undefined.
358 * @param pfnProgress Pointer to callback function for reporting progress.
359 * @param pvUser User argument to pass to pfnProgress along with the completion percentage.
360 */
361RTDECL(int) RTFileCopyByHandlesEx(RTFILE FileSrc, RTFILE FileDst, PFNRTPROGRESS pfnProgress, void *pvUser)
362{
363 /*
364 * Validate input.
365 */
366 AssertMsgReturn(RTFileIsValid(FileSrc), ("FileSrc=%RTfile\n", FileSrc), VERR_INVALID_PARAMETER);
367 AssertMsgReturn(RTFileIsValid(FileDst), ("FileDst=%RTfile\n", FileDst), VERR_INVALID_PARAMETER);
368 AssertMsgReturn(!pfnProgress || VALID_PTR(pfnProgress), ("pfnProgress=%p\n", pfnProgress), VERR_INVALID_PARAMETER);
369
370 /*
371 * Save file offset.
372 */
373 RTFOFF offSrcSaved;
374 int rc = RTFileSeek(FileSrc, 0, RTFILE_SEEK_CURRENT, (uint64_t *)&offSrcSaved);
375 if (RT_FAILURE(rc))
376 return rc;
377
378 /*
379 * Get the file size.
380 */
381 RTFOFF cbSrc;
382 rc = RTFileSeek(FileSrc, 0, RTFILE_SEEK_END, (uint64_t *)&cbSrc);
383 if (RT_FAILURE(rc))
384 return rc;
385
386 /*
387 * Allocate buffer.
388 */
389 size_t cbBuf;
390 uint8_t *pbBufFree = NULL;
391 uint8_t *pbBuf;
392 if (cbSrc < _512K)
393 {
394 cbBuf = 8*_1K;
395 pbBuf = (uint8_t *)alloca(cbBuf);
396 }
397 else
398 {
399 cbBuf = _128K;
400 pbBuf = pbBufFree = (uint8_t *)RTMemTmpAlloc(cbBuf);
401 }
402 if (pbBuf)
403 {
404 /*
405 * Seek to the start of each file
406 * and set the size of the destination file.
407 */
408 rc = RTFileSeek(FileSrc, 0, RTFILE_SEEK_BEGIN, NULL);
409 if (RT_SUCCESS(rc))
410 {
411 rc = RTFileSeek(FileDst, 0, RTFILE_SEEK_BEGIN, NULL);
412 if (RT_SUCCESS(rc))
413 rc = RTFileSetSize(FileDst, cbSrc);
414 if (RT_SUCCESS(rc) && pfnProgress)
415 rc = pfnProgress(0, pvUser);
416 if (RT_SUCCESS(rc))
417 {
418 /*
419 * Copy loop.
420 */
421 unsigned uPercentage = 0;
422 RTFOFF off = 0;
423 RTFOFF cbPercent = cbSrc / 100;
424 RTFOFF offNextPercent = cbPercent;
425 while (off < cbSrc)
426 {
427 /* copy block */
428 RTFOFF cbLeft = cbSrc - off;
429 size_t cbBlock = cbLeft >= (RTFOFF)cbBuf ? cbBuf : (size_t)cbLeft;
430 rc = RTFileRead(FileSrc, pbBuf, cbBlock, NULL);
431 if (RT_FAILURE(rc))
432 break;
433 rc = RTFileWrite(FileDst, pbBuf, cbBlock, NULL);
434 if (RT_FAILURE(rc))
435 break;
436
437 /* advance */
438 off += cbBlock;
439 if (pfnProgress && offNextPercent < off)
440 {
441 while (offNextPercent < off)
442 {
443 uPercentage++;
444 offNextPercent += cbPercent;
445 }
446 rc = pfnProgress(uPercentage, pvUser);
447 if (RT_FAILURE(rc))
448 break;
449 }
450 }
451
452#if 0
453 /*
454 * Copy OS specific data (EAs and stuff).
455 */
456 rtFileCopyOSStuff(FileSrc, FileDst);
457#endif
458
459 /* 100% */
460 if (pfnProgress && uPercentage < 100 && RT_SUCCESS(rc))
461 rc = pfnProgress(100, pvUser);
462 }
463 }
464 RTMemTmpFree(pbBufFree);
465 }
466 else
467 rc = VERR_NO_MEMORY;
468
469 /*
470 * Restore source position.
471 */
472 RTFileSeek(FileSrc, offSrcSaved, RTFILE_SEEK_BEGIN, NULL);
473
474 return rc;
475}
476
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette