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
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
mod entry_iter;
use core::fmt::Debug;
use core::mem::{self, MaybeUninit};
use core::slice;
use alloc::rc::Rc;
use super::entryset::{EntryRef, EntrySet};
use super::file::File;
use super::meta::MetaFileDirectory;
use super::metadata::Metadata;
use crate::error::{DataError, Error, ImplementationError, InputError, OperationError};
use crate::file::{FileOptions, TouchOptions, MAX_FILENAME_SIZE};
use crate::fs::SectorRef;
use crate::region::data::entry_type::{EntryType, RawEntryType};
use crate::region::data::entryset::primary::{name_hash, DateTime, FileDirectory};
use crate::region::data::entryset::secondary::{Filename, Secondary, StreamExtension};
use crate::region::data::entryset::{checksum, RawEntry, ENTRY_SIZE};
use crate::sync::acquire;
use crate::types::ClusterID;
use crate::upcase_table::UpcaseTable;
use entry_iter::EntryIter;
pub struct Directory<E: Debug, IO: crate::io::IO<Error = E>> {
pub(crate) meta: MetaFileDirectory<IO>,
pub(crate) upcase_table: Rc<UpcaseTable>,
}
pub enum FileOrDirectory<E: Debug, IO: crate::io::IO<Error = E>> {
File(File<E, IO>),
Directory(Directory<E, IO>),
}
#[cfg_attr(not(feature = "async"), deasync::deasync)]
impl<E: Debug, IO: crate::io::IO<Error = E>> Directory<E, IO> {
async fn walk_matches<F, H, R>(&mut self, f: F, mut h: H) -> Result<Option<R>, Error<E>>
where
F: Fn(&FileDirectory, &Secondary<StreamExtension>) -> bool,
H: FnMut(&EntrySet) -> Option<R>,
{
let mut iter = EntryIter::new(&mut self.meta).await?;
let mut file_directory: FileDirectory;
let mut stream_extension: Secondary<StreamExtension>;
loop {
let entry = match iter.next().await? {
Some(entry) => entry,
None => break,
};
let entry_type: RawEntryType = entry[0].into();
match entry_type.entry_type() {
Ok(EntryType::FileDirectory) => (),
Ok(_) => {
continue;
}
Err(t) => {
warn!("Unexpected entry type {}", t);
return Err(DataError::Metadata.into());
}
};
file_directory = unsafe { mem::transmute(*entry) };
if file_directory.secondary_count < 2 {
return Err(DataError::Metadata.into());
}
let entryset_sector_ref = iter.sector_ref;
let entryset_index = iter.index;
let entry = iter.next().await?.unwrap();
stream_extension = unsafe { mem::transmute(*entry) };
if !f(&file_directory, &stream_extension) {
iter.skip(file_directory.secondary_count - 2).await?;
continue;
}
let array: MaybeUninit<[u16; MAX_FILENAME_SIZE / 2]> = MaybeUninit::uninit();
let mut array: [u16; MAX_FILENAME_SIZE / 2] = unsafe { array.assume_init() };
for i in 0..(file_directory.secondary_count - 1) as usize {
if cfg!(feature = "limit-max-filename-size") && (i + 1) * 15 > array.len() {
continue;
}
let entry: &Filename = unsafe { mem::transmute(iter.next().await?.unwrap()) };
let slice = &unsafe { entry.filename.assume_init_ref() }[..];
array[i * 15..(i + 1) * 15].copy_from_slice(slice);
}
let name_length = stream_extension.custom_defined.name_length as usize;
for i in 0..name_length {
array[i] = u16::from_le(array[i]);
}
let slice = unsafe { slice::from_raw_parts(&array[0], name_length) };
let mut buf: [u8; MAX_FILENAME_SIZE] = unsafe { mem::transmute(array) };
let mut cursor = 0;
for &ch in slice {
let ch = unsafe { char::from_u32_unchecked(ch as u32) };
ch.encode_utf8(&mut buf[cursor..]);
cursor += ch.len_utf8();
}
let entryset = EntrySet {
name_bytes: buf,
name_length: cursor as u8,
file_directory,
stream_extension,
entry_ref: EntryRef::new(entryset_sector_ref, entryset_index as u8),
};
if let Some(retval) = h(&entryset) {
return Ok(Some(retval));
}
}
Ok(None)
}
pub async fn walk<H>(&mut self, mut h: H) -> Result<Option<EntrySet>, Error<E>>
where
H: FnMut(&EntrySet) -> bool,
{
self.walk_matches(
|_, _| true,
|entryset| {
if h(entryset) {
Some(entryset.clone())
} else {
None
}
},
)
.await
}
pub async fn find(&mut self, name: &str) -> Result<Option<EntrySet>, Error<E>> {
let name_length = name.chars().count();
let upcase_table = self.upcase_table.clone();
let hash = name_hash(&self.upcase_table.to_upper(name));
self.walk_matches(
|file_directory, stream_extension| -> bool {
let entry_type = file_directory.entry_type;
if !entry_type.in_use() {
return false;
}
let length = stream_extension.custom_defined.name_length;
let name_hash = stream_extension.custom_defined.name_hash.to_ne();
if length as usize != name_length || name_hash != hash {
return false;
}
true
},
|entryset| {
if upcase_table.equals(name, &entryset.name()) {
Some(entryset.clone())
} else {
None
}
},
)
.await
}
pub async fn touch(&mut self, datetime: DateTime, opts: TouchOptions) -> Result<(), Error<E>> {
self.meta.touch(datetime, opts).await?;
acquire!(self.meta.io).flush().await
}
pub async fn open(&mut self, entryset: &EntrySet) -> Result<FileOrDirectory<E, IO>, Error<E>> {
trace!("Open {} on entry-ref {}", entryset.name(), entryset.entry_ref);
let mut context = acquire!(self.meta.context);
if !context.opened_entries.add(entryset.id(&self.meta.fs_info)) {
return Err(OperationError::AlreadyOpen.into());
}
let cluster_id = entryset.stream_extension.first_cluster.to_ne();
let file_attributes = entryset.file_directory.file_attributes();
let sector_ref = SectorRef::new(cluster_id.into(), 0);
let meta = MetaFileDirectory {
io: self.meta.io.clone(),
context: self.meta.context.clone(),
metadata: Metadata::new(entryset.clone()),
options: FileOptions::default(),
sector_ref,
..self.meta
};
let (length, capacity) = (meta.metadata.length(), meta.metadata.capacity());
trace!("Cluster id {} length {} capacity {}", cluster_id, length, capacity);
if file_attributes.directory() > 0 {
let upcase_table = self.upcase_table.clone();
Ok(FileOrDirectory::Directory(Directory { meta, upcase_table }))
} else {
Ok(FileOrDirectory::File(File::new(meta, sector_ref)))
}
}
async fn lookup_free(&mut self, size: u8) -> Result<(EntryRef, bool), Error<E>> {
let mut best: Option<EntryRef> = None;
let mut best_count = u8::MAX;
let mut candidate = EntryRef::default();
let mut free_count = 0;
let mut sector_ref = self.meta.sector_ref;
let mut skip = 0;
loop {
let mut io = acquire!(self.meta.io);
let sector = io.read(sector_ref.id(&self.meta.fs_info)).await?;
let entries: &[[RawEntry; 16]] = unsafe { mem::transmute(sector) };
for (i, entry) in entries.iter().map(|e| e.iter()).flatten().enumerate() {
if skip > 0 {
skip -= 1;
continue;
}
let entry_type: RawEntryType = entry[0].into();
if entry_type.is_end_of_directory() {
let tail = best.is_none();
return Ok((best.unwrap_or(EntryRef::new(sector_ref, i as u8)), tail));
}
match (free_count == 0, entry_type.in_use()) {
(true, false) => candidate = EntryRef::new(sector_ref, i as u8),
(false, false) => free_count += 1,
(false, true) => {
if free_count >= size && free_count < best_count {
best = Some(candidate);
best_count = free_count;
}
free_count = 0;
}
_ => (),
}
if !entry_type.in_use() {
continue;
}
skip = match entry_type.entry_type() {
Ok(EntryType::FileDirectory) => {
let file_directory: &FileDirectory = unsafe { mem::transmute(entry) };
file_directory.secondary_count
}
Ok(_) => 0,
Err(_) => return Err(DataError::Metadata.into()),
}
}
drop(io);
sector_ref = self.meta.next(sector_ref).await?;
}
}
pub async fn create(&mut self, name: &str, directory: bool) -> Result<(), Error<E>> {
if directory {
return Err(ImplementationError::CreateDirectoryNotSupported.into());
}
trace!("Create file {}", name);
let name_length = name.chars().count();
if name_length > 255 {
return Err(InputError::NameTooLong.into());
}
if self.find(name).await?.is_some() {
return Err(OperationError::AlreadyExists.into());
}
let num_entries = ((name.len() + 14) / 15) as u8 + 2;
let (free_entry_ref, tail) = self.lookup_free(num_entries).await?;
let mut write_entry_ref = free_entry_ref;
let sector_ref = free_entry_ref.sector_ref;
let sector_size = self.meta.fs_info.sector_size() as usize;
let capacity = sector_size / ENTRY_SIZE;
let out_of_capacity = free_entry_ref.index + num_entries + tail as u8 >= capacity as u8;
if out_of_capacity {
let sector_ref = match self.meta.next(sector_ref).await {
Ok(sector_ref) => sector_ref,
Err(Error::Operation(OperationError::EOF)) => {
SectorRef::new(self.meta.allocate(sector_ref.cluster_id).await?, 0)
}
Err(e) => return Err(e),
};
write_entry_ref = EntryRef::new(sector_ref, 0);
}
debug!("Write entryset at entry-ref {}", write_entry_ref);
let hash = name_hash(&self.upcase_table.to_upper(name));
let stream_extension = Secondary::new(StreamExtension::new(name.len() as u8, hash));
let mut file_directory = FileDirectory::new(num_entries - 1, directory);
let sum = checksum(&file_directory, &stream_extension, name);
file_directory.set_checksum = sum.into();
let sector_id = write_entry_ref.sector_ref.id(&self.meta.fs_info);
let offset = write_entry_ref.index as usize * ENTRY_SIZE;
let bytes: &[u8; ENTRY_SIZE] = unsafe { mem::transmute(&file_directory) };
let mut io = acquire!(self.meta.io);
io.write(sector_id, offset, bytes).await?;
let bytes: &[u8; ENTRY_SIZE] = unsafe { mem::transmute(&stream_extension) };
io.write(sector_id, offset + ENTRY_SIZE, bytes).await?;
let mut chars = name.chars();
let mut filename = Filename::default();
for index in 2..(num_entries as usize) {
let buf = unsafe { filename.filename.assume_init_mut() };
for i in 0..15 {
buf[i] = u16::to_le(chars.next().unwrap_or('\0') as u16)
}
let bytes: &[u8; ENTRY_SIZE] = unsafe { mem::transmute(&filename) };
io.write(sector_id, offset + index * ENTRY_SIZE, bytes).await?;
}
if tail {
let offset = offset + (num_entries as usize + 2) * ENTRY_SIZE;
io.write(sector_id, offset, &[0]).await?;
};
if out_of_capacity {
let sector_id = sector_ref.id(&self.meta.fs_info);
let byte: u8 = RawEntryType::new(EntryType::Filename, false).into();
for i in free_entry_ref.index as usize..(sector_size / ENTRY_SIZE) {
io.write(sector_id, i * ENTRY_SIZE, &[byte]).await?;
}
}
io.flush().await
}
pub async fn delete(&mut self, entryset: &EntrySet) -> Result<(), Error<E>> {
debug!("Delete file or directory {} entry-ref {}", entryset.name(), entryset.entry_ref);
let file_or_directory = self.open(entryset).await?;
let meta = match file_or_directory {
FileOrDirectory::Directory(mut directory) => {
if directory.walk(|_| true).await?.is_some() {
#[cfg(all(feature = "async", not(feature = "std")))]
directory.close().await?;
return Err(OperationError::DirectoryNotEmpty.into());
}
directory.meta.metadata.clone()
}
FileOrDirectory::File(file) => file.meta.metadata.clone(),
};
let fs_info = self.meta.fs_info;
let mut sector_id = meta.entry_ref.sector_ref.id(&fs_info);
let secondary_count = meta.file_directory.secondary_count as usize;
let last_index = meta.entry_ref.index as usize + secondary_count;
let sector_size = fs_info.sector_size() as usize;
let next_sector_id = match last_index * ENTRY_SIZE > sector_size {
true => self.meta.next(meta.entry_ref.sector_ref).await?.id(&fs_info),
false => sector_id,
};
let mut offset = meta.entry_ref.index as usize * ENTRY_SIZE;
let mut io = acquire!(self.meta.io);
io.write(sector_id, offset, &[EntryType::FileDirectory.into(); 1]).await?;
offset = (offset + ENTRY_SIZE) % sector_size;
if offset == 0 {
sector_id = next_sector_id;
}
io.write(sector_id, offset, &[EntryType::StreamExtension.into(); 1]).await?;
for _ in 0..(secondary_count - 1) {
offset = (offset + ENTRY_SIZE) % sector_size;
if offset == 0 {
sector_id = next_sector_id;
}
io.write(sector_id, offset, &[EntryType::Filename.into(); 1]).await?;
}
drop(io);
let stream_extension = &meta.stream_extension;
let cluster_id: ClusterID = stream_extension.first_cluster.to_ne().into();
let fat_chain = meta.stream_extension.general_secondary_flags.fat_chain();
if cluster_id.valid() {
let mut context = acquire!(self.meta.context);
context.allocation_bitmap.release(cluster_id, fat_chain).await?;
}
acquire!(self.meta.io).flush().await
}
#[cfg(all(feature = "async", not(feature = "std")))]
pub async fn close(mut self) -> Result<(), Error<E>> {
self.meta.close().await
}
}
#[cfg(any(not(feature = "async"), feature = "std"))]
impl<E: core::fmt::Debug, IO: crate::io::IO<Error = E>> Drop for Directory<E, IO> {
fn drop(&mut self) {
match () {
#[cfg(all(feature = "async", not(feature = "std")))]
() => panic!("Close must be explicit called"),
#[cfg(all(feature = "async", feature = "std"))]
() => async_std::task::block_on(self.meta.close()).unwrap(),
#[cfg(not(feature = "async"))]
() => self.meta.close().unwrap(),
}
}
}