1 //===-- ProgramInfo.cpp - Compute and cache info about a program ----------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file implements the ProgramInfo and related classes, by sorting through
13 //===----------------------------------------------------------------------===//
15 #include "llvm/Debugger/ProgramInfo.h"
16 #include "llvm/Constants.h"
17 #include "llvm/Analysis/ValueTracking.h"
18 #include "llvm/DerivedTypes.h"
19 #include "llvm/Intrinsics.h"
20 #include "llvm/IntrinsicInst.h"
21 #include "llvm/Instructions.h"
22 #include "llvm/Module.h"
23 #include "llvm/Debugger/SourceFile.h"
24 #include "llvm/Debugger/SourceLanguage.h"
25 #include "llvm/Support/SlowOperationInformer.h"
26 #include "llvm/ADT/STLExtras.h"
29 /// getGlobalVariablesUsing - Return all of the global variables which have the
30 /// specified value in their initializer somewhere.
31 static void getGlobalVariablesUsing(Value *V,
32 std::vector<GlobalVariable*> &Found) {
33 for (Value::use_iterator I = V->use_begin(), E = V->use_end(); I != E; ++I) {
34 if (GlobalVariable *GV = dyn_cast<GlobalVariable>(*I))
36 else if (Constant *C = dyn_cast<Constant>(*I))
37 getGlobalVariablesUsing(C, Found);
41 /// getNextStopPoint - Follow the def-use chains of the specified LLVM value,
42 /// traversing the use chains until we get to a stoppoint. When we do, return
43 /// the source location of the stoppoint. If we don't find a stoppoint, return
45 static const GlobalVariable *getNextStopPoint(const Value *V, unsigned &LineNo,
47 // The use-def chains can fork. As such, we pick the lowest numbered one we
49 const GlobalVariable *LastDesc = 0;
50 unsigned LastLineNo = ~0;
51 unsigned LastColNo = ~0;
53 for (Value::use_const_iterator UI = V->use_begin(), E = V->use_end();
55 bool ShouldRecurse = true;
56 if (cast<Instruction>(*UI)->getOpcode() == Instruction::PHI) {
57 // Infinite loops == bad, ignore PHI nodes.
58 ShouldRecurse = false;
59 } else if (const CallInst *CI = dyn_cast<CallInst>(*UI)) {
61 // If we found a stop point, check to see if it is earlier than what we
62 // already have. If so, remember it.
63 if (CI->getCalledFunction())
64 if (const DbgStopPointInst *SPI = dyn_cast<DbgStopPointInst>(CI)) {
65 unsigned CurLineNo = SPI->getLine();
66 unsigned CurColNo = SPI->getColumn();
67 const GlobalVariable *CurDesc = 0;
68 const Value *Op = SPI->getContext();
70 if ((CurDesc = dyn_cast<GlobalVariable>(Op)) &&
71 (LineNo < LastLineNo ||
72 (LineNo == LastLineNo && ColNo < LastColNo))) {
74 LastLineNo = CurLineNo;
77 ShouldRecurse = false;
81 // If this is not a phi node or a stopping point, recursively scan the users
82 // of this instruction to skip over region.begin's and the like.
84 unsigned CurLineNo, CurColNo;
85 if (const GlobalVariable *GV = getNextStopPoint(*UI, CurLineNo,CurColNo)){
86 if (LineNo < LastLineNo || (LineNo == LastLineNo && ColNo < LastColNo)){
88 LastLineNo = CurLineNo;
96 LineNo = LastLineNo != ~0U ? LastLineNo : 0;
97 ColNo = LastColNo != ~0U ? LastColNo : 0;
103 //===----------------------------------------------------------------------===//
104 // SourceFileInfo implementation
107 SourceFileInfo::SourceFileInfo(const GlobalVariable *Desc,
108 const SourceLanguage &Lang)
109 : Language(&Lang), Descriptor(Desc) {
113 if (Desc && Desc->hasInitializer())
114 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Desc->getInitializer()))
115 if (CS->getNumOperands() > 4) {
116 if (ConstantInt *CUI = dyn_cast<ConstantInt>(CS->getOperand(1)))
117 Version = CUI->getZExtValue();
119 if (!GetConstantStringInfo(CS->getOperand(3), BaseName))
121 if (!GetConstantStringInfo(CS->getOperand(4), Directory))
126 SourceFileInfo::~SourceFileInfo() {
130 SourceFile &SourceFileInfo::getSourceText() const {
131 // FIXME: this should take into account the source search directories!
132 if (SourceText == 0) { // Read the file in if we haven't already.
134 if (!Directory.empty())
135 tmpPath.set(Directory);
136 tmpPath.appendComponent(BaseName);
137 if (tmpPath.canRead())
138 SourceText = new SourceFile(tmpPath.toString(), Descriptor);
140 SourceText = new SourceFile(BaseName, Descriptor);
146 //===----------------------------------------------------------------------===//
147 // SourceFunctionInfo implementation
149 SourceFunctionInfo::SourceFunctionInfo(ProgramInfo &PI,
150 const GlobalVariable *Desc)
153 if (Desc && Desc->hasInitializer())
154 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Desc->getInitializer()))
155 if (CS->getNumOperands() > 2) {
156 // Entry #1 is the file descriptor.
157 if (const GlobalVariable *GV =
158 dyn_cast<GlobalVariable>(CS->getOperand(1)))
159 SourceFile = &PI.getSourceFile(GV);
161 // Entry #2 is the function name.
162 if (!GetConstantStringInfo(CS->getOperand(2), Name))
167 /// getSourceLocation - This method returns the location of the first stopping
168 /// point in the function.
169 void SourceFunctionInfo::getSourceLocation(unsigned &RetLineNo,
170 unsigned &RetColNo) const {
171 // If we haven't computed this yet...
173 // Look at all of the users of the function descriptor, looking for calls to
174 // %llvm.dbg.func.start.
175 for (Value::use_const_iterator UI = Descriptor->use_begin(),
176 E = Descriptor->use_end(); UI != E; ++UI)
177 if (const CallInst *CI = dyn_cast<CallInst>(*UI))
178 if (const Function *F = CI->getCalledFunction())
179 if (F->getIntrinsicID() == Intrinsic::dbg_func_start) {
180 // We found the start of the function. Check to see if there are
181 // any stop points on the use-list of the function start.
182 const GlobalVariable *SD = getNextStopPoint(CI, LineNo, ColNo);
183 if (SD) { // We found the first stop point!
184 // This is just a sanity check.
185 if (getSourceFile().getDescriptor() != SD)
186 cout << "WARNING: first line of function is not in the"
187 << " file that the function descriptor claims it is in.\n";
192 RetLineNo = LineNo; RetColNo = ColNo;
195 //===----------------------------------------------------------------------===//
196 // ProgramInfo implementation
199 ProgramInfo::ProgramInfo(Module *m) : M(m), ProgramTimeStamp(0,0) {
200 assert(M && "Cannot create program information with a null module!");
201 sys::PathWithStatus ModPath(M->getModuleIdentifier());
202 const sys::FileStatus *Stat = ModPath.getFileStatus();
204 ProgramTimeStamp = Stat->getTimestamp();
206 SourceFilesIsComplete = false;
207 SourceFunctionsIsComplete = false;
210 ProgramInfo::~ProgramInfo() {
211 // Delete cached information about source program objects...
212 for (std::map<const GlobalVariable*, SourceFileInfo*>::iterator
213 I = SourceFiles.begin(), E = SourceFiles.end(); I != E; ++I)
215 for (std::map<const GlobalVariable*, SourceFunctionInfo*>::iterator
216 I = SourceFunctions.begin(), E = SourceFunctions.end(); I != E; ++I)
219 // Delete the source language caches.
220 for (unsigned i = 0, e = LanguageCaches.size(); i != e; ++i)
221 delete LanguageCaches[i].second;
225 //===----------------------------------------------------------------------===//
226 // SourceFileInfo tracking...
229 /// getSourceFile - Return source file information for the specified source file
230 /// descriptor object, adding it to the collection as needed. This method
231 /// always succeeds (is unambiguous), and is always efficient.
233 const SourceFileInfo &
234 ProgramInfo::getSourceFile(const GlobalVariable *Desc) {
235 SourceFileInfo *&Result = SourceFiles[Desc];
236 if (Result) return *Result;
238 // Figure out what language this source file comes from...
239 unsigned LangID = 0; // Zero is unknown language
240 if (Desc && Desc->hasInitializer())
241 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Desc->getInitializer()))
242 if (CS->getNumOperands() > 2)
243 if (ConstantInt *CUI = dyn_cast<ConstantInt>(CS->getOperand(2)))
244 LangID = CUI->getZExtValue();
246 const SourceLanguage &Lang = SourceLanguage::get(LangID);
247 SourceFileInfo *New = Lang.createSourceFileInfo(Desc, *this);
249 // FIXME: this should check to see if there is already a Filename/WorkingDir
250 // pair that matches this one. If so, we shouldn't create the duplicate!
252 SourceFileIndex.insert(std::make_pair(New->getBaseName(), New));
253 return *(Result = New);
257 /// getSourceFiles - Index all of the source files in the program and return
258 /// a mapping of it. This information is lazily computed the first time
259 /// that it is requested. Since this information can take a long time to
260 /// compute, the user is given a chance to cancel it. If this occurs, an
261 /// exception is thrown.
262 const std::map<const GlobalVariable*, SourceFileInfo*> &
263 ProgramInfo::getSourceFiles(bool RequiresCompleteMap) {
264 // If we have a fully populated map, or if the client doesn't need one, just
265 // return what we have.
266 if (SourceFilesIsComplete || !RequiresCompleteMap)
269 // Ok, all of the source file descriptors (compile_unit in dwarf terms),
270 // should be on the use list of the llvm.dbg.translation_units global.
272 GlobalVariable *Units =
273 M->getGlobalVariable("llvm.dbg.translation_units",
274 StructType::get(std::vector<const Type*>()));
276 throw "Program contains no debugging information!";
278 std::vector<GlobalVariable*> TranslationUnits;
279 getGlobalVariablesUsing(Units, TranslationUnits);
281 SlowOperationInformer SOI("building source files index");
283 // Loop over all of the translation units found, building the SourceFiles
285 for (unsigned i = 0, e = TranslationUnits.size(); i != e; ++i) {
286 getSourceFile(TranslationUnits[i]);
287 if (SOI.progress(i+1, e))
288 throw "While building source files index, operation cancelled.";
291 // Ok, if we got this far, then we indexed the whole program.
292 SourceFilesIsComplete = true;
296 /// getSourceFile - Look up the file with the specified name. If there is
297 /// more than one match for the specified filename, prompt the user to pick
298 /// one. If there is no source file that matches the specified name, throw
299 /// an exception indicating that we can't find the file. Otherwise, return
300 /// the file information for that file.
301 const SourceFileInfo &ProgramInfo::getSourceFile(const std::string &Filename) {
302 std::multimap<std::string, SourceFileInfo*>::const_iterator Start, End;
304 tie(Start, End) = SourceFileIndex.equal_range(Filename);
306 if (Start == End) throw "Could not find source file '" + Filename + "'!";
307 const SourceFileInfo &SFI = *Start->second;
309 if (Start == End) return SFI;
311 throw "FIXME: Multiple source files with the same name not implemented!";
315 //===----------------------------------------------------------------------===//
316 // SourceFunctionInfo tracking...
320 /// getFunction - Return function information for the specified function
321 /// descriptor object, adding it to the collection as needed. This method
322 /// always succeeds (is unambiguous), and is always efficient.
324 const SourceFunctionInfo &
325 ProgramInfo::getFunction(const GlobalVariable *Desc) {
326 SourceFunctionInfo *&Result = SourceFunctions[Desc];
327 if (Result) return *Result;
329 // Figure out what language this function comes from...
330 const GlobalVariable *SourceFileDesc = 0;
331 if (Desc && Desc->hasInitializer())
332 if (ConstantStruct *CS = dyn_cast<ConstantStruct>(Desc->getInitializer()))
333 if (CS->getNumOperands() > 0)
334 if (const GlobalVariable *GV =
335 dyn_cast<GlobalVariable>(CS->getOperand(1)))
338 const SourceLanguage &Lang = getSourceFile(SourceFileDesc).getLanguage();
339 return *(Result = Lang.createSourceFunctionInfo(Desc, *this));
343 // getSourceFunctions - Index all of the functions in the program and return
344 // them. This information is lazily computed the first time that it is
345 // requested. Since this information can take a long time to compute, the user
346 // is given a chance to cancel it. If this occurs, an exception is thrown.
347 const std::map<const GlobalVariable*, SourceFunctionInfo*> &
348 ProgramInfo::getSourceFunctions(bool RequiresCompleteMap) {
349 if (SourceFunctionsIsComplete || !RequiresCompleteMap)
350 return SourceFunctions;
352 // Ok, all of the source function descriptors (subprogram in dwarf terms),
353 // should be on the use list of the llvm.dbg.translation_units global.
355 GlobalVariable *Units =
356 M->getGlobalVariable("llvm.dbg.globals",
357 StructType::get(std::vector<const Type*>()));
359 throw "Program contains no debugging information!";
361 std::vector<GlobalVariable*> Functions;
362 getGlobalVariablesUsing(Units, Functions);
364 SlowOperationInformer SOI("building functions index");
366 // Loop over all of the functions found, building the SourceFunctions mapping.
367 for (unsigned i = 0, e = Functions.size(); i != e; ++i) {
368 getFunction(Functions[i]);
369 if (SOI.progress(i+1, e))
370 throw "While functions index, operation cancelled.";
373 // Ok, if we got this far, then we indexed the whole program.
374 SourceFunctionsIsComplete = true;
375 return SourceFunctions;