/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* vim: set ts=8 sts=2 et sw=2 tw=80:
*
* Copyright 2016 Mozilla Foundation
*
* 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.
*/
#ifndef wasm_validate_h
#define wasm_validate_h
#include <type_traits>
#include "js/Utility.h"
#include "js/WasmFeatures.h"
#include "wasm/WasmBinary.h"
#include "wasm/WasmCompile.h"
#include "wasm/WasmCompileArgs.h"
#include "wasm/WasmModuleTypes.h"
#include "wasm/WasmProcess.h"
#include "wasm/WasmTypeDef.h"
namespace js {
namespace wasm {
// ElemSegmentFlags provides methods for decoding and encoding the flags field
// of an element segment. This is needed as the flags field has a non-trivial
// encoding that is effectively split into independent `kind` and `payload`
// enums.
class ElemSegmentFlags {
enum class Flags : uint32_t {
// 0 means active. 1 means (passive or declared), disambiguated by the next
// bit.
Passive = 0x1,
// For active segments, 1 means a table index is present. Otherwise, 0 means
// passive and 1 means declared.
TableIndexOrDeclared = 0x2,
// 0 means element kind / index (currently only func indexes). 1 means
// element ref type and initializer expressions.
ElemExpressions = 0x4,
// Below this line are convenient combinations of flags
KindMask = Passive | TableIndexOrDeclared,
PayloadMask = ElemExpressions,
AllFlags = Passive | TableIndexOrDeclared | ElemExpressions,
};
uint32_t encoded_;
explicit ElemSegmentFlags(uint32_t encoded) : encoded_(encoded) {}
public:
ElemSegmentFlags(ElemSegmentKind kind, ElemSegmentPayload payload) {
encoded_ = uint32_t(kind) | uint32_t(payload);
}
static mozilla::Maybe<ElemSegmentFlags> construct(uint32_t encoded) {
if (encoded > uint32_t(Flags::AllFlags)) {
return mozilla::Nothing();
}
return mozilla::Some(ElemSegmentFlags(encoded));
}
uint32_t encoded()
const {
return encoded_; }
ElemSegmentKind kind()
const {
return static_cast<ElemSegmentKind>(encoded_ & uint32_t(Flags::KindMask));
}
ElemSegmentPayload payload()
const {
return static_cast<ElemSegmentPayload>(encoded_ &
uint32_t(Flags::PayloadMask));
}
};
// OpIter specialized for validation.
class NothingVector {
mozilla::Nothing unused_;
public:
bool reserve(size_t size) {
return true; }
bool resize(size_t length) {
return true; }
mozilla::Nothing&
operator[](size_t) {
return unused_; }
mozilla::Nothing& back() {
return unused_; }
size_t length()
const {
return 0; }
bool append(mozilla::Nothing& nothing) {
return true; }
void infallibleAppend(mozilla::Nothing& nothing) {}
};
struct ValidatingPolicy {
using Value = mozilla::Nothing;
using ValueVector = NothingVector;
using ControlItem = mozilla::Nothing;
};
template <
typename Policy>
class OpIter;
using ValidatingOpIter = OpIter<ValidatingPolicy>;
// Shared subtyping function across validation.
[[nodiscard]]
bool CheckIsSubtypeOf(Decoder& d,
const CodeMetadata& codeMeta,
size_t opcodeOffset, ResultType subType,
ResultType superType);
[[nodiscard]]
bool CheckIsSubtypeOf(Decoder& d,
const CodeMetadata& codeMeta,
size_t opcodeOffset, StorageType subType,
StorageType superType);
// The local entries are part of function bodies and thus serialized by both
// wasm and asm.js and decoded as part of both validation and compilation.
[[nodiscard]]
bool EncodeLocalEntries(Encoder& e,
const ValTypeVector& locals)
;
// This performs no validation; the local entries must already have been
// validated by an earlier pass.
[[nodiscard]] bool DecodeValidatedLocalEntries(const TypeContext& types,
Decoder& d,
ValTypeVector* locals);
// This validates the entries. Function params are inserted before the locals
// to generate the full local entries for use in validation
[[nodiscard]] bool DecodeLocalEntriesWithParams(Decoder& d,
const CodeMetadata& codeMeta,
uint32_t funcIndex,
ValTypeVector* locals);
// Returns whether the given [begin, end) prefix of a module's bytecode starts a
// code section and, if so, returns the BytecodeRange of that code section.
// Note that, even if this function returns 'false', [begin, end) may actually
// be a valid module in the special case when there are no function defs and the
// code section is not present. Such modules can be valid so the caller must
// handle this special case.
[[nodiscard]] bool StartsCodeSection(const uint8_t* begin, const uint8_t* end,
BytecodeRange* codeSection);
// Calling DecodeModuleEnvironment decodes all sections up to the code section
// and performs full validation of all those sections. The client must then
// decode the code section itself, reusing ValidateFunctionBody if necessary,
// and finally call DecodeModuleTail to decode all remaining sections after the
// code section (again, performing full validation).
[[nodiscard]] bool DecodeModuleEnvironment(Decoder& d, CodeMetadata* codeMeta,
ModuleMetadata* moduleMeta);
[[nodiscard]] bool ValidateFunctionBody(const CodeMetadata& codeMeta,
uint32_t funcIndex, uint32_t bodySize,
Decoder& d);
#ifdef DEBUG
[[nodiscard]] bool DumpFunctionBody(const CodeMetadata& codeMeta,
uint32_t funcIndex,
const uint8_t* bodyBegin, uint32_t bodySize,
IndentedPrinter& out, UniqueChars* error);
#endif
[[nodiscard]] bool DecodeModuleTail(Decoder& d, CodeMetadata* codeMeta,
ModuleMetadata* meta);
// Validate an entire module, returning true if the module was validated
// successfully. If Validate returns false:
// - if *error is null, the caller should report out-of-memory
// - otherwise, there was a legitimate error described by *error
[[nodiscard]] bool Validate(JSContext* cx, const ShareableBytes& bytecode,
const FeatureOptions& options, UniqueChars* error);
} // namespace wasm
} // namespace js
#endif // namespace wasm_validate_h
