Discuss this project here

BareMetal OS is an exokernel-based operating system crafted entirely in x86-64 assembly and is designed to provide unparalleled levels of flexibility and efficiency. By exposing hardware resources directly to applications, it empowers developers to finely tune and optimize their software for specific tasks. With the exokernel's minimalist design, it minimizes the overhead imposed by traditional operating systems, enabling applications to achieve peak performance. Its x86-64 assembly implementation speaks to its commitment to squeezing every ounce of performance from the hardware, making it a compelling choice for those who demand the utmost control and efficiency from their computing environments.

[!NOTE]

BareMetal OS is under active development. Some physical hardware configurations may not work correctly.

Table of Contents

• Prerequisites
• Components
• Supported hardware
• Initial configuration
• Building the source code
• Installing
  • Installing the system
  • Installing the demos
• Running on a virtual system
  • QEMU
  • QEMU via UEFI
  • QEMU - Second Instance
  • VMware
  • VirtualBox
  • Bochs
• Running on a physical system

Prerequisites

The script in this repo depends on a Debian-based Linux system like Ubuntu or Elementary. macOS is also supported to build and test the OS, as well as the Assembly applications, if you are using Homebrew.

• NASM - Assembly compiler to build the loader and kernel, as well as the apps written in Assembly.
• QEMU - Computer emulator if you plan on running the OS for quick testing.
• GCC - C compiler for building C/C++ applications.
• Git - Version control software for pulling the source code from GitHub.
• mtools - Utilities to access DOS (FAT32) disk images in Unix.

In Linux this can be completed with the following command:

sudo apt install nasm qemu-system-x86 gcc git mtools

In macOS via Homebrew this can be completed with the following command:

brew install nasm qemu gcc git mtools

Components

BareMetal OS consists of several different projects:

• Pure64 - The software loader.
• BareMetal - The kernel.
• Monitor - A simple command line interface.
• BMFS - The BareMetal File System utility.
• BareMetal-Demo - Various demo programs.

Supported Hardware

• CPU
  • Multi-core on 64-bit x86 systems (Intel/AMD)
• Bus
  • PCIe
  • PCI
• Network
  • Virtio-Net
• Storage
  • Virtio-Blk
• HID (Human Interface Devices)
  • PS/2 Keyboard

Initial configuration

git clone https://github.com/ReturnInfinity/BareMetal-OS.git
cd BareMetal-OS
./baremetal.sh setup

baremetal.sh setup automatically runs the build and install functions. Once the setup is complete you can execute baremetal.sh run to verify that everything installed correctly.

Building

./baremetal.sh build

This command builds the boot sector, loader (Pure64), kernel, and simple command line interface (Monitor) to the disk image. If you want to attach your own binary to the end of the kernel you can use ./baremetal.sh build mybinary.bin

Installing

Installing the system

./baremetal.sh install

This command installs the software to the disk image.

Installing the demos

./baremetal.sh demos

This command installs the demo programs to the disk image.

Running on a virtual system

QEMU

./baremetal.sh run

QEMU via UEFI

./baremetal.sh run-uefi

QEMU - Second Instance

./baremetal.sh run-2

Running a cloned second instance is useful for testing network connectivity between QEMU systems.

VMware

./baremetal.sh vmdk

VirtualBox

./baremetal.sh vdi

Notes:

• The VDI script rewrites the disk ID of the VDI file to avoid the disk warning in VirtualBox.
• The Chipset Type for the VirtualBox VM must be ICH9

Bochs

bochs -f bochs.cfg

Notes:

• The bochs.cfg file may need to be adjusted for your usage. It was created for a Linux-based system.
• display_libary is set to use x for X Windows with the GUI Debugger by default. On macOS or Windows you will need to use sdl2 with no additional options.
• The file paths for romimage and vgaromimage will need to be updated if the Bochs BIOS files are in a different location.

Running on a physical system

Booting via BIOS and UEFI is supported. Secure boot in UEFI mode must be disabled since this software isn't signed. You may need to press DEL or F12 on the keyboard on power-up to select the boot drive.

[!IMPORTANT] Booting from a floppy or USB drive works. For BIOS-based floppy boot and UEFI-based USB drive booting there is a RAM drive image loaded that contains the demo programs.

BIOS Floppy

Write the floppy.sys image to your diskette and boot your system with it.

BIOS/UEFI Hard drive or SSD

The baremetal_os.img file is a hybrid disk image and supports both BIOS and UEFI systems. Write the baremetal_os.img image to your disk:

[!CAUTION] Doublecheck that you are writing the disk image to the correct disk

dd if=baremetal_os.img of=/dev/sdc

Once the disk image is written you can install the disk in the system and boot from it.

UEFI USB

Copy the BOOTX64.EFI file to /EFI/BOOT on your USB drive and boot your system from it.

// EOF