Mike Magruder
22f8788e2f
Cleanup a lot of hangs with either the debugger client or server in a variety of error conditions, mostly related to communication errors or the client or server exiting unexpectedly. One of the biggest fixes is that all cases where the client was left in a state where Ctrl-C wouldn't work have been fixed. Remove lots of little snippets of dead code. If you see a function (or small set of functions/fields) deleted then it was actually dead. I debated whether to keep throwing DebuggerClientExitException on the server, and I decided to keep it. I think it's reasonable that if you've got the server stopped and you quit the debugger that the request gets terminated rather than continuing to run. I also considered a big change to the way Ctrl-C works, but ended up staying with what was there with just a bit of cleanup. We need to guard against people banging on Ctrl-C, which is a reasonable behavior, and I think it feels pretty reasonable with the updated message. Finally, added many comments about how this stuff works.
141 linhas
5.3 KiB
C++
141 linhas
5.3 KiB
C++
/*
|
|
+----------------------------------------------------------------------+
|
|
| HipHop for PHP |
|
|
+----------------------------------------------------------------------+
|
|
| Copyright (c) 2010-2013 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 "hphp/util/base.h"
|
|
#include "hphp/runtime/debugger/debugger_thrift_buffer.h"
|
|
#include "hphp/runtime/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_UNUSED = 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,
|
|
|
|
// Internal testing only
|
|
KindOfInternalTesting = 20000, // The real test command
|
|
KindOfInternalTestingBad = 20001, // A command type we never recgonize
|
|
};
|
|
|
|
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 void help(DebuggerClient &client);
|
|
void onClient(DebuggerClient &client);
|
|
virtual void setClientOutput(DebuggerClient &client);
|
|
virtual bool onServer(DebuggerProxy &proxy);
|
|
|
|
// This seems to be confined to eval and print commands.
|
|
// It is not clear that it belongs in this interface or that the
|
|
// assert is safe.
|
|
virtual void handleReply(DebuggerClient &client) { assert(false); }
|
|
|
|
// Returns true if DebuggerProxy::processInterrupt() should return
|
|
// to its caller instead of processing further commands from the client.
|
|
bool shouldExitInterrupt() { return m_exitInterrupt;}
|
|
|
|
// Returns a non empty error message if the receipt of this command
|
|
// did not complete successfully.
|
|
String getWireError() const { return m_wireError; }
|
|
|
|
protected:
|
|
// Carries out the command, possibly by sending it to the server.
|
|
virtual void onClientImpl(DebuggerClient &client) = 0;
|
|
|
|
bool displayedHelp(DebuggerClient &client);
|
|
virtual void sendImpl(DebuggerThriftBuffer &thrift);
|
|
virtual void recvImpl(DebuggerThriftBuffer &thrift);
|
|
|
|
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_
|