/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "GeckoProfiler.h"
#include "mozilla/dom/Document.h"
#include "mozilla/HoldDropJSObjects.h"
#include "mozilla/StaticPrefs_dom.h"
#include "mozilla/Unused.h"
#include "mozilla/Utf8.h" // mozilla::Utf8Unit
#include "js/SourceText.h"
#include "js/loader/LoadContextBase.h"
#include "js/loader/ModuleLoadRequest.h"
#include "ScriptLoadContext.h"
#include "ModuleLoadRequest.h"
#include "nsContentUtils.h"
#include "nsICacheInfoChannel.h"
#include "nsIClassOfService.h"
#include "nsISupportsPriority.h"
namespace mozilla::dom {
//////////////////////////////////////////////////////////////
// ScriptLoadContext
//////////////////////////////////////////////////////////////
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(ScriptLoadContext)
NS_INTERFACE_MAP_END_INHERITING(JS::loader::LoadContextBase)
NS_IMPL_CYCLE_COLLECTION_CLASS(ScriptLoadContext)
NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN_INHERITED(ScriptLoadContext,
JS::loader::LoadContextBase)
MOZ_ASSERT(!tmp->mCompileOrDecodeTask);
tmp->MaybeUnblockOnload();
NS_IMPL_CYCLE_COLLECTION_UNLINK(mScriptElement);
NS_IMPL_CYCLE_COLLECTION_UNLINK_END
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN_INHERITED(ScriptLoadContext,
JS::loader::LoadContextBase)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mLoadBlockedDocument)
NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mScriptElement);
NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
NS_IMPL_ADDREF_INHERITED(ScriptLoadContext, JS::loader::LoadContextBase)
NS_IMPL_RELEASE_INHERITED(ScriptLoadContext, JS::loader::LoadContextBase)
ScriptLoadContext::ScriptLoadContext(
nsIScriptElement* aScriptElement
/* = nullptr */)
: JS::loader::LoadContextBase(JS::loader::ContextKind::Window),
mScriptMode(ScriptMode::eBlocking),
mScriptFromHead(
false),
mIsInline(
true),
mInDeferList(
false),
mInAsyncList(
false),
mIsNonAsyncScriptInserted(
false),
mIsXSLT(
false),
mInCompilingList(
false),
mIsTracking(
false),
mWasCompiledOMT(
false),
mLineNo(1),
mColumnNo(0),
mIsPreload(
false),
mScriptElement(aScriptElement),
mUnreportedPreloadError(NS_OK) {}
ScriptLoadContext::~ScriptLoadContext() {
MOZ_ASSERT(NS_IsMainThread());
// Off-thread parsing must have completed or cancelled by this point.
MOZ_DIAGNOSTIC_ASSERT(!mCompileOrDecodeTask);
mRequest = nullptr;
MaybeUnblockOnload();
}
void ScriptLoadContext::BlockOnload(Document* aDocument) {
MOZ_ASSERT(!mLoadBlockedDocument);
aDocument->BlockOnload();
mLoadBlockedDocument = aDocument;
}
void ScriptLoadContext::MaybeUnblockOnload() {
if (mLoadBlockedDocument) {
mLoadBlockedDocument->UnblockOnload(
false);
mLoadBlockedDocument = nullptr;
}
}
void ScriptLoadContext::MaybeCancelOffThreadScript() {
MOZ_ASSERT(NS_IsMainThread());
if (!mCompileOrDecodeTask) {
return;
}
// Cancel the task if it hasn't been started yet or wait for it to finish.
mCompileOrDecodeTask->Cancel();
mCompileOrDecodeTask = nullptr;
MaybeUnblockOnload();
}
void ScriptLoadContext::SetScriptMode(
bool aDeferAttr,
bool aAsyncAttr,
bool aLinkPreload) {
if (aLinkPreload) {
mScriptMode = ScriptMode::eLinkPreload;
}
else if (aAsyncAttr) {
mScriptMode = ScriptMode::eAsync;
}
else if (aDeferAttr || mRequest->IsModuleRequest()) {
mScriptMode = ScriptMode::eDeferred;
}
else {
mScriptMode = ScriptMode::eBlocking;
}
}
// static
void ScriptLoadContext::PrioritizeAsPreload(nsIChannel* aChannel) {
if (nsCOMPtr<nsIClassOfService> cos = do_QueryInterface(aChannel)) {
cos->AddClassFlags(nsIClassOfService::Unblocked);
}
if (nsCOMPtr<nsISupportsPriority> sp = do_QueryInterface(aChannel)) {
sp->AdjustPriority(nsISupportsPriority::PRIORITY_HIGHEST);
}
}
bool ScriptLoadContext::IsPreload()
const {
if (mRequest->IsModuleRequest() && !mRequest->IsTopLevel()) {
JS::loader::ModuleLoadRequest* root =
mRequest->AsModuleRequest()->GetRootModule();
return root->GetScriptLoadContext()->IsPreload();
}
MOZ_ASSERT_IF(mIsPreload, !HasScriptElement());
return mIsPreload;
}
bool ScriptLoadContext::CompileStarted()
const {
return mRequest->IsCompiling() || (mRequest->IsFinished() && mWasCompiledOMT);
}
bool ScriptLoadContext::HasScriptElement()
const {
return !!mScriptElement; }
void ScriptLoadContext::GetInlineScriptText(nsAString& aText)
const {
MOZ_ASSERT(mIsInline);
mScriptElement->GetScriptText(aText);
}
void ScriptLoadContext::GetHintCharset(nsAString& aCharset)
const {
MOZ_ASSERT(mScriptElement);
mScriptElement->GetScriptCharset(aCharset);
}
uint32_t ScriptLoadContext::GetScriptLineNumber()
const {
if (mScriptElement) {
return mScriptElement->GetScriptLineNumber();
}
return 0;
}
JS::ColumnNumberOneOrigin ScriptLoadContext::GetScriptColumnNumber()
const {
if (mScriptElement) {
return mScriptElement->GetScriptColumnNumber();
}
return JS::ColumnNumberOneOrigin();
}
void ScriptLoadContext::BeginEvaluatingTopLevel()
const {
MOZ_ASSERT(mScriptElement);
mScriptElement->BeginEvaluating();
}
void ScriptLoadContext::EndEvaluatingTopLevel()
const {
MOZ_ASSERT(mScriptElement);
mScriptElement->EndEvaluating();
}
void ScriptLoadContext::UnblockParser()
const {
MOZ_ASSERT(mScriptElement);
mScriptElement->UnblockParser();
}
void ScriptLoadContext::ContinueParserAsync()
const {
MOZ_ASSERT(mScriptElement);
mScriptElement->ContinueParserAsync();
}
Document* ScriptLoadContext::GetScriptOwnerDocument()
const {
nsCOMPtr<nsIContent> scriptContent(do_QueryInterface(mScriptElement));
MOZ_ASSERT(scriptContent);
return scriptContent->OwnerDoc();
}
void ScriptLoadContext::SetIsLoadRequest(nsIScriptElement* aElement) {
MOZ_ASSERT(aElement);
MOZ_ASSERT(!HasScriptElement());
MOZ_ASSERT(IsPreload());
mScriptElement = aElement;
mIsPreload =
false;
}
void ScriptLoadContext::GetProfilerLabel(nsACString& aOutString) {
if (!profiler_is_active()) {
aOutString.Append(
"<script> element");
return;
}
aOutString.Append(
"<script");
if (IsAsyncScript()) {
aOutString.Append(
" async");
}
else if (IsDeferredScript()) {
aOutString.Append(
" defer");
}
if (mRequest->IsModuleRequest()) {
aOutString.Append(
" type=\"module\
"");
}
nsAutoCString url;
if (mRequest->mURI) {
mRequest->mURI->GetAsciiSpec(url);
}
else {
url =
"<unknown>";
}
if (mIsInline) {
if (GetParserCreated() != NOT_FROM_PARSER) {
aOutString.Append(
"> inline at line ");
aOutString.AppendInt(mLineNo);
aOutString.Append(
" of ");
}
else {
aOutString.Append(
"> inline (dynamically created) in ");
}
aOutString.Append(url);
}
else {
aOutString.Append(
" src=\"");
aOutString.Append(url);
aOutString.Append(
"\">
");
}
}
already_AddRefed<JS::Stencil> ScriptLoadContext::StealOffThreadResult(
JSContext* aCx, JS::InstantiationStorage* aInstantiationStorage) {
RefPtr<CompileOrDecodeTask> compileOrDecodeTask =
mCompileOrDecodeTask.forget();
return compileOrDecodeTask->StealResult(aCx, aInstantiationStorage);
}
}
// namespace mozilla::dom
