diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..57bc88a --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/README.md b/README.md index ffa3137..6af9cdd 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,194 @@ -## Setup +

+cyrius +

+ +

+ + CI + + + License + + + DeepWiki + +

+ +Cyrius is a container-focused operating system that runs OCI containers natively, without depending on the Linux kernel. Cyrius treats containers as first-class OS entities and manages their lifecycle and isolation directly. + +For implementation-oriented documentation and code-level explanations, see DeepWiki: +https://deepwiki.com/n4mlz/Cyrius + +## 🧭 Overview + +Linux containers are effective, but the kernel does not treat “container” as a native concept. In many systems, container lifecycle and state are maintained indirectly via user-space bookkeeping. + +Cyrius explores an alternative model: containers are explicit OS-managed objects, and container operations are expressed as container operations. + +## ❓ Why Cyrius + +Cyrius is motivated by practical friction points that appear when containers are represented as “processes with attributes”: + +- Isolation and visibility can rely on cross-subsystem interfaces with subtle dependencies. +- The security model can become difficult to reason about when built from many separate features. +- Container state can become coupled to user-space runtimes keeping critical handles alive. + +Cyrius aims to make the container environment a durable, OS-managed entity rather than an emergent property of a running process. + +## 🧩 Design principles + +1. Containers are first-class OS objects + A container is an explicit entity representing an execution environment. The OS tracks its lifecycle and state. + +2. Environment-first model + Creating an environment and starting a process within it are separate steps (“create then start”). + +3. Minimal host interface, container-native operations + The host-side interface focuses on container management (create/start/stop), avoiding long chains of low-level setup steps. + +4. Compatibility where it matters + Cyrius targets Linux syscall compatibility sufficient for typical container workloads, but does not aim for full Linux feature parity. + +5. Deliberate scope constraints + Cyrius assumes a two-world model (host world and container world) and does not treat nested containers as a primary goal. + +## 🧪 Status and scope + +Cyrius is experimental and under active development. Interfaces and behavior may change. + +Targets: + +- Native execution of OCI bundles (runtime config + root filesystem) +- OS-managed container lifecycle +- A pragmatic subset of Linux syscall compatibility for container workloads + +Non-targets (for now): + +- General-purpose desktop/server usage +- Full parity with all Linux system calls and Linux container-specific features +- Nested containers as a primary design goal + +## 🚀 Quick start + +### Requirements + +Rust toolchain: + +- Rust nightly: `nightly-2025-09-04` +- Components: `rust-src`, `rustfmt`, `clippy`, `llvm-tools-preview` +- Targets: `x86_64-unknown-none`, `x86_64-unknown-uefi` + +Runtime: + +- `qemu-system-x86_64` + +Optional (for preparing OCI bundles on your development machine): + +- `skopeo` +- `umoci` + +### Build and run ```sh -rustup install nightly -rustup component add llvm-tools-preview -rustup target add x86_64-unknown-none +$ cargo xtask run --release ``` -## Usage +## 📦 Running an OCI bundle (example) + +The following example shows a typical flow: + +1. prepare an OCI bundle (BusyBox in this case), and +2. boot Cyrius and run the bundle using the built-in OCI runtime interface. + +### 1) Prepare the bundle (on your development machine) + +This project includes a helper script that creates an OCI bundle. It expects `./mnt` to contain `busybox.tar`. + +``` +$ ./make_bundle.sh +Getting image source signatures +Copying blob 5bfa213ad291 done | +Copying config ff7d91a4de done | +Writing manifest to image destination +``` + +### 2) Boot Cyrius and run the container + +``` +$ cargo xtask run --release +(omitted) +INFO : Jumping to kernel entry point at VirtAddr(0x100000a5d10) +[blk] discovered 1 virtio block device(s) +[net] discovered 1 virtio network device(s) +[vfs] mounted FAT32 at /mnt from virtio-blk0 (1163002 blocks) +[kernel] scheduler started + _____ _ + / ____| (_) + | | _ _ _ __ _ _ _ ___ + | | | | | | '__| | | | / __| + | |___| |_| | | | | |_| \__ \ + \_____|\__, |_| |_|\__,_|___/ + __/ | + |___/ + +[timer] first tick +[web] echo server listening on 0.0.0.0:12345 +[shell] ready; type `help` for command list +``` + +In the Cyrius shell: + +``` +$ ls +d 0 mnt + +$ tar mnt/busybox.tar bundle +$ ls bundle + 3181 config.json +d 0 rootfs + +$ oci-runtime create some_container bundle +container some_container created + +$ oci-runtime state some_container +{"annotations":{"org.opencontainers.image.architecture":"amd64","org.opencontainers.image.author":"","org.opencontainers.image.created":"2024-09-26T21:31:42Z","org.opencontainers.image.exposedPorts":"","org.opencontainers.image.os":"linux","org.opencontainers.image.stopSignal":""},"bundle":"/bundle","id":"some_container","ociVersion":"1.0.0","pid":null,"status":"created"} + +$ oci-runtime start some_container +/ # ls +bin dev etc home proc root sys tmp usr var +/ # uname -a +Linux umoci-default 0.0.1-alpha cyrius x86_64 GNU/Linux +/ # whoami +root +/ # echo "Hello world, from Linux container!" +Hello world, from Linux container! +/ # exit +``` + +## 🛠️ Development + +This repository uses `cargo xtask` to keep build, run, and test workflows consistent. + +Common commands: + +```sh +# Run (release) +$ cargo xtask run --release + +# Test +$ cargo xtask test +``` + +If you are new to this codebase, start with: + +- the top-level build/run workflow (`cargo xtask run`) +- the DeepWiki pages for boot flow, syscall handling, and container lifecycle design + +## 📚 Documentation + +- DeepWiki (implementation-focused): [https://deepwiki.com/n4mlz/Cyrius](https://deepwiki.com/n4mlz/Cyrius) +- Repository Wiki (design notes, higher-level documentation): (add link once published) -- `cargo xtask run`: Builds the kernel and starts QEMU. -- `cargo xtask test`: Builds and runs all tests. -- `cargo xtask test --list`: Displays only the list of test cases. -- `cargo xtask test --name foo`: Runs tests whose names contain `foo` (function name or module name). -- `cargo xtask test --no-run`: Only generates the test binary. +## 📄 License -All commands can be combined with --release. +Cyrius is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details. diff --git a/assets/cyrius.png b/assets/cyrius.png new file mode 100644 index 0000000..cf129a9 Binary files /dev/null and b/assets/cyrius.png differ diff --git a/kernel/src/kernel.rs b/kernel/src/kernel.rs index a279b36..b36ce24 100644 --- a/kernel/src/kernel.rs +++ b/kernel/src/kernel.rs @@ -61,6 +61,15 @@ fn kernel_main(boot_info: &'static mut BootInfo) -> ! { println!("[kernel] scheduler started"); + println!(" _____ _ "); + println!(" / ____| (_) "); + println!(" | | _ _ _ __ _ _ _ ___ "); + println!(" | | | | | | '__| | | | / __|"); + println!(" | |___| |_| | | | | |_| \\__ \\"); + println!(" \\_____|\\__, |_| |_|\\__,_|___/"); + println!(" __/ | "); + println!(" |___/ \n"); + loop { core::hint::spin_loop() }