vfs.h@ 76585

Last change on this file since 76585 was 76585, checked in by vboxsync, 6 years ago
*: scm --fix-header-guard-endif
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 76.9 KB

Line
1	/** @file
2	* IPRT - Virtual Filesystem.
3	*/
4
5	/*
6	* Copyright (C) 2010-2019 Oracle Corporation
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*/
25
26	#ifndef IPRT_INCLUDED_vfs_h
27	#define IPRT_INCLUDED_vfs_h
28	#ifndef RT_WITHOUT_PRAGMA_ONCE
29	# pragma once
30	#endif
31
32	#include <iprt/cdefs.h>
33	#include <iprt/types.h>
34	#include <iprt/dir.h>
35	#include <iprt/fs.h>
36	#include <iprt/handle.h>
37	#include <iprt/symlink.h>
38	#include <iprt/sg.h>
39	#include <iprt/time.h>
40
41
42	RT_C_DECLS_BEGIN
43
44	/** @defgroup grp_rt_vfs RTVfs - Virtual Filesystem
45	* @ingroup grp_rt
46	*
47	* The virtual filesystem APIs are intended to make it possible to work on
48	* container files, file system sub-trees, file system overlays and other custom
49	* filesystem configurations. It also makes it possible to create filters, like
50	* automatically gunzipping a tar.gz file before feeding it to the RTTar API for
51	* unpacking - or wise versa.
52	*
53	* The virtual filesystem APIs are intended to mirror the RTDir, RTFile, RTPath
54	* and RTFs APIs pretty closely so that rewriting a piece of code to work with
55	* it should be easy. However there are some differences to the way the APIs
56	* works and the user should heed the documentation. The differences are
57	* usually motivated by simplification and in some case to make the VFS more
58	* flexible.
59	*
60	* @{
61	*/
62
63	/**
64	* The object type.
65	*/
66	typedef enum RTVFSOBJTYPE
67	{
68	/** Invalid type. */
69	RTVFSOBJTYPE_INVALID = 0,
70	/** Pure base object.
71	* This is returned by the filesystem stream to represent directories,
72	* devices, fifos and similar that needs to be created. */
73	RTVFSOBJTYPE_BASE,
74	/** Virtual filesystem. */
75	RTVFSOBJTYPE_VFS,
76	/** Filesystem stream. */
77	RTVFSOBJTYPE_FS_STREAM,
78	/** Pure I/O stream. */
79	RTVFSOBJTYPE_IO_STREAM,
80	/** Directory. */
81	RTVFSOBJTYPE_DIR,
82	/** File. */
83	RTVFSOBJTYPE_FILE,
84	/** Symbolic link. */
85	RTVFSOBJTYPE_SYMLINK,
86	/** End of valid object types. */
87	RTVFSOBJTYPE_END,
88	/** Pure I/O stream. */
89	RTVFSOBJTYPE_32BIT_HACK = 0x7fffffff
90	} RTVFSOBJTYPE;
91	/** Pointer to a VFS object type. */
92	typedef RTVFSOBJTYPE *PRTVFSOBJTYPE;
93
94
95
96	/** @name RTVfsCreate flags
97	* @{ */
98	/** Whether the file system is read-only. */
99	#define RTVFS_C_READONLY RT_BIT(0)
100	/** Whether we the VFS should be thread safe (i.e. automaticaly employ
101	* locks). */
102	#define RTVFS_C_THREAD_SAFE RT_BIT(1)
103	/** @} */
104
105	/**
106	* Creates an empty virtual filesystem.
107	*
108	* @returns IPRT status code.
109	* @param pszName Name, for logging and such.
110	* @param fFlags Flags, MBZ.
111	* @param phVfs Where to return the VFS handle. Release the returned
112	* reference by calling RTVfsRelease.
113	*/
114	RTDECL(int) RTVfsCreate(const char *pszName, uint32_t fFlags, PRTVFS phVfs);
115	RTDECL(uint32_t) RTVfsRetain(RTVFS hVfs);
116	RTDECL(uint32_t) RTVfsRetainDebug(RTVFS hVfs, RT_SRC_POS_DECL);
117	RTDECL(uint32_t) RTVfsRelease(RTVFS hVfs);
118
119	/** @name RTVFSMNT_F_XXX - Flags for RTVfsMount
120	* @{ */
121	/** Mount read-only. */
122	#define RTVFSMNT_F_READ_ONLY RT_BIT_32(0)
123	/** Purpose is . */
124	#define RTVFSMNT_F_FOR_RANGE_IN_USE RT_BIT_32(1)
125	/** Valid mask. */
126	#define RTVFSMNT_F_VALID_MASK UINT32_C(0x00000003)
127	/** @} */
128
129	/**
130	* Does the file system detection and mounting.
131	*
132	* @returns IPRT status code.
133	* @retval VERR_VFS_UNSUPPORTED_FORMAT if not recognized as a support file
134	* system.
135	* @param hVfsFileIn The file handle of the volume.
136	* @param fFlags RTVFSMTN_F_XXX.
137	* @param phVfs Where to return the VFS handle on success.
138	* @param pErrInfo Where to return additional error information.
139	* Optional.
140	*/
141	RTDECL(int) RTVfsMountVol(RTVFSFILE hVfsFileIn, uint32_t fFlags, PRTVFS phVfs, PRTERRINFO pErrInfo);
142
143	RTDECL(int) RTVfsAttach(RTVFS hVfs, const char *pszMountPoint, uint32_t fFlags, RTVFS hVfsAttach);
144	RTDECL(int) RTVfsDetach(RTVFS hVfs, const char pszMountPoint, RTVFS hVfsToDetach, PRTVFS phVfsDetached);
145	RTDECL(uint32_t) RTVfsGetAttachmentCount(RTVFS hVfs);
146	RTDECL(int) RTVfsGetAttachment(RTVFS hVfs, uint32_t iOrdinal, PRTVFS phVfsAttached, uint32_t pfFlags,
147	char *pszMountPoint, size_t cbMountPoint);
148
149	/**
150	* Opens the root director of the given VFS.
151	*
152	* @returns IPRT status code.
153	* @param hVfs VFS handle.
154	* @param phDir Where to return the root directory handle.
155	*/
156	RTDECL(int) RTVfsOpenRoot(RTVFS hVfs, PRTVFSDIR phDir);
157
158	/**
159	* Queries information about a object in the virtual filesystem.
160	*
161	* @returns IPRT Status code.
162	* @param hVfs VFS handle.
163	* @param pszPath Path to the object, relative to the VFS root.
164	* @param pObjInfo Where to return info.
165	* @param enmAddAttr What to return.
166	* @param fFlags RTPATH_F_XXX.
167	* @sa RTPathQueryInfoEx, RTVfsDirQueryPathInfo, RTVfsObjQueryInfo
168	*/
169	RTDECL(int) RTVfsQueryPathInfo(RTVFS hVfs, const char *pszPath, PRTFSOBJINFO pObjInfo,
170	RTFSOBJATTRADD enmAddAttr, uint32_t fFlags);
171
172	/**
173	* Checks whether a given range is in use by the virtual filesystem.
174	*
175	* @returns IPRT status code.
176	* @param hVfs VFS handle.
177	* @param off Start offset to check.
178	* @param cb Number of bytes to check.
179	* @param pfUsed Where to store the result.
180	*/
181	RTDECL(int) RTVfsQueryRangeState(RTVFS hVfs, uint64_t off, size_t cb, bool *pfUsed);
182
183
184	/** @defgroup grp_vfs_obj VFS Base Object API
185	* @{
186	*/
187
188	/**
189	* Retains a reference to the VFS base object handle.
190	*
191	* @returns New reference count on success, UINT32_MAX on failure.
192	* @param hVfsObj The VFS base object handle.
193	*/
194	RTDECL(uint32_t) RTVfsObjRetain(RTVFSOBJ hVfsObj);
195	RTDECL(uint32_t) RTVfsObjRetainDebug(RTVFSOBJ hVfsObj, RT_SRC_POS_DECL);
196
197	/**
198	* Releases a reference to the VFS base handle.
199	*
200	* @returns New reference count on success (0 if closed), UINT32_MAX on failure.
201	* @param hVfsObj The VFS base object handle.
202	*/
203	RTDECL(uint32_t) RTVfsObjRelease(RTVFSOBJ hVfsObj);
204
205	/** @name RTVFSOBJ_F_XXX - Flags or RTVfsObjOpen and RTVfsDirOpenObj.
206	* @note Must leave space for RTPATH_F_XXX.
207	* @{ */
208	/** Directory (RTFS_TYPE_DIRECTORY). */
209	#define RTVFSOBJ_F_OPEN_DIRECTORY RT_BIT_32(8)
210	/** Symbolic link (RTFS_TYPE_SYMLINK). */
211	#define RTVFSOBJ_F_OPEN_SYMLINK RT_BIT_32(9)
212	/** Regular file (RTFS_TYPE_FILE). */
213	#define RTVFSOBJ_F_OPEN_FILE RT_BIT_32(10)
214	/** Character device (RTFS_TYPE_DEV_CHAR). */
215	#define RTVFSOBJ_F_OPEN_DEV_CHAR RT_BIT_32(11)
216	/** Block device (RTFS_TYPE_DEV_BLOCK). */
217	#define RTVFSOBJ_F_OPEN_DEV_BLOCK RT_BIT_32(12)
218	/** Named pipe (fifo) (RTFS_TYPE_FIFO). */
219	#define RTVFSOBJ_F_OPEN_FIFO RT_BIT_32(13)
220	/** Socket (RTFS_TYPE_SOCKET). */
221	#define RTVFSOBJ_F_OPEN_SOCKET RT_BIT_32(14)
222	/** Mounted VFS. */
223	#define RTVFSOBJ_F_OPEN_MOUNT RT_BIT_32(15)
224	/** Mask object types we wish to open. */
225	#define RTVFSOBJ_F_OPEN_MASK UINT32_C(0x0000ff00)
226	/** Any kind of object that translates to RTVFSOBJTYPE_FILE. */
227	#define RTVFSOBJ_F_OPEN_ANY_FILE (RTVFSOBJ_F_OPEN_FILE \| RTVFSOBJ_F_OPEN_DEV_BLOCK)
228	/** Any kind of object that translates to RTVFSOBJTYPE_IOS or
229	* RTVFSOBJTYPE_FILE. */
230	#define RTVFSOBJ_F_OPEN_ANY_IO_STREAM ( RTVFSOBJ_F_ANY_OPEN_FILE \| RTVFSOBJ_F_DEV_OPEN_BLOCK \
231	\| RTVFSOBJ_F_OPEN_FIFO \| RTVFSOBJ_F_OPEN_SOCKET)
232	/** Any kind of object. */
233	#define RTVFSOBJ_F_OPEN_ANY RTVFSOBJ_F_OPEN_MASK
234
235	/** Do't create anything, return file not found. */
236	#define RTVFSOBJ_F_CREATE_NOTHING UINT32_C(0x00000000)
237	/** Create a file if the if the object was not found and the RTFILE_O_XXX
238	* flags allows it. */
239	#define RTVFSOBJ_F_CREATE_FILE UINT32_C(0x00010000)
240	/** Create a directory if the object was not found and the RTFILE_O_XXX
241	* flags allows it. */
242	#define RTVFSOBJ_F_CREATE_DIRECTORY UINT32_C(0x00020000)
243	/** The creation type mask. */
244	#define RTVFSOBJ_F_CREATE_MASK UINT32_C(0x00070000)
245
246	/** Indicate that this call is for traversal.
247	* @internal only */
248	#define RTVFSOBJ_F_TRAVERSAL RT_BIT_32(31)
249	/** Valid mask for external callers. */
250	#define RTVFSOBJ_F_VALID_MASK UINT32_C(0x0007ff00)
251	/** @} */
252
253	/**
254	* Opens any file system object in the given VFS.
255	*
256	* @returns IPRT status code.
257	* @param hVfs The VFS to open the object within.
258	* @param pszPath Path to the file.
259	* @param fFileOpen RTFILE_O_XXX flags.
260	* @param fObjFlags More flags: RTVFSOBJ_F_XXX, RTPATH_F_XXX.
261	* @param phVfsObj Where to return the object handle.
262	* @sa RTVfsDirOpenObj, RTVfsDirOpenDir, RTVfsDirOpenFile
263	*/
264	RTDECL(int) RTVfsObjOpen(RTVFS hVfs, const char *pszPath, uint64_t fFileOpen, uint32_t fObjFlags, PRTVFSOBJ phVfsObj);
265
266	/**
267	* Query information about the object.
268	*
269	* @returns IPRT status code.
270	* @retval VERR_NOT_SUPPORTED if the @a enmAddAttr value is not handled by the
271	* implementation.
272	*
273	* @param hVfsObj The VFS object handle.
274	* @param pObjInfo Where to return the info.
275	* @param enmAddAttr Which additional attributes should be retrieved.
276	* @sa RTVfsIoStrmQueryInfo, RTVfsFileQueryInfo, RTFileQueryInfo,
277	* RTPathQueryInfo
278	*/
279	RTDECL(int) RTVfsObjQueryInfo(RTVFSOBJ hVfsObj, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
280
281	/**
282	* Sets the file mode for the given VFS object.
283	*
284	* @returns IPRT status code.
285	* @retval VERR_INVALID_FUNCTION if the object type has no file mode to set.
286	* Only directories, files and symbolic links support this operation.
287	*
288	* @param hVfsObj The VFS object handle.
289	* @param fMode The mode mask.
290	* @param fMask The bits in the mode mask which should be changed.
291	*/
292	RTDECL(int) RTVfsObjSetMode(RTVFSOBJ hVfsObj, RTFMODE fMode, RTFMODE fMask);
293
294	/**
295	* Sets one or more timestamps for the given VFS object.
296	*
297	* @returns IPRT status code.
298	* @retval VERR_INVALID_FUNCTION if the object type has no file mode to set.
299	* Only directories, files and symbolic links support this operation.
300	*
301	* @param hVfsObj The VFS object handle.
302	* @param pAccessTime Pointer to the new access time. NULL if not to
303	* be changed.
304	* @param pModificationTime Pointer to the new modifcation time. NULL if not
305	* to be changed.
306	* @param pChangeTime Pointer to the new change time. NULL if not to
307	* be changed.
308	* @param pBirthTime Pointer to the new time of birth. NULL if not to
309	* be changed.
310	*
311	* @remarks See RTFileSetTimes for restrictions and behavior imposed by the
312	* host OS or underlying VFS provider.
313	* @sa RTFileSetTimes, RTPathSetTimes
314	*/
315	RTDECL(int) RTVfsObjSetTimes(RTVFSOBJ hVfsObj, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
316	PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime);
317
318	/**
319	* Set the unix style owner and group on the given VFS object.
320	*
321	* @returns IPRT status code.
322	* @retval VERR_INVALID_FUNCTION if the object type has no file mode to set.
323	* Only directories, files and symbolic links support this operation.
324	*
325	* @param hVfsObj The VFS object handle.
326	* @param uid The user ID of the new owner. NIL_RTUID if
327	* unchanged.
328	* @param gid The group ID of the new owner group. NIL_RTGID if
329	* unchanged.
330	*
331	* @sa RTFileSetOwner, RTPathSetOwner.
332	*/
333	RTDECL(int) RTVfsObjSetOwner(RTVFSOBJ hVfsObj, RTUID uid, RTGID gid);
334
335
336	/**
337	* Gets the type of a VFS object.
338	*
339	* @returns The VFS object type on success, RTVFSOBJTYPE_INVALID on failure.
340	* @param hVfsObj The VFS base object handle.
341	*/
342	RTDECL(RTVFSOBJTYPE) RTVfsObjGetType(RTVFSOBJ hVfsObj);
343
344	/**
345	* Converts a VFS base object handle to a VFS handle.
346	*
347	* @returns Referenced handle on success, NIL on failure.
348	* @param hVfsObj The VFS base object handle.
349	*/
350	RTDECL(RTVFS) RTVfsObjToVfs(RTVFSOBJ hVfsObj);
351
352	/**
353	* Converts a VFS base object handle to a VFS filesystem stream handle.
354	*
355	* @returns Referenced handle on success, NIL on failure.
356	* @param hVfsObj The VFS base object handle.
357	*/
358	RTDECL(RTVFSFSSTREAM) RTVfsObjToFsStream(RTVFSOBJ hVfsObj);
359
360	/**
361	* Converts a VFS base object handle to a VFS directory handle.
362	*
363	* @returns Referenced handle on success, NIL on failure.
364	* @param hVfsObj The VFS base object handle.
365	*/
366	RTDECL(RTVFSDIR) RTVfsObjToDir(RTVFSOBJ hVfsObj);
367
368	/**
369	* Converts a VFS base object handle to a VFS I/O stream handle.
370	*
371	* @returns Referenced handle on success, NIL on failure.
372	* @param hVfsObj The VFS base object handle.
373	*/
374	RTDECL(RTVFSIOSTREAM) RTVfsObjToIoStream(RTVFSOBJ hVfsObj);
375
376	/**
377	* Converts a VFS base object handle to a VFS file handle.
378	*
379	* @returns Referenced handle on success, NIL on failure.
380	* @param hVfsObj The VFS base object handle.
381	*/
382	RTDECL(RTVFSFILE) RTVfsObjToFile(RTVFSOBJ hVfsObj);
383
384	/**
385	* Converts a VFS base object handle to a VFS symbolic link handle.
386	*
387	* @returns Referenced handle on success, NIL on failure.
388	* @param hVfsObj The VFS base object handle.
389	*/
390	RTDECL(RTVFSSYMLINK) RTVfsObjToSymlink(RTVFSOBJ hVfsObj);
391
392
393	/**
394	* Converts a VFS handle to a VFS base object handle.
395	*
396	* @returns Referenced handle on success, NIL if the input handle was invalid.
397	* @param hVfs The VFS handle.
398	*/
399	RTDECL(RTVFSOBJ) RTVfsObjFromVfs(RTVFS hVfs);
400
401	/**
402	* Converts a VFS filesystem stream handle to a VFS base object handle.
403	*
404	* @returns Referenced handle on success, NIL if the input handle was invalid.
405	* @param hVfsFss The VFS filesystem stream handle.
406	*/
407	RTDECL(RTVFSOBJ) RTVfsObjFromFsStream(RTVFSFSSTREAM hVfsFss);
408
409	/**
410	* Converts a VFS directory handle to a VFS base object handle.
411	*
412	* @returns Referenced handle on success, NIL if the input handle was invalid.
413	* @param hVfsDir The VFS directory handle.
414	*/
415	RTDECL(RTVFSOBJ) RTVfsObjFromDir(RTVFSDIR hVfsDir);
416
417	/**
418	* Converts a VFS I/O stream handle to a VFS base object handle.
419	*
420	* @returns Referenced handle on success, NIL if the input handle was invalid.
421	* @param hVfsIos The VFS I/O stream handle.
422	*/
423	RTDECL(RTVFSOBJ) RTVfsObjFromIoStream(RTVFSIOSTREAM hVfsIos);
424
425	/**
426	* Converts a VFS file handle to a VFS base object handle.
427	*
428	* @returns Referenced handle on success, NIL if the input handle was invalid.
429	* @param hVfsFile The VFS file handle.
430	*/
431	RTDECL(RTVFSOBJ) RTVfsObjFromFile(RTVFSFILE hVfsFile);
432
433	/**
434	* Converts a VFS symbolic link handle to a VFS base object handle.
435	*
436	* @returns Referenced handle on success, NIL if the input handle was invalid.
437	* @param hVfsSym The VFS symbolic link handle.
438	*/
439	RTDECL(RTVFSOBJ) RTVfsObjFromSymlink(RTVFSSYMLINK hVfsSym);
440
441	/** @} */
442
443
444	/** @defgroup grp_vfs_fsstream VFS Filesystem Stream API
445	*
446	* Filesystem streams are for tar, cpio and similar. Any virtual filesystem can
447	* be turned into a filesystem stream using RTVfsFsStrmFromVfs.
448	*
449	* @{
450	*/
451
452	RTDECL(uint32_t) RTVfsFsStrmRetain(RTVFSFSSTREAM hVfsFss);
453	RTDECL(uint32_t) RTVfsFsStrmRetainDebug(RTVFSFSSTREAM hVfsFss, RT_SRC_POS_DECL);
454	RTDECL(uint32_t) RTVfsFsStrmRelease(RTVFSFSSTREAM hVfsFss);
455	RTDECL(int) RTVfsFsStrmQueryInfo(RTVFSFSSTREAM hVfsFss, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
456
457	/**
458	* Gets the next object in the stream.
459	*
460	* This call may affect the stream posision of a previously returned object.
461	*
462	* The type of object returned here typically boils down to three types:
463	* - I/O streams (representing files),
464	* - symbolic links
465	* - base object
466	* The base objects represent anything not convered by the two other, i.e.
467	* directories, device nodes, fifos, sockets and whatnot. The details can be
468	* queried using RTVfsObjQueryInfo.
469	*
470	* That said, absolutely any object except for filesystem stream objects can be
471	* returned by this call. Any generic code is adviced to just deal with it all.
472	*
473	* @returns IPRT status code.
474	* @retval VINF_SUCCESS if a new object was retrieved.
475	* @retval VERR_EOF when there are no more objects.
476	* @retval VERR_INVALID_FUNCTION if called on a non-readable stream.
477	*
478	* @param hVfsFss The file system stream handle.
479	* @param ppszName Where to return the object name. Must be freed by
480	* calling RTStrFree.
481	* @param penmType Where to return the object type.
482	* @param phVfsObj Where to return the object handle (referenced). This
483	* must be cast to the desired type before use.
484	*/
485	RTDECL(int) RTVfsFsStrmNext(RTVFSFSSTREAM hVfsFss, char *ppszName, RTVFSOBJTYPE penmType, PRTVFSOBJ phVfsObj);
486
487	/**
488	* Appends a VFS object to the stream.
489	*
490	* The stream must be writable.
491	*
492	* @returns IPRT status code.
493	* @retval VERR_INVALID_FUNCTION if called on a non-writable stream.
494	* @param hVfsFss The file system stream handle.
495	* @param pszPath The path.
496	* @param hVfsObj The VFS object to add.
497	* @param fFlags RTVFSFSSTRM_ADD_F_XXX.
498	*/
499	RTDECL(int) RTVfsFsStrmAdd(RTVFSFSSTREAM hVfsFss, const char *pszPath, RTVFSOBJ hVfsObj, uint32_t fFlags);
500
501	/** @name RTVFSFSSTRM_ADD_F_XXX - Flags for RTVfsFsStrmAdd.
502	* @{ */
503	/** Input is an I/O stream of indeterminate length, read to the end and then
504	* update the file header.
505	* @note This is only possible if the output stream is actually a file. */
506	#define RTVFSFSSTRM_ADD_F_STREAM RT_BIT_32(0)
507	/** Mask of flags specific to the target stream. */
508	#define RTVFSFSSTRM_ADD_F_SPECIFIC_MASK UINT32_C(0xff000000)
509	/** Valid bits. */
510	#define RTVFSFSSTRM_ADD_F_VALID_MASK UINT32_C(0xff000001)
511	/** @} */
512
513	/**
514	* Pushes an byte stream onto the stream.
515	*
516	* The stream must be writable.
517	*
518	* This differs from RTVfsFsStrmAdd() in that it will create a regular file in
519	* the output file system stream and provide the actual content bytes via the
520	* returned I/O stream object.
521	*
522	* @returns IPRT status code.
523	* @retval VERR_INVALID_FUNCTION if called on a non-writable stream.
524	* @param hVfsFss The file system stream handle.
525	* @param pszPath The path to the file.
526	* @param cbFile The file size. This can also be set to UINT64_MAX if
527	* the file system stream is backed by a file.
528	* @param paObjInfo Array of zero or more RTFSOBJINFO structures containing
529	* different pieces of information about the file. If any
530	* provided, the first one should be a RTFSOBJATTRADD_UNIX
531	* one, additional can be supplied if wanted. What exactly
532	* is needed depends on the underlying FS stream
533	* implementation.
534	* @param cObjInfo Number of items in the array @a paObjInfo points at.
535	* @param fFlags RTVFSFSSTRM_PUSH_F_XXX.
536	* @param phVfsIos Where to return the I/O stream to feed the file content
537	* to. If the FS stream is backed by a file, the returned
538	* handle can be cast to a file if necessary.
539	*/
540	RTDECL(int) RTVfsFsStrmPushFile(RTVFSFSSTREAM hVfsFss, const char *pszPath, uint64_t cbFile,
541	PCRTFSOBJINFO paObjInfo, uint32_t cObjInfo, uint32_t fFlags, PRTVFSIOSTREAM phVfsIos);
542
543	/** @name RTVFSFSSTRM_PUSH_F_XXX - Flags for RTVfsFsStrmPushFile.
544	* @{ */
545	/** Input is an I/O stream of indeterminate length, read to the end and then
546	* update the file header.
547	* @note This is only possible if the output stream is actually a file. */
548	#define RTVFSFSSTRM_PUSH_F_STREAM RT_BIT_32(0)
549	/** Mask of flags specific to the target stream. */
550	#define RTVFSFSSTRM_PUSH_F_SPECIFIC_MASK UINT32_C(0xff000000)
551	/** Valid bits. */
552	#define RTVFSFSSTRM_PUSH_F_VALID_MASK UINT32_C(0xff000001)
553	/** @} */
554
555	/**
556	* Marks the end of the stream.
557	*
558	* The stream must be writable.
559	*
560	* @returns IPRT status code.
561	* @retval VERR_INVALID_FUNCTION if called on a non-writable stream.
562	* @param hVfsFss The file system stream handle.
563	*/
564	RTDECL(int) RTVfsFsStrmEnd(RTVFSFSSTREAM hVfsFss);
565
566	/** @} */
567
568
569	/** @defgroup grp_vfs_dir VFS Directory API
570	* @{
571	*/
572
573	/**
574	* Retains a reference to the VFS directory handle.
575	*
576	* @returns New reference count on success, UINT32_MAX on failure.
577	* @param hVfsDir The VFS directory handle.
578	*/
579	RTDECL(uint32_t) RTVfsDirRetain(RTVFSDIR hVfsDir);
580	RTDECL(uint32_t) RTVfsDirRetainDebug(RTVFSDIR hVfsDir, RT_SRC_POS_DECL);
581
582	/**
583	* Releases a reference to the VFS directory handle.
584	*
585	* @returns New reference count on success (0 if closed), UINT32_MAX on failure.
586	* @param hVfsDir The VFS directory handle.
587	*/
588	RTDECL(uint32_t) RTVfsDirRelease(RTVFSDIR hVfsDir);
589
590	/**
591	* Opens a directory in the specified file system.
592	*
593	* @returns IPRT status code.
594	* @param hVfs The VFS to open the directory within.
595	* @param pszPath Path to the directory, relative to the root.
596	* @param fFlags Reserved, MBZ.
597	* @param phVfsDir Where to return the directory.
598	*/
599	RTDECL(int) RTVfsDirOpen(RTVFS hVfs, const char *pszPath, uint32_t fFlags, PRTVFSDIR phVfsDir);
600
601	/**
602	* Opens any file system object in or under the given directory.
603	*
604	* @returns IPRT status code.
605	* @param hVfsDir The VFS directory start walking the @a pszPath
606	* relative to.
607	* @param pszPath Path to the file.
608	* @param fFileOpen RTFILE_O_XXX flags.
609	* @param fObjFlags More flags: RTVFSOBJ_F_XXX, RTPATH_F_XXX.
610	* @param phVfsObj Where to return the object handle.
611	* @sa RTVfsObjOpen, RTVfsDirOpenDir, RTVfsDirOpenFile
612	*/
613	RTDECL(int) RTVfsDirOpenObj(RTVFSDIR hVfsDir, const char *pszPath, uint64_t fFileOpen, uint32_t fObjFlags, PRTVFSOBJ phVfsObj);
614
615	/**
616	* Opens a file in or under the given directory.
617	*
618	* @returns IPRT status code.
619	* @param hVfsDir The VFS directory start walking the @a pszPath
620	* relative to.
621	* @param pszPath Path to the file.
622	* @param fOpen RTFILE_O_XXX flags.
623	* @param phVfsFile Where to return the file.
624	* @sa RTVfsDirOpenFileAsIoStream
625	*/
626	RTDECL(int) RTVfsDirOpenFile(RTVFSDIR hVfsDir, const char *pszPath, uint64_t fOpen, PRTVFSFILE phVfsFile);
627
628	/**
629	* Convenience wrapper around RTVfsDirOpenFile that returns an I/O stream.
630	*
631	* @returns IPRT status code.
632	* @param hVfsDir The VFS directory start walking the @a pszPath
633	* relative to.
634	* @param pszPath Path to the file.
635	* @param fOpen RTFILE_O_XXX flags.
636	* @param phVfsIos Where to return the I/O stream handle of the file.
637	* @sa RTVfsDirOpenFile
638	*/
639	RTDECL(int) RTVfsDirOpenFileAsIoStream(RTVFSDIR hVfsDir, const char *pszPath, uint64_t fOpen, PRTVFSIOSTREAM phVfsIos);
640
641	/**
642	* Opens a directory in or under the given directory.
643	*
644	* @returns IPRT status code.
645	* @param hVfsDir The VFS directory start walking the @a pszPath
646	* relative to.
647	* @param pszPath Path to the file.
648	* @param fFlags Reserved, MBZ.
649	* @param phVfsDir Where to return the directory.
650	*/
651	RTDECL(int) RTVfsDirOpenDir(RTVFSDIR hVfsDir, const char *pszPath, uint32_t fFlags, PRTVFSDIR phVfsDir);
652
653	/**
654	* Creates a directory relative to @a hVfsDir.
655	*
656	* @returns IPRT status code
657	* @param hVfsDir The directory the path is relative to.
658	* @param pszRelPath The relative path to the new directory.
659	* @param fMode The file mode for the new directory.
660	* @param fFlags Directory creation flags, RTDIRCREATE_FLAGS_XXX.
661	* @param phVfsDir Where to return the handle to the newly created
662	* directory. Optional.
663	* @sa RTDirCreate, RTDirRelDirCreate
664	*/
665	RTDECL(int) RTVfsDirCreateDir(RTVFSDIR hVfsDir, const char *pszRelPath, RTFMODE fMode, uint32_t fFlags, PRTVFSDIR phVfsDir);
666
667	/**
668	* Create a VFS directory handle from a standard IPRT directory handle (RTDIR).
669	*
670	* @returns IPRT status code.
671	* @param hDir The standard IPRT directory handle.
672	* @param fLeaveOpen Whether to leave the handle open when the VFS
673	* directory is released, or to close it (@c false).
674	* @param phVfsDir Where to return the VFS directory handle.
675	*/
676	RTDECL(int) RTVfsDirFromRTDir(RTDIR hDir, bool fLeaveOpen, PRTVFSDIR phVfsDir);
677
678	/**
679	* RTDirOpen + RTVfsDirFromRTDir.
680	*
681	* @returns IPRT status code.
682	* @param pszPath The path to the directory.
683	* @param fFlags RTDIR_F_XXX.
684	* @param phVfsDir Where to return the VFS directory handle.
685	*/
686	RTDECL(int) RTVfsDirOpenNormal(const char *pszPath, uint32_t fFlags, PRTVFSDIR phVfsDir);
687
688	/**
689	* Queries information about a object in or under the given directory.
690	*
691	* @returns IPRT Status code.
692	* @param hVfsDir The VFS directory start walking the @a pszPath
693	* relative to.
694	* @param pszPath Path to the object.
695	* @param pObjInfo Where to return info.
696	* @param enmAddAttr What to return.
697	* @param fFlags RTPATH_F_XXX.
698	* @sa RTPathQueryInfoEx, RTVfsQueryPathInfo, RTVfsObjQueryInfo
699	*/
700	RTDECL(int) RTVfsDirQueryPathInfo(RTVFSDIR hVfsDir, const char *pszPath, PRTFSOBJINFO pObjInfo,
701	RTFSOBJATTRADD enmAddAttr, uint32_t fFlags);
702
703	/**
704	* Removes a directory relative to @a hVfsDir.
705	*
706	* @returns IPRT status code.
707	* @param hVfsDir The VFS directory to start walking the @a pszRelPath
708	* relative to.
709	* @param pszRelPath The path to the directory that should be removed.
710	* @param fFlags Reserved, MBZ.
711	*/
712	RTDECL(int) RTVfsDirRemoveDir(RTVFSDIR hVfsDir, const char *pszRelPath, uint32_t fFlags);
713
714	/**
715	* Reads the next entry in the directory returning extended information.
716	*
717	* @returns VINF_SUCCESS and data in pDirEntry on success.
718	* @returns VERR_NO_MORE_FILES when the end of the directory has been reached.
719	* @returns VERR_BUFFER_OVERFLOW if the buffer is too small to contain the filename. If
720	* pcbDirEntry is specified it will be updated with the required buffer size.
721	* @returns suitable iprt status code on other errors.
722	*
723	* @param hVfsDir The VFS directory.
724	* @param pDirEntry Where to store the information about the next
725	* directory entry on success.
726	* @param pcbDirEntry Optional parameter used for variable buffer size.
727	*
728	* On input the variable pointed to contains the size of the pDirEntry
729	* structure. This must be at least OFFSET(RTDIRENTRYEX, szName[2]) bytes.
730	*
731	* On successful output the field is updated to
732	* OFFSET(RTDIRENTRYEX, szName[pDirEntry->cbName + 1]).
733	*
734	* When the data doesn't fit in the buffer and VERR_BUFFER_OVERFLOW is
735	* returned, this field contains the required buffer size.
736	*
737	* The value is unchanged in all other cases.
738	* @param enmAddAttr Which set of additional attributes to request.
739	* Use RTFSOBJATTRADD_NOTHING if this doesn't matter.
740	*
741	* @sa RTDirReadEx
742	*/
743	RTDECL(int) RTVfsDirReadEx(RTVFSDIR hVfsDir, PRTDIRENTRYEX pDirEntry, size_t *pcbDirEntry, RTFSOBJATTRADD enmAddAttr);
744
745	/** @} */
746
747
748	/** @defgroup grp_vfs_symlink VFS Symbolic Link API
749	*
750	* @remarks The TAR VFS and filesystem stream uses symbolic links for
751	* describing hard links as well. The users must use RTFS_IS_SYMLINK
752	* to check if it is a real symlink in those cases.
753	*
754	* @remarks Any VFS which is backed by a real file system may be subject to
755	* races with other processes or threads, so the user may get
756	* unexpected errors when this happends. This is a bit host specific,
757	* i.e. it might be prevent on windows if we care.
758	*
759	* @{
760	*/
761
762
763	/**
764	* Retains a reference to the VFS symbolic link handle.
765	*
766	* @returns New reference count on success, UINT32_MAX on failure.
767	* @param hVfsSym The VFS symbolic link handle.
768	*/
769	RTDECL(uint32_t) RTVfsSymlinkRetain(RTVFSSYMLINK hVfsSym);
770	RTDECL(uint32_t) RTVfsSymlinkRetainDebug(RTVFSSYMLINK hVfsSym, RT_SRC_POS_DECL);
771
772	/**
773	* Releases a reference to the VFS symbolic link handle.
774	*
775	* @returns New reference count on success (0 if closed), UINT32_MAX on failure.
776	* @param hVfsSym The VFS symbolic link handle.
777	*/
778	RTDECL(uint32_t) RTVfsSymlinkRelease(RTVFSSYMLINK hVfsSym);
779
780	/**
781	* Query information about the symbolic link.
782	*
783	* @returns IPRT status code.
784	* @param hVfsSym The VFS symbolic link handle.
785	* @param pObjInfo Where to return the info.
786	* @param enmAddAttr Which additional attributes should be retrieved.
787	*
788	* @sa RTFileQueryInfo, RTPathQueryInfo, RTPathQueryInfoEx
789	*/
790	RTDECL(int) RTVfsSymlinkQueryInfo(RTVFSSYMLINK hVfsSym, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
791
792	/**
793	* Set the unix style owner and group.
794	*
795	* @returns IPRT status code.
796	* @param hVfsSym The VFS symbolic link handle.
797	* @param fMode The new mode bits.
798	* @param fMask The mask indicating which bits we are changing.
799	* @sa RTFileSetMode, RTPathSetMode
800	*/
801	RTDECL(int) RTVfsSymlinkSetMode(RTVFSSYMLINK hVfsSym, RTFMODE fMode, RTFMODE fMask);
802
803	/**
804	* Set the timestamps associated with the object.
805	*
806	* @returns IPRT status code.
807	* @param hVfsSym The VFS symbolic link handle.
808	* @param pAccessTime Pointer to the new access time. NULL if not
809	* to be changed.
810	* @param pModificationTime Pointer to the new modifcation time. NULL if
811	* not to be changed.
812	* @param pChangeTime Pointer to the new change time. NULL if not to be
813	* changed.
814	* @param pBirthTime Pointer to the new time of birth. NULL if not to be
815	* changed.
816	* @remarks See RTFileSetTimes for restrictions and behavior imposed by the
817	* host OS or underlying VFS provider.
818	* @sa RTFileSetTimes, RTPathSetTimes
819	*/
820	RTDECL(int) RTVfsSymlinkSetTimes(RTVFSSYMLINK hVfsSym, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
821	PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime);
822
823	/**
824	* Set the unix style owner and group.
825	*
826	* @returns IPRT status code.
827	* @param hVfsSym The VFS symbolic link handle.
828	* @param uid The user ID of the new owner. NIL_RTUID if
829	* unchanged.
830	* @param gid The group ID of the new owner group. NIL_RTGID if
831	* unchanged.
832	* @sa RTFileSetOwner, RTPathSetOwner.
833	*/
834	RTDECL(int) RTVfsSymlinkSetOwner(RTVFSSYMLINK hVfsSym, RTUID uid, RTGID gid);
835
836	/**
837	* Read the symbolic link target.
838	*
839	* @returns IPRT status code.
840	* @param hVfsSym The VFS symbolic link handle.
841	* @param pszTarget The target buffer.
842	* @param cbTarget The size of the target buffer.
843	* @sa RTSymlinkRead
844	*/
845	RTDECL(int) RTVfsSymlinkRead(RTVFSSYMLINK hVfsSym, char *pszTarget, size_t cbTarget);
846
847	/** @} */
848
849
850
851	/** @defgroup grp_vfs_iostream VFS I/O Stream API
852	* @{
853	*/
854
855	/**
856	* Creates a VFS file from a memory buffer.
857	*
858	* @returns IPRT status code.
859	*
860	* @param fFlags A combination of RTFILE_O_READ and RTFILE_O_WRITE.
861	* @param pvBuf The buffer. This will be copied and not referenced
862	* after this function returns.
863	* @param cbBuf The buffer size.
864	* @param phVfsIos Where to return the VFS I/O stream handle.
865	*/
866	RTDECL(int) RTVfsIoStrmFromBuffer(uint32_t fFlags, void const *pvBuf, size_t cbBuf, PRTVFSIOSTREAM phVfsIos);
867
868	/**
869	* Creates a VFS I/O stream handle from a standard IPRT file handle (RTFILE).
870	*
871	* @returns IPRT status code.
872	* @param hFile The standard IPRT file handle.
873	* @param fOpen The flags the handle was opened with. Pass 0 to
874	* have these detected.
875	* @param fLeaveOpen Whether to leave the handle open when the VFS file
876	* is released, or to close it (@c false).
877	* @param phVfsIos Where to return the VFS I/O stream handle.
878	*/
879	RTDECL(int) RTVfsIoStrmFromRTFile(RTFILE hFile, uint64_t fOpen, bool fLeaveOpen, PRTVFSIOSTREAM phVfsIos);
880
881	/**
882	* Creates a VFS I/O stream handle from a standard IPRT pipe handle (RTPIPE).
883	*
884	* @returns IPRT status code.
885	* @param hPipe The standard IPRT pipe handle.
886	* @param fLeaveOpen Whether to leave the handle open when the VFS file
887	* is released, or to close it (@c false).
888	* @param phVfsIos Where to return the VFS I/O stream handle.
889	*/
890	RTDECL(int) RTVfsIoStrmFromRTPipe(RTPIPE hPipe, bool fLeaveOpen, PRTVFSIOSTREAM phVfsIos);
891
892	/**
893	* Convenience function combining RTFileOpen with RTVfsIoStrmFromRTFile.
894	*
895	* @returns IPRT status code.
896	* @param pszFilename The path to the file in the normal file system.
897	* @param fOpen The flags to pass to RTFileOpen when opening the
898	* file, i.e. RTFILE_O_XXX.
899	* @param phVfsIos Where to return the VFS I/O stream handle.
900	*/
901	RTDECL(int) RTVfsIoStrmOpenNormal(const char *pszFilename, uint64_t fOpen, PRTVFSIOSTREAM phVfsIos);
902
903	/**
904	* Create a VFS I/O stream handle from one of the standard handles.
905	*
906	* @returns IPRT status code.
907	* @param enmStdHandle The standard IPRT file handle.
908	* @param fOpen The flags the handle was opened with. Pass 0 to
909	* have these detected.
910	* @param fLeaveOpen Whether to leave the handle open when the VFS file
911	* is released, or to close it (@c false).
912	* @param phVfsIos Where to return the VFS I/O stream handle.
913	*/
914	RTDECL(int) RTVfsIoStrmFromStdHandle(RTHANDLESTD enmStdHandle, uint64_t fOpen, bool fLeaveOpen,
915	PRTVFSIOSTREAM phVfsIos);
916
917	/**
918	* Retains a reference to the VFS I/O stream handle.
919	*
920	* @returns New reference count on success, UINT32_MAX on failure.
921	* @param hVfsIos The VFS I/O stream handle.
922	*/
923	RTDECL(uint32_t) RTVfsIoStrmRetain(RTVFSIOSTREAM hVfsIos);
924	RTDECL(uint32_t) RTVfsIoStrmRetainDebug(RTVFSIOSTREAM hVfsIos, RT_SRC_POS_DECL);
925
926	/**
927	* Releases a reference to the VFS I/O stream handle.
928	*
929	* @returns New reference count on success (0 if closed), UINT32_MAX on failure.
930	* @param hVfsIos The VFS I/O stream handle.
931	*/
932	RTDECL(uint32_t) RTVfsIoStrmRelease(RTVFSIOSTREAM hVfsIos);
933
934	/**
935	* Convert the VFS I/O stream handle to a VFS file handle.
936	*
937	* @returns The VFS file handle on success, this must be released.
938	* NIL_RTVFSFILE if the I/O stream handle is invalid.
939	* @param hVfsIos The VFS I/O stream handle.
940	* @sa RTVfsFileToIoStream
941	*/
942	RTDECL(RTVFSFILE) RTVfsIoStrmToFile(RTVFSIOSTREAM hVfsIos);
943
944	/**
945	* Query information about the I/O stream.
946	*
947	* @returns IPRT status code.
948	* @param hVfsIos The VFS I/O stream handle.
949	* @param pObjInfo Where to return the info.
950	* @param enmAddAttr Which additional attributes should be retrieved.
951	* @sa RTFileQueryInfo
952	*/
953	RTDECL(int) RTVfsIoStrmQueryInfo(RTVFSIOSTREAM hVfsIos, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
954
955	/**
956	* Read bytes from the I/O stream.
957	*
958	* @returns IPRT status code.
959	* @retval VINF_SUCCESS and the number of bytes read written to @a pcbRead.
960	* @retval VINF_TRY_AGAIN if @a fBlocking is @c false, @a pcbRead is not NULL,
961	* and no data was available. @a *pcbRead will be set to 0.
962	* @retval VINF_EOF when trying to read __beyond__ the end of the stream and
963	* @a pcbRead is not NULL (it will be set to the number of bytes read,
964	* or 0 if the end of the stream was reached before this call).
965	* When the last byte of the read request is the last byte in the
966	* stream, this status code will not be used. However, VINF_EOF is
967	* returned when attempting to read 0 bytes while standing at the end
968	* of the stream.
969	* @retval VERR_EOF when trying to read __beyond__ the end of the stream and
970	* @a pcbRead is NULL.
971	* @retval VERR_ACCESS_DENIED if the stream is not readable.
972	*
973	* @param hVfsIos The VFS I/O stream handle.
974	* @param pvBuf Where to store the read bytes.
975	* @param cbToRead The number of bytes to read.
976	* @param fBlocking Whether the call is blocking (@c true) or not. If
977	* not, the @a pcbRead parameter must not be NULL.
978	* @param pcbRead Where to always store the number of bytes actually
979	* read. This can be NULL if @a fBlocking is true.
980	* @sa RTVfsFileRead, RTFileRead, RTPipeRead, RTPipeReadBlocking,
981	* RTSocketRead
982	*/
983	RTDECL(int) RTVfsIoStrmRead(RTVFSIOSTREAM hVfsIos, void pvBuf, size_t cbToRead, bool fBlocking, size_t pcbRead);
984
985	/**
986	* Read bytes from the I/O stream, optionally with offset.
987	*
988	* @returns IPRT status code.
989	* @retval VINF_SUCCESS and the number of bytes read written to @a pcbRead.
990	* @retval VINF_TRY_AGAIN if @a fBlocking is @c false, @a pcbRead is not NULL,
991	* and no data was available. @a *pcbRead will be set to 0.
992	* @retval VINF_EOF when trying to read __beyond__ the end of the stream and
993	* @a pcbRead is not NULL (it will be set to the number of bytes read,
994	* or 0 if the end of the stream was reached before this call).
995	* When the last byte of the read request is the last byte in the
996	* stream, this status code will not be used. However, VINF_EOF is
997	* returned when attempting to read 0 bytes while standing at the end
998	* of the stream.
999	* @retval VERR_EOF when trying to read __beyond__ the end of the stream and
1000	* @a pcbRead is NULL.
1001	* @retval VERR_ACCESS_DENIED if the stream is not readable.
1002	*
1003	* @param hVfsIos The VFS I/O stream handle.
1004	* @param off Where to read at, -1 for the current position.
1005	* @param pvBuf Where to store the read bytes.
1006	* @param cbToRead The number of bytes to read.
1007	* @param fBlocking Whether the call is blocking (@c true) or not. If
1008	* not, the @a pcbRead parameter must not be NULL.
1009	* @param pcbRead Where to always store the number of bytes actually
1010	* read. This can be NULL if @a fBlocking is true.
1011	* @sa RTVfsFileRead, RTFileRead, RTPipeRead, RTPipeReadBlocking,
1012	* RTSocketRead
1013	*/
1014	RTDECL(int) RTVfsIoStrmReadAt(RTVFSIOSTREAM hVfsIos, RTFOFF off, void pvBuf, size_t cbToRead, bool fBlocking, size_t pcbRead);
1015
1016	/**
1017	* Reads the remainder of the stream into a memory buffer.
1018	*
1019	* For simplifying string-style processing, the is a zero byte after the
1020	* returned buffer, making sure it can be used as a zero terminated string.
1021	*
1022	* @returns IPRT status code.
1023	* @param hVfsIos The VFS I/O stream handle.
1024	* @param ppvBuf Where to return the buffer. Must pass to
1025	* RTVfsIoStrmReadAllFree for freeing, not RTMemFree!
1026	* @param pcbBuf Where to return the buffer size.
1027	*/
1028	RTDECL(int) RTVfsIoStrmReadAll(RTVFSIOSTREAM hVfsIos, void *ppvBuf, size_t pcbBuf);
1029
1030	/**
1031	* Free memory buffer returned by RTVfsIoStrmReadAll.
1032	*
1033	* @param pvBuf What RTVfsIoStrmReadAll returned.
1034	* @param cbBuf What RTVfsIoStrmReadAll returned.
1035	*/
1036	RTDECL(void) RTVfsIoStrmReadAllFree(void *pvBuf, size_t cbBuf);
1037
1038	/**
1039	* Write bytes to the I/O stream.
1040	*
1041	* @returns IPRT status code.
1042	* @retval VERR_ACCESS_DENIED if the stream is not writable.
1043	*
1044	* @param hVfsIos The VFS I/O stream handle.
1045	* @param pvBuf The bytes to write.
1046	* @param cbToWrite The number of bytes to write.
1047	* @param fBlocking Whether the call is blocking (@c true) or not. If
1048	* not, the @a pcbWritten parameter must not be NULL.
1049	* @param pcbWritten Where to always store the number of bytes actually
1050	* written. This can be NULL if @a fBlocking is true.
1051	* @sa RTVfsFileWrite, RTFileWrite, RTPipeWrite, RTPipeWriteBlocking,
1052	* RTSocketWrite
1053	*/
1054	RTDECL(int) RTVfsIoStrmWrite(RTVFSIOSTREAM hVfsIos, const void pvBuf, size_t cbToWrite, bool fBlocking, size_t pcbWritten);
1055	RTDECL(int) RTVfsIoStrmWriteAt(RTVFSIOSTREAM hVfsIos, RTFOFF off, const void pvBuf, size_t cbToWrite, bool fBlocking, size_t pcbWritten);
1056
1057	/**
1058	* Reads bytes from the I/O stream into a scatter buffer.
1059	*
1060	* @returns IPRT status code.
1061	* @retval VINF_SUCCESS and the number of bytes read written to @a pcbRead.
1062	* @retval VINF_TRY_AGAIN if @a fBlocking is @c false, @a pcbRead is not NULL,
1063	* and no data was available. @a *pcbRead will be set to 0.
1064	* @retval VINF_EOF when trying to read __beyond__ the end of the stream and
1065	* @a pcbRead is not NULL (it will be set to the number of bytes read,
1066	* or 0 if the end of the stream was reached before this call).
1067	* When the last byte of the read request is the last byte in the
1068	* stream, this status code will not be used. However, VINF_EOF is
1069	* returned when attempting to read 0 bytes while standing at the end
1070	* of the stream.
1071	* @retval VERR_EOF when trying to read __beyond__ the end of the stream and
1072	* @a pcbRead is NULL.
1073	* @retval VERR_ACCESS_DENIED if the stream is not readable.
1074	*
1075	* @param hVfsIos The VFS I/O stream handle.
1076	* @param off Where to read at, -1 for the current position.
1077	* @param pSgBuf Pointer to a scatter buffer descriptor. The number
1078	* of bytes described by the segments is what will be
1079	* attemted read.
1080	* @param fBlocking Whether the call is blocking (@c true) or not. If
1081	* not, the @a pcbRead parameter must not be NULL.
1082	* @param pcbRead Where to always store the number of bytes actually
1083	* read. This can be NULL if @a fBlocking is true.
1084	* @sa RTFileSgRead, RTSocketSgRead, RTPipeRead, RTPipeReadBlocking
1085	*/
1086	RTDECL(int) RTVfsIoStrmSgRead(RTVFSIOSTREAM hVfsIos, RTFOFF off, PCRTSGBUF pSgBuf, bool fBlocking, size_t *pcbRead);
1087
1088	/**
1089	* Write bytes to the I/O stream from a gather buffer.
1090	*
1091	* @returns IPRT status code.
1092	* @retval VERR_ACCESS_DENIED if the stream is not writable.
1093	*
1094	* @param hVfsIos The VFS I/O stream handle.
1095	* @param off Where to write at, -1 for the current position.
1096	* @param pSgBuf Pointer to a gather buffer descriptor. The number
1097	* of bytes described by the segments is what will be
1098	* attemted written.
1099	* @param fBlocking Whether the call is blocking (@c true) or not. If
1100	* not, the @a pcbWritten parameter must not be NULL.
1101	* @param pcbWritten Where to always store the number of bytes actually
1102	* written. This can be NULL if @a fBlocking is true.
1103	* @sa RTFileSgWrite, RTSocketSgWrite
1104	*/
1105	RTDECL(int) RTVfsIoStrmSgWrite(RTVFSIOSTREAM hVfsIos, RTFOFF off, PCRTSGBUF pSgBuf, bool fBlocking, size_t *pcbWritten);
1106
1107	/**
1108	* Flush any buffered data to the I/O stream.
1109	*
1110	* @returns IPRT status code.
1111	* @param hVfsIos The VFS I/O stream handle.
1112	* @sa RTVfsFileFlush, RTFileFlush, RTPipeFlush
1113	*/
1114	RTDECL(int) RTVfsIoStrmFlush(RTVFSIOSTREAM hVfsIos);
1115
1116	/**
1117	* Poll for events.
1118	*
1119	* @returns IPRT status code.
1120	* @param hVfsIos The VFS I/O stream handle.
1121	* @param fEvents The events to poll for (RTPOLL_EVT_XXX).
1122	* @param cMillies How long to wait for event to eventuate.
1123	* @param fIntr Whether the wait is interruptible and can return
1124	* VERR_INTERRUPTED (@c true) or if this condition
1125	* should be hidden from the caller (@c false).
1126	* @param pfRetEvents Where to return the event mask.
1127	* @sa RTVfsFilePoll, RTPollSetAdd, RTPoll, RTPollNoResume.
1128	*/
1129	RTDECL(int) RTVfsIoStrmPoll(RTVFSIOSTREAM hVfsIos, uint32_t fEvents, RTMSINTERVAL cMillies, bool fIntr,
1130	uint32_t *pfRetEvents);
1131	/**
1132	* Tells the current I/O stream position.
1133	*
1134	* @returns Zero or higher - where to return the I/O stream offset. Values
1135	* below zero are IPRT status codes (VERR_XXX).
1136	* @param hVfsIos The VFS I/O stream handle.
1137	* @sa RTFileTell
1138	*/
1139	RTDECL(RTFOFF) RTVfsIoStrmTell(RTVFSIOSTREAM hVfsIos);
1140
1141	/**
1142	* Skips @a cb ahead in the stream.
1143	*
1144	* @returns IPRT status code.
1145	* @param hVfsIos The VFS I/O stream handle.
1146	* @param cb The number bytes to skip.
1147	*/
1148	RTDECL(int) RTVfsIoStrmSkip(RTVFSIOSTREAM hVfsIos, RTFOFF cb);
1149
1150	/**
1151	* Fills the stream with @a cb zeros.
1152	*
1153	* @returns IPRT status code.
1154	* @param hVfsIos The VFS I/O stream handle.
1155	* @param cb The number of zero bytes to insert.
1156	*/
1157	RTDECL(int) RTVfsIoStrmZeroFill(RTVFSIOSTREAM hVfsIos, RTFOFF cb);
1158
1159	/**
1160	* Checks if we're at the end of the I/O stream.
1161	*
1162	* @returns true if at EOS, otherwise false.
1163	* @param hVfsIos The VFS I/O stream handle.
1164	*/
1165	RTDECL(bool) RTVfsIoStrmIsAtEnd(RTVFSIOSTREAM hVfsIos);
1166
1167	/**
1168	* Get the RTFILE_O_XXX flags for the I/O stream.
1169	*
1170	* @returns RTFILE_O_XXX, 0 on failure.
1171	* @param hVfsIos The VFS I/O stream handle.
1172	*/
1173	RTDECL(uint64_t) RTVfsIoStrmGetOpenFlags(RTVFSIOSTREAM hVfsIos);
1174
1175	/**
1176	* Process the rest of the stream, checking if it's all valid UTF-8 encoding.
1177	*
1178	* @returns IPRT status code.
1179	*
1180	* @param hVfsIos The VFS I/O stream handle.
1181	* @param fFlags Flags governing the validation, see
1182	* RTVFS_VALIDATE_UTF8_XXX.
1183	* @param poffError Where to return the error offset. Optional.
1184	*/
1185	RTDECL(int) RTVfsIoStrmValidateUtf8Encoding(RTVFSIOSTREAM hVfsIos, uint32_t fFlags, PRTFOFF poffError);
1186
1187	/** @defgroup RTVFS_VALIDATE_UTF8_XXX RTVfsIoStrmValidateUtf8Encoding flags.
1188	* @{ */
1189	/** The text must not contain any null terminator codepoints. */
1190	#define RTVFS_VALIDATE_UTF8_NO_NULL RT_BIT_32(0)
1191	/** The codepoints must be in the range covered by RTC-3629. */
1192	#define RTVFS_VALIDATE_UTF8_BY_RTC_3629 RT_BIT_32(1)
1193	/** Mask of valid flags. */
1194	#define RTVFS_VALIDATE_UTF8_VALID_MASK UINT32_C(0x00000003)
1195	/** @} */
1196
1197	/** @} */
1198
1199
1200	/** @defgroup grp_vfs_file VFS File API
1201	* @{
1202	*/
1203	RTDECL(int) RTVfsFileOpen(RTVFS hVfs, const char *pszFilename, uint64_t fOpen, PRTVFSFILE phVfsFile);
1204
1205	/**
1206	* Create a VFS file handle from a standard IPRT file handle (RTFILE).
1207	*
1208	* @returns IPRT status code.
1209	* @param hFile The standard IPRT file handle.
1210	* @param fOpen The flags the handle was opened with. Pass 0 to
1211	* have these detected.
1212	* @param fLeaveOpen Whether to leave the handle open when the VFS file
1213	* is released, or to close it (@c false).
1214	* @param phVfsFile Where to return the VFS file handle.
1215	*/
1216	RTDECL(int) RTVfsFileFromRTFile(RTFILE hFile, uint64_t fOpen, bool fLeaveOpen, PRTVFSFILE phVfsFile);
1217	RTDECL(RTHCUINTPTR) RTVfsFileToNative(RTFILE hVfsFile);
1218
1219	/**
1220	* Convenience function combining RTFileOpen with RTVfsFileFromRTFile.
1221	*
1222	* @returns IPRT status code.
1223	* @param pszFilename The path to the file in the normal file system.
1224	* @param fOpen The flags to pass to RTFileOpen when opening the
1225	* file, i.e. RTFILE_O_XXX.
1226	* @param phVfsFile Where to return the VFS file handle.
1227	*/
1228	RTDECL(int) RTVfsFileOpenNormal(const char *pszFilename, uint64_t fOpen, PRTVFSFILE phVfsFile);
1229
1230	/**
1231	* Convert the VFS file handle to a VFS I/O stream handle.
1232	*
1233	* @returns The VFS I/O stream handle on success, this must be released.
1234	* NIL_RTVFSIOSTREAM if the file handle is invalid.
1235	* @param hVfsFile The VFS file handle.
1236	* @sa RTVfsIoStrmToFile
1237	*/
1238	RTDECL(RTVFSIOSTREAM) RTVfsFileToIoStream(RTVFSFILE hVfsFile);
1239
1240	/**
1241	* Retains a reference to the VFS file handle.
1242	*
1243	* @returns New reference count on success, UINT32_MAX on failure.
1244	* @param hVfsFile The VFS file handle.
1245	*/
1246	RTDECL(uint32_t) RTVfsFileRetain(RTVFSFILE hVfsFile);
1247	RTDECL(uint32_t) RTVfsFileRetainDebug(RTVFSFILE hVfsFile, RT_SRC_POS_DECL);
1248
1249	/**
1250	* Releases a reference to the VFS file handle.
1251	*
1252	* @returns New reference count on success (0 if closed), UINT32_MAX on failure.
1253	* @param hVfsFile The VFS file handle.
1254	*/
1255	RTDECL(uint32_t) RTVfsFileRelease(RTVFSFILE hVfsFile);
1256
1257	/**
1258	* Query information about the object.
1259	*
1260	* @returns IPRT status code.
1261	* @retval VERR_NOT_SUPPORTED if the @a enmAddAttr value is not handled by the
1262	* implementation.
1263	*
1264	* @param hVfsFile The VFS file handle.
1265	* @param pObjInfo Where to return the info.
1266	* @param enmAddAttr Which additional attributes should be retrieved.
1267	* @sa RTVfsObjQueryInfo, RTVfsFsStrmQueryInfo, RTVfsDirQueryInfo,
1268	* RTVfsIoStrmQueryInfo, RTVfsFileQueryInfo, RTFileQueryInfo,
1269	* RTPathQueryInfo.
1270	*/
1271	RTDECL(int) RTVfsFileQueryInfo(RTVFSFILE hVfsFile, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
1272
1273	/**
1274	* Read bytes from the file at the current position.
1275	*
1276	* @returns IPRT status code.
1277	* @retval VINF_SUCCESS and the number of bytes read written to @a pcbRead.
1278	* @retval VINF_EOF when trying to read __beyond__ the end of the file and
1279	* @a pcbRead is not NULL (it will be set to the number of bytes read,
1280	* or 0 if the end of the file was reached before this call).
1281	* When the last byte of the read request is the last byte in the
1282	* file, this status code will not be used. However, VINF_EOF is
1283	* returned when attempting to read 0 bytes while standing at the end
1284	* of the file.
1285	* @retval VERR_EOF when trying to read __beyond__ the end of the file and
1286	* @a pcbRead is NULL.
1287	* @retval VERR_ACCESS_DENIED if the file is not readable.
1288	*
1289	* @param hVfsFile The VFS file handle.
1290	* @param pvBuf Where to store the read bytes.
1291	* @param cbToRead The number of bytes to read.
1292	* @param pcbRead Where to always store the number of bytes actually
1293	* read. Optional.
1294	* @sa RTVfsIoStrmRead, RTFileRead, RTPipeRead, RTPipeReadBlocking,
1295	* RTSocketRead
1296	*/
1297	RTDECL(int) RTVfsFileRead(RTVFSFILE hVfsFile, void pvBuf, size_t cbToRead, size_t pcbRead);
1298	RTDECL(int) RTVfsFileReadAt(RTVFSFILE hVfsFile, RTFOFF off, void pvBuf, size_t cbToRead, size_t pcbRead);
1299
1300	/**
1301	* Write bytes to the file at the current position.
1302	*
1303	* @returns IPRT status code.
1304	* @retval VERR_ACCESS_DENIED if the file is not writable.
1305	*
1306	* @param hVfsFile The VFS file handle.
1307	* @param pvBuf The bytes to write.
1308	* @param cbToWrite The number of bytes to write.
1309	* @param pcbWritten Where to always store the number of bytes actually
1310	* written. This can be NULL.
1311	* @sa RTVfsIoStrmRead, RTFileWrite, RTPipeWrite, RTPipeWriteBlocking,
1312	* RTSocketWrite
1313	*/
1314	RTDECL(int) RTVfsFileWrite(RTVFSFILE hVfsFile, const void pvBuf, size_t cbToWrite, size_t pcbWritten);
1315	RTDECL(int) RTVfsFileWriteAt(RTVFSFILE hVfsFile, RTFOFF off, const void pvBuf, size_t cbToWrite, size_t pcbWritten);
1316
1317
1318	/**
1319	* Reads bytes from the file into a scatter buffer.
1320	*
1321	* @returns IPRT status code.
1322	* @retval VINF_SUCCESS and the number of bytes read written to @a pcbRead.
1323	* @retval VINF_TRY_AGAIN if @a fBlocking is @c false, @a pcbRead is not NULL,
1324	* and no data was available. @a *pcbRead will be set to 0.
1325	* @retval VINF_EOF when trying to read __beyond__ the end of the stream and
1326	* @a pcbRead is not NULL (it will be set to the number of bytes read,
1327	* or 0 if the end of the stream was reached before this call).
1328	* When the last byte of the read request is the last byte in the
1329	* stream, this status code will not be used. However, VINF_EOF is
1330	* returned when attempting to read 0 bytes while standing at the end
1331	* of the stream.
1332	* @retval VERR_EOF when trying to read __beyond__ the end of the stream and
1333	* @a pcbRead is NULL.
1334	* @retval VERR_ACCESS_DENIED if the stream is not readable.
1335	*
1336	* @param hVfsFile The VFS file handle.
1337	* @param off Where to read at, -1 for the current position.
1338	* @param pSgBuf Pointer to a scatter buffer descriptor. The number
1339	* of bytes described by the segments is what will be
1340	* attemted read.
1341	* @param fBlocking Whether the call is blocking (@c true) or not. If
1342	* not, the @a pcbRead parameter must not be NULL.
1343	* @param pcbRead Where to always store the number of bytes actually
1344	* read. This can be NULL if @a fBlocking is true.
1345	* @sa RTFileSgRead, RTSocketSgRead, RTPipeRead, RTPipeReadBlocking
1346	*/
1347	RTDECL(int) RTVfsFileSgRead(RTVFSFILE hVfsFile, RTFOFF off, PCRTSGBUF pSgBuf, bool fBlocking, size_t *pcbRead);
1348
1349	/**
1350	* Write bytes to the file from a gather buffer.
1351	*
1352	* @returns IPRT status code.
1353	* @retval VERR_ACCESS_DENIED if the stream is not writable.
1354	*
1355	* @param hVfsFile The VFS file handle.
1356	* @param off Where to write at, -1 for the current position.
1357	* @param pSgBuf Pointer to a gather buffer descriptor. The number
1358	* of bytes described by the segments is what will be
1359	* attemted written.
1360	* @param fBlocking Whether the call is blocking (@c true) or not. If
1361	* not, the @a pcbWritten parameter must not be NULL.
1362	* @param pcbWritten Where to always store the number of bytes actually
1363	* written. This can be NULL if @a fBlocking is true.
1364	* @sa RTFileSgWrite, RTSocketSgWrite
1365	*/
1366	RTDECL(int) RTVfsFileSgWrite(RTVFSFILE hVfsFile, RTFOFF off, PCRTSGBUF pSgBuf, bool fBlocking, size_t *pcbWritten);
1367
1368	/**
1369	* Flush any buffered data to the file.
1370	*
1371	* @returns IPRT status code.
1372	* @param hVfsFile The VFS file handle.
1373	* @sa RTVfsIoStrmFlush, RTFileFlush, RTPipeFlush
1374	*/
1375	RTDECL(int) RTVfsFileFlush(RTVFSFILE hVfsFile);
1376
1377	/**
1378	* Poll for events.
1379	*
1380	* @returns IPRT status code.
1381	* @param hVfsFile The VFS file handle.
1382	* @param fEvents The events to poll for (RTPOLL_EVT_XXX).
1383	* @param cMillies How long to wait for event to eventuate.
1384	* @param fIntr Whether the wait is interruptible and can return
1385	* VERR_INTERRUPTED (@c true) or if this condition
1386	* should be hidden from the caller (@c false).
1387	* @param pfRetEvents Where to return the event mask.
1388	* @sa RTVfsIoStrmPoll, RTPollSetAdd, RTPoll, RTPollNoResume.
1389	*/
1390	RTDECL(RTFOFF) RTVfsFilePoll(RTVFSFILE hVfsFile, uint32_t fEvents, RTMSINTERVAL cMillies, bool fIntr,
1391	uint32_t *pfRetEvents);
1392
1393	/**
1394	* Tells the current file position.
1395	*
1396	* @returns Zero or higher - where to return the file offset. Values
1397	* below zero are IPRT status codes (VERR_XXX).
1398	* @param hVfsFile The VFS file handle.
1399	* @sa RTFileTell, RTVfsIoStrmTell.
1400	*/
1401	RTDECL(RTFOFF) RTVfsFileTell(RTVFSFILE hVfsFile);
1402
1403	/**
1404	* Changes the current read/write position of a file.
1405	*
1406	* @returns IPRT status code.
1407	*
1408	* @param hVfsFile The VFS file handle.
1409	* @param offSeek The seek offset.
1410	* @param uMethod The seek emthod.
1411	* @param poffActual Where to optionally return the new file offset.
1412	*
1413	* @sa RTFileSeek
1414	*/
1415	RTDECL(int) RTVfsFileSeek(RTVFSFILE hVfsFile, RTFOFF offSeek, uint32_t uMethod, uint64_t *poffActual);
1416
1417	/**
1418	* Sets the size of a file.
1419	*
1420	* This may also be used for preallocating space
1421	* (RTVFSFILE_SIZE_F_PREALLOC_KEEP_SIZE).
1422	*
1423	* @returns IPRT status code.
1424	* @retval VERR_ACCESS_DENIED if handle isn't writable.
1425	* @retval VERR_WRITE_PROTECT if read-only file system.
1426	* @retval VERR_FILE_TOO_BIG if cbSize is larger than what the file system can
1427	* theoretically deal with.
1428	* @retval VERR_DISK_FULL if the file system if full.
1429	* @retval VERR_NOT_SUPPORTED if fFlags indicates some operation that's not
1430	* supported by the file system / host operating system.
1431	*
1432	* @param hVfsFile The VFS file handle.
1433	* @param cbSize The new file size.
1434	* @param fFlags RTVFSFILE_SIZE_F_NORMAL, RTVFSFILE_SIZE_F_GROW, or
1435	* RTVFSFILE_SIZE_F_GROW_KEEP_SIZE.
1436	*
1437	* @sa RTFileSetSize, RTFileSetAllocationSize
1438	*/
1439	RTDECL(int) RTVfsFileSetSize(RTVFSFILE hVfsFile, uint64_t cbSize, uint32_t fFlags);
1440
1441	/** @name RTVFSFILE_SIZE_F_XXX - RTVfsFileSetSize flags.
1442	* @{ */
1443	/** Normal truncate or grow (zero'ed) like RTFileSetSize . */
1444	#define RTVFSFILE_SIZE_F_NORMAL UINT32_C(0x00000001)
1445	/** Only grow the file, ignore call if cbSize would trunacte the file.
1446	* This is what RTFileSetAllocationSize does by default. */
1447	#define RTVFSFILE_SIZE_F_GROW UINT32_C(0x00000002)
1448	/** Only grow the file, ignore call if cbSize would trunacte the file.
1449	* This is what RTFileSetAllocationSize does by default. */
1450	#define RTVFSFILE_SIZE_F_GROW_KEEP_SIZE UINT32_C(0x00000003)
1451	/** Action mask. */
1452	#define RTVFSFILE_SIZE_F_ACTION_MASK UINT32_C(0x00000003)
1453	/** Validate the flags.
1454	* Will reference @a a_fFlags more than once. */
1455	#define RTVFSFILE_SIZE_F_IS_VALID(a_fFlags) \
1456	( !((a_fFlags) & ~RTVFSFILE_SIZE_F_ACTION_MASK) && ((a_fFlags) & RTVFSFILE_SIZE_F_ACTION_MASK) != 0 )
1457	/** @} */
1458
1459
1460	/** Mask of valid flags. */
1461	#define RTFILE_ALLOC_SIZE_F_VALID (RTFILE_ALLOC_SIZE_F_KEEP_SIZE)
1462	/** @} */
1463
1464
1465	RTDECL(int) RTVfsFileGetSize(RTVFSFILE hVfsFile, uint64_t *pcbSize);
1466	RTDECL(RTFOFF) RTVfsFileGetMaxSize(RTVFSFILE hVfsFile);
1467	RTDECL(int) RTVfsFileQueryMaxSize(RTVFSFILE hVfsFile, uint64_t *pcbMax);
1468
1469	/**
1470	* Get the RTFILE_O_XXX flags for the I/O stream.
1471	*
1472	* @returns RTFILE_O_XXX, 0 on failure.
1473	* @param hVfsFile The VFS file handle.
1474	*/
1475	RTDECL(uint64_t) RTVfsFileGetOpenFlags(RTVFSFILE hVfsFile);
1476
1477	/** @} */
1478
1479
1480	#ifdef DEBUG
1481	# undef RTVfsRetain
1482	# define RTVfsRetain(hVfs) RTVfsRetainDebug(hVfs, RT_SRC_POS)
1483	# undef RTVfsObjRetain
1484	# define RTVfsObjRetain(hVfsObj) RTVfsObjRetainDebug(hVfsObj, RT_SRC_POS)
1485	# undef RTVfsDirRetain
1486	# define RTVfsDirRetain(hVfsDir) RTVfsDirRetainDebug(hVfsDir, RT_SRC_POS)
1487	# undef RTVfsFileRetain
1488	# define RTVfsFileRetain(hVfsFile) RTVfsFileRetainDebug(hVfsFile, RT_SRC_POS)
1489	# undef RTVfsIoStrmRetain
1490	# define RTVfsIoStrmRetain(hVfsIos) RTVfsIoStrmRetainDebug(hVfsIos, RT_SRC_POS)
1491	# undef RTVfsFsStrmRetain
1492	# define RTVfsFsStrmRetain(hVfsFss) RTVfsFsStrmRetainDebug(hVfsFss, RT_SRC_POS)
1493	#endif
1494
1495
1496
1497	/** @defgroup grp_vfs_misc VFS Miscellaneous
1498	* @{
1499	*/
1500
1501	/**
1502	* Memorizes the I/O stream as a file backed by memory.
1503	*
1504	* @returns IPRT status code.
1505	*
1506	* @param hVfsIos The VFS I/O stream to memorize. This will be read
1507	* to the end on success, on failure its position is
1508	* undefined.
1509	* @param fFlags A combination of RTFILE_O_READ and RTFILE_O_WRITE.
1510	* @param phVfsFile Where to return the handle to the memory file on
1511	* success.
1512	*/
1513	RTDECL(int) RTVfsMemorizeIoStreamAsFile(RTVFSIOSTREAM hVfsIos, uint32_t fFlags, PRTVFSFILE phVfsFile);
1514
1515	/**
1516	* Creates a VFS file from a memory buffer.
1517	*
1518	* @returns IPRT status code.
1519	*
1520	* @param fFlags A combination of RTFILE_O_READ and RTFILE_O_WRITE.
1521	* @param pvBuf The buffer. This will be copied and not referenced
1522	* after this function returns.
1523	* @param cbBuf The buffer size.
1524	* @param phVfsFile Where to return the handle to the memory file on
1525	* success.
1526	*/
1527	RTDECL(int) RTVfsFileFromBuffer(uint32_t fFlags, void const *pvBuf, size_t cbBuf, PRTVFSFILE phVfsFile);
1528
1529	/**
1530	* Creates a memory backed VFS file object for read and write.
1531	*
1532	* @returns IPRT status code.
1533	*
1534	* @param hVfsIos The VFS I/O stream to memorize. This will be read
1535	* to the end on success, on failure its position is
1536	* undefined.
1537	* @param cbEstimate The estimated file size.
1538	* @param phVfsFile Where to return the handle to the memory file on
1539	* success.
1540	* @sa RTVfsMemIoStrmCreate
1541	*/
1542	RTDECL(int) RTVfsMemFileCreate(RTVFSIOSTREAM hVfsIos, size_t cbEstimate, PRTVFSFILE phVfsFile);
1543
1544	/**
1545	* Creates a memory backed VFS file object for read and write.
1546	*
1547	* @returns IPRT status code.
1548	*
1549	* @param hVfsIos The VFS I/O stream to memorize. This will be read
1550	* to the end on success, on failure its position is
1551	* undefined.
1552	* @param cbEstimate The estimated file size.
1553	* @param phVfsIos Where to return the handle to the memory I/O stream
1554	* on success.
1555	* @sa RTVfsMemFileCreate
1556	*/
1557	RTDECL(int) RTVfsMemIoStrmCreate(RTVFSIOSTREAM hVfsIos, size_t cbEstimate, PRTVFSIOSTREAM phVfsIos);
1558
1559	/**
1560	* Pumps data from one I/O stream to another.
1561	*
1562	* The data is read in chunks from @a hVfsIosSrc and written to @a hVfsIosDst
1563	* until @a hVfsIosSrc indicates end of stream.
1564	*
1565	* @returns IPRT status code
1566	*
1567	* @param hVfsIosSrc The input stream.
1568	* @param hVfsIosDst The output stream.
1569	* @param cbBufHint Hints at a good temporary buffer size, pass 0 if
1570	* clueless.
1571	*/
1572	RTDECL(int) RTVfsUtilPumpIoStreams(RTVFSIOSTREAM hVfsIosSrc, RTVFSIOSTREAM hVfsIosDst, size_t cbBufHint);
1573
1574
1575	/**
1576	* Creates a progress wrapper for an I/O stream.
1577	*
1578	* @returns IRPT status code.
1579	* @param hVfsIos The I/O stream to wrap.
1580	* @param pfnProgress The progress callback. The return code is
1581	* ignored by default, see
1582	* RTVFSPROGRESS_F_CANCELABLE.
1583	* @param pvUser The user argument to @a pfnProgress.
1584	* @param fFlags RTVFSPROGRESS_F_XXX
1585	* @param cbExpectedRead The expected number of bytes read.
1586	* @param cbExpectedWritten The execpted number of bytes written.
1587	* @param phVfsIos Where to return the I/O stream handle.
1588	*/
1589	RTDECL(int) RTVfsCreateProgressForIoStream(RTVFSIOSTREAM hVfsIos, PFNRTPROGRESS pfnProgress, void *pvUser, uint32_t fFlags,
1590	uint64_t cbExpectedRead, uint64_t cbExpectedWritten, PRTVFSIOSTREAM phVfsIos);
1591
1592	/**
1593	* Creates a progress wrapper for a file stream.
1594	*
1595	* @returns IRPT status code.
1596	* @param hVfsFile The file to wrap.
1597	* @param pfnProgress The progress callback. The return code is
1598	* ignored by default, see
1599	* RTVFSPROGRESS_F_CANCELABLE.
1600	* @param pvUser The user argument to @a pfnProgress.
1601	* @param fFlags RTVFSPROGRESS_F_XXX
1602	* @param cbExpectedRead The expected number of bytes read.
1603	* @param cbExpectedWritten The execpted number of bytes written.
1604	* @param phVfsFile Where to return the file handle.
1605	*/
1606	RTDECL(int) RTVfsCreateProgressForFile(RTVFSFILE hVfsFile, PFNRTPROGRESS pfnProgress, void *pvUser, uint32_t fFlags,
1607	uint64_t cbExpectedRead, uint64_t cbExpectedWritten, PRTVFSFILE phVfsFile);
1608
1609	/** @name RTVFSPROGRESS_F_XXX - Flags for RTVfsCreateProcessForIoStream and
1610	* RTVfsCreateProcessForFile.
1611	* @{ */
1612	/** Cancel if the callback returns a failure status code.
1613	* This isn't default behavior because the cancelation is delayed one I/O
1614	* operation in most cases and it's uncertain how the VFS user will handle the
1615	* cancellation status code. */
1616	#define RTVFSPROGRESS_F_CANCELABLE RT_BIT_32(0)
1617	/** Account forward seeks as reads. */
1618	#define RTVFSPROGRESS_F_FORWARD_SEEK_AS_READ RT_BIT_32(1)
1619	/** Account fprward seeks as writes. */
1620	#define RTVFSPROGRESS_F_FORWARD_SEEK_AS_WRITE RT_BIT_32(2)
1621	/** Valid bits. */
1622	#define RTVFSPROGRESS_F_VALID_MASK UINT32_C(0x00000007)
1623	/** @} */
1624
1625
1626	/**
1627	* Create an I/O stream instance performing simple sequential read-ahead.
1628	*
1629	* @returns IPRT status code.
1630	* @param hVfsIos The input stream to perform read ahead on. If this is
1631	* actually for a file object, the returned I/O stream
1632	* handle can also be cast to a file handle.
1633	* @param fFlags Flags reserved for future use, MBZ.
1634	* @param cBuffers How many read ahead buffers to use. Specify 0 for
1635	* default value.
1636	* @param cbBuffer The size of each read ahead buffer. Specify 0 for
1637	* default value.
1638	* @param phVfsIos Where to return the read ahead I/O stream handle.
1639	*
1640	* @remarks Careful using this on a message pipe or socket. The reads are
1641	* performed in blocked mode and it may be host and/or implementation
1642	* dependent whether they will return ready data immediate or wait
1643	* until there's a whole @a cbBuffer (or default) worth ready.
1644	*
1645	* @sa RTVfsCreateReadAheadForFile
1646	*/
1647	RTDECL(int) RTVfsCreateReadAheadForIoStream(RTVFSIOSTREAM hVfsIos, uint32_t fFlags, uint32_t cBuffers, uint32_t cbBuffer,
1648	PRTVFSIOSTREAM phVfsIos);
1649
1650	/**
1651	* Create an I/O stream instance performing simple sequential read-ahead.
1652	*
1653	* @returns IPRT status code.
1654	* @param hVfsFile The input file to perform read ahead on.
1655	* @param fFlags Flags reserved for future use, MBZ.
1656	* @param cBuffers How many read ahead buffers to use. Specify 0 for
1657	* default value.
1658	* @param cbBuffer The size of each read ahead buffer. Specify 0 for
1659	* default value.
1660	* @param phVfsFile Where to return the read ahead file handle.
1661	* @sa RTVfsCreateReadAheadForIoStream
1662	*/
1663	RTDECL(int) RTVfsCreateReadAheadForFile(RTVFSFILE hVfsFile, uint32_t fFlags, uint32_t cBuffers, uint32_t cbBuffer,
1664	PRTVFSFILE phVfsFile);
1665
1666
1667	/**
1668	* Create a file system stream for writing to a directory.
1669	*
1670	* This is just supposed to be a drop in replacement for the TAR creator stream
1671	* that instead puts the files and stuff in a directory instead of a TAR
1672	* archive. In addition, it has an undo feature for simplying cleaning up after
1673	* a botched run
1674	*
1675	* @returns IPRT status code.
1676	* @param hVfsBaseDir The base directory.
1677	* @param fFlags RTVFSFSS2DIR_F_XXX
1678	* @param phVfsFss Where to return the FSS handle.
1679	* @sa RTVfsFsStrmToNormalDir, RTVfsFsStrmToDirUndo
1680	*/
1681	RTDECL(int) RTVfsFsStrmToDir(RTVFSDIR hVfsBaseDir, uint32_t fFlags, PRTVFSFSSTREAM phVfsFss);
1682
1683	/**
1684	* Create a file system stream for writing to a normal directory.
1685	*
1686	* This is just supposed to be a drop in replacement for the TAR creator stream
1687	* that instead puts the files and stuff in a directory instead of a TAR
1688	* archive. In addition, it has an undo feature for simplying cleaning up after
1689	* a botched run
1690	*
1691	* @returns IPRT status code.
1692	* @param pszBaseDir The base directory. Must exist.
1693	* @param fFlags RTVFSFSS2DIR_F_XXX
1694	* @param phVfsFss Where to return the FSS handle.
1695	* @sa RTVfsFsStrmToDir, RTVfsFsStrmToDirUndo
1696	*/
1697	RTDECL(int) RTVfsFsStrmToNormalDir(const char *pszBaseDir, uint32_t fFlags, PRTVFSFSSTREAM phVfsFss);
1698
1699	/** @name RTVFSFSS2DIR_F_XXX - Flags for RTVfsFsStrmToNormalDir
1700	* @{ */
1701	/** Overwrite existing files (default is to not overwrite anything). */
1702	#define RTVFSFSS2DIR_F_OVERWRITE_FILES RT_BIT_32(0)
1703	/** Valid bits. */
1704	#define RTVFSFSS2DIR_F_VALID_MASK UINT32_C(0x00000001)
1705	/** @} */
1706
1707	/**
1708	* Deletes files, directories, symlinks and stuff created by a FSS returned by
1709	* RTVfsFsStrmToNormalDir or RTVfsFsStrmToDir.
1710	*
1711	* @returns IPRT status code.
1712	* @param hVfsFss The write-to-directory FSS handle.
1713	*/
1714	RTDECL(int) RTVfsFsStrmToDirUndo(RTVFSFSSTREAM hVfsFss);
1715
1716
1717
1718	/** @} */
1719
1720
1721	/** @defgroup grp_rt_vfs_chain VFS Chains
1722	*
1723	* VFS chains is for doing pipe like things with VFS objects from the command
1724	* line. Imagine you want to cat the readme.gz of an ISO you could do
1725	* something like:
1726	* RTCat :iprtvfs:file(stdfile,live.iso)\|vfs(isofs)\|iso(open,readme.gz)\|ios(gunzip)
1727	* or
1728	* RTCat :iprtvfs:file(stdfile,live.iso)\|ios(isofs,readme.gz)\|ios(gunzip)
1729	*
1730	* Or say you want to read the README.TXT on a floppy image:
1731	* RTCat :iprtvfs:file(stdfile,floppy.img,r)\|vfs(fat)\|ios(open,README.TXT)
1732	* or
1733	* RTCat :iprtvfs:file(stdfile,floppy.img,r)\|vfs(fat)\|README.TXT
1734	*
1735	* Or in the other direction, you want to write a STUFF.TGZ file to the above
1736	* floppy image, using a lazy writer thread for compressing the data:
1737	* RTTar cf :iprtvfs:file(stdfile,floppy.img,rw)\|ios(fat,STUFF.TGZ)\|ios(gzip)\|ios(push) .
1738	*
1739	*
1740	* A bit more formally:
1741	* :iprtvfs:{type}({provider}[,provider-args])[{separator}{type}...][{separator}{path}]
1742	*
1743	* The @c type refers to VFS object that should be created by the @c provider.
1744	* Valid types:
1745	* - vfs: A virtual file system (volume).
1746	* - fss: A file system stream (e.g. tar).
1747	* - ios: An I/O stream.
1748	* - file: A file.
1749	* - dir: A directory.
1750	* - sym: A symbolic link (not sure how useful this is).
1751	*
1752	* The @c provider refers to registered chain element providers (see
1753	* RTVFSCHAINELEMENTREG for how that works internally). These are asked to
1754	* create a VFS object of the specified type using the given arguments (if any).
1755	* Default providers:
1756	* - std: Standard file, directory and file system.
1757	* - open: Opens a file, I/O stream or directory in a vfs or directory object.
1758	* - pull: Read-ahead buffering thread on file or I/O stream.
1759	* - push: Lazy-writer buffering thread on file or I/O stream.
1760	* - gzip: Compresses an I/O stream.
1761	* - gunzip: Decompresses an I/O stream.
1762	* - fat: FAT file system accessor.
1763	* - isofs: ISOFS file system accessor.
1764	*
1765	* As element @c separator we allow both colon (':') and the pipe character
1766	* ('\|'). The latter the conventional one, but since it's inconvenient on the
1767	* command line, colon is provided as an alternative.
1768	*
1769	* In the final element we allow a simple @a path to be specified instead of the
1770	* type-provider-arguments stuff. The previous object must be a directory, file
1771	* system or file system stream. The application will determin exactly which
1772	* operation or operations which will be performed.
1773	*
1774	* @{
1775	*/
1776
1777	/** The path prefix used to identify an VFS chain specification. */
1778	#define RTVFSCHAIN_SPEC_PREFIX ":iprtvfs:"
1779
1780	RTDECL(int) RTVfsChainOpenVfs(const char pszSpec, PRTVFS phVfs, uint32_t poffError, PRTERRINFO pErrInfo);
1781	RTDECL(int) RTVfsChainOpenFsStream(const char pszSpec, PRTVFSFSSTREAM phVfsFss, uint32_t poffError, PRTERRINFO pErrInfo);
1782
1783	/**
1784	* Opens any kind of file system object.
1785	*
1786	* @returns IPRT status code.
1787	* @param pszSpec The VFS chain specification or plain path.
1788	* @param fFileOpen RTFILE_O_XXX flags.
1789	* @param fObjFlags More flags: RTVFSOBJ_F_XXX, RTPATH_F_XXX.
1790	* @param phVfsObj Where to return the handle to the opened object.
1791	* @param poffError Where to on error return an offset into @a pszSpec
1792	* of what cause the error. Optional.
1793	* @param pErrInfo Where to return additional error information.
1794	* Optional.
1795	*/
1796	RTDECL(int) RTVfsChainOpenObj(const char *pszSpec, uint64_t fFileOpen, uint32_t fObjFlags,
1797	PRTVFSOBJ phVfsObj, uint32_t *poffError, PRTERRINFO pErrInfo);
1798
1799	RTDECL(int) RTVfsChainOpenDir(const char pszSpec, uint32_t fOpen, PRTVFSDIR phVfsDir, uint32_t poffError, PRTERRINFO pErrInfo);
1800	RTDECL(int) RTVfsChainOpenParentDir(const char pszSpec, uint32_t fOpen, PRTVFSDIR phVfsDir, const char *ppszChild,
1801	uint32_t *poffError, PRTERRINFO pErrInfo);
1802	RTDECL(int) RTVfsChainOpenFile(const char pszSpec, uint64_t fOpen, PRTVFSFILE phVfsFile, uint32_t poffError, PRTERRINFO pErrInfo);
1803	RTDECL(int) RTVfsChainOpenIoStream(const char pszSpec, uint64_t fOpen, PRTVFSIOSTREAM phVfsIos, uint32_t poffError, PRTERRINFO pErrInfo);
1804	RTDECL(int) RTVfsChainOpenSymlink(const char pszSpec, PRTVFSSYMLINK phVfsSym, uint32_t poffError, PRTERRINFO pErrInfo);
1805
1806	RTDECL(int) RTVfsChainQueryInfo(const char *pszSpec, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAdditionalAttribs,
1807	uint32_t fFlags, uint32_t *poffError, PRTERRINFO pErrInfo);
1808
1809	/**
1810	* Tests if the given string is a chain specification or not.
1811	*
1812	* @returns true if it is, false if it isn't.
1813	* @param pszSpec The alleged chain spec.
1814	*/
1815	RTDECL(bool) RTVfsChainIsSpec(const char *pszSpec);
1816
1817	/**
1818	* Queries the path from the final element.
1819	*
1820	* @returns IPRT status code.
1821	* @retval VERR_VFS_CHAIN_NOT_PATH_ONLY if the final element isn't just a
1822	* simple path.
1823	* @param pszSpec The chain spec.
1824	* @param ppszFinalPath Where to return a copy of the final path on success.
1825	* Call RTStrFree when done.
1826	* @param poffError Where to on error return an offset into @a pszSpec
1827	* of what cause the error. Optional.
1828	*
1829	*/
1830	RTDECL(int) RTVfsChainQueryFinalPath(const char pszSpec, char ppszFinalPath, uint32_t poffError);
1831
1832	/**
1833	* Splits the given chain spec into a final path and the preceeding spec.
1834	*
1835	* This works on plain paths too.
1836	*
1837	* @returns IPRT status code.
1838	* @param pszSpec The chain spec to split. This will be modified!
1839	* @param ppszSpec Where to return the pointer to the chain spec part.
1840	* This is set to NULL if it's a plain path or a chain
1841	* spec with only a final-path element.
1842	* @param ppszFinalPath Where to return the pointer to the final path. This
1843	* is set to NULL if no final path.
1844	* @param poffError Where to on error return an offset into @a pszSpec
1845	* of what cause the error. Optional.
1846	*/
1847	RTDECL(int) RTVfsChainSplitOffFinalPath(char pszSpec, char ppszSpec, char ppszFinalPath, uint32_t poffError);
1848
1849	/**
1850	* Common code for reporting errors of a RTVfsChainOpen* API.
1851	*
1852	* @param pszFunction The API called.
1853	* @param pszSpec The VFS chain specification or file path passed to the.
1854	* @param rc The return code.
1855	* @param offError The error offset value returned (0 if not captured).
1856	* @param pErrInfo Additional error information. Optional.
1857	*
1858	* @sa RTVfsChainMsgErrorExitFailure
1859	* @sa RTVfsChainOpenVfs, RTVfsChainOpenFsStream, RTVfsChainOpenDir,
1860	* RTVfsChainOpenFile, RTVfsChainOpenIoStream, RTVfsChainOpenSymlink
1861	*/
1862	RTDECL(void) RTVfsChainMsgError(const char pszFunction, const char pszSpec, int rc, uint32_t offError, PRTERRINFO pErrInfo);
1863
1864	/**
1865	* Common code for reporting errors of a RTVfsChainOpen* API.
1866	*
1867	* @returns RTEXITCODE_FAILURE
1868	*
1869	* @param pszFunction The API called.
1870	* @param pszSpec The VFS chain specification or file path passed to the.
1871	* @param rc The return code.
1872	* @param offError The error offset value returned (0 if not captured).
1873	* @param pErrInfo Additional error information. Optional.
1874	*
1875	* @sa RTVfsChainMsgError
1876	* @sa RTVfsChainOpenVfs, RTVfsChainOpenFsStream, RTVfsChainOpenDir,
1877	* RTVfsChainOpenFile, RTVfsChainOpenIoStream, RTVfsChainOpenSymlink
1878	*/
1879	RTDECL(RTEXITCODE) RTVfsChainMsgErrorExitFailure(const char pszFunction, const char pszSpec,
1880	int rc, uint32_t offError, PRTERRINFO pErrInfo);
1881
1882
1883	/** @} */
1884
1885
1886	/** @} */
1887
1888	RT_C_DECLS_END
1889
1890	#endif /* !IPRT_INCLUDED_vfs_h */
1891

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

source: vbox/trunk/include/iprt/vfs.h@ 76585

Download in other formats: