WASI-enabled WebAssembly C/C++ toolchain
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Cheng Shao 388a7cacbf
Enable ccache for CI builds of LLVM (#277)
2 years ago
.github/workflows Enable ccache for CI builds of LLVM (#277) 2 years ago
cmake/Platform Update how wasi-sdk uses cmake (#161) 4 years ago
docker Add docker image that can be used to build projects with wasi-sdk sysroot (#271) 2 years ago
src Update to the latest wasi-libc. (#261) 2 years ago
tests Add -fno-exception to iostream_main.cc.options. 2 years ago
.dockerignore Enable ccache for CI builds of LLVM (#277) 2 years ago
.gitattributes Add a .gitattributes file to make *.sh files use LF line endings. (#267) 2 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 Enable ccache for CI builds of LLVM (#277) 2 years ago
LICENSE Add a LICENSE file, "Apache-2.0 WITH LLVM-exception". (#100) 5 years ago
Makefile Enable ccache for CI builds of LLVM (#277) 2 years ago
README.md Fix typo in "Notable Limitations" section of README (#246) 3 years ago
deb_from_installation.sh fix deb build (#167) 4 years ago
docker_build.sh Enable ccache for CI builds of LLVM (#277) 2 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 Enable building under msys 3 years ago
version.sh Fixes docker build on Linux 3 years ago
wasi-sdk.cmake Update how wasi-sdk uses cmake (#161) 4 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 9.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".

Clone

This repository uses git submodule, to clone it you need use the command below :

git clone --recursive https://github.com/WebAssembly/wasi-sdk.git

Requirements

The Wasm-sdk's build process needs some packages :

  • cmake
  • clang
  • ninja

Please refer to your OS documentation to install those packages.

Build

To build the full package

cd wasi-sdk
NINJA_FLAGS=-v make package

The built package can be found into dist directory.

Install

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

export WASI_VERSION=14
export WASI_VERSION_FULL=${WASI_VERSION}.0
wget https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-${WASI_VERSION}/wasi-sdk-${WASI_VERSION_FULL}-linux.tar.gz
tar xvf wasi-sdk-${WASI_VERSION_FULL}-linux.tar.gz

Use

Use the clang installed in the wasi-sdk directory:

export WASI_SDK_PATH=`pwd`/wasi-sdk-${WASI_VERSION_FULL}
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

Autoconf 2.70 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 is 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.