lwext4/ext4.h

   1 /*
   2  * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  *
   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.
  16  *
  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.
  27  */
  28
  29 /** @addtogroup lwext4
  30  * @{
  31  */
  32 /**
  33  * @file  ext4.h
  34  * @brief Ext4 high level operations (files, directories, mount points...).
  35  *        Client has to include only this file.
  36  */
  37
  38 #ifndef EXT4_H_
  39 #define EXT4_H_
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 #include <stdint.h>
  46 #include <stddef.h>
  47
  48 /********************************FILE OPEN FLAGS*****************************/
  49
  50 #if CONFIG_HAVE_OWN_OFLAGS
  51
  52  #ifndef O_RDONLY
  53  #define O_RDONLY 00
  54  #endif
  55
  56  #ifndef O_WRONLY
  57  #define O_WRONLY 01
  58  #endif
  59
  60  #ifndef O_RDWR
  61  #define O_RDWR 02
  62  #endif
  63
  64  #ifndef O_CREAT
  65  #define O_CREAT 0100
  66  #endif
  67
  68  #ifndef O_EXCL
  69  #define O_EXCL 0200
  70  #endif
  71
  72  #ifndef O_TRUNC
  73  #define O_TRUNC 01000
  74  #endif
  75
  76  #ifndef O_APPEND
  77  #define O_APPEND 02000
  78  #endif
  79
  80 /********************************FILE SEEK FLAGS*****************************/
  81
  82  #ifndef SEEK_SET
  83  #define SEEK_SET 0
  84  #endif
  85
  86  #ifndef SEEK_CUR
  87  #define SEEK_CUR 1
  88  #endif
  89
  90  #ifndef SEEK_END
  91  #define SEEK_END 2
  92  #endif
  93
  94 #else
  95  #include <unistd.h>
  96  #include <fcntl.h>
  97 #endif
  98
  99 #include "ext4_config.h"
 100 #include "ext4_types.h"
 101 #include "ext4_blockdev.h"
 102
 103 /********************************OS LOCK INFERFACE***************************/
 104
 105 /**@brief   OS dependent lock interface.*/
 106 struct ext4_lock {
 107
 108         /**@brief   Lock access to mount point*/
 109         void (*lock)(void);
 110
 111         /**@brief   Unlock access to mount point*/
 112         void (*unlock)(void);
 113 };
 114
 115 /********************************FILE DESCRIPTOR*****************************/
 116
 117 /**@brief   File descriptor*/
 118 typedef struct ext4_file {
 119
 120         /**@brief   Mount point handle.*/
 121         struct ext4_mountpoint *mp;
 122
 123         /**@brief   File inode id*/
 124         uint32_t inode;
 125
 126         /**@brief   Open flags.*/
 127         uint32_t flags;
 128
 129         /**@brief   File size.*/
 130         uint64_t fsize;
 131
 132         /**@brief   File position*/
 133         uint64_t fpos;
 134 } ext4_file;
 135
 136 /*****************************DIRECTORY DESCRIPTOR***************************/
 137
 138 /**@brief   Directory entry descriptor. Copy from ext4_types.h*/
 139 typedef struct ext4_direntry {
 140         uint32_t inode;
 141         uint16_t entry_length;
 142         uint8_t name_length;
 143         uint8_t inode_type;
 144         uint8_t name[255];
 145 } ext4_direntry;
 146
 147 typedef struct ext4_dir {
 148         /**@brief   File descriptor*/
 149         ext4_file f;
 150         /**@brief   Current directory entry.*/
 151         ext4_direntry de;
 152         /**@brief   Next entry offset*/
 153         uint64_t next_off;
 154 } ext4_dir;
 155
 156 /********************************MOUNT OPERATIONS****************************/
 157
 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);
 169
 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
 173  *          -   /
 174  *          -   /my_partition/
 175  *          -   /my_second_partition/
 176  *
 177  * @return standard error code */
 178 int ext4_mount(const char *dev_name, const char *mount_point);
 179
 180 /**@brief   Umount operation.
 181  * @param   mount_point mount name
 182  * @return  standard error code */
 183 int ext4_umount(const char *mount_point);
 184
 185
 186 /**@brief   Journal recovery.
 187  * @param   mount_point mount point
 188  * @warning Must be called after @ref ext4_mount
 189  * @return standard error code */
 190 int ext4_recover(const char *mount_point);
 191
 192 /**@brief   Some of the filesystem stats.*/
 193 struct ext4_mount_stats {
 194         uint32_t inodes_count;
 195         uint32_t free_inodes_count;
 196         uint64_t blocks_count;
 197         uint64_t free_blocks_count;
 198
 199         uint32_t block_size;
 200         uint32_t block_group_count;
 201         uint32_t blocks_per_group;
 202         uint32_t inodes_per_group;
 203
 204         char volume_name[16];
 205 };
 206
 207 /**@brief   Get file system params.
 208  * @param   mount_point mount path
 209  * @param   stats ext fs stats
 210  * @return  standard error code */
 211 int ext4_mount_point_stats(const char *mount_point,
 212                            struct ext4_mount_stats *stats);
 213
 214 /**@brief   Setup OS lock routines.
 215  * @param   mount_point mount path
 216  * @param   locks - lock and unlock functions
 217  * @return  standard error code */
 218 int ext4_mount_setup_locks(const char *mount_point,
 219                            const struct ext4_lock *locks);
 220
 221 /**@brief   Acquire the filesystem superblock pointer of a mp.
 222  * @param   mount_point mount path
 223  * @param   superblock pointer
 224  * @return  standard error code */
 225 int ext4_get_sblock(const char *mount_point, struct ext4_sblock **sb);
 226
 227 /**@brief   Enable/disable write back cache mode.
 228  * @warning Default model of cache is write trough. It means that when You do:
 229  *
 230  *          ext4_fopen(...);
 231  *          ext4_fwrie(...);
 232  *                           < --- data is flushed to physical drive
 233  *
 234  *          When you do:
 235  *          ext4_cache_write_back(..., 1);
 236  *          ext4_fopen(...);
 237  *          ext4_fwrie(...);
 238  *                           < --- data is NOT flushed to physical drive
 239  *          ext4_cache_write_back(..., 0);
 240  *                           < --- when write back mode is disabled all
 241  *                                 cache data will be flushed
 242  * To enable write back mode permanently just call this function
 243  * once after ext4_mount (and disable before ext4_umount).
 244  *
 245  * Some of the function use write back cache mode internally.
 246  * If you enable write back mode twice you have to disable it twice
 247  * to flush all data:
 248  *
 249  *      ext4_cache_write_back(..., 1);
 250  *      ext4_cache_write_back(..., 1);
 251  *
 252  *      ext4_cache_write_back(..., 0);
 253  *      ext4_cache_write_back(..., 0);
 254  *
 255  * Write back mode is useful when you want to create a lot of empty
 256  * files/directories.
 257  *
 258  * @param   path mount point path
 259  * @param   on enable/disable
 260  *
 261  * @return  standard error code */
 262 int ext4_cache_write_back(const char *path, bool on);
 263
 264 /********************************FILE OPERATIONS*****************************/
 265
 266 /**@brief   Remove file by path.
 267  * @param   path path to file
 268  * @return  standard error code */
 269 int ext4_fremove(const char *path);
 270
 271 /**@brief   create a hardlink for a file.
 272  * @param   path path to file
 273  * @param   hardlink_path path of hardlink
 274  * @return  standard error code */
 275 int ext4_flink(const char *path, const char *hardlink_path);
 276
 277 /**@brief Rename file
 278  * @param path source
 279  * @param new_path destination
 280  * @return  standard error code */
 281 int ext4_frename(const char *path, const char *new_path);
 282
 283 /**@brief   File open function.
 284  * @param   path filename (has to start from mount point)
 285  *          /my_partition/my_file
 286  * @param   flags open file flags
 287  *  |---------------------------------------------------------------|
 288  *  |   r or rb                 O_RDONLY                            |
 289  *  |---------------------------------------------------------------|
 290  *  |   w or wb                 O_WRONLY|O_CREAT|O_TRUNC            |
 291  *  |---------------------------------------------------------------|
 292  *  |   a or ab                 O_WRONLY|O_CREAT|O_APPEND           |
 293  *  |---------------------------------------------------------------|
 294  *  |   r+ or rb+ or r+b        O_RDWR                              |
 295  *  |---------------------------------------------------------------|
 296  *  |   w+ or wb+ or w+b        O_RDWR|O_CREAT|O_TRUNC              |
 297  *  |---------------------------------------------------------------|
 298  *  |   a+ or ab+ or a+b        O_RDWR|O_CREAT|O_APPEND             |
 299  *  |---------------------------------------------------------------|
 300  *
 301  * @return  standard error code*/
 302 int ext4_fopen(ext4_file *f, const char *path, const char *flags);
 303
 304 /**@brief   Alternate file open function.
 305  * @param   filename, (has to start from mount point)
 306  *          /my_partition/my_file
 307  * @param   flags open file flags
 308  * @return  standard error code*/
 309 int ext4_fopen2(ext4_file *f, const char *path, int flags);
 310
 311 /**@brief   File close function.
 312  * @param   f file handle
 313  * @return  standard error code*/
 314 int ext4_fclose(ext4_file *f);
 315
 316 /**@brief   Fill in the ext4_inode buffer.
 317  * @param   path fetch inode data of the path
 318  * @param   ret_ino the inode id of the path
 319  * @param   ext4_inode buffer
 320  * @return  standard error code*/
 321 int ext4_fill_raw_inode(const char *path, uint32_t *ret_ino,
 322                         struct ext4_inode *inode);
 323
 324 /**@brief   File truncate function.
 325  * @param   f file handle
 326  * @param   new file size
 327  * @return  standard error code*/
 328 int ext4_ftruncate(ext4_file *f, uint64_t size);
 329
 330 /**@brief   Read data from file.
 331  * @param   f file handle
 332  * @param   buf output buffer
 333  * @param   size bytes to read
 334  * @param   rcnt bytes read (may be NULL)
 335  * @return  standard error code*/
 336 int ext4_fread(ext4_file *f, void *buf, size_t size, size_t *rcnt);
 337
 338 /**@brief   Write data to file.
 339  * @param   f file handle
 340  * @param   buf data to write
 341  * @param   size write length
 342  * @param   wcnt bytes written (may be NULL)
 343  * @return  standard error code*/
 344 int ext4_fwrite(ext4_file *f, const void *buf, size_t size, size_t *wcnt);
 345
 346 /**@brief   File seek operation.
 347  * @param   f file handle
 348  * @param   offset offset to seek
 349  * @param   origin seek type:
 350  *              @ref SEEK_SET
 351  *              @ref SEEK_CUR
 352  *              @ref SEEK_END
 353  * @return  standard error code*/
 354 int ext4_fseek(ext4_file *f, uint64_t offset, uint32_t origin);
 355
 356 /**@brief   Get file position.
 357  * @param   f file handle
 358  * @return  actual file position */
 359 uint64_t ext4_ftell(ext4_file *f);
 360
 361 /**@brief   Get file size.
 362  * @param   f file handle
 363  * @return  file size */
 364 uint64_t ext4_fsize(ext4_file *f);
 365
 366 /**@brief Change file/directory/link mode bits
 367  * @param path to file/dir/link
 368  * @param mode new mode bits (for example 0777)
 369  * @return  standard error code*/
 370 int ext4_chmod(const char *path, uint32_t mode);
 371
 372 /**@brief Change file owner and group
 373  * @param path to file/dir/link
 374  * @param uid user id
 375  * @param gid group id
 376  * @return  standard error code*/
 377 int ext4_chown(const char *path, uint32_t uid, uint32_t gid);
 378
 379 /**@brief Set file access time
 380  * @param path to file/dir/link
 381  * @param atime access timestamp
 382  * @return  standard error code*/
 383 int ext4_file_set_atime(const char *path, uint32_t atime);
 384
 385 /**@brief Set file modify time
 386  * @param path to file/dir/link
 387  * @param mtime modify timestamp
 388  * @return  standard error code*/
 389 int ext4_file_set_mtime(const char *path, uint32_t mtime);
 390
 391 /**@brief Set file change time
 392  * @param path to file/dir/link
 393  * @param ctime change timestamp
 394  * @return  standard error code*/
 395 int ext4_file_set_ctime(const char *path, uint32_t ctime);
 396
 397 /**@brief Create symbolic link
 398  * @param target destination path
 399  * @param path source entry
 400  * @return standard error code*/
 401 int ext4_fsymlink(const char *target, const char *path);
 402
 403
 404 /**@brief Read symbolic link payload
 405  * @param path to symlink
 406  * @param buf output buffer
 407  * @param bufsize output buffer max size
 408  * @param rcnt bytes read
 409  * @return standard error code*/
 410 int ext4_readlink(const char *path, char *buf, size_t bufsize, size_t *rcnt);
 411
 412 /**@brief Set extended attribute
 413  * @param path to entry
 414  *
 415  * TODO: write detailed description
 416  */
 417 int ext4_setxattr(const char *path, const char *name, size_t name_len,
 418                   const void *data, size_t data_size, bool replace);
 419
 420 /**@brief Get extended attribute
 421  * @param path to entry
 422  *
 423  * TODO: write detailed description
 424  */
 425 int ext4_getxattr(const char *path, const char *name, size_t name_len,
 426                   void *buf, size_t buf_size, size_t *data_size);
 427
 428 /**@brief List extended attributes
 429  * @param path to entry
 430  *
 431  * TODO: write detailed description
 432  */
 433 int ext4_listxattr(const char *path, char *list, size_t size, size_t *ret_size);
 434
 435 /**@brief Remove extended attribute
 436  * @param path to entry
 437  *
 438  * TODO: write detailed description
 439  */
 440 int ext4_removexattr(const char *path, const char *name, size_t name_len);
 441
 442
 443 /*********************************DIRECTORY OPERATION***********************/
 444
 445 /**@brief   Recursive directory remove.
 446  * @param   path directory path to remove
 447  * @return  standard error code*/
 448 int ext4_dir_rm(const char *path);
 449
 450 /**@brief   Create new directory.
 451  * @param   name new directory name
 452  * @return  standard error code*/
 453 int ext4_dir_mk(const char *path);
 454
 455 /**@brief   Directory open.
 456  * @param   d directory handle
 457  * @param   path directory path
 458  * @return  standard error code*/
 459 int ext4_dir_open(ext4_dir *d, const char *path);
 460
 461 /**@brief   Directory close.
 462  * @param   d directory handle
 463  * @return  standard error code*/
 464 int ext4_dir_close(ext4_dir *d);
 465
 466 /**@brief   Return next directory entry.
 467  * @param   d directory handle
 468  * @param   id entry id
 469  * @return  directory entry id (NULL if no entry)*/
 470 const ext4_direntry *ext4_dir_entry_next(ext4_dir *d);
 471
 472 /**@brief   Rewine directory entry offset.
 473  * @param   d directory handle*/
 474 void ext4_dir_entry_rewind(ext4_dir *d);
 475
 476 /**@brief   Test journal functionality
 477  * @param   mount_point mount point, for example
 478  *          -   /
 479  *          -   /my_partition/
 480  *          -   /my_second_partition/
 481  *
 482  * @return standard error code */
 483 int ext4_test_journal(const char *mount_point);
 484
 485 #ifdef __cplusplus
 486 }
 487 #endif
 488
 489 #endif /* EXT4_H_ */
 490
 491 /**
 492  * @}
 493  */