Add ParseInlineMetadata() which can parses metadata that refers to an instruction...
[oota-llvm.git] / lib / AsmParser / LLParser.cpp
1 //===-- LLParser.cpp - Parser Class ---------------------------------------===//
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 //  This file defines the parser class for .ll files.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "LLParser.h"
15 #include "llvm/AutoUpgrade.h"
16 #include "llvm/CallingConv.h"
17 #include "llvm/Constants.h"
18 #include "llvm/DerivedTypes.h"
19 #include "llvm/InlineAsm.h"
20 #include "llvm/Instructions.h"
21 #include "llvm/LLVMContext.h"
22 #include "llvm/Metadata.h"
23 #include "llvm/Module.h"
24 #include "llvm/Operator.h"
25 #include "llvm/ValueSymbolTable.h"
26 #include "llvm/ADT/SmallPtrSet.h"
27 #include "llvm/ADT/StringExtras.h"
28 #include "llvm/Support/ErrorHandling.h"
29 #include "llvm/Support/raw_ostream.h"
30 using namespace llvm;
31
32 /// Run: module ::= toplevelentity*
33 bool LLParser::Run() {
34   // Prime the lexer.
35   Lex.Lex();
36
37   return ParseTopLevelEntities() ||
38          ValidateEndOfModule();
39 }
40
41 /// ValidateEndOfModule - Do final validity and sanity checks at the end of the
42 /// module.
43 bool LLParser::ValidateEndOfModule() {
44   // Update auto-upgraded malloc calls to "malloc".
45   // FIXME: Remove in LLVM 3.0.
46   if (MallocF) {
47     MallocF->setName("malloc");
48     // If setName() does not set the name to "malloc", then there is already a 
49     // declaration of "malloc".  In that case, iterate over all calls to MallocF
50     // and get them to call the declared "malloc" instead.
51     if (MallocF->getName() != "malloc") {
52       Constant *RealMallocF = M->getFunction("malloc");
53       if (RealMallocF->getType() != MallocF->getType())
54         RealMallocF = ConstantExpr::getBitCast(RealMallocF, MallocF->getType());
55       MallocF->replaceAllUsesWith(RealMallocF);
56       MallocF->eraseFromParent();
57       MallocF = NULL;
58     }
59   }
60   
61   
62   // If there are entries in ForwardRefBlockAddresses at this point, they are
63   // references after the function was defined.  Resolve those now.
64   while (!ForwardRefBlockAddresses.empty()) {
65     // Okay, we are referencing an already-parsed function, resolve them now.
66     Function *TheFn = 0;
67     const ValID &Fn = ForwardRefBlockAddresses.begin()->first;
68     if (Fn.Kind == ValID::t_GlobalName)
69       TheFn = M->getFunction(Fn.StrVal);
70     else if (Fn.UIntVal < NumberedVals.size())
71       TheFn = dyn_cast<Function>(NumberedVals[Fn.UIntVal]);
72     
73     if (TheFn == 0)
74       return Error(Fn.Loc, "unknown function referenced by blockaddress");
75     
76     // Resolve all these references.
77     if (ResolveForwardRefBlockAddresses(TheFn, 
78                                       ForwardRefBlockAddresses.begin()->second,
79                                         0))
80       return true;
81     
82     ForwardRefBlockAddresses.erase(ForwardRefBlockAddresses.begin());
83   }
84   
85   
86   if (!ForwardRefTypes.empty())
87     return Error(ForwardRefTypes.begin()->second.second,
88                  "use of undefined type named '" +
89                  ForwardRefTypes.begin()->first + "'");
90   if (!ForwardRefTypeIDs.empty())
91     return Error(ForwardRefTypeIDs.begin()->second.second,
92                  "use of undefined type '%" +
93                  utostr(ForwardRefTypeIDs.begin()->first) + "'");
94
95   if (!ForwardRefVals.empty())
96     return Error(ForwardRefVals.begin()->second.second,
97                  "use of undefined value '@" + ForwardRefVals.begin()->first +
98                  "'");
99
100   if (!ForwardRefValIDs.empty())
101     return Error(ForwardRefValIDs.begin()->second.second,
102                  "use of undefined value '@" +
103                  utostr(ForwardRefValIDs.begin()->first) + "'");
104
105   if (!ForwardRefMDNodes.empty())
106     return Error(ForwardRefMDNodes.begin()->second.second,
107                  "use of undefined metadata '!" +
108                  utostr(ForwardRefMDNodes.begin()->first) + "'");
109
110
111   // Look for intrinsic functions and CallInst that need to be upgraded
112   for (Module::iterator FI = M->begin(), FE = M->end(); FI != FE; )
113     UpgradeCallsToIntrinsic(FI++); // must be post-increment, as we remove
114
115   // Check debug info intrinsics.
116   CheckDebugInfoIntrinsics(M);
117   return false;
118 }
119
120 bool LLParser::ResolveForwardRefBlockAddresses(Function *TheFn, 
121                              std::vector<std::pair<ValID, GlobalValue*> > &Refs,
122                                                PerFunctionState *PFS) {
123   // Loop over all the references, resolving them.
124   for (unsigned i = 0, e = Refs.size(); i != e; ++i) {
125     BasicBlock *Res;
126     if (PFS) {
127       if (Refs[i].first.Kind == ValID::t_LocalName)
128         Res = PFS->GetBB(Refs[i].first.StrVal, Refs[i].first.Loc);
129       else
130         Res = PFS->GetBB(Refs[i].first.UIntVal, Refs[i].first.Loc);
131     } else if (Refs[i].first.Kind == ValID::t_LocalID) {
132       return Error(Refs[i].first.Loc,
133        "cannot take address of numeric label after the function is defined");
134     } else {
135       Res = dyn_cast_or_null<BasicBlock>(
136                      TheFn->getValueSymbolTable().lookup(Refs[i].first.StrVal));
137     }
138     
139     if (Res == 0)
140       return Error(Refs[i].first.Loc,
141                    "referenced value is not a basic block");
142     
143     // Get the BlockAddress for this and update references to use it.
144     BlockAddress *BA = BlockAddress::get(TheFn, Res);
145     Refs[i].second->replaceAllUsesWith(BA);
146     Refs[i].second->eraseFromParent();
147   }
148   return false;
149 }
150
151
152 //===----------------------------------------------------------------------===//
153 // Top-Level Entities
154 //===----------------------------------------------------------------------===//
155
156 bool LLParser::ParseTopLevelEntities() {
157   while (1) {
158     switch (Lex.getKind()) {
159     default:         return TokError("expected top-level entity");
160     case lltok::Eof: return false;
161     //case lltok::kw_define:
162     case lltok::kw_declare: if (ParseDeclare()) return true; break;
163     case lltok::kw_define:  if (ParseDefine()) return true; break;
164     case lltok::kw_module:  if (ParseModuleAsm()) return true; break;
165     case lltok::kw_target:  if (ParseTargetDefinition()) return true; break;
166     case lltok::kw_deplibs: if (ParseDepLibs()) return true; break;
167     case lltok::kw_type:    if (ParseUnnamedType()) return true; break;
168     case lltok::LocalVarID: if (ParseUnnamedType()) return true; break;
169     case lltok::StringConstant: // FIXME: REMOVE IN LLVM 3.0
170     case lltok::LocalVar:   if (ParseNamedType()) return true; break;
171     case lltok::GlobalID:   if (ParseUnnamedGlobal()) return true; break;
172     case lltok::GlobalVar:  if (ParseNamedGlobal()) return true; break;
173     case lltok::Metadata:   if (ParseStandaloneMetadata()) return true; break;
174     case lltok::NamedOrCustomMD: if (ParseNamedMetadata()) return true; break;
175
176     // The Global variable production with no name can have many different
177     // optional leading prefixes, the production is:
178     // GlobalVar ::= OptionalLinkage OptionalVisibility OptionalThreadLocal
179     //               OptionalAddrSpace ('constant'|'global') ...
180     case lltok::kw_private :       // OptionalLinkage
181     case lltok::kw_linker_private: // OptionalLinkage
182     case lltok::kw_internal:       // OptionalLinkage
183     case lltok::kw_weak:           // OptionalLinkage
184     case lltok::kw_weak_odr:       // OptionalLinkage
185     case lltok::kw_linkonce:       // OptionalLinkage
186     case lltok::kw_linkonce_odr:   // OptionalLinkage
187     case lltok::kw_appending:      // OptionalLinkage
188     case lltok::kw_dllexport:      // OptionalLinkage
189     case lltok::kw_common:         // OptionalLinkage
190     case lltok::kw_dllimport:      // OptionalLinkage
191     case lltok::kw_extern_weak:    // OptionalLinkage
192     case lltok::kw_external: {     // OptionalLinkage
193       unsigned Linkage, Visibility;
194       if (ParseOptionalLinkage(Linkage) ||
195           ParseOptionalVisibility(Visibility) ||
196           ParseGlobal("", SMLoc(), Linkage, true, Visibility))
197         return true;
198       break;
199     }
200     case lltok::kw_default:       // OptionalVisibility
201     case lltok::kw_hidden:        // OptionalVisibility
202     case lltok::kw_protected: {   // OptionalVisibility
203       unsigned Visibility;
204       if (ParseOptionalVisibility(Visibility) ||
205           ParseGlobal("", SMLoc(), 0, false, Visibility))
206         return true;
207       break;
208     }
209
210     case lltok::kw_thread_local:  // OptionalThreadLocal
211     case lltok::kw_addrspace:     // OptionalAddrSpace
212     case lltok::kw_constant:      // GlobalType
213     case lltok::kw_global:        // GlobalType
214       if (ParseGlobal("", SMLoc(), 0, false, 0)) return true;
215       break;
216     }
217   }
218 }
219
220
221 /// toplevelentity
222 ///   ::= 'module' 'asm' STRINGCONSTANT
223 bool LLParser::ParseModuleAsm() {
224   assert(Lex.getKind() == lltok::kw_module);
225   Lex.Lex();
226
227   std::string AsmStr;
228   if (ParseToken(lltok::kw_asm, "expected 'module asm'") ||
229       ParseStringConstant(AsmStr)) return true;
230
231   const std::string &AsmSoFar = M->getModuleInlineAsm();
232   if (AsmSoFar.empty())
233     M->setModuleInlineAsm(AsmStr);
234   else
235     M->setModuleInlineAsm(AsmSoFar+"\n"+AsmStr);
236   return false;
237 }
238
239 /// toplevelentity
240 ///   ::= 'target' 'triple' '=' STRINGCONSTANT
241 ///   ::= 'target' 'datalayout' '=' STRINGCONSTANT
242 bool LLParser::ParseTargetDefinition() {
243   assert(Lex.getKind() == lltok::kw_target);
244   std::string Str;
245   switch (Lex.Lex()) {
246   default: return TokError("unknown target property");
247   case lltok::kw_triple:
248     Lex.Lex();
249     if (ParseToken(lltok::equal, "expected '=' after target triple") ||
250         ParseStringConstant(Str))
251       return true;
252     M->setTargetTriple(Str);
253     return false;
254   case lltok::kw_datalayout:
255     Lex.Lex();
256     if (ParseToken(lltok::equal, "expected '=' after target datalayout") ||
257         ParseStringConstant(Str))
258       return true;
259     M->setDataLayout(Str);
260     return false;
261   }
262 }
263
264 /// toplevelentity
265 ///   ::= 'deplibs' '=' '[' ']'
266 ///   ::= 'deplibs' '=' '[' STRINGCONSTANT (',' STRINGCONSTANT)* ']'
267 bool LLParser::ParseDepLibs() {
268   assert(Lex.getKind() == lltok::kw_deplibs);
269   Lex.Lex();
270   if (ParseToken(lltok::equal, "expected '=' after deplibs") ||
271       ParseToken(lltok::lsquare, "expected '=' after deplibs"))
272     return true;
273
274   if (EatIfPresent(lltok::rsquare))
275     return false;
276
277   std::string Str;
278   if (ParseStringConstant(Str)) return true;
279   M->addLibrary(Str);
280
281   while (EatIfPresent(lltok::comma)) {
282     if (ParseStringConstant(Str)) return true;
283     M->addLibrary(Str);
284   }
285
286   return ParseToken(lltok::rsquare, "expected ']' at end of list");
287 }
288
289 /// ParseUnnamedType:
290 ///   ::= 'type' type
291 ///   ::= LocalVarID '=' 'type' type
292 bool LLParser::ParseUnnamedType() {
293   unsigned TypeID = NumberedTypes.size();
294
295   // Handle the LocalVarID form.
296   if (Lex.getKind() == lltok::LocalVarID) {
297     if (Lex.getUIntVal() != TypeID)
298       return Error(Lex.getLoc(), "type expected to be numbered '%" +
299                    utostr(TypeID) + "'");
300     Lex.Lex(); // eat LocalVarID;
301
302     if (ParseToken(lltok::equal, "expected '=' after name"))
303       return true;
304   }
305
306   assert(Lex.getKind() == lltok::kw_type);
307   LocTy TypeLoc = Lex.getLoc();
308   Lex.Lex(); // eat kw_type
309
310   PATypeHolder Ty(Type::getVoidTy(Context));
311   if (ParseType(Ty)) return true;
312
313   // See if this type was previously referenced.
314   std::map<unsigned, std::pair<PATypeHolder, LocTy> >::iterator
315     FI = ForwardRefTypeIDs.find(TypeID);
316   if (FI != ForwardRefTypeIDs.end()) {
317     if (FI->second.first.get() == Ty)
318       return Error(TypeLoc, "self referential type is invalid");
319
320     cast<DerivedType>(FI->second.first.get())->refineAbstractTypeTo(Ty);
321     Ty = FI->second.first.get();
322     ForwardRefTypeIDs.erase(FI);
323   }
324
325   NumberedTypes.push_back(Ty);
326
327   return false;
328 }
329
330 /// toplevelentity
331 ///   ::= LocalVar '=' 'type' type
332 bool LLParser::ParseNamedType() {
333   std::string Name = Lex.getStrVal();
334   LocTy NameLoc = Lex.getLoc();
335   Lex.Lex();  // eat LocalVar.
336
337   PATypeHolder Ty(Type::getVoidTy(Context));
338
339   if (ParseToken(lltok::equal, "expected '=' after name") ||
340       ParseToken(lltok::kw_type, "expected 'type' after name") ||
341       ParseType(Ty))
342     return true;
343
344   // Set the type name, checking for conflicts as we do so.
345   bool AlreadyExists = M->addTypeName(Name, Ty);
346   if (!AlreadyExists) return false;
347
348   // See if this type is a forward reference.  We need to eagerly resolve
349   // types to allow recursive type redefinitions below.
350   std::map<std::string, std::pair<PATypeHolder, LocTy> >::iterator
351   FI = ForwardRefTypes.find(Name);
352   if (FI != ForwardRefTypes.end()) {
353     if (FI->second.first.get() == Ty)
354       return Error(NameLoc, "self referential type is invalid");
355
356     cast<DerivedType>(FI->second.first.get())->refineAbstractTypeTo(Ty);
357     Ty = FI->second.first.get();
358     ForwardRefTypes.erase(FI);
359   }
360
361   // Inserting a name that is already defined, get the existing name.
362   const Type *Existing = M->getTypeByName(Name);
363   assert(Existing && "Conflict but no matching type?!");
364
365   // Otherwise, this is an attempt to redefine a type. That's okay if
366   // the redefinition is identical to the original.
367   // FIXME: REMOVE REDEFINITIONS IN LLVM 3.0
368   if (Existing == Ty) return false;
369
370   // Any other kind of (non-equivalent) redefinition is an error.
371   return Error(NameLoc, "redefinition of type named '" + Name + "' of type '" +
372                Ty->getDescription() + "'");
373 }
374
375
376 /// toplevelentity
377 ///   ::= 'declare' FunctionHeader
378 bool LLParser::ParseDeclare() {
379   assert(Lex.getKind() == lltok::kw_declare);
380   Lex.Lex();
381
382   Function *F;
383   return ParseFunctionHeader(F, false);
384 }
385
386 /// toplevelentity
387 ///   ::= 'define' FunctionHeader '{' ...
388 bool LLParser::ParseDefine() {
389   assert(Lex.getKind() == lltok::kw_define);
390   Lex.Lex();
391
392   Function *F;
393   return ParseFunctionHeader(F, true) ||
394          ParseFunctionBody(*F);
395 }
396
397 /// ParseGlobalType
398 ///   ::= 'constant'
399 ///   ::= 'global'
400 bool LLParser::ParseGlobalType(bool &IsConstant) {
401   if (Lex.getKind() == lltok::kw_constant)
402     IsConstant = true;
403   else if (Lex.getKind() == lltok::kw_global)
404     IsConstant = false;
405   else {
406     IsConstant = false;
407     return TokError("expected 'global' or 'constant'");
408   }
409   Lex.Lex();
410   return false;
411 }
412
413 /// ParseUnnamedGlobal:
414 ///   OptionalVisibility ALIAS ...
415 ///   OptionalLinkage OptionalVisibility ...   -> global variable
416 ///   GlobalID '=' OptionalVisibility ALIAS ...
417 ///   GlobalID '=' OptionalLinkage OptionalVisibility ...   -> global variable
418 bool LLParser::ParseUnnamedGlobal() {
419   unsigned VarID = NumberedVals.size();
420   std::string Name;
421   LocTy NameLoc = Lex.getLoc();
422
423   // Handle the GlobalID form.
424   if (Lex.getKind() == lltok::GlobalID) {
425     if (Lex.getUIntVal() != VarID)
426       return Error(Lex.getLoc(), "variable expected to be numbered '%" +
427                    utostr(VarID) + "'");
428     Lex.Lex(); // eat GlobalID;
429
430     if (ParseToken(lltok::equal, "expected '=' after name"))
431       return true;
432   }
433
434   bool HasLinkage;
435   unsigned Linkage, Visibility;
436   if (ParseOptionalLinkage(Linkage, HasLinkage) ||
437       ParseOptionalVisibility(Visibility))
438     return true;
439
440   if (HasLinkage || Lex.getKind() != lltok::kw_alias)
441     return ParseGlobal(Name, NameLoc, Linkage, HasLinkage, Visibility);
442   return ParseAlias(Name, NameLoc, Visibility);
443 }
444
445 /// ParseNamedGlobal:
446 ///   GlobalVar '=' OptionalVisibility ALIAS ...
447 ///   GlobalVar '=' OptionalLinkage OptionalVisibility ...   -> global variable
448 bool LLParser::ParseNamedGlobal() {
449   assert(Lex.getKind() == lltok::GlobalVar);
450   LocTy NameLoc = Lex.getLoc();
451   std::string Name = Lex.getStrVal();
452   Lex.Lex();
453
454   bool HasLinkage;
455   unsigned Linkage, Visibility;
456   if (ParseToken(lltok::equal, "expected '=' in global variable") ||
457       ParseOptionalLinkage(Linkage, HasLinkage) ||
458       ParseOptionalVisibility(Visibility))
459     return true;
460
461   if (HasLinkage || Lex.getKind() != lltok::kw_alias)
462     return ParseGlobal(Name, NameLoc, Linkage, HasLinkage, Visibility);
463   return ParseAlias(Name, NameLoc, Visibility);
464 }
465
466 // MDString:
467 //   ::= '!' STRINGCONSTANT
468 bool LLParser::ParseMDString(MetadataBase *&MDS) {
469   std::string Str;
470   if (ParseStringConstant(Str)) return true;
471   MDS = MDString::get(Context, Str);
472   return false;
473 }
474
475 // MDNode:
476 //   ::= '!' MDNodeNumber
477 bool LLParser::ParseMDNode(MetadataBase *&Node) {
478   // !{ ..., !42, ... }
479   unsigned MID = 0;
480   if (ParseUInt32(MID))  return true;
481
482   // Check existing MDNode.
483   std::map<unsigned, WeakVH>::iterator I = MetadataCache.find(MID);
484   if (I != MetadataCache.end()) {
485     Node = cast<MetadataBase>(I->second);
486     return false;
487   }
488
489   // Check known forward references.
490   std::map<unsigned, std::pair<WeakVH, LocTy> >::iterator
491     FI = ForwardRefMDNodes.find(MID);
492   if (FI != ForwardRefMDNodes.end()) {
493     Node = cast<MetadataBase>(FI->second.first);
494     return false;
495   }
496
497   // Create MDNode forward reference
498   SmallVector<Value *, 1> Elts;
499   std::string FwdRefName = "llvm.mdnode.fwdref." + utostr(MID);
500   Elts.push_back(MDString::get(Context, FwdRefName));
501   MDNode *FwdNode = MDNode::get(Context, Elts.data(), Elts.size());
502   ForwardRefMDNodes[MID] = std::make_pair(FwdNode, Lex.getLoc());
503   Node = FwdNode;
504   return false;
505 }
506
507 ///ParseNamedMetadata:
508 ///   !foo = !{ !1, !2 }
509 bool LLParser::ParseNamedMetadata() {
510   assert(Lex.getKind() == lltok::NamedOrCustomMD);
511   Lex.Lex();
512   std::string Name = Lex.getStrVal();
513
514   if (ParseToken(lltok::equal, "expected '=' here"))
515     return true;
516
517   if (Lex.getKind() != lltok::Metadata)
518     return TokError("Expected '!' here");
519   Lex.Lex();
520
521   if (Lex.getKind() != lltok::lbrace)
522     return TokError("Expected '{' here");
523   Lex.Lex();
524   SmallVector<MetadataBase *, 8> Elts;
525   do {
526     if (Lex.getKind() != lltok::Metadata)
527       return TokError("Expected '!' here");
528     Lex.Lex();
529     MetadataBase *N = 0;
530     if (ParseMDNode(N)) return true;
531     Elts.push_back(N);
532   } while (EatIfPresent(lltok::comma));
533
534   if (ParseToken(lltok::rbrace, "expected end of metadata node"))
535     return true;
536
537   NamedMDNode::Create(Context, Name, Elts.data(), Elts.size(), M);
538   return false;
539 }
540
541 /// ParseStandaloneMetadata:
542 ///   !42 = !{...}
543 bool LLParser::ParseStandaloneMetadata() {
544   assert(Lex.getKind() == lltok::Metadata);
545   Lex.Lex();
546   unsigned MetadataID = 0;
547   if (ParseUInt32(MetadataID))
548     return true;
549   if (MetadataCache.find(MetadataID) != MetadataCache.end())
550     return TokError("Metadata id is already used");
551   if (ParseToken(lltok::equal, "expected '=' here"))
552     return true;
553
554   LocTy TyLoc;
555   PATypeHolder Ty(Type::getVoidTy(Context));
556   if (ParseType(Ty, TyLoc))
557     return true;
558
559   if (Lex.getKind() != lltok::Metadata)
560     return TokError("Expected metadata here");
561
562   Lex.Lex();
563   if (Lex.getKind() != lltok::lbrace)
564     return TokError("Expected '{' here");
565
566   SmallVector<Value *, 16> Elts;
567   if (ParseMDNodeVector(Elts)
568       || ParseToken(lltok::rbrace, "expected end of metadata node"))
569     return true;
570
571   MDNode *Init = MDNode::get(Context, Elts.data(), Elts.size());
572   MetadataCache[MetadataID] = Init;
573   std::map<unsigned, std::pair<WeakVH, LocTy> >::iterator
574     FI = ForwardRefMDNodes.find(MetadataID);
575   if (FI != ForwardRefMDNodes.end()) {
576     MDNode *FwdNode = cast<MDNode>(FI->second.first);
577     FwdNode->replaceAllUsesWith(Init);
578     ForwardRefMDNodes.erase(FI);
579   }
580
581   return false;
582 }
583
584 /// ParseInlineMetadata:
585 ///   !{type %instr}
586 ///   !{...} MDNode
587 ///   !"foo" MDString
588 bool LLParser::ParseInlineMetadata(Value *&V, PerFunctionState &PFS) {
589   assert(Lex.getKind() == lltok::Metadata && "Only for Metadata");
590   V = 0;
591
592   Lex.Lex();
593   if (Lex.getKind() == lltok::lbrace) {
594     Lex.Lex();
595     if (ParseTypeAndValue(V, PFS) ||
596         ParseToken(lltok::rbrace, "expected end of metadata node"))
597       return true;
598
599     Value *Vals[] = { V };
600     V = MDNode::get(Context, Vals, 1);
601     return false;
602   }
603
604   // Standalone metadata reference
605   // !{ ..., !42, ... }
606   if (!ParseMDNode((MetadataBase *&)V))
607     return false;
608
609   // MDString:
610   // '!' STRINGCONSTANT
611   if (ParseMDString((MetadataBase *&)V)) return true;
612   return false;
613 }
614
615 /// ParseAlias:
616 ///   ::= GlobalVar '=' OptionalVisibility 'alias' OptionalLinkage Aliasee
617 /// Aliasee
618 ///   ::= TypeAndValue
619 ///   ::= 'bitcast' '(' TypeAndValue 'to' Type ')'
620 ///   ::= 'getelementptr' 'inbounds'? '(' ... ')'
621 ///
622 /// Everything through visibility has already been parsed.
623 ///
624 bool LLParser::ParseAlias(const std::string &Name, LocTy NameLoc,
625                           unsigned Visibility) {
626   assert(Lex.getKind() == lltok::kw_alias);
627   Lex.Lex();
628   unsigned Linkage;
629   LocTy LinkageLoc = Lex.getLoc();
630   if (ParseOptionalLinkage(Linkage))
631     return true;
632
633   if (Linkage != GlobalValue::ExternalLinkage &&
634       Linkage != GlobalValue::WeakAnyLinkage &&
635       Linkage != GlobalValue::WeakODRLinkage &&
636       Linkage != GlobalValue::InternalLinkage &&
637       Linkage != GlobalValue::PrivateLinkage &&
638       Linkage != GlobalValue::LinkerPrivateLinkage)
639     return Error(LinkageLoc, "invalid linkage type for alias");
640
641   Constant *Aliasee;
642   LocTy AliaseeLoc = Lex.getLoc();
643   if (Lex.getKind() != lltok::kw_bitcast &&
644       Lex.getKind() != lltok::kw_getelementptr) {
645     if (ParseGlobalTypeAndValue(Aliasee)) return true;
646   } else {
647     // The bitcast dest type is not present, it is implied by the dest type.
648     ValID ID;
649     if (ParseValID(ID)) return true;
650     if (ID.Kind != ValID::t_Constant)
651       return Error(AliaseeLoc, "invalid aliasee");
652     Aliasee = ID.ConstantVal;
653   }
654
655   if (!isa<PointerType>(Aliasee->getType()))
656     return Error(AliaseeLoc, "alias must have pointer type");
657
658   // Okay, create the alias but do not insert it into the module yet.
659   GlobalAlias* GA = new GlobalAlias(Aliasee->getType(),
660                                     (GlobalValue::LinkageTypes)Linkage, Name,
661                                     Aliasee);
662   GA->setVisibility((GlobalValue::VisibilityTypes)Visibility);
663
664   // See if this value already exists in the symbol table.  If so, it is either
665   // a redefinition or a definition of a forward reference.
666   if (GlobalValue *Val = M->getNamedValue(Name)) {
667     // See if this was a redefinition.  If so, there is no entry in
668     // ForwardRefVals.
669     std::map<std::string, std::pair<GlobalValue*, LocTy> >::iterator
670       I = ForwardRefVals.find(Name);
671     if (I == ForwardRefVals.end())
672       return Error(NameLoc, "redefinition of global named '@" + Name + "'");
673
674     // Otherwise, this was a definition of forward ref.  Verify that types
675     // agree.
676     if (Val->getType() != GA->getType())
677       return Error(NameLoc,
678               "forward reference and definition of alias have different types");
679
680     // If they agree, just RAUW the old value with the alias and remove the
681     // forward ref info.
682     Val->replaceAllUsesWith(GA);
683     Val->eraseFromParent();
684     ForwardRefVals.erase(I);
685   }
686
687   // Insert into the module, we know its name won't collide now.
688   M->getAliasList().push_back(GA);
689   assert(GA->getNameStr() == Name && "Should not be a name conflict!");
690
691   return false;
692 }
693
694 /// ParseGlobal
695 ///   ::= GlobalVar '=' OptionalLinkage OptionalVisibility OptionalThreadLocal
696 ///       OptionalAddrSpace GlobalType Type Const
697 ///   ::= OptionalLinkage OptionalVisibility OptionalThreadLocal
698 ///       OptionalAddrSpace GlobalType Type Const
699 ///
700 /// Everything through visibility has been parsed already.
701 ///
702 bool LLParser::ParseGlobal(const std::string &Name, LocTy NameLoc,
703                            unsigned Linkage, bool HasLinkage,
704                            unsigned Visibility) {
705   unsigned AddrSpace;
706   bool ThreadLocal, IsConstant;
707   LocTy TyLoc;
708
709   PATypeHolder Ty(Type::getVoidTy(Context));
710   if (ParseOptionalToken(lltok::kw_thread_local, ThreadLocal) ||
711       ParseOptionalAddrSpace(AddrSpace) ||
712       ParseGlobalType(IsConstant) ||
713       ParseType(Ty, TyLoc))
714     return true;
715
716   // If the linkage is specified and is external, then no initializer is
717   // present.
718   Constant *Init = 0;
719   if (!HasLinkage || (Linkage != GlobalValue::DLLImportLinkage &&
720                       Linkage != GlobalValue::ExternalWeakLinkage &&
721                       Linkage != GlobalValue::ExternalLinkage)) {
722     if (ParseGlobalValue(Ty, Init))
723       return true;
724   }
725
726   if (isa<FunctionType>(Ty) || Ty->isLabelTy())
727     return Error(TyLoc, "invalid type for global variable");
728
729   GlobalVariable *GV = 0;
730
731   // See if the global was forward referenced, if so, use the global.
732   if (!Name.empty()) {
733     if (GlobalValue *GVal = M->getNamedValue(Name)) {
734       if (!ForwardRefVals.erase(Name) || !isa<GlobalValue>(GVal))
735         return Error(NameLoc, "redefinition of global '@" + Name + "'");
736       GV = cast<GlobalVariable>(GVal);
737     }
738   } else {
739     std::map<unsigned, std::pair<GlobalValue*, LocTy> >::iterator
740       I = ForwardRefValIDs.find(NumberedVals.size());
741     if (I != ForwardRefValIDs.end()) {
742       GV = cast<GlobalVariable>(I->second.first);
743       ForwardRefValIDs.erase(I);
744     }
745   }
746
747   if (GV == 0) {
748     GV = new GlobalVariable(*M, Ty, false, GlobalValue::ExternalLinkage, 0,
749                             Name, 0, false, AddrSpace);
750   } else {
751     if (GV->getType()->getElementType() != Ty)
752       return Error(TyLoc,
753             "forward reference and definition of global have different types");
754
755     // Move the forward-reference to the correct spot in the module.
756     M->getGlobalList().splice(M->global_end(), M->getGlobalList(), GV);
757   }
758
759   if (Name.empty())
760     NumberedVals.push_back(GV);
761
762   // Set the parsed properties on the global.
763   if (Init)
764     GV->setInitializer(Init);
765   GV->setConstant(IsConstant);
766   GV->setLinkage((GlobalValue::LinkageTypes)Linkage);
767   GV->setVisibility((GlobalValue::VisibilityTypes)Visibility);
768   GV->setThreadLocal(ThreadLocal);
769
770   // Parse attributes on the global.
771   while (Lex.getKind() == lltok::comma) {
772     Lex.Lex();
773
774     if (Lex.getKind() == lltok::kw_section) {
775       Lex.Lex();
776       GV->setSection(Lex.getStrVal());
777       if (ParseToken(lltok::StringConstant, "expected global section string"))
778         return true;
779     } else if (Lex.getKind() == lltok::kw_align) {
780       unsigned Alignment;
781       if (ParseOptionalAlignment(Alignment)) return true;
782       GV->setAlignment(Alignment);
783     } else {
784       TokError("unknown global variable property!");
785     }
786   }
787
788   return false;
789 }
790
791
792 //===----------------------------------------------------------------------===//
793 // GlobalValue Reference/Resolution Routines.
794 //===----------------------------------------------------------------------===//
795
796 /// GetGlobalVal - Get a value with the specified name or ID, creating a
797 /// forward reference record if needed.  This can return null if the value
798 /// exists but does not have the right type.
799 GlobalValue *LLParser::GetGlobalVal(const std::string &Name, const Type *Ty,
800                                     LocTy Loc) {
801   const PointerType *PTy = dyn_cast<PointerType>(Ty);
802   if (PTy == 0) {
803     Error(Loc, "global variable reference must have pointer type");
804     return 0;
805   }
806
807   // Look this name up in the normal function symbol table.
808   GlobalValue *Val =
809     cast_or_null<GlobalValue>(M->getValueSymbolTable().lookup(Name));
810
811   // If this is a forward reference for the value, see if we already created a
812   // forward ref record.
813   if (Val == 0) {
814     std::map<std::string, std::pair<GlobalValue*, LocTy> >::iterator
815       I = ForwardRefVals.find(Name);
816     if (I != ForwardRefVals.end())
817       Val = I->second.first;
818   }
819
820   // If we have the value in the symbol table or fwd-ref table, return it.
821   if (Val) {
822     if (Val->getType() == Ty) return Val;
823     Error(Loc, "'@" + Name + "' defined with type '" +
824           Val->getType()->getDescription() + "'");
825     return 0;
826   }
827
828   // Otherwise, create a new forward reference for this value and remember it.
829   GlobalValue *FwdVal;
830   if (const FunctionType *FT = dyn_cast<FunctionType>(PTy->getElementType())) {
831     // Function types can return opaque but functions can't.
832     if (isa<OpaqueType>(FT->getReturnType())) {
833       Error(Loc, "function may not return opaque type");
834       return 0;
835     }
836
837     FwdVal = Function::Create(FT, GlobalValue::ExternalWeakLinkage, Name, M);
838   } else {
839     FwdVal = new GlobalVariable(*M, PTy->getElementType(), false,
840                                 GlobalValue::ExternalWeakLinkage, 0, Name);
841   }
842
843   ForwardRefVals[Name] = std::make_pair(FwdVal, Loc);
844   return FwdVal;
845 }
846
847 GlobalValue *LLParser::GetGlobalVal(unsigned ID, const Type *Ty, LocTy Loc) {
848   const PointerType *PTy = dyn_cast<PointerType>(Ty);
849   if (PTy == 0) {
850     Error(Loc, "global variable reference must have pointer type");
851     return 0;
852   }
853
854   GlobalValue *Val = ID < NumberedVals.size() ? NumberedVals[ID] : 0;
855
856   // If this is a forward reference for the value, see if we already created a
857   // forward ref record.
858   if (Val == 0) {
859     std::map<unsigned, std::pair<GlobalValue*, LocTy> >::iterator
860       I = ForwardRefValIDs.find(ID);
861     if (I != ForwardRefValIDs.end())
862       Val = I->second.first;
863   }
864
865   // If we have the value in the symbol table or fwd-ref table, return it.
866   if (Val) {
867     if (Val->getType() == Ty) return Val;
868     Error(Loc, "'@" + utostr(ID) + "' defined with type '" +
869           Val->getType()->getDescription() + "'");
870     return 0;
871   }
872
873   // Otherwise, create a new forward reference for this value and remember it.
874   GlobalValue *FwdVal;
875   if (const FunctionType *FT = dyn_cast<FunctionType>(PTy->getElementType())) {
876     // Function types can return opaque but functions can't.
877     if (isa<OpaqueType>(FT->getReturnType())) {
878       Error(Loc, "function may not return opaque type");
879       return 0;
880     }
881     FwdVal = Function::Create(FT, GlobalValue::ExternalWeakLinkage, "", M);
882   } else {
883     FwdVal = new GlobalVariable(*M, PTy->getElementType(), false,
884                                 GlobalValue::ExternalWeakLinkage, 0, "");
885   }
886
887   ForwardRefValIDs[ID] = std::make_pair(FwdVal, Loc);
888   return FwdVal;
889 }
890
891
892 //===----------------------------------------------------------------------===//
893 // Helper Routines.
894 //===----------------------------------------------------------------------===//
895
896 /// ParseToken - If the current token has the specified kind, eat it and return
897 /// success.  Otherwise, emit the specified error and return failure.
898 bool LLParser::ParseToken(lltok::Kind T, const char *ErrMsg) {
899   if (Lex.getKind() != T)
900     return TokError(ErrMsg);
901   Lex.Lex();
902   return false;
903 }
904
905 /// ParseStringConstant
906 ///   ::= StringConstant
907 bool LLParser::ParseStringConstant(std::string &Result) {
908   if (Lex.getKind() != lltok::StringConstant)
909     return TokError("expected string constant");
910   Result = Lex.getStrVal();
911   Lex.Lex();
912   return false;
913 }
914
915 /// ParseUInt32
916 ///   ::= uint32
917 bool LLParser::ParseUInt32(unsigned &Val) {
918   if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned())
919     return TokError("expected integer");
920   uint64_t Val64 = Lex.getAPSIntVal().getLimitedValue(0xFFFFFFFFULL+1);
921   if (Val64 != unsigned(Val64))
922     return TokError("expected 32-bit integer (too large)");
923   Val = Val64;
924   Lex.Lex();
925   return false;
926 }
927
928
929 /// ParseOptionalAddrSpace
930 ///   := /*empty*/
931 ///   := 'addrspace' '(' uint32 ')'
932 bool LLParser::ParseOptionalAddrSpace(unsigned &AddrSpace) {
933   AddrSpace = 0;
934   if (!EatIfPresent(lltok::kw_addrspace))
935     return false;
936   return ParseToken(lltok::lparen, "expected '(' in address space") ||
937          ParseUInt32(AddrSpace) ||
938          ParseToken(lltok::rparen, "expected ')' in address space");
939 }
940
941 /// ParseOptionalAttrs - Parse a potentially empty attribute list.  AttrKind
942 /// indicates what kind of attribute list this is: 0: function arg, 1: result,
943 /// 2: function attr.
944 /// 3: function arg after value: FIXME: REMOVE IN LLVM 3.0
945 bool LLParser::ParseOptionalAttrs(unsigned &Attrs, unsigned AttrKind) {
946   Attrs = Attribute::None;
947   LocTy AttrLoc = Lex.getLoc();
948
949   while (1) {
950     switch (Lex.getKind()) {
951     case lltok::kw_sext:
952     case lltok::kw_zext:
953       // Treat these as signext/zeroext if they occur in the argument list after
954       // the value, as in "call i8 @foo(i8 10 sext)".  If they occur before the
955       // value, as in "call i8 @foo(i8 sext (" then it is part of a constant
956       // expr.
957       // FIXME: REMOVE THIS IN LLVM 3.0
958       if (AttrKind == 3) {
959         if (Lex.getKind() == lltok::kw_sext)
960           Attrs |= Attribute::SExt;
961         else
962           Attrs |= Attribute::ZExt;
963         break;
964       }
965       // FALL THROUGH.
966     default:  // End of attributes.
967       if (AttrKind != 2 && (Attrs & Attribute::FunctionOnly))
968         return Error(AttrLoc, "invalid use of function-only attribute");
969
970       if (AttrKind != 0 && AttrKind != 3 && (Attrs & Attribute::ParameterOnly))
971         return Error(AttrLoc, "invalid use of parameter-only attribute");
972
973       return false;
974     case lltok::kw_zeroext:         Attrs |= Attribute::ZExt; break;
975     case lltok::kw_signext:         Attrs |= Attribute::SExt; break;
976     case lltok::kw_inreg:           Attrs |= Attribute::InReg; break;
977     case lltok::kw_sret:            Attrs |= Attribute::StructRet; break;
978     case lltok::kw_noalias:         Attrs |= Attribute::NoAlias; break;
979     case lltok::kw_nocapture:       Attrs |= Attribute::NoCapture; break;
980     case lltok::kw_byval:           Attrs |= Attribute::ByVal; break;
981     case lltok::kw_nest:            Attrs |= Attribute::Nest; break;
982
983     case lltok::kw_noreturn:        Attrs |= Attribute::NoReturn; break;
984     case lltok::kw_nounwind:        Attrs |= Attribute::NoUnwind; break;
985     case lltok::kw_noinline:        Attrs |= Attribute::NoInline; break;
986     case lltok::kw_readnone:        Attrs |= Attribute::ReadNone; break;
987     case lltok::kw_readonly:        Attrs |= Attribute::ReadOnly; break;
988     case lltok::kw_inlinehint:      Attrs |= Attribute::InlineHint; break;
989     case lltok::kw_alwaysinline:    Attrs |= Attribute::AlwaysInline; break;
990     case lltok::kw_optsize:         Attrs |= Attribute::OptimizeForSize; break;
991     case lltok::kw_ssp:             Attrs |= Attribute::StackProtect; break;
992     case lltok::kw_sspreq:          Attrs |= Attribute::StackProtectReq; break;
993     case lltok::kw_noredzone:       Attrs |= Attribute::NoRedZone; break;
994     case lltok::kw_noimplicitfloat: Attrs |= Attribute::NoImplicitFloat; break;
995     case lltok::kw_naked:           Attrs |= Attribute::Naked; break;
996
997     case lltok::kw_align: {
998       unsigned Alignment;
999       if (ParseOptionalAlignment(Alignment))
1000         return true;
1001       Attrs |= Attribute::constructAlignmentFromInt(Alignment);
1002       continue;
1003     }
1004     }
1005     Lex.Lex();
1006   }
1007 }
1008
1009 /// ParseOptionalLinkage
1010 ///   ::= /*empty*/
1011 ///   ::= 'private'
1012 ///   ::= 'linker_private'
1013 ///   ::= 'internal'
1014 ///   ::= 'weak'
1015 ///   ::= 'weak_odr'
1016 ///   ::= 'linkonce'
1017 ///   ::= 'linkonce_odr'
1018 ///   ::= 'appending'
1019 ///   ::= 'dllexport'
1020 ///   ::= 'common'
1021 ///   ::= 'dllimport'
1022 ///   ::= 'extern_weak'
1023 ///   ::= 'external'
1024 bool LLParser::ParseOptionalLinkage(unsigned &Res, bool &HasLinkage) {
1025   HasLinkage = false;
1026   switch (Lex.getKind()) {
1027   default:                       Res=GlobalValue::ExternalLinkage; return false;
1028   case lltok::kw_private:        Res = GlobalValue::PrivateLinkage;       break;
1029   case lltok::kw_linker_private: Res = GlobalValue::LinkerPrivateLinkage; break;
1030   case lltok::kw_internal:       Res = GlobalValue::InternalLinkage;      break;
1031   case lltok::kw_weak:           Res = GlobalValue::WeakAnyLinkage;       break;
1032   case lltok::kw_weak_odr:       Res = GlobalValue::WeakODRLinkage;       break;
1033   case lltok::kw_linkonce:       Res = GlobalValue::LinkOnceAnyLinkage;   break;
1034   case lltok::kw_linkonce_odr:   Res = GlobalValue::LinkOnceODRLinkage;   break;
1035   case lltok::kw_available_externally:
1036     Res = GlobalValue::AvailableExternallyLinkage;
1037     break;
1038   case lltok::kw_appending:      Res = GlobalValue::AppendingLinkage;     break;
1039   case lltok::kw_dllexport:      Res = GlobalValue::DLLExportLinkage;     break;
1040   case lltok::kw_common:         Res = GlobalValue::CommonLinkage;        break;
1041   case lltok::kw_dllimport:      Res = GlobalValue::DLLImportLinkage;     break;
1042   case lltok::kw_extern_weak:    Res = GlobalValue::ExternalWeakLinkage;  break;
1043   case lltok::kw_external:       Res = GlobalValue::ExternalLinkage;      break;
1044   }
1045   Lex.Lex();
1046   HasLinkage = true;
1047   return false;
1048 }
1049
1050 /// ParseOptionalVisibility
1051 ///   ::= /*empty*/
1052 ///   ::= 'default'
1053 ///   ::= 'hidden'
1054 ///   ::= 'protected'
1055 ///
1056 bool LLParser::ParseOptionalVisibility(unsigned &Res) {
1057   switch (Lex.getKind()) {
1058   default:                  Res = GlobalValue::DefaultVisibility; return false;
1059   case lltok::kw_default:   Res = GlobalValue::DefaultVisibility; break;
1060   case lltok::kw_hidden:    Res = GlobalValue::HiddenVisibility; break;
1061   case lltok::kw_protected: Res = GlobalValue::ProtectedVisibility; break;
1062   }
1063   Lex.Lex();
1064   return false;
1065 }
1066
1067 /// ParseOptionalCallingConv
1068 ///   ::= /*empty*/
1069 ///   ::= 'ccc'
1070 ///   ::= 'fastcc'
1071 ///   ::= 'coldcc'
1072 ///   ::= 'x86_stdcallcc'
1073 ///   ::= 'x86_fastcallcc'
1074 ///   ::= 'arm_apcscc'
1075 ///   ::= 'arm_aapcscc'
1076 ///   ::= 'arm_aapcs_vfpcc'
1077 ///   ::= 'cc' UINT
1078 ///
1079 bool LLParser::ParseOptionalCallingConv(CallingConv::ID &CC) {
1080   switch (Lex.getKind()) {
1081   default:                       CC = CallingConv::C; return false;
1082   case lltok::kw_ccc:            CC = CallingConv::C; break;
1083   case lltok::kw_fastcc:         CC = CallingConv::Fast; break;
1084   case lltok::kw_coldcc:         CC = CallingConv::Cold; break;
1085   case lltok::kw_x86_stdcallcc:  CC = CallingConv::X86_StdCall; break;
1086   case lltok::kw_x86_fastcallcc: CC = CallingConv::X86_FastCall; break;
1087   case lltok::kw_arm_apcscc:     CC = CallingConv::ARM_APCS; break;
1088   case lltok::kw_arm_aapcscc:    CC = CallingConv::ARM_AAPCS; break;
1089   case lltok::kw_arm_aapcs_vfpcc:CC = CallingConv::ARM_AAPCS_VFP; break;
1090   case lltok::kw_cc: {
1091       unsigned ArbitraryCC;
1092       Lex.Lex();
1093       if (ParseUInt32(ArbitraryCC)) {
1094         return true;
1095       } else
1096         CC = static_cast<CallingConv::ID>(ArbitraryCC);
1097         return false;
1098     }
1099     break;
1100   }
1101
1102   Lex.Lex();
1103   return false;
1104 }
1105
1106 /// ParseOptionalCustomMetadata
1107 ///   ::= /* empty */
1108 ///   ::= !dbg !42
1109 bool LLParser::ParseOptionalCustomMetadata() {
1110   if (Lex.getKind() != lltok::NamedOrCustomMD)
1111     return false;
1112
1113   std::string Name = Lex.getStrVal();
1114   Lex.Lex();
1115
1116   if (Lex.getKind() != lltok::Metadata)
1117     return TokError("Expected '!' here");
1118   Lex.Lex();
1119
1120   MetadataBase *Node;
1121   if (ParseMDNode(Node)) return true;
1122
1123   MetadataContext &TheMetadata = M->getContext().getMetadata();
1124   unsigned MDK = TheMetadata.getMDKind(Name.c_str());
1125   if (!MDK)
1126     MDK = TheMetadata.registerMDKind(Name.c_str());
1127   MDsOnInst.push_back(std::make_pair(MDK, cast<MDNode>(Node)));
1128
1129   return false;
1130 }
1131
1132 /// ParseOptionalAlignment
1133 ///   ::= /* empty */
1134 ///   ::= 'align' 4
1135 bool LLParser::ParseOptionalAlignment(unsigned &Alignment) {
1136   Alignment = 0;
1137   if (!EatIfPresent(lltok::kw_align))
1138     return false;
1139   LocTy AlignLoc = Lex.getLoc();
1140   if (ParseUInt32(Alignment)) return true;
1141   if (!isPowerOf2_32(Alignment))
1142     return Error(AlignLoc, "alignment is not a power of two");
1143   return false;
1144 }
1145
1146 /// ParseOptionalInfo
1147 ///   ::= OptionalInfo (',' OptionalInfo)+
1148 bool LLParser::ParseOptionalInfo(unsigned &Alignment) {
1149
1150   // FIXME: Handle customized metadata info attached with an instruction.
1151   do {
1152       if (Lex.getKind() == lltok::NamedOrCustomMD) {
1153       if (ParseOptionalCustomMetadata()) return true;
1154     } else if (Lex.getKind() == lltok::kw_align) {
1155       if (ParseOptionalAlignment(Alignment)) return true;
1156     } else
1157       return true;
1158   } while (EatIfPresent(lltok::comma));
1159
1160   return false;
1161 }
1162
1163
1164 /// ParseIndexList
1165 ///    ::=  (',' uint32)+
1166 bool LLParser::ParseIndexList(SmallVectorImpl<unsigned> &Indices) {
1167   if (Lex.getKind() != lltok::comma)
1168     return TokError("expected ',' as start of index list");
1169
1170   while (EatIfPresent(lltok::comma)) {
1171     if (Lex.getKind() == lltok::NamedOrCustomMD)
1172       break;
1173     unsigned Idx;
1174     if (ParseUInt32(Idx)) return true;
1175     Indices.push_back(Idx);
1176   }
1177
1178   return false;
1179 }
1180
1181 //===----------------------------------------------------------------------===//
1182 // Type Parsing.
1183 //===----------------------------------------------------------------------===//
1184
1185 /// ParseType - Parse and resolve a full type.
1186 bool LLParser::ParseType(PATypeHolder &Result, bool AllowVoid) {
1187   LocTy TypeLoc = Lex.getLoc();
1188   if (ParseTypeRec(Result)) return true;
1189
1190   // Verify no unresolved uprefs.
1191   if (!UpRefs.empty())
1192     return Error(UpRefs.back().Loc, "invalid unresolved type up reference");
1193
1194   if (!AllowVoid && Result.get()->isVoidTy())
1195     return Error(TypeLoc, "void type only allowed for function results");
1196
1197   return false;
1198 }
1199
1200 /// HandleUpRefs - Every time we finish a new layer of types, this function is
1201 /// called.  It loops through the UpRefs vector, which is a list of the
1202 /// currently active types.  For each type, if the up-reference is contained in
1203 /// the newly completed type, we decrement the level count.  When the level
1204 /// count reaches zero, the up-referenced type is the type that is passed in:
1205 /// thus we can complete the cycle.
1206 ///
1207 PATypeHolder LLParser::HandleUpRefs(const Type *ty) {
1208   // If Ty isn't abstract, or if there are no up-references in it, then there is
1209   // nothing to resolve here.
1210   if (!ty->isAbstract() || UpRefs.empty()) return ty;
1211
1212   PATypeHolder Ty(ty);
1213 #if 0
1214   errs() << "Type '" << Ty->getDescription()
1215          << "' newly formed.  Resolving upreferences.\n"
1216          << UpRefs.size() << " upreferences active!\n";
1217 #endif
1218
1219   // If we find any resolvable upreferences (i.e., those whose NestingLevel goes
1220   // to zero), we resolve them all together before we resolve them to Ty.  At
1221   // the end of the loop, if there is anything to resolve to Ty, it will be in
1222   // this variable.
1223   OpaqueType *TypeToResolve = 0;
1224
1225   for (unsigned i = 0; i != UpRefs.size(); ++i) {
1226     // Determine if 'Ty' directly contains this up-references 'LastContainedTy'.
1227     bool ContainsType =
1228       std::find(Ty->subtype_begin(), Ty->subtype_end(),
1229                 UpRefs[i].LastContainedTy) != Ty->subtype_end();
1230
1231 #if 0
1232     errs() << "  UR#" << i << " - TypeContains(" << Ty->getDescription() << ", "
1233            << UpRefs[i].LastContainedTy->getDescription() << ") = "
1234            << (ContainsType ? "true" : "false")
1235            << " level=" << UpRefs[i].NestingLevel << "\n";
1236 #endif
1237     if (!ContainsType)
1238       continue;
1239
1240     // Decrement level of upreference
1241     unsigned Level = --UpRefs[i].NestingLevel;
1242     UpRefs[i].LastContainedTy = Ty;
1243
1244     // If the Up-reference has a non-zero level, it shouldn't be resolved yet.
1245     if (Level != 0)
1246       continue;
1247
1248 #if 0
1249     errs() << "  * Resolving upreference for " << UpRefs[i].UpRefTy << "\n";
1250 #endif
1251     if (!TypeToResolve)
1252       TypeToResolve = UpRefs[i].UpRefTy;
1253     else
1254       UpRefs[i].UpRefTy->refineAbstractTypeTo(TypeToResolve);
1255     UpRefs.erase(UpRefs.begin()+i);     // Remove from upreference list.
1256     --i;                                // Do not skip the next element.
1257   }
1258
1259   if (TypeToResolve)
1260     TypeToResolve->refineAbstractTypeTo(Ty);
1261
1262   return Ty;
1263 }
1264
1265
1266 /// ParseTypeRec - The recursive function used to process the internal
1267 /// implementation details of types.
1268 bool LLParser::ParseTypeRec(PATypeHolder &Result) {
1269   switch (Lex.getKind()) {
1270   default:
1271     return TokError("expected type");
1272   case lltok::Type:
1273     // TypeRec ::= 'float' | 'void' (etc)
1274     Result = Lex.getTyVal();
1275     Lex.Lex();
1276     break;
1277   case lltok::kw_opaque:
1278     // TypeRec ::= 'opaque'
1279     Result = OpaqueType::get(Context);
1280     Lex.Lex();
1281     break;
1282   case lltok::lbrace:
1283     // TypeRec ::= '{' ... '}'
1284     if (ParseStructType(Result, false))
1285       return true;
1286     break;
1287   case lltok::lsquare:
1288     // TypeRec ::= '[' ... ']'
1289     Lex.Lex(); // eat the lsquare.
1290     if (ParseArrayVectorType(Result, false))
1291       return true;
1292     break;
1293   case lltok::less: // Either vector or packed struct.
1294     // TypeRec ::= '<' ... '>'
1295     Lex.Lex();
1296     if (Lex.getKind() == lltok::lbrace) {
1297       if (ParseStructType(Result, true) ||
1298           ParseToken(lltok::greater, "expected '>' at end of packed struct"))
1299         return true;
1300     } else if (ParseArrayVectorType(Result, true))
1301       return true;
1302     break;
1303   case lltok::LocalVar:
1304   case lltok::StringConstant:  // FIXME: REMOVE IN LLVM 3.0
1305     // TypeRec ::= %foo
1306     if (const Type *T = M->getTypeByName(Lex.getStrVal())) {
1307       Result = T;
1308     } else {
1309       Result = OpaqueType::get(Context);
1310       ForwardRefTypes.insert(std::make_pair(Lex.getStrVal(),
1311                                             std::make_pair(Result,
1312                                                            Lex.getLoc())));
1313       M->addTypeName(Lex.getStrVal(), Result.get());
1314     }
1315     Lex.Lex();
1316     break;
1317
1318   case lltok::LocalVarID:
1319     // TypeRec ::= %4
1320     if (Lex.getUIntVal() < NumberedTypes.size())
1321       Result = NumberedTypes[Lex.getUIntVal()];
1322     else {
1323       std::map<unsigned, std::pair<PATypeHolder, LocTy> >::iterator
1324         I = ForwardRefTypeIDs.find(Lex.getUIntVal());
1325       if (I != ForwardRefTypeIDs.end())
1326         Result = I->second.first;
1327       else {
1328         Result = OpaqueType::get(Context);
1329         ForwardRefTypeIDs.insert(std::make_pair(Lex.getUIntVal(),
1330                                                 std::make_pair(Result,
1331                                                                Lex.getLoc())));
1332       }
1333     }
1334     Lex.Lex();
1335     break;
1336   case lltok::backslash: {
1337     // TypeRec ::= '\' 4
1338     Lex.Lex();
1339     unsigned Val;
1340     if (ParseUInt32(Val)) return true;
1341     OpaqueType *OT = OpaqueType::get(Context); //Use temporary placeholder.
1342     UpRefs.push_back(UpRefRecord(Lex.getLoc(), Val, OT));
1343     Result = OT;
1344     break;
1345   }
1346   }
1347
1348   // Parse the type suffixes.
1349   while (1) {
1350     switch (Lex.getKind()) {
1351     // End of type.
1352     default: return false;
1353
1354     // TypeRec ::= TypeRec '*'
1355     case lltok::star:
1356       if (Result.get()->isLabelTy())
1357         return TokError("basic block pointers are invalid");
1358       if (Result.get()->isVoidTy())
1359         return TokError("pointers to void are invalid; use i8* instead");
1360       if (!PointerType::isValidElementType(Result.get()))
1361         return TokError("pointer to this type is invalid");
1362       Result = HandleUpRefs(PointerType::getUnqual(Result.get()));
1363       Lex.Lex();
1364       break;
1365
1366     // TypeRec ::= TypeRec 'addrspace' '(' uint32 ')' '*'
1367     case lltok::kw_addrspace: {
1368       if (Result.get()->isLabelTy())
1369         return TokError("basic block pointers are invalid");
1370       if (Result.get()->isVoidTy())
1371         return TokError("pointers to void are invalid; use i8* instead");
1372       if (!PointerType::isValidElementType(Result.get()))
1373         return TokError("pointer to this type is invalid");
1374       unsigned AddrSpace;
1375       if (ParseOptionalAddrSpace(AddrSpace) ||
1376           ParseToken(lltok::star, "expected '*' in address space"))
1377         return true;
1378
1379       Result = HandleUpRefs(PointerType::get(Result.get(), AddrSpace));
1380       break;
1381     }
1382
1383     /// Types '(' ArgTypeListI ')' OptFuncAttrs
1384     case lltok::lparen:
1385       if (ParseFunctionType(Result))
1386         return true;
1387       break;
1388     }
1389   }
1390 }
1391
1392 /// ParseParameterList
1393 ///    ::= '(' ')'
1394 ///    ::= '(' Arg (',' Arg)* ')'
1395 ///  Arg
1396 ///    ::= Type OptionalAttributes Value OptionalAttributes
1397 bool LLParser::ParseParameterList(SmallVectorImpl<ParamInfo> &ArgList,
1398                                   PerFunctionState &PFS) {
1399   if (ParseToken(lltok::lparen, "expected '(' in call"))
1400     return true;
1401
1402   while (Lex.getKind() != lltok::rparen) {
1403     // If this isn't the first argument, we need a comma.
1404     if (!ArgList.empty() &&
1405         ParseToken(lltok::comma, "expected ',' in argument list"))
1406       return true;
1407
1408     // Parse the argument.
1409     LocTy ArgLoc;
1410     PATypeHolder ArgTy(Type::getVoidTy(Context));
1411     unsigned ArgAttrs1 = Attribute::None;
1412     unsigned ArgAttrs2 = Attribute::None;
1413     Value *V;
1414     if (ParseType(ArgTy, ArgLoc))
1415       return true;
1416
1417     if (Lex.getKind() == lltok::Metadata) {
1418       if (ParseInlineMetadata(V, PFS))
1419         return true;
1420     } else {
1421       if (ParseOptionalAttrs(ArgAttrs1, 0) ||
1422           ParseValue(ArgTy, V, PFS) ||
1423           // FIXME: Should not allow attributes after the argument, remove this
1424           // in LLVM 3.0.
1425           ParseOptionalAttrs(ArgAttrs2, 3))
1426         return true;
1427     }
1428     ArgList.push_back(ParamInfo(ArgLoc, V, ArgAttrs1|ArgAttrs2));
1429   }
1430
1431   Lex.Lex();  // Lex the ')'.
1432   return false;
1433 }
1434
1435
1436
1437 /// ParseArgumentList - Parse the argument list for a function type or function
1438 /// prototype.  If 'inType' is true then we are parsing a FunctionType.
1439 ///   ::= '(' ArgTypeListI ')'
1440 /// ArgTypeListI
1441 ///   ::= /*empty*/
1442 ///   ::= '...'
1443 ///   ::= ArgTypeList ',' '...'
1444 ///   ::= ArgType (',' ArgType)*
1445 ///
1446 bool LLParser::ParseArgumentList(std::vector<ArgInfo> &ArgList,
1447                                  bool &isVarArg, bool inType) {
1448   isVarArg = false;
1449   assert(Lex.getKind() == lltok::lparen);
1450   Lex.Lex(); // eat the (.
1451
1452   if (Lex.getKind() == lltok::rparen) {
1453     // empty
1454   } else if (Lex.getKind() == lltok::dotdotdot) {
1455     isVarArg = true;
1456     Lex.Lex();
1457   } else {
1458     LocTy TypeLoc = Lex.getLoc();
1459     PATypeHolder ArgTy(Type::getVoidTy(Context));
1460     unsigned Attrs;
1461     std::string Name;
1462
1463     // If we're parsing a type, use ParseTypeRec, because we allow recursive
1464     // types (such as a function returning a pointer to itself).  If parsing a
1465     // function prototype, we require fully resolved types.
1466     if ((inType ? ParseTypeRec(ArgTy) : ParseType(ArgTy)) ||
1467         ParseOptionalAttrs(Attrs, 0)) return true;
1468
1469     if (ArgTy->isVoidTy())
1470       return Error(TypeLoc, "argument can not have void type");
1471
1472     if (Lex.getKind() == lltok::LocalVar ||
1473         Lex.getKind() == lltok::StringConstant) { // FIXME: REMOVE IN LLVM 3.0
1474       Name = Lex.getStrVal();
1475       Lex.Lex();
1476     }
1477
1478     if (!FunctionType::isValidArgumentType(ArgTy))
1479       return Error(TypeLoc, "invalid type for function argument");
1480
1481     ArgList.push_back(ArgInfo(TypeLoc, ArgTy, Attrs, Name));
1482
1483     while (EatIfPresent(lltok::comma)) {
1484       // Handle ... at end of arg list.
1485       if (EatIfPresent(lltok::dotdotdot)) {
1486         isVarArg = true;
1487         break;
1488       }
1489
1490       // Otherwise must be an argument type.
1491       TypeLoc = Lex.getLoc();
1492       if ((inType ? ParseTypeRec(ArgTy) : ParseType(ArgTy)) ||
1493           ParseOptionalAttrs(Attrs, 0)) return true;
1494
1495       if (ArgTy->isVoidTy())
1496         return Error(TypeLoc, "argument can not have void type");
1497
1498       if (Lex.getKind() == lltok::LocalVar ||
1499           Lex.getKind() == lltok::StringConstant) { // FIXME: REMOVE IN LLVM 3.0
1500         Name = Lex.getStrVal();
1501         Lex.Lex();
1502       } else {
1503         Name = "";
1504       }
1505
1506       if (!ArgTy->isFirstClassType() && !isa<OpaqueType>(ArgTy))
1507         return Error(TypeLoc, "invalid type for function argument");
1508
1509       ArgList.push_back(ArgInfo(TypeLoc, ArgTy, Attrs, Name));
1510     }
1511   }
1512
1513   return ParseToken(lltok::rparen, "expected ')' at end of argument list");
1514 }
1515
1516 /// ParseFunctionType
1517 ///  ::= Type ArgumentList OptionalAttrs
1518 bool LLParser::ParseFunctionType(PATypeHolder &Result) {
1519   assert(Lex.getKind() == lltok::lparen);
1520
1521   if (!FunctionType::isValidReturnType(Result))
1522     return TokError("invalid function return type");
1523
1524   std::vector<ArgInfo> ArgList;
1525   bool isVarArg;
1526   unsigned Attrs;
1527   if (ParseArgumentList(ArgList, isVarArg, true) ||
1528       // FIXME: Allow, but ignore attributes on function types!
1529       // FIXME: Remove in LLVM 3.0
1530       ParseOptionalAttrs(Attrs, 2))
1531     return true;
1532
1533   // Reject names on the arguments lists.
1534   for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
1535     if (!ArgList[i].Name.empty())
1536       return Error(ArgList[i].Loc, "argument name invalid in function type");
1537     if (!ArgList[i].Attrs != 0) {
1538       // Allow but ignore attributes on function types; this permits
1539       // auto-upgrade.
1540       // FIXME: REJECT ATTRIBUTES ON FUNCTION TYPES in LLVM 3.0
1541     }
1542   }
1543
1544   std::vector<const Type*> ArgListTy;
1545   for (unsigned i = 0, e = ArgList.size(); i != e; ++i)
1546     ArgListTy.push_back(ArgList[i].Type);
1547
1548   Result = HandleUpRefs(FunctionType::get(Result.get(),
1549                                                 ArgListTy, isVarArg));
1550   return false;
1551 }
1552
1553 /// ParseStructType: Handles packed and unpacked types.  </> parsed elsewhere.
1554 ///   TypeRec
1555 ///     ::= '{' '}'
1556 ///     ::= '{' TypeRec (',' TypeRec)* '}'
1557 ///     ::= '<' '{' '}' '>'
1558 ///     ::= '<' '{' TypeRec (',' TypeRec)* '}' '>'
1559 bool LLParser::ParseStructType(PATypeHolder &Result, bool Packed) {
1560   assert(Lex.getKind() == lltok::lbrace);
1561   Lex.Lex(); // Consume the '{'
1562
1563   if (EatIfPresent(lltok::rbrace)) {
1564     Result = StructType::get(Context, Packed);
1565     return false;
1566   }
1567
1568   std::vector<PATypeHolder> ParamsList;
1569   LocTy EltTyLoc = Lex.getLoc();
1570   if (ParseTypeRec(Result)) return true;
1571   ParamsList.push_back(Result);
1572
1573   if (Result->isVoidTy())
1574     return Error(EltTyLoc, "struct element can not have void type");
1575   if (!StructType::isValidElementType(Result))
1576     return Error(EltTyLoc, "invalid element type for struct");
1577
1578   while (EatIfPresent(lltok::comma)) {
1579     EltTyLoc = Lex.getLoc();
1580     if (ParseTypeRec(Result)) return true;
1581
1582     if (Result->isVoidTy())
1583       return Error(EltTyLoc, "struct element can not have void type");
1584     if (!StructType::isValidElementType(Result))
1585       return Error(EltTyLoc, "invalid element type for struct");
1586
1587     ParamsList.push_back(Result);
1588   }
1589
1590   if (ParseToken(lltok::rbrace, "expected '}' at end of struct"))
1591     return true;
1592
1593   std::vector<const Type*> ParamsListTy;
1594   for (unsigned i = 0, e = ParamsList.size(); i != e; ++i)
1595     ParamsListTy.push_back(ParamsList[i].get());
1596   Result = HandleUpRefs(StructType::get(Context, ParamsListTy, Packed));
1597   return false;
1598 }
1599
1600 /// ParseArrayVectorType - Parse an array or vector type, assuming the first
1601 /// token has already been consumed.
1602 ///   TypeRec
1603 ///     ::= '[' APSINTVAL 'x' Types ']'
1604 ///     ::= '<' APSINTVAL 'x' Types '>'
1605 bool LLParser::ParseArrayVectorType(PATypeHolder &Result, bool isVector) {
1606   if (Lex.getKind() != lltok::APSInt || Lex.getAPSIntVal().isSigned() ||
1607       Lex.getAPSIntVal().getBitWidth() > 64)
1608     return TokError("expected number in address space");
1609
1610   LocTy SizeLoc = Lex.getLoc();
1611   uint64_t Size = Lex.getAPSIntVal().getZExtValue();
1612   Lex.Lex();
1613
1614   if (ParseToken(lltok::kw_x, "expected 'x' after element count"))
1615       return true;
1616
1617   LocTy TypeLoc = Lex.getLoc();
1618   PATypeHolder EltTy(Type::getVoidTy(Context));
1619   if (ParseTypeRec(EltTy)) return true;
1620
1621   if (EltTy->isVoidTy())
1622     return Error(TypeLoc, "array and vector element type cannot be void");
1623
1624   if (ParseToken(isVector ? lltok::greater : lltok::rsquare,
1625                  "expected end of sequential type"))
1626     return true;
1627
1628   if (isVector) {
1629     if (Size == 0)
1630       return Error(SizeLoc, "zero element vector is illegal");
1631     if ((unsigned)Size != Size)
1632       return Error(SizeLoc, "size too large for vector");
1633     if (!VectorType::isValidElementType(EltTy))
1634       return Error(TypeLoc, "vector element type must be fp or integer");
1635     Result = VectorType::get(EltTy, unsigned(Size));
1636   } else {
1637     if (!ArrayType::isValidElementType(EltTy))
1638       return Error(TypeLoc, "invalid array element type");
1639     Result = HandleUpRefs(ArrayType::get(EltTy, Size));
1640   }
1641   return false;
1642 }
1643
1644 //===----------------------------------------------------------------------===//
1645 // Function Semantic Analysis.
1646 //===----------------------------------------------------------------------===//
1647
1648 LLParser::PerFunctionState::PerFunctionState(LLParser &p, Function &f,
1649                                              int functionNumber)
1650   : P(p), F(f), FunctionNumber(functionNumber) {
1651
1652   // Insert unnamed arguments into the NumberedVals list.
1653   for (Function::arg_iterator AI = F.arg_begin(), E = F.arg_end();
1654        AI != E; ++AI)
1655     if (!AI->hasName())
1656       NumberedVals.push_back(AI);
1657 }
1658
1659 LLParser::PerFunctionState::~PerFunctionState() {
1660   // If there were any forward referenced non-basicblock values, delete them.
1661   for (std::map<std::string, std::pair<Value*, LocTy> >::iterator
1662        I = ForwardRefVals.begin(), E = ForwardRefVals.end(); I != E; ++I)
1663     if (!isa<BasicBlock>(I->second.first)) {
1664       I->second.first->replaceAllUsesWith(
1665                            UndefValue::get(I->second.first->getType()));
1666       delete I->second.first;
1667       I->second.first = 0;
1668     }
1669
1670   for (std::map<unsigned, std::pair<Value*, LocTy> >::iterator
1671        I = ForwardRefValIDs.begin(), E = ForwardRefValIDs.end(); I != E; ++I)
1672     if (!isa<BasicBlock>(I->second.first)) {
1673       I->second.first->replaceAllUsesWith(
1674                            UndefValue::get(I->second.first->getType()));
1675       delete I->second.first;
1676       I->second.first = 0;
1677     }
1678 }
1679
1680 bool LLParser::PerFunctionState::FinishFunction() {
1681   // Check to see if someone took the address of labels in this block.
1682   if (!P.ForwardRefBlockAddresses.empty()) {
1683     ValID FunctionID;
1684     if (!F.getName().empty()) {
1685       FunctionID.Kind = ValID::t_GlobalName;
1686       FunctionID.StrVal = F.getName();
1687     } else {
1688       FunctionID.Kind = ValID::t_GlobalID;
1689       FunctionID.UIntVal = FunctionNumber;
1690     }
1691   
1692     std::map<ValID, std::vector<std::pair<ValID, GlobalValue*> > >::iterator
1693       FRBAI = P.ForwardRefBlockAddresses.find(FunctionID);
1694     if (FRBAI != P.ForwardRefBlockAddresses.end()) {
1695       // Resolve all these references.
1696       if (P.ResolveForwardRefBlockAddresses(&F, FRBAI->second, this))
1697         return true;
1698       
1699       P.ForwardRefBlockAddresses.erase(FRBAI);
1700     }
1701   }
1702   
1703   if (!ForwardRefVals.empty())
1704     return P.Error(ForwardRefVals.begin()->second.second,
1705                    "use of undefined value '%" + ForwardRefVals.begin()->first +
1706                    "'");
1707   if (!ForwardRefValIDs.empty())
1708     return P.Error(ForwardRefValIDs.begin()->second.second,
1709                    "use of undefined value '%" +
1710                    utostr(ForwardRefValIDs.begin()->first) + "'");
1711   return false;
1712 }
1713
1714
1715 /// GetVal - Get a value with the specified name or ID, creating a
1716 /// forward reference record if needed.  This can return null if the value
1717 /// exists but does not have the right type.
1718 Value *LLParser::PerFunctionState::GetVal(const std::string &Name,
1719                                           const Type *Ty, LocTy Loc) {
1720   // Look this name up in the normal function symbol table.
1721   Value *Val = F.getValueSymbolTable().lookup(Name);
1722
1723   // If this is a forward reference for the value, see if we already created a
1724   // forward ref record.
1725   if (Val == 0) {
1726     std::map<std::string, std::pair<Value*, LocTy> >::iterator
1727       I = ForwardRefVals.find(Name);
1728     if (I != ForwardRefVals.end())
1729       Val = I->second.first;
1730   }
1731
1732   // If we have the value in the symbol table or fwd-ref table, return it.
1733   if (Val) {
1734     if (Val->getType() == Ty) return Val;
1735     if (Ty->isLabelTy())
1736       P.Error(Loc, "'%" + Name + "' is not a basic block");
1737     else
1738       P.Error(Loc, "'%" + Name + "' defined with type '" +
1739               Val->getType()->getDescription() + "'");
1740     return 0;
1741   }
1742
1743   // Don't make placeholders with invalid type.
1744   if (!Ty->isFirstClassType() && !isa<OpaqueType>(Ty) &&
1745       Ty != Type::getLabelTy(F.getContext())) {
1746     P.Error(Loc, "invalid use of a non-first-class type");
1747     return 0;
1748   }
1749
1750   // Otherwise, create a new forward reference for this value and remember it.
1751   Value *FwdVal;
1752   if (Ty->isLabelTy())
1753     FwdVal = BasicBlock::Create(F.getContext(), Name, &F);
1754   else
1755     FwdVal = new Argument(Ty, Name);
1756
1757   ForwardRefVals[Name] = std::make_pair(FwdVal, Loc);
1758   return FwdVal;
1759 }
1760
1761 Value *LLParser::PerFunctionState::GetVal(unsigned ID, const Type *Ty,
1762                                           LocTy Loc) {
1763   // Look this name up in the normal function symbol table.
1764   Value *Val = ID < NumberedVals.size() ? NumberedVals[ID] : 0;
1765
1766   // If this is a forward reference for the value, see if we already created a
1767   // forward ref record.
1768   if (Val == 0) {
1769     std::map<unsigned, std::pair<Value*, LocTy> >::iterator
1770       I = ForwardRefValIDs.find(ID);
1771     if (I != ForwardRefValIDs.end())
1772       Val = I->second.first;
1773   }
1774
1775   // If we have the value in the symbol table or fwd-ref table, return it.
1776   if (Val) {
1777     if (Val->getType() == Ty) return Val;
1778     if (Ty->isLabelTy())
1779       P.Error(Loc, "'%" + utostr(ID) + "' is not a basic block");
1780     else
1781       P.Error(Loc, "'%" + utostr(ID) + "' defined with type '" +
1782               Val->getType()->getDescription() + "'");
1783     return 0;
1784   }
1785
1786   if (!Ty->isFirstClassType() && !isa<OpaqueType>(Ty) &&
1787       Ty != Type::getLabelTy(F.getContext())) {
1788     P.Error(Loc, "invalid use of a non-first-class type");
1789     return 0;
1790   }
1791
1792   // Otherwise, create a new forward reference for this value and remember it.
1793   Value *FwdVal;
1794   if (Ty->isLabelTy())
1795     FwdVal = BasicBlock::Create(F.getContext(), "", &F);
1796   else
1797     FwdVal = new Argument(Ty);
1798
1799   ForwardRefValIDs[ID] = std::make_pair(FwdVal, Loc);
1800   return FwdVal;
1801 }
1802
1803 /// SetInstName - After an instruction is parsed and inserted into its
1804 /// basic block, this installs its name.
1805 bool LLParser::PerFunctionState::SetInstName(int NameID,
1806                                              const std::string &NameStr,
1807                                              LocTy NameLoc, Instruction *Inst) {
1808   // If this instruction has void type, it cannot have a name or ID specified.
1809   if (Inst->getType()->isVoidTy()) {
1810     if (NameID != -1 || !NameStr.empty())
1811       return P.Error(NameLoc, "instructions returning void cannot have a name");
1812     return false;
1813   }
1814
1815   // If this was a numbered instruction, verify that the instruction is the
1816   // expected value and resolve any forward references.
1817   if (NameStr.empty()) {
1818     // If neither a name nor an ID was specified, just use the next ID.
1819     if (NameID == -1)
1820       NameID = NumberedVals.size();
1821
1822     if (unsigned(NameID) != NumberedVals.size())
1823       return P.Error(NameLoc, "instruction expected to be numbered '%" +
1824                      utostr(NumberedVals.size()) + "'");
1825
1826     std::map<unsigned, std::pair<Value*, LocTy> >::iterator FI =
1827       ForwardRefValIDs.find(NameID);
1828     if (FI != ForwardRefValIDs.end()) {
1829       if (FI->second.first->getType() != Inst->getType())
1830         return P.Error(NameLoc, "instruction forward referenced with type '" +
1831                        FI->second.first->getType()->getDescription() + "'");
1832       FI->second.first->replaceAllUsesWith(Inst);
1833       delete FI->second.first;
1834       ForwardRefValIDs.erase(FI);
1835     }
1836
1837     NumberedVals.push_back(Inst);
1838     return false;
1839   }
1840
1841   // Otherwise, the instruction had a name.  Resolve forward refs and set it.
1842   std::map<std::string, std::pair<Value*, LocTy> >::iterator
1843     FI = ForwardRefVals.find(NameStr);
1844   if (FI != ForwardRefVals.end()) {
1845     if (FI->second.first->getType() != Inst->getType())
1846       return P.Error(NameLoc, "instruction forward referenced with type '" +
1847                      FI->second.first->getType()->getDescription() + "'");
1848     FI->second.first->replaceAllUsesWith(Inst);
1849     delete FI->second.first;
1850     ForwardRefVals.erase(FI);
1851   }
1852
1853   // Set the name on the instruction.
1854   Inst->setName(NameStr);
1855
1856   if (Inst->getNameStr() != NameStr)
1857     return P.Error(NameLoc, "multiple definition of local value named '" +
1858                    NameStr + "'");
1859   return false;
1860 }
1861
1862 /// GetBB - Get a basic block with the specified name or ID, creating a
1863 /// forward reference record if needed.
1864 BasicBlock *LLParser::PerFunctionState::GetBB(const std::string &Name,
1865                                               LocTy Loc) {
1866   return cast_or_null<BasicBlock>(GetVal(Name,
1867                                         Type::getLabelTy(F.getContext()), Loc));
1868 }
1869
1870 BasicBlock *LLParser::PerFunctionState::GetBB(unsigned ID, LocTy Loc) {
1871   return cast_or_null<BasicBlock>(GetVal(ID,
1872                                         Type::getLabelTy(F.getContext()), Loc));
1873 }
1874
1875 /// DefineBB - Define the specified basic block, which is either named or
1876 /// unnamed.  If there is an error, this returns null otherwise it returns
1877 /// the block being defined.
1878 BasicBlock *LLParser::PerFunctionState::DefineBB(const std::string &Name,
1879                                                  LocTy Loc) {
1880   BasicBlock *BB;
1881   if (Name.empty())
1882     BB = GetBB(NumberedVals.size(), Loc);
1883   else
1884     BB = GetBB(Name, Loc);
1885   if (BB == 0) return 0; // Already diagnosed error.
1886
1887   // Move the block to the end of the function.  Forward ref'd blocks are
1888   // inserted wherever they happen to be referenced.
1889   F.getBasicBlockList().splice(F.end(), F.getBasicBlockList(), BB);
1890
1891   // Remove the block from forward ref sets.
1892   if (Name.empty()) {
1893     ForwardRefValIDs.erase(NumberedVals.size());
1894     NumberedVals.push_back(BB);
1895   } else {
1896     // BB forward references are already in the function symbol table.
1897     ForwardRefVals.erase(Name);
1898   }
1899
1900   return BB;
1901 }
1902
1903 //===----------------------------------------------------------------------===//
1904 // Constants.
1905 //===----------------------------------------------------------------------===//
1906
1907 /// ParseValID - Parse an abstract value that doesn't necessarily have a
1908 /// type implied.  For example, if we parse "4" we don't know what integer type
1909 /// it has.  The value will later be combined with its type and checked for
1910 /// sanity.
1911 bool LLParser::ParseValID(ValID &ID) {
1912   ID.Loc = Lex.getLoc();
1913   switch (Lex.getKind()) {
1914   default: return TokError("expected value token");
1915   case lltok::GlobalID:  // @42
1916     ID.UIntVal = Lex.getUIntVal();
1917     ID.Kind = ValID::t_GlobalID;
1918     break;
1919   case lltok::GlobalVar:  // @foo
1920     ID.StrVal = Lex.getStrVal();
1921     ID.Kind = ValID::t_GlobalName;
1922     break;
1923   case lltok::LocalVarID:  // %42
1924     ID.UIntVal = Lex.getUIntVal();
1925     ID.Kind = ValID::t_LocalID;
1926     break;
1927   case lltok::LocalVar:  // %foo
1928   case lltok::StringConstant:  // "foo" - FIXME: REMOVE IN LLVM 3.0
1929     ID.StrVal = Lex.getStrVal();
1930     ID.Kind = ValID::t_LocalName;
1931     break;
1932   case lltok::Metadata: {  // !{...} MDNode, !"foo" MDString
1933     ID.Kind = ValID::t_Metadata;
1934     Lex.Lex();
1935     if (Lex.getKind() == lltok::lbrace) {
1936       SmallVector<Value*, 16> Elts;
1937       if (ParseMDNodeVector(Elts) ||
1938           ParseToken(lltok::rbrace, "expected end of metadata node"))
1939         return true;
1940
1941       ID.MetadataVal = MDNode::get(Context, Elts.data(), Elts.size());
1942       return false;
1943     }
1944
1945     // Standalone metadata reference
1946     // !{ ..., !42, ... }
1947     if (!ParseMDNode(ID.MetadataVal))
1948       return false;
1949
1950     // MDString:
1951     //   ::= '!' STRINGCONSTANT
1952     if (ParseMDString(ID.MetadataVal)) return true;
1953     ID.Kind = ValID::t_Metadata;
1954     return false;
1955   }
1956   case lltok::APSInt:
1957     ID.APSIntVal = Lex.getAPSIntVal();
1958     ID.Kind = ValID::t_APSInt;
1959     break;
1960   case lltok::APFloat:
1961     ID.APFloatVal = Lex.getAPFloatVal();
1962     ID.Kind = ValID::t_APFloat;
1963     break;
1964   case lltok::kw_true:
1965     ID.ConstantVal = ConstantInt::getTrue(Context);
1966     ID.Kind = ValID::t_Constant;
1967     break;
1968   case lltok::kw_false:
1969     ID.ConstantVal = ConstantInt::getFalse(Context);
1970     ID.Kind = ValID::t_Constant;
1971     break;
1972   case lltok::kw_null: ID.Kind = ValID::t_Null; break;
1973   case lltok::kw_undef: ID.Kind = ValID::t_Undef; break;
1974   case lltok::kw_zeroinitializer: ID.Kind = ValID::t_Zero; break;
1975
1976   case lltok::lbrace: {
1977     // ValID ::= '{' ConstVector '}'
1978     Lex.Lex();
1979     SmallVector<Constant*, 16> Elts;
1980     if (ParseGlobalValueVector(Elts) ||
1981         ParseToken(lltok::rbrace, "expected end of struct constant"))
1982       return true;
1983
1984     ID.ConstantVal = ConstantStruct::get(Context, Elts.data(),
1985                                          Elts.size(), false);
1986     ID.Kind = ValID::t_Constant;
1987     return false;
1988   }
1989   case lltok::less: {
1990     // ValID ::= '<' ConstVector '>'         --> Vector.
1991     // ValID ::= '<' '{' ConstVector '}' '>' --> Packed Struct.
1992     Lex.Lex();
1993     bool isPackedStruct = EatIfPresent(lltok::lbrace);
1994
1995     SmallVector<Constant*, 16> Elts;
1996     LocTy FirstEltLoc = Lex.getLoc();
1997     if (ParseGlobalValueVector(Elts) ||
1998         (isPackedStruct &&
1999          ParseToken(lltok::rbrace, "expected end of packed struct")) ||
2000         ParseToken(lltok::greater, "expected end of constant"))
2001       return true;
2002
2003     if (isPackedStruct) {
2004       ID.ConstantVal =
2005         ConstantStruct::get(Context, Elts.data(), Elts.size(), true);
2006       ID.Kind = ValID::t_Constant;
2007       return false;
2008     }
2009
2010     if (Elts.empty())
2011       return Error(ID.Loc, "constant vector must not be empty");
2012
2013     if (!Elts[0]->getType()->isInteger() &&
2014         !Elts[0]->getType()->isFloatingPoint())
2015       return Error(FirstEltLoc,
2016                    "vector elements must have integer or floating point type");
2017
2018     // Verify that all the vector elements have the same type.
2019     for (unsigned i = 1, e = Elts.size(); i != e; ++i)
2020       if (Elts[i]->getType() != Elts[0]->getType())
2021         return Error(FirstEltLoc,
2022                      "vector element #" + utostr(i) +
2023                     " is not of type '" + Elts[0]->getType()->getDescription());
2024
2025     ID.ConstantVal = ConstantVector::get(Elts.data(), Elts.size());
2026     ID.Kind = ValID::t_Constant;
2027     return false;
2028   }
2029   case lltok::lsquare: {   // Array Constant
2030     Lex.Lex();
2031     SmallVector<Constant*, 16> Elts;
2032     LocTy FirstEltLoc = Lex.getLoc();
2033     if (ParseGlobalValueVector(Elts) ||
2034         ParseToken(lltok::rsquare, "expected end of array constant"))
2035       return true;
2036
2037     // Handle empty element.
2038     if (Elts.empty()) {
2039       // Use undef instead of an array because it's inconvenient to determine
2040       // the element type at this point, there being no elements to examine.
2041       ID.Kind = ValID::t_EmptyArray;
2042       return false;
2043     }
2044
2045     if (!Elts[0]->getType()->isFirstClassType())
2046       return Error(FirstEltLoc, "invalid array element type: " +
2047                    Elts[0]->getType()->getDescription());
2048
2049     ArrayType *ATy = ArrayType::get(Elts[0]->getType(), Elts.size());
2050
2051     // Verify all elements are correct type!
2052     for (unsigned i = 0, e = Elts.size(); i != e; ++i) {
2053       if (Elts[i]->getType() != Elts[0]->getType())
2054         return Error(FirstEltLoc,
2055                      "array element #" + utostr(i) +
2056                      " is not of type '" +Elts[0]->getType()->getDescription());
2057     }
2058
2059     ID.ConstantVal = ConstantArray::get(ATy, Elts.data(), Elts.size());
2060     ID.Kind = ValID::t_Constant;
2061     return false;
2062   }
2063   case lltok::kw_c:  // c "foo"
2064     Lex.Lex();
2065     ID.ConstantVal = ConstantArray::get(Context, Lex.getStrVal(), false);
2066     if (ParseToken(lltok::StringConstant, "expected string")) return true;
2067     ID.Kind = ValID::t_Constant;
2068     return false;
2069
2070   case lltok::kw_asm: {
2071     // ValID ::= 'asm' SideEffect? AlignStack? STRINGCONSTANT ',' STRINGCONSTANT
2072     bool HasSideEffect, AlignStack;
2073     Lex.Lex();
2074     if (ParseOptionalToken(lltok::kw_sideeffect, HasSideEffect) ||
2075         ParseOptionalToken(lltok::kw_alignstack, AlignStack) ||
2076         ParseStringConstant(ID.StrVal) ||
2077         ParseToken(lltok::comma, "expected comma in inline asm expression") ||
2078         ParseToken(lltok::StringConstant, "expected constraint string"))
2079       return true;
2080     ID.StrVal2 = Lex.getStrVal();
2081     ID.UIntVal = unsigned(HasSideEffect) | (unsigned(AlignStack)<<1);
2082     ID.Kind = ValID::t_InlineAsm;
2083     return false;
2084   }
2085
2086   case lltok::kw_blockaddress: {
2087     // ValID ::= 'blockaddress' '(' @foo ',' %bar ')'
2088     Lex.Lex();
2089
2090     ValID Fn, Label;
2091     LocTy FnLoc, LabelLoc;
2092     
2093     if (ParseToken(lltok::lparen, "expected '(' in block address expression") ||
2094         ParseValID(Fn) ||
2095         ParseToken(lltok::comma, "expected comma in block address expression")||
2096         ParseValID(Label) ||
2097         ParseToken(lltok::rparen, "expected ')' in block address expression"))
2098       return true;
2099     
2100     if (Fn.Kind != ValID::t_GlobalID && Fn.Kind != ValID::t_GlobalName)
2101       return Error(Fn.Loc, "expected function name in blockaddress");
2102     if (Label.Kind != ValID::t_LocalID && Label.Kind != ValID::t_LocalName)
2103       return Error(Label.Loc, "expected basic block name in blockaddress");
2104     
2105     // Make a global variable as a placeholder for this reference.
2106     GlobalVariable *FwdRef = new GlobalVariable(*M, Type::getInt8Ty(Context),
2107                                            false, GlobalValue::InternalLinkage,
2108                                                 0, "");
2109     ForwardRefBlockAddresses[Fn].push_back(std::make_pair(Label, FwdRef));
2110     ID.ConstantVal = FwdRef;
2111     ID.Kind = ValID::t_Constant;
2112     return false;
2113   }
2114       
2115   case lltok::kw_trunc:
2116   case lltok::kw_zext:
2117   case lltok::kw_sext:
2118   case lltok::kw_fptrunc:
2119   case lltok::kw_fpext:
2120   case lltok::kw_bitcast:
2121   case lltok::kw_uitofp:
2122   case lltok::kw_sitofp:
2123   case lltok::kw_fptoui:
2124   case lltok::kw_fptosi:
2125   case lltok::kw_inttoptr:
2126   case lltok::kw_ptrtoint: {
2127     unsigned Opc = Lex.getUIntVal();
2128     PATypeHolder DestTy(Type::getVoidTy(Context));
2129     Constant *SrcVal;
2130     Lex.Lex();
2131     if (ParseToken(lltok::lparen, "expected '(' after constantexpr cast") ||
2132         ParseGlobalTypeAndValue(SrcVal) ||
2133         ParseToken(lltok::kw_to, "expected 'to' in constantexpr cast") ||
2134         ParseType(DestTy) ||
2135         ParseToken(lltok::rparen, "expected ')' at end of constantexpr cast"))
2136       return true;
2137     if (!CastInst::castIsValid((Instruction::CastOps)Opc, SrcVal, DestTy))
2138       return Error(ID.Loc, "invalid cast opcode for cast from '" +
2139                    SrcVal->getType()->getDescription() + "' to '" +
2140                    DestTy->getDescription() + "'");
2141     ID.ConstantVal = ConstantExpr::getCast((Instruction::CastOps)Opc,
2142                                                  SrcVal, DestTy);
2143     ID.Kind = ValID::t_Constant;
2144     return false;
2145   }
2146   case lltok::kw_extractvalue: {
2147     Lex.Lex();
2148     Constant *Val;
2149     SmallVector<unsigned, 4> Indices;
2150     if (ParseToken(lltok::lparen, "expected '(' in extractvalue constantexpr")||
2151         ParseGlobalTypeAndValue(Val) ||
2152         ParseIndexList(Indices) ||
2153         ParseToken(lltok::rparen, "expected ')' in extractvalue constantexpr"))
2154       return true;
2155     if (Lex.getKind() == lltok::NamedOrCustomMD)
2156       if (ParseOptionalCustomMetadata()) return true;
2157
2158     if (!isa<StructType>(Val->getType()) && !isa<ArrayType>(Val->getType()))
2159       return Error(ID.Loc, "extractvalue operand must be array or struct");
2160     if (!ExtractValueInst::getIndexedType(Val->getType(), Indices.begin(),
2161                                           Indices.end()))
2162       return Error(ID.Loc, "invalid indices for extractvalue");
2163     ID.ConstantVal =
2164       ConstantExpr::getExtractValue(Val, Indices.data(), Indices.size());
2165     ID.Kind = ValID::t_Constant;
2166     return false;
2167   }
2168   case lltok::kw_insertvalue: {
2169     Lex.Lex();
2170     Constant *Val0, *Val1;
2171     SmallVector<unsigned, 4> Indices;
2172     if (ParseToken(lltok::lparen, "expected '(' in insertvalue constantexpr")||
2173         ParseGlobalTypeAndValue(Val0) ||
2174         ParseToken(lltok::comma, "expected comma in insertvalue constantexpr")||
2175         ParseGlobalTypeAndValue(Val1) ||
2176         ParseIndexList(Indices) ||
2177         ParseToken(lltok::rparen, "expected ')' in insertvalue constantexpr"))
2178       return true;
2179     if (Lex.getKind() == lltok::NamedOrCustomMD)
2180       if (ParseOptionalCustomMetadata()) return true;
2181     if (!isa<StructType>(Val0->getType()) && !isa<ArrayType>(Val0->getType()))
2182       return Error(ID.Loc, "extractvalue operand must be array or struct");
2183     if (!ExtractValueInst::getIndexedType(Val0->getType(), Indices.begin(),
2184                                           Indices.end()))
2185       return Error(ID.Loc, "invalid indices for insertvalue");
2186     ID.ConstantVal = ConstantExpr::getInsertValue(Val0, Val1,
2187                        Indices.data(), Indices.size());
2188     ID.Kind = ValID::t_Constant;
2189     return false;
2190   }
2191   case lltok::kw_icmp:
2192   case lltok::kw_fcmp: {
2193     unsigned PredVal, Opc = Lex.getUIntVal();
2194     Constant *Val0, *Val1;
2195     Lex.Lex();
2196     if (ParseCmpPredicate(PredVal, Opc) ||
2197         ParseToken(lltok::lparen, "expected '(' in compare constantexpr") ||
2198         ParseGlobalTypeAndValue(Val0) ||
2199         ParseToken(lltok::comma, "expected comma in compare constantexpr") ||
2200         ParseGlobalTypeAndValue(Val1) ||
2201         ParseToken(lltok::rparen, "expected ')' in compare constantexpr"))
2202       return true;
2203
2204     if (Val0->getType() != Val1->getType())
2205       return Error(ID.Loc, "compare operands must have the same type");
2206
2207     CmpInst::Predicate Pred = (CmpInst::Predicate)PredVal;
2208
2209     if (Opc == Instruction::FCmp) {
2210       if (!Val0->getType()->isFPOrFPVector())
2211         return Error(ID.Loc, "fcmp requires floating point operands");
2212       ID.ConstantVal = ConstantExpr::getFCmp(Pred, Val0, Val1);
2213     } else {
2214       assert(Opc == Instruction::ICmp && "Unexpected opcode for CmpInst!");
2215       if (!Val0->getType()->isIntOrIntVector() &&
2216           !isa<PointerType>(Val0->getType()))
2217         return Error(ID.Loc, "icmp requires pointer or integer operands");
2218       ID.ConstantVal = ConstantExpr::getICmp(Pred, Val0, Val1);
2219     }
2220     ID.Kind = ValID::t_Constant;
2221     return false;
2222   }
2223
2224   // Binary Operators.
2225   case lltok::kw_add:
2226   case lltok::kw_fadd:
2227   case lltok::kw_sub:
2228   case lltok::kw_fsub:
2229   case lltok::kw_mul:
2230   case lltok::kw_fmul:
2231   case lltok::kw_udiv:
2232   case lltok::kw_sdiv:
2233   case lltok::kw_fdiv:
2234   case lltok::kw_urem:
2235   case lltok::kw_srem:
2236   case lltok::kw_frem: {
2237     bool NUW = false;
2238     bool NSW = false;
2239     bool Exact = false;
2240     unsigned Opc = Lex.getUIntVal();
2241     Constant *Val0, *Val1;
2242     Lex.Lex();
2243     LocTy ModifierLoc = Lex.getLoc();
2244     if (Opc == Instruction::Add ||
2245         Opc == Instruction::Sub ||
2246         Opc == Instruction::Mul) {
2247       if (EatIfPresent(lltok::kw_nuw))
2248         NUW = true;
2249       if (EatIfPresent(lltok::kw_nsw)) {
2250         NSW = true;
2251         if (EatIfPresent(lltok::kw_nuw))
2252           NUW = true;
2253       }
2254     } else if (Opc == Instruction::SDiv) {
2255       if (EatIfPresent(lltok::kw_exact))
2256         Exact = true;
2257     }
2258     if (ParseToken(lltok::lparen, "expected '(' in binary constantexpr") ||
2259         ParseGlobalTypeAndValue(Val0) ||
2260         ParseToken(lltok::comma, "expected comma in binary constantexpr") ||
2261         ParseGlobalTypeAndValue(Val1) ||
2262         ParseToken(lltok::rparen, "expected ')' in binary constantexpr"))
2263       return true;
2264     if (Val0->getType() != Val1->getType())
2265       return Error(ID.Loc, "operands of constexpr must have same type");
2266     if (!Val0->getType()->isIntOrIntVector()) {
2267       if (NUW)
2268         return Error(ModifierLoc, "nuw only applies to integer operations");
2269       if (NSW)
2270         return Error(ModifierLoc, "nsw only applies to integer operations");
2271     }
2272     // API compatibility: Accept either integer or floating-point types with
2273     // add, sub, and mul.
2274     if (!Val0->getType()->isIntOrIntVector() &&
2275         !Val0->getType()->isFPOrFPVector())
2276       return Error(ID.Loc,"constexpr requires integer, fp, or vector operands");
2277     unsigned Flags = 0;
2278     if (NUW)   Flags |= OverflowingBinaryOperator::NoUnsignedWrap;
2279     if (NSW)   Flags |= OverflowingBinaryOperator::NoSignedWrap;
2280     if (Exact) Flags |= SDivOperator::IsExact;
2281     Constant *C = ConstantExpr::get(Opc, Val0, Val1, Flags);
2282     ID.ConstantVal = C;
2283     ID.Kind = ValID::t_Constant;
2284     return false;
2285   }
2286
2287   // Logical Operations
2288   case lltok::kw_shl:
2289   case lltok::kw_lshr:
2290   case lltok::kw_ashr:
2291   case lltok::kw_and:
2292   case lltok::kw_or:
2293   case lltok::kw_xor: {
2294     unsigned Opc = Lex.getUIntVal();
2295     Constant *Val0, *Val1;
2296     Lex.Lex();
2297     if (ParseToken(lltok::lparen, "expected '(' in logical constantexpr") ||
2298         ParseGlobalTypeAndValue(Val0) ||
2299         ParseToken(lltok::comma, "expected comma in logical constantexpr") ||
2300         ParseGlobalTypeAndValue(Val1) ||
2301         ParseToken(lltok::rparen, "expected ')' in logical constantexpr"))
2302       return true;
2303     if (Val0->getType() != Val1->getType())
2304       return Error(ID.Loc, "operands of constexpr must have same type");
2305     if (!Val0->getType()->isIntOrIntVector())
2306       return Error(ID.Loc,
2307                    "constexpr requires integer or integer vector operands");
2308     ID.ConstantVal = ConstantExpr::get(Opc, Val0, Val1);
2309     ID.Kind = ValID::t_Constant;
2310     return false;
2311   }
2312
2313   case lltok::kw_getelementptr:
2314   case lltok::kw_shufflevector:
2315   case lltok::kw_insertelement:
2316   case lltok::kw_extractelement:
2317   case lltok::kw_select: {
2318     unsigned Opc = Lex.getUIntVal();
2319     SmallVector<Constant*, 16> Elts;
2320     bool InBounds = false;
2321     Lex.Lex();
2322     if (Opc == Instruction::GetElementPtr)
2323       InBounds = EatIfPresent(lltok::kw_inbounds);
2324     if (ParseToken(lltok::lparen, "expected '(' in constantexpr") ||
2325         ParseGlobalValueVector(Elts) ||
2326         ParseToken(lltok::rparen, "expected ')' in constantexpr"))
2327       return true;
2328
2329     if (Opc == Instruction::GetElementPtr) {
2330       if (Elts.size() == 0 || !isa<PointerType>(Elts[0]->getType()))
2331         return Error(ID.Loc, "getelementptr requires pointer operand");
2332
2333       if (!GetElementPtrInst::getIndexedType(Elts[0]->getType(),
2334                                              (Value**)(Elts.data() + 1),
2335                                              Elts.size() - 1))
2336         return Error(ID.Loc, "invalid indices for getelementptr");
2337       ID.ConstantVal = InBounds ?
2338         ConstantExpr::getInBoundsGetElementPtr(Elts[0],
2339                                                Elts.data() + 1,
2340                                                Elts.size() - 1) :
2341         ConstantExpr::getGetElementPtr(Elts[0],
2342                                        Elts.data() + 1, Elts.size() - 1);
2343     } else if (Opc == Instruction::Select) {
2344       if (Elts.size() != 3)
2345         return Error(ID.Loc, "expected three operands to select");
2346       if (const char *Reason = SelectInst::areInvalidOperands(Elts[0], Elts[1],
2347                                                               Elts[2]))
2348         return Error(ID.Loc, Reason);
2349       ID.ConstantVal = ConstantExpr::getSelect(Elts[0], Elts[1], Elts[2]);
2350     } else if (Opc == Instruction::ShuffleVector) {
2351       if (Elts.size() != 3)
2352         return Error(ID.Loc, "expected three operands to shufflevector");
2353       if (!ShuffleVectorInst::isValidOperands(Elts[0], Elts[1], Elts[2]))
2354         return Error(ID.Loc, "invalid operands to shufflevector");
2355       ID.ConstantVal =
2356                  ConstantExpr::getShuffleVector(Elts[0], Elts[1],Elts[2]);
2357     } else if (Opc == Instruction::ExtractElement) {
2358       if (Elts.size() != 2)
2359         return Error(ID.Loc, "expected two operands to extractelement");
2360       if (!ExtractElementInst::isValidOperands(Elts[0], Elts[1]))
2361         return Error(ID.Loc, "invalid extractelement operands");
2362       ID.ConstantVal = ConstantExpr::getExtractElement(Elts[0], Elts[1]);
2363     } else {
2364       assert(Opc == Instruction::InsertElement && "Unknown opcode");
2365       if (Elts.size() != 3)
2366       return Error(ID.Loc, "expected three operands to insertelement");
2367       if (!InsertElementInst::isValidOperands(Elts[0], Elts[1], Elts[2]))
2368         return Error(ID.Loc, "invalid insertelement operands");
2369       ID.ConstantVal =
2370                  ConstantExpr::getInsertElement(Elts[0], Elts[1],Elts[2]);
2371     }
2372
2373     ID.Kind = ValID::t_Constant;
2374     return false;
2375   }
2376   }
2377
2378   Lex.Lex();
2379   return false;
2380 }
2381
2382 /// ParseGlobalValue - Parse a global value with the specified type.
2383 bool LLParser::ParseGlobalValue(const Type *Ty, Constant *&V) {
2384   V = 0;
2385   ValID ID;
2386   return ParseValID(ID) ||
2387          ConvertGlobalValIDToValue(Ty, ID, V);
2388 }
2389
2390 /// ConvertGlobalValIDToValue - Apply a type to a ValID to get a fully resolved
2391 /// constant.
2392 bool LLParser::ConvertGlobalValIDToValue(const Type *Ty, ValID &ID,
2393                                          Constant *&V) {
2394   if (isa<FunctionType>(Ty))
2395     return Error(ID.Loc, "functions are not values, refer to them as pointers");
2396
2397   switch (ID.Kind) {
2398   default: llvm_unreachable("Unknown ValID!");
2399   case ValID::t_Metadata:
2400     return Error(ID.Loc, "invalid use of metadata");
2401   case ValID::t_LocalID:
2402   case ValID::t_LocalName:
2403     return Error(ID.Loc, "invalid use of function-local name");
2404   case ValID::t_InlineAsm:
2405     return Error(ID.Loc, "inline asm can only be an operand of call/invoke");
2406   case ValID::t_GlobalName:
2407     V = GetGlobalVal(ID.StrVal, Ty, ID.Loc);
2408     return V == 0;
2409   case ValID::t_GlobalID:
2410     V = GetGlobalVal(ID.UIntVal, Ty, ID.Loc);
2411     return V == 0;
2412   case ValID::t_APSInt:
2413     if (!isa<IntegerType>(Ty))
2414       return Error(ID.Loc, "integer constant must have integer type");
2415     ID.APSIntVal.extOrTrunc(Ty->getPrimitiveSizeInBits());
2416     V = ConstantInt::get(Context, ID.APSIntVal);
2417     return false;
2418   case ValID::t_APFloat:
2419     if (!Ty->isFloatingPoint() ||
2420         !ConstantFP::isValueValidForType(Ty, ID.APFloatVal))
2421       return Error(ID.Loc, "floating point constant invalid for type");
2422
2423     // The lexer has no type info, so builds all float and double FP constants
2424     // as double.  Fix this here.  Long double does not need this.
2425     if (&ID.APFloatVal.getSemantics() == &APFloat::IEEEdouble &&
2426         Ty->isFloatTy()) {
2427       bool Ignored;
2428       ID.APFloatVal.convert(APFloat::IEEEsingle, APFloat::rmNearestTiesToEven,
2429                             &Ignored);
2430     }
2431     V = ConstantFP::get(Context, ID.APFloatVal);
2432
2433     if (V->getType() != Ty)
2434       return Error(ID.Loc, "floating point constant does not have type '" +
2435                    Ty->getDescription() + "'");
2436
2437     return false;
2438   case ValID::t_Null:
2439     if (!isa<PointerType>(Ty))
2440       return Error(ID.Loc, "null must be a pointer type");
2441     V = ConstantPointerNull::get(cast<PointerType>(Ty));
2442     return false;
2443   case ValID::t_Undef:
2444     // FIXME: LabelTy should not be a first-class type.
2445     if ((!Ty->isFirstClassType() || Ty->isLabelTy()) &&
2446         !isa<OpaqueType>(Ty))
2447       return Error(ID.Loc, "invalid type for undef constant");
2448     V = UndefValue::get(Ty);
2449     return false;
2450   case ValID::t_EmptyArray:
2451     if (!isa<ArrayType>(Ty) || cast<ArrayType>(Ty)->getNumElements() != 0)
2452       return Error(ID.Loc, "invalid empty array initializer");
2453     V = UndefValue::get(Ty);
2454     return false;
2455   case ValID::t_Zero:
2456     // FIXME: LabelTy should not be a first-class type.
2457     if (!Ty->isFirstClassType() || Ty->isLabelTy())
2458       return Error(ID.Loc, "invalid type for null constant");
2459     V = Constant::getNullValue(Ty);
2460     return false;
2461   case ValID::t_Constant:
2462     if (ID.ConstantVal->getType() != Ty)
2463       return Error(ID.Loc, "constant expression type mismatch");
2464     V = ID.ConstantVal;
2465     return false;
2466   }
2467 }
2468
2469 bool LLParser::ParseGlobalTypeAndValue(Constant *&V) {
2470   PATypeHolder Type(Type::getVoidTy(Context));
2471   return ParseType(Type) ||
2472          ParseGlobalValue(Type, V);
2473 }
2474
2475 /// ParseGlobalValueVector
2476 ///   ::= /*empty*/
2477 ///   ::= TypeAndValue (',' TypeAndValue)*
2478 bool LLParser::ParseGlobalValueVector(SmallVectorImpl<Constant*> &Elts) {
2479   // Empty list.
2480   if (Lex.getKind() == lltok::rbrace ||
2481       Lex.getKind() == lltok::rsquare ||
2482       Lex.getKind() == lltok::greater ||
2483       Lex.getKind() == lltok::rparen)
2484     return false;
2485
2486   Constant *C;
2487   if (ParseGlobalTypeAndValue(C)) return true;
2488   Elts.push_back(C);
2489
2490   while (EatIfPresent(lltok::comma)) {
2491     if (ParseGlobalTypeAndValue(C)) return true;
2492     Elts.push_back(C);
2493   }
2494
2495   return false;
2496 }
2497
2498
2499 //===----------------------------------------------------------------------===//
2500 // Function Parsing.
2501 //===----------------------------------------------------------------------===//
2502
2503 bool LLParser::ConvertValIDToValue(const Type *Ty, ValID &ID, Value *&V,
2504                                    PerFunctionState &PFS) {
2505   if (ID.Kind == ValID::t_LocalID)
2506     V = PFS.GetVal(ID.UIntVal, Ty, ID.Loc);
2507   else if (ID.Kind == ValID::t_LocalName)
2508     V = PFS.GetVal(ID.StrVal, Ty, ID.Loc);
2509   else if (ID.Kind == ValID::t_InlineAsm) {
2510     const PointerType *PTy = dyn_cast<PointerType>(Ty);
2511     const FunctionType *FTy =
2512       PTy ? dyn_cast<FunctionType>(PTy->getElementType()) : 0;
2513     if (!FTy || !InlineAsm::Verify(FTy, ID.StrVal2))
2514       return Error(ID.Loc, "invalid type for inline asm constraint string");
2515     V = InlineAsm::get(FTy, ID.StrVal, ID.StrVal2, ID.UIntVal&1, ID.UIntVal>>1);
2516     return false;
2517   } else if (ID.Kind == ValID::t_Metadata) {
2518     V = ID.MetadataVal;
2519   } else {
2520     Constant *C;
2521     if (ConvertGlobalValIDToValue(Ty, ID, C)) return true;
2522     V = C;
2523     return false;
2524   }
2525
2526   return V == 0;
2527 }
2528
2529 bool LLParser::ParseValue(const Type *Ty, Value *&V, PerFunctionState &PFS) {
2530   V = 0;
2531   ValID ID;
2532   return ParseValID(ID) ||
2533          ConvertValIDToValue(Ty, ID, V, PFS);
2534 }
2535
2536 bool LLParser::ParseTypeAndValue(Value *&V, PerFunctionState &PFS) {
2537   PATypeHolder T(Type::getVoidTy(Context));
2538   return ParseType(T) ||
2539          ParseValue(T, V, PFS);
2540 }
2541
2542 bool LLParser::ParseTypeAndBasicBlock(BasicBlock *&BB, LocTy &Loc,
2543                                       PerFunctionState &PFS) {
2544   Value *V;
2545   Loc = Lex.getLoc();
2546   if (ParseTypeAndValue(V, PFS)) return true;
2547   if (!isa<BasicBlock>(V))
2548     return Error(Loc, "expected a basic block");
2549   BB = cast<BasicBlock>(V);
2550   return false;
2551 }
2552
2553
2554 /// FunctionHeader
2555 ///   ::= OptionalLinkage OptionalVisibility OptionalCallingConv OptRetAttrs
2556 ///       Type GlobalName '(' ArgList ')' OptFuncAttrs OptSection
2557 ///       OptionalAlign OptGC
2558 bool LLParser::ParseFunctionHeader(Function *&Fn, bool isDefine) {
2559   // Parse the linkage.
2560   LocTy LinkageLoc = Lex.getLoc();
2561   unsigned Linkage;
2562
2563   unsigned Visibility, RetAttrs;
2564   CallingConv::ID CC;
2565   PATypeHolder RetType(Type::getVoidTy(Context));
2566   LocTy RetTypeLoc = Lex.getLoc();
2567   if (ParseOptionalLinkage(Linkage) ||
2568       ParseOptionalVisibility(Visibility) ||
2569       ParseOptionalCallingConv(CC) ||
2570       ParseOptionalAttrs(RetAttrs, 1) ||
2571       ParseType(RetType, RetTypeLoc, true /*void allowed*/))
2572     return true;
2573
2574   // Verify that the linkage is ok.
2575   switch ((GlobalValue::LinkageTypes)Linkage) {
2576   case GlobalValue::ExternalLinkage:
2577     break; // always ok.
2578   case GlobalValue::DLLImportLinkage:
2579   case GlobalValue::ExternalWeakLinkage:
2580     if (isDefine)
2581       return Error(LinkageLoc, "invalid linkage for function definition");
2582     break;
2583   case GlobalValue::PrivateLinkage:
2584   case GlobalValue::LinkerPrivateLinkage:
2585   case GlobalValue::InternalLinkage:
2586   case GlobalValue::AvailableExternallyLinkage:
2587   case GlobalValue::LinkOnceAnyLinkage:
2588   case GlobalValue::LinkOnceODRLinkage:
2589   case GlobalValue::WeakAnyLinkage:
2590   case GlobalValue::WeakODRLinkage:
2591   case GlobalValue::DLLExportLinkage:
2592     if (!isDefine)
2593       return Error(LinkageLoc, "invalid linkage for function declaration");
2594     break;
2595   case GlobalValue::AppendingLinkage:
2596   case GlobalValue::GhostLinkage:
2597   case GlobalValue::CommonLinkage:
2598     return Error(LinkageLoc, "invalid function linkage type");
2599   }
2600
2601   if (!FunctionType::isValidReturnType(RetType) ||
2602       isa<OpaqueType>(RetType))
2603     return Error(RetTypeLoc, "invalid function return type");
2604
2605   LocTy NameLoc = Lex.getLoc();
2606
2607   std::string FunctionName;
2608   if (Lex.getKind() == lltok::GlobalVar) {
2609     FunctionName = Lex.getStrVal();
2610   } else if (Lex.getKind() == lltok::GlobalID) {     // @42 is ok.
2611     unsigned NameID = Lex.getUIntVal();
2612
2613     if (NameID != NumberedVals.size())
2614       return TokError("function expected to be numbered '%" +
2615                       utostr(NumberedVals.size()) + "'");
2616   } else {
2617     return TokError("expected function name");
2618   }
2619
2620   Lex.Lex();
2621
2622   if (Lex.getKind() != lltok::lparen)
2623     return TokError("expected '(' in function argument list");
2624
2625   std::vector<ArgInfo> ArgList;
2626   bool isVarArg;
2627   unsigned FuncAttrs;
2628   std::string Section;
2629   unsigned Alignment;
2630   std::string GC;
2631
2632   if (ParseArgumentList(ArgList, isVarArg, false) ||
2633       ParseOptionalAttrs(FuncAttrs, 2) ||
2634       (EatIfPresent(lltok::kw_section) &&
2635        ParseStringConstant(Section)) ||
2636       ParseOptionalAlignment(Alignment) ||
2637       (EatIfPresent(lltok::kw_gc) &&
2638        ParseStringConstant(GC)))
2639     return true;
2640
2641   // If the alignment was parsed as an attribute, move to the alignment field.
2642   if (FuncAttrs & Attribute::Alignment) {
2643     Alignment = Attribute::getAlignmentFromAttrs(FuncAttrs);
2644     FuncAttrs &= ~Attribute::Alignment;
2645   }
2646
2647   // Okay, if we got here, the function is syntactically valid.  Convert types
2648   // and do semantic checks.
2649   std::vector<const Type*> ParamTypeList;
2650   SmallVector<AttributeWithIndex, 8> Attrs;
2651   // FIXME : In 3.0, stop accepting zext, sext and inreg as optional function
2652   // attributes.
2653   unsigned ObsoleteFuncAttrs = Attribute::ZExt|Attribute::SExt|Attribute::InReg;
2654   if (FuncAttrs & ObsoleteFuncAttrs) {
2655     RetAttrs |= FuncAttrs & ObsoleteFuncAttrs;
2656     FuncAttrs &= ~ObsoleteFuncAttrs;
2657   }
2658
2659   if (RetAttrs != Attribute::None)
2660     Attrs.push_back(AttributeWithIndex::get(0, RetAttrs));
2661
2662   for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
2663     ParamTypeList.push_back(ArgList[i].Type);
2664     if (ArgList[i].Attrs != Attribute::None)
2665       Attrs.push_back(AttributeWithIndex::get(i+1, ArgList[i].Attrs));
2666   }
2667
2668   if (FuncAttrs != Attribute::None)
2669     Attrs.push_back(AttributeWithIndex::get(~0, FuncAttrs));
2670
2671   AttrListPtr PAL = AttrListPtr::get(Attrs.begin(), Attrs.end());
2672
2673   if (PAL.paramHasAttr(1, Attribute::StructRet) &&
2674       RetType != Type::getVoidTy(Context))
2675     return Error(RetTypeLoc, "functions with 'sret' argument must return void");
2676
2677   const FunctionType *FT =
2678     FunctionType::get(RetType, ParamTypeList, isVarArg);
2679   const PointerType *PFT = PointerType::getUnqual(FT);
2680
2681   Fn = 0;
2682   if (!FunctionName.empty()) {
2683     // If this was a definition of a forward reference, remove the definition
2684     // from the forward reference table and fill in the forward ref.
2685     std::map<std::string, std::pair<GlobalValue*, LocTy> >::iterator FRVI =
2686       ForwardRefVals.find(FunctionName);
2687     if (FRVI != ForwardRefVals.end()) {
2688       Fn = M->getFunction(FunctionName);
2689       ForwardRefVals.erase(FRVI);
2690     } else if ((Fn = M->getFunction(FunctionName))) {
2691       // If this function already exists in the symbol table, then it is
2692       // multiply defined.  We accept a few cases for old backwards compat.
2693       // FIXME: Remove this stuff for LLVM 3.0.
2694       if (Fn->getType() != PFT || Fn->getAttributes() != PAL ||
2695           (!Fn->isDeclaration() && isDefine)) {
2696         // If the redefinition has different type or different attributes,
2697         // reject it.  If both have bodies, reject it.
2698         return Error(NameLoc, "invalid redefinition of function '" +
2699                      FunctionName + "'");
2700       } else if (Fn->isDeclaration()) {
2701         // Make sure to strip off any argument names so we can't get conflicts.
2702         for (Function::arg_iterator AI = Fn->arg_begin(), AE = Fn->arg_end();
2703              AI != AE; ++AI)
2704           AI->setName("");
2705       }
2706     } else if (M->getNamedValue(FunctionName)) {
2707       return Error(NameLoc, "redefinition of function '@" + FunctionName + "'");
2708     }
2709
2710   } else {
2711     // If this is a definition of a forward referenced function, make sure the
2712     // types agree.
2713     std::map<unsigned, std::pair<GlobalValue*, LocTy> >::iterator I
2714       = ForwardRefValIDs.find(NumberedVals.size());
2715     if (I != ForwardRefValIDs.end()) {
2716       Fn = cast<Function>(I->second.first);
2717       if (Fn->getType() != PFT)
2718         return Error(NameLoc, "type of definition and forward reference of '@" +
2719                      utostr(NumberedVals.size()) +"' disagree");
2720       ForwardRefValIDs.erase(I);
2721     }
2722   }
2723
2724   if (Fn == 0)
2725     Fn = Function::Create(FT, GlobalValue::ExternalLinkage, FunctionName, M);
2726   else // Move the forward-reference to the correct spot in the module.
2727     M->getFunctionList().splice(M->end(), M->getFunctionList(), Fn);
2728
2729   if (FunctionName.empty())
2730     NumberedVals.push_back(Fn);
2731
2732   Fn->setLinkage((GlobalValue::LinkageTypes)Linkage);
2733   Fn->setVisibility((GlobalValue::VisibilityTypes)Visibility);
2734   Fn->setCallingConv(CC);
2735   Fn->setAttributes(PAL);
2736   Fn->setAlignment(Alignment);
2737   Fn->setSection(Section);
2738   if (!GC.empty()) Fn->setGC(GC.c_str());
2739
2740   // Add all of the arguments we parsed to the function.
2741   Function::arg_iterator ArgIt = Fn->arg_begin();
2742   for (unsigned i = 0, e = ArgList.size(); i != e; ++i, ++ArgIt) {
2743     // If we run out of arguments in the Function prototype, exit early.
2744     // FIXME: REMOVE THIS IN LLVM 3.0, this is just for the mismatch case above.
2745     if (ArgIt == Fn->arg_end()) break;
2746     
2747     // If the argument has a name, insert it into the argument symbol table.
2748     if (ArgList[i].Name.empty()) continue;
2749
2750     // Set the name, if it conflicted, it will be auto-renamed.
2751     ArgIt->setName(ArgList[i].Name);
2752
2753     if (ArgIt->getNameStr() != ArgList[i].Name)
2754       return Error(ArgList[i].Loc, "redefinition of argument '%" +
2755                    ArgList[i].Name + "'");
2756   }
2757
2758   return false;
2759 }
2760
2761
2762 /// ParseFunctionBody
2763 ///   ::= '{' BasicBlock+ '}'
2764 ///   ::= 'begin' BasicBlock+ 'end'  // FIXME: remove in LLVM 3.0
2765 ///
2766 bool LLParser::ParseFunctionBody(Function &Fn) {
2767   if (Lex.getKind() != lltok::lbrace && Lex.getKind() != lltok::kw_begin)
2768     return TokError("expected '{' in function body");
2769   Lex.Lex();  // eat the {.
2770
2771   int FunctionNumber = -1;
2772   if (!Fn.hasName()) FunctionNumber = NumberedVals.size()-1;
2773   
2774   PerFunctionState PFS(*this, Fn, FunctionNumber);
2775
2776   while (Lex.getKind() != lltok::rbrace && Lex.getKind() != lltok::kw_end)
2777     if (ParseBasicBlock(PFS)) return true;
2778
2779   // Eat the }.
2780   Lex.Lex();
2781
2782   // Verify function is ok.
2783   return PFS.FinishFunction();
2784 }
2785
2786 /// ParseBasicBlock
2787 ///   ::= LabelStr? Instruction*
2788 bool LLParser::ParseBasicBlock(PerFunctionState &PFS) {
2789   // If this basic block starts out with a name, remember it.
2790   std::string Name;
2791   LocTy NameLoc = Lex.getLoc();
2792   if (Lex.getKind() == lltok::LabelStr) {
2793     Name = Lex.getStrVal();
2794     Lex.Lex();
2795   }
2796
2797   BasicBlock *BB = PFS.DefineBB(Name, NameLoc);
2798   if (BB == 0) return true;
2799
2800   std::string NameStr;
2801
2802   // Parse the instructions in this block until we get a terminator.
2803   Instruction *Inst;
2804   do {
2805     // This instruction may have three possibilities for a name: a) none
2806     // specified, b) name specified "%foo =", c) number specified: "%4 =".
2807     LocTy NameLoc = Lex.getLoc();
2808     int NameID = -1;
2809     NameStr = "";
2810
2811     if (Lex.getKind() == lltok::LocalVarID) {
2812       NameID = Lex.getUIntVal();
2813       Lex.Lex();
2814       if (ParseToken(lltok::equal, "expected '=' after instruction id"))
2815         return true;
2816     } else if (Lex.getKind() == lltok::LocalVar ||
2817                // FIXME: REMOVE IN LLVM 3.0
2818                Lex.getKind() == lltok::StringConstant) {
2819       NameStr = Lex.getStrVal();
2820       Lex.Lex();
2821       if (ParseToken(lltok::equal, "expected '=' after instruction name"))
2822         return true;
2823     }
2824
2825     if (ParseInstruction(Inst, BB, PFS)) return true;
2826     if (EatIfPresent(lltok::comma))
2827       ParseOptionalCustomMetadata();
2828
2829     // Set metadata attached with this instruction.
2830     MetadataContext &TheMetadata = M->getContext().getMetadata();
2831     for (SmallVector<std::pair<unsigned, MDNode *>, 2>::iterator
2832            MDI = MDsOnInst.begin(), MDE = MDsOnInst.end(); MDI != MDE; ++MDI)
2833       TheMetadata.addMD(MDI->first, MDI->second, Inst);
2834     MDsOnInst.clear();
2835
2836     BB->getInstList().push_back(Inst);
2837
2838     // Set the name on the instruction.
2839     if (PFS.SetInstName(NameID, NameStr, NameLoc, Inst)) return true;
2840   } while (!isa<TerminatorInst>(Inst));
2841
2842   return false;
2843 }
2844
2845 //===----------------------------------------------------------------------===//
2846 // Instruction Parsing.
2847 //===----------------------------------------------------------------------===//
2848
2849 /// ParseInstruction - Parse one of the many different instructions.
2850 ///
2851 bool LLParser::ParseInstruction(Instruction *&Inst, BasicBlock *BB,
2852                                 PerFunctionState &PFS) {
2853   lltok::Kind Token = Lex.getKind();
2854   if (Token == lltok::Eof)
2855     return TokError("found end of file when expecting more instructions");
2856   LocTy Loc = Lex.getLoc();
2857   unsigned KeywordVal = Lex.getUIntVal();
2858   Lex.Lex();  // Eat the keyword.
2859
2860   switch (Token) {
2861   default:                    return Error(Loc, "expected instruction opcode");
2862   // Terminator Instructions.
2863   case lltok::kw_unwind:      Inst = new UnwindInst(Context); return false;
2864   case lltok::kw_unreachable: Inst = new UnreachableInst(Context); return false;
2865   case lltok::kw_ret:         return ParseRet(Inst, BB, PFS);
2866   case lltok::kw_br:          return ParseBr(Inst, PFS);
2867   case lltok::kw_switch:      return ParseSwitch(Inst, PFS);
2868   case lltok::kw_indirectbr:  return ParseIndirectBr(Inst, PFS);
2869   case lltok::kw_invoke:      return ParseInvoke(Inst, PFS);
2870   // Binary Operators.
2871   case lltok::kw_add:
2872   case lltok::kw_sub:
2873   case lltok::kw_mul: {
2874     bool NUW = false;
2875     bool NSW = false;
2876     LocTy ModifierLoc = Lex.getLoc();
2877     if (EatIfPresent(lltok::kw_nuw))
2878       NUW = true;
2879     if (EatIfPresent(lltok::kw_nsw)) {
2880       NSW = true;
2881       if (EatIfPresent(lltok::kw_nuw))
2882         NUW = true;
2883     }
2884     // API compatibility: Accept either integer or floating-point types.
2885     bool Result = ParseArithmetic(Inst, PFS, KeywordVal, 0);
2886     if (!Result) {
2887       if (!Inst->getType()->isIntOrIntVector()) {
2888         if (NUW)
2889           return Error(ModifierLoc, "nuw only applies to integer operations");
2890         if (NSW)
2891           return Error(ModifierLoc, "nsw only applies to integer operations");
2892       }
2893       if (NUW)
2894         cast<BinaryOperator>(Inst)->setHasNoUnsignedWrap(true);
2895       if (NSW)
2896         cast<BinaryOperator>(Inst)->setHasNoSignedWrap(true);
2897     }
2898     return Result;
2899   }
2900   case lltok::kw_fadd:
2901   case lltok::kw_fsub:
2902   case lltok::kw_fmul:    return ParseArithmetic(Inst, PFS, KeywordVal, 2);
2903
2904   case lltok::kw_sdiv: {
2905     bool Exact = false;
2906     if (EatIfPresent(lltok::kw_exact))
2907       Exact = true;
2908     bool Result = ParseArithmetic(Inst, PFS, KeywordVal, 1);
2909     if (!Result)
2910       if (Exact)
2911         cast<BinaryOperator>(Inst)->setIsExact(true);
2912     return Result;
2913   }
2914
2915   case lltok::kw_udiv:
2916   case lltok::kw_urem:
2917   case lltok::kw_srem:   return ParseArithmetic(Inst, PFS, KeywordVal, 1);
2918   case lltok::kw_fdiv:
2919   case lltok::kw_frem:   return ParseArithmetic(Inst, PFS, KeywordVal, 2);
2920   case lltok::kw_shl:
2921   case lltok::kw_lshr:
2922   case lltok::kw_ashr:
2923   case lltok::kw_and:
2924   case lltok::kw_or:
2925   case lltok::kw_xor:    return ParseLogical(Inst, PFS, KeywordVal);
2926   case lltok::kw_icmp:
2927   case lltok::kw_fcmp:   return ParseCompare(Inst, PFS, KeywordVal);
2928   // Casts.
2929   case lltok::kw_trunc:
2930   case lltok::kw_zext:
2931   case lltok::kw_sext:
2932   case lltok::kw_fptrunc:
2933   case lltok::kw_fpext:
2934   case lltok::kw_bitcast:
2935   case lltok::kw_uitofp:
2936   case lltok::kw_sitofp:
2937   case lltok::kw_fptoui:
2938   case lltok::kw_fptosi:
2939   case lltok::kw_inttoptr:
2940   case lltok::kw_ptrtoint:       return ParseCast(Inst, PFS, KeywordVal);
2941   // Other.
2942   case lltok::kw_select:         return ParseSelect(Inst, PFS);
2943   case lltok::kw_va_arg:         return ParseVA_Arg(Inst, PFS);
2944   case lltok::kw_extractelement: return ParseExtractElement(Inst, PFS);
2945   case lltok::kw_insertelement:  return ParseInsertElement(Inst, PFS);
2946   case lltok::kw_shufflevector:  return ParseShuffleVector(Inst, PFS);
2947   case lltok::kw_phi:            return ParsePHI(Inst, PFS);
2948   case lltok::kw_call:           return ParseCall(Inst, PFS, false);
2949   case lltok::kw_tail:           return ParseCall(Inst, PFS, true);
2950   // Memory.
2951   case lltok::kw_alloca:         return ParseAlloc(Inst, PFS);
2952   case lltok::kw_malloc:         return ParseAlloc(Inst, PFS, BB, false);
2953   case lltok::kw_free:           return ParseFree(Inst, PFS, BB);
2954   case lltok::kw_load:           return ParseLoad(Inst, PFS, false);
2955   case lltok::kw_store:          return ParseStore(Inst, PFS, false);
2956   case lltok::kw_volatile:
2957     if (EatIfPresent(lltok::kw_load))
2958       return ParseLoad(Inst, PFS, true);
2959     else if (EatIfPresent(lltok::kw_store))
2960       return ParseStore(Inst, PFS, true);
2961     else
2962       return TokError("expected 'load' or 'store'");
2963   case lltok::kw_getresult:     return ParseGetResult(Inst, PFS);
2964   case lltok::kw_getelementptr: return ParseGetElementPtr(Inst, PFS);
2965   case lltok::kw_extractvalue:  return ParseExtractValue(Inst, PFS);
2966   case lltok::kw_insertvalue:   return ParseInsertValue(Inst, PFS);
2967   }
2968 }
2969
2970 /// ParseCmpPredicate - Parse an integer or fp predicate, based on Kind.
2971 bool LLParser::ParseCmpPredicate(unsigned &P, unsigned Opc) {
2972   if (Opc == Instruction::FCmp) {
2973     switch (Lex.getKind()) {
2974     default: TokError("expected fcmp predicate (e.g. 'oeq')");
2975     case lltok::kw_oeq: P = CmpInst::FCMP_OEQ; break;
2976     case lltok::kw_one: P = CmpInst::FCMP_ONE; break;
2977     case lltok::kw_olt: P = CmpInst::FCMP_OLT; break;
2978     case lltok::kw_ogt: P = CmpInst::FCMP_OGT; break;
2979     case lltok::kw_ole: P = CmpInst::FCMP_OLE; break;
2980     case lltok::kw_oge: P = CmpInst::FCMP_OGE; break;
2981     case lltok::kw_ord: P = CmpInst::FCMP_ORD; break;
2982     case lltok::kw_uno: P = CmpInst::FCMP_UNO; break;
2983     case lltok::kw_ueq: P = CmpInst::FCMP_UEQ; break;
2984     case lltok::kw_une: P = CmpInst::FCMP_UNE; break;
2985     case lltok::kw_ult: P = CmpInst::FCMP_ULT; break;
2986     case lltok::kw_ugt: P = CmpInst::FCMP_UGT; break;
2987     case lltok::kw_ule: P = CmpInst::FCMP_ULE; break;
2988     case lltok::kw_uge: P = CmpInst::FCMP_UGE; break;
2989     case lltok::kw_true: P = CmpInst::FCMP_TRUE; break;
2990     case lltok::kw_false: P = CmpInst::FCMP_FALSE; break;
2991     }
2992   } else {
2993     switch (Lex.getKind()) {
2994     default: TokError("expected icmp predicate (e.g. 'eq')");
2995     case lltok::kw_eq:  P = CmpInst::ICMP_EQ; break;
2996     case lltok::kw_ne:  P = CmpInst::ICMP_NE; break;
2997     case lltok::kw_slt: P = CmpInst::ICMP_SLT; break;
2998     case lltok::kw_sgt: P = CmpInst::ICMP_SGT; break;
2999     case lltok::kw_sle: P = CmpInst::ICMP_SLE; break;
3000     case lltok::kw_sge: P = CmpInst::ICMP_SGE; break;
3001     case lltok::kw_ult: P = CmpInst::ICMP_ULT; break;
3002     case lltok::kw_ugt: P = CmpInst::ICMP_UGT; break;
3003     case lltok::kw_ule: P = CmpInst::ICMP_ULE; break;
3004     case lltok::kw_uge: P = CmpInst::ICMP_UGE; break;
3005     }
3006   }
3007   Lex.Lex();
3008   return false;
3009 }
3010
3011 //===----------------------------------------------------------------------===//
3012 // Terminator Instructions.
3013 //===----------------------------------------------------------------------===//
3014
3015 /// ParseRet - Parse a return instruction.
3016 ///   ::= 'ret' void (',' !dbg, !1)
3017 ///   ::= 'ret' TypeAndValue (',' !dbg, !1)
3018 ///   ::= 'ret' TypeAndValue (',' TypeAndValue)+  (',' !dbg, !1)
3019 ///         [[obsolete: LLVM 3.0]]
3020 bool LLParser::ParseRet(Instruction *&Inst, BasicBlock *BB,
3021                         PerFunctionState &PFS) {
3022   PATypeHolder Ty(Type::getVoidTy(Context));
3023   if (ParseType(Ty, true /*void allowed*/)) return true;
3024
3025   if (Ty->isVoidTy()) {
3026     Inst = ReturnInst::Create(Context);
3027     return false;
3028   }
3029
3030   Value *RV;
3031   if (ParseValue(Ty, RV, PFS)) return true;
3032
3033   if (EatIfPresent(lltok::comma)) {
3034     // Parse optional custom metadata, e.g. !dbg
3035     if (Lex.getKind() == lltok::NamedOrCustomMD) {
3036       if (ParseOptionalCustomMetadata()) return true;
3037     } else {
3038       // The normal case is one return value.
3039       // FIXME: LLVM 3.0 remove MRV support for 'ret i32 1, i32 2', requiring use
3040       // of 'ret {i32,i32} {i32 1, i32 2}'
3041       SmallVector<Value*, 8> RVs;
3042       RVs.push_back(RV);
3043
3044       do {
3045         // If optional custom metadata, e.g. !dbg is seen then this is the 
3046         // end of MRV.
3047         if (Lex.getKind() == lltok::NamedOrCustomMD)
3048           break;
3049         if (ParseTypeAndValue(RV, PFS)) return true;
3050         RVs.push_back(RV);
3051       } while (EatIfPresent(lltok::comma));
3052
3053       RV = UndefValue::get(PFS.getFunction().getReturnType());
3054       for (unsigned i = 0, e = RVs.size(); i != e; ++i) {
3055         Instruction *I = InsertValueInst::Create(RV, RVs[i], i, "mrv");
3056         BB->getInstList().push_back(I);
3057         RV = I;
3058       }
3059     }
3060   }
3061
3062   Inst = ReturnInst::Create(Context, RV);
3063   return false;
3064 }
3065
3066
3067 /// ParseBr
3068 ///   ::= 'br' TypeAndValue
3069 ///   ::= 'br' TypeAndValue ',' TypeAndValue ',' TypeAndValue
3070 bool LLParser::ParseBr(Instruction *&Inst, PerFunctionState &PFS) {
3071   LocTy Loc, Loc2;
3072   Value *Op0;
3073   BasicBlock *Op1, *Op2;
3074   if (ParseTypeAndValue(Op0, Loc, PFS)) return true;
3075
3076   if (BasicBlock *BB = dyn_cast<BasicBlock>(Op0)) {
3077     Inst = BranchInst::Create(BB);
3078     return false;
3079   }
3080
3081   if (Op0->getType() != Type::getInt1Ty(Context))
3082     return Error(Loc, "branch condition must have 'i1' type");
3083
3084   if (ParseToken(lltok::comma, "expected ',' after branch condition") ||
3085       ParseTypeAndBasicBlock(Op1, Loc, PFS) ||
3086       ParseToken(lltok::comma, "expected ',' after true destination") ||
3087       ParseTypeAndBasicBlock(Op2, Loc2, PFS))
3088     return true;
3089
3090   Inst = BranchInst::Create(Op1, Op2, Op0);
3091   return false;
3092 }
3093
3094 /// ParseSwitch
3095 ///  Instruction
3096 ///    ::= 'switch' TypeAndValue ',' TypeAndValue '[' JumpTable ']'
3097 ///  JumpTable
3098 ///    ::= (TypeAndValue ',' TypeAndValue)*
3099 bool LLParser::ParseSwitch(Instruction *&Inst, PerFunctionState &PFS) {
3100   LocTy CondLoc, BBLoc;
3101   Value *Cond;
3102   BasicBlock *DefaultBB;
3103   if (ParseTypeAndValue(Cond, CondLoc, PFS) ||
3104       ParseToken(lltok::comma, "expected ',' after switch condition") ||
3105       ParseTypeAndBasicBlock(DefaultBB, BBLoc, PFS) ||
3106       ParseToken(lltok::lsquare, "expected '[' with switch table"))
3107     return true;
3108
3109   if (!isa<IntegerType>(Cond->getType()))
3110     return Error(CondLoc, "switch condition must have integer type");
3111
3112   // Parse the jump table pairs.
3113   SmallPtrSet<Value*, 32> SeenCases;
3114   SmallVector<std::pair<ConstantInt*, BasicBlock*>, 32> Table;
3115   while (Lex.getKind() != lltok::rsquare) {
3116     Value *Constant;
3117     BasicBlock *DestBB;
3118
3119     if (ParseTypeAndValue(Constant, CondLoc, PFS) ||
3120         ParseToken(lltok::comma, "expected ',' after case value") ||
3121         ParseTypeAndBasicBlock(DestBB, PFS))
3122       return true;
3123     
3124     if (!SeenCases.insert(Constant))
3125       return Error(CondLoc, "duplicate case value in switch");
3126     if (!isa<ConstantInt>(Constant))
3127       return Error(CondLoc, "case value is not a constant integer");
3128
3129     Table.push_back(std::make_pair(cast<ConstantInt>(Constant), DestBB));
3130   }
3131
3132   Lex.Lex();  // Eat the ']'.
3133
3134   SwitchInst *SI = SwitchInst::Create(Cond, DefaultBB, Table.size());
3135   for (unsigned i = 0, e = Table.size(); i != e; ++i)
3136     SI->addCase(Table[i].first, Table[i].second);
3137   Inst = SI;
3138   return false;
3139 }
3140
3141 /// ParseIndirectBr
3142 ///  Instruction
3143 ///    ::= 'indirectbr' TypeAndValue ',' '[' LabelList ']'
3144 bool LLParser::ParseIndirectBr(Instruction *&Inst, PerFunctionState &PFS) {
3145   LocTy AddrLoc;
3146   Value *Address;
3147   if (ParseTypeAndValue(Address, AddrLoc, PFS) ||
3148       ParseToken(lltok::comma, "expected ',' after indirectbr address") ||
3149       ParseToken(lltok::lsquare, "expected '[' with indirectbr"))
3150     return true;
3151   
3152   if (!isa<PointerType>(Address->getType()))
3153     return Error(AddrLoc, "indirectbr address must have pointer type");
3154   
3155   // Parse the destination list.
3156   SmallVector<BasicBlock*, 16> DestList;
3157   
3158   if (Lex.getKind() != lltok::rsquare) {
3159     BasicBlock *DestBB;
3160     if (ParseTypeAndBasicBlock(DestBB, PFS))
3161       return true;
3162     DestList.push_back(DestBB);
3163     
3164     while (EatIfPresent(lltok::comma)) {
3165       if (ParseTypeAndBasicBlock(DestBB, PFS))
3166         return true;
3167       DestList.push_back(DestBB);
3168     }
3169   }
3170   
3171   if (ParseToken(lltok::rsquare, "expected ']' at end of block list"))
3172     return true;
3173
3174   IndirectBrInst *IBI = IndirectBrInst::Create(Address, DestList.size());
3175   for (unsigned i = 0, e = DestList.size(); i != e; ++i)
3176     IBI->addDestination(DestList[i]);
3177   Inst = IBI;
3178   return false;
3179 }
3180
3181
3182 /// ParseInvoke
3183 ///   ::= 'invoke' OptionalCallingConv OptionalAttrs Type Value ParamList
3184 ///       OptionalAttrs 'to' TypeAndValue 'unwind' TypeAndValue
3185 bool LLParser::ParseInvoke(Instruction *&Inst, PerFunctionState &PFS) {
3186   LocTy CallLoc = Lex.getLoc();
3187   unsigned RetAttrs, FnAttrs;
3188   CallingConv::ID CC;
3189   PATypeHolder RetType(Type::getVoidTy(Context));
3190   LocTy RetTypeLoc;
3191   ValID CalleeID;
3192   SmallVector<ParamInfo, 16> ArgList;
3193
3194   BasicBlock *NormalBB, *UnwindBB;
3195   if (ParseOptionalCallingConv(CC) ||
3196       ParseOptionalAttrs(RetAttrs, 1) ||
3197       ParseType(RetType, RetTypeLoc, true /*void allowed*/) ||
3198       ParseValID(CalleeID) ||
3199       ParseParameterList(ArgList, PFS) ||
3200       ParseOptionalAttrs(FnAttrs, 2) ||
3201       ParseToken(lltok::kw_to, "expected 'to' in invoke") ||
3202       ParseTypeAndBasicBlock(NormalBB, PFS) ||
3203       ParseToken(lltok::kw_unwind, "expected 'unwind' in invoke") ||
3204       ParseTypeAndBasicBlock(UnwindBB, PFS))
3205     return true;
3206
3207   // If RetType is a non-function pointer type, then this is the short syntax
3208   // for the call, which means that RetType is just the return type.  Infer the
3209   // rest of the function argument types from the arguments that are present.
3210   const PointerType *PFTy = 0;
3211   const FunctionType *Ty = 0;
3212   if (!(PFTy = dyn_cast<PointerType>(RetType)) ||
3213       !(Ty = dyn_cast<FunctionType>(PFTy->getElementType()))) {
3214     // Pull out the types of all of the arguments...
3215     std::vector<const Type*> ParamTypes;
3216     for (unsigned i = 0, e = ArgList.size(); i != e; ++i)
3217       ParamTypes.push_back(ArgList[i].V->getType());
3218
3219     if (!FunctionType::isValidReturnType(RetType))
3220       return Error(RetTypeLoc, "Invalid result type for LLVM function");
3221
3222     Ty = FunctionType::get(RetType, ParamTypes, false);
3223     PFTy = PointerType::getUnqual(Ty);
3224   }
3225
3226   // Look up the callee.
3227   Value *Callee;
3228   if (ConvertValIDToValue(PFTy, CalleeID, Callee, PFS)) return true;
3229
3230   // FIXME: In LLVM 3.0, stop accepting zext, sext and inreg as optional
3231   // function attributes.
3232   unsigned ObsoleteFuncAttrs = Attribute::ZExt|Attribute::SExt|Attribute::InReg;
3233   if (FnAttrs & ObsoleteFuncAttrs) {
3234     RetAttrs |= FnAttrs & ObsoleteFuncAttrs;
3235     FnAttrs &= ~ObsoleteFuncAttrs;
3236   }
3237
3238   // Set up the Attributes for the function.
3239   SmallVector<AttributeWithIndex, 8> Attrs;
3240   if (RetAttrs != Attribute::None)
3241     Attrs.push_back(AttributeWithIndex::get(0, RetAttrs));
3242
3243   SmallVector<Value*, 8> Args;
3244
3245   // Loop through FunctionType's arguments and ensure they are specified
3246   // correctly.  Also, gather any parameter attributes.
3247   FunctionType::param_iterator I = Ty->param_begin();
3248   FunctionType::param_iterator E = Ty->param_end();
3249   for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
3250     const Type *ExpectedTy = 0;
3251     if (I != E) {
3252       ExpectedTy = *I++;
3253     } else if (!Ty->isVarArg()) {
3254       return Error(ArgList[i].Loc, "too many arguments specified");
3255     }
3256
3257     if (ExpectedTy && ExpectedTy != ArgList[i].V->getType())
3258       return Error(ArgList[i].Loc, "argument is not of expected type '" +
3259                    ExpectedTy->getDescription() + "'");
3260     Args.push_back(ArgList[i].V);
3261     if (ArgList[i].Attrs != Attribute::None)
3262       Attrs.push_back(AttributeWithIndex::get(i+1, ArgList[i].Attrs));
3263   }
3264
3265   if (I != E)
3266     return Error(CallLoc, "not enough parameters specified for call");
3267
3268   if (FnAttrs != Attribute::None)
3269     Attrs.push_back(AttributeWithIndex::get(~0, FnAttrs));
3270
3271   // Finish off the Attributes and check them
3272   AttrListPtr PAL = AttrListPtr::get(Attrs.begin(), Attrs.end());
3273
3274   InvokeInst *II = InvokeInst::Create(Callee, NormalBB, UnwindBB,
3275                                       Args.begin(), Args.end());
3276   II->setCallingConv(CC);
3277   II->setAttributes(PAL);
3278   Inst = II;
3279   return false;
3280 }
3281
3282
3283
3284 //===----------------------------------------------------------------------===//
3285 // Binary Operators.
3286 //===----------------------------------------------------------------------===//
3287
3288 /// ParseArithmetic
3289 ///  ::= ArithmeticOps TypeAndValue ',' Value
3290 ///
3291 /// If OperandType is 0, then any FP or integer operand is allowed.  If it is 1,
3292 /// then any integer operand is allowed, if it is 2, any fp operand is allowed.
3293 bool LLParser::ParseArithmetic(Instruction *&Inst, PerFunctionState &PFS,
3294                                unsigned Opc, unsigned OperandType) {
3295   LocTy Loc; Value *LHS, *RHS;
3296   if (ParseTypeAndValue(LHS, Loc, PFS) ||
3297       ParseToken(lltok::comma, "expected ',' in arithmetic operation") ||
3298       ParseValue(LHS->getType(), RHS, PFS))
3299     return true;
3300
3301   bool Valid;
3302   switch (OperandType) {
3303   default: llvm_unreachable("Unknown operand type!");
3304   case 0: // int or FP.
3305     Valid = LHS->getType()->isIntOrIntVector() ||
3306             LHS->getType()->isFPOrFPVector();
3307     break;
3308   case 1: Valid = LHS->getType()->isIntOrIntVector(); break;
3309   case 2: Valid = LHS->getType()->isFPOrFPVector(); break;
3310   }
3311
3312   if (!Valid)
3313     return Error(Loc, "invalid operand type for instruction");
3314
3315   Inst = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
3316   return false;
3317 }
3318
3319 /// ParseLogical
3320 ///  ::= ArithmeticOps TypeAndValue ',' Value {
3321 bool LLParser::ParseLogical(Instruction *&Inst, PerFunctionState &PFS,
3322                             unsigned Opc) {
3323   LocTy Loc; Value *LHS, *RHS;
3324   if (ParseTypeAndValue(LHS, Loc, PFS) ||
3325       ParseToken(lltok::comma, "expected ',' in logical operation") ||
3326       ParseValue(LHS->getType(), RHS, PFS))
3327     return true;
3328
3329   if (!LHS->getType()->isIntOrIntVector())
3330     return Error(Loc,"instruction requires integer or integer vector operands");
3331
3332   Inst = BinaryOperator::Create((Instruction::BinaryOps)Opc, LHS, RHS);
3333   return false;
3334 }
3335
3336
3337 /// ParseCompare
3338 ///  ::= 'icmp' IPredicates TypeAndValue ',' Value
3339 ///  ::= 'fcmp' FPredicates TypeAndValue ',' Value
3340 bool LLParser::ParseCompare(Instruction *&Inst, PerFunctionState &PFS,
3341                             unsigned Opc) {
3342   // Parse the integer/fp comparison predicate.
3343   LocTy Loc;
3344   unsigned Pred;
3345   Value *LHS, *RHS;
3346   if (ParseCmpPredicate(Pred, Opc) ||
3347       ParseTypeAndValue(LHS, Loc, PFS) ||
3348       ParseToken(lltok::comma, "expected ',' after compare value") ||
3349       ParseValue(LHS->getType(), RHS, PFS))
3350     return true;
3351
3352   if (Opc == Instruction::FCmp) {
3353     if (!LHS->getType()->isFPOrFPVector())
3354       return Error(Loc, "fcmp requires floating point operands");
3355     Inst = new FCmpInst(CmpInst::Predicate(Pred), LHS, RHS);
3356   } else {
3357     assert(Opc == Instruction::ICmp && "Unknown opcode for CmpInst!");
3358     if (!LHS->getType()->isIntOrIntVector() &&
3359         !isa<PointerType>(LHS->getType()))
3360       return Error(Loc, "icmp requires integer operands");
3361     Inst = new ICmpInst(CmpInst::Predicate(Pred), LHS, RHS);
3362   }
3363   return false;
3364 }
3365
3366 //===----------------------------------------------------------------------===//
3367 // Other Instructions.
3368 //===----------------------------------------------------------------------===//
3369
3370
3371 /// ParseCast
3372 ///   ::= CastOpc TypeAndValue 'to' Type
3373 bool LLParser::ParseCast(Instruction *&Inst, PerFunctionState &PFS,
3374                          unsigned Opc) {
3375   LocTy Loc;  Value *Op;
3376   PATypeHolder DestTy(Type::getVoidTy(Context));
3377   if (ParseTypeAndValue(Op, Loc, PFS) ||
3378       ParseToken(lltok::kw_to, "expected 'to' after cast value") ||
3379       ParseType(DestTy))
3380     return true;
3381
3382   if (!CastInst::castIsValid((Instruction::CastOps)Opc, Op, DestTy)) {
3383     CastInst::castIsValid((Instruction::CastOps)Opc, Op, DestTy);
3384     return Error(Loc, "invalid cast opcode for cast from '" +
3385                  Op->getType()->getDescription() + "' to '" +
3386                  DestTy->getDescription() + "'");
3387   }
3388   Inst = CastInst::Create((Instruction::CastOps)Opc, Op, DestTy);
3389   return false;
3390 }
3391
3392 /// ParseSelect
3393 ///   ::= 'select' TypeAndValue ',' TypeAndValue ',' TypeAndValue
3394 bool LLParser::ParseSelect(Instruction *&Inst, PerFunctionState &PFS) {
3395   LocTy Loc;
3396   Value *Op0, *Op1, *Op2;
3397   if (ParseTypeAndValue(Op0, Loc, PFS) ||
3398       ParseToken(lltok::comma, "expected ',' after select condition") ||
3399       ParseTypeAndValue(Op1, PFS) ||
3400       ParseToken(lltok::comma, "expected ',' after select value") ||
3401       ParseTypeAndValue(Op2, PFS))
3402     return true;
3403
3404   if (const char *Reason = SelectInst::areInvalidOperands(Op0, Op1, Op2))
3405     return Error(Loc, Reason);
3406
3407   Inst = SelectInst::Create(Op0, Op1, Op2);
3408   return false;
3409 }
3410
3411 /// ParseVA_Arg
3412 ///   ::= 'va_arg' TypeAndValue ',' Type
3413 bool LLParser::ParseVA_Arg(Instruction *&Inst, PerFunctionState &PFS) {
3414   Value *Op;
3415   PATypeHolder EltTy(Type::getVoidTy(Context));
3416   LocTy TypeLoc;
3417   if (ParseTypeAndValue(Op, PFS) ||
3418       ParseToken(lltok::comma, "expected ',' after vaarg operand") ||
3419       ParseType(EltTy, TypeLoc))
3420     return true;
3421
3422   if (!EltTy->isFirstClassType())
3423     return Error(TypeLoc, "va_arg requires operand with first class type");
3424
3425   Inst = new VAArgInst(Op, EltTy);
3426   return false;
3427 }
3428
3429 /// ParseExtractElement
3430 ///   ::= 'extractelement' TypeAndValue ',' TypeAndValue
3431 bool LLParser::ParseExtractElement(Instruction *&Inst, PerFunctionState &PFS) {
3432   LocTy Loc;
3433   Value *Op0, *Op1;
3434   if (ParseTypeAndValue(Op0, Loc, PFS) ||
3435       ParseToken(lltok::comma, "expected ',' after extract value") ||
3436       ParseTypeAndValue(Op1, PFS))
3437     return true;
3438
3439   if (!ExtractElementInst::isValidOperands(Op0, Op1))
3440     return Error(Loc, "invalid extractelement operands");
3441
3442   Inst = ExtractElementInst::Create(Op0, Op1);
3443   return false;
3444 }
3445
3446 /// ParseInsertElement
3447 ///   ::= 'insertelement' TypeAndValue ',' TypeAndValue ',' TypeAndValue
3448 bool LLParser::ParseInsertElement(Instruction *&Inst, PerFunctionState &PFS) {
3449   LocTy Loc;
3450   Value *Op0, *Op1, *Op2;
3451   if (ParseTypeAndValue(Op0, Loc, PFS) ||
3452       ParseToken(lltok::comma, "expected ',' after insertelement value") ||
3453       ParseTypeAndValue(Op1, PFS) ||
3454       ParseToken(lltok::comma, "expected ',' after insertelement value") ||
3455       ParseTypeAndValue(Op2, PFS))
3456     return true;
3457
3458   if (!InsertElementInst::isValidOperands(Op0, Op1, Op2))
3459     return Error(Loc, "invalid insertelement operands");
3460
3461   Inst = InsertElementInst::Create(Op0, Op1, Op2);
3462   return false;
3463 }
3464
3465 /// ParseShuffleVector
3466 ///   ::= 'shufflevector' TypeAndValue ',' TypeAndValue ',' TypeAndValue
3467 bool LLParser::ParseShuffleVector(Instruction *&Inst, PerFunctionState &PFS) {
3468   LocTy Loc;
3469   Value *Op0, *Op1, *Op2;
3470   if (ParseTypeAndValue(Op0, Loc, PFS) ||
3471       ParseToken(lltok::comma, "expected ',' after shuffle mask") ||
3472       ParseTypeAndValue(Op1, PFS) ||
3473       ParseToken(lltok::comma, "expected ',' after shuffle value") ||
3474       ParseTypeAndValue(Op2, PFS))
3475     return true;
3476
3477   if (!ShuffleVectorInst::isValidOperands(Op0, Op1, Op2))
3478     return Error(Loc, "invalid extractelement operands");
3479
3480   Inst = new ShuffleVectorInst(Op0, Op1, Op2);
3481   return false;
3482 }
3483
3484 /// ParsePHI
3485 ///   ::= 'phi' Type '[' Value ',' Value ']' (',' '[' Value ',' Value ']')*
3486 bool LLParser::ParsePHI(Instruction *&Inst, PerFunctionState &PFS) {
3487   PATypeHolder Ty(Type::getVoidTy(Context));
3488   Value *Op0, *Op1;
3489   LocTy TypeLoc = Lex.getLoc();
3490
3491   if (ParseType(Ty) ||
3492       ParseToken(lltok::lsquare, "expected '[' in phi value list") ||
3493       ParseValue(Ty, Op0, PFS) ||
3494       ParseToken(lltok::comma, "expected ',' after insertelement value") ||
3495       ParseValue(Type::getLabelTy(Context), Op1, PFS) ||
3496       ParseToken(lltok::rsquare, "expected ']' in phi value list"))
3497     return true;
3498
3499   SmallVector<std::pair<Value*, BasicBlock*>, 16> PHIVals;
3500   while (1) {
3501     PHIVals.push_back(std::make_pair(Op0, cast<BasicBlock>(Op1)));
3502
3503     if (!EatIfPresent(lltok::comma))
3504       break;
3505
3506     if (Lex.getKind() == lltok::NamedOrCustomMD)
3507       break;
3508
3509     if (ParseToken(lltok::lsquare, "expected '[' in phi value list") ||
3510         ParseValue(Ty, Op0, PFS) ||
3511         ParseToken(lltok::comma, "expected ',' after insertelement value") ||
3512         ParseValue(Type::getLabelTy(Context), Op1, PFS) ||
3513         ParseToken(lltok::rsquare, "expected ']' in phi value list"))
3514       return true;
3515   }
3516
3517   if (Lex.getKind() == lltok::NamedOrCustomMD)
3518     if (ParseOptionalCustomMetadata()) return true;
3519
3520   if (!Ty->isFirstClassType())
3521     return Error(TypeLoc, "phi node must have first class type");
3522
3523   PHINode *PN = PHINode::Create(Ty);
3524   PN->reserveOperandSpace(PHIVals.size());
3525   for (unsigned i = 0, e = PHIVals.size(); i != e; ++i)
3526     PN->addIncoming(PHIVals[i].first, PHIVals[i].second);
3527   Inst = PN;
3528   return false;
3529 }
3530
3531 /// ParseCall
3532 ///   ::= 'tail'? 'call' OptionalCallingConv OptionalAttrs Type Value
3533 ///       ParameterList OptionalAttrs
3534 bool LLParser::ParseCall(Instruction *&Inst, PerFunctionState &PFS,
3535                          bool isTail) {
3536   unsigned RetAttrs, FnAttrs;
3537   CallingConv::ID CC;
3538   PATypeHolder RetType(Type::getVoidTy(Context));
3539   LocTy RetTypeLoc;
3540   ValID CalleeID;
3541   SmallVector<ParamInfo, 16> ArgList;
3542   LocTy CallLoc = Lex.getLoc();
3543
3544   if ((isTail && ParseToken(lltok::kw_call, "expected 'tail call'")) ||
3545       ParseOptionalCallingConv(CC) ||
3546       ParseOptionalAttrs(RetAttrs, 1) ||
3547       ParseType(RetType, RetTypeLoc, true /*void allowed*/) ||
3548       ParseValID(CalleeID) ||
3549       ParseParameterList(ArgList, PFS) ||
3550       ParseOptionalAttrs(FnAttrs, 2))
3551     return true;
3552
3553   // If RetType is a non-function pointer type, then this is the short syntax
3554   // for the call, which means that RetType is just the return type.  Infer the
3555   // rest of the function argument types from the arguments that are present.
3556   const PointerType *PFTy = 0;
3557   const FunctionType *Ty = 0;
3558   if (!(PFTy = dyn_cast<PointerType>(RetType)) ||
3559       !(Ty = dyn_cast<FunctionType>(PFTy->getElementType()))) {
3560     // Pull out the types of all of the arguments...
3561     std::vector<const Type*> ParamTypes;
3562     for (unsigned i = 0, e = ArgList.size(); i != e; ++i)
3563       ParamTypes.push_back(ArgList[i].V->getType());
3564
3565     if (!FunctionType::isValidReturnType(RetType))
3566       return Error(RetTypeLoc, "Invalid result type for LLVM function");
3567
3568     Ty = FunctionType::get(RetType, ParamTypes, false);
3569     PFTy = PointerType::getUnqual(Ty);
3570   }
3571
3572   // Look up the callee.
3573   Value *Callee;
3574   if (ConvertValIDToValue(PFTy, CalleeID, Callee, PFS)) return true;
3575
3576   // FIXME: In LLVM 3.0, stop accepting zext, sext and inreg as optional
3577   // function attributes.
3578   unsigned ObsoleteFuncAttrs = Attribute::ZExt|Attribute::SExt|Attribute::InReg;
3579   if (FnAttrs & ObsoleteFuncAttrs) {
3580     RetAttrs |= FnAttrs & ObsoleteFuncAttrs;
3581     FnAttrs &= ~ObsoleteFuncAttrs;
3582   }
3583
3584   // Set up the Attributes for the function.
3585   SmallVector<AttributeWithIndex, 8> Attrs;
3586   if (RetAttrs != Attribute::None)
3587     Attrs.push_back(AttributeWithIndex::get(0, RetAttrs));
3588
3589   SmallVector<Value*, 8> Args;
3590
3591   // Loop through FunctionType's arguments and ensure they are specified
3592   // correctly.  Also, gather any parameter attributes.
3593   FunctionType::param_iterator I = Ty->param_begin();
3594   FunctionType::param_iterator E = Ty->param_end();
3595   for (unsigned i = 0, e = ArgList.size(); i != e; ++i) {
3596     const Type *ExpectedTy = 0;
3597     if (I != E) {
3598       ExpectedTy = *I++;
3599     } else if (!Ty->isVarArg()) {
3600       return Error(ArgList[i].Loc, "too many arguments specified");
3601     }
3602
3603     if (ExpectedTy && ExpectedTy != ArgList[i].V->getType())
3604       return Error(ArgList[i].Loc, "argument is not of expected type '" +
3605                    ExpectedTy->getDescription() + "'");
3606     Args.push_back(ArgList[i].V);
3607     if (ArgList[i].Attrs != Attribute::None)
3608       Attrs.push_back(AttributeWithIndex::get(i+1, ArgList[i].Attrs));
3609   }
3610
3611   if (I != E)
3612     return Error(CallLoc, "not enough parameters specified for call");
3613
3614   if (FnAttrs != Attribute::None)
3615     Attrs.push_back(AttributeWithIndex::get(~0, FnAttrs));
3616
3617   // Finish off the Attributes and check them
3618   AttrListPtr PAL = AttrListPtr::get(Attrs.begin(), Attrs.end());
3619
3620   CallInst *CI = CallInst::Create(Callee, Args.begin(), Args.end());
3621   CI->setTailCall(isTail);
3622   CI->setCallingConv(CC);
3623   CI->setAttributes(PAL);
3624   Inst = CI;
3625   return false;
3626 }
3627
3628 //===----------------------------------------------------------------------===//
3629 // Memory Instructions.
3630 //===----------------------------------------------------------------------===//
3631
3632 /// ParseAlloc
3633 ///   ::= 'malloc' Type (',' TypeAndValue)? (',' OptionalInfo)?
3634 ///   ::= 'alloca' Type (',' TypeAndValue)? (',' OptionalInfo)?
3635 bool LLParser::ParseAlloc(Instruction *&Inst, PerFunctionState &PFS,
3636                           BasicBlock* BB, bool isAlloca) {
3637   PATypeHolder Ty(Type::getVoidTy(Context));
3638   Value *Size = 0;
3639   LocTy SizeLoc;
3640   unsigned Alignment = 0;
3641   if (ParseType(Ty)) return true;
3642
3643   if (EatIfPresent(lltok::comma)) {
3644     if (Lex.getKind() == lltok::kw_align 
3645         || Lex.getKind() == lltok::NamedOrCustomMD) {
3646       if (ParseOptionalInfo(Alignment)) return true;
3647     } else {
3648       if (ParseTypeAndValue(Size, SizeLoc, PFS)) return true;
3649       if (EatIfPresent(lltok::comma))
3650         if (ParseOptionalInfo(Alignment)) return true;
3651     }
3652   }
3653
3654   if (Size && Size->getType() != Type::getInt32Ty(Context))
3655     return Error(SizeLoc, "element count must be i32");
3656
3657   if (isAlloca) {
3658     Inst = new AllocaInst(Ty, Size, Alignment);
3659     return false;
3660   }
3661
3662   // Autoupgrade old malloc instruction to malloc call.
3663   // FIXME: Remove in LLVM 3.0.
3664   const Type *IntPtrTy = Type::getInt32Ty(Context);
3665   Constant *AllocSize = ConstantExpr::getSizeOf(Ty);
3666   AllocSize = ConstantExpr::getTruncOrBitCast(AllocSize, IntPtrTy);
3667   if (!MallocF)
3668     // Prototype malloc as "void *(int32)".
3669     // This function is renamed as "malloc" in ValidateEndOfModule().
3670     MallocF = cast<Function>(
3671        M->getOrInsertFunction("", Type::getInt8PtrTy(Context), IntPtrTy, NULL));
3672   Inst = CallInst::CreateMalloc(BB, IntPtrTy, Ty, AllocSize, Size, MallocF);
3673   return false;
3674 }
3675
3676 /// ParseFree
3677 ///   ::= 'free' TypeAndValue
3678 bool LLParser::ParseFree(Instruction *&Inst, PerFunctionState &PFS,
3679                          BasicBlock* BB) {
3680   Value *Val; LocTy Loc;
3681   if (ParseTypeAndValue(Val, Loc, PFS)) return true;
3682   if (!isa<PointerType>(Val->getType()))
3683     return Error(Loc, "operand to free must be a pointer");
3684   Inst = CallInst::CreateFree(Val, BB);
3685   return false;
3686 }
3687
3688 /// ParseLoad
3689 ///   ::= 'volatile'? 'load' TypeAndValue (',' OptionalInfo)?
3690 bool LLParser::ParseLoad(Instruction *&Inst, PerFunctionState &PFS,
3691                          bool isVolatile) {
3692   Value *Val; LocTy Loc;
3693   unsigned Alignment = 0;
3694   if (ParseTypeAndValue(Val, Loc, PFS)) return true;
3695
3696   if (EatIfPresent(lltok::comma))
3697     if (ParseOptionalInfo(Alignment)) return true;
3698
3699   if (!isa<PointerType>(Val->getType()) ||
3700       !cast<PointerType>(Val->getType())->getElementType()->isFirstClassType())
3701     return Error(Loc, "load operand must be a pointer to a first class type");
3702
3703   Inst = new LoadInst(Val, "", isVolatile, Alignment);
3704   return false;
3705 }
3706
3707 /// ParseStore
3708 ///   ::= 'volatile'? 'store' TypeAndValue ',' TypeAndValue (',' 'align' i32)?
3709 bool LLParser::ParseStore(Instruction *&Inst, PerFunctionState &PFS,
3710                           bool isVolatile) {
3711   Value *Val, *Ptr; LocTy Loc, PtrLoc;
3712   unsigned Alignment = 0;
3713   if (ParseTypeAndValue(Val, Loc, PFS) ||
3714       ParseToken(lltok::comma, "expected ',' after store operand") ||
3715       ParseTypeAndValue(Ptr, PtrLoc, PFS))
3716     return true;
3717
3718   if (EatIfPresent(lltok::comma))
3719     if (ParseOptionalInfo(Alignment)) return true;
3720
3721   if (!isa<PointerType>(Ptr->getType()))
3722     return Error(PtrLoc, "store operand must be a pointer");
3723   if (!Val->getType()->isFirstClassType())
3724     return Error(Loc, "store operand must be a first class value");
3725   if (cast<PointerType>(Ptr->getType())->getElementType() != Val->getType())
3726     return Error(Loc, "stored value and pointer type do not match");
3727
3728   Inst = new StoreInst(Val, Ptr, isVolatile, Alignment);
3729   return false;
3730 }
3731
3732 /// ParseGetResult
3733 ///   ::= 'getresult' TypeAndValue ',' i32
3734 /// FIXME: Remove support for getresult in LLVM 3.0
3735 bool LLParser::ParseGetResult(Instruction *&Inst, PerFunctionState &PFS) {
3736   Value *Val; LocTy ValLoc, EltLoc;
3737   unsigned Element;
3738   if (ParseTypeAndValue(Val, ValLoc, PFS) ||
3739       ParseToken(lltok::comma, "expected ',' after getresult operand") ||
3740       ParseUInt32(Element, EltLoc))
3741     return true;
3742
3743   if (!isa<StructType>(Val->getType()) && !isa<ArrayType>(Val->getType()))
3744     return Error(ValLoc, "getresult inst requires an aggregate operand");
3745   if (!ExtractValueInst::getIndexedType(Val->getType(), Element))
3746     return Error(EltLoc, "invalid getresult index for value");
3747   Inst = ExtractValueInst::Create(Val, Element);
3748   return false;
3749 }
3750
3751 /// ParseGetElementPtr
3752 ///   ::= 'getelementptr' 'inbounds'? TypeAndValue (',' TypeAndValue)*
3753 bool LLParser::ParseGetElementPtr(Instruction *&Inst, PerFunctionState &PFS) {
3754   Value *Ptr, *Val; LocTy Loc, EltLoc;
3755
3756   bool InBounds = EatIfPresent(lltok::kw_inbounds);
3757
3758   if (ParseTypeAndValue(Ptr, Loc, PFS)) return true;
3759
3760   if (!isa<PointerType>(Ptr->getType()))
3761     return Error(Loc, "base of getelementptr must be a pointer");
3762
3763   SmallVector<Value*, 16> Indices;
3764   while (EatIfPresent(lltok::comma)) {
3765     if (Lex.getKind() == lltok::NamedOrCustomMD)
3766       break;
3767     if (ParseTypeAndValue(Val, EltLoc, PFS)) return true;
3768     if (!isa<IntegerType>(Val->getType()))
3769       return Error(EltLoc, "getelementptr index must be an integer");
3770     Indices.push_back(Val);
3771   }
3772   if (Lex.getKind() == lltok::NamedOrCustomMD)
3773     if (ParseOptionalCustomMetadata()) return true;
3774
3775   if (!GetElementPtrInst::getIndexedType(Ptr->getType(),
3776                                          Indices.begin(), Indices.end()))
3777     return Error(Loc, "invalid getelementptr indices");
3778   Inst = GetElementPtrInst::Create(Ptr, Indices.begin(), Indices.end());
3779   if (InBounds)
3780     cast<GetElementPtrInst>(Inst)->setIsInBounds(true);
3781   return false;
3782 }
3783
3784 /// ParseExtractValue
3785 ///   ::= 'extractvalue' TypeAndValue (',' uint32)+
3786 bool LLParser::ParseExtractValue(Instruction *&Inst, PerFunctionState &PFS) {
3787   Value *Val; LocTy Loc;
3788   SmallVector<unsigned, 4> Indices;
3789   if (ParseTypeAndValue(Val, Loc, PFS) ||
3790       ParseIndexList(Indices))
3791     return true;
3792   if (Lex.getKind() == lltok::NamedOrCustomMD)
3793     if (ParseOptionalCustomMetadata()) return true;
3794
3795   if (!isa<StructType>(Val->getType()) && !isa<ArrayType>(Val->getType()))
3796     return Error(Loc, "extractvalue operand must be array or struct");
3797
3798   if (!ExtractValueInst::getIndexedType(Val->getType(), Indices.begin(),
3799                                         Indices.end()))
3800     return Error(Loc, "invalid indices for extractvalue");
3801   Inst = ExtractValueInst::Create(Val, Indices.begin(), Indices.end());
3802   return false;
3803 }
3804
3805 /// ParseInsertValue
3806 ///   ::= 'insertvalue' TypeAndValue ',' TypeAndValue (',' uint32)+
3807 bool LLParser::ParseInsertValue(Instruction *&Inst, PerFunctionState &PFS) {
3808   Value *Val0, *Val1; LocTy Loc0, Loc1;
3809   SmallVector<unsigned, 4> Indices;
3810   if (ParseTypeAndValue(Val0, Loc0, PFS) ||
3811       ParseToken(lltok::comma, "expected comma after insertvalue operand") ||
3812       ParseTypeAndValue(Val1, Loc1, PFS) ||
3813       ParseIndexList(Indices))
3814     return true;
3815   if (Lex.getKind() == lltok::NamedOrCustomMD)
3816     if (ParseOptionalCustomMetadata()) return true;
3817
3818   if (!isa<StructType>(Val0->getType()) && !isa<ArrayType>(Val0->getType()))
3819     return Error(Loc0, "extractvalue operand must be array or struct");
3820
3821   if (!ExtractValueInst::getIndexedType(Val0->getType(), Indices.begin(),
3822                                         Indices.end()))
3823     return Error(Loc0, "invalid indices for insertvalue");
3824   Inst = InsertValueInst::Create(Val0, Val1, Indices.begin(), Indices.end());
3825   return false;
3826 }
3827
3828 //===----------------------------------------------------------------------===//
3829 // Embedded metadata.
3830 //===----------------------------------------------------------------------===//
3831
3832 /// ParseMDNodeVector
3833 ///   ::= Element (',' Element)*
3834 /// Element
3835 ///   ::= 'null' | TypeAndValue
3836 bool LLParser::ParseMDNodeVector(SmallVectorImpl<Value*> &Elts) {
3837   assert(Lex.getKind() == lltok::lbrace);
3838   Lex.Lex();
3839   do {
3840     Value *V = 0;
3841     if (Lex.getKind() == lltok::kw_null) {
3842       Lex.Lex();
3843       V = 0;
3844     } else {
3845       PATypeHolder Ty(Type::getVoidTy(Context));
3846       if (ParseType(Ty)) return true;
3847       if (Lex.getKind() == lltok::Metadata) {
3848         Lex.Lex();
3849         MetadataBase *Node = 0;
3850         if (!ParseMDNode(Node))
3851           V = Node;
3852         else {
3853           MetadataBase *MDS = 0;
3854           if (ParseMDString(MDS)) return true;
3855           V = MDS;
3856         }
3857       } else {
3858         Constant *C;
3859         if (ParseGlobalValue(Ty, C)) return true;
3860         V = C;
3861       }
3862     }
3863     Elts.push_back(V);
3864   } while (EatIfPresent(lltok::comma));
3865
3866   return false;
3867 }