1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
/* SPDX-License-Identifier: BSD-2-Clause */
/**
* @file
*
* @brief RTEMS File Systems Group Management
*
* @ingroup rtems_rfs
*
* RTEMS File Systems Group Management.
*
* These functions manage the groups used in the file system.
*/
/*
* COPYRIGHT (c) 2010 Chris Johns <chrisj@rtems.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#if !defined (_RTEMS_RFS_GROUP_H_)
#define _RTEMS_RFS_GROUP_H_
/**
* @ingroup rtems_rfs
*
* RTEMS File System Group Management
*/
/**@{*/
#include <rtems/rfs/rtems-rfs-trace.h>
#include <rtems/rfs/rtems-rfs-bitmaps.h>
#include <rtems/rfs/rtems-rfs-buffer.h>
/**
* Block allocations for a group on disk.
*/
#define RTEMS_RFS_GROUP_BLOCK_BITMAP_BLOCK (0)
#define RTEMS_RFS_GROUP_INODE_BITMAP_BLOCK (1)
#define RTEMS_RFS_GROUP_INODE_BLOCK (2)
/**
* @brief Creates bit allocator for blocks in the group simpler.
*
* A group is a selection of blocks on the disk. Typically the number of blocks
* in a group is determined by the number of bits a block holds. This makes the
* bit allocator for blocks in the group simpler plus is allows a simple way to
* localise access to files and directories.
*/
typedef struct _rtems_rfs_group
{
/**
* Base block number.
*/
rtems_rfs_buffer_block base;
/**
* The number of blocks in the group. Groups may be different sizes.
*/
size_t size;
/**
* The block bitmap control.
*/
rtems_rfs_bitmap_control block_bitmap;
/**
* The handle to the block bitmap buffer.
*/
rtems_rfs_buffer_handle block_bitmap_buffer;
/**
* The inode bitmap control.
*/
rtems_rfs_bitmap_control inode_bitmap;
/**
* The handle to the inode bitmap buffer.
*/
rtems_rfs_buffer_handle inode_bitmap_buffer;
} rtems_rfs_group;
/**
* Return the disk's block for a block in a group.
*/
#define rtems_rfs_group_block(_g, _b) (((_g)->base) + (_b))
/**
* Return the file system inode for a inode in a group.
*/
#define rtems_rfs_group_inode(_f, _g, _i) \
(((_f)->group_inodes * (_g)) + (_i) + RTEMS_RFS_ROOT_INO)
/**
* @brief Open a group.
*
* Allocate all the resources including the bitmaps.
*
* @param fs The file system.
* @param base The base block number.
* @param size The number of blocks in the group.
* @param group Reference to the group to open.
* @retval int The error number (errno). No error if 0.
*/
int rtems_rfs_group_open (rtems_rfs_file_system* fs,
rtems_rfs_buffer_block base,
size_t size,
size_t inodes,
rtems_rfs_group* group);
/**
* @brief Close a group.
*
* Release all resources the group holds.
*
* @param fs The file system.
* @param group The group to close.
* @retval int The error number (errno). No error if 0.
*/
int rtems_rfs_group_close (rtems_rfs_file_system* fs,
rtems_rfs_group* group);
/**
* @brief Allocate an inode or block.
*
* The groups are searched to find the next
* available inode or block.
*
* @param fs The file system data.
* @param goal The goal to seed the bitmap search.
* @param inode If true allocate an inode else allocate a block.
* @param result The allocated bit in the bitmap.
* @retval int The error number (errno). No error if 0.
*/
int rtems_rfs_group_bitmap_alloc (rtems_rfs_file_system* fs,
rtems_rfs_bitmap_bit goal,
bool inode,
rtems_rfs_bitmap_bit* result);
/**
* @brief Free the group allocated bit.
*
* @param fs The file system data.
* @param inode If true the number to free is an inode else it is a block.
* @param block The inode or block number to free.
* @retval int The error number (errno). No error if 0.
*/
int rtems_rfs_group_bitmap_free (rtems_rfs_file_system* fs,
bool inode,
rtems_rfs_bitmap_bit no);
/**
* @brief Test the group allocated bit.
*
* @param fs The file system data.
* @param inode If true the number to free is an inode else it is a block.
* @param block The inode or block number to free.
* @param state Return the state of the bit.
* @retval int The error number (errno). No error if 0.
*/
int rtems_rfs_group_bitmap_test (rtems_rfs_file_system* fs,
bool inode,
rtems_rfs_bitmap_bit no,
bool* state);
/**
* @brief Determine the number of blocks and inodes used.
*
* @param fs The file system data.
* @param blocks The number of blocks used.
* @param inodes The number of inodes used.
* @retval int The error number (errno). No error if 0.
*/
int rtems_rfs_group_usage (rtems_rfs_file_system* fs,
size_t* blocks,
size_t* inodes);
/** @} */
#endif
|
