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