2 //===-- PIC16DebugInfo.cpp - Implementation for PIC16 Debug Information ======//
4 // The LLVM Compiler Infrastructure
6 // This file is distributed under the University of Illinois Open Source
7 // License. See LICENSE.TXT for details.
9 //===----------------------------------------------------------------------===//
11 // This file contains the helper functions for representing debug information.
13 //===----------------------------------------------------------------------===//
16 #include "PIC16DebugInfo.h"
17 #include "llvm/GlobalVariable.h"
18 #include "llvm/CodeGen/MachineFunction.h"
19 #include "llvm/MC/MCAsmInfo.h"
20 #include "llvm/Support/DebugLoc.h"
21 #include "llvm/Support/FormattedStream.h"
22 #include "llvm/ADT/SmallString.h"
26 /// PopulateDebugInfo - Populate the TypeNo, Aux[] and TagName from Ty.
28 void PIC16DbgInfo::PopulateDebugInfo (DIType Ty, unsigned short &TypeNo,
29 bool &HasAux, int Aux[],
30 std::string &TagName) {
32 PopulateBasicTypeInfo (Ty, TypeNo);
33 else if (Ty.isDerivedType())
34 PopulateDerivedTypeInfo (Ty, TypeNo, HasAux, Aux, TagName);
35 else if (Ty.isCompositeType())
36 PopulateCompositeTypeInfo (Ty, TypeNo, HasAux, Aux, TagName);
38 TypeNo = PIC16Dbg::T_NULL;
44 /// PopulateBasicTypeInfo- Populate TypeNo for basic type from Ty.
46 void PIC16DbgInfo::PopulateBasicTypeInfo (DIType Ty, unsigned short &TypeNo) {
47 std::string Name = Ty.getName();
48 unsigned short BaseTy = GetTypeDebugNumber(Name);
49 TypeNo = TypeNo << PIC16Dbg::S_BASIC;
50 TypeNo = TypeNo | (0xffff & BaseTy);
53 /// PopulateDerivedTypeInfo - Populate TypeNo, Aux[], TagName for derived type
54 /// from Ty. Derived types are mostly pointers.
56 void PIC16DbgInfo::PopulateDerivedTypeInfo (DIType Ty, unsigned short &TypeNo,
57 bool &HasAux, int Aux[],
58 std::string &TagName) {
62 case dwarf::DW_TAG_pointer_type:
63 TypeNo = TypeNo << PIC16Dbg::S_DERIVED;
64 TypeNo = TypeNo | PIC16Dbg::DT_PTR;
67 TypeNo = TypeNo << PIC16Dbg::S_DERIVED;
70 // We also need to encode the the information about the base type of
72 DIType BaseType = DIDerivedType(Ty.getNode()).getTypeDerivedFrom();
73 PopulateDebugInfo(BaseType, TypeNo, HasAux, Aux, TagName);
76 /// PopulateArrayTypeInfo - Populate TypeNo, Aux[] for array from Ty.
77 void PIC16DbgInfo::PopulateArrayTypeInfo (DIType Ty, unsigned short &TypeNo,
78 bool &HasAux, int Aux[],
79 std::string &TagName) {
81 DICompositeType CTy = DICompositeType(Ty.getNode());
82 DIArray Elements = CTy.getTypeArray();
83 unsigned short size = 1;
84 unsigned short Dimension[4]={0,0,0,0};
85 for (unsigned i = 0, N = Elements.getNumElements(); i < N; ++i) {
86 DIDescriptor Element = Elements.getElement(i);
87 if (Element.getTag() == dwarf::DW_TAG_subrange_type) {
88 TypeNo = TypeNo << PIC16Dbg::S_DERIVED;
89 TypeNo = TypeNo | PIC16Dbg::DT_ARY;
90 DISubrange SubRange = DISubrange(Element.getNode());
91 Dimension[i] = SubRange.getHi() - SubRange.getLo() + 1;
92 // Each dimension is represented by 2 bytes starting at byte 9.
93 Aux[8+i*2+0] = Dimension[i];
94 Aux[8+i*2+1] = Dimension[i] >> 8;
95 size = size * Dimension[i];
99 // In auxillary entry for array, 7th and 8th byte represent array size.
100 Aux[6] = size & 0xff;
102 DIType BaseType = CTy.getTypeDerivedFrom();
103 PopulateDebugInfo(BaseType, TypeNo, HasAux, Aux, TagName);
106 /// PopulateStructOrUnionTypeInfo - Populate TypeNo, Aux[] , TagName for
107 /// structure or union.
109 void PIC16DbgInfo::PopulateStructOrUnionTypeInfo (DIType Ty,
110 unsigned short &TypeNo,
111 bool &HasAux, int Aux[],
112 std::string &TagName) {
113 DICompositeType CTy = DICompositeType(Ty.getNode());
114 TypeNo = TypeNo << PIC16Dbg::S_BASIC;
115 if (Ty.getTag() == dwarf::DW_TAG_structure_type)
116 TypeNo = TypeNo | PIC16Dbg::T_STRUCT;
118 TypeNo = TypeNo | PIC16Dbg::T_UNION;
119 TagName = CTy.getName();
120 // UniqueSuffix is .number where number is obtained from
121 // llvm.dbg.composite<number>.
122 // FIXME: This will break when composite type is not represented by
123 // llvm.dbg.composite* global variable. Since we need to revisit
124 // PIC16DebugInfo implementation anyways after the MDNodes based
125 // framework is done, let us continue with the way it is.
126 std::string UniqueSuffix = "." + Ty.getNode()->getNameStr().substr(18);
127 TagName += UniqueSuffix;
128 unsigned short size = CTy.getSizeInBits()/8;
129 // 7th and 8th byte represent size.
131 Aux[6] = size & 0xff;
135 /// PopulateEnumTypeInfo - Populate TypeNo for enum from Ty.
136 void PIC16DbgInfo::PopulateEnumTypeInfo (DIType Ty, unsigned short &TypeNo) {
137 TypeNo = TypeNo << PIC16Dbg::S_BASIC;
138 TypeNo = TypeNo | PIC16Dbg::T_ENUM;
141 /// PopulateCompositeTypeInfo - Populate TypeNo, Aux[] and TagName for
142 /// composite types from Ty.
144 void PIC16DbgInfo::PopulateCompositeTypeInfo (DIType Ty, unsigned short &TypeNo,
145 bool &HasAux, int Aux[],
146 std::string &TagName) {
147 switch (Ty.getTag()) {
148 case dwarf::DW_TAG_array_type: {
149 PopulateArrayTypeInfo (Ty, TypeNo, HasAux, Aux, TagName);
152 case dwarf:: DW_TAG_union_type:
153 case dwarf::DW_TAG_structure_type: {
154 PopulateStructOrUnionTypeInfo (Ty, TypeNo, HasAux, Aux, TagName);
157 case dwarf::DW_TAG_enumeration_type: {
158 PopulateEnumTypeInfo (Ty, TypeNo);
162 TypeNo = TypeNo << PIC16Dbg::S_DERIVED;
166 /// GetTypeDebugNumber - Get debug type number for given type.
168 unsigned PIC16DbgInfo::GetTypeDebugNumber(std::string &type) {
170 return PIC16Dbg::T_CHAR;
171 else if (type == "short")
172 return PIC16Dbg::T_SHORT;
173 else if (type == "int")
174 return PIC16Dbg::T_INT;
175 else if (type == "long")
176 return PIC16Dbg::T_LONG;
177 else if (type == "unsigned char")
178 return PIC16Dbg::T_UCHAR;
179 else if (type == "unsigned short")
180 return PIC16Dbg::T_USHORT;
181 else if (type == "unsigned int")
182 return PIC16Dbg::T_UINT;
183 else if (type == "unsigned long")
184 return PIC16Dbg::T_ULONG;
189 /// GetStorageClass - Get storage class for give debug variable.
191 short PIC16DbgInfo::getStorageClass(DIGlobalVariable DIGV) {
193 if (PAN::isLocalName(DIGV.getGlobal()->getName())) {
194 // Generating C_AUTO here fails due to error in linker. Change it once
196 ClassNo = PIC16Dbg::C_STAT;
198 else if (DIGV.isLocalToUnit())
199 ClassNo = PIC16Dbg::C_STAT;
201 ClassNo = PIC16Dbg::C_EXT;
205 /// BeginModule - Emit necessary debug info to start a Module and do other
206 /// required initializations.
207 void PIC16DbgInfo::BeginModule(Module &M) {
208 // Emit file directive for module.
209 DebugInfoFinder DbgFinder;
210 DbgFinder.processModule(M);
211 if (DbgFinder.compile_unit_count() != 0) {
212 // FIXME : What if more then one CUs are present in a module ?
213 MDNode *CU = *DbgFinder.compile_unit_begin();
214 EmitDebugDirectives = true;
217 // Emit debug info for decls of composite types.
218 EmitCompositeTypeDecls(M);
221 /// Helper to find first valid debug loc for a function.
223 static const DebugLoc GetDebugLocForFunction(const MachineFunction &MF) {
225 for (MachineFunction::const_iterator I = MF.begin(), E = MF.end();
227 for (MachineBasicBlock::const_iterator II = I->begin(), E = I->end();
229 DL = II->getDebugLoc();
237 /// BeginFunction - Emit necessary debug info to start a function.
239 void PIC16DbgInfo::BeginFunction(const MachineFunction &MF) {
240 if (! EmitDebugDirectives) return;
242 // Retreive the first valid debug Loc and process it.
243 const DebugLoc &DL = GetDebugLocForFunction(MF);
244 // Emit debug info only if valid debug info is available.
245 if (!DL.isUnknown()) {
246 ChangeDebugLoc(MF, DL, true);
247 EmitFunctBeginDI(MF.getFunction());
249 // Set current line to 0 so that.line directive is genearted after .bf.
253 /// ChangeDebugLoc - Take necessary steps when DebugLoc changes.
254 /// CurFile and CurLine may change as a result of this.
256 void PIC16DbgInfo::ChangeDebugLoc(const MachineFunction &MF,
257 const DebugLoc &DL, bool IsInBeginFunction) {
258 if (! EmitDebugDirectives) return;
259 assert (! DL.isUnknown() && "can't change to invalid debug loc");
261 MDNode *CU = MF.getDebugLocTuple(DL).Scope;
262 unsigned line = MF.getDebugLocTuple(DL).Line;
265 SwitchToLine(line, IsInBeginFunction);
268 /// SwitchToLine - Emit line directive for a new line.
270 void PIC16DbgInfo::SwitchToLine(unsigned Line, bool IsInBeginFunction) {
271 if (CurLine == Line) return;
272 if (!IsInBeginFunction) O << "\n\t.line " << Line << "\n";
276 /// EndFunction - Emit .ef for end of function.
278 void PIC16DbgInfo::EndFunction(const MachineFunction &MF) {
279 if (! EmitDebugDirectives) return;
280 const DebugLoc &DL = GetDebugLocForFunction(MF);
281 // Emit debug info only if valid debug info is available.
283 EmitFunctEndDI(MF.getFunction(), CurLine);
286 /// EndModule - Emit .eof for end of module.
288 void PIC16DbgInfo::EndModule(Module &M) {
289 if (! EmitDebugDirectives) return;
291 if (CurFile != "") O << "\n\t.eof";
294 /// EmitCompositeTypeElements - Emit debug information for members of a
297 void PIC16DbgInfo::EmitCompositeTypeElements (DICompositeType CTy,
298 std::string SuffixNo) {
299 unsigned long Value = 0;
300 DIArray Elements = CTy.getTypeArray();
301 for (unsigned i = 0, N = Elements.getNumElements(); i < N; i++) {
302 DIDescriptor Element = Elements.getElement(i);
303 unsigned short TypeNo = 0;
305 int ElementAux[PIC16Dbg::AuxSize] = { 0 };
306 std::string TagName = "";
307 DIDerivedType DITy(Element.getNode());
308 const char *ElementName = DITy.getName();
309 unsigned short ElementSize = DITy.getSizeInBits()/8;
310 // Get mangleddd name for this structure/union element.
311 std::string MangMemName = ElementName + SuffixNo;
312 PopulateDebugInfo(DITy, TypeNo, HasAux, ElementAux, TagName);
314 if( CTy.getTag() == dwarf::DW_TAG_union_type)
315 Class = PIC16Dbg::C_MOU;
316 else if (CTy.getTag() == dwarf::DW_TAG_structure_type)
317 Class = PIC16Dbg::C_MOS;
318 EmitSymbol(MangMemName.c_str(), Class, TypeNo, Value);
319 if (CTy.getTag() == dwarf::DW_TAG_structure_type)
320 Value += ElementSize;
322 EmitAuxEntry(MangMemName.c_str(), ElementAux, PIC16Dbg::AuxSize, TagName);
326 /// EmitCompositeTypeDecls - Emit composite type declarations like structure
327 /// and union declarations.
329 void PIC16DbgInfo::EmitCompositeTypeDecls(Module &M) {
330 DebugInfoFinder DbgFinder;
331 DbgFinder.processModule(M);
332 for (DebugInfoFinder::iterator I = DbgFinder.type_begin(),
333 E = DbgFinder.type_end(); I != E; ++I) {
334 DICompositeType CTy(*I);
337 if (CTy.getTag() == dwarf::DW_TAG_union_type ||
338 CTy.getTag() == dwarf::DW_TAG_structure_type ) {
339 const char *Name = CTy.getName();
340 // Get the number after llvm.dbg.composite and make UniqueSuffix from
342 std::string DIVar = CTy.getNode()->getNameStr();
343 std::string UniqueSuffix = "." + DIVar.substr(18);
344 std::string MangledCTyName = Name + UniqueSuffix;
345 unsigned short size = CTy.getSizeInBits()/8;
346 int Aux[PIC16Dbg::AuxSize] = {0};
347 // 7th and 8th byte represent size of structure/union.
348 Aux[6] = size & 0xff;
350 // Emit .def for structure/union tag.
351 if( CTy.getTag() == dwarf::DW_TAG_union_type)
352 EmitSymbol(MangledCTyName.c_str(), PIC16Dbg::C_UNTAG);
353 else if (CTy.getTag() == dwarf::DW_TAG_structure_type)
354 EmitSymbol(MangledCTyName.c_str(), PIC16Dbg::C_STRTAG);
356 // Emit auxiliary debug information for structure/union tag.
357 EmitAuxEntry(MangledCTyName.c_str(), Aux, PIC16Dbg::AuxSize);
360 EmitCompositeTypeElements (CTy, UniqueSuffix);
362 // Emit mangled Symbol for end of structure/union.
363 std::string EOSSymbol = ".eos" + UniqueSuffix;
364 EmitSymbol(EOSSymbol.c_str(), PIC16Dbg::C_EOS);
365 EmitAuxEntry(EOSSymbol.c_str(), Aux, PIC16Dbg::AuxSize,
366 MangledCTyName.c_str());
372 /// EmitFunctBeginDI - Emit .bf for function.
374 void PIC16DbgInfo::EmitFunctBeginDI(const Function *F) {
375 std::string FunctName = F->getName();
376 if (EmitDebugDirectives) {
377 std::string FunctBeginSym = ".bf." + FunctName;
378 std::string BlockBeginSym = ".bb." + FunctName;
380 int BFAux[PIC16Dbg::AuxSize] = {0};
382 BFAux[5] = CurLine >> 8;
384 // Emit debug directives for beginning of function.
385 EmitSymbol(FunctBeginSym, PIC16Dbg::C_FCN);
386 EmitAuxEntry(FunctBeginSym, BFAux, PIC16Dbg::AuxSize);
388 EmitSymbol(BlockBeginSym, PIC16Dbg::C_BLOCK);
389 EmitAuxEntry(BlockBeginSym, BFAux, PIC16Dbg::AuxSize);
393 /// EmitFunctEndDI - Emit .ef for function end.
395 void PIC16DbgInfo::EmitFunctEndDI(const Function *F, unsigned Line) {
396 std::string FunctName = F->getName();
397 if (EmitDebugDirectives) {
398 std::string FunctEndSym = ".ef." + FunctName;
399 std::string BlockEndSym = ".eb." + FunctName;
401 // Emit debug directives for end of function.
402 EmitSymbol(BlockEndSym, PIC16Dbg::C_BLOCK);
403 int EFAux[PIC16Dbg::AuxSize] = {0};
404 // 5th and 6th byte stand for line number.
406 EFAux[5] = CurLine >> 8;
407 EmitAuxEntry(BlockEndSym, EFAux, PIC16Dbg::AuxSize);
408 EmitSymbol(FunctEndSym, PIC16Dbg::C_FCN);
409 EmitAuxEntry(FunctEndSym, EFAux, PIC16Dbg::AuxSize);
413 /// EmitAuxEntry - Emit Auxiliary debug information.
415 void PIC16DbgInfo::EmitAuxEntry(const std::string VarName, int Aux[], int Num,
416 std::string TagName) {
417 O << "\n\t.dim " << VarName << ", 1" ;
418 // TagName is emitted in case of structure/union objects.
420 O << ", " << TagName;
421 for (int i = 0; i<Num; i++)
425 /// EmitSymbol - Emit .def for a symbol. Value is offset for the member.
427 void PIC16DbgInfo::EmitSymbol(std::string Name, short Class, unsigned short
428 Type, unsigned long Value) {
429 O << "\n\t" << ".def "<< Name << ", type = " << Type << ", class = "
432 O << ", value = " << Value;
435 /// EmitVarDebugInfo - Emit debug information for all variables.
437 void PIC16DbgInfo::EmitVarDebugInfo(Module &M) {
438 DebugInfoFinder DbgFinder;
439 DbgFinder.processModule(M);
441 for (DebugInfoFinder::iterator I = DbgFinder.global_variable_begin(),
442 E = DbgFinder.global_variable_end(); I != E; ++I) {
443 DIGlobalVariable DIGV(*I);
444 DIType Ty = DIGV.getType();
445 unsigned short TypeNo = 0;
447 int Aux[PIC16Dbg::AuxSize] = { 0 };
448 std::string TagName = "";
449 std::string VarName = MAI->getGlobalPrefix()+DIGV.getGlobal()->getNameStr();
450 PopulateDebugInfo(Ty, TypeNo, HasAux, Aux, TagName);
451 // Emit debug info only if type information is availaible.
452 if (TypeNo != PIC16Dbg::T_NULL) {
453 O << "\n\t.type " << VarName << ", " << TypeNo;
454 short ClassNo = getStorageClass(DIGV);
455 O << "\n\t.class " << VarName << ", " << ClassNo;
457 EmitAuxEntry(VarName, Aux, PIC16Dbg::AuxSize, TagName);
463 /// SwitchToCU - Switch to a new compilation unit.
465 void PIC16DbgInfo::SwitchToCU(MDNode *CU) {
466 // Get the file path from CU.
467 DICompileUnit cu(CU);
468 std::string DirName = cu.getDirectory();
469 std::string FileName = cu.getFilename();
470 std::string FilePath = DirName + "/" + FileName;
472 // Nothing to do if source file is still same.
473 if ( FilePath == CurFile ) return;
475 // Else, close the current one and start a new.
476 if (CurFile != "") O << "\n\t.eof";
477 O << "\n\t.file\t\"" << FilePath << "\"\n" ;
482 /// EmitEOF - Emit .eof for end of file.
484 void PIC16DbgInfo::EmitEOF() {