Files
Jonathan Hui 27321a2110 [nexus] add WebAssembly support using Emscripten (#12904)
This commit adds support for building the Nexus simulator for
WebAssembly (WASM) using the Emscripten toolchain. This enables the
simulator to run in a web browser environment with a JavaScript-based
control interface and visualization.

Key implementation details:
- Introduced `nexus_wasm.cpp` which defines Emscripten bindings (using
  Embind) for core simulation controls, including stepping time,
  node creation, topology orchestration, and state manipulation.
- Implemented a `WasmObserver` and a global event queue to capture
  simulation events (node state changes, link updates, packet events)
  and expose them to JavaScript via a polling mechanism (`pollEvent`).
- Updated the CMake build system to support the `EMSCRIPTEN` platform,
  configuring specific linker options for ES6 module export,
  modularization, and memory growth.
- Enhanced `build.sh` to allow targeting WASM via `emcmake`.
- Guarded file-system-dependent operations in `nexus_pcap.cpp` and
  adjusted `nexus_core.cpp` to handle WASM-specific constraints where
  standard I/O or multiple observers might not be applicable.
- Added `test_wasm_bindings.mjs`, a Node.js-based smoke test that
  verifies the integrity of the WASM bindings and event pipeline.
- Integrated `nexus-wasm-tests` into the GitHub Actions workflow to
  ensure continuous verification of the WASM build and functionality.
2026-04-17 15:25:28 -05:00

98 lines
5.0 KiB
C++

/*
* Copyright (c) 2024, The OpenThread Authors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef OT_NEXUS_PLATFORM_NEXUS_UTILS_HPP_
#define OT_NEXUS_PLATFORM_NEXUS_UTILS_HPP_
#include <stdio.h>
#include <stdlib.h>
#include "common/arg_macros.hpp"
#include <openthread/link.h>
/**
* Verifies a given error status to be successful (compared against value zero (0)), otherwise, it emits a
* given error messages and exits the program.
*
* @param[in] aStatus A scalar error status to be evaluated against zero (0).
* @param[in] aMessage An optional message (constant C string) to print on failure.
*/
#define SuccessOrQuit(...) \
do \
{ \
if ((OT_FIRST_ARG(__VA_ARGS__)) != 0) \
{ \
fprintf(stderr, "\nFAILED %s:%d - SuccessOrQuit(%s)" OT_SECOND_ARG(__VA_ARGS__) "\n", __FUNCTION__, \
__LINE__, _Stringize(OT_FIRST_ARG(__VA_ARGS__))); \
exit(-1); \
} \
} while (false)
/**
* Verifies that a given boolean condition is true, otherwise, it emits a given error message and exits the
* program.
*
* @param[in] aCondition A Boolean expression to be evaluated.
* @param[in] aMessage An optional message (constant C string) to print on failure.
*/
#define VerifyOrQuit(...) \
do \
{ \
if (!(OT_FIRST_ARG(__VA_ARGS__))) \
{ \
fprintf(stderr, "\nFAILED %s:%d - VerifyOrQuit(%s) " OT_SECOND_ARG(__VA_ARGS__) "\n", __FUNCTION__, \
__LINE__, _Stringize(OT_FIRST_ARG(__VA_ARGS__))); \
exit(-1); \
} \
} while (false)
// Private macros to convert `aArg` to string
#define _Stringize(aArg) _Stringize2(aArg)
#define _Stringize2(aArg) #aArg
namespace ot {
namespace Nexus {
/**
* Invalid Node ID.
*/
static constexpr uint32_t kInvalidNodeId = 0xffffffff;
/**
* CSL period constants in units of 10 symbols.
*/
static constexpr uint16_t kCslPeriod500ms = 500 * 1000 / OT_US_PER_TEN_SYMBOLS;
static constexpr uint16_t kCslPeriod3300ms = 3300 * 1000 / OT_US_PER_TEN_SYMBOLS;
static constexpr uint16_t kCslPeriod400ms = 400 * 1000 / OT_US_PER_TEN_SYMBOLS;
} // namespace Nexus
} // namespace ot
#endif // OT_NEXUS_PLATFORM_NEXUS_UTILS_HPP_