Spell `necessary' correctly.
[oota-llvm.git] / lib / Bytecode / Reader / Reader.cpp
1 //===- Reader.cpp - Code to read bytecode files ---------------------------===//
2 //
3 // This library implements the functionality defined in llvm/Bytecode/Reader.h
4 //
5 // Note that this library should be as fast as possible, reentrant, and 
6 // threadsafe!!
7 //
8 // TODO: Return error messages to caller instead of printing them out directly.
9 // TODO: Allow passing in an option to ignore the symbol table
10 //
11 //===----------------------------------------------------------------------===//
12
13 #include "ReaderInternals.h"
14 #include "Config/sys/mman.h"
15 #include "llvm/Bytecode/Reader.h"
16 #include "llvm/Bytecode/Format.h"
17 #include "llvm/Module.h"
18 #include "llvm/Constants.h"
19 #include "llvm/iPHINode.h"
20 #include "llvm/iOther.h"
21 #include "Config/sys/types.h"
22 #include "Config/sys/stat.h"
23 #include "Config/fcntl.h"
24 #include "Config/unistd.h"
25 #include <algorithm>
26
27 bool BytecodeParser::getTypeSlot(const Type *Ty, unsigned &Slot) {
28   if (Ty->isPrimitiveType()) {
29     Slot = Ty->getPrimitiveID();
30   } else {
31     // Check the function level types first...
32     TypeValuesListTy::iterator I = find(FunctionTypeValues.begin(),
33                                         FunctionTypeValues.end(), Ty);
34     if (I != FunctionTypeValues.end()) {
35       Slot = FirstDerivedTyID+ModuleTypeValues.size()+
36              (&*I - &FunctionTypeValues[0]);
37     } else {
38       I = find(ModuleTypeValues.begin(), ModuleTypeValues.end(), Ty);
39       if (I == ModuleTypeValues.end()) return true;   // Didn't find type!
40       Slot = FirstDerivedTyID + (&*I - &ModuleTypeValues[0]);
41     }
42   }
43   //cerr << "getTypeSlot '" << Ty->getName() << "' = " << Slot << "\n";
44   return false;
45 }
46
47 const Type *BytecodeParser::getType(unsigned ID) {
48   if (ID < Type::NumPrimitiveIDs) {
49     const Type *T = Type::getPrimitiveType((Type::PrimitiveID)ID);
50     if (T) return T;
51   }
52   
53   //cerr << "Looking up Type ID: " << ID << "\n";
54   const Value *V = getValue(Type::TypeTy, ID, false);
55   return cast_or_null<Type>(V);
56 }
57
58 int BytecodeParser::insertValue(Value *Val, ValueTable &ValueTab) {
59   assert((!HasImplicitZeroInitializer || !isa<Constant>(Val) ||
60           Val->getType()->isPrimitiveType() ||
61           !cast<Constant>(Val)->isNullValue()) &&
62          "Cannot read null values from bytecode!");
63   unsigned type;
64   if (getTypeSlot(Val->getType(), type)) return -1;
65   assert(type != Type::TypeTyID && "Types should never be insertValue'd!");
66  
67   if (ValueTab.size() <= type) {
68     unsigned OldSize = ValueTab.size();
69     ValueTab.resize(type+1);
70     while (OldSize != type+1)
71       ValueTab[OldSize++] = new ValueList();
72   }
73
74   //cerr << "insertValue Values[" << type << "][" << ValueTab[type].size() 
75   //     << "] = " << Val << "\n";
76   ValueTab[type]->push_back(Val);
77
78   bool HasOffset = HasImplicitZeroInitializer &&
79                        !Val->getType()->isPrimitiveType();
80
81   return ValueTab[type]->size()-1 + HasOffset;
82 }
83
84
85 void BytecodeParser::setValueTo(ValueTable &ValueTab, unsigned Slot,
86                                 Value *Val) {
87   assert(&ValueTab == &ModuleValues && "Can only setValueTo on Module values!");
88   unsigned type;
89   if (getTypeSlot(Val->getType(), type))
90     assert(0 && "getTypeSlot failed!");
91   
92   assert((!HasImplicitZeroInitializer || Slot != 0) &&
93          "Cannot change zero init");
94   assert(type < ValueTab.size() && Slot <= ValueTab[type]->size());
95   ValueTab[type]->setOperand(Slot-HasImplicitZeroInitializer, Val);
96 }
97
98 Value *BytecodeParser::getValue(const Type *Ty, unsigned oNum, bool Create) {
99   unsigned Num = oNum;
100   unsigned type;   // The type plane it lives in...
101
102   if (getTypeSlot(Ty, type)) return 0;
103
104   if (type == Type::TypeTyID) {  // The 'type' plane has implicit values
105     assert(Create == false);
106     if (Num < Type::NumPrimitiveIDs) {
107       const Type *T = Type::getPrimitiveType((Type::PrimitiveID)Num);
108       if (T) return (Value*)T;   // Asked for a primitive type...
109     }
110
111     // Otherwise, derived types need offset...
112     Num -= FirstDerivedTyID;
113
114     // Is it a module level type?
115     if (Num < ModuleTypeValues.size())
116       return (Value*)ModuleTypeValues[Num].get();
117
118     // Nope, is it a function level type?
119     Num -= ModuleTypeValues.size();
120     if (Num < FunctionTypeValues.size())
121       return (Value*)FunctionTypeValues[Num].get();
122
123     return 0;
124   }
125
126   if (HasImplicitZeroInitializer && type >= FirstDerivedTyID) {
127     if (Num == 0)
128       return Constant::getNullValue(Ty);
129     --Num;
130   }
131
132   if (type < ModuleValues.size()) {
133     if (Num < ModuleValues[type]->size())
134       return ModuleValues[type]->getOperand(Num);
135     Num -= ModuleValues[type]->size();
136   }
137
138   if (Values.size() > type && Values[type]->size() > Num)
139     return Values[type]->getOperand(Num);
140
141   if (!Create) return 0;  // Do not create a placeholder?
142
143   Value *d = 0;
144   switch (Ty->getPrimitiveID()) {
145   case Type::LabelTyID:
146     d = new BBPHolder(Ty, oNum);
147     break;
148   default:
149     d = new ValPHolder(Ty, oNum);
150     break;
151   }
152
153   assert(d != 0 && "How did we not make something?");
154   if (insertValue(d, LateResolveValues) == -1) return 0;
155   return d;
156 }
157
158 /// getConstantValue - Just like getValue, except that it returns a null pointer
159 /// only on error.  It always returns a constant (meaning that if the value is
160 /// defined, but is not a constant, that is an error).  If the specified
161 /// constant hasn't been parsed yet, a placeholder is defined and used.  Later,
162 /// after the real value is parsed, the placeholder is eliminated.
163 ///
164 Constant *BytecodeParser::getConstantValue(const Type *Ty, unsigned Slot) {
165   if (Value *V = getValue(Ty, Slot, false))
166     return dyn_cast<Constant>(V);      // If we already have the value parsed...
167
168   std::pair<const Type*, unsigned> Key(Ty, Slot);
169   GlobalRefsType::iterator I = GlobalRefs.lower_bound(Key);
170
171   if (I != GlobalRefs.end() && I->first == Key) {
172     BCR_TRACE(5, "Previous forward ref found!\n");
173     return cast<Constant>(I->second);
174   } else {
175     // Create a placeholder for the constant reference and
176     // keep track of the fact that we have a forward ref to recycle it
177     BCR_TRACE(5, "Creating new forward ref to a constant!\n");
178     Constant *C = new ConstPHolder(Ty, Slot);
179     
180     // Keep track of the fact that we have a forward ref to recycle it
181     GlobalRefs.insert(I, std::make_pair(Key, C));
182     return C;
183   }
184 }
185
186
187 bool BytecodeParser::postResolveValues(ValueTable &ValTab) {
188   bool Error = false;
189   while (!ValTab.empty()) {
190     ValueList &DL = *ValTab.back();
191     ValTab.pop_back();    
192
193     while (!DL.empty()) {
194       Value *D = DL.back();
195       unsigned IDNumber = getValueIDNumberFromPlaceHolder(D);
196       DL.pop_back();
197
198       Value *NewDef = getValue(D->getType(), IDNumber, false);
199       if (NewDef == 0) {
200         Error = true;  // Unresolved thinger
201         std::cerr << "Unresolvable reference found: <"
202                   << *D->getType() << ">:" << IDNumber <<"!\n";
203       } else {
204         // Fixup all of the uses of this placeholder def...
205         D->replaceAllUsesWith(NewDef);
206
207         // Now that all the uses are gone, delete the placeholder...
208         // If we couldn't find a def (error case), then leak a little
209         delete D;  // memory, 'cause otherwise we can't remove all uses!
210       }
211     }
212     delete &DL;
213   }
214
215   return Error;
216 }
217
218 bool BytecodeParser::ParseBasicBlock(const unsigned char *&Buf,
219                                      const unsigned char *EndBuf, 
220                                      BasicBlock *&BB) {
221   BB = new BasicBlock();
222
223   while (Buf < EndBuf) {
224     Instruction *Inst;
225     if (ParseInstruction(Buf, EndBuf, Inst, /*HACK*/BB)) {
226       delete BB;
227       return true;
228     }
229
230     if (Inst == 0) { delete BB; return true; }
231     if (insertValue(Inst, Values) == -1) { delete BB; return true; }
232
233     BB->getInstList().push_back(Inst);
234
235     BCR_TRACE(4, Inst);
236   }
237
238   return false;
239 }
240
241 bool BytecodeParser::ParseSymbolTable(const unsigned char *&Buf,
242                                       const unsigned char *EndBuf,
243                                       SymbolTable *ST) {
244   while (Buf < EndBuf) {
245     // Symtab block header: [num entries][type id number]
246     unsigned NumEntries, Typ;
247     if (read_vbr(Buf, EndBuf, NumEntries) ||
248         read_vbr(Buf, EndBuf, Typ)) return true;
249     const Type *Ty = getType(Typ);
250     if (Ty == 0) return true;
251
252     BCR_TRACE(3, "Plane Type: '" << Ty << "' with " << NumEntries <<
253               " entries\n");
254
255     for (unsigned i = 0; i < NumEntries; ++i) {
256       // Symtab entry: [def slot #][name]
257       unsigned slot;
258       if (read_vbr(Buf, EndBuf, slot)) return true;
259       std::string Name;
260       if (read(Buf, EndBuf, Name, false))  // Not aligned...
261         return true;
262
263       Value *V = getValue(Ty, slot, false); // Find mapping...
264       if (V == 0) {
265         BCR_TRACE(3, "FAILED LOOKUP: Slot #" << slot << "\n");
266         return true;
267       }
268       BCR_TRACE(4, "Map: '" << Name << "' to #" << slot << ":" << *V;
269                 if (!isa<Instruction>(V)) std::cerr << "\n");
270
271       V->setName(Name, ST);
272     }
273   }
274
275   if (Buf > EndBuf) return true;
276   return false;
277 }
278
279 void BytecodeParser::ResolveReferencesToValue(Value *NewV, unsigned Slot) {
280   GlobalRefsType::iterator I = GlobalRefs.find(std::make_pair(NewV->getType(),
281                                                               Slot));
282   if (I == GlobalRefs.end()) return;   // Never forward referenced?
283
284   BCR_TRACE(3, "Mutating forward refs!\n");
285   Value *VPH = I->second;   // Get the placeholder...
286
287   VPH->replaceAllUsesWith(NewV);
288
289   // If this is a global variable being resolved, remove the placeholder from
290   // the module...
291   if (GlobalValue* GVal = dyn_cast<GlobalValue>(NewV))
292     GVal->getParent()->getGlobalList().remove(cast<GlobalVariable>(VPH));
293
294   delete VPH;                         // Delete the old placeholder
295   GlobalRefs.erase(I);                // Remove the map entry for it
296 }
297
298
299 bool BytecodeParser::ParseFunction(const unsigned char *&Buf,
300                                    const unsigned char *EndBuf) {
301   // Clear out the local values table...
302   if (FunctionSignatureList.empty()) {
303     Error = "Function found, but FunctionSignatureList empty!";
304     return true;  // Unexpected function!
305   }
306
307   GlobalValue::LinkageTypes Linkage = GlobalValue::ExternalLinkage;
308
309   if (!hasInternalMarkerOnly) {
310     unsigned LinkageType;
311     if (read_vbr(Buf, EndBuf, LinkageType)) return true;
312     if (LinkageType & ~0x3) return true;
313     Linkage = (GlobalValue::LinkageTypes)LinkageType;
314   } else {
315     // We used to only support two linkage models: internal and external
316     unsigned isInternal;
317     if (read_vbr(Buf, EndBuf, isInternal)) return true;
318     if (isInternal) Linkage = GlobalValue::InternalLinkage;
319   }
320
321   Function *F = FunctionSignatureList.back().first;
322   unsigned FunctionSlot = FunctionSignatureList.back().second;
323   FunctionSignatureList.pop_back();
324   F->setLinkage(Linkage);
325
326   const FunctionType::ParamTypes &Params =F->getFunctionType()->getParamTypes();
327   Function::aiterator AI = F->abegin();
328   for (FunctionType::ParamTypes::const_iterator It = Params.begin();
329        It != Params.end(); ++It, ++AI) {
330     if (insertValue(AI, Values) == -1) {
331       Error = "Error reading function arguments!\n";
332       return true; 
333     }
334   }
335
336   while (Buf < EndBuf) {
337     unsigned Type, Size;
338     const unsigned char *OldBuf = Buf;
339     if (readBlock(Buf, EndBuf, Type, Size)) {
340       Error = "Error reading Function level block!";
341       return true; 
342     }
343
344     switch (Type) {
345     case BytecodeFormat::ConstantPool:
346       BCR_TRACE(2, "BLOCK BytecodeFormat::ConstantPool: {\n");
347       if (ParseConstantPool(Buf, Buf+Size, Values, FunctionTypeValues))
348         return true;
349       break;
350
351     case BytecodeFormat::BasicBlock: {
352       BCR_TRACE(2, "BLOCK BytecodeFormat::BasicBlock: {\n");
353       BasicBlock *BB;
354       if (ParseBasicBlock(Buf, Buf+Size, BB) ||
355           insertValue(BB, Values) == -1)
356         return true;                // Parse error... :(
357
358       F->getBasicBlockList().push_back(BB);
359       break;
360     }
361
362     case BytecodeFormat::SymbolTable:
363       BCR_TRACE(2, "BLOCK BytecodeFormat::SymbolTable: {\n");
364       if (ParseSymbolTable(Buf, Buf+Size, &F->getSymbolTable()))
365         return true;
366       break;
367
368     default:
369       BCR_TRACE(2, "BLOCK <unknown>:ignored! {\n");
370       Buf += Size;
371       if (OldBuf > Buf) return true; // Wrap around!
372       break;
373     }
374     BCR_TRACE(2, "} end block\n");
375
376     if (align32(Buf, EndBuf)) {
377       Error = "Error aligning Function level block!";
378       return true;   // Malformed bc file, read past end of block.
379     }
380   }
381
382   if (postResolveValues(LateResolveValues)) {
383     Error = "Error resolving function values!";
384     return true;     // Unresolvable references!
385   }
386
387   ResolveReferencesToValue(F, FunctionSlot);
388
389   // Clear out function level types...
390   FunctionTypeValues.clear();
391
392   freeTable(Values);
393   return false;
394 }
395
396 bool BytecodeParser::ParseModuleGlobalInfo(const unsigned char *&Buf,
397                                            const unsigned char *End){
398   if (!FunctionSignatureList.empty()) {
399     Error = "Two ModuleGlobalInfo packets found!";
400     return true;  // Two ModuleGlobal blocks?
401   }
402
403   // Read global variables...
404   unsigned VarType;
405   if (read_vbr(Buf, End, VarType)) return true;
406   while (VarType != Type::VoidTyID) { // List is terminated by Void
407     unsigned SlotNo;
408     GlobalValue::LinkageTypes Linkage;
409
410     if (!hasInternalMarkerOnly) {
411       // VarType Fields: bit0 = isConstant, bit1 = hasInitializer,
412       // bit2,3 = Linkage, bit4+ = slot#
413       SlotNo = VarType >> 4;
414       Linkage = (GlobalValue::LinkageTypes)((VarType >> 2) & 3);
415     } else {
416       // VarType Fields: bit0 = isConstant, bit1 = hasInitializer,
417       // bit2 = isInternal, bit3+ = slot#
418       SlotNo = VarType >> 3;
419       Linkage = (VarType & 4) ? GlobalValue::InternalLinkage :
420         GlobalValue::ExternalLinkage;
421     }
422
423     const Type *Ty = getType(SlotNo);
424     if (!Ty || !isa<PointerType>(Ty)) { 
425       Error = "Global not pointer type!  Ty = " + Ty->getDescription();
426       return true; 
427     }
428
429     const Type *ElTy = cast<PointerType>(Ty)->getElementType();
430
431     // Create the global variable...
432     GlobalVariable *GV = new GlobalVariable(ElTy, VarType & 1, Linkage,
433                                             0, "", TheModule);
434     int DestSlot = insertValue(GV, ModuleValues);
435     if (DestSlot == -1) return true;
436     BCR_TRACE(2, "Global Variable of type: " << *Ty << "\n");
437     ResolveReferencesToValue(GV, (unsigned)DestSlot);
438
439     if (VarType & 2) { // Does it have an initalizer?
440       unsigned InitSlot;
441       if (read_vbr(Buf, End, InitSlot)) return true;
442       GlobalInits.push_back(std::make_pair(GV, InitSlot));
443     }
444     if (read_vbr(Buf, End, VarType)) return true;
445   }
446
447   // Read the function objects for all of the functions that are coming
448   unsigned FnSignature;
449   if (read_vbr(Buf, End, FnSignature)) return true;
450   while (FnSignature != Type::VoidTyID) { // List is terminated by Void
451     const Type *Ty = getType(FnSignature);
452     if (!Ty || !isa<PointerType>(Ty) ||
453         !isa<FunctionType>(cast<PointerType>(Ty)->getElementType())) { 
454       Error = "Function not ptr to func type!  Ty = " + Ty->getDescription();
455       return true; 
456     }
457
458     // We create functions by passing the underlying FunctionType to create...
459     Ty = cast<PointerType>(Ty)->getElementType();
460
461     // When the ModuleGlobalInfo section is read, we load the type of each
462     // function and the 'ModuleValues' slot that it lands in.  We then load a
463     // placeholder into its slot to reserve it.  When the function is loaded,
464     // this placeholder is replaced.
465
466     // Insert the placeholder...
467     Function *Func = new Function(cast<FunctionType>(Ty),
468                                   GlobalValue::InternalLinkage, "", TheModule);
469     int DestSlot = insertValue(Func, ModuleValues);
470     if (DestSlot == -1) return true;
471     ResolveReferencesToValue(Func, (unsigned)DestSlot);
472
473     // Keep track of this information in a list that is emptied as functions are
474     // loaded...
475     //
476     FunctionSignatureList.push_back(std::make_pair(Func, DestSlot));
477
478     if (read_vbr(Buf, End, FnSignature)) return true;
479     BCR_TRACE(2, "Function of type: " << Ty << "\n");
480   }
481
482   if (align32(Buf, End)) return true;
483
484   // Now that the function signature list is set up, reverse it so that we can 
485   // remove elements efficiently from the back of the vector.
486   std::reverse(FunctionSignatureList.begin(), FunctionSignatureList.end());
487
488   // This is for future proofing... in the future extra fields may be added that
489   // we don't understand, so we transparently ignore them.
490   //
491   Buf = End;
492   return false;
493 }
494
495 bool BytecodeParser::ParseVersionInfo(const unsigned char *&Buf,
496                                       const unsigned char *EndBuf) {
497   unsigned Version;
498   if (read_vbr(Buf, EndBuf, Version)) return true;
499
500   // Unpack version number: low four bits are for flags, top bits = version
501   isBigEndian     = Version & 1;
502   hasLongPointers = Version & 2;
503   RevisionNum     = Version >> 4;
504
505   // Default values for the current bytecode version
506   HasImplicitZeroInitializer = true;
507   hasInternalMarkerOnly = false;
508   FirstDerivedTyID = 14;
509
510   switch (RevisionNum) {
511   case 0:                  // Initial revision
512     // Version #0 didn't have any of the flags stored correctly, and in fact as
513     // only valid with a 14 in the flags values.  Also, it does not support
514     // encoding zero initializers for arrays compactly.
515     //
516     if (Version != 14) return true;  // Unknown revision 0 flags?
517     HasImplicitZeroInitializer = false;
518     isBigEndian = hasLongPointers = true;
519     hasInternalMarkerOnly = true;
520     break;
521   case 1:
522     // Version #1 has two bit fields: isBigEndian and hasLongPointers
523     hasInternalMarkerOnly = true;
524     break;
525   case 2:
526     // Version #2 added information about all 4 linkage types instead of just
527     // having internal and external.
528     break;
529   default:
530     Error = "Unknown bytecode version number!";
531     return true;
532   }
533
534   TheModule->setEndianness(isBigEndian ? Module::BigEndian :
535                                          Module::LittleEndian);
536   TheModule->setPointerSize(hasLongPointers ? Module::Pointer64 : 
537                                               Module::Pointer32);
538
539   BCR_TRACE(1, "Bytecode Rev = " << (unsigned)RevisionNum << "\n");
540   BCR_TRACE(1, "BigEndian/LongPointers = " << isBigEndian << ","
541                << hasLongPointers << "\n");
542   BCR_TRACE(1, "HasImplicitZeroInit = " << HasImplicitZeroInitializer << "\n");
543   return false;
544 }
545
546 bool BytecodeParser::ParseModule(const unsigned char *Buf,
547                                  const unsigned char *EndBuf) {
548   unsigned Type, Size;
549   if (readBlock(Buf, EndBuf, Type, Size)) return true;
550   if (Type != BytecodeFormat::Module || Buf+Size != EndBuf) {
551     Error = "Expected Module packet!";
552     return true;                      // Hrm, not a class?
553   }
554
555   BCR_TRACE(0, "BLOCK BytecodeFormat::Module: {\n");
556   FunctionSignatureList.clear();                 // Just in case...
557
558   // Read into instance variables...
559   if (ParseVersionInfo(Buf, EndBuf)) return true;
560   if (align32(Buf, EndBuf)) return true;
561
562   while (Buf < EndBuf) {
563     const unsigned char *OldBuf = Buf;
564     if (readBlock(Buf, EndBuf, Type, Size)) return true;
565     switch (Type) {
566     case BytecodeFormat::GlobalTypePlane:
567       BCR_TRACE(1, "BLOCK BytecodeFormat::GlobalTypePlane: {\n");
568       if (ParseGlobalTypes(Buf, Buf+Size)) return true;
569       break;
570
571     case BytecodeFormat::ModuleGlobalInfo:
572       BCR_TRACE(1, "BLOCK BytecodeFormat::ModuleGlobalInfo: {\n");
573       if (ParseModuleGlobalInfo(Buf, Buf+Size)) return true;
574       break;
575
576     case BytecodeFormat::ConstantPool:
577       BCR_TRACE(1, "BLOCK BytecodeFormat::ConstantPool: {\n");
578       if (ParseConstantPool(Buf, Buf+Size, ModuleValues, ModuleTypeValues))
579         return true;
580       break;
581
582     case BytecodeFormat::Function: {
583       BCR_TRACE(1, "BLOCK BytecodeFormat::Function: {\n");
584       if (ParseFunction(Buf, Buf+Size))
585         return true;  // Error parsing function
586       break;
587     }
588
589     case BytecodeFormat::SymbolTable:
590       BCR_TRACE(1, "BLOCK BytecodeFormat::SymbolTable: {\n");
591       if (ParseSymbolTable(Buf, Buf+Size, &TheModule->getSymbolTable()))
592         return true;
593       break;
594
595     default:
596       Error = "Expected Module Block!";
597       Buf += Size;
598       if (OldBuf > Buf) return true; // Wrap around!
599       break;
600     }
601     BCR_TRACE(1, "} end block\n");
602     if (align32(Buf, EndBuf)) return true;
603   }
604
605   // After the module constant pool has been read, we can safely initialize
606   // global variables...
607   while (!GlobalInits.empty()) {
608     GlobalVariable *GV = GlobalInits.back().first;
609     unsigned Slot = GlobalInits.back().second;
610     GlobalInits.pop_back();
611
612     // Look up the initializer value...
613     if (Value *V = getValue(GV->getType()->getElementType(), Slot, false)) {
614       if (GV->hasInitializer()) return true;
615       GV->setInitializer(cast<Constant>(V));
616     } else
617       return true;
618   }
619
620   if (!FunctionSignatureList.empty()) {     // Expected more functions!
621     Error = "Function expected, but bytecode stream at end!";
622     return true;
623   }
624
625   BCR_TRACE(0, "} end block\n\n");
626   return false;
627 }
628
629 static inline Module *Error(std::string *ErrorStr, const char *Message) {
630   if (ErrorStr) *ErrorStr = Message;
631   return 0;
632 }
633
634 Module *BytecodeParser::ParseBytecode(const unsigned char *Buf,
635                                       const unsigned char *EndBuf,
636                                       const std::string &ModuleID) {
637   unsigned Sig;
638   // Read and check signature...
639   if (read(Buf, EndBuf, Sig) ||
640       Sig != ('l' | ('l' << 8) | ('v' << 16) | 'm' << 24))
641     return ::Error(&Error, "Invalid bytecode signature!");
642
643   TheModule = new Module(ModuleID);
644   if (ParseModule(Buf, EndBuf)) {
645     freeState();       // Must destroy handles before deleting module!
646     delete TheModule;
647     TheModule = 0;
648   }
649   return TheModule;
650 }
651
652
653 Module *ParseBytecodeBuffer(const unsigned char *Buffer, unsigned Length,
654                             const std::string &ModuleID, std::string *ErrorStr){
655   BytecodeParser Parser;
656   unsigned char *PtrToDelete = 0;
657   if ((intptr_t)Buffer & 3) {         // If the buffer is not 4 byte aligned...
658     // Allocate a new buffer to hold the bytecode...
659     PtrToDelete = new unsigned char[Length+4];
660     unsigned Offset = 4-((intptr_t)PtrToDelete & 3);  // Make sure it's aligned
661     memcpy(PtrToDelete+Offset, Buffer, Length);       // Copy it over
662     Buffer = PtrToDelete+Offset;
663   }
664
665   Module *R = Parser.ParseBytecode(Buffer, Buffer+Length, ModuleID);
666   if (ErrorStr) *ErrorStr = Parser.getError();
667
668   delete [] PtrToDelete;   // Delete alignment buffer if necessary
669   return R;
670 }
671
672
673 /// FDHandle - Simple handle class to make sure a file descriptor gets closed
674 /// when the object is destroyed.
675 class FDHandle {
676   int FD;
677 public:
678   FDHandle(int fd) : FD(fd) {}
679   operator int() const { return FD; }
680   ~FDHandle() {
681     if (FD != -1) close(FD);
682   }
683 };
684
685 // Parse and return a class file...
686 //
687 Module *ParseBytecodeFile(const std::string &Filename, std::string *ErrorStr) {
688   Module *Result = 0;
689
690   if (Filename != std::string("-")) {        // Read from a file...
691     FDHandle FD = open(Filename.c_str(), O_RDONLY);
692     if (FD == -1)
693       return Error(ErrorStr, "Error opening file!");
694
695     // Stat the file to get its length...
696     struct stat StatBuf;
697     if (fstat(FD, &StatBuf) == -1 || StatBuf.st_size == 0)
698       return Error(ErrorStr, "Error stat'ing file!");
699
700     // mmap in the file all at once...
701     int Length = StatBuf.st_size;
702     unsigned char *Buffer = (unsigned char*)mmap(0, Length, PROT_READ, 
703                                                  MAP_PRIVATE, FD, 0);
704     if (Buffer == (unsigned char*)MAP_FAILED)
705       return Error(ErrorStr, "Error mmapping file!");
706
707     // Parse the bytecode we mmapped in
708     Result = ParseBytecodeBuffer(Buffer, Length, Filename, ErrorStr);
709
710     // Unmmap the bytecode...
711     munmap((char*)Buffer, Length);
712   } else {                              // Read from stdin
713     int BlockSize;
714     unsigned char Buffer[4096*4];
715     std::vector<unsigned char> FileData;
716
717     // Read in all of the data from stdin, we cannot mmap stdin...
718     while ((BlockSize = read(0 /*stdin*/, Buffer, 4096*4))) {
719       if (BlockSize == -1)
720         return Error(ErrorStr, "Error reading from stdin!");
721
722       FileData.insert(FileData.end(), Buffer, Buffer+BlockSize);
723     }
724
725     if (FileData.empty())
726       return Error(ErrorStr, "Standard Input empty!");
727
728 #define ALIGN_PTRS 0
729 #if ALIGN_PTRS
730     unsigned char *Buf =
731       (unsigned char*)mmap(0, FileData.size(), PROT_READ|PROT_WRITE, 
732                            MAP_PRIVATE|MAP_ANONYMOUS, -1, 0);
733     assert((Buf != (unsigned char*)-1) && "mmap returned error!");
734     memcpy(Buf, &FileData[0], FileData.size());
735 #else
736     unsigned char *Buf = &FileData[0];
737 #endif
738
739     Result = ParseBytecodeBuffer(Buf, FileData.size(), "<stdin>", ErrorStr);
740
741 #if ALIGN_PTRS
742     munmap((char*)Buf, FileData.size());   // Free mmap'd data area
743 #endif
744   }
745
746   return Result;
747 }