Maximally group commands. When all instructions within a command set have a
[oota-llvm.git] / utils / TableGen / AsmWriterEmitter.cpp
1 //===- AsmWriterEmitter.cpp - Generate an assembly writer -----------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This tablegen backend is emits an assembly printer for the current target.
11 // Note that this is currently fairly skeletal, but will grow over time.
12 //
13 //===----------------------------------------------------------------------===//
14
15 #include "AsmWriterEmitter.h"
16 #include "CodeGenTarget.h"
17 #include "Record.h"
18 #include "llvm/ADT/StringExtras.h"
19 #include "llvm/Support/Debug.h"
20 #include "llvm/Support/MathExtras.h"
21 #include <algorithm>
22 #include <ostream>
23 using namespace llvm;
24
25 static bool isIdentChar(char C) {
26   return (C >= 'a' && C <= 'z') ||
27          (C >= 'A' && C <= 'Z') ||
28          (C >= '0' && C <= '9') ||
29          C == '_';
30 }
31
32 namespace {
33   struct AsmWriterOperand {
34     enum { isLiteralTextOperand, isMachineInstrOperand } OperandType;
35
36     /// Str - For isLiteralTextOperand, this IS the literal text.  For
37     /// isMachineInstrOperand, this is the PrinterMethodName for the operand.
38     std::string Str;
39
40     /// MiOpNo - For isMachineInstrOperand, this is the operand number of the
41     /// machine instruction.
42     unsigned MIOpNo;
43     
44     /// MiModifier - For isMachineInstrOperand, this is the modifier string for
45     /// an operand, specified with syntax like ${opname:modifier}.
46     std::string MiModifier;
47
48     AsmWriterOperand(const std::string &LitStr)
49       : OperandType(isLiteralTextOperand), Str(LitStr) {}
50
51     AsmWriterOperand(const std::string &Printer, unsigned OpNo, 
52                      const std::string &Modifier) 
53       : OperandType(isMachineInstrOperand), Str(Printer), MIOpNo(OpNo),
54       MiModifier(Modifier) {}
55
56     bool operator!=(const AsmWriterOperand &Other) const {
57       if (OperandType != Other.OperandType || Str != Other.Str) return true;
58       if (OperandType == isMachineInstrOperand)
59         return MIOpNo != Other.MIOpNo || MiModifier != Other.MiModifier;
60       return false;
61     }
62     bool operator==(const AsmWriterOperand &Other) const {
63       return !operator!=(Other);
64     }
65     
66     /// getCode - Return the code that prints this operand.
67     std::string getCode() const;
68   };
69 }
70
71 namespace llvm {
72   struct AsmWriterInst {
73     std::vector<AsmWriterOperand> Operands;
74     const CodeGenInstruction *CGI;
75
76     AsmWriterInst(const CodeGenInstruction &CGI, unsigned Variant);
77
78     /// MatchesAllButOneOp - If this instruction is exactly identical to the
79     /// specified instruction except for one differing operand, return the
80     /// differing operand number.  Otherwise return ~0.
81     unsigned MatchesAllButOneOp(const AsmWriterInst &Other) const;
82
83   private:
84     void AddLiteralString(const std::string &Str) {
85       // If the last operand was already a literal text string, append this to
86       // it, otherwise add a new operand.
87       if (!Operands.empty() &&
88           Operands.back().OperandType == AsmWriterOperand::isLiteralTextOperand)
89         Operands.back().Str.append(Str);
90       else
91         Operands.push_back(AsmWriterOperand(Str));
92     }
93   };
94 }
95
96
97 std::string AsmWriterOperand::getCode() const {
98   if (OperandType == isLiteralTextOperand)
99     return "O << \"" + Str + "\"; ";
100
101   std::string Result = Str + "(MI, " + utostr(MIOpNo);
102   if (!MiModifier.empty())
103     Result += ", \"" + MiModifier + '"';
104   return Result + "); ";
105 }
106
107
108 /// ParseAsmString - Parse the specified Instruction's AsmString into this
109 /// AsmWriterInst.
110 ///
111 AsmWriterInst::AsmWriterInst(const CodeGenInstruction &CGI, unsigned Variant) {
112   this->CGI = &CGI;
113   unsigned CurVariant = ~0U;  // ~0 if we are outside a {.|.|.} region, other #.
114
115   // NOTE: Any extensions to this code need to be mirrored in the 
116   // AsmPrinter::printInlineAsm code that executes as compile time (assuming
117   // that inline asm strings should also get the new feature)!
118   const std::string &AsmString = CGI.AsmString;
119   std::string::size_type LastEmitted = 0;
120   while (LastEmitted != AsmString.size()) {
121     std::string::size_type DollarPos =
122       AsmString.find_first_of("${|}", LastEmitted);
123     if (DollarPos == std::string::npos) DollarPos = AsmString.size();
124
125     // Emit a constant string fragment.
126     if (DollarPos != LastEmitted) {
127       // TODO: this should eventually handle escaping.
128       if (CurVariant == Variant || CurVariant == ~0U)
129         AddLiteralString(std::string(AsmString.begin()+LastEmitted,
130                                      AsmString.begin()+DollarPos));
131       LastEmitted = DollarPos;
132     } else if (AsmString[DollarPos] == '{') {
133       if (CurVariant != ~0U)
134         throw "Nested variants found for instruction '" +
135               CGI.TheDef->getName() + "'!";
136       LastEmitted = DollarPos+1;
137       CurVariant = 0;   // We are now inside of the variant!
138     } else if (AsmString[DollarPos] == '|') {
139       if (CurVariant == ~0U)
140         throw "'|' character found outside of a variant in instruction '"
141           + CGI.TheDef->getName() + "'!";
142       ++CurVariant;
143       ++LastEmitted;
144     } else if (AsmString[DollarPos] == '}') {
145       if (CurVariant == ~0U)
146         throw "'}' character found outside of a variant in instruction '"
147           + CGI.TheDef->getName() + "'!";
148       ++LastEmitted;
149       CurVariant = ~0U;
150     } else if (DollarPos+1 != AsmString.size() &&
151                AsmString[DollarPos+1] == '$') {
152       if (CurVariant == Variant || CurVariant == ~0U) 
153         AddLiteralString("$");  // "$$" -> $
154       LastEmitted = DollarPos+2;
155     } else {
156       // Get the name of the variable.
157       std::string::size_type VarEnd = DollarPos+1;
158
159       // handle ${foo}bar as $foo by detecting whether the character following
160       // the dollar sign is a curly brace.  If so, advance VarEnd and DollarPos
161       // so the variable name does not contain the leading curly brace.
162       bool hasCurlyBraces = false;
163       if (VarEnd < AsmString.size() && '{' == AsmString[VarEnd]) {
164         hasCurlyBraces = true;
165         ++DollarPos;
166         ++VarEnd;
167       }
168
169       while (VarEnd < AsmString.size() && isIdentChar(AsmString[VarEnd]))
170         ++VarEnd;
171       std::string VarName(AsmString.begin()+DollarPos+1,
172                           AsmString.begin()+VarEnd);
173
174       // Modifier - Support ${foo:modifier} syntax, where "modifier" is passed
175       // into printOperand.
176       std::string Modifier;
177       
178       // In order to avoid starting the next string at the terminating curly
179       // brace, advance the end position past it if we found an opening curly
180       // brace.
181       if (hasCurlyBraces) {
182         if (VarEnd >= AsmString.size())
183           throw "Reached end of string before terminating curly brace in '"
184                 + CGI.TheDef->getName() + "'";
185         
186         // Look for a modifier string.
187         if (AsmString[VarEnd] == ':') {
188           ++VarEnd;
189           if (VarEnd >= AsmString.size())
190             throw "Reached end of string before terminating curly brace in '"
191               + CGI.TheDef->getName() + "'";
192           
193           unsigned ModifierStart = VarEnd;
194           while (VarEnd < AsmString.size() && isIdentChar(AsmString[VarEnd]))
195             ++VarEnd;
196           Modifier = std::string(AsmString.begin()+ModifierStart,
197                                  AsmString.begin()+VarEnd);
198           if (Modifier.empty())
199             throw "Bad operand modifier name in '"+ CGI.TheDef->getName() + "'";
200         }
201         
202         if (AsmString[VarEnd] != '}')
203           throw "Variable name beginning with '{' did not end with '}' in '"
204                 + CGI.TheDef->getName() + "'";
205         ++VarEnd;
206       }
207       if (VarName.empty())
208         throw "Stray '$' in '" + CGI.TheDef->getName() +
209               "' asm string, maybe you want $$?";
210
211       unsigned OpNo = CGI.getOperandNamed(VarName);
212       CodeGenInstruction::OperandInfo OpInfo = CGI.OperandList[OpNo];
213
214       // If this is a two-address instruction and we are not accessing the
215       // 0th operand, remove an operand.
216       unsigned MIOp = OpInfo.MIOperandNo;
217       if (CGI.isTwoAddress && MIOp != 0) {
218         if (MIOp == 1)
219           throw "Should refer to operand #0 instead of #1 for two-address"
220             " instruction '" + CGI.TheDef->getName() + "'!";
221         --MIOp;
222       }
223
224       if (CurVariant == Variant || CurVariant == ~0U) 
225         Operands.push_back(AsmWriterOperand(OpInfo.PrinterMethodName, MIOp,
226                                             Modifier));
227       LastEmitted = VarEnd;
228     }
229   }
230
231   AddLiteralString("\\n");
232 }
233
234 /// MatchesAllButOneOp - If this instruction is exactly identical to the
235 /// specified instruction except for one differing operand, return the differing
236 /// operand number.  If more than one operand mismatches, return ~1, otherwise
237 /// if the instructions are identical return ~0.
238 unsigned AsmWriterInst::MatchesAllButOneOp(const AsmWriterInst &Other)const{
239   if (Operands.size() != Other.Operands.size()) return ~1;
240
241   unsigned MismatchOperand = ~0U;
242   for (unsigned i = 0, e = Operands.size(); i != e; ++i) {
243     if (Operands[i] != Other.Operands[i])
244       if (MismatchOperand != ~0U)  // Already have one mismatch?
245         return ~1U;
246       else
247         MismatchOperand = i;
248   }
249   return MismatchOperand;
250 }
251
252 static void PrintCases(std::vector<std::pair<std::string,
253                        AsmWriterOperand> > &OpsToPrint, std::ostream &O) {
254   O << "    case " << OpsToPrint.back().first << ": ";
255   AsmWriterOperand TheOp = OpsToPrint.back().second;
256   OpsToPrint.pop_back();
257
258   // Check to see if any other operands are identical in this list, and if so,
259   // emit a case label for them.
260   for (unsigned i = OpsToPrint.size(); i != 0; --i)
261     if (OpsToPrint[i-1].second == TheOp) {
262       O << "\n    case " << OpsToPrint[i-1].first << ": ";
263       OpsToPrint.erase(OpsToPrint.begin()+i-1);
264     }
265
266   // Finally, emit the code.
267   O << TheOp.getCode();
268   O << "break;\n";
269 }
270
271
272 /// EmitInstructions - Emit the last instruction in the vector and any other
273 /// instructions that are suitably similar to it.
274 static void EmitInstructions(std::vector<AsmWriterInst> &Insts,
275                              std::ostream &O) {
276   AsmWriterInst FirstInst = Insts.back();
277   Insts.pop_back();
278
279   std::vector<AsmWriterInst> SimilarInsts;
280   unsigned DifferingOperand = ~0;
281   for (unsigned i = Insts.size(); i != 0; --i) {
282     unsigned DiffOp = Insts[i-1].MatchesAllButOneOp(FirstInst);
283     if (DiffOp != ~1U) {
284       if (DifferingOperand == ~0U)  // First match!
285         DifferingOperand = DiffOp;
286
287       // If this differs in the same operand as the rest of the instructions in
288       // this class, move it to the SimilarInsts list.
289       if (DifferingOperand == DiffOp || DiffOp == ~0U) {
290         SimilarInsts.push_back(Insts[i-1]);
291         Insts.erase(Insts.begin()+i-1);
292       }
293     }
294   }
295
296   O << "  case " << FirstInst.CGI->Namespace << "::"
297     << FirstInst.CGI->TheDef->getName() << ":\n";
298   for (unsigned i = 0, e = SimilarInsts.size(); i != e; ++i)
299     O << "  case " << SimilarInsts[i].CGI->Namespace << "::"
300       << SimilarInsts[i].CGI->TheDef->getName() << ":\n";
301   for (unsigned i = 0, e = FirstInst.Operands.size(); i != e; ++i) {
302     if (i != DifferingOperand) {
303       // If the operand is the same for all instructions, just print it.
304       O << "    " << FirstInst.Operands[i].getCode();
305     } else {
306       // If this is the operand that varies between all of the instructions,
307       // emit a switch for just this operand now.
308       O << "    switch (MI->getOpcode()) {\n";
309       std::vector<std::pair<std::string, AsmWriterOperand> > OpsToPrint;
310       OpsToPrint.push_back(std::make_pair(FirstInst.CGI->Namespace + "::" +
311                                           FirstInst.CGI->TheDef->getName(),
312                                           FirstInst.Operands[i]));
313
314       for (unsigned si = 0, e = SimilarInsts.size(); si != e; ++si) {
315         AsmWriterInst &AWI = SimilarInsts[si];
316         OpsToPrint.push_back(std::make_pair(AWI.CGI->Namespace+"::"+
317                                             AWI.CGI->TheDef->getName(),
318                                             AWI.Operands[i]));
319       }
320       std::reverse(OpsToPrint.begin(), OpsToPrint.end());
321       while (!OpsToPrint.empty())
322         PrintCases(OpsToPrint, O);
323       O << "    }";
324     }
325     O << "\n";
326   }
327
328   O << "    break;\n";
329 }
330
331 void AsmWriterEmitter::
332 FindUniqueOperandCommands(std::vector<std::string> &UniqueOperandCommands, 
333                           std::vector<unsigned> &InstIdxs,
334                           std::vector<unsigned> &InstOpsUsed) const {
335   InstIdxs.assign(NumberedInstructions.size(), 0);
336   
337   // This vector parallels UniqueOperandCommands, keeping track of which
338   // instructions each case are used for.  It is a comma separated string of
339   // enums.
340   std::vector<std::string> InstrsForCase;
341   InstrsForCase.resize(UniqueOperandCommands.size());
342   InstOpsUsed.assign(UniqueOperandCommands.size(), 0);
343   
344   for (unsigned i = 0, e = NumberedInstructions.size(); i != e; ++i) {
345     const AsmWriterInst *Inst = getAsmWriterInstByID(i);
346     if (Inst == 0) continue;  // PHI, INLINEASM, etc.
347     
348     std::string Command;
349     if (Inst->Operands.empty())
350       continue;   // Instruction already done.
351
352     Command = "    " + Inst->Operands[0].getCode() + "\n";
353
354     // If this is the last operand, emit a return.
355     if (Inst->Operands.size() == 1)
356       Command += "    return true;\n";
357     
358     // Check to see if we already have 'Command' in UniqueOperandCommands.
359     // If not, add it.
360     bool FoundIt = false;
361     for (unsigned idx = 0, e = UniqueOperandCommands.size(); idx != e; ++idx)
362       if (UniqueOperandCommands[idx] == Command) {
363         InstIdxs[i] = idx;
364         InstrsForCase[idx] += ", ";
365         InstrsForCase[idx] += Inst->CGI->TheDef->getName();
366         FoundIt = true;
367         break;
368       }
369     if (!FoundIt) {
370       InstIdxs[i] = UniqueOperandCommands.size();
371       UniqueOperandCommands.push_back(Command);
372       InstrsForCase.push_back(Inst->CGI->TheDef->getName());
373
374       // This command matches one operand so far.
375       InstOpsUsed.push_back(1);
376     }
377   }
378   
379   // For each entry of UniqueOperandCommands, there is a set of instructions
380   // that uses it.  If the next command of all instructions in the set are
381   // identical, fold it into the command.
382   for (unsigned CommandIdx = 0, e = UniqueOperandCommands.size();
383        CommandIdx != e; ++CommandIdx) {
384     
385     for (unsigned Op = 1; ; ++Op) {
386       // Scan for the first instruction in the set.
387       std::vector<unsigned>::iterator NIT =
388         std::find(InstIdxs.begin(), InstIdxs.end(), CommandIdx);
389       if (NIT == InstIdxs.end()) break;  // No commonality.
390
391       // If this instruction has no more operands, we isn't anything to merge
392       // into this command.
393       const AsmWriterInst *FirstInst = 
394         getAsmWriterInstByID(NIT-InstIdxs.begin());
395       if (!FirstInst || FirstInst->Operands.size() == Op)
396         break;
397
398       // Otherwise, scan to see if all of the other instructions in this command
399       // set share the operand.
400       bool AllSame = true;
401       
402       NIT = std::find(NIT+1, InstIdxs.end(), CommandIdx);
403       for (NIT = std::find(NIT+1, InstIdxs.end(), CommandIdx);
404            NIT != InstIdxs.end();
405            NIT = std::find(NIT+1, InstIdxs.end(), CommandIdx)) {
406         // Okay, found another instruction in this command set.  If the operand
407         // matches, we're ok, otherwise bail out.
408         const AsmWriterInst *OtherInst = 
409           getAsmWriterInstByID(NIT-InstIdxs.begin());
410         if (!OtherInst || OtherInst->Operands.size() == Op ||
411             OtherInst->Operands[Op] != FirstInst->Operands[Op]) {
412           AllSame = false;
413           break;
414         }
415       }
416       if (!AllSame) break;
417       
418       // Okay, everything in this command set has the same next operand.  Add it
419       // to UniqueOperandCommands and remember that it was consumed.
420       std::string Command = "    " + FirstInst->Operands[Op].getCode() + "\n";
421       
422       // If this is the last operand, emit a return after the code.
423       if (FirstInst->Operands.size() == Op+1)
424         Command += "    return true;\n";
425       
426       UniqueOperandCommands[CommandIdx] += Command;
427       InstOpsUsed[CommandIdx]++;
428     }
429   }
430   
431   // Prepend some of the instructions each case is used for onto the case val.
432   for (unsigned i = 0, e = InstrsForCase.size(); i != e; ++i) {
433     std::string Instrs = InstrsForCase[i];
434     if (Instrs.size() > 70) {
435       Instrs.erase(Instrs.begin()+70, Instrs.end());
436       Instrs += "...";
437     }
438     
439     if (!Instrs.empty())
440       UniqueOperandCommands[i] = "    // " + Instrs + "\n" + 
441         UniqueOperandCommands[i];
442   }
443 }
444
445
446
447 void AsmWriterEmitter::run(std::ostream &O) {
448   EmitSourceFileHeader("Assembly Writer Source Fragment", O);
449
450   CodeGenTarget Target;
451   Record *AsmWriter = Target.getAsmWriter();
452   std::string ClassName = AsmWriter->getValueAsString("AsmWriterClassName");
453   unsigned Variant = AsmWriter->getValueAsInt("Variant");
454
455   O <<
456   "/// printInstruction - This method is automatically generated by tablegen\n"
457   "/// from the instruction set description.  This method returns true if the\n"
458   "/// machine instruction was sufficiently described to print it, otherwise\n"
459   "/// it returns false.\n"
460     "bool " << Target.getName() << ClassName
461             << "::printInstruction(const MachineInstr *MI) {\n";
462
463   std::vector<AsmWriterInst> Instructions;
464
465   for (CodeGenTarget::inst_iterator I = Target.inst_begin(),
466          E = Target.inst_end(); I != E; ++I)
467     if (!I->second.AsmString.empty())
468       Instructions.push_back(AsmWriterInst(I->second, Variant));
469
470   // Get the instruction numbering.
471   Target.getInstructionsByEnumValue(NumberedInstructions);
472   
473   // Compute the CodeGenInstruction -> AsmWriterInst mapping.  Note that not
474   // all machine instructions are necessarily being printed, so there may be
475   // target instructions not in this map.
476   for (unsigned i = 0, e = Instructions.size(); i != e; ++i)
477     CGIAWIMap.insert(std::make_pair(Instructions[i].CGI, &Instructions[i]));
478
479   // Build an aggregate string, and build a table of offsets into it.
480   std::map<std::string, unsigned> StringOffset;
481   std::string AggregateString;
482   AggregateString += '\0';
483   
484   /// OpcodeInfo - Theis encodes the index of the string to use for the first
485   /// chunk of the output as well as indices used for operand printing.
486   std::vector<unsigned> OpcodeInfo;
487   
488   unsigned MaxStringIdx = 0;
489   for (unsigned i = 0, e = NumberedInstructions.size(); i != e; ++i) {
490     AsmWriterInst *AWI = CGIAWIMap[NumberedInstructions[i]];
491     unsigned Idx;
492     if (AWI == 0 || AWI->Operands[0].Str.empty()) {
493       // Something not handled by the asmwriter printer.
494       Idx = 0;
495     } else {
496       unsigned &Entry = StringOffset[AWI->Operands[0].Str];
497       if (Entry == 0) {
498         // Add the string to the aggregate if this is the first time found.
499         MaxStringIdx = Entry = AggregateString.size();
500         std::string Str = AWI->Operands[0].Str;
501         UnescapeString(Str);
502         AggregateString += Str;
503         AggregateString += '\0';
504       }
505       Idx = Entry;
506
507       // Nuke the string from the operand list.  It is now handled!
508       AWI->Operands.erase(AWI->Operands.begin());
509     }
510     OpcodeInfo.push_back(Idx);
511   }
512   
513   // Figure out how many bits we used for the string index.
514   unsigned AsmStrBits = Log2_32_Ceil(MaxStringIdx);
515   
516   // To reduce code size, we compactify common instructions into a few bits
517   // in the opcode-indexed table.
518   unsigned BitsLeft = 32-AsmStrBits;
519
520   std::vector<std::vector<std::string> > TableDrivenOperandPrinters;
521   
522   bool isFirst = true;
523   while (1) {
524     std::vector<std::string> UniqueOperandCommands;
525
526     // For the first operand check, add a default value that unhandled
527     // instructions will use.
528     if (isFirst) {
529       UniqueOperandCommands.push_back("    return false;\n");
530       isFirst = false;
531     }
532     
533     std::vector<unsigned> InstIdxs;
534     std::vector<unsigned> NumInstOpsHandled;
535     FindUniqueOperandCommands(UniqueOperandCommands, InstIdxs,
536                               NumInstOpsHandled);
537     
538     // If we ran out of operands to print, we're done.
539     if (UniqueOperandCommands.empty()) break;
540     
541     // Compute the number of bits we need to represent these cases, this is
542     // ceil(log2(numentries)).
543     unsigned NumBits = Log2_32_Ceil(UniqueOperandCommands.size());
544     
545     // If we don't have enough bits for this operand, don't include it.
546     if (NumBits > BitsLeft) {
547       DEBUG(std::cerr << "Not enough bits to densely encode " << NumBits
548                       << " more bits\n");
549       break;
550     }
551     
552     // Otherwise, we can include this in the initial lookup table.  Add it in.
553     BitsLeft -= NumBits;
554     for (unsigned i = 0, e = InstIdxs.size(); i != e; ++i)
555       OpcodeInfo[i] |= InstIdxs[i] << (BitsLeft+AsmStrBits);
556     
557     // Remove the info about this operand.
558     for (unsigned i = 0, e = NumberedInstructions.size(); i != e; ++i) {
559       if (AsmWriterInst *Inst = getAsmWriterInstByID(i))
560         if (!Inst->Operands.empty()) {
561           unsigned NumOps = NumInstOpsHandled[InstIdxs[i]];
562           Inst->Operands.erase(Inst->Operands.begin(),
563                                Inst->Operands.begin()+NumOps);
564         }
565     }
566     
567     // Remember the handlers for this set of operands.
568     TableDrivenOperandPrinters.push_back(UniqueOperandCommands);
569   }
570   
571   
572   
573   O<<"  static const unsigned OpInfo[] = {\n";
574   for (unsigned i = 0, e = NumberedInstructions.size(); i != e; ++i) {
575     O << "    " << OpcodeInfo[i] << "U,\t// "
576       << NumberedInstructions[i]->TheDef->getName() << "\n";
577   }
578   // Add a dummy entry so the array init doesn't end with a comma.
579   O << "    0U\n";
580   O << "  };\n\n";
581   
582   // Emit the string itself.
583   O << "  const char *AsmStrs = \n    \"";
584   unsigned CharsPrinted = 0;
585   EscapeString(AggregateString);
586   for (unsigned i = 0, e = AggregateString.size(); i != e; ++i) {
587     if (CharsPrinted > 70) {
588       O << "\"\n    \"";
589       CharsPrinted = 0;
590     }
591     O << AggregateString[i];
592     ++CharsPrinted;
593     
594     // Print escape sequences all together.
595     if (AggregateString[i] == '\\') {
596       assert(i+1 < AggregateString.size() && "Incomplete escape sequence!");
597       if (isdigit(AggregateString[i+1])) {
598         assert(isdigit(AggregateString[i+2]) && isdigit(AggregateString[i+3]) &&
599                "Expected 3 digit octal escape!");
600         O << AggregateString[++i];
601         O << AggregateString[++i];
602         O << AggregateString[++i];
603         CharsPrinted += 3;
604       } else {
605         O << AggregateString[++i];
606         ++CharsPrinted;
607       }
608     }
609   }
610   O << "\";\n\n";
611
612   O << "  if (MI->getOpcode() == TargetInstrInfo::INLINEASM) {\n"
613     << "    printInlineAsm(MI);\n"
614     << "    return true;\n"
615     << "  }\n\n";
616   
617   O << "  // Emit the opcode for the instruction.\n"
618     << "  unsigned Bits = OpInfo[MI->getOpcode()];\n"
619     << "  O << AsmStrs+(Bits & " << (1 << AsmStrBits)-1 << ");\n\n";
620
621   // Output the table driven operand information.
622   BitsLeft = 32-AsmStrBits;
623   for (unsigned i = 0, e = TableDrivenOperandPrinters.size(); i != e; ++i) {
624     std::vector<std::string> &Commands = TableDrivenOperandPrinters[i];
625
626     // Compute the number of bits we need to represent these cases, this is
627     // ceil(log2(numentries)).
628     unsigned NumBits = Log2_32_Ceil(Commands.size());
629     assert(NumBits <= BitsLeft && "consistency error");
630     
631     // Emit code to extract this field from Bits.
632     BitsLeft -= NumBits;
633     
634     O << "\n  // Fragment " << i << " encoded into " << NumBits
635       << " bits for " << Commands.size() << " unique commands.\n";
636     
637     if (Commands.size() == 2) {
638       // Emit two possibilitys with if/else.
639       O << "  if ((Bits >> " << (BitsLeft+AsmStrBits) << ") & "
640         << ((1 << NumBits)-1) << ") {\n"
641         << Commands[1]
642         << "  } else {\n"
643         << Commands[0]
644         << "  }\n\n";
645     } else {
646       O << "  switch ((Bits >> " << (BitsLeft+AsmStrBits) << ") & "
647         << ((1 << NumBits)-1) << ") {\n"
648         << "  default:   // unreachable.\n";
649       
650       // Print out all the cases.
651       for (unsigned i = 0, e = Commands.size(); i != e; ++i) {
652         O << "  case " << i << ":\n";
653         O << Commands[i];
654         O << "    break;\n";
655       }
656       O << "  }\n\n";
657     }
658   }
659   
660   // Okay, delete instructions with no operand info left.
661   for (unsigned i = 0, e = Instructions.size(); i != e; ++i) {
662     // Entire instruction has been emitted?
663     AsmWriterInst &Inst = Instructions[i];
664     if (Inst.Operands.empty()) {
665       Instructions.erase(Instructions.begin()+i);
666       --i; --e;
667     }
668   }
669
670     
671   // Because this is a vector, we want to emit from the end.  Reverse all of the
672   // elements in the vector.
673   std::reverse(Instructions.begin(), Instructions.end());
674   
675   if (!Instructions.empty()) {
676     // Find the opcode # of inline asm.
677     O << "  switch (MI->getOpcode()) {\n";
678     while (!Instructions.empty())
679       EmitInstructions(Instructions, O);
680
681     O << "  }\n";
682   }
683   
684   O << "  return true;\n"
685        "}\n";
686 }