/* -*- 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/Console.h" #include "mozilla/dom/ConsoleInstance.h" #include "mozilla/dom/ConsoleBinding.h" #include "ConsoleCommon.h" #include "mozilla/dom/BlobBinding.h" #include "mozilla/dom/DOMPrefs.h" #include "mozilla/dom/Exceptions.h" #include "mozilla/dom/File.h" #include "mozilla/dom/FunctionBinding.h" #include "mozilla/dom/Performance.h" #include "mozilla/dom/ScriptSettings.h" #include "mozilla/dom/StructuredCloneHolder.h" #include "mozilla/dom/ToJSValue.h" #include "mozilla/dom/WorkerPrivate.h" #include "mozilla/dom/WorkerRunnable.h" #include "mozilla/dom/WorkerScope.h" #include "mozilla/dom/WorkletGlobalScope.h" #include "mozilla/dom/WorkletThread.h" #include "mozilla/Maybe.h" #include "nsCycleCollectionParticipant.h" #include "nsDocument.h" #include "nsDOMNavigationTiming.h" #include "nsGlobalWindow.h" #include "nsJSUtils.h" #include "nsNetUtil.h" #include "xpcpublic.h" #include "nsContentUtils.h" #include "nsDocShell.h" #include "nsProxyRelease.h" #include "mozilla/ConsoleTimelineMarker.h" #include "mozilla/TimestampTimelineMarker.h" #include "nsIConsoleAPIStorage.h" #include "nsIDOMWindowUtils.h" #include "nsIException.h" // for nsIStackFrame #include "nsIInterfaceRequestorUtils.h" #include "nsILoadContext.h" #include "nsISensitiveInfoHiddenURI.h" #include "nsIServiceManager.h" #include "nsISupportsPrimitives.h" #include "nsIWebNavigation.h" #include "nsIXPConnect.h" // The maximum allowed number of concurrent timers per page. #define MAX_PAGE_TIMERS 10000 // The maximum allowed number of concurrent counters per page. #define MAX_PAGE_COUNTERS 10000 // The maximum stacktrace depth when populating the stacktrace array used for // console.trace(). #define DEFAULT_MAX_STACKTRACE_DEPTH 200 // This tags are used in the Structured Clone Algorithm to move js values from // worker thread to main thread #define CONSOLE_TAG_BLOB JS_SCTAG_USER_MIN // This value is taken from ConsoleAPIStorage.js #define STORAGE_MAX_EVENTS 1000 using namespace mozilla::dom::exceptions; namespace mozilla { namespace dom { struct ConsoleStructuredCloneData { nsCOMPtr mParent; nsTArray> mBlobs; }; /** * Console API in workers uses the Structured Clone Algorithm to move any value * from the worker thread to the main-thread. Some object cannot be moved and, * in these cases, we convert them to strings. * It's not the best, but at least we are able to show something. */ class ConsoleCallData final { public: NS_INLINE_DECL_REFCOUNTING(ConsoleCallData) ConsoleCallData() : mMethodName(Console::MethodLog) , mTimeStamp(JS_Now() / PR_USEC_PER_MSEC) , mStartTimerValue(0) , mStartTimerStatus(Console::eTimerUnknown) , mLogTimerDuration(0) , mLogTimerStatus(Console::eTimerUnknown) , mCountValue(MAX_PAGE_COUNTERS) , mIDType(eUnknown) , mOuterIDNumber(0) , mInnerIDNumber(0) , mStatus(eUnused) {} bool Initialize(JSContext* aCx, Console::MethodName aName, const nsAString& aString, const Sequence& aArguments, Console* aConsole) { AssertIsOnOwningThread(); MOZ_ASSERT(aConsole); // We must be registered before doing any JS operation otherwise it can // happen that mCopiedArguments are not correctly traced. aConsole->StoreCallData(this); mMethodName = aName; mMethodString = aString; mGlobal = JS::CurrentGlobalOrNull(aCx); for (uint32_t i = 0; i < aArguments.Length(); ++i) { if (NS_WARN_IF(!mCopiedArguments.AppendElement(aArguments[i]))) { aConsole->UnstoreCallData(this); return false; } } return true; } void SetIDs(uint64_t aOuterID, uint64_t aInnerID) { MOZ_ASSERT(mIDType == eUnknown); mOuterIDNumber = aOuterID; mInnerIDNumber = aInnerID; mIDType = eNumber; } void SetIDs(const nsAString& aOuterID, const nsAString& aInnerID) { MOZ_ASSERT(mIDType == eUnknown); mOuterIDString = aOuterID; mInnerIDString = aInnerID; mIDType = eString; } void SetOriginAttributes(const OriginAttributes& aOriginAttributes) { mOriginAttributes = aOriginAttributes; } void SetAddonId(nsIPrincipal* aPrincipal) { nsAutoString addonId; aPrincipal->GetAddonId(addonId); mAddonId = addonId; } bool PopulateArgumentsSequence(Sequence& aSequence) const { AssertIsOnOwningThread(); for (uint32_t i = 0; i < mCopiedArguments.Length(); ++i) { if (NS_WARN_IF(!aSequence.AppendElement(mCopiedArguments[i], fallible))) { return false; } } return true; } void Trace(const TraceCallbacks& aCallbacks, void* aClosure) { ConsoleCallData* tmp = this; for (uint32_t i = 0; i < mCopiedArguments.Length(); ++i) { NS_IMPL_CYCLE_COLLECTION_TRACE_JS_MEMBER_CALLBACK(mCopiedArguments[i]) } NS_IMPL_CYCLE_COLLECTION_TRACE_JS_MEMBER_CALLBACK(mGlobal); } void AssertIsOnOwningThread() const { NS_ASSERT_OWNINGTHREAD(ConsoleCallData); } JS::Heap mGlobal; // This is a copy of the arguments we received from the DOM bindings. Console // object traces them because this ConsoleCallData calls // RegisterConsoleCallData() in the Initialize(). nsTArray> mCopiedArguments; Console::MethodName mMethodName; int64_t mTimeStamp; // These values are set in the owning thread and they contain the timestamp of // when the new timer has started, the name of it and the status of the // creation of it. If status is false, something went wrong. User // DOMHighResTimeStamp instead mozilla::TimeStamp because we use // monotonicTimer from Performance.now(); // They will be set on the owning thread and never touched again on that // thread. They will be used in order to create a ConsoleTimerStart dictionary // when console.time() is used. DOMHighResTimeStamp mStartTimerValue; nsString mStartTimerLabel; Console::TimerStatus mStartTimerStatus; // These values are set in the owning thread and they contain the duration, // the name and the status of the LogTimer method. If status is false, // something went wrong. They will be set on the owning thread and never // touched again on that thread. They will be used in order to create a // ConsoleTimerLogOrEnd dictionary. This members are set when // console.timeEnd() or console.timeLog() are called. double mLogTimerDuration; nsString mLogTimerLabel; Console::TimerStatus mLogTimerStatus; // These 2 values are set by IncreaseCounter on the owning thread and they are // used CreateCounterValue. These members are set when console.count() is // called. nsString mCountLabel; uint32_t mCountValue; // The concept of outerID and innerID is misleading because when a // ConsoleCallData is created from a window, these are the window IDs, but // when the object is created from a SharedWorker, a ServiceWorker or a // subworker of a ChromeWorker these IDs are the type of worker and the // filename of the callee. // In Console.jsm the ID is 'jsm'. enum { eString, eNumber, eUnknown } mIDType; uint64_t mOuterIDNumber; nsString mOuterIDString; uint64_t mInnerIDNumber; nsString mInnerIDString; OriginAttributes mOriginAttributes; nsString mAddonId; nsString mMethodString; // Stack management is complicated, because we want to do it as // lazily as possible. Therefore, we have the following behavior: // 1) mTopStackFrame is initialized whenever we have any JS on the stack // 2) mReifiedStack is initialized if we're created in a worker. // 3) mStack is set (possibly to null if there is no JS on the stack) if // we're created on main thread. Maybe mTopStackFrame; Maybe> mReifiedStack; nsCOMPtr mStack; // mStatus is about the lifetime of this object. Console must take care of // keep it alive or not following this enumeration. enum { // If the object is created but it is owned by some runnable, this is its // status. It can be deleted at any time. eUnused, // When a runnable takes ownership of a ConsoleCallData and send it to // different thread, this is its status. Console cannot delete it at this // time. eInUse, // When a runnable owns this ConsoleCallData, we can't delete it directly. // instead, we mark it with this new status and we move it in // mCallDataStoragePending list in order to keep it alive an trace it // correctly. Once the runnable finishs its task, it will delete this object // calling ReleaseCallData(). eToBeDeleted } mStatus; private: ~ConsoleCallData() { AssertIsOnOwningThread(); MOZ_ASSERT(mStatus != eInUse); } }; // This base class must be extended for Worker and for Worklet. class ConsoleRunnable : public StructuredCloneHolderBase { public: ~ConsoleRunnable() override { // Clear the StructuredCloneHolderBase class. Clear(); } protected: JSObject* CustomReadHandler(JSContext* aCx, JSStructuredCloneReader* aReader, uint32_t aTag, uint32_t aIndex) override { AssertIsOnMainThread(); if (aTag == CONSOLE_TAG_BLOB) { MOZ_ASSERT(mClonedData.mBlobs.Length() > aIndex); JS::Rooted val(aCx); { RefPtr blob = Blob::Create(mClonedData.mParent, mClonedData.mBlobs.ElementAt(aIndex)); if (!ToJSValue(aCx, blob, &val)) { return nullptr; } } return &val.toObject(); } MOZ_CRASH("No other tags are supported."); return nullptr; } bool CustomWriteHandler(JSContext* aCx, JSStructuredCloneWriter* aWriter, JS::Handle aObj) override { RefPtr blob; if (NS_SUCCEEDED(UNWRAP_OBJECT(Blob, aObj, blob)) && blob->Impl()->MayBeClonedToOtherThreads()) { if (NS_WARN_IF(!JS_WriteUint32Pair(aWriter, CONSOLE_TAG_BLOB, mClonedData.mBlobs.Length()))) { return false; } mClonedData.mBlobs.AppendElement(blob->Impl()); return true; } if (!JS_ObjectNotWritten(aWriter, aObj)) { return false; } JS::Rooted value(aCx, JS::ObjectOrNullValue(aObj)); JS::Rooted jsString(aCx, JS::ToString(aCx, value)); if (NS_WARN_IF(!jsString)) { return false; } if (NS_WARN_IF(!JS_WriteString(aWriter, jsString))) { return false; } return true; } // Helper methods for CallData bool StoreConsoleData(JSContext* aCx, ConsoleCallData* aCallData) { ConsoleCommon::ClearException ce(aCx); JS::Rooted arguments(aCx, JS_NewArrayObject(aCx, aCallData->mCopiedArguments.Length())); if (NS_WARN_IF(!arguments)) { return false; } JS::Rooted arg(aCx); for (uint32_t i = 0; i < aCallData->mCopiedArguments.Length(); ++i) { arg = aCallData->mCopiedArguments[i]; if (NS_WARN_IF(!JS_DefineElement(aCx, arguments, i, arg, JSPROP_ENUMERATE))) { return false; } } JS::Rooted value(aCx, JS::ObjectValue(*arguments)); if (NS_WARN_IF(!Write(aCx, value))) { return false; } return true; } void ProcessCallData(JSContext* aCx, Console* aConsole, ConsoleCallData* aCallData) { AssertIsOnMainThread(); ConsoleCommon::ClearException ce(aCx); JS::Rooted argumentsValue(aCx); if (!Read(aCx, &argumentsValue)) { return; } MOZ_ASSERT(argumentsValue.isObject()); JS::Rooted argumentsObj(aCx, &argumentsValue.toObject()); uint32_t length; if (!JS_GetArrayLength(aCx, argumentsObj, &length)) { return; } Sequence values; SequenceRooter arguments(aCx, &values); for (uint32_t i = 0; i < length; ++i) { JS::Rooted value(aCx); if (!JS_GetElement(aCx, argumentsObj, i, &value)) { return; } if (!values.AppendElement(value, fallible)) { return; } } MOZ_ASSERT(values.Length() == length); aConsole->ProcessCallData(aCx, aCallData, values); } void ReleaseCallData(Console* aConsole, ConsoleCallData* aCallData) { aConsole->AssertIsOnOwningThread(); if (aCallData->mStatus == ConsoleCallData::eToBeDeleted) { aConsole->ReleaseCallData(aCallData); } else { MOZ_ASSERT(aCallData->mStatus == ConsoleCallData::eInUse); aCallData->mStatus = ConsoleCallData::eUnused; } } // Helper methods for Profile calls bool StoreProfileData(JSContext* aCx, const Sequence& aArguments) { ConsoleCommon::ClearException ce(aCx); JS::Rooted arguments(aCx, JS_NewArrayObject(aCx, aArguments.Length())); if (NS_WARN_IF(!arguments)) { return false; } JS::Rooted arg(aCx); for (uint32_t i = 0; i < aArguments.Length(); ++i) { arg = aArguments[i]; if (NS_WARN_IF(!JS_DefineElement(aCx, arguments, i, arg, JSPROP_ENUMERATE))) { return false; } } JS::Rooted value(aCx, JS::ObjectValue(*arguments)); if (NS_WARN_IF(!Write(aCx, value))) { return false; } return true; } void ProcessProfileData(JSContext* aCx, Console* aConsole, Console::MethodName aMethodName, const nsAString& aAction) { AssertIsOnMainThread(); ConsoleCommon::ClearException ce(aCx); JS::Rooted argumentsValue(aCx); bool ok = Read(aCx, &argumentsValue); mClonedData.mParent = nullptr; if (!ok) { return; } MOZ_ASSERT(argumentsValue.isObject()); JS::Rooted argumentsObj(aCx, &argumentsValue.toObject()); if (NS_WARN_IF(!argumentsObj)) { return; } uint32_t length; if (!JS_GetArrayLength(aCx, argumentsObj, &length)) { return; } Sequence arguments; for (uint32_t i = 0; i < length; ++i) { JS::Rooted value(aCx); if (!JS_GetElement(aCx, argumentsObj, i, &value)) { return; } if (!arguments.AppendElement(value, fallible)) { return; } } aConsole->ProfileMethodInternal(aCx, aMethodName, aAction, arguments); } ConsoleStructuredCloneData mClonedData; }; class ConsoleWorkletRunnable : public Runnable , public ConsoleRunnable { protected: explicit ConsoleWorkletRunnable(Console* aConsole) : Runnable("dom::console::ConsoleWorkletRunnable") , mConsole(aConsole) , mWorkletThread(WorkletThread::Get()) { WorkletThread::AssertIsOnWorkletThread(); MOZ_ASSERT(mWorkletThread); } ~ConsoleWorkletRunnable() override = default; NS_IMETHOD Run() override { // This runnable is dispatched to main-thread first, then it goes back to // worklet thread. if (NS_IsMainThread()) { RunOnMainThread(); RefPtr runnable(this); return mWorkletThread->DispatchRunnable(runnable.forget()); } WorkletThread::AssertIsOnWorkletThread(); ReleaseData(); mConsole = nullptr; return NS_OK; } protected: // This method is called in the main-thread. virtual void RunOnMainThread() = 0; // This method is called in the owning thread of the Console object. virtual void ReleaseData() = 0; // This must be released on the worker thread. RefPtr mConsole; RefPtr mWorkletThread; }; // This runnable appends a CallData object into the Console queue running on // the main-thread. class ConsoleCallDataWorkletRunnable final : public ConsoleWorkletRunnable { public: static already_AddRefed Create(Console* aConsole, ConsoleCallData* aConsoleData) { WorkletThread::AssertIsOnWorkletThread(); RefPtr workletThread = WorkletThread::Get(); MOZ_ASSERT(workletThread); aConsoleData->SetIDs(workletThread->GetWorkletLoadInfo().OuterWindowID(), workletThread->GetWorkletLoadInfo().InnerWindowID()); RefPtr runnable = new ConsoleCallDataWorkletRunnable(aConsole, aConsoleData); if (!runnable->StoreConsoleData(WorkletThread::Get()->GetJSContext(), aConsoleData)) { return nullptr; } return runnable.forget(); } private: ConsoleCallDataWorkletRunnable(Console* aConsole, ConsoleCallData* aCallData) : ConsoleWorkletRunnable(aConsole) , mCallData(aCallData) { WorkletThread::AssertIsOnWorkletThread(); MOZ_ASSERT(aCallData); aCallData->AssertIsOnOwningThread(); // Marking this CallData as in use. mCallData->mStatus = ConsoleCallData::eInUse; } ~ConsoleCallDataWorkletRunnable() override { MOZ_ASSERT(!mCallData); } void RunOnMainThread() override { AutoSafeJSContext cx; JSObject* sandbox = mConsole->GetOrCreateSandbox(cx, mWorkletThread->GetWorkletLoadInfo().Principal()); JS::Rooted global(cx, sandbox); if (NS_WARN_IF(!global)) { return; } // The CreateSandbox call returns a proxy to the actual sandbox object. We // don't need a proxy here. global = js::UncheckedUnwrap(global); JSAutoRealm ar(cx, global); // We don't need to set a parent object in mCallData bacause there are not // DOM objects exposed to worklet. ProcessCallData(cx, mConsole, mCallData); } virtual void ReleaseData() override { ReleaseCallData(mConsole, mCallData); mCallData = nullptr; } RefPtr mCallData; }; class ConsoleWorkerRunnable : public WorkerProxyToMainThreadRunnable , public ConsoleRunnable { public: explicit ConsoleWorkerRunnable(Console* aConsole) : WorkerProxyToMainThreadRunnable(GetCurrentThreadWorkerPrivate()) , mConsole(aConsole) {} ~ConsoleWorkerRunnable() override = default; bool Dispatch(JSContext* aCx) { mWorkerPrivate->AssertIsOnWorkerThread(); if (NS_WARN_IF(!PreDispatch(aCx))) { RunBackOnWorkerThreadForCleanup(); return false; } if (NS_WARN_IF(!WorkerProxyToMainThreadRunnable::Dispatch())) { // RunBackOnWorkerThreadForCleanup() will be called by // WorkerProxyToMainThreadRunnable::Dispatch(). return false; } return true; } protected: void RunOnMainThread() override { AssertIsOnMainThread(); // Walk up to our containing page WorkerPrivate* wp = mWorkerPrivate; while (wp->GetParent()) { wp = wp->GetParent(); } nsPIDOMWindowInner* window = wp->GetWindow(); if (!window) { RunWindowless(); } else { RunWithWindow(window); } } void RunWithWindow(nsPIDOMWindowInner* aWindow) { AssertIsOnMainThread(); AutoJSAPI jsapi; MOZ_ASSERT(aWindow); RefPtr win = nsGlobalWindowInner::Cast(aWindow); if (NS_WARN_IF(!jsapi.Init(win))) { return; } nsPIDOMWindowOuter* outerWindow = aWindow->GetOuterWindow(); if (NS_WARN_IF(!outerWindow)) { return; } RunConsole(jsapi.cx(), outerWindow, aWindow); } void RunWindowless() { AssertIsOnMainThread(); WorkerPrivate* wp = mWorkerPrivate; while (wp->GetParent()) { wp = wp->GetParent(); } MOZ_ASSERT(!wp->GetWindow()); AutoJSAPI jsapi; jsapi.Init(); JSContext* cx = jsapi.cx(); JS::Rooted global(cx, mConsole->GetOrCreateSandbox(cx, wp->GetPrincipal())); if (NS_WARN_IF(!global)) { return; } // The GetOrCreateSandbox call returns a proxy to the actual sandbox object. // We don't need a proxy here. global = js::UncheckedUnwrap(global); JSAutoRealm ar(cx, global); RunConsole(cx, nullptr, nullptr); } void RunBackOnWorkerThreadForCleanup() override { mWorkerPrivate->AssertIsOnWorkerThread(); ReleaseData(); mConsole = nullptr; } // This method is called in the owning thread of the Console object. virtual bool PreDispatch(JSContext* aCx) = 0; // This method is called in the main-thread. virtual void RunConsole(JSContext* aCx, nsPIDOMWindowOuter* aOuterWindow, nsPIDOMWindowInner* aInnerWindow) = 0; // This method is called in the owning thread of the Console object. virtual void ReleaseData() = 0; // This must be released on the worker thread. RefPtr mConsole; ConsoleStructuredCloneData mClonedData; }; // This runnable appends a CallData object into the Console queue running on // the main-thread. class ConsoleCallDataWorkerRunnable final : public ConsoleWorkerRunnable { public: ConsoleCallDataWorkerRunnable(Console* aConsole, ConsoleCallData* aCallData) : ConsoleWorkerRunnable(aConsole) , mCallData(aCallData) { MOZ_ASSERT(aCallData); mWorkerPrivate->AssertIsOnWorkerThread(); mCallData->AssertIsOnOwningThread(); // Marking this CallData as in use. mCallData->mStatus = ConsoleCallData::eInUse; } private: ~ConsoleCallDataWorkerRunnable() override { MOZ_ASSERT(!mCallData); } bool PreDispatch(JSContext* aCx) override { return StoreConsoleData(aCx, mCallData); } void RunConsole(JSContext* aCx, nsPIDOMWindowOuter* aOuterWindow, nsPIDOMWindowInner* aInnerWindow) override { AssertIsOnMainThread(); // The windows have to run in parallel. MOZ_ASSERT(!!aOuterWindow == !!aInnerWindow); if (aOuterWindow) { mCallData->SetIDs(aOuterWindow->WindowID(), aInnerWindow->WindowID()); } else { ConsoleStackEntry frame; if (mCallData->mTopStackFrame) { frame = *mCallData->mTopStackFrame; } nsString id = frame.mFilename; nsString innerID; if (mWorkerPrivate->IsSharedWorker()) { innerID = NS_LITERAL_STRING("SharedWorker"); } else if (mWorkerPrivate->IsServiceWorker()) { innerID = NS_LITERAL_STRING("ServiceWorker"); // Use scope as ID so the webconsole can decide if the message should // show up per tab CopyASCIItoUTF16(mWorkerPrivate->ServiceWorkerScope(), id); } else { innerID = NS_LITERAL_STRING("Worker"); } mCallData->SetIDs(id, innerID); } // Now we could have the correct window (if we are not window-less). mClonedData.mParent = aInnerWindow; ProcessCallData(aCx, mConsole, mCallData); mClonedData.mParent = nullptr; } virtual void ReleaseData() override { ReleaseCallData(mConsole, mCallData); mCallData = nullptr; } RefPtr mCallData; }; // This runnable calls ProfileMethod() on the console on the main-thread. class ConsoleProfileWorkletRunnable final : public ConsoleWorkletRunnable { public: static already_AddRefed Create(Console* aConsole, Console::MethodName aName, const nsAString& aAction, const Sequence& aArguments) { WorkletThread::AssertIsOnWorkletThread(); RefPtr runnable = new ConsoleProfileWorkletRunnable(aConsole, aName, aAction); if (!runnable->StoreProfileData(WorkletThread::Get()->GetJSContext(), aArguments)) { return nullptr; } return runnable.forget(); } private: ConsoleProfileWorkletRunnable(Console* aConsole, Console::MethodName aName, const nsAString& aAction) : ConsoleWorkletRunnable(aConsole) , mName(aName) , mAction(aAction) { MOZ_ASSERT(aConsole); } void RunOnMainThread() override { AssertIsOnMainThread(); AutoSafeJSContext cx; JSObject* sandbox = mConsole->GetOrCreateSandbox(cx, mWorkletThread->GetWorkletLoadInfo().Principal()); JS::Rooted global(cx, sandbox); if (NS_WARN_IF(!global)) { return; } // The CreateSandbox call returns a proxy to the actual sandbox object. We // don't need a proxy here. global = js::UncheckedUnwrap(global); JSAutoRealm ar(cx, global); // We don't need to set a parent object in mCallData bacause there are not // DOM objects exposed to worklet. ProcessProfileData(cx, mConsole, mName, mAction); } virtual void ReleaseData() override {} Console::MethodName mName; nsString mAction; }; // This runnable calls ProfileMethod() on the console on the main-thread. class ConsoleProfileWorkerRunnable final : public ConsoleWorkerRunnable { public: ConsoleProfileWorkerRunnable(Console* aConsole, Console::MethodName aName, const nsAString& aAction, const Sequence& aArguments) : ConsoleWorkerRunnable(aConsole) , mName(aName) , mAction(aAction) , mArguments(aArguments) { MOZ_ASSERT(aConsole); } private: bool PreDispatch(JSContext* aCx) override { return StoreProfileData(aCx, mArguments); } void RunConsole(JSContext* aCx, nsPIDOMWindowOuter* aOuterWindow, nsPIDOMWindowInner* aInnerWindow) override { AssertIsOnMainThread(); // Now we could have the correct window (if we are not window-less). mClonedData.mParent = aInnerWindow; ProcessProfileData(aCx, mConsole, mName, mAction); mClonedData.mParent = nullptr; } virtual void ReleaseData() override {} Console::MethodName mName; nsString mAction; // This is a reference of the sequence of arguments we receive from the DOM // bindings and it's rooted by them. It's only used on the owning thread in // PreDispatch(). const Sequence& mArguments; }; NS_IMPL_CYCLE_COLLECTION_CLASS(Console) // We don't need to traverse/unlink mStorage and mSandbox because they are not // CCed objects and they are only used on the main thread, even when this // Console object is used on workers. NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(Console) NS_IMPL_CYCLE_COLLECTION_UNLINK(mWindow) NS_IMPL_CYCLE_COLLECTION_UNLINK(mConsoleEventNotifier) NS_IMPL_CYCLE_COLLECTION_UNLINK(mDumpFunction) tmp->Shutdown(); NS_IMPL_CYCLE_COLLECTION_UNLINK_END NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(Console) NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mWindow) NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mConsoleEventNotifier) NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mDumpFunction) NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END NS_IMPL_CYCLE_COLLECTION_TRACE_BEGIN(Console) for (uint32_t i = 0; i < tmp->mCallDataStorage.Length(); ++i) { tmp->mCallDataStorage[i]->Trace(aCallbacks, aClosure); } for (uint32_t i = 0; i < tmp->mCallDataStoragePending.Length(); ++i) { tmp->mCallDataStoragePending[i]->Trace(aCallbacks, aClosure); } NS_IMPL_CYCLE_COLLECTION_TRACE_END NS_IMPL_CYCLE_COLLECTING_ADDREF(Console) NS_IMPL_CYCLE_COLLECTING_RELEASE(Console) NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(Console) NS_INTERFACE_MAP_ENTRY(nsIObserver) NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIObserver) NS_INTERFACE_MAP_ENTRY(nsISupportsWeakReference) NS_INTERFACE_MAP_END /* static */ already_AddRefed Console::Create(JSContext* aCx, nsPIDOMWindowInner* aWindow, ErrorResult& aRv) { MOZ_ASSERT_IF(NS_IsMainThread(), aWindow); uint64_t outerWindowID = 0; uint64_t innerWindowID = 0; if (aWindow) { innerWindowID = aWindow->WindowID(); // Without outerwindow any console message coming from this object will not // shown in the devtools webconsole. But this should be fine because // probably we are shutting down, or the window is CCed/GCed. nsPIDOMWindowOuter* outerWindow = aWindow->GetOuterWindow(); if (outerWindow) { outerWindowID = outerWindow->WindowID(); } } RefPtr console = new Console(aCx, aWindow, outerWindowID, innerWindowID); console->Initialize(aRv); if (NS_WARN_IF(aRv.Failed())) { return nullptr; } return console.forget(); } /* static */ already_AddRefed Console::CreateForWorklet(JSContext* aCx, uint64_t aOuterWindowID, uint64_t aInnerWindowID, ErrorResult& aRv) { WorkletThread::AssertIsOnWorkletThread(); RefPtr console = new Console(aCx, nullptr, aOuterWindowID, aInnerWindowID); console->Initialize(aRv); if (NS_WARN_IF(aRv.Failed())) { return nullptr; } return console.forget(); } Console::Console(JSContext* aCx, nsPIDOMWindowInner* aWindow, uint64_t aOuterWindowID, uint64_t aInnerWindowID) : mWindow(aWindow) , mOuterID(aOuterWindowID) , mInnerID(aInnerWindowID) , mDumpToStdout(false) , mChromeInstance(false) , mMaxLogLevel(ConsoleLogLevel::All) , mStatus(eUnknown) , mCreationTimeStamp(TimeStamp::Now()) { // Let's enable the dumping to stdout by default for chrome. if (nsContentUtils::ThreadsafeIsSystemCaller(aCx)) { mDumpToStdout = DOMPrefs::DumpEnabled(); } mozilla::HoldJSObjects(this); } Console::~Console() { AssertIsOnOwningThread(); Shutdown(); mozilla::DropJSObjects(this); } void Console::Initialize(ErrorResult& aRv) { AssertIsOnOwningThread(); MOZ_ASSERT(mStatus == eUnknown); if (NS_IsMainThread()) { nsCOMPtr obs = mozilla::services::GetObserverService(); if (NS_WARN_IF(!obs)) { aRv.Throw(NS_ERROR_FAILURE); return; } if (mWindow) { aRv = obs->AddObserver(this, "inner-window-destroyed", true); if (NS_WARN_IF(aRv.Failed())) { return; } } aRv = obs->AddObserver(this, "memory-pressure", true); if (NS_WARN_IF(aRv.Failed())) { return; } } mStatus = eInitialized; } void Console::Shutdown() { AssertIsOnOwningThread(); if (mStatus == eUnknown || mStatus == eShuttingDown) { return; } if (NS_IsMainThread()) { nsCOMPtr obs = mozilla::services::GetObserverService(); if (obs) { obs->RemoveObserver(this, "inner-window-destroyed"); obs->RemoveObserver(this, "memory-pressure"); } } NS_ReleaseOnMainThreadSystemGroup("Console::mStorage", mStorage.forget()); NS_ReleaseOnMainThreadSystemGroup("Console::mSandbox", mSandbox.forget()); mTimerRegistry.Clear(); mCounterRegistry.Clear(); mCallDataStorage.Clear(); mCallDataStoragePending.Clear(); mStatus = eShuttingDown; } NS_IMETHODIMP Console::Observe(nsISupports* aSubject, const char* aTopic, const char16_t* aData) { AssertIsOnMainThread(); if (!strcmp(aTopic, "inner-window-destroyed")) { nsCOMPtr wrapper = do_QueryInterface(aSubject); NS_ENSURE_TRUE(wrapper, NS_ERROR_FAILURE); uint64_t innerID; nsresult rv = wrapper->GetData(&innerID); NS_ENSURE_SUCCESS(rv, rv); if (innerID == mInnerID) { Shutdown(); } return NS_OK; } if (!strcmp(aTopic, "memory-pressure")) { ClearStorage(); return NS_OK; } return NS_OK; } void Console::ClearStorage() { mCallDataStorage.Clear(); } #define METHOD(name, string) \ /* static */ void \ Console::name(const GlobalObject& aGlobal, const Sequence& aData) \ { \ Method(aGlobal, Method##name, NS_LITERAL_STRING(string), aData); \ } METHOD(Log, "log") METHOD(Info, "info") METHOD(Warn, "warn") METHOD(Error, "error") METHOD(Exception, "exception") METHOD(Debug, "debug") METHOD(Table, "table") METHOD(Trace, "trace") // Displays an interactive listing of all the properties of an object. METHOD(Dir, "dir"); METHOD(Dirxml, "dirxml"); METHOD(Group, "group") METHOD(GroupCollapsed, "groupCollapsed") #undef METHOD /* static */ void Console::Clear(const GlobalObject& aGlobal) { const Sequence data; Method(aGlobal, MethodClear, NS_LITERAL_STRING("clear"), data); } /* static */ void Console::GroupEnd(const GlobalObject& aGlobal) { const Sequence data; Method(aGlobal, MethodGroupEnd, NS_LITERAL_STRING("groupEnd"), data); } /* static */ void Console::Time(const GlobalObject& aGlobal, const nsAString& aLabel) { StringMethod(aGlobal, aLabel, Sequence(), MethodTime, NS_LITERAL_STRING("time")); } /* static */ void Console::TimeEnd(const GlobalObject& aGlobal, const nsAString& aLabel) { StringMethod(aGlobal, aLabel, Sequence(), MethodTimeEnd, NS_LITERAL_STRING("timeEnd")); } /* static */ void Console::TimeLog(const GlobalObject& aGlobal, const nsAString& aLabel, const Sequence& aData) { StringMethod(aGlobal, aLabel, aData, MethodTimeLog, NS_LITERAL_STRING("timeLog")); } /* static */ void Console::StringMethod(const GlobalObject& aGlobal, const nsAString& aLabel, const Sequence& aData, MethodName aMethodName, const nsAString& aMethodString) { RefPtr console = GetConsole(aGlobal); if (!console) { return; } console->StringMethodInternal(aGlobal.Context(), aLabel, aData, aMethodName, aMethodString); } void Console::StringMethodInternal(JSContext* aCx, const nsAString& aLabel, const Sequence& aData, MethodName aMethodName, const nsAString& aMethodString) { ConsoleCommon::ClearException ce(aCx); Sequence data; SequenceRooter rooter(aCx, &data); JS::Rooted value(aCx); if (!dom::ToJSValue(aCx, aLabel, &value)) { return; } if (!data.AppendElement(value, fallible)) { return; } for (uint32_t i = 0; i < aData.Length(); ++i) { if (!data.AppendElement(aData[i], fallible)) { return; } } MethodInternal(aCx, aMethodName, aMethodString, data); } /* static */ void Console::TimeStamp(const GlobalObject& aGlobal, const JS::Handle aData) { JSContext* cx = aGlobal.Context(); ConsoleCommon::ClearException ce(cx); Sequence data; SequenceRooter rooter(cx, &data); if (aData.isString() && !data.AppendElement(aData, fallible)) { return; } Method(aGlobal, MethodTimeStamp, NS_LITERAL_STRING("timeStamp"), data); } /* static */ void Console::Profile(const GlobalObject& aGlobal, const Sequence& aData) { ProfileMethod(aGlobal, MethodProfile, NS_LITERAL_STRING("profile"), aData); } /* static */ void Console::ProfileEnd(const GlobalObject& aGlobal, const Sequence& aData) { ProfileMethod(aGlobal, MethodProfileEnd, NS_LITERAL_STRING("profileEnd"), aData); } /* static */ void Console::ProfileMethod(const GlobalObject& aGlobal, MethodName aName, const nsAString& aAction, const Sequence& aData) { RefPtr console = GetConsole(aGlobal); if (!console) { return; } JSContext* cx = aGlobal.Context(); console->ProfileMethodInternal(cx, aName, aAction, aData); } bool Console::IsEnabled(JSContext* aCx) const { // Console is always enabled if it is a custom Chrome-Only instance. if (mChromeInstance) { return true; } // Make all Console API no-op if DevTools aren't enabled. return DOMPrefs::DevToolsEnabled(); } void Console::ProfileMethodInternal(JSContext* aCx, MethodName aMethodName, const nsAString& aAction, const Sequence& aData) { if (!IsEnabled(aCx)) { return; } if (!ShouldProceed(aMethodName)) { return; } MaybeExecuteDumpFunction(aCx, aAction, aData, nullptr); if (WorkletThread::IsOnWorkletThread()) { RefPtr runnable = ConsoleProfileWorkletRunnable::Create(this, aMethodName, aAction, aData); if (!runnable) { return; } WorkletThread::Get()->DispatchRunnable(runnable.forget()); return; } if (!NS_IsMainThread()) { // Here we are in a worker thread. RefPtr runnable = new ConsoleProfileWorkerRunnable(this, aMethodName, aAction, aData); runnable->Dispatch(aCx); return; } ConsoleCommon::ClearException ce(aCx); RootedDictionary event(aCx); event.mAction = aAction; event.mArguments.Construct(); Sequence& sequence = event.mArguments.Value(); for (uint32_t i = 0; i < aData.Length(); ++i) { if (!sequence.AppendElement(aData[i], fallible)) { return; } } JS::Rooted eventValue(aCx); if (!ToJSValue(aCx, event, &eventValue)) { return; } JS::Rooted eventObj(aCx, &eventValue.toObject()); MOZ_ASSERT(eventObj); if (!JS_DefineProperty(aCx, eventObj, "wrappedJSObject", eventValue, JSPROP_ENUMERATE)) { return; } nsIXPConnect* xpc = nsContentUtils::XPConnect(); nsCOMPtr wrapper; const nsIID& iid = NS_GET_IID(nsISupports); if (NS_FAILED(xpc->WrapJS(aCx, eventObj, iid, getter_AddRefs(wrapper)))) { return; } nsCOMPtr obs = mozilla::services::GetObserverService(); if (obs) { obs->NotifyObservers(wrapper, "console-api-profiler", nullptr); } } /* static */ void Console::Assert(const GlobalObject& aGlobal, bool aCondition, const Sequence& aData) { if (!aCondition) { Method(aGlobal, MethodAssert, NS_LITERAL_STRING("assert"), aData); } } /* static */ void Console::Count(const GlobalObject& aGlobal, const nsAString& aLabel) { StringMethod(aGlobal, aLabel, Sequence(), MethodCount, NS_LITERAL_STRING("count")); } namespace { void StackFrameToStackEntry(JSContext* aCx, nsIStackFrame* aStackFrame, ConsoleStackEntry& aStackEntry) { MOZ_ASSERT(aStackFrame); aStackFrame->GetFilename(aCx, aStackEntry.mFilename); aStackEntry.mLineNumber = aStackFrame->GetLineNumber(aCx); aStackEntry.mColumnNumber = aStackFrame->GetColumnNumber(aCx); aStackFrame->GetName(aCx, aStackEntry.mFunctionName); nsString cause; aStackFrame->GetAsyncCause(aCx, cause); if (!cause.IsEmpty()) { aStackEntry.mAsyncCause.Construct(cause); } } void ReifyStack(JSContext* aCx, nsIStackFrame* aStack, nsTArray& aRefiedStack) { nsCOMPtr stack(aStack); while (stack) { ConsoleStackEntry& data = *aRefiedStack.AppendElement(); StackFrameToStackEntry(aCx, stack, data); nsCOMPtr caller = stack->GetCaller(aCx); if (!caller) { caller = stack->GetAsyncCaller(aCx); } stack.swap(caller); } } } // anonymous namespace // Queue a call to a console method. See the CALL_DELAY constant. /* static */ void Console::Method(const GlobalObject& aGlobal, MethodName aMethodName, const nsAString& aMethodString, const Sequence& aData) { RefPtr console = GetConsole(aGlobal); if (!console) { return; } console->MethodInternal(aGlobal.Context(), aMethodName, aMethodString, aData); } void Console::MethodInternal(JSContext* aCx, MethodName aMethodName, const nsAString& aMethodString, const Sequence& aData) { if (!IsEnabled(aCx)) { return; } if (!ShouldProceed(aMethodName)) { return; } AssertIsOnOwningThread(); RefPtr callData(new ConsoleCallData()); ConsoleCommon::ClearException ce(aCx); if (NS_WARN_IF(!callData->Initialize(aCx, aMethodName, aMethodString, aData, this))) { return; } OriginAttributes oa; if (NS_IsMainThread()) { if (mWindow) { // Save the principal's OriginAttributes in the console event data // so that we will be able to filter messages by origin attributes. nsCOMPtr sop = do_QueryInterface(mWindow); if (NS_WARN_IF(!sop)) { return; } nsCOMPtr principal = sop->GetPrincipal(); if (NS_WARN_IF(!principal)) { return; } oa = principal->OriginAttributesRef(); callData->SetAddonId(principal); #ifdef DEBUG if (!nsContentUtils::IsSystemPrincipal(principal)) { nsCOMPtr webNav = do_GetInterface(mWindow); if (webNav) { nsCOMPtr loadContext = do_QueryInterface(webNav); MOZ_ASSERT(loadContext); bool pb; if (NS_SUCCEEDED(loadContext->GetUsePrivateBrowsing(&pb))) { MOZ_ASSERT(pb == !!oa.mPrivateBrowsingId); } } } #endif } } else if (WorkletThread::IsOnWorkletThread()) { oa = WorkletThread::Get()->GetWorkletLoadInfo().OriginAttributesRef(); } else { WorkerPrivate* workerPrivate = GetCurrentThreadWorkerPrivate(); MOZ_ASSERT(workerPrivate); oa = workerPrivate->GetOriginAttributes(); } callData->SetOriginAttributes(oa); JS::StackCapture captureMode = ShouldIncludeStackTrace(aMethodName) ? JS::StackCapture(JS::MaxFrames(DEFAULT_MAX_STACKTRACE_DEPTH)) : JS::StackCapture(JS::FirstSubsumedFrame(aCx)); nsCOMPtr stack = CreateStack(aCx, mozilla::Move(captureMode)); if (stack) { callData->mTopStackFrame.emplace(); StackFrameToStackEntry(aCx, stack, *callData->mTopStackFrame); } if (NS_IsMainThread()) { callData->mStack = stack; } else { // nsIStackFrame is not threadsafe, so we need to snapshot it now, // before we post our runnable to the main thread. callData->mReifiedStack.emplace(); ReifyStack(aCx, stack, *callData->mReifiedStack); } DOMHighResTimeStamp monotonicTimer; // Monotonic timer for 'time', 'timeLog' and 'timeEnd' if ((aMethodName == MethodTime || aMethodName == MethodTimeLog || aMethodName == MethodTimeEnd || aMethodName == MethodTimeStamp) && !MonotonicTimer(aCx, aMethodName, aData, &monotonicTimer)) { return; } if (aMethodName == MethodTime && !aData.IsEmpty()) { callData->mStartTimerStatus = StartTimer(aCx, aData[0], monotonicTimer, callData->mStartTimerLabel, &callData->mStartTimerValue); } else if (aMethodName == MethodTimeEnd && !aData.IsEmpty()) { callData->mLogTimerStatus = LogTimer(aCx, aData[0], monotonicTimer, callData->mLogTimerLabel, &callData->mLogTimerDuration, true /* Cancel timer */); } else if (aMethodName == MethodTimeLog && !aData.IsEmpty()) { callData->mLogTimerStatus = LogTimer(aCx, aData[0], monotonicTimer, callData->mLogTimerLabel, &callData->mLogTimerDuration, false /* Cancel timer */); } else if (aMethodName == MethodCount) { callData->mCountValue = IncreaseCounter(aCx, aData, callData->mCountLabel); if (!callData->mCountValue) { return; } } // Before processing this CallData differently, it's time to call the dump // function. if (aMethodName == MethodTrace || aMethodName == MethodAssert) { MaybeExecuteDumpFunction(aCx, aMethodString, aData, stack); } else if ((aMethodName == MethodTime || aMethodName == MethodTimeEnd) && !aData.IsEmpty()) { MaybeExecuteDumpFunctionForTime(aCx, aMethodName, aMethodString, monotonicTimer, aData[0]); } else { MaybeExecuteDumpFunction(aCx, aMethodString, aData, nullptr); } if (NS_IsMainThread()) { if (mWindow) { callData->SetIDs(mOuterID, mInnerID); } else if (!mPassedInnerID.IsEmpty()) { callData->SetIDs(NS_LITERAL_STRING("jsm"), mPassedInnerID); } else { nsAutoString filename; if (callData->mTopStackFrame.isSome()) { filename = callData->mTopStackFrame->mFilename; } callData->SetIDs(NS_LITERAL_STRING("jsm"), filename); } ProcessCallData(aCx, callData, aData); // Just because we don't want to expose // retrieveConsoleEvents/setConsoleEventHandler to main-thread, we can // cleanup the mCallDataStorage: UnstoreCallData(callData); return; } if (WorkletThread::IsOnWorkletThread()) { RefPtr runnable = ConsoleCallDataWorkletRunnable::Create(this, callData); if (!runnable) { return; } NS_DispatchToMainThread(runnable); return; } // We do this only in workers for now. NotifyHandler(aCx, aData, callData); RefPtr runnable = new ConsoleCallDataWorkerRunnable(this, callData); Unused << NS_WARN_IF(!runnable->Dispatch(aCx)); } // We store information to lazily compute the stack in the reserved slots of // LazyStackGetter. The first slot always stores a JS object: it's either the // JS wrapper of the nsIStackFrame or the actual reified stack representation. // The second slot is a PrivateValue() holding an nsIStackFrame* when we haven't // reified the stack yet, or an UndefinedValue() otherwise. enum { SLOT_STACKOBJ, SLOT_RAW_STACK }; bool LazyStackGetter(JSContext* aCx, unsigned aArgc, JS::Value* aVp) { JS::CallArgs args = CallArgsFromVp(aArgc, aVp); JS::Rooted callee(aCx, &args.callee()); JS::Value v = js::GetFunctionNativeReserved(&args.callee(), SLOT_RAW_STACK); if (v.isUndefined()) { // Already reified. args.rval().set(js::GetFunctionNativeReserved(callee, SLOT_STACKOBJ)); return true; } nsIStackFrame* stack = reinterpret_cast(v.toPrivate()); nsTArray reifiedStack; ReifyStack(aCx, stack, reifiedStack); JS::Rooted stackVal(aCx); if (NS_WARN_IF(!ToJSValue(aCx, reifiedStack, &stackVal))) { return false; } MOZ_ASSERT(stackVal.isObject()); js::SetFunctionNativeReserved(callee, SLOT_STACKOBJ, stackVal); js::SetFunctionNativeReserved(callee, SLOT_RAW_STACK, JS::UndefinedValue()); args.rval().set(stackVal); return true; } void Console::ProcessCallData(JSContext* aCx, ConsoleCallData* aData, const Sequence& aArguments) { AssertIsOnMainThread(); MOZ_ASSERT(aData); JS::Rooted eventValue(aCx); // We want to create a console event object and pass it to our // nsIConsoleAPIStorage implementation. We want to define some accessor // properties on this object, and those will need to keep an nsIStackFrame // alive. But nsIStackFrame cannot be wrapped in an untrusted scope. And // further, passing untrusted objects to system code is likely to run afoul of // Object Xrays. So we want to wrap in a system-principal scope here. But // which one? We could cheat and try to get the underlying JSObject* of // mStorage, but that's a bit fragile. Instead, we just use the junk scope, // with explicit permission from the XPConnect module owner. If you're // tempted to do that anywhere else, talk to said module owner first. // aCx and aArguments are in the same compartment. if (NS_WARN_IF(!PopulateConsoleNotificationInTheTargetScope(aCx, aArguments, xpc::PrivilegedJunkScope(), &eventValue, aData))) { return; } if (!mStorage) { mStorage = do_GetService("@mozilla.org/consoleAPI-storage;1"); } if (!mStorage) { NS_WARNING("Failed to get the ConsoleAPIStorage service."); return; } nsAutoString innerID, outerID; MOZ_ASSERT(aData->mIDType != ConsoleCallData::eUnknown); if (aData->mIDType == ConsoleCallData::eString) { outerID = aData->mOuterIDString; innerID = aData->mInnerIDString; } else { MOZ_ASSERT(aData->mIDType == ConsoleCallData::eNumber); outerID.AppendInt(aData->mOuterIDNumber); innerID.AppendInt(aData->mInnerIDNumber); } if (aData->mMethodName == MethodClear) { DebugOnly rv = mStorage->ClearEvents(innerID); NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "ClearEvents failed"); } if (NS_FAILED(mStorage->RecordEvent(innerID, outerID, eventValue))) { NS_WARNING("Failed to record a console event."); } } bool Console::PopulateConsoleNotificationInTheTargetScope(JSContext* aCx, const Sequence& aArguments, JSObject* aTargetScope, JS::MutableHandle aEventValue, ConsoleCallData* aData) { MOZ_ASSERT(aCx); MOZ_ASSERT(aData); MOZ_ASSERT(aTargetScope); JS::Rooted targetScope(aCx, aTargetScope); ConsoleStackEntry frame; if (aData->mTopStackFrame) { frame = *aData->mTopStackFrame; } ConsoleCommon::ClearException ce(aCx); RootedDictionary event(aCx); event.mAddonId = aData->mAddonId; event.mID.Construct(); event.mInnerID.Construct(); if (aData->mIDType == ConsoleCallData::eString) { event.mID.Value().SetAsString() = aData->mOuterIDString; event.mInnerID.Value().SetAsString() = aData->mInnerIDString; } else if (aData->mIDType == ConsoleCallData::eNumber) { event.mID.Value().SetAsUnsignedLongLong() = aData->mOuterIDNumber; event.mInnerID.Value().SetAsUnsignedLongLong() = aData->mInnerIDNumber; } else { // aData->mIDType can be eUnknown when we dispatch notifications via // mConsoleEventNotifier. event.mID.Value().SetAsUnsignedLongLong() = 0; event.mInnerID.Value().SetAsUnsignedLongLong() = 0; } event.mConsoleID = mConsoleID; event.mLevel = aData->mMethodString; event.mFilename = frame.mFilename; event.mPrefix = mPrefix; nsCOMPtr filenameURI; nsAutoCString pass; if (NS_IsMainThread() && NS_SUCCEEDED(NS_NewURI(getter_AddRefs(filenameURI), frame.mFilename)) && NS_SUCCEEDED(filenameURI->GetPassword(pass)) && !pass.IsEmpty()) { nsCOMPtr safeURI = do_QueryInterface(filenameURI); nsAutoCString spec; if (safeURI && NS_SUCCEEDED(safeURI->GetSensitiveInfoHiddenSpec(spec))) { CopyUTF8toUTF16(spec, event.mFilename); } } event.mLineNumber = frame.mLineNumber; event.mColumnNumber = frame.mColumnNumber; event.mFunctionName = frame.mFunctionName; event.mTimeStamp = aData->mTimeStamp; event.mPrivate = !!aData->mOriginAttributes.mPrivateBrowsingId; switch (aData->mMethodName) { case MethodLog: case MethodInfo: case MethodWarn: case MethodError: case MethodException: case MethodDebug: case MethodAssert: case MethodGroup: case MethodGroupCollapsed: event.mArguments.Construct(); event.mStyles.Construct(); if (NS_WARN_IF(!ProcessArguments(aCx, aArguments, event.mArguments.Value(), event.mStyles.Value()))) { return false; } break; default: event.mArguments.Construct(); if (NS_WARN_IF(!ArgumentsToValueList(aArguments, event.mArguments.Value()))) { return false; } } if (aData->mMethodName == MethodGroup || aData->mMethodName == MethodGroupCollapsed) { ComposeAndStoreGroupName(aCx, event.mArguments.Value(), event.mGroupName); } else if (aData->mMethodName == MethodGroupEnd) { if (!UnstoreGroupName(event.mGroupName)) { return false; } } else if (aData->mMethodName == MethodTime && !aArguments.IsEmpty()) { event.mTimer = CreateStartTimerValue(aCx, aData->mStartTimerLabel, aData->mStartTimerStatus); } else if ((aData->mMethodName == MethodTimeEnd || aData->mMethodName == MethodTimeLog) && !aArguments.IsEmpty()) { event.mTimer = CreateLogOrEndTimerValue(aCx, aData->mLogTimerLabel, aData->mLogTimerDuration, aData->mLogTimerStatus); } else if (aData->mMethodName == MethodCount) { event.mCounter = CreateCounterValue(aCx, aData->mCountLabel, aData->mCountValue); } JSAutoRealm ar2(aCx, targetScope); if (NS_WARN_IF(!ToJSValue(aCx, event, aEventValue))) { return false; } JS::Rooted eventObj(aCx, &aEventValue.toObject()); if (NS_WARN_IF(!JS_DefineProperty(aCx, eventObj, "wrappedJSObject", eventObj, JSPROP_ENUMERATE))) { return false; } if (ShouldIncludeStackTrace(aData->mMethodName)) { // Now define the "stacktrace" property on eventObj. There are two cases // here. Either we came from a worker and have a reified stack, or we want // to define a getter that will lazily reify the stack. if (aData->mReifiedStack) { JS::Rooted stacktrace(aCx); if (NS_WARN_IF(!ToJSValue(aCx, *aData->mReifiedStack, &stacktrace)) || NS_WARN_IF(!JS_DefineProperty(aCx, eventObj, "stacktrace", stacktrace, JSPROP_ENUMERATE))) { return false; } } else { JSFunction* fun = js::NewFunctionWithReserved(aCx, LazyStackGetter, 0, 0, "stacktrace"); if (NS_WARN_IF(!fun)) { return false; } JS::Rooted funObj(aCx, JS_GetFunctionObject(fun)); // We want to store our stack in the function and have it stay alive. But // we also need sane access to the C++ nsIStackFrame. So store both a JS // wrapper and the raw pointer: the former will keep the latter alive. JS::Rooted stackVal(aCx); nsresult rv = nsContentUtils::WrapNative(aCx, aData->mStack, &stackVal); if (NS_WARN_IF(NS_FAILED(rv))) { return false; } js::SetFunctionNativeReserved(funObj, SLOT_STACKOBJ, stackVal); js::SetFunctionNativeReserved(funObj, SLOT_RAW_STACK, JS::PrivateValue(aData->mStack.get())); if (NS_WARN_IF(!JS_DefineProperty(aCx, eventObj, "stacktrace", JS_DATA_TO_FUNC_PTR(JSNative, funObj.get()), nullptr, JSPROP_ENUMERATE | JSPROP_GETTER | JSPROP_SETTER))) { return false; } } } return true; } namespace { // Helper method for ProcessArguments. Flushes output, if non-empty, to aSequence. bool FlushOutput(JSContext* aCx, Sequence& aSequence, nsString &aOutput) { if (!aOutput.IsEmpty()) { JS::Rooted str(aCx, JS_NewUCStringCopyN(aCx, aOutput.get(), aOutput.Length())); if (NS_WARN_IF(!str)) { return false; } if (NS_WARN_IF(!aSequence.AppendElement(JS::StringValue(str), fallible))) { return false; } aOutput.Truncate(); } return true; } } // namespace bool Console::ProcessArguments(JSContext* aCx, const Sequence& aData, Sequence& aSequence, Sequence& aStyles) const { if (aData.IsEmpty()) { return true; } if (aData.Length() == 1 || !aData[0].isString()) { return ArgumentsToValueList(aData, aSequence); } JS::Rooted format(aCx, aData[0]); JS::Rooted jsString(aCx, JS::ToString(aCx, format)); if (NS_WARN_IF(!jsString)) { return false; } nsAutoJSString string; if (NS_WARN_IF(!string.init(aCx, jsString))) { return false; } nsString::const_iterator start, end; string.BeginReading(start); string.EndReading(end); nsString output; uint32_t index = 1; while (start != end) { if (*start != '%') { output.Append(*start); ++start; continue; } ++start; if (start == end) { output.Append('%'); break; } if (*start == '%') { output.Append(*start); ++start; continue; } nsAutoString tmp; tmp.Append('%'); int32_t integer = -1; int32_t mantissa = -1; // Let's parse %. for %d and %f if (*start >= '0' && *start <= '9') { integer = 0; do { integer = integer * 10 + *start - '0'; tmp.Append(*start); ++start; } while (*start >= '0' && *start <= '9' && start != end); } if (start == end) { output.Append(tmp); break; } if (*start == '.') { tmp.Append(*start); ++start; if (start == end) { output.Append(tmp); break; } // '.' must be followed by a number. if (*start < '0' || *start > '9') { output.Append(tmp); continue; } mantissa = 0; do { mantissa = mantissa * 10 + *start - '0'; tmp.Append(*start); ++start; } while (*start >= '0' && *start <= '9' && start != end); if (start == end) { output.Append(tmp); break; } } char ch = *start; tmp.Append(ch); ++start; switch (ch) { case 'o': case 'O': { if (NS_WARN_IF(!FlushOutput(aCx, aSequence, output))) { return false; } JS::Rooted v(aCx); if (index < aData.Length()) { v = aData[index++]; } if (NS_WARN_IF(!aSequence.AppendElement(v, fallible))) { return false; } break; } case 'c': { // If there isn't any output but there's already a style, then // discard the previous style and use the next one instead. if (output.IsEmpty() && !aStyles.IsEmpty()) { aStyles.TruncateLength(aStyles.Length() - 1); } if (NS_WARN_IF(!FlushOutput(aCx, aSequence, output))) { return false; } if (index < aData.Length()) { JS::Rooted v(aCx, aData[index++]); JS::Rooted jsString(aCx, JS::ToString(aCx, v)); if (NS_WARN_IF(!jsString)) { return false; } int32_t diff = aSequence.Length() - aStyles.Length(); if (diff > 0) { for (int32_t i = 0; i < diff; i++) { if (NS_WARN_IF(!aStyles.AppendElement(VoidString(), fallible))) { return false; } } } nsAutoJSString string; if (NS_WARN_IF(!string.init(aCx, jsString))) { return false; } if (NS_WARN_IF(!aStyles.AppendElement(string, fallible))) { return false; } } break; } case 's': if (index < aData.Length()) { JS::Rooted value(aCx, aData[index++]); JS::Rooted jsString(aCx, JS::ToString(aCx, value)); if (NS_WARN_IF(!jsString)) { return false; } nsAutoJSString v; if (NS_WARN_IF(!v.init(aCx, jsString))) { return false; } output.Append(v); } break; case 'd': case 'i': if (index < aData.Length()) { JS::Rooted value(aCx, aData[index++]); int32_t v; if (NS_WARN_IF(!JS::ToInt32(aCx, value, &v))) { return false; } nsCString format; MakeFormatString(format, integer, mantissa, 'd'); output.AppendPrintf(format.get(), v); } break; case 'f': if (index < aData.Length()) { JS::Rooted value(aCx, aData[index++]); double v; if (NS_WARN_IF(!JS::ToNumber(aCx, value, &v))) { return false; } // nspr returns "nan", but we want to expose it as "NaN" if (std::isnan(v)) { output.AppendFloat(v); } else { nsCString format; MakeFormatString(format, integer, mantissa, 'f'); output.AppendPrintf(format.get(), v); } } break; default: output.Append(tmp); break; } } if (NS_WARN_IF(!FlushOutput(aCx, aSequence, output))) { return false; } // Discard trailing style element if there is no output to apply it to. if (aStyles.Length() > aSequence.Length()) { aStyles.TruncateLength(aSequence.Length()); } // The rest of the array, if unused by the format string. for (; index < aData.Length(); ++index) { if (NS_WARN_IF(!aSequence.AppendElement(aData[index], fallible))) { return false; } } return true; } void Console::MakeFormatString(nsCString& aFormat, int32_t aInteger, int32_t aMantissa, char aCh) const { aFormat.Append('%'); if (aInteger >= 0) { aFormat.AppendInt(aInteger); } if (aMantissa >= 0) { aFormat.Append('.'); aFormat.AppendInt(aMantissa); } aFormat.Append(aCh); } void Console::ComposeAndStoreGroupName(JSContext* aCx, const Sequence& aData, nsAString& aName) { for (uint32_t i = 0; i < aData.Length(); ++i) { if (i != 0) { aName.AppendASCII(" "); } JS::Rooted value(aCx, aData[i]); JS::Rooted jsString(aCx, JS::ToString(aCx, value)); if (!jsString) { return; } nsAutoJSString string; if (!string.init(aCx, jsString)) { return; } aName.Append(string); } mGroupStack.AppendElement(aName); } bool Console::UnstoreGroupName(nsAString& aName) { if (mGroupStack.IsEmpty()) { return false; } uint32_t pos = mGroupStack.Length() - 1; aName = mGroupStack[pos]; mGroupStack.RemoveElementAt(pos); return true; } Console::TimerStatus Console::StartTimer(JSContext* aCx, const JS::Value& aName, DOMHighResTimeStamp aTimestamp, nsAString& aTimerLabel, DOMHighResTimeStamp* aTimerValue) { AssertIsOnOwningThread(); MOZ_ASSERT(aTimerValue); *aTimerValue = 0; if (NS_WARN_IF(mTimerRegistry.Count() >= MAX_PAGE_TIMERS)) { return eTimerMaxReached; } JS::Rooted name(aCx, aName); JS::Rooted jsString(aCx, JS::ToString(aCx, name)); if (NS_WARN_IF(!jsString)) { return eTimerJSException; } nsAutoJSString label; if (NS_WARN_IF(!label.init(aCx, jsString))) { return eTimerJSException; } aTimerLabel = label; auto entry = mTimerRegistry.LookupForAdd(label); if (entry) { return eTimerAlreadyExists; } entry.OrInsert([&aTimestamp](){ return aTimestamp; }); *aTimerValue = aTimestamp; return eTimerDone; } JS::Value Console::CreateStartTimerValue(JSContext* aCx, const nsAString& aTimerLabel, TimerStatus aTimerStatus) const { MOZ_ASSERT(aTimerStatus != eTimerUnknown); if (aTimerStatus != eTimerDone) { return CreateTimerError(aCx, aTimerLabel, aTimerStatus); } RootedDictionary timer(aCx); timer.mName = aTimerLabel; JS::Rooted value(aCx); if (!ToJSValue(aCx, timer, &value)) { return JS::UndefinedValue(); } return value; } Console::TimerStatus Console::LogTimer(JSContext* aCx, const JS::Value& aName, DOMHighResTimeStamp aTimestamp, nsAString& aTimerLabel, double* aTimerDuration, bool aCancelTimer) { AssertIsOnOwningThread(); MOZ_ASSERT(aTimerDuration); *aTimerDuration = 0; JS::Rooted name(aCx, aName); JS::Rooted jsString(aCx, JS::ToString(aCx, name)); if (NS_WARN_IF(!jsString)) { return eTimerJSException; } nsAutoJSString key; if (NS_WARN_IF(!key.init(aCx, jsString))) { return eTimerJSException; } aTimerLabel = key; DOMHighResTimeStamp value = 0; if (aCancelTimer) { if (!mTimerRegistry.Remove(key, &value)) { NS_WARNING("mTimerRegistry entry not found"); return eTimerDoesntExist; } } else { if (!mTimerRegistry.Get(key, &value)) { NS_WARNING("mTimerRegistry entry not found"); return eTimerDoesntExist; } } *aTimerDuration = aTimestamp - value; return eTimerDone; } JS::Value Console::CreateLogOrEndTimerValue(JSContext* aCx, const nsAString& aLabel, double aDuration, TimerStatus aStatus) const { if (aStatus != eTimerDone) { return CreateTimerError(aCx, aLabel, aStatus); } RootedDictionary timer(aCx); timer.mName = aLabel; timer.mDuration = aDuration; JS::Rooted value(aCx); if (!ToJSValue(aCx, timer, &value)) { return JS::UndefinedValue(); } return value; } JS::Value Console::CreateTimerError(JSContext* aCx, const nsAString& aLabel, TimerStatus aStatus) const { MOZ_ASSERT(aStatus != eTimerUnknown && aStatus != eTimerDone); RootedDictionary error(aCx); error.mName = aLabel; switch (aStatus) { case eTimerAlreadyExists: error.mError.AssignLiteral("timerAlreadyExists"); break; case eTimerDoesntExist: error.mError.AssignLiteral("timerDoesntExist"); break; case eTimerJSException: error.mError.AssignLiteral("timerJSError"); break; case eTimerMaxReached: error.mError.AssignLiteral("maxTimersExceeded"); break; default: MOZ_CRASH("Unsupported status"); break; } JS::Rooted value(aCx); if (!ToJSValue(aCx, error, &value)) { return JS::UndefinedValue(); } return value; } bool Console::ArgumentsToValueList(const Sequence& aData, Sequence& aSequence) const { for (uint32_t i = 0; i < aData.Length(); ++i) { if (NS_WARN_IF(!aSequence.AppendElement(aData[i], fallible))) { return false; } } return true; } uint32_t Console::IncreaseCounter(JSContext* aCx, const Sequence& aArguments, nsAString& aCountLabel) { AssertIsOnOwningThread(); ConsoleCommon::ClearException ce(aCx); MOZ_ASSERT(!aArguments.IsEmpty()); JS::Rooted labelValue(aCx, aArguments[0]); JS::Rooted jsString(aCx, JS::ToString(aCx, labelValue)); if (!jsString) { return 0; // We cannot continue. } nsAutoJSString string; if (!string.init(aCx, jsString)) { return 0; // We cannot continue. } aCountLabel = string; const bool maxCountersReached = mCounterRegistry.Count() >= MAX_PAGE_COUNTERS; auto entry = mCounterRegistry.LookupForAdd(aCountLabel); if (entry) { ++entry.Data(); } else { entry.OrInsert([](){ return 1; }); if (maxCountersReached) { // oops, we speculatively added an entry even though we shouldn't mCounterRegistry.Remove(aCountLabel); return MAX_PAGE_COUNTERS; } } return entry.Data(); } JS::Value Console::CreateCounterValue(JSContext* aCx, const nsAString& aCountLabel, uint32_t aCountValue) const { ConsoleCommon::ClearException ce(aCx); if (aCountValue == MAX_PAGE_COUNTERS) { RootedDictionary error(aCx); JS::Rooted value(aCx); if (!ToJSValue(aCx, error, &value)) { return JS::UndefinedValue(); } return value; } RootedDictionary data(aCx); data.mLabel = aCountLabel; data.mCount = aCountValue; JS::Rooted value(aCx); if (!ToJSValue(aCx, data, &value)) { return JS::UndefinedValue(); } return value; } bool Console::ShouldIncludeStackTrace(MethodName aMethodName) const { switch (aMethodName) { case MethodError: case MethodException: case MethodAssert: case MethodTrace: return true; default: return false; } } JSObject* Console::GetOrCreateSandbox(JSContext* aCx, nsIPrincipal* aPrincipal) { AssertIsOnMainThread(); if (!mSandbox) { nsIXPConnect* xpc = nsContentUtils::XPConnect(); MOZ_ASSERT(xpc, "This should never be null!"); JS::Rooted sandbox(aCx); nsresult rv = xpc->CreateSandbox(aCx, aPrincipal, sandbox.address()); if (NS_WARN_IF(NS_FAILED(rv))) { return nullptr; } mSandbox = new JSObjectHolder(aCx, sandbox); } return mSandbox->GetJSObject(); } void Console::StoreCallData(ConsoleCallData* aCallData) { AssertIsOnOwningThread(); MOZ_ASSERT(aCallData); MOZ_ASSERT(!mCallDataStorage.Contains(aCallData)); MOZ_ASSERT(!mCallDataStoragePending.Contains(aCallData)); mCallDataStorage.AppendElement(aCallData); if (mCallDataStorage.Length() > STORAGE_MAX_EVENTS) { RefPtr callData = mCallDataStorage[0]; mCallDataStorage.RemoveElementAt(0); MOZ_ASSERT(callData->mStatus != ConsoleCallData::eToBeDeleted); // We cannot delete this object now because we have to trace its JSValues // until the pending operation (ConsoleCallDataWorkerRunnable or // ConsoleCallDataWorkletRunnable) is completed. if (callData->mStatus == ConsoleCallData::eInUse) { callData->mStatus = ConsoleCallData::eToBeDeleted; mCallDataStoragePending.AppendElement(callData); } } } void Console::UnstoreCallData(ConsoleCallData* aCallData) { AssertIsOnOwningThread(); MOZ_ASSERT(aCallData); MOZ_ASSERT(!mCallDataStoragePending.Contains(aCallData)); // It can be that mCallDataStorage has been already cleaned in case the // processing of the argument of some Console methods triggers the // window.close(). mCallDataStorage.RemoveElement(aCallData); } void Console::ReleaseCallData(ConsoleCallData* aCallData) { AssertIsOnOwningThread(); MOZ_ASSERT(aCallData); MOZ_ASSERT(aCallData->mStatus == ConsoleCallData::eToBeDeleted); MOZ_ASSERT(mCallDataStoragePending.Contains(aCallData)); mCallDataStoragePending.RemoveElement(aCallData); } void Console::NotifyHandler(JSContext* aCx, const Sequence& aArguments, ConsoleCallData* aCallData) { AssertIsOnOwningThread(); MOZ_ASSERT(!NS_IsMainThread()); MOZ_ASSERT(aCallData); if (!mConsoleEventNotifier) { return; } JS::Rooted value(aCx); JS::Rooted callable(aCx, mConsoleEventNotifier->CallableOrNull()); if (NS_WARN_IF(!callable)) { return; } // aCx and aArguments are in the same compartment because this method is // called directly when a Console.something() runs. // mConsoleEventNotifier->Callable() is the scope where value will be sent to. if (NS_WARN_IF(!PopulateConsoleNotificationInTheTargetScope(aCx, aArguments, callable, &value, aCallData))) { return; } JS::Rooted ignored(aCx); mConsoleEventNotifier->Call(value, &ignored); } void Console::RetrieveConsoleEvents(JSContext* aCx, nsTArray& aEvents, ErrorResult& aRv) { AssertIsOnOwningThread(); // We don't want to expose this functionality to main-thread yet. MOZ_ASSERT(!NS_IsMainThread()); JS::Rooted targetScope(aCx, JS::CurrentGlobalOrNull(aCx)); for (uint32_t i = 0; i < mCallDataStorage.Length(); ++i) { JS::Rooted value(aCx); JS::Rooted sequenceScope(aCx, mCallDataStorage[i]->mGlobal); JSAutoRealm ar(aCx, sequenceScope); Sequence sequence; SequenceRooter arguments(aCx, &sequence); if (!mCallDataStorage[i]->PopulateArgumentsSequence(sequence)) { aRv.Throw(NS_ERROR_OUT_OF_MEMORY); return; } // Here we have aCx and sequence in the same compartment. // targetScope is the destination scope and value will be populated in its // compartment. if (NS_WARN_IF(!PopulateConsoleNotificationInTheTargetScope(aCx, sequence, targetScope, &value, mCallDataStorage[i]))) { aRv.Throw(NS_ERROR_FAILURE); return; } aEvents.AppendElement(value); } } void Console::SetConsoleEventHandler(AnyCallback* aHandler) { AssertIsOnOwningThread(); // We don't want to expose this functionality to main-thread yet. MOZ_ASSERT(!NS_IsMainThread()); mConsoleEventNotifier = aHandler; } void Console::AssertIsOnOwningThread() const { NS_ASSERT_OWNINGTHREAD(Console); } bool Console::IsShuttingDown() const { MOZ_ASSERT(mStatus != eUnknown); return mStatus == eShuttingDown; } /* static */ already_AddRefed Console::GetConsole(const GlobalObject& aGlobal) { ErrorResult rv; RefPtr console = GetConsoleInternal(aGlobal, rv); if (NS_WARN_IF(rv.Failed()) || !console) { rv.SuppressException(); return nullptr; } console->AssertIsOnOwningThread(); if (console->IsShuttingDown()) { return nullptr; } return console.forget(); } /* static */ already_AddRefed Console::GetConsoleInternal(const GlobalObject& aGlobal, ErrorResult& aRv) { // Window if (NS_IsMainThread()) { nsCOMPtr innerWindow = do_QueryInterface(aGlobal.GetAsSupports()); // we are probably running a chrome script. if (!innerWindow) { RefPtr console = new Console(aGlobal.Context(), nullptr, 0, 0); console->Initialize(aRv); if (NS_WARN_IF(aRv.Failed())) { return nullptr; } return console.forget(); } nsGlobalWindowInner* window = nsGlobalWindowInner::Cast(innerWindow); return window->GetConsole(aGlobal.Context(), aRv); } // Worklet nsCOMPtr workletScope = do_QueryInterface(aGlobal.GetAsSupports()); if (workletScope) { WorkletThread::AssertIsOnWorkletThread(); return workletScope->GetConsole(aGlobal.Context(), aRv); } // Workers MOZ_ASSERT(!NS_IsMainThread()); JSContext* cx = aGlobal.Context(); WorkerPrivate* workerPrivate = GetWorkerPrivateFromContext(cx); MOZ_ASSERT(workerPrivate); nsCOMPtr global = do_QueryInterface(aGlobal.GetAsSupports()); if (NS_WARN_IF(!global)) { return nullptr; } WorkerGlobalScope* scope = workerPrivate->GlobalScope(); MOZ_ASSERT(scope); // Normal worker scope. if (scope == global) { return scope->GetConsole(aRv); } // Debugger worker scope else { WorkerDebuggerGlobalScope* debuggerScope = workerPrivate->DebuggerGlobalScope(); MOZ_ASSERT(debuggerScope); MOZ_ASSERT(debuggerScope == global, "Which kind of global do we have?"); return debuggerScope->GetConsole(aRv); } } bool Console::MonotonicTimer(JSContext* aCx, MethodName aMethodName, const Sequence& aData, DOMHighResTimeStamp* aTimeStamp) { if (mWindow) { nsGlobalWindowInner *win = nsGlobalWindowInner::Cast(mWindow); MOZ_ASSERT(win); RefPtr performance = win->GetPerformance(); if (!performance) { return false; } *aTimeStamp = performance->Now(); nsDocShell* docShell = static_cast(mWindow->GetDocShell()); RefPtr timelines = TimelineConsumers::Get(); bool isTimelineRecording = timelines && timelines->HasConsumer(docShell); // The 'timeStamp' recordings do not need an argument; use empty string // if no arguments passed in. if (isTimelineRecording && aMethodName == MethodTimeStamp) { JS::Rooted value(aCx, aData.Length() == 0 ? JS_GetEmptyStringValue(aCx) : aData[0]); JS::Rooted jsString(aCx, JS::ToString(aCx, value)); if (!jsString) { return false; } nsAutoJSString key; if (!key.init(aCx, jsString)) { return false; } timelines->AddMarkerForDocShell(docShell, Move( MakeUnique(key))); } // For `console.time(foo)` and `console.timeEnd(foo)`. else if (isTimelineRecording && aData.Length() == 1) { JS::Rooted value(aCx, aData[0]); JS::Rooted jsString(aCx, JS::ToString(aCx, value)); if (!jsString) { return false; } nsAutoJSString key; if (!key.init(aCx, jsString)) { return false; } timelines->AddMarkerForDocShell(docShell, Move( MakeUnique( key, aMethodName == MethodTime ? MarkerTracingType::START : MarkerTracingType::END))); } return true; } if (NS_IsMainThread()) { *aTimeStamp = (TimeStamp::Now() - mCreationTimeStamp).ToMilliseconds(); return true; } if (WorkletThread::IsOnWorkletThread()) { *aTimeStamp = WorkletThread::Get()->TimeStampToDOMHighRes(TimeStamp::Now()); return true; } WorkerPrivate* workerPrivate = GetCurrentThreadWorkerPrivate(); MOZ_ASSERT(workerPrivate); *aTimeStamp = workerPrivate->TimeStampToDOMHighRes(TimeStamp::Now()); return true; } /* static */ already_AddRefed Console::CreateInstance(const GlobalObject& aGlobal, const ConsoleInstanceOptions& aOptions) { RefPtr console = new ConsoleInstance(aGlobal.Context(), aOptions); return console.forget(); } void Console::MaybeExecuteDumpFunction(JSContext* aCx, const nsAString& aMethodName, const Sequence& aData, nsIStackFrame* aStack) { if (!mDumpFunction && !mDumpToStdout) { return; } nsAutoString message; message.AssignLiteral("console."); message.Append(aMethodName); message.AppendLiteral(": "); if (!mPrefix.IsEmpty()) { message.Append(mPrefix); message.AppendLiteral(": "); } for (uint32_t i = 0; i < aData.Length(); ++i) { JS::Rooted v(aCx, aData[i]); JS::Rooted jsString(aCx, JS_ValueToSource(aCx, v)); if (!jsString) { continue; } nsAutoJSString string; if (NS_WARN_IF(!string.init(aCx, jsString))) { return; } if (i != 0) { message.AppendLiteral(" "); } message.Append(string); } message.AppendLiteral("\n"); // aStack can be null. nsCOMPtr stack(aStack); while (stack) { nsAutoString filename; stack->GetFilename(aCx, filename); message.Append(filename); message.AppendLiteral(" "); message.AppendInt(stack->GetLineNumber(aCx)); message.AppendLiteral(" "); nsAutoString functionName; stack->GetName(aCx, functionName); message.Append(functionName); message.AppendLiteral("\n"); nsCOMPtr caller = stack->GetCaller(aCx); if (!caller) { caller = stack->GetAsyncCaller(aCx); } stack.swap(caller); } ExecuteDumpFunction(message); } void Console::MaybeExecuteDumpFunctionForTime(JSContext* aCx, MethodName aMethodName, const nsAString& aMethodString, uint64_t aMonotonicTimer, const JS::Value& aData) { if (!mDumpFunction && !mDumpToStdout) { return; } nsAutoString message; message.AssignLiteral("console."); message.Append(aMethodString); message.AppendLiteral(": "); if (!mPrefix.IsEmpty()) { message.Append(mPrefix); message.AppendLiteral(": "); } JS::Rooted v(aCx, aData); JS::Rooted jsString(aCx, JS_ValueToSource(aCx, v)); if (!jsString) { return; } nsAutoJSString string; if (NS_WARN_IF(!string.init(aCx, jsString))) { return; } message.Append(string); message.AppendLiteral(" @ "); message.AppendInt(aMonotonicTimer); message.AppendLiteral("\n"); ExecuteDumpFunction(message); } void Console::ExecuteDumpFunction(const nsAString& aMessage) { if (mDumpFunction) { mDumpFunction->Call(aMessage); return; } NS_ConvertUTF16toUTF8 str(aMessage); MOZ_LOG(nsContentUtils::DOMDumpLog(), LogLevel::Debug, ("%s", str.get())); #ifdef ANDROID __android_log_print(ANDROID_LOG_INFO, "Gecko", "%s", str.get()); #endif fputs(str.get(), stdout); fflush(stdout); } bool Console::ShouldProceed(MethodName aName) const { return WebIDLLogLevelToInteger(mMaxLogLevel) <= InternalLogLevelToInteger(aName); } uint32_t Console::WebIDLLogLevelToInteger(ConsoleLogLevel aLevel) const { switch (aLevel) { case ConsoleLogLevel::All: return 0; case ConsoleLogLevel::Debug: return 2; case ConsoleLogLevel::Log: return 3; case ConsoleLogLevel::Info: return 3; case ConsoleLogLevel::Clear: return 3; case ConsoleLogLevel::Trace: return 3; case ConsoleLogLevel::TimeLog: return 3; case ConsoleLogLevel::TimeEnd: return 3; case ConsoleLogLevel::Time: return 3; case ConsoleLogLevel::Group: return 3; case ConsoleLogLevel::GroupEnd: return 3; case ConsoleLogLevel::Profile: return 3; case ConsoleLogLevel::ProfileEnd: return 3; case ConsoleLogLevel::Dir: return 3; case ConsoleLogLevel::Dirxml: return 3; case ConsoleLogLevel::Warn: return 4; case ConsoleLogLevel::Error: return 5; case ConsoleLogLevel::Off: return UINT32_MAX; default: MOZ_CRASH("ConsoleLogLevel is out of sync with the Console implementation!"); return 0; } return 0; } uint32_t Console::InternalLogLevelToInteger(MethodName aName) const { switch (aName) { case MethodLog: return 3; case MethodInfo: return 3; case MethodWarn: return 4; case MethodError: return 5; case MethodException: return 5; case MethodDebug: return 2; case MethodTable: return 3; case MethodTrace: return 3; case MethodDir: return 3; case MethodDirxml: return 3; case MethodGroup: return 3; case MethodGroupCollapsed: return 3; case MethodGroupEnd: return 3; case MethodTime: return 3; case MethodTimeLog: return 3; case MethodTimeEnd: return 3; case MethodTimeStamp: return 3; case MethodAssert: return 3; case MethodCount: return 3; case MethodClear: return 3; case MethodProfile: return 3; case MethodProfileEnd: return 3; default: MOZ_CRASH("MethodName is out of sync with the Console implementation!"); return 0; } return 0; } } // namespace dom } // namespace mozilla