/src/WasmEdge/lib/loader/ast/component/component_canonical.cpp

Source
// SPDX-License-Identifier: Apache-2.0
// SPDX-FileCopyrightText: Copyright The WasmEdge Authors

#include "loader/loader.h"

#include "common/component_valtype.h"

namespace WasmEdge {
namespace Loader {

Expect<void> Loader::loadCanonical(AST::Component::Canonical &C) {
  auto ReportError = [this](auto E) {
    return logLoadError(E, FMgr.getLastOffset(), ASTNodeAttr::Comp_Canonical);
  };
  // canon ::= 0x00 0x00 f:<core:funcidx> opts:<opts> ft:<typeidx>
  //           => (canon lift f opts type-index-space[ft])
  //         | 0x01 0x00 f:<funcidx> opts:<opts>
  //           => (canon lower f opts (core func))
  //         | 0x02 rt:<typeidx>    => (canon resource.new rt (core func))
  //         | 0x03 rt:<typeidx>    => (canon resource.drop rt (core func))
  //         | 0x04 rt:<typeidx>    => (canon resource.rep rt (core func))
  //         | 0x09 rs:<resultlist> opts:<opts>
  //           => (canon task.return rs opts (core func)) 🔀
  //         | 0x05                 => (canon task.cancel (core func)) 🔀
  //         | 0x0a t:<core:valtype> i:<u32>
  //           => (canon context.get t i (core func)) 🔀
  //         | 0x0b t:<core:valtype> i:<u32>
  //           => (canon context.set t i (core func)) 🔀
  //         | 0x0c 0x00
  //           => (canon thread.yield (core func)) 🔀
  //         | 0x06 async?:<async?>
  //           => (canon subtask.cancel async? (core func)) 🔀
  //         | 0x0d                 => (canon subtask.drop (core func)) 🔀
  //         | 0x0e t:<typeidx>     => (canon stream.new t (core func)) 🔀
  //         | 0x0f t:<typeidx> opts:<opts>
  //           => (canon stream.read t opts (core func)) 🔀
  //         | 0x10 t:<typeidx> opts:<opts>
  //           => (canon stream.write t opts (core func)) 🔀
  //         | 0x11 t:<typeidx> async?:<async?>
  //           => (canon stream.cancel-read t async? (core func)) 🔀
  //         | 0x12 t:<typeidx> async?:<async?>
  //           => (canon stream.cancel-write t async? (core func)) 🔀
  //         | 0x13 t:<typeidx>
  //           => (canon stream.drop-readable t (core func)) 🔀
  //         | 0x14 t:<typeidx>
  //           => (canon stream.drop-writable t (core func)) 🔀
  //         | 0x2e t:<typeidx> => (canon stream.forward t (core func)) ➡️
  //         | 0x15 t:<typeidx> => (canon future.new t (core func)) 🔀
  //         | 0x16 t:<typeidx> opts:<opts>
  //           => (canon future.read t opts (core func)) 🔀
  //         | 0x17 t:<typeidx> opts:<opts>
  //           => (canon future.write t opts (core func)) 🔀
  //         | 0x18 t:<typeidx> async?:<async?>
  //           => (canon future.cancel-read t async? (core func)) 🔀
  //         | 0x19 t:<typeidx> async?:<async?>
  //           => (canon future.cancel-write t async? (core func)) 🔀
  //         | 0x1a t:<typeidx>
  //           => (canon future.drop-readable t (core func)) 🔀
  //         | 0x1b t:<typeidx>
  //           => (canon future.drop-writable t (core func)) 🔀
  //         | 0x2f t:<typeidx> => (canon future.forward t (core func)) ➡️
  //         | 0x1c opts:<opts> => (canon error-context.new opts (core func)) 📝
  //         | 0x1d opts:<opts>
  //           => (canon error-context.debug-message opts (core func)) 📝
  //         | 0x1e                => (canon error-context.drop (core func)) 📝
  //         | 0x1f                => (canon waitable-set.new (core func)) 🔀
  //         | 0x20 0x00 m:<core:memoryidx>
  //           => (canon waitable-set.wait (memory m) (core func)) 🔀
  //         | 0x21 0x00 m:<core:memoryidx>
  //           => (canon waitable-set.poll (memory m) (core func)) 🔀
  //         | 0x22                => (canon waitable-set.drop (core func)) 🔀
  //         | 0x23                => (canon waitable.join (core func)) 🔀
  //         | 0x24                => (canon backpressure.inc (core func)) 🔀
  //         | 0x25                => (canon backpressure.dec (core func)) 🔀
  //         | 0x26                => (canon thread.index (core func)) 🧵
  //         | 0x27 ft:<core:typeidx> t:<core:tableidx>
  //           => (canon thread.new-indirect ft t (core func)) 🧵
  //         | 0x28                => (canon thread.resume-later (core func)) 🧵
  //         | 0x29 0x00
  //           => (canon thread.suspend (core func)) 🧵
  //         | 0x2a 0x00
  //           => (canon thread.suspend-then-resume (core func)) 🧵
  //         | 0x2b 0x00
  //           => (canon thread.yield-then-resume (core func)) 🧵
  //         | 0x2c 0x00
  //           => (canon thread.suspend-then-promote (core func)) 🧵
  //         | 0x2d 0x00
  //           => (canon thread.yield-then-promote (core func)) 🧵
  //         | 0x40 sh?:<sh?> ft:<core:typeidx>
  //           => (canon thread.spawn-ref sh? ft (core func)) 🧵②
  //         | 0x41 sh?:<sh?> ft:<core:typeidx> t:<core:tableidx>
  //           => (canon thread.spawn-indirect sh? ft t (core func)) 🧵②
  //         | 0x42 sh?:<sh?>
  //           => (canon thread.available-parallelism sh? (core func)) 🧵②
  // async?  ::= 0x00 => ϵ
  //           | 0x01 => async
  // sh?     ::= 0x00 => ϵ
  //           | 0x01 => shared 🧵②

  // Helper: load the vestigial 0x00 of the thread.* and waitable-set.*
  // built-ins.
  auto LoadReservedByte = [this, &ReportError]() -> Expect<void> {
    EXPECTED_TRY(uint8_t B, FMgr.readByte().map_error(ReportError));
    if (B != 0x00) {
      return ReportError(ErrCode::Value::NonZeroReservedByte);
    }
    return {};
  };

  // Helper: load the async? immediate.
  auto LoadFlagImm = [this, &ReportError, &C]() -> Expect<void> {
    EXPECTED_TRY(uint8_t B, FMgr.readByte().map_error(ReportError));
    if (B == 0x00) {
      C.setFlagImmediate(false);
    } else if (B == 0x01) {
      C.setFlagImmediate(true);
    } else {
      return ReportError(ErrCode::Value::MalformedCanonical);
    }
    return {};
  };

  // Helper: load the 🧵② shared? flag.
  auto LoadShared = [this, &ReportError]() -> Expect<void> {
    EXPECTED_TRY(uint8_t B, FMgr.readByte().map_error(ReportError));
    if (B > 0x01) {
      return ReportError(ErrCode::Value::MalformedCanonical);
    }
    return {};
  };

  // Helper: load opts (vec of canonopt).
  auto LoadOpts = [this, &C]() -> Expect<void> {
    std::vector<AST::Component::CanonOpt> Opts;
    EXPECTED_TRY(loadVec<AST::Component::Canonical>(
        Opts, [this](AST::Component::CanonOpt &Opt) {
          return loadCanonicalOption(Opt);
        }));
    C.setOptions(std::move(Opts));
    return {};
  };

  EXPECTED_TRY(uint8_t Flag, FMgr.readByte().map_error(ReportError));
  auto Code = static_cast<ComponentCanonOpCode>(Flag);
  switch (Code) {

  // 0x00 0x00 f:<core:funcidx> opts:<opts> ft:<typeidx>
  case ComponentCanonOpCode::Lift: {
    EXPECTED_TRY(uint8_t B, FMgr.readByte().map_error(ReportError));
    if (unlikely(B != 0x00)) {
      return ReportError(ErrCode::Value::MalformedCanonical);
    }
    EXPECTED_TRY(uint32_t Idx, FMgr.readU32().map_error(ReportError));
    C.setIndex(Idx);
    EXPECTED_TRY(LoadOpts());
    EXPECTED_TRY(uint32_t TypeIdx, FMgr.readU32().map_error(ReportError));
    C.setTargetIndex(TypeIdx);
    break;
  }

  // 0x01 0x00 f:<funcidx> opts:<opts>
  case ComponentCanonOpCode::Lower: {
    EXPECTED_TRY(uint8_t B, FMgr.readByte().map_error(ReportError));
    if (unlikely(B != 0x00)) {
      return ReportError(ErrCode::Value::MalformedCanonical);
    }
    EXPECTED_TRY(uint32_t Idx, FMgr.readU32().map_error(ReportError));
    C.setIndex(Idx);
    EXPECTED_TRY(LoadOpts());
    break;
  }

  // typeidx-only opcodes
  case ComponentCanonOpCode::Resource__new:
  case ComponentCanonOpCode::Resource__drop:
  case ComponentCanonOpCode::Resource__rep:
  case ComponentCanonOpCode::Stream__new:
  case ComponentCanonOpCode::Stream__drop_readable:
  case ComponentCanonOpCode::Stream__drop_writable:
  case ComponentCanonOpCode::Stream__forward:
  case ComponentCanonOpCode::Future__new:
  case ComponentCanonOpCode::Future__drop_readable:
  case ComponentCanonOpCode::Future__drop_writable:
  case ComponentCanonOpCode::Future__forward: {
    EXPECTED_TRY(uint32_t Idx, FMgr.readU32().map_error(ReportError));
    C.setIndex(Idx);
    break;
  }

  // no-arg opcodes
  case ComponentCanonOpCode::Backpressure__inc:
  case ComponentCanonOpCode::Backpressure__dec:
  case ComponentCanonOpCode::Thread__index:
  case ComponentCanonOpCode::Thread__resume_later:
  case ComponentCanonOpCode::Task__cancel:
  case ComponentCanonOpCode::Subtask__drop:
  case ComponentCanonOpCode::Error_context__drop:
  case ComponentCanonOpCode::Waitable_set__new:
  case ComponentCanonOpCode::Waitable_set__drop:
  case ComponentCanonOpCode::Waitable__join:
    break;

  // 0x09 rs:<resultlist> opts:<opts>
  case ComponentCanonOpCode::Task__return: {
    // resultlist ::= 0x00 t:<valtype> => (result t)
    //              | 0x01 0x00        => ϵ
    EXPECTED_TRY(uint8_t RFlag, FMgr.readByte().map_error(ReportError));
    switch (RFlag) {
    case 0x00: {
      ComponentValType VT;
      EXPECTED_TRY(loadType(VT).map_error([](auto E) {
        spdlog::error(ErrInfo::InfoAST(ASTNodeAttr::Comp_Canonical));
        return E;
      }));
      C.setResult(VT);
      break;
    }
    case 0x01: {
      EXPECTED_TRY(uint8_t B, FMgr.readByte().map_error(ReportError));
      if (B != 0x00) {
        return ReportError(ErrCode::Value::MalformedCanonical);
      }
      C.setResult(std::nullopt);
      break;
    }
    default:
      return ReportError(ErrCode::Value::MalformedCanonical);
    }
    EXPECTED_TRY(LoadOpts());
    break;
  }

  // 0x0a t:<core:valtype> i:<u32> and 0x0b t:<core:valtype> i:<u32>
  case ComponentCanonOpCode::Context__get:
  case ComponentCanonOpCode::Context__set: {
    EXPECTED_TRY(ValType T, loadValType(ASTNodeAttr::Comp_Canonical));
    C.setContextType(T);
    EXPECTED_TRY(uint32_t Val, FMgr.readU32().map_error(ReportError));
    C.setConstVal(Val);
    break;
  }

  // 0x06 async?:<async?>
  case ComponentCanonOpCode::Subtask__cancel: {
    EXPECTED_TRY(LoadFlagImm());
    break;
  }

  // 0x00-suffixed opcodes
  case ComponentCanonOpCode::Thread__yield:
  case ComponentCanonOpCode::Thread__suspend:
  case ComponentCanonOpCode::Thread__suspend_then_resume:
  case ComponentCanonOpCode::Thread__yield_then_resume:
  case ComponentCanonOpCode::Thread__suspend_then_promote:
  case ComponentCanonOpCode::Thread__yield_then_promote: {
    EXPECTED_TRY(LoadReservedByte());
    break;
  }

  // typeidx + opts opcodes
  case ComponentCanonOpCode::Stream__read:
  case ComponentCanonOpCode::Stream__write:
  case ComponentCanonOpCode::Future__read:
  case ComponentCanonOpCode::Future__write: {
    EXPECTED_TRY(uint32_t Idx, FMgr.readU32().map_error(ReportError));
    C.setIndex(Idx);
    EXPECTED_TRY(LoadOpts());
    break;
  }

  // typeidx + async? opcodes
  case ComponentCanonOpCode::Stream__cancel_read:
  case ComponentCanonOpCode::Stream__cancel_write:
  case ComponentCanonOpCode::Future__cancel_read:
  case ComponentCanonOpCode::Future__cancel_write: {
    EXPECTED_TRY(uint32_t Idx, FMgr.readU32().map_error(ReportError));
    C.setIndex(Idx);
    EXPECTED_TRY(LoadFlagImm());
    break;
  }

  // opts-only opcodes
  case ComponentCanonOpCode::Error_context__new:
  case ComponentCanonOpCode::Error_context__debug_message: {
    EXPECTED_TRY(LoadOpts());
    break;
  }

  // 0x00 + memidx opcodes
  case ComponentCanonOpCode::Waitable_set__wait:
  case ComponentCanonOpCode::Waitable_set__poll: {
    EXPECTED_TRY(LoadReservedByte());
    EXPECTED_TRY(uint32_t MemIdx, FMgr.readU32().map_error(ReportError));
    C.setIndex(MemIdx);
    break;
  }

  // 0x27 ft:<core:typeidx> t:<core:tableidx>
  case ComponentCanonOpCode::Thread__new_indirect: {
    EXPECTED_TRY(uint32_t TypeIdx, FMgr.readU32().map_error(ReportError));
    C.setIndex(TypeIdx);
    EXPECTED_TRY(uint32_t TblIdx, FMgr.readU32().map_error(ReportError));
    C.setTargetIndex(TblIdx);
    break;
  }

  // 🧵② shared?-prefixed opcodes. The flag is parsed but not kept, because
  // these built-ins belong to shared-everything-threads and are not
  // instantiated.
  case ComponentCanonOpCode::Thread__spawn_ref: {
    EXPECTED_TRY(LoadShared());
    EXPECTED_TRY(uint32_t TypeIdx, FMgr.readU32().map_error(ReportError));
    C.setIndex(TypeIdx);
    break;
  }
  case ComponentCanonOpCode::Thread__spawn_indirect: {
    EXPECTED_TRY(LoadShared());
    EXPECTED_TRY(uint32_t TypeIdx, FMgr.readU32().map_error(ReportError));
    C.setIndex(TypeIdx);
    EXPECTED_TRY(uint32_t TblIdx, FMgr.readU32().map_error(ReportError));
    C.setTargetIndex(TblIdx);
    break;
  }
  case ComponentCanonOpCode::Thread__available_parallelism:
    EXPECTED_TRY(LoadShared());
    break;

  default:
    return ReportError(ErrCode::Value::MalformedCanonical);
  }
  C.setOpCode(Code);
  return {};
}

Expect<void> Loader::loadCanonicalOption(AST::Component::CanonOpt &Opt) {
  auto ReportError = [this](auto E) {
    return logLoadError(E, FMgr.getLastOffset(), ASTNodeAttr::Comp_CanonOpt);
  };
  // canonopt ::= 0x00                  => string-encoding=utf8
  //            | 0x01                  => string-encoding=utf16
  //            | 0x02                  => string-encoding=latin1+utf16
  //            | 0x03 m:<core:memidx>  => (memory m)
  //            | 0x04 f:<core:funcidx> => (realloc f)
  //            | 0x05 f:<core:funcidx> => (post-return f)
  //            | 0x06                  => async 🔀
  //            | 0x07 f:<core:funcidx> => (callback f) 🔀

  EXPECTED_TRY(uint8_t Flag, FMgr.readByte().map_error(ReportError));
  const auto Code = static_cast<ComponentCanonOptCode>(Flag);
  switch (Code) {
  case ComponentCanonOptCode::Encode_UTF8:
  case ComponentCanonOptCode::Encode_UTF16:
  case ComponentCanonOptCode::Encode_Latin1:
  case ComponentCanonOptCode::Async:
    break;
  case ComponentCanonOptCode::Memory:
  case ComponentCanonOptCode::Realloc:
  case ComponentCanonOptCode::PostReturn:
  case ComponentCanonOptCode::Callback: {
    EXPECTED_TRY(uint32_t Idx, FMgr.readU32().map_error(ReportError));
    Opt.setIndex(Idx);
    break;
  }
  default:
    return ReportError(ErrCode::Value::UnknownCanonicalOption);
  }
  Opt.setCode(Code);
  return {};
}

} // namespace Loader
} // namespace WasmEdge

Coverage Report

Created: 2026-11-12 06:35