1. ✏️ In short
2. 🔰 Building
3. 👩‍🏫 Running
4. 💁 Testing
5. ⚖️ License
6. 🔄 Changelog
7. 🐛 Bugs & TODO

Let me tell you a story. This is the story of the Zorglub-33 micro-controller. Well, this is no great story: like all things on Earth, z33 is temporary. Few can say they ended up writting z33 assembly. In fact, at least two newer versions of the z33 came up. But when z34 was announced in a subject paper, it was all over. So let me introduce to you : PH osX! The new and improved architecture design (well, it is based on x86), kernel and (very) basic OS for academic purposes. From basic kernel implementation through vga text buffers, all the way up to paging and multitasking, PH osX has it all.

Of course this is no ordinary code. And this is not just buggy code. You can find and learn more about building an os from scratch in the helper directory or you can read the Wiki.

This project requires a nightly version of Rust because it uses some unstable features. At least nightly 2020-07-15 is required for building. You might need to run rustup update nightly --force to update to the latest nightly even if some components such as rustfmt are missing it.

You can build the project by running:

cargo build

To create a bootable disk image from the compiled kernel, you need to install the bootimage tool:

cargo install bootimage

After installing, you can create the bootable disk image by running:

cargo bootimage

This creates a bootable disk image in the target/x86_64-ph_osx/debug directory.

Please file an issue if you have any problems.

You can run the disk image in QEMU through:

cargo run

QEMU and the bootimage tool need to be installed for this.

You can also write the image to an USB stick for booting it on a real machine. On Linux, the command for this is:

dd if=target/x86_64-ph_osx/debug/bootimage-ph_osx.bin of=/dev/sdX && sync

Where sdX is the device name of your USB stick. Be careful to choose the correct device name, because everything on that device is overwritten.

To run the unit and integration tests, execute cargo xtest.

This project is licensed under the GPL-3.0 new or revised license. Please read the LICENSE file.

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of the PH osX authors nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Please refer to the changelog.md file for the full history.

gantt
    title Posts
    dateFormat YYYY-MM-DD

    section Bare Bones
    A Freestanding Rust Binary : 2022-05-15, 1d
    A Minimal Rust Kernel      : 2d
    VGA Text Mode              : 1d
    Testing                    : 1d

    section Interrupts
    CPU Exceptions      : 2022-05-16, 1d
    Double Faults       : 3d
    Hardware Interrupts : 1d

    section Memory Management
    Introduction to Paging : 2022-05-17, 1d
    Paging Implementation  : 1d
    Heap Allocation        : 1d
    Allocator Designs      : 1d

    section Multitasking
    Async/Await : 2022-05-19, 3d

• cargo clippy --all-targets --all-features -- -D clippy::all (does not apply on no_std targets)
• threads