06ad897ef6f4951e29b6cfe628d57290493a2654
[lwext4.git] / lwext4 / ext4_balloc.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_balloc.h
39  * @brief Physical block allocator.
40  */
41
42 #ifndef EXT4_BALLOC_H_
43 #define EXT4_BALLOC_H_
44
45 #include "ext4_config.h"
46 #include "ext4_types.h"
47
48 #include <stdint.h>
49 #include <stdbool.h>
50
51 /**@brief   Get first datablock in block group
52  * @param   s superblock descriptor
53  * @param   bg_ref block group reference
54  * @return  block id of the first datablock in block group*/
55 uint32_t
56 ext4_balloc_get_first_data_block_in_group(struct ext4_sblock *s,
57                                           struct ext4_block_group_ref *bg_ref);
58
59 /**@brief   Free block from inode.
60  * @param   inode_ref inode reference
61  * @param   baddr block address
62  * @return  standard error code*/
63 int ext4_balloc_free_block(struct ext4_inode_ref *inode_ref, uint32_t baddr);
64
65 /**@brief   Free blocks from inode.
66  * @param   inode_ref inode reference
67  * @param   baddr block address
68  * @return  standard error code*/
69 int ext4_balloc_free_blocks(struct ext4_inode_ref *inode_ref, uint32_t first,
70                             uint32_t count);
71
72 /**@brief   Allocate block procedure.
73  * @param   inode_ref inode reference
74  * @param   baddr allocated block address
75  * @return  standard error code*/
76 int ext4_balloc_alloc_block(struct ext4_inode_ref *inode_ref, uint32_t *baddr);
77
78 /**@brief   Try allocate selected block.
79  * @param   inode_ref inode reference
80  * @param   baddr block address to allocate
81  * @param   free if baddr is not allocated
82  * @return  standard error code*/
83 int ext4_balloc_try_alloc_block(struct ext4_inode_ref *inode_ref,
84                                 uint32_t baddr, bool *free);
85
86 #endif /* EXT4_BALLOC_H_ */
87
88 /**
89  * @}
90  */