s/MethodType/FunctionType
[oota-llvm.git] / lib / AsmParser / llvmAsmParser.y
1 //===-- llvmAsmParser.y - Parser for llvm assembly files ---------*- C++ -*--=//
2 //
3 //  This file implements the bison parser for LLVM assembly languages files.
4 //
5 //===------------------------------------------------------------------------=//
6
7 %{
8 #include "ParserInternals.h"
9 #include "llvm/Assembly/Parser.h"
10 #include "llvm/SymbolTable.h"
11 #include "llvm/Module.h"
12 #include "llvm/GlobalVariable.h"
13 #include "llvm/Function.h"
14 #include "llvm/BasicBlock.h"
15 #include "llvm/DerivedTypes.h"
16 #include "llvm/iTerminators.h"
17 #include "llvm/iMemory.h"
18 #include "llvm/iPHINode.h"
19 #include "Support/STLExtras.h"
20 #include "Support/DepthFirstIterator.h"
21 #include <list>
22 #include <utility>            // Get definition of pair class
23 #include <algorithm>
24 #include <stdio.h>            // This embarasment is due to our flex lexer...
25 #include <iostream>
26 using std::list;
27 using std::vector;
28 using std::pair;
29 using std::map;
30 using std::pair;
31 using std::make_pair;
32 using std::cerr;
33 using std::string;
34
35 int yyerror(const char *ErrorMsg); // Forward declarations to prevent "implicit
36 int yylex();                       // declaration" of xxx warnings.
37 int yyparse();
38
39 static Module *ParserResult;
40 string CurFilename;
41
42 // DEBUG_UPREFS - Define this symbol if you want to enable debugging output
43 // relating to upreferences in the input stream.
44 //
45 //#define DEBUG_UPREFS 1
46 #ifdef DEBUG_UPREFS
47 #define UR_OUT(X) cerr << X
48 #else
49 #define UR_OUT(X)
50 #endif
51
52 // This contains info used when building the body of a method.  It is destroyed
53 // when the method is completed.
54 //
55 typedef vector<Value *> ValueList;           // Numbered defs
56 static void ResolveDefinitions(vector<ValueList> &LateResolvers,
57                                vector<ValueList> *FutureLateResolvers = 0);
58
59 static struct PerModuleInfo {
60   Module *CurrentModule;
61   vector<ValueList>    Values;     // Module level numbered definitions
62   vector<ValueList>    LateResolveValues;
63   vector<PATypeHolder> Types;
64   map<ValID, PATypeHolder> LateResolveTypes;
65
66   // GlobalRefs - This maintains a mapping between <Type, ValID>'s and forward
67   // references to global values.  Global values may be referenced before they
68   // are defined, and if so, the temporary object that they represent is held
69   // here.  This is used for forward references of ConstantPointerRefs.
70   //
71   typedef map<pair<const PointerType *, ValID>, GlobalVariable*> GlobalRefsType;
72   GlobalRefsType GlobalRefs;
73
74   void ModuleDone() {
75     // If we could not resolve some methods at method compilation time (calls to
76     // methods before they are defined), resolve them now...  Types are resolved
77     // when the constant pool has been completely parsed.
78     //
79     ResolveDefinitions(LateResolveValues);
80
81     // Check to make sure that all global value forward references have been
82     // resolved!
83     //
84     if (!GlobalRefs.empty()) {
85       string UndefinedReferences = "Unresolved global references exist:\n";
86       
87       for (GlobalRefsType::iterator I = GlobalRefs.begin(), E =GlobalRefs.end();
88            I != E; ++I) {
89         UndefinedReferences += "  " + I->first.first->getDescription() + " " +
90                                I->first.second.getName() + "\n";
91       }
92       ThrowException(UndefinedReferences);
93     }
94
95     Values.clear();         // Clear out method local definitions
96     Types.clear();
97     CurrentModule = 0;
98   }
99
100
101   // DeclareNewGlobalValue - Called every type a new GV has been defined.  This
102   // is used to remove things from the forward declaration map, resolving them
103   // to the correct thing as needed.
104   //
105   void DeclareNewGlobalValue(GlobalValue *GV, ValID D) {
106     // Check to see if there is a forward reference to this global variable...
107     // if there is, eliminate it and patch the reference to use the new def'n.
108     GlobalRefsType::iterator I = GlobalRefs.find(make_pair(GV->getType(), D));
109
110     if (I != GlobalRefs.end()) {
111       GlobalVariable *OldGV = I->second;   // Get the placeholder...
112       I->first.second.destroy();  // Free string memory if neccesary
113       
114       // Loop over all of the uses of the GlobalValue.  The only thing they are
115       // allowed to be at this point is ConstantPointerRef's.
116       assert(OldGV->use_size() == 1 && "Only one reference should exist!");
117       while (!OldGV->use_empty()) {
118         User *U = OldGV->use_back();  // Must be a ConstantPointerRef...
119         ConstantPointerRef *CPPR = cast<ConstantPointerRef>(U);
120         assert(CPPR->getValue() == OldGV && "Something isn't happy");
121         
122         // Change the const pool reference to point to the real global variable
123         // now.  This should drop a use from the OldGV.
124         CPPR->mutateReference(GV);
125       }
126     
127       // Remove GV from the module...
128       CurrentModule->getGlobalList().remove(OldGV);
129       delete OldGV;                        // Delete the old placeholder
130
131       // Remove the map entry for the global now that it has been created...
132       GlobalRefs.erase(I);
133     }
134   }
135
136 } CurModule;
137
138 static struct PerFunctionInfo {
139   Function *CurrentFunction;     // Pointer to current method being created
140
141   vector<ValueList> Values;      // Keep track of numbered definitions
142   vector<ValueList> LateResolveValues;
143   vector<PATypeHolder> Types;
144   map<ValID, PATypeHolder> LateResolveTypes;
145   bool isDeclare;                // Is this method a forward declararation?
146
147   inline PerFunctionInfo() {
148     CurrentFunction = 0;
149     isDeclare = false;
150   }
151
152   inline ~PerFunctionInfo() {}
153
154   inline void FunctionStart(Function *M) {
155     CurrentFunction = M;
156   }
157
158   void FunctionDone() {
159     // If we could not resolve some blocks at parsing time (forward branches)
160     // resolve the branches now...
161     ResolveDefinitions(LateResolveValues, &CurModule.LateResolveValues);
162
163     Values.clear();         // Clear out method local definitions
164     Types.clear();
165     CurrentFunction = 0;
166     isDeclare = false;
167   }
168 } CurMeth;  // Info for the current method...
169
170 static bool inFunctionScope() { return CurMeth.CurrentFunction != 0; }
171
172
173 //===----------------------------------------------------------------------===//
174 //               Code to handle definitions of all the types
175 //===----------------------------------------------------------------------===//
176
177 static int InsertValue(Value *D, vector<ValueList> &ValueTab = CurMeth.Values) {
178   if (D->hasName()) return -1;           // Is this a numbered definition?
179
180   // Yes, insert the value into the value table...
181   unsigned type = D->getType()->getUniqueID();
182   if (ValueTab.size() <= type)
183     ValueTab.resize(type+1, ValueList());
184   //printf("Values[%d][%d] = %d\n", type, ValueTab[type].size(), D);
185   ValueTab[type].push_back(D);
186   return ValueTab[type].size()-1;
187 }
188
189 // TODO: FIXME when Type are not const
190 static void InsertType(const Type *Ty, vector<PATypeHolder> &Types) {
191   Types.push_back(Ty);
192 }
193
194 static const Type *getTypeVal(const ValID &D, bool DoNotImprovise = false) {
195   switch (D.Type) {
196   case 0: {                 // Is it a numbered definition?
197     unsigned Num = (unsigned)D.Num;
198
199     // Module constants occupy the lowest numbered slots...
200     if (Num < CurModule.Types.size()) 
201       return CurModule.Types[Num];
202
203     Num -= CurModule.Types.size();
204
205     // Check that the number is within bounds...
206     if (Num <= CurMeth.Types.size())
207       return CurMeth.Types[Num];
208     break;
209   }
210   case 1: {                // Is it a named definition?
211     string Name(D.Name);
212     SymbolTable *SymTab = 0;
213     if (inFunctionScope()) SymTab = CurMeth.CurrentFunction->getSymbolTable();
214     Value *N = SymTab ? SymTab->lookup(Type::TypeTy, Name) : 0;
215
216     if (N == 0) {
217       // Symbol table doesn't automatically chain yet... because the method
218       // hasn't been added to the module...
219       //
220       SymTab = CurModule.CurrentModule->getSymbolTable();
221       if (SymTab)
222         N = SymTab->lookup(Type::TypeTy, Name);
223       if (N == 0) break;
224     }
225
226     D.destroy();  // Free old strdup'd memory...
227     return cast<const Type>(N);
228   }
229   default:
230     ThrowException("Invalid symbol type reference!");
231   }
232
233   // If we reached here, we referenced either a symbol that we don't know about
234   // or an id number that hasn't been read yet.  We may be referencing something
235   // forward, so just create an entry to be resolved later and get to it...
236   //
237   if (DoNotImprovise) return 0;  // Do we just want a null to be returned?
238
239   map<ValID, PATypeHolder> &LateResolver = inFunctionScope() ? 
240     CurMeth.LateResolveTypes : CurModule.LateResolveTypes;
241   
242   map<ValID, PATypeHolder>::iterator I = LateResolver.find(D);
243   if (I != LateResolver.end()) {
244     return I->second;
245   }
246
247   Type *Typ = OpaqueType::get();
248   LateResolver.insert(make_pair(D, Typ));
249   return Typ;
250 }
251
252 static Value *lookupInSymbolTable(const Type *Ty, const string &Name) {
253   SymbolTable *SymTab = 
254     inFunctionScope() ? CurMeth.CurrentFunction->getSymbolTable() : 0;
255   Value *N = SymTab ? SymTab->lookup(Ty, Name) : 0;
256
257   if (N == 0) {
258     // Symbol table doesn't automatically chain yet... because the method
259     // hasn't been added to the module...
260     //
261     SymTab = CurModule.CurrentModule->getSymbolTable();
262     if (SymTab)
263       N = SymTab->lookup(Ty, Name);
264   }
265
266   return N;
267 }
268
269 // getValNonImprovising - Look up the value specified by the provided type and
270 // the provided ValID.  If the value exists and has already been defined, return
271 // it.  Otherwise return null.
272 //
273 static Value *getValNonImprovising(const Type *Ty, const ValID &D) {
274   if (isa<FunctionType>(Ty))
275     ThrowException("Functions are not values and "
276                    "must be referenced as pointers");
277
278   switch (D.Type) {
279   case ValID::NumberVal: {                 // Is it a numbered definition?
280     unsigned type = Ty->getUniqueID();
281     unsigned Num = (unsigned)D.Num;
282
283     // Module constants occupy the lowest numbered slots...
284     if (type < CurModule.Values.size()) {
285       if (Num < CurModule.Values[type].size()) 
286         return CurModule.Values[type][Num];
287
288       Num -= CurModule.Values[type].size();
289     }
290
291     // Make sure that our type is within bounds
292     if (CurMeth.Values.size() <= type) return 0;
293
294     // Check that the number is within bounds...
295     if (CurMeth.Values[type].size() <= Num) return 0;
296   
297     return CurMeth.Values[type][Num];
298   }
299
300   case ValID::NameVal: {                // Is it a named definition?
301     Value *N = lookupInSymbolTable(Ty, string(D.Name));
302     if (N == 0) return 0;
303
304     D.destroy();  // Free old strdup'd memory...
305     return N;
306   }
307
308   // Check to make sure that "Ty" is an integral type, and that our 
309   // value will fit into the specified type...
310   case ValID::ConstSIntVal:    // Is it a constant pool reference??
311     if (Ty == Type::BoolTy) {  // Special handling for boolean data
312       return ConstantBool::get(D.ConstPool64 != 0);
313     } else {
314       if (!ConstantSInt::isValueValidForType(Ty, D.ConstPool64))
315         ThrowException("Symbolic constant pool value '" +
316                        itostr(D.ConstPool64) + "' is invalid for type '" + 
317                        Ty->getDescription() + "'!");
318       return ConstantSInt::get(Ty, D.ConstPool64);
319     }
320
321   case ValID::ConstUIntVal:     // Is it an unsigned const pool reference?
322     if (!ConstantUInt::isValueValidForType(Ty, D.UConstPool64)) {
323       if (!ConstantSInt::isValueValidForType(Ty, D.ConstPool64)) {
324         ThrowException("Integral constant pool reference is invalid!");
325       } else {     // This is really a signed reference.  Transmogrify.
326         return ConstantSInt::get(Ty, D.ConstPool64);
327       }
328     } else {
329       return ConstantUInt::get(Ty, D.UConstPool64);
330     }
331
332   case ValID::ConstStringVal:    // Is it a string const pool reference?
333     cerr << "FIXME: TODO: String constants [sbyte] not implemented yet!\n";
334     abort();
335     return 0;
336
337   case ValID::ConstFPVal:        // Is it a floating point const pool reference?
338     if (!ConstantFP::isValueValidForType(Ty, D.ConstPoolFP))
339       ThrowException("FP constant invalid for type!!");
340     return ConstantFP::get(Ty, D.ConstPoolFP);
341     
342   case ValID::ConstNullVal:      // Is it a null value?
343     if (!Ty->isPointerType())
344       ThrowException("Cannot create a a non pointer null!");
345     return ConstantPointerNull::get(cast<PointerType>(Ty));
346     
347   default:
348     assert(0 && "Unhandled case!");
349     return 0;
350   }   // End of switch
351
352   assert(0 && "Unhandled case!");
353   return 0;
354 }
355
356
357 // getVal - This function is identical to getValNonImprovising, except that if a
358 // value is not already defined, it "improvises" by creating a placeholder var
359 // that looks and acts just like the requested variable.  When the value is
360 // defined later, all uses of the placeholder variable are replaced with the
361 // real thing.
362 //
363 static Value *getVal(const Type *Ty, const ValID &D) {
364   assert(Ty != Type::TypeTy && "Should use getTypeVal for types!");
365
366   // See if the value has already been defined...
367   Value *V = getValNonImprovising(Ty, D);
368   if (V) return V;
369
370   // If we reached here, we referenced either a symbol that we don't know about
371   // or an id number that hasn't been read yet.  We may be referencing something
372   // forward, so just create an entry to be resolved later and get to it...
373   //
374   Value *d = 0;
375   switch (Ty->getPrimitiveID()) {
376   case Type::LabelTyID:  d = new   BBPlaceHolder(Ty, D); break;
377   default:               d = new ValuePlaceHolder(Ty, D); break;
378   }
379
380   assert(d != 0 && "How did we not make something?");
381   if (inFunctionScope())
382     InsertValue(d, CurMeth.LateResolveValues);
383   else 
384     InsertValue(d, CurModule.LateResolveValues);
385   return d;
386 }
387
388
389 //===----------------------------------------------------------------------===//
390 //              Code to handle forward references in instructions
391 //===----------------------------------------------------------------------===//
392 //
393 // This code handles the late binding needed with statements that reference
394 // values not defined yet... for example, a forward branch, or the PHI node for
395 // a loop body.
396 //
397 // This keeps a table (CurMeth.LateResolveValues) of all such forward references
398 // and back patchs after we are done.
399 //
400
401 // ResolveDefinitions - If we could not resolve some defs at parsing 
402 // time (forward branches, phi functions for loops, etc...) resolve the 
403 // defs now...
404 //
405 static void ResolveDefinitions(vector<ValueList> &LateResolvers,
406                                vector<ValueList> *FutureLateResolvers = 0) {
407   // Loop over LateResolveDefs fixing up stuff that couldn't be resolved
408   for (unsigned ty = 0; ty < LateResolvers.size(); ty++) {
409     while (!LateResolvers[ty].empty()) {
410       Value *V = LateResolvers[ty].back();
411       assert(!isa<Type>(V) && "Types should be in LateResolveTypes!");
412
413       LateResolvers[ty].pop_back();
414       ValID &DID = getValIDFromPlaceHolder(V);
415
416       Value *TheRealValue = getValNonImprovising(Type::getUniqueIDType(ty),DID);
417       if (TheRealValue) {
418         V->replaceAllUsesWith(TheRealValue);
419         delete V;
420       } else if (FutureLateResolvers) {
421         // Functions have their unresolved items forwarded to the module late
422         // resolver table
423         InsertValue(V, *FutureLateResolvers);
424       } else {
425         if (DID.Type == 1)
426           ThrowException("Reference to an invalid definition: '" +DID.getName()+
427                          "' of type '" + V->getType()->getDescription() + "'",
428                          getLineNumFromPlaceHolder(V));
429         else
430           ThrowException("Reference to an invalid definition: #" +
431                          itostr(DID.Num) + " of type '" + 
432                          V->getType()->getDescription() + "'",
433                          getLineNumFromPlaceHolder(V));
434       }
435     }
436   }
437
438   LateResolvers.clear();
439 }
440
441 // ResolveTypeTo - A brand new type was just declared.  This means that (if
442 // name is not null) things referencing Name can be resolved.  Otherwise, things
443 // refering to the number can be resolved.  Do this now.
444 //
445 static void ResolveTypeTo(char *Name, const Type *ToTy) {
446   vector<PATypeHolder> &Types = inFunctionScope() ? 
447      CurMeth.Types : CurModule.Types;
448
449    ValID D;
450    if (Name) D = ValID::create(Name);
451    else      D = ValID::create((int)Types.size());
452
453    map<ValID, PATypeHolder> &LateResolver = inFunctionScope() ? 
454      CurMeth.LateResolveTypes : CurModule.LateResolveTypes;
455   
456    map<ValID, PATypeHolder>::iterator I = LateResolver.find(D);
457    if (I != LateResolver.end()) {
458      cast<DerivedType>(I->second.get())->refineAbstractTypeTo(ToTy);
459      LateResolver.erase(I);
460    }
461 }
462
463 // ResolveTypes - At this point, all types should be resolved.  Any that aren't
464 // are errors.
465 //
466 static void ResolveTypes(map<ValID, PATypeHolder> &LateResolveTypes) {
467   if (!LateResolveTypes.empty()) {
468     const ValID &DID = LateResolveTypes.begin()->first;
469
470     if (DID.Type == ValID::NameVal)
471       ThrowException("Reference to an invalid type: '" +DID.getName() + "'");
472     else
473       ThrowException("Reference to an invalid type: #" + itostr(DID.Num));
474   }
475 }
476
477
478 // setValueName - Set the specified value to the name given.  The name may be
479 // null potentially, in which case this is a noop.  The string passed in is
480 // assumed to be a malloc'd string buffer, and is freed by this function.
481 //
482 // This function returns true if the value has already been defined, but is
483 // allowed to be redefined in the specified context.  If the name is a new name
484 // for the typeplane, false is returned.
485 //
486 static bool setValueName(Value *V, char *NameStr) {
487   if (NameStr == 0) return false;
488   
489   string Name(NameStr);           // Copy string
490   free(NameStr);                  // Free old string
491
492   if (V->getType() == Type::VoidTy) 
493     ThrowException("Can't assign name '" + Name + 
494                    "' to a null valued instruction!");
495
496   SymbolTable *ST = inFunctionScope() ? 
497     CurMeth.CurrentFunction->getSymbolTableSure() : 
498     CurModule.CurrentModule->getSymbolTableSure();
499
500   Value *Existing = ST->lookup(V->getType(), Name);
501   if (Existing) {    // Inserting a name that is already defined???
502     // There is only one case where this is allowed: when we are refining an
503     // opaque type.  In this case, Existing will be an opaque type.
504     if (const Type *Ty = dyn_cast<const Type>(Existing)) {
505       if (OpaqueType *OpTy = dyn_cast<OpaqueType>(Ty)) {
506         // We ARE replacing an opaque type!
507         OpTy->refineAbstractTypeTo(cast<Type>(V));
508         return true;
509       }
510     }
511
512     // Otherwise, we are a simple redefinition of a value, check to see if it
513     // is defined the same as the old one...
514     if (const Type *Ty = dyn_cast<const Type>(Existing)) {
515       if (Ty == cast<const Type>(V)) return true;  // Yes, it's equal.
516       // cerr << "Type: " << Ty->getDescription() << " != "
517       //      << cast<const Type>(V)->getDescription() << "!\n";
518     } else if (GlobalVariable *EGV = dyn_cast<GlobalVariable>(Existing)) {
519       // We are allowed to redefine a global variable in two circumstances:
520       // 1. If at least one of the globals is uninitialized or 
521       // 2. If both initializers have the same value.
522       //
523       // This can only be done if the const'ness of the vars is the same.
524       //
525       if (GlobalVariable *GV = dyn_cast<GlobalVariable>(V)) {
526         if (EGV->isConstant() == GV->isConstant() &&
527             (!EGV->hasInitializer() || !GV->hasInitializer() ||
528              EGV->getInitializer() == GV->getInitializer())) {
529
530           // Make sure the existing global version gets the initializer!
531           if (GV->hasInitializer() && !EGV->hasInitializer())
532             EGV->setInitializer(GV->getInitializer());
533           
534           delete GV;     // Destroy the duplicate!
535           return true;   // They are equivalent!
536         }
537       }
538     }
539     ThrowException("Redefinition of value named '" + Name + "' in the '" +
540                    V->getType()->getDescription() + "' type plane!");
541   }
542
543   V->setName(Name, ST);
544   return false;
545 }
546
547
548 //===----------------------------------------------------------------------===//
549 // Code for handling upreferences in type names...
550 //
551
552 // TypeContains - Returns true if Ty contains E in it.
553 //
554 static bool TypeContains(const Type *Ty, const Type *E) {
555   return find(df_begin(Ty), df_end(Ty), E) != df_end(Ty);
556 }
557
558
559 static vector<pair<unsigned, OpaqueType *> > UpRefs;
560
561 static PATypeHolder HandleUpRefs(const Type *ty) {
562   PATypeHolder Ty(ty);
563   UR_OUT("Type '" << ty->getDescription() << 
564          "' newly formed.  Resolving upreferences.\n" <<
565          UpRefs.size() << " upreferences active!\n");
566   for (unsigned i = 0; i < UpRefs.size(); ) {
567     UR_OUT("  UR#" << i << " - TypeContains(" << Ty->getDescription() << ", " 
568            << UpRefs[i].second->getDescription() << ") = " 
569            << (TypeContains(Ty, UpRefs[i].second) ? "true" : "false") << endl);
570     if (TypeContains(Ty, UpRefs[i].second)) {
571       unsigned Level = --UpRefs[i].first;   // Decrement level of upreference
572       UR_OUT("  Uplevel Ref Level = " << Level << endl);
573       if (Level == 0) {                     // Upreference should be resolved! 
574         UR_OUT("  * Resolving upreference for "
575                << UpRefs[i].second->getDescription() << endl;
576                string OldName = UpRefs[i].second->getDescription());
577         UpRefs[i].second->refineAbstractTypeTo(Ty);
578         UpRefs.erase(UpRefs.begin()+i);     // Remove from upreference list...
579         UR_OUT("  * Type '" << OldName << "' refined upreference to: "
580                << (const void*)Ty << ", " << Ty->getDescription() << endl);
581         continue;
582       }
583     }
584
585     ++i;                                  // Otherwise, no resolve, move on...
586   }
587   // FIXME: TODO: this should return the updated type
588   return Ty;
589 }
590
591
592 //===----------------------------------------------------------------------===//
593 //            RunVMAsmParser - Define an interface to this parser
594 //===----------------------------------------------------------------------===//
595 //
596 Module *RunVMAsmParser(const string &Filename, FILE *F) {
597   llvmAsmin = F;
598   CurFilename = Filename;
599   llvmAsmlineno = 1;      // Reset the current line number...
600
601   CurModule.CurrentModule = new Module();  // Allocate a new module to read
602   yyparse();       // Parse the file.
603   Module *Result = ParserResult;
604   llvmAsmin = stdin;    // F is about to go away, don't use it anymore...
605   ParserResult = 0;
606
607   return Result;
608 }
609
610 %}
611
612 %union {
613   Module                           *ModuleVal;
614   Function                         *FunctionVal;
615   std::pair<FunctionArgument*,char*> *MethArgVal;
616   BasicBlock                       *BasicBlockVal;
617   TerminatorInst                   *TermInstVal;
618   Instruction                      *InstVal;
619   Constant                         *ConstVal;
620
621   const Type                       *PrimType;
622   PATypeHolder                     *TypeVal;
623   Value                            *ValueVal;
624
625   std::list<std::pair<FunctionArgument*,char*> > *FunctionArgList;
626   std::vector<Value*>              *ValueList;
627   std::list<PATypeHolder>          *TypeList;
628   std::list<std::pair<Value*,
629                       BasicBlock*> > *PHIList; // Represent the RHS of PHI node
630   std::list<std::pair<Constant*, BasicBlock*> > *JumpTable;
631   std::vector<Constant*>           *ConstVector;
632
633   int64_t                           SInt64Val;
634   uint64_t                          UInt64Val;
635   int                               SIntVal;
636   unsigned                          UIntVal;
637   double                            FPVal;
638   bool                              BoolVal;
639
640   char                             *StrVal;   // This memory is strdup'd!
641   ValID                             ValIDVal; // strdup'd memory maybe!
642
643   Instruction::UnaryOps             UnaryOpVal;
644   Instruction::BinaryOps            BinaryOpVal;
645   Instruction::TermOps              TermOpVal;
646   Instruction::MemoryOps            MemOpVal;
647   Instruction::OtherOps             OtherOpVal;
648 }
649
650 %type <ModuleVal>     Module FunctionList
651 %type <FunctionVal>   Function FunctionProto FunctionHeader BasicBlockList
652 %type <BasicBlockVal> BasicBlock InstructionList
653 %type <TermInstVal>   BBTerminatorInst
654 %type <InstVal>       Inst InstVal MemoryInst
655 %type <ConstVal>      ConstVal
656 %type <ConstVector>   ConstVector
657 %type <FunctionArgList> ArgList ArgListH
658 %type <MethArgVal>    ArgVal
659 %type <PHIList>       PHIList
660 %type <ValueList>     ValueRefList ValueRefListE  // For call param lists
661 %type <ValueList>     IndexList                   // For GEP derived indices
662 %type <TypeList>      TypeListI ArgTypeListI
663 %type <JumpTable>     JumpTable
664 %type <BoolVal>       GlobalType OptInternal      // GLOBAL or CONSTANT? Intern?
665
666 // ValueRef - Unresolved reference to a definition or BB
667 %type <ValIDVal>      ValueRef ConstValueRef SymbolicValueRef
668 %type <ValueVal>      ResolvedVal            // <type> <valref> pair
669 // Tokens and types for handling constant integer values
670 //
671 // ESINT64VAL - A negative number within long long range
672 %token <SInt64Val> ESINT64VAL
673
674 // EUINT64VAL - A positive number within uns. long long range
675 %token <UInt64Val> EUINT64VAL
676 %type  <SInt64Val> EINT64VAL
677
678 %token  <SIntVal>   SINTVAL   // Signed 32 bit ints...
679 %token  <UIntVal>   UINTVAL   // Unsigned 32 bit ints...
680 %type   <SIntVal>   INTVAL
681 %token  <FPVal>     FPVAL     // Float or Double constant
682
683 // Built in types...
684 %type  <TypeVal> Types TypesV UpRTypes UpRTypesV
685 %type  <PrimType> SIntType UIntType IntType FPType PrimType   // Classifications
686 %token <PrimType> VOID BOOL SBYTE UBYTE SHORT USHORT INT UINT LONG ULONG
687 %token <PrimType> FLOAT DOUBLE TYPE LABEL
688
689 %token <StrVal>     VAR_ID LABELSTR STRINGCONSTANT
690 %type  <StrVal>  OptVAR_ID OptAssign
691
692
693 %token IMPLEMENTATION TRUE FALSE BEGINTOK END DECLARE GLOBAL CONSTANT UNINIT
694 %token TO EXCEPT DOTDOTDOT STRING NULL_TOK CONST INTERNAL OPAQUE
695
696 // Basic Block Terminating Operators 
697 %token <TermOpVal> RET BR SWITCH
698
699 // Unary Operators 
700 %type  <UnaryOpVal> UnaryOps  // all the unary operators
701 %token <UnaryOpVal> NOT
702
703 // Binary Operators 
704 %type  <BinaryOpVal> BinaryOps  // all the binary operators
705 %token <BinaryOpVal> ADD SUB MUL DIV REM AND OR XOR
706 %token <BinaryOpVal> SETLE SETGE SETLT SETGT SETEQ SETNE  // Binary Comarators
707
708 // Memory Instructions
709 %token <MemoryOpVal> MALLOC ALLOCA FREE LOAD STORE GETELEMENTPTR
710
711 // Other Operators
712 %type  <OtherOpVal> ShiftOps
713 %token <OtherOpVal> PHI CALL INVOKE CAST SHL SHR
714
715 %start Module
716 %%
717
718 // Handle constant integer size restriction and conversion...
719 //
720
721 INTVAL : SINTVAL
722 INTVAL : UINTVAL {
723   if ($1 > (uint32_t)INT32_MAX)     // Outside of my range!
724     ThrowException("Value too large for type!");
725   $$ = (int32_t)$1;
726 }
727
728
729 EINT64VAL : ESINT64VAL       // These have same type and can't cause problems...
730 EINT64VAL : EUINT64VAL {
731   if ($1 > (uint64_t)INT64_MAX)     // Outside of my range!
732     ThrowException("Value too large for type!");
733   $$ = (int64_t)$1;
734 }
735
736 // Operations that are notably excluded from this list include: 
737 // RET, BR, & SWITCH because they end basic blocks and are treated specially.
738 //
739 UnaryOps  : NOT
740 BinaryOps : ADD | SUB | MUL | DIV | REM | AND | OR | XOR
741 BinaryOps : SETLE | SETGE | SETLT | SETGT | SETEQ | SETNE
742 ShiftOps  : SHL | SHR
743
744 // These are some types that allow classification if we only want a particular 
745 // thing... for example, only a signed, unsigned, or integral type.
746 SIntType :  LONG |  INT |  SHORT | SBYTE
747 UIntType : ULONG | UINT | USHORT | UBYTE
748 IntType  : SIntType | UIntType
749 FPType   : FLOAT | DOUBLE
750
751 // OptAssign - Value producing statements have an optional assignment component
752 OptAssign : VAR_ID '=' {
753     $$ = $1;
754   }
755   | /*empty*/ { 
756     $$ = 0; 
757   }
758
759 OptInternal : INTERNAL { $$ = true; } | /*empty*/ { $$ = false; }
760
761 //===----------------------------------------------------------------------===//
762 // Types includes all predefined types... except void, because it can only be
763 // used in specific contexts (method returning void for example).  To have
764 // access to it, a user must explicitly use TypesV.
765 //
766
767 // TypesV includes all of 'Types', but it also includes the void type.
768 TypesV    : Types    | VOID { $$ = new PATypeHolder($1); }
769 UpRTypesV : UpRTypes | VOID { $$ = new PATypeHolder($1); }
770
771 Types     : UpRTypes {
772     if (UpRefs.size())
773       ThrowException("Invalid upreference in type: " + (*$1)->getDescription());
774     $$ = $1;
775   }
776
777
778 // Derived types are added later...
779 //
780 PrimType : BOOL | SBYTE | UBYTE | SHORT  | USHORT | INT   | UINT 
781 PrimType : LONG | ULONG | FLOAT | DOUBLE | TYPE   | LABEL
782 UpRTypes : OPAQUE {
783     $$ = new PATypeHolder(OpaqueType::get());
784   }
785   | PrimType {
786     $$ = new PATypeHolder($1);
787   }
788 UpRTypes : ValueRef {                    // Named types are also simple types...
789   $$ = new PATypeHolder(getTypeVal($1));
790 }
791
792 // Include derived types in the Types production.
793 //
794 UpRTypes : '\\' EUINT64VAL {                   // Type UpReference
795     if ($2 > (uint64_t)INT64_MAX) ThrowException("Value out of range!");
796     OpaqueType *OT = OpaqueType::get();        // Use temporary placeholder
797     UpRefs.push_back(make_pair((unsigned)$2, OT));  // Add to vector...
798     $$ = new PATypeHolder(OT);
799     UR_OUT("New Upreference!\n");
800   }
801   | UpRTypesV '(' ArgTypeListI ')' {           // Function derived type?
802     vector<const Type*> Params;
803     mapto($3->begin(), $3->end(), std::back_inserter(Params), 
804           std::mem_fun_ref(&PATypeHandle<Type>::get));
805     bool isVarArg = Params.size() && Params.back() == Type::VoidTy;
806     if (isVarArg) Params.pop_back();
807
808     $$ = new PATypeHolder(HandleUpRefs(FunctionType::get(*$1,Params,isVarArg)));
809     delete $3;      // Delete the argument list
810     delete $1;      // Delete the old type handle
811   }
812   | '[' EUINT64VAL 'x' UpRTypes ']' {          // Sized array type?
813     $$ = new PATypeHolder(HandleUpRefs(ArrayType::get(*$4, (unsigned)$2)));
814     delete $4;
815   }
816   | '{' TypeListI '}' {                        // Structure type?
817     vector<const Type*> Elements;
818     mapto($2->begin(), $2->end(), std::back_inserter(Elements), 
819         std::mem_fun_ref(&PATypeHandle<Type>::get));
820
821     $$ = new PATypeHolder(HandleUpRefs(StructType::get(Elements)));
822     delete $2;
823   }
824   | '{' '}' {                                  // Empty structure type?
825     $$ = new PATypeHolder(StructType::get(vector<const Type*>()));
826   }
827   | UpRTypes '*' {                             // Pointer type?
828     $$ = new PATypeHolder(HandleUpRefs(PointerType::get(*$1)));
829     delete $1;
830   }
831
832 // TypeList - Used for struct declarations and as a basis for method type 
833 // declaration type lists
834 //
835 TypeListI : UpRTypes {
836     $$ = new list<PATypeHolder>();
837     $$->push_back(*$1); delete $1;
838   }
839   | TypeListI ',' UpRTypes {
840     ($$=$1)->push_back(*$3); delete $3;
841   }
842
843 // ArgTypeList - List of types for a method type declaration...
844 ArgTypeListI : TypeListI
845   | TypeListI ',' DOTDOTDOT {
846     ($$=$1)->push_back(Type::VoidTy);
847   }
848   | DOTDOTDOT {
849     ($$ = new list<PATypeHolder>())->push_back(Type::VoidTy);
850   }
851   | /*empty*/ {
852     $$ = new list<PATypeHolder>();
853   }
854
855
856 // ConstVal - The various declarations that go into the constant pool.  This
857 // includes all forward declarations of types, constants, and functions.
858 //
859 ConstVal: Types '[' ConstVector ']' { // Nonempty unsized arr
860     const ArrayType *ATy = dyn_cast<const ArrayType>($1->get());
861     if (ATy == 0)
862       ThrowException("Cannot make array constant with type: '" + 
863                      (*$1)->getDescription() + "'!");
864     const Type *ETy = ATy->getElementType();
865     int NumElements = ATy->getNumElements();
866
867     // Verify that we have the correct size...
868     if (NumElements != -1 && NumElements != (int)$3->size())
869       ThrowException("Type mismatch: constant sized array initialized with " +
870                      utostr($3->size()) +  " arguments, but has size of " + 
871                      itostr(NumElements) + "!");
872
873     // Verify all elements are correct type!
874     for (unsigned i = 0; i < $3->size(); i++) {
875       if (ETy != (*$3)[i]->getType())
876         ThrowException("Element #" + utostr(i) + " is not of type '" + 
877                        ETy->getDescription() +"' as required!\nIt is of type '"+
878                        (*$3)[i]->getType()->getDescription() + "'.");
879     }
880
881     $$ = ConstantArray::get(ATy, *$3);
882     delete $1; delete $3;
883   }
884   | Types '[' ']' {
885     const ArrayType *ATy = dyn_cast<const ArrayType>($1->get());
886     if (ATy == 0)
887       ThrowException("Cannot make array constant with type: '" + 
888                      (*$1)->getDescription() + "'!");
889
890     int NumElements = ATy->getNumElements();
891     if (NumElements != -1 && NumElements != 0) 
892       ThrowException("Type mismatch: constant sized array initialized with 0"
893                      " arguments, but has size of " + itostr(NumElements) +"!");
894     $$ = ConstantArray::get(ATy, vector<Constant*>());
895     delete $1;
896   }
897   | Types 'c' STRINGCONSTANT {
898     const ArrayType *ATy = dyn_cast<const ArrayType>($1->get());
899     if (ATy == 0)
900       ThrowException("Cannot make array constant with type: '" + 
901                      (*$1)->getDescription() + "'!");
902
903     int NumElements = ATy->getNumElements();
904     const Type *ETy = ATy->getElementType();
905     char *EndStr = UnEscapeLexed($3, true);
906     if (NumElements != -1 && NumElements != (EndStr-$3))
907       ThrowException("Can't build string constant of size " + 
908                      itostr((int)(EndStr-$3)) +
909                      " when array has size " + itostr(NumElements) + "!");
910     vector<Constant*> Vals;
911     if (ETy == Type::SByteTy) {
912       for (char *C = $3; C != EndStr; ++C)
913         Vals.push_back(ConstantSInt::get(ETy, *C));
914     } else if (ETy == Type::UByteTy) {
915       for (char *C = $3; C != EndStr; ++C)
916         Vals.push_back(ConstantUInt::get(ETy, *C));
917     } else {
918       free($3);
919       ThrowException("Cannot build string arrays of non byte sized elements!");
920     }
921     free($3);
922     $$ = ConstantArray::get(ATy, Vals);
923     delete $1;
924   }
925   | Types '{' ConstVector '}' {
926     const StructType *STy = dyn_cast<const StructType>($1->get());
927     if (STy == 0)
928       ThrowException("Cannot make struct constant with type: '" + 
929                      (*$1)->getDescription() + "'!");
930     // FIXME: TODO: Check to see that the constants are compatible with the type
931     // initializer!
932     $$ = ConstantStruct::get(STy, *$3);
933     delete $1; delete $3;
934   }
935   | Types NULL_TOK {
936     const PointerType *PTy = dyn_cast<const PointerType>($1->get());
937     if (PTy == 0)
938       ThrowException("Cannot make null pointer constant with type: '" + 
939                      (*$1)->getDescription() + "'!");
940
941     $$ = ConstantPointerNull::get(PTy);
942     delete $1;
943   }
944   | Types SymbolicValueRef {
945     const PointerType *Ty = dyn_cast<const PointerType>($1->get());
946     if (Ty == 0)
947       ThrowException("Global const reference must be a pointer type!");
948
949     Value *V = getValNonImprovising(Ty, $2);
950
951     // If this is an initializer for a constant pointer, which is referencing a
952     // (currently) undefined variable, create a stub now that shall be replaced
953     // in the future with the right type of variable.
954     //
955     if (V == 0) {
956       assert(isa<PointerType>(Ty) && "Globals may only be used as pointers!");
957       const PointerType *PT = cast<PointerType>(Ty);
958
959       // First check to see if the forward references value is already created!
960       PerModuleInfo::GlobalRefsType::iterator I =
961         CurModule.GlobalRefs.find(make_pair(PT, $2));
962     
963       if (I != CurModule.GlobalRefs.end()) {
964         V = I->second;             // Placeholder already exists, use it...
965       } else {
966         // TODO: Include line number info by creating a subclass of
967         // TODO: GlobalVariable here that includes the said information!
968         
969         // Create a placeholder for the global variable reference...
970         GlobalVariable *GV = new GlobalVariable(PT->getElementType(),
971                                                 false, true);
972         // Keep track of the fact that we have a forward ref to recycle it
973         CurModule.GlobalRefs.insert(make_pair(make_pair(PT, $2), GV));
974
975         // Must temporarily push this value into the module table...
976         CurModule.CurrentModule->getGlobalList().push_back(GV);
977         V = GV;
978       }
979     }
980
981     GlobalValue *GV = cast<GlobalValue>(V);
982     $$ = ConstantPointerRef::get(GV);
983     delete $1;            // Free the type handle
984   }
985
986
987 ConstVal : SIntType EINT64VAL {     // integral constants
988     if (!ConstantSInt::isValueValidForType($1, $2))
989       ThrowException("Constant value doesn't fit in type!");
990     $$ = ConstantSInt::get($1, $2);
991   } 
992   | UIntType EUINT64VAL {           // integral constants
993     if (!ConstantUInt::isValueValidForType($1, $2))
994       ThrowException("Constant value doesn't fit in type!");
995     $$ = ConstantUInt::get($1, $2);
996   } 
997   | BOOL TRUE {                     // Boolean constants
998     $$ = ConstantBool::True;
999   }
1000   | BOOL FALSE {                    // Boolean constants
1001     $$ = ConstantBool::False;
1002   }
1003   | FPType FPVAL {                   // Float & Double constants
1004     $$ = ConstantFP::get($1, $2);
1005   }
1006
1007 // ConstVector - A list of comma seperated constants.
1008 ConstVector : ConstVector ',' ConstVal {
1009     ($$ = $1)->push_back($3);
1010   }
1011   | ConstVal {
1012     $$ = new vector<Constant*>();
1013     $$->push_back($1);
1014   }
1015
1016
1017 // GlobalType - Match either GLOBAL or CONSTANT for global declarations...
1018 GlobalType : GLOBAL { $$ = false; } | CONSTANT { $$ = true; }
1019
1020
1021 // ConstPool - Constants with optional names assigned to them.
1022 ConstPool : ConstPool OptAssign CONST ConstVal { 
1023     if (setValueName($4, $2)) { assert(0 && "No redefinitions allowed!"); }
1024     InsertValue($4);
1025   }
1026   | ConstPool OptAssign TYPE TypesV {  // Types can be defined in the const pool
1027     // Eagerly resolve types.  This is not an optimization, this is a
1028     // requirement that is due to the fact that we could have this:
1029     //
1030     // %list = type { %list * }
1031     // %list = type { %list * }    ; repeated type decl
1032     //
1033     // If types are not resolved eagerly, then the two types will not be
1034     // determined to be the same type!
1035     //
1036     ResolveTypeTo($2, $4->get());
1037
1038     // TODO: FIXME when Type are not const
1039     if (!setValueName(const_cast<Type*>($4->get()), $2)) {
1040       // If this is not a redefinition of a type...
1041       if (!$2) {
1042         InsertType($4->get(),
1043                    inFunctionScope() ? CurMeth.Types : CurModule.Types);
1044       }
1045     }
1046
1047     delete $4;
1048   }
1049   | ConstPool FunctionProto {       // Function prototypes can be in const pool
1050   }
1051   | ConstPool OptAssign OptInternal GlobalType ConstVal {
1052     const Type *Ty = $5->getType();
1053     // Global declarations appear in Constant Pool
1054     Constant *Initializer = $5;
1055     if (Initializer == 0)
1056       ThrowException("Global value initializer is not a constant!");
1057          
1058     GlobalVariable *GV = new GlobalVariable(Ty, $4, $3, Initializer);
1059     if (!setValueName(GV, $2)) {   // If not redefining...
1060       CurModule.CurrentModule->getGlobalList().push_back(GV);
1061       int Slot = InsertValue(GV, CurModule.Values);
1062
1063       if (Slot != -1) {
1064         CurModule.DeclareNewGlobalValue(GV, ValID::create(Slot));
1065       } else {
1066         CurModule.DeclareNewGlobalValue(GV, ValID::create(
1067                                                 (char*)GV->getName().c_str()));
1068       }
1069     }
1070   }
1071   | ConstPool OptAssign OptInternal UNINIT GlobalType Types {
1072     const Type *Ty = *$6;
1073     // Global declarations appear in Constant Pool
1074     GlobalVariable *GV = new GlobalVariable(Ty, $5, $3);
1075     if (!setValueName(GV, $2)) {   // If not redefining...
1076       CurModule.CurrentModule->getGlobalList().push_back(GV);
1077       int Slot = InsertValue(GV, CurModule.Values);
1078
1079       if (Slot != -1) {
1080         CurModule.DeclareNewGlobalValue(GV, ValID::create(Slot));
1081       } else {
1082         assert(GV->hasName() && "Not named and not numbered!?");
1083         CurModule.DeclareNewGlobalValue(GV, ValID::create(
1084                                                 (char*)GV->getName().c_str()));
1085       }
1086     }
1087     delete $6;
1088   }
1089   | /* empty: end of list */ { 
1090   }
1091
1092
1093 //===----------------------------------------------------------------------===//
1094 //                             Rules to match Modules
1095 //===----------------------------------------------------------------------===//
1096
1097 // Module rule: Capture the result of parsing the whole file into a result
1098 // variable...
1099 //
1100 Module : FunctionList {
1101   $$ = ParserResult = $1;
1102   CurModule.ModuleDone();
1103 }
1104
1105 // FunctionList - A list of methods, preceeded by a constant pool.
1106 //
1107 FunctionList : FunctionList Function {
1108     $$ = $1;
1109     assert($2->getParent() == 0 && "Function already in module!");
1110     $1->getFunctionList().push_back($2);
1111     CurMeth.FunctionDone();
1112   } 
1113   | FunctionList FunctionProto {
1114     $$ = $1;
1115   }
1116   | ConstPool IMPLEMENTATION {
1117     $$ = CurModule.CurrentModule;
1118     // Resolve circular types before we parse the body of the module
1119     ResolveTypes(CurModule.LateResolveTypes);
1120   }
1121
1122
1123 //===----------------------------------------------------------------------===//
1124 //                       Rules to match Function Headers
1125 //===----------------------------------------------------------------------===//
1126
1127 OptVAR_ID : VAR_ID | /*empty*/ { $$ = 0; }
1128
1129 ArgVal : Types OptVAR_ID {
1130   $$ = new pair<FunctionArgument*,char*>(new FunctionArgument(*$1), $2);
1131   delete $1;  // Delete the type handle..
1132 }
1133
1134 ArgListH : ArgVal ',' ArgListH {
1135     $$ = $3;
1136     $3->push_front(*$1);
1137     delete $1;
1138   }
1139   | ArgVal {
1140     $$ = new list<pair<FunctionArgument*,char*> >();
1141     $$->push_front(*$1);
1142     delete $1;
1143   }
1144   | DOTDOTDOT {
1145     $$ = new list<pair<FunctionArgument*, char*> >();
1146     $$->push_front(pair<FunctionArgument*,char*>(
1147                             new FunctionArgument(Type::VoidTy), 0));
1148   }
1149
1150 ArgList : ArgListH {
1151     $$ = $1;
1152   }
1153   | /* empty */ {
1154     $$ = 0;
1155   }
1156
1157 FunctionHeaderH : OptInternal TypesV STRINGCONSTANT '(' ArgList ')' {
1158   UnEscapeLexed($3);
1159   string FunctionName($3);
1160   
1161   vector<const Type*> ParamTypeList;
1162   if ($5)
1163     for (list<pair<FunctionArgument*,char*> >::iterator I = $5->begin();
1164          I != $5->end(); ++I)
1165       ParamTypeList.push_back(I->first->getType());
1166
1167   bool isVarArg = ParamTypeList.size() && ParamTypeList.back() == Type::VoidTy;
1168   if (isVarArg) ParamTypeList.pop_back();
1169
1170   const FunctionType *MT = FunctionType::get(*$2, ParamTypeList, isVarArg);
1171   const PointerType *PMT = PointerType::get(MT);
1172   delete $2;
1173
1174   Function *M = 0;
1175   if (SymbolTable *ST = CurModule.CurrentModule->getSymbolTable()) {
1176     // Is the function already in symtab?
1177     if (Value *V = ST->lookup(PMT, FunctionName)) {
1178       M = cast<Function>(V);
1179
1180       // Yes it is.  If this is the case, either we need to be a forward decl,
1181       // or it needs to be.
1182       if (!CurMeth.isDeclare && !M->isExternal())
1183         ThrowException("Redefinition of method '" + FunctionName + "'!");      
1184
1185       // If we found a preexisting method prototype, remove it from the module,
1186       // so that we don't get spurious conflicts with global & local variables.
1187       //
1188       CurModule.CurrentModule->getFunctionList().remove(M);
1189     }
1190   }
1191
1192   if (M == 0) {  // Not already defined?
1193     M = new Function(MT, $1, FunctionName);
1194     InsertValue(M, CurModule.Values);
1195     CurModule.DeclareNewGlobalValue(M, ValID::create($3));
1196   }
1197   free($3);  // Free strdup'd memory!
1198
1199   CurMeth.FunctionStart(M);
1200
1201   // Add all of the arguments we parsed to the method...
1202   if ($5 && !CurMeth.isDeclare) {        // Is null if empty...
1203     Function::ArgumentListType &ArgList = M->getArgumentList();
1204
1205     for (list<pair<FunctionArgument*, char*> >::iterator I = $5->begin();
1206          I != $5->end(); ++I) {
1207       if (setValueName(I->first, I->second)) {  // Insert into symtab...
1208         assert(0 && "No arg redef allowed!");
1209       }
1210       
1211       InsertValue(I->first);
1212       ArgList.push_back(I->first);
1213     }
1214     delete $5;                     // We're now done with the argument list
1215   } else if ($5) {
1216     // If we are a declaration, we should free the memory for the argument list!
1217     for (list<pair<FunctionArgument*, char*> >::iterator I = $5->begin();
1218          I != $5->end(); ++I) {
1219       if (I->second) free(I->second);   // Free the memory for the name...
1220       delete I->first;                  // Free the unused function argument
1221     }
1222     delete $5;                          // Free the memory for the list itself
1223   }
1224 }
1225
1226 FunctionHeader : FunctionHeaderH ConstPool BEGINTOK {
1227   $$ = CurMeth.CurrentFunction;
1228
1229   // Resolve circular types before we parse the body of the method.
1230   ResolveTypes(CurMeth.LateResolveTypes);
1231 }
1232
1233 Function : BasicBlockList END {
1234   $$ = $1;
1235 }
1236
1237 FunctionProto : DECLARE { CurMeth.isDeclare = true; } FunctionHeaderH {
1238   $$ = CurMeth.CurrentFunction;
1239   assert($$->getParent() == 0 && "Function already in module!");
1240   CurModule.CurrentModule->getFunctionList().push_back($$);
1241   CurMeth.FunctionDone();
1242 }
1243
1244 //===----------------------------------------------------------------------===//
1245 //                        Rules to match Basic Blocks
1246 //===----------------------------------------------------------------------===//
1247
1248 ConstValueRef : ESINT64VAL {    // A reference to a direct constant
1249     $$ = ValID::create($1);
1250   }
1251   | EUINT64VAL {
1252     $$ = ValID::create($1);
1253   }
1254   | FPVAL {                     // Perhaps it's an FP constant?
1255     $$ = ValID::create($1);
1256   }
1257   | TRUE {
1258     $$ = ValID::create((int64_t)1);
1259   } 
1260   | FALSE {
1261     $$ = ValID::create((int64_t)0);
1262   }
1263   | NULL_TOK {
1264     $$ = ValID::createNull();
1265   }
1266
1267 /*
1268   | STRINGCONSTANT {        // Quoted strings work too... especially for methods
1269     $$ = ValID::create_conststr($1);
1270   }
1271 */
1272
1273 // SymbolicValueRef - Reference to one of two ways of symbolically refering to
1274 // another value.
1275 //
1276 SymbolicValueRef : INTVAL {  // Is it an integer reference...?
1277     $$ = ValID::create($1);
1278   }
1279   | VAR_ID {                 // Is it a named reference...?
1280     $$ = ValID::create($1);
1281   }
1282
1283 // ValueRef - A reference to a definition... either constant or symbolic
1284 ValueRef : SymbolicValueRef | ConstValueRef
1285
1286
1287 // ResolvedVal - a <type> <value> pair.  This is used only in cases where the
1288 // type immediately preceeds the value reference, and allows complex constant
1289 // pool references (for things like: 'ret [2 x int] [ int 12, int 42]')
1290 ResolvedVal : Types ValueRef {
1291     $$ = getVal(*$1, $2); delete $1;
1292   }
1293
1294
1295 BasicBlockList : BasicBlockList BasicBlock {
1296     ($$ = $1)->getBasicBlocks().push_back($2);
1297   }
1298   | FunctionHeader BasicBlock { // Do not allow methods with 0 basic blocks   
1299     ($$ = $1)->getBasicBlocks().push_back($2);
1300   }
1301
1302
1303 // Basic blocks are terminated by branching instructions: 
1304 // br, br/cc, switch, ret
1305 //
1306 BasicBlock : InstructionList OptAssign BBTerminatorInst  {
1307     if (setValueName($3, $2)) { assert(0 && "No redefn allowed!"); }
1308     InsertValue($3);
1309
1310     $1->getInstList().push_back($3);
1311     InsertValue($1);
1312     $$ = $1;
1313   }
1314   | LABELSTR InstructionList OptAssign BBTerminatorInst  {
1315     if (setValueName($4, $3)) { assert(0 && "No redefn allowed!"); }
1316     InsertValue($4);
1317
1318     $2->getInstList().push_back($4);
1319     if (setValueName($2, $1)) { assert(0 && "No label redef allowed!"); }
1320
1321     InsertValue($2);
1322     $$ = $2;
1323   }
1324
1325 InstructionList : InstructionList Inst {
1326     $1->getInstList().push_back($2);
1327     $$ = $1;
1328   }
1329   | /* empty */ {
1330     $$ = new BasicBlock();
1331   }
1332
1333 BBTerminatorInst : RET ResolvedVal {              // Return with a result...
1334     $$ = new ReturnInst($2);
1335   }
1336   | RET VOID {                                       // Return with no result...
1337     $$ = new ReturnInst();
1338   }
1339   | BR LABEL ValueRef {                         // Unconditional Branch...
1340     $$ = new BranchInst(cast<BasicBlock>(getVal(Type::LabelTy, $3)));
1341   }                                                  // Conditional Branch...
1342   | BR BOOL ValueRef ',' LABEL ValueRef ',' LABEL ValueRef {  
1343     $$ = new BranchInst(cast<BasicBlock>(getVal(Type::LabelTy, $6)), 
1344                         cast<BasicBlock>(getVal(Type::LabelTy, $9)),
1345                         getVal(Type::BoolTy, $3));
1346   }
1347   | SWITCH IntType ValueRef ',' LABEL ValueRef '[' JumpTable ']' {
1348     SwitchInst *S = new SwitchInst(getVal($2, $3), 
1349                                    cast<BasicBlock>(getVal(Type::LabelTy, $6)));
1350     $$ = S;
1351
1352     list<pair<Constant*, BasicBlock*> >::iterator I = $8->begin(), 
1353                                                       end = $8->end();
1354     for (; I != end; ++I)
1355       S->dest_push_back(I->first, I->second);
1356   }
1357   | INVOKE TypesV ValueRef '(' ValueRefListE ')' TO ResolvedVal 
1358     EXCEPT ResolvedVal {
1359     const PointerType *PMTy;
1360     const FunctionType *Ty;
1361
1362     if (!(PMTy = dyn_cast<PointerType>($2->get())) ||
1363         !(Ty = dyn_cast<FunctionType>(PMTy->getElementType()))) {
1364       // Pull out the types of all of the arguments...
1365       vector<const Type*> ParamTypes;
1366       if ($5) {
1367         for (vector<Value*>::iterator I = $5->begin(), E = $5->end(); I!=E; ++I)
1368           ParamTypes.push_back((*I)->getType());
1369       }
1370
1371       bool isVarArg = ParamTypes.size() && ParamTypes.back() == Type::VoidTy;
1372       if (isVarArg) ParamTypes.pop_back();
1373
1374       Ty = FunctionType::get($2->get(), ParamTypes, isVarArg);
1375       PMTy = PointerType::get(Ty);
1376     }
1377     delete $2;
1378
1379     Value *V = getVal(PMTy, $3);   // Get the method we're calling...
1380
1381     BasicBlock *Normal = dyn_cast<BasicBlock>($8);
1382     BasicBlock *Except = dyn_cast<BasicBlock>($10);
1383
1384     if (Normal == 0 || Except == 0)
1385       ThrowException("Invoke instruction without label destinations!");
1386
1387     // Create the call node...
1388     if (!$5) {                                   // Has no arguments?
1389       $$ = new InvokeInst(V, Normal, Except, vector<Value*>());
1390     } else {                                     // Has arguments?
1391       // Loop through FunctionType's arguments and ensure they are specified
1392       // correctly!
1393       //
1394       FunctionType::ParamTypes::const_iterator I = Ty->getParamTypes().begin();
1395       FunctionType::ParamTypes::const_iterator E = Ty->getParamTypes().end();
1396       vector<Value*>::iterator ArgI = $5->begin(), ArgE = $5->end();
1397
1398       for (; ArgI != ArgE && I != E; ++ArgI, ++I)
1399         if ((*ArgI)->getType() != *I)
1400           ThrowException("Parameter " +(*ArgI)->getName()+ " is not of type '" +
1401                          (*I)->getDescription() + "'!");
1402
1403       if (I != E || (ArgI != ArgE && !Ty->isVarArg()))
1404         ThrowException("Invalid number of parameters detected!");
1405
1406       $$ = new InvokeInst(V, Normal, Except, *$5);
1407     }
1408     delete $5;
1409   }
1410
1411
1412
1413 JumpTable : JumpTable IntType ConstValueRef ',' LABEL ValueRef {
1414     $$ = $1;
1415     Constant *V = cast<Constant>(getValNonImprovising($2, $3));
1416     if (V == 0)
1417       ThrowException("May only switch on a constant pool value!");
1418
1419     $$->push_back(make_pair(V, cast<BasicBlock>(getVal($5, $6))));
1420   }
1421   | IntType ConstValueRef ',' LABEL ValueRef {
1422     $$ = new list<pair<Constant*, BasicBlock*> >();
1423     Constant *V = cast<Constant>(getValNonImprovising($1, $2));
1424
1425     if (V == 0)
1426       ThrowException("May only switch on a constant pool value!");
1427
1428     $$->push_back(make_pair(V, cast<BasicBlock>(getVal($4, $5))));
1429   }
1430
1431 Inst : OptAssign InstVal {
1432   // Is this definition named?? if so, assign the name...
1433   if (setValueName($2, $1)) { assert(0 && "No redefin allowed!"); }
1434   InsertValue($2);
1435   $$ = $2;
1436 }
1437
1438 PHIList : Types '[' ValueRef ',' ValueRef ']' {    // Used for PHI nodes
1439     $$ = new list<pair<Value*, BasicBlock*> >();
1440     $$->push_back(make_pair(getVal(*$1, $3), 
1441                             cast<BasicBlock>(getVal(Type::LabelTy, $5))));
1442     delete $1;
1443   }
1444   | PHIList ',' '[' ValueRef ',' ValueRef ']' {
1445     $$ = $1;
1446     $1->push_back(make_pair(getVal($1->front().first->getType(), $4),
1447                             cast<BasicBlock>(getVal(Type::LabelTy, $6))));
1448   }
1449
1450
1451 ValueRefList : ResolvedVal {    // Used for call statements, and memory insts...
1452     $$ = new vector<Value*>();
1453     $$->push_back($1);
1454   }
1455   | ValueRefList ',' ResolvedVal {
1456     $$ = $1;
1457     $1->push_back($3);
1458   }
1459
1460 // ValueRefListE - Just like ValueRefList, except that it may also be empty!
1461 ValueRefListE : ValueRefList | /*empty*/ { $$ = 0; }
1462
1463 InstVal : BinaryOps Types ValueRef ',' ValueRef {
1464     $$ = BinaryOperator::create($1, getVal(*$2, $3), getVal(*$2, $5));
1465     if ($$ == 0)
1466       ThrowException("binary operator returned null!");
1467     delete $2;
1468   }
1469   | UnaryOps ResolvedVal {
1470     $$ = UnaryOperator::create($1, $2);
1471     if ($$ == 0)
1472       ThrowException("unary operator returned null!");
1473   }
1474   | ShiftOps ResolvedVal ',' ResolvedVal {
1475     if ($4->getType() != Type::UByteTy)
1476       ThrowException("Shift amount must be ubyte!");
1477     $$ = new ShiftInst($1, $2, $4);
1478   }
1479   | CAST ResolvedVal TO Types {
1480     $$ = new CastInst($2, *$4);
1481     delete $4;
1482   }
1483   | PHI PHIList {
1484     const Type *Ty = $2->front().first->getType();
1485     $$ = new PHINode(Ty);
1486     while ($2->begin() != $2->end()) {
1487       if ($2->front().first->getType() != Ty) 
1488         ThrowException("All elements of a PHI node must be of the same type!");
1489       cast<PHINode>($$)->addIncoming($2->front().first, $2->front().second);
1490       $2->pop_front();
1491     }
1492     delete $2;  // Free the list...
1493   } 
1494   | CALL TypesV ValueRef '(' ValueRefListE ')' {
1495     const PointerType *PMTy;
1496     const FunctionType *Ty;
1497
1498     if (!(PMTy = dyn_cast<PointerType>($2->get())) ||
1499         !(Ty = dyn_cast<FunctionType>(PMTy->getElementType()))) {
1500       // Pull out the types of all of the arguments...
1501       vector<const Type*> ParamTypes;
1502       if ($5) {
1503         for (vector<Value*>::iterator I = $5->begin(), E = $5->end(); I!=E; ++I)
1504           ParamTypes.push_back((*I)->getType());
1505       }
1506
1507       bool isVarArg = ParamTypes.size() && ParamTypes.back() == Type::VoidTy;
1508       if (isVarArg) ParamTypes.pop_back();
1509
1510       Ty = FunctionType::get($2->get(), ParamTypes, isVarArg);
1511       PMTy = PointerType::get(Ty);
1512     }
1513     delete $2;
1514
1515     Value *V = getVal(PMTy, $3);   // Get the method we're calling...
1516
1517     // Create the call node...
1518     if (!$5) {                                   // Has no arguments?
1519       $$ = new CallInst(V, vector<Value*>());
1520     } else {                                     // Has arguments?
1521       // Loop through FunctionType's arguments and ensure they are specified
1522       // correctly!
1523       //
1524       FunctionType::ParamTypes::const_iterator I = Ty->getParamTypes().begin();
1525       FunctionType::ParamTypes::const_iterator E = Ty->getParamTypes().end();
1526       vector<Value*>::iterator ArgI = $5->begin(), ArgE = $5->end();
1527
1528       for (; ArgI != ArgE && I != E; ++ArgI, ++I)
1529         if ((*ArgI)->getType() != *I)
1530           ThrowException("Parameter " +(*ArgI)->getName()+ " is not of type '" +
1531                          (*I)->getDescription() + "'!");
1532
1533       if (I != E || (ArgI != ArgE && !Ty->isVarArg()))
1534         ThrowException("Invalid number of parameters detected!");
1535
1536       $$ = new CallInst(V, *$5);
1537     }
1538     delete $5;
1539   }
1540   | MemoryInst {
1541     $$ = $1;
1542   }
1543
1544
1545 // IndexList - List of indices for GEP based instructions...
1546 IndexList : ',' ValueRefList { 
1547   $$ = $2; 
1548 } | /* empty */ { 
1549   $$ = new vector<Value*>(); 
1550 }
1551
1552 MemoryInst : MALLOC Types {
1553     $$ = new MallocInst(PointerType::get(*$2));
1554     delete $2;
1555   }
1556   | MALLOC Types ',' UINT ValueRef {
1557     const Type *Ty = PointerType::get(*$2);
1558     $$ = new MallocInst(Ty, getVal($4, $5));
1559     delete $2;
1560   }
1561   | ALLOCA Types {
1562     $$ = new AllocaInst(PointerType::get(*$2));
1563     delete $2;
1564   }
1565   | ALLOCA Types ',' UINT ValueRef {
1566     const Type *Ty = PointerType::get(*$2);
1567     Value *ArrSize = getVal($4, $5);
1568     $$ = new AllocaInst(Ty, ArrSize);
1569     delete $2;
1570   }
1571   | FREE ResolvedVal {
1572     if (!$2->getType()->isPointerType())
1573       ThrowException("Trying to free nonpointer type " + 
1574                      $2->getType()->getDescription() + "!");
1575     $$ = new FreeInst($2);
1576   }
1577
1578   | LOAD Types ValueRef IndexList {
1579     if (!(*$2)->isPointerType())
1580       ThrowException("Can't load from nonpointer type: " +
1581                      (*$2)->getDescription());
1582     if (LoadInst::getIndexedType(*$2, *$4) == 0)
1583       ThrowException("Invalid indices for load instruction!");
1584
1585     $$ = new LoadInst(getVal(*$2, $3), *$4);
1586     delete $4;   // Free the vector...
1587     delete $2;
1588   }
1589   | STORE ResolvedVal ',' Types ValueRef IndexList {
1590     if (!(*$4)->isPointerType())
1591       ThrowException("Can't store to a nonpointer type: " +
1592                      (*$4)->getDescription());
1593     const Type *ElTy = StoreInst::getIndexedType(*$4, *$6);
1594     if (ElTy == 0)
1595       ThrowException("Can't store into that field list!");
1596     if (ElTy != $2->getType())
1597       ThrowException("Can't store '" + $2->getType()->getDescription() +
1598                      "' into space of type '" + ElTy->getDescription() + "'!");
1599     $$ = new StoreInst($2, getVal(*$4, $5), *$6);
1600     delete $4; delete $6;
1601   }
1602   | GETELEMENTPTR Types ValueRef IndexList {
1603     if (!(*$2)->isPointerType())
1604       ThrowException("getelementptr insn requires pointer operand!");
1605     if (!GetElementPtrInst::getIndexedType(*$2, *$4, true))
1606       ThrowException("Can't get element ptr '" + (*$2)->getDescription()+ "'!");
1607     $$ = new GetElementPtrInst(getVal(*$2, $3), *$4);
1608     delete $2; delete $4;
1609   }
1610
1611 %%
1612 int yyerror(const char *ErrorMsg) {
1613   ThrowException(string("Parse error: ") + ErrorMsg);
1614   return 0;
1615 }