https://github.com/unikraft/app-duktape

kraft-ready repo for building JavaScript/duktape applications with Unikraft
https://github.com/unikraft/app-duktape

duktape javascript unikraft unikraft-application

Last synced: 22 days ago
JSON representation

kraft-ready repo for building JavaScript/duktape applications with Unikraft

Host: GitHub
URL: https://github.com/unikraft/app-duktape
Owner: unikraft
Created: 2020-02-13T14:24:45.000Z (about 5 years ago)
Default Branch: stable
Last Pushed: 2023-10-23T09:07:02.000Z (over 1 year ago)
Last Synced: 2025-03-24T15:11:21.646Z (about 1 month ago)
Topics: duktape, javascript, unikraft, unikraft-application
Language: Shell
Size: 13.7 KB
Stars: 2
Watchers: 10
Forks: 4
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# JavaScript/Duktape on Unikraft

This application starts a Duktape JavaScript engine with Unikraft.
Follow the instructions below to set up, configure, build and run Duktape.

To get started immediately, you can use Unikraft's companion command-line companion tool, [`kraft`](https://github.com/unikraft/kraftkit).
Start by running the interactive installer:

```console
curl --proto '=https' --tlsv1.2 -sSf https://get.kraftkit.sh | sudo sh
```

Once installed, clone [this repository](https://github.com/unikraft/app-duktape) and run `kraft build`:

```console
git clone https://github.com/unikraft/app-duktape duktape
cd duktape/
kraft build
```

This will guide you through an interactive build process where you can select one of the available targets (architecture/platform combinations).
Otherwise, we recommend building for `qemu/x86_64` like so:

```console
kraft build --target duktape-qemu-x86_64-initrd
```

Once built, you can instantiate the unikernel via:

```console
kraft run --target duktape-qemu-x86_64-initrd --initrd ./
```

If you don't have KVM support (such as when running inside a virtual machine), pass the `-W` option to `kraft run` to disable virtualization support:

```console
kraft run -W --target duktape-qemu-x86_64-initrd --initrd ./
```

When left without the `--target` argument, you'll be queried for the desired target from the list.

To use the Unikraft instance of Duktape, type JavaScript instructions and the prompt, such as below:

```console
duk> Math.sqrt(100)
= 10
duk> 10+20
= 30
```

To close the QEMU Duktape instance, use the `Ctrl+a x` keyboard shortcut;
that is press the `Ctrl` and `a` keys at the same time and then, separately, press the `x` key.

## Work with the Basic Build & Run Toolchain (Advanced)

You can set up, configure, build and run the application from grounds up, without using the companion tool `kraft`.

### Quick Setup (aka TLDR)

For a quick setup, run the commands below.
Note that you still need to install the [requirements](#requirements).

For building and running everything for `x86_64`, follow the steps below:

```console
git clone https://github.com/unikraft/app-duktape duktape
cd duktape/
./scripts/setup.sh
wget https://raw.githubusercontent.com/unikraft/app-testing/staging/scripts/generate.py -O scripts/generate.py
chmod a+x scripts/generate.py
./scripts/generate.py
./scripts/build/make-qemu-x86_64-9pfs.sh
./scripts/run/qemu-x86_64-9pfs-interp.sh
```

This will configure, build and run Duktape.
You can see how to test it in the [running section](#run).

The same can be done for `AArch64`, by running the commands below:

```console
git clone https://github.com/unikraft/app-duktape duktape
cd duktape/
./scripts/setup.sh
wget https://raw.githubusercontent.com/unikraft/app-testing/staging/scripts/generate.py -O scripts/generate.py
chmod a+x scripts/generate.py
./scripts/generate.py
./scripts/build/make-qemu-arm64-9pfs.sh
./scripts/run/qemu-arm64-9pfs-interp.sh
```

Similar to the `x86_64` build, this will start Duktape.
Information about every step is detailed below.

### Requirements

In order to set up, configure, build and run Duktape on Unikraft, the following packages are required:

* `build-essential` / `base-devel` / `@development-tools` (the meta-package that includes `make`, `gcc` and other development-related packages)
* `sudo`
* `flex`
* `bison`
* `git`
* `wget`
* `uuid-runtime`
* `qemu-system-x86`
* `qemu-system-arm`
* `qemu-kvm`
* `sgabios`
* `gcc-aarch64-linux-gnu`

GCC >= 8 is required to build Duktape on Unikraft.

On Ubuntu/Debian or other `apt`-based distributions, run the following command to install the requirements:

```console
apt-get install -y --no-install-recommends \
build-essential \
sudo \
gcc-aarch64-linux-gnu \
libncurses-dev \
libyaml-dev \
flex \
bison \
git \
wget \
uuid-runtime \
qemu-kvm \
qemu-system-x86 \
qemu-system-arm \
sgabios
```

In addition, Python 2.7 needs to be installed under the name `python2`:

```console
sudo apt install python2
```

Also `pyYaml` needs to be installed.
This can be done in two ways:

```console
sudo apt install python-pip
pip2 install pyYaml
```

or it can be installed with:

```console
sudo apt-get install python-yaml
```

### Set Up

The following repositories are required for Duktape:

* The application repository (this repository): [`app-duktape`](https://github.com/unikraft/app-duktape)
* The Unikraft core repository: [`unikraft`](https://github.com/unikraft/unikraft)
* Library repositories:
* The Duktape library repository: [`lib-duktape`](https://github.com/unikraft/lib-duktape)
* The standard C library: [`lib-musl`](https://github.com/unikraft/lib-musl)

Follow the steps below for the setup:

1. First clone the [`app-duktape` repository](https://github.com/unikraft/app-duktape) in the `duktape/` directory:

```console
git clone https://github.com/unikraft/app-duktape duktape
```

Enter the `duktape/` directory:

```console
cd duktape/

ls -aF
```

This will print the contents of the repository:

```text
Makefile Makefile.uk README.md defconfigs/ kraft.cloud.yaml kraft.yaml rootfs/ scripts/
```

1. While inside the `duktape/` directory, clone all required repositories by using the `setup.sh` script:

```console
./scripts/setup.sh
```

1. Use the `tree` command to inspect the contents of the `workdir/` directory:

```console
tree -F -L 2 workdir/
```

The layout of the `workdir/` directory should look something like this:

9 directories, 7 files
```

### Scripted Building and Running

To make it easier to build, run and test different configurations, the repository provides a set of scripts that do everything required.
These are scripts used for building different configurations of Duktape and for running these with all the requirements behind the scenes.

First of all, grab the [`generate.py` script](https://github.com/unikraft/app-testing/blob/staging/scripts/generate.py) and place it in the `scripts/` directory by running:

```console
wget https://raw.githubusercontent.com/unikraft/app-testing/staging/scripts/generate.py -O scripts/generate.py
chmod a+x scripts/generate.py
```

Now, run the `generate.py` script.
You must run it in the root directory of this repository:

```console
./scripts/generate.py
```

The scripts (as shell scripts) are now generated in `scripts/build/` and `scripts/run/`:

They are shell scripts, so you can use an editor or a text viewer to check their contents:

```console
cat scripts/run/fc-x86_64-initrd-interp.sh
```

Now, invoke each script to build and run the application.
A sample build and run set of commands is:

```console
./scripts/build/make-qemu-x86_64-9pfs.sh
./scripts/run/qemu-x86_64-9pfs-interp.sh
```

Note that Firecracker only works with initrd (not 9pfs).
And Firecracker networking is not yet upstream.

## Detailed Steps

### Configure

Configuring, building and running a Unikraft application depends on our choice of platform and architecture.
Currently, supported platforms are QEMU (KVM), Xen and linuxu.
QEMU (KVM) is known to be working, so we focus on that.

Supported architectures are x86_64 and AArch64.

Use the corresponding the configuration files (`defconfigs/*`), according to your choice of platform and architecture.

## Detailed Steps

### Configure

Supported architectures are x86_64 and AArch64.

Use the corresponding the configuration files (`defconfigs/*`), according to your choice of platform and architecture.

#### QEMU x86_64

Use the `defconfigs/qemu-x86_64-9pfs` configuration file together with `make defconfig` to create the configuration file:

```console
UK_DEFCONFIG=$(pwd)/defconfigs/qemu-x86_64-9pfs make defconfig
```

This results in the creation of the `.config` file:

```console
ls .config
.config
```

The `.config` file will be used in the build step.

#### QEMU AArch64

Use the `defconfigs/qemu-arm64-9pfs` configuration file together with `make defconfig` to create the configuration file:

```console
UK_DEFCONFIG=$(pwd)/defconfigs/qemu-arm64-9pfs make defconfig
```

Similar to the x86_64 configuration, this results in the creation of the `.config` file that will be used in the build step.

### Build

Building uses as input the `.config` file from above, and results in a unikernel image as output.
The unikernel output image, together with intermediary build files, are stored in the `workdir/build/` directory.

#### Clean Up

Before starting a build on a different platform or architecture, you must clean up the build output.
This may also be required in case of a new configuration.

Cleaning up is done with 3 possible commands:

* `make clean`: cleans all actual build output files (binary files, including the unikernel image)
* `make properclean`: removes the entire `workdir/build/` directory
* `make distclean`: removes the entire `workdir/build/` directory **and** the `.config` file

Typically, you would use `make properclean` to remove all build artifacts, but keep the configuration file.

#### QEMU x86_64

Building for QEMU x86_64 assumes you did the QEMU x86_64 configuration step above.
Build the Unikraft Wamr image for QEMU x86_64 by using the command below:

```console
make -j $(nproc)
```

You will see a list of all the files generated by the build system:

```text
[...]
LD duktape_qemu-x86_64.dbg
UKBI duktape_qemu-x86_64.dbg.bootinfo
SCSTRIP duktape_qemu-x86_64
GZ duktape_qemu-x86_64.gz
make[1]: Leaving directory 'duktape/workdir/unikraft'
```

At the end of the build command, the `duktape_qemu-x86_64` unikernel image is generated.
This image is to be used in the run step.

#### QEMU AArch64

If you had configured and build a unikernel image for another platform or architecture (such as x86_64) before, then:

1. Do a cleanup step with `make properclean`.

1. Configure for QEMU AAarch64, as shown above.

1. Follow the instructions below to build for QEMU AArch64.

Building for QEMU AArch64 assumes you did the QEMU AArch64 configuration step above.
Build the Unikraft Wamr image for QEMU AArch64 by using the same command as for x86_64:

```console
make -j $(nproc)
```

Similar to building for x86_64, you will see a list of the files generated by the build system.

```text
[...]
LD duktape_qemu-arm64.dbg
UKBI duktape_qemu-arm64.dbg.bootinfo
SCSTRIP duktape_qemu-arm64
GZ duktape_qemu-arm64.gz
make[1]: Leaving directory 'duktape/workdir/unikraft
```

Similarly to x86_64, at the end of the build command, the `duktape_qemu-arm64` unikernel image is generated.
This image is to be used in the run step.

### Run

#### QEMU x86_64

To run the QEMU x86_64 build, use `qemu-x86_64-9pfs-interp.sh`:

```console
./scripts/generate.py
./scripts/run/qemu-x86_64-9pfs-interp.sh
```

The application will start and you can enter Duktape instructions / commands:

```text
Powered by
o. .o _ _ __ _
Oo Oo ___ (_) | __ __ __ _ ' _) :_
oO oO ' _ `| | |/ / _)' _` | |_| _)
oOo oOO| | | | | (| | | (_) | _) :_
OoOoO ._, ._:_:_,\_._, .__,_:_, \___)
Prometheus 0.14.0~14b1ee3d
duk> 5 + 2
= 7
duk> a = 36
= 36
duk> Math.sqrt(a)
= 6
duk>
```

#### QEMU AArch64

To run the AArch64 build, use `qemu-aarch64-9pfs-interp.sh`:

```console
./scripts/generate.py
./scripts/run/qemu-arm64-9pfs-interp.sh
```

Same as above, this will run the `rootfs/main.wasm` file with Wamr.

### Building and Running with initrd

The examples above use 9pfs as the filesystem interface.
Clean up the previous configuration, use the initrd configuration and build the unikernel by using the commands:

```console
./scripts/generate.py
./scripts/build/make-qemu-x86_64-initrd.sh
```

To run the QEMU x86_64 initrd build, use the `qemu-x86_64-initrd-interp.sh` script:

```console
./scripts/run/qemu-x86_64-initrd-interp.sh
```

The commands for AArch64 are similar:

```console
./scripts/build/make-qemu-arm64-initrd.sh
./scripts/run/qemu-arm64-initrd-interp.sh
```

### Building and Running with Firecracker

[Firecracker](https://firecracker-microvm.github.io/) is a lightweight VMM (*virtual machine manager*) that can be used as more efficient alternative to QEMU.

Configure and build commands are similar to a QEMU-based build with an initrd-based filesystem:

```console
./scripts/build/make-fc-x86_64-initrd.sh
```

To use Firecraker, you need to download a [Firecracker release](https://github.com/firecracker-microvm/firecracker/releases).
You can use the commands below to make the `firecracker-x86_64` executable from release v1.4.0 available globally in the command line:

```console
cd /tmp
wget https://github.com/firecracker-microvm/firecracker/releases/download/v1.4.0/firecracker-v1.4.0-x86_64.tgz
tar xzf firecracker-v1.4.0-x86_64.tgz
sudo cp release-v1.4.0-x86_64/firecracker-v1.4.0-x86_64 /usr/local/bin/firecracker-x86_64
```

To run a unikernel image, you need to configure a JSON file.
This is the `scripts/run/fc-x86_64-initrd.json` file.
This configuration file is uses as part of the run command:

```console
./scripts/run/fc-x86_64-initrd-interp.sh
```

Same as running with QEMU, the application will start and you can enter Duktape instructions / commands:

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/unikraft/app-duktape

Awesome Lists containing this project

README