gecko-dev/xpcom/system/nsIXULRuntime.idl
Andrew McCreight 46622f995f Bug 1561653 - Drop URIs from remote types we use in telemetry. r=nika
With Fission enabled, remote types can have the form
webIsolated=<URI>. This is bad, because we store them in telemetry in
some places. This patch adds and uses a method that sanitizes remote
types.

Differential Revision: https://phabricator.services.mozilla.com/D36068

--HG--
extra : moz-landing-system : lando
2019-06-28 14:30:18 +00:00

215 lines
6.5 KiB
Plaintext

/* 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 "nsISupports.idl"
%{C++
namespace mozilla {
// Simple C++ getter for nsIXULRuntime::browserTabsRemoteAutostart
// This getter is a temporary function that checks for special
// conditions in which e10s support is not great yet, and should
// therefore be disabled. Bug 1065561 tracks its removal.
bool BrowserTabsRemoteAutostart();
uint32_t GetMaxWebProcessCount();
}
%}
/**
* Provides information about the XUL runtime.
* @status UNSTABLE - This interface is not frozen and will probably change in
* future releases. If you need this functionality to be
* stable/frozen, please contact Benjamin Smedberg.
*/
[scriptable, uuid(03602fac-fa3f-4a50-9baa-b88456fb4a0f)]
interface nsIXULRuntime : nsISupports
{
/**
* Whether the application was launched in safe mode.
*/
readonly attribute boolean inSafeMode;
/**
* Whether to write console errors to a log file. If a component
* encounters startup errors that might prevent the app from showing
* proper UI, it should set this flag to "true".
*/
attribute boolean logConsoleErrors;
/**
* A string tag identifying the current operating system. This is taken
* from the OS_TARGET configure variable. It will always be available.
*/
readonly attribute AUTF8String OS;
/**
* A string tag identifying the binary ABI of the current processor and
* compiler vtable. This is taken from the TARGET_XPCOM_ABI configure
* variable. It may not be available on all platforms, especially
* unusual processor or compiler combinations.
*
* The result takes the form <processor>-<compilerABI>, for example:
* x86-msvc
* ppc-gcc3
*
* This value should almost always be used in combination with "OS".
*
* @throw NS_ERROR_NOT_AVAILABLE if not available.
*/
readonly attribute AUTF8String XPCOMABI;
/**
* A string tag identifying the target widget toolkit in use.
* This is taken from the MOZ_WIDGET_TOOLKIT configure variable.
*/
readonly attribute AUTF8String widgetToolkit;
/**
* The legal values of processType.
*/
const unsigned long PROCESS_TYPE_DEFAULT = 0;
const unsigned long PROCESS_TYPE_PLUGIN = 1;
const unsigned long PROCESS_TYPE_CONTENT = 2;
const unsigned long PROCESS_TYPE_IPDLUNITTEST = 3;
const unsigned long PROCESS_TYPE_GMPLUGIN = 4;
const unsigned long PROCESS_TYPE_GPU = 5;
const unsigned long PROCESS_TYPE_VR = 6;
const unsigned long PROCESS_TYPE_RDD = 7;
const unsigned long PROCESS_TYPE_SOCKET = 8;
const unsigned long PROCESS_TYPE_SANDBOX_BROKER = 9;
/**
* The type of the caller's process. Returns one of the values above.
*/
readonly attribute unsigned long processType;
/**
* The system process ID of the caller's process.
*/
readonly attribute unsigned long processID;
/**
* A globally unique and non-recycled ID of the caller's process.
*/
readonly attribute uint64_t uniqueProcessID;
/**
* The type of remote content process we're running in.
* null if we're in the parent/chrome process. This can contain
* a URI if Fission is enabled, so don't use it for any kind of
* telemetry.
*/
readonly attribute AString remoteType;
/**
* If true, browser tabs may be opened by default in a different process
* from the main browser UI.
*/
readonly attribute boolean browserTabsRemoteAutostart;
/**
* Returns the number of content processes to use for normal web pages. If
* this value is > 1, then e10s-multi should be considered to be "on".
*
* NB: If browserTabsRemoteAutostart is false, then this value has no
* meaning and e10s should be considered to be "off"!
*/
readonly attribute uint32_t maxWebProcessCount;
/**
* The current e10s-multi experiment number. Set dom.ipc.multiOptOut to (at
* least) this to disable it until the next experiment.
*/
const uint32_t E10S_MULTI_EXPERIMENT = 1;
/**
* If true, the accessibility service is running.
*/
readonly attribute boolean accessibilityEnabled;
/**
* If true, the AccessibleHandler dll is used.
*/
readonly attribute boolean accessibleHandlerUsed;
/**
* Executable of Windows service that activated accessibility.
*/
readonly attribute AString accessibilityInstantiator;
/**
* Temporary, do not use. Indicates if an incompat version of JAWS
* screen reader software is loaded in our process space.
*/
readonly attribute boolean shouldBlockIncompatJaws;
/**
* Indicates whether the current Firefox build is 64-bit.
*/
readonly attribute boolean is64Bit;
/**
* Signal the apprunner to invalidate caches on the next restart.
* This will cause components to be autoregistered and all
* fastload data to be re-created.
*/
void invalidateCachesOnRestart();
/**
* Starts a child process. This method is intented to pre-start a
* content child process so that when it is actually needed, it is
* ready to go.
*
* @throw NS_ERROR_NOT_AVAILABLE if not available.
*/
void ensureContentProcess();
/**
* Modification time of the profile lock before the profile was locked on
* this startup. Used to know the last time the profile was used and not
* closed cleanly. This is set to 0 if there was no existing profile lock.
*/
readonly attribute PRTime replacedLockTime;
/**
* True if this is RELEASE_OR_BETA.
*/
readonly attribute boolean isReleaseOrBeta;
/**
* True if this build uses official branding (MOZ_OFFICIAL_BRANDING).
*/
readonly attribute boolean isOfficialBranding;
/**
* The default update channel (MOZ_UPDATE_CHANNEL).
*/
readonly attribute AUTF8String defaultUpdateChannel;
/**
* The distribution ID for this build (MOZ_DISTRIBUTION_ID).
*/
readonly attribute AUTF8String distributionID;
/**
* True if Windows DLL blocklist initialized correctly. This is
* primarily for automated testing purposes.
*/
readonly attribute boolean windowsDLLBlocklistStatus;
/**
* True if this application was started by the OS as part of an automatic
* restart mechanism (such as RegisterApplicationRestart on Windows).
*/
readonly attribute boolean restartedByOS;
/**
* Returns a value corresponding to one of the
* |mozilla::LauncherRegistryInfo::EnabledState| values.
*/
readonly attribute uint32_t launcherProcessState;
};