VirtualBox

source: vbox/trunk/include/iprt/fsvfs.h@ 71293

Last change on this file since 71293 was 69853, checked in by vboxsync, 7 years ago

nits

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 7.0 KB
Line 
1/** @file
2 * IPRT - Filesystem, VFS implementations.
3 */
4
5/*
6 * Copyright (C) 2006-2017 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_fsvfs_h
27#define ___iprt_fsvfs_h
28
29#include <iprt/cdefs.h>
30#include <iprt/types.h>
31
32
33RT_C_DECLS_BEGIN
34
35/** @defgroup grp_rt_fs_vfs VFS File System Implementations
36 * @ingroup grp_rt_fs
37 * @{
38 */
39
40/**
41 * Opens a FAT file system volume.
42 *
43 * @returns IPRT status code.
44 * @param hVfsFileIn The file or device backing the volume.
45 * @param fReadOnly Whether to mount it read-only.
46 * @param offBootSector The offset of the boot sector relative to the start
47 * of @a hVfsFileIn. Pass 0 for floppies.
48 * @param phVfs Where to return the virtual file system handle.
49 * @param pErrInfo Where to return additional error information.
50 */
51RTDECL(int) RTFsFatVolOpen(RTVFSFILE hVfsFileIn, bool fReadOnly, uint64_t offBootSector, PRTVFS phVfs, PRTERRINFO pErrInfo);
52
53
54/**
55 * FAT type (format).
56 */
57typedef enum RTFSFATTYPE
58{
59 RTFSFATTYPE_INVALID = 0,
60 RTFSFATTYPE_FAT12,
61 RTFSFATTYPE_FAT16,
62 RTFSFATTYPE_FAT32,
63 RTFSFATTYPE_END
64} RTFSFATTYPE;
65
66
67/** @name RTFSFATVOL_FMT_F_XXX - RTFsFatVolFormat flags
68 * @{ */
69/** Perform a full format, filling unused sectors with 0xf6. */
70#define RTFSFATVOL_FMT_F_FULL UINT32_C(0)
71/** Perform a quick format.
72 * I.e. just write the boot sector, FATs and root directory. */
73#define RTFSFATVOL_FMT_F_QUICK RT_BIT_32(0)
74/** Mask containing all valid flags. */
75#define RTFSFATVOL_FMT_F_VALID_MASK UINT32_C(0x00000001)
76/** @} */
77
78/**
79 * Formats a FAT volume.
80 *
81 * @returns IRPT status code.
82 * @param hVfsFile The volume file.
83 * @param offVol The offset into @a hVfsFile of the file.
84 * Typically 0.
85 * @param cbVol The size of the volume. Pass 0 if the rest of
86 * hVfsFile should be used.
87 * @param fFlags See RTFSFATVOL_FMT_F_XXX.
88 * @param cbSector The logical sector size. Must be power of two.
89 * Optional, pass zero to use 512.
90 * @param cSectorsPerCluster Number of sectors per cluster. Power of two.
91 * Optional, pass zero to auto detect.
92 * @param enmFatType The FAT type (12, 16, 32) to use.
93 * Optional, pass RTFSFATTYPE_INVALID for default.
94 * @param cHeads The number of heads to report in the BPB.
95 * Optional, pass zero to auto detect.
96 * @param cSectorsPerTrack The number of sectors per track to put in the
97 * BPB. Optional, pass zero to auto detect.
98 * @param bMedia The media byte value and FAT ID to use.
99 * Optional, pass zero to auto detect.
100 * @param cRootDirEntries Number of root directory entries.
101 * Optional, pass zero to auto detect.
102 * @param cHiddenSectors Number of hidden sectors. Pass 0 for
103 * unpartitioned media.
104 * @param pErrInfo Additional error information, maybe. Optional.
105 */
106RTDECL(int) RTFsFatVolFormat(RTVFSFILE hVfsFile, uint64_t offVol, uint64_t cbVol, uint32_t fFlags, uint16_t cbSector,
107 uint16_t cSectorsPerCluster, RTFSFATTYPE enmFatType, uint32_t cHeads, uint32_t cSectorsPerTrack,
108 uint8_t bMedia, uint16_t cRootDirEntries, uint32_t cHiddenSectors, PRTERRINFO pErrInfo);
109
110/**
111 * Formats a 1.44MB floppy image.
112 *
113 * @returns IPRT status code.
114 * @param hVfsFile The image. Will be grown to 1.44MB if
115 * necessary.
116 * @param fQuick Whether to quick format the floppy or not.
117 */
118RTDECL(int) RTFsFatVolFormat144(RTVFSFILE hVfsFile, bool fQuick);
119
120
121
122/**
123 * Opens an EXT2 file system volume.
124 *
125 * @returns IPRT status code.
126 * @param hVfsFileIn The file or device backing the volume.
127 * @param fMntFlags RTVFSMNT_F_XXX.
128 * @param fExt2Flags Reserved, MBZ.
129 * @param phVfs Where to return the virtual file system handle.
130 * @param pErrInfo Where to return additional error information.
131 */
132RTDECL(int) RTFsExt2VolOpen(RTVFSFILE hVfsFileIn, uint32_t fMntFlags, uint32_t fExt2Flags, PRTVFS phVfs, PRTERRINFO pErrInfo);
133
134
135
136/** @name RTFSISO9660_F_XXX - ISO 9660 mount flags.
137 * @{ */
138/** Do not use the UDF part if present. */
139#define RTFSISO9660_F_NO_UDF RT_BIT_32(0)
140/** Do not use the joliet part. */
141#define RTFSISO9660_F_NO_JOLIET RT_BIT_32(1)
142/** Do not use the rock ridge extensions if present. */
143#define RTFSISO9660_F_NO_ROCK RT_BIT_32(2)
144/** Valid ISO 9660 mount option mask. */
145#define RTFSISO9660_F_VALID_MASK UINT32_C(0x00000007)
146/** Checks if @a a_fNoType is the only acceptable volume type. */
147#define RTFSISO9660_F_IS_ONLY_TYPE(a_fFlags, a_fNoType) \
148 ( ((a_fFlags) & (RTFSISO9660_F_NO_UDF | RTFSISO9660_F_NO_JOLIET | RTFSISO9660_F_NO_ROCK)) \
149 == (~(a_fNoType) & (RTFSISO9660_F_NO_UDF | RTFSISO9660_F_NO_JOLIET | RTFSISO9660_F_NO_ROCK)) )
150/** @} */
151
152/**
153 * Opens an ISO 9660 file system volume.
154 *
155 * @returns IPRT status code.
156 * @param hVfsFileIn The file or device backing the volume.
157 * @param fFlags RTFSISO9660_F_XXX.
158 * @param phVfs Where to return the virtual file system handle.
159 * @param pErrInfo Where to return additional error information.
160 */
161RTDECL(int) RTFsIso9660VolOpen(RTVFSFILE hVfsFileIn, uint32_t fFlags, PRTVFS phVfs, PRTERRINFO pErrInfo);
162
163
164/**
165 * Opens an NTFS file system volume.
166 *
167 * @returns IPRT status code.
168 * @param hVfsFileIn The file or device backing the volume.
169 * @param fMntFlags RTVFSMNT_F_XXX.
170 * @param fNtfsFlags Reserved, MBZ.
171 * @param phVfs Where to return the virtual file system handle.
172 * @param pErrInfo Where to return additional error information.
173 */
174RTDECL(int) RTFsNtfsVolOpen(RTVFSFILE hVfsFileIn, uint32_t fMntFlags, uint32_t fNtfsFlags, PRTVFS phVfs, PRTERRINFO pErrInfo);
175
176
177/** @} */
178
179RT_C_DECLS_END
180
181#endif
182
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette