vfs.h@ 44528

Last change on this file since 44528 was 44528, checked in by vboxsync, 12 years ago
header (C) fixes
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 35.5 KB

Line
1	/** @file
2	* IPRT - Virtual Filesystem.
3	*/
4
5	/*
6	* Copyright (C) 2012 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_vfs_h
27	#define ___iprt_vfs_h
28
29	#include <iprt/cdefs.h>
30	#include <iprt/types.h>
31	#include <iprt/dir.h>
32	#include <iprt/fs.h>
33	#include <iprt/handle.h>
34	#include <iprt/symlink.h>
35	#include <iprt/sg.h>
36	#include <iprt/time.h>
37
38
39	RT_C_DECLS_BEGIN
40
41	/** @defgroup grp_rt_vfs RTVfs - Virtual Filesystem
42	* @ingroup grp_rt
43	*
44	* The virtual filesystem APIs are intended to make it possible to work on
45	* container files, file system sub-trees, file system overlays and other custom
46	* filesystem configurations. It also makes it possible to create filters, like
47	* automatically gunzipping a tar.gz file before feeding it to the RTTar API for
48	* unpacking - or wise versa.
49	*
50	* The virtual filesystem APIs are intended to mirror the RTDir, RTFile, RTPath
51	* and RTFs APIs pretty closely so that rewriting a piece of code to work with
52	* it should be easy. However there are some differences to the way the APIs
53	* works and the user should heed the documentation. The differences are
54	* usually motivated by simplification and in some case to make the VFS more
55	* flexible.
56	*
57	* @{
58	*/
59
60	/**
61	* The object type.
62	*/
63	typedef enum RTVFSOBJTYPE
64	{
65	/** Invalid type. */
66	RTVFSOBJTYPE_INVALID = 0,
67	/** Pure base object.
68	* This is returned by the filesystem stream to represent directories,
69	* devices, fifos and similar that needs to be created. */
70	RTVFSOBJTYPE_BASE,
71	/** Virtual filesystem. */
72	RTVFSOBJTYPE_VFS,
73	/** Filesystem stream. */
74	RTVFSOBJTYPE_FS_STREAM,
75	/** Pure I/O stream. */
76	RTVFSOBJTYPE_IO_STREAM,
77	/** Directory. */
78	RTVFSOBJTYPE_DIR,
79	/** File. */
80	RTVFSOBJTYPE_FILE,
81	/** Symbolic link. */
82	RTVFSOBJTYPE_SYMLINK,
83	/** End of valid object types. */
84	RTVFSOBJTYPE_END,
85	/** Pure I/O stream. */
86	RTVFSOBJTYPE_32BIT_HACK = 0x7fffffff
87	} RTVFSOBJTYPE;
88	/** Pointer to a VFS object type. */
89	typedef RTVFSOBJTYPE *PRTVFSOBJTYPE;
90
91
92
93	/** @name RTVfsCreate flags
94	* @{ */
95	/** Whether the file system is read-only. */
96	#define RTVFS_C_READONLY RT_BIT(0)
97	/** Whether we the VFS should be thread safe (i.e. automaticaly employ
98	* locks). */
99	#define RTVFS_C_THREAD_SAFE RT_BIT(1)
100	/** @} */
101
102	/**
103	* Creates an empty virtual filesystem.
104	*
105	* @returns IPRT status code.
106	* @param pszName Name, for logging and such.
107	* @param fFlags Flags, MBZ.
108	* @param phVfs Where to return the VFS handle. Release the returned
109	* reference by calling RTVfsRelease.
110	*/
111	RTDECL(int) RTVfsCreate(const char *pszName, uint32_t fFlags, PRTVFS phVfs);
112	RTDECL(uint32_t) RTVfsRetain(RTVFS phVfs);
113	RTDECL(uint32_t) RTVfsRelease(RTVFS phVfs);
114	RTDECL(int) RTVfsAttach(RTVFS hVfs, const char *pszMountPoint, uint32_t fFlags, RTVFS hVfsAttach);
115	RTDECL(int) RTVfsDetach(RTVFS hVfs, const char pszMountPoint, RTVFS hVfsToDetach, PRTVFS phVfsDetached);
116	RTDECL(uint32_t) RTVfsGetAttachmentCount(RTVFS hVfs);
117	RTDECL(int) RTVfsGetAttachment(RTVFS hVfs, uint32_t iOrdinal, PRTVFS phVfsAttached, uint32_t pfFlags,
118	char *pszMountPoint, size_t cbMountPoint);
119
120	/**
121	* Checks whether a given range is in use by the virtual filesystem.
122	*
123	* @returns IPRT status code.
124	* @param hVfs VFS handle.
125	* @param off Start offset to check.
126	* @param cb Number of bytes to check.
127	* @param pfUsed Where to store the result.
128	*/
129	RTDECL(int) RTVfsIsRangeInUse(RTVFS hVfs, uint64_t off, size_t cb,
130	bool *pfUsed);
131
132	/** @defgroup grp_vfs_dir VFS Base Object API
133	* @{
134	*/
135
136	/**
137	* Retains a reference to the VFS base object handle.
138	*
139	* @returns New reference count on success, UINT32_MAX on failure.
140	* @param hVfsObj The VFS base object handle.
141	*/
142	RTDECL(uint32_t) RTVfsObjRetain(RTVFSOBJ hVfsObj);
143
144	/**
145	* Releases a reference to the VFS base handle.
146	*
147	* @returns New reference count on success (0 if closed), UINT32_MAX on failure.
148	* @param hVfsObj The VFS base object handle.
149	*/
150	RTDECL(uint32_t) RTVfsObjRelease(RTVFSOBJ hVfsObj);
151
152	/**
153	* Query information about the object.
154	*
155	* @returns IPRT status code.
156	* @retval VERR_NOT_SUPPORTED if the @a enmAddAttr value is not handled by the
157	* implementation.
158	*
159	* @param hVfsObj The VFS object handle.
160	* @param pObjInfo Where to return the info.
161	* @param enmAddAttr Which additional attributes should be retrieved.
162	* @sa RTVfsIoStrmQueryInfo, RTVfsFileQueryInfo, RTFileQueryInfo,
163	* RTPathQueryInfo
164	*/
165	RTDECL(int) RTVfsObjQueryInfo(RTVFSOBJ hVfsObj, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
166
167
168	/**
169	* Converts a VFS base object handle to a VFS handle.
170	*
171	* @returns Referenced handle on success, NIL on failure.
172	* @param hVfsObj The VFS base object handle.
173	*/
174	RTDECL(RTVFS) RTVfsObjToVfs(RTVFSOBJ hVfsObj);
175
176	/**
177	* Converts a VFS base object handle to a VFS filesystem stream handle.
178	*
179	* @returns Referenced handle on success, NIL on failure.
180	* @param hVfsObj The VFS base object handle.
181	*/
182	RTDECL(RTVFSFSSTREAM) RTVfsObjToFsStream(RTVFSOBJ hVfsObj);
183
184	/**
185	* Converts a VFS base object handle to a VFS directory handle.
186	*
187	* @returns Referenced handle on success, NIL on failure.
188	* @param hVfsObj The VFS base object handle.
189	*/
190	RTDECL(RTVFSDIR) RTVfsObjToDir(RTVFSOBJ hVfsObj);
191
192	/**
193	* Converts a VFS base object handle to a VFS I/O stream handle.
194	*
195	* @returns Referenced handle on success, NIL on failure.
196	* @param hVfsObj The VFS base object handle.
197	*/
198	RTDECL(RTVFSIOSTREAM) RTVfsObjToIoStream(RTVFSOBJ hVfsObj);
199
200	/**
201	* Converts a VFS base object handle to a VFS file handle.
202	*
203	* @returns Referenced handle on success, NIL on failure.
204	* @param hVfsObj The VFS base object handle.
205	*/
206	RTDECL(RTVFSFILE) RTVfsObjToFile(RTVFSOBJ hVfsObj);
207
208	/**
209	* Converts a VFS base object handle to a VFS symbolic link handle.
210	*
211	* @returns Referenced handle on success, NIL on failure.
212	* @param hVfsObj The VFS base object handle.
213	*/
214	RTDECL(RTVFSSYMLINK) RTVfsObjToSymlink(RTVFSOBJ hVfsObj);
215
216
217	/**
218	* Converts a VFS handle to a VFS base object handle.
219	*
220	* @returns Referenced handle on success, NIL if the input handle was invalid.
221	* @param hVfs The VFS handle.
222	*/
223	RTDECL(RTVFSOBJ) RTVfsObjFromVfs(RTVFS hVfs);
224
225	/**
226	* Converts a VFS filesystem stream handle to a VFS base object handle.
227	*
228	* @returns Referenced handle on success, NIL if the input handle was invalid.
229	* @param hVfsFSs The VFS filesystem stream handle.
230	*/
231	RTDECL(RTVFSOBJ) RTVfsObjFromFsStream(RTVFSFSSTREAM hVfsFss);
232
233	/**
234	* Converts a VFS directory handle to a VFS base object handle.
235	*
236	* @returns Referenced handle on success, NIL if the input handle was invalid.
237	* @param hVfsDir The VFS directory handle.
238	*/
239	RTDECL(RTVFSOBJ) RTVfsObjFromDir(RTVFSDIR hVfsDir);
240
241	/**
242	* Converts a VFS I/O stream handle to a VFS base object handle.
243	*
244	* @returns Referenced handle on success, NIL if the input handle was invalid.
245	* @param hVfsIos The VFS I/O stream handle.
246	*/
247	RTDECL(RTVFSOBJ) RTVfsObjFromIoStream(RTVFSIOSTREAM hVfsIos);
248
249	/**
250	* Converts a VFS file handle to a VFS base object handle.
251	*
252	* @returns Referenced handle on success, NIL if the input handle was invalid.
253	* @param hVfsFile The VFS file handle.
254	*/
255	RTDECL(RTVFSOBJ) RTVfsObjFromFile(RTVFSFILE hVfsFile);
256
257	/**
258	* Converts a VFS symbolic link handle to a VFS base object handle.
259	*
260	* @returns Referenced handle on success, NIL if the input handle was invalid.
261	* @param hVfsSym The VFS symbolic link handle.
262	*/
263	RTDECL(RTVFSOBJ) RTVfsObjFromSymlink(RTVFSSYMLINK hVfsSym);
264
265	/** @} */
266
267
268	/** @defgroup grp_vfs_fsstream VFS Filesystem Stream API
269	*
270	* Filesystem streams are for tar, cpio and similar. Any virtual filesystem can
271	* be turned into a filesystem stream using RTVfsFsStrmFromVfs.
272	*
273	* @{
274	*/
275
276	RTDECL(uint32_t) RTVfsFsStrmRetain(RTVFSFSSTREAM hVfsFss);
277	RTDECL(uint32_t) RTVfsFsStrmRelease(RTVFSFSSTREAM hVfsFss);
278	RTDECL(int) RTVfsFsStrmQueryInfo(RTVFSFSSTREAM hVfsFss, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
279
280	/**
281	* Gets the next object in the stream.
282	*
283	* This call may affect the stream posision of a previously returned object.
284	*
285	* The type of object returned here typically boils down to three types:
286	* - I/O streams (representing files),
287	* - symbolic links
288	* - base object
289	* The base objects represent anything not convered by the two other, i.e.
290	* directories, device nodes, fifos, sockets and whatnot. The details can be
291	* queried using RTVfsObjQueryInfo.
292	*
293	* That said, absolutely any object except for filesystem stream objects can be
294	* returned by this call. Any generic code is adviced to just deal with it all.
295	*
296	* @returns IPRT status code.
297	* @retval VINF_SUCCESS if a new object was retrieved.
298	* @retval VERR_EOF when there are no more objects.
299	*
300	* @param pvThis The implementation specific directory data.
301	* @param ppszName Where to return the object name. Must be freed by
302	* calling RTStrFree.
303	* @param penmType Where to return the object type.
304	* @param hVfsObj Where to return the object handle (referenced).
305	* This must be cast to the desired type before use.
306	*/
307	RTDECL(int) RTVfsFsStrmNext(RTVFSFSSTREAM hVfsFss, char *ppszName, RTVFSOBJTYPE penmType, PRTVFSOBJ phVfsObj);
308
309	/** @} */
310
311
312	/** @defgroup grp_vfs_dir VFS Directory API
313	* @{
314	*/
315
316	/**
317	* Retains a reference to the VFS directory handle.
318	*
319	* @returns New reference count on success, UINT32_MAX on failure.
320	* @param hVfsDir The VFS directory handle.
321	*/
322	RTDECL(uint32_t) RTVfsDirRetain(RTVFSDIR hVfsDir);
323
324	/**
325	* Releases a reference to the VFS directory handle.
326	*
327	* @returns New reference count on success (0 if closed), UINT32_MAX on failure.
328	* @param hVfsIos The VFS directory handle.
329	*/
330	RTDECL(uint32_t) RTVfsDirRelease(RTVFSDIR hVfsDir);
331
332	/** @} */
333
334
335	/** @defgroup grp_vfs_iostream VFS Symbolic Link API
336	*
337	* @remarks The TAR VFS and filesystem stream uses symbolic links for
338	* describing hard links as well. The users must use RTFS_IS_SYMLINK
339	* to check if it is a real symlink in those cases.
340	*
341	* @remarks Any VFS which is backed by a real file system may be subject to
342	* races with other processes or threads, so the user may get
343	* unexpected errors when this happends. This is a bit host specific,
344	* i.e. it might be prevent on windows if we care.
345	*
346	* @{
347	*/
348
349
350	/**
351	* Retains a reference to the VFS symbolic link handle.
352	*
353	* @returns New reference count on success, UINT32_MAX on failure.
354	* @param hVfsSym The VFS symbolic link handle.
355	*/
356	RTDECL(uint32_t) RTVfsSymlinkRetain(RTVFSSYMLINK hVfsSym);
357
358	/**
359	* Releases a reference to the VFS symbolic link handle.
360	*
361	* @returns New reference count on success (0 if closed), UINT32_MAX on failure.
362	* @param hVfsSym The VFS symbolic link handle.
363	*/
364	RTDECL(uint32_t) RTVfsSymlinkRelease(RTVFSSYMLINK hVfsSym);
365
366	/**
367	* Query information about the symbolic link.
368	*
369	* @returns IPRT status code.
370	* @param hVfsSym The VFS symbolic link handle.
371	* @param pObjInfo Where to return the info.
372	* @param enmAddAttr Which additional attributes should be retrieved.
373	*
374	* @sa RTFileQueryInfo, RTPathQueryInfo, RTPathQueryInfoEx
375	*/
376	RTDECL(int) RTVfsSymlinkQueryInfo(RTVFSSYMLINK hVfsSym, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
377
378	/**
379	* Set the unix style owner and group.
380	*
381	* @returns IPRT status code.
382	* @param hVfsSym The VFS symbolic link handle.
383	* @param fMode The new mode bits.
384	* @param fMask The mask indicating which bits we are changing.
385	* @sa RTFileSetMode, RTPathSetMode
386	*/
387	RTDECL(int) RTVfsSymlinkSetMode(RTVFSSYMLINK hVfsSym, RTFMODE fMode, RTFMODE fMask);
388
389	/**
390	* Set the timestamps associated with the object.
391	*
392	* @returns IPRT status code.
393	* @param hVfsSym The VFS symbolic link handle.
394	* @param pAccessTime Pointer to the new access time. NULL if not
395	* to be changed.
396	* @param pModificationTime Pointer to the new modifcation time. NULL if
397	* not to be changed.
398	* @param pChangeTime Pointer to the new change time. NULL if not to be
399	* changed.
400	* @param pBirthTime Pointer to the new time of birth. NULL if not to be
401	* changed.
402	* @remarks See RTFileSetTimes for restrictions and behavior imposed by the
403	* host OS or underlying VFS provider.
404	* @sa RTFileSetTimes, RTPathSetTimes
405	*/
406	RTDECL(int) RTVfsSymlinkSetTimes(RTVFSSYMLINK hVfsSym, PCRTTIMESPEC pAccessTime, PCRTTIMESPEC pModificationTime,
407	PCRTTIMESPEC pChangeTime, PCRTTIMESPEC pBirthTime);
408
409	/**
410	* Set the unix style owner and group.
411	*
412	* @returns IPRT status code.
413	* @param hVfsSym The VFS symbolic link handle.
414	* @param uid The user ID of the new owner. NIL_RTUID if
415	* unchanged.
416	* @param gid The group ID of the new owner group. NIL_RTGID if
417	* unchanged.
418	* @sa RTFileSetOwner, RTPathSetOwner.
419	*/
420	RTDECL(int) RTVfsSymlinkSetOwner(RTVFSSYMLINK hVfsSym, RTUID uid, RTGID gid);
421
422	/**
423	* Read the symbolic link target.
424	*
425	* @returns IPRT status code.
426	* @param hVfsSym The VFS symbolic link handle.
427	* @param pszTarget The target buffer.
428	* @param cbTarget The size of the target buffer.
429	* @sa RTSymlinkRead
430	*/
431	RTDECL(int) RTVfsSymlinkRead(RTVFSSYMLINK hVfsSym, char *pszTarget, size_t cbTarget);
432
433	/** @} */
434
435
436
437	/** @defgroup grp_vfs_iostream VFS I/O Stream API
438	* @{
439	*/
440
441	/**
442	* Create a VFS I/O stream handle from a standard IPRT file handle (RTFILE).
443	*
444	* @returns IPRT status code.
445	* @param hFile The standard IPRT file handle.
446	* @param fOpen The flags the handle was opened with. Pass 0 to
447	* have these detected.
448	* @param fLeaveOpen Whether to leave the handle open when the VFS file
449	* is released, or to close it (@c false).
450	* @param phVfsIos Where to return the VFS I/O stream handle.
451	*/
452	RTDECL(int) RTVfsIoStrmFromRTFile(RTFILE hFile, uint64_t fOpen, bool fLeaveOpen, PRTVFSIOSTREAM phVfsIos);
453
454	/**
455	* Create a VFS I/O stream handle from one of the standard handles.
456	*
457	* @returns IPRT status code.
458	* @param enmStdHandle The standard IPRT file handle.
459	* @param fOpen The flags the handle was opened with. Pass 0 to
460	* have these detected.
461	* @param fLeaveOpen Whether to leave the handle open when the VFS file
462	* is released, or to close it (@c false).
463	* @param phVfsIos Where to return the VFS I/O stream handle.
464	*/
465	RTDECL(int) RTVfsIoStrmFromStdHandle(RTHANDLESTD enmStdHandle, uint64_t fOpen, bool fLeaveOpen,
466	PRTVFSIOSTREAM phVfsIos);
467
468	/**
469	* Retains a reference to the VFS I/O stream handle.
470	*
471	* @returns New reference count on success, UINT32_MAX on failure.
472	* @param hVfsIos The VFS I/O stream handle.
473	*/
474	RTDECL(uint32_t) RTVfsIoStrmRetain(RTVFSIOSTREAM hVfsIos);
475
476	/**
477	* Releases a reference to the VFS I/O stream handle.
478	*
479	* @returns New reference count on success (0 if closed), UINT32_MAX on failure.
480	* @param hVfsIos The VFS I/O stream handle.
481	*/
482	RTDECL(uint32_t) RTVfsIoStrmRelease(RTVFSIOSTREAM hVfsIos);
483
484	/**
485	* Convert the VFS I/O stream handle to a VFS file handle.
486	*
487	* @returns The VFS file handle on success, this must be released.
488	* NIL_RTVFSFILE if the I/O stream handle is invalid.
489	* @param hVfsIos The VFS I/O stream handle.
490	* @sa RTVfsFileToIoStream
491	*/
492	RTDECL(RTVFSFILE) RTVfsIoStrmToFile(RTVFSIOSTREAM hVfsIos);
493
494	/**
495	* Query information about the I/O stream.
496	*
497	* @returns IPRT status code.
498	* @param hVfsIos The VFS I/O stream handle.
499	* @param pObjInfo Where to return the info.
500	* @param enmAddAttr Which additional attributes should be retrieved.
501	* @sa RTFileQueryInfo
502	*/
503	RTDECL(int) RTVfsIoStrmQueryInfo(RTVFSIOSTREAM hVfsIos, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
504
505	/**
506	* Read bytes from the I/O stream.
507	*
508	* @returns IPRT status code.
509	* @retval VINF_SUCCESS and the number of bytes read written to @a pcbRead.
510	* @retval VINF_TRY_AGAIN if @a fBlocking is @c false, @a pcbRead is not NULL,
511	* and no data was available. @a *pcbRead will be set to 0.
512	* @retval VINF_EOF when trying to read __beyond__ the end of the stream and
513	* @a pcbRead is not NULL (it will be set to the number of bytes read,
514	* or 0 if the end of the stream was reached before this call).
515	* When the last byte of the read request is the last byte in the
516	* stream, this status code will not be used. However, VINF_EOF is
517	* returned when attempting to read 0 bytes while standing at the end
518	* of the stream.
519	* @retval VERR_EOF when trying to read __beyond__ the end of the stream and
520	* @a pcbRead is NULL.
521	* @retval VERR_ACCESS_DENIED if the stream is not readable.
522	*
523	* @param hVfsIos The VFS I/O stream handle.
524	* @param pvBuf Where to store the read bytes.
525	* @param cbToRead The number of bytes to read.
526	* @param fBlocking Whether the call is blocking (@c true) or not. If
527	* not, the @a pcbRead parameter must not be NULL.
528	* @param pcbRead Where to always store the number of bytes actually
529	* read. This can be NULL if @a fBlocking is true.
530	* @sa RTVfsFileRead, RTFileRead, RTPipeRead, RTPipeReadBlocking,
531	* RTSocketRead
532	*/
533	RTDECL(int) RTVfsIoStrmRead(RTVFSIOSTREAM hVfsIos, void pvBuf, size_t cbToRead, bool fBlocking, size_t pcbRead);
534	RTDECL(int) RTVfsIoStrmReadAt(RTVFSIOSTREAM hVfsIos, RTFOFF off, void pvBuf, size_t cbToRead, bool fBlocking, size_t pcbRead);
535
536	/**
537	* Write bytes to the I/O stream.
538	*
539	* @returns IPRT status code.
540	* @retval VERR_ACCESS_DENIED if the stream is not writable.
541	*
542	* @param hVfsIos The VFS I/O stream handle.
543	* @param pvBuf The bytes to write.
544	* @param cbToWrite The number of bytes to write.
545	* @param fBlocking Whether the call is blocking (@c true) or not. If
546	* not, the @a pcbWritten parameter must not be NULL.
547	* @param pcbRead Where to always store the number of bytes actually
548	* written. This can be NULL if @a fBlocking is true.
549	* @sa RTVfsFileWrite, RTFileWrite, RTPipeWrite, RTPipeWriteBlocking,
550	* RTSocketWrite
551	*/
552	RTDECL(int) RTVfsIoStrmWrite(RTVFSIOSTREAM hVfsIos, const void pvBuf, size_t cbToWrite, bool fBlocking, size_t pcbWritten);
553	RTDECL(int) RTVfsIoStrmWriteAt(RTVFSIOSTREAM hVfsIos, RTFOFF off, const void pvBuf, size_t cbToWrite, bool fBlocking, size_t pcbWritten);
554
555	/**
556	* Reads bytes from the I/O stream into a scatter buffer.
557	*
558	* @returns IPRT status code.
559	* @retval VINF_SUCCESS and the number of bytes read written to @a pcbRead.
560	* @retval VINF_TRY_AGAIN if @a fBlocking is @c false, @a pcbRead is not NULL,
561	* and no data was available. @a *pcbRead will be set to 0.
562	* @retval VINF_EOF when trying to read __beyond__ the end of the stream and
563	* @a pcbRead is not NULL (it will be set to the number of bytes read,
564	* or 0 if the end of the stream was reached before this call).
565	* When the last byte of the read request is the last byte in the
566	* stream, this status code will not be used. However, VINF_EOF is
567	* returned when attempting to read 0 bytes while standing at the end
568	* of the stream.
569	* @retval VERR_EOF when trying to read __beyond__ the end of the stream and
570	* @a pcbRead is NULL.
571	* @retval VERR_ACCESS_DENIED if the stream is not readable.
572	*
573	* @param hVfsIos The VFS I/O stream handle.
574	* @param pSgBuf Pointer to a scatter buffer descriptor. The number
575	* of bytes described by the segments is what will be
576	* attemted read.
577	* @param fBlocking Whether the call is blocking (@c true) or not. If
578	* not, the @a pcbRead parameter must not be NULL.
579	* @param pcbRead Where to always store the number of bytes actually
580	* read. This can be NULL if @a fBlocking is true.
581	* @sa RTFileSgRead, RTSocketSgRead, RTPipeRead, RTPipeReadBlocking
582	*/
583	RTDECL(int) RTVfsIoStrmSgRead(RTVFSIOSTREAM hVfsIos, PCRTSGBUF pSgBuf, bool fBlocking, size_t *pcbRead);
584
585	/**
586	* Write bytes to the I/O stream from a gather buffer.
587	*
588	* @returns IPRT status code.
589	* @retval VERR_ACCESS_DENIED if the stream is not writable.
590	*
591	* @param hVfsIos The VFS I/O stream handle.
592	* @param pSgBuf Pointer to a gather buffer descriptor. The number
593	* of bytes described by the segments is what will be
594	* attemted written.
595	* @param fBlocking Whether the call is blocking (@c true) or not. If
596	* not, the @a pcbWritten parameter must not be NULL.
597	* @param pcbRead Where to always store the number of bytes actually
598	* written. This can be NULL if @a fBlocking is true.
599	* @sa RTFileSgWrite, RTSocketSgWrite
600	*/
601	RTDECL(int) RTVfsIoStrmSgWrite(RTVFSIOSTREAM hVfsIos, PCRTSGBUF pSgBuf, bool fBlocking, size_t *pcbWritten);
602
603	/**
604	* Flush any buffered data to the I/O stream.
605	*
606	* @returns IPRT status code.
607	* @param hVfsIos The VFS I/O stream handle.
608	* @sa RTVfsFileFlush, RTFileFlush, RTPipeFlush
609	*/
610	RTDECL(int) RTVfsIoStrmFlush(RTVFSIOSTREAM hVfsIos);
611
612	/**
613	* Poll for events.
614	*
615	* @returns IPRT status code.
616	* @param hVfsIos The VFS I/O stream handle.
617	* @param fEvents The events to poll for (RTPOLL_EVT_XXX).
618	* @param cMillies How long to wait for event to eventuate.
619	* @param fIntr Whether the wait is interruptible and can return
620	* VERR_INTERRUPTED (@c true) or if this condition
621	* should be hidden from the caller (@c false).
622	* @param pfRetEvents Where to return the event mask.
623	* @sa RTVfsFilePoll, RTPollSetAdd, RTPoll, RTPollNoResume.
624	*/
625	RTDECL(int) RTVfsIoStrmPoll(RTVFSIOSTREAM hVfsIos, uint32_t fEvents, RTMSINTERVAL cMillies, bool fIntr,
626	uint32_t *pfRetEvents);
627	/**
628	* Tells the current I/O stream position.
629	*
630	* @returns Zero or higher - where to return the I/O stream offset. Values
631	* below zero are IPRT status codes (VERR_XXX).
632	* @param hVfsIos The VFS I/O stream handle.
633	* @sa RTFileTell
634	*/
635	RTDECL(RTFOFF) RTVfsIoStrmTell(RTVFSIOSTREAM hVfsIos);
636
637	/**
638	* Skips @a cb ahead in the stream.
639	*
640	* @returns IPRT status code.
641	* @param hVfsIos The VFS I/O stream handle.
642	* @param cb The number bytes to skip.
643	*/
644	RTDECL(int) RTVfsIoStrmSkip(RTVFSIOSTREAM hVfsIos, RTFOFF cb);
645
646	/**
647	* Fills the stream with @a cb zeros.
648	*
649	* @returns IPRT status code.
650	* @param hVfsIos The VFS I/O stream handle.
651	* @param cb The number of zero bytes to insert.
652	*/
653	RTDECL(int) RTVfsIoStrmZeroFill(RTVFSIOSTREAM hVfsIos, RTFOFF cb);
654
655	/**
656	* Checks if we're at the end of the I/O stream.
657	*
658	* @returns true if at EOS, otherwise false.
659	* @param hVfsIos The VFS I/O stream handle.
660	*/
661	RTDECL(bool) RTVfsIoStrmIsAtEnd(RTVFSIOSTREAM hVfsIos);
662
663	/**
664	* Process the rest of the stream, checking if it's all valid UTF-8 encoding.
665	*
666	* @returns VBox status cod.e
667	*
668	* @param hVfsIos The VFS I/O stream handle.
669	* @param fFlags Flags governing the validation, see
670	* RTVFS_VALIDATE_UTF8_XXX.
671	* @param poffError Where to return the error offset. Optional.
672	*/
673	RTDECL(int) RTVfsIoStrmValidateUtf8Encoding(RTVFSIOSTREAM hVfsIos, uint32_t fFlags, PRTFOFF poffError);
674
675	/** @defgroup RTVFS_VALIDATE_UTF8_XXX RTVfsIoStrmValidateUtf8Encoding flags.
676	* @{ */
677	/** The text must not contain any null terminator codepoints. */
678	#define RTVFS_VALIDATE_UTF8_NO_NULL RT_BIT_32(0)
679	/** The codepoints must be in the range covered by RTC-3629. */
680	#define RTVFS_VALIDATE_UTF8_BY_RTC_3629 RT_BIT_32(1)
681	/** Mask of valid flags. */
682	#define RTVFS_VALIDATE_UTF8_VALID_MASK UINT32_C(0x00000003)
683	/** @} */
684
685	/** @} */
686
687
688	/** @defgroup grp_vfs_file VFS File API
689	* @{
690	*/
691	RTDECL(int) RTVfsFileOpen(RTVFS hVfs, const char *pszFilename, uint64_t fOpen, PRTVFSFILE phVfsFile);
692
693	/**
694	* Create a VFS file handle from a standard IPRT file handle (RTFILE).
695	*
696	* @returns IPRT status code.
697	* @param hFile The standard IPRT file handle.
698	* @param fOpen The flags the handle was opened with. Pass 0 to
699	* have these detected.
700	* @param fLeaveOpen Whether to leave the handle open when the VFS file
701	* is released, or to close it (@c false).
702	* @param phVfsFile Where to return the VFS file handle.
703	*/
704	RTDECL(int) RTVfsFileFromRTFile(RTFILE hFile, uint64_t fOpen, bool fLeaveOpen, PRTVFSFILE phVfsFile);
705	RTDECL(RTHCUINTPTR) RTVfsFileToNative(RTFILE hVfsFile);
706
707	/**
708	* Convert the VFS file handle to a VFS I/O stream handle.
709	*
710	* @returns The VFS I/O stream handle on success, this must be released.
711	* NIL_RTVFSIOSTREAM if the file handle is invalid.
712	* @param hVfsFile The VFS file handle.
713	* @sa RTVfsIoStrmToFile
714	*/
715	RTDECL(RTVFSIOSTREAM) RTVfsFileToIoStream(RTVFSFILE hVfsFile);
716
717	/**
718	* Retains a reference to the VFS file handle.
719	*
720	* @returns New reference count on success, UINT32_MAX on failure.
721	* @param hVfsFile The VFS file handle.
722	*/
723	RTDECL(uint32_t) RTVfsFileRetain(RTVFSFILE hVfsFile);
724
725	/**
726	* Releases a reference to the VFS file handle.
727	*
728	* @returns New reference count on success (0 if closed), UINT32_MAX on failure.
729	* @param hVfsFile The VFS file handle.
730	*/
731	RTDECL(uint32_t) RTVfsFileRelease(RTVFSFILE hVfsFile);
732
733	/**
734	* Query information about the object.
735	*
736	* @returns IPRT status code.
737	* @retval VERR_NOT_SUPPORTED if the @a enmAddAttr value is not handled by the
738	* implementation.
739	*
740	* @param hVfsObj The VFS object handle.
741	* @param pObjInfo Where to return the info.
742	* @param enmAddAttr Which additional attributes should be retrieved.
743	* @sa RTVfsObjQueryInfo, RTVfsFsStrmQueryInfo, RTVfsDirQueryInfo,
744	* RTVfsIoStrmQueryInfo, RTVfsFileQueryInfo, RTFileQueryInfo,
745	* RTPathQueryInfo.
746	*/
747	RTDECL(int) RTVfsFileQueryInfo(RTVFSFILE hVfsFile, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
748
749	/**
750	* Read bytes from the file at the current position.
751	*
752	* @returns IPRT status code.
753	* @retval VINF_SUCCESS and the number of bytes read written to @a pcbRead.
754	* @retval VINF_TRY_AGAIN if @a fBlocking is @c false, @a pcbRead is not NULL,
755	* and no data was available. @a *pcbRead will be set to 0.
756	* @retval VINF_EOF when trying to read __beyond__ the end of the file and
757	* @a pcbRead is not NULL (it will be set to the number of bytes read,
758	* or 0 if the end of the file was reached before this call).
759	* When the last byte of the read request is the last byte in the
760	* file, this status code will not be used. However, VINF_EOF is
761	* returned when attempting to read 0 bytes while standing at the end
762	* of the file.
763	* @retval VERR_EOF when trying to read __beyond__ the end of the file and
764	* @a pcbRead is NULL.
765	* @retval VERR_ACCESS_DENIED if the file is not readable.
766	*
767	* @param hVfsFile The VFS file handle.
768	* @param pvBuf Where to store the read bytes.
769	* @param cbToRead The number of bytes to read.
770	* @param fBlocking Whether the call is blocking (@c true) or not. If
771	* not, the @a pcbRead parameter must not be NULL.
772	* @param pcbRead Where to always store the number of bytes actually
773	* read. This can be NULL if @a fBlocking is true.
774	* @sa RTVfsIoStrmRead, RTFileRead, RTPipeRead, RTPipeReadBlocking,
775	* RTSocketRead
776	*/
777	RTDECL(int) RTVfsFileRead(RTVFSFILE hVfsFile, void pvBuf, size_t cbToRead, size_t pcbRead);
778	RTDECL(int) RTVfsFileReadAt(RTVFSFILE hVfsFile, RTFOFF off, void pvBuf, size_t cbToRead, size_t pcbRead);
779
780	/**
781	* Write bytes to the file at the current position.
782	*
783	* @returns IPRT status code.
784	* @retval VERR_ACCESS_DENIED if the file is not writable.
785	*
786	* @param hVfsFile The VFS file handle.
787	* @param pvBuf The bytes to write.
788	* @param cbToWrite The number of bytes to write.
789	* @param fBlocking Whether the call is blocking (@c true) or not. If
790	* not, the @a pcbWritten parameter must not be NULL.
791	* @param pcbRead Where to always store the number of bytes actually
792	* written. This can be NULL if @a fBlocking is true.
793	* @sa RTVfsIoStrmRead, RTFileWrite, RTPipeWrite, RTPipeWriteBlocking,
794	* RTSocketWrite
795	*/
796	RTDECL(int) RTVfsFileWrite(RTVFSFILE hVfsFile, const void pvBuf, size_t cbToWrite, size_t pcbWritten);
797	RTDECL(int) RTVfsFileWriteAt(RTVFSFILE hVfsFile, RTFOFF off, const void pvBuf, size_t cbToWrite, size_t pcbWritten);
798
799	/**
800	* Flush any buffered data to the file.
801	*
802	* @returns IPRT status code.
803	* @param hVfsFile The VFS file handle.
804	* @sa RTVfsIoStrmFlush, RTFileFlush, RTPipeFlush
805	*/
806	RTDECL(int) RTVfsFileFlush(RTVFSFILE hVfsFile);
807
808	/**
809	* Poll for events.
810	*
811	* @returns IPRT status code.
812	* @param hVfsFile The VFS file handle.
813	* @param fEvents The events to poll for (RTPOLL_EVT_XXX).
814	* @param cMillies How long to wait for event to eventuate.
815	* @param fIntr Whether the wait is interruptible and can return
816	* VERR_INTERRUPTED (@c true) or if this condition
817	* should be hidden from the caller (@c false).
818	* @param pfRetEvents Where to return the event mask.
819	* @sa RTVfsIoStrmPoll, RTPollSetAdd, RTPoll, RTPollNoResume.
820	*/
821	RTDECL(RTFOFF) RTVfsFilePoll(RTVFSFILE hVfsFile, uint32_t fEvents, RTMSINTERVAL cMillies, bool fIntr,
822	uint32_t *pfRetEvents);
823
824	/**
825	* Tells the current file position.
826	*
827	* @returns Zero or higher - where to return the file offset. Values
828	* below zero are IPRT status codes (VERR_XXX).
829	* @param hVfsFile The VFS file handle.
830	* @sa RTFileTell, RTVfsIoStrmTell.
831	*/
832	RTDECL(RTFOFF) RTVfsFileTell(RTVFSFILE hVfsFile);
833
834	/**
835	* Changes the current read/write position of a file.
836	*
837	* @returns IPRT status code.
838	*
839	* @param hVfsFile The VFS file handle.
840	* @param offSeek The seek offset.
841	* @param uMethod The seek emthod.
842	* @param poffActual Where to optionally return the new file offset.
843	*
844	* @sa RTFileSeek
845	*/
846	RTDECL(int) RTVfsFileSeek(RTVFSFILE hVfsFile, RTFOFF offSeek, uint32_t uMethod, uint64_t *poffActual);
847
848	RTDECL(int) RTVfsFileSetSize(RTVFSFILE hVfsFile, uint64_t cbSize);
849	RTDECL(int) RTVfsFileGetSize(RTVFSFILE hVfsFile, uint64_t *pcbSize);
850	RTDECL(RTFOFF) RTVfsFileGetMaxSize(RTVFSFILE hVfsFile);
851	RTDECL(int) RTVfsFileGetMaxSizeEx(RTVFSFILE hVfsFile, PRTFOFF pcbMax);
852
853	/** @} */
854
855
856	/** @defgroup grp_vfs_misc VFS Miscellaneous
857	* @{
858	*/
859
860	/**
861	* Memorizes the I/O stream as a file backed by memory.
862	*
863	* @returns VBox status code.
864	*
865	* @param hVfsIos The VFS I/O stream to memorize. This will be read
866	* to the end on success, on failure its position is
867	* undefined.
868	* @param fFlags A combination of RTFILE_O_READ and RTFILE_O_WRITE.
869	* @param phVfsFile Where to return the handle to the memory file on
870	* success.
871	*/
872	RTDECL(int) RTVfsMemorizeIoStreamAsFile(RTVFSIOSTREAM hVfsIos, uint32_t fFlags, PRTVFSFILE phVfsFile);
873
874
875	/**
876	* Pumps data from one I/O stream to another.
877	*
878	* The data is read in chunks from @a hVfsIosSrc and written to @a hVfsIosDst
879	* until @hVfsIosSrc indicates end of stream.
880	*
881	* @returns IPRT status code
882	*
883	* @param hVfsIosSrc The input stream.
884	* @param hVfsIosDst The output stream.
885	* @param cbBufHint Hints at a good temporary buffer size, pass 0 if
886	* clueless.
887	*/
888	RTDECL(int) RTVfsUtilPumpIoStreams(RTVFSIOSTREAM hVfsIosSrc, RTVFSIOSTREAM hVfsIosDst, size_t cbBufHint);
889
890	/** @} */
891
892
893	/** @defgroup grp_rt_vfs_chain VFS Chains
894	*
895	* VFS chains is for doing pipe like things with VFS objects from the command
896	* line. Imagine you want to cat the readme.gz of an ISO you could do
897	* something like:
898	* RTCat :iprtvfs:vfs(isofs,./mycd.iso)\|ios(open,readme.gz)\|ios(gunzip)
899	* or
900	* RTCat :iprtvfs:ios(isofs,./mycd.iso,/readme.gz)\|ios(gunzip)
901	*
902	* The "isofs", "open" and "gunzip" bits in the above examples are chain
903	* element providers registered with IPRT. See RTVFSCHAINELEMENTREG for how
904	* these works.
905	*
906	* @{ */
907
908	/** The path prefix used to identify an VFS chain specification. */
909	#define RTVFSCHAIN_SPEC_PREFIX ":iprtvfs:"
910
911	RTDECL(int) RTVfsChainOpenVfs( const char pszSpec, PRTVFS phVfs, const char *ppszError);
912	RTDECL(int) RTVfsChainOpenFsStream( const char pszSpec, PRTVFSFSSTREAM phVfsFss, const char *ppszError);
913	RTDECL(int) RTVfsChainOpenDir( const char pszSpec, uint64_t fOpen, PRTVFSDIR phVfsDir, const char *ppszError);
914	RTDECL(int) RTVfsChainOpenFile( const char pszSpec, uint64_t fOpen, PRTVFSFILE phVfsFile, const char *ppszError);
915	RTDECL(int) RTVfsChainOpenSymlink( const char pszSpec, PRTVFSSYMLINK phVfsSym, const char *ppszError);
916	RTDECL(int) RTVfsChainOpenIoStream( const char pszSpec, uint64_t fOpen, PRTVFSIOSTREAM phVfsIos, const char *ppszError);
917
918	/**
919	* Tests if the given string is a chain specification or not.
920	*
921	* @returns true if it is, false if it isn't.
922	* @param pszSpec The alleged chain spec.
923	*/
924	RTDECL(bool) RTVfsChainIsSpec(const char *pszSpec);
925
926	/** @} */
927
928
929	/** @} */
930
931	RT_C_DECLS_END
932
933	#endif /* !___iprt_vfs_h */
934

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

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

Download in other formats: