Coverage Report

Created: 2025-07-11 06:21

/src/WasmEdge/lib/loader/ast/segment.cpp
Line
Count
Source (jump to first uncovered line)
1
// SPDX-License-Identifier: Apache-2.0
2
// SPDX-FileCopyrightText: 2019-2024 Second State INC
3
4
#include "loader/loader.h"
5
6
namespace WasmEdge {
7
namespace Loader {
8
9
// Load binary of TableSegment node. See "include/loader/loader.h".
10
586
Expect<void> Loader::loadSegment(AST::TableSegment &TabSeg) {
11
  // Check the first byte is the reftype in table type or not.
12
586
  EXPECTED_TRY(uint8_t CheckByte, FMgr.peekByte().map_error([this](auto E) {
13
579
    return logLoadError(E, FMgr.getLastOffset(), ASTNodeAttr::Seg_Table);
14
579
  }));
15
16
579
  if (CheckByte == 0x40U) {
17
    // Table segment case is for FunctionReferences proposal.
18
3
    if (!Conf.hasProposal(Proposal::FunctionReferences)) {
19
3
      return logNeedProposal(ErrCode::Value::MalformedTable,
20
3
                             Proposal::FunctionReferences, FMgr.getLastOffset(),
21
3
                             ASTNodeAttr::Seg_Table);
22
3
    }
23
0
    FMgr.readByte();
24
25
    // Check the second byte.
26
0
    EXPECTED_TRY(uint8_t B, FMgr.readByte().map_error([this](auto E) {
27
0
      return logLoadError(E, FMgr.getLastOffset(), ASTNodeAttr::Seg_Table);
28
0
    }));
29
0
    if (B != 0x00U) {
30
0
      return logLoadError(ErrCode::Value::MalformedTable, FMgr.getLastOffset(),
31
0
                          ASTNodeAttr::Seg_Table);
32
0
    }
33
34
    // Read the table type.
35
0
    EXPECTED_TRY(loadType(TabSeg.getTableType()).map_error([](auto E) {
36
0
      spdlog::error(ErrInfo::InfoAST(ASTNodeAttr::Seg_Table));
37
0
      return E;
38
0
    }));
39
40
    // Read the expression.
41
0
    EXPECTED_TRY(loadExpression(TabSeg.getExpr()).map_error([](auto E) {
42
0
      spdlog::error(ErrInfo::InfoAST(ASTNodeAttr::Seg_Table));
43
0
      return E;
44
0
    }));
45
576
  } else {
46
    // The table type case.
47
576
    EXPECTED_TRY(loadType(TabSeg.getTableType()).map_error([](auto E) {
48
576
      spdlog::error(ErrInfo::InfoAST(ASTNodeAttr::Seg_Table));
49
576
      return E;
50
576
    }));
51
576
  }
52
53
526
  return {};
54
579
}
55
56
// Load binary of GlobalSegment node. See "include/loader/loader.h".
57
930
Expect<void> Loader::loadSegment(AST::GlobalSegment &GlobSeg) {
58
930
  return Expect<void>{}
59
930
      .and_then([this, &GlobSeg]() {
60
        // Read global type node.
61
930
        return loadType(GlobSeg.getGlobalType());
62
930
      })
63
930
      .and_then([this, &GlobSeg]() {
64
        // Read the expression.
65
883
        return loadExpression(GlobSeg.getExpr());
66
883
      })
67
930
      .map_error([](auto E) {
68
427
        spdlog::error(ErrInfo::InfoAST(ASTNodeAttr::Seg_Global));
69
427
        return E;
70
427
      });
71
930
}
72
73
// Load binary of ElementSegment node. See "include/loader/loader.h".
74
6.15k
Expect<void> Loader::loadSegment(AST::ElementSegment &ElemSeg) {
75
6.15k
  auto ReportError = [this](auto E) {
76
77
    return logLoadError(E, FMgr.getLastOffset(), ASTNodeAttr::Seg_Element);
77
77
  };
78
79
  // Element segment binary format:
80
  // ---------------------------------------------------------------------------
81
  //  Mode | TableIdx | OffExpr | ElemKind | RefType | vec(FuncIdx) | vec(expr)
82
  // ------|----------|---------|----------|---------|--------------|-----------
83
  //    0  |          |    v    |          |         |       v      |
84
  //    1  |          |         |    v     |         |       v      |
85
  //    2  |    v     |    v    |    v     |         |       v      |
86
  //    3  |          |         |    v     |         |       v      |
87
  //    4  |          |    v    |          |         |              |     v
88
  //    5  |          |         |          |    v    |              |     v
89
  //    6  |    v     |    v    |          |    v    |              |     v
90
  //    7  |          |         |          |    v    |              |     v
91
  // ---------------------------------------------------------------------------
92
  // Mode: element initial integer, u32
93
  // TableIdx: target table index, u32
94
  // OffExpr: init offset expression, expr
95
  // ElemKind: byte 0x00, ref.func
96
  // RefType: reference type, RefType
97
  // vec(FuncIdx): function index vector, vec(u32)
98
  // vec(expr): reference init list, vec(expr)
99
100
  // Read the checking byte.
101
6.15k
  uint32_t Check = 0;
102
6.15k
  if (unlikely(!Conf.hasProposal(Proposal::BulkMemoryOperations) &&
103
6.15k
               !Conf.hasProposal(Proposal::ReferenceTypes))) {
104
    // Legacy for BulkMemoryOperations and ReferenceTypes proposals turned off.
105
    // Element segment binary format: TableIdx + OffExpr + vec(FuncIdx)
106
0
    EXPECTED_TRY(FMgr.readU32().map_error(ReportError).map([&](auto Idx) {
107
0
      ElemSeg.setIdx(Idx);
108
0
    }));
109
6.15k
  } else {
110
6.15k
    EXPECTED_TRY(Check, FMgr.readU32().map_error(ReportError));
111
6.14k
  }
112
113
  // Check the prefix byte.
114
6.14k
  switch (Check) {
115
2.59k
  case 0x00:
116
3.56k
  case 0x02:
117
4.66k
  case 0x04:
118
4.78k
  case 0x06:
119
4.78k
    ElemSeg.setMode(AST::ElementSegment::ElemMode::Active);
120
4.78k
    break;
121
122
897
  case 0x01:
123
994
  case 0x05:
124
994
    ElemSeg.setMode(AST::ElementSegment::ElemMode::Passive);
125
994
    break;
126
127
206
  case 0x03:
128
320
  case 0x07:
129
320
    ElemSeg.setMode(AST::ElementSegment::ElemMode::Declarative);
130
320
    break;
131
132
41
  default:
133
    // TODO: Correctness the error code once there's spec test.
134
41
    return logLoadError(ErrCode::Value::IllegalGrammar, FMgr.getLastOffset(),
135
41
                        ASTNodeAttr::Seg_Element);
136
6.14k
  }
137
138
  // Read the table index.
139
6.09k
  ElemSeg.setIdx(0);
140
6.09k
  switch (Check) {
141
971
  case 0x02:
142
1.09k
  case 0x06:
143
1.09k
    EXPECTED_TRY(FMgr.readU32().map_error(ReportError).map([&](auto Idx) {
144
1.09k
      ElemSeg.setIdx(Idx);
145
1.09k
    }));
146
1.09k
    break;
147
148
5.00k
  default:
149
5.00k
    break;
150
6.09k
  }
151
152
  // Read the expression.
153
6.09k
  switch (Check) {
154
2.59k
  case 0x00:
155
3.56k
  case 0x02:
156
4.65k
  case 0x04:
157
4.78k
  case 0x06:
158
4.78k
    EXPECTED_TRY(loadExpression(ElemSeg.getExpr()).map_error([](auto E) {
159
3.88k
      spdlog::error(ErrInfo::InfoAST(ASTNodeAttr::Seg_Element));
160
3.88k
      return E;
161
3.88k
    }));
162
3.88k
    break;
163
164
3.88k
  default:
165
1.31k
    break;
166
6.09k
  }
167
168
  // Read element kind and init function indices.
169
5.19k
  switch (Check) {
170
897
  case 0x01:
171
1.84k
  case 0x02:
172
2.05k
  case 0x03:
173
2.05k
    EXPECTED_TRY(FMgr.readByte()
174
2.03k
                     .and_then([&](auto B) -> Expect<void> {
175
2.03k
                       if (B != 0x00U) {
176
2.03k
                         return Unexpect(ErrCode::Value::ExpectedZeroByte);
177
2.03k
                       };
178
2.03k
                       return {};
179
2.03k
                     })
180
2.03k
                     .map_error(ReportError));
181
2.03k
    [[fallthrough]];
182
183
4.00k
  case 0x00: {
184
4.00k
    EXPECTED_TRY(uint32_t VecCnt, loadVecCnt().map_error(ReportError));
185
14.6k
    for (uint32_t I = 0; I < VecCnt; ++I) {
186
      // For each element in vec(funcidx), make expr(ref.func idx end).
187
10.7k
      ElemSeg.getInitExprs().emplace_back();
188
10.7k
      AST::Instruction RefFunc(OpCode::Ref__func);
189
10.7k
      AST::Instruction End(OpCode::End);
190
10.7k
      EXPECTED_TRY(loadInstruction(RefFunc).map_error([](auto E) {
191
10.7k
        spdlog::error(ErrInfo::InfoAST(ASTNodeAttr::Seg_Element));
192
10.7k
        return E;
193
10.7k
      }));
194
10.7k
      ElemSeg.getInitExprs().back().getInstrs().emplace_back(
195
10.7k
          std::move(RefFunc));
196
10.7k
      ElemSeg.getInitExprs().back().getInstrs().emplace_back(std::move(End));
197
10.7k
    }
198
3.94k
    break;
199
3.95k
  }
200
3.94k
  default:
201
1.17k
    break;
202
5.19k
  }
203
204
  // Set the default reference type.
205
5.11k
  if (Check == 0x04) {
206
877
    ElemSeg.setRefType(TypeCode::FuncRef);
207
4.24k
  } else {
208
4.24k
    ElemSeg.setRefType(ValType(TypeCode::Ref, TypeCode::FuncRef));
209
4.24k
  }
210
211
  // Read the reference type and init expressions.
212
5.11k
  switch (Check) {
213
97
  case 0x05:
214
185
  case 0x06:
215
299
  case 0x07: {
216
    // The AST node information is handled.
217
299
    EXPECTED_TRY(auto Type, loadRefType(ASTNodeAttr::Seg_Element));
218
287
    ElemSeg.setRefType(Type);
219
287
    [[fallthrough]];
220
287
  }
221
1.16k
  case 0x04: {
222
1.16k
    return loadVec<AST::ElementSegment>(
223
3.34k
        ElemSeg.getInitExprs(), [this](AST::Expression &Expr) -> Expect<void> {
224
3.34k
          return loadExpression(Expr);
225
3.34k
        });
226
287
  }
227
228
3.94k
  default:
229
3.94k
    break;
230
5.11k
  }
231
232
3.94k
  return {};
233
5.11k
}
234
235
// Load binary of CodeSegment node. See "include/loader/loader.h".
236
20.4k
Expect<void> Loader::loadSegment(AST::CodeSegment &CodeSeg) {
237
20.4k
  auto ReportError = [this](auto E) {
238
32
    return logLoadError(E, FMgr.getLastOffset(), ASTNodeAttr::Seg_Code);
239
32
  };
240
241
  // Read the code segment size.
242
20.4k
  EXPECTED_TRY(FMgr.readU32().map_error(ReportError).map([&](auto S) {
243
20.3k
    CodeSeg.setSegSize(S);
244
20.3k
  }));
245
20.3k
  auto ExprSizeBound = FMgr.getOffset() + CodeSeg.getSegSize();
246
247
  // Read the vector of local variable counts and types.
248
20.3k
  EXPECTED_TRY(uint32_t VecCnt, loadVecCnt().map_error(ReportError));
249
20.3k
  CodeSeg.getLocals().clear();
250
20.3k
  CodeSeg.getLocals().reserve(VecCnt);
251
20.3k
  uint32_t TotalLocalCnt = 0;
252
22.9k
  for (uint32_t I = 0; I < VecCnt; ++I) {
253
2.62k
    EXPECTED_TRY(uint32_t LocalCnt, FMgr.readU32().map_error(ReportError));
254
    // Total local variables should not more than 2^32. Capped at 2^26.
255
2.62k
    if (UINT32_C(67108864) - TotalLocalCnt < LocalCnt) {
256
9
      return logLoadError(ErrCode::Value::TooManyLocals, FMgr.getLastOffset(),
257
9
                          ASTNodeAttr::Seg_Code);
258
9
    }
259
2.61k
    TotalLocalCnt += LocalCnt;
260
    // Read the value type.
261
    // The AST node information is handled.
262
2.61k
    EXPECTED_TRY(ValType LocalType, loadValType(ASTNodeAttr::Seg_Code));
263
2.57k
    CodeSeg.getLocals().push_back(std::make_pair(LocalCnt, LocalType));
264
2.57k
  }
265
266
20.3k
  if (!Conf.getRuntimeConfigure().isForceInterpreter() &&
267
20.3k
      WASMType != InputType::WASM) {
268
    // For the AOT mode and not force interpreter in configure, skip the
269
    // function body.
270
0
    FMgr.seek(ExprSizeBound);
271
20.3k
  } else {
272
    // Read function body with expected expression size.
273
20.3k
    EXPECTED_TRY(
274
20.3k
        loadExpression(CodeSeg.getExpr(), ExprSizeBound).map_error([](auto E) {
275
20.3k
          spdlog::error(ErrInfo::InfoAST(ASTNodeAttr::Seg_Code));
276
20.3k
          return E;
277
20.3k
        }));
278
20.3k
  }
279
280
19.2k
  return {};
281
20.3k
}
282
283
// Load binary of DataSegment node. See "include/loader/loader.h".
284
5.21k
Expect<void> Loader::loadSegment(AST::DataSegment &DataSeg) {
285
5.21k
  auto ReportError = [this](auto E) {
286
28
    return logLoadError(E, FMgr.getLastOffset(), ASTNodeAttr::Seg_Data);
287
28
  };
288
5.21k
  DataSeg.setMode(AST::DataSegment::DataMode::Passive);
289
5.21k
  DataSeg.setIdx(0);
290
291
  // Data segment binary format:
292
  // ----------------------------------------
293
  //  Mode | MemoryIdx | OffExpr | vec(byte)
294
  // ------|-----------|---------|-----------
295
  //    0  |           |    v    |     v
296
  //    1  |           |         |     v
297
  //    2  |     v     |    v    |     v
298
  // ----------------------------------------
299
  // Mode: data initial integer, u32
300
  // MemoryIdx: target memory index, u32
301
  // OffExpr: init offset expression, expr
302
  // vec(byte): init data, vec(u8)
303
304
  // Read the checking byte.
305
5.21k
  EXPECTED_TRY(uint32_t Check, FMgr.readU32().map_error(ReportError));
306
  // Check > 0 cases are for BulkMemoryOperations or ReferenceTypes proposal.
307
5.21k
  if (Check > 0 && !Conf.hasProposal(Proposal::BulkMemoryOperations) &&
308
5.21k
      !Conf.hasProposal(Proposal::ReferenceTypes)) {
309
0
    return logNeedProposal(ErrCode::Value::ExpectedZeroByte,
310
0
                           Proposal::BulkMemoryOperations, FMgr.getLastOffset(),
311
0
                           ASTNodeAttr::Seg_Data);
312
0
  }
313
314
5.21k
  switch (Check) {
315
850
  case 0x02: // 0x02 memidx expr vec(byte) , Active
316
    // Read target memory index.
317
850
    EXPECTED_TRY(FMgr.readU32().map_error(ReportError).map([&](auto Idx) {
318
848
      DataSeg.setIdx(Idx);
319
848
    }));
320
848
    [[fallthrough]];
321
322
3.17k
  case 0x00: // 0x00 expr vec(byte) , Active
323
    // Read the offset expression.
324
3.17k
    EXPECTED_TRY(loadExpression(DataSeg.getExpr()).map_error([](auto E) {
325
1.88k
      spdlog::error(ErrInfo::InfoAST(ASTNodeAttr::Seg_Data));
326
1.88k
      return E;
327
1.88k
    }));
328
1.88k
    DataSeg.setMode(AST::DataSegment::DataMode::Active);
329
1.88k
    [[fallthrough]];
330
331
3.88k
  case 0x01: // 0x01 vec(byte) , Passive
332
3.88k
  {
333
    // Read initialization data.
334
3.88k
    EXPECTED_TRY(uint32_t VecCnt, loadVecCnt().map_error(ReportError));
335
3.86k
    EXPECTED_TRY(FMgr.readBytes(VecCnt).map_error(ReportError).map([&](auto V) {
336
3.86k
      DataSeg.getData() = std::move(V);
337
3.86k
    }));
338
3.86k
    break;
339
3.86k
  }
340
3.86k
  default:
341
    // TODO: Correctness the error code once there's spec test.
342
38
    return logLoadError(ErrCode::Value::IllegalGrammar, FMgr.getLastOffset(),
343
38
                        ASTNodeAttr::Seg_Data);
344
5.21k
  }
345
3.86k
  return {};
346
5.21k
}
347
348
} // namespace Loader
349
} // namespace WasmEdge