2 * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 /** @addtogroup lwext4
34 * @brief Ext4 high level operations (files, directories, mount points...).
35 * Client has to include only this file.
48 /********************************FILE OPEN FLAGS*****************************/
50 #if CONFIG_HAVE_OWN_OFLAGS
77 #define O_APPEND 02000
80 /********************************FILE SEEK FLAGS*****************************/
99 #include "ext4_config.h"
100 #include "ext4_types.h"
101 #include "ext4_blockdev.h"
103 /********************************OS LOCK INFERFACE***************************/
105 /**@brief OS dependent lock interface.*/
108 /**@brief Lock access to mount point*/
111 /**@brief Unlock access to mount point*/
112 void (*unlock)(void);
115 /********************************FILE DESCRIPTOR*****************************/
117 /**@brief File descriptor*/
118 typedef struct ext4_file {
120 /**@brief Mount point handle.*/
121 struct ext4_mountpoint *mp;
123 /**@brief File inode id*/
126 /**@brief Open flags.*/
129 /**@brief File size.*/
132 /**@brief File position*/
136 /*****************************DIRECTORY DESCRIPTOR***************************/
138 /**@brief Directory entry descriptor. Copy from ext4_types.h*/
141 uint16_t entry_length;
148 /**@brief File descriptor*/
150 /**@brief Current directory entry.*/
152 /**@brief Next entry offset*/
156 /********************************MOUNT OPERATIONS****************************/
158 /**@brief Register a block device to a name.
159 * @warning Block device has to be filled by
160 * @ref EXT4_BLOCKDEV_STATIC_INSTANCE. Block cache may be created
161 * @ref EXT4_BCACHE_STATIC_INSTANCE.
162 * Block cache may by created automatically when bc parameter is 0.
163 * @param bd block device
164 * @param bd block device cache (0 = automatic cache mode)
165 * @param dev_name register name
166 * @param standard error code*/
167 int ext4_device_register(struct ext4_blockdev *bd, struct ext4_bcache *bc,
168 const char *dev_name);
170 /**@brief Mount a block device with EXT4 partition to the mount point.
171 * @param dev_name block device name (@ref ext4_device_register)
172 * @param mount_point mount point, for example
175 * - /my_second_partition/
177 * @return standard error code */
178 int ext4_mount(const char *dev_name, const char *mount_point);
180 /**@brief Umount operation.
181 * @param mount_point mount name
182 * @return standard error code */
183 int ext4_umount(const char *mount_point);
185 /**@brief Some of the filesystem stats.*/
186 struct ext4_mount_stats {
187 uint32_t inodes_count;
188 uint32_t free_inodes_count;
189 uint64_t blocks_count;
190 uint64_t free_blocks_count;
193 uint32_t block_group_count;
194 uint32_t blocks_per_group;
195 uint32_t inodes_per_group;
197 char volume_name[16];
200 /**@brief Get file system params.
201 * @param mount_point mount path
202 * @param stats ext fs stats
203 * @return standard error code */
204 int ext4_mount_point_stats(const char *mount_point,
205 struct ext4_mount_stats *stats);
207 /**@brief Setup OS lock routines.
208 * @param mount_point mount path
209 * @param locks - lock and unlock functions
210 * @return standard error code */
211 int ext4_mount_setup_locks(const char *mount_point,
212 const struct ext4_lock *locks);
214 /**@brief Acquire the filesystem superblock pointer of a mp.
215 * @param mount_point mount path
216 * @param superblock pointer
217 * @return standard error code */
218 int ext4_get_sblock(const char *mount_point, struct ext4_sblock **sb);
220 /**@brief Enable/disable write back cache mode.
221 * @warning Default model of cache is write trough. It means that when You do:
225 * < --- data is flushed to physical drive
228 * ext4_cache_write_back(..., 1);
231 * < --- data is NOT flushed to physical drive
232 * ext4_cache_write_back(..., 0);
233 * < --- when write back mode is disabled all
234 * cache data will be flushed
235 * To enable write back mode permanently just call this function
236 * once after ext4_mount (and disable before ext4_umount).
238 * Some of the function use write back cache mode internally.
239 * If you enable write back mode twice you have to disable it twice
242 * ext4_cache_write_back(..., 1);
243 * ext4_cache_write_back(..., 1);
245 * ext4_cache_write_back(..., 0);
246 * ext4_cache_write_back(..., 0);
248 * Write back mode is useful when you want to create a lot of empty
251 * @param path mount point path
252 * @param on enable/disable
254 * @return standard error code */
255 int ext4_cache_write_back(const char *path, bool on);
257 /********************************FILE OPERATIONS*****************************/
259 /**@brief Remove file by path.
260 * @param path path to file
261 * @return standard error code */
262 int ext4_fremove(const char *path);
264 /**@brief create a hardlink for a file.
265 * @param path path to file
266 * @param hardlink_path path of hardlink
267 * @return standard error code */
268 int ext4_flink(const char *path, const char *hardlink_path);
270 /**@brief Rename file
272 * @param new_path destination
273 * @return standard error code */
274 int ext4_frename(const char *path, const char *new_path);
276 /**@brief File open function.
277 * @param filename, (has to start from mount point)
278 * /my_partition/my_file
279 * @param flags open file flags
280 * |---------------------------------------------------------------|
281 * | r or rb O_RDONLY |
282 * |---------------------------------------------------------------|
283 * | w or wb O_WRONLY|O_CREAT|O_TRUNC |
284 * |---------------------------------------------------------------|
285 * | a or ab O_WRONLY|O_CREAT|O_APPEND |
286 * |---------------------------------------------------------------|
287 * | r+ or rb+ or r+b O_RDWR |
288 * |---------------------------------------------------------------|
289 * | w+ or wb+ or w+b O_RDWR|O_CREAT|O_TRUNC |
290 * |---------------------------------------------------------------|
291 * | a+ or ab+ or a+b O_RDWR|O_CREAT|O_APPEND |
292 * |---------------------------------------------------------------|
294 * @return standard error code*/
295 int ext4_fopen(ext4_file *f, const char *path, const char *flags);
297 /**@brief Alternate file open function.
298 * @param filename, (has to start from mount point)
299 * /my_partition/my_file
300 * @param flags open file flags
301 * @return standard error code*/
302 int ext4_fopen2(ext4_file *f, const char *path, int flags);
304 /**@brief File close function.
305 * @param f file handle
306 * @return standard error code*/
307 int ext4_fclose(ext4_file *f);
309 /**@brief Fill in the ext4_inode buffer.
310 * @param path fetch inode data of the path
311 * @param ret_ino the inode id of the path
312 * @param ext4_inode buffer
313 * @return standard error code*/
314 int ext4_fill_raw_inode(const char *path, uint32_t *ret_ino,
315 struct ext4_inode *inode);
317 /**@brief File truncate function.
318 * @param f file handle
319 * @param new file size
320 * @return standard error code*/
321 int ext4_ftruncate(ext4_file *f, uint64_t size);
323 /**@brief Read data from file.
324 * @param f file handle
325 * @param buf output buffer
326 * @param size bytes to read
327 * @param rcnt bytes read (may be NULL)
328 * @return standard error code*/
329 int ext4_fread(ext4_file *f, void *buf, size_t size, size_t *rcnt);
331 /**@brief Write data to file.
332 * @param f file handle
333 * @param buf data to write
334 * @param size write length
335 * @param wcnt bytes written (may be NULL)
336 * @return standard error code*/
337 int ext4_fwrite(ext4_file *f, const void *buf, size_t size, size_t *wcnt);
339 /**@brief File seek operation.
340 * @param f file handle
341 * @param offset offset to seek
342 * @param origin seek type:
346 * @return standard error code*/
347 int ext4_fseek(ext4_file *f, uint64_t offset, uint32_t origin);
349 /**@brief Get file position.
350 * @param f file handle
351 * @return actual file position */
352 uint64_t ext4_ftell(ext4_file *f);
354 /**@brief Get file size.
355 * @param f file handle
356 * @return file size */
357 uint64_t ext4_fsize(ext4_file *f);
359 int ext4_chmod(const char *path, uint32_t mode);
360 int ext4_chown(const char *path, uint32_t uid, uint32_t gid);
361 int ext4_file_set_atime(const char *path, uint32_t atime);
362 int ext4_file_set_mtime(const char *path, uint32_t mtime);
363 int ext4_file_set_ctime(const char *path, uint32_t ctime);
365 int ext4_fsymlink(const char *target, const char *path);
367 int ext4_readlink(const char *path, char *buf, size_t bufsize, size_t *rcnt);
369 int ext4_setxattr(const char *path, const char *name, size_t name_len,
370 const void *data, size_t data_size, bool replace);
371 int ext4_getxattr(const char *path, const char *name, size_t name_len,
372 void *buf, size_t buf_size, size_t *data_size);
373 int ext4_listxattr(const char *path, char *list, size_t size, size_t *ret_size);
374 int ext4_removexattr(const char *path, const char *name, size_t name_len);
377 /*********************************DIRECTORY OPERATION***********************/
379 /**@brief Recursive directory remove.
380 * @param path directory path to remove
381 * @return standard error code*/
382 int ext4_dir_rm(const char *path);
384 /**@brief Create new directory.
385 * @param name new directory name
386 * @return standard error code*/
387 int ext4_dir_mk(const char *path);
389 /**@brief Directory open.
390 * @param d directory handle
391 * @param path directory path
392 * @return standard error code*/
393 int ext4_dir_open(ext4_dir *d, const char *path);
395 /**@brief Directory close.
396 * @param d directory handle
397 * @return standard error code*/
398 int ext4_dir_close(ext4_dir *d);
400 /**@brief Return next directory entry.
401 * @param d directory handle
403 * @return directory entry id (NULL if no entry)*/
404 const ext4_direntry *ext4_dir_entry_next(ext4_dir *d);
406 /**@brief Rewine directory entry offset.
407 * @param d directory handle*/
408 void ext4_dir_entry_rewind(ext4_dir *d);