This repository has been archived on 2023-11-05. You can view files and clone it, but cannot push or open issues or pull requests.
wasm-micro-runtime/doc/port_wamr.md
wenyongh 46b93b9d22 Enable AoT and wamr-sdk, and change arguments of call wasm API (#157)
* Implement memory profiler, optimize memory usage, modify code indent

* Implement memory.grow and limit heap space base offset to 1G; modify iwasm build type to Release and 64 bit by default

* Add a new extension library: connection

* Fix bug of reading magic number and version in big endian platform

* Re-org platform APIs: move most platform APIs from iwasm to shared-lib

* Enhance wasm loader to fix some security issues

* Fix issue about illegal load of EXC_RETURN into PC on stm32 board

* Updates that let a restricted version of the interpreter run in SGX

* Enable native/app address validation and conversion for wasm app

* Remove wasm_application_exectue_* APIs from wasm_export.h which makes confused

* Refine binary size and fix several minor issues

Optimize interpreter LOAD/STORE opcodes to decrease the binary size
Fix issues when using iwasm library: _bh_log undefined, bh_memory.h not found
Remove unused _stdin/_stdout/_stderr global variables resolve in libc wrapper
Add macros of global heap size, stack size, heap size for Zephyr main.c
Clear compile warning of wasm_application.c

* Add more strict security checks for libc wrapper API's

* Use one libc wrapper copy for sgx and other platforms; remove bh_printf macro for other platform header files

* Enhance security of libc strcpy/sprintf wrapper function

* Fix issue of call native for x86_64/arm/mips, add module inst parameter for native wrapper functions

* Remove get_module_inst() and fix issue of call native

* Refine wgl lib: remove module_inst parameter from widget functions; move function index check to runtime instantiate

* Refine interpreter call native process, refine memory boudary check

* Fix issues of invokeNative function of arm/mips/general version

* Add a switch to build simple sample without gui support

* Add BUILD_TARGET setting in makefile to replace cpu compiler flags in source code

* Re-org shared lib header files, remove unused info; fix compile issues of vxworks

* Add build target general

* Remove unused files

* Update license header

* test push

* Restore file

* Sync up with internal/feature

* Sync up with internal/feature

* Rename build_wamr_app to build_wasm_app

* Fix small issues of README

* Enhance malformed wasm file checking
Fix issue of print hex int and implement utf8 string check
Fix wasi file read/write right issue
Fix minor issue of build wasm app doc

* Sync up with internal/feature

* Sync up with internal/feature: fix interpreter arm issue, fix read leb issue

* Sync up with internal/feature

* Fix bug of config.h and rename wasi config.h to ssp_config.h

* Sync up with internal/feature

* Import wamr aot

* update document

* update document

* Update document, disable WASI in 32bit

* update document

* remove files

* update document

* Update document

* update document

* update document

* update samples

* Sync up with internal repo
2020-01-21 13:26:14 +08:00

2.8 KiB

WAMR porting guide

This document describes how to port WAMR to a new platform "super-os"

Step 1: Create folders for the new platform


Create folders:

  • core/shared/platform/super-os: for platform API layer implementations
  • product-mini/platforms/super-os: for the platform mini product build

Step 2: Implement platform API layer


Implement folder core/shared/platform/super-os. Normally in this folder you should implement the following files:

  • bh_platform.h and bh_platform.c: define the platform related macros, data types and APIs.
  • bh_assert.c: implement function bh_assert_internal() and bh_debug_internal().
  • bh_definition.c: implement function b_memcpy_s, b_strcat_s and b_strcpy_s. And implement fopen_s if we need to read wasm file from file system.
  • bh_platform_log.c: implement function bh_log_emit, bh_fprintf and bh_fflush.
  • bh_time.c: implement several time related functions.
  • bh_thread.c: implement thread, mutex, condition related functions.
  • bh_math.c: implement some math functions if the platform doesn't support them, e.g. sqrt, fabs and isnan. We may use the open source fdlibm implementation, for example, ref to platform/zephyr/bh_math.c.

Please ref to implementation of other platform for more details, e.g. platform/zephyr, platform/linux.

Step 3: Create the mini product build for the platform


Implement folder product-mini/platforms/super-os. Normally this folder is to implement the C main function, and generate a WAMR VM core binary named iwasm which can load and run wasm apps. We should implement following files:

  • main.c: implement the C main function, which reads wasm file to buffer, loads the wasm file to wasm module, instantiate the module, lookup wasm app main function, and then execute the function.
  • ext_lib_export.c: implement the native APIs if you want, and if no native API is to be implemented, just keep array extended_native_symbol_defs empty.
  • CMakeLists.txt: there are some settings which can be passed from cmake variables:
    • set (WAMR_BUILD_PLATFORM "platform_name"): set the name of the platform
    • set (WAMR_BUILD_TARGET ): set the build target, currently the value supported: X86_64, X86_32, ARM[sub], THUMB[sub], MIPS and XTENSA. For ARM and THUMB, you can specify the sub version, e.g. ARMV4, ARMV7, THUMBV4T, THUMBV7T.
    • set (WAMR_BUILD_INTERP 1 or 0): whether to interpreter or not
    • set (WAMR_BUILD_AOT 1 or 0): whether to build AOT or not
    • set (WAMR_BUILD_JIT 1 or 0): whether to build JIT or not
    • set (WAMR_BUILD_LIBC_BUILTIN 1 or 0): whether to build Libc builtin or not
    • set (WAMR_BUILD_LIBC_WASI 1 or 0): whether to build Libc WASI or not