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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
use alloc::{collections::BTreeMap, sync::Arc, vec::Vec};
use core::arch::asm;

use bitflags::bitflags;
use lazy_static::lazy_static;
use riscv::register::satp;
use xmas_elf::{program::Type, ElfFile};

use crate::{
    constant::{MEM_LIMIT, PAGE_SIZE, TRAMPOLINE, TRAP_CONTEXT_BASE},
    mem::{
        address::PageRange,
        frame_allocator::{allocate_frame, FrameTracker},
        page_table::{PTEFlags, PageTable, PageTableEntry},
        FrameNumber,
        PageNumber,
        PhysicalAddress,
        VirtualAddress,
    },
    sync::Mutex,
};

#[derive(Copy, Clone, PartialEq, Debug)]
pub enum MapType {
    Identical,
    Framed,
}

bitflags! {
  #[derive(Clone, Copy)]
  pub struct MapPermission: usize {
      const R = 1 << 1;
      const W = 1 << 2;
      const X = 1 << 3;
      const U = 1 << 4;
  }
}

extern "C" {
    fn text_start();
    fn text_end();
    fn rodata_start();
    fn rodata_end();
    fn data_start();
    fn data_end();
    fn bss_stack_start();
    fn bss_end();
    fn kernel_end();
    fn trampoline_start();
}

/// The `PageSegment` struct represents a consecutive range of pages,
/// which are mapped to frames in the same method (`Identical` or `Framed`)
/// and have the same permissions.
#[derive(Clone)]
pub struct PageSegment {
    page_range: PageRange,
    frame_map: BTreeMap<PageNumber, Arc<FrameTracker>>,
    map_type: MapType,
    map_permission: MapPermission,
}

impl PageSegment {
    pub fn new(
        start_address: VirtualAddress,
        end_address: VirtualAddress,
        map_type: MapType,
        map_permission: MapPermission,
    ) -> Self {
        Self {
            page_range: PageRange::new(start_address.floor(), end_address.ceil()),
            frame_map: BTreeMap::new(),
            map_type,
            map_permission,
        }
    }

    pub fn start(&self) -> PageNumber {
        self.page_range.start()
    }

    pub fn end(&self) -> PageNumber {
        self.page_range.end()
    }

    pub fn page_range(&self) -> &PageRange {
        &self.page_range
    }

    pub fn frame_map(&self) -> &BTreeMap<PageNumber, Arc<FrameTracker>> {
        &self.frame_map
    }

    pub fn frame_map_mut(&mut self) -> &mut BTreeMap<PageNumber, Arc<FrameTracker>> {
        &mut self.frame_map
    }

    /// Maps the range of pages represented with `page_range` to frames in the `page_table`.
    pub fn map_range(&mut self, page_table: &mut PageTable) {
        for page_number in self.page_range.iter() {
            self.map_page(page_table, page_number);
        }
    }

    /// Unmaps the range of pages represented with `page_range` from frames in the `page_table`.
    pub fn unmap_range(&mut self, page_table: &mut PageTable) {
        for page_number in self.page_range.iter() {
            self.unmap_page(page_table, page_number);
        }
    }

    /// Maps a page with `page_number` to a frame in the `page_table`.
    pub fn map_page(&mut self, page_table: &mut PageTable, page_number: PageNumber) {
        let frame_number = match self.map_type {
            MapType::Identical => FrameNumber::from(usize::from(page_number)),
            MapType::Framed => {
                let frame = allocate_frame().unwrap();
                let frame_number = frame.frame_number();
                self.frame_map.insert(page_number, Arc::new(frame));
                frame_number
            }
        };

        let pte_flags = PTEFlags::from_bits(self.map_permission.bits()).unwrap();
        page_table.map(page_number, frame_number, pte_flags);
    }

    /// Unmaps a page with `page_number` from a frame in the `page_table`.
    pub fn unmap_page(&mut self, page_table: &mut PageTable, page_number: PageNumber) {
        if self.map_type == MapType::Framed {
            self.frame_map.remove(&page_number);
        }
        page_table.unmap(page_number);
    }

    /// Writes `bytes` to the pages represented with `page_range`.
    pub fn clone_bytes(&mut self, page_table: &mut PageTable, bytes: &[u8]) {
        let mut offset = 0;
        for state in self.page_range.iter() {
            let source = &bytes[offset..bytes.len().min(offset + PAGE_SIZE)];
            let destination = &mut page_table
                .translate_page(state)
                .unwrap()
                .frame_number()
                .as_bytes_mut()[..source.len()];
            destination.clone_from_slice(source);

            offset += PAGE_SIZE;
            if offset >= bytes.len() {
                break;
            }
        }
    }
}

/// The `PageSet` struct represents a collection of related [PageSegment].
pub struct PageSet {
    page_table: PageTable,
    segment_list: Vec<PageSegment>,
}

impl PageSet {
    pub fn new() -> Self {
        Self {
            page_table: PageTable::new(),
            segment_list: Vec::new(),
        }
    }

    pub fn clone_from(page_set: &mut Self) -> Self {
        let mut page_set_clone = Self::new();
        page_set_clone.page_table.map(
            PageNumber::from(VirtualAddress::from(TRAMPOLINE)),
            FrameNumber::from(PhysicalAddress::from(trampoline_start as usize)),
            PTEFlags::R | PTEFlags::W | PTEFlags::X,
        );

        let mut page_mappings = Vec::new();
        for page_segment in page_set.segment_list().iter() {
            let page_segment_clone = page_segment.clone();

            if page_segment_clone.start() >= PageNumber::from(TRAP_CONTEXT_BASE) {
                page_set_clone.push(page_segment_clone, None);
                for page_number in page_segment.page_range().iter() {
                    let source = page_set.translate(page_number).unwrap().frame_number();
                    let destination = page_set_clone
                        .translate(page_number)
                        .unwrap()
                        .frame_number();
                    destination
                        .as_bytes_mut()
                        .clone_from_slice(source.as_bytes());
                }
            } else {
                page_set_clone.push_mapped(page_segment_clone, None);
                for page_number in page_segment.page_range().iter() {
                    let pte = page_set.page_table.translate_page(page_number).unwrap();
                    let frame_number = pte.frame_number();

                    let mut pte_flags = pte.flags();
                    if pte.is_writable() {
                        pte_flags.remove(PTEFlags::W);
                        pte_flags.insert(PTEFlags::COW);
                    }
                    page_mappings.push((page_number, frame_number, pte_flags));
                }
            }
        }

        for (page_number, frame_number, pte_flags) in page_mappings {
            page_set
                .page_table
                .map(page_number, frame_number, pte_flags);
            page_set_clone
                .page_table
                .map(page_number, frame_number, pte_flags);
        }
        page_set_clone
    }

    pub fn init(&self) {
        unsafe {
            satp::write(self.satp());
            asm!("sfence.vma");
        }
    }

    pub fn satp(&self) -> usize {
        self.page_table.satp()
    }

    pub fn translate(&self, page_number: PageNumber) -> Option<PageTableEntry> {
        self.page_table.translate_page(page_number)
    }

    pub fn clone_frame(&mut self, virtual_address: VirtualAddress) -> bool {
        let page_number = PageNumber::from(virtual_address);
        let pte = self.page_table.translate_page(page_number).unwrap();
        if pte.is_cow() {
            if let Some(page_segment) = self.find_segment_mut(virtual_address) {
                let source_frame_tracker = page_segment.frame_map().get(&page_number).unwrap();
                let source_frame = source_frame_tracker.frame_number();
                let mut pte_flags = pte.flags();
                pte_flags.insert(PTEFlags::W);
                pte_flags.remove(PTEFlags::COW);

                if Arc::strong_count(source_frame_tracker) == 1 {
                    self.page_table.map(page_number, source_frame, pte_flags);
                } else {
                    let destination_frame_tracker = allocate_frame().unwrap();
                    let destination_frame = destination_frame_tracker.frame_number();
                    destination_frame
                        .as_bytes_mut()
                        .clone_from_slice(source_frame.as_bytes());
                    page_segment
                        .frame_map_mut()
                        .insert(page_number, Arc::new(destination_frame_tracker));
                    self.page_table
                        .map(page_number, destination_frame, pte_flags);
                }
            }
            true
        } else {
            false
        }
    }

    pub fn push(&mut self, mut segment: PageSegment, bytes: Option<&[u8]>) {
        segment.map_range(&mut self.page_table);
        if let Some(bytes) = bytes {
            segment.clone_bytes(&mut self.page_table, bytes);
        }
        self.segment_list.push(segment);
    }

    pub fn push_mapped(&mut self, mut segment: PageSegment, bytes: Option<&[u8]>) {
        if let Some(bytes) = bytes {
            segment.clone_bytes(&mut self.page_table, bytes);
        }
        self.segment_list.push(segment);
    }

    pub fn segment_list(&self) -> &Vec<PageSegment> {
        &self.segment_list
    }

    pub fn insert_frame(
        &mut self,
        start_address: VirtualAddress,
        end_address: VirtualAddress,
        map_permission: MapPermission,
    ) {
        self.push(
            PageSegment::new(start_address, end_address, MapType::Framed, map_permission),
            None,
        );
    }

    pub fn find_segment_mut(&mut self, address: VirtualAddress) -> Option<&mut PageSegment> {
        self.segment_list.iter_mut().find(|segment| {
            VirtualAddress::from(segment.start()) <= address
                && address < VirtualAddress::from(segment.end())
        })
    }

    /// Removes a [PageSegment] that contains a specific [VirtualAddress].
    pub fn remove_segment(&mut self, address: VirtualAddress) {
        if let Some((index, segment)) =
            self.segment_list
                .iter_mut()
                .enumerate()
                .find(|(_, segment)| {
                    VirtualAddress::from(segment.start()) <= address
                        && address < VirtualAddress::from(segment.end())
                })
        {
            segment.unmap_range(&mut self.page_table);
            self.segment_list.remove(index);
        }
    }

    pub fn from_kernel() -> Self {
        let mut page_set = Self::new();
        page_set.page_table.map(
            PageNumber::from(VirtualAddress::from(TRAMPOLINE)),
            FrameNumber::from(PhysicalAddress::from(trampoline_start as usize)),
            PTEFlags::R | PTEFlags::X,
        );

        page_set.push(
            PageSegment::new(
                VirtualAddress::from(text_start as usize),
                VirtualAddress::from(text_end as usize),
                MapType::Identical,
                MapPermission::R | MapPermission::X,
            ),
            None,
        );

        page_set.push(
            PageSegment::new(
                VirtualAddress::from(rodata_start as usize),
                VirtualAddress::from(rodata_end as usize),
                MapType::Identical,
                MapPermission::R,
            ),
            None,
        );

        page_set.push(
            PageSegment::new(
                VirtualAddress::from(data_start as usize),
                VirtualAddress::from(data_end as usize),
                MapType::Identical,
                MapPermission::R | MapPermission::W,
            ),
            None,
        );

        page_set.push(
            PageSegment::new(
                VirtualAddress::from(bss_stack_start as usize),
                VirtualAddress::from(bss_end as usize),
                MapType::Identical,
                MapPermission::R | MapPermission::W,
            ),
            None,
        );

        page_set.push(
            PageSegment::new(
                VirtualAddress::from(kernel_end as usize),
                VirtualAddress::from(MEM_LIMIT),
                MapType::Identical,
                MapPermission::R | MapPermission::W,
            ),
            None,
        );

        page_set
    }

    pub fn from_elf(elf_data: &[u8]) -> (Self, VirtualAddress, VirtualAddress) {
        let mut page_set = Self::new();
        page_set.page_table.map(
            PageNumber::from(VirtualAddress::from(TRAMPOLINE)),
            FrameNumber::from(PhysicalAddress::from(trampoline_start as usize)),
            PTEFlags::R | PTEFlags::X,
        );

        let elf = ElfFile::new(elf_data).unwrap();
        assert_eq!(
            elf.header.pt1.magic,
            [0x7f, b'E', b'L', b'F'],
            "the ELF is invalid"
        );

        let mut virtual_address_limit = VirtualAddress::from(0);
        for program_header_index in 0..elf.header.pt2.ph_count() {
            let program_header = elf.program_header(program_header_index).unwrap();
            if program_header.get_type().unwrap() == Type::Load {
                let start_address = VirtualAddress::from(program_header.virtual_addr() as usize);
                let end_address = VirtualAddress::from(
                    (program_header.virtual_addr() + program_header.mem_size()) as usize,
                );

                let mut map_permission = MapPermission::U;
                if program_header.flags().is_read() {
                    map_permission |= MapPermission::R;
                }

                if program_header.flags().is_write() {
                    map_permission |= MapPermission::W;
                }

                if program_header.flags().is_execute() {
                    map_permission |= MapPermission::X;
                }

                let page_segment =
                    PageSegment::new(start_address, end_address, MapType::Framed, map_permission);
                virtual_address_limit = VirtualAddress::from(page_segment.end());

                page_set.push(
                    page_segment,
                    Some(
                        &elf.input[program_header.offset() as usize
                            ..(program_header.offset() + program_header.file_size()) as usize],
                    ),
                );
            }
        }

        let user_stack_base = virtual_address_limit + PAGE_SIZE;
        (
            page_set,
            user_stack_base,
            VirtualAddress::from(elf.header.pt2.entry_point() as usize),
        )
    }
}

lazy_static! {
    pub static ref KERNEL_SPACE: Arc<Mutex<PageSet>> = Arc::new(Mutex::new(PageSet::from_kernel()));
}