blob: 76bf3abbc7838236b98c5b5eebe142a273e8ddf9 [file] [log] [blame]
/*
* Copyright (C) 2019 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "WasmEntryPlan.h"
#include "WasmBinding.h"
#include <wtf/DataLog.h>
#include <wtf/Locker.h>
#include <wtf/MonotonicTime.h>
#include <wtf/StdLibExtras.h>
#include <wtf/SystemTracing.h>
#include <wtf/text/StringConcatenateNumbers.h>
#if ENABLE(WEBASSEMBLY)
namespace JSC { namespace Wasm {
namespace WasmEntryPlanInternal {
static constexpr bool verbose = false;
}
EntryPlan::EntryPlan(Context* context, Ref<ModuleInformation> info, CompilerMode compilerMode, CompletionTask&& task)
: Base(context, WTFMove(info), WTFMove(task))
, m_streamingParser(m_moduleInformation.get(), *this)
, m_state(State::Validated)
, m_compilerMode(compilerMode)
{
}
EntryPlan::EntryPlan(Context* context, Vector<uint8_t>&& source, CompilerMode compilerMode, CompletionTask&& task)
: Base(context, WTFMove(task))
, m_source(WTFMove(source))
, m_streamingParser(m_moduleInformation.get(), *this)
, m_state(State::Initial)
, m_compilerMode(compilerMode)
{
}
const char* EntryPlan::stateString(State state)
{
switch (state) {
case State::Initial: return "Initial";
case State::Validated: return "Validated";
case State::Prepared: return "Prepared";
case State::Compiled: return "Compiled";
case State::Completed: return "Completed";
}
RELEASE_ASSERT_NOT_REACHED();
}
void EntryPlan::moveToState(State state)
{
ASSERT(state >= m_state);
dataLogLnIf(WasmEntryPlanInternal::verbose && state != m_state, "moving to state: ", stateString(state), " from state: ", stateString(m_state));
m_state = state;
}
bool EntryPlan::parseAndValidateModule(const uint8_t* source, size_t sourceLength)
{
if (m_state != State::Initial)
return true;
dataLogLnIf(WasmEntryPlanInternal::verbose, "starting validation");
MonotonicTime startTime;
if (WasmEntryPlanInternal::verbose || Options::reportCompileTimes())
startTime = MonotonicTime::now();
m_streamingParser.addBytes(source, sourceLength);
{
Locker locker { m_lock };
if (failed())
return false;
}
if (m_streamingParser.finalize() != StreamingParser::State::Finished) {
Locker locker { m_lock };
fail(m_streamingParser.errorMessage());
return false;
}
if (WasmEntryPlanInternal::verbose || Options::reportCompileTimes())
dataLogLn("Took ", (MonotonicTime::now() - startTime).microseconds(), " us to validate module");
moveToState(State::Validated);
return true;
}
void EntryPlan::prepare()
{
ASSERT(m_state == State::Validated);
dataLogLnIf(WasmEntryPlanInternal::verbose, "Starting preparation");
const auto& functions = m_moduleInformation->functions;
m_numberOfFunctions = functions.size();
if (!tryReserveCapacity(m_wasmToWasmExitStubs, m_moduleInformation->importFunctionTypeIndices.size(), " WebAssembly to JavaScript stubs")
|| !tryReserveCapacity(m_unlinkedWasmToWasmCalls, functions.size(), " unlinked WebAssembly to WebAssembly calls"))
return;
m_unlinkedWasmToWasmCalls.resize(functions.size());
for (unsigned importIndex = 0; importIndex < m_moduleInformation->imports.size(); ++importIndex) {
Import* import = &m_moduleInformation->imports[importIndex];
if (import->kind != ExternalKind::Function)
continue;
unsigned importFunctionIndex = m_wasmToWasmExitStubs.size();
dataLogLnIf(WasmEntryPlanInternal::verbose, "Processing import function number ", importFunctionIndex, ": ", makeString(import->module), ": ", makeString(import->field));
auto binding = wasmToWasm(importFunctionIndex);
if (UNLIKELY(!binding)) {
switch (binding.error()) {
case BindingFailure::OutOfMemory: {
Locker locker { m_lock };
return fail(makeString("Out of executable memory at import ", String::number(importIndex)));
}
}
RELEASE_ASSERT_NOT_REACHED();
}
m_wasmToWasmExitStubs.uncheckedAppend(binding.value());
}
const uint32_t importFunctionCount = m_moduleInformation->importFunctionCount();
for (const auto& exp : m_moduleInformation->exports) {
if (exp.kindIndex >= importFunctionCount)
m_exportedFunctionIndices.add(exp.kindIndex - importFunctionCount);
}
for (const auto& element : m_moduleInformation->elements) {
for (const uint32_t functionIndex : element.functionIndices) {
if (!Element::isNullFuncIndex(functionIndex) && functionIndex >= importFunctionCount)
m_exportedFunctionIndices.add(functionIndex - importFunctionCount);
}
}
if (m_moduleInformation->startFunctionIndexSpace && m_moduleInformation->startFunctionIndexSpace >= importFunctionCount)
m_exportedFunctionIndices.add(*m_moduleInformation->startFunctionIndexSpace - importFunctionCount);
if (!prepareImpl())
return;
moveToState(State::Prepared);
}
// We don't have a semaphore class... and this does kinda interesting things.
class EntryPlan::ThreadCountHolder {
public:
ThreadCountHolder(EntryPlan& plan)
: m_plan(plan)
{
Locker locker { m_plan.m_lock };
m_plan.m_numberOfActiveThreads++;
}
~ThreadCountHolder()
{
Locker locker { m_plan.m_lock };
m_plan.m_numberOfActiveThreads--;
if (!m_plan.m_numberOfActiveThreads && !m_plan.hasWork())
m_plan.complete();
}
EntryPlan& m_plan;
};
void EntryPlan::compileFunctions(CompilationEffort effort)
{
ASSERT(m_state >= State::Prepared);
dataLogLnIf(WasmEntryPlanInternal::verbose, "Starting compilation");
if (!hasWork())
return;
std::optional<TraceScope> traceScope;
if (Options::useTracePoints())
traceScope.emplace(WebAssemblyCompileStart, WebAssemblyCompileEnd);
ThreadCountHolder holder(*this);
size_t bytesCompiled = 0;
while (true) {
if (effort == Partial && bytesCompiled >= Options::webAssemblyPartialCompileLimit())
return;
uint32_t functionIndex;
{
Locker locker { m_lock };
if (m_currentIndex >= m_numberOfFunctions) {
if (hasWork())
moveToState(State::Compiled);
return;
}
functionIndex = m_currentIndex;
++m_currentIndex;
}
compileFunction(functionIndex);
bytesCompiled += m_moduleInformation->functions[functionIndex].data.size();
}
}
void EntryPlan::complete()
{
ASSERT(m_state != State::Compiled || m_currentIndex >= m_moduleInformation->functions.size());
dataLogLnIf(WasmEntryPlanInternal::verbose, "Starting Completion");
if (!failed() && m_state == State::Compiled)
didCompleteCompilation();
if (!isComplete()) {
moveToState(State::Completed);
runCompletionTasks();
}
}
} } // namespace JSC::Wasm
#endif // ENABLE(WEBASSEMBLY)