hphp/runtime/base/program-functions.h

   1 /*
   2    +----------------------------------------------------------------------+
   3    | HipHop for PHP                                                       |
   4    +----------------------------------------------------------------------+
   5    | Copyright (c) 2010-present 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
  17 #ifndef incl_HPHP_PROGRAM_FUNCTIONS_H_
  18 #define incl_HPHP_PROGRAM_FUNCTIONS_H_
  19
  20 #include "hphp/runtime/base/types.h"
  21 #include <boost/program_options/parsers.hpp>
  22
  23 // Needed for compatibility with oniguruma-5.9.4+
  24 #define ONIG_ESCAPE_UCHAR_COLLISION
  25
  26 namespace HPHP {
  27 ///////////////////////////////////////////////////////////////////////////////
  28
  29 struct Transport;
  30
  31 #if defined(__APPLE__) || defined(_MSC_VER)
  32 extern const void* __hot_start;
  33 extern const void* __hot_end;
  34 #else
  35 extern "C" {
  36 void __attribute__((__weak__)) __hot_start();
  37 void __attribute__((__weak__)) __hot_end();
  38 }
  39 #endif
  40
  41 /**
  42  * Main entry point of the entire program.
  43  */
  44 int execute_program(int argc, char **argv);
  45 void execute_command_line_begin(int argc, char **argv, int xhprof);
  46 void execute_command_line_end(int xhprof, bool coverage, const char *program);
  47
  48 void init_command_line_session(int arc, char** argv);
  49 void
  50 init_command_line_globals(int argc, char** argv, char** envp,
  51                           int xhprof,
  52                           std::map<std::string, std::string>& serverVariables,
  53                           std::map<std::string, std::string>& envVariables);
  54 /**
  55  * Setting up environment variables.
  56  */
  57 void process_env_variables(Array& variables);
  58
  59 /**
  60  * Inserting a variable into specified symbol table.
  61  *
  62  * "overwrite" parameter is only for cookies:
  63  * According to rfc2965, more specific paths are listed above the less
  64  * specific ones. If we encounter a duplicate cookie name, we should
  65  * skip it, since it is not possible to have the same (plain text)
  66  * cookie name for the same path and we should not overwrite more
  67  * specific cookies with the less specific ones.
  68  */
  69 void register_variable(Array& variables,
  70                        char* name,
  71                        const Variant& value,
  72                        bool overwrite = true);
  73
  74 String canonicalize_path(const String& path, const char* root, int rootLen);
  75
  76 /**
  77  * Translate hex encode stack into both C++ and PHP frames.
  78  */
  79 std::string translate_stack(const char *hexencoded,
  80                             bool with_frame_numbers = true);
  81
  82 time_t start_time();
  83
  84 // Boost 1.54 has a bug where it doesn't handle options with - in them as
  85 // it only gives us the string after the last -
  86 // https://github.com/facebook/hhvm/issues/2864
  87 // This won't fix the problem in 100% of cases (e.g. two options are
  88 // used that both end in the same substring. How do you choose?) But
  89 // that should be very rare.
  90 #if defined(BOOST_VERSION) && BOOST_VERSION <= 105400
  91 std::string get_right_option_name(
  92   const boost::program_options::basic_parsed_options<char>& opts,
  93   std::string& wrong_name);
  94 #endif
  95
  96 ///////////////////////////////////////////////////////////////////////////////
  97
  98 struct ExecutionContext;
  99
 100 void hphp_process_init();
 101 void hphp_session_init();
 102
 103 bool hphp_invoke_simple(const std::string& filename, bool warmupOnly);
 104 bool hphp_invoke(ExecutionContext *context,
 105                  const std::string &cmd,
 106                  bool func,
 107                  const Array& funcParams,
 108                  VRefParam funcRet,
 109                  const std::string &reqInitFunc,
 110                  const std::string &reqInitDoc,
 111                  bool &error,
 112                  std::string &errorMsg,
 113                  bool once,
 114                  bool warmupOnly,
 115                  bool richErrorMsg,
 116                  const std::string& prelude);
 117 void hphp_context_shutdown();
 118 void hphp_context_exit(bool shutdown = true);
 119
 120 void hphp_thread_init();
 121 void hphp_thread_exit();
 122
 123 void hphp_memory_cleanup();
 124 /*
 125  * Tear down various internal state at the very end of a session. If transport
 126  * is provided, various statistics about resources consumed by the request will
 127  * be logged to ServiceData.
 128  */
 129 void hphp_session_exit(const Transport* transport = nullptr);
 130 void hphp_process_exit() noexcept;
 131 bool is_hphp_session_initialized();
 132 std::string get_systemlib(std::string* hhas = nullptr,
 133                           const std::string &section = "systemlib",
 134                           const std::string &filename = "");
 135
 136 // Helper function for stats tracking with exceptions.
 137 void bump_counter_and_rethrow(bool isPsp);
 138
 139 ///////////////////////////////////////////////////////////////////////////////
 140 }
 141
 142 #endif // incl_HPHP_PROGRAM_FUNCTIONS_H_