├── .cargo └── config.toml ├── .data └── logo.png ├── .github ├── FUNDING.yml └── workflows │ └── rust.yml ├── .gitignore ├── Cargo.toml ├── license ├── readme.md ├── src ├── allocator.rs ├── gdt.rs ├── interrupts.rs ├── lib.rs ├── main.rs ├── memory.rs ├── serial.rs ├── shell.rs └── vga.rs ├── tests ├── basic_boot.rs ├── should_panic.rs └── stack_overflow.rs └── x86_64.json /.cargo/config.toml: -------------------------------------------------------------------------------- 1 | [unstable] 2 | build-std = ["core", "compiler_builtins", "alloc"] 3 | build-std-features = ["compiler-builtins-mem"] 4 | 5 | [build] 6 | target = "x86_64.json" 7 | 8 | [target.'cfg(target_os = "none")'] 9 | runner = "bootimage runner" -------------------------------------------------------------------------------- /.data/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsManjeet/rlxnix-kernel/4017b843b4ead4511826bb0684779888a4c0b4b9/.data/logo.png -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | patreon: itsmanjeet -------------------------------------------------------------------------------- /.github/workflows/rust.yml: -------------------------------------------------------------------------------- 1 | name: Rust 2 | 3 | on: 4 | push: 5 | branches: [ main ] 6 | pull_request: 7 | branches: [ main ] 8 | 9 | env: 10 | CARGO_TERM_COLOR: always 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - uses: actions/checkout@v2 19 | - name: Build 20 | run: cargo build --verbose 21 | - name: Run tests 22 | run: cargo test --verbose 23 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | Cargo.lock -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "rlxos" 3 | version = "0.1.0" 4 | authors = ["itsmanjeet "] 5 | edition = "2018" 6 | 7 | # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html 8 | 9 | [[test]] 10 | name = "should_panic" 11 | harness = false 12 | 13 | [[test]] 14 | name = "stack_overflow" 15 | harness = false 16 | 17 | [dependencies] 18 | bootloader = { version = "0.9.8", features = ["map_physical_memory"] } 19 | volatile = "0.2.6" 20 | spin = "0.5.2" 21 | x86_64 = "0.12.1" 22 | uart_16550 = "0.2.0" 23 | pic8259_simple = "0.2.0" 24 | pc-keyboard = "0.5.0" 25 | linked_list_allocator = "0.8.0" 26 | 27 | [dependencies.lazy_static] 28 | version = "1.0" 29 | features = ["spin_no_std"] 30 | 31 | [package.metadata.bootimage] 32 | test-args = [ 33 | "-device", "isa-debug-exit,iobase=0xf4,iosize=0x04", "-serial", "stdio", 34 | "-display", "none" 35 | ] 36 | test-success-exit-code = 33 -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 20 | [![Contributors][contributors-shield]][contributors-url] 21 | [![Forks][forks-shield]][forks-url] 22 | [![Stargazers][stars-shield]][stars-url] 23 | [![Issues][issues-shield]][issues-url] 24 | [![GPL License][license-shield]][license-url] 25 | ![Rust](https://github.com/itsManjeet/rlxnix/workflows/Rust/badge.svg) 26 | 27 | 28 |
29 |

30 | 31 | Logo 32 | 33 |

34 | An experimental monolithic kernel in rust 35 |
36 | 37 |
38 |
39 | 40 | · 41 | Report Bug 42 | · 43 | Request Feature 44 |

45 |

46 | 47 | 48 | 49 | 50 | ## Table of Contents 51 | 52 | * [Getting Started](#getting-started) 53 | * [Requirements](#requirements) 54 | * [Installation and Testing](#installation-and-testing) 55 | * [Roadmap](#roadmap) 56 | * [Contributing](#contributing) 57 | * [License](#license) 58 | * [Contact](#contact) 59 | 60 | 61 | 62 | 63 | ## Getting Started 64 | 65 | rlxnix is a experimental monolithic kernel written in rust for analyzing and learning the internals of operating system in a memory safe language. 66 | 67 | ### Requirements 68 | 69 | - rust, cargo (testing) 70 | - qemu 71 | 72 | ### Installation and Testing 73 | ```bash 74 | cargo run 75 | ``` 76 | 77 | 78 | 79 | ## Roadmap 80 | 81 | - [x] Target x86_64 82 | - [x] Setup std macros via vga memory (print!,println!) 83 | - [x] Unit testing framework 84 | - [x] Descriptor tables 85 | - [x] IRQ and ISRS 86 | - [x] Implement basic Paging 87 | - [x] Allocator Framework 88 | - [ ] Buddy allocator ?? 89 | - [ ] Multitask Await/Async 90 | - [ ] Virtual filesystem 91 | - [ ] Initrd Support 92 | - [ ] Usermode 93 | - [ ] Switch to ring 0 -> 3 94 | - [ ] Basic syscall support 95 | - [ ] C runtime libraries 96 | - [ ] Modules Support 97 | 98 | 99 | See the [open issues](https://github.com/itsmanjeet/rlxnix/issues) for a list of proposed features (and known issues). 100 | 101 | 102 | 103 | 104 | ## Contributing 105 | 106 | Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. 107 | 108 | 1. Fork the Project 109 | 2. Create your Feature Branch (`git checkout -b 0.1.0`) 110 | 3. Commit your Changes (`git commit -m '[my-id] my awesome Feature'`) 111 | 4. Push to the Branch (`git push origin 0.1.0`) 112 | 5. Open a Pull Request 113 | 114 | 115 | 116 | 117 | ## License 118 | 119 | Distributed under the GPL3 License. See `license` for more information. 120 | 121 | 122 | 123 | 124 | ## Contact 125 | Manjeet Singh - [@releaxos](https://twitter.com/releaxos) - itsmanjeet@releax.in
126 | 127 | [Join](https://discord.gg/TXTxDTYcdg) our discord server for any query 128 | 129 | 130 | ## Acknowledgement 131 | 132 | - [https://os.phil-opp.com/](https://os.phil-opp.com/) 133 | - [blog os](https://github.com/phil-opp/blog_os) 134 | - [osdev](https://osdev.org) 135 | - [JamesM's kernel development](http://www.jamesmolloy.co.uk/tutorial_html/) 136 | 137 | 138 | 139 | [contributors-shield]: https://img.shields.io/github/contributors/itsmanjeet/rlxnix.svg?style=flat-square 140 | [contributors-url]: https://github.com/itsmanjeet/rlxnix/graphs/contributors 141 | [forks-shield]: https://img.shields.io/github/forks/itsmanjeet/rlxnix.svg?style=flat-square 142 | [forks-url]: https://github.com/itsmanjeet/rlxnix/network/members 143 | [stars-shield]: https://img.shields.io/github/stars/itsmanjeet/rlxnix.svg?style=flat-square 144 | [stars-url]: https://github.com/itsmanjeet/rlxnix/stargazers 145 | [issues-shield]: https://img.shields.io/github/issues/itsmanjeet/rlxnix.svg?style=flat-square 146 | [issues-url]: https://github.com/itsmanjeet/rlxnix/issues 147 | [license-shield]: https://img.shields.io/github/license/itsmanjeet/rlxnix.svg?style=flat-square 148 | [license-url]: https://github.com/itsmanjeet/rlxnix/blob/master/license 149 | [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555 150 | -------------------------------------------------------------------------------- /src/allocator.rs: -------------------------------------------------------------------------------- 1 | use alloc::alloc::{GlobalAlloc, Layout}; 2 | use core::ptr::null_mut; 3 | use x86_64::{ 4 | structures::paging::{ 5 | mapper::MapToError, FrameAllocator, 6 | Mapper, 7 | Page, PageTableFlags, Size4KiB, 8 | }, 9 | VirtAddr, 10 | }; 11 | use linked_list_allocator::LockedHeap; 12 | 13 | #[global_allocator] 14 | static ALLOCATOR: LockedHeap = LockedHeap::empty(); 15 | 16 | pub const HEAP_START: usize = 0x_4444_4444_0000; 17 | pub const HEAP_SIZE: usize = 100 * 1024; 18 | 19 | pub struct Dummy; 20 | 21 | unsafe impl GlobalAlloc for Dummy { 22 | unsafe fn alloc(&self, _layout: Layout) -> *mut u8 { 23 | null_mut() 24 | } 25 | 26 | unsafe fn dealloc(&self, _ptr: *mut u8, _layout: Layout) { 27 | panic!("dealloc should be never called") 28 | } 29 | } 30 | 31 | 32 | pub fn initialize( 33 | mapper: &mut impl Mapper, 34 | frame_alloc: &mut impl FrameAllocator, 35 | ) -> Result<(), MapToError> { 36 | let page_range = { 37 | let heap_start = VirtAddr::new(HEAP_START as u64); 38 | let heap_end = heap_start + HEAP_SIZE - 1u64; 39 | let heap_start_page = Page::containing_address(heap_start); 40 | let heap_end_page = Page::containing_address(heap_end); 41 | 42 | Page::range_inclusive(heap_start_page, heap_end_page) 43 | }; 44 | 45 | for page in page_range { 46 | let frame = frame_alloc 47 | .allocate_frame() 48 | .ok_or(MapToError::FrameAllocationFailed)?; 49 | let flags = PageTableFlags::PRESENT | PageTableFlags::WRITABLE; 50 | 51 | unsafe { 52 | mapper.map_to(page, frame, flags, frame_alloc)?.flush() 53 | }; 54 | } 55 | 56 | 57 | unsafe { 58 | ALLOCATOR.lock().init(HEAP_START, HEAP_SIZE); 59 | } 60 | Ok(()) 61 | } 62 | -------------------------------------------------------------------------------- /src/gdt.rs: -------------------------------------------------------------------------------- 1 | use x86_64::VirtAddr; 2 | use x86_64::structures::tss::TaskStateSegment; 3 | use x86_64::structures::gdt::{ 4 | GlobalDescriptorTable, 5 | Descriptor, 6 | SegmentSelector 7 | }; 8 | use lazy_static::lazy_static; 9 | 10 | pub const DOUBLE_FAULT_IST_INDEX: u16 = 0; 11 | 12 | pub fn initialize() { 13 | use x86_64::instructions::segmentation::set_cs; 14 | use x86_64::instructions::tables::load_tss; 15 | 16 | GDT.0.load(); 17 | unsafe { 18 | set_cs(GDT.1.code_selector); 19 | load_tss(GDT.1.tss_selector); 20 | } 21 | } 22 | 23 | struct Selectors { 24 | code_selector: SegmentSelector, 25 | tss_selector: SegmentSelector, 26 | } 27 | 28 | lazy_static! { 29 | static ref TSS: TaskStateSegment = { 30 | let mut tss = TaskStateSegment::new(); 31 | tss.interrupt_stack_table[DOUBLE_FAULT_IST_INDEX as usize] = { 32 | const STACK_SIZE: usize = 4096 * 5; 33 | static mut STACK: [u8; STACK_SIZE] = [0; STACK_SIZE]; 34 | 35 | let stack_start = VirtAddr::from_ptr(unsafe { &STACK}); 36 | let stack_end = stack_start + STACK_SIZE; 37 | stack_end 38 | }; 39 | tss 40 | }; 41 | } 42 | 43 | lazy_static! { 44 | static ref GDT: (GlobalDescriptorTable, Selectors) = { 45 | let mut gdt = GlobalDescriptorTable::new(); 46 | let code_selector = gdt.add_entry(Descriptor::kernel_code_segment()); 47 | let tss_selector = gdt.add_entry(Descriptor::tss_segment(&TSS)); 48 | (gdt, Selectors{ code_selector, tss_selector}) 49 | }; 50 | } 51 | -------------------------------------------------------------------------------- /src/interrupts.rs: -------------------------------------------------------------------------------- 1 | use crate::{ 2 | println, 3 | gdt, 4 | print 5 | }; 6 | use lazy_static::lazy_static; 7 | use x86_64::structures::idt::{ 8 | InterruptDescriptorTable, 9 | InterruptStackFrame 10 | }; 11 | use pic8259_simple::ChainedPics; 12 | use spin; 13 | 14 | use x86_64::structures::idt::PageFaultErrorCode; 15 | use crate::hlt_loop; 16 | 17 | 18 | pub const PIC_1_OFFSET: u8 = 32; 19 | pub const PIC_2_OFFSET: u8 = PIC_1_OFFSET + 8; 20 | 21 | pub static PICS: spin::Mutex = 22 | spin::Mutex::new(unsafe { 23 | ChainedPics::new(PIC_1_OFFSET, PIC_2_OFFSET) 24 | }); 25 | 26 | static mut TICKS: usize = 0; 27 | static mut SUB_TICKS: usize = 0; 28 | 29 | lazy_static! { 30 | static ref IDT: InterruptDescriptorTable = { 31 | let mut idt = InterruptDescriptorTable::new(); 32 | idt.breakpoint.set_handler_fn(breakpoint_handler); 33 | unsafe { 34 | idt.double_fault.set_handler_fn(double_fault_handler) 35 | .set_stack_index(gdt::DOUBLE_FAULT_IST_INDEX); 36 | } 37 | idt[InterruptIndex::Timer.as_usize()] 38 | .set_handler_fn(timer_interrupt_handler); 39 | 40 | idt[InterruptIndex::Keyboard.as_usize()] 41 | .set_handler_fn(keyboard_interrupt_handler); 42 | 43 | idt.page_fault.set_handler_fn(page_fault_handler); 44 | 45 | idt 46 | }; 47 | } 48 | 49 | 50 | pub fn initialize() { 51 | IDT.load(); 52 | } 53 | 54 | extern "x86-interrupt" fn breakpoint_handler(stack_frame: &mut InterruptStackFrame) { 55 | println!("EXCEPTION: Breakpoint\n{:#?}",stack_frame); 56 | } 57 | 58 | extern "x86-interrupt" fn double_fault_handler(stack_frame: &mut InterruptStackFrame, _error_code: u64) -> ! { 59 | panic!("EXCEPTION: DOUBLE FAULT\n{:#?}",stack_frame); 60 | } 61 | 62 | extern "x86-interrupt" fn timer_interrupt_handler(_stack_fram: &mut InterruptStackFrame) { 63 | unsafe { 64 | SUB_TICKS += 1; 65 | if SUB_TICKS == 1000 { 66 | TICKS += 1; 67 | SUB_TICKS = 0; 68 | } 69 | } 70 | 71 | unsafe { 72 | PICS.lock() 73 | .notify_end_of_interrupt(InterruptIndex::Timer.as_u8()); 74 | } 75 | } 76 | 77 | extern "x86-interrupt" fn keyboard_interrupt_handler(_stack_frame: &mut InterruptStackFrame) { 78 | 79 | use pc_keyboard::{ 80 | layouts, 81 | DecodedKey, 82 | HandleControl, 83 | Keyboard, 84 | ScancodeSet1 85 | }; 86 | use x86_64::instructions::port::Port; 87 | use spin::Mutex; 88 | 89 | lazy_static! { 90 | static ref KEYBOARD: Mutex> = 91 | Mutex::new(Keyboard::new(layouts::Us104Key, ScancodeSet1, HandleControl::Ignore)); 92 | } 93 | 94 | let mut keyboard = KEYBOARD.lock(); 95 | let mut port = Port::new(0x60); 96 | 97 | let scancode: u8 = unsafe { port.read() }; 98 | if let Ok(Some(key_event)) = keyboard.add_byte(scancode) { 99 | if let Some(key) = keyboard.process_keyevent(key_event) { 100 | match key { 101 | DecodedKey::Unicode(character) => print!("{}",character), 102 | DecodedKey::RawKey(key) => print!("{:?}",key), 103 | } 104 | } 105 | } 106 | 107 | unsafe { 108 | PICS.lock() 109 | .notify_end_of_interrupt(InterruptIndex::Keyboard.as_u8()); 110 | } 111 | 112 | } 113 | 114 | extern "x86-interrupt" fn page_fault_handler(stack_frame: &mut InterruptStackFrame, error_code: PageFaultErrorCode) { 115 | use x86_64::registers::control::Cr2; 116 | 117 | println!("EXCEPTION: PAGE FAULT"); 118 | println!("Accessed Address: {:?}", Cr2::read()); 119 | println!("Error Code: {:?}",error_code); 120 | println!("{:#?}", stack_frame); 121 | hlt_loop(); 122 | } 123 | 124 | #[test_case] 125 | fn test_breakpoint_exception() { 126 | x86_64::instructions::interrupts::int3(); 127 | } 128 | 129 | #[derive(Debug, Clone, Copy)] 130 | #[repr(u8)] 131 | pub enum InterruptIndex { 132 | Timer = PIC_1_OFFSET, 133 | Keyboard, 134 | } 135 | 136 | impl InterruptIndex { 137 | fn as_u8(self) -> u8 { 138 | self as u8 139 | } 140 | 141 | fn as_usize(self) -> usize { 142 | usize::from(self.as_u8()) 143 | } 144 | } 145 | 146 | 147 | 148 | -------------------------------------------------------------------------------- /src/lib.rs: -------------------------------------------------------------------------------- 1 | #![no_std] 2 | #![cfg_attr(test, no_main)] 3 | #![feature(custom_test_frameworks)] 4 | #![feature(alloc_error_handler)] 5 | #![test_runner(crate::test_runner)] 6 | #![feature(abi_x86_interrupt)] 7 | #![reexport_test_harness_main = "test_main"] 8 | 9 | use core::panic::PanicInfo; 10 | extern crate alloc; 11 | 12 | pub mod serial; 13 | pub mod vga; 14 | pub mod interrupts; 15 | pub mod gdt; 16 | pub mod memory; 17 | pub mod allocator; 18 | 19 | 20 | pub fn initialize() { 21 | gdt::initialize(); 22 | interrupts::initialize(); 23 | 24 | unsafe { 25 | interrupts::PICS.lock().initialize() 26 | }; 27 | 28 | x86_64::instructions::interrupts::enable(); 29 | } 30 | 31 | pub fn hlt_loop() -> ! { 32 | loop { 33 | x86_64::instructions::hlt(); 34 | } 35 | } 36 | 37 | #[alloc_error_handler] 38 | fn alloc_error_handler(layout: alloc::alloc::Layout) -> ! { 39 | panic!("allocation error: {:?}",layout) 40 | } 41 | 42 | pub trait Testable { 43 | fn run(&self) -> (); 44 | } 45 | 46 | impl Testable for T where T: Fn(), { 47 | fn run(&self) { 48 | serial_print!("{}...\t", core::any::type_name::()); 49 | self(); 50 | serial_println!("[pass]"); 51 | } 52 | } 53 | 54 | pub fn test_runner(tests: &[&dyn Testable]) { 55 | serial_println!("Running {} tests", tests.len()); 56 | for test in tests { 57 | test.run(); 58 | } 59 | exit_qemu(QemuExitCode::Success); 60 | } 61 | 62 | pub fn test_panic_handler(info: &PanicInfo) -> ! { 63 | serial_println!("[failed]\n"); 64 | serial_println!("Error: {}\n", info); 65 | exit_qemu(QemuExitCode::Failed); 66 | hlt_loop(); 67 | } 68 | 69 | #[derive(Debug, Clone, Copy, PartialEq, Eq)] 70 | #[repr(u32)] 71 | pub enum QemuExitCode { 72 | Success = 0x10, 73 | Failed = 0x11, 74 | } 75 | 76 | pub fn exit_qemu(exit_code: QemuExitCode) { 77 | use x86_64::instructions::port::Port; 78 | 79 | unsafe { 80 | let mut port = Port::new(0xf4); 81 | port.write(exit_code as u32); 82 | } 83 | } 84 | 85 | /// Entry point for `cargo xtest` 86 | #[cfg(test)] 87 | #[no_mangle] 88 | fn test_kernel_main(_boot_info: &'static BootInfo) -> ! { 89 | initialize(); 90 | test_main(); 91 | hlt_loop(); 92 | } 93 | 94 | #[cfg(test)] 95 | #[panic_handler] 96 | fn panic(info: &PanicInfo) -> ! { 97 | test_panic_handler(info) 98 | } 99 | 100 | #[cfg(test)] 101 | use bootloader::{ 102 | entry_point, 103 | BootInfo, 104 | }; 105 | 106 | #[cfg(test)] 107 | entry_point!(test_kernel_main); 108 | -------------------------------------------------------------------------------- /src/main.rs: -------------------------------------------------------------------------------- 1 | #![no_std] 2 | #![no_main] 3 | #![feature(custom_test_frameworks)] 4 | #![test_runner(rlxos::test_runner)] 5 | #![reexport_test_harness_main = "test_main"] 6 | 7 | extern crate alloc; 8 | 9 | use alloc::boxed::Box; 10 | use rlxos::println; 11 | use core::panic::PanicInfo; 12 | use bootloader::{ 13 | BootInfo, 14 | entry_point, 15 | }; 16 | 17 | 18 | /* 19 | * Entry Point 20 | */ 21 | entry_point!(kernel_main); 22 | 23 | #[no_mangle] 24 | fn kernel_main(boot_info: &'static BootInfo) -> ! { 25 | use rlxos::memory::{self, BootInfoFrameAllocator}; 26 | use x86_64::VirtAddr; 27 | use rlxos::allocator; 28 | 29 | println!("Welcome to rlxos {}","!"); 30 | rlxos::initialize(); 31 | 32 | let phys_addr = VirtAddr::new(boot_info.physical_memory_offset); 33 | let mut mapper = unsafe {memory::initialize(phys_addr)}; 34 | let mut frame_allocator = unsafe { BootInfoFrameAllocator::initialize(&boot_info.memory_map)}; 35 | 36 | allocator::initialize(&mut mapper, &mut frame_allocator) 37 | .expect("Heap initialization failed"); 38 | 39 | let x = Box::new(41); 40 | 41 | #[cfg(test)] 42 | test_main(); 43 | 44 | rlxos::hlt_loop(); 45 | } 46 | 47 | 48 | /* 49 | * Panic Handler 50 | */ 51 | #[cfg(not(test))] 52 | #[panic_handler] 53 | fn panic(info: &PanicInfo) -> ! { 54 | println!("{}", info); 55 | rlxos::hlt_loop(); 56 | } 57 | 58 | 59 | 60 | // Test cased 61 | #[cfg(test)] 62 | #[panic_handler] 63 | fn panic(info: &PanicInfo) -> ! { 64 | rlxos::test_panic_handler(info) 65 | } 66 | 67 | #[test_case] 68 | fn trival_assertion() { 69 | assert_eq!(1, 1); 70 | } -------------------------------------------------------------------------------- /src/memory.rs: -------------------------------------------------------------------------------- 1 | use x86_64::{ 2 | structures::paging::{ 3 | FrameAllocator, 4 | OffsetPageTable, 5 | PageTable, 6 | PhysFrame, 7 | Size4KiB, 8 | }, 9 | VirtAddr, 10 | PhysAddr, 11 | }; 12 | use bootloader::bootinfo::{ 13 | MemoryMap, 14 | MemoryRegionType 15 | }; 16 | 17 | 18 | pub unsafe fn initialize(phy_addr: VirtAddr) -> OffsetPageTable<'static> { 19 | let level_4_table = active_level_4_table(phy_addr); 20 | OffsetPageTable::new(level_4_table, phy_addr) 21 | } 22 | 23 | 24 | unsafe fn active_level_4_table(phys_addr: VirtAddr) -> &'static mut PageTable { 25 | use x86_64::registers::control::Cr3; 26 | 27 | let (level_4_table_frame, _) = Cr3::read(); 28 | 29 | let phy = level_4_table_frame.start_address(); 30 | let virt = phys_addr + phy.as_u64(); 31 | let page_table_ptr: *mut PageTable = virt.as_mut_ptr(); 32 | 33 | &mut *page_table_ptr 34 | } 35 | 36 | pub struct EmptyFrameAllocator; 37 | 38 | unsafe impl FrameAllocator for EmptyFrameAllocator { 39 | fn allocate_frame(&mut self) -> Option { 40 | None 41 | } 42 | } 43 | 44 | pub struct BootInfoFrameAllocator { 45 | memory_map: &'static MemoryMap, 46 | next: usize, 47 | } 48 | 49 | impl BootInfoFrameAllocator { 50 | pub unsafe fn initialize(memory_map: &'static MemoryMap) -> Self { 51 | BootInfoFrameAllocator { 52 | memory_map, 53 | next: 0, 54 | } 55 | } 56 | 57 | fn usable_frames(&self) -> impl Iterator { 58 | let regions = self.memory_map.iter(); 59 | 60 | let usable_regions = regions.filter(|r| r.region_type == MemoryRegionType::Usable); 61 | 62 | let addr_range = usable_regions.map(|r| r.range.start_addr()..r.range.end_addr()); 63 | let frame_addr = addr_range.flat_map(|r| r.step_by(4096)); 64 | 65 | frame_addr.map(|addr| PhysFrame::containing_address(PhysAddr::new(addr))) 66 | } 67 | } 68 | 69 | 70 | unsafe impl FrameAllocator for BootInfoFrameAllocator { 71 | fn allocate_frame(&mut self) -> Option { 72 | let frame = self.usable_frames().nth(self.next); 73 | self.next += 1; 74 | frame 75 | } 76 | } -------------------------------------------------------------------------------- /src/serial.rs: -------------------------------------------------------------------------------- 1 | use lazy_static::lazy_static; 2 | use spin::Mutex; 3 | use uart_16550::SerialPort; 4 | 5 | lazy_static! { 6 | pub static ref SERIAL1: Mutex = { 7 | let mut serial_port = unsafe { 8 | SerialPort::new(0x3F8) 9 | }; 10 | 11 | serial_port.init(); 12 | Mutex::new(serial_port) 13 | }; 14 | } 15 | 16 | #[doc(hidden)] 17 | pub fn _print(args: ::core::fmt::Arguments) { 18 | use core::fmt::Write; 19 | use x86_64::instructions::interrupts; 20 | 21 | interrupts::without_interrupts(|| { 22 | SERIAL1 23 | .lock() 24 | .write_fmt(args) 25 | .expect("Print to serial failed"); 26 | }) 27 | 28 | } 29 | 30 | #[macro_export] 31 | macro_rules! serial_print { 32 | ($($arg:tt)*) => { 33 | $crate::serial::_print(format_args!($($arg)*)); 34 | }; 35 | } 36 | 37 | #[macro_export] 38 | macro_rules! serial_println { 39 | () => ($crate::serial_print!("\n")); 40 | ($fmt:expr) => ($crate::serial_print!(concat!($fmt,"\n"))); 41 | ($fmt:expr, $($arg:tt)*) => ($crate::serial_print!( 42 | concat!($fmt, "\n"), $($arg)* 43 | )); 44 | } -------------------------------------------------------------------------------- /src/shell.rs: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/itsManjeet/rlxnix-kernel/4017b843b4ead4511826bb0684779888a4c0b4b9/src/shell.rs -------------------------------------------------------------------------------- /src/vga.rs: -------------------------------------------------------------------------------- 1 | #[allow(dead_code)] 2 | #[derive(Debug, Clone, Copy, PartialEq, Eq)] 3 | #[repr(u8)] 4 | pub enum Color { 5 | Black = 0, 6 | Blue = 1, 7 | Green = 2, 8 | Cyan = 3, 9 | Red = 4, 10 | Magenta = 5, 11 | Brown = 6, 12 | LightGray = 7, 13 | DarkGray = 8, 14 | LightBlue = 9, 15 | LightGreen = 10, 16 | LightCyan = 11, 17 | LightRed = 12, 18 | Pink = 13, 19 | Yellow = 14, 20 | White = 15, 21 | } 22 | 23 | 24 | const VGA_HEIGHT: usize = 25; 25 | const VGA_WIDTH: usize = 80; 26 | 27 | 28 | use volatile::Volatile; 29 | 30 | #[repr(transparent)] 31 | struct Buffer { 32 | chars: [[Volatile; VGA_WIDTH]; VGA_HEIGHT], 33 | } 34 | 35 | pub struct Vga { 36 | buffer: &'static mut Buffer, 37 | index: usize, 38 | color: u8, 39 | } 40 | 41 | impl Vga { 42 | 43 | pub fn write_byte(&mut self, byte: u8) { 44 | match byte { 45 | b'\n' => self.new_line(), 46 | 47 | byte => { 48 | let x = self.index % VGA_WIDTH; 49 | let y = self.index / VGA_WIDTH; 50 | let color = self.color; 51 | 52 | self.buffer.chars[y][x].write((byte as u16) | (color as u16) << 8); 53 | 54 | self.index += 1; 55 | } 56 | } 57 | } 58 | 59 | fn new_line(&mut self) { 60 | self.index += VGA_WIDTH - (self.index % VGA_WIDTH); 61 | if self.index >= VGA_WIDTH * VGA_HEIGHT { 62 | self.index = 0; 63 | } 64 | } 65 | 66 | pub fn write_string(&mut self, s: &str) { 67 | for byte in s.bytes() { 68 | match byte { 69 | 0x20..=0x7e | b'\n' => self.write_byte(byte), 70 | _ => self.write_byte(0xFE), 71 | } 72 | } 73 | } 74 | } 75 | 76 | 77 | use core::fmt; 78 | 79 | impl fmt::Write for Vga { 80 | fn write_str(&mut self, s: &str) -> fmt::Result { 81 | self.write_string(s); 82 | Ok(()) 83 | } 84 | } 85 | 86 | use lazy_static::lazy_static; 87 | use spin::Mutex; 88 | 89 | lazy_static! { 90 | pub static ref VGA: Mutex = Mutex::new(Vga { 91 | index: 0, 92 | color: (Color::LightGreen as u8) | (Color::Black as u8) << 4, 93 | buffer: unsafe { &mut *(0xB8000 as *mut Buffer) } 94 | }); 95 | } 96 | 97 | 98 | 99 | #[macro_export] 100 | macro_rules! print { 101 | ($($arg:tt)*) => ($crate::vga::_print(format_args!($($arg)*))); 102 | } 103 | 104 | #[macro_export] 105 | macro_rules! println { 106 | () => { $crate::print!("\n")}; 107 | ($($arg:tt)*) => ($crate::print!("{}\n", format_args!($($arg)*))); 108 | } 109 | 110 | #[doc(hidden)] 111 | pub fn _print(args: fmt::Arguments) { 112 | use core::fmt::Write; 113 | use x86_64::instructions::interrupts; 114 | 115 | interrupts::without_interrupts(|| { 116 | VGA.lock().write_fmt(args).unwrap(); 117 | }); 118 | 119 | } 120 | 121 | -------------------------------------------------------------------------------- /tests/basic_boot.rs: -------------------------------------------------------------------------------- 1 | #![no_std] 2 | #![no_main] 3 | #![feature(custom_test_frameworks)] 4 | #![test_runner(rlxos::test_runner)] 5 | #![reexport_test_harness_main = "test_main"] 6 | 7 | use rlxos::println; 8 | use core::panic::PanicInfo; 9 | 10 | #[no_mangle] 11 | pub extern "C" fn _start() -> ! { 12 | test_main(); 13 | 14 | loop {} 15 | } 16 | 17 | #[panic_handler] 18 | fn panic(info: &PanicInfo) -> ! { 19 | rlxos::test_panic_handler(info) 20 | } 21 | 22 | #[test_case] 23 | fn test_println() { 24 | println!("test_println output"); 25 | } -------------------------------------------------------------------------------- /tests/should_panic.rs: -------------------------------------------------------------------------------- 1 | #![no_std] 2 | #![no_main] 3 | 4 | use rlxos::{exit_qemu, serial_print, serial_println, QemuExitCode}; 5 | use core::panic::PanicInfo; 6 | 7 | #[no_mangle] 8 | pub extern "C" fn _start() -> ! { 9 | should_fail(); 10 | serial_println!("[test did not panic]"); 11 | exit_qemu(QemuExitCode::Failed); 12 | loop {} 13 | } 14 | 15 | fn should_fail() { 16 | serial_print!("should_panic::should_fail...\t"); 17 | assert_eq!(0, 1); 18 | } 19 | 20 | #[panic_handler] 21 | fn panic(_info: &PanicInfo) -> ! { 22 | serial_println!("[ok]"); 23 | exit_qemu(QemuExitCode::Success); 24 | loop {} 25 | } -------------------------------------------------------------------------------- /tests/stack_overflow.rs: -------------------------------------------------------------------------------- 1 | #![no_std] 2 | #![no_main] 3 | #![feature(abi_x86_interrupt)] 4 | 5 | use core::panic::PanicInfo; 6 | use rlxos::{ 7 | serial_print, 8 | exit_qemu, 9 | QemuExitCode, 10 | serial_println, 11 | }; 12 | use lazy_static::lazy_static; 13 | use x86_64::structures::idt::{ 14 | InterruptDescriptorTable, 15 | InterruptStackFrame, 16 | }; 17 | 18 | 19 | lazy_static! { 20 | static ref TEST_IDT: InterruptDescriptorTable = { 21 | let mut idt = InterruptDescriptorTable::new(); 22 | unsafe { 23 | idt.double_fault 24 | .set_handler_fn(test_double_fault_handler) 25 | .set_stack_index(rlxos::gdt::DOUBLE_FAULT_IST_INDEX); 26 | } 27 | idt 28 | }; 29 | } 30 | 31 | pub fn init_test_idt() { 32 | TEST_IDT.load(); 33 | } 34 | 35 | #[no_mangle] 36 | pub extern "C" fn _start() -> ! { 37 | serial_print!("stack_overflow::stack_overflow...\t"); 38 | rlxos::gdt::initialize(); 39 | init_test_idt(); 40 | 41 | stack_overflow(); 42 | unimplemented!(); 43 | } 44 | 45 | #[panic_handler] 46 | fn panic(info: &PanicInfo) -> ! { 47 | rlxos::test_panic_handler(info) 48 | } 49 | 50 | #[allow(unconditional_recursion)] 51 | fn stack_overflow() { 52 | stack_overflow(); 53 | volatile::Volatile::new(0).read(); 54 | } 55 | 56 | extern "x86-interrupt" fn test_double_fault_handler(_stack_frame: &mut InterruptStackFrame, _error_code: u64,) -> ! { 57 | serial_println!("[pass]"); 58 | exit_qemu(QemuExitCode::Success); 59 | loop {} 60 | } -------------------------------------------------------------------------------- /x86_64.json: -------------------------------------------------------------------------------- 1 | { 2 | "llvm-target": "x86_64-unknown-none", 3 | "data-layout": "e-m:e-i64:64-f80:128-n8:16:32:64-S128", 4 | "arch": "x86_64", 5 | "target-endian": "little", 6 | "target-pointer-width": "64", 7 | "target-c-int-width": "32", 8 | "os": "none", 9 | "executables": true, 10 | "linker-flavor": "ld.lld", 11 | "linker": "rust-lld", 12 | "panic-strategy": "abort", 13 | "disable-redzone": true, 14 | "features": "-mmx,-sse,+soft-float" 15 | } --------------------------------------------------------------------------------