Adding support for placing global objects in shared data memory.
[oota-llvm.git] / lib / Target / PIC16 / PIC16TargetObjectFile.cpp
1 //===-- PIC16TargetObjectFile.cpp - PIC16 object files --------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9
10 #include "PIC16TargetObjectFile.h"
11 #include "PIC16ISelLowering.h"
12 #include "PIC16TargetMachine.h"
13 #include "PIC16Section.h"
14 #include "llvm/DerivedTypes.h"
15 #include "llvm/Module.h"
16 #include "llvm/MC/MCSection.h"
17 #include "llvm/MC/MCContext.h"
18 #include "llvm/Support/raw_ostream.h"
19 using namespace llvm;
20
21
22 PIC16TargetObjectFile::PIC16TargetObjectFile() {
23 }
24
25 PIC16TargetObjectFile::~PIC16TargetObjectFile() {
26 }
27
28 /// Find a pic16 section. Return null if not found. Do not create one.
29 PIC16Section *PIC16TargetObjectFile::
30 findPIC16Section(const std::string &Name) {
31   /// Return if we have an already existing one.
32   PIC16Section *Entry = SectionsByName[Name];
33   if (Entry)
34     return Entry;
35
36   return NULL;
37 }
38
39
40 /// Find a pic16 section. If not found, create one.
41 PIC16Section *PIC16TargetObjectFile::
42 getPIC16Section(const std::string &Name, PIC16SectionType Ty, 
43                 const std::string &Address, int Color) const {
44
45   /// Return if we have an already existing one.
46   PIC16Section *&Entry = SectionsByName[Name];
47   if (Entry)
48     return Entry;
49
50
51   Entry = PIC16Section::Create(Name, Ty, Address, Color, getContext());
52   return Entry;
53 }
54
55 /// Find a standard pic16 data section. If not found, create one and keep
56 /// track of it by adding it to appropriate std section list.
57 PIC16Section *PIC16TargetObjectFile::
58 getPIC16DataSection(const std::string &Name, PIC16SectionType Ty, 
59                     const std::string &Address, int Color) const {
60
61   /// Return if we have an already existing one.
62   PIC16Section *&Entry = SectionsByName[Name];
63   if (Entry)
64     return Entry;
65
66
67   /// Else create a new one and add it to appropriate section list.
68   Entry = PIC16Section::Create(Name, Ty, Address, Color, getContext());
69
70   switch (Ty) {
71   default: llvm_unreachable ("unknow standard section type.");
72   case UDATA: UDATASections_.push_back(Entry); break;
73   case IDATA: IDATASections_.push_back(Entry); break;
74   case ROMDATA: ROMDATASection_ = Entry; break;
75   case UDATA_SHR: SHAREDUDATASection_ = Entry; break;
76   }
77
78   return Entry;
79 }
80     
81
82 /// Find a standard pic16 autos section. If not found, create one and keep
83 /// track of it by adding it to appropriate std section list.
84 PIC16Section *PIC16TargetObjectFile::
85 getPIC16AutoSection(const std::string &Name, PIC16SectionType Ty, 
86                     const std::string &Address, int Color) const {
87
88   /// Return if we have an already existing one.
89   PIC16Section *&Entry = SectionsByName[Name];
90   if (Entry)
91     return Entry;
92
93
94   /// Else create a new one and add it to appropriate section list.
95   Entry = PIC16Section::Create(Name, Ty, Address, Color, getContext());
96
97   assert (Ty == UDATA_OVR && "incorrect section type for autos");
98   AUTOSections_.push_back(Entry);
99
100   return Entry;
101 }
102     
103 /// Find a pic16 user section. If not found, create one and keep
104 /// track of it by adding it to appropriate std section list.
105 PIC16Section *PIC16TargetObjectFile::
106 getPIC16UserSection(const std::string &Name, PIC16SectionType Ty, 
107                     const std::string &Address, int Color) const {
108
109   /// Return if we have an already existing one.
110   PIC16Section *&Entry = SectionsByName[Name];
111   if (Entry)
112     return Entry;
113
114
115   /// Else create a new one and add it to appropriate section list.
116   Entry = PIC16Section::Create(Name, Ty, Address, Color, getContext());
117
118   USERSections_.push_back(Entry);
119
120   return Entry;
121 }
122
123 /// Do some standard initialization.
124 void PIC16TargetObjectFile::Initialize(MCContext &Ctx, const TargetMachine &tm){
125   TargetLoweringObjectFile::Initialize(Ctx, tm);
126   TM = &tm;
127   
128   ROMDATASection_ = NULL;
129 }
130
131 /// allocateUDATA - Allocate a un-initialized global to an existing or new UDATA
132 /// section and return that section.
133 const MCSection *
134 PIC16TargetObjectFile::allocateUDATA(const GlobalVariable *GV) const {
135   assert(GV->hasInitializer() && "This global doesn't need space");
136   Constant *C = GV->getInitializer();
137   assert(C->isNullValue() && "Unitialized globals has non-zero initializer");
138
139   // Find how much space this global needs.
140   const TargetData *TD = TM->getTargetData();
141   const Type *Ty = C->getType(); 
142   unsigned ValSize = TD->getTypeAllocSize(Ty);
143  
144   // Go through all UDATA Sections and assign this variable
145   // to the first available section having enough space.
146   PIC16Section *Found = NULL;
147   for (unsigned i = 0; i < UDATASections_.size(); i++) {
148     if (DataBankSize - UDATASections_[i]->getSize() >= ValSize) {
149       Found = UDATASections_[i];
150       break;
151     }
152   }
153
154   // No UDATA section spacious enough was found. Crate a new one.
155   if (!Found) {
156     std::string name = PAN::getUdataSectionName(UDATASections_.size());
157     Found = getPIC16DataSection(name.c_str(), UDATA);
158   }
159   
160   // Insert the GV into this UDATA section.
161   Found->Items.push_back(GV);
162   Found->setSize(Found->getSize() + ValSize);
163   return Found;
164
165
166 /// allocateIDATA - allocate an initialized global into an existing
167 /// or new section and return that section.
168 const MCSection *
169 PIC16TargetObjectFile::allocateIDATA(const GlobalVariable *GV) const{
170   assert(GV->hasInitializer() && "This global doesn't need space");
171   Constant *C = GV->getInitializer();
172   assert(!C->isNullValue() && "initialized globals has zero initializer");
173   assert(GV->getType()->getAddressSpace() == PIC16ISD::RAM_SPACE &&
174          "can allocate initialized RAM data only");
175
176   // Find how much space this global needs.
177   const TargetData *TD = TM->getTargetData();
178   const Type *Ty = C->getType(); 
179   unsigned ValSize = TD->getTypeAllocSize(Ty);
180  
181   // Go through all IDATA Sections and assign this variable
182   // to the first available section having enough space.
183   PIC16Section *Found = NULL;
184   for (unsigned i = 0; i < IDATASections_.size(); i++) {
185     if (DataBankSize - IDATASections_[i]->getSize() >= ValSize) {
186       Found = IDATASections_[i]; 
187       break;
188     }
189   }
190
191   // No IDATA section spacious enough was found. Crate a new one.
192   if (!Found) {
193     std::string name = PAN::getIdataSectionName(IDATASections_.size());
194     Found = getPIC16DataSection(name.c_str(), IDATA);
195   }
196   
197   // Insert the GV into this IDATA.
198   Found->Items.push_back(GV);
199   Found->setSize(Found->getSize() + ValSize);
200   return Found;
201
202
203 // Allocate a program memory variable into ROMDATA section.
204 const MCSection *
205 PIC16TargetObjectFile::allocateROMDATA(const GlobalVariable *GV) const {
206
207   std::string name = PAN::getRomdataSectionName();
208   PIC16Section *S = getPIC16DataSection(name.c_str(), ROMDATA);
209
210   S->Items.push_back(GV);
211   return S;
212 }
213
214 // Get the section for an automatic variable of a function.
215 // For PIC16 they are globals only with mangled names.
216 const MCSection *
217 PIC16TargetObjectFile::allocateAUTO(const GlobalVariable *GV) const {
218
219   const std::string name = PAN::getSectionNameForSym(GV->getName());
220   PIC16Section *S = getPIC16AutoSection(name.c_str());
221
222   S->Items.push_back(GV);
223   return S;
224 }
225
226
227 // Override default implementation to put the true globals into
228 // multiple data sections if required.
229 const MCSection *
230 PIC16TargetObjectFile::SelectSectionForGlobal(const GlobalValue *GV1,
231                                               SectionKind Kind,
232                                               Mangler *Mang,
233                                               const TargetMachine &TM) const {
234   // We select the section based on the initializer here, so it really
235   // has to be a GlobalVariable.
236   const GlobalVariable *GV = dyn_cast<GlobalVariable>(GV1); 
237   if (!GV)
238     return TargetLoweringObjectFile::SelectSectionForGlobal(GV1, Kind, Mang,TM);
239
240   assert(GV->hasInitializer() && "A def without initializer?");
241
242   // First, if this is an automatic variable for a function, get the section
243   // name for it and return.
244   std::string name = GV->getName();
245   if (PAN::isLocalName(name))
246     return allocateAUTO(GV);
247
248   // See if this is an uninitialized global.
249   const Constant *C = GV->getInitializer();
250   if (C->isNullValue()) 
251     return allocateUDATA(GV);
252
253   // If this is initialized data in RAM. Put it in the correct IDATA section.
254   if (GV->getType()->getAddressSpace() == PIC16ISD::RAM_SPACE) 
255     return allocateIDATA(GV);
256
257   // This is initialized data in rom, put it in the readonly section.
258   if (GV->getType()->getAddressSpace() == PIC16ISD::ROM_SPACE) 
259     return allocateROMDATA(GV);
260
261   // Else let the default implementation take care of it.
262   return TargetLoweringObjectFile::SelectSectionForGlobal(GV, Kind, Mang,TM);
263 }
264
265
266
267
268 /// getExplicitSectionGlobal - Allow the target to completely override
269 /// section assignment of a global.
270 const MCSection *PIC16TargetObjectFile::
271 getExplicitSectionGlobal(const GlobalValue *GV, SectionKind Kind, 
272                          Mangler *Mang, const TargetMachine &TM) const {
273   assert(GV->hasSection());
274   
275   if (const GlobalVariable *GVar = cast<GlobalVariable>(GV)) {
276     std::string SectName = GVar->getSection();
277     // If address for a variable is specified, get the address and create
278     // section.
279     // FIXME: move this attribute checking in PAN.
280     std::string AddrStr = "Address=";
281     if (SectName.compare(0, AddrStr.length(), AddrStr) == 0) {
282       std::string SectAddr = SectName.substr(AddrStr.length());
283       if (SectAddr.compare("NEAR") == 0)
284         return allocateSHARED(GVar, Mang);
285       else
286         return allocateAtGivenAddress(GVar, SectAddr);
287     }
288      
289     // Create the section specified with section attribute. 
290     return allocateInGivenSection(GVar);
291   }
292
293   return getPIC16DataSection(GV->getSection().c_str(), UDATA);
294 }
295
296 const MCSection *
297 PIC16TargetObjectFile::allocateSHARED(const GlobalVariable *GV,
298                                       Mangler *Mang) const {
299   // Make sure that this is an uninitialized global.
300   assert(GV->hasInitializer() && "This global doesn't need space");
301   if (!GV->getInitializer()->isNullValue()) {
302     // FIXME: Generate a warning in this case that near qualifier will be 
303     // ignored.
304     return SelectSectionForGlobal(GV, SectionKind::getDataRel(), Mang, *TM); 
305   } 
306   std::string Name = PAN::getSharedUDataSectionName(); 
307
308   PIC16Section *SharedUDataSect = getPIC16DataSection(Name.c_str(), UDATA_SHR); 
309   // Insert the GV into shared section.
310   SharedUDataSect->Items.push_back(GV);
311   return SharedUDataSect;
312 }
313
314
315 // Interface used by AsmPrinter to get a code section for a function.
316 const PIC16Section *
317 PIC16TargetObjectFile::SectionForCode(const std::string &FnName) const {
318   const std::string &sec_name = PAN::getCodeSectionName(FnName);
319   return getPIC16Section(sec_name, CODE);
320 }
321
322 // Interface used by AsmPrinter to get a frame section for a function.
323 const PIC16Section *
324 PIC16TargetObjectFile::SectionForFrame(const std::string &FnName) const {
325   const std::string &sec_name = PAN::getFrameSectionName(FnName);
326   return getPIC16Section(sec_name, UDATA_OVR);
327 }
328
329 // Allocate a global var in existing or new section of given name.
330 const MCSection *
331 PIC16TargetObjectFile::allocateInGivenSection(const GlobalVariable *GV) const {
332   // Determine the type of section that we need to create.
333   PIC16SectionType SecTy;
334
335   // See if this is an uninitialized global.
336   const Constant *C = GV->getInitializer();
337   if (C->isNullValue())
338     SecTy = UDATA;
339   // If this is initialized data in RAM. Put it in the correct IDATA section.
340   else if (GV->getType()->getAddressSpace() == PIC16ISD::RAM_SPACE)
341     SecTy = IDATA;
342   // This is initialized data in rom, put it in the readonly section.
343   else if (GV->getType()->getAddressSpace() == PIC16ISD::ROM_SPACE) 
344     SecTy = ROMDATA;
345   else
346     llvm_unreachable ("Could not determine section type for global");
347
348   PIC16Section *S = getPIC16UserSection(GV->getSection().c_str(), SecTy);
349   S->Items.push_back(GV);
350   return S;
351 }
352
353 // Allocate a global var in a new absolute sections at given address.
354 const MCSection *
355 PIC16TargetObjectFile::allocateAtGivenAddress(const GlobalVariable *GV,
356                                                const std::string &Addr) const {
357   // Determine the type of section that we need to create.
358   PIC16SectionType SecTy;
359
360   // See if this is an uninitialized global.
361   const Constant *C = GV->getInitializer();
362   if (C->isNullValue())
363     SecTy = UDATA;
364   // If this is initialized data in RAM. Put it in the correct IDATA section.
365   else if (GV->getType()->getAddressSpace() == PIC16ISD::RAM_SPACE)
366     SecTy = IDATA;
367   // This is initialized data in rom, put it in the readonly section.
368   else if (GV->getType()->getAddressSpace() == PIC16ISD::ROM_SPACE) 
369     SecTy = ROMDATA;
370   else
371     llvm_unreachable ("Could not determine section type for global");
372
373   std::string Prefix = GV->getNameStr() + "." + Addr + ".";
374   std::string SName = PAN::getUserSectionName(Prefix);
375   PIC16Section *S = getPIC16UserSection(SName.c_str(), SecTy, Addr.c_str());
376   S->Items.push_back(GV);
377   return S;
378 }
379
380