Mike Magruder
76db66ec82
Add a lot of comments to the debugger based on my current understanding of it. These may change in the future as we learn more, but they're helpful right now. Also moved a few small things around in the code to clarify their purpose or scope. I.e., making a few things private, renaming a few functions, etc. No real logic changes, though. Also minor dead code removal. Also a few lint errors.
136 linhas
5.0 KiB
C++
136 linhas
5.0 KiB
C++
/*
|
|
+----------------------------------------------------------------------+
|
|
| HipHop for PHP |
|
|
+----------------------------------------------------------------------+
|
|
| Copyright (c) 2010- 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_EVAL_DEBUGGER_COMMAND_H_
|
|
#define incl_HPHP_EVAL_DEBUGGER_COMMAND_H_
|
|
|
|
#include <util/base.h>
|
|
#include <runtime/eval/debugger/debugger_thrift_buffer.h>
|
|
#include <runtime/eval/debugger/debugger_client.h>
|
|
|
|
namespace HPHP { namespace Eval {
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
// DebuggerCommand is the base of all commands executed by the debugger. It
|
|
// also represents the base binary communication format between DebuggerProxy
|
|
// and DebuggerClient.
|
|
//
|
|
// Each command has serialization logic, plus client- and server-side logic.
|
|
// Client-side logic is implemented in the onClient* methods, while server-side
|
|
// is in the onServer* methods.
|
|
//
|
|
|
|
DECLARE_BOOST_TYPES(DebuggerCommand);
|
|
class DebuggerCommand {
|
|
public:
|
|
/**
|
|
* Warning: Do NOT modify exists values, as they are used in binary network
|
|
* protocol, and changing them may create incompatibility between different
|
|
* versions of debugger and server!
|
|
*/
|
|
enum Type {
|
|
// Now I sing my A, B, C...
|
|
KindOfAbort = 1,
|
|
KindOfBreak = 2,
|
|
KindOfContinue = 3,
|
|
KindOfDown = 4,
|
|
KindOfException = 5,
|
|
KindOfFrame = 6,
|
|
KindOfGlobal = 7,
|
|
KindOfHelp = 8,
|
|
KindOfInfo = 9,
|
|
KindOfJump = 10,
|
|
KindOfConstant = 11,
|
|
KindOfList = 12,
|
|
KindOfMachine = 13,
|
|
KindOfNext = 14,
|
|
KindOfOut = 15,
|
|
KindOfPrint = 16,
|
|
KindOfQuit = 17,
|
|
KindOfRun = 18,
|
|
KindOfStep = 19,
|
|
KindOfThread = 20,
|
|
KindOfUp = 21,
|
|
KindOfVariable = 22,
|
|
KindOfWhere = 23,
|
|
KindOfExtended = 24,
|
|
KindOfUser = 25,
|
|
KindOfZend = 26,
|
|
KindOfComplete = 27,
|
|
|
|
KindOfEval = 1000,
|
|
KindOfShell = 1001,
|
|
KindOfMacro = 1002,
|
|
KindOfConfig = 1003,
|
|
KindOfInstrument = 1004,
|
|
|
|
// DebuggerProxy -> DebuggerClient
|
|
KindOfInterrupt = 10000,
|
|
KindOfSignal = 10001,
|
|
};
|
|
|
|
static bool Receive(DebuggerThriftBuffer &thrift, DebuggerCommandPtr &cmd,
|
|
const char *caller);
|
|
|
|
public:
|
|
explicit DebuggerCommand(Type type)
|
|
: m_type(type), m_version(0), m_exitInterrupt(false),
|
|
m_incomplete(false) {}
|
|
|
|
bool is(Type type) const { return m_type == type;}
|
|
Type getType() const { return m_type;}
|
|
|
|
bool send(DebuggerThriftBuffer &thrift);
|
|
bool recv(DebuggerThriftBuffer &thrift);
|
|
|
|
virtual void list(DebuggerClient *client);
|
|
virtual bool help(DebuggerClient *client);
|
|
virtual bool onClient(DebuggerClient *client);
|
|
virtual bool onClientVM(DebuggerClient *client) { return onClient(client); }
|
|
virtual void setClientOutput(DebuggerClient *client);
|
|
bool onClientD(DebuggerClient *client);
|
|
virtual bool onServer(DebuggerProxy *proxy);
|
|
virtual bool onServerVM(DebuggerProxy *proxy) { return onServer(proxy); }
|
|
bool onServerD(DebuggerProxy *proxy) {
|
|
return onServerVM(proxy);
|
|
}
|
|
virtual void sendImpl(DebuggerThriftBuffer &thrift);
|
|
virtual void recvImpl(DebuggerThriftBuffer &thrift);
|
|
|
|
virtual void handleReply(DebuggerClient *client) { assert(false); }
|
|
|
|
/**
|
|
* A server command processing can set m_exitInterrupt to true to break
|
|
* message loop in DebuggerProxy::processInterrupt().
|
|
*/
|
|
virtual bool shouldExitInterrupt() { return m_exitInterrupt;}
|
|
String getWireError() const { return m_wireError; }
|
|
|
|
protected:
|
|
Type m_type;
|
|
std::string m_class; // for CmdExtended
|
|
std::string m_body;
|
|
int m_version;
|
|
|
|
bool m_exitInterrupt; // server side breaking out of message loop
|
|
String m_wireError; // used to save temporary error happened on the wire
|
|
bool m_incomplete; // another interrupt comes before the command could finish
|
|
};
|
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
}}
|
|
|
|
#endif // incl_HPHP_EVAL_DEBUGGER_COMMAND_H_
|