lwext4/ext4.h

   1 /*\r
   2  * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)\r
   3  * All rights reserved.\r
   4  *\r
   5  * Redistribution and use in source and binary forms, with or without\r
   6  * modification, are permitted provided that the following conditions\r
   7  * are met:\r
   8  *\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
  16  *\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
  27  */\r
  28 \r
  29 /** @addtogroup lwext4\r
  30  * @{\r
  31  */\r
  32 /**\r
  33  * @file  ext4.h\r
  34  * @brief Ext4 high level operations (files, directories, mount points...).\r
  35  *        Client has to include only this file.\r
  36  */\r
  37 \r
  38 #ifndef EXT4_H_\r
  39 #define EXT4_H_\r
  40 \r
  41 #include <ext4_config.h>\r
  42 #include <ext4_blockdev.h>\r
  43 #include <stdint.h>\r
  44 \r
  45 /********************************FILE OPEN FLAGS*****************************/\r
  46 \r
  47 #ifndef O_RDONLY\r
  48 #define O_RDONLY    00\r
  49 #endif\r
  50 \r
  51 #ifndef O_WRONLY\r
  52 #define O_WRONLY    01\r
  53 #endif\r
  54 \r
  55 #ifndef O_RDWR\r
  56 #define O_RDWR      02\r
  57 #endif\r
  58 \r
  59 #ifndef O_CREAT\r
  60 #define O_CREAT     0100\r
  61 #endif\r
  62 \r
  63 #ifndef O_EXCL\r
  64 #define O_EXCL      0200\r
  65 #endif\r
  66 \r
  67 #ifndef O_TRUNC\r
  68 #define O_TRUNC     01000\r
  69 #endif\r
  70 \r
  71 #ifndef O_APPEND\r
  72 #define O_APPEND    02000\r
  73 #endif\r
  74 \r
  75 /********************************FILE SEEK FLAGS*****************************/\r
  76 \r
  77 #ifndef SEEK_SET\r
  78 #define SEEK_SET    0\r
  79 #endif\r
  80 \r
  81 #ifndef SEEK_CUR\r
  82 #define SEEK_CUR    1\r
  83 #endif\r
  84 \r
  85 #ifndef SEEK_END\r
  86 #define SEEK_END    2\r
  87 #endif\r
  88 \r
  89 /********************************OS LOCK INFERFACE***************************/\r
  90 \r
  91 /**@brief   OS dependent lock interface.*/\r
  92 struct ext4_lock {\r
  93 \r
  94     /**@brief   Lock access to mount point*/\r
  95     void (*lock)(void);\r
  96 \r
  97     /**@brief   Unlock access to mount point*/\r
  98     void (*unlock)(void);\r
  99 };\r
 100 \r
 101 \r
 102 /********************************FILE DESCRIPTOR*****************************/\r
 103 \r
 104 /**@brief   File descriptor*/\r
 105 typedef struct ext4_file {\r
 106 \r
 107     /**@brief   Mount point handle.*/\r
 108     struct ext4_mountpoint *mp;\r
 109 \r
 110     /**@brief   File inode id*/\r
 111     uint32_t inode;\r
 112 \r
 113     /**@brief   Open flags.*/\r
 114     uint32_t flags;\r
 115 \r
 116     /**@brief   File size.*/\r
 117     uint64_t fsize;\r
 118 \r
 119     /**@brief   File position*/\r
 120     uint64_t fpos;\r
 121 }ext4_file;\r
 122 \r
 123 /*****************************DIRECTORY DESCRIPTOR***************************/\r
 124 /**@brief   Directory entry types. Copy from ext4_types.h*/\r
 125 enum  {\r
 126     EXT4_DIRENTRY_UNKNOWN = 0,\r
 127     EXT4_DIRENTRY_REG_FILE,\r
 128     EXT4_DIRENTRY_DIR,\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
 134 };\r
 135 \r
 136 /**@brief   Directory entry descriptor. Copy from ext4_types.h*/\r
 137 typedef struct {\r
 138     uint32_t inode;\r
 139     uint16_t entry_length;\r
 140     uint8_t name_length;\r
 141     uint8_t inode_type;\r
 142     uint8_t name[255];\r
 143 }ext4_direntry;\r
 144 \r
 145 typedef struct  {\r
 146     /**@brief   File descriptor*/\r
 147     ext4_file f;\r
 148     /**@brief   Current directory entry.*/\r
 149     ext4_direntry de;\r
 150     /**@brief   Next entry offset*/\r
 151     uint64_t next_off;\r
 152 }ext4_dir;\r
 153 \r
 154 /********************************MOUNT OPERATIONS****************************/\r
 155 \r
 156 /**@brief   Register a block device to a name.\r
 157  *          @warning Block device has to be filled by\r
 158  *          @ref EXT4_BLOCKDEV_STATIC_INSTANCE. Block cache may be created\r
 159  *          @ref EXT4_BCACHE_STATIC_INSTANCE.\r
 160  *          Block cache may by created automatically when bc parameter is 0.\r
 161  * @param   bd block device\r
 162  * @param   bd block device cache (0 = automatic cache mode)\r
 163  * @param   dev_name register name\r
 164  * @param   standard error code*/\r
 165 int ext4_device_register(struct ext4_blockdev *bd, struct ext4_bcache *bc,\r
 166         const char *dev_name);\r
 167 \r
 168 /**@brief   Mount a block device with EXT4 partition to the mount point.\r
 169  * @param   dev_name block device name (@ref ext4_device_register)\r
 170  * @param   mount_point mount point, for example\r
 171  *          -   /\r
 172  *          -   /my_partition/\r
 173  *          -   /my_second_partition/\r
 174  *\r
 175  * @return standard error code */\r
 176 int ext4_mount(const char * dev_name,  char *mount_point);\r
 177 \r
 178 /**@brief   Umount operation.\r
 179  * @param   mount_point mount name\r
 180  * @return  standard error code */\r
 181 int ext4_umount(char *mount_point);\r
 182 \r
 183 \r
 184 /**@brief   Some of the filesystem stats.*/\r
 185 struct ext4_mount_stats {\r
 186     uint32_t inodes_count;\r
 187     uint32_t free_inodes_count;\r
 188     uint64_t blocks_count;\r
 189     uint64_t free_blocks_count;\r
 190 \r
 191     uint32_t block_size;\r
 192     uint32_t block_group_count;\r
 193     uint32_t blocks_per_group;\r
 194     uint32_t inodes_per_group;\r
 195 \r
 196     char volume_name[16];\r
 197 };\r
 198 \r
 199 /**@brief   Get file system params.\r
 200  * @param   mount_point mount path\r
 201  * @param   stats ext fs stats\r
 202  * @return  standard error code */\r
 203 int ext4_mount_point_stats(const char *mount_point,\r
 204     struct ext4_mount_stats *stats);\r
 205 \r
 206 /**@brief   Setup OS lock routines.\r
 207  * @param   mount_point mount path\r
 208  * @param   locks - lock and unlock functions\r
 209  * @return  standard error code */\r
 210 int ext4_mount_setup_locks(const char * mount_point,\r
 211     const struct ext4_lock *locks);\r
 212 \r
 213 /**@brief   Enable/disable write back cache mode.\r
 214  * @warning Default model of cache is write trough. It means that when You do:\r
 215  *\r
 216  *          ext4_fopen(...);\r
 217  *          ext4_fwrie(...);\r
 218  *                           < --- data is flushed to physical drive\r
 219  *\r
 220  *          When you do:\r
 221  *          ext4_cache_write_back(..., 1);\r
 222  *          ext4_fopen(...);\r
 223  *          ext4_fwrie(...);\r
 224  *                           < --- data is NOT flushed to physical drive\r
 225  *          ext4_cache_write_back(..., 0);\r
 226  *                           < --- when write back mode is disabled all\r
 227  *                                 cache data will be flushed\r
 228  * To enable write back mode permanently just call this function\r
 229  * once after ext4_mount (and disable before ext4_umount).\r
 230  *\r
 231  * Some of the function use write back cache mode internally.\r
 232  * If you enable write back mode twice you have to disable it twice\r
 233  * to flush all data:\r
 234  *\r
 235  *      ext4_cache_write_back(..., 1);\r
 236  *      ext4_cache_write_back(..., 1);\r
 237  *\r
 238  *      ext4_cache_write_back(..., 0);\r
 239  *      ext4_cache_write_back(..., 0);\r
 240  *\r
 241  * Write back mode is useful when you want to create a lot of empty\r
 242  * files/directories.\r
 243  *\r
 244  * @param   path mount point path\r
 245  * @param   on enable/disable\r
 246  *\r
 247  * @return  standard error code */\r
 248 int ext4_cache_write_back(const char *path, bool on);\r
 249 \r
 250 /********************************FILE OPERATIONS*****************************/\r
 251 \r
 252 /**@brief   Remove file by path.\r
 253  * @param   path path to file\r
 254  * @return  standard error code */\r
 255 int ext4_fremove(const char *path);\r
 256 \r
 257 /**@brief   File open function.\r
 258  * @param   filename, (has to start from mount point)\r
 259  *          /my_partition/my_file\r
 260  * @param   flags open file flags\r
 261  *  |---------------------------------------------------------------|\r
 262  *  |   r or rb                 O_RDONLY                            |\r
 263  *  |---------------------------------------------------------------|\r
 264  *  |   w or wb                 O_WRONLY|O_CREAT|O_TRUNC            |\r
 265  *  |---------------------------------------------------------------|\r
 266  *  |   a or ab                 O_WRONLY|O_CREAT|O_APPEND           |\r
 267  *  |---------------------------------------------------------------|\r
 268  *  |   r+ or rb+ or r+b        O_RDWR                              |\r
 269  *  |---------------------------------------------------------------|\r
 270  *  |   w+ or wb+ or w+b        O_RDWR|O_CREAT|O_TRUNC              |\r
 271  *  |---------------------------------------------------------------|\r
 272  *  |   a+ or ab+ or a+b        O_RDWR|O_CREAT|O_APPEND             |\r
 273  *  |---------------------------------------------------------------|\r
 274  *\r
 275  * @return  standard error code*/\r
 276 int ext4_fopen (ext4_file *f, const char *path, const char *flags);\r
 277 \r
 278 /**@brief   File close function.\r
 279  * @param   f file handle\r
 280  * @return  standard error code*/\r
 281 int ext4_fclose(ext4_file *f);\r
 282 \r
 283 /**@brief   Read data from file.\r
 284  * @param   f file handle\r
 285  * @param   buf output buffer\r
 286  * @param   size bytes to read\r
 287  * @param   rcnt bytes read (may be NULL)\r
 288  * @return  standard error code*/\r
 289 int ext4_fread (ext4_file *f, void *buf, uint32_t size, uint32_t *rcnt);\r
 290 \r
 291 /**@brief   Write data to file.\r
 292  * @param   f file handle\r
 293  * @param   buf data to write\r
 294  * @param   size write length\r
 295  * @param   wcnt bytes written (may be NULL)\r
 296  * @return  standard error code*/\r
 297 int ext4_fwrite(ext4_file *f, const void *buf, uint32_t size, uint32_t *wcnt);\r
 298 \r
 299 /**@brief   File seek operation.\r
 300  * @param   f file handle\r
 301  * @param   offset offset to seek\r
 302  * @param   origin seek type:\r
 303  *              @ref SEEK_SET\r
 304  *              @ref SEEK_CUR\r
 305  *              @ref SEEK_END\r
 306  * @return  standard error code*/\r
 307 int ext4_fseek (ext4_file *f, uint64_t offset, uint32_t origin);\r
 308 \r
 309 /**@brief   Get file position.\r
 310  * @param   f file handle\r
 311  * @return  actual file position */\r
 312 uint64_t ext4_ftell (ext4_file *f);\r
 313 \r
 314 /**@brief   Get file size.\r
 315  * @param   f file handle\r
 316  * @return  file size */\r
 317 uint64_t ext4_fsize (ext4_file *f);\r
 318 \r
 319 /*********************************DIRECTORY OPERATION***********************/\r
 320 \r
 321 /**@brief   Recursive directory remove.\r
 322  * @param   path directory path to remove\r
 323  * @return  standard error code*/\r
 324 int ext4_dir_rm(const char *path);\r
 325 \r
 326 /**@brief   Create new directory.\r
 327  * @param   name new directory name\r
 328  * @return  standard error code*/\r
 329 int ext4_dir_mk(const char *path);\r
 330 \r
 331 /**@brief   Directory open.\r
 332  * @param   d directory handle\r
 333  * @param   path directory path\r
 334  * @return  standard error code*/\r
 335 int ext4_dir_open (ext4_dir *d, const char *path);\r
 336 \r
 337 /**@brief   Directory close.\r
 338  * @param   d directory handle\r
 339  * @return  standard error code*/\r
 340 int ext4_dir_close(ext4_dir *d);\r
 341 \r
 342 /**@brief   Return next directory entry.\r
 343  * @param   d directory handle\r
 344  * @param   id entry id\r
 345  * @return  directory entry id (NULL if no entry)*/\r
 346 ext4_direntry* ext4_dir_entry_next(ext4_dir *d);\r
 347 \r
 348 #endif /* EXT4_H_ */\r
 349 \r
 350 /**\r
 351  * @}\r
 352  */\r