binaryen/src/parser/wast-parser.cpp at main · WebAssembly/binaryen · GitHub

History

701 lines (625 loc) · 17.5 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

* 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.

#include "lexer.h"

#include "literal.h"

#include "wasm-features.h"

#include "wat-parser.h"

namespace wasm::WATParser {

using namespace std::string_view_literals;

namespace {

Result<WASTCommand> command(Lexer& in);

Result<Literal> const_(Lexer& in) {

if (in.takeSExprStart("ref.extern"sv)) {

auto n = in.takeI32();

if (!n) {

return in.err("expected host reference payload");

}

if (!in.takeRParen()) {

return in.err("expected end of ref.extern");

}

// Represent host references as externalized i31s.

return Literal::makeI31(*n, Unshared).externalize();

}

return parseConst(in);

}

Result<Literals> consts(Lexer& in) {

Literals lits;

while (!in.peekRParen()) {

auto l = const_(in);

CHECK_ERR(l);

lits.push_back(*l);

}

return lits;

}

MaybeResult<Action> maybeAction(Lexer& in) {

if (in.takeSExprStart("invoke"sv)) {

auto id = in.takeID();

auto name = in.takeName();

if (!name) {

return in.err("expected export name");

}

auto args = consts(in);

CHECK_ERR(args);

if (!in.takeRParen()) {

return in.err("expected end of invoke action");

}

return InvokeAction{id, *name, *args};

}

if (in.takeSExprStart("get"sv)) {

auto id = in.takeID();

auto name = in.takeName();

if (!name) {

return in.err("expected export name");

}

if (!in.takeRParen()) {

return in.err("expected end of get action");

}

return GetAction{id, *name};

}

return {};

}

Result<Action> action(Lexer& in) {

if (auto a = maybeAction(in)) {

CHECK_ERR(a);

return *a;

}

return in.err("expected action");

}

// (module id binary string*)

// (module id quote string*)

// (module definition id? ...)

// (module definition id? binary ...)

Result<WASTModule> wastModule(Lexer& in, bool maybeInvalid = false) {

Lexer reset = in;

if (!in.takeSExprStart("module"sv)) {

return in.err("expected module");

}

bool isDefinition = in.takeKeyword("definition"sv);

std::optional<Name> id = in.takeID();

Lexer moduleBody = in;

QuotedModuleType type;

if (in.takeKeyword("quote"sv)) {

type = QuotedModuleType::Text;

} else if (in.takeKeyword("binary")) {

type = QuotedModuleType::Binary;

} else if (maybeInvalid) {

// This is not a quoted text or binary module, so it must be a normal inline

// module, but we might not be able to parse it. Treat it as through it were

// a quoted module instead.

int count = 1;

while (count && in.takeUntilParen()) {

if (in.takeLParen()) {

++count;

} else if (in.takeRParen()) {

--count;

} else {

return in.err("unexpected end of script");

}

std::string mod(reset.next().substr(0, in.getPos() - reset.getPos()));

return WASTModule{isDefinition, QuotedModule{QuotedModuleType::Text, mod}};

} else {

// In this case the module is mostly valid WAT, unless it is a module

// definition in which case it will begin with (module definition ...)

in = std::move(moduleBody);

auto wasm = std::make_shared<Module>();

if (id) {

wasm->name = *id;

}

wasm->features = FeatureSet::All;

CHECK_ERR(parseModuleBody(*wasm, in));

if (!in.takeRParen()) {

return in.err("expected end of module");

}

return WASTModule{isDefinition, wasm};

}

// We have a quote or binary module. Collect its contents.

std::stringstream ss;

while (auto s = in.takeString()) {

ss << *s;

}

if (!in.takeRParen()) {

return in.err("expected end of module");

}

return WASTModule{isDefinition, QuotedModule{type, ss.str()}};

}

Result<NaNKind> nan(Lexer& in) {

if (in.takeKeyword("nan:canonical"sv)) {

return NaNKind::Canonical;

}

if (in.takeKeyword("nan:arithmetic"sv)) {

return NaNKind::Arithmetic;

}

return in.err("expected NaN result pattern");

}

Result<ExpectedResult> result(Lexer& in) {

if (in.takeSExprStart("v128.const"sv)) {

auto laneTypeChar = in.peekChar();

if (!laneTypeChar) {

return in.err("expected vector shape");

}

LaneResults::LaneType laneType;

switch (*laneTypeChar) {

case 'f': {

laneType = LaneResults::LaneType::Float;

break;

}

case 'i': {

laneType = LaneResults::LaneType::Int;

break;

}

default: {

return in.err("expected vector shape");

}

LaneResults results(laneType);

auto& lanes = results.lanes;

if (in.takeKeyword("i8x16"sv)) {

for (int i = 0; i < 16; ++i) {

auto int_ = in.takeI8();

if (!int_) {

return in.err("expected i8 immediate");

}

lanes.push_back(Literal(static_cast<uint32_t>(*int_)));

}

} else if (in.takeKeyword("i16x8"sv)) {

for (int i = 0; i < 8; ++i) {

auto int_ = in.takeI16();

if (!int_) {

return in.err("expected i16 immediate");

}

lanes.push_back(Literal(static_cast<uint32_t>(*int_)));

}

} else if (in.takeKeyword("i32x4"sv)) {

for (int i = 0; i < 4; ++i) {

auto int_ = in.takeI32();

if (!int_) {

return in.err("expected i32 immediate");

}

lanes.push_back(Literal(static_cast<uint32_t>(*int_)));

}

} else if (in.takeKeyword("i64x2"sv)) {

for (int i = 0; i < 2; ++i) {

auto int_ = in.takeI64();

if (!int_) {

return in.err("expected i64 immediate");

}

lanes.push_back(Literal(*int_));

}

} else if (in.takeKeyword("f32x4"sv)) {

for (int i = 0; i < 4; ++i) {

if (auto f = in.takeF32()) {

lanes.push_back(Literal(*f));

} else {

auto kind = nan(in);

CHECK_ERR(kind);

lanes.push_back(NaNResult{*kind, Type::f32});

}

} else if (in.takeKeyword("f64x2"sv)) {

for (int i = 0; i < 2; ++i) {

if (auto f = in.takeF64()) {

lanes.push_back(Literal(*f));

} else {

auto kind = nan(in);

CHECK_ERR(kind);

lanes.push_back(NaNResult{*kind, Type::f64});

}

} else {

return in.err("unexpected vector shape");

}

if (!in.takeRParen()) {

return in.err("expected end of v128.const");

}

return results;

}

Lexer constLexer = in;

auto c = const_(constLexer);

// TODO: Generating and discarding errors like this can lead to quadratic

// behavior. Optimize this if necessary.

if (!c.getErr()) {

in = constLexer;

return *c;

}

// If we failed to parse a constant, we must have either a nan pattern or a

// reference.

if (in.takeSExprStart("f32.const"sv)) {

auto kind = nan(in);

CHECK_ERR(kind);

if (!in.takeRParen()) {

return in.err("expected end of f32.const");

}

return NaNResult{*kind, Type::f32};

}

if (in.takeSExprStart("f64.const"sv)) {

auto kind = nan(in);

CHECK_ERR(kind);

if (!in.takeRParen()) {

return in.err("expected end of f64.const");

}

return NaNResult{*kind, Type::f64};

}

if (in.takeSExprStart("ref.null")) {

if (!in.takeRParen()) {

return in.err("expected end of ref.null");

}

return NullRefResult{};

}

if (in.takeSExprStart("ref.extern")) {

if (!in.takeRParen()) {

return in.err("expected end of ref.extern");

}

return RefResult{HeapType::ext};

}

if (in.takeSExprStart("ref.func")) {

if (!in.takeRParen()) {

return in.err("expected end of ref.func");

}

return RefResult{HeapType::func};

}

if (in.takeSExprStart("ref.struct")) {

if (!in.takeRParen()) {

return in.err("expected end of ref.struct");

}

return RefResult{HeapType::struct_};

}

if (in.takeSExprStart("ref.array")) {

if (!in.takeRParen()) {

return in.err("expected end of ref.array");

}

return RefResult{HeapType::array};

}

if (in.takeSExprStart("ref.eq")) {

if (!in.takeRParen()) {

return in.err("expected end of ref.eq");

}

return RefResult{HeapType::eq};

}

if (in.takeSExprStart("ref.i31")) {

if (!in.takeRParen()) {

return in.err("expected end of ref.i31");

}

return RefResult{HeapType::i31};

}

if (in.takeSExprStart("ref.i31_shared")) {

if (!in.takeRParen()) {

return in.err("expected end of ref.i31_shared");

}

return RefResult{HeapTypes::i31.getBasic(Shared)};

}

return in.err("unrecognized result");

}

Result<ResultAlternatives> eitherResult(Lexer& in) {

if (in.takeSExprStart("either"sv)) {

ResultAlternatives alternatives;

do {

auto r = result(in);

CHECK_ERR(r);

alternatives.push_back(*std::move(r));

} while (!in.takeRParen());

return alternatives;

}

auto r = result(in);

CHECK_ERR(r);

return ResultAlternatives{*std::move(r)};

}

Result<ExpectedResults> results(Lexer& in) {

ExpectedResults res;

while (!in.peekRParen()) {

auto r = eitherResult(in);

CHECK_ERR(r);

res.emplace_back(*std::move(r));

}

return res;

}

// (assert_return action result*)

MaybeResult<AssertReturn> assertReturn(Lexer& in) {

if (!in.takeSExprStart("assert_return"sv)) {

return {};

}

auto a = action(in);

CHECK_ERR(a);

auto expected = results(in);

CHECK_ERR(expected);

if (!in.takeRParen()) {

return in.err("expected end of assert_return");

}

return AssertReturn{*a, *expected};

}

// (assert_exception action)

MaybeResult<AssertAction> assertException(Lexer& in) {

if (!in.takeSExprStart("assert_exception"sv)) {

return {};

}

auto a = action(in);

CHECK_ERR(a);

if (!in.takeRParen()) {

return in.err("expected end of assert_exception");

}

return AssertAction{ActionAssertionType::Exception, *a};

}

// (assert_exhaustion action msg)

MaybeResult<AssertAction> assertAction(Lexer& in) {

ActionAssertionType type;

if (in.takeSExprStart("assert_exhaustion"sv)) {

type = ActionAssertionType::Exhaustion;

} else {

return {};

}

auto a = action(in);

CHECK_ERR(a);

auto msg = in.takeString();

if (!msg) {

return in.err("expected error message");

}

if (!in.takeRParen()) {

return in.err("expected end of assertion");

}

return AssertAction{type, *a};

}

// (assert_malformed module msg)

// (assert_invalid module msg)

// (assert_unlinkable module msg)

MaybeResult<AssertModule> assertModule(Lexer& in) {

ModuleAssertionType type;

if (in.takeSExprStart("assert_malformed"sv)) {

type = ModuleAssertionType::Malformed;

} else if (in.takeSExprStart("assert_invalid"sv)) {

type = ModuleAssertionType::Invalid;

} else if (in.takeSExprStart("assert_unlinkable"sv)) {

type = ModuleAssertionType::Unlinkable;

} else {

return {};

}

auto mod = wastModule(in, type == ModuleAssertionType::Invalid);

CHECK_ERR(mod);

auto msg = in.takeString();

if (!msg) {

return in.err("expected error message");

}

if (!in.takeRParen()) {

return in.err("expected end of assertion");

}

return AssertModule{type, *mod};

}

// (assert_trap action msg)

// (assert_trap module msg)

MaybeResult<Assertion> assertTrap(Lexer& in) {

if (!in.takeSExprStart("assert_trap"sv)) {

return {};

}

auto pos = in.getPos();

if (auto a = maybeAction(in)) {

CHECK_ERR(a);

auto msg = in.takeString();

if (!msg) {

return in.err("expected error message");

}

if (!in.takeRParen()) {

return in.err("expected end of assertion");

}

return Assertion{AssertAction{ActionAssertionType::Trap, *a}};

}

auto mod = wastModule(in);

if (mod.getErr()) {

return in.err(pos, "expected action or module");

}

auto msg = in.takeString();

if (!msg) {

return in.err("expected error message");

}

if (!in.takeRParen()) {

return in.err("expected end of assertion");

}

return Assertion{AssertModule{ModuleAssertionType::Trap, *mod}};

}

// (assert_suspension action msg)

MaybeResult<Assertion> assertSuspension(Lexer& in) {

if (!in.takeSExprStart("assert_suspension"sv)) {

return {};

}

if (auto a = maybeAction(in)) {

CHECK_ERR(a);

auto msg = in.takeString();

if (!msg) {

return in.err("expected error message");

}

if (!in.takeRParen()) {

return in.err("expected end of assertion");

}

return Assertion{AssertAction{ActionAssertionType::Suspension, *a}};

}

return in.err("invalid assert_suspension");

}

MaybeResult<Assertion> assertion(Lexer& in) {

if (auto a = assertReturn(in)) {

CHECK_ERR(a);

return Assertion{*a};

}

if (auto a = assertException(in)) {

CHECK_ERR(a);

return Assertion{*a};

}

if (auto a = assertAction(in)) {

CHECK_ERR(a);

return Assertion{*a};

}

if (auto a = assertModule(in)) {

CHECK_ERR(a);

return Assertion{*a};

}

if (auto a = assertTrap(in)) {

CHECK_ERR(a);

return *a;

}

if (auto a = assertSuspension(in)) {

CHECK_ERR(a);

return *a;

}

return {};

}

// (register name id?)

MaybeResult<Register> register_(Lexer& in) {

if (!in.takeSExprStart("register"sv)) {

return {};

}

auto name = in.takeName();

if (!name) {

return in.err("expected name");

}

auto instanceName = in.takeID();

if (!in.takeRParen()) {

return in.err("expected end of register command");

}

return Register{*name, instanceName};

}

// (module instance instance_name? module_name?)

MaybeResult<ModuleInstantiation> instantiation(Lexer& in) {

Lexer reset = in;

if (!in.takeSExprStart("module"sv)) {

std::optional<std::string_view> actual = in.peekKeyword();

return in.err((std::stringstream() << "expected `module` keyword but got "

<< actual.value_or("<not a keyword>"))

.str());

}

if (!in.takeKeyword("instance"sv)) {

// This is not a module instance and probably a module instead.

in = reset;

return {};

}

auto instanceId = in.takeID();

auto moduleId = in.takeID();

if (!in.takeRParen()) {

return in.err("expected end of module instantiation");

}

return ModuleInstantiation{moduleId, instanceId};

}

// (thread name (shared (module name))? command*)

MaybeResult<ThreadBlock> threadBlock(Lexer& in) {

if (!in.takeSExprStart("thread"sv)) {

return {};

}

auto name = in.takeID();

if (!name) {

return in.err("expected thread name");

}

std::optional<Name> sharedModule;

if (in.takeSExprStart("shared"sv)) {

if (!in.takeSExprStart("module"sv)) {

return in.err("expected module keyword in (shared ...) block");

}

auto modName = in.takeID();

if (!modName) {

return in.err("expected module name after (shared (module ...))");

}

sharedModule = *modName;

if (!in.takeRParen()) {

return in.err("expected end of shared module");

}

if (!in.takeRParen()) {

return in.err("expected end of (shared ...) expression");

}

std::vector<ScriptEntry> commands;

while (!in.peekRParen() && !in.empty()) {

size_t line = in.position().line;

auto cmd = command(in);

CHECK_ERR(cmd);

commands.push_back({std::move(*cmd), line});

}

if (!in.takeRParen()) {

return in.err("expected end of thread");

}

return ThreadBlock{*name, sharedModule, std::move(commands)};

}

// (wait name)

MaybeResult<Wait> wait(Lexer& in) {

if (!in.takeSExprStart("wait"sv)) {

return {};

}

auto name = in.takeID();

if (!name) {

return in.err("expected thread name in wait");

}

if (!in.takeRParen()) {

return in.err("expected end of wait");

}

return Wait{*name};

}

Result<WASTCommand> command(Lexer& in) {

if (auto cmd = register_(in)) {

CHECK_ERR(cmd);

return *cmd;

}

if (auto cmd = threadBlock(in)) {

CHECK_ERR(cmd);

return *cmd;

}

if (auto cmd = wait(in)) {

CHECK_ERR(cmd);

return *cmd;

}

if (auto cmd = maybeAction(in)) {

CHECK_ERR(cmd);

return *cmd;

}

if (auto cmd = assertion(in)) {

CHECK_ERR(cmd);

return *cmd;

}

if (auto cmd = instantiation(in)) {

CHECK_ERR(cmd);

return *cmd;

}

auto module = wastModule(in);

CHECK_ERR(module);

return *module;

}

#pragma GCC diagnostic push

#pragma GCC diagnostic ignored "-Wmaybe-uninitialized"

Result<WASTScript> wast(Lexer& in) {

WASTScript cmds;

while (!in.empty()) {

size_t line = in.position().line;

auto cmd = command(in);

if (auto* err = cmd.getErr(); err && cmds.empty()) {

// The entire script might be a single module comprising a sequence of

// module fields with a top-level `(module ...)`.

auto wasm = std::make_shared<Module>();

wasm->features = FeatureSet::All;

auto parsed = parseModule(*wasm, in.buffer);

if (parsed.getErr()) {

// No, that wasn't the problem. Return the original error.

return Err{err->msg};

}

cmds.push_back(

{WASTModule{/*isDefinition=*/false, std::move(wasm)}, line});

return cmds;

}

CHECK_ERR(cmd);

cmds.push_back(ScriptEntry{*std::move(cmd), line});

}

return cmds;

}

#pragma GCC diagnostic pop

} // anonymous namespace

Result<WASTScript> parseScript(std::string_view in) {

Lexer lexer(in);

return wast(lexer);

}

} // namespace wasm::WATParser

binaryen/src/parser/wast-parser.cpp at main · WebAssembly/binaryen · GitHub

Uh oh!

Expand file tree

Breadcrumbs

wast-parser.cpp

Latest commit

History

Breadcrumbs

wast-parser.cpp

File metadata and controls