vfs.h revision 4d3f12a2094df73f5e04b71d3b7623aa0130285c
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * IPRT - Virtual Filesystem.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * Copyright (C) 2010 Oracle Corporation
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * available from http://www.virtualbox.org. This file is free software;
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * you can redistribute it and/or modify it under the terms of the GNU
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * General Public License (GPL) as published by the Free Software
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * The contents of this file may alternatively be used under the terms
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * of the Common Development and Distribution License Version 1.0
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * VirtualBox OSE distribution, in which case the provisions of the
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * CDDL are applicable instead of those of the GPL.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * You may elect to license modified versions of this file under the
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * terms and conditions of either the GPL or the CDDL or both.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync/** @defgroup grp_rt_fs RTVfs - Virtual Filesystem
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @ingroup grp_rt
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * The virtual filesystem APIs are intended to make it possible to work on
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * container files, file system sub-trees, file system overlays and other custom
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * filesystem configurations. It also makes it possible to create filters, like
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * automatically gunzipping a tar.gz file before feeding it to the RTTar API for
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * unpacking - or wise versa.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * The virtual filesystem APIs are intended to mirror the RTDir, RTFile, RTPath
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * and RTFs APIs pretty closely so that rewriting a piece of code to work with
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * it should be easy. However there are some differences to the way the APIs
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * works and the user should heed the documentation. The differences are
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * usually motivated by simplification and in some case to make the VFS more
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * flexible.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * The object type.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync /** Invalid type. */
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync /** Pure base object.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * This is returned by the filesystem stream to represent directories,
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * devices, fifos and similar that needs to be created. */
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync /** Virtual filesystem. */
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync /** Filesystem stream. */
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync /** Pure I/O stream. */
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync /** Directory. */
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync /** File. */
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync /** Symbolic link. */
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync /** End of valid object types. */
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync /** Pure I/O stream. */
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync/** Pointer to a VFS object type. */
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync/** @name RTVfsCreate flags
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync/** Whether the file system is read-only. */
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync/** Whether we the VFS should be thread safe (i.e. automaticaly employ
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * locks). */
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * Creates an empty virtual filesystem.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @returns IPRT status code.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @param pszName Name, for logging and such.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @param fFlags Flags, MBZ.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @param phVfs Where to return the VFS handle. Release the returned
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * reference by calling RTVfsRelease.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsCreate(const char *pszName, uint32_t fFlags, PRTVFS phVfs);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsAttach(RTVFS hVfs, const char *pszMountPoint, uint32_t fFlags, RTVFS hVfsAttach);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsDetach(RTVFS hVfs, const char *pszMountPoint, RTVFS hVfsToDetach, PRTVFS *phVfsDetached);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(uint32_t) RTVfsGetAttachmentCount(RTVFS hVfs);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsGetAttachment(RTVFS hVfs, uint32_t iOrdinal, PRTVFS *phVfsAttached, uint32_t *pfFlags,
1e9c7d1236e5efe007e5984e75dad70243214559vboxsync/** @defgroup grp_vfs_dir VFS Directory API
1e9c7d1236e5efe007e5984e75dad70243214559vboxsyncRTDECL(RTVFSFSSTREAM) RTVfsObjToFsStream(RTVFSOBJ hVfsObj);
1e9c7d1236e5efe007e5984e75dad70243214559vboxsyncRTDECL(RTVFSIOSTREAM) RTVfsObjToIoStream(RTVFSOBJ hVfsObj);
1e9c7d1236e5efe007e5984e75dad70243214559vboxsyncRTDECL(RTVFSSYMLINK) RTVfsObjToSymlink(RTVFSOBJ hVfsObj);
1e9c7d1236e5efe007e5984e75dad70243214559vboxsyncRTDECL(RTVFSOBJ) RTVfsObjFromFsStream(RTVFSFSSTREAM hVfsFss);
1e9c7d1236e5efe007e5984e75dad70243214559vboxsyncRTDECL(RTVFSOBJ) RTVfsObjFromIoStream(RTVFSIOSTREAM hVfsIos);
1e9c7d1236e5efe007e5984e75dad70243214559vboxsyncRTDECL(RTVFSOBJ) RTVfsObjFromFile(RTVFSFILE hVfsFile);
1e9c7d1236e5efe007e5984e75dad70243214559vboxsyncRTDECL(RTVFSOBJ) RTVfsObjFromSymlink(RTVFSSYMLINK hVfsSym);
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * Query information about the object.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * @returns IPRT status code.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * @param hVfsObj The VFS object handle.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * @param pObjInfo Where to return the info.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * @param enmAddAttr Which additional attributes should be retrieved.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * @sa RTFileQueryInfo, RTPathQueryInfo
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsyncRTDECL(int) RTVfsObjQueryInfo(RTVFSOBJ hVfsObj, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync/** @defgroup grp_vfs_fsstream VFS Filesystem Stream API
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * Filesystem streams are for tar, cpio and similar. Any virtual filesystem can
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * be turned into a filesystem stream using RTVfsFsStrmFromVfs.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsyncRTDECL(uint32_t) RTVfsFsStrmRetain(RTVFSFSSTREAM hVfsFss);
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsyncRTDECL(uint32_t) RTVfsFsStrmRelease(RTVFSFSSTREAM hVfsFss);
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsyncRTDECL(int) RTVfsFsStrmQueryInfo(RTVFSFSSTREAM hVfsFss, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * Gets the next object in the stream.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * This call may affect the stream posision of a previously returned object.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * The type of object returned here typically boils down to three types:
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * - I/O streams (representing files),
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * - symbolic links
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * - base object
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * The base objects represent anything not convered by the two other, i.e.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * directories, device nodes, fifos, sockets and whatnot. The details can be
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * queried using RTVfsObjQueryInfo.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * That said, absolutely any object except for filesystem stream objects can be
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * returned by this call. Any generic code is adviced to just deal with it all.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * @returns IPRT status code.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * @retval VINF_SUCCESS if a new object was retrieved.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * @retval VERR_EOF when there are no more objects.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * @param pvThis The implementation specific directory data.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * @param ppszName Where to return the object name. Must be freed by
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * calling RTStrFree.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * @param penmType Where to return the object type.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * @param hVfsObj Where to return the object handle (referenced).
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsync * This must be cast to the desired type before use.
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsyncRTDECL(int) RTVfsFsStrmNext(RTVFSFSSTREAM hVfsFss, char **ppszName, RTVFSOBJTYPE *penmType, PRTVFSOBJ phVfsObj);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync/** @defgroup grp_vfs_dir VFS Directory API
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * Retains a reference to the VFS directory handle.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * @returns New reference count on success, UINT32_MAX on failure.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * @param hVfsDir The VFS directory handle.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * Releases a reference to the VFS directory handle.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * @returns New reference count on success (0 if closed), UINT32_MAX on failure.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * @param hVfsIos The VFS directory handle.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync/** @defgroup grp_vfs_iostream VFS Symbolic Link API
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsyncRTDECL(uint32_t) RTVfsSymlinkRetain(RTVFSSYMLINK hVfsSym);
f6f1d32779a2a6a1a4579c3bf6ff3aa0c37f0823vboxsyncRTDECL(uint32_t) RTVfsSymlinkRelease(RTVFSSYMLINK hVfsSym);
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * Read the symbolic link target.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * @returns IPRT status code.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * @param hVfsSym The VFS symbolic link handle.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * @param pszTarget The target buffer.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * @param cbTarget The size of the target buffer.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * @sa RTSymlinkRead
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsyncRTDECL(int) RTVfsSymlinkRead(RTVFSSYMLINK hVfsSym, char *pszTarget, size_t cbTarget);
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync/** @defgroup grp_vfs_iostream VFS I/O Stream API
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * Create a VFS I/O stream handle from a standard IPRT file handle (RTFILE).
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @returns IPRT status code.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @param hFile The standard IPRT file handle.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @param fOpen The flags the handle was opened with. Pass 0 to
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * have these detected.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @param fLeaveOpen Whether to leave the handle open when the VFS file
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * is released, or to close it (@c false).
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @param phVfsIos Where to return the VFS I/O stream handle.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsyncRTDECL(int) RTVfsIoStrmFromRTFile(RTFILE hFile, uint32_t fOpen, bool fLeaveOpen, PRTVFSIOSTREAM phVfsIos);
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * Create a VFS I/O stream handle from one of the standard handles.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @returns IPRT status code.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @param enmStdHandle The standard IPRT file handle.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @param fOpen The flags the handle was opened with. Pass 0 to
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * have these detected.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @param fLeaveOpen Whether to leave the handle open when the VFS file
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * is released, or to close it (@c false).
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @param phVfsIos Where to return the VFS I/O stream handle.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsyncRTDECL(int) RTVfsIoStrmFromStdHandle(RTHANDLESTD enmStdHandle, uint32_t fOpen, bool fLeaveOpen,
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * Retains a reference to the VFS I/O stream handle.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @returns New reference count on success, UINT32_MAX on failure.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param hVfsIos The VFS I/O stream handle.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(uint32_t) RTVfsIoStrmRetain(RTVFSIOSTREAM hVfsIos);
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * Releases a reference to the VFS I/O stream handle.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @returns New reference count on success (0 if closed), UINT32_MAX on failure.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param hVfsIos The VFS I/O stream handle.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(uint32_t) RTVfsIoStrmRelease(RTVFSIOSTREAM hVfsIos);
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * Convert the VFS I/O stream handle to a VFS file handle.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @returns The VFS file handle on success, this must be released.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * NIL_RTVFSFILE if the I/O stream handle is invalid.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param hVfsIos The VFS I/O stream handle.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @sa RTVfsFileToIoStream
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsyncRTDECL(RTVFSFILE) RTVfsIoStrmToFile(RTVFSIOSTREAM hVfsIos);
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * Query information about the I/O stream.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @returns IPRT status code.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param hVfsIos The VFS I/O stream handle.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param pObjInfo Where to return the info.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param enmAddAttr Which additional attributes should be retrieved.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @sa RTFileQueryInfo
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsyncRTDECL(int) RTVfsIoStrmQueryInfo(RTVFSIOSTREAM hVfsIos, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * Read bytes from the I/O stream.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @returns IPRT status code.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @retval VINF_SUCCESS and the number of bytes read written to @a pcbRead.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @retval VINF_TRY_AGAIN if @a fBlocking is @c false, @a pcbRead is not NULL,
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * and no data was available. @a *pcbRead will be set to 0.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @retval VINF_EOF when trying to read __beyond__ the end of the stream and
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @a pcbRead is not NULL (it will be set to the number of bytes read,
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * or 0 if the end of the stream was reached before this call).
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * When the last byte of the read request is the last byte in the
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * stream, this status code will not be used. However, VINF_EOF is
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * returned when attempting to read 0 bytes while standing at the end
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * of the stream.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @retval VERR_EOF when trying to read __beyond__ the end of the stream and
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @a pcbRead is NULL.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param hVfsIos The VFS I/O stream handle.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param pvBuf Where to store the read bytes.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param cbToRead The number of bytes to read.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @param fBlocking Whether the call is blocking (@c true) or not. If
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * not, the @a pcbRead parameter must not be NULL.
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * @param pcbRead Where to always store the number of bytes actually
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * read. This can be NULL if @a fBlocking is true.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @sa RTFileRead, RTPipeRead, RTPipeReadBlocking, RTSocketRead
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsyncRTDECL(int) RTVfsIoStrmRead(RTVFSIOSTREAM hVfsIos, void *pvBuf, size_t cbToRead, bool fBlocking, size_t *pcbRead);
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * Write bytes to the I/O stream.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @returns IPRT status code.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param hVfsIos The VFS I/O stream handle.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param pvBuf The bytes to write.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param cbToWrite The number of bytes to write.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @param fBlocking Whether the call is blocking (@c true) or not. If
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * not, the @a pcbWritten parameter must not be NULL.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @param pcbRead Where to always store the number of bytes actually
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * written. This can be NULL if @a fBlocking is true.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @sa RTFileWrite, RTPipeWrite, RTPipeWriteBlocking, RTSocketWrite
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsyncRTDECL(int) RTVfsIoStrmWrite(RTVFSIOSTREAM hVfsIos, const void *pvBuf, size_t cbToWrite, bool fBlocking, size_t *pcbWritten);
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * Reads bytes from the I/O stream into a scatter buffer.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @returns IPRT status code.
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * @retval VINF_SUCCESS and the number of bytes read written to @a pcbRead.
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * @retval VINF_TRY_AGAIN if @a fBlocking is @c false, @a pcbRead is not NULL,
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * and no data was available. @a *pcbRead will be set to 0.
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * @retval VINF_EOF when trying to read __beyond__ the end of the stream and
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * @a pcbRead is not NULL (it will be set to the number of bytes read,
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * or 0 if the end of the stream was reached before this call).
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * When the last byte of the read request is the last byte in the
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * stream, this status code will not be used. However, VINF_EOF is
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * returned when attempting to read 0 bytes while standing at the end
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * of the stream.
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * @retval VERR_EOF when trying to read __beyond__ the end of the stream and
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * @a pcbRead is NULL.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param hVfsIos The VFS I/O stream handle.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param pSgBuf Pointer to a scatter buffer descriptor. The number
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * of bytes described by the segments is what will be
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * attemted read.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param fBlocking Whether the call is blocking (@c true) or not. If
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * not, the @a pcbRead parameter must not be NULL.
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * @param pcbRead Where to always store the number of bytes actually
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * read. This can be NULL if @a fBlocking is true.
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * @sa RTFileSgRead, RTSocketSgRead, RTPipeRead, RTPipeReadBlocking
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsyncRTDECL(int) RTVfsIoStrmSgRead(RTVFSIOSTREAM hVfsIos, PCRTSGBUF pSgBuf, bool fBlocking, size_t *pcbRead);
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * Write bytes to the I/O stream from a gather buffer.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @returns IPRT status code.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param hVfsIos The VFS I/O stream handle.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param pSgBuf Pointer to a gather buffer descriptor. The number
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * of bytes described by the segments is what will be
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * attemted written.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param fBlocking Whether the call is blocking (@c true) or not. If
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * not, the @a pcbWritten parameter must not be NULL.
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * @param pcbRead Where to always store the number of bytes actually
667506dc4c739586cde5d4f245677ef5aac62ac2vboxsync * written. This can be NULL if @a fBlocking is true.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @sa RTFileSgWrite, RTSocketSgWrite
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsyncRTDECL(int) RTVfsIoStrmSgWrite(RTVFSIOSTREAM hVfsIos, PCRTSGBUF pSgBuf, bool fBlocking, size_t *pcbWritten);
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * Flush any buffered data to the I/O stream.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @returns IPRT status code.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param hVfsIos The VFS I/O stream handle.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @sa RTFileFlush, RTPipeFlush
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsIoStrmFlush(RTVFSIOSTREAM hVfsIos);
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * Poll for events.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @returns IPRT status code.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param hVfsIos The VFS I/O stream handle.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param fEvents The events to poll for (RTPOLL_EVT_XXX).
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param cMillies How long to wait for event to eventuate.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param fIntr Whether the wait is interruptible and can return
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * VERR_INTERRUPTED (@c true) or if this condition
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * should be hidden from the caller (@c false).
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param pfRetEvents Where to return the event mask.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @sa RTPollSetAdd, RTPoll, RTPollNoResume.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(RTFOFF) RTVfsIoStrmPoll(RTVFSIOSTREAM hVfsIos, uint32_t fEvents, RTMSINTERVAL cMillies, bool fIntr,
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * Tells the current I/O stream position.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @returns Zero or higher - where to return the I/O stream offset. Values
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * below zero are IPRT status codes (VERR_XXX).
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @param hVfsIos The VFS I/O stream handle.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @sa RTFileTell
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(RTFOFF) RTVfsIoStrmTell(RTVFSIOSTREAM hVfsIos);
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * Skips @a cb ahead in the stream.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * @returns IPRT status code.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * @param hVfsIos The VFS I/O stream handle.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * @param cb The number bytes to skip.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsyncRTDECL(int) RTVfsIoStrmSkip(RTVFSIOSTREAM hVfsIos, RTFOFF cb);
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * Fills the stream with @a cb zeros.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * @returns IPRT status code.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * @param hVfsIos The VFS I/O stream handle.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsync * @param cb The number of zero bytes to insert.
d6c4b5eecea7735227dc41255d4e742543ddc86fvboxsyncRTDECL(int) RTVfsIoStrmZeroFill(RTVFSIOSTREAM hVfsIos, RTFOFF cb);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync/** @defgroup grp_vfs_file VFS File API
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsFileOpen(RTVFS hVfs, const char *pszFilename, uint32_t fOpen, PRTVFSFILE phVfsFile);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * Create a VFS file handle from a standard IPRT file handle (RTFILE).
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @returns IPRT status code.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @param hFile The standard IPRT file handle.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @param fOpen The flags the handle was opened with. Pass 0 to
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * have these detected.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @param fLeaveOpen Whether to leave the handle open when the VFS file
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * is released, or to close it (@c false).
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @param phVfsFile Where to return the VFS file handle.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsFileFromRTFile(RTFILE hFile, uint32_t fOpen, bool fLeaveOpen, PRTVFSFILE phVfsFile);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(RTHCUINTPTR) RTVfsFileToNative(RTFILE hVfsFile);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * Convert the VFS file handle to a VFS I/O stream handle.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @returns The VFS I/O stream handle on success, this must be released.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * NIL_RTVFSIOSTREAM if the file handle is invalid.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @param hVfsFile The VFS file handle.
404df8b2baf3f931a57bffd773b093d0fe40cd50vboxsync * @sa RTVfsIoStrmToFile
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(RTVFSIOSTREAM) RTVfsFileToIoStream(RTVFSFILE hVfsFile);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * Retains a reference to the VFS file handle.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @returns New reference count on success, UINT32_MAX on failure.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @param hVfsFile The VFS file handle.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(uint32_t) RTVfsFileRetain(RTVFSFILE hVfsFile);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * Releases a reference to the VFS file handle.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @returns New reference count on success (0 if closed), UINT32_MAX on failure.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync * @param hVfsFile The VFS file handle.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(uint32_t) RTVfsFileRelease(RTVFSFILE hVfsFile);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsFileQueryInfo(RTVFSFILE hVfsFile, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsFileRead(RTVFSFILE hVfsFile, void *pvBuf, size_t cbToRead, size_t *pcbRead);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsFileReadAt(RTVFSFILE hVfsFile, RTFOFF off, void *pvBuf, size_t cbToRead, size_t *pcbRead);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsFileWrite(RTVFSFILE hVfsFile, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsFileWriteAt(RTVFSFILE hVfsFile, RTFOFF off, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(RTFOFF) RTVfsFilePoll(RTVFSFILE hVfsFile, uint32_t fEvents, RTMSINTERVAL cMillies, bool fIntr,
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsFileSeek(RTVFSFILE hVfsFile, RTFOFF offSeek, uint32_t uMethod, uint64_t *poffActual);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsFileSetSize(RTVFSFILE hVfsFile, uint64_t cbSize);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsFileGetSize(RTVFSFILE hVfsFile, uint64_t *pcbSize);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(RTFOFF) RTVfsFileGetMaxSize(RTVFSFILE hVfsFile);
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsyncRTDECL(int) RTVfsFileGetMaxSizeEx(RTVFSFILE hVfsFile, PRTFOFF pcbMax);
1e9c7d1236e5efe007e5984e75dad70243214559vboxsync/** @defgroup grp_rt_vfs_chain VFS Chains
1e9c7d1236e5efe007e5984e75dad70243214559vboxsync * VFS chains is for doing pipe like things with VFS objects from the command
1e9c7d1236e5efe007e5984e75dad70243214559vboxsync * line. Imagine you want to cat the readme.gz of an ISO you could do
1e9c7d1236e5efe007e5984e75dad70243214559vboxsync * something like:
1e9c7d1236e5efe007e5984e75dad70243214559vboxsync * RTCat :iprtvfs:vfs(isofs,./mycd.iso)|ios(open,readme.gz)|ios(gunzip)
1e9c7d1236e5efe007e5984e75dad70243214559vboxsync * RTCat :iprtvfs:ios(isofs,./mycd.iso,/readme.gz)|ios(gunzip)
1e9c7d1236e5efe007e5984e75dad70243214559vboxsync * The "isofs", "open" and "gunzip" bits in the above examples are chain
1e9c7d1236e5efe007e5984e75dad70243214559vboxsync * element providers registered with IPRT. See RTVFSCHAINELEMENTREG for how
1e9c7d1236e5efe007e5984e75dad70243214559vboxsync * these works.
1e9c7d1236e5efe007e5984e75dad70243214559vboxsync/** The path prefix used to identify an VFS chain specification. */
1e9c7d1236e5efe007e5984e75dad70243214559vboxsyncRTDECL(int) RTVfsChainOpenVfs( const char *pszSpec, PRTVFS phVfs, const char **ppszError);
1e9c7d1236e5efe007e5984e75dad70243214559vboxsyncRTDECL(int) RTVfsChainOpenFsStream( const char *pszSpec, PRTVFSFSSTREAM phVfsFss, const char **ppszError);
1e9c7d1236e5efe007e5984e75dad70243214559vboxsyncRTDECL(int) RTVfsChainOpenDir( const char *pszSpec, uint32_t fOpen, PRTVFSDIR phVfsDir, const char **ppszError);
1e9c7d1236e5efe007e5984e75dad70243214559vboxsyncRTDECL(int) RTVfsChainOpenFile( const char *pszSpec, uint32_t fOpen, PRTVFSFILE phVfsFile, const char **ppszError);
1e9c7d1236e5efe007e5984e75dad70243214559vboxsyncRTDECL(int) RTVfsChainOpenSymlink( const char *pszSpec, PRTVFSSYMLINK phVfsSym, const char **ppszError);
1e9c7d1236e5efe007e5984e75dad70243214559vboxsyncRTDECL(int) RTVfsChainOpenIoStream( const char *pszSpec, uint32_t fOpen, PRTVFSIOSTREAM phVfsIos, const char **ppszError);
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * Tests if the given string is a chain specification or not.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @returns true if it is, false if it isn't.
4d3f12a2094df73f5e04b71d3b7623aa0130285cvboxsync * @param pszSpec The alleged chain spec.
4e38f78b4916ef128a3902ed2a8d7e8d7f947d8dvboxsync#endif /* !___iprt_vfs_h */