ad4f01b7a9ad87eb193427faf28281d0f6b454b8
[oota-llvm.git] / lib / CodeGen / MachineModuleInfo.cpp
1 //===-- llvm/CodeGen/MachineModuleInfo.cpp ----------------------*- C++ -*-===//
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 "llvm/CodeGen/MachineModuleInfo.h"
11
12 #include "llvm/Constants.h"
13 #include "llvm/DerivedTypes.h"
14 #include "llvm/GlobalVariable.h"
15 #include "llvm/Intrinsics.h"
16 #include "llvm/Instructions.h"
17 #include "llvm/Module.h"
18 #include "llvm/Analysis/ValueTracking.h"
19 #include "llvm/CodeGen/MachineFunctionPass.h"
20 #include "llvm/CodeGen/MachineFunction.h"
21 #include "llvm/CodeGen/Passes.h"
22 #include "llvm/Target/TargetInstrInfo.h"
23 #include "llvm/Target/TargetMachine.h"
24 #include "llvm/Target/TargetOptions.h"
25 #include "llvm/MC/MCSymbol.h"
26 #include "llvm/ADT/PointerUnion.h"
27 #include "llvm/Support/Dwarf.h"
28 #include "llvm/Support/ErrorHandling.h"
29 using namespace llvm;
30 using namespace llvm::dwarf;
31
32 // Handle the Pass registration stuff necessary to use TargetData's.
33 static RegisterPass<MachineModuleInfo>
34 X("machinemoduleinfo", "Machine Module Information");
35 char MachineModuleInfo::ID = 0;
36
37 // Out of line virtual method.
38 MachineModuleInfoImpl::~MachineModuleInfoImpl() {}
39
40 namespace llvm {
41 class MMIAddrLabelMapCallbackPtr : CallbackVH {
42   MMIAddrLabelMap *Map;
43 public:
44   MMIAddrLabelMapCallbackPtr() : Map(0) {}
45   MMIAddrLabelMapCallbackPtr(Value *V) : CallbackVH(V), Map(0) {}
46   
47   void setPtr(BasicBlock *BB) {
48     ValueHandleBase::operator=(BB);
49   }
50     
51   void setMap(MMIAddrLabelMap *map) { Map = map; }
52   
53   virtual void deleted();
54   virtual void allUsesReplacedWith(Value *V2);
55 };
56   
57 class MMIAddrLabelMap {
58   MCContext &Context;
59   struct AddrLabelSymEntry {
60     /// Symbols - The symbols for the label.  This is a pointer union that is
61     /// either one symbol (the common case) or a list of symbols.
62     PointerUnion<MCSymbol *, std::vector<MCSymbol*>*> Symbols;
63     
64     Function *Fn;   // The containing function of the BasicBlock.
65     unsigned Index; // The index in BBCallbacks for the BasicBlock.
66   };
67   
68   DenseMap<AssertingVH<BasicBlock>, AddrLabelSymEntry> AddrLabelSymbols;
69   
70   /// BBCallbacks - Callbacks for the BasicBlock's that we have entries for.  We
71   /// use this so we get notified if a block is deleted or RAUWd.
72   std::vector<MMIAddrLabelMapCallbackPtr> BBCallbacks;
73
74   /// DeletedAddrLabelsNeedingEmission - This is a per-function list of symbols
75   /// whose corresponding BasicBlock got deleted.  These symbols need to be
76   /// emitted at some point in the file, so AsmPrinter emits them after the
77   /// function body.
78   DenseMap<AssertingVH<Function>, std::vector<MCSymbol*> >
79     DeletedAddrLabelsNeedingEmission;
80 public:
81   
82   MMIAddrLabelMap(MCContext &context) : Context(context) {}
83   ~MMIAddrLabelMap() {
84     assert(DeletedAddrLabelsNeedingEmission.empty() &&
85            "Some labels for deleted blocks never got emitted");
86     
87     // Deallocate any of the 'list of symbols' case.
88     for (DenseMap<AssertingVH<BasicBlock>, AddrLabelSymEntry>::iterator
89          I = AddrLabelSymbols.begin(), E = AddrLabelSymbols.end(); I != E; ++I)
90       if (I->second.Symbols.is<std::vector<MCSymbol*>*>())
91         delete I->second.Symbols.get<std::vector<MCSymbol*>*>();
92   }
93   
94   MCSymbol *getAddrLabelSymbol(BasicBlock *BB);
95   std::vector<MCSymbol*> getAddrLabelSymbolToEmit(BasicBlock *BB);
96
97   void takeDeletedSymbolsForFunction(Function *F, 
98                                      std::vector<MCSymbol*> &Result);
99
100   void UpdateForDeletedBlock(BasicBlock *BB);
101   void UpdateForRAUWBlock(BasicBlock *Old, BasicBlock *New);
102 };
103 }
104
105 MCSymbol *MMIAddrLabelMap::getAddrLabelSymbol(BasicBlock *BB) {
106   assert(BB->hasAddressTaken() &&
107          "Shouldn't get label for block without address taken");
108   AddrLabelSymEntry &Entry = AddrLabelSymbols[BB];
109   
110   // If we already had an entry for this block, just return it.
111   if (!Entry.Symbols.isNull()) {
112     assert(BB->getParent() == Entry.Fn && "Parent changed");
113     if (Entry.Symbols.is<MCSymbol*>())
114       return Entry.Symbols.get<MCSymbol*>();
115     return (*Entry.Symbols.get<std::vector<MCSymbol*>*>())[0];
116   }
117   
118   // Otherwise, this is a new entry, create a new symbol for it and add an
119   // entry to BBCallbacks so we can be notified if the BB is deleted or RAUWd.
120   BBCallbacks.push_back(BB);
121   BBCallbacks.back().setMap(this);
122   Entry.Index = BBCallbacks.size()-1;
123   Entry.Fn = BB->getParent();
124   MCSymbol *Result = Context.CreateTempSymbol();
125   Entry.Symbols = Result;
126   return Result;
127 }
128
129 std::vector<MCSymbol*>
130 MMIAddrLabelMap::getAddrLabelSymbolToEmit(BasicBlock *BB) {
131   assert(BB->hasAddressTaken() &&
132          "Shouldn't get label for block without address taken");
133   AddrLabelSymEntry &Entry = AddrLabelSymbols[BB];
134   
135   std::vector<MCSymbol*> Result;
136   
137   // If we already had an entry for this block, just return it.
138   if (Entry.Symbols.isNull())
139     Result.push_back(getAddrLabelSymbol(BB));
140   else if (MCSymbol *Sym = Entry.Symbols.dyn_cast<MCSymbol*>())
141     Result.push_back(Sym);
142   else
143     Result = *Entry.Symbols.get<std::vector<MCSymbol*>*>();
144   return Result;
145 }
146
147
148 /// takeDeletedSymbolsForFunction - If we have any deleted symbols for F, return
149 /// them.
150 void MMIAddrLabelMap::
151 takeDeletedSymbolsForFunction(Function *F, std::vector<MCSymbol*> &Result) {
152   DenseMap<AssertingVH<Function>, std::vector<MCSymbol*> >::iterator I =
153     DeletedAddrLabelsNeedingEmission.find(F);
154
155   // If there are no entries for the function, just return.
156   if (I == DeletedAddrLabelsNeedingEmission.end()) return;
157   
158   // Otherwise, take the list.
159   std::swap(Result, I->second);
160   DeletedAddrLabelsNeedingEmission.erase(I);
161 }
162
163
164 void MMIAddrLabelMap::UpdateForDeletedBlock(BasicBlock *BB) {
165   // If the block got deleted, there is no need for the symbol.  If the symbol
166   // was already emitted, we can just forget about it, otherwise we need to
167   // queue it up for later emission when the function is output.
168   AddrLabelSymEntry Entry = AddrLabelSymbols[BB];
169   AddrLabelSymbols.erase(BB);
170   assert(!Entry.Symbols.isNull() && "Didn't have a symbol, why a callback?");
171   BBCallbacks[Entry.Index] = 0;  // Clear the callback.
172
173   assert((BB->getParent() == 0 || BB->getParent() == Entry.Fn) &&
174          "Block/parent mismatch");
175
176   // Handle both the single and the multiple symbols cases.
177   if (MCSymbol *Sym = Entry.Symbols.dyn_cast<MCSymbol*>()) {
178     if (Sym->isDefined())
179       return;
180   
181     // If the block is not yet defined, we need to emit it at the end of the
182     // function.  Add the symbol to the DeletedAddrLabelsNeedingEmission list
183     // for the containing Function.  Since the block is being deleted, its
184     // parent may already be removed, we have to get the function from 'Entry'.
185     DeletedAddrLabelsNeedingEmission[Entry.Fn].push_back(Sym);
186   } else {
187     std::vector<MCSymbol*> *Syms = Entry.Symbols.get<std::vector<MCSymbol*>*>();
188
189     for (unsigned i = 0, e = Syms->size(); i != e; ++i) {
190       MCSymbol *Sym = (*Syms)[i];
191       if (Sym->isDefined()) continue;  // Ignore already emitted labels.
192       
193       // If the block is not yet defined, we need to emit it at the end of the
194       // function.  Add the symbol to the DeletedAddrLabelsNeedingEmission list
195       // for the containing Function.  Since the block is being deleted, its
196       // parent may already be removed, we have to get the function from
197       // 'Entry'.
198       DeletedAddrLabelsNeedingEmission[Entry.Fn].push_back(Sym);
199     }
200     
201     // The entry is deleted, free the memory associated with the symbol list.
202     delete Syms;
203   }
204 }
205
206 void MMIAddrLabelMap::UpdateForRAUWBlock(BasicBlock *Old, BasicBlock *New) {
207   // Get the entry for the RAUW'd block and remove it from our map.
208   AddrLabelSymEntry OldEntry = AddrLabelSymbols[Old];
209   AddrLabelSymbols.erase(Old);
210   assert(!OldEntry.Symbols.isNull() && "Didn't have a symbol, why a callback?");
211
212   AddrLabelSymEntry &NewEntry = AddrLabelSymbols[New];
213
214   // If New is not address taken, just move our symbol over to it.
215   if (NewEntry.Symbols.isNull()) {
216     BBCallbacks[OldEntry.Index].setPtr(New);    // Update the callback.
217     NewEntry = OldEntry;     // Set New's entry.
218     return;
219   }
220
221   BBCallbacks[OldEntry.Index] = 0;    // Update the callback.
222
223   // Otherwise, we need to add the old symbol to the new block's set.  If it is
224   // just a single entry, upgrade it to a symbol list.
225   if (MCSymbol *PrevSym = NewEntry.Symbols.dyn_cast<MCSymbol*>()) {
226     std::vector<MCSymbol*> *SymList = new std::vector<MCSymbol*>();
227     SymList->push_back(PrevSym);
228     NewEntry.Symbols = SymList;
229   }
230       
231   std::vector<MCSymbol*> *SymList =
232     NewEntry.Symbols.get<std::vector<MCSymbol*>*>();
233
234   // If the old entry was a single symbol, add it.
235   if (MCSymbol *Sym = OldEntry.Symbols.dyn_cast<MCSymbol*>()) {
236     SymList->push_back(Sym);
237     return;
238   }
239   
240   // Otherwise, concatenate the list.
241   std::vector<MCSymbol*> *Syms =OldEntry.Symbols.get<std::vector<MCSymbol*>*>();
242   SymList->insert(SymList->end(), Syms->begin(), Syms->end());
243   delete Syms;
244 }
245
246
247 void MMIAddrLabelMapCallbackPtr::deleted() {
248   Map->UpdateForDeletedBlock(cast<BasicBlock>(getValPtr()));
249 }
250
251 void MMIAddrLabelMapCallbackPtr::allUsesReplacedWith(Value *V2) {
252   Map->UpdateForRAUWBlock(cast<BasicBlock>(getValPtr()), cast<BasicBlock>(V2));
253 }
254
255
256 //===----------------------------------------------------------------------===//
257
258 MachineModuleInfo::MachineModuleInfo(const MCAsmInfo &MAI)
259 : ImmutablePass(&ID), Context(MAI),
260   ObjFileMMI(0),
261   CurCallSite(0), CallsEHReturn(0), CallsUnwindInit(0), DbgInfoAvailable(false){
262   // Always emit some info, by default "no personality" info.
263   Personalities.push_back(NULL);
264   AddrLabelSymbols = 0;
265 }
266
267 MachineModuleInfo::MachineModuleInfo()
268 : ImmutablePass(&ID), Context(*(MCAsmInfo*)0) {
269   assert(0 && "This MachineModuleInfo constructor should never be called, MMI "
270          "should always be explicitly constructed by LLVMTargetMachine");
271   abort();
272 }
273
274 MachineModuleInfo::~MachineModuleInfo() {
275   delete ObjFileMMI;
276   
277   // FIXME: Why isn't doFinalization being called??
278   //assert(AddrLabelSymbols == 0 && "doFinalization not called");
279   delete AddrLabelSymbols;
280   AddrLabelSymbols = 0;
281 }
282
283 /// doInitialization - Initialize the state for a new module.
284 ///
285 bool MachineModuleInfo::doInitialization() {
286   assert(AddrLabelSymbols == 0 && "Improperly initialized");
287   return false;
288 }
289
290 /// doFinalization - Tear down the state after completion of a module.
291 ///
292 bool MachineModuleInfo::doFinalization() {
293   delete AddrLabelSymbols;
294   AddrLabelSymbols = 0;
295   return false;
296 }
297
298 /// EndFunction - Discard function meta information.
299 ///
300 void MachineModuleInfo::EndFunction() {
301   // Clean up frame info.
302   FrameMoves.clear();
303
304   // Clean up exception info.
305   LandingPads.clear();
306   CallSiteMap.clear();
307   TypeInfos.clear();
308   FilterIds.clear();
309   FilterEnds.clear();
310   CallsEHReturn = 0;
311   CallsUnwindInit = 0;
312   VariableDbgInfo.clear();
313 }
314
315 /// AnalyzeModule - Scan the module for global debug information.
316 ///
317 void MachineModuleInfo::AnalyzeModule(Module &M) {
318   // Insert functions in the llvm.used array (but not llvm.compiler.used) into
319   // UsedFunctions.
320   GlobalVariable *GV = M.getGlobalVariable("llvm.used");
321   if (!GV || !GV->hasInitializer()) return;
322
323   // Should be an array of 'i8*'.
324   ConstantArray *InitList = dyn_cast<ConstantArray>(GV->getInitializer());
325   if (InitList == 0) return;
326
327   for (unsigned i = 0, e = InitList->getNumOperands(); i != e; ++i)
328     if (Function *F =
329           dyn_cast<Function>(InitList->getOperand(i)->stripPointerCasts()))
330       UsedFunctions.insert(F);
331 }
332
333 //===- Address of Block Management ----------------------------------------===//
334
335
336 /// getAddrLabelSymbol - Return the symbol to be used for the specified basic
337 /// block when its address is taken.  This cannot be its normal LBB label
338 /// because the block may be accessed outside its containing function.
339 MCSymbol *MachineModuleInfo::getAddrLabelSymbol(const BasicBlock *BB) {
340   // Lazily create AddrLabelSymbols.
341   if (AddrLabelSymbols == 0)
342     AddrLabelSymbols = new MMIAddrLabelMap(Context);
343   return AddrLabelSymbols->getAddrLabelSymbol(const_cast<BasicBlock*>(BB));
344 }
345
346 /// getAddrLabelSymbolToEmit - Return the symbol to be used for the specified
347 /// basic block when its address is taken.  If other blocks were RAUW'd to
348 /// this one, we may have to emit them as well, return the whole set.
349 std::vector<MCSymbol*> MachineModuleInfo::
350 getAddrLabelSymbolToEmit(const BasicBlock *BB) {
351   // Lazily create AddrLabelSymbols.
352   if (AddrLabelSymbols == 0)
353     AddrLabelSymbols = new MMIAddrLabelMap(Context);
354  return AddrLabelSymbols->getAddrLabelSymbolToEmit(const_cast<BasicBlock*>(BB));
355 }
356
357
358 /// takeDeletedSymbolsForFunction - If the specified function has had any
359 /// references to address-taken blocks generated, but the block got deleted,
360 /// return the symbol now so we can emit it.  This prevents emitting a
361 /// reference to a symbol that has no definition.
362 void MachineModuleInfo::
363 takeDeletedSymbolsForFunction(const Function *F,
364                               std::vector<MCSymbol*> &Result) {
365   // If no blocks have had their addresses taken, we're done.
366   if (AddrLabelSymbols == 0) return;
367   return AddrLabelSymbols->
368      takeDeletedSymbolsForFunction(const_cast<Function*>(F), Result);
369 }
370
371 //===- EH -----------------------------------------------------------------===//
372
373 /// getOrCreateLandingPadInfo - Find or create an LandingPadInfo for the
374 /// specified MachineBasicBlock.
375 LandingPadInfo &MachineModuleInfo::getOrCreateLandingPadInfo
376     (MachineBasicBlock *LandingPad) {
377   unsigned N = LandingPads.size();
378   for (unsigned i = 0; i < N; ++i) {
379     LandingPadInfo &LP = LandingPads[i];
380     if (LP.LandingPadBlock == LandingPad)
381       return LP;
382   }
383
384   LandingPads.push_back(LandingPadInfo(LandingPad));
385   return LandingPads[N];
386 }
387
388 /// addInvoke - Provide the begin and end labels of an invoke style call and
389 /// associate it with a try landing pad block.
390 void MachineModuleInfo::addInvoke(MachineBasicBlock *LandingPad,
391                                   MCSymbol *BeginLabel, MCSymbol *EndLabel) {
392   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
393   LP.BeginLabels.push_back(BeginLabel);
394   LP.EndLabels.push_back(EndLabel);
395 }
396
397 /// addLandingPad - Provide the label of a try LandingPad block.
398 ///
399 MCSymbol *MachineModuleInfo::addLandingPad(MachineBasicBlock *LandingPad) {
400   MCSymbol *LandingPadLabel = Context.CreateTempSymbol();
401   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
402   LP.LandingPadLabel = LandingPadLabel;
403   return LandingPadLabel;
404 }
405
406 /// addPersonality - Provide the personality function for the exception
407 /// information.
408 void MachineModuleInfo::addPersonality(MachineBasicBlock *LandingPad,
409                                        Function *Personality) {
410   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
411   LP.Personality = Personality;
412
413   for (unsigned i = 0; i < Personalities.size(); ++i)
414     if (Personalities[i] == Personality)
415       return;
416
417   // If this is the first personality we're adding go
418   // ahead and add it at the beginning.
419   if (Personalities[0] == NULL)
420     Personalities[0] = Personality;
421   else
422     Personalities.push_back(Personality);
423 }
424
425 /// addCatchTypeInfo - Provide the catch typeinfo for a landing pad.
426 ///
427 void MachineModuleInfo::addCatchTypeInfo(MachineBasicBlock *LandingPad,
428                                         std::vector<GlobalVariable *> &TyInfo) {
429   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
430   for (unsigned N = TyInfo.size(); N; --N)
431     LP.TypeIds.push_back(getTypeIDFor(TyInfo[N - 1]));
432 }
433
434 /// addFilterTypeInfo - Provide the filter typeinfo for a landing pad.
435 ///
436 void MachineModuleInfo::addFilterTypeInfo(MachineBasicBlock *LandingPad,
437                                         std::vector<GlobalVariable *> &TyInfo) {
438   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
439   std::vector<unsigned> IdsInFilter(TyInfo.size());
440   for (unsigned I = 0, E = TyInfo.size(); I != E; ++I)
441     IdsInFilter[I] = getTypeIDFor(TyInfo[I]);
442   LP.TypeIds.push_back(getFilterIDFor(IdsInFilter));
443 }
444
445 /// addCleanup - Add a cleanup action for a landing pad.
446 ///
447 void MachineModuleInfo::addCleanup(MachineBasicBlock *LandingPad) {
448   LandingPadInfo &LP = getOrCreateLandingPadInfo(LandingPad);
449   LP.TypeIds.push_back(0);
450 }
451
452 /// TidyLandingPads - Remap landing pad labels and remove any deleted landing
453 /// pads.
454 void MachineModuleInfo::TidyLandingPads() {
455   for (unsigned i = 0; i != LandingPads.size(); ) {
456     LandingPadInfo &LandingPad = LandingPads[i];
457     if (LandingPad.LandingPadLabel && !LandingPad.LandingPadLabel->isDefined())
458       LandingPad.LandingPadLabel = 0;
459
460     // Special case: we *should* emit LPs with null LP MBB. This indicates
461     // "nounwind" case.
462     if (!LandingPad.LandingPadLabel && LandingPad.LandingPadBlock) {
463       LandingPads.erase(LandingPads.begin() + i);
464       continue;
465     }
466
467     for (unsigned j = 0, e = LandingPads[i].BeginLabels.size(); j != e; ++j) {
468       MCSymbol *BeginLabel = LandingPad.BeginLabels[j];
469       MCSymbol *EndLabel = LandingPad.EndLabels[j];
470       if (BeginLabel->isDefined() && EndLabel->isDefined()) continue;
471       
472       LandingPad.BeginLabels.erase(LandingPad.BeginLabels.begin() + j);
473       LandingPad.EndLabels.erase(LandingPad.EndLabels.begin() + j);
474       --j, --e;
475     }
476
477     // Remove landing pads with no try-ranges.
478     if (LandingPads[i].BeginLabels.empty()) {
479       LandingPads.erase(LandingPads.begin() + i);
480       continue;
481     }
482
483     // If there is no landing pad, ensure that the list of typeids is empty.
484     // If the only typeid is a cleanup, this is the same as having no typeids.
485     if (!LandingPad.LandingPadBlock ||
486         (LandingPad.TypeIds.size() == 1 && !LandingPad.TypeIds[0]))
487       LandingPad.TypeIds.clear();
488     ++i;
489   }
490 }
491
492 /// getTypeIDFor - Return the type id for the specified typeinfo.  This is
493 /// function wide.
494 unsigned MachineModuleInfo::getTypeIDFor(GlobalVariable *TI) {
495   for (unsigned i = 0, N = TypeInfos.size(); i != N; ++i)
496     if (TypeInfos[i] == TI) return i + 1;
497
498   TypeInfos.push_back(TI);
499   return TypeInfos.size();
500 }
501
502 /// getFilterIDFor - Return the filter id for the specified typeinfos.  This is
503 /// function wide.
504 int MachineModuleInfo::getFilterIDFor(std::vector<unsigned> &TyIds) {
505   // If the new filter coincides with the tail of an existing filter, then
506   // re-use the existing filter.  Folding filters more than this requires
507   // re-ordering filters and/or their elements - probably not worth it.
508   for (std::vector<unsigned>::iterator I = FilterEnds.begin(),
509        E = FilterEnds.end(); I != E; ++I) {
510     unsigned i = *I, j = TyIds.size();
511
512     while (i && j)
513       if (FilterIds[--i] != TyIds[--j])
514         goto try_next;
515
516     if (!j)
517       // The new filter coincides with range [i, end) of the existing filter.
518       return -(1 + i);
519
520 try_next:;
521   }
522
523   // Add the new filter.
524   int FilterID = -(1 + FilterIds.size());
525   FilterIds.reserve(FilterIds.size() + TyIds.size() + 1);
526   for (unsigned I = 0, N = TyIds.size(); I != N; ++I)
527     FilterIds.push_back(TyIds[I]);
528   FilterEnds.push_back(FilterIds.size());
529   FilterIds.push_back(0); // terminator
530   return FilterID;
531 }
532
533 /// getPersonality - Return the personality function for the current function.
534 Function *MachineModuleInfo::getPersonality() const {
535   // FIXME: Until PR1414 will be fixed, we're using 1 personality function per
536   // function
537   return !LandingPads.empty() ? LandingPads[0].Personality : NULL;
538 }
539
540 /// getPersonalityIndex - Return unique index for current personality
541 /// function. NULL/first personality function should always get zero index.
542 unsigned MachineModuleInfo::getPersonalityIndex() const {
543   const Function* Personality = NULL;
544
545   // Scan landing pads. If there is at least one non-NULL personality - use it.
546   for (unsigned i = 0; i != LandingPads.size(); ++i)
547     if (LandingPads[i].Personality) {
548       Personality = LandingPads[i].Personality;
549       break;
550     }
551
552   for (unsigned i = 0; i < Personalities.size(); ++i) {
553     if (Personalities[i] == Personality)
554       return i;
555   }
556
557   // This will happen if the current personality function is
558   // in the zero index.
559   return 0;
560 }
561