-
Notifications
You must be signed in to change notification settings - Fork 0
/
labs.lyx~
2064 lines (1452 loc) · 38.1 KB
/
labs.lyx~
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
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#LyX 2.3 created this file. For more info see http://www.lyx.org/
\lyxformat 544
\begin_document
\begin_header
\save_transient_properties true
\origin unavailable
\textclass extbook
\begin_preamble
\usepackage{listings}
\end_preamble
\use_default_options true
\maintain_unincluded_children false
\language english
\language_package default
\inputencoding auto
\fontencoding global
\font_roman "default" "default"
\font_sans "default" "default"
\font_typewriter "default" "default"
\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100 100
\font_tt_scale 100 100
\use_microtype false
\use_dash_ligatures true
\graphics default
\default_output_format default
\output_sync 0
\bibtex_command default
\index_command makeindex
\float_placement H
\paperfontsize default
\spacing single
\use_hyperref true
\pdf_bookmarks true
\pdf_bookmarksnumbered false
\pdf_bookmarksopen false
\pdf_bookmarksopenlevel 1
\pdf_breaklinks false
\pdf_pdfborder false
\pdf_colorlinks false
\pdf_backref false
\pdf_pdfusetitle true
\papersize default
\use_geometry false
\use_package amsmath 1
\use_package amssymb 1
\use_package cancel 1
\use_package esint 1
\use_package mathdots 1
\use_package mathtools 1
\use_package mhchem 1
\use_package stackrel 1
\use_package stmaryrd 1
\use_package undertilde 1
\cite_engine basic
\cite_engine_type default
\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
\justification true
\use_refstyle 1
\use_minted 0
\index Index
\shortcut idx
\color #008000
\end_index
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation default
\is_math_indent 0
\math_numbering_side default
\quotes_style english
\dynamic_quotes 0
\papercolumns 1
\papersides 1
\paperpagestyle default
\listings_params "frame=lines,breaklines=true,columns=fullflexible"
\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict false
\end_header
\begin_body
\begin_layout Title
The guide to ChronOS
\end_layout
\begin_layout Author
Betty Liu u2061245
\end_layout
\begin_layout Standard
\begin_inset CommandInset toc
LatexCommand tableofcontents
\end_inset
\end_layout
\begin_layout Chapter
Introduction to ChronOS
\end_layout
\begin_layout Standard
All code available here
\begin_inset Flex URL
status open
\begin_layout Plain Layout
https://github.com/acyanbird/chronos_labs/
\end_layout
\end_inset
Please see different branch for each stage.
\end_layout
\begin_layout Standard
Writing a lab assignment to create an operating system using Rust as the
programming language:
\end_layout
\begin_layout Standard
\series bold
Lab Assignment:
\series default
Building an Operating System with Rust
\end_layout
\begin_layout Standard
\series bold
Objective:
\series default
In this lab, you will learn to create a simple operating system using the
Rust programming language.
Operating systems are complex pieces of software that manage hardware resources
and provide services to other software applications.
This lab will introduce you to the basics of operating system development,
focusing on the foundational components.
\end_layout
\begin_layout Standard
.
\end_layout
\begin_layout Chapter
Lab 0 - Introduction to Rust Programming languoage
\end_layout
\begin_layout Section
Objectives
\end_layout
\begin_layout Standard
Since this project uses Rust as the programming language, and there are
no specific university courses for it, this lab will introduce you to some
fundamental syntax to help you get started.
However, to master this language, you'll need to continue learning as you
go.
Towards the end, we'll share extra resources for self-study.
\end_layout
\begin_layout Section
Install Rust
\end_layout
\begin_layout Standard
Rustup is used to install and managed Rust.
You can check if your machine is already install Rust by typing rustc --version
in your console.
\end_layout
\begin_layout Standard
If not, for installation on Unix-like machine (e.g.
MacOS, Linux) input this in terminal
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
\end_layout
\end_inset
\end_layout
\begin_layout Standard
For windows users install
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
https://static.rust-lang.org/rustup/dist/i686-pc-windows-gnu/
\end_layout
\begin_layout Plain Layout
rustup-init.exe
\end_layout
\end_inset
\end_layout
\begin_layout Subsection
Integrated Development Environment
\end_layout
\begin_layout Standard
I highly recommend using an IDE for development.
Currently, there are not many IDEs that support Rust.
Here, I recommend Visual Studio Code + rust-analyzer entension or RustRover.
\end_layout
\begin_layout Section
Hello World
\end_layout
\begin_layout Standard
We will use cargo to create the basic framework for the project.
Cargo is Rust’s build system and package manager and it should be installed
by rustup.
You could check it by
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
cargo --version
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Create project by
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
cargo new hello
\end_layout
\begin_layout Plain Layout
cd hello
\end_layout
\end_inset
\end_layout
\begin_layout Standard
It will also generate an empty git repository for version control, and a
cargo.toml that procvie project basic information and dependency.
We could ignore it right now.
The file structure is like:
\end_layout
\begin_layout Standard
\begin_inset Float figure
placement H
wide false
sideways false
status collapsed
\begin_layout Plain Layout
\begin_inset Graphics
filename /home/lucia/Pictures/Screenshots/Screenshot from 2024-01-11 23-19-08.png
\end_inset
\end_layout
\begin_layout Plain Layout
\begin_inset Caption Standard
\begin_layout Plain Layout
project structure
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
Cargo.toml: This is the configuration file for your Rust project.
It contains metadata about the project, such as its name, version, dependencies
, and other settings.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
src/directory: This directory is where you put your source code files.
It contains your project's main code.
You will often have one or more Rust source files (.rs) in this directory.
\end_layout
\begin_layout Labeling
\labelwidthstring 00.00.0000
main.rs: This is the primary entry point for your Rust application.
It typically contains the main function, which is the starting point of
your program.
\end_layout
\begin_layout Standard
The main.rs created by cargo is a simple program that would print Hello,
world! It is similar to C.
To run project use
\series bold
cargo run
\series default
command in terminal.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
fn main() {
\end_layout
\begin_layout Plain Layout
println!("Hello, world!");
\end_layout
\begin_layout Plain Layout
}
\end_layout
\end_inset
\end_layout
\begin_layout Section
Variables
\begin_inset CommandInset label
LatexCommand label
name "sec:Variables"
\end_inset
\end_layout
\begin_layout Standard
\series bold
Variables:
\end_layout
\begin_layout Itemize
Variables in Rust are declared using the let keyword.
\end_layout
\begin_layout Itemize
By default, variables in Rust are immutable, which means their values cannot
be changed once assigned.
To make a variable mutable, you use the mut keyword.
\end_layout
\begin_layout Itemize
You can reassign values to mutable variables, but their types must remain
the same.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
// Declare an immutable integer variable
\end_layout
\begin_layout Plain Layout
let x = 10;
\end_layout
\begin_layout Plain Layout
// Declare a mutable integer variable
\end_layout
\begin_layout Plain Layout
let mut y = 20;
\end_layout
\begin_layout Plain Layout
// Reassign a value to the mutable variable
\end_layout
\begin_layout Plain Layout
y = 30;
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\series bold
Constants:
\end_layout
\begin_layout Itemize
Constants in Rust are declared using the const keyword.
\end_layout
\begin_layout Itemize
Constants must have an explicitly defined type and must have a fixed, compile-ti
me determined value.
\end_layout
\begin_layout Itemize
Conventionally, constants are named using all uppercase letters and underscores
to separate words.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
// Declare an integer constant
\end_layout
\begin_layout Plain Layout
const MAX_VALUE: i32 = 100;
\end_layout
\begin_layout Plain Layout
// Declare a string constant
\end_layout
\begin_layout Plain Layout
const GREETING: &str = "Hello, Rust!";
\end_layout
\end_inset
\end_layout
\begin_layout Section
Attributes
\begin_inset CommandInset label
LatexCommand label
name "sec:Attributes"
\end_inset
\end_layout
\begin_layout Standard
Attributes in Rust are metadata applied to modules, crates, functions, structs,
or other items.
They can instruct the compiler to perform specific tasks or apply certain
properties to the item they annotate.
Attributes can be divided into two main categories: Inner Attributes and
Outer Attributes.
\end_layout
\begin_layout Itemize
Outer Attributes (#[outer_attribute]): Applied to the item that follows
them.
They are used to set attributes or give instructions related to the item
directly below them.
\end_layout
\begin_layout Itemize
Inner Attributes (#![inner_attribute]): Applied to the item they are contained
within.
They are often found at the beginning of source files or modules to configure
or set options for the scope they reside in.
\end_layout
\begin_layout Section
Unsafe Rust
\begin_inset CommandInset label
LatexCommand label
name "sec:Unsafe-Rust"
\end_inset
\end_layout
\begin_layout Standard
\series bold
Tell the compiler I know what I'm doing!
\end_layout
\begin_layout Standard
The unsafe keyword allows you to bypass the language's usual safety checks
and guarantees.
It's used when you need to perform operations that the Rust compiler can't
prove to be safe at compile-time, such as accessing raw pointers, dereferencing
them, or making changes to mutable static variables.
It's a way to tell the Rust compiler that you, the programmer, will ensure
the safety of the code within the unsafe block.
\end_layout
\begin_layout Subsection
External Code
\begin_inset CommandInset label
LatexCommand label
name "subsec:External-Code"
\end_inset
\end_layout
\begin_layout Chapter
Lab 1 - Getting started
\end_layout
\begin_layout Standard
These lab is running and tested on Linux (Debian) only for now.
\end_layout
\begin_layout Section
Expected Outcome
\end_layout
\begin_layout Standard
In this lab, we'll create a Rust program entirely from scratch, free from
any reliance on a host operating system.
Our goal is to develop a minimal 64-bit kernel that can display text using
VGA through QEMU.
Below is the expected output.
\end_layout
\begin_layout Section
Preparation
\end_layout
\begin_layout Itemize
QEMU
\end_layout
\begin_layout Standard
To run the experiment's output, we need to use QEMU.
Here, we won't list the installation steps for QEMU on various operating
systems.
Please visit the official website at
\begin_inset Flex URL
status open
\begin_layout Plain Layout
https://www.qemu.org/download/
\end_layout
\end_inset
to download the appropriate installer and follow the on-screen instructions
for installation.
\end_layout
\begin_layout Itemize
Nightly Rust
\end_layout
\begin_layout Standard
Rust offers various versions, but for operating system development, we require
certain experimental features not available in the stable version.
Thus, we can't use the stable version.
To install Nightly Rust, simply enter the following command in your terminal.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
rustup update nightly
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
bootimage
\end_layout
\begin_layout Standard
This tool assists us in generating files for the virtual machine (QEMU).
To install it, use the following command in your terminal using Cargo.
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
cargo install bootimage
\end_layout
\end_inset
\end_layout
\begin_layout Itemize
llvm-tools-preview
\end_layout
\begin_layout Standard
The llvm-tools-preview is a dependency for the bootimage tool.
You can install it using command
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
rustup component add llvm-tools-preview
\end_layout
\end_inset
\end_layout
\begin_layout Section
Task 1 - Standalone Rust Binary
\end_layout
\begin_layout Subsection
Introduction
\end_layout
\begin_layout Standard
When we create a Rust program, similar to Lab 0, it usually relies on an
existing operating system.
Rust comes with a standard library that depends on the features of that
operating system.
\end_layout
\begin_layout Standard
\begin_inset Float figure
placement H
wide false
sideways false
status collapsed
\begin_layout Plain Layout
\begin_inset Graphics
filename /home/lucia/Pictures/Screenshots/Screenshot from 2024-01-14 23-37-02.png
width 60page%
\end_inset
\end_layout
\begin_layout Plain Layout
\begin_inset Caption Standard
\begin_layout Plain Layout
Common Rust Program
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Standard
But since our goal is to build an operating system from the ground up, we
can't rely on the existing one.
So, we disable the standard library using no_std, and this lets us work
directly with hardware.
\end_layout
\begin_layout Standard
\begin_inset Float figure
placement H
wide false
sideways false
status collapsed
\begin_layout Plain Layout
\begin_inset Graphics
filename /home/lucia/Pictures/Screenshots/Screenshot from 2024-01-15 00-04-29.png
scale 50
\end_inset
\end_layout
\begin_layout Plain Layout
\begin_inset Caption Standard
\begin_layout Plain Layout
Standalone Rust
\end_layout
\end_inset
\end_layout
\begin_layout Plain Layout
\end_layout
\end_inset
\end_layout
\begin_layout Standard
See branch lab-1-1 for the code.
\end_layout
\begin_layout Subsection
Implementation
\end_layout
\begin_layout Standard
\series bold
Step 1: Setup a New Rust Project
\end_layout
\begin_layout Standard
Open a terminal and create a new Rust project by running
\end_layout
\begin_layout Standard
\begin_inset listings
lstparams "language=bash,basicstyle={\small},breaklines=true,showspaces=true"
inline false
status open
\begin_layout Plain Layout
cargo new chronos_lab --bin --edition 2018
\end_layout
\end_inset
This creates a new binary project named chronos_lab.
You could use your own name.
Change into the project directory with
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
cd <your project name>
\end_layout
\end_inset
\end_layout
\begin_layout Standard
\series bold
Step 2: Editing Cargo.toml
\end_layout
\begin_layout Standard
Open the Cargo.toml file in your project's root directory.
\end_layout
\begin_layout Standard
In the initial Cargo.toml file, the [package] section includes predefined
name, version, and edition information.
You can now leave them unchanged.
\end_layout
\begin_layout Standard
Add configurations for development and release profiles to change the panic
strategy to abort, which disables stack unwinding during a panic.
Add these lines at the end of the Cargo.toml file:
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
[profile.dev]
\end_layout
\begin_layout Plain Layout
panic = "abort" # Configures the compiler to abort the program on panic
during development builds.
\end_layout
\begin_layout Plain Layout
[profile.release]
\end_layout
\begin_layout Plain Layout
panic = "abort" # Configures the compiler to abort the program on panic
during release builds.
\end_layout
\end_inset
\end_layout
\begin_layout Standard
Here is the detail explaination of this part:
\end_layout
\begin_layout Itemize
[profile.dev] and [profile.release]: These sections allow you to specify settings
for development (cargo build) and release (cargo build --release) profiles,
respectively.
\end_layout
\begin_layout Itemize
panic = "abort": By default, Rust tries to recover from errors (panics)
by unwinding the program's stack, which can't be done without additional
support.
In this case, we want the program to just stop immediately when an error
happens.
Setting panic = "abort" makes the program do that.
\end_layout
\begin_layout Standard
\series bold
Step 3: Writing the Freestanding Rust Code
\end_layout
\begin_layout Standard
Open the src/main.rs file.
Replace its contents with the following code:
\end_layout
\begin_layout Standard
\begin_inset listings
inline false
status open
\begin_layout Plain Layout
#![no_std] // disable the Rust standard library
\end_layout
\begin_layout Plain Layout
#![no_main] // disable all Rust-level entry points
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
#[no_mangle] // don't mangle the name of this function
\end_layout
\begin_layout Plain Layout
pub extern "C" fn _start() {
\end_layout
\begin_layout Plain Layout
loop {}
\end_layout
\begin_layout Plain Layout
}
\end_layout
\begin_layout Plain Layout
\end_layout
\begin_layout Plain Layout
#[panic_handler] // this function is called on panic
\end_layout
\begin_layout Plain Layout
fn panic(_info: &core::panic::PanicInfo) -> ! {
\end_layout
\begin_layout Plain Layout