Arquivos
hhvm/hphp/runtime/eval/debugger/cmd/cmd_flow_control.h
T
Paul Tarjan fef62f03a2 kill VM namespace
Now that HHVM is the default runtime, this namespace doesn't mean anything.
2013-05-15 13:05:05 -07:00

96 linhas
3.9 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_CMD_FLOW_CONTROL_H_
#define incl_HPHP_EVAL_DEBUGGER_CMD_FLOW_CONTROL_H_
#include <runtime/eval/debugger/debugger_command.h>
#include <runtime/eval/debugger/cmd/cmd_interrupt.h>
namespace HPHP { namespace Eval {
///////////////////////////////////////////////////////////////////////////////
// CmdFlowControl is the base class of all "flow control" cmds: Continue, Step,
// Next, and Out. A DebuggerProxy can execute exactly one of these cmds at a
// time.
//
// 1. Proxy receives a flow command (say, Next).
// 2. Proxy calls the cmd's onSetup() with current source position.
// 3. Cmd sets up state in the VM to control stepping, etc.
// 4. If the cmd is complete the proxy deletes the cmd, otherwise it saves it
// in m_flow.
// 5. Proxy lets the thread continue execution.
// 6. Proxy receives an interrupt from the VM, delivers it to the cmd in m_flow.
// 7. Cmd inspects the site and VM state, and either decides it is done, or
// sets up state in the VM to continue the control flow operation.
// 8. If the cmd is complete the proxy stops and waits for more input from the
// client. Otherwise, rinse and repeat at step 5.
DECLARE_BOOST_TYPES(CmdFlowControl);
class CmdFlowControl : public DebuggerCommand {
public:
explicit CmdFlowControl(Type type)
: DebuggerCommand(type), m_complete(false), m_needsVMInterrupt(false),
m_stackDepth(0), m_vmDepth(0), m_stepOutOffset(0), m_stepOutUnit(nullptr),
m_count(1) { }
virtual ~CmdFlowControl();
virtual bool onClient(DebuggerClient *client);
virtual bool onServer(DebuggerProxy *proxy);
// Work done to setup a new flow command, after receiving it from the client.
virtual void onSetup(DebuggerProxy *proxy, CmdInterrupt &interrupt);
// Work done when a VM thread interrupts the proxy.
virtual void onBeginInterrupt(DebuggerProxy *proxy,
CmdInterrupt &interrupt) = 0;
// A completed flow cmd has done all its work and can be deleted.
bool complete() { return m_complete; }
// Does this cmd need to force interrupts in the interpreter loop?
bool needsVMInterrupt() { return m_needsVMInterrupt; }
protected:
virtual void sendImpl(DebuggerThriftBuffer &thrift);
virtual void recvImpl(DebuggerThriftBuffer &thrift);
int decCount() { assert(m_count > 0); return --m_count;}
int getCount() const { assert(m_count > 0); return m_count;}
void installLocationFilterForLine(InterruptSite *site);
void removeLocationFilter();
void setupStepOut();
void cleanupStepOut();
bool m_complete;
bool m_needsVMInterrupt;
// Support for stepping operations
int m_stackDepth;
int m_vmDepth;
std::string m_loc; // last break's source location
Offset m_stepOutOffset;
HPHP::Unit *m_stepOutUnit;
private:
int16_t m_count;
bool m_smallStep;
};
///////////////////////////////////////////////////////////////////////////////
}}
#endif // incl_HPHP_EVAL_DEBUGGER_CMD_FLOW_CONTROL_H_