fs.h@ 45809

Last change on this file since 45809 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: 20.6 KB

Line
1	/** @file
2	* IPRT - Filesystem.
3	*/
4
5	/*
6	* Copyright (C) 2006-2013 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_fs_h
27	#define ___iprt_fs_h
28
29	#include <iprt/cdefs.h>
30	#include <iprt/types.h>
31	#include <iprt/time.h>
32
33
34	RT_C_DECLS_BEGIN
35
36	/** @defgroup grp_rt_fs RTFs - Filesystem and Volume
37	* @ingroup grp_rt
38	* @{
39	*/
40
41
42	/** @name Filesystem Object Mode Flags.
43	*
44	* There are two sets of flags: the unix mode flags and the dos attributes.
45	*
46	* APIs returning mode flags will provide both sets.
47	*
48	* When specifying mode flags to any API at least one of them must be given. If
49	* one set is missing the API will synthesize it from the one given if it
50	* requires it.
51	*
52	* Both sets match their x86 ABIs, the DOS/NT one is simply shifted up 16 bits.
53	* The DOS/NT range is bits 16 to 31 inclusively. The Unix range is bits 0 to 15
54	* (inclusively).
55	*
56	* @remarks These constants have been comitted to a binary format and must not
57	* be changed in any incompatible ways.
58	*
59	* @{
60	*/
61
62	/** Set user id on execution (S_ISUID). */
63	#define RTFS_UNIX_ISUID 0004000U
64	/** Set group id on execution (S_ISGID). */
65	#define RTFS_UNIX_ISGID 0002000U
66	/** Sticky bit (S_ISVTX / S_ISTXT). */
67	#define RTFS_UNIX_ISTXT 0001000U
68
69	/** Owner RWX mask (S_IRWXU). */
70	#define RTFS_UNIX_IRWXU 0000700U
71	/** Owner readable (S_IRUSR). */
72	#define RTFS_UNIX_IRUSR 0000400U
73	/** Owner writable (S_IWUSR). */
74	#define RTFS_UNIX_IWUSR 0000200U
75	/** Owner executable (S_IXUSR). */
76	#define RTFS_UNIX_IXUSR 0000100U
77
78	/** Group RWX mask (S_IRWXG). */
79	#define RTFS_UNIX_IRWXG 0000070U
80	/** Group readable (S_IRGRP). */
81	#define RTFS_UNIX_IRGRP 0000040U
82	/** Group writable (S_IWGRP). */
83	#define RTFS_UNIX_IWGRP 0000020U
84	/** Group executable (S_IXGRP). */
85	#define RTFS_UNIX_IXGRP 0000010U
86
87	/** Other RWX mask (S_IRWXO). */
88	#define RTFS_UNIX_IRWXO 0000007U
89	/** Other readable (S_IROTH). */
90	#define RTFS_UNIX_IROTH 0000004U
91	/** Other writable (S_IWOTH). */
92	#define RTFS_UNIX_IWOTH 0000002U
93	/** Other executable (S_IXOTH). */
94	#define RTFS_UNIX_IXOTH 0000001U
95
96	/** All UNIX access permission bits (0777). */
97	#define RTFS_UNIX_ALL_ACCESS_PERMS 0000777U
98	/** All UNIX permission bits, including set id and sticky bits. */
99	#define RTFS_UNIX_ALL_PERMS 0007777U
100
101	/** Named pipe (fifo) (S_IFIFO). */
102	#define RTFS_TYPE_FIFO 0010000U
103	/** Character device (S_IFCHR). */
104	#define RTFS_TYPE_DEV_CHAR 0020000U
105	/** Directory (S_IFDIR). */
106	#define RTFS_TYPE_DIRECTORY 0040000U
107	/** Block device (S_IFBLK). */
108	#define RTFS_TYPE_DEV_BLOCK 0060000U
109	/** Regular file (S_IFREG). */
110	#define RTFS_TYPE_FILE 0100000U
111	/** Symbolic link (S_IFLNK). */
112	#define RTFS_TYPE_SYMLINK 0120000U
113	/** Socket (S_IFSOCK). */
114	#define RTFS_TYPE_SOCKET 0140000U
115	/** Whiteout (S_IFWHT). */
116	#define RTFS_TYPE_WHITEOUT 0160000U
117	/** Type mask (S_IFMT). */
118	#define RTFS_TYPE_MASK 0170000U
119
120	/** Unix attribute mask. */
121	#define RTFS_UNIX_MASK 0xffffU
122	/** The mask of all the NT, OS/2 and DOS attributes. */
123	#define RTFS_DOS_MASK (0x7fffU << RTFS_DOS_SHIFT)
124
125	/** The shift value. */
126	#define RTFS_DOS_SHIFT 16
127	/** The mask of the OS/2 and DOS attributes. */
128	#define RTFS_DOS_MASK_OS2 (0x003fU << RTFS_DOS_SHIFT)
129	/** The mask of the NT attributes. */
130	#define RTFS_DOS_MASK_NT (0x7fffU << RTFS_DOS_SHIFT)
131
132	/** Readonly object. */
133	#define RTFS_DOS_READONLY (0x0001U << RTFS_DOS_SHIFT)
134	/** Hidden object. */
135	#define RTFS_DOS_HIDDEN (0x0002U << RTFS_DOS_SHIFT)
136	/** System object. */
137	#define RTFS_DOS_SYSTEM (0x0004U << RTFS_DOS_SHIFT)
138	/** Directory. */
139	#define RTFS_DOS_DIRECTORY (0x0010U << RTFS_DOS_SHIFT)
140	/** Archived object.
141	* This bit is set by the filesystem after each modification of a file. */
142	#define RTFS_DOS_ARCHIVED (0x0020U << RTFS_DOS_SHIFT)
143	/** Undocumented / Reserved, used to be the FAT volume label. */
144	#define RTFS_DOS_NT_DEVICE (0x0040U << RTFS_DOS_SHIFT)
145	/** Normal object, no other attribute set (NT). */
146	#define RTFS_DOS_NT_NORMAL (0x0080U << RTFS_DOS_SHIFT)
147	/** Temporary object (NT). */
148	#define RTFS_DOS_NT_TEMPORARY (0x0100U << RTFS_DOS_SHIFT)
149	/** Sparse file (NT). */
150	#define RTFS_DOS_NT_SPARSE_FILE (0x0200U << RTFS_DOS_SHIFT)
151	/** Reparse point (NT). */
152	#define RTFS_DOS_NT_REPARSE_POINT (0x0400U << RTFS_DOS_SHIFT)
153	/** Compressed object (NT).
154	* For a directory, compression is the default for new files. */
155	#define RTFS_DOS_NT_COMPRESSED (0x0800U << RTFS_DOS_SHIFT)
156	/** Physically offline data (NT).
157	* MSDN say, don't mess with this one. */
158	#define RTFS_DOS_NT_OFFLINE (0x1000U << RTFS_DOS_SHIFT)
159	/** Not content indexed by the content indexing service (NT). */
160	#define RTFS_DOS_NT_NOT_CONTENT_INDEXED (0x2000U << RTFS_DOS_SHIFT)
161	/** Encryped object (NT).
162	* For a directory, encrypted is the default for new files. */
163	#define RTFS_DOS_NT_ENCRYPTED (0x4000U << RTFS_DOS_SHIFT)
164
165	/** @} */
166
167
168	/** @name Filesystem Object Type Predicates.
169	* @{ */
170	/** Checks the mode flags indicate a named pipe (fifo) (S_ISFIFO). */
171	#define RTFS_IS_FIFO(fMode) ( ((fMode) & RTFS_TYPE_MASK) == RTFS_TYPE_FIFO )
172	/** Checks the mode flags indicate a character device (S_ISCHR). */
173	#define RTFS_IS_DEV_CHAR(fMode) ( ((fMode) & RTFS_TYPE_MASK) == RTFS_TYPE_DEV_CHAR )
174	/** Checks the mode flags indicate a directory (S_ISDIR). */
175	#define RTFS_IS_DIRECTORY(fMode) ( ((fMode) & RTFS_TYPE_MASK) == RTFS_TYPE_DIRECTORY )
176	/** Checks the mode flags indicate a block device (S_ISBLK). */
177	#define RTFS_IS_DEV_BLOCK(fMode) ( ((fMode) & RTFS_TYPE_MASK) == RTFS_TYPE_DEV_BLOCK )
178	/** Checks the mode flags indicate a regular file (S_ISREG). */
179	#define RTFS_IS_FILE(fMode) ( ((fMode) & RTFS_TYPE_MASK) == RTFS_TYPE_FILE )
180	/** Checks the mode flags indicate a symbolic link (S_ISLNK). */
181	#define RTFS_IS_SYMLINK(fMode) ( ((fMode) & RTFS_TYPE_MASK) == RTFS_TYPE_SYMLINK )
182	/** Checks the mode flags indicate a socket (S_ISSOCK). */
183	#define RTFS_IS_SOCKET(fMode) ( ((fMode) & RTFS_TYPE_MASK) == RTFS_TYPE_SOCKET )
184	/** Checks the mode flags indicate a whiteout (S_ISWHT). */
185	#define RTFS_IS_WHITEOUT(fMode) ( ((fMode) & RTFS_TYPE_MASK) == RTFS_TYPE_WHITEOUT )
186	/** @} */
187
188
189	/**
190	* Filesystem type IDs returned by RTFsQueryType.
191	*
192	* This enum is subject to changes and must not be used as part of any ABI or
193	* binary format (file, network, etc).
194	*
195	* @remarks When adding new entries, please update RTFsTypeName(). Also, try
196	* add them to the most natural group.
197	*/
198	typedef enum RTFSTYPE
199	{
200	/** Unknown file system. */
201	RTFSTYPE_UNKNOWN = 0,
202
203	/** Universal Disk Format. */
204	RTFSTYPE_UDF,
205	/** ISO 9660, aka Compact Disc File System (CDFS). */
206	RTFSTYPE_ISO9660,
207	/** Filesystem in Userspace. */
208	RTFSTYPE_FUSE,
209	/** VirtualBox shared folders. */
210	RTFSTYPE_VBOXSHF,
211
212	/* Linux: */
213	RTFSTYPE_EXT,
214	RTFSTYPE_EXT2,
215	RTFSTYPE_EXT3,
216	RTFSTYPE_EXT4,
217	RTFSTYPE_XFS,
218	RTFSTYPE_CIFS,
219	RTFSTYPE_SMBFS,
220	RTFSTYPE_TMPFS,
221	RTFSTYPE_SYSFS,
222	RTFSTYPE_PROC,
223	RTFSTYPE_OCFS2,
224
225	/* Windows: */
226	/** New Technology File System. */
227	RTFSTYPE_NTFS,
228	/** FAT12, FAT16 and FAT32 lumped into one basket.
229	* The partition size limit of FAT12 and FAT16 will be the factor
230	* limiting the file size (except, perhaps for the 64KB cluster case on
231	* non-Windows hosts). */
232	RTFSTYPE_FAT,
233
234	/* Solaris: */
235	/** Zettabyte File System. */
236	RTFSTYPE_ZFS,
237	/** Unix File System. */
238	RTFSTYPE_UFS,
239	/** Network File System. */
240	RTFSTYPE_NFS,
241
242	/* Mac OS X: */
243	/** Hierarchical File System. */
244	RTFSTYPE_HFS,
245	/** @todo RTFSTYPE_HFS_PLUS? */
246	RTFSTYPE_AUTOFS,
247	RTFSTYPE_DEVFS,
248
249	/* BSD: /
250
251	/* OS/2: */
252	/** High Performance File System. */
253	RTFSTYPE_HPFS,
254	/** Journaled File System (v2). */
255	RTFSTYPE_JFS,
256
257	/** The end of valid Filesystem types IDs. */
258	RTFSTYPE_END,
259	/** The usual 32-bit type blow up. */
260	RTFSTYPE_32BIT_HACK = 0x7fffffff
261	} RTFSTYPE;
262	/** Pointer to a Filesystem type ID. */
263	typedef RTFSTYPE *PRTFSTYPE;
264
265
266	/**
267	* The available additional information in a RTFSOBJATTR object.
268	*/
269	typedef enum RTFSOBJATTRADD
270	{
271	/** No additional information is available / requested. */
272	RTFSOBJATTRADD_NOTHING = 1,
273	/** The additional unix attributes (RTFSOBJATTR::u::Unix) are available /
274	* requested. */
275	RTFSOBJATTRADD_UNIX,
276	/** The additional unix attributes (RTFSOBJATTR::u::UnixOwner) are
277	* available / requested. */
278	RTFSOBJATTRADD_UNIX_OWNER,
279	/** The additional unix attributes (RTFSOBJATTR::u::UnixGroup) are
280	* available / requested. */
281	RTFSOBJATTRADD_UNIX_GROUP,
282	/** The additional extended attribute size (RTFSOBJATTR::u::EASize) is available / requested. */
283	RTFSOBJATTRADD_EASIZE,
284	/** The last valid item (inclusive).
285	* The valid range is RTFSOBJATTRADD_NOTHING thru RTFSOBJATTRADD_LAST. */
286	RTFSOBJATTRADD_LAST = RTFSOBJATTRADD_EASIZE,
287
288	/** The usual 32-bit hack. */
289	RTFSOBJATTRADD_32BIT_SIZE_HACK = 0x7fffffff
290	} RTFSOBJATTRADD;
291
292	/** The number of bytes reserved for the additional attribute union. */
293	#define RTFSOBJATTRUNION_MAX_SIZE 128
294
295	/**
296	* Additional Unix Attributes (RTFSOBJATTRADD_UNIX).
297	*/
298	typedef struct RTFSOBJATTRUNIX
299	{
300	/** The user owning the filesystem object (st_uid).
301	* This field is NIL_UID if not supported. */
302	RTUID uid;
303
304	/** The group the filesystem object is assigned (st_gid).
305	* This field is NIL_GID if not supported. */
306	RTGID gid;
307
308	/** Number of hard links to this filesystem object (st_nlink).
309	* This field is 1 if the filesystem doesn't support hardlinking or
310	* the information isn't available.
311	*/
312	uint32_t cHardlinks;
313
314	/** The device number of the device which this filesystem object resides on (st_dev).
315	* This field is 0 if this information is not available. */
316	RTDEV INodeIdDevice;
317
318	/** The unique identifier (within the filesystem) of this filesystem object (st_ino).
319	* Together with INodeIdDevice, this field can be used as a OS wide unique id
320	* when both their values are not 0.
321	* This field is 0 if the information is not available. */
322	RTINODE INodeId;
323
324	/** User flags (st_flags).
325	* This field is 0 if this information is not available. */
326	uint32_t fFlags;
327
328	/** The current generation number (st_gen).
329	* This field is 0 if this information is not available. */
330	uint32_t GenerationId;
331
332	/** The device number of a character or block device type object (st_rdev).
333	* This field is 0 if the file isn't of a character or block device type and
334	* when the OS doesn't subscribe to the major+minor device idenfication scheme. */
335	RTDEV Device;
336	} RTFSOBJATTRUNIX;
337
338
339	/**
340	* Additional Unix Attributes (RTFSOBJATTRADD_UNIX_OWNER).
341	*
342	* @remarks This interface is mainly for TAR.
343	*/
344	typedef struct RTFSOBJATTRUNIXOWNER
345	{
346	/** The user owning the filesystem object (st_uid).
347	* This field is NIL_UID if not supported. */
348	RTUID uid;
349	/** The user name.
350	* Empty if not available or not supported, truncated if too long. */
351	char szName[RTFSOBJATTRUNION_MAX_SIZE - sizeof(RTUID)];
352	} RTFSOBJATTRUNIXOWNER;
353
354
355	/**
356	* Additional Unix Attributes (RTFSOBJATTRADD_UNIX_GROUP).
357	*
358	* @remarks This interface is mainly for TAR.
359	*/
360	typedef struct RTFSOBJATTRUNIXGROUP
361	{
362	/** The user owning the filesystem object (st_uid).
363	* This field is NIL_GID if not supported. */
364	RTGID gid;
365	/** The group name.
366	* Empty if not available or not supported, truncated if too long. */
367	char szName[RTFSOBJATTRUNION_MAX_SIZE - sizeof(RTGID)];
368	} RTFSOBJATTRUNIXGROUP;
369
370
371	/**
372	* Filesystem object attributes.
373	*/
374	typedef struct RTFSOBJATTR
375	{
376	/** Mode flags (st_mode). RTFS_UNIX_, RTFS_TYPE_, and RTFS_DOS_. /
377	RTFMODE fMode;
378
379	/** The additional attributes available. */
380	RTFSOBJATTRADD enmAdditional;
381
382	/**
383	* Additional attributes.
384	*
385	* Unless explicitly specified to an API, the API can provide additional
386	* data as it is provided by the underlying OS.
387	*/
388	union RTFSOBJATTRUNION
389	{
390	/** Additional Unix Attributes - RTFSOBJATTRADD_UNIX. */
391	RTFSOBJATTRUNIX Unix;
392	/** Additional Unix Owner Attributes - RTFSOBJATTRADD_UNIX_OWNER. */
393	RTFSOBJATTRUNIXOWNER UnixOwner;
394	/** Additional Unix Group Attributes - RTFSOBJATTRADD_UNIX_GROUP. */
395	RTFSOBJATTRUNIXGROUP UnixGroup;
396
397	/**
398	* Extended attribute size is available when RTFS_DOS_HAVE_EA_SIZE is set.
399	*/
400	struct RTFSOBJATTREASIZE
401	{
402	/** Size of EAs. */
403	RTFOFF cb;
404	} EASize;
405	/** Reserved space. */
406	uint8_t abReserveSpace[128];
407	} u;
408	} RTFSOBJATTR;
409	/** Pointer to a filesystem object attributes structure. */
410	typedef RTFSOBJATTR *PRTFSOBJATTR;
411	/** Pointer to a const filesystem object attributes structure. */
412	typedef const RTFSOBJATTR *PCRTFSOBJATTR;
413
414
415	/**
416	* Filesystem object information structure.
417	*
418	* This is returned by the RTPathQueryInfo(), RTFileQueryInfo() and RTDirRead() APIs.
419	*/
420	typedef struct RTFSOBJINFO
421	{
422	/** Logical size (st_size).
423	* For normal files this is the size of the file.
424	* For symbolic links, this is the length of the path name contained
425	* in the symbolic link.
426	* For other objects this fields needs to be specified.
427	*/
428	RTFOFF cbObject;
429
430	/** Disk allocation size (st_blocks * DEV_BSIZE). */
431	RTFOFF cbAllocated;
432
433	/** Time of last access (st_atime). */
434	RTTIMESPEC AccessTime;
435
436	/** Time of last data modification (st_mtime). */
437	RTTIMESPEC ModificationTime;
438
439	/** Time of last status change (st_ctime).
440	* If not available this is set to ModificationTime.
441	*/
442	RTTIMESPEC ChangeTime;
443
444	/** Time of file birth (st_birthtime).
445	* If not available this is set to ChangeTime.
446	*/
447	RTTIMESPEC BirthTime;
448
449	/** Attributes. */
450	RTFSOBJATTR Attr;
451
452	} RTFSOBJINFO;
453	/** Pointer to a filesystem object information structure. */
454	typedef RTFSOBJINFO *PRTFSOBJINFO;
455	/** Pointer to a const filesystem object information structure. */
456	typedef const RTFSOBJINFO *PCRTFSOBJINFO;
457
458
459	#ifdef IN_RING3
460
461	/**
462	* Query the sizes of a filesystem.
463	*
464	* @returns iprt status code.
465	* @param pszFsPath Path within the mounted filesystem.
466	* @param pcbTotal Where to store the total filesystem space. (Optional)
467	* @param pcbFree Where to store the remaining free space in the filesystem. (Optional)
468	* @param pcbBlock Where to store the block size. (Optional)
469	* @param pcbSector Where to store the sector size. (Optional)
470	*
471	* @sa RTFileQueryFsSizes
472	*/
473	RTR3DECL(int) RTFsQuerySizes(const char pszFsPath, PRTFOFF pcbTotal, RTFOFF pcbFree,
474	uint32_t pcbBlock, uint32_t pcbSector);
475
476	/**
477	* Query the mountpoint of a filesystem.
478	*
479	* @returns iprt status code.
480	* @returns VERR_BUFFER_OVERFLOW if cbMountpoint isn't enough.
481	* @param pszFsPath Path within the mounted filesystem.
482	* @param pszMountpoint Where to store the mountpoint path.
483	* @param cbMountpoint Size of the buffer pointed to by pszMountpoint.
484	*/
485	RTR3DECL(int) RTFsQueryMountpoint(const char pszFsPath, char pszMountpoint, size_t cbMountpoint);
486
487	/**
488	* Query the label of a filesystem.
489	*
490	* @returns iprt status code.
491	* @returns VERR_BUFFER_OVERFLOW if cbLabel isn't enough.
492	* @param pszFsPath Path within the mounted filesystem.
493	* @param pszLabel Where to store the label.
494	* @param cbLabel Size of the buffer pointed to by pszLabel.
495	*/
496	RTR3DECL(int) RTFsQueryLabel(const char pszFsPath, char pszLabel, size_t cbLabel);
497
498	/**
499	* Query the serial number of a filesystem.
500	*
501	* @returns iprt status code.
502	* @param pszFsPath Path within the mounted filesystem.
503	* @param pu32Serial Where to store the serial number.
504	*/
505	RTR3DECL(int) RTFsQuerySerial(const char pszFsPath, uint32_t pu32Serial);
506
507	/**
508	* Query the name of the filesystem driver.
509	*
510	* @returns iprt status code.
511	* @returns VERR_BUFFER_OVERFLOW if cbFsDriver isn't enough.
512	* @param pszFsPath Path within the mounted filesystem.
513	* @param pszFsDriver Where to store the filesystem driver name.
514	* @param cbFsDriver Size of the buffer pointed to by pszFsDriver.
515	*/
516	RTR3DECL(int) RTFsQueryDriver(const char pszFsPath, char pszFsDriver, size_t cbFsDriver);
517
518	/**
519	* Query the name of the filesystem the file is located on.
520	*
521	* @returns iprt status code.
522	* @param pszFsPath Path within the mounted filesystem. It must exist.
523	* In case this is a symlink, the file it refers to is
524	* evaluated.
525	* @param penmType Where to store the filesystem type, this is always
526	* set. See RTFSTYPE for the values.
527	*/
528	RTR3DECL(int) RTFsQueryType(const char *pszFsPath, PRTFSTYPE penmType);
529
530	#endif /* IN_RING3 */
531
532	/**
533	* Gets the name of a filesystem type.
534	*
535	* @returns Pointer to a read-only string containing the name.
536	* @param enmType A valid filesystem ID. If outside the valid range,
537	* the returned string will be pointing to a static
538	* memory buffer which will be changed on subsequent
539	* calls to this function by any thread.
540	*/
541	RTDECL(const char *) RTFsTypeName(RTFSTYPE enmType);
542
543	/**
544	* Filesystem properties.
545	*/
546	typedef struct RTFSPROPERTIES
547	{
548	/** The maximum size of a filesystem object name.
549	* This does not include the '\\0'. */
550	uint32_t cbMaxComponent;
551
552	/** True if the filesystem is remote.
553	* False if the filesystem is local. */
554	bool fRemote;
555
556	/** True if the filesystem is case sensitive.
557	* False if the filesystem is case insensitive. */
558	bool fCaseSensitive;
559
560	/** True if the filesystem is mounted read only.
561	* False if the filesystem is mounted read write. */
562	bool fReadOnly;
563
564	/** True if the filesystem can encode unicode object names.
565	* False if it can't. */
566	bool fSupportsUnicode;
567
568	/** True if the filesystem is compresses.
569	* False if it isn't or we don't know. */
570	bool fCompressed;
571
572	/** True if the filesystem compresses of individual files.
573	* False if it doesn't or we don't know. */
574	bool fFileCompression;
575
576	/** @todo more? */
577	} RTFSPROPERTIES;
578	/** Pointer to a filesystem properties structure. */
579	typedef RTFSPROPERTIES *PRTFSPROPERTIES;
580	/** Pointer to a const filesystem properties structure. */
581	typedef RTFSPROPERTIES const *PCRTFSPROPERTIES;
582
583	#ifdef IN_RING3
584
585	/**
586	* Query the properties of a mounted filesystem.
587	*
588	* @returns iprt status code.
589	* @param pszFsPath Path within the mounted filesystem.
590	* @param pProperties Where to store the properties.
591	*/
592	RTR3DECL(int) RTFsQueryProperties(const char *pszFsPath, PRTFSPROPERTIES pProperties);
593
594
595	/**
596	* Mountpoint enumerator callback.
597	*
598	* @returns iprt status code. Failure terminates the enumeration.
599	* @param pszMountpoint The mountpoint name.
600	* @param pvUser The user argument.
601	*/
602	typedef DECLCALLBACK(int) FNRTFSMOUNTPOINTENUM(const char pszMountpoint, void pvUser);
603	/** Pointer to a FNRTFSMOUNTPOINTENUM(). */
604	typedef FNRTFSMOUNTPOINTENUM *PFNRTFSMOUNTPOINTENUM;
605
606	/**
607	* Enumerate mount points.
608	*
609	* @returns iprt status code.
610	* @param pfnCallback The callback function.
611	* @param pvUser The user argument to the callback.
612	*/
613	RTR3DECL(int) RTFsMountpointsEnum(PFNRTFSMOUNTPOINTENUM pfnCallback, void *pvUser);
614
615
616	#endif /* IN_RING3 */
617
618	/** @} */
619
620	RT_C_DECLS_END
621
622	#endif /* !___iprt_fs_h */
623

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

source: vbox/trunk/include/iprt/fs.h@ 45809

Download in other formats: