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