kdbg/debugger.h

   1 // $Id$
   2
   3 // Copyright by Johannes Sixt
   4 // This file is under GPL, the GNU General Public Licence
   5
   6 #ifndef DEBUGGER_H
   7 #define DEBUGGER_H
   8
   9 #include <qtimer.h>
  10 #include <qdict.h>
  11 #include <qptrvector.h>
  12 #include <qstringlist.h>
  13 #include "envvar.h"
  14 #include "exprwnd.h"                    /* some compilers require this */
  15
  16 #ifdef HAVE_CONFIG_H
  17 #include "config.h"
  18 #endif
  19
  20 class ExprWnd;
  21 class VarTree;
  22 class ProgramTypeTable;
  23 class KTreeViewItem;
  24 class KConfig;
  25 class KConfigBase;
  26 class ProgramConfig;
  27 class QListBox;
  28 class RegisterInfo;
  29 class ThreadInfo;
  30 class DebuggerDriver;
  31 class CmdQueueItem;
  32 class Breakpoint;
  33 struct DisassembledCode;
  34 struct MemoryDump;
  35 struct DbgAddr;
  36 class KProcess;
  37
  38
  39 class KDebugger : public QObject
  40 {
  41     Q_OBJECT
  42 public:
  43     KDebugger(QWidget* parent,          /* will be used as the parent for dialogs */
  44               ExprWnd* localVars,
  45               ExprWnd* watchVars,
  46               QListBox* backtrace);
  47     ~KDebugger();
  48
  49     /**
  50      * This function starts to debug the specified executable using the
  51      * specified driver. If a program is currently being debugged, it is
  52      * terminated first. Ownership of driver is taken if and only if
  53      * true is returned.
  54      *
  55      * @return false if an error occurs.
  56      */
  57     bool debugProgram(const QString& executable,
  58                       DebuggerDriver* driver);
  59
  60     /**
  61      * Uses the specified core to debug the active program.
  62      * @param batch tells whether the core file was given on the
  63      * command line.
  64      */
  65     void useCoreFile(QString corefile, bool batch);
  66
  67     /**
  68      * Attaches to the specified process and debugs it.
  69      */
  70     void attachProgram(const QString& pid);
  71
  72     /**
  73      * Returns the file name of the per-program config file for the
  74      * specified program.
  75      */
  76     static QString getConfigForExe(const QString& exe);
  77
  78     /**
  79      * The driver name entry in the per-program config file.
  80      */
  81     static const char DriverNameEntry[];
  82
  83 public slots:
  84     /**
  85      * Runs the program or continues it if it is stopped at a breakpoint.
  86      */
  87     void programRun();
  88
  89     /**
  90      * Restarts the debuggee.
  91      */
  92     void programRunAgain();
  93
  94     /**
  95      * Performs a single-step, possibly stepping into a function call.
  96      * If byInsn is true, a step by instruction is performed.
  97      */
  98     void programStep();
  99
 100     /**
 101      * Performs a single-step, stepping over a function call.
 102      * If byInsn is true, a step by instruction is performed.
 103      */
 104     void programNext();
 105
 106     /**
 107      * Performs a single-step by instruction, possibly stepping into a
 108      * function call.
 109      */
 110     void programStepi();
 111
 112     /**
 113      * Performs a single-step by instruction, stepping over a function
 114      * call.
 115      */
 116     void programNexti();
 117
 118     /**
 119      * Runs the program until it returns from the current function.
 120      */
 121     void programFinish();
 122
 123     /**
 124      * Kills the program (removes it from memory).
 125      */
 126     void programKill();
 127
 128     /**
 129      * Interrupts the program if it is currently running.
 130      */
 131     void programBreak();
 132
 133     /**
 134      * Moves the program counter to the specified line.
 135      * If an address is given, it is moved to the address.
 136      */
 137     void setProgramCounter(const QString&, int, const DbgAddr&);
 138
 139 public:
 140     /**
 141      * Queries the user for program arguments.
 142      */
 143     void programArgs(QWidget* parent);
 144
 145     /**
 146      * Queries the user for program settings: Debugger command, terminal
 147      * emulator.
 148      */
 149     void programSettings(QWidget* parent);
 150
 151     /**
 152      * Setup remote debugging device
 153      */
 154     void setRemoteDevice(const QString& remoteDevice) { m_remoteDevice = remoteDevice; }
 155
 156     /**
 157      * Run the debuggee until the specified line in the specified file is
 158      * reached.
 159      *
 160      * @return false if the command was not executed, e.g. because the
 161      * debuggee is running at the moment.
 162      */
 163     bool runUntil(const QString& fileName, int lineNo);
 164
 165     /**
 166      * Set a breakpoint.
 167      *
 168      * @param fileName The source file in which to set the breakpoint.
 169      * @param lineNo The zero-based line number.
 170      * @param address The exact address of the breakpoint.
 171      * @param temporary Specifies whether this is a temporary breakpoint
 172      * @return false if the command was not executed, e.g. because the
 173      * debuggee is running at the moment.
 174      */
 175     bool setBreakpoint(QString fileName, int lineNo,
 176                        const DbgAddr& address, bool temporary);
 177
 178     /**
 179      * Set a breakpoint.
 180      *
 181      * @param bp Describes the breakpoint.
 182      * @param queueOnly If false, the breakpoint is set using a high-priority command.
 183      */
 184     void setBreakpoint(Breakpoint* bp, bool queueOnly);
 185
 186     /**
 187      * Enable or disable a breakpoint at the specified location.
 188      *
 189      * @param fileName The source file in which the breakpoint is.
 190      * @param lineNo The zero-based line number.
 191      * @param address The exact address of the breakpoint.
 192      * @return false if the command was not executed, e.g. because the
 193      * debuggee is running at the moment.
 194      */
 195     bool enableDisableBreakpoint(QString fileName, int lineNo,
 196                                  const DbgAddr& address);
 197
 198     /**
 199      * Enables or disables the specified breakpoint.
 200      *
 201      * @return false if the command was not executed, e.g. because the
 202      * debuggee is running at the moment.
 203      */
 204     bool enableDisableBreakpoint(Breakpoint* bp);
 205
 206     /**
 207      * Removes the specified breakpoint. Note that if bp is an orphaned
 208      * breakpoint, then bp is an invalid pointer if (and only if) this
 209      * function returns true.
 210      *
 211      * @return false if the command was not executed, e.g. because the
 212      * debuggee is running at the moment.
 213      */
 214     bool deleteBreakpoint(Breakpoint* bp);
 215
 216     /**
 217      * Changes the specified breakpoint's condition and ignore count.
 218      *
 219      * @return false if the command was not executed, e.g. because the
 220      * debuggee is running at the moment.
 221      */
 222     bool conditionalBreakpoint(Breakpoint* bp,
 223                                const QString& condition,
 224                                int ignoreCount);
 225
 226     /**
 227      * Tells whether one of the single stepping commands can be invoked
 228      * (step, next, finish, until, also run).
 229      */
 230     bool canSingleStep();
 231
 232     /**
 233      * Tells whether a breakpoints can be set, deleted, enabled, or disabled.
 234      */
 235     bool canChangeBreakpoints();
 236
 237     /**
 238      * Tells whether the debuggee can be changed.
 239      */
 240     bool canUseCoreFile() { return isReady() && !m_programActive; }
 241
 242     /**
 243      * Add a watch expression.
 244      */
 245     void addWatch(const QString& expr);
 246
 247     /**
 248      * Retrieves the current status message.
 249      */
 250     const QString& statusMessage() const { return m_statusMessage; }
 251
 252     /**
 253      * Is the debugger ready to receive another high-priority command?
 254      */
 255     bool isReady() const;
 256
 257     /**
 258      * Is the debuggee running (not just active)?
 259      */
 260     bool isProgramRunning() { return m_haveExecutable && m_programRunning; }
 261
 262     /**
 263      * Do we have an executable set?
 264      */
 265     bool haveExecutable() { return m_haveExecutable; }
 266
 267     /**
 268      * Is the debuggee active, i.e. was it started by the debugger?
 269      */
 270     bool isProgramActive() { return m_programActive; }
 271
 272     /**
 273      * Is the debugger driver idle?
 274      */
 275     bool isIdle() const;
 276
 277     /** The list of breakpoints. */
 278     int numBreakpoints() const { return m_brkpts.size(); }
 279     const Breakpoint* breakpoint(int i) const { return m_brkpts[i]; }
 280
 281     /**
 282      * Returns the breakpoint with the specified \a id.
 283      */
 284     Breakpoint* breakpointById(int id);
 285
 286     const QString& executable() const { return m_executable; }
 287
 288     /**
 289      * Terminal emulation level.
 290      */
 291     enum TTYLevel {
 292         ttyNone = 0,                    /* ignore output, input triggers EOF */
 293         ttySimpleOutputOnly = 1,        /* minmal output emulation, input triggers EOF */
 294         ttyFull = 7                     /* program needs full emulation */
 295     };
 296
 297     /**
 298      * Returns the level of terminal emulation requested by the inferior.
 299      */
 300     TTYLevel ttyLevel() const { return m_ttyLevel; }
 301
 302     /** Sets the terminal that is to be used by the debugger. */
 303     void setTerminal(const QString& term) { m_inferiorTerminal = term; }
 304
 305     /** Returns the debugger driver. */
 306     DebuggerDriver* driver() { return m_d; }
 307
 308     /** Returns the pid that the debugger is currently attached to. */
 309     const QString& attachedPid() const { return m_attachedPid; }
 310
 311     /**
 312      * The memory at that the expression evaluates to is watched. Can be
 313      * empty. Triggers a redisplay even if the expression did not change.
 314      */
 315     void setMemoryExpression(const QString& memexpr);
 316
 317     /**
 318      * Sets how the watched memory location is displayed.
 319      * Call setMemoryExpression() to force a redisplay.
 320      */
 321     void setMemoryFormat(unsigned format) { m_memoryFormat = format; }
 322
 323     // settings
 324     void saveSettings(KConfig*);
 325     void restoreSettings(KConfig*);
 326
 327 protected:
 328     QString m_inferiorTerminal;
 329     QString m_debuggerCmd;              /* per-program setting */
 330     TTYLevel m_ttyLevel;                /* level of terminal emulation */
 331     bool startDriver();
 332     void stopDriver();
 333     void writeCommand();
 334
 335     QList<VarTree> m_watchEvalExpr;     /* exprs to evaluate for watch windows */
 336     QPtrVector<Breakpoint> m_brkpts;
 337     QString m_memoryExpression;         /* memory location to watch */
 338     unsigned m_memoryFormat;            /* how that output should look */
 339
 340 protected slots:
 341     void parse(CmdQueueItem* cmd, const char* output);
 342 protected:
 343     VarTree* parseExpr(const char* output, bool wantErrorValue);
 344     void handleRunCommands(const char* output);
 345     void updateAllExprs();
 346     void updateProgEnvironment(const QString& args, const QString& wd,
 347                                const QDict<EnvVar>& newVars,
 348                                const QStringList& newOptions);
 349     void parseLocals(const char* output, QList<VarTree>& newVars);
 350     void handleLocals(const char* output);
 351     bool handlePrint(CmdQueueItem* cmd, const char* output);
 352     void handleBacktrace(const char* output);
 353     void handleFrameChange(const char* output);
 354     void handleFindType(CmdQueueItem* cmd, const char* output);
 355     void handlePrintStruct(CmdQueueItem* cmd, const char* output);
 356     void handleSharedLibs(const char* output);
 357     void handleRegisters(const char* output);
 358     void handleMemoryDump(const char* output);
 359     void handleInfoLine(CmdQueueItem* cmd, const char* output);
 360     void handleDisassemble(CmdQueueItem* cmd, const char* output);
 361     void handleThreadList(const char* output);
 362     void handleSetPC(const char* output);
 363     void evalExpressions();
 364     void evalInitialStructExpression(VarTree* var, ExprWnd* wnd, bool immediate);
 365     void evalStructExpression(VarTree* var, ExprWnd* wnd, bool immediate);
 366     void exprExpandingHelper(ExprWnd* wnd, KTreeViewItem* item, bool& allow);
 367     void dereferencePointer(ExprWnd* wnd, VarTree* var, bool immediate);
 368     void determineType(ExprWnd* wnd, VarTree* var);
 369     void removeExpr(ExprWnd* wnd, VarTree* var);
 370     void queueMemoryDump(bool immediate);
 371     CmdQueueItem* loadCoreFile();
 372     void openProgramConfig(const QString& name);
 373
 374     Breakpoint* breakpointByFilePos(QString file, int lineNo,
 375                                     const DbgAddr& address);
 376     void newBreakpoint(CmdQueueItem* cmd, const char* output);
 377     void updateBreakList(const char* output);
 378     bool stopMayChangeBreakList() const;
 379     void saveBreakpoints(ProgramConfig* config);
 380     void restoreBreakpoints(ProgramConfig* config);
 381
 382     bool m_haveExecutable;              /* has an executable been specified */
 383     bool m_programActive;               /* is the program active (possibly halting in a brkpt)? */
 384     bool m_programRunning;              /* is the program executing (not stopped)? */
 385     bool m_sharedLibsListed;            /* do we know the shared libraries loaded by the prog? */
 386     QString m_executable;
 387     QString m_corefile;
 388     QString m_attachedPid;              /* user input of attaching to pid */
 389     QString m_programArgs;
 390     QString m_remoteDevice;
 391     QString m_programWD;                /* working directory of gdb */
 392     QDict<EnvVar> m_envVars;            /* environment variables set by user */
 393     QStringList m_boolOptions;          /* boolean options */
 394     QStrList m_sharedLibs;              /* shared libraries used by program */
 395     ProgramTypeTable* m_typeTable;      /* known types used by the program */
 396     ProgramConfig* m_programConfig;     /* program-specific settings (brkpts etc) */
 397     void saveProgramSettings();
 398     void restoreProgramSettings();
 399     QString readDebuggerCmd();
 400
 401     // debugger process
 402     DebuggerDriver* m_d;
 403     bool m_explicitKill;                /* whether we are killing gdb ourselves */
 404
 405     QString m_statusMessage;
 406
 407 protected slots:
 408     void gdbExited(KProcess*);
 409     void slotInferiorRunning();
 410     void backgroundUpdate();
 411     void gotoFrame(int);
 412     void slotLocalsExpanding(KTreeViewItem*, bool&);
 413     void slotWatchExpanding(KTreeViewItem*, bool&);
 414     void slotUpdateAnimation();
 415     void slotDeleteWatch();
 416     void slotValuePopup(const QString&);
 417     void slotDisassemble(const QString&, int);
 418 public slots:
 419     void setThread(int);
 420     void shutdown();
 421
 422 signals:
 423     /**
 424      * This signal is emitted before the debugger is started. The slot is
 425      * supposed to set up m_inferiorTerminal.
 426      */
 427     void debuggerStarting();
 428
 429     /**
 430      * This signal is emitted whenever a part of the debugger needs to
 431      * highlight the specfied source code line (e.g. when the program
 432      * stops).
 433      *
 434      * @param file specifies the file; this is not necessarily a full path
 435      * name, and if it is relative, you won't know relative to what, you
 436      * can only guess.
 437      * @param lineNo specifies the line number (0-based!) (this may be
 438      * negative, in which case the file should be activated, but the line
 439      * should NOT be changed).
 440      * @param address specifies the exact address of the PC or is empty.
 441      */
 442     void activateFileLine(const QString& file, int lineNo, const DbgAddr& address);
 443
 444     /**
 445      * This signal indicates that the program counter has changed.
 446      *
 447      * @param filename specifies the filename where the program stopped
 448      * @param lineNo specifies the line number (zero-based); it can be -1
 449      * if it is unknown
 450      * @param address specifies the address that the instruction pointer
 451      * points to.
 452      * @param frameNo specifies the frame number: 0 is the innermost frame,
 453      * positive numbers are frames somewhere up the stack (indicates points
 454      * where a function was called); the latter cases should be indicated
 455      * differently in the source window.
 456      */
 457     void updatePC(const QString& filename, int lineNo,
 458                   const DbgAddr& address, int frameNo);
 459
 460     /**
 461      * This signal is emitted when gdb detects that the executable has been
 462      * updated, e.g. recompiled. (You usually need not handle this signal
 463      * if you are the editor which changed the executable.)
 464      */
 465     void executableUpdated();
 466
 467     /**
 468      * This signal is emitted when the animated icon should advance to the
 469      * next picture.
 470      */
 471     void animationTimeout();
 472
 473     /**
 474      * Indicates that a new status message is available.
 475      */
 476     void updateStatusMessage();
 477
 478     /**
 479      * Indicates that the internal state of the debugger has changed, and
 480      * that this will very likely have an impact on the UI.
 481      */
 482     void updateUI();
 483
 484     /**
 485      * Indicates that the list of breakpoints has possibly changed.
 486      */
 487     void breakpointsChanged();
 488
 489     /**
 490      * Indicates that the register values have possibly changed.
 491      */
 492     void registersChanged(QList<RegisterInfo>&);
 493
 494     /**
 495      * Indicates that the list of threads has possibly changed.
 496      */
 497     void threadsChanged(QList<ThreadInfo>&);
 498
 499     /**
 500      * Indicates that the value for a value popup is ready.
 501      */
 502     void valuePopup(const QString&);
 503
 504     /**
 505      * Provides the disassembled code of the location given by file and
 506      * line number (zero-based).
 507      */
 508     void disassembled(const QString& file, int line, const QList<DisassembledCode>& code);
 509
 510     /**
 511      * Indicates that the program has stopped for any reason: by a
 512      * breakpoint, by a signal that the debugger driver caught, by a single
 513      * step instruction.
 514      */
 515     void programStopped();
 516
 517     /**
 518      * Indicates that a new memory dump output is ready.
 519      * @param msg is an error message or empty
 520      * @param memdump is the memory dump
 521      */
 522     void memoryDumpChanged(const QString&, QList<MemoryDump>&);
 523
 524     /**
 525      * Gives other objects a chance to save program specific settings.
 526      */
 527     void saveProgramSpecific(KConfigBase* config);
 528
 529     /**
 530      * Gives other objects a chance to restore program specific settings.
 531      */
 532     void restoreProgramSpecific(KConfigBase* config);
 533
 534 protected:
 535     ExprWnd& m_localVariables;
 536     ExprWnd& m_watchVariables;
 537     QListBox& m_btWindow;
 538
 539     // animation
 540     QTimer m_animationTimer;
 541     int m_animationInterval;
 542
 543     // implementation helpers
 544 protected:
 545     void startAnimation(bool fast);
 546     void stopAnimation();
 547
 548     QWidget* parentWidget() { return static_cast<QWidget*>(parent()); }
 549
 550     friend class BreakpointTable;
 551 };
 552
 553 #endif // DEBUGGER_H