forked from unikraft/catalog
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(library): Introduce Findtime as library
Introduce Findtime (master) image (ELF Loader) for bincompat runs. Add `Kraftfile` to build for QMEU and Firecracker on x86_64 using embedded initrd. The current build uses embedded initrd to build a single image consisting of both the kernel and the initial ramdisk. Add GitHub workflow to build and deploy the image. Add success badge in `README.md`. Signed-off-by: Razvan Deaconescu <[email protected]>
- Loading branch information
Showing
6 changed files
with
320 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| name: library/findtime | ||
|
|
||
| on: | ||
| schedule: | ||
| - cron: '0 0 * * *' # Everyday at 12AM | ||
|
|
||
| push: | ||
| branches: [main] | ||
| paths: | ||
| - 'library/findtime/**' | ||
| - '.github/workflows/library-findtime.yaml' | ||
| - '!library/findtime/README.md' | ||
|
|
||
| pull_request: | ||
| types: [opened, synchronize, reopened] | ||
| branches: [main] | ||
| paths: | ||
| - 'library/findtime/**' | ||
| - '.github/workflows/library-findtime.yaml' | ||
| - '!library/findtime/README.md' | ||
|
|
||
| jobs: | ||
| build: | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| include: | ||
| - plat: qemu | ||
| arch: x86_64 | ||
| - plat: fc | ||
| arch: x86_64 | ||
|
|
||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v3 | ||
|
|
||
| - name: Build findtime | ||
| uses: unikraft/kraftkit@staging | ||
| with: | ||
| loglevel: debug | ||
| workdir: library/findtime | ||
| runtimedir: /github/workspace/.kraftkit | ||
| plat: ${{ matrix.plat }} | ||
| arch: ${{ matrix.arch }} | ||
| push: false | ||
| output: oci://index.unikraft.io/unikraft.org/findtime:latest | ||
|
|
||
| - name: Archive OCI digests | ||
| uses: actions/upload-artifact@v3 | ||
| with: | ||
| name: oci-digests-${{ matrix.arch }}-${{ matrix.plat }} | ||
| path: ${{ github.workspace }}/.kraftkit/oci/digests | ||
| if-no-files-found: error | ||
|
|
||
| push: | ||
| if: ${{ github.event_name == 'push' || github.event_name == 'schedule' }} | ||
| needs: [ build ] | ||
| runs-on: ubuntu-latest | ||
|
|
||
| steps: | ||
| - uses: actions/checkout@v3 | ||
|
|
||
| - name: Login to OCI registry | ||
| uses: docker/login-action@v2 | ||
| with: | ||
| registry: index.unikraft.io | ||
| username: ${{ secrets.REG_USERNAME }} | ||
| password: ${{ secrets.REG_TOKEN }} | ||
|
|
||
| - name: Retrieve, merge and push OCI digests | ||
| uses: ./.github/actions/merge-oci-digests | ||
| with: | ||
| name: index.unikraft.io/unikraft.org/findtime:latest | ||
| push: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| FROM --platform=linux/x86_64 rust:1.80.1-bookworm AS build | ||
|
|
||
| WORKDIR /src | ||
|
|
||
| RUN set -xe; \ | ||
| apt-get update; \ | ||
| apt-get install -y --no-install-recommends \ | ||
| ca-certificates \ | ||
| wget \ | ||
| xz-utils \ | ||
| musl-dev \ | ||
| musl-tools \ | ||
| patch \ | ||
| git; \ | ||
| git clone https://github.com/fbergen/findtime \ | ||
| ; | ||
|
|
||
| WORKDIR /src/findtime | ||
|
|
||
| RUN set -xe; \ | ||
| rustup target add x86_64-unknown-linux-musl; \ | ||
| cargo build --release --target=x86_64-unknown-linux-musl \ | ||
| ; | ||
|
|
||
| RUN --mount=type=tmpfs,target=/etc set -xe; \ | ||
| echo "nameserver 8.8.8.8" > /etc/resolv.conf | ||
|
|
||
| FROM scratch | ||
|
|
||
| COPY --from=build /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ca-certificates.crt | ||
| COPY --from=build /src/findtime/target/x86_64-unknown-linux-musl/release/findtime /usr/bin/findtime | ||
| COPY --from=build /src/findtime/index.html /src/findtime/main.js / | ||
| COPY --from=build /etc/resolv.conf /etc/resolv.conf |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| spec: v0.6 | ||
|
|
||
| name: findtime | ||
|
|
||
| rootfs: ./Dockerfile | ||
|
|
||
| cmd: ["/usr/bin/findtime"] | ||
|
|
||
| template: | ||
| source: https://github.com/unikraft/app-elfloader.git | ||
| version: staging | ||
|
|
||
| unikraft: | ||
| source: https://github.com/unikraft/unikraft.git | ||
| version: staging | ||
| kconfig: | ||
| # Configurations options for app-elfloader | ||
| # (they can't be part of the template atm) | ||
| CONFIG_APPELFLOADER_ARCH_PRCTL: 'y' | ||
| CONFIG_APPELFLOADER_BRK: 'y' | ||
| CONFIG_APPELFLOADER_CUSTOMAPPNAME: 'y' | ||
| CONFIG_APPELFLOADER_STACK_NBPAGES: 128 | ||
| CONFIG_APPELFLOADER_VFSEXEC_EXECBIT: 'n' | ||
| CONFIG_APPELFLOADER_VFSEXEC: 'y' | ||
| CONFIG_APPELFLOADER_HFS: 'y' | ||
| CONFIG_APPELFLOADER_HFS_ETCRESOLVCONF: 'y' | ||
| CONFIG_APPELFLOADER_HFS_ETCHOSTS: 'y' | ||
| CONFIG_APPELFLOADER_HFS_ETCHOSTNAME: 'y' | ||
| CONFIG_APPELFLOADER_HFS_REPLACEEXIST: 'y' | ||
| # Unikraft options | ||
| CONFIG_HAVE_PAGING_DIRECTMAP: 'y' | ||
| CONFIG_HAVE_PAGING: 'y' | ||
| CONFIG_I8042: 'y' | ||
| CONFIG_LIBDEVFS_AUTOMOUNT: 'y' | ||
| CONFIG_LIBDEVFS_DEV_NULL: 'y' | ||
| CONFIG_LIBDEVFS_DEV_STDOUT: 'y' | ||
| CONFIG_LIBDEVFS_DEV_ZERO: 'y' | ||
| CONFIG_LIBDEVFS: 'y' | ||
| CONFIG_LIBPOSIX_ENVIRON_ENVP0: "PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin" | ||
| CONFIG_LIBPOSIX_ENVIRON_ENVP1: "LD_LIBRARY_PATH=/usr/local/lib:/usr/lib:/lib" | ||
| CONFIG_LIBPOSIX_ENVIRON_ENVP2: "HOME=/" | ||
| CONFIG_LIBPOSIX_ENVIRON: 'y' | ||
| CONFIG_LIBPOSIX_EVENTFD: 'y' | ||
| CONFIG_LIBPOSIX_FDIO: 'y' | ||
| CONFIG_LIBPOSIX_FDTAB: 'y' | ||
| CONFIG_LIBPOSIX_FUTEX: 'y' | ||
| CONFIG_LIBPOSIX_MMAP: 'y' | ||
| CONFIG_LIBPOSIX_NETLINK: 'y' | ||
| CONFIG_LIBPOSIX_PIPE: 'y' | ||
| CONFIG_LIBPOSIX_POLL: 'y' | ||
| CONFIG_LIBPOSIX_PROCESS_CLONE: 'y' | ||
| CONFIG_LIBPOSIX_SOCKET: 'y' | ||
| CONFIG_LIBPOSIX_SYSINFO: 'y' | ||
| CONFIG_LIBPOSIX_TIME: 'y' | ||
| CONFIG_LIBPOSIX_TIMERFD: 'y' | ||
| CONFIG_LIBPOSIX_UNIXSOCKET: 'y' | ||
| CONFIG_LIBPOSIX_USER_GID: 0 | ||
| CONFIG_LIBPOSIX_USER_GROUPNAME: "root" | ||
| CONFIG_LIBPOSIX_USER_UID: 0 | ||
| CONFIG_LIBPOSIX_USER_USERNAME: "root" | ||
| CONFIG_LIBPOSIX_USER: 'y' | ||
| CONFIG_LIBRAMFS: 'y' | ||
| CONFIG_LIBSYSCALL_SHIM_HANDLER_ULTLS: 'y' | ||
| CONFIG_LIBSYSCALL_SHIM_HANDLER: 'y' | ||
| CONFIG_LIBSYSCALL_SHIM_LEGACY_VERBOSE: 'y' | ||
| CONFIG_LIBSYSCALL_SHIM: 'y' | ||
| CONFIG_LIBUKALLOCPOOL: 'y' | ||
| CONFIG_LIBUKBLKDEV_SYNC_IO_BLOCKED_WAITING: 'y' | ||
| CONFIG_LIBUKBLKDEV: 'y' | ||
| CONFIG_LIBUKBOOT_BANNER_MINIMAL: 'y' | ||
| CONFIG_LIBUKBOOT_HEAP_BASE: '0x400000000' | ||
| CONFIG_LIBUKBOOT_MAINTHREAD: 'y' | ||
| CONFIG_LIBUKBOOT_SHUTDOWNREQ_HANDLER: 'y' | ||
| CONFIG_LIBUKCPIO: 'y' | ||
| CONFIG_LIBUKDEBUG_CRASH_SCREEN: 'y' | ||
| CONFIG_LIBUKDEBUG_ENABLE_ASSERT: 'y' | ||
| CONFIG_LIBUKDEBUG_PRINT_SRCNAME: 'n' | ||
| CONFIG_LIBUKDEBUG_PRINT_TIME: 'y' | ||
| CONFIG_LIBUKDEBUG_PRINTK_ERR: 'y' | ||
| CONFIG_LIBUKDEBUG_PRINTK: 'y' | ||
| CONFIG_LIBUKDEBUG: 'y' | ||
| CONFIG_LIBUKFALLOC: 'y' | ||
| CONFIG_LIBUKMPI: 'n' | ||
| CONFIG_LIBUKSIGNAL: 'y' | ||
| CONFIG_LIBUKSWRAND_DEVFS: 'y' | ||
| CONFIG_LIBUKSWRAND: 'y' | ||
| CONFIG_LIBUKVMEM_DEFAULT_BASE: '0x0000001000000000' | ||
| CONFIG_LIBUKVMEM_DEMAND_PAGE_IN_SIZE: 12 | ||
| CONFIG_LIBUKVMEM_PAGEFAULT_HANDLER_PRIO: 4 | ||
| CONFIG_LIBUKVMEM: 'y' | ||
| CONFIG_LIBVFSCORE_AUTOMOUNT_ROOTFS: 'y' # needed for einitrd | ||
| CONFIG_LIBVFSCORE_FSTAB: 'y' | ||
| CONFIG_LIBVFSCORE_NONLARGEFILE: 'y' | ||
| CONFIG_LIBVFSCORE_ROOTFS_EINITRD: 'y' | ||
| CONFIG_LIBVFSCORE: 'y' | ||
| CONFIG_OPTIMIZE_DEADELIM: 'y' | ||
| CONFIG_OPTIMIZE_LTO: 'y' | ||
| CONFIG_PAGING: 'y' | ||
| CONFIG_STACK_SIZE_PAGE_ORDER: 4 # 128 * 4K = 512K | ||
| CONFIG_UKPLAT_KSP_SIZE: 32768 | ||
| CONFIG_UKPLAT_MEMREGION_MAX_COUNT: 64 | ||
|
|
||
| # Debug options | ||
| # CONFIG_LIBUKDEBUG_PRINTD: 'y' | ||
| # CONFIG_LIBUKDEBUG_PRINTK_INFO: 'y' | ||
| # CONFIG_LIBSYSCALL_SHIM_STRACE: 'y' | ||
| # CONFIG_LIBSYSCALL_SHIM_DEBUG: 'y' | ||
|
|
||
| libraries: | ||
| lwip: | ||
| source: https://github.com/unikraft/lib-lwip.git | ||
| version: staging | ||
| kconfig: | ||
| CONFIG_LWIP_LOOPIF: 'y' | ||
| CONFIG_LWIP_UKNETDEV: 'y' | ||
| CONFIG_LWIP_LOOPBACK: 'y' | ||
| CONFIG_LWIP_TCP: 'y' | ||
| CONFIG_LWIP_UDP: 'y' | ||
| CONFIG_LWIP_RAW: 'y' | ||
| CONFIG_LWIP_WND_SCALE: 'y' | ||
| CONFIG_LWIP_TCP_KEEPALIVE: 'y' | ||
| CONFIG_LWIP_THREADS: 'y' | ||
| CONFIG_LWIP_HEAP: 'y' | ||
| CONFIG_LWIP_SOCKET: 'y' | ||
| CONFIG_LWIP_AUTOIFACE: 'y' | ||
| CONFIG_LWIP_IPV4: 'y' | ||
| CONFIG_LWIP_DHCP: 'n' | ||
| CONFIG_LWIP_DNS: 'n' | ||
| CONFIG_LWIP_NUM_TCPCON: 64 | ||
| CONFIG_LWIP_NUM_TCPLISTENERS: 64 | ||
| CONFIG_LWIP_ICMP: 'y' | ||
| libelf: | ||
| source: https://github.com/unikraft/lib-libelf.git | ||
| version: staging | ||
|
|
||
| targets: | ||
| - fc/x86_64 | ||
| - qemu/x86_64 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| IMAGE_NAME = unikraft-findtime | ||
|
|
||
| include ../../../utils/bincompat/docker.Makefile |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| # Findtime | ||
|
|
||
| This directory contains the [Findtime](https://github.com/fbergen/findtime) runtime on Unikraft, in binary compatibility mode. | ||
| It implements a Findtime instance running on Unikraft. | ||
|
|
||
| ## Run and Use | ||
|
|
||
| Use `kraft` to run the image and start a Unikraft instance: | ||
|
|
||
| ```bash | ||
| kraft run --rm -M 128M -p 8080:8080 --plat qemu --arch x86_64 unikraft.org/findtime:master | ||
| ``` | ||
|
|
||
| If the `--plat` argument is left out, it defaults to `qemu`. | ||
| If the `--arch` argument is left out, it defaults to your system's CPU architecture. | ||
|
|
||
| Once executed, it will open port `8080` and wait for connections. | ||
| To test it, point your browser to http://localhost:8080. | ||
| You should see Findtime's interface. | ||
|
|
||
| ## Inspect and Close | ||
|
|
||
| To list information about the Unikraft instance, use: | ||
|
|
||
| ```bash | ||
| kraft ps | ||
| ``` | ||
|
|
||
| ```text | ||
| TODO | ||
| ``` | ||
|
|
||
| The instance name is `keen_nonja`. | ||
| To close the Unikraft instance, close the `kraft` process (e.g., via `Ctrl+c`) or run: | ||
|
|
||
| ```bash | ||
| kraft rm keen_nonja | ||
| ``` | ||
|
|
||
| ## Build and Run Locally | ||
|
|
||
| The commands so far used the pre-build Findtime image available in the Unikraft registry. | ||
|
|
||
| In oder to to build a local Findtime image, clone this repository and `cd` into this directory. | ||
| Then use `kraft` to build an image locally: | ||
|
|
||
| ```bash | ||
| kraft build --no-cache --no-update --plat qemu --arch x86_64 | ||
| ``` | ||
|
|
||
| Similar to the `kraft run` command, if the `--plat` argument is left out, it defaults to `qemu`. | ||
| If the `--arch` argument is left out, it defaults to your system's CPU architecture. | ||
|
|
||
| In order to run the locally built image, use `.` (_dot_, the current directory) as the final argument to the `kraft run` command: | ||
|
|
||
| ```bash | ||
| kraft run --rm -M 128M -p 8080:8080 --plat qemu --arch x86_64 . | ||
| ``` | ||
|
|
||
| Same as above, it will open port `8080` and wait for connections. | ||
|
|
||
| ## `kraft` and `sudo` | ||
|
|
||
| Mixing invocations of `kraft` and `sudo` can lead to unexpected behavior. | ||
| Read more about how to start `kraft` without `sudo` at [https://unikraft.org/sudoless](https://unikraft.org/sudoless). | ||
|
|
||
| ## Learn More | ||
|
|
||
| - [How to run unikernels locally](https://unikraft.org/docs/cli/running) | ||
| - [How to build `Dockerfile` root filesystems with BuildKit](https://unikraft.org/guides/building-dockerfile-images-with-buildkit) |