Skip to content
Permalink
HHVM-4.68
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
/*
+----------------------------------------------------------------------+
| HipHop for PHP |
+----------------------------------------------------------------------+
| Copyright (c) 2010-present Facebook, Inc. (http://www.facebook.com) |
+----------------------------------------------------------------------+
| This source file is subject to version 3.01 of the PHP license, |
| that is bundled with this package in the file LICENSE, and is |
| available through the world-wide-web at the following url: |
| http://www.php.net/license/3_01.txt |
| If you did not receive a copy of the PHP license and are unable to |
| obtain it through the world-wide-web, please send a note to |
| license@php.net so we can mail you a copy immediately. |
+----------------------------------------------------------------------+
*/
#ifndef incl_HPHP_RUNTIME_OPTION_H_
#define incl_HPHP_RUNTIME_OPTION_H_
#include <folly/dynamic.h>
#include <folly/experimental/io/FsUtil.h>
#include <unordered_map>
#include <algorithm>
#include <vector>
#include <string>
#include <map>
#include <set>
#include <boost/container/flat_set.hpp>
#include <memory>
#include <sys/stat.h>
#include "hphp/runtime/base/config.h"
#include "hphp/runtime/base/typed-value.h"
#include "hphp/util/compilation-flags.h"
#include "hphp/util/hash-map.h"
#include "hphp/util/functional.h"
namespace HPHP {
///////////////////////////////////////////////////////////////////////////////
struct AccessLogFileData;
struct ErrorLogFileData;
struct VirtualHost;
struct IpBlockMap;
struct SatelliteServerInfo;
struct FilesMatch;
struct Hdf;
struct IniSettingMap;
constexpr int kDefaultInitialStaticStringTableSize = 500000;
enum class JitSerdesMode {
// NB: if changing the encoding here, make sure to update isJitSerializing()
// and isJitDeserializing() as needed.
//
// Bit 0: serialize
// Bit 1: deserialize
Off = 0x0,
Serialize = 0x1, // 00001
SerializeAndExit = 0x5, // 00101
Deserialize = 0x2, // 00010
DeserializeOrFail = 0x6, // 00110
DeserializeOrGenerate = 0xa, // 01010
DeserializeAndDelete = 0xe, // 01110
DeserializeAndExit = 0x12, // 10010
};
struct RepoOptions {
RepoOptions(const RepoOptions&) = default;
RepoOptions(RepoOptions&&) = default;
using StringMap = std::map<std::string, std::string>;
// (Type, HDFName, DV)
// (N=no-prefix, P=PHP7, E=Eval, H=Hack.Lang)
#define PARSERFLAGS() \
N(StringMap, AliasedNamespaces, StringMap{}) \
P(bool, UVS, s_PHP7_master) \
P(bool, LTRAssign, s_PHP7_master) \
H(bool, EnableCoroutines, true) \
H(bool, Hacksperimental, false) \
H(bool, DisableLvalAsAnExpression, false) \
H(bool, AllowNewAttributeSyntax, false) \
H(bool, ConstDefaultFuncArgs, false) \
H(bool, ConstStaticProps, false) \
H(bool, AbstractStaticProps, false) \
H(bool, DisableUnsetClassConst, false) \
H(bool, DisallowFuncPtrsInConstants, false) \
E(bool, EmitFuncPointers, true) \
E(bool, EmitInstMethPointers, EmitFuncPointers) \
H(bool, EnableXHPClassModifier, false) \
H(bool, DisableXHPElementMangling, false) \
H(bool, DisableArray, true) \
H(bool, DisableArrayCast, true) \
H(bool, DisableArrayTypehint, true) \
/**/
/**/
#define AUTOLOADFLAGS() \
N(std::string, Query, "") \
N(std::string, TrustedDBPath, "") \
/**/
std::string path() const { return m_path; }
std::string cacheKeyRaw() const;
std::string cacheKeySha1() const;
std::string toJSON() const;
folly::dynamic toDynamic() const;
struct stat stat() const { return m_stat; }
std::string autoloadQuery() const noexcept { return Query; }
std::string trustedDBPath() const noexcept { return TrustedDBPath; }
bool operator==(const RepoOptions& o) const;
static const RepoOptions& defaults();
static void setDefaults(const Hdf& hdf, const IniSettingMap& ini);
static const RepoOptions& forFile(const char* path);
private:
RepoOptions() = default;
explicit RepoOptions(const char* file);
void filterNamespaces();
void initDefaults(const Hdf& hdf, const IniSettingMap& ini);
#define N(t, n, ...) t n;
#define P(t, n, ...) t n;
#define H(t, n, ...) t n;
#define E(t, n, ...) t n;
PARSERFLAGS()
AUTOLOADFLAGS()
#undef N
#undef P
#undef H
#undef E
std::string m_path;
struct stat m_stat;
static bool s_init;
static RepoOptions s_defaults;
};
/**
* Configurable options set from command line or configurable file at startup
* time.
*/
struct RuntimeOption {
static void Load(
IniSettingMap &ini, Hdf& config,
const std::vector<std::string>& iniClis = std::vector<std::string>(),
const std::vector<std::string>& hdfClis = std::vector<std::string>(),
std::vector<std::string>* messages = nullptr,
std::string cmd = "");
static bool ServerExecutionMode() {
return ServerMode;
}
static bool GcSamplingEnabled() {
return EvalGCSampleRate > 0;
}
static bool JitSamplingEnabled() {
return EvalJit && EvalJitSampleRate > 0;
}
static void ReadSatelliteInfo(
const IniSettingMap& ini,
const Hdf& hdf,
std::vector<std::shared_ptr<SatelliteServerInfo>>& infos,
std::string& xboxPassword,
std::set<std::string>& xboxPasswords
);
static folly::Optional<folly::fs::path> GetHomePath(
const folly::StringPiece user);
static std::string GetDefaultUser();
/**
* Find a config file corresponding to the given user and parse its
* settings into the given ini and hdf objects.
*
* Return true on success and false on failure.
*/
static bool ReadPerUserSettings(const folly::fs::path& confFileName,
IniSettingMap& ini, Hdf& config);
static std::string getTraceOutputFile();
static bool ServerMode;
static std::string BuildId;
static std::string InstanceId;
static std::string DeploymentId; // ID for set of instances deployed at once
static int64_t ConfigId; // Queryable to verify a specific config was read
static std::string PidFile;
static std::map<std::string, ErrorLogFileData> ErrorLogs;
static std::string LogFile;
static std::string LogFileSymLink;
static uint16_t LogFilePeriodMultiplier;
static int LogHeaderMangle;
static bool AlwaysEscapeLog;
static bool AlwaysLogUnhandledExceptions;
static bool NoSilencer;
static int ErrorUpgradeLevel; // Bitmask of errors to upgrade to E_USER_ERROR
static bool CallUserHandlerOnFatals;
static bool ThrowExceptionOnBadMethodCall;
static bool LogNativeStackOnOOM;
static int RuntimeErrorReportingLevel;
static int ForceErrorReportingLevel; // Bitmask ORed with the reporting level
static std::string ServerUser; // run server under this user account
static bool AllowRunAsRoot; // Allow running hhvm as root.
static int MaxSerializedStringSize;
static bool NoInfiniteRecursionDetection;
static bool AssertEmitted;
static int64_t NoticeFrequency; // output 1 out of NoticeFrequency notices
static int64_t WarningFrequency;
static int RaiseDebuggingFrequency;
static int64_t SerializationSizeLimit;
static std::string AccessLogDefaultFormat;
static std::map<std::string, AccessLogFileData> AccessLogs;
static std::string AdminLogFormat;
static std::string AdminLogFile;
static std::string AdminLogSymLink;
static std::map<std::string, AccessLogFileData> RPCLogs;
static std::string Host;
static std::string DefaultServerNameSuffix;
static std::string ServerType;
static std::string ServerIP;
static std::string ServerFileSocket;
static const std::string& GetServerPrimaryIPv4();
static const std::string& GetServerPrimaryIPv6();
static int ServerPort;
static int ServerPortFd;
static int ServerBacklog;
static int ServerConnectionLimit;
static int ServerThreadCount;
static int ServerQueueCount;
static int ServerIOThreadCount;
static int ServerHighQueueingThreshold;
static bool ServerLegacyBehavior;
// Number of worker threads with stack partially on huge pages.
static int ServerHugeThreadCount;
static int ServerHugeStackKb;
static uint32_t ServerLoopSampleRate;
static int ServerWarmupThrottleRequestCount;
static int ServerWarmupThrottleThreadCount;
static int ServerThreadDropCacheTimeoutSeconds;
static int ServerThreadJobLIFOSwitchThreshold;
static int ServerThreadJobMaxQueuingMilliSeconds;
static bool AlwaysDecodePostDataDefault;
static bool ServerThreadDropStack;
static bool ServerHttpSafeMode;
static bool ServerStatCache;
static bool ServerFixPathInfo;
static bool ServerAddVaryEncoding;
static bool ServerLogSettingsOnStartup;
static bool ServerLogReorderProps;
static bool ServerForkEnabled;
static bool ServerForkLogging;
static bool ServerWarmupConcurrently;
static bool ServerDedupeWarmupRequests;
static int ServerWarmupThreadCount;
static int ServerExtendedWarmupThreadCount;
static unsigned ServerExtendedWarmupRepeat;
static unsigned ServerExtendedWarmupDelaySeconds;
static std::vector<std::string> ServerWarmupRequests;
static std::vector<std::string> ServerExtendedWarmupRequests;
static std::string ServerCleanupRequest;
static int ServerInternalWarmupThreads;
static boost::container::flat_set<std::string> ServerHighPriorityEndPoints;
static bool ServerExitOnBindFail;
static int PageletServerThreadCount;
static int PageletServerHugeThreadCount;
static int PageletServerThreadDropCacheTimeoutSeconds;
static int PageletServerQueueLimit;
static bool PageletServerThreadDropStack;
static int RequestTimeoutSeconds;
static int PspTimeoutSeconds;
static int PspCpuTimeoutSeconds;
static int64_t MaxRequestAgeFactor;
static int64_t RequestMemoryMaxBytes;
// Approximate upper bound for thread heap that is backed by huge pages. This
// doesn't include the first slab colocated with thread stack, if any.
static int64_t RequestHugeMaxBytes;
static int64_t ImageMemoryMaxBytes;
static int ServerGracefulShutdownWait;
static bool ServerHarshShutdown;
static bool ServerEvilShutdown;
static bool ServerKillOnTimeout;
static bool Server503OnShutdownAbort;
static int ServerPreShutdownWait;
static int ServerShutdownListenWait;
static int ServerShutdownEOMWait;
static int ServerPrepareToStopTimeout;
static int ServerPartialPostStatusCode;
// If `StopOldServer` is set, we try to stop the old server running
// on the local host earlier when we initialize, and we do not start
// serving requests until we are confident that the system can give
// the new server `ServerRSSNeededMb` resident memory, or till
// `OldServerWait` seconds passes after an effort to stop the old
// server is made.
static bool StopOldServer;
static int64_t ServerRSSNeededMb;
// Threshold of free memory below which the old server is shutdown immediately
// upon a memory pressure check.
static int64_t ServerCriticalFreeMb;
static int OldServerWait;
// The percentage of page caches that can be considered as free (0 -
// 100). This is experimental.
static int CacheFreeFactor;
static std::vector<std::string> ServerNextProtocols;
static bool ServerEnableH2C;
static int BrotliCompressionEnabled;
static int BrotliChunkedCompressionEnabled;
static int BrotliCompressionMode;
// Base 2 logarithm of the sliding window size. Range is 10-24.
static int BrotliCompressionLgWindowSize;
static int BrotliCompressionQuality;
static int ZstdCompressionEnabled;
static int ZstdCompressionLevel;
static int ZstdChecksumRate;
static int GzipCompressionLevel;
static int GzipMaxCompressionLevel;
static bool EnableKeepAlive;
static bool ExposeHPHP;
static bool ExposeXFBServer;
static bool ExposeXFBDebug;
static std::string XFBDebugSSLKey;
static int ConnectionTimeoutSeconds;
static bool EnableOutputBuffering;
static std::string OutputHandler;
static bool ImplicitFlush;
static bool EnableEarlyFlush;
static bool ForceChunkedEncoding;
static int64_t MaxPostSize;
static int64_t LowestMaxPostSize;
static bool AlwaysPopulateRawPostData;
static int64_t UploadMaxFileSize;
static std::string UploadTmpDir;
static bool EnableFileUploads;
static bool EnableUploadProgress;
static int64_t MaxFileUploads;
static int Rfc1867Freq;
static std::string Rfc1867Prefix;
static std::string Rfc1867Name;
static bool ExpiresActive;
static int ExpiresDefault;
static std::string DefaultCharsetName;
static bool ForceServerNameToHeader;
static bool PathDebug;
static std::vector<std::shared_ptr<VirtualHost>> VirtualHosts;
static std::shared_ptr<IpBlockMap> IpBlocks;
static std::vector<std::shared_ptr<SatelliteServerInfo>>
SatelliteServerInfos;
// If a request has a body over this limit, switch to on-demand reading.
// -1 for no limit.
static int64_t RequestBodyReadLimit;
static bool EnableSSL;
static int SSLPort;
static int SSLPortFd;
static std::string SSLCertificateFile;
static std::string SSLCertificateKeyFile;
static std::string SSLCertificateDir;
static std::string SSLTicketSeedFile;
static bool TLSDisableTLS1_2;
static std::string TLSClientCipherSpec;
static bool EnableSSLWithPlainText;
// Level of TLS client auth. Valid values are
// 0 => disabled (default)
// 1 => optional (verify if client presents a cert)
// 2 => required (client must present a valid cert)
static int SSLClientAuthLevel;
// CA file to verify client cert against.
static std::string SSLClientCAFile;
// [DEPRECATED] Sampling ratio for client auth logging.
// Must be an int within [0, 100]. 0 => disabled; 100 => log all connections.
static uint32_t SSLClientAuthLoggingSampleRatio;
// Which ACL identity and action to check the client against.
static std::string ClientAuthAclIdentity;
static std::string ClientAuthAclAction;
// If true, terminate connection immediately if a client fails ACL,
// otherwise log it and let in.
static bool ClientAuthFailClose;
// On average, sample X connections per ClientAuthLogSampleBase connections,
// where X is ClientAuthSuccessLogSampleRatio for client auth successes, and
// ClientAuthFailureLogSampleRatio for client auth failures. Set X to 0 to
// disable sampling.
// For example, if ClientAuthLogSampleBase = 100,
// ClientAuthSuccessLogSampleRatio = 0, and
// ClientAuthFailureLogSampleRatio = 50, then no (0/100) client auth successes
// and half (50/100) of client auth failures will be logged.
static uint32_t ClientAuthLogSampleBase;
static uint32_t ClientAuthSuccessLogSampleRatio;
static uint32_t ClientAuthFailureLogSampleRatio;
static int XboxServerThreadCount;
static int XboxServerMaxQueueLength;
static int XboxServerPort;
static int XboxDefaultLocalTimeoutMilliSeconds;
static int XboxDefaultRemoteTimeoutSeconds;
static int XboxServerInfoMaxRequest;
static int XboxServerInfoDuration;
static std::string XboxServerInfoReqInitFunc;
static std::string XboxServerInfoReqInitDoc;
static bool XboxServerInfoAlwaysReset;
static bool XboxServerLogInfo;
static std::string XboxProcessMessageFunc;
static std::string XboxPassword;
static std::set<std::string> XboxPasswords;
static std::string SourceRoot;
static std::vector<std::string> IncludeSearchPaths;
/**
* Legal root directory expressions in an include expression. For example,
*
* include_once $PHP_ROOT . '/lib.php';
*
* Here, "$PHP_ROOT" is a legal include root. Stores what it resolves to.
*
* RuntimeOption::IncludeRoots["$PHP_ROOT"] = "";
* RuntimeOption::IncludeRoots["$LIB_ROOT"] = "lib";
*/
static std::map<std::string, std::string> IncludeRoots;
static std::map<std::string, std::string> AutoloadRoots;
static bool AutoloadEnabled;
static std::string AutoloadDBPath;
static std::string FileCache;
static std::string DefaultDocument;
static std::string GlobalDocument;
static std::string ErrorDocument404;
static bool ForbiddenAs404;
static std::string ErrorDocument500;
static std::string FatalErrorMessage;
static std::string FontPath;
static bool EnableStaticContentFromDisk;
static bool EnableOnDemandUncompress;
static bool EnableStaticContentMMap;
static bool Utf8izeReplace;
static std::string RequestInitFunction;
static std::string RequestInitDocument;
static std::string AutoPrependFile;
static std::string AutoAppendFile;
static bool SafeFileAccess;
static std::vector<std::string> AllowedDirectories;
static std::set<std::string> AllowedFiles;
static hphp_string_imap<std::string> StaticFileExtensions;
static hphp_string_imap<std::string> PhpFileExtensions;
static std::set<std::string> ForbiddenFileExtensions;
static std::set<std::string> StaticFileGenerators;
static std::vector<std::shared_ptr<FilesMatch>> FilesMatches;
static bool WhitelistExec;
static bool WhitelistExecWarningOnly;
static std::vector<std::string> AllowedExecCmds;
static bool UnserializationWhitelistCheck;
static bool UnserializationWhitelistCheckWarningOnly;
static int64_t UnserializationBigMapThreshold;
static std::string TakeoverFilename;
static std::string AdminServerIP;
static int AdminServerPort;
static int AdminThreadCount;
static bool AdminServerEnableSSLWithPlainText;
static bool AdminServerStatsNeedPassword;
static std::string AdminPassword;
static std::set<std::string> AdminPasswords;
static std::set<std::string> HashedAdminPasswords;
/*
* Options related to reverse proxying. ProxyOriginRaw and ProxyPercentageRaw
* may be mutated by background threads and should only be read or written
* using the helper functions defined with HttpRequestHandler.
*/
static std::string ProxyOriginRaw;
static int ProxyPercentageRaw;
static int ProxyRetry;
static bool UseServeURLs;
static std::set<std::string> ServeURLs;
static bool UseProxyURLs;
static std::set<std::string> ProxyURLs;
static std::vector<std::string> ProxyPatterns;
static bool AlwaysUseRelativePath;
static int HttpDefaultTimeout;
static int HttpSlowQueryThreshold;
static bool NativeStackTrace;
static bool ServerErrorMessage;
static bool RecordInput;
static bool ClearInputOnSuccess;
static std::string ProfilerOutputDir;
static std::string CoreDumpEmail;
static bool CoreDumpReport;
static std::string CoreDumpReportDirectory;
static std::string StackTraceFilename;
static int StackTraceTimeout;
static std::string RemoteTraceOutputDir;
static std::set<std::string, stdltistr> TraceFunctions;
static uint32_t TraceFuncId;
static bool EnableStats;
static bool EnableAPCStats;
static bool EnableWebStats;
static bool EnableMemoryStats;
static bool EnableSQLStats;
static bool EnableSQLTableStats;
static bool EnableNetworkIOStatus;
static std::string StatsXSL;
static std::string StatsXSLProxy;
static uint32_t StatsSlotDuration;
static uint32_t StatsMaxSlot;
static bool EnableHotProfiler;
static int32_t ProfilerTraceBuffer;
static double ProfilerTraceExpansion;
static int32_t ProfilerMaxTraceBuffer;
static int64_t MaxSQLRowCount;
static int64_t SocketDefaultTimeout;
static bool LockCodeMemory;
static int MaxArrayChain;
static bool WarnOnCollectionToArray;
static bool UseDirectCopy;
static bool DisableSmallAllocator;
static std::map<std::string, std::string> ServerVariables;
static std::map<std::string, std::string> EnvVariables;
// The file name that is used by LightProcess to bind the socket
// is the following prefix followed by the pid of the hphp process.
static std::string LightProcessFilePrefix;
static int LightProcessCount;
// Eval options
static bool EnableHipHopSyntax;
static bool EnableShortTags;
static bool EnableXHP;
static bool EnableIntrinsicsExtension;
static bool CheckSymLink;
static bool TrustAutoloaderPath;
static bool EnableArgsInBacktraces;
static bool EnableZendIniCompat;
static bool TimeoutsUseWallTime;
static bool CheckFlushOnUserClose;
static bool EvalAuthoritativeMode;
static int CheckCLIClientCommands;
static int CheckIntOverflow;
static HackStrictOption StrictArrayFillKeys;
static bool LookForTypechecker;
static bool AutoTypecheck;
static uint32_t EvalInitialStaticStringTableSize;
static uint32_t EvalInitialNamedEntityTableSize;
static JitSerdesMode EvalJitSerdesMode;
static int ProfDataTTLHours;
static std::string EvalJitSerdesFile;
static std::string ProfDataTag;
static bool DumpPreciseProfData;
static bool EnableFirstClassFunctionPointers;
// ENABLED (1) selects PHP7 behavior.
static bool PHP7_NoHexNumerics;
static bool PHP7_Builtins;
static bool PHP7_EngineExceptions;
static bool PHP7_Substr;
static bool PHP7_DisallowUnsafeCurlUploads;
static int64_t HeapSizeMB;
static int64_t HeapResetCountBase;
static int64_t HeapResetCountMultiple;
static int64_t HeapLowWaterMark;
static int64_t HeapHighWaterMark;
// Disables PHP's call_user_func function.
// Valid values are 0 => enabled (default),
// 1 => warning, 2 => error.
static uint64_t DisableCallUserFunc;
// Disables PHP's call_user_func_array function.
// Valid values are 0 => enabled (default),
// 1 => warning, 2 => error.
static uint64_t DisableCallUserFuncArray;
// Disables PHP's constant function
// valid values are 0 => enabled (default)
// 1 => warning, 2 => error
static uint64_t DisableConstant;
// Disables PHP's assert() function
// valid values are 0 => enabled (default)
// 1 => warning, 2 => error
static uint64_t DisableAssert;
// Disables non-top-level declarations
// true => error, false => default behaviour
static bool DisableNontoplevelDeclarations;
// Disables static closures
// true => error, false => default behaviour
static bool DisableStaticClosures;
// Enables the class-level where constraints
// true => allow the feature, false => disable the feature
static bool EnableClassLevelWhereClauses;
static int GetScannerType();
static std::set<std::string, stdltistr> DynamicInvokeFunctions;
static hphp_string_imap<TypedValue> ConstantFunctions;
static const uint32_t kPCREInitialTableSize = 96 * 1024;
static std::string ExtensionDir;
static std::vector<std::string> Extensions;
static std::string DynamicExtensionPath;
static std::vector<std::string> DynamicExtensions;
static std::vector<std::string> TzdataSearchPaths;
#define HAC_CHECK_OPTS \
HC(Compare, compare) \
HC(ArrayKeyCast, array_key_cast) \
HC(ArrayPlus, array_plus)
#define EVALFLAGS() \
/* F(type, name, defaultVal) */ \
/* \
* Maximum number of elements on the VM execution stack. \
*/ \
F(uint64_t, VMStackElms, kEvalVMStackElmsDefault) \
/* \
* Initial space reserved for the global variable environment (in \
* number of global variables). \
*/ \
F(uint32_t, VMInitialGlobalTableSize, \
kEvalVMInitialGlobalTableSizeDefault) \
F(bool, Jit, evalJitDefault()) \
F(bool, JitEvaledCode, true) \
F(bool, JitRequireWriteLease, false) \
F(uint64_t, JitRelocationSize, kJitRelocationSizeDefault) \
F(uint64_t, JitMatureSize, 125 << 20) \
F(bool, JitMatureAfterWarmup, true) \
F(double, JitMaturityExponent, 1.) \
F(bool, JitTimer, kJitTimerDefault) \
F(int, JitConcurrently, 1) \
F(int, JitThreads, 4) \
F(int, JitWorkerThreads, std::max(1, Process::GetCPUCount() / 2)) \
F(int, JitWorkerThreadsForSerdes, 0) \
F(int, JitWorkerArenas, std::max(1, Process::GetCPUCount() / 4)) \
F(bool, JitParallelDeserialize, true) \
F(int, JitLdimmqSpan, 8) \
F(int, JitPrintOptimizedIR, 0) \
F(bool, RecordSubprocessTimes, false) \
F(bool, AllowHhas, false) \
F(bool, GenerateDocComments, true) \
F(bool, DisassemblerDocComments, true) \
F(bool, DisassemblerPropDocComments, true) \
F(bool, LoadFilepathFromUnitCache, false) \
F(bool, FatalOnParserOptionMismatch, true) \
F(bool, WarnOnSkipFrameLookup, true) \
/* \
* 0 - Code coverage cannot be enabled through request param \
* 1 - Code coverage can be enabled through request param \
* 2 - Code coverage enabled \
*/ \
F(uint32_t, EnableCodeCoverage, 0) \
/* Whether to use the embedded hackc binary */ \
F(bool, HackCompilerUseEmbedded, facebook) \
/* Whether to trust existing versions of the extracted compiler */ \
F(bool, HackCompilerTrustExtract, true) \
/* When using an embedded hackc, extract it to the ExtractPath or the
ExtractFallback. */ \
F(string, HackCompilerExtractPath, "/var/run/hackc_%{schema}") \
F(string, HackCompilerFallbackPath, "/tmp/hackc_%{schema}_XXXXXX") \
/* Arguments to run embedded hackc binary with */ \
F(string, HackCompilerArgs, hackCompilerArgsDefault()) \
/* The command to invoke to spawn hh_single_compile in server mode. */\
F(string, HackCompilerCommand, hackCompilerCommandDefault()) \
/* The number of hh_single_compile daemons to keep alive. */ \
F(uint64_t, HackCompilerWorkers, Process::GetCPUCount()) \
/* The number of hh_single_compile daemons to keep alive during a \
* repo build after the files in the tree are parsed--set to 0 to \
* disable resizing the pool of compilers */ \
F(uint64_t, HackCompilerSecondaryWorkers, 2) \
/* The number of times to retry after an infra failure communicating
with a compiler process. */ \
F(uint64_t, HackCompilerMaxRetries, 0) \
/* Whether to log extern compiler performance */ \
F(bool, LogExternCompilerPerf, false) \
/* Whether to write verbose log messages to the error log and include
the hhas from failing units in the fatal error messages produced by
bad hh_single_compile units. */ \
F(bool, HackCompilerVerboseErrors, true) \
/* Whether the HackC compiler should inherit the compiler config of the
HHVM process that launches it. */ \
F(bool, HackCompilerInheritConfig, true) \
/* When using embedded data, extract it to the ExtractPath or the
* ExtractFallback. */ \
F(string, EmbeddedDataExtractPath, "/var/run/hhvm_%{type}_%{buildid}") \
F(string, EmbeddedDataFallbackPath, "/tmp/hhvm_%{type}_%{buildid}_XXXXXX") \
/* Whether to trust existing versions of extracted embedded data. */ \
F(bool, EmbeddedDataTrustExtract, true) \
F(bool, LogThreadCreateBacktraces, false) \
F(bool, FailJitPrologs, false) \
F(bool, UseHHBBC, !getenv("HHVM_DISABLE_HHBBC")) \
F(bool, EnablePerRepoOptions, true) \
F(bool, CachePerRepoOptionsPath, true) \
/* ThrowOnNonExhaustiveSwitch
* Generates warnings when switch statements are non exhaustive.
* 0 - Nothing
* 1 - Raise Warning
* >1 - Throw Exception
*/ \
F(uint32_t, ThrowOnNonExhaustiveSwitch, 1) \
/* CheckReturnTypeHints:
<2 - Raises E_WARNING if a return type hint fails.
2 - Raises E_RECOVERABLE_ERROR if regular return type hint fails,
raises E_WARNING if soft return type hint fails. If a regular
return type hint fails, it's possible for execution to resume
normally if the user error handler doesn't throw and returns
something other than boolean false.
3 - Same as 2, except if a regular type hint fails the runtime
will not allow execution to resume normally; if the user
error handler returns something other than boolean false,
the runtime will throw a fatal error. */ \
F(int32_t, CheckReturnTypeHints, 3) \
/*
CheckPropTypeHints:
0 - No checks or enforcement of property type hints.
1 - Raises E_WARNING if a property type hint fails.
2 - Raises E_RECOVERABLE_ERROR if regular property type hint fails, raises
E_WARNING if soft property type hint fails. If a regular property type
hint fails, it's possible for execution to resume normally if the user
error handler doesn't throw and returns something other than boolean
false.
3 - Same as 2, except if a regular property type hint fails the runtime will
not allow execution to resume normally; if the user error handler
returns something other than boolean false, the runtime will throw a
fatal error.
*/ \
F(int32_t, CheckPropTypeHints, 1) \
/* Enables enforcing upper-bounds for generic types
1 => warning, 2 => error
*/ \
F(int32_t, EnforceGenericsUB, 1) \
/* WarnOnTooManyArguments:
* 0 -> no warning, 1 -> warning, 2 -> exception
*/ \
F(uint32_t, WarnOnTooManyArguments, 0) \
/* GetClassBadArgument:
* 0 -> no warning, 1 -> warning, 2 -> exception
*/ \
F(uint32_t, GetClassBadArgument, 0) \
/* WarnOnIncDecInvalidType:
* 0 - No restrictions on types that can be incremented or decremented
* 1 - Warn when incrementing or decrementing non numeric types
* 2 - Throw when incrementing or decrementing non numeric types
*/ \
F(uint32_t, WarnOnIncDecInvalidType, 0) \
F(bool, EnableImplicitContext, false) \
F(bool, MoreAccurateMemStats, true) \
F(bool, AllowScopeBinding, false) \
F(bool, JitNoGdb, true) \
F(bool, SpinOnCrash, false) \
F(uint32_t, DumpRingBufferOnCrash, 0) \
F(bool, PerfPidMap, true) \
F(bool, PerfPidMapIncludeFilePath, true) \
F(bool, PerfJitDump, false) \
F(string, PerfJitDumpDir, "/tmp") \
F(bool, PerfDataMap, false) \
F(bool, KeepPerfPidMap, false) \
F(uint32_t, ThreadTCMainBufferSize, 6 << 20) \
F(uint32_t, ThreadTCColdBufferSize, 6 << 20) \
F(uint32_t, ThreadTCFrozenBufferSize,4 << 20) \
F(uint32_t, ThreadTCDataBufferSize, 256 << 10) \
F(uint32_t, JitTargetCacheSize, 64 << 20) \
F(uint32_t, HHBCArenaChunkSize, 10 << 20) \
F(bool, ProfileBC, false) \
F(bool, ProfileHeapAcrossRequests, false) \
F(bool, ProfileHWEnable, true) \
F(string, ProfileHWEvents, std::string("")) \
F(bool, ProfileHWExcludeKernel, false) \
F(bool, ProfileHWFastReads, false) \
F(bool, ProfileHWStructLog, false) \
F(int32_t, ProfileHWExportInterval, 30) \
F(string, ReorderProps, reorderPropsDefault()) \
F(bool, JitAlwaysInterpOne, false) \
F(int32_t, JitNopInterval, 0) \
F(uint32_t, JitMaxTranslations, 10) \
F(uint32_t, JitMaxProfileTranslations, 30) \
F(uint32_t, JitTraceletGuardsLimit, 5) \
F(uint64_t, JitGlobalTranslationLimit, -1) \
F(int64_t, JitMaxRequestTranslationTime, -1) \
F(uint32_t, JitMaxRegionInstrs, 1347) \
F(uint32_t, JitMaxLiveRegionInstrs, 50) \
F(uint32_t, JitMaxAwaitAllUnroll, 8) \
F(bool, JitProfileWarmupRequests, false) \
F(uint32_t, JitProfileRequests, profileRequestsDefault()) \
F(uint32_t, JitProfileBCSize, profileBCSizeDefault()) \
F(uint32_t, JitResetProfCountersRequest, resetProfCountersDefault()) \
F(uint32_t, JitRetranslateAllRequest, retranslateAllRequestDefault()) \
F(uint32_t, JitRetranslateAllSeconds, retranslateAllSecondsDefault()) \
F(bool, JitPGOLayoutSplitHotCold, pgoLayoutSplitHotColdDefault()) \
F(bool, JitPGOVasmBlockCounters, true) \
F(bool, JitPGOVasmBlockCountersForceSaveSF, false) \
F(bool, JitPGOVasmBlockCountersForceSaveGP, false) \
F(uint32_t, JitPGOVasmBlockCountersMaxOpMismatches, 12) \
F(uint32_t, JitPGOVasmBlockCountersMinEntryValue, \
ServerExecutionMode() ? 200 : 0) \
F(bool, JitPGOVasmBlockCountersSkipFixWeights, false) \
F(double, JitPGOVasmBlockCountersHotWeightMultiplier, 0) \
F(bool, JitLayoutSeparateZeroWeightBlocks, false) \
F(bool, JitLayoutPrologueSplitHotCold, layoutPrologueSplitHotColdDefault()) \
F(bool, JitLayoutProfileSplitHotCold, true) \
F(uint64_t, JitLayoutMinHotThreshold, 0) \
F(uint64_t, JitLayoutMinColdThreshold, 0) \
F(double, JitLayoutHotThreshold, 0.01) \
F(double, JitLayoutColdThreshold, 0.0005) \
F(int32_t, JitLayoutMainFactor, 1000) \
F(int32_t, JitLayoutColdFactor, 5) \
F(bool, JitAHotSizeRoundUp, true) \
F(uint32_t, GdbSyncChunks, 128) \
F(bool, JitKeepDbgFiles, false) \
/* despite the unfortunate name, this enables function renaming and
* interception in the interpreter as well as the jit, and also
* implies all functions may be used with fb_intercept */ \
F(bool, JitEnableRenameFunction, EvalJitEnableRenameFunction) \
F(bool, JitUseVtuneAPI, false) \
F(bool, TraceCommandLineRequest, true) \
\
F(bool, JitDisabledByHphpd, false) \
F(uint32_t, JitWarmupStatusBytes, ((25 << 10) + 1)) \
F(uint32_t, JitWarmupMaxCodeGenRate, 20000) \
F(uint32_t, JitWarmupRateSeconds, 64) \
F(uint32_t, JitWriteLeaseExpiration, 1500) /* in microseconds */ \
F(int, JitRetargetJumps, 1) \
/* Sync VM reg state for all native calls. */ \
F(bool, JitForceVMRegSync, false) \
/* Log the profile used to optimize array-like gets and sets. */ \
F(bool, LogArrayAccessProfile, false) \
/* Log the profile used to target iterator specialization. */ \
F(bool, LogArrayIterProfile, false) \
/* We use PGO to target specialization for "foreach" iterator loops. \
* We specialize if the chosen specialization covers this fraction \
* of profiled loops. If the value is > 1.0, we won't specialize. */ \
F(double, ArrayIterSpecializationRate, 0.99) \
F(bool, HHIRSimplification, true) \
F(bool, HHIRGenOpts, true) \
F(bool, HHIRRefcountOpts, true) \
F(bool, HHIREnableGenTimeInlining, true) \
F(uint32_t, HHIRInliningCostFactorMain, 100) \
F(uint32_t, HHIRInliningCostFactorCold, 32) \
F(uint32_t, HHIRInliningCostFactorFrozen, 10) \
F(uint32_t, HHIRInliningVasmCostLimit, 10500) \
F(uint32_t, HHIRInliningMinVasmCostLimit, 10000) \
F(uint32_t, HHIRInliningMaxVasmCostLimit, 40000) \
F(uint32_t, HHIRAlwaysInlineVasmCostLimit, 4800) \
F(uint32_t, HHIRInliningMaxDepth, 1000) \
F(double, HHIRInliningVasmCallerExp, .5) \
F(double, HHIRInliningVasmCalleeExp, .5) \
F(double, HHIRInliningDepthExp, 0) \
F(uint32_t, HHIRInliningMaxReturnDecRefs, 24) \
F(uint32_t, HHIRInliningMaxReturnLocals, 40) \
F(uint32_t, HHIRInliningMaxInitObjProps, 12) \
F(bool, HHIRInliningIgnoreHints, !debug) \
F(bool, HHIRInliningUseStackedCost, true) \
F(bool, HHIRInliningUseLayoutBlocks, false) \
F(bool, HHIRInlineFrameOpts, true) \
F(bool, HHIRPartialInlineFrameOpts, true) \
F(bool, HHIRAlwaysInterpIgnoreHint, !debug) \
F(bool, HHIRGenerateAsserts, false) \
F(bool, HHIRDeadCodeElim, true) \
F(bool, HHIRGlobalValueNumbering, true) \
F(bool, HHIRPredictionOpts, true) \
F(bool, HHIRMemoryOpts, true) \
F(bool, AssemblerFoldDefaultValues, true) \
F(uint64_t, AssemblerMaxScalarSize, 1073741824) /* 1GB */ \
F(uint32_t, HHIRLoadElimMaxIters, 10) \
/* Temporarily only enable in debug builds so the optimizations get
* tested */ \
F(bool, HHIRLoadEnableTeardownOpts, debug) \
F(uint32_t, HHIRLoadStackTeardownMaxDecrefs, 8) \
F(uint32_t, HHIRLoadThrowMaxDecrefs, 64) \
F(bool, HHIRStorePRE, true) \
F(bool, HHIROutlineGenericIncDecRef, true) \
/* How many elements to inline for packed- or mixed-array inits. */ \
F(uint32_t, HHIRMaxInlineInitPackedElements, 8) \
F(uint32_t, HHIRMaxInlineInitMixedElements, 4) \
F(double, HHIROffsetArrayProfileThreshold, 0.85) \
F(double, HHIRSmallArrayProfileThreshold, 0.8) \
F(double, HHIRMissingArrayProfileThreshold, 0.8) \
F(double, HHIRExitArrayProfileThreshold, 0.98) \
F(double, HHIROffsetExitArrayProfileThreshold, 1.2) /* disabled */ \
F(double, HHIRIsTypeStructProfileThreshold, 0.95) \
/* Register allocation flags */ \
F(bool, HHIREnablePreColoring, true) \
F(bool, HHIREnableCoalescing, true) \
F(bool, HHIRAllocSIMDRegs, true) \
F(bool, HHIRStressSpill, false) \
F(bool, JitStressTestLiveness, false) \
/* Region compiler flags */ \
F(string, JitRegionSelector, regionSelectorDefault()) \
F(bool, JitPGO, pgoDefault()) \
F(string, JitPGORegionSelector, "hotcfg") \
F(uint64_t, JitPGOThreshold, pgoThresholdDefault()) \
F(bool, JitPGOOnly, false) \
F(bool, JitPGOUsePostConditions, true) \
F(bool, JitPGOUseAddrCountedCheck, false) \
F(uint32_t, JitPGOUnlikelyIncRefCountedPercent, 2) \
F(uint32_t, JitPGOUnlikelyIncRefIncrementPercent, 5) \
F(uint32_t, JitPGOUnlikelyDecRefReleasePercent, 5) \
F(uint32_t, JitPGOUnlikelyDecRefCountedPercent, 2) \
F(uint32_t, JitPGOUnlikelyDecRefPersistPercent, 5) \
F(uint32_t, JitPGOUnlikelyDecRefSurvivePercent, 5) \
F(uint32_t, JitPGOUnlikelyDecRefDecrementPercent, 5) \
F(double, JitPGODecRefNZReleasePercentCOW, \
ServerExecutionMode() ? 0.5 : 0) \
F(double, JitPGODecRefNZReleasePercent, \
ServerExecutionMode() ? 5 : 0) \
F(double, JitPGODecRefNopDecPercentCOW, \
ServerExecutionMode() ? 0.5 : 0) \
F(double, JitPGODecRefNopDecPercent, ServerExecutionMode() ? 5 : 0) \
F(bool, JitPGOArrayGetStress, false) \
F(double, JitPGOMinBlockCountPercent, 0.025) \
F(double, JitPGOMinArcProbability, 0.0) \
F(uint32_t, JitPGOMaxFuncSizeDupBody, 80) \
F(uint32_t, JitPGORelaxPercent, 100) \
F(uint32_t, JitPGORelaxUncountedToGenPercent, 20) \
F(uint32_t, JitPGORelaxCountedToGenPercent, 75) \
F(double, JitPGOCalledFuncCheckThreshold, 50) \
F(double, JitPGOCalledFuncExitThreshold, 99.9) \
F(bool, JitPGODumpCallGraph, false) \
F(bool, JitPGOOptCodeCallGraph, true) \
F(bool, JitPGORacyProfiling, false) \
F(uint32_t, JitLiveThreshold, ServerExecutionMode() ? 1000 : 0) \
F(uint32_t, JitProfileThreshold, ServerExecutionMode() ? 200 : 0) \
F(uint32_t, JitSrcKeyThreshold, 0) \
F(uint64_t, FuncCountHint, 10000) \
F(uint64_t, PGOFuncCountHint, 1000) \
F(bool, RegionRelaxGuards, true) \
/* DumpBytecode =1 dumps user php, =2 dumps systemlib & user php */ \
F(int32_t, DumpBytecode, 0) \
/* DumpHhas =1 dumps user php, =2 dumps systemlib & user php */ \
F(int32_t, DumpHhas, 0) \
F(string, DumpHhasToFile, "") \
F(bool, DumpTC, false) \
F(string, DumpTCPath, "/tmp") \
F(bool, DumpTCAnchors, false) \
F(uint32_t, DumpIR, 0) \
F(uint32_t, DumpIRJson, 0) \
F(bool, DumpTCAnnotationsForAllTrans,debug) \
/* DumpInlDecision 0=none ; 1=refuses ; 2=refuses+accepts */ \
F(uint32_t, DumpInlDecision, 0) \
F(uint32_t, DumpRegion, 0) \
F(bool, DumpCallTargets, false) \
F(bool, DumpLayoutCFG, false) \
F(bool, DumpVBC, false) \
F(bool, DumpAst, false) \
F(bool, DumpTargetProfiles, false) \
F(bool, MapTgtCacheHuge, false) \
F(bool, NewTHPHotText, false) \
F(uint32_t, MaxHotTextHugePages, hotTextHugePagesDefault()) \
F(uint32_t, MaxLowMemHugePages, hugePagesSoundNice() ? 8 : 0) \
F(uint32_t, MaxHighArenaHugePages, 0) \
F(uint32_t, Num1GPagesForSlabs, 0) \
F(uint32_t, Num2MPagesForSlabs, 0) \
F(uint32_t, Num1GPagesForReqHeap, 0) \
F(uint32_t, Num2MPagesForReqHeap, 0) \
F(uint32_t, NumReservedSlabs, 0) \
F(uint32_t, Num1GPagesForA0, 0) \
F(uint32_t, Num2MPagesForA0, 0) \
F(bool, BigAllocUseLocalArena, true) \
F(bool, JsonParserUseLocalArena, true) \
F(bool, XmlParserUseLocalArena, true) \
F(bool, LowStaticArrays, true) \
F(int64_t, HeapPurgeWindowSize, 5 * 1000000) \
F(uint64_t, HeapPurgeThreshold, 128 * 1024 * 1024) \
/* GC Options: See heap-collect.cpp for more details */ \
F(bool, EagerGC, eagerGcDefault()) \
F(bool, FilterGCPoints, true) \
F(bool, Quarantine, eagerGcDefault()) \
F(bool, HeapAllocSampleNativeStack, false) \
F(bool, LogKilledRequests, true) \
F(uint32_t, GCSampleRate, 0) \
F(uint32_t, HeapAllocSampleRequests, 0) \
F(uint32_t, HeapAllocSampleBytes, 256 * 1024) \
F(uint32_t, SlabAllocAlign, 64) \
F(int64_t, GCMinTrigger, 64L<<20) \
F(double, GCTriggerPct, 0.5) \
F(bool, TwoPhaseGC, false) \
F(bool, EnableGC, enableGcDefault()) \
/* End of GC Options */ \
F(bool, Verify, (getenv("HHVM_VERIFY") || \
!EvalHackCompilerCommand.empty())) \
F(bool, VerifyOnly, false) \
F(bool, FatalOnVerifyError, !RepoAuthoritative) \
F(bool, AbortBuildOnVerifyError, true) \
F(bool, AbortBuildOnCompilerError, true) \
F(uint32_t, StaticContentsLogRate, 100) \
F(uint32_t, LogUnitLoadRate, 0) \
F(uint32_t, MaxDeferredErrors, 50) \
F(bool, JitAlignMacroFusionPairs, alignMacroFusionPairs()) \
F(bool, JitAlignUniqueStubs, true) \
F(uint32_t, SerDesSampleRate, 0) \
F(bool, JitSerdesModeForceOff, false) \
F(bool, JitDesUnitPreload, false) \
F(std::set<std::string>, JitSerdesDebugFunctions, {}) \
F(uint32_t, JitSerializeOptProfSeconds, ServerExecutionMode() ? 300 : 0)\
F(uint32_t, JitSerializeOptProfRequests, 0) \
F(int, SimpleJsonMaxLength, 2 << 20) \
F(uint32_t, JitSampleRate, 0) \
F(uint32_t, TraceServerRequestRate, 0) \
/* Tracing Options */ \
/* Base tracing sample rate for all requests */ \
F(uint32_t, TracingSampleRate, 0) \
/* Tracing sample rate for first N requests */ \
F(uint32_t, TracingPerRequestCount, 0) \
F(uint32_t, TracingPerRequestSampleRate, 0) \
/* Tracing sample rate for first N requests per URL */ \
F(uint32_t, TracingFirstRequestsCount, 0) \
F(uint32_t, TracingFirstRequestsSampleRate, 0) \
/* Empty string disables any Artillery tracing */ \
F(std::string, ArtilleryTracePolicy, "") \
/* Opaque tag to add to each trace. Useful for aggregation */ \
F(std::string, TracingTagId, "") \
/* Log the sizes and metadata for all translations in the TC broken
* down by function and inclusive/exclusive size for inlined regions.
* When set to "" TC size data will be sampled on a per function basis
* as determined by JitSampleRate. When set to a non-empty string all
* translations will be logged, and run_key column will be logged with
* the value of this option. */ \
F(string, JitLogAllInlineRegions, "") \
F(bool, JitProfileGuardTypes, false) \
F(uint32_t, JitFilterLease, 1) \
F(uint32_t, PCRETableSize, kPCREInitialTableSize) \
F(uint64_t, PCREExpireInterval, 2 * 60 * 60) \
F(string, PCRECacheType, std::string("static")) \
F(bool, EnableCompactBacktrace, true) \
F(bool, EnableNuma, (numa_num_nodes > 1) && ServerExecutionMode()) \
/* Use 1G pages for jemalloc metadata. */ \
F(bool, EnableArenaMetadata1GPage, false) \
/* Use 1G pages for jemalloc metadata (NUMA arenas if applicable). */ \
F(bool, EnableNumaArenaMetadata1GPage, false) \
/* Reserved space on 1G pages for jemalloc metadata (arena0). */ \
F(uint64_t, ArenaMetadataReservedSize, 216 << 20) \
F(bool, EnableCallBuiltin, true) \
F(bool, EnableReusableTC, reuseTCDefault()) \
F(bool, LogServerRestartStats, false) \
/* Extra bytes added to each area (Hot/Cold/Frozen) of a translation. \
* If we don't end up using a reusable TC, we'll drop the padding. */ \
F(uint32_t, ReusableTCPadding, 128) \
F(int64_t, StressUnitCacheFreq, 0) \
/* Perf warning sampling rates. The SelectHotCFG warning is noisy. */ \
F(int64_t, PerfWarningSampleRate, 1) \
F(int64_t, SelectHotCFGSampleRate, 100) \
F(int64_t, FunctionCallSampleRate, 0) \
F(double, InitialLoadFactor, 1.0) \
/* When the "allow" flag is off, we assume that all array-likes have \
* their standard (aka "vanilla") layouts. When the flag is on, we \
* must check for "bespoke" hidden classes as well. \
* \
* The "allow" flag affects the JIT, but setting it doesn't cause us \
* to produce BespokeArrays - to set the "emit" flag to do that. */ \
F(bool, AllowBespokeArrayLikes, false) \
F(bool, EmitBespokeArrayLikes, false) \
/* Raise notices on various array operations which may present \
* compatibility issues with Hack arrays. \
* \
* The various *Notices options independently control separate \
* subsets of notices. The Check* options are subordinate to the \
* HackArrCompatNotices option, and control whether various runtime
* checks are made; they do not affect any optimizations. */ \
F(bool, HackArrCompatNotices, false) \
F(bool, HackArrCompatCheckCompare, false) \
F(bool, HackArrCompatCheckArrayPlus, false) \
F(bool, HackArrCompatFBSerializeHackArraysNotices, false) \
/* Raise notices on intish-cast (which may use an is_array check) */ \
F(bool, HackArrCompatIntishCastNotices, false) \
/* Raise notices when is_array is called with any hack array */ \
F(bool, HackArrCompatIsArrayNotices, false) \
/* Raise notices when is_vec or is_dict is called with a v/darray */ \
F(bool, HackArrCompatIsVecDictNotices, false) \
F(bool, HackArrCompatSerializeNotices, false) \
/* Raise notices when fb_compact_*() would change behavior */ \
F(bool, HackArrCompatCompactSerializeNotices, false) \
/* When this flag is on, d/varray constructions are marked. */ \
F(bool, HackArrDVArrMark, false) \
/* When this flag is on, var_dump outputs d/varrays. */ \
F(bool, HackArrDVArrVarDump, false) \
/* This is the flag for "unification", meaning that darrays are \
* replaced by dicts and varrays by vecs. */ \
F(bool, HackArrDVArrs, false) \
/* Raise a notice for `$dict is shape` and `$vec is tuple`. */ \
F(bool, HackArrIsShapeTupleNotices, false) \
/* Enable instrumentation and information in the repo for tracking \
* the source of vecs and dicts whose vec/dict-ness is observed \
* during program execution \
* \
* Latches to false at startup if either the repo we're loading in \
* RepoAuthoritativeMode wasn't built with this flag or if the \
* flag LogArrayProvenance is unset */ \
F(bool, ArrayProvenance, false) \
/* Log the source of dvarrays whose dvarray-ness is observed, e.g. \
* through serialization. If this flag is off, we won't bother to \
* track array provenance at runtime, because it isn't exposed. \
* \
* Code should just depend on ArrayProvenance alone - we'll set it \
* based on this flag when loading a repo build. */ \
F(bool, LogArrayProvenance, false) \
/* Log only out out of this many array headers when serializing */ \
F(uint32_t, LogArrayProvenanceSampleRatio, 1000) \
/* Use dummy tags for enums with this many values, to avoid copies */ \
F(uint32_t, ArrayProvenanceLargeEnumLimit, 256) \
/* What fraction of array provenance diagnostics should be logged? \
* Set to 0 to disable diagnostics entirely */ \
F(uint32_t, LogArrayProvenanceDiagnosticsSampleRate, 0) \
/* Warn if is expression are used with type aliases that cannot be |
* resolved */ \
F(bool, IsExprEnableUnresolvedWarning, false) \
/* Raise a notice if a Func type is passed to is_string */ \
F(bool, IsStringNotices, false) \
/* Raise a notice if a Class type is passed to is_string */ \
F(bool, ClassIsStringNotices, false) \
/* Raise a notice if a Func type is passed to function that expects a
string */ \
F(bool, StringHintNotices, false) \
/* Raise a notice if a Class type is passed to function that expects a
string */ \
F(bool, ClassStringHintNotices, false) \
/* Raise a notice if a ClsMeth type is passed to is_vec/is_array */ \
F(bool, IsVecNotices, false) \
/* Raise a notice if a ClsMeth type is passed to a function that
* expects a vec/varray */ \
F(bool, VecHintNotices, false) \
/* Switches on miscellaneous junk. */ \
F(bool, NoticeOnCreateDynamicProp, false) \
F(bool, NoticeOnReadDynamicProp, false) \
F(bool, NoticeOnImplicitInvokeToString, false) \
F(bool, FatalOnConvertObjectToString, false) \
F(bool, NoticeOnBuiltinDynamicCalls, false) \
F(bool, RxPretendIsEnabled, false) \
/* When true function pointers will pass string typehints and checks,
while optionally raising notices. */ \
F(bool, EnableFuncStringInterop, true) \
/* Raise warning when function pointers are used as strings. */ \
F(bool, RaiseFuncConversionWarning, false) \
/* Raise warning when class pointers are used as strings. */ \
F(bool, RaiseClassConversionWarning, false) \
F(bool, EmitClsMethPointers, false) \
/* EmitClassPointers:
* 0 => convert Foo::class to string "Foo"
* 1 => convert Foo::class to class pointer
* 2 => convert Foo::class to lazy class */ \
F(uint16_t, EmitClassPointers, 0) \
/* false to skip type refinement for ClsMeth type at HHBBC. */ \
F(bool, IsCompatibleClsMethType, false) \
/* Raise warning if a ClsMeth type is compared to other types. */ \
F(bool, RaiseClsMethComparisonWarning, false) \
/* Raise warning when ClsMethDataRef is used as varray/vec. */ \
F(bool, RaiseClsMethConversionWarning, false) \
/* Raise warning when strings are used as classes. */ \
F(bool, RaiseStrToClsConversionWarning, false) \
F(bool, EmitMethCallerFuncPointers, false) \
/* trigger E_USER_WARNING error when getClassName()/getMethodName()
* is used on __SystemLib\MethCallerHelper */ \
F(bool, NoticeOnMethCallerHelperUse, false) \
F(bool, NoticeOnCollectionToBool, false) \
F(bool, NoticeOnSimpleXMLBehavior, false) \
F(bool, ForbidDivisionByZero, true) \
/* Enables Hack records. */ \
F(bool, HackRecords, false) \
/* \
* Control dynamic calls to functions and dynamic constructs of \
* classes which haven't opted into being called that way. \
* \
* 0 - Nothing \
* 1 - Warn if target is not annotated or dynamic callsite is using \
* a raw string or array \
* (depending on ForbidDynamicCallsWithAttr setting) \
* 2 - Throw exception if target is not annotated, and warn if \
* dynamic callsite is using a raw string or array \
* 3 - Throw exception \
* \
*/ \
F(int32_t, ForbidDynamicCallsToFunc, 0) \
F(int32_t, ForbidDynamicCallsToClsMeth, 0) \
F(int32_t, ForbidDynamicCallsToInstMeth, 0) \
F(int32_t, ForbidDynamicConstructs, 0) \
/* \
* Keep logging dynamic calls according to options above even if \
* __DynamicallyCallable attribute is present at declaration. \
*/ \
F(bool, ForbidDynamicCallsWithAttr, false) \
/* Toggles logging for expressions of type $var::name() */ \
F(bool, LogKnownMethodsAsDynamicCalls, true) \
/* \
* Don't allow unserializing to __PHP_Incomplete_Class \
* 0 - Nothing \
* 1 - Warn \
* 2 - Throw exception \
*/ \
F(int32_t, ForbidUnserializeIncompleteClass, 0) \
F(int32_t, RxEnforceCalls, 0) \
/* \
* 0 - Nothing \
* 1 - Warn \
* 2 - Fail unit verification (i.e. fail to load it) \
*/ \
F(int32_t, RxVerifyBody, 0) \
F(bool, RxIsEnabled, EvalRxPretendIsEnabled) \
/* \
* Controls behavior on reflection to default value expressions \
* that throw during evaluation \
* 0 - Nothing \
* 1 - Warn and retain current behavior \
* 2 - Return null for parameter value \
*/ \
F(int32_t, FixDefaultArgReflection, 1) \
F(int32_t, ServerOOMAdj, 0) \
F(std::string, PreludePath, "") \
F(uint32_t, NonSharedInstanceMemoCaches, 10) \
F(bool, UseGraphColor, true) \
F(std::vector<std::string>, IniGetHide, std::vector<std::string>()) \
F(std::string, UseRemoteUnixServer, "no") \
F(std::string, UnixServerPath, "") \
F(uint32_t, UnixServerWorkers, Process::GetCPUCount()) \
F(bool, UnixServerQuarantineApc, false) \
F(bool, UnixServerQuarantineUnits, false) \
F(bool, UnixServerVerifyExeAccess, false) \
F(bool, UnixServerFailWhenBusy, false) \
F(std::vector<std::string>, UnixServerAllowedUsers, \
std::vector<std::string>()) \
F(std::vector<std::string>, UnixServerAllowedGroups, \
std::vector<std::string>()) \
/* Options for testing */ \
F(bool, TrashFillOnRequestExit, false) \
/****************** \
| ARM Options. | \
*****************/ \
F(bool, JitArmLse, armLseDefault()) \
/****************** \
| PPC64 Options. | \
*****************/ \
/* Minimum immediate size to use TOC */ \
F(uint16_t, PPC64MinTOCImmSize, 64) \
/* Relocation features. Use with care on production */ \
/* Allow a Far branch be converted to a Near branch. */ \
F(bool, PPC64RelocationShrinkFarBranches, false) \
/* Remove nops from a Far branch. */ \
F(bool, PPC64RelocationRemoveFarBranchesNops, true) \
/******************** \
| Profiling flags. | \
********************/ \
/* Whether to maintain the address-to-VM-object mapping. */ \
F(bool, EnableReverseDataMap, true) \
/* Turn on perf-mem-event sampling roughly every this many requests. \
* To maintain the same overall sampling rate, the ratio between the \
* request and sample frequencies should be kept constant. */ \
F(uint32_t, PerfMemEventRequestFreq, 0) \
/* Sample this many memory instructions per second. This should be \
* kept low to avoid the risk of collecting a sample while we're \
* processing a previous sample. */ \
F(uint32_t, PerfMemEventSampleFreq, 80) \
/* Sampling frequency for TC branch profiling. */ \
F(uint32_t, ProfBranchSampleFreq, 0) \
/* Sampling frequency for profiling packed array accesses. */ \
F(uint32_t, ProfPackedArraySampleFreq, 0) \
F(bool, UseXedAssembler, false) \
/* Record the first N units loaded via StructuredLog::log() */ \
F(uint64_t, RecordFirstUnits, 0) \
/* More aggresively reuse already compiled units based on SHA1 */ \
F(bool, CheckUnitSHA1, true) \
/* When dynamic_fun is called on a function not marked as
__DynamicallyCallable:
0 - do nothing
1 - raise a warning
2 - throw */ \
F(uint64_t, DynamicFunLevel, 1) \
/* When dynamic_class_meth is called on a method not marked as
__DynamicallyCallable:
0 - do nothing
1 - raise a warning
2 - throw */ \
F(uint64_t, DynamicClsMethLevel, 1) \
F(bool, APCSerializeFuncs, true) \
/* When set:
* - `is_array` becomes equivalent to `is_any_array` or
* `isTvArrayLike` instead of being a strict KindOfArray check.
* - For safety, we still log when these calls receive Hack arrays.
* See `SuppressWidenIsArrayLogs`.
*/ \
F(bool, WidenIsArray, false) \
F(bool, WidenIsArrayLogs, true) \
F(bool, EnablePerFileCoverage, false) \
/* Should we use the autoload map from the repo */ \
F(bool, UseRepoAutoloadMap, true) \
F(bool, LogOnIsArrayFunction, false) \
private:
using string = std::string;
// Custom settings. This should be accessed via the GetServerCustomSetting
// APIs.
static std::map<std::string, std::string> CustomSettings;
public:
#define F(type, name, unused) \
static type Eval ## name;
EVALFLAGS()
#undef F
static bool RecordCodeCoverage;
static std::string CodeCoverageOutputFile;
// Repo (hhvm bytecode repository) options
static std::string RepoLocalMode;
static std::string RepoLocalPath;
static std::string RepoCentralPath;
static int32_t RepoCentralFileMode;
static std::string RepoCentralFileUser;
static std::string RepoCentralFileGroup;
static bool RepoAllowFallbackPath;
static std::string RepoEvalMode;
static std::string RepoJournal;
static bool RepoCommit;
static bool RepoDebugInfo;
static bool RepoAuthoritative;
static int64_t RepoLocalReadaheadRate;
static bool RepoLitstrLazyLoad;
static bool RepoLocalReadaheadConcurrent;
static uint32_t RepoBusyTimeoutMS;
// pprof/hhprof options
static bool HHProfEnabled;
static bool HHProfActive;
static bool HHProfAccum;
static bool HHProfRequest;
static bool TrackPerUnitMemory;
// Sandbox options
static bool SandboxMode;
static std::string SandboxPattern;
static std::string SandboxHome;
static std::string SandboxFallback;
static std::string SandboxConfFile;
static std::map<std::string, std::string> SandboxServerVariables;
static bool SandboxFromCommonRoot;
static std::string SandboxDirectoriesRoot;
static std::string SandboxLogsRoot;
static std::string SandboxDefaultUserFile;
static std::string SandboxHostAlias;
// Debugger options
static bool EnableHphpdDebugger;
static bool EnableVSDebugger;
static int VSDebuggerListenPort;
static std::string VSDebuggerDomainSocketPath;
static bool VSDebuggerNoWait;
static bool EnableDebuggerColor;
static bool EnableDebuggerPrompt;
static bool EnableDebuggerServer;
static bool EnableDebuggerUsageLog;
static bool DebuggerDisableIPv6;
static std::string DebuggerServerIP;
static int DebuggerServerPort;
static int DebuggerDefaultRpcPort;
static std::string DebuggerDefaultRpcAuth;
static std::string DebuggerRpcHostDomain;
static int DebuggerDefaultRpcTimeout;
static std::string DebuggerDefaultSandboxPath;
static std::string DebuggerStartupDocument;
static int DebuggerSignalTimeout;
static std::string DebuggerAuthTokenScriptBin;
static std::string DebuggerSessionAuthScriptBin;
// Mail options
static std::string SendmailPath;
static std::string MailForceExtraParameters;
// preg stack depth and debug support options
static int64_t PregBacktraceLimit;
static int64_t PregRecursionLimit;
static bool EnablePregErrorLog;
// SimpleXML options
static bool SimpleXMLEmptyNamespaceMatchesAll;
// Cookie options
static bool AllowDuplicateCookies;
#ifdef FACEBOOK
// fb303 server
static bool EnableFb303Server;
static int Fb303ServerPort;
static int Fb303ServerThreadStackSizeMb;
static int Fb303ServerWorkerThreads;
static int Fb303ServerPoolThreads;
#endif
// Xenon options
static double XenonPeriodSeconds;
static uint32_t XenonRequestFreq;
static bool XenonForceAlwaysOn;
// Strobelight options
static bool StrobelightEnabled;
static bool SetProfileNullThisObject;
};
static_assert(sizeof(RuntimeOption) == 1, "no instance variables");
using RO = RuntimeOption;
inline bool isJitDeserializing() {
auto const m = RuntimeOption::EvalJitSerdesMode;
return static_cast<std::underlying_type<JitSerdesMode>::type>(m) & 0x2;
}
inline bool isJitSerializing() {
auto const m = RuntimeOption::EvalJitSerdesMode;
return static_cast<std::underlying_type<JitSerdesMode>::type>(m) & 0x1;
}
///////////////////////////////////////////////////////////////////////////////
}
#endif // incl_HPHP_RUNTIME_OPTION_H_