IncludeOS

SertakanOS

IncludeOS adalah sistem operasi unikernel minimal yang disertakan untuk layanan C++ yang berjalan di cloud dan di HW nyata. Memulai program dengan #include <os> benar-benar akan memasukkan sistem operasi kecil ke dalam layanan Anda selama waktu tautan.

IncludeOS adalah perangkat lunak gratis, dengan "tidak ada jaminan atau batasan apa pun".

Catatan: IncludeOS sedang dalam pengembangan aktif. API publik tidak boleh dianggap stabil.

Fitur utama

• Jejak memori ekstrem : Server web 64-bit minimal yang dapat di-boot, termasuk komponen sistem operasi dan apa pun yang diperlukan dari pustaka standar C/C++ saat ini berukuran 2,5 MB.
• Dukungan KVM, VirtualBox dan VMWare dengan virtualisasi penuh, menggunakan virtualisasi perangkat keras x86, tersedia di sebagian besar CPU x86 modern. IncludeOS akan berjalan pada platform perangkat keras x86 apa pun, bahkan pada komputer fisik x86, dengan driver yang sesuai. Secara resmi, kami mengembangkan dan menguji di Linux KVM, dan VMWare ESXi/Fusion yang berarti Anda dapat menjalankan layanan IncludeOS di Linux, Microsoft Windows dan macOS, serta pada penyedia cloud seperti Google Compute Engine, OpenStack, dan VMWare vcloud .
• Boot instan: IncludeOS pada Qemu/kvm melakukan booting dalam waktu sekitar 300 mdtk tetapi IBM Research juga telah mengintegrasikan IncludeOS dengan Solo5/uKVM, memberikan waktu booting serendah 10 milidetik.
• Dukungan C++ modern
  • Dukungan penuh bahasa C++11/14/17/20 dengan clang 18 dan yang lebih baru.
  • Pustaka C++ standar (STL) libc++ dari LLVM.
  • Pengecualian dan pelepasan tumpukan (saat ini menggunakan libgcc).
  • Catatan: Fitur bahasa tertentu, seperti thread dan aliran file saat ini tidak memiliki dukungan backend tetapi sedang dikerjakan.
• Pustaka C standar menggunakan musl libc.
• Driver Jaringan Virtio dan vmxnet3 dengan DMA. Virtio menyediakan virtualisasi I/O yang sangat efisien dan didukung secara luas. vmxnet3 setara dengan VMWare.
• Tumpukan TCP/IP yang sangat modular .

Daftar fitur dan batasan yang lebih panjang dapat ditemukan di situs dokumentasi kami.

Isi

• Memulai
  • Ketergantungan
  • Halo dunia
  • Pengembangan kernel
  • Menjalankan tes
• Berkontribusi pada IncludeOS
• Pedoman C++
• Kontak keamanan

Memulai

Ketergantungan

Untuk membangun dan mem-boot layanan IncludeOS Anda memerlukan nix dan Linux. Nix akan secara otomatis mengunduh dan mengatur versi yang benar dari semua perpustakaan dan kompiler yang diperlukan.

Untuk mempercepat pembangunan lokal kami juga merekomendasikan konfigurasi nix dengan dukungan ccache tetapi ini bukan keharusan. Untuk menggunakan ccache, --arg withCcache true dapat ditambahkan ke sebagian besar perintah nix-build dan nix-shell yang ditunjukkan di bawah.

IncludeOS saat ini tidak dapat dibangun di MacOS atau Windows.

Halo Dunia

IncludeOS minimal "hello world" terlihat seperti program C++ biasa:

# include < iostream >

int main (){
  std::cout << " Hello world n " ;
}

Layanan lengkap "Hello world" dengan alur kerja nix yang berfungsi tersedia di repo hello world. Repositori ini juga dapat digunakan sebagai titik awal untuk mengembangkan layanan IncludeOS Anda sendiri.

Untuk contoh layanan lebih lanjut, lihat pengujian integrasi (di bawah ./IncludeOS/test/*/integration).

Pengembangan kernel

Untuk membangun IncludeOS, jalankan

$ nix-build

Ini akan membangun rantai alat dan semua pustaka kernel IncludeOS.

Perhatikan bahwa pembangunan pertama akan memerlukan waktu untuk diselesaikan, karena rantai alat IncludeOS dibangun kembali dari kode sumber. Ini termasuk clang, llvm, libcxx, musl dan sebagainya. Tidak ada cache biner nix yang tersedia untuk file-file ini saat ini. Pembangunan selanjutnya akan berjalan lebih cepat ketika rantai alat telah di-cache di nix-store lokal.

Setelah melakukan perubahan pada kernel, jalankan nix-build lagi untuk mendapatkan binari baru. Jika Anda mengulangi perubahan pada satu bagian kernel, Anda dapat mempercepat pembangunan secara signifikan dengan menggunakan ccache. Semua perintah nix-build dan nix-shell di bagian ini mendukung parameter opsional --arg withCcache true .

Tidak selalu praktis untuk membangun kembali seluruh kernel selama pengembangan. Anda bisa mendapatkan shell pengembangan dengan lingkungan yang telah dikonfigurasi sebelumnya menggunakan shell.nix :

$ nix-shell

Petunjuk lebih lanjut akan ditampilkan untuk mengonfigurasi jaringan VM secara opsional atau mengganti jalur build saat memulai shell.

Secara default shell juga akan membangun unikernel dari example.nix . Contoh unikernel dapat di-boot dari dalam shell:

$ nix-shell
[...]
nix$ boot hello_includeos.elf.bin

Jika Anda ingin membuat unikernel yang berbeda dari contoh, ini dapat ditentukan dengan parameter --argstr unikernel [path] . Ini terutama digunakan untuk tes integrasi. Misalnya, untuk membuat dan menjalankan pengujian stacktrace:

$ nix-shell --argstr unikernel ./test/kernel/integration/stacktrace
[...]
nix$ ls -l kernel *
kernel_stacktrace
nix$ boot kernel_stacktrace
[...]
Calling os::print_backtrace ()
symtab or strtab is empty, indicating image may be stripped
[0] 0x000000000025dcd2 + 0x000: 0x25dcd2
[1] 0x000000000021097d + 0x000: 0x21097d
[2] 0x00000000002b370a + 0x000: 0x2b370a
[3] 0x0000000000210eea + 0x000: 0x210eea
We reached the end.

Untuk membangun dan menjalankan VM pengujian sebagai satu perintah:

$ nix-shell --argstr unikernel ./test/kernel/integration/stacktrace --run ./test.py

Menjalankan tes

Anda dapat menjalankan semua pengujian integrasi menggunakan skrip ./test.sh . Pengujian akan dijalankan secara lokal di lingkungan nix. Kami menyarankan untuk memverifikasi secara manual bahwa semua tes lulus secara lokal sebelum mengirimkan PR baru ke IncludeOS untuk menghemat waktu peninjauan.

Tes individual dapat dijalankan dengan nix-shell secara langsung. Lihat test.sh untuk lebih jelasnya.

Berkontribusi pada IncludeOS

IncludeOS sedang dikembangkan di GitHub. Buat fork Anda sendiri dan kirimkan permintaan tarik kepada kami. Silakan baca Pedoman Berkontribusi pada IncludeOS.

Pedoman C++

Kami ingin sebisa mungkin mematuhi Pedoman Inti ISO C++. Jika Anda menemukan kode di IncludeOS yang tidak sesuai, beri tahu kami di pelacak masalah - atau lebih baik lagi, perbaiki di fork Anda sendiri dan kirimkan permintaan tarik kepada kami.

Kontak keamanan

Jika Anda menemukan masalah keamanan di IncludeOS, harap hindari pelacak masalah publik. Alih-alih, kirim email ke [email protected]. Untuk informasi lebih lanjut dan enkripsi silakan merujuk ke dokumentasi.