1 /// 引入Module
2 use crate::include::bindings::bindings::E2BIG;
3 use alloc::{sync::Arc, vec::Vec};
4 use core::{any::Any, fmt::Debug};
5
6 use super::disk_info::Partition;
7
8 /// 该文件定义了 Device 和 BlockDevice 的接口
9 /// Notice 设备错误码使用 Posix 规定的 int32_t 的错误码表示，而不是自己定义错误enum
10
11 // 使用方法:
12 // 假设 blk_dev 是块设备
13 // <blk_dev as Device>::read_at() 调用的是Device的函数
14 // <blk_dev as BlockDevice>::read_at() 调用的是BlockDevice的函数
15
16 /// 定义类型
17 pub type BlockId = usize;
18
19 /// 定义常量
20 const BLK_SIZE_LOG2_LIMIT: u8 = 12; // 设定块设备的块大小不能超过 1 << 12.
21 /// 在DragonOS中，我们认为磁盘的每个LBA大小均为512字节。（注意，文件系统的1个扇区可能事实上是多个LBA）
22 pub const LBA_SIZE: usize = 512;
23
24 /// @brief 设备应该实现的操作
25 /// @usage Device::read_at()
26 pub trait Device: Any + Send + Sync + Debug {
27 /// Notice buffer对应设备按字节划分，使用u8类型
28 /// Notice offset应该从0开始计数
29
30 /// @brief: 从设备的第offset个字节开始，读取len个byte，存放到buf中
31 /// @parameter offset: 起始字节偏移量
32 /// @parameter len: 读取字节的数量
33 /// @parameter buf: 目标数组
34 /// @return: 如果操作成功，返回操作的长度(单位是字节)；否则返回错误码；如果操作异常，但是并没有检查出什么错误，将返回已操作的长度
read_at(&self, offset: usize, len: usize, buf: &mut [u8]) -> Result<usize, i32>35 fn read_at(&self, offset: usize, len: usize, buf: &mut [u8]) -> Result<usize, i32>;
36
37 /// @brief: 从设备的第offset个字节开始，把buf数组的len个byte，写入到设备中
38 /// @parameter offset: 起始字节偏移量
39 /// @parameter len: 读取字节的数量
40 /// @parameter buf: 目标数组
41 /// @return: 如果操作成功，返回操作的长度(单位是字节)；否则返回错误码；如果操作异常，但是并没有检查出什么错误，将返回已操作的长度
write_at(&self, offset: usize, len: usize, buf: &[u8]) -> Result<usize, i32>42 fn write_at(&self, offset: usize, len: usize, buf: &[u8]) -> Result<usize, i32>;
43
44 /// @brief: 同步信息，把所有的dirty数据写回设备 - 待实现
sync(&self) -> Result<(), i32>45 fn sync(&self) -> Result<(), i32>;
46
47 // TODO: 待实现 open, close
48 }
49
50 /// @brief 块设备应该实现的操作
51 pub trait BlockDevice: Any + Send + Sync + Debug {
52 /// @brief: 在块设备中，从第lba_id_start个块开始，读取count个块数据，存放到buf中
53 ///
54 /// @parameter lba_id_start: 起始块
55 /// @parameter count: 读取块的数量
56 /// @parameter buf: 目标数组
57 /// @return: 如果操作成功，返回 Ok(操作的长度) 其中单位是字节；
58 /// 否则返回Err(错误码)，其中错误码为负数；
59 /// 如果操作异常，但是并没有检查出什么错误，将返回Err(已操作的长度)
read_at(&self, lba_id_start: BlockId, count: usize, buf: &mut [u8]) -> Result<usize, i32>60 fn read_at(&self, lba_id_start: BlockId, count: usize, buf: &mut [u8]) -> Result<usize, i32>;
61
62 /// @brief: 在块设备中，从第lba_id_start个块开始，把buf中的count个块数据，存放到设备中
63 /// @parameter lba_id_start: 起始块
64 /// @parameter count: 写入块的数量
65 /// @parameter buf: 目标数组
66 /// @return: 如果操作成功，返回 Ok(操作的长度) 其中单位是字节；
67 /// 否则返回Err(错误码)，其中错误码为负数；
68 /// 如果操作异常，但是并没有检查出什么错误，将返回Err(已操作的长度)
write_at(&self, lba_id_start: BlockId, count: usize, buf: &[u8]) -> Result<usize, i32>69 fn write_at(&self, lba_id_start: BlockId, count: usize, buf: &[u8]) -> Result<usize, i32>;
70
71 /// @brief: 同步磁盘信息，把所有的dirty数据写回硬盘 - 待实现
sync(&self) -> Result<(), i32>72 fn sync(&self) -> Result<(), i32>;
73
74 /// @breif: 每个块设备都必须固定自己块大小，而且该块大小必须是2的幂次
75 /// @return: 返回一个固定量，硬编码(编程的时候固定的常量).
blk_size_log2(&self) -> u876 fn blk_size_log2(&self) -> u8;
77
78 // TODO: 待实现 open, close
79
80 /// @brief 本函数用于实现动态转换。
81 /// 具体的文件系统在实现本函数时，最简单的方式就是：直接返回self
as_any_ref(&self) -> &dyn Any82 fn as_any_ref(&self) -> &dyn Any;
83
84 /// @brief 本函数用于将BlockDevice转换为Device。
85 /// 由于实现了BlockDevice的结构体，本身也实现了Device Trait, 因此转换是可能的。
86 /// 思路：在BlockDevice的结构体中新增一个self_ref变量，返回self_ref.upgrade()即可。
device(&self) -> Arc<dyn Device>87 fn device(&self) -> Arc<dyn Device>;
88
89 /// @brief 返回块设备的块大小（单位：字节）
block_size(&self) -> usize90 fn block_size(&self) -> usize;
91
92 /// @brief 返回当前磁盘上的所有分区的Arc指针数组
partitions(&self) -> Vec<Arc<Partition>>93 fn partitions(&self) -> Vec<Arc<Partition>>;
94 }
95
96 /// 对于所有<块设备>自动实现 Device Trait 的 read_at 和 write_at 函数
97 impl<T: BlockDevice> Device for T {
98 // 读取设备操作，读取设备内部 [offset, offset + buf.len) 区间内的字符，存放到 buf 中
read_at(&self, offset: usize, len: usize, buf: &mut [u8]) -> Result<usize, i32>99 fn read_at(&self, offset: usize, len: usize, buf: &mut [u8]) -> Result<usize, i32> {
100 if len > buf.len() {
101 return Err(-(E2BIG as i32));
102 }
103
104 let iter = BlockIter::new_multiblock(offset, offset + len, self.blk_size_log2());
105 let multi = iter.multiblock;
106
107 // 枚举每一个range
108 for range in iter {
109 let buf_begin = range.origin_begin() - offset; // 本次读操作的起始位置/已经读了这么多字节
110 let buf_end = range.origin_end() - offset;
111 let buf_slice = &mut buf[buf_begin..buf_end];
112 let count: usize = (range.lba_end - range.lba_start).try_into().unwrap();
113 let full = multi && range.is_multi() || !multi && range.is_full();
114
115 if full {
116 // 调用 BlockDevice::read_at() 直接把引用传进去，不是把整个数组move进去
117 BlockDevice::read_at(self, range.lba_start, count, buf_slice)?;
118 } else {
119 // 判断块的长度不能超过最大值
120 if self.blk_size_log2() > BLK_SIZE_LOG2_LIMIT {
121 return Err(-(E2BIG as i32));
122 }
123
124 let mut temp = Vec::new();
125 temp.resize(1usize << self.blk_size_log2(), 0);
126 BlockDevice::read_at(self, range.lba_start, 1, &mut temp[..])?;
127 // 把数据从临时buffer复制到目标buffer
128 buf_slice.copy_from_slice(&temp[range.begin..range.end]);
129 }
130 }
131 return Ok(len);
132 }
133
134 /// 写入设备操作，把 buf 的数据写入到设备内部 [offset, offset + len) 区间内
write_at(&self, offset: usize, len: usize, buf: &[u8]) -> Result<usize, i32>135 fn write_at(&self, offset: usize, len: usize, buf: &[u8]) -> Result<usize, i32> {
136 // assert!(len <= buf.len());
137 if len > buf.len() {
138 return Err(-(E2BIG as i32));
139 }
140
141 let iter = BlockIter::new_multiblock(offset, offset + len, self.blk_size_log2());
142 let multi = iter.multiblock;
143
144 for range in iter {
145 let buf_begin = range.origin_begin() - offset; // 本次读操作的起始位置/已经读了这么多字节
146 let buf_end = range.origin_end() - offset;
147 let buf_slice = &buf[buf_begin..buf_end];
148 let count: usize = (range.lba_end - range.lba_start).try_into().unwrap();
149 let full = multi && range.is_multi() || !multi && range.is_full();
150
151 if full {
152 BlockDevice::write_at(self, range.lba_start, count, buf_slice)?;
153 } else {
154 if self.blk_size_log2() > BLK_SIZE_LOG2_LIMIT {
155 return Err(-(E2BIG as i32));
156 }
157
158 let mut temp = Vec::new();
159 temp.resize(1usize << self.blk_size_log2(), 0);
160 // 由于块设备每次读写都是整块的，在不完整写入之前，必须把不完整的地方补全
161 BlockDevice::read_at(self, range.lba_start, 1, &mut temp[..])?;
162 // 把数据从临时buffer复制到目标buffer
163 temp[range.begin..range.end].copy_from_slice(&buf_slice);
164 BlockDevice::write_at(self, range.lba_start, 1, &temp[..])?;
165 }
166 }
167 return Ok(len);
168 }
169
170 /// 数据同步
sync(&self) -> Result<(), i32>171 fn sync(&self) -> Result<(), i32> {
172 BlockDevice::sync(self)
173 }
174 }
175
176 /// @brief 块设备的迭代器
177 /// @usage 某次操作读/写块设备的[L,R]范围内的字节，
178 /// 那么可以使用此结构体进行迭代遍历，每次调用next()返回一个BlockRange
179 pub struct BlockIter {
180 pub begin: usize, // 迭代器的起始位置 -> 块设备的地址 （单位是字节）
181 pub end: usize,
182 pub blk_size_log2: u8,
183 pub multiblock: bool, // 是否启用连续整块同时遍历
184 }
185
186 /// @brief Range搭配迭代器BlockIter使用，[L,R]区间被分割成多个小的Range
187 /// Range要么是整块，要么是一块的某一部分
188 /// 细节： range = [begin, end) 左闭右开
189 pub struct BlockRange {
190 pub lba_start: usize, // 起始块的lba_id
191 pub lba_end: usize, // 终止块的lba_id
192 pub begin: usize, // 起始位置在块内的偏移量， 如果BlockIter启用Multiblock，则是多个块的偏移量
193 pub end: usize, // 结束位置在块内的偏移量，单位是字节
194 pub blk_size_log2: u8,
195 }
196
197 impl BlockIter {
198 #[allow(dead_code)]
new(start_addr: usize, end_addr: usize, blk_size_log2: u8) -> BlockIter199 pub fn new(start_addr: usize, end_addr: usize, blk_size_log2: u8) -> BlockIter {
200 return BlockIter {
201 begin: start_addr,
202 end: end_addr,
203 blk_size_log2: blk_size_log2,
204 multiblock: false,
205 };
206 }
new_multiblock(start_addr: usize, end_addr: usize, blk_size_log2: u8) -> BlockIter207 pub fn new_multiblock(start_addr: usize, end_addr: usize, blk_size_log2: u8) -> BlockIter {
208 return BlockIter {
209 begin: start_addr,
210 end: end_addr,
211 blk_size_log2: blk_size_log2,
212 multiblock: true,
213 };
214 }
215
216 /// 获取下一个整块或者不完整的块
next_block(&mut self) -> BlockRange217 pub fn next_block(&mut self) -> BlockRange {
218 let blk_size_log2 = self.blk_size_log2;
219 let blk_size = 1usize << self.blk_size_log2;
220 let lba_id = self.begin / blk_size;
221 let begin = self.begin % blk_size;
222 let end = if lba_id == self.end / blk_size {
223 self.end % blk_size
224 } else {
225 blk_size
226 };
227
228 self.begin += end - begin;
229
230 return BlockRange {
231 lba_start: lba_id,
232 lba_end: lba_id + 1,
233 begin: begin,
234 end: end,
235 blk_size_log2: blk_size_log2,
236 };
237 }
238
239 /// 如果能返回多个连续的整块，则返回；否则调用next_block()返回不完整的块
next_multiblock(&mut self) -> BlockRange240 pub fn next_multiblock(&mut self) -> BlockRange {
241 let blk_size_log2 = self.blk_size_log2;
242 let blk_size = 1usize << self.blk_size_log2;
243 let lba_start = self.begin / blk_size;
244 let lba_end = self.end / blk_size;
245
246 // 如果不是整块，先返回非整块的小部分
247 if __bytes_to_lba(self.begin, blk_size)
248 != __bytes_to_lba(self.begin + blk_size - 1, blk_size)
249 || lba_start == lba_end
250 {
251 return self.next_block();
252 }
253
254 let begin = self.begin % blk_size; // 因为是多个整块，这里必然是0
255 let end = __lba_to_bytes(lba_end, blk_size) - self.begin;
256
257 self.begin += end - begin;
258
259 return BlockRange {
260 lba_start: lba_start,
261 lba_end: lba_end,
262 begin: begin,
263 end: end,
264 blk_size_log2: blk_size_log2,
265 };
266 }
267 }
268
269 /// BlockIter 函数实现
270 impl Iterator for BlockIter {
271 type Item = BlockRange;
272
next(&mut self) -> Option<<Self as Iterator>::Item>273 fn next(&mut self) -> Option<<Self as Iterator>::Item> {
274 if self.begin >= self.end {
275 return None;
276 }
277 if self.multiblock {
278 return Some(self.next_multiblock());
279 } else {
280 return Some(self.next_block());
281 }
282 }
283 }
284
285 /// BlockRange 函数实现
286 impl BlockRange {
287 #[allow(dead_code)]
is_empty(&self) -> bool288 pub fn is_empty(&self) -> bool {
289 return self.end == self.begin;
290 }
len(&self) -> usize291 pub fn len(&self) -> usize {
292 return self.end - self.begin;
293 }
294 /// 判断是不是整块
is_full(&self) -> bool295 pub fn is_full(&self) -> bool {
296 return self.len() == (1usize << self.blk_size_log2);
297 }
298 /// 判断是不是多个整块连在一起
is_multi(&self) -> bool299 pub fn is_multi(&self) -> bool {
300 return self.len() >= (1usize << self.blk_size_log2)
301 && (self.len() % (1usize << self.blk_size_log2) == 0);
302 }
303 /// 获取 BlockRange 在块设备内部的起始位置 (单位是字节)
origin_begin(&self) -> usize304 pub fn origin_begin(&self) -> usize {
305 return (self.lba_start << self.blk_size_log2) + self.begin;
306 }
307 /// 获取 BlockRange 在块设备内部的结尾位置 (单位是字节)
origin_end(&self) -> usize308 pub fn origin_end(&self) -> usize {
309 return (self.lba_start << self.blk_size_log2) + self.end;
310 }
311 }
312
313 /// 从字节地址转换到lba id
314 #[inline]
__bytes_to_lba(addr: usize, blk_size: usize) -> BlockId315 pub fn __bytes_to_lba(addr: usize, blk_size: usize) -> BlockId {
316 return addr / blk_size;
317 }
318
319 /// 从lba id转换到字节地址， 返回lba_id的最左侧字节
320 #[inline]
__lba_to_bytes(lba_id: usize, blk_size: usize) -> BlockId321 pub fn __lba_to_bytes(lba_id: usize, blk_size: usize) -> BlockId {
322 return lba_id * blk_size;
323 }
324