kdbg/dbgdriver.h

   1 /*
   2  * Copyright Johannes Sixt
   3  * This file is licensed under the GNU General Public License Version 2.
   4  * See the file COPYING in the toplevel directory of the source directory.
   5  */
   6
   7 #ifndef DBGDRIVER_H
   8 #define DBGDRIVER_H
   9
  10 #include <QFile>
  11 #include <QByteArray>
  12 #include <QProcess>
  13 #include <queue>
  14 #include <list>
  15
  16
  17 class VarTree;
  18 class ExprValue;
  19 class ExprWnd;
  20 class KDebugger;
  21 class QStringList;
  22
  23
  24 /**
  25  * A type representing an address.
  26  */
  27 struct DbgAddr
  28 {
  29     QString a;
  30     QString fnoffs;
  31     DbgAddr() { }
  32     DbgAddr(const QString& aa);
  33     DbgAddr(const DbgAddr& src) : a(src.a), fnoffs(src.fnoffs) { }
  34     void operator=(const QString& aa);
  35     void operator=(const DbgAddr& src) { a = src.a; fnoffs = src.fnoffs; }
  36     QString asString() const;
  37     bool isEmpty() const { return a.isEmpty(); }
  38 protected:
  39     void cleanAddr();
  40 };
  41 bool operator==(const DbgAddr& a1, const DbgAddr& a2);
  42 bool operator>(const DbgAddr& a1, const DbgAddr& a2);
  43
  44
  45 enum DbgCommand {
  46         DCinitialize,
  47         DCtty,
  48         DCexecutable,
  49         DCtargetremote,
  50         DCcorefile,
  51         DCattach,
  52         DCinfolinemain,
  53         DCinfolocals,
  54         DCinforegisters,
  55         DCexamine,
  56         DCinfoline,
  57         DCdisassemble,
  58         DCsetargs,
  59         DCsetenv,
  60         DCunsetenv,
  61         DCsetoption,                    /* debugger options */
  62         DCcd,
  63         DCbt,
  64         DCrun,
  65         DCcont,
  66         DCstep,
  67         DCstepi,
  68         DCnext,
  69         DCnexti,
  70         DCfinish,
  71         DCuntil,                        /* line number is zero-based! */
  72         DCkill,
  73         DCbreaktext,
  74         DCbreakline,                    /* line number is zero-based! */
  75         DCtbreakline,                   /* line number is zero-based! */
  76         DCbreakaddr,
  77         DCtbreakaddr,
  78         DCwatchpoint,
  79         DCdelete,
  80         DCenable,
  81         DCdisable,
  82         DCprint,
  83         DCprintDeref,
  84         DCprintStruct,
  85         DCprintQStringStruct,
  86         DCframe,
  87         DCfindType,
  88         DCinfosharedlib,
  89         DCthread,
  90         DCinfothreads,
  91         DCinfobreak,
  92         DCcondition,
  93         DCsetpc,
  94         DCignore,
  95         DCprintWChar,
  96         DCsetvariable
  97 };
  98
  99 enum RunDevNull {
 100     RDNstdin = 0x1,                     /* redirect stdin to /dev/null */
 101     RDNstdout = 0x2,                    /* redirect stdout to /dev/null */
 102     RDNstderr = 0x4                     /* redirect stderr to /dev/null */
 103 };
 104
 105 /**
 106  * How the memory dump is formated. The lowest 4 bits define the size of
 107  * the entities. The higher bits define how these are formatted. Note that
 108  * not all combinations make sense.
 109  */
 110 enum MemoryDumpType {
 111     // sizes
 112     MDTbyte = 0x1,
 113     MDThalfword = 0x2,
 114     MDTword = 0x3,
 115     MDTgiantword = 0x4,
 116     MDTsizemask = 0xf,
 117     // formats
 118     MDThex = 0x10,
 119     MDTsigned = 0x20,
 120     MDTunsigned = 0x30,
 121     MDToctal = 0x40,
 122     MDTbinary = 0x50,
 123     MDTaddress = 0x60,
 124     MDTchar = 0x70,
 125     MDTfloat = 0x80,
 126     MDTstring = 0x90,
 127     MDTinsn = 0xa0,
 128     MDTformatmask = 0xf0
 129 };
 130
 131 struct Breakpoint;
 132
 133 /**
 134  * Debugger commands are placed in a queue. Only one command at a time is
 135  * sent down to the debugger. All other commands in the queue are retained
 136  * until the sent command has been processed by gdb. The debugger tells us
 137  * that it's done with the command by sending the prompt. The output of the
 138  * debugger is parsed at that time. Then, if more commands are in the
 139  * queue, the next one is sent to the debugger.
 140  */
 141 struct CmdQueueItem
 142 {
 143     DbgCommand m_cmd;
 144     QString m_cmdString;
 145     bool m_committed;                   /* just a debugging aid */
 146     // remember which expression when printing an expression
 147     VarTree* m_expr;
 148     ExprWnd* m_exprWnd;
 149     // remember file position
 150     QString m_fileName;
 151     int m_lineNo;
 152     DbgAddr m_addr;
 153     // the breakpoint info
 154     Breakpoint* m_brkpt;
 155     int m_existingBrkpt;
 156     // whether command was emitted due to direct user request (only set when relevant)
 157     bool m_byUser;
 158
 159     CmdQueueItem(DbgCommand cmd, const QString& str) :
 160         m_cmd(cmd),
 161         m_cmdString(str),
 162         m_committed(false),
 163         m_expr(0),
 164         m_exprWnd(0),
 165         m_lineNo(0),
 166         m_brkpt(0),
 167         m_existingBrkpt(0),
 168         m_byUser(false)
 169     { }
 170
 171     struct IsEqualCmd
 172     {
 173         IsEqualCmd(DbgCommand cmd, const QString& str) : m_cmd(cmd), m_str(str) { }
 174         bool operator()(CmdQueueItem*) const;
 175         DbgCommand m_cmd;
 176         const QString& m_str;
 177     };
 178 };
 179
 180 /**
 181  * The information about a breakpoint that is parsed from the list of
 182  * breakpoints.
 183  */
 184 struct Breakpoint
 185 {
 186     int id;                             /* gdb's number */
 187     enum Type {
 188         breakpoint, watchpoint
 189     } type;
 190     bool temporary;
 191     bool enabled;
 192     QString location;
 193     QString text;                       /* text if set using DCbreaktext */
 194     DbgAddr address;                    /* exact address of breakpoint */
 195     QString condition;                  /* condition as printed by gdb */
 196     int ignoreCount;                    /* ignore next that may hits */
 197     int hitCount;                       /* as reported by gdb */
 198     // the following items repeat the location, but in a better usable way
 199     QString fileName;
 200     int lineNo;                         /* zero-based line number */
 201     Breakpoint();
 202     bool isOrphaned() const { return id < 0; }
 203 };
 204
 205 /**
 206  * Information about a stack frame.
 207  */
 208 struct FrameInfo
 209 {
 210     QString fileName;
 211     int lineNo;                         /* zero-based line number */
 212     DbgAddr address;                    /* exact address of PC */
 213 };
 214
 215 /**
 216  * The information about a stack frame as parsed from the backtrace.
 217  */
 218 struct StackFrame : FrameInfo
 219 {
 220     int frameNo;
 221     ExprValue* var;                     /* more information if non-zero */
 222     StackFrame() : var(0) { }
 223     ~StackFrame();
 224 };
 225
 226 /**
 227  * The information about a thread as parsed from the threads list.
 228  */
 229 struct ThreadInfo : FrameInfo
 230 {
 231     int id;                             /* gdb's number */
 232     QString threadName;                 /* the SYSTAG */
 233     QString function;                   /* where thread is halted */
 234     bool hasFocus;                      /* the thread whose stack we are watching */
 235 };
 236
 237 /**
 238  * Register information
 239  */
 240 struct RegisterInfo
 241 {
 242     QString regName;
 243     QString rawValue;
 244     QString cookedValue;                /* may be empty */
 245     QString type;                       /* of vector register if not empty */
 246 };
 247
 248 /**
 249  * Disassembled code
 250  */
 251 struct DisassembledCode
 252 {
 253     DbgAddr address;
 254     QString code;
 255 };
 256
 257 /**
 258  * Memory contents
 259  */
 260 struct MemoryDump
 261 {
 262     DbgAddr address;
 263     QString dump;
 264 };
 265
 266 /**
 267  * This is an abstract base class for debugger process.
 268  *
 269  * This class represents the debugger program. It provides the low-level
 270  * interface to the commandline debugger. As such it implements the
 271  * commands and parses the output.
 272  */
 273 class DebuggerDriver : public QProcess
 274 {
 275     Q_OBJECT
 276 public:
 277     DebuggerDriver();
 278     virtual ~DebuggerDriver() = 0;
 279
 280     virtual QString driverName() const = 0;
 281     /**
 282      * Returns the default command string to invoke the debugger driver.
 283      */
 284     virtual QString defaultInvocation() const = 0;
 285
 286     /**
 287      * Returns a list of options that can be  turned on and off.
 288      */
 289     virtual QStringList boolOptionList() const = 0;
 290
 291     virtual bool startup(QString cmdStr);
 292     void setLogFileName(const QString& fname) { m_logFileName = fname; }
 293     bool isRunning() { return state() != NotRunning; }
 294
 295 protected:
 296     QString m_runCmd;
 297
 298     enum DebuggerState {
 299         DSidle,                         /* gdb waits for input */
 300         DSinterrupted,                  /* a command was interrupted */
 301         DSrunningLow,                   /* gdb is running a low-priority command */
 302         DSrunning,                      /* gdb waits for program */
 303         DScommandSent,                  /* command has been sent, we wait for wroteStdin signal */
 304         DScommandSentLow                /* low-prioritycommand has been sent */
 305     };
 306     DebuggerState m_state;
 307
 308 public:
 309     bool isIdle() const { return m_state == DSidle; }
 310     /**
 311      * Tells whether a high prority command would be executed immediately.
 312      */
 313     bool canExecuteImmediately() const { return m_hipriCmdQueue.empty(); }
 314
 315 protected:
 316     QByteArray m_output;                // normal gdb output
 317     std::queue<QByteArray> m_delayedOutput;     // output colleced before signal bytesWritten() arrived
 318
 319 public:
 320     /**
 321      * Enqueues a high-priority command. High-priority commands are
 322      * executed before any low-priority commands. No user interaction is
 323      * possible as long as there is a high-priority command in the queue.
 324      */
 325     virtual CmdQueueItem* executeCmd(DbgCommand,
 326                                      bool clearLow = false) = 0;
 327     virtual CmdQueueItem* executeCmd(DbgCommand, QString strArg,
 328                                      bool clearLow = false) = 0;
 329     virtual CmdQueueItem* executeCmd(DbgCommand, int intArg,
 330                                      bool clearLow = false) = 0;
 331     virtual CmdQueueItem* executeCmd(DbgCommand, QString strArg, int intArg,
 332                                      bool clearLow = false) = 0;
 333     virtual CmdQueueItem* executeCmd(DbgCommand, QString strArg1, QString strArg2,
 334                                      bool clearLow = false) = 0;
 335     virtual CmdQueueItem* executeCmd(DbgCommand, int intArg1, int intArg2,
 336                                      bool clearLow = false) = 0;
 337
 338     enum QueueMode {
 339         QMnormal,                       /* queues the command last */
 340         QMoverride,                     /* removes an already queued command */
 341         QMoverrideMoreEqual             /* ditto, also puts the command first in the queue */
 342     };
 343
 344     /**
 345      * Enqueues a low-priority command. Low-priority commands are executed
 346      * after any high-priority commands.
 347      */
 348     virtual CmdQueueItem* queueCmd(DbgCommand,
 349                                    QueueMode mode) = 0;
 350     virtual CmdQueueItem* queueCmd(DbgCommand, QString strArg,
 351                                    QueueMode mode) = 0;
 352     virtual CmdQueueItem* queueCmd(DbgCommand, int intArg,
 353                                    QueueMode mode) = 0;
 354     virtual CmdQueueItem* queueCmd(DbgCommand, QString strArg, int intArg,
 355                                    QueueMode mode) = 0;
 356     virtual CmdQueueItem* queueCmd(DbgCommand, QString strArg1, QString strArg2,
 357                                    QueueMode mode) = 0;
 358
 359     /**
 360      * Flushes the command queues.
 361      * @param hipriOnly if true, only the high priority queue is flushed.
 362      */
 363     virtual void flushCommands(bool hipriOnly = false);
 364
 365     /**
 366      * Terminates the debugger process.
 367      */
 368     virtual void terminate() = 0;
 369
 370     /**
 371      * Terminates the debugger process, but also detaches any program that
 372      * it has been attached to.
 373      */
 374     virtual void detachAndTerminate() = 0;
 375
 376     /**
 377      * Interrupts the debuggee.
 378      */
 379     virtual void interruptInferior() = 0;
 380
 381     /**
 382      * Specifies the command that prints the QString data.
 383      */
 384     virtual void setPrintQStringDataCmd(const char* cmd) = 0;
 385
 386     /**
 387      * Parses the output as an array of QChars.
 388      */
 389     virtual ExprValue* parseQCharArray(const char* output, bool wantErrorValue, bool qt3like) = 0;
 390
 391     /**
 392      * Parses a back-trace (the output of the DCbt command).
 393      */
 394     virtual void parseBackTrace(const char* output, std::list<StackFrame>& stack) = 0;
 395
 396     /**
 397      * Parses the output of the DCframe command;
 398      * @param frameNo Returns the frame number.
 399      * @param file Returns the source file name.
 400      * @param lineNo The zero-based line number.
 401      * @param address Returns the exact address.
 402      * @return false if the frame could not be parsed successfully. The
 403      * output values are undefined in this case.
 404      */
 405     virtual bool parseFrameChange(const char* output, int& frameNo,
 406                                   QString& file, int& lineNo, DbgAddr& address) = 0;
 407
 408     /**
 409      * Parses a list of breakpoints.
 410      * @param output The output of the debugger.
 411      * @param brks The list of new #Breakpoint objects. The list
 412      * must initially be empty.
 413      * @return False if there was an error before the first breakpoint
 414      * was found. Even if true is returned, #brks may be empty.
 415      */
 416     virtual bool parseBreakList(const char* output, std::list<Breakpoint>& brks) = 0;
 417
 418     /**
 419      * Parses a list of threads.
 420      * @param output The output of the debugger.
 421      * @return The new thread list. There is no indication if there was
 422      * a parse error.
 423      */
 424     virtual std::list<ThreadInfo> parseThreadList(const char* output) = 0;
 425
 426     /**
 427      * Parses the output when the program stops to see whether this it
 428      * stopped due to a breakpoint.
 429      * @param output The output of the debugger.
 430      * @param id Returns the breakpoint id.
 431      * @param file Returns the file name in which the breakpoint is.
 432      * @param lineNo Returns the zero-based line number of the breakpoint.
 433      * @param address Returns the address of the breakpoint.
 434      * @return False if there was no breakpoint.
 435      */
 436     virtual bool parseBreakpoint(const char* output, int& id,
 437                                  QString& file, int& lineNo, QString& address) = 0;
 438
 439     /**
 440      * Parses the output of the DCinfolocals command.
 441      * @param output The output of the debugger.
 442      * @param newVars Receives the parsed variable values. The values are
 443      * simply append()ed to the supplied list.
 444      */
 445     virtual void parseLocals(const char* output, std::list<ExprValue*>& newVars) = 0;
 446
 447     /**
 448      * Parses the output of a DCprint or DCprintStruct command.
 449      * @param output The output of the debugger.
 450      * @param wantErrorValue Specifies whether the error message should be
 451      * provided as the value of a NKplain variable. If this is false,
 452      * 0 is returned if the printed value is an error message.
 453      * @return the parsed value. It is 0 if there was a parse error
 454      * or if the output is an error message and #wantErrorValue
 455      * is \c false. The returned object's text() is undefined.
 456      */
 457     virtual ExprValue* parsePrintExpr(const char* output, bool wantErrorValue) = 0;
 458
 459     /**
 460      * Parses the output of the DCcd command.
 461      * @return false if the message is an error message.
 462      */
 463     virtual bool parseChangeWD(const char* output, QString& message) = 0;
 464
 465     /**
 466      * Parses the output of the DCexecutable command.
 467      * @return false if an error occured.
 468      */
 469     virtual bool parseChangeExecutable(const char* output, QString& message) = 0;
 470
 471     /**
 472      * Parses the output of the DCcorefile command.
 473      * @return false if the core file was not loaded successfully.
 474      */
 475     virtual bool parseCoreFile(const char* output) = 0;
 476
 477     enum StopFlags {
 478         SFrefreshSource = 1,            /* refresh of source code is needed */
 479         SFrefreshBreak = 2,             /* refresh breakpoints */
 480         SFrefreshThreads = 4,           /* refresh thread list */
 481         SFprogramActive = 128           /* program remains active */
 482     };
 483     /**
 484      * Parses the output of commands that execute (a piece of) the program.
 485      * @return The inclusive OR of zero or more of the StopFlags.
 486      */
 487     virtual uint parseProgramStopped(const char* output, QString& message) = 0;
 488
 489     /**
 490      * Parses the output of the DCsharedlibs command.
 491      */
 492     virtual QStringList parseSharedLibs(const char* output) = 0;
 493
 494     /**
 495      * Parses the output of the DCfindType command.
 496      * @return true if a type was found.
 497      */
 498     virtual bool parseFindType(const char* output, QString& type) = 0;
 499
 500     /**
 501      * Parses the output of the DCinforegisters command.
 502      */
 503     virtual std::list<RegisterInfo> parseRegisters(const char* output) = 0;
 504
 505     /**
 506      * Parses the output of the DCinfoline command. Returns false if the
 507      * two addresses could not be found.
 508      */
 509     virtual bool parseInfoLine(const char* output,
 510                                QString& addrFrom, QString& addrTo) = 0;
 511
 512     /**
 513      * Parses the ouput of the DCdisassemble command.
 514      */
 515     virtual std::list<DisassembledCode> parseDisassemble(const char* output) = 0;
 516
 517     /**
 518      * Parses a memory dump. Returns an empty string if no error was found;
 519      * otherwise it contains an error message.
 520      */
 521     virtual QString parseMemoryDump(const char* output, std::list<MemoryDump>& memdump) = 0;
 522
 523     /**
 524      * Parses the output of the DCsetvariable command. Returns an empty
 525      * string if no error was found; otherwise it contains an error
 526      * message.
 527      */
 528     virtual QString parseSetVariable(const char* output) = 0;
 529
 530     /**
 531      * Returns a value that the user can edit.
 532      */
 533     virtual QString editableValue(VarTree* value);
 534
 535 protected:
 536     /** Removes all commands from the low-priority queue. */
 537     void flushLoPriQueue();
 538     /** Removes all commands from  the high-priority queue. */
 539     void flushHiPriQueue();
 540
 541     std::queue<CmdQueueItem*> m_hipriCmdQueue;
 542     std::list<CmdQueueItem*> m_lopriCmdQueue;
 543     /**
 544      * The active command is kept separately from other pending commands.
 545      */
 546     CmdQueueItem* m_activeCmd;
 547     /**
 548      * Helper function that queues the given command string in the
 549      * low-priority queue.
 550      */
 551     CmdQueueItem* queueCmdString(DbgCommand cmd, QString cmdString,
 552                                  QueueMode mode);
 553     /**
 554      * Helper function that queues the given command string in the
 555      * high-priority queue.
 556      */
 557     CmdQueueItem* executeCmdString(DbgCommand cmd, QString cmdString,
 558                                    bool clearLow);
 559     void writeCommand();
 560     virtual void commandFinished(CmdQueueItem* cmd) = 0;
 561
 562 protected:
 563     void processOutput(const QByteArray& data);
 564
 565     /**
 566      * Returns the start of the prompt in \a output or -1.
 567      * \a len specifies the size of \a output, but in addition, the contents
 568      * of \a output are NUL-terminated, i.e., \c output[len] is zero.
 569      */
 570     virtual int findPrompt(const QByteArray& output) const = 0;
 571
 572     // log file
 573     QString m_logFileName;
 574     QFile m_logFile;
 575
 576 public slots:
 577     void dequeueCmdByVar(VarTree* var);
 578
 579 protected slots:
 580     virtual void slotReceiveOutput();
 581     virtual void slotCommandRead();
 582     virtual void slotExited();
 583
 584 signals:
 585     /**
 586      * This signal is emitted when the output of a command has been fully
 587      * collected and is ready to be interpreted.
 588      */
 589     void commandReceived(CmdQueueItem* cmd, const char* output);
 590
 591     /**
 592      * This signal is emitted when the debugger recognizes that a specific
 593      * location in a file ought to be displayed.
 594      *
 595      * Gdb's --fullname option supports this for the step, next, frame, and
 596      * run commands (and possibly others).
 597      *
 598      * @param file specifies the file; this is not necessarily a full path
 599      * name, and if it is relative, you won't know relative to what, you
 600      * can only guess.
 601      * @param lineNo specifies the line number (0-based!) (this may be
 602      * negative, in which case the file should be activated, but the line
 603      * should NOT be changed).
 604      * @param address specifies the exact address of the PC or is empty.
 605      */
 606     void activateFileLine(const QString& file, int lineNo, const DbgAddr& address);
 607
 608     /**
 609      * This signal is emitted when a command that starts the inferior has
 610      * been submitted to the debugger.
 611      */
 612     void inferiorRunning();
 613
 614     /**
 615      * This signal is emitted when all output from the debugger has been
 616      * consumed and no more commands are in the queues.
 617      */
 618     void enterIdleState();
 619 };
 620
 621 #endif // DBGDRIVER_H