ToAruOS (とあるOS)

とあるOS (ToaruOS) is a hobby Unix-like operating system. Development began in December of 2010 at the University of Illinois at Urbana-Champaign and is currently a one-man effort. For a short time, the project was the focus of the UIUC SIGOps.

Both the kernel and userspace are included in this repository.

Community

IRC

For discussion, help with building or running the OS, and for up-to-date build verification, please join us in #toaruos on Freenode (irc.freenode.net).

Features

The とある kernel provides a number of standard features, including:

• Processes and threads
  • The kernel supports loading of static ELF binaries
  • Threads are scheduled by the kernel
• Shared memory
• Pipes and TTYs
• Virtual file system
  • /proc implementation similar to Linux
  • /dev entries
  • EXT2 filesystem for disk access
• Signals
  • Delivery is asynchronous from sending
  • Processed immediately during next context switch into receiving process

The included userspace also provides:

• A number of standard Unix utilities
• A graphical interface
  • Composited window manager
  • Limited widget toolkit
• Terminal emulator
  • Some xterm compatibility, support for 256 color palette, etc.
  • Anti-aliased text with FreeType
  • General support for UTF-8

Third-Party Software

とあるOS makes use of the following third-party libraries in userspace applications:

• libpng - Used extensively by the native graphics library to provide wallpaper and icons.
• zlib - Dependency of libpng, but also generally useful.
• freetype - For rendering text
• cairo and pixman - For accelerated and managed graphics.

Additionally, a number of third-party software packages have been ported to とあるOS, but are not included in this distribution:

• Lua - Builds as-is
• MuPDF - See klange/toaru-pdfviewer (library must be cross compiled)
• Vim - Port completed in March of 2013

Screenshots

Here's what とあるOS looks like:

(http://i.imgur.com/uG1HFbq.png)

Here's what とあるOS has looked like in the past:

• Old, simple GUI decorationt heme
• Running a Cairo demo
• With multiple transparent terminals
• A terminal and the native editor
• Running the native editor in a full-screen terminal
• Fully userspace shell, demonstrating a threading application
• Logging in and moving around
• Booting up the (WIP) graphical interface
• Nyaning
• Demoing multitasking
• Empty kernel shell
• With a wallpaper and mouse cursor
• Running some GNU apps
• Playing a simple RPG
• Generating Julia fractals
• Early boot screen testing and some old serial output

Testing it Out

From some Linux hosts (Ubuntu/Debian, Fedora), you can clone the repository and run:

./build.sh

This will install the required dependencies, build the userspace libraries and toolchain, build the kernel, and give you a hard disk image.

You can then run make run or make kvm to run QEMU. An additional make run-config command is available that allows easy customization of the emulation environment through a config file (.config, see util/config-parser for available options).

While we only officially support QEMU, other environments - including actual hardware - should work given the appropriate tools. If you are eager to try とあるOS from a real machine, please use GRUB 2 and ensure that you provide the correct graphics payload options. You may find a sample GRUB configuration the image-builder directory.

User Accounts

The default root password is toor. There is also a regular user local with password local. While general system security is lacking, most system-modifying calls to the kernel require root privileges. When booting directly to a graphical terminal, the system will run in single-user mode and automatically log in as root. When running in graphical or VGA-terminal mode, a login screen is presented.

Cygwin

With some work, とあるOS is also known to build successfully under cygwin. Instructions are forthcoming.

Making modifications

If you have made modifications to the kernel or userspace, make will suffice to build a new image and kernel. build.sh should only be used once when first cloning. If you have made modifications to the system call bindings for newlib, run rebuild-newlib.sh from the toolchain directory, then rebuild userspace applications as necessray.

Prebuilt Images

Unfortunately, we are no longer able to host prebuilt images through GitHub. We are exploring other options for distributing pre-built images and are also working to provide an ISO distribution.

Building an Image for VirtualBox, etc.

An experimental, unsupported image building tool that will produce a "production-ready" image, including GRUB 2, is provided in the image-builder directory. The script, create-image.sh, must be run as root and will produce a 1GB raw disk image which be converted to other formats as needed.

Troubleshooting

If you have any issues at all while attempting to build とあるOS, or you would like help building on an unsupported platform, please join us on IRC (#toaruos@irc.freenode.net). Problems encountered while using the build scripts in an unsupported environment will not be considered bugs until thoroughly examined.

Dependencies

Kernel

To build the kernel, you will need yasm, clang, and GNU ld (which you undoubtedly have if you have clang or gcc).

Hard disks

You will need genext2fs to generate the EXT2 images for the hard disk drive.

Userspace

A toolchain is provided and can be built through build.sh; this script should be able to install its own dependencies on Ubuntu/Debian and Fedora. Other environments are not supported, but examination for the script should provide a reference point on what packages are necessary.

References

Here are some tutorials we found useful early on:

• James M's kernel development tutorials
• Bran's Kernel Development Tutorial
• Skelix's OS tutorial

Licenses

ToAruOS Itself

This project is released under the terms of the University of Illinois / NCSA Open Source License, an OSI- and FSF-approved, GPL-compatible open source license. The NCSA License is a derivative of the MIT license and the BSD license; it is reproduced here for your convenience:

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to
deal with the Software without restriction, including without limitation the
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
  1. Redistributions of source code must retain the above copyright notice,
     this list of conditions and the following disclaimers.
  2. Redistributions in binary form must reproduce the above copyright
     notice, this list of conditions and the following disclaimers in the
     documentation and/or other materials provided with the distribution.
  3. Neither the names of the ToAruOS Kernel Development Team, Kevin Lange,
     nor the names of its contributors may be used to endorse
     or promote products derived from this Software without specific prior
     written permission.

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 NONINFRINGEMENT.  IN NO EVENT SHALL THE
CONTRIBUTORS 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
WITH THE SOFTWARE.

Additional Licenses

ToAruOS contains additional software with the following copyright notices:

• The CPU detection code provided in userspace/cpudet.c carries the following copyright notice, and has been made available by its author for use in other projects: Copyright (c) 2006-2007 - http://brynet.biz.tm - brynet@gmail.com

• A copy of the VL Gothic TrueType font is included in this repository; VL Gothic is distributed under the following license:

    Copyright (c) 1990-2003 Wada Laboratory, the University of Tokyo.
    Copyright (c) 2003-2004 Electronic Font Open Laboratory (/efont/).
    Copyright (C) 2002-2010 M+ FONTS PROJECT Copyright (C) 2006-2010
    Daisuke SUZUKI .  Copyright (C) 2006-2010 Project Vine .  All rights
    reserved.
  
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions are
    met:
    1. Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.
    2. 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.
    3. Neither the name of the Wada Laboratory, the University of Tokyo 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 WADA LABORATORY, THE UNIVERSITY OF TOKYO
    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 LABORATORY 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.
  

• As of January 23, 2012, the repository also contains the DejaVu fonts package, which is a set of public-domain modifications of the Bitstream Vera font set, which is released under this license:

    Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. Bitstream
    Vera is a trademark of Bitstream, Inc.
  
    Permission is hereby granted, free of charge, to any person obtaining a
    copy of the fonts accompanying this license ("Fonts") and associated
    documentation files (the "Font Software"), to reproduce and distribute
    the Font Software, including without limitation the rights to use,
    copy, merge, publish, distribute, and/or sell copies of the Font
    Software, and to permit persons to whom the Font Software is furnished
    to do so, subject to the following conditions:
  
    The above copyright and trademark notices and this permission notice
    shall be included in all copies of one or more of the Font Software
    typefaces.
  
    The Font Software may be modified, altered, or added to, and in
    particular the designs of glyphs or characters in the Fonts may be
    modified and additional glyphs or characters may be added to the Fonts,
    only if the fonts are renamed to names not containing either the words
    "Bitstream" or the word "Vera".
  
    This License becomes null and void to the extent applicable to Fonts or
    Font Software that has been modified and is distributed under the
    "Bitstream Vera" names.
  
    The Font Software may be sold as part of a larger software package but
    no copy of one or more of the Font Software typefaces may be sold by
    itself.
  
    THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
    OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL
    BITSTREAM OR THE GNOME FOUNDATION BE LIABLE FOR ANY CLAIM, DAMAGES OR
    OTHER LIABILITY, INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL,
    OR CONSEQUENTIAL DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR
    OTHERWISE, ARISING FROM, OUT OF THE USE OR INABILITY TO USE THE FONT
    SOFTWARE OR FROM OTHER DEALINGS IN THE FONT SOFTWARE.
  
    Except as contained in this notice, the names of Gnome, the Gnome
    Foundation, and Bitstream Inc., shall not be used in advertising or
    otherwise to promote the sale, use or other dealings in this Font
    Software without prior written authorization from the Gnome Foundation
    or Bitstream Inc., respectively. For further information, contact:
    fonts at gnome dot org.
  

• The included SHA512 support library (userspace/lib/sha2.{c,h}) is provided under the BSD license as follows:

    Copyright (c) 2000-2001, Aaron D. Gifford
    All rights reserved.
  
    Redistribution and use in source and binary forms, with or without
    modification, are permitted provided that the following conditions
    are met:
    1. Redistributions of source code must retain the above copyright
       notice, this list of conditions and the following disclaimer.
    2. 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.
    3. Neither the name of the copyright holder nor the names of contributors
       may be used to endorse or promote products derived from this software
       without specific prior written permission.
  
    THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTOR(S) ``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 AUTHOR OR CONTRIBUTOR(S) 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.
  

• The DMZ mouse cursor theme is licensed under the Creative Commons Attribution-ShareAlike 3.0 license with the following copyright notice:

    Copyright © 2007-2010 Novell, Inc.
  

• Bjoern Hoehrmann's super-simple UTF8 decoder is included for use in userspace applications and is provided under the following license:

    Copyright (c) 2008-2009 Bjoern Hoehrmann <bjoern@hoehrmann.de>
  
    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal in
    the Software without restriction, including without limitation the rights to
    use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
    the Software, and to permit persons to whom the Software is furnished to do so,
    subject to the following conditions:
  
    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.
  
    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 NONINFRINGEMENT. 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.
  

• userspace/lib/wcwidth.c is an implementation of the wcwidth() and wcswidth() C functions by Markus Kuhn herein used to replace the faulty implementation from newlib; it is provided with the following license:

    Markus Kuhn -- 2007-05-26 (Unicode 5.0)
  
    Permission to use, copy, modify, and distribute this software
    for any purpose and without fee is hereby granted. The author
    disclaims all warranties with regard to this software.
  
    Latest version: http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
  

• The code to perform a Gaussian blur on a graphics context (part of userspace/lib/graphics.c) comes from sample code for Cairo and carries the following license, which is forward compatible with the NCSA license:

    Copyright © 2008 Kristian Høgsberg
    Copyright © 2009 Chris Wilson
  
    Permission to use, copy, modify, distribute, and sell this software and its
    documentation for any purpose is hereby granted without fee, provided that
    the above copyright notice appear in all copies and that both that copyright
    notice and this permission notice appear in supporting documentation, and
    that the name of the copyright holders not be used in advertising or
    publicity pertaining to distribution of the software without specific,
    written prior permission.  The copyright holders make no representations
    about the suitability of this software for any purpose.  It is provided "as
    is" without express or implied warranty.
  
    THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
    EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
    OF THIS SOFTWARE.
  

• Build scripts will retrieve copies of GCC, Newlib, FreeType, libpng, zlib, and Cairo. Patches for these software packages are provided under the same license as the package they are for.