fileio-posix.cpp revision d1b42bafb224593e8911f216ff27789c9f63f547
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * IPRT - File I/O, POSIX.
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * Copyright (C) 2006-2007 Sun Microsystems, Inc.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * available from http://www.virtualbox.org. This file is free software;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * you can redistribute it and/or modify it under the terms of the GNU
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * General Public License (GPL) as published by the Free Software
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
a16eb14ad7a4b5ef91ddc22d3e8e92d930f736fcvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * The contents of this file may alternatively be used under the terms
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * of the Common Development and Distribution License Version 1.0
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * VirtualBox OSE distribution, in which case the provisions of the
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * CDDL are applicable instead of those of the GPL.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * You may elect to license modified versions of this file under the
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * terms and conditions of either the GPL or the CDDL or both.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * additional information or have any questions.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/*******************************************************************************
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync* Header Files *
d31ded334a29f575e23dc889b603b1a586759348vboxsync*******************************************************************************/
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync#if defined(RT_OS_OS2) && (!defined(__INNOTEK_LIBC__) || __INNOTEK_LIBC__ < 0x006)
afed5ab737f4aacfae3fe73776f40e989190a7cavboxsync/* This is currently ifdef'ed out in the relevant L4 header file */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/* Same as `utimes', but takes an open file descriptor instead of a name. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncextern int futimes(int __fd, __const struct timeval __tvp[2]) __THROW;
2daaccf68be3773aee600c5c3e48bcf5401418a6vboxsync# define futimes(filedes, timeval) futimesat(filedes, NULL, timeval)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/*******************************************************************************
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync* Defined Constants And Macros *
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync*******************************************************************************/
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** @def RT_DONT_CONVERT_FILENAMES
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Define this to pass UTF-8 unconverted to the kernel. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync/** Default file permissions for newly created files. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTFileOpen(PRTFILE pFile, const char *pszFilename, unsigned fOpen)
22e281e75ed636601178296c6daebda8f1d17c59vboxsync * Validate input.
22e281e75ed636601178296c6daebda8f1d17c59vboxsync AssertMsgFailed(("Invalid pszFilename %p\n", pszFilename));
22e281e75ed636601178296c6daebda8f1d17c59vboxsync * Merge forced open flags and validate them.
22e281e75ed636601178296c6daebda8f1d17c59vboxsync AssertMsgFailed(("Invalid parameters! fOpen=%#x\n", fOpen));
22e281e75ed636601178296c6daebda8f1d17c59vboxsync * Calculate open mode flags.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /* O_DIRECT is mandatory to get async I/O working on Linux. */
b1c3cdef473df2fbc621d5da81acc82dbfb8a11avboxsync#if defined(O_DIRECT) && (defined(RT_OS_LINUX) || defined(RT_OS_FREEBSD))
a11c569636fa6838bd423f4631a9660a5a84204bvboxsync /* Disable the kernel cache. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync case RTFILE_O_OPEN_CREATE: fOpenMode |= O_CREAT; break;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync case RTFILE_O_CREATE: fOpenMode |= O_CREAT | O_EXCL; break;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync case RTFILE_O_CREATE_REPLACE: fOpenMode |= O_CREAT | O_TRUNC; break; /** @todo replacing needs fixing, this is *not* a 1:1 mapping! */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync case RTFILE_O_READWRITE: fOpenMode |= O_RDWR; break;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync AssertMsgFailed(("RTFileOpen received an invalid RW value, fOpen=%#x\n", fOpen));
750d4d0506a38b2e80c997075d40aad474e675fbvboxsync /* File mode. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync ? (fOpen & RTFILE_O_CREATE_MODE_MASK) >> RTFILE_O_CREATE_MODE_SHIFT
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /** @todo sharing! */
b74ca013e5f201a2dd371e6c438433ceac12af30vboxsync rc = rtPathToNative(&pszNativeFilename, pszFilename);
b74ca013e5f201a2dd371e6c438433ceac12af30vboxsync int fh = open(pszNativeFilename, fOpenMode, fMode);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Mark the file handle close on exec, unless inherit is specified.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync || (fOpenMode & O_NOINHERIT) /* careful since it could be a dummy. */
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync /* Switch direct I/O on now if requested */
22e281e75ed636601178296c6daebda8f1d17c59vboxsync LogFlow(("RTFileOpen(%p:{%RTfile}, %p:{%s}, %#x): returns %Rrc\n",
8a132edc1577cbe2a19cd778c1b2bea6ae5e8515vboxsync pFile, *pFile, pszFilename, pszFilename, fOpen, rc));
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsyncRTR3DECL(int) RTFileFromNative(PRTFILE pFile, RTHCINTPTR uNative)
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync int rc = rtPathToNative(&pszNativeFilename, pszFilename);
22e281e75ed636601178296c6daebda8f1d17c59vboxsyncRTR3DECL(int) RTFileSeek(RTFILE File, int64_t offSeek, unsigned uMethod, uint64_t *poffActual)
b74ca013e5f201a2dd371e6c438433ceac12af30vboxsync static const unsigned aSeekRecode[] =
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Validate input.
00599f6d39cc25ca39845c2433cd75de7b9f6971vboxsync AssertMsgFailed(("Invalid uMethod=%d\n", uMethod));
533ffcb943c4af2c5fe6385d816d0ba3eda9383bvboxsync /* check that within off_t range. */
533ffcb943c4af2c5fe6385d816d0ba3eda9383bvboxsync && ( (offSeek > 0 && (unsigned)(offSeek >> 32) != 0)
22e281e75ed636601178296c6daebda8f1d17c59vboxsync || (offSeek < 0 && (unsigned)(-offSeek >> 32) != 0)))
e50404712a2b5234c42bdf9740bddab5729ba188vboxsync AssertMsgFailed(("64-bit search not supported\n"));
57399ab65e2825c324fb9dcb4642d4ae2c232509vboxsync off_t offCurrent = lseek((int)File, (off_t)offSeek, aSeekRecode[uMethod]);
13ba5527caaa9b8c4fee29f22e374fa67c4c6f72vboxsyncRTR3DECL(int) RTFileRead(RTFILE File, void *pvBuf, size_t cbToRead, size_t *pcbRead)
1843553dbdf4e46417158b4c6348c503adf10740vboxsync * Attempt read.
9e4166cf5ed4940f506bc718ea6c89bf7ed252c8vboxsync /* caller can handle partial read. */
1843553dbdf4e46417158b4c6348c503adf10740vboxsync /* Caller expects all to be read. */
1843553dbdf4e46417158b4c6348c503adf10740vboxsync ssize_t cbReadPart = read((int)File, (char*)pvBuf + cbRead, cbToRead - cbRead);
1843553dbdf4e46417158b4c6348c503adf10740vboxsyncRTR3DECL(int) RTFileWrite(RTFILE File, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten)
533ffcb943c4af2c5fe6385d816d0ba3eda9383bvboxsync * Attempt write.
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync ssize_t cbWritten = write((int)File, pvBuf, cbToWrite);
b978e5849454446957177fd47ee98609ab0457a6vboxsync /* caller can handle partial write. */
22e281e75ed636601178296c6daebda8f1d17c59vboxsync /* Caller expects all to be write. */
b74ca013e5f201a2dd371e6c438433ceac12af30vboxsync ssize_t cbWrittenPart = write((int)File, (const char *)pvBuf + cbWritten, cbToWrite - cbWritten);
22e281e75ed636601178296c6daebda8f1d17c59vboxsyncRTR3DECL(int) RTFileSetSize(RTFILE File, uint64_t cbSize)
2d53f6e472561965d363674e17f48d3bdffc24d3vboxsync * Validate offset.
22e281e75ed636601178296c6daebda8f1d17c59vboxsync AssertMsgFailed(("64-bit filesize not supported! cbSize=%lld\n", cbSize));
2d53f6e472561965d363674e17f48d3bdffc24d3vboxsync#if defined(_MSC_VER) || (defined(RT_OS_OS2) && (!defined(__INNOTEK_LIBC__) || __INNOTEK_LIBC__ < 0x006))
6ae4b1c72625a8e5c369effea7f018b578d733c4vboxsync /* This relies on a non-standard feature of FreeBSD, Linux, and OS/2
2d53f6e472561965d363674e17f48d3bdffc24d3vboxsync * LIBC v0.6 and higher. (SuS doesn't define ftruncate() and size bigger
0e77737b0ba913683e614db11463b31ca67aacbevboxsync * than the file.)
8e972b677df5ee27b99211fc7e456a5aa50f3e68vboxsyncRTR3DECL(int) RTFileGetSize(RTFILE File, uint64_t *pcbSize)
806d0b554daa555364af5f87bc96eccbe760db7avboxsync * Determine the maximum file size.
806d0b554daa555364af5f87bc96eccbe760db7avboxsync * @returns IPRT status code.
806d0b554daa555364af5f87bc96eccbe760db7avboxsync * @param File Handle to the file.
806d0b554daa555364af5f87bc96eccbe760db7avboxsync * @param pcbMax Where to store the max file size.
806d0b554daa555364af5f87bc96eccbe760db7avboxsync * @see RTFileGetMaxSize.
806d0b554daa555364af5f87bc96eccbe760db7avboxsyncRTR3DECL(int) RTFileGetMaxSizeEx(RTFILE File, PRTFOFF pcbMax)
6ae4b1c72625a8e5c369effea7f018b578d733c4vboxsync * Save the current location
d98e61ba075ed7d0b567a5d884bc85d643fe3de7vboxsync int rc = RTFileSeek(File, 0, RTFILE_SEEK_CURRENT, &offOld);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync * Perform a binary search for the max file size.
13ba5527caaa9b8c4fee29f22e374fa67c4c6f72vboxsync uint64_t offHigh = 8 * _1T; /* we don't need bigger files */
806d0b554daa555364af5f87bc96eccbe760db7avboxsync /** @todo Unfortunately this does not work for certain file system types,
806d0b554daa555364af5f87bc96eccbe760db7avboxsync * for instance cifs mounts. Even worse, statvfs.f_fsid returns 0 for such
22e281e75ed636601178296c6daebda8f1d17c59vboxsync * file systems. */
42c1972c22e09797b4b24afbd0ec114ed076c37cvboxsync //uint64_t offHigh = INT64_MAX;
13ba5527caaa9b8c4fee29f22e374fa67c4c6f72vboxsync return RTFileSeek(File, offOld, RTFILE_SEEK_BEGIN, NULL);
806d0b554daa555364af5f87bc96eccbe760db7avboxsync rc = RTFileSeek(File, offLow + cbInterval, RTFILE_SEEK_BEGIN, NULL);
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync return true;
d408b82da0773c7e8cd4b3a01cb8a065a2c73a2dvboxsync return false;
3dde2f85d4cf477621a3128887a2c08a8bca7c01vboxsyncRTR3DECL(int) RTFileIoCtl(RTFILE File, int iRequest, void *pvData, unsigned cbData, int *piRet)
22e281e75ed636601178296c6daebda8f1d17c59vboxsync return rc >= 0 ? VINF_SUCCESS : RTErrConvertFromErrno(errno);
806d0b554daa555364af5f87bc96eccbe760db7avboxsyncRTR3DECL(int) RTFileQueryInfo(RTFILE File, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAdditionalAttribs)
3cac8f8c6923a3a89ecfccda5e89ad75f48658e0vboxsync * Validate input.
5e797edc29f96c8367de4fbf5874171c24a89ba7vboxsync AssertMsgFailed(("Invalid pObjInfo=%p\n", pObjInfo));
7bae75e0b207aa4d4cad2a951271ad1a0e8ab9fdvboxsync AssertMsgFailed(("Invalid enmAdditionalAttribs=%p\n", enmAdditionalAttribs));
9e4166cf5ed4940f506bc718ea6c89bf7ed252c8vboxsync * Query file info.
13ba5527caaa9b8c4fee29f22e374fa67c4c6f72vboxsync Log(("RTFileQueryInfo(%RTfile,,%d): returns %Rrc\n", File, enmAdditionalAttribs, rc));
e0b9d3c357adf9b7d05f55540e86f22943fc4b23vboxsync * Setup the returned data.
79b24ef0ab7cd4a03a3571b3954c52ab8b573137vboxsync rtFsConvertStatToObjInfo(pObjInfo, &Stat, NULL, 0);
13ba5527caaa9b8c4fee29f22e374fa67c4c6f72vboxsync * Requested attributes (we cannot provide anything actually).
3dde2f85d4cf477621a3128887a2c08a8bca7c01vboxsync pObjInfo->Attr.enmAdditional = RTFSOBJATTRADD_EASIZE;
b978e5849454446957177fd47ee98609ab0457a6vboxsync LogFlow(("RTFileQueryInfo(%RTfile,,%d): returns VINF_SUCCESS\n", File, enmAdditionalAttribs));
7082d29724f6c3788977a51591b0379fd3acbf72vboxsyncRTR3DECL(int) RTFileSetTimes(RTFILE File, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
22e281e75ed636601178296c6daebda8f1d17c59vboxsync * We can only set AccessTime and ModificationTime, so if neither
6f0193f5a9287559d34a75f438c2682d8fb08038vboxsync * are specified we can return immediately.
22e281e75ed636601178296c6daebda8f1d17c59vboxsync * Convert the input to timeval, getting the missing one if necessary,
42c1972c22e09797b4b24afbd0ec114ed076c37cvboxsync * and call the API which does the change.
13ba5527caaa9b8c4fee29f22e374fa67c4c6f72vboxsync RTTimeSpecGetTimeval(pModificationTime, &aTimevals[1]);
6f0193f5a9287559d34a75f438c2682d8fb08038vboxsync int rc = RTFileQueryInfo(File, &ObjInfo, RTFSOBJATTRADD_UNIX);
6f0193f5a9287559d34a75f438c2682d8fb08038vboxsync RTTimeSpecGetTimeval(pAccessTime ? pAccessTime : &ObjInfo.AccessTime, &aTimevals[0]);
6f0193f5a9287559d34a75f438c2682d8fb08038vboxsync RTTimeSpecGetTimeval(pModificationTime ? pModificationTime : &ObjInfo.ModificationTime, &aTimevals[1]);
9e4166cf5ed4940f506bc718ea6c89bf7ed252c8vboxsync Log(("RTFileSetTimes(%RTfile,%p,%p,,): returns %Rrc\n", File, pAccessTime, pModificationTime, rc));
6f0193f5a9287559d34a75f438c2682d8fb08038vboxsyncRTR3DECL(int) RTFileSetMode(RTFILE File, RTFMODE fMode)
42c1972c22e09797b4b24afbd0ec114ed076c37cvboxsync * Normalize the mode and call the API.
6f0193f5a9287559d34a75f438c2682d8fb08038vboxsync Log(("RTFileSetMode(%RTfile,%RTfmode): returns %Rrc\n", File, fMode, rc));
6ae4b1c72625a8e5c369effea7f018b578d733c4vboxsyncRTR3DECL(int) RTFileRename(const char *pszSrc, const char *pszDst, unsigned fRename)
f9147fe1eaa4e35287f8f39282c7f92f0d7de0b7vboxsync * Validate input.
f9147fe1eaa4e35287f8f39282c7f92f0d7de0b7vboxsync AssertMsgReturn(VALID_PTR(pszSrc), ("%p\n", pszSrc), VERR_INVALID_POINTER);
f9147fe1eaa4e35287f8f39282c7f92f0d7de0b7vboxsync AssertMsgReturn(VALID_PTR(pszDst), ("%p\n", pszDst), VERR_INVALID_POINTER);
f9147fe1eaa4e35287f8f39282c7f92f0d7de0b7vboxsync AssertMsgReturn(*pszSrc, ("%p\n", pszSrc), VERR_INVALID_PARAMETER);
7e960d3a0a8a3a84d7aba2cca45d72b1c31cc97bvboxsync AssertMsgReturn(*pszDst, ("%p\n", pszDst), VERR_INVALID_PARAMETER);
65b61798a61dd4c32cce448db1dac70bba8d5cf5vboxsync AssertMsgReturn(!(fRename & ~RTPATHRENAME_FLAGS_REPLACE), ("%#x\n", fRename), VERR_INVALID_PARAMETER);
22e281e75ed636601178296c6daebda8f1d17c59vboxsync * Take common cause with RTPathRename.
13ba5527caaa9b8c4fee29f22e374fa67c4c6f72vboxsync int rc = rtPathPosixRename(pszSrc, pszDst, fRename, RTFS_TYPE_FILE);
65b61798a61dd4c32cce448db1dac70bba8d5cf5vboxsync LogFlow(("RTDirRename(%p:{%s}, %p:{%s}, %#x): returns %Rrc\n",