springboard 3.0.1

A bootloader that works on both BIOS and UEFI systems.
Documentation 
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


/// Create a FAT filesystem image.
pub fn create_fat_filesystem(
   files: BTreeMap<&str, &FileDataSource>,
   out_fat_path: &Path,
) -> anyhow::Result<()> {
   const MB: u64 = 1024 * 1024;

   // calculate needed size
   let mut needed_size = 0;
   for source in files.values() {
      needed_size += source.len()?;
   }

   // create new filesystem image file at the given path and set its length
   let fat_file = fs::OpenOptions::new()
      .read(true)
      .write(true)
      .create(true)
      .truncate(true)
      .open(out_fat_path)
      .unwrap();
   let fat_size_padded_and_rounded = ((needed_size + 1024 * 64 - 1) / MB + 1) * MB + MB;
   fat_file.set_len(fat_size_padded_and_rounded).unwrap();

   // choose a file system label
   let mut label = *b"MY_RUST_OS!";

   // This __should__ always be a file, but maybe not. Should we allow the caller to set the volume label instead?
   if let Some(FileDataSource::File(path)) = files.get(KERNEL_FILE_NAME) {
      if let Some(name) = path.file_stem() {
         let converted = name.to_string_lossy();
         let name = converted.as_bytes();
         let mut new_label = [0u8; 11];
         let name = &name[..usize::min(new_label.len(), name.len())];
         let slice = &mut new_label[..name.len()];
         slice.copy_from_slice(name);
         label = new_label;
      }
   }

   // format the file system and open it
   let format_options = fatfs::FormatVolumeOptions::new().volume_label(label);
   fatfs::format_volume(&fat_file, format_options).context("Failed to format FAT file")?;
   let filesystem = fatfs::FileSystem::new(&fat_file, fatfs::FsOptions::new())
      .context("Failed to open FAT file system of UEFI FAT file")?;
   let root_dir = filesystem.root_dir();

   // copy files to file system
   add_files_to_image(&root_dir, files)
}

/// Add files to the FAT filesystem image.
pub fn add_files_to_image(
   root_dir: &Dir<&File>,
   files: BTreeMap<&str, &FileDataSource>,
) -> anyhow::Result<()> {
   for (target_path_raw, source) in files {
      let target_path = Path::new(target_path_raw);
      // create parent directories
      let ancestors: Vec<_> = target_path.ancestors().skip(1).collect();
      for ancestor in ancestors.into_iter().rev().skip(1) {
         root_dir
            .create_dir(&ancestor.display().to_string())
            .with_context(|| {
               format!(
                  "failed to create directory `{}` on FAT filesystem",
                  ancestor.display()
               )
            })?;
      }

      let mut new_file = root_dir
         .create_file(target_path_raw)
         .with_context(|| format!("failed to create file at `{}`", target_path.display()))?;
      new_file.truncate().unwrap();

      source.copy_to(&mut new_file).with_context(|| {
         format!(
            "failed to copy source data `{:?}` to file at `{}`",
            source,
            target_path.display()
         )
      })?;
   }

   Ok(())
}

// IMPORTS //

use {
   crate::{
      KERNEL_FILE_NAME,
      file_data_source::FileDataSource,
   },
   anyhow::Context,
   fatfs::Dir,
   std::{
      collections::BTreeMap,
      fs::{self, File},
      path::Path,
   },
};