WASI-enabled WebAssembly C/C++ toolchain

Go to file

Sam Clegg f67e6ab62f Run tests under wasmtime as part of the CI As a followup I plan to add support for running under wabt too.		5 years ago
.github/workflows	Run tests under wasmtime as part of the CI	5 years ago
src	pull in wasi-libc in prep for release 11 (#141 )	5 years ago
tests	Run tests under wasmtime as part of the CI	5 years ago
.dockerignore	Add .dockerignore file (#63 )	5 years ago
.gitignore	Fix windows SDK builds (#126 )	5 years ago
.gitmodules	Remove branch from LLVM submodule (#136 )	5 years ago
CODE_OF_CONDUCT.md	Add a CODE_OF_CONDUCT.md file.	5 years ago
Dockerfile	Build against ubuntu xenial (#123 )	5 years ago
LICENSE	Add a LICENSE file, "Apache-2.0 WITH LLVM-exception". (#100 )	5 years ago
Makefile	Run tests under wasmtime as part of the CI	5 years ago
README.md	update links to wasm org, avoid github redirect (#130 )	5 years ago
deb_from_installation.sh	More CI Fixes (#119 )	5 years ago
docker_build.sh	produce deb and tars	6 years ago
llvm_version.sh	Allow llvm-project path change; version from llvm-config.	6 years ago
strip_symbols.sh	Fix `strip_symbols.sh` on mac; bump libc to include utime.h (#116 )	5 years ago
tar_from_installation.sh	Fix windows SDK builds (#126 )	5 years ago
version.sh	build system fixups	6 years ago
wasi-sdk.cmake	Fix windows SDK builds (#126 )	5 years ago
wasi-sdk.control	initial commit	6 years ago

README.md

WASI SDK

Quick Start

Download SDK packages here.

About this repository

This repository contains no compiler or library code itself; it uses git submodules to pull in the upstream Clang and LLVM tree, as well as the wasi-libc tree.

The libc portion of this SDK is the wasi-libc.

Upstream Clang and LLVM (from 8.0 onwards) can compile for WASI out of the box, and WebAssembly support is included in them by default. So, all that's done here is to provide builds configured to set the default target and sysroot for convenience.

One could also use a standard Clang installation, build a sysroot from the sources mentioned above, and compile with "--target=wasm32-wasi --sysroot=/path/to/sysroot".

Install

A typical installation from the release binaries might look like the following:

wget https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-[VERSION]/wasi-sdk-[VERSION]-linux.tar.gz
tar xvf wasi-sdk-[VERSION]-linux.tar.gz

Use

Use the clang installed in the wasi-sdk directory:

CC="[WASI_SDK_PATH]/bin/clang --sysroot=[WASI_SDK_PATH]/share/wasi-sysroot"
$CC foo.c -o foo.wasm

Note: [WASI_SDK_PATH]/share/wasi-sysroot contains the WASI-specific includes/libraries/etc. The --sysroot=... option is not necessary if WASI_SDK_PATH is /opt/wasi-sdk.

Notes for Autoconf

Upstream autoconf now recognizes WASI.

For convenience when building packages that aren't yet updated, updated config.sub and config.guess files are installed at share/misc/config.* in the install directory.

Notable Limitations

This repository does not yet support C++ exceptions. C++ code is supported only with -fno-exceptions for now. Similarly, there is not yet support for setjmp/longjmp. Work on support for exception handling s underway at the language level which will support both of these features.

This repository does not yet support threads. Specifically, WASI does not yet have an API for creating and managing threads yet, and WASI libc does not yet have pthread support.

This repository does not yet support dynamic libraries. While there are some efforts to design a system for dynamic libraries in wasm, it is still in development and not yet generally usable.

There is no support for networking. It is a goal of WASI to support networking in the future though.