1 | /** @file
|
---|
2 | * IPRT - Virtual Filesystem.
|
---|
3 | */
|
---|
4 |
|
---|
5 | /*
|
---|
6 | * Copyright (C) 2010-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_symlink 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 | * Convenience function combining RTFileOpen with RTVfsIoStrmFromRTFile.
|
---|
456 | *
|
---|
457 | * @returns IPRT status code.
|
---|
458 | * @param pszFilename The path to the file in the normal file system.
|
---|
459 | * @param fOpen The flags to pass to RTFileOpen when opening the
|
---|
460 | * file, i.e. RTFILE_O_XXX.
|
---|
461 | * @param phVfsIos Where to return the VFS I/O stream handle.
|
---|
462 | */
|
---|
463 | RTDECL(int) RTVfsIoStrmOpenNormal(const char *pszFilename, uint64_t fOpen, PRTVFSIOSTREAM phVfsIos);
|
---|
464 |
|
---|
465 | /**
|
---|
466 | * Create a VFS I/O stream handle from one of the standard handles.
|
---|
467 | *
|
---|
468 | * @returns IPRT status code.
|
---|
469 | * @param enmStdHandle The standard IPRT file handle.
|
---|
470 | * @param fOpen The flags the handle was opened with. Pass 0 to
|
---|
471 | * have these detected.
|
---|
472 | * @param fLeaveOpen Whether to leave the handle open when the VFS file
|
---|
473 | * is released, or to close it (@c false).
|
---|
474 | * @param phVfsIos Where to return the VFS I/O stream handle.
|
---|
475 | */
|
---|
476 | RTDECL(int) RTVfsIoStrmFromStdHandle(RTHANDLESTD enmStdHandle, uint64_t fOpen, bool fLeaveOpen,
|
---|
477 | PRTVFSIOSTREAM phVfsIos);
|
---|
478 |
|
---|
479 | /**
|
---|
480 | * Retains a reference to the VFS I/O stream handle.
|
---|
481 | *
|
---|
482 | * @returns New reference count on success, UINT32_MAX on failure.
|
---|
483 | * @param hVfsIos The VFS I/O stream handle.
|
---|
484 | */
|
---|
485 | RTDECL(uint32_t) RTVfsIoStrmRetain(RTVFSIOSTREAM hVfsIos);
|
---|
486 |
|
---|
487 | /**
|
---|
488 | * Releases a reference to the VFS I/O stream handle.
|
---|
489 | *
|
---|
490 | * @returns New reference count on success (0 if closed), UINT32_MAX on failure.
|
---|
491 | * @param hVfsIos The VFS I/O stream handle.
|
---|
492 | */
|
---|
493 | RTDECL(uint32_t) RTVfsIoStrmRelease(RTVFSIOSTREAM hVfsIos);
|
---|
494 |
|
---|
495 | /**
|
---|
496 | * Convert the VFS I/O stream handle to a VFS file handle.
|
---|
497 | *
|
---|
498 | * @returns The VFS file handle on success, this must be released.
|
---|
499 | * NIL_RTVFSFILE if the I/O stream handle is invalid.
|
---|
500 | * @param hVfsIos The VFS I/O stream handle.
|
---|
501 | * @sa RTVfsFileToIoStream
|
---|
502 | */
|
---|
503 | RTDECL(RTVFSFILE) RTVfsIoStrmToFile(RTVFSIOSTREAM hVfsIos);
|
---|
504 |
|
---|
505 | /**
|
---|
506 | * Query information about the I/O stream.
|
---|
507 | *
|
---|
508 | * @returns IPRT status code.
|
---|
509 | * @param hVfsIos The VFS I/O stream handle.
|
---|
510 | * @param pObjInfo Where to return the info.
|
---|
511 | * @param enmAddAttr Which additional attributes should be retrieved.
|
---|
512 | * @sa RTFileQueryInfo
|
---|
513 | */
|
---|
514 | RTDECL(int) RTVfsIoStrmQueryInfo(RTVFSIOSTREAM hVfsIos, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
|
---|
515 |
|
---|
516 | /**
|
---|
517 | * Read bytes from the I/O stream.
|
---|
518 | *
|
---|
519 | * @returns IPRT status code.
|
---|
520 | * @retval VINF_SUCCESS and the number of bytes read written to @a pcbRead.
|
---|
521 | * @retval VINF_TRY_AGAIN if @a fBlocking is @c false, @a pcbRead is not NULL,
|
---|
522 | * and no data was available. @a *pcbRead will be set to 0.
|
---|
523 | * @retval VINF_EOF when trying to read __beyond__ the end of the stream and
|
---|
524 | * @a pcbRead is not NULL (it will be set to the number of bytes read,
|
---|
525 | * or 0 if the end of the stream was reached before this call).
|
---|
526 | * When the last byte of the read request is the last byte in the
|
---|
527 | * stream, this status code will not be used. However, VINF_EOF is
|
---|
528 | * returned when attempting to read 0 bytes while standing at the end
|
---|
529 | * of the stream.
|
---|
530 | * @retval VERR_EOF when trying to read __beyond__ the end of the stream and
|
---|
531 | * @a pcbRead is NULL.
|
---|
532 | * @retval VERR_ACCESS_DENIED if the stream is not readable.
|
---|
533 | *
|
---|
534 | * @param hVfsIos The VFS I/O stream handle.
|
---|
535 | * @param pvBuf Where to store the read bytes.
|
---|
536 | * @param cbToRead The number of bytes to read.
|
---|
537 | * @param fBlocking Whether the call is blocking (@c true) or not. If
|
---|
538 | * not, the @a pcbRead parameter must not be NULL.
|
---|
539 | * @param pcbRead Where to always store the number of bytes actually
|
---|
540 | * read. This can be NULL if @a fBlocking is true.
|
---|
541 | * @sa RTVfsFileRead, RTFileRead, RTPipeRead, RTPipeReadBlocking,
|
---|
542 | * RTSocketRead
|
---|
543 | */
|
---|
544 | RTDECL(int) RTVfsIoStrmRead(RTVFSIOSTREAM hVfsIos, void *pvBuf, size_t cbToRead, bool fBlocking, size_t *pcbRead);
|
---|
545 | RTDECL(int) RTVfsIoStrmReadAt(RTVFSIOSTREAM hVfsIos, RTFOFF off, void *pvBuf, size_t cbToRead, bool fBlocking, size_t *pcbRead);
|
---|
546 |
|
---|
547 | /**
|
---|
548 | * Write bytes to the I/O stream.
|
---|
549 | *
|
---|
550 | * @returns IPRT status code.
|
---|
551 | * @retval VERR_ACCESS_DENIED if the stream is not writable.
|
---|
552 | *
|
---|
553 | * @param hVfsIos The VFS I/O stream handle.
|
---|
554 | * @param pvBuf The bytes to write.
|
---|
555 | * @param cbToWrite The number of bytes to write.
|
---|
556 | * @param fBlocking Whether the call is blocking (@c true) or not. If
|
---|
557 | * not, the @a pcbWritten parameter must not be NULL.
|
---|
558 | * @param pcbRead Where to always store the number of bytes actually
|
---|
559 | * written. This can be NULL if @a fBlocking is true.
|
---|
560 | * @sa RTVfsFileWrite, RTFileWrite, RTPipeWrite, RTPipeWriteBlocking,
|
---|
561 | * RTSocketWrite
|
---|
562 | */
|
---|
563 | RTDECL(int) RTVfsIoStrmWrite(RTVFSIOSTREAM hVfsIos, const void *pvBuf, size_t cbToWrite, bool fBlocking, size_t *pcbWritten);
|
---|
564 | RTDECL(int) RTVfsIoStrmWriteAt(RTVFSIOSTREAM hVfsIos, RTFOFF off, const void *pvBuf, size_t cbToWrite, bool fBlocking, size_t *pcbWritten);
|
---|
565 |
|
---|
566 | /**
|
---|
567 | * Reads bytes from the I/O stream into a scatter buffer.
|
---|
568 | *
|
---|
569 | * @returns IPRT status code.
|
---|
570 | * @retval VINF_SUCCESS and the number of bytes read written to @a pcbRead.
|
---|
571 | * @retval VINF_TRY_AGAIN if @a fBlocking is @c false, @a pcbRead is not NULL,
|
---|
572 | * and no data was available. @a *pcbRead will be set to 0.
|
---|
573 | * @retval VINF_EOF when trying to read __beyond__ the end of the stream and
|
---|
574 | * @a pcbRead is not NULL (it will be set to the number of bytes read,
|
---|
575 | * or 0 if the end of the stream was reached before this call).
|
---|
576 | * When the last byte of the read request is the last byte in the
|
---|
577 | * stream, this status code will not be used. However, VINF_EOF is
|
---|
578 | * returned when attempting to read 0 bytes while standing at the end
|
---|
579 | * of the stream.
|
---|
580 | * @retval VERR_EOF when trying to read __beyond__ the end of the stream and
|
---|
581 | * @a pcbRead is NULL.
|
---|
582 | * @retval VERR_ACCESS_DENIED if the stream is not readable.
|
---|
583 | *
|
---|
584 | * @param hVfsIos The VFS I/O stream handle.
|
---|
585 | * @param pSgBuf Pointer to a scatter buffer descriptor. The number
|
---|
586 | * of bytes described by the segments is what will be
|
---|
587 | * attemted read.
|
---|
588 | * @param fBlocking Whether the call is blocking (@c true) or not. If
|
---|
589 | * not, the @a pcbRead parameter must not be NULL.
|
---|
590 | * @param pcbRead Where to always store the number of bytes actually
|
---|
591 | * read. This can be NULL if @a fBlocking is true.
|
---|
592 | * @sa RTFileSgRead, RTSocketSgRead, RTPipeRead, RTPipeReadBlocking
|
---|
593 | */
|
---|
594 | RTDECL(int) RTVfsIoStrmSgRead(RTVFSIOSTREAM hVfsIos, PCRTSGBUF pSgBuf, bool fBlocking, size_t *pcbRead);
|
---|
595 |
|
---|
596 | /**
|
---|
597 | * Write bytes to the I/O stream from a gather buffer.
|
---|
598 | *
|
---|
599 | * @returns IPRT status code.
|
---|
600 | * @retval VERR_ACCESS_DENIED if the stream is not writable.
|
---|
601 | *
|
---|
602 | * @param hVfsIos The VFS I/O stream handle.
|
---|
603 | * @param pSgBuf Pointer to a gather buffer descriptor. The number
|
---|
604 | * of bytes described by the segments is what will be
|
---|
605 | * attemted written.
|
---|
606 | * @param fBlocking Whether the call is blocking (@c true) or not. If
|
---|
607 | * not, the @a pcbWritten parameter must not be NULL.
|
---|
608 | * @param pcbRead Where to always store the number of bytes actually
|
---|
609 | * written. This can be NULL if @a fBlocking is true.
|
---|
610 | * @sa RTFileSgWrite, RTSocketSgWrite
|
---|
611 | */
|
---|
612 | RTDECL(int) RTVfsIoStrmSgWrite(RTVFSIOSTREAM hVfsIos, PCRTSGBUF pSgBuf, bool fBlocking, size_t *pcbWritten);
|
---|
613 |
|
---|
614 | /**
|
---|
615 | * Flush any buffered data to the I/O stream.
|
---|
616 | *
|
---|
617 | * @returns IPRT status code.
|
---|
618 | * @param hVfsIos The VFS I/O stream handle.
|
---|
619 | * @sa RTVfsFileFlush, RTFileFlush, RTPipeFlush
|
---|
620 | */
|
---|
621 | RTDECL(int) RTVfsIoStrmFlush(RTVFSIOSTREAM hVfsIos);
|
---|
622 |
|
---|
623 | /**
|
---|
624 | * Poll for events.
|
---|
625 | *
|
---|
626 | * @returns IPRT status code.
|
---|
627 | * @param hVfsIos The VFS I/O stream handle.
|
---|
628 | * @param fEvents The events to poll for (RTPOLL_EVT_XXX).
|
---|
629 | * @param cMillies How long to wait for event to eventuate.
|
---|
630 | * @param fIntr Whether the wait is interruptible and can return
|
---|
631 | * VERR_INTERRUPTED (@c true) or if this condition
|
---|
632 | * should be hidden from the caller (@c false).
|
---|
633 | * @param pfRetEvents Where to return the event mask.
|
---|
634 | * @sa RTVfsFilePoll, RTPollSetAdd, RTPoll, RTPollNoResume.
|
---|
635 | */
|
---|
636 | RTDECL(int) RTVfsIoStrmPoll(RTVFSIOSTREAM hVfsIos, uint32_t fEvents, RTMSINTERVAL cMillies, bool fIntr,
|
---|
637 | uint32_t *pfRetEvents);
|
---|
638 | /**
|
---|
639 | * Tells the current I/O stream position.
|
---|
640 | *
|
---|
641 | * @returns Zero or higher - where to return the I/O stream offset. Values
|
---|
642 | * below zero are IPRT status codes (VERR_XXX).
|
---|
643 | * @param hVfsIos The VFS I/O stream handle.
|
---|
644 | * @sa RTFileTell
|
---|
645 | */
|
---|
646 | RTDECL(RTFOFF) RTVfsIoStrmTell(RTVFSIOSTREAM hVfsIos);
|
---|
647 |
|
---|
648 | /**
|
---|
649 | * Skips @a cb ahead in the stream.
|
---|
650 | *
|
---|
651 | * @returns IPRT status code.
|
---|
652 | * @param hVfsIos The VFS I/O stream handle.
|
---|
653 | * @param cb The number bytes to skip.
|
---|
654 | */
|
---|
655 | RTDECL(int) RTVfsIoStrmSkip(RTVFSIOSTREAM hVfsIos, RTFOFF cb);
|
---|
656 |
|
---|
657 | /**
|
---|
658 | * Fills the stream with @a cb zeros.
|
---|
659 | *
|
---|
660 | * @returns IPRT status code.
|
---|
661 | * @param hVfsIos The VFS I/O stream handle.
|
---|
662 | * @param cb The number of zero bytes to insert.
|
---|
663 | */
|
---|
664 | RTDECL(int) RTVfsIoStrmZeroFill(RTVFSIOSTREAM hVfsIos, RTFOFF cb);
|
---|
665 |
|
---|
666 | /**
|
---|
667 | * Checks if we're at the end of the I/O stream.
|
---|
668 | *
|
---|
669 | * @returns true if at EOS, otherwise false.
|
---|
670 | * @param hVfsIos The VFS I/O stream handle.
|
---|
671 | */
|
---|
672 | RTDECL(bool) RTVfsIoStrmIsAtEnd(RTVFSIOSTREAM hVfsIos);
|
---|
673 |
|
---|
674 | /**
|
---|
675 | * Process the rest of the stream, checking if it's all valid UTF-8 encoding.
|
---|
676 | *
|
---|
677 | * @returns VBox status cod.e
|
---|
678 | *
|
---|
679 | * @param hVfsIos The VFS I/O stream handle.
|
---|
680 | * @param fFlags Flags governing the validation, see
|
---|
681 | * RTVFS_VALIDATE_UTF8_XXX.
|
---|
682 | * @param poffError Where to return the error offset. Optional.
|
---|
683 | */
|
---|
684 | RTDECL(int) RTVfsIoStrmValidateUtf8Encoding(RTVFSIOSTREAM hVfsIos, uint32_t fFlags, PRTFOFF poffError);
|
---|
685 |
|
---|
686 | /** @defgroup RTVFS_VALIDATE_UTF8_XXX RTVfsIoStrmValidateUtf8Encoding flags.
|
---|
687 | * @{ */
|
---|
688 | /** The text must not contain any null terminator codepoints. */
|
---|
689 | #define RTVFS_VALIDATE_UTF8_NO_NULL RT_BIT_32(0)
|
---|
690 | /** The codepoints must be in the range covered by RTC-3629. */
|
---|
691 | #define RTVFS_VALIDATE_UTF8_BY_RTC_3629 RT_BIT_32(1)
|
---|
692 | /** Mask of valid flags. */
|
---|
693 | #define RTVFS_VALIDATE_UTF8_VALID_MASK UINT32_C(0x00000003)
|
---|
694 | /** @} */
|
---|
695 |
|
---|
696 | /** @} */
|
---|
697 |
|
---|
698 |
|
---|
699 | /** @defgroup grp_vfs_file VFS File API
|
---|
700 | * @{
|
---|
701 | */
|
---|
702 | RTDECL(int) RTVfsFileOpen(RTVFS hVfs, const char *pszFilename, uint64_t fOpen, PRTVFSFILE phVfsFile);
|
---|
703 |
|
---|
704 | /**
|
---|
705 | * Create a VFS file handle from a standard IPRT file handle (RTFILE).
|
---|
706 | *
|
---|
707 | * @returns IPRT status code.
|
---|
708 | * @param hFile The standard IPRT file handle.
|
---|
709 | * @param fOpen The flags the handle was opened with. Pass 0 to
|
---|
710 | * have these detected.
|
---|
711 | * @param fLeaveOpen Whether to leave the handle open when the VFS file
|
---|
712 | * is released, or to close it (@c false).
|
---|
713 | * @param phVfsFile Where to return the VFS file handle.
|
---|
714 | */
|
---|
715 | RTDECL(int) RTVfsFileFromRTFile(RTFILE hFile, uint64_t fOpen, bool fLeaveOpen, PRTVFSFILE phVfsFile);
|
---|
716 | RTDECL(RTHCUINTPTR) RTVfsFileToNative(RTFILE hVfsFile);
|
---|
717 |
|
---|
718 | /**
|
---|
719 | * Convenience function combining RTFileOpen with RTVfsFileFromRTFile.
|
---|
720 | *
|
---|
721 | * @returns IPRT status code.
|
---|
722 | * @param pszFilename The path to the file in the normal file system.
|
---|
723 | * @param fOpen The flags to pass to RTFileOpen when opening the
|
---|
724 | * file, i.e. RTFILE_O_XXX.
|
---|
725 | * @param phVfsFile Where to return the VFS file handle.
|
---|
726 | */
|
---|
727 | RTDECL(int) RTVfsFileOpenNormal(const char *pszFilename, uint64_t fOpen, PRTVFSFILE phVfsFile);
|
---|
728 |
|
---|
729 | /**
|
---|
730 | * Convert the VFS file handle to a VFS I/O stream handle.
|
---|
731 | *
|
---|
732 | * @returns The VFS I/O stream handle on success, this must be released.
|
---|
733 | * NIL_RTVFSIOSTREAM if the file handle is invalid.
|
---|
734 | * @param hVfsFile The VFS file handle.
|
---|
735 | * @sa RTVfsIoStrmToFile
|
---|
736 | */
|
---|
737 | RTDECL(RTVFSIOSTREAM) RTVfsFileToIoStream(RTVFSFILE hVfsFile);
|
---|
738 |
|
---|
739 | /**
|
---|
740 | * Retains a reference to the VFS file handle.
|
---|
741 | *
|
---|
742 | * @returns New reference count on success, UINT32_MAX on failure.
|
---|
743 | * @param hVfsFile The VFS file handle.
|
---|
744 | */
|
---|
745 | RTDECL(uint32_t) RTVfsFileRetain(RTVFSFILE hVfsFile);
|
---|
746 |
|
---|
747 | /**
|
---|
748 | * Releases a reference to the VFS file handle.
|
---|
749 | *
|
---|
750 | * @returns New reference count on success (0 if closed), UINT32_MAX on failure.
|
---|
751 | * @param hVfsFile The VFS file handle.
|
---|
752 | */
|
---|
753 | RTDECL(uint32_t) RTVfsFileRelease(RTVFSFILE hVfsFile);
|
---|
754 |
|
---|
755 | /**
|
---|
756 | * Query information about the object.
|
---|
757 | *
|
---|
758 | * @returns IPRT status code.
|
---|
759 | * @retval VERR_NOT_SUPPORTED if the @a enmAddAttr value is not handled by the
|
---|
760 | * implementation.
|
---|
761 | *
|
---|
762 | * @param hVfsObj The VFS object handle.
|
---|
763 | * @param pObjInfo Where to return the info.
|
---|
764 | * @param enmAddAttr Which additional attributes should be retrieved.
|
---|
765 | * @sa RTVfsObjQueryInfo, RTVfsFsStrmQueryInfo, RTVfsDirQueryInfo,
|
---|
766 | * RTVfsIoStrmQueryInfo, RTVfsFileQueryInfo, RTFileQueryInfo,
|
---|
767 | * RTPathQueryInfo.
|
---|
768 | */
|
---|
769 | RTDECL(int) RTVfsFileQueryInfo(RTVFSFILE hVfsFile, PRTFSOBJINFO pObjInfo, RTFSOBJATTRADD enmAddAttr);
|
---|
770 |
|
---|
771 | /**
|
---|
772 | * Read bytes from the file at the current position.
|
---|
773 | *
|
---|
774 | * @returns IPRT status code.
|
---|
775 | * @retval VINF_SUCCESS and the number of bytes read written to @a pcbRead.
|
---|
776 | * @retval VINF_TRY_AGAIN if @a fBlocking is @c false, @a pcbRead is not NULL,
|
---|
777 | * and no data was available. @a *pcbRead will be set to 0.
|
---|
778 | * @retval VINF_EOF when trying to read __beyond__ the end of the file and
|
---|
779 | * @a pcbRead is not NULL (it will be set to the number of bytes read,
|
---|
780 | * or 0 if the end of the file was reached before this call).
|
---|
781 | * When the last byte of the read request is the last byte in the
|
---|
782 | * file, this status code will not be used. However, VINF_EOF is
|
---|
783 | * returned when attempting to read 0 bytes while standing at the end
|
---|
784 | * of the file.
|
---|
785 | * @retval VERR_EOF when trying to read __beyond__ the end of the file and
|
---|
786 | * @a pcbRead is NULL.
|
---|
787 | * @retval VERR_ACCESS_DENIED if the file is not readable.
|
---|
788 | *
|
---|
789 | * @param hVfsFile The VFS file handle.
|
---|
790 | * @param pvBuf Where to store the read bytes.
|
---|
791 | * @param cbToRead The number of bytes to read.
|
---|
792 | * @param fBlocking Whether the call is blocking (@c true) or not. If
|
---|
793 | * not, the @a pcbRead parameter must not be NULL.
|
---|
794 | * @param pcbRead Where to always store the number of bytes actually
|
---|
795 | * read. This can be NULL if @a fBlocking is true.
|
---|
796 | * @sa RTVfsIoStrmRead, RTFileRead, RTPipeRead, RTPipeReadBlocking,
|
---|
797 | * RTSocketRead
|
---|
798 | */
|
---|
799 | RTDECL(int) RTVfsFileRead(RTVFSFILE hVfsFile, void *pvBuf, size_t cbToRead, size_t *pcbRead);
|
---|
800 | RTDECL(int) RTVfsFileReadAt(RTVFSFILE hVfsFile, RTFOFF off, void *pvBuf, size_t cbToRead, size_t *pcbRead);
|
---|
801 |
|
---|
802 | /**
|
---|
803 | * Write bytes to the file at the current position.
|
---|
804 | *
|
---|
805 | * @returns IPRT status code.
|
---|
806 | * @retval VERR_ACCESS_DENIED if the file is not writable.
|
---|
807 | *
|
---|
808 | * @param hVfsFile The VFS file handle.
|
---|
809 | * @param pvBuf The bytes to write.
|
---|
810 | * @param cbToWrite The number of bytes to write.
|
---|
811 | * @param fBlocking Whether the call is blocking (@c true) or not. If
|
---|
812 | * not, the @a pcbWritten parameter must not be NULL.
|
---|
813 | * @param pcbRead Where to always store the number of bytes actually
|
---|
814 | * written. This can be NULL if @a fBlocking is true.
|
---|
815 | * @sa RTVfsIoStrmRead, RTFileWrite, RTPipeWrite, RTPipeWriteBlocking,
|
---|
816 | * RTSocketWrite
|
---|
817 | */
|
---|
818 | RTDECL(int) RTVfsFileWrite(RTVFSFILE hVfsFile, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten);
|
---|
819 | RTDECL(int) RTVfsFileWriteAt(RTVFSFILE hVfsFile, RTFOFF off, const void *pvBuf, size_t cbToWrite, size_t *pcbWritten);
|
---|
820 |
|
---|
821 | /**
|
---|
822 | * Flush any buffered data to the file.
|
---|
823 | *
|
---|
824 | * @returns IPRT status code.
|
---|
825 | * @param hVfsFile The VFS file handle.
|
---|
826 | * @sa RTVfsIoStrmFlush, RTFileFlush, RTPipeFlush
|
---|
827 | */
|
---|
828 | RTDECL(int) RTVfsFileFlush(RTVFSFILE hVfsFile);
|
---|
829 |
|
---|
830 | /**
|
---|
831 | * Poll for events.
|
---|
832 | *
|
---|
833 | * @returns IPRT status code.
|
---|
834 | * @param hVfsFile The VFS file handle.
|
---|
835 | * @param fEvents The events to poll for (RTPOLL_EVT_XXX).
|
---|
836 | * @param cMillies How long to wait for event to eventuate.
|
---|
837 | * @param fIntr Whether the wait is interruptible and can return
|
---|
838 | * VERR_INTERRUPTED (@c true) or if this condition
|
---|
839 | * should be hidden from the caller (@c false).
|
---|
840 | * @param pfRetEvents Where to return the event mask.
|
---|
841 | * @sa RTVfsIoStrmPoll, RTPollSetAdd, RTPoll, RTPollNoResume.
|
---|
842 | */
|
---|
843 | RTDECL(RTFOFF) RTVfsFilePoll(RTVFSFILE hVfsFile, uint32_t fEvents, RTMSINTERVAL cMillies, bool fIntr,
|
---|
844 | uint32_t *pfRetEvents);
|
---|
845 |
|
---|
846 | /**
|
---|
847 | * Tells the current file position.
|
---|
848 | *
|
---|
849 | * @returns Zero or higher - where to return the file offset. Values
|
---|
850 | * below zero are IPRT status codes (VERR_XXX).
|
---|
851 | * @param hVfsFile The VFS file handle.
|
---|
852 | * @sa RTFileTell, RTVfsIoStrmTell.
|
---|
853 | */
|
---|
854 | RTDECL(RTFOFF) RTVfsFileTell(RTVFSFILE hVfsFile);
|
---|
855 |
|
---|
856 | /**
|
---|
857 | * Changes the current read/write position of a file.
|
---|
858 | *
|
---|
859 | * @returns IPRT status code.
|
---|
860 | *
|
---|
861 | * @param hVfsFile The VFS file handle.
|
---|
862 | * @param offSeek The seek offset.
|
---|
863 | * @param uMethod The seek emthod.
|
---|
864 | * @param poffActual Where to optionally return the new file offset.
|
---|
865 | *
|
---|
866 | * @sa RTFileSeek
|
---|
867 | */
|
---|
868 | RTDECL(int) RTVfsFileSeek(RTVFSFILE hVfsFile, RTFOFF offSeek, uint32_t uMethod, uint64_t *poffActual);
|
---|
869 |
|
---|
870 | RTDECL(int) RTVfsFileSetSize(RTVFSFILE hVfsFile, uint64_t cbSize);
|
---|
871 | RTDECL(int) RTVfsFileGetSize(RTVFSFILE hVfsFile, uint64_t *pcbSize);
|
---|
872 | RTDECL(RTFOFF) RTVfsFileGetMaxSize(RTVFSFILE hVfsFile);
|
---|
873 | RTDECL(int) RTVfsFileGetMaxSizeEx(RTVFSFILE hVfsFile, PRTFOFF pcbMax);
|
---|
874 |
|
---|
875 | /** @} */
|
---|
876 |
|
---|
877 |
|
---|
878 | /** @defgroup grp_vfs_misc VFS Miscellaneous
|
---|
879 | * @{
|
---|
880 | */
|
---|
881 |
|
---|
882 | /**
|
---|
883 | * Memorizes the I/O stream as a file backed by memory.
|
---|
884 | *
|
---|
885 | * @returns VBox status code.
|
---|
886 | *
|
---|
887 | * @param hVfsIos The VFS I/O stream to memorize. This will be read
|
---|
888 | * to the end on success, on failure its position is
|
---|
889 | * undefined.
|
---|
890 | * @param fFlags A combination of RTFILE_O_READ and RTFILE_O_WRITE.
|
---|
891 | * @param phVfsFile Where to return the handle to the memory file on
|
---|
892 | * success.
|
---|
893 | */
|
---|
894 | RTDECL(int) RTVfsMemorizeIoStreamAsFile(RTVFSIOSTREAM hVfsIos, uint32_t fFlags, PRTVFSFILE phVfsFile);
|
---|
895 |
|
---|
896 |
|
---|
897 | /**
|
---|
898 | * Pumps data from one I/O stream to another.
|
---|
899 | *
|
---|
900 | * The data is read in chunks from @a hVfsIosSrc and written to @a hVfsIosDst
|
---|
901 | * until @hVfsIosSrc indicates end of stream.
|
---|
902 | *
|
---|
903 | * @returns IPRT status code
|
---|
904 | *
|
---|
905 | * @param hVfsIosSrc The input stream.
|
---|
906 | * @param hVfsIosDst The output stream.
|
---|
907 | * @param cbBufHint Hints at a good temporary buffer size, pass 0 if
|
---|
908 | * clueless.
|
---|
909 | */
|
---|
910 | RTDECL(int) RTVfsUtilPumpIoStreams(RTVFSIOSTREAM hVfsIosSrc, RTVFSIOSTREAM hVfsIosDst, size_t cbBufHint);
|
---|
911 |
|
---|
912 | /** @} */
|
---|
913 |
|
---|
914 |
|
---|
915 | /** @defgroup grp_rt_vfs_chain VFS Chains
|
---|
916 | *
|
---|
917 | * VFS chains is for doing pipe like things with VFS objects from the command
|
---|
918 | * line. Imagine you want to cat the readme.gz of an ISO you could do
|
---|
919 | * something like:
|
---|
920 | * RTCat :iprtvfs:vfs(isofs,./mycd.iso)|ios(open,readme.gz)|ios(gunzip)
|
---|
921 | * or
|
---|
922 | * RTCat :iprtvfs:ios(isofs,./mycd.iso,/readme.gz)|ios(gunzip)
|
---|
923 | *
|
---|
924 | * The "isofs", "open" and "gunzip" bits in the above examples are chain
|
---|
925 | * element providers registered with IPRT. See RTVFSCHAINELEMENTREG for how
|
---|
926 | * these works.
|
---|
927 | *
|
---|
928 | * @{ */
|
---|
929 |
|
---|
930 | /** The path prefix used to identify an VFS chain specification. */
|
---|
931 | #define RTVFSCHAIN_SPEC_PREFIX ":iprtvfs:"
|
---|
932 |
|
---|
933 | RTDECL(int) RTVfsChainOpenVfs( const char *pszSpec, PRTVFS phVfs, const char **ppszError);
|
---|
934 | RTDECL(int) RTVfsChainOpenFsStream( const char *pszSpec, PRTVFSFSSTREAM phVfsFss, const char **ppszError);
|
---|
935 | RTDECL(int) RTVfsChainOpenDir( const char *pszSpec, uint64_t fOpen, PRTVFSDIR phVfsDir, const char **ppszError);
|
---|
936 | RTDECL(int) RTVfsChainOpenFile( const char *pszSpec, uint64_t fOpen, PRTVFSFILE phVfsFile, const char **ppszError);
|
---|
937 | RTDECL(int) RTVfsChainOpenSymlink( const char *pszSpec, PRTVFSSYMLINK phVfsSym, const char **ppszError);
|
---|
938 | RTDECL(int) RTVfsChainOpenIoStream( const char *pszSpec, uint64_t fOpen, PRTVFSIOSTREAM phVfsIos, const char **ppszError);
|
---|
939 |
|
---|
940 | /**
|
---|
941 | * Tests if the given string is a chain specification or not.
|
---|
942 | *
|
---|
943 | * @returns true if it is, false if it isn't.
|
---|
944 | * @param pszSpec The alleged chain spec.
|
---|
945 | */
|
---|
946 | RTDECL(bool) RTVfsChainIsSpec(const char *pszSpec);
|
---|
947 |
|
---|
948 | /** @} */
|
---|
949 |
|
---|
950 |
|
---|
951 | /** @} */
|
---|
952 |
|
---|
953 | RT_C_DECLS_END
|
---|
954 |
|
---|
955 | #endif /* !___iprt_vfs_h */
|
---|
956 |
|
---|