lwext4/ext4_fs.h

   1 /*
   2  * Copyright (c) 2013 Grzegorz Kostka (kostka.grzegorz@gmail.com)
   3  *
   4  *
   5  * HelenOS:
   6  * Copyright (c) 2012 Martin Sucha
   7  * Copyright (c) 2012 Frantisek Princ
   8  * All rights reserved.
   9  *
  10  * Redistribution and use in source and binary forms, with or without
  11  * modification, are permitted provided that the following conditions
  12  * are met:
  13  *
  14  * - Redistributions of source code must retain the above copyright
  15  *   notice, this list of conditions and the following disclaimer.
  16  * - Redistributions in binary form must reproduce the above copyright
  17  *   notice, this list of conditions and the following disclaimer in the
  18  *   documentation and/or other materials provided with the distribution.
  19  * - The name of the author may not be used to endorse or promote products
  20  *   derived from this software without specific prior written permission.
  21  *
  22  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  24  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  25  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  27  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  31  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 /** @addtogroup lwext4
  35  * @{
  36  */
  37 /**
  38  * @file  ext4_fs.c
  39  * @brief More complex filesystem functions.
  40  */
  41
  42 #ifndef EXT4_FS_H_
  43 #define EXT4_FS_H_
  44
  45 #include <ext4_config.h>
  46 #include <ext4_types.h>
  47
  48 #include <stdint.h>
  49 #include <stdbool.h>
  50
  51 /**@brief   TODO: ...*/
  52 int ext4_fs_init(struct ext4_fs *fs, struct ext4_blockdev *bdev);
  53
  54 /**@brief   TODO: ...*/
  55 int ext4_fs_fini(struct ext4_fs *fs);
  56
  57 /**@brief   TODO: ...*/
  58 int ext4_fs_check_features(struct ext4_fs *fs, bool *read_only);
  59
  60 /**@brief   TODO: ...*/
  61 uint32_t ext4_fs_baddr2_index_in_group(struct ext4_sblock *s, uint32_t baddr);
  62
  63 /**@brief   TODO: ...*/
  64 uint32_t ext4_fs_index_in_group2_baddr(struct ext4_sblock *s, uint32_t index,
  65     uint32_t bgid);
  66
  67 /**@brief   TODO: ...*/
  68 int ext4_fs_get_block_group_ref(struct ext4_fs *fs, uint32_t bgid,
  69     struct ext4_block_group_ref *ref);
  70
  71 /**@brief   TODO: ...*/
  72 int ext4_fs_put_block_group_ref(struct ext4_block_group_ref *ref);
  73
  74 /**@brief   TODO: ...*/
  75 int ext4_fs_get_inode_ref(struct ext4_fs *fs, uint32_t index,
  76     struct ext4_inode_ref *ref);
  77
  78 /**@brief   TODO: ...*/
  79 int ext4_fs_put_inode_ref(struct ext4_inode_ref *ref);
  80
  81 /**@brief   TODO: ...*/
  82 int ext4_fs_alloc_inode(struct ext4_fs *fs, struct ext4_inode_ref *inode_ref,
  83     bool is_directory);
  84
  85 /**@brief   TODO: ...*/
  86 int ext4_fs_free_inode(struct ext4_inode_ref *inode_ref);
  87
  88 /**@brief   TODO: ...*/
  89 int ext4_fs_truncate_inode(struct ext4_inode_ref *inode_ref,
  90     uint64_t new_size);
  91
  92 /**@brief   TODO: ...*/
  93 int ext4_fs_get_inode_data_block_index(struct ext4_inode_ref *inode_ref,
  94     uint64_t iblock, uint32_t *fblock);
  95
  96 /**@brief   TODO: ...*/
  97 int ext4_fs_set_inode_data_block_index(struct ext4_inode_ref *inode_ref,
  98     uint64_t iblock, uint32_t fblock);
  99
 100 /**@brief   TODO: ...*/
 101 int ext4_fs_release_inode_block(struct ext4_inode_ref *inode_ref,
 102     uint32_t iblock);
 103
 104 /**@brief   TODO: ...*/
 105 int ext4_fs_append_inode_block(struct ext4_inode_ref *inode_ref,
 106     uint32_t *fblock, uint32_t *iblock);
 107
 108 #endif /* EXT4_FS_H_ */
 109
 110 /**
 111  * @}
 112  */