sortix-mirror/README
Jonas 'Sortie' Termansen 2ef6804ead Add networking stack.
This change adds all the kernel parts of a network stack. The network stack
is partial but implements many of the important parts.

Add if(4) network interface abstraction. Network interfaces are registered
in a global list that can be iterated and each assigned an unique integer
identifier.

Add reference counted packets with a cache that recycles recent packets.

Add support for lo(4) loopback and ether(4) ethernet network interfaces.
The /dev/lo0 loopback device is created automatically on boot.

Add arp(4) address resolution protocol driver for translation of inet(4)
network layer addresses into ether(4) link layer addresses. arp(4) entries
are cached and evicted from the cache when needed or when the entry has not
been used for a while. The cache is limited to 256 entries for now.

Add ip(4) internet protocol version 4 support. IP fragmentation and options
are not implemented yet.

Add tcp(4) transmission control protocol sockets for a reliable transport
layer protocol that provides a reliable byte stream connection between two
hosts. The implementation is incomplete and does not yet implement out of
band data, options, and high performance extensions.

Add udp(4) user datagram protocol sockets for a connectionless transport
layer that provides best-effort delivery of datagrams.

Add ping(4) sockets for a best-effort delivery of echo datagrams.

Change type of sa_family_t from unsigned short to uint16_t.

Add --disable-network-drivers to the kernel(7) options and expose it with a
bootloader menu. tix-iso-bootconfig can set this option by default.

Import CRC32 code from libz for the Ethernet checksum.

This is a compatible ABI change that adds features to socket(2) (AF_INET,
IPPROTO_TCP, IPPROTO_UDP, IPPROTO_PING), the ioctls for if(4), socket
options, and the lo0 loopback interface.

This commit is based on work by Meisaka Yukara contributed as the commit
bbf7f1e8a5238a2bd1fe8eb1d2cc5c9c2421e2c4. Almost no lines of this work
remains in this final commit as it has been rewritten or refactored away
over the years, see the individual file headers for which files contain
remnants of this work.

Co-authored-by: Meisaka Yukara <Meisaka.Yukara@gmail.com>
2022-12-11 13:40:34 +01:00

47 lines
1.5 KiB
Text

The Sortix Operating System
===========================
Sortix is a small self-hosting operating-system aiming to be a clean and modern
POSIX implementation. It is a hobbyist operating system written from scratch
with its own base system, including kernel and standard library, as well as
ports of third party software. It has a straightforward installer and can be
developed under itself. Releases come with the source code in /src, ready for
tinkering.
It has been in development since 2011 by a single developer and contributors.
Though the system is stable and capable right now, it is still early in
development, and a number of crucial features haven't been made yet. Releases
are made yearly and future releases will add features such as SMP, and USB that
were skipped in favor of becoming self-hosting now.
Documentation
-------------
The system is documented as manual pages. Introductory system usage is covered
in the user-guide(7) manual page.
Links
-----
For more information, please visit the official website:
https://sortix.org/
Building Sortix
---------------
Development of Sortix under itself is covered in development(7).
Development from another operating system is covered in cross-development(7).
You can view the cross-development(7) manual page with this command:
man share/man/man7/cross-development.7
License
-------
Copyright 2011-2016 Jonas 'Sortie' Termansen and contributors.
Sortix is free software licensed under the ISC license as described in the
LICENSE file. It also contains permissively licensed code from other projects.