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