cea3fe6bb47f2bfdf7a9efc5860af325659fb589
[lwext4.git] / include / ext4_ialloc.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_ialloc.c
39  * @brief Inode allocation procedures.
40  */
41
42 #ifndef EXT4_IALLOC_H_
43 #define EXT4_IALLOC_H_
44
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 #include "ext4_config.h"
50 #include "ext4_types.h"
51
52 /**@brief Calculate and set checksum of inode bitmap.
53  * @param sb superblock pointer.
54  * @param bg block group
55  * @param bitmap bitmap buffer
56  */
57 void ext4_ialloc_set_bitmap_csum(struct ext4_sblock *sb, struct ext4_bgroup *bg,
58                                  void *bitmap);
59
60 /**@brief Free i-node number and modify filesystem data structers.
61  * @param fs     Filesystem, where the i-node is located
62  * @param index  Index of i-node to be release
63  * @param is_dir Flag us for information whether i-node is directory or not
64  */
65 int ext4_ialloc_free_inode(struct ext4_fs *fs, uint32_t index, bool is_dir);
66
67 /**@brief I-node allocation algorithm.
68  * This is more simple algorithm, than Orlov allocator used
69  * in the Linux kernel.
70  * @param fs     Filesystem to allocate i-node on
71  * @param index  Output value - allocated i-node number
72  * @param is_dir Flag if allocated i-node will be file or directory
73  * @return Error code
74  */
75 int ext4_ialloc_alloc_inode(struct ext4_fs *fs, uint32_t *index, bool is_dir);
76
77 #ifdef __cplusplus
78 }
79 #endif
80
81 #endif /* EXT4_IALLOC_H_ */
82
83 /**
84  * @}
85  */