base/base_switches.cc - chromium/src - Git at Google

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.

 #include "base/base_switches.h"
 #include "build/build_config.h"
 #include "build/chromeos_buildflags.h"

 namespace switches {

 // Delays execution of TaskPriority::BEST_EFFORT tasks until shutdown.
 const char kDisableBestEffortTasks[] = "disable-best-effort-tasks";

 // Disables the crash reporting.
 const char kDisableBreakpad[]               = "disable-breakpad";

 // Comma-separated list of feature names to disable. See also kEnableFeatures.
 const char kDisableFeatures[] = "disable-features";

 // Force disabling of low-end device mode when set.
 const char kDisableLowEndDeviceMode[] = "disable-low-end-device-mode";

 // Indicates that crash reporting should be enabled. On platforms where helper
 // processes cannot access to files needed to make this decision, this flag is
 // generated internally.
 const char kEnableCrashReporter[]           = "enable-crash-reporter";

 // Comma-separated list of feature names to enable. See also kDisableFeatures.
 const char kEnableFeatures[] = "enable-features";

 // Force low-end device mode when set.
 const char kEnableLowEndDeviceMode[]        = "enable-low-end-device-mode";

 // Enable the use of background thread priorities for background tasks in the
 // ThreadPool even on systems where it is disabled by default, e.g. due to
 // concerns about priority inversions.
 const char kEnableBackgroundThreadPool[] = "enable-background-thread-pool";

 // This option can be used to force field trials when testing changes locally.
 // The argument is a list of name and value pairs, separated by slashes. If a
 // trial name is prefixed with an asterisk, that trial will start activated.
 // For example, the following argument defines two trials, with the second one
 // activated: "GoogleNow/Enable/*MaterialDesignNTP/Default/" This option can
 // also be used by the browser process to send the list of trials to a
 // non-browser process, using the same format. See
 // FieldTrialList::CreateTrialsFromString() in field_trial.h for details.
 const char kForceFieldTrials[]              = "force-fieldtrials";

 // Generates full memory crash dump.
 const char kFullMemoryCrashReport[] = "full-memory-crash-report";

 // Logs information about all tasks posted with TaskPriority::BEST_EFFORT. Use
 // this to diagnose issues that are thought to be caused by
 // TaskPriority::BEST_EFFORT execution fences. Note: Tasks posted to a
 // non-BEST_EFFORT UpdateableSequencedTaskRunner whose priority is later lowered
 // to BEST_EFFORT are not logged.
 const char kLogBestEffortTasks[] = "log-best-effort-tasks";

 // Suppresses all error dialogs when present.
 const char kNoErrorDialogs[]                = "noerrdialogs";

 // Starts the sampling based profiler for the browser process at startup. This
 // will only work if chrome has been built with the gn arg enable_profiling =
 // true. The output will go to the value of kProfilingFile.
 const char kProfilingAtStart[] = "profiling-at-start";

 // Specifies a location for profiling output. This will only work if chrome has
 // been built with the gyp variable profiling=1 or gn arg enable_profiling=true.
 //
 //   {pid} if present will be replaced by the pid of the process.
 //   {count} if present will be incremented each time a profile is generated
 //           for this process.
 // The default is chrome-profile-{pid} for the browser and test-profile-{pid}
 // for tests.
 const char kProfilingFile[] = "profiling-file";

 // Controls whether profile data is periodically flushed to a file. Normally
 // the data gets written on exit but cases exist where chromium doesn't exit
 // cleanly (especially when using single-process). A time in seconds can be
 // specified.
 const char kProfilingFlush[] = "profiling-flush";

 // When running certain tests that spawn child processes, this switch indicates
 // to the test framework that the current process is a child process.
 const char kTestChildProcess[] = "test-child-process";

 // When running certain tests that spawn child processes, this switch indicates
 // to the test framework that the current process should not initialize ICU to
 // avoid creating any scoped handles too early in startup.
 const char kTestDoNotInitializeIcu[] = "test-do-not-initialize-icu";

 // Sends trace events from these categories to a file.
 // --trace-to-file on its own sends to default categories.
 const char kTraceToFile[] = "trace-to-file";

 // Specifies the file name for --trace-to-file. If unspecified, it will
 // go to a default file name.
 const char kTraceToFileName[] = "trace-to-file-name";

 // Gives the default maximal active V-logging level; 0 is the default.
 // Normally positive values are used for V-logging levels.
 const char kV[] = "v";

 // Gives the per-module maximal V-logging levels to override the value
 // given by --v.  E.g. "my_module=2,foo*=3" would change the logging
 // level for all code in source files "my_module.*" and "foo*.*"
 // ("-inl" suffixes are also disregarded for this matching).
 //
 // Any pattern containing a forward or backward slash will be tested
 // against the whole pathname and not just the module.  E.g.,
 // "*/foo/bar/*=2" would change the logging level for all code in
 // source files under a "foo/bar" directory.
 const char kVModule[] = "vmodule";

 // Will wait for 60 seconds for a debugger to come to attach to the process.
 const char kWaitForDebugger[] = "wait-for-debugger";

 #if defined(OS_WIN)
 // Disable high-resolution timer on Windows.
 const char kDisableHighResTimer[] = "disable-highres-timer";

 // Disables the USB keyboard detection for blocking the OSK on Win8+.
 const char kDisableUsbKeyboardDetect[]      = "disable-usb-keyboard-detect";
 #endif

 // TODO(crbug.com/1052397): Revisit the macro expression once build flag switch
 // of lacros-chrome is complete.
 #if defined(OS_LINUX) && !BUILDFLAG(IS_CHROMEOS_ASH) && \
     !BUILDFLAG(IS_CHROMEOS_LACROS)
 // The /dev/shm partition is too small in certain VM environments, causing
 // Chrome to fail or crash (see http://crbug.com/715363). Use this flag to
 // work-around this issue (a temporary directory will always be used to create
 // anonymous shared memory files).
 const char kDisableDevShmUsage[] = "disable-dev-shm-usage";
 #endif

 #if defined(OS_POSIX)
 // Used for turning on Breakpad crash reporting in a debug environment where
 // crash reporting is typically compiled but disabled.
 const char kEnableCrashReporterForTesting[] =
     "enable-crash-reporter-for-testing";
 #endif

 #if defined(OS_ANDROID)
 // Enables the reached code profiler that samples all threads in all processes
 // to determine which functions are almost never executed.
 const char kEnableReachedCodeProfiler[] = "enable-reached-code-profiler";

 // Specifies the profiling interval in microseconds for reached code profiler.
 const char kReachedCodeSamplingIntervalUs[] =
     "reached-code-sampling-interval-us";

 // Default country code to be used for search engine localization.
 const char kDefaultCountryCodeAtInstall[] = "default-country-code";

 // Adds additional thread idle time information into the trace event output.
 const char kEnableIdleTracing[] = "enable-idle-tracing";

 // The field trial parameters and their values when testing changes locally.
 const char kForceFieldTrialParams[] = "force-fieldtrial-params";

 #endif

 #if defined(OS_LINUX) || defined(OS_CHROMEOS)
 // Controls whether or not retired instruction counts are surfaced for threads
 // in trace events on Linux.
 //
 // This flag requires the BPF sandbox to be disabled.
 const char kEnableThreadInstructionCount[] = "enable-thread-instruction-count";

 // TODO(crbug.com/1176772): Remove kEnableCrashpad and IsCrashpadEnabled() when
 // Crashpad is fully enabled on Linux. Indicates that Crashpad should be
 // enabled.
 extern const char kEnableCrashpad[] = "enable-crashpad";
 #endif

 #if BUILDFLAG(IS_CHROMEOS_ASH) || BUILDFLAG(IS_CHROMEOS_LACROS)
 // Override the default scheduling boosting value for urgent tasks.
 // This can be adjusted if a specific chromeos device shows better perf/power
 // ratio (e.g. by running video conference tests).
 // Currently, this values directs to linux scheduler's utilization min clamp.
 // Range is 0(no biased load) ~ 100(mamximum load value).
 const char kSchedulerBoostUrgent[] = "scheduler-boost-urgent";
 #endif

 }  // namespace switches
	// Copyright (c) 2012 The Chromium Authors. All rights reserved.
	// Use of this source code is governed by a BSD-style license that can be
	// found in the LICENSE file.

	#include "base/base_switches.h"
	#include "build/build_config.h"
	#include "build/chromeos_buildflags.h"

	namespace switches {

	// Delays execution of TaskPriority::BEST_EFFORT tasks until shutdown.
	const char kDisableBestEffortTasks[] = "disable-best-effort-tasks";

	// Disables the crash reporting.
	const char kDisableBreakpad[] = "disable-breakpad";

	// Comma-separated list of feature names to disable. See also kEnableFeatures.
	const char kDisableFeatures[] = "disable-features";

	// Force disabling of low-end device mode when set.
	const char kDisableLowEndDeviceMode[] = "disable-low-end-device-mode";

	// Indicates that crash reporting should be enabled. On platforms where helper
	// processes cannot access to files needed to make this decision, this flag is
	// generated internally.
	const char kEnableCrashReporter[] = "enable-crash-reporter";

	// Comma-separated list of feature names to enable. See also kDisableFeatures.
	const char kEnableFeatures[] = "enable-features";

	// Force low-end device mode when set.
	const char kEnableLowEndDeviceMode[] = "enable-low-end-device-mode";

	// Enable the use of background thread priorities for background tasks in the
	// ThreadPool even on systems where it is disabled by default, e.g. due to
	// concerns about priority inversions.
	const char kEnableBackgroundThreadPool[] = "enable-background-thread-pool";

	// This option can be used to force field trials when testing changes locally.
	// The argument is a list of name and value pairs, separated by slashes. If a
	// trial name is prefixed with an asterisk, that trial will start activated.
	// For example, the following argument defines two trials, with the second one
	// activated: "GoogleNow/Enable/*MaterialDesignNTP/Default/" This option can
	// also be used by the browser process to send the list of trials to a
	// non-browser process, using the same format. See
	// FieldTrialList::CreateTrialsFromString() in field_trial.h for details.
	const char kForceFieldTrials[] = "force-fieldtrials";

	// Generates full memory crash dump.
	const char kFullMemoryCrashReport[] = "full-memory-crash-report";

	// Logs information about all tasks posted with TaskPriority::BEST_EFFORT. Use
	// this to diagnose issues that are thought to be caused by
	// TaskPriority::BEST_EFFORT execution fences. Note: Tasks posted to a
	// non-BEST_EFFORT UpdateableSequencedTaskRunner whose priority is later lowered
	// to BEST_EFFORT are not logged.
	const char kLogBestEffortTasks[] = "log-best-effort-tasks";

	// Suppresses all error dialogs when present.
	const char kNoErrorDialogs[] = "noerrdialogs";

	// Starts the sampling based profiler for the browser process at startup. This
	// will only work if chrome has been built with the gn arg enable_profiling =
	// true. The output will go to the value of kProfilingFile.
	const char kProfilingAtStart[] = "profiling-at-start";

	// Specifies a location for profiling output. This will only work if chrome has
	// been built with the gyp variable profiling=1 or gn arg enable_profiling=true.
	//
	// {pid} if present will be replaced by the pid of the process.
	// {count} if present will be incremented each time a profile is generated
	// for this process.
	// The default is chrome-profile-{pid} for the browser and test-profile-{pid}
	// for tests.
	const char kProfilingFile[] = "profiling-file";

	// Controls whether profile data is periodically flushed to a file. Normally
	// the data gets written on exit but cases exist where chromium doesn't exit
	// cleanly (especially when using single-process). A time in seconds can be
	// specified.
	const char kProfilingFlush[] = "profiling-flush";

	// When running certain tests that spawn child processes, this switch indicates
	// to the test framework that the current process is a child process.
	const char kTestChildProcess[] = "test-child-process";

	// When running certain tests that spawn child processes, this switch indicates
	// to the test framework that the current process should not initialize ICU to
	// avoid creating any scoped handles too early in startup.
	const char kTestDoNotInitializeIcu[] = "test-do-not-initialize-icu";

	// Sends trace events from these categories to a file.
	// --trace-to-file on its own sends to default categories.
	const char kTraceToFile[] = "trace-to-file";

	// Specifies the file name for --trace-to-file. If unspecified, it will
	// go to a default file name.
	const char kTraceToFileName[] = "trace-to-file-name";

	// Gives the default maximal active V-logging level; 0 is the default.
	// Normally positive values are used for V-logging levels.
	const char kV[] = "v";

	// Gives the per-module maximal V-logging levels to override the value
	// given by --v. E.g. "my_module=2,foo*=3" would change the logging
	// level for all code in source files "my_module." and "foo.*"
	// ("-inl" suffixes are also disregarded for this matching).
	//
	// Any pattern containing a forward or backward slash will be tested
	// against the whole pathname and not just the module. E.g.,
	// "/foo/bar/=2" would change the logging level for all code in
	// source files under a "foo/bar" directory.
	const char kVModule[] = "vmodule";

	// Will wait for 60 seconds for a debugger to come to attach to the process.
	const char kWaitForDebugger[] = "wait-for-debugger";

	#if defined(OS_WIN)
	// Disable high-resolution timer on Windows.
	const char kDisableHighResTimer[] = "disable-highres-timer";

	// Disables the USB keyboard detection for blocking the OSK on Win8+.
	const char kDisableUsbKeyboardDetect[] = "disable-usb-keyboard-detect";
	#endif

	// TODO(crbug.com/1052397): Revisit the macro expression once build flag switch
	// of lacros-chrome is complete.
	#if defined(OS_LINUX) && !BUILDFLAG(IS_CHROMEOS_ASH) && \
	!BUILDFLAG(IS_CHROMEOS_LACROS)
	// The /dev/shm partition is too small in certain VM environments, causing
	// Chrome to fail or crash (see http://crbug.com/715363). Use this flag to
	// work-around this issue (a temporary directory will always be used to create
	// anonymous shared memory files).
	const char kDisableDevShmUsage[] = "disable-dev-shm-usage";
	#endif

	#if defined(OS_POSIX)
	// Used for turning on Breakpad crash reporting in a debug environment where
	// crash reporting is typically compiled but disabled.
	const char kEnableCrashReporterForTesting[] =
	"enable-crash-reporter-for-testing";
	#endif

	#if defined(OS_ANDROID)
	// Enables the reached code profiler that samples all threads in all processes
	// to determine which functions are almost never executed.
	const char kEnableReachedCodeProfiler[] = "enable-reached-code-profiler";

	// Specifies the profiling interval in microseconds for reached code profiler.
	const char kReachedCodeSamplingIntervalUs[] =
	"reached-code-sampling-interval-us";

	// Default country code to be used for search engine localization.
	const char kDefaultCountryCodeAtInstall[] = "default-country-code";

	// Adds additional thread idle time information into the trace event output.
	const char kEnableIdleTracing[] = "enable-idle-tracing";

	// The field trial parameters and their values when testing changes locally.
	const char kForceFieldTrialParams[] = "force-fieldtrial-params";

	#endif

	#if defined(OS_LINUX) \|\| defined(OS_CHROMEOS)
	// Controls whether or not retired instruction counts are surfaced for threads
	// in trace events on Linux.
	//
	// This flag requires the BPF sandbox to be disabled.
	const char kEnableThreadInstructionCount[] = "enable-thread-instruction-count";

	// TODO(crbug.com/1176772): Remove kEnableCrashpad and IsCrashpadEnabled() when
	// Crashpad is fully enabled on Linux. Indicates that Crashpad should be
	// enabled.
	extern const char kEnableCrashpad[] = "enable-crashpad";
	#endif

	#if BUILDFLAG(IS_CHROMEOS_ASH) \|\| BUILDFLAG(IS_CHROMEOS_LACROS)
	// Override the default scheduling boosting value for urgent tasks.
	// This can be adjusted if a specific chromeos device shows better perf/power
	// ratio (e.g. by running video conference tests).
	// Currently, this values directs to linux scheduler's utilization min clamp.
	// Range is 0(no biased load) ~ 100(mamximum load value).
	const char kSchedulerBoostUrgent[] = "scheduler-boost-urgent";
	#endif

	} // namespace switches