tools/llvm-db/Commands.cpp

   1 //===-- Commands.cpp - Implement various commands for the CLI -------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements many builtin user commands.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #include "CLIDebugger.h"
  15 #include "CLICommand.h"
  16 #include "llvm/Debugger/ProgramInfo.h"
  17 #include "llvm/Debugger/RuntimeInfo.h"
  18 #include "llvm/Debugger/SourceLanguage.h"
  19 #include "llvm/Debugger/SourceFile.h"
  20 #include "llvm/Debugger/InferiorProcess.h"
  21 #include "Support/FileUtilities.h"
  22 #include "Support/StringExtras.h"
  23 #include <iostream>
  24 using namespace llvm;
  25
  26 /// getCurrentLanguage - Return the current source language that the user is
  27 /// playing around with.  This is aquired from the current stack frame of a
  28 /// running program if one exists, but this value can be explicitly set by the
  29 /// user as well.
  30 const SourceLanguage &CLIDebugger::getCurrentLanguage() const {
  31   // If the user explicitly switched languages with 'set language', use what
  32   // they asked for.
  33   if (CurrentLanguage) {
  34     return *CurrentLanguage;
  35   } else if (Dbg.isProgramRunning()) {
  36     // Otherwise, if the program is running, infer the current language from it.
  37     const GlobalVariable *FuncDesc =
  38       getRuntimeInfo().getCurrentFrame().getFunctionDesc();
  39     return getProgramInfo().getFunction(FuncDesc).getSourceFile().getLanguage();
  40   } else {
  41     // Otherwise, default to C like GDB apparently does.
  42     return SourceLanguage::getCFamilyInstance();
  43   }
  44 }
  45
  46 /// startProgramRunning - If the program has been updated, reload it, then
  47 /// start executing the program.
  48 void CLIDebugger::startProgramRunning() {
  49   eliminateRunInfo();
  50
  51   // If the program has been modified, reload it!
  52   std::string Program = Dbg.getProgramPath();
  53   if (TheProgramInfo->getProgramTimeStamp() != getFileTimestamp(Program)) {
  54     std::cout << "'" << Program << "' has changed; re-reading program.\n";
  55
  56     // Unload an existing program.  This kills the program if necessary.
  57     Dbg.unloadProgram();
  58     delete TheProgramInfo;
  59     TheProgramInfo = 0;
  60     CurrentFile = 0;
  61
  62     Dbg.loadProgram(Program);
  63     TheProgramInfo = new ProgramInfo(Dbg.getProgram());
  64   }
  65
  66   std::cout << "Starting program: " << Dbg.getProgramPath() << "\n";
  67   Dbg.createProgram();
  68
  69   // There was no current frame.
  70   LastCurrentFrame = 0;
  71 }
  72
  73 /// printSourceLine - Print the specified line of the current source file.
  74 /// If the specified line is invalid (the source file could not be loaded or
  75 /// the line number is out of range), don't print anything, but return true.
  76 bool CLIDebugger::printSourceLine(unsigned LineNo) {
  77   assert(CurrentFile && "There is no current source file to print!");
  78   const char *LineStart, *LineEnd;
  79   CurrentFile->getSourceLine(LineNo-1, LineStart, LineEnd);
  80   if (LineStart == 0) return true;
  81   std::cout << LineNo;
  82
  83   // If this is the line the program is currently stopped at, print a marker.
  84   if (Dbg.isProgramRunning()) {
  85     unsigned CurLineNo, CurColNo;
  86     const SourceFileInfo *CurSFI;
  87     getRuntimeInfo().getCurrentFrame().getSourceLocation(CurLineNo, CurColNo,
  88                                                          CurSFI);
  89
  90     if (CurLineNo == LineNo && CurrentFile == &CurSFI->getSourceText())
  91       std::cout << " ->";
  92   }
  93
  94   std::cout << "\t" << std::string(LineStart, LineEnd) << "\n";
  95   return false;
  96 }
  97
  98 /// printProgramLocation - Print a line of the place where the current stack
  99 /// frame has stopped and the source line it is on.
 100 ///
 101 void CLIDebugger::printProgramLocation(bool PrintLocation) {
 102   assert(Dbg.isProgramLoaded() && Dbg.isProgramRunning() &&
 103          "Error program is not loaded and running!");
 104
 105   // Figure out where the program stopped...
 106   StackFrame &SF = getRuntimeInfo().getCurrentFrame();
 107   unsigned LineNo, ColNo;
 108   const SourceFileInfo *FileDesc;
 109   SF.getSourceLocation(LineNo, ColNo, FileDesc);
 110
 111   // If requested, print out some program information about WHERE we are.
 112   if (PrintLocation) {
 113     // FIXME: print the current function arguments
 114     if (const GlobalVariable *FuncDesc = SF.getFunctionDesc())
 115       std::cout << getProgramInfo().getFunction(FuncDesc).getSymbolicName();
 116     else
 117       std::cout << "<unknown function>";
 118
 119     CurrentFile = &FileDesc->getSourceText();
 120
 121     std::cout << " at " << CurrentFile->getFilename() << ":" << LineNo;
 122     if (ColNo) std::cout << ":" << ColNo << "\n";
 123   }
 124
 125   if (printSourceLine(LineNo))
 126     std::cout << "<could not load source file>\n";
 127   else {
 128     LineListedStart = LineNo-ListSize/2+1;
 129     if ((int)LineListedStart < 1) LineListedStart = 1;
 130     LineListedEnd = LineListedStart+1;
 131   }
 132 }
 133
 134 /// eliminateRunInfo - We are about to run the program.  Forget any state
 135 /// about how the program used to be stopped.
 136 void CLIDebugger::eliminateRunInfo() {
 137   delete TheRuntimeInfo;
 138   TheRuntimeInfo = 0;
 139 }
 140
 141 /// programStoppedSuccessfully - This method updates internal data
 142 /// structures to reflect the fact that the program just executed a while,
 143 /// and has successfully stopped.
 144 void CLIDebugger::programStoppedSuccessfully() {
 145   assert(TheRuntimeInfo==0 && "Someone forgot to release the old RuntimeInfo!");
 146
 147   TheRuntimeInfo = new RuntimeInfo(TheProgramInfo, Dbg.getRunningProcess());
 148
 149   // FIXME: if there are any breakpoints at the current location, print them as
 150   // well.
 151
 152   // Since the program as successfully stopped, print its location.
 153   void *CurrentFrame = getRuntimeInfo().getCurrentFrame().getFrameID();
 154   printProgramLocation(CurrentFrame != LastCurrentFrame);
 155   LastCurrentFrame = CurrentFrame;
 156 }
 157
 158
 159
 160 /// getUnsignedIntegerOption - Get an unsigned integer number from the Val
 161 /// string.  Check to make sure that the string contains an unsigned integer
 162 /// token, and if not, throw an exception.  If isOnlyOption is set, also throw
 163 /// an exception if there is extra junk at the end of the string.
 164 static unsigned getUnsignedIntegerOption(const char *Msg, std::string &Val,
 165                                          bool isOnlyOption = true) {
 166   std::string Tok = getToken(Val);
 167   if (Tok.empty() || (isOnlyOption && !getToken(Val).empty()))
 168     throw std::string(Msg) + " expects an unsigned integer argument.";
 169
 170   char *EndPtr;
 171   unsigned Result = strtoul(Tok.c_str(), &EndPtr, 0);
 172   if (EndPtr != Tok.c_str()+Tok.size())
 173     throw std::string(Msg) + " expects an unsigned integer argument.";
 174
 175   return Result;
 176 }
 177
 178 /// getOptionalUnsignedIntegerOption - This method is just like
 179 /// getUnsignedIntegerOption, but if the argument value is not specified, a
 180 /// default is returned instead of causing an error.
 181 static unsigned
 182 getOptionalUnsignedIntegerOption(const char *Msg, unsigned Default,
 183                                  std::string &Val, bool isOnlyOption = true) {
 184   // Check to see if the value was specified...
 185   std::string TokVal = getToken(Val);
 186   if (TokVal.empty()) return Default;
 187
 188   // If it was specified, add it back to the value we are parsing...
 189   Val = TokVal+Val;
 190
 191   // And parse normally.
 192   return getUnsignedIntegerOption(Msg, Val, isOnlyOption);
 193 }
 194
 195
 196 /// parseProgramOptions - This method parses the Options string and loads it
 197 /// as options to be passed to the program.  This is used by the run command
 198 /// and by 'set args'.
 199 void CLIDebugger::parseProgramOptions(std::string &Options) {
 200   // FIXME: tokenizing by whitespace is clearly incorrect.  Instead we should
 201   // honor quotes and other things that a shell would.  Also in the future we
 202   // should support redirection of standard IO.
 203
 204   std::vector<std::string> Arguments;
 205   for (std::string A = getToken(Options); !A.empty(); A = getToken(Options))
 206     Arguments.push_back(A);
 207   Dbg.setProgramArguments(Arguments.begin(), Arguments.end());
 208 }
 209
 210
 211 //===----------------------------------------------------------------------===//
 212 //                   Program startup and shutdown options
 213 //===----------------------------------------------------------------------===//
 214
 215
 216 /// file command - If the user specifies an option, search the PATH for the
 217 /// specified program/bytecode file and load it.  If the user does not specify
 218 /// an option, unload the current program.
 219 void CLIDebugger::fileCommand(std::string &Options) {
 220   std::string Prog = getToken(Options);
 221   if (!getToken(Options).empty())
 222     throw "file command takes at most one argument.";
 223
 224   // Check to make sure the user knows what they are doing
 225   if (Dbg.isProgramRunning() &&
 226       !askYesNo("A program is already loaded.  Kill it?"))
 227     return;
 228
 229   // Unload an existing program.  This kills the program if necessary.
 230   eliminateRunInfo();
 231   delete TheProgramInfo;
 232   TheProgramInfo = 0;
 233   Dbg.unloadProgram();
 234   CurrentFile = 0;
 235
 236   // If requested, start the new program.
 237   if (Prog.empty()) {
 238     std::cout << "Unloaded program.\n";
 239   } else {
 240     std::cout << "Loading program... " << std::flush;
 241     Dbg.loadProgram(Prog);
 242     assert(Dbg.isProgramLoaded() &&
 243            "loadProgram succeeded, but not program loaded!");
 244     TheProgramInfo = new ProgramInfo(Dbg.getProgram());
 245     std::cout << "successfully loaded '" << Dbg.getProgramPath() << "'!\n";
 246   }
 247 }
 248
 249
 250 void CLIDebugger::createCommand(std::string &Options) {
 251   if (!getToken(Options).empty())
 252     throw "create command does not take any arguments.";
 253   if (!Dbg.isProgramLoaded()) throw "No program loaded.";
 254   if (Dbg.isProgramRunning() &&
 255       !askYesNo("The program is already running.  Restart from the beginning?"))
 256     return;
 257
 258   // Start the program running.
 259   startProgramRunning();
 260
 261   // The program stopped!
 262   programStoppedSuccessfully();
 263 }
 264
 265 void CLIDebugger::killCommand(std::string &Options) {
 266   if (!getToken(Options).empty())
 267     throw "kill command does not take any arguments.";
 268   if (!Dbg.isProgramRunning())
 269     throw "No program is currently being run.";
 270
 271   if (askYesNo("Kill the program being debugged?"))
 272     Dbg.killProgram();
 273   eliminateRunInfo();
 274 }
 275
 276 void CLIDebugger::quitCommand(std::string &Options) {
 277   if (!getToken(Options).empty())
 278     throw "quit command does not take any arguments.";
 279
 280   if (Dbg.isProgramRunning() &&
 281       !askYesNo("The program is running.  Exit anyway?"))
 282     return;
 283
 284   // Throw exception to get out of the user-input loop.
 285   throw 0;
 286 }
 287
 288
 289 //===----------------------------------------------------------------------===//
 290 //                        Program execution commands
 291 //===----------------------------------------------------------------------===//
 292
 293 void CLIDebugger::runCommand(std::string &Options) {
 294   if (!Dbg.isProgramLoaded()) throw "No program loaded.";
 295   if (Dbg.isProgramRunning() &&
 296       !askYesNo("The program is already running.  Restart from the beginning?"))
 297     return;
 298
 299   // Parse all of the options to the run command, which specify program
 300   // arguments to run with.
 301   parseProgramOptions(Options);
 302
 303   eliminateRunInfo();
 304
 305   // Start the program running.
 306   startProgramRunning();
 307
 308   // Start the program running...
 309   Options = "";
 310   contCommand(Options);
 311 }
 312
 313 void CLIDebugger::contCommand(std::string &Options) {
 314   if (!getToken(Options).empty()) throw "cont argument not supported yet.";
 315   if (!Dbg.isProgramRunning()) throw "Program is not running.";
 316
 317   eliminateRunInfo();
 318
 319   Dbg.contProgram();
 320
 321   // The program stopped!
 322   programStoppedSuccessfully();
 323 }
 324
 325 void CLIDebugger::stepCommand(std::string &Options) {
 326   if (!Dbg.isProgramRunning()) throw "Program is not running.";
 327
 328   // Figure out how many times to step.
 329   unsigned Amount =
 330     getOptionalUnsignedIntegerOption("'step' command", 1, Options);
 331
 332   eliminateRunInfo();
 333
 334   // Step the specified number of times.
 335   for (; Amount; --Amount)
 336     Dbg.stepProgram();
 337
 338   // The program stopped!
 339   programStoppedSuccessfully();
 340 }
 341
 342 void CLIDebugger::nextCommand(std::string &Options) {
 343   if (!Dbg.isProgramRunning()) throw "Program is not running.";
 344   unsigned Amount =
 345     getOptionalUnsignedIntegerOption("'next' command", 1, Options);
 346
 347   eliminateRunInfo();
 348
 349   for (; Amount; --Amount)
 350     Dbg.nextProgram();
 351
 352   // The program stopped!
 353   programStoppedSuccessfully();
 354 }
 355
 356 void CLIDebugger::finishCommand(std::string &Options) {
 357   if (!getToken(Options).empty())
 358     throw "finish command does not take any arguments.";
 359   if (!Dbg.isProgramRunning()) throw "Program is not running.";
 360
 361   // Figure out where we are exactly.  If the user requests that we return from
 362   // a frame that is not the top frame, make sure we get it.
 363   void *CurrentFrame = getRuntimeInfo().getCurrentFrame().getFrameID();
 364
 365   eliminateRunInfo();
 366
 367   Dbg.finishProgram(CurrentFrame);
 368
 369   // The program stopped!
 370   programStoppedSuccessfully();
 371 }
 372
 373 //===----------------------------------------------------------------------===//
 374 //                           Stack frame commands
 375 //===----------------------------------------------------------------------===//
 376
 377 void CLIDebugger::backtraceCommand(std::string &Options) {
 378   // Accepts "full", n, -n
 379   if (!getToken(Options).empty())
 380     throw "FIXME: bt command argument not implemented yet!";
 381
 382   RuntimeInfo &RI = getRuntimeInfo();
 383   ProgramInfo &PI = getProgramInfo();
 384
 385   try {
 386     for (unsigned i = 0; ; ++i) {
 387       StackFrame &SF = RI.getStackFrame(i);
 388       std::cout << "#" << i;
 389       if (i == RI.getCurrentFrameIdx())
 390         std::cout << " ->";
 391       std::cout << "\t" << SF.getFrameID() << " in ";
 392       if (const GlobalVariable *G = SF.getFunctionDesc())
 393         std::cout << PI.getFunction(G).getSymbolicName();
 394
 395       unsigned LineNo, ColNo;
 396       const SourceFileInfo *SFI;
 397       SF.getSourceLocation(LineNo, ColNo, SFI);
 398       if (!SFI->getBaseName().empty()) {
 399         std::cout << " at " << SFI->getBaseName();
 400         if (LineNo) {
 401           std::cout << ":" << LineNo;
 402           if (ColNo)
 403             std::cout << ":" << ColNo;
 404         }
 405       }
 406
 407       // FIXME: when we support shared libraries, we should print ' from foo.so'
 408       // if the stack frame is from a different object than the current one.
 409
 410       std::cout << "\n";
 411     }
 412   } catch (...) {
 413     // Stop automatically when we run off the bottom of the stack.
 414   }
 415 }
 416
 417 void CLIDebugger::upCommand(std::string &Options) {
 418   unsigned Num =
 419     getOptionalUnsignedIntegerOption("'up' command", 1, Options);
 420
 421   RuntimeInfo &RI = getRuntimeInfo();
 422   unsigned CurFrame = RI.getCurrentFrameIdx();
 423
 424   // Check to see if we go can up the specified number of frames.
 425   try {
 426     RI.getStackFrame(CurFrame+Num);
 427   } catch (...) {
 428     if (Num == 1)
 429       throw "Initial frame selected; you cannot go up.";
 430     else
 431       throw "Cannot go up " + utostr(Num) + " frames!";
 432   }
 433
 434   RI.setCurrentFrameIdx(CurFrame+Num);
 435   printProgramLocation();
 436 }
 437
 438 void CLIDebugger::downCommand(std::string &Options) {
 439   unsigned Num =
 440     getOptionalUnsignedIntegerOption("'down' command", 1, Options);
 441
 442   RuntimeInfo &RI = getRuntimeInfo();
 443   unsigned CurFrame = RI.getCurrentFrameIdx();
 444
 445   // Check to see if we can go up the specified number of frames.
 446   if (CurFrame < Num)
 447     if (Num == 1)
 448       throw "Bottom (i.e., innermost) frame selected; you cannot go down.";
 449     else
 450       throw "Cannot go down " + utostr(Num) + " frames!";
 451
 452   RI.setCurrentFrameIdx(CurFrame-Num);
 453   printProgramLocation();
 454 }
 455
 456 void CLIDebugger::frameCommand(std::string &Options) {
 457   RuntimeInfo &RI = getRuntimeInfo();
 458   unsigned CurFrame = RI.getCurrentFrameIdx();
 459
 460   unsigned Num =
 461     getOptionalUnsignedIntegerOption("'frame' command", CurFrame, Options);
 462
 463   // Check to see if we go to the specified frame.
 464   RI.getStackFrame(Num);
 465
 466   RI.setCurrentFrameIdx(Num);
 467   printProgramLocation();
 468 }
 469
 470
 471 //===----------------------------------------------------------------------===//
 472 //                        Breakpoint related commands
 473 //===----------------------------------------------------------------------===//
 474
 475 void CLIDebugger::breakCommand(std::string &Options) {
 476   // Figure out where the user wants a breakpoint.
 477   const SourceFile *File;
 478   unsigned LineNo;
 479
 480   // Check to see if the user specified a line specifier.
 481   std::string Option = getToken(Options);  // strip whitespace
 482   if (!Option.empty()) {
 483     Options = Option + Options;  // reconstruct string
 484
 485     // Parse the line specifier.
 486     parseLineSpec(Options, File, LineNo);
 487   } else {
 488     // Build a line specifier for the current stack frame.
 489     throw "FIXME: breaking at the current location is not implemented yet!";
 490   }
 491
 492   if (!File) File = CurrentFile;
 493   if (File == 0)
 494     throw "Unknown file to place breakpoint!";
 495
 496   std::cerr << "Break: " << File->getFilename() << ":" << LineNo << "\n";
 497
 498   throw "breakpoints not implemented yet!";
 499 }
 500
 501 //===----------------------------------------------------------------------===//
 502 //                          Miscellaneous commands
 503 //===----------------------------------------------------------------------===//
 504
 505 void CLIDebugger::infoCommand(std::string &Options) {
 506   std::string What = getToken(Options);
 507
 508   if (What.empty() || !getToken(Options).empty())
 509     throw "info command expects exactly one argument.";
 510
 511   if (What == "frame") {
 512   } else if (What == "functions") {
 513     const std::map<const GlobalVariable*, SourceFunctionInfo*> &Functions
 514       = getProgramInfo().getSourceFunctions();
 515     std::cout << "All defined functions:\n";
 516     // FIXME: GDB groups these by source file.  We could do that I guess.
 517     for (std::map<const GlobalVariable*, SourceFunctionInfo*>::const_iterator
 518            I = Functions.begin(), E = Functions.end(); I != E; ++I) {
 519       std::cout << I->second->getSymbolicName() << "\n";
 520     }
 521
 522   } else if (What == "source") {
 523     if (CurrentFile == 0)
 524       throw "No current source file.";
 525
 526     // Get the SourceFile information for the current file.
 527     const SourceFileInfo &SF =
 528       getProgramInfo().getSourceFile(CurrentFile->getDescriptor());
 529
 530     std::cout << "Current source file is: " << SF.getBaseName() << "\n"
 531               << "Compilation directory is: " << SF.getDirectory() << "\n";
 532     if (unsigned NL = CurrentFile->getNumLines())
 533       std::cout << "Located in: " << CurrentFile->getFilename() << "\n"
 534                 << "Contains " << NL << " lines\n";
 535     else
 536       std::cout << "Could not find source file.\n";
 537     std::cout << "Source language is "
 538               << SF.getLanguage().getSourceLanguageName() << "\n";
 539
 540   } else if (What == "sources") {
 541     const std::map<const GlobalVariable*, SourceFileInfo*> &SourceFiles =
 542       getProgramInfo().getSourceFiles();
 543     std::cout << "Source files for the program:\n";
 544     for (std::map<const GlobalVariable*, SourceFileInfo*>::const_iterator I =
 545            SourceFiles.begin(), E = SourceFiles.end(); I != E;) {
 546       std::cout << I->second->getDirectory() << "/"
 547                 << I->second->getBaseName();
 548       ++I;
 549       if (I != E) std::cout << ", ";
 550     }
 551     std::cout << "\n";
 552   } else if (What == "target") {
 553     std::cout << Dbg.getRunningProcess().getStatus();
 554   } else {
 555     // See if this is something handled by the current language.
 556     if (getCurrentLanguage().printInfo(What))
 557       return;
 558
 559     throw "Unknown info command '" + What + "'.  Try 'help info'.";
 560   }
 561 }
 562
 563 /// parseLineSpec - Parses a line specifier, for use by the 'list' command.
 564 /// If SourceFile is returned as a void pointer, then it was not specified.
 565 /// If the line specifier is invalid, an exception is thrown.
 566 void CLIDebugger::parseLineSpec(std::string &LineSpec,
 567                                 const SourceFile *&SourceFile,
 568                                 unsigned &LineNo) {
 569   SourceFile = 0;
 570   LineNo = 0;
 571
 572   // First, check to see if we have a : separator.
 573   std::string FirstPart = getToken(LineSpec, ":");
 574   std::string SecondPart = getToken(LineSpec, ":");
 575   if (!getToken(LineSpec).empty()) throw "Malformed line specification!";
 576
 577   // If there is no second part, we must have either "function", "number",
 578   // "+offset", or "-offset".
 579   if (SecondPart.empty()) {
 580     if (FirstPart.empty()) throw "Malformed line specification!";
 581     if (FirstPart[0] == '+') {
 582       FirstPart.erase(FirstPart.begin(), FirstPart.begin()+1);
 583       // For +n, return LineListedEnd+n
 584       LineNo = LineListedEnd +
 585                getUnsignedIntegerOption("Line specifier '+'", FirstPart);
 586
 587     } else if (FirstPart[0] == '-') {
 588       FirstPart.erase(FirstPart.begin(), FirstPart.begin()+1);
 589       // For -n, return LineListedEnd-n
 590       LineNo = LineListedEnd -
 591                getUnsignedIntegerOption("Line specifier '-'", FirstPart);
 592       if ((int)LineNo < 1) LineNo = 1;
 593     } else if (FirstPart[0] == '*') {
 594       throw "Address expressions not supported as source locations!";
 595     } else {
 596       // Ok, check to see if this is just a line number.
 597       std::string Saved = FirstPart;
 598       try {
 599         LineNo = getUnsignedIntegerOption("", Saved);
 600       } catch (...) {
 601         // Ok, it's not a valid line number.  It must be a source-language
 602         // entity name.
 603         std::string Name = getToken(FirstPart);
 604         if (!getToken(FirstPart).empty())
 605           throw "Extra junk in line specifier after '" + Name + "'.";
 606         SourceFunctionInfo *SFI =
 607           getCurrentLanguage().lookupFunction(Name, getProgramInfo(),
 608                                               TheRuntimeInfo);
 609         if (SFI == 0)
 610           throw "Unknown identifier '" + Name + "'.";
 611
 612         unsigned L, C;
 613         SFI->getSourceLocation(L, C);
 614         if (L == 0) throw "Could not locate '" + Name + "'!";
 615         LineNo = L;
 616         SourceFile = &SFI->getSourceFile().getSourceText();
 617         return;
 618       }
 619     }
 620
 621   } else {
 622     // Ok, this must be a filename qualified line number or function name.
 623     // First, figure out the source filename.
 624     std::string SourceFilename = getToken(FirstPart);
 625     if (!getToken(FirstPart).empty())
 626       throw "Invalid filename qualified source location!";
 627
 628     // Next, check to see if this is just a line number.
 629     std::string Saved = SecondPart;
 630     try {
 631       LineNo = getUnsignedIntegerOption("", Saved);
 632     } catch (...) {
 633       // Ok, it's not a valid line number.  It must be a function name.
 634       throw "FIXME: Filename qualified function names are not support "
 635             "as line specifiers yet!";
 636     }
 637
 638     // Ok, we got the line number.  Now check out the source file name to make
 639     // sure it's all good.  If it is, return it.  If not, throw exception.
 640     SourceFile =&getProgramInfo().getSourceFile(SourceFilename).getSourceText();
 641   }
 642 }
 643
 644 void CLIDebugger::listCommand(std::string &Options) {
 645   if (!Dbg.isProgramLoaded())
 646     throw "No program is loaded.  Use the 'file' command.";
 647
 648   // Handle "list foo," correctly, by returning " " as the second token
 649   Options += " ";
 650
 651   std::string FirstLineSpec = getToken(Options, ",");
 652   std::string SecondLineSpec = getToken(Options, ",");
 653   if (!getToken(Options, ",").empty())
 654     throw "list command only expects two source location specifiers!";
 655
 656   // StartLine, EndLine - The starting and ending line numbers to print.
 657   unsigned StartLine = 0, EndLine = 0;
 658
 659   if (SecondLineSpec.empty()) {    // No second line specifier provided?
 660     // Handle special forms like "", "+", "-", etc.
 661     std::string TmpSpec = FirstLineSpec;
 662     std::string Tok = getToken(TmpSpec);
 663     if (getToken(TmpSpec).empty() && (Tok == "" || Tok == "+" || Tok == "-")) {
 664       if (Tok == "+" || Tok == "") {
 665         StartLine = LineListedEnd;
 666         EndLine = StartLine + ListSize;
 667       } else {
 668         assert(Tok == "-");
 669         StartLine = LineListedStart-ListSize;
 670         EndLine = LineListedStart;
 671         if ((int)StartLine <= 0) StartLine = 1;
 672       }
 673     } else {
 674       // Must be a normal line specifier.
 675       const SourceFile *File;
 676       unsigned LineNo;
 677       parseLineSpec(FirstLineSpec, File, LineNo);
 678
 679       // If the user only specified one file specifier, we should display
 680       // ListSize lines centered at the specified line.
 681       if (File != 0) CurrentFile = File;
 682       StartLine = LineNo - (ListSize+1)/2;
 683       if ((int)StartLine <= 0) StartLine = 1;
 684       EndLine = StartLine + ListSize;
 685     }
 686
 687   } else {
 688     // Parse two line specifiers...
 689     const SourceFile *StartFile, *EndFile;
 690     unsigned StartLineNo, EndLineNo;
 691     parseLineSpec(FirstLineSpec, StartFile, StartLineNo);
 692     unsigned SavedLLE = LineListedEnd;
 693     LineListedEnd = StartLineNo;
 694     try {
 695       parseLineSpec(SecondLineSpec, EndFile, EndLineNo);
 696     } catch (...) {
 697       LineListedEnd = SavedLLE;
 698       throw;
 699     }
 700
 701     // Inherit file specified by the first line spec if there was one.
 702     if (EndFile == 0) EndFile = StartFile;
 703
 704     if (StartFile != EndFile)
 705       throw "Start and end line specifiers are in different files!";
 706     CurrentFile = StartFile;
 707     StartLine = StartLineNo;
 708     EndLine = EndLineNo+1;
 709   }
 710
 711   assert((int)StartLine > 0 && (int)EndLine > 0 && StartLine <= EndLine &&
 712          "Error reading line specifiers!");
 713
 714   // If there was no current file, and the user didn't specify one to list, we
 715   // have an error.
 716   if (CurrentFile == 0)
 717     throw "There is no current file to list.";
 718
 719   // Remember for next time.
 720   LineListedStart = StartLine;
 721   LineListedEnd = StartLine;
 722
 723   for (unsigned LineNo = StartLine; LineNo != EndLine; ++LineNo) {
 724     // Print the source line, unless it is invalid.
 725     if (printSourceLine(LineNo))
 726       break;
 727     LineListedEnd = LineNo+1;
 728   }
 729
 730   // If we didn't print any lines, find out why.
 731   if (LineListedEnd == StartLine) {
 732     // See if we can read line #0 from the file, if not, we couldn't load the
 733     // file.
 734     const char *LineStart, *LineEnd;
 735     CurrentFile->getSourceLine(0, LineStart, LineEnd);
 736     if (LineStart == 0)
 737       throw "Could not load source file '" + CurrentFile->getFilename() + "'!";
 738     else
 739       std::cout << "<end of file>\n";
 740   }
 741 }
 742
 743 void CLIDebugger::setCommand(std::string &Options) {
 744   std::string What = getToken(Options);
 745
 746   if (What.empty())
 747     throw "set command expects at least two arguments.";
 748   if (What == "args") {
 749     parseProgramOptions(Options);
 750   } else if (What == "language") {
 751     std::string Lang = getToken(Options);
 752     if (!getToken(Options).empty())
 753       throw "set language expects one argument at most.";
 754     if (Lang == "") {
 755       std::cout << "The currently understood settings are:\n\n"
 756                 << "local or auto  Automatic setting based on source file\n"
 757                 << "c              Use the C language\n"
 758                 << "c++            Use the C++ language\n"
 759                 << "unknown        Use when source language is not supported\n";
 760     } else if (Lang == "local" || Lang == "auto") {
 761       CurrentLanguage = 0;
 762     } else if (Lang == "c") {
 763       CurrentLanguage = &SourceLanguage::getCFamilyInstance();
 764     } else if (Lang == "c++") {
 765       CurrentLanguage = &SourceLanguage::getCPlusPlusInstance();
 766     } else if (Lang == "unknown") {
 767       CurrentLanguage = &SourceLanguage::getUnknownLanguageInstance();
 768     } else {
 769       throw "Unknown language '" + Lang + "'.";
 770     }
 771
 772   } else if (What == "listsize") {
 773     ListSize = getUnsignedIntegerOption("'set prompt' command", Options);
 774   } else if (What == "prompt") {
 775     // Include any trailing whitespace or other tokens, but not leading
 776     // whitespace.
 777     Prompt = getToken(Options);  // Strip leading whitespace
 778     Prompt += Options;           // Keep trailing whitespace or other stuff
 779   } else {
 780     // FIXME: Try to parse this as a source-language program expression.
 781     throw "Don't know how to set '" + What + "'!";
 782   }
 783 }
 784
 785 void CLIDebugger::showCommand(std::string &Options) {
 786   std::string What = getToken(Options);
 787
 788   if (What.empty() || !getToken(Options).empty())
 789     throw "show command expects one argument.";
 790
 791   if (What == "args") {
 792     std::cout << "Argument list to give program when started is \"";
 793     // FIXME: This doesn't print stuff correctly if the arguments have spaces in
 794     // them, but currently the only way to get that is to use the --args command
 795     // line argument.  This should really handle escaping all hard characters as
 796     // needed.
 797     for (unsigned i = 0, e = Dbg.getNumProgramArguments(); i != e; ++i)
 798       std::cout << (i ? " " : "") << Dbg.getProgramArgument(i);
 799     std::cout << "\"\n";
 800
 801   } else if (What == "language") {
 802     std::cout << "The current source language is '";
 803     if (CurrentLanguage)
 804       std::cout << CurrentLanguage->getSourceLanguageName();
 805     else
 806       std::cout << "auto; currently "
 807                 << getCurrentLanguage().getSourceLanguageName();
 808     std::cout << "'.\n";
 809   } else if (What == "listsize") {
 810     std::cout << "Number of source lines llvm-db will list by default is "
 811               << ListSize << ".\n";
 812   } else if (What == "prompt") {
 813     std::cout << "llvm-db's prompt is \"" << Prompt << "\".\n";
 814   } else {
 815     throw "Unknown show command '" + What + "'.  Try 'help show'.";
 816   }
 817 }
 818
 819 void CLIDebugger::helpCommand(std::string &Options) {
 820   // Print out all of the commands in the CommandTable
 821   std::string Command = getToken(Options);
 822   if (!getToken(Options).empty())
 823     throw "help command takes at most one argument.";
 824
 825   // Getting detailed help on a particular command?
 826   if (!Command.empty()) {
 827     CLICommand *C = getCommand(Command);
 828     std::cout << C->getShortHelp() << ".\n" << C->getLongHelp();
 829
 830     // If there are aliases for this option, print them out.
 831     const std::vector<std::string> &Names = C->getOptionNames();
 832     if (Names.size() > 1) {
 833       std::cout << "The '" << Command << "' command is known as: '"
 834                 << Names[0] << "'";
 835       for (unsigned i = 1, e = Names.size(); i != e; ++i)
 836         std::cout << ", '" << Names[i] << "'";
 837       std::cout << "\n";
 838     }
 839
 840   } else {
 841     unsigned MaxSize = 0;
 842     for (std::map<std::string, CLICommand*>::iterator I = CommandTable.begin(),
 843            E = CommandTable.end(); I != E; ++I)
 844       if (I->first.size() > MaxSize &&
 845           I->first == I->second->getPrimaryOptionName())
 846         MaxSize = I->first.size();
 847
 848     // Loop over all of the commands, printing the short help version
 849     for (std::map<std::string, CLICommand*>::iterator I = CommandTable.begin(),
 850            E = CommandTable.end(); I != E; ++I)
 851       if (I->first == I->second->getPrimaryOptionName())
 852         std::cout << I->first << std::string(MaxSize - I->first.size(), ' ')
 853                   << " - " << I->second->getShortHelp() << "\n";
 854   }
 855 }