build: add recipes for installing WASI libc

Author: kgryte

tools/make/common.mk

@@ -496,11 +496,23 @@ DEPS_LLVM_BUILD_OUT ?= $(DEPS_BUILD_DIR)/llvm
 # Define the LLVM version:
 DEPS_LLVM_VERSION ?=
 
-# Define the path to clang compiler:
+# Define the path to the LLVM clang compiler:
 DEPS_LLVM_CLANG ?= $(DEPS_LLVM_BUILD_OUT)/build/bin/clang
 
-# Define the path to LLVM static compiler:
-DEPS_LLVM_LLC ?= $(DEPS_LLVM_BUILD_OUT)/build/bin/llc
+# Define the path to the LLVM archiver:
+DEPS_LLVM_AR ?= $(DEPS_LLVM_BUILD_OUT)/build/bin/llvm-ar
+
+# Define the path to the LLVM tool for listing LLVM bitcode and object file symbol tables:
+DEPS_LLVM_NM ?= $(DEPS_LLVM_BUILD_OUT)/build/bin/llvm-nm
+
+# Define the output path when building WASI libc:
+DEPS_WASI_LIBC_BUILD_OUT ?= $(DEPS_BUILD_DIR)/wasi-libc
+
+# Define the WASI libc version:
+DEPS_WASI_LIBC_VERSION ?=
+
+# Define the path to WASI libc sysroot:
+DEPS_WASI_LIBC_SYSROOT ?= $(DEPS_WASI_LIBC_BUILD_OUT)/sysroot
 
 # Define the output path when building the Emscripten SDK:
 DEPS_EMSDK_BUILD_OUT ?= $(DEPS_BUILD_DIR)/emsdk

tools/make/lib/install/Makefile

@@ -46,6 +46,7 @@ include $(TOOLS_MAKE_LIB_DIR)/install/python_deps.mk
 include $(TOOLS_MAKE_LIB_DIR)/install/r_deps.mk
 include $(TOOLS_MAKE_LIB_DIR)/install/shellcheck.mk
 include $(TOOLS_MAKE_LIB_DIR)/install/wabt.mk
+include $(TOOLS_MAKE_LIB_DIR)/install/wasi_libc.mk
 
 
 # RULES #

tools/make/lib/install/README.md

@@ -43,6 +43,7 @@ This directory contains [`make`][make] rules for running the project's installat
     -   [R](#r)
     -   [ShellCheck](#shellcheck)
     -   [WebAssembly Binary Toolkit](#wabt)
+    -   [WASI libc](#wasi-libc)
 
 </section>
 
@@ -598,6 +599,36 @@ Removes [WebAssembly Binary Toolkit][wabt] installation tests.
 $ make clean-deps-wabt-tests
 ```
 
+* * *
+
+<a name="wasi-libc"></a>
+
+### WASI libc
+
+#### install-deps-wasi-libc
+
+Installs a [WASI libc][wasi-libc] implementation for WebAssembly.
+
+```bash
+$ make install-deps-wasi-libc
+```
+
+#### clean-deps-wasi-libc
+
+Removes an installed [WASI libc][wasi-libc] distribution.
+
+```bash
+$ make clean-deps-wasi-libc
+```
+
+#### clean-deps-wasi-libc-tests
+
+Removes [WASI libc][wasi-libc] installation tests.
+
+```bash
+$ make clean-deps-wasi-libc-tests
+```
+
 </section>
 
 <!-- /.usage -->
@@ -638,6 +669,8 @@ $ make clean-deps-wabt-tests
 
 [wabt]: https://github.com/WebAssembly/wabt
 
+[wasi-libc]: https://github.com/WebAssembly/wasi-libc
+
 </section>
 
 <!-- /.links -->

tools/make/lib/install/wabt.mk

@@ -170,7 +170,7 @@ deps-install-wabt: $(DEPS_WABT_BUILD_OUT) deps-prerequisites-wabt
 .PHONY: deps-install-wabt
 
 #/
-# Updates the WebAssemby Binary Toolkit (WABT).
+# Updates the WebAssembly Binary Toolkit (WABT).
 #
 # @private
 #
@@ -204,7 +204,7 @@ deps-test-wabt: $(DEPS_WABT_TEST_INSTALL_WAT_OUT) $(DEPS_WABT_TEST_INSTALL_WASM_
 .PHONY: deps-test-wabt
 
 #/
-# Installs the WebAsembly Binary Toolkit (WABT).
+# Installs the WebAssembly Binary Toolkit (WABT).
 #
 # @example
 # make install-deps-wabt

tools/make/lib/install/wasi_libc.mk

@@ -0,0 +1,191 @@
+#/
+# @license Apache-2.0
+#
+# Copyright (c) 2024 The Stdlib Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#/
+
+# VARIABLES #
+
+# Define the path to an executable for checking git:
+DEPS_CHECK_GIT ?= $(TOOLS_DIR)/scripts/check_git
+
+# Define the download URL:
+DEPS_WASI_LIBC_URL ?= https://github.com/WebAssembly/wasi-libc
+
+# Determine the basename for the download:
+deps_wasi_libc_basename := wasi_libc
+
+# Define the path to the file containing a checksum to verify a download:
+DEPS_WASI_LIBC_CHECKSUM ?= $(shell $(CAT) $(DEPS_CHECKSUMS_DIR)/$(subst .,_,$(deps_wasi_libc_basename))/sha256)
+
+# Define the output path when downloading:
+DEPS_WASI_LIBC_DOWNLOAD_OUT ?= $(DEPS_TMP_DIR)/$(deps_wasi_libc_basename)
+
+# Define the output path after extracting:
+deps_wasi_libc_extract_out := $(DEPS_BUILD_DIR)/wasi_libc_extracted
+
+
+# RULES #
+
+#/
+# Downloads WASI libc.
+#
+# @private
+#/
+$(DEPS_WASI_LIBC_DOWNLOAD_OUT): | $(DEPS_TMP_DIR)
+	$(QUIET) echo 'Downloading WASI libc...' >&2
+	$(QUIET) $(GIT) clone --depth=1 $(DEPS_WASI_LIBC_URL) $(DEPS_WASI_LIBC_DOWNLOAD_OUT)
+
+#/
+# Extracts a WASI libc download.
+#
+# @private
+#/
+$(DEPS_WASI_LIBC_BUILD_OUT): | $(DEPS_BUILD_DIR) $(DEPS_WASI_LIBC_DOWNLOAD_OUT)
+	$(QUIET) echo 'Extracting WASI libc...' >&2
+	$(QUIET) $(CP) -a $(DEPS_WASI_LIBC_DOWNLOAD_OUT) $(deps_wasi_libc_extract_out)
+	$(QUIET) mv $(deps_wasi_libc_extract_out) $(DEPS_WASI_LIBC_BUILD_OUT)
+
+#/
+# Compiles a WASI libc sysroot.
+#
+# @private
+#/
+$(DEPS_WASI_LIBC_SYSROOT): $(DEPS_LLVM_CLANG) $(DEPS_LLVM_AR) $(DEPS_LLVM_NM) $(DEPS_WASI_LIBC_BUILD_OUT)
+	$(QUIET) cd $(DEPS_WASI_LIBC_BUILD_OUT) && \
+		$(MAKE) CC="$(DEPS_LLVM_CLANG)" AR="$(DEPS_LLVM_AR)" NM="$(DEPS_LLVM_NM)"
+
+#/
+# Downloads WASI libc.
+#
+# @private
+#
+# @example
+# make deps-download-wasi-libc
+#/
+deps-download-wasi-libc: $(DEPS_WASI_LIBC_DOWNLOAD_OUT)
+
+.PHONY: deps-download-wasi-libc
+
+#/
+# Verifies a WASI libc download.
+#
+# @private
+#
+# @example
+# make deps-verify-wasi-libc
+#/
+deps-verify-wasi-libc: deps-download-wasi-libc
+	$(QUIET) echo 'Verifying download...' >&2
+	$(QUIET) echo 'Nothing to verify.' >&2
+
+.PHONY: deps-verify-wasi-libc
+
+#/
+# Extracts a WASI libc download.
+#
+# @private
+#
+# @example
+# make deps-extract-wasi-libc
+#/
+deps-extract-wasi-libc: $(DEPS_WASI_LIBC_BUILD_OUT)
+
+.PHONY: deps-extract-wasi-libc
+
+#/
+# Checks a host system for WASI libc installation prerequisites.
+#
+# @private
+#
+# @example
+# make deps-prerequisites-wasi-libc
+#/
+deps-prerequisites-wasi-libc:
+	$(QUIET) $(DEPS_CHECK_GIT)
+
+.PHONY: deps-prerequisites-wasi-libc
+
+#/
+# Installs WASI libc.
+#
+# @private
+#
+# @example
+# make deps-install-wasi-libc
+#/
+deps-install-wasi-libc: deps-prerequisites-wasi-libc $(DEPS_WASI_LIBC_BUILD_OUT)  $(DEPS_WASI_LIBC_SYSROOT)
+
+.PHONY: deps-install-wasi-libc
+
+#/
+# Updates WASI libc.
+#
+# @private
+#
+# @example
+# make deps-update-wasi-libc
+#/
+deps-update-wasi-libc: deps-install-wasi-libc
+
+.PHONY: deps-update-wasi-libc
+
+#/
+# Tests a WASI libc installation.
+#
+# @private
+#
+# @example
+# make deps-test-wasi-libc
+#/
+deps-test-wasi-libc:
+	$(QUIET) echo '' >&2
+	$(QUIET) test -d $(DEPS_WASI_LIBC_SYSROOT) >&2
+	$(QUIET) echo '' >&2
+	$(QUIET) echo 'Success.' >&2
+
+.PHONY: deps-test-wasi-libc
+
+#/
+# Installs WASI libc.
+#
+# @example
+# make install-deps-wasi-libc
+#/
+install-deps-wasi-libc: deps-download-wasi-libc deps-verify-wasi-libc deps-extract-wasi-libc deps-install-wasi-libc deps-test-wasi-libc
+
+.PHONY: install-deps-wasi-libc
+
+#/
+# Removes a WASI libc install (but does not remove a download if one exists).
+#
+# @example
+# make clean-deps-wasi-libc
+#/
+clean-deps-wasi-libc: clean-deps-wasi-libc-tests
+	$(QUIET) $(DELETE) $(DELETE_FLAGS) $(DEPS_WASI_LIBC_BUILD_OUT)
+
+.PHONY: clean-deps-wasi-libc
+
+#/
+# Removes WASI libc installation tests.
+#
+# @example
+# make clean-deps-wasi-libc-tests
+#/
+clean-deps-wasi-libc-tests:
+	$(QUIET) echo '' >&2
+
+.PHONY: clean-deps-wasi-libc-tests

tools/make/lib/wasm/Makefile

@@ -59,6 +59,8 @@ wasm: $(NODE_MODULES)
 		NODE="$(NODE)" \
 		NODE_PATH="$(NODE_PATH)" \
 		SRC_FOLDER="$(SRC_FOLDER)" \
+		CLANG_COMPILER="$(DEPS_LLVM_CLANG)" \
+		CLANG_SYSROOT="$(DEPS_WASI_LIBC_SYSROOT)" \
 		EMCC_COMPILER="$(DEPS_EMSDK_EMSCRIPTEN_EMCC)" \
 		WASM2WAT="$(DEPS_WABT_WASM2WAT)" \
 		WASM2JS="$(DEPS_EMSDK_EMSCRIPTEN_WASM2JS)" \

tools/scripts/compile_wasm

@@ -29,7 +29,9 @@
 #
 #   NODE            Command for running Node.js. Default: `node`.
 #   NODE_PATH       Path for resolving node modules.
-#   EMCCC_COMPILER  Emscripten C compiler. Default: `emcc`.
+#   CLANG_COMPILER  LLVM Clang compiler. Default: `clang`.
+#   CLANG_SYSROOT   Path to a C standard library.
+#   EMCC_COMPILER   Emscripten C compiler. Default: `emcc`.
 #   WASM2WAT        Command for converting WebAssembly binary format to text format. Default. `wasm2wat`.
 #   WASM2JS         Command for converting WebAssembly binary format to JavaScript. Default. `wasm2js`.
 #   SRC_FOLDER      Folder containing source files. Default: `src`.
@@ -56,6 +58,12 @@ fi
 # Define the node path:
 node_path="${NODE_PATH}"
 
+# Define the path to the LLVM `clang` compiler:
+clang_compiler="${CLANG_COMPILER}"
+if [[ -z "${clang_compiler}" ]]; then
+	clang_compiler='clang'
+fi
+
 # Define the path to the Emscripten `emcc` compiler:
 emcc_compiler="${EMCC_COMPILER}"
 if [[ -z "${emcc_compiler}" ]]; then
@@ -80,6 +88,9 @@ if [[ -z "${src_folder}" ]]; then
 	src_folder='src'
 fi
 
+# Define a path to a C standard library:
+clang_sysroot="${CLANG_SYSROOT}"
+
 # Define a list of external `include` directories:
 include="${INCLUDE}"
 
@@ -201,7 +212,7 @@ resolve_libpaths() {
 #
 # $1 - source directory
 compile() {
-	cd "$1" && EMCC_COMPILER="${emcc_compiler}" WASM2WAT="${wasm_to_wat}" WASM2JS="${wasm_to_js}" INCLUDE="${include}" SOURCE_FILES="${source_files}" LIBRARIES="${libraries}" LIBPATH="${libpath}" make wasm 2>&1
+	cd "$1" && CLANG_COMPILER="${clang_compiler}" CLANG_SYSROOT="${clang_sysroot}" EMCC_COMPILER="${emcc_compiler}" WASM2WAT="${wasm_to_wat}" WASM2JS="${wasm_to_js}" INCLUDE="${include}" SOURCE_FILES="${source_files}" LIBRARIES="${libraries}" LIBPATH="${libpath}" make wasm 2>&1
 	if [[ "$?" -ne 0 ]]; then
 		echo 'Error when attempting to compile WebAssembly.' >&2
 		return 1