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