Go to file
Patrick Meyer 83f88df757 Kernel: Add option to build with coverage instrumentation and KCOV
GCC and Clang allow us to inject a call to a function named
__sanitizer_cov_trace_pc on every edge. This function has to be defined
by us. By noting down the caller in that function we can trace the code
we have encountered during execution. Such information is used by
coverage guided fuzzers like AFL and LibFuzzer to determine if a new
input resulted in a new code path. This makes fuzzing much more
effective.

Additionally this adds a basic KCOV implementation. KCOV is an API that
allows user space to request the kernel to start collecting coverage
information for a given user space thread. Furthermore KCOV then exposes
the collected program counters to user space via a BlockDevice which can
be mmaped from user space.

This work is required to add effective support for fuzzing SerenityOS to
the Syzkaller syscall fuzzer. :^) :^)
2021-07-26 17:40:28 +02:00
.github CI: Skip commit linter line length check on lines that contain URLs 2021-07-23 20:27:12 +04:30
AK AK: Create MACAddress from string 2021-07-25 17:57:08 +02:00
Base Spider: Improve 32x32 icon 2021-07-26 12:41:01 +02:00
Documentation Kernel: Add option to build with coverage instrumentation and KCOV 2021-07-26 17:40:28 +02:00
Kernel Kernel: Add option to build with coverage instrumentation and KCOV 2021-07-26 17:40:28 +02:00
Meta Meta: Don't reboot on triple-fault in CI mode 2021-07-26 02:29:25 +04:30
Ports Toolchain+Ports: Ignore -arch on macOS M1 hosts 2021-07-24 14:04:13 +02:00
Tests AK: Create MACAddress from string 2021-07-25 17:57:08 +02:00
Toolchain Toolchain+Ports: Ignore -arch on macOS M1 hosts 2021-07-24 14:04:13 +02:00
Userland Kernel: Add option to build with coverage instrumentation and KCOV 2021-07-26 17:40:28 +02:00
.clang-format Meta: Update .clang-format to not indent nested namespaces 2020-03-14 10:10:21 +01:00
.gitattributes Meta: Mark the other image file formats as binary in .gitattributes 2021-05-20 08:04:28 +02:00
.gitignore LibWasm+Meta: Implement instantiation/execution primitives in test-wasm 2021-05-21 00:15:23 +01:00
.mailmap Meta: Add my emails to .mailmap 2021-06-30 00:59:23 +04:30
.pre-commit-config.yaml Meta: Add a post-commit commit message linter hook 2021-05-02 16:28:01 +02:00
.prettierignore LibJS: Correct behaviour of direct vs. indirect eval 2021-06-23 09:38:33 +01:00
.prettierrc Meta: Move prettier config files to the root of the repository 2020-08-24 18:21:33 +02:00
CMakeLists.txt Kernel: Add option to build with coverage instrumentation and KCOV 2021-07-26 17:40:28 +02:00
CONTRIBUTING.md Meta: Update CONTRIBUTING.md 2021-07-09 10:18:24 +02:00
LICENSE Everywhere: Use "the SerenityOS developers." in copyright headers 2021-04-29 00:59:26 +02:00
README.md Meta: Add LibIMAP and Mail to the list of libraries and features 2021-07-24 20:11:28 +04:30

SerenityOS

Graphical Unix-like operating system for x86 computers.

Build status Fuzzing Status Discord

About

SerenityOS is a love letter to '90s user interfaces with a custom Unix-like core. It flatters with sincerity by stealing beautiful ideas from various other systems.

Roughly speaking, the goal is a marriage between the aesthetic of late-1990s productivity software and the power-user accessibility of late-2000s *nix. This is a system by us, for us, based on the things we like.

I (Andreas) regularly post raw hacking sessions and demos on my YouTube channel.

Sometimes I write about the system on my github.io blog.

I'm also on Patreon and GitHub Sponsors if you would like to show some support that way.

Screenshot

Screenshot as of 0f85753.png

Kernel features

  • x86 (32-bit) kernel with pre-emptive multi-threading
  • Hardware protections (SMEP, SMAP, UMIP, NX, WP, TSD, ...)
  • IPv4 stack with ARP, TCP, UDP and ICMP protocols
  • ext2 filesystem
  • POSIX signals
  • Purgeable memory
  • /proc filesystem
  • Pseudoterminals (with /dev/pts filesystem)
  • Filesystem notifications
  • CPU and memory profiling
  • SoundBlaster 16 driver
  • VMWare/QEMU mouse integration

System services

  • Launch/session daemon (SystemServer)
  • Compositing window server (WindowServer)
  • Text console manager (TTYServer)
  • DNS client (LookupServer)
  • Network protocols server (RequestServer and WebSocket)
  • Software-mixing sound daemon (AudioServer)
  • Desktop notifications (NotificationServer)
  • HTTP server (WebServer)
  • Telnet server (TelnetServer)
  • DHCP client (DHCPClient)

Libraries

  • C++ templates and containers (AK)
  • Event loop and utilities (LibCore)
  • 2D graphics library (LibGfx)
  • OpenGL 1.x compatible library (LibGL)
  • GUI toolkit (LibGUI)
  • Cross-process communication library (LibIPC)
  • HTML/CSS engine (LibWeb)
  • JavaScript engine (LibJS)
  • Markdown (LibMarkdown)
  • Audio (LibAudio)
  • PCI database (LibPCIDB)
  • Terminal emulation (LibVT)
  • Out-of-process network protocol I/O (LibProtocol)
  • Mathematical functions (LibM)
  • ELF file handling (LibELF)
  • POSIX threading (LibPthread)
  • Higher-level threading (LibThreading)
  • Transport Layer Security (LibTLS)
  • HTTP and HTTPS (LibHTTP)
  • IMAP (LibIMAP)

Userland features

  • Unix-like libc and userland
  • Shell with pipes and I/O redirection
  • On-line help system (both terminal and GUI variants)
  • Web browser (Browser)
  • C++ IDE (HackStudio)
  • IRC client
  • Desktop synthesizer (Piano)
  • E-mail client (Mail)
  • Various desktop apps & games
  • Color themes

How do I read the documentation?

Man pages are available online at man.serenityos.org. These pages are generated from the Markdown source files in Base/usr/share/man and updated automatically.

When running SerenityOS you can use man for the terminal interface, or help for the GUI.

How do I build and run this?

See the SerenityOS build instructions

Before opening an issue

Please see the issue policy.

FAQ: Frequently Asked Questions

Get in touch

Join our Discord server: SerenityOS Discord

Author

Contributors

(And many more!) The people listed above have landed more than 100 commits in the project. :^)

License

SerenityOS is licensed under a 2-clause BSD license.