Backed out changeset 9062e17fe15c (bug 1676361) on devs request. CLOSED TREE

This commit is contained in:
smolnar 2021-03-04 16:51:21 +02:00
parent 591f256df1
commit 9f8b74a18d
40 changed files with 253 additions and 359 deletions

View File

@ -51,7 +51,6 @@
#include "mozilla/Unused.h" #include "mozilla/Unused.h"
#include "mozilla/WidgetUtils.h" #include "mozilla/WidgetUtils.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/ChildProcessChannelListener.h" #include "mozilla/dom/ChildProcessChannelListener.h"
#include "mozilla/dom/ClientChannelHelper.h" #include "mozilla/dom/ClientChannelHelper.h"
#include "mozilla/dom/ClientHandle.h" #include "mozilla/dom/ClientHandle.h"

View File

@ -6,7 +6,6 @@
#include "BodyStream.h" #include "BodyStream.h"
#include "mozilla/CycleCollectedJSContext.h" #include "mozilla/CycleCollectedJSContext.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/DOMException.h" #include "mozilla/dom/DOMException.h"
#include "mozilla/dom/ScriptSettings.h" #include "mozilla/dom/ScriptSettings.h"
#include "mozilla/dom/WorkerCommon.h" #include "mozilla/dom/WorkerCommon.h"

View File

@ -8,7 +8,6 @@
#include "mozilla/AsyncEventDispatcher.h" #include "mozilla/AsyncEventDispatcher.h"
#include "mozilla/CycleCollectedJSContext.h" #include "mozilla/CycleCollectedJSContext.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/CustomElementRegistryBinding.h" #include "mozilla/dom/CustomElementRegistryBinding.h"
#include "mozilla/dom/ElementBinding.h" #include "mozilla/dom/ElementBinding.h"
#include "mozilla/dom/HTMLElementBinding.h" #include "mozilla/dom/HTMLElementBinding.h"

View File

@ -126,7 +126,6 @@
#include "mozilla/Variant.h" #include "mozilla/Variant.h"
#include "mozilla/ViewportUtils.h" #include "mozilla/ViewportUtils.h"
#include "mozilla/dom/AncestorIterator.h" #include "mozilla/dom/AncestorIterator.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/AutocompleteInfoBinding.h" #include "mozilla/dom/AutocompleteInfoBinding.h"
#include "mozilla/dom/AutoSuppressEventHandlingAndSuspend.h" #include "mozilla/dom/AutoSuppressEventHandlingAndSuspend.h"
#include "mozilla/dom/BindingDeclarations.h" #include "mozilla/dom/BindingDeclarations.h"

View File

@ -40,7 +40,6 @@
#include "mozilla/TimeStamp.h" #include "mozilla/TimeStamp.h"
#include "mozilla/TypedEnumBits.h" #include "mozilla/TypedEnumBits.h"
#include "mozilla/UniquePtr.h" #include "mozilla/UniquePtr.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/BindingDeclarations.h" #include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/dom/CallbackObject.h" #include "mozilla/dom/CallbackObject.h"
#include "mozilla/dom/ChildProcessMessageManager.h" #include "mozilla/dom/ChildProcessMessageManager.h"

View File

@ -86,7 +86,6 @@
#include "mozilla/UniquePtr.h" #include "mozilla/UniquePtr.h"
#include "mozilla/Unused.h" #include "mozilla/Unused.h"
#include "mozilla/dom/AudioContext.h" #include "mozilla/dom/AudioContext.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/BarProps.h" #include "mozilla/dom/BarProps.h"
#include "mozilla/dom/BindingDeclarations.h" #include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/dom/BindingUtils.h" #include "mozilla/dom/BindingUtils.h"

View File

@ -30,7 +30,6 @@
#include "mozilla/Maybe.h" #include "mozilla/Maybe.h"
#include "mozilla/MemoryReporting.h" #include "mozilla/MemoryReporting.h"
#include "mozilla/RefPtr.h" #include "mozilla/RefPtr.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/BindingCallContext.h" #include "mozilla/dom/BindingCallContext.h"
#include "mozilla/dom/ScriptSettings.h" #include "mozilla/dom/ScriptSettings.h"
#include "nsCOMPtr.h" #include "nsCOMPtr.h"

View File

@ -8,7 +8,6 @@
#include "InternalResponse.h" #include "InternalResponse.h"
#include "js/Stream.h" #include "js/Stream.h"
#include "mozilla/ConsoleReportCollector.h" #include "mozilla/ConsoleReportCollector.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/DOMException.h" #include "mozilla/dom/DOMException.h"
#include "mozilla/dom/Promise.h" #include "mozilla/dom/Promise.h"
#include "mozilla/dom/PromiseBinding.h" #include "mozilla/dom/PromiseBinding.h"

View File

@ -10,7 +10,6 @@
#include "MemMapSnapshot.h" #include "MemMapSnapshot.h"
#include "ScriptPreloader-inl.h" #include "ScriptPreloader-inl.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/BlobImpl.h" #include "mozilla/dom/BlobImpl.h"
#include "mozilla/dom/ContentParent.h" #include "mozilla/dom/ContentParent.h"
#include "mozilla/dom/ContentProcessMessageManager.h" #include "mozilla/dom/ContentProcessMessageManager.h"

View File

@ -10,7 +10,6 @@
#include "chrome/common/ipc_channel.h" #include "chrome/common/ipc_channel.h"
#include "mozilla/Attributes.h" #include "mozilla/Attributes.h"
#include "mozilla/FunctionRef.h" #include "mozilla/FunctionRef.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/ClonedErrorHolder.h" #include "mozilla/dom/ClonedErrorHolder.h"
#include "mozilla/dom/ClonedErrorHolderBinding.h" #include "mozilla/dom/ClonedErrorHolderBinding.h"
#include "mozilla/dom/DOMException.h" #include "mozilla/dom/DOMException.h"

View File

@ -5,8 +5,6 @@
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "mozilla/dom/JSActorManager.h" #include "mozilla/dom/JSActorManager.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/JSActorService.h" #include "mozilla/dom/JSActorService.h"
#include "mozilla/dom/PWindowGlobal.h" #include "mozilla/dom/PWindowGlobal.h"
#include "mozilla/ipc/ProtocolUtils.h" #include "mozilla/ipc/ProtocolUtils.h"

View File

@ -42,7 +42,6 @@
#include "nsSandboxFlags.h" #include "nsSandboxFlags.h"
#include "mozilla/BasePrincipal.h" #include "mozilla/BasePrincipal.h"
#include "mozilla/CycleCollectedJSContext.h" #include "mozilla/CycleCollectedJSContext.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/DOMSecurityMonitor.h" #include "mozilla/dom/DOMSecurityMonitor.h"
#include "mozilla/dom/JSExecutionContext.h" #include "mozilla/dom/JSExecutionContext.h"
#include "mozilla/dom/ScriptSettings.h" #include "mozilla/dom/ScriptSettings.h"

View File

@ -10,7 +10,6 @@
#include "nsIScriptError.h" #include "nsIScriptError.h"
#include "DOMLocalization.h" #include "DOMLocalization.h"
#include "mozilla/intl/LocaleService.h" #include "mozilla/intl/LocaleService.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/Element.h" #include "mozilla/dom/Element.h"
#include "mozilla/dom/L10nOverlays.h" #include "mozilla/dom/L10nOverlays.h"

View File

@ -6,7 +6,6 @@
#include "DocumentL10n.h" #include "DocumentL10n.h"
#include "nsIContentSink.h" #include "nsIContentSink.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/Document.h" #include "mozilla/dom/Document.h"
#include "mozilla/dom/DocumentL10nBinding.h" #include "mozilla/dom/DocumentL10nBinding.h"
#include "mozilla/Telemetry.h" #include "mozilla/Telemetry.h"

View File

@ -14,7 +14,6 @@
#include "js/experimental/TypedData.h" // JS_NewFloat32Array, JS_GetFloat32ArrayData, JS_GetTypedArrayLength, JS_GetArrayBufferViewBuffer #include "js/experimental/TypedData.h" // JS_NewFloat32Array, JS_GetFloat32ArrayData, JS_GetTypedArrayLength, JS_GetArrayBufferViewBuffer
#include "mozilla/dom/AudioWorkletNodeBinding.h" #include "mozilla/dom/AudioWorkletNodeBinding.h"
#include "mozilla/dom/AudioParamMapBinding.h" #include "mozilla/dom/AudioParamMapBinding.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/RootedDictionary.h" #include "mozilla/dom/RootedDictionary.h"
#include "mozilla/dom/ErrorEvent.h" #include "mozilla/dom/ErrorEvent.h"
#include "mozilla/dom/Worklet.h" #include "mozilla/dom/Worklet.h"

View File

@ -11,7 +11,7 @@
#include "nsCOMPtr.h" #include "nsCOMPtr.h"
#include "nsPIDOMWindow.h" // nsPIDOMWindowInner #include "nsPIDOMWindow.h" // nsPIDOMWindowInner
#include "mozilla/dom/AutoEntryScript.h" #include "mozilla/dom/ScriptSettings.h" // AutoEntryScript
#include "nsIGlobalObject.h" #include "nsIGlobalObject.h"
#include "js/RootingAPI.h" // JS::Rooted #include "js/RootingAPI.h" // JS::Rooted
#include "js/Value.h" #include "js/Value.h"

View File

@ -32,7 +32,6 @@
#include "mozilla/HashFunctions.h" #include "mozilla/HashFunctions.h"
#include "mozilla/ProfilerLabels.h" #include "mozilla/ProfilerLabels.h"
#include "mozilla/UniquePtr.h" #include "mozilla/UniquePtr.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/ScriptSettings.h" #include "mozilla/dom/ScriptSettings.h"
#define NPRUNTIME_JSCLASS_NAME "NPObject JS wrapper class" #define NPRUNTIME_JSCLASS_NAME "NPObject JS wrapper class"

View File

@ -32,7 +32,6 @@
#include "nsPIDOMWindow.h" #include "nsPIDOMWindow.h"
#include "nsGlobalWindow.h" #include "nsGlobalWindow.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/Document.h" #include "mozilla/dom/Document.h"
#include "nsIContent.h" #include "nsIContent.h"
#include "nsIIDNService.h" #include "nsIIDNService.h"

View File

@ -18,7 +18,6 @@
#include "mozilla/ResultExtensions.h" #include "mozilla/ResultExtensions.h"
#include "mozilla/Unused.h" #include "mozilla/Unused.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/BindingUtils.h" #include "mozilla/dom/BindingUtils.h"
#include "mozilla/dom/DOMException.h" #include "mozilla/dom/DOMException.h"
#include "mozilla/dom/DOMExceptionBinding.h" #include "mozilla/dom/DOMExceptionBinding.h"

View File

@ -19,7 +19,6 @@
#include "mozilla/RefPtr.h" #include "mozilla/RefPtr.h"
#include "mozilla/Result.h" #include "mozilla/Result.h"
#include "mozilla/WeakPtr.h" #include "mozilla/WeakPtr.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/ScriptSettings.h" #include "mozilla/dom/ScriptSettings.h"
#include "mozilla/dom/ToJSValue.h" #include "mozilla/dom/ToJSValue.h"
#include "nsCycleCollectionParticipant.h" #include "nsCycleCollectionParticipant.h"

View File

@ -38,7 +38,6 @@
#include "nsMimeTypes.h" #include "nsMimeTypes.h"
#include "nsHtml5SVGLoadDispatcher.h" #include "nsHtml5SVGLoadDispatcher.h"
#include "nsTextNode.h" #include "nsTextNode.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/CDATASection.h" #include "mozilla/dom/CDATASection.h"
#include "mozilla/dom/Comment.h" #include "mozilla/dom/Comment.h"
#include "mozilla/dom/DocumentType.h" #include "mozilla/dom/DocumentType.h"

View File

@ -1,164 +0,0 @@
/* -*- 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 "mozilla/dom/AutoEntryScript.h"
#include <stdint.h>
#include <utility>
#include "js/ProfilingCategory.h"
#include "js/ProfilingStack.h"
#include "jsapi.h"
#include "mozilla/Assertions.h"
#include "mozilla/Maybe.h"
#include "mozilla/Span.h"
#include "nsCOMPtr.h"
#include "nsContentUtils.h"
#include "nsGlobalWindowInner.h"
#include "nsIDocShell.h"
#include "nsJSUtils.h"
#include "nsPIDOMWindow.h"
#include "nsPIDOMWindowInlines.h"
#include "nsString.h"
#include "xpcpublic.h"
namespace mozilla::dom {
namespace {
// Assert if it's not safe to run script. The helper class
// AutoAllowLegacyScriptExecution allows to allow-list
// legacy cases where it's actually not safe to run script.
#ifdef DEBUG
void AssertIfNotSafeToRunScript() {
// if it's safe to run script, then there is nothing to do here.
if (nsContentUtils::IsSafeToRunScript()) {
return;
}
// auto allowing legacy script execution is fine for now.
if (AutoAllowLegacyScriptExecution::IsAllowed()) {
return;
}
MOZ_ASSERT(false, "is it safe to run script?");
}
#endif
static unsigned long gRunToCompletionListeners = 0;
} // namespace
void UseEntryScriptProfiling() {
MOZ_ASSERT(NS_IsMainThread());
++gRunToCompletionListeners;
}
void UnuseEntryScriptProfiling() {
MOZ_ASSERT(NS_IsMainThread());
MOZ_ASSERT(gRunToCompletionListeners > 0);
--gRunToCompletionListeners;
}
AutoEntryScript::AutoEntryScript(nsIGlobalObject* aGlobalObject,
const char* aReason, bool aIsMainThread)
: AutoJSAPI(aGlobalObject, aIsMainThread, eEntryScript),
mWebIDLCallerPrincipal(nullptr)
// This relies on us having a cx() because the AutoJSAPI constructor
// already ran.
,
mCallerOverride(cx())
#ifdef MOZ_GECKO_PROFILER
,
mAutoProfilerLabel(
"", aReason, JS::ProfilingCategoryPair::JS,
uint32_t(js::ProfilingStackFrame::Flags::RELEVANT_FOR_JS))
#endif
,
mJSThreadExecution(aGlobalObject, aIsMainThread) {
MOZ_ASSERT(aGlobalObject);
if (aIsMainThread) {
#ifdef DEBUG
AssertIfNotSafeToRunScript();
#endif
if (gRunToCompletionListeners > 0) {
mDocShellEntryMonitor.emplace(cx(), aReason);
}
mScriptActivity.emplace(true);
}
}
AutoEntryScript::AutoEntryScript(JSObject* aObject, const char* aReason,
bool aIsMainThread)
: AutoEntryScript(xpc::NativeGlobal(aObject), aReason, aIsMainThread) {
// xpc::NativeGlobal uses JS::GetNonCCWObjectGlobal, which asserts that
// aObject is not a CCW.
}
AutoEntryScript::~AutoEntryScript() = default;
AutoEntryScript::DocshellEntryMonitor::DocshellEntryMonitor(JSContext* aCx,
const char* aReason)
: JS::dbg::AutoEntryMonitor(aCx), mReason(aReason) {}
void AutoEntryScript::DocshellEntryMonitor::Entry(
JSContext* aCx, JSFunction* aFunction, JSScript* aScript,
JS::Handle<JS::Value> aAsyncStack, const char* aAsyncCause) {
JS::Rooted<JSFunction*> rootedFunction(aCx);
if (aFunction) {
rootedFunction = aFunction;
}
JS::Rooted<JSScript*> rootedScript(aCx);
if (aScript) {
rootedScript = aScript;
}
nsCOMPtr<nsPIDOMWindowInner> window = xpc::CurrentWindowOrNull(aCx);
if (!window || !window->GetDocShell() ||
!window->GetDocShell()->GetRecordProfileTimelineMarkers()) {
return;
}
nsCOMPtr<nsIDocShell> docShellForJSRunToCompletion = window->GetDocShell();
nsAutoJSString functionName;
if (rootedFunction) {
JS::Rooted<JSString*> displayId(aCx,
JS_GetFunctionDisplayId(rootedFunction));
if (displayId) {
if (!functionName.init(aCx, displayId)) {
JS_ClearPendingException(aCx);
return;
}
}
}
nsString filename;
uint32_t lineNumber = 0;
if (!rootedScript) {
rootedScript = JS_GetFunctionScript(aCx, rootedFunction);
}
if (rootedScript) {
CopyUTF8toUTF16(MakeStringSpan(JS_GetScriptFilename(rootedScript)),
filename);
lineNumber = JS_GetScriptBaseLineNumber(aCx, rootedScript);
}
if (!filename.IsEmpty() || !functionName.IsEmpty()) {
docShellForJSRunToCompletion->NotifyJSRunToCompletionStart(
mReason, functionName, filename, lineNumber, aAsyncStack, aAsyncCause);
}
}
void AutoEntryScript::DocshellEntryMonitor::Exit(JSContext* aCx) {
nsCOMPtr<nsPIDOMWindowInner> window = xpc::CurrentWindowOrNull(aCx);
// Not really worth checking GetRecordProfileTimelineMarkers here.
if (window && window->GetDocShell()) {
nsCOMPtr<nsIDocShell> docShellForJSRunToCompletion = window->GetDocShell();
docShellForJSRunToCompletion->NotifyJSRunToCompletionStop();
}
}
} // namespace mozilla::dom

View File

@ -1,125 +0,0 @@
/* -*- 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/. */
#ifndef DOM_SCRIPT_AUTOENTRYSCRIPT_H_
#define DOM_SCRIPT_AUTOENTRYSCRIPT_H_
#include "MainThreadUtils.h"
#include "js/Debug.h"
//#include "js/RootingAPI.h"
#include "js/TypeDecls.h"
#include "jsapi.h"
#include "mozilla/Attributes.h"
#include "mozilla/Maybe.h"
#include "mozilla/dom/JSExecutionManager.h"
#include "mozilla/dom/ScriptSettings.h"
#ifdef MOZ_GECKO_PROFILER
# include "GeckoProfiler.h"
#endif
class nsIGlobalObject;
class nsIPrincipal;
namespace xpc {
class AutoScriptActivity;
}
namespace mozilla::dom {
/*
* Static helpers in ScriptSettings which track the number of listeners
* of Javascript RunToCompletion events. These should be used by the code in
* nsDocShell::SetRecordProfileTimelineMarkers to indicate to script
* settings that script run-to-completion needs to be monitored.
* SHOULD BE CALLED ONLY BY MAIN THREAD.
*/
void UseEntryScriptProfiling();
void UnuseEntryScriptProfiling();
/*
* A class that represents a new script entry point.
*
* |aReason| should be a statically-allocated C string naming the reason we're
* invoking JavaScript code: "setTimeout", "event", and so on. The devtools use
* these strings to label JS execution in timeline and profiling displays.
*
*/
class MOZ_STACK_CLASS AutoEntryScript : public AutoJSAPI {
public:
// Constructing the AutoEntryScript will ensure that it enters the
// Realm of aGlobalObject's JSObject and exposes that JSObject to active JS.
AutoEntryScript(nsIGlobalObject* aGlobalObject, const char* aReason,
bool aIsMainThread = NS_IsMainThread());
// aObject can be any object from the relevant global. It must not be a
// cross-compartment wrapper because CCWs are not associated with a single
// global.
//
// Constructing the AutoEntryScript will ensure that it enters the
// Realm of aObject JSObject and exposes aObject's global to active JS.
AutoEntryScript(JSObject* aObject, const char* aReason,
bool aIsMainThread = NS_IsMainThread());
~AutoEntryScript();
void SetWebIDLCallerPrincipal(nsIPrincipal* aPrincipal) {
mWebIDLCallerPrincipal = aPrincipal;
}
private:
// A subclass of AutoEntryMonitor that notifies the docshell.
class DocshellEntryMonitor final : public JS::dbg::AutoEntryMonitor {
public:
DocshellEntryMonitor(JSContext* aCx, const char* aReason);
// Please note that |aAsyncCause| here is owned by the caller, and its
// lifetime must outlive the lifetime of the DocshellEntryMonitor object.
// In practice, |aAsyncCause| is identical to |aReason| passed into
// the AutoEntryScript constructor, so the lifetime requirements are
// trivially satisfied by |aReason| being a statically allocated string.
void Entry(JSContext* aCx, JSFunction* aFunction,
JS::Handle<JS::Value> aAsyncStack,
const char* aAsyncCause) override {
Entry(aCx, aFunction, nullptr, aAsyncStack, aAsyncCause);
}
void Entry(JSContext* aCx, JSScript* aScript,
JS::Handle<JS::Value> aAsyncStack,
const char* aAsyncCause) override {
Entry(aCx, nullptr, aScript, aAsyncStack, aAsyncCause);
}
void Exit(JSContext* aCx) override;
private:
void Entry(JSContext* aCx, JSFunction* aFunction, JSScript* aScript,
JS::Handle<JS::Value> aAsyncStack, const char* aAsyncCause);
const char* mReason;
};
// It's safe to make this a weak pointer, since it's the subject principal
// when we go on the stack, so can't go away until after we're gone. In
// particular, this is only used from the CallSetup constructor, and only in
// the aIsJSImplementedWebIDL case. And in that case, the subject principal
// is the principal of the callee function that is part of the CallArgs just a
// bit up the stack, and which will outlive us. So we know the principal
// can't go away until then either.
nsIPrincipal* MOZ_NON_OWNING_REF mWebIDLCallerPrincipal;
friend nsIPrincipal* GetWebIDLCallerPrincipal();
Maybe<DocshellEntryMonitor> mDocShellEntryMonitor;
Maybe<xpc::AutoScriptActivity> mScriptActivity;
JS::AutoHideScriptedCaller mCallerOverride;
#ifdef MOZ_GECKO_PROFILER
AutoProfilerLabel mAutoProfilerLabel;
#endif
AutoRequestJSThreadExecution mJSThreadExecution;
};
} // namespace mozilla::dom
#endif // DOM_SCRIPT_AUTOENTRYSCRIPT_H_

View File

@ -29,7 +29,6 @@
#include "nsCycleCollectionParticipant.h" #include "nsCycleCollectionParticipant.h"
#include "nsIContent.h" #include "nsIContent.h"
#include "nsJSUtils.h" #include "nsJSUtils.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/DocGroup.h" #include "mozilla/dom/DocGroup.h"
#include "mozilla/dom/Element.h" #include "mozilla/dom/Element.h"
#include "mozilla/dom/JSExecutionContext.h" #include "mozilla/dom/JSExecutionContext.h"

View File

@ -5,47 +5,32 @@
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "mozilla/dom/ScriptSettings.h" #include "mozilla/dom/ScriptSettings.h"
#include <utility>
#include "LoadedScript.h" #include "LoadedScript.h"
#include "MainThreadUtils.h"
#include "js/CharacterEncoding.h"
#include "js/CompilationAndEvaluation.h"
#include "js/Conversions.h"
#include "js/ErrorReport.h"
#include "js/Exception.h"
#include "js/GCAPI.h"
#include "js/TypeDecls.h"
#include "js/Value.h"
#include "js/Warnings.h"
#include "js/Wrapper.h"
#include "js/friend/ErrorMessages.h"
#include "jsapi.h"
#include "mozilla/Assertions.h" #include "mozilla/Assertions.h"
#include "mozilla/BasePrincipal.h" #include "mozilla/BasePrincipal.h"
#include "mozilla/CycleCollectedJSContext.h" #include "mozilla/CycleCollectedJSContext.h"
#include "mozilla/DebugOnly.h"
#include "mozilla/Maybe.h"
#include "mozilla/RefPtr.h"
#include "mozilla/ThreadLocal.h" #include "mozilla/ThreadLocal.h"
#include "mozilla/dom/AutoEntryScript.h" #include "mozilla/Maybe.h"
#include "mozilla/dom/BindingUtils.h"
#include "mozilla/dom/Document.h" #include "mozilla/dom/Document.h"
#include "mozilla/dom/Element.h" #include "mozilla/dom/Element.h"
#include "mozilla/dom/ScriptLoadRequest.h" #include "mozilla/dom/JSExecutionManager.h"
#include "mozilla/dom/WorkerCommon.h" #include "mozilla/dom/WorkerPrivate.h"
#include "nsContentUtils.h"
#include "nsDebug.h" #include "jsapi.h"
#include "nsGlobalWindowInner.h" #include "js/CompilationAndEvaluation.h"
#include "nsIGlobalObject.h" #include "js/friend/ErrorMessages.h" // JSMSG_OUT_OF_MEMORY
#include "nsINode.h" #include "js/Warnings.h" // JS::{Get,}WarningReporter
#include "nsIPrincipal.h"
#include "nsISupports.h"
#include "nsJSUtils.h"
#include "nsPIDOMWindow.h"
#include "nsString.h"
#include "nscore.h"
#include "xpcpublic.h" #include "xpcpublic.h"
#include "nsIGlobalObject.h"
#include "nsIDocShell.h"
#include "nsIScriptGlobalObject.h"
#include "nsIScriptContext.h"
#include "nsContentUtils.h"
#include "nsGlobalWindow.h"
#include "nsPIDOMWindow.h"
#include "nsTArray.h"
#include "nsJSUtils.h"
#include "nsDOMJSUtils.h"
namespace mozilla { namespace mozilla {
namespace dom { namespace dom {
@ -81,6 +66,25 @@ JSObject* GetElementCallback(JSContext* aCx, JS::HandleValue aValue) {
static MOZ_THREAD_LOCAL(ScriptSettingsStackEntry*) sScriptSettingsTLS; static MOZ_THREAD_LOCAL(ScriptSettingsStackEntry*) sScriptSettingsTLS;
// Assert if it's not safe to run script. The helper class
// AutoAllowLegacyScriptExecution allows to allow-list
// legacy cases where it's actually not safe to run script.
#ifdef DEBUG
static void AssertIfNotSafeToRunScript() {
// if it's safe to run script, then there is nothing to do here.
if (nsContentUtils::IsSafeToRunScript()) {
return;
}
// auto allowing legacy script execution is fine for now.
if (AutoAllowLegacyScriptExecution::IsAllowed()) {
return;
}
MOZ_ASSERT(false, "is it safe to run script?");
}
#endif
class ScriptSettingsStack { class ScriptSettingsStack {
public: public:
static ScriptSettingsStackEntry* Top() { return sScriptSettingsTLS.get(); } static ScriptSettingsStackEntry* Top() { return sScriptSettingsTLS.get(); }
@ -148,6 +152,19 @@ class ScriptSettingsStack {
#endif // DEBUG #endif // DEBUG
}; };
static unsigned long gRunToCompletionListeners = 0;
void UseEntryScriptProfiling() {
MOZ_ASSERT(NS_IsMainThread());
++gRunToCompletionListeners;
}
void UnuseEntryScriptProfiling() {
MOZ_ASSERT(NS_IsMainThread());
MOZ_ASSERT(gRunToCompletionListeners > 0);
--gRunToCompletionListeners;
}
void InitScriptSettings() { void InitScriptSettings() {
bool success = sScriptSettingsTLS.init(); bool success = sScriptSettingsTLS.init();
if (!success) { if (!success) {
@ -615,6 +632,106 @@ bool AutoJSAPI::IsStackTop() const {
} }
#endif // DEBUG #endif // DEBUG
AutoEntryScript::AutoEntryScript(nsIGlobalObject* aGlobalObject,
const char* aReason, bool aIsMainThread)
: AutoJSAPI(aGlobalObject, aIsMainThread, eEntryScript),
mWebIDLCallerPrincipal(nullptr)
// This relies on us having a cx() because the AutoJSAPI constructor
// already ran.
,
mCallerOverride(cx())
#ifdef MOZ_GECKO_PROFILER
,
mAutoProfilerLabel(
"", aReason, JS::ProfilingCategoryPair::JS,
uint32_t(js::ProfilingStackFrame::Flags::RELEVANT_FOR_JS))
#endif
,
mJSThreadExecution(aGlobalObject, aIsMainThread) {
MOZ_ASSERT(aGlobalObject);
if (aIsMainThread) {
#ifdef DEBUG
AssertIfNotSafeToRunScript();
#endif
if (gRunToCompletionListeners > 0) {
mDocShellEntryMonitor.emplace(cx(), aReason);
}
mScriptActivity.emplace(true);
}
}
AutoEntryScript::AutoEntryScript(JSObject* aObject, const char* aReason,
bool aIsMainThread)
: AutoEntryScript(xpc::NativeGlobal(aObject), aReason, aIsMainThread) {
// xpc::NativeGlobal uses JS::GetNonCCWObjectGlobal, which asserts that
// aObject is not a CCW.
}
AutoEntryScript::~AutoEntryScript() = default;
AutoEntryScript::DocshellEntryMonitor::DocshellEntryMonitor(JSContext* aCx,
const char* aReason)
: JS::dbg::AutoEntryMonitor(aCx), mReason(aReason) {}
void AutoEntryScript::DocshellEntryMonitor::Entry(
JSContext* aCx, JSFunction* aFunction, JSScript* aScript,
JS::Handle<JS::Value> aAsyncStack, const char* aAsyncCause) {
JS::Rooted<JSFunction*> rootedFunction(aCx);
if (aFunction) {
rootedFunction = aFunction;
}
JS::Rooted<JSScript*> rootedScript(aCx);
if (aScript) {
rootedScript = aScript;
}
nsCOMPtr<nsPIDOMWindowInner> window = xpc::CurrentWindowOrNull(aCx);
if (!window || !window->GetDocShell() ||
!window->GetDocShell()->GetRecordProfileTimelineMarkers()) {
return;
}
nsCOMPtr<nsIDocShell> docShellForJSRunToCompletion = window->GetDocShell();
nsAutoJSString functionName;
if (rootedFunction) {
JS::Rooted<JSString*> displayId(aCx,
JS_GetFunctionDisplayId(rootedFunction));
if (displayId) {
if (!functionName.init(aCx, displayId)) {
JS_ClearPendingException(aCx);
return;
}
}
}
nsString filename;
uint32_t lineNumber = 0;
if (!rootedScript) {
rootedScript = JS_GetFunctionScript(aCx, rootedFunction);
}
if (rootedScript) {
CopyUTF8toUTF16(MakeStringSpan(JS_GetScriptFilename(rootedScript)),
filename);
lineNumber = JS_GetScriptBaseLineNumber(aCx, rootedScript);
}
if (!filename.IsEmpty() || !functionName.IsEmpty()) {
docShellForJSRunToCompletion->NotifyJSRunToCompletionStart(
mReason, functionName, filename, lineNumber, aAsyncStack, aAsyncCause);
}
}
void AutoEntryScript::DocshellEntryMonitor::Exit(JSContext* aCx) {
nsCOMPtr<nsPIDOMWindowInner> window = xpc::CurrentWindowOrNull(aCx);
// Not really worth checking GetRecordProfileTimelineMarkers here.
if (window && window->GetDocShell()) {
nsCOMPtr<nsIDocShell> docShellForJSRunToCompletion = window->GetDocShell();
docShellForJSRunToCompletion->NotifyJSRunToCompletionStop();
}
}
AutoIncumbentScript::AutoIncumbentScript(nsIGlobalObject* aGlobalObject) AutoIncumbentScript::AutoIncumbentScript(nsIGlobalObject* aGlobalObject)
: ScriptSettingsStackEntry(aGlobalObject, eIncumbentScript), : ScriptSettingsStackEntry(aGlobalObject, eIncumbentScript),
mCallerOverride(nsContentUtils::GetCurrentJSContext()) { mCallerOverride(nsContentUtils::GetCurrentJSContext()) {

View File

@ -9,15 +9,23 @@
#ifndef mozilla_dom_ScriptSettings_h #ifndef mozilla_dom_ScriptSettings_h
#define mozilla_dom_ScriptSettings_h #define mozilla_dom_ScriptSettings_h
#include "MainThreadUtils.h"
#include "xpcpublic.h" #include "xpcpublic.h"
#include "mozilla/dom/JSExecutionManager.h" #include "mozilla/dom/JSExecutionManager.h"
#include "mozilla/Maybe.h" #include "mozilla/Maybe.h"
#include "jsapi.h" #include "jsapi.h"
#include "js/Debug.h"
#include "js/Warnings.h" // JS::WarningReporter #include "js/Warnings.h" // JS::WarningReporter
#ifdef MOZ_GECKO_PROFILER
# include "GeckoProfiler.h"
#endif
class JSFunction;
class JSObject; class JSObject;
class JSScript;
class nsIGlobalObject; class nsIGlobalObject;
class nsIPrincipal; class nsIPrincipal;
class nsPIDOMWindowInner; class nsPIDOMWindowInner;
@ -42,6 +50,16 @@ class Document;
void InitScriptSettings(); void InitScriptSettings();
void DestroyScriptSettings(); void DestroyScriptSettings();
/*
* Static helpers in ScriptSettings which track the number of listeners
* of Javascript RunToCompletion events. These should be used by the code in
* nsDocShell::SetRecordProfileTimelineMarkers to indicate to script
* settings that script run-to-completion needs to be monitored.
* SHOULD BE CALLED ONLY BY MAIN THREAD.
*/
void UseEntryScriptProfiling();
void UnuseEntryScriptProfiling();
// To implement a web-compatible browser, it is often necessary to obtain the // To implement a web-compatible browser, it is often necessary to obtain the
// global object that is "associated" with the currently-running code. This // global object that is "associated" with the currently-running code. This
// process is made more complicated by the fact that, historically, different // process is made more complicated by the fact that, historically, different
@ -299,6 +317,87 @@ class MOZ_STACK_CLASS AutoJSAPI : protected ScriptSettingsStackEntry {
AutoJSAPI& operator=(const AutoJSAPI&) = delete; AutoJSAPI& operator=(const AutoJSAPI&) = delete;
}; };
/*
* A class that represents a new script entry point.
*
* |aReason| should be a statically-allocated C string naming the reason we're
* invoking JavaScript code: "setTimeout", "event", and so on. The devtools use
* these strings to label JS execution in timeline and profiling displays.
*
*/
class MOZ_STACK_CLASS AutoEntryScript : public AutoJSAPI {
public:
// Constructing the AutoEntryScript will ensure that it enters the
// Realm of aGlobalObject's JSObject and exposes that JSObject to active JS.
AutoEntryScript(nsIGlobalObject* aGlobalObject, const char* aReason,
bool aIsMainThread = NS_IsMainThread());
// aObject can be any object from the relevant global. It must not be a
// cross-compartment wrapper because CCWs are not associated with a single
// global.
//
// Constructing the AutoEntryScript will ensure that it enters the
// Realm of aObject JSObject and exposes aObject's global to active JS.
AutoEntryScript(JSObject* aObject, const char* aReason,
bool aIsMainThread = NS_IsMainThread());
~AutoEntryScript();
void SetWebIDLCallerPrincipal(nsIPrincipal* aPrincipal) {
mWebIDLCallerPrincipal = aPrincipal;
}
private:
// A subclass of AutoEntryMonitor that notifies the docshell.
class DocshellEntryMonitor final : public JS::dbg::AutoEntryMonitor {
public:
DocshellEntryMonitor(JSContext* aCx, const char* aReason);
// Please note that |aAsyncCause| here is owned by the caller, and its
// lifetime must outlive the lifetime of the DocshellEntryMonitor object.
// In practice, |aAsyncCause| is identical to |aReason| passed into
// the AutoEntryScript constructor, so the lifetime requirements are
// trivially satisfied by |aReason| being a statically allocated string.
void Entry(JSContext* aCx, JSFunction* aFunction,
JS::Handle<JS::Value> aAsyncStack,
const char* aAsyncCause) override {
Entry(aCx, aFunction, nullptr, aAsyncStack, aAsyncCause);
}
void Entry(JSContext* aCx, JSScript* aScript,
JS::Handle<JS::Value> aAsyncStack,
const char* aAsyncCause) override {
Entry(aCx, nullptr, aScript, aAsyncStack, aAsyncCause);
}
void Exit(JSContext* aCx) override;
private:
void Entry(JSContext* aCx, JSFunction* aFunction, JSScript* aScript,
JS::Handle<JS::Value> aAsyncStack, const char* aAsyncCause);
const char* mReason;
};
// It's safe to make this a weak pointer, since it's the subject principal
// when we go on the stack, so can't go away until after we're gone. In
// particular, this is only used from the CallSetup constructor, and only in
// the aIsJSImplementedWebIDL case. And in that case, the subject principal
// is the principal of the callee function that is part of the CallArgs just a
// bit up the stack, and which will outlive us. So we know the principal
// can't go away until then either.
nsIPrincipal* MOZ_NON_OWNING_REF mWebIDLCallerPrincipal;
friend nsIPrincipal* GetWebIDLCallerPrincipal();
Maybe<DocshellEntryMonitor> mDocShellEntryMonitor;
Maybe<xpc::AutoScriptActivity> mScriptActivity;
JS::AutoHideScriptedCaller mCallerOverride;
#ifdef MOZ_GECKO_PROFILER
AutoProfilerLabel mAutoProfilerLabel;
#endif
AutoRequestJSThreadExecution mJSThreadExecution;
};
/* /*
* A class that can be used to force a particular incumbent script on the stack. * A class that can be used to force a particular incumbent script on the stack.
*/ */

View File

@ -18,7 +18,6 @@ EXPORTS += [
] ]
EXPORTS.mozilla.dom += [ EXPORTS.mozilla.dom += [
"AutoEntryScript.h",
"LoadedScript.h", "LoadedScript.h",
"ScriptDecoding.h", "ScriptDecoding.h",
"ScriptElement.h", "ScriptElement.h",
@ -29,7 +28,6 @@ EXPORTS.mozilla.dom += [
] ]
UNIFIED_SOURCES += [ UNIFIED_SOURCES += [
"AutoEntryScript.cpp",
"LoadedScript.cpp", "LoadedScript.cpp",
"ModuleLoadRequest.cpp", "ModuleLoadRequest.cpp",
"nsIScriptElement.cpp", "nsIScriptElement.cpp",

View File

@ -39,7 +39,6 @@
#include "mozilla/StorageAccess.h" #include "mozilla/StorageAccess.h"
#include "mozilla/TaskCategory.h" #include "mozilla/TaskCategory.h"
#include "mozilla/UniquePtr.h" #include "mozilla/UniquePtr.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/BindingDeclarations.h" #include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/dom/BindingUtils.h" #include "mozilla/dom/BindingUtils.h"
#include "mozilla/dom/BlobURLProtocolHandler.h" #include "mozilla/dom/BlobURLProtocolHandler.h"

View File

@ -7,7 +7,6 @@
#include "Worklet.h" #include "Worklet.h"
#include "WorkletThread.h" #include "WorkletThread.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/WorkletBinding.h" #include "mozilla/dom/WorkletBinding.h"
#include "mozilla/dom/WorkletGlobalScope.h" #include "mozilla/dom/WorkletGlobalScope.h"
#include "mozilla/dom/BlobBinding.h" #include "mozilla/dom/BlobBinding.h"

View File

@ -8,7 +8,6 @@
#include "jsfriendapi.h" #include "jsfriendapi.h"
#include "mozilla/ArrayUtils.h" #include "mozilla/ArrayUtils.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/ScriptSettings.h" #include "mozilla/dom/ScriptSettings.h"
#include "xpcpublic.h" #include "xpcpublic.h"

View File

@ -27,7 +27,6 @@
#include "mozilla/Utf8.h" // mozilla::Utf8Unit #include "mozilla/Utf8.h" // mozilla::Utf8Unit
#include "mozilla/XPCOM.h" #include "mozilla/XPCOM.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/ScriptSettings.h" #include "mozilla/dom/ScriptSettings.h"
#include "nsIPrincipal.h" #include "nsIPrincipal.h"

View File

@ -62,7 +62,6 @@
#include "mozilla/ResultExtensions.h" #include "mozilla/ResultExtensions.h"
#include "mozilla/ScriptPreloader.h" #include "mozilla/ScriptPreloader.h"
#include "mozilla/ScopeExit.h" #include "mozilla/ScopeExit.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/ScriptSettings.h" #include "mozilla/dom/ScriptSettings.h"
#include "mozilla/ResultExtensions.h" #include "mozilla/ResultExtensions.h"
#include "mozilla/UniquePtrExtensions.h" #include "mozilla/UniquePtrExtensions.h"

View File

@ -32,7 +32,6 @@
#include "xpc_make_class.h" #include "xpc_make_class.h"
#include "XPCWrapper.h" #include "XPCWrapper.h"
#include "Crypto.h" #include "Crypto.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/BindingCallContext.h" #include "mozilla/dom/BindingCallContext.h"
#include "mozilla/dom/BindingUtils.h" #include "mozilla/dom/BindingUtils.h"
#include "mozilla/dom/BlobBinding.h" #include "mozilla/dom/BlobBinding.h"

View File

@ -80,6 +80,7 @@
using namespace mozilla; using namespace mozilla;
using namespace xpc; using namespace xpc;
using namespace JS; using namespace JS;
using mozilla::dom::AutoEntryScript;
// The watchdog thread loop is pretty trivial, and should not require much stack // The watchdog thread loop is pretty trivial, and should not require much stack
// space to do its job. So only give it 32KiB or the platform minimum. // space to do its job. So only give it 32KiB or the platform minimum.

View File

@ -86,6 +86,7 @@
using namespace mozilla; using namespace mozilla;
using namespace xpc; using namespace xpc;
using namespace JS; using namespace JS;
using mozilla::dom::AutoEntryScript;
using mozilla::dom::PerThreadAtomCache; using mozilla::dom::PerThreadAtomCache;
/***************************************************************************/ /***************************************************************************/

View File

@ -15,7 +15,6 @@
#include "js/PropertySpec.h" #include "js/PropertySpec.h"
#include "js/SourceText.h" // JS::SourceText #include "js/SourceText.h" // JS::SourceText
#include "mozilla/ChaosMode.h" #include "mozilla/ChaosMode.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/ScriptSettings.h" #include "mozilla/dom/ScriptSettings.h"
#include "mozilla/IOInterposer.h" #include "mozilla/IOInterposer.h"
#include "mozilla/Preferences.h" #include "mozilla/Preferences.h"

View File

@ -17,7 +17,6 @@
#include "nsJSUtils.h" #include "nsJSUtils.h"
#include "nsPrintfCString.h" #include "nsPrintfCString.h"
#include "mozilla/Attributes.h" #include "mozilla/Attributes.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/BindingUtils.h" #include "mozilla/dom/BindingUtils.h"
#include "mozilla/dom/DOMException.h" #include "mozilla/dom/DOMException.h"
#include "mozilla/dom/DOMExceptionBinding.h" #include "mozilla/dom/DOMExceptionBinding.h"

View File

@ -161,7 +161,6 @@
namespace mozilla { namespace mozilla {
namespace dom { namespace dom {
class AutoEntryScript;
class Exception; class Exception;
} // namespace dom } // namespace dom
} // namespace mozilla } // namespace mozilla

View File

@ -15,7 +15,6 @@
#include "mozilla/extensions/StreamFilterChild.h" #include "mozilla/extensions/StreamFilterChild.h"
#include "mozilla/extensions/StreamFilterEvents.h" #include "mozilla/extensions/StreamFilterEvents.h"
#include "mozilla/extensions/StreamFilterParent.h" #include "mozilla/extensions/StreamFilterParent.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/ContentChild.h" #include "mozilla/dom/ContentChild.h"
#include "mozilla/ipc/Endpoint.h" #include "mozilla/ipc/Endpoint.h"
#include "nsContentUtils.h" #include "nsContentUtils.h"

View File

@ -77,7 +77,6 @@
#include "mozilla/TimelineConsumers.h" #include "mozilla/TimelineConsumers.h"
#include "mozilla/TimelineMarker.h" #include "mozilla/TimelineMarker.h"
#include "mozilla/Unused.h" #include "mozilla/Unused.h"
#include "mozilla/dom/AutoEntryScript.h"
#include "mozilla/dom/DOMJSClass.h" #include "mozilla/dom/DOMJSClass.h"
#include "mozilla/dom/JSExecutionManager.h" #include "mozilla/dom/JSExecutionManager.h"
#include "mozilla/dom/ProfileTimelineMarkerBinding.h" #include "mozilla/dom/ProfileTimelineMarkerBinding.h"