hphp/runtime/vm/repo-global-data.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | HipHop for PHP                                                       |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 2010-2013 Facebook, Inc. (http://www.facebook.com)     |
   6    +----------------------------------------------------------------------+
   7    | This source file is subject to version 3.01 of the PHP license,      |
   8    | that is bundled with this package in the file LICENSE, and is        |
   9    | available through the world-wide-web at the following url:           |
  10    | http://www.php.net/license/3_01.txt                                  |
  11    | If you did not receive a copy of the PHP license and are unable to   |
  12    | obtain it through the world-wide-web, please send a note to          |
  13    | license@php.net so we can mail you a copy immediately.               |
  14    +----------------------------------------------------------------------+
  15 */
  16 #ifndef incl_HPHP_REPO_GLOBAL_DATA_H_
  17 #define incl_HPHP_REPO_GLOBAL_DATA_H_
  18
  19 #include "hphp/runtime/vm/repo.h"
  20 #include "hphp/runtime/base/repo-auth-type-array.h"
  21
  22 namespace HPHP {
  23
  24 //////////////////////////////////////////////////////////////////////
  25
  26 /*
  27  * Global repo metadata.
  28  *
  29  * Only used in RepoAuthoritative mode.  See loadGlobalData().
  30  */
  31 struct Repo::GlobalData {
  32   GlobalData() {}
  33
  34   /*
  35    * Indicates whether a repo was compiled using HHBBC.
  36    */
  37   bool UsedHHBBC = false;
  38
  39   /*
  40    * Was the repo compiled with EnableHipHopSyntax.
  41    */
  42   bool EnableHipHopSyntax = false;
  43
  44   /*
  45    * Copy of InitialNamedEntityTableSize for hhbbc to use.
  46    */
  47   uint32_t InitialNamedEntityTableSize = 0;
  48
  49   /*
  50    * Copy of InitialStaticStringTableSize for hhbbc to use.
  51    */
  52   uint32_t InitialStaticStringTableSize = 0;
  53
  54   /*
  55    * Indicates whether a repo was compiled with HardTypeHints.
  56    *
  57    * If so, we disallow recovering from the E_RECOVERABLE_ERROR we
  58    * raise if you violate a parameter typehint, because doing so
  59    * would allow violating assumptions from the optimizer.
  60    */
  61   bool HardTypeHints = false;
  62
  63   /*
  64    * Indicates whether a repo was compiled with HardReturnTypeHints.
  65    *
  66    * If so, we disallow recovering from the E_RECOVERABLE_ERROR we
  67    * raise if you violate a return typehint, because doing so would
  68    * allow violating assumptions from the optimizer.
  69    */
  70   bool HardReturnTypeHints = false;
  71
  72   /*
  73    * Indicates whether a repo was compiled assumming that `this` types will be
  74    * verified by Verify*Type instructions at runtime.
  75    *
  76    * This changes program behavior because this type hints that are checked
  77    * at runtime will enable additional HHBBC optimizations.
  78    */
  79   int32_t ThisTypeHintLevel = 0;
  80
  81   /*
  82    * Indicates whether a repo was compiled with HardPrivatePropInference.
  83    */
  84   bool HardPrivatePropInference = false;
  85
  86   /*
  87    * Indicates whether the repo was compiled with DisallowDynamicVarEnvFuncs. If
  88    * so, we assume that '$f()' doesn't read or write over locals (that
  89    * haven't been passed).
  90    */
  91   HackStrictOption DisallowDynamicVarEnvFuncs = HackStrictOption::OFF;
  92
  93   /*
  94    * Indicates whether the repo was compiled with ElideAutoloadInvokes. If so,
  95    * potential invocations of the autoloader may have been optimized away if it
  96    * could be proven the invocation would not find a viable function.
  97    */
  98   bool ElideAutoloadInvokes = true;
  99
 100   /*
 101    * Indicates whether the repo was compiled with PHP7 integer semantics. This
 102    * slightly changes the way certain arithmetic operations are evaluated, in
 103    * small enough ways that don't warrant new bytecodes, but in ways that do
 104    * affect everything from hphpc's constant folding up through the JIT, and
 105    * so need to be kept consistent.
 106    */
 107   bool PHP7_IntSemantics = false;
 108
 109   /*
 110    * Indicates whether hex strings (e.g. "0x20") can be used for numeric
 111    * operations, e.g. ("0x20" + 1)
 112    */
 113   bool PHP7_NoHexNumerics = false;
 114
 115   /*
 116    * Indicates whether the repo was compiled with PHP7 scalar type hint support.
 117    * In this mode non hh units will default to weak types and scalar types will
 118    * be available outside the HH namespace.
 119    */
 120   bool PHP7_ScalarTypes = false;
 121
 122   /*
 123    * Indicates whether the repo was compiled with PHP7 builtins enabled.
 124    */
 125   bool PHP7_Builtins = false;
 126
 127   /*
 128    * Indicates whether the repo was compiled with PHP7 substr behavior which
 129    * returns an empty string if the stringi length is equal to start characters
 130    * long, instead of PHP5's false.
 131    */
 132   bool PHP7_Substr = false;
 133
 134   /*
 135    * Indicates that generators should be autoprimed and not require an initial
 136    * call to next() before calling other generator functions.
 137    */
 138   bool AutoprimeGenerators = true;
 139
 140   /*
 141    * Should emptyish in lval context be promoted to a stdclass object?
 142    */
 143   bool PromoteEmptyObject = true;
 144
 145   /*
 146    * Disable return by reference in PHP
 147    */
 148   bool DisableReturnByReference = true;
 149
 150   /*
 151    * Should all functions be interceptable?
 152    */
 153   bool EnableRenameFunction = false;
 154
 155   /*
 156    * Are Hack array compatibility notices enabled? If so, certain optimizations
 157    * may be disabled.
 158    */
 159   bool HackArrCompatNotices = false;
 160   bool HackArrCompatIsArrayNotices = false;
 161   bool HackArrCompatPromoteNotices = false;
 162   bool HackArrCompatTypeHintNotices = false;
 163   bool HackArrCompatDVCmpNotices = false;
 164   bool HackArrCompatSerializeNotices = false;
 165
 166   /*
 167    * Are d/varrays dicts and vecs?
 168    */
 169   bool HackArrDVArrs = false;
 170
 171   /*
 172    * Should the extension containing HHVM intrinsics be enabled?
 173    */
 174   bool EnableIntrinsicsExtension = false;
 175
 176   /*
 177    * Should the runtime emit notices or throw whenever a function is called
 178    * dynamically and that function has not been marked as allowing that?
 179    */
 180   int32_t ForbidDynamicCalls = 0;
 181
 182   /*
 183    * Should the runtime emit notices whenever a builtin is called dynamically?
 184    */
 185   bool NoticeOnBuiltinDynamicCalls = false;
 186
 187   /*
 188    * Should we enforce that reffiness annotations are invaraint in overridden
 189    * methods?
 190    */
 191   bool ReffinessInvariance = false;
 192
 193   /*
 194    * Are objects allowed to run destructors?
 195    */
 196   bool AllowObjectDestructors = false;
 197
 198   /*
 199    * A more-or-less unique identifier for the repo
 200    */
 201   uint64_t Signature = 0;
 202
 203   std::vector<const StringData*> APCProfile;
 204
 205   std::vector<std::pair<std::string,Cell>> ConstantFunctions;
 206
 207   template<class SerDe> void serde(SerDe& sd) {
 208     sd(UsedHHBBC)
 209       (EnableHipHopSyntax)
 210       (InitialNamedEntityTableSize)
 211       (InitialStaticStringTableSize)
 212       (HardTypeHints)
 213       (ThisTypeHintLevel)
 214       (HardReturnTypeHints)
 215       (HardPrivatePropInference)
 216       (DisallowDynamicVarEnvFuncs)
 217       (ElideAutoloadInvokes)
 218       (PHP7_IntSemantics)
 219       (PHP7_NoHexNumerics)
 220       (PHP7_ScalarTypes)
 221       (PHP7_Substr)
 222       (PHP7_Builtins)
 223       (AutoprimeGenerators)
 224       (PromoteEmptyObject)
 225       (EnableRenameFunction)
 226       (HackArrCompatNotices)
 227       (HackArrCompatIsArrayNotices)
 228       (HackArrCompatPromoteNotices)
 229       (HackArrCompatTypeHintNotices)
 230       (HackArrCompatDVCmpNotices)
 231       (HackArrCompatSerializeNotices)
 232       (HackArrDVArrs)
 233       (EnableIntrinsicsExtension)
 234       (ReffinessInvariance)
 235       (ForbidDynamicCalls)
 236       (NoticeOnBuiltinDynamicCalls)
 237       (AllowObjectDestructors)
 238       (Signature)
 239       (DisableReturnByReference)
 240       ;
 241   }
 242 };
 243
 244 //////////////////////////////////////////////////////////////////////
 245
 246 }
 247
 248
 249 #endif