2 * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
\r
3 * All rights reserved.
\r
5 * Redistribution and use in source and binary forms, with or without
\r
6 * modification, are permitted provided that the following conditions
\r
9 * - Redistributions of source code must retain the above copyright
\r
10 * notice, this list of conditions and the following disclaimer.
\r
11 * - Redistributions in binary form must reproduce the above copyright
\r
12 * notice, this list of conditions and the following disclaimer in the
\r
13 * documentation and/or other materials provided with the distribution.
\r
14 * - The name of the author may not be used to endorse or promote products
\r
15 * derived from this software without specific prior written permission.
\r
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
\r
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
\r
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
\r
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
\r
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
\r
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
\r
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
\r
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
\r
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
\r
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\r
29 /** @addtogroup lwext4
\r
34 * @brief Ext4 high level operations (files, directories, mount points...).
\r
35 * Client has to include only this file.
\r
41 #include <ext4_config.h>
\r
42 #include <ext4_blockdev.h>
\r
45 /********************************FILE OPEN FLAGS*****************************/
\r
60 #define O_CREAT 0100
\r
68 #define O_TRUNC 01000
\r
72 #define O_APPEND 02000
\r
75 /********************************FILE SEEK FLAGS*****************************/
\r
89 /********************************OS LOCK INFERFACE***************************/
\r
91 /**@brief OS dependent lock interface.*/
\r
94 /**@brief Lock access to mount point*/
\r
97 /**@brief Unlock access to mount point*/
\r
98 void (*unlock)(void);
\r
102 /********************************FILE DESCRIPTOR*****************************/
\r
104 /**@brief File descriptor*/
\r
105 typedef struct ext4_file {
\r
107 /**@brief Mount point handle.*/
\r
108 struct ext4_mountpoint *mp;
\r
110 /**@brief File inode id*/
\r
113 /**@brief Open flags.*/
\r
116 /**@brief File size.*/
\r
119 /**@brief File position*/
\r
123 /*****************************DIRECTORY DESCRIPTOR***************************/
\r
124 /**@brief Directory entry types. Copy from ext4_types.h*/
\r
126 EXT4_DIRENTRY_UNKNOWN = 0,
\r
127 EXT4_DIRENTRY_REG_FILE,
\r
129 EXT4_DIRENTRY_CHRDEV,
\r
130 EXT4_DIRENTRY_BLKDEV,
\r
131 EXT4_DIRENTRY_FIFO,
\r
132 EXT4_DIRENTRY_SOCK,
\r
133 EXT4_DIRENTRY_SYMLINK
\r
136 /**@brief Directory entry descriptor. Copy from ext4_types.h*/
\r
139 uint16_t entry_length;
\r
140 uint8_t name_length;
\r
142 uint8_t name_length_high;
\r
143 uint8_t inode_type;
\r
149 /**@brief File descriptor*/
\r
151 /**@brief Current directory entry.*/
\r
155 /********************************MOUNT OPERATIONS****************************/
\r
157 /**@brief Register a block device to a name.
\r
158 * @warning Block device has to be filled by
\r
159 * @ref EXT4_BLOCKDEV_STATIC_INSTANCE. Block cache may be created
\r
160 * @ref EXT4_BCACHE_STATIC_INSTANCE.
\r
161 * Block cache may by created automatically when bc parameter is 0.
\r
162 * @param bd block device
\r
163 * @param bd block device cache (0 = automatic cache mode)
\r
164 * @param dev_name register name
\r
165 * @param standard error code*/
\r
166 int ext4_device_register(struct ext4_blockdev *bd, struct ext4_bcache *bc,
\r
167 const char *dev_name);
\r
169 /**@brief Mount a block device with EXT4 partition to the mount point.
\r
170 * @param dev_name block device name (@ref ext4_device_register)
\r
171 * @param mount_point mount point, for example
\r
174 * - /my_second_partition/
\r
176 * @return standard error code */
\r
177 int ext4_mount(const char * dev_name, char *mount_point);
\r
179 /**@brief Umount operation.
\r
180 * @param mount_point mount name
\r
181 * @return standard error code */
\r
182 int ext4_umount(char *mount_point);
\r
185 /**@brief Some of the filesystem stats.*/
\r
186 struct ext4_mount_stats {
\r
187 uint32_t inodes_count;
\r
188 uint32_t free_inodes_count;
\r
189 uint64_t blocks_count;
\r
190 uint64_t free_blocks_count;
\r
192 uint32_t block_size;
\r
193 uint32_t block_group_count;
\r
194 uint32_t blocks_per_group;
\r
195 uint32_t inodes_per_group;
\r
197 char volume_name[16];
\r
200 /**@brief Get file system params.
\r
201 * @param mount_point mount path
\r
202 * @param stats ext fs stats
\r
203 * @return standard error code */
\r
204 int ext4_mount_point_stats(const char *mount_point,
\r
205 struct ext4_mount_stats *stats);
\r
208 /**@brief Enable/disable write back cache mode.
\r
209 * @warning Default model of cache is write trough. It means that when You do:
\r
213 * < --- data is flushed to physical drive
\r
216 * ext4_cache_write_back(..., 1);
\r
219 * < --- data is NOT flushed to physical drive
\r
220 * ext4_cache_write_back(..., 0);
\r
221 * < --- when write back mode is disabled all
\r
222 * cache data will be flushed
\r
223 * To enable write back mode permanently just call this function
\r
224 * once after ext4_mount (and disable before ext4_umount).
\r
226 * Some of the function use write back cache mode internally.
\r
227 * If you enable write back mode twice you have to disable it twice
\r
228 * to flush all data:
\r
230 * ext4_cache_write_back(..., 1);
\r
231 * ext4_cache_write_back(..., 1);
\r
233 * ext4_cache_write_back(..., 0);
\r
234 * ext4_cache_write_back(..., 0);
\r
236 * Write back mode is useful when you want to create a lot of empty
\r
237 * files/directories.
\r
239 * @param path mount point path
\r
240 * @param on enable/disable
\r
242 * @return standard error code */
\r
243 int ext4_cache_write_back(const char *path, bool on);
\r
245 /********************************FILE OPERATIONS*****************************/
\r
247 /**@brief Remove file by path.
\r
248 * @param path path to file
\r
249 * @return standard error code */
\r
250 int ext4_fremove(const char *path);
\r
252 /**@brief File open function.
\r
253 * @param filename, (has to start from mount point)
\r
254 * /my_partition/my_file
\r
255 * @param flags open file flags
\r
256 * |---------------------------------------------------------------|
\r
257 * | r or rb O_RDONLY |
\r
258 * |---------------------------------------------------------------|
\r
259 * | w or wb O_WRONLY|O_CREAT|O_TRUNC |
\r
260 * |---------------------------------------------------------------|
\r
261 * | a or ab O_WRONLY|O_CREAT|O_APPEND |
\r
262 * |---------------------------------------------------------------|
\r
263 * | r+ or rb+ or r+b O_RDWR |
\r
264 * |---------------------------------------------------------------|
\r
265 * | w+ or wb+ or w+b O_RDWR|O_CREAT|O_TRUNC |
\r
266 * |---------------------------------------------------------------|
\r
267 * | a+ or ab+ or a+b O_RDWR|O_CREAT|O_APPEND |
\r
268 * |---------------------------------------------------------------|
\r
270 * @return standard error code*/
\r
271 int ext4_fopen (ext4_file *f, const char *path, const char *flags);
\r
273 /**@brief File close function.
\r
274 * @param f file handle
\r
275 * @return standard error code*/
\r
276 int ext4_fclose(ext4_file *f);
\r
278 /**@brief Read data from file.
\r
279 * @param f file handle
\r
280 * @param buf output buffer
\r
281 * @param size bytes to read
\r
282 * @param rcnt bytes read (may be NULL)
\r
283 * @return standard error code*/
\r
284 int ext4_fread (ext4_file *f, void *buf, uint32_t size, uint32_t *rcnt);
\r
286 /**@brief Write data to file.
\r
287 * @param f file handle
\r
288 * @param buf data to write
\r
289 * @param size write length
\r
290 * @param wcnt bytes written (may be NULL)
\r
291 * @return standard error code*/
\r
292 int ext4_fwrite(ext4_file *f, void *buf, uint32_t size, uint32_t *wcnt);
\r
294 /**@brief File seek operation.
\r
295 * @param f file handle
\r
296 * @param offset offset to seek
\r
297 * @param origin seek type:
\r
301 * @return standard error code*/
\r
302 int ext4_fseek (ext4_file *f, uint64_t offset, uint32_t origin);
\r
304 /**@brief Get file position.
\r
305 * @param f file handle
\r
306 * @return actual file position */
\r
307 uint64_t ext4_ftell (ext4_file *f);
\r
309 /**@brief Get file size.
\r
310 * @param f file handle
\r
311 * @return file size */
\r
312 uint64_t ext4_fsize (ext4_file *f);
\r
314 /*********************************DIRECTORY OPERATION***********************/
\r
316 /**@brief Recursive directory remove.
\r
317 * @param path directory path to remove
\r
318 * @return standard error code*/
\r
319 int ext4_dir_rm(const char *path);
\r
321 /**@brief Create new directory.
\r
322 * @param name new directory name
\r
323 * @return standard error code*/
\r
324 int ext4_dir_mk(const char *path);
\r
326 /**@brief Directory open.
\r
327 * @param d directory handle
\r
328 * @param path directory path
\r
329 * @return standard error code*/
\r
330 int ext4_dir_open (ext4_dir *d, const char *path);
\r
332 /**@brief Directory close.
\r
333 * @param d directory handle
\r
334 * @return standard error code*/
\r
335 int ext4_dir_close(ext4_dir *d);
\r
338 /**@brief Return directory entry by id.
\r
339 * @param d directory handle
\r
340 * @param id entry id
\r
341 * @return directory entry id (NULL id no entry)*/
\r
342 ext4_direntry* ext4_dir_entry_get(ext4_dir *d, uint32_t id);
\r
344 #endif /* EXT4_H_ */
\r