mirror of
https://github.com/genodelabs/genode.git
synced 2025-02-20 17:52:52 +00:00
b723b11b30
This patch equips Sculpt with the ability to customize the system image in very flexible ways. All customizable aspects of the image have been relocated from the former sculpt.run script and the accompanied gems/run/sculpt/ directory to a new location - the sculpt/ directory - which can exist in any repository. The directory at repos/gems/sculpt/ serves as reference. The sculpt directory can host any number of <name>-<board>.sculpt files, each containing a list of ingredients to be incorporated into the Sculpt system image. The <name> can be specified to the sculpt.run script. E.g., the following command refers to the 'default-pc.sculpt' file: make run/sculpt KERNEL=nova BOARD=pc SCULPT=default If no 'SCULPT' argument is supplied, the value 'default' is used. A .sculpt file refers to a selection of files found at various subdirectries named after their respective purpose. In particular, There exists a subdirectory for each file in Sculpt's config fs, like nitpicker, drivers... The .sculpt file selects the alternative to use by a simple tag-value notation. drivers: pc The supported tags are as follows. *Optional* selection of /config files. If not specified, those files are omitted, which prompts Sculpt to manage those configurations automatically or via the Leitzentrale GUI: fonts nic_router event_filter wifi runtime gpu_drv Selection of mandatory /config files. If not specified, the respective 'default' alternative will be used. nitpicker deploy fb_drv clipboard drivers numlock_remap leitzentrale usb system ram_fs Furthermore, the .sculpt file supports the optional selection of supplemental content such as a set of launchers. launches: nano3d system_shell Another type of content are the set of blessed pubkey/download files used for installing and verifying software on target. With the new version, it has become possible to supply a depot with the the system image. The depot content is assembled according to the 'pkg' attributes found in launcher files and the selected deploy config. The resulting depot is incorporated into the system image as 'depot.tar' archive. It can be supplied to the Sculpt system by mounting it into the ram fs as done by the 'ram_fs/depot' configuration for the ram fs. It is possible to add additional boot modules to the system image. There are two options. build: <list of targets> This tag prompts the sculpt.run script to build the specified targets directly using the Genode build system and add the created artifacts into the system image as boot modules. import: <list of depot src or pkg archives> This tag instructs Sculpt to supply the specifid depot-archive content as boot modules to the system image. This change eliminates the need for board-specific pkg/sculpt-<board> archives. The board-specific specializations can now be placed directly into the respective .sculpt files by using 'import:'. To make the use of Sculpt as testbed during development more convenient, the log output of the drivers, leitzentrale, and runtime subsystems can be redirected to core using the optional 'LOG=core' argument, e.g., make run/sculpt KERNEL=linux BOARD=linux LOG=core The former pkg/sculpt-installation and pkg/sculpt-installation-pc archives have been replaced by pkg/sculpt_distribution-pc, which references the generic pkg/sculpt_distribution archive. Those pkgs are solely used for publishing / distribution purposes. Fixes #4369
=================================
Genode Operating System Framework
=================================
This is the source tree of the reference implementation of the Genode OS
architecture. For a general overview about the architecture, please refer to
the project's official website:
:Official project website for the Genode OS Framework:
[https://genode.org/documentation/general-overview]
The current implementation can be compiled for 8 different kernels: Linux,
L4ka::Pistachio, L4/Fiasco, OKL4, NOVA, Fiasco.OC, seL4, and a custom
kernel for running Genode directly on ARM-based hardware. Whereas the Linux
version serves us as development vehicle and enables us to rapidly develop the
generic parts of the system, the actual target platforms of the framework are
microkernels. There is no "perfect" microkernel - and neither should there be
one. If a microkernel pretended to be fit for all use cases, it wouldn't be
"micro". Hence, all microkernels differ in terms of their respective features,
complexity, and supported hardware architectures.
Genode allows the use of each of the kernels listed above with a rich set of
device drivers, protocol stacks, libraries, and applications in a uniform way.
For developers, the framework provides an easy way to target multiple different
kernels instead of tying the development to a particular kernel technology. For
kernel developers, Genode contributes advanced workloads, stress-testing their
kernel, and enabling a variety of application use cases that would not be
possible otherwise. For users and system integrators, it enables the choice of
the kernel that fits best with the requirements at hand for the particular
usage scenario.
Documentation
#############
The primary documentation is the book "Genode Foundations", which is available
on the front page of Genode website:
:Download the book "Genode Foundations":
[https://genode.org]
The book describes Genode in a holistic and comprehensive way. It equips you
with a thorough understanding of the architecture, assists developers with the
explanation of the development environment and system configuration, and
provides a look under the hood of the framework. Furthermore, it contains the
specification of the framework's programming interface.
The project has a quarterly release cycle. Each version is accompanied with
detailed release documentation, which is available at the documentation
section of the project website:
:Release documentation:
[https://genode.org/documentation/release-notes/]
Directory overview
##################
The source tree is composed of the following subdirectories:
:'doc':
This directory contains general documentation along with a comprehensive
collection of release notes.
:'repos':
This directory contains the source code, organized in so-called source-code
repositories. Please refer to the README file in the 'repos' directory to
learn more about the roles of the individual repositories.
:'tool':
Source-code management tools and scripts. Please refer to the README file
contained in the directory.
:'depot':
Directory used by Genode's package-management tools. It contains the public
keys and download locations of software providers.
Additional community-maintained components
##########################################
The components found within the main source tree are complemented by a growing
library of additional software, which can be seamlessly integrated into Genode
system scenarios.
:Genode-world repository:
[https://github.com/genodelabs/genode-world]
Contact
#######
The best way to get in touch with Genode developers and users is the project's
mailing list. Please feel welcome to join in!
:Genode Mailing Lists:
[https://genode.org/community/mailing-lists]
Commercial support
##################
The driving force behind the Genode OS Framework is the German company Genode
Labs. The company offers commercial licensing, trainings, support, and
contracted development work:
:Genode Labs website:
[https://www.genode-labs.com]