kdbg/dbgdriver.h

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