hphp/hhbbc/debug.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 #ifndef incl_HHBBC_DEBUG_H_
  17 #define incl_HHBBC_DEBUG_H_
  18
  19 #include "hphp/util/trace.h"
  20
  21 #include "hphp/hhbbc/misc.h"
  22 #include "hphp/hhbbc/representation.h"
  23 #include "hphp/hhbbc/unit-util.h"
  24
  25 namespace HPHP { namespace HHBBC {
  26
  27 //////////////////////////////////////////////////////////////////////
  28
  29 /*
  30  * If the hhbbc_dump trace module is on, dump the entire program to a
  31  * temporary directory as readable text.
  32  */
  33 void debug_dump_program(const Index&, const php::Program&);
  34 std::string debug_dump_to();
  35 void dump_representation(const std::string& dir, const php::Unit*);
  36 void dump_index(const std::string&, const Index&, const php::Unit*);
  37
  38 /*
  39  * Utilities for printing the state of the program after various
  40  * transformations.
  41  */
  42
  43 inline void banner(const char* what) {
  44   TRACE_SET_MOD(hhbbc);
  45   FTRACE(2, "{:-^70}\n", what);
  46 }
  47
  48 inline void state_after(const char* when, const php::Unit& u) {
  49   TRACE_SET_MOD(hhbbc);
  50   Trace::Bump bumper{Trace::hhbbc, kSystemLibBump, is_systemlib_part(u)};
  51   FTRACE(4, "{:-^70}\n{}{:-^70}\n", when, show(u), "");
  52 }
  53
  54 inline void state_after(const char* when, const php::Program& program) {
  55   TRACE_SET_MOD(hhbbc);
  56   banner(when);
  57   for (auto& u : program.units) {
  58     Trace::Bump bumper{Trace::hhbbc, kSystemLibBump, is_systemlib_part(*u)};
  59     FTRACE(4, "{}", show(*u));
  60   }
  61   banner("");
  62 }
  63
  64 //////////////////////////////////////////////////////////////////////
  65
  66 }}
  67
  68 #endif