Welcome to FoolOS
=================

![FoolOS Logo](https://gitweb.softwarefools.com/?p=miguel/fool-os.git;a=blob_plain;f=img/logo.png;hb=HEAD)

Abstract
--------
Welcome to the Home of the worlds most useless operating system.

Quick-start
-----------
Simply boot from the __FoolOS.iso__ in your favourite emulator 
or __dd__ to an USB stick and test on real hardware. 

Features
--------

* Booting with Multiboot (e.g. GRUB 2)
* 32-bit protected mode
* Logging to COM1
* Parsing ACPI (incomplete) and Multiboot Data
* Symmetrical Multiprocessing with LAPIC and IOAPIC
* APIC and PIT Timers
* Seperate GDT and IVT for each CPU
* Paging / Virtual Memory
* Ext2 RAM Disk
* Pipes
* Standard streams (stdin/stdout/stderr)
* Mouse and Keyboard support
* Multi-threading & Multitasking
* Kernel and Userspace Tasks
* CPU Private Memory 
* Support for ELF binaries.
* IRQ Handling Framework
* Finegrained Spinlocks
* Superfast Task Scheduler
* PCI Bus scanning
* Ethernet E1000 PCI Driver
* VESA Framebuffer with fallback to a text-only terminal
* Composite Window Manager
* C-library for Userspace (Newlib)
* Simple Network Stack (ARP, IPv4, ICMP, UDP)
* Simple FoolShell
* Snake Game
* Ships with some useless userspace software

_Please note that most features are only very rudimentary and mostly buggy._

Multiboot
---------
The FoolOS Kernel is following the Multiboot Specification (0.6.96) 
providing a multiboot header and the entry point _start().

This in turn calls the C function kernel_main().

Building
--------

You should at least setup a gcc cross-compiler and setup newlib to
build FoolOS yourself.

GCC CROSS-COMPILER (i686-elf)

    https://wiki.osdev.org/GCC_Cross-Compiler (18 AUG 2018)
    ftp://ftp.fu-berlin.de/unix/languages/gcc/releases/gcc-8.2.0/gcc-8.2.0.tar.gz
    https://sunsite.icm.edu.pl/pub/gnu/binutils/binutils-2.31.1.tar.gz

NEWLIB

    https://wiki.osdev.org/Porting_Newlib (18 AUG 2018)
    ftp://sourceware.org/pub/newlib/newlib-3.0.0.20180802.tar.gz
    https://ftp.gnu.org/gnu/autoconf/autoconf-2.68.tar.gz
    https://ftp.gnu.org/gnu/automake/automake-1.11.6.tar.gz

Supported Platforms
-------------------
__TODO: update/recheck__

FoolOS was/is tested/developed on the following emulators/machines

* bochs 2.6 (try compiled with: ./configure --enable-clgd54xx --enable-a20-pin --enable-debugger --enable-disasm --enable-e1000 --with-x --with-x11 --with-term --enable-smp) (add -lpthread to LIBS in the Makefile!)
* qemu 2.8.1
* qemu 3.0.0
* virtual box
* Acer Aspire 1810TZ (Notebook)
* Q6600 on Asus p5n32-e sli plus (Desktop PC)
* 4790K on Asus z97-pro gamer    (Desktop PC)

Todos
-----

* PRIO: ringbuffers (spinlock on/off, interrupts on/off, read/write blocks of data);
* PRIO: Writing to ext2 RAM-image!!!!
* PRIO: Fix scheduler. use all cpus! / accounting/bookkeppiung x86: tsc /rdtscp? / load bareer / queues?
* PRIO: semaphores/ mutexes
* PRIO: return value / argv / env
* PRIO: create/remove pages on demand (sbrk, stack, load prog)
* PRIO: grow kernel memory!

* PRIO: optimized Mouse & KB processing in seperate task. (Kb all chars and different layouts, arrow keys, ctrl-c etc)

* NETWORKING:   tcp/ip stack/ traceroute / arptables /  sockets! / 
                vbox E1000! (remap) / virtio / NS2000  / ipxe network drivers / laptop acer card

* TODO: check Kernel Stuff Reentrancy? multicpu? interrupt syscall processing? Cleanup syscalls
* TODO: GCC optimizations (break kernel?) / volatile keyword etc?
* TODO: gcc-foolos (Porting (ncurses, gcc, binutils, vim, apache...)

* EXTRA: switch to DMA where possible!?
* EXTRA: Unit Testing
* EXTRA: GUI / Window Manager (update\_rect, etc..) / double buffering /  physical, virtual sizE? virtio ? / Cairo library
                            /forum.osdev.org/viewtopic.php?t=10018&p=64358 / vsync
* EXTRA: qemu tcg , slower other cpus
* EXTRA: Crazy & Funny terminal effects while typing (idea)
* EXTRA: port to arm and berryboot / minicom?

Disclaimer
----------

THIS IS A WORK IN PROGRESS.

This is a simple and useless "operating system", with a very basic set 
of features. It is the fruit of my fundamental explorations of the x86 
architecture and operating system design.

Copyright M.Idziorek <m.i@gmx.at> unless stated otherwise.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, 
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE 
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.