[opaque pointer type] Add textual IR support for explicit type parameter to gep operator

[oota-llvm.git] / lib / IR / AsmWriter.cpp

diff --git a/lib/IR/AsmWriter.cpp b/lib/IR/AsmWriter.cpp
index 27f619b5eedd384b78773c5ca97fb2998b5b0267..5ab6953bdbd1b5391a1480710f2a8c1d80405aa8 100644 (file)
--- a/lib/IR/AsmWriter.cpp
+++ b/lib/IR/AsmWriter.cpp
@@ -1010,7 +1010,7 @@ static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
              (StrVal[1] >= '0' && StrVal[1] <= '9'))) {
           // Reparse stringized version!
           if (APFloat(APFloat::IEEEdouble, StrVal).convertToDouble() == Val) {
-            Out << StrVal.str();
+            Out << StrVal;
             return;
           }
         }
@@ -1223,6 +1223,14 @@ static void WriteConstantInternal(raw_ostream &Out, const Constant *CV,
       Out << ' ' << getPredicateText(CE->getPredicate());
     Out << " (";
 
+    if (const GEPOperator *GEP = dyn_cast<GEPOperator>(CE)) {
+      TypePrinter.print(
+          cast<PointerType>(GEP->getPointerOperandType()->getScalarType())
+              ->getElementType(),
+          Out);
+      Out << ", ";
+    }
+
     for (User::const_op_iterator OI=CE->op_begin(); OI != CE->op_end(); ++OI) {
       TypePrinter.print((*OI)->getType(), Out);
       Out << ' ';
@@ -1275,14 +1283,15 @@ static void writeMDTuple(raw_ostream &Out, const MDTuple *Node,
 namespace {
 struct FieldSeparator {
   bool Skip;
-  FieldSeparator() : Skip(true) {}
+  const char *Sep;
+  FieldSeparator(const char *Sep = ", ") : Skip(true), Sep(Sep) {}
 };
 raw_ostream &operator<<(raw_ostream &OS, FieldSeparator &FS) {
   if (FS.Skip) {
     FS.Skip = false;
     return OS;
   }
-  return OS << ", ";
+  return OS << FS.Sep;
 }
 } // end namespace
 
@@ -1305,17 +1314,24 @@ static void writeTag(raw_ostream &Out, FieldSeparator &FS, const DebugNode *N) {
     Out << N->getTag();
 }
 
+static void writeStringField(raw_ostream &Out, FieldSeparator &FS,
+                             StringRef Name, StringRef Value,
+                             bool ShouldSkipEmpty = true) {
+  if (ShouldSkipEmpty && Value.empty())
+    return;
+
+  Out << FS << Name << ": \"";
+  PrintEscapedString(Value, Out);
+  Out << "\"";
+}
+
 static void writeGenericDebugNode(raw_ostream &Out, const GenericDebugNode *N,
                                   TypePrinting *TypePrinter,
                                   SlotTracker *Machine, const Module *Context) {
   Out << "!GenericDebugNode(";
   FieldSeparator FS;
   writeTag(Out, FS, N);
-  if (!N->getHeader().empty()) {
-    Out << FS << "header: \"";
-    PrintEscapedString(N->getHeader(), Out);
-    Out << "\"";
-  }
+  writeStringField(Out, FS, "header", N->getHeader());
   if (N->getNumDwarfOperands()) {
     Out << FS << "operands: {";
     FieldSeparator IFS;
@@ -1361,8 +1377,8 @@ static void writeMDEnumerator(raw_ostream &Out, const MDEnumerator *N,
                               TypePrinting *, SlotTracker *, const Module *) {
   Out << "!MDEnumerator(";
   FieldSeparator FS;
+  writeStringField(Out, FS, "name", N->getName(), /* ShouldSkipEmpty */ false);
   Out << FS << "value: " << N->getValue();
-  Out << FS << "name: \"" << N->getName() << "\"";
   Out << ")";
 }
 
@@ -1370,9 +1386,9 @@ static void writeMDBasicType(raw_ostream &Out, const MDBasicType *N,
                              TypePrinting *, SlotTracker *, const Module *) {
   Out << "!MDBasicType(";
   FieldSeparator FS;
-  writeTag(Out, FS, N);
-  if (!N->getName().empty())
-    Out << FS << "name: \"" << N->getName() << "\"";
+  if (N->getTag() != dwarf::DW_TAG_base_type)
+    writeTag(Out, FS, N);
+  writeStringField(Out, FS, "name", N->getName());
   if (N->getSizeInBits())
     Out << FS << "size: " << N->getSizeInBits();
   if (N->getAlignInBits())
@@ -1387,14 +1403,31 @@ static void writeMDBasicType(raw_ostream &Out, const MDBasicType *N,
   Out << ")";
 }
 
+static void writeDIFlags(raw_ostream &Out, unsigned Flags) {
+  SmallVector<unsigned, 8> SplitFlags;
+  unsigned Extra = DIDescriptor::splitFlags(Flags, SplitFlags);
+
+  FieldSeparator FS(" | ");
+  for (unsigned F : SplitFlags) {
+    const char *StringF = DIDescriptor::getFlagString(F);
+    assert(StringF && "Expected valid flag");
+    Out << FS << StringF;
+  }
+  if (Extra || SplitFlags.empty())
+    Out << FS << Extra;
+}
+
 static void writeMDDerivedType(raw_ostream &Out, const MDDerivedType *N,
                                TypePrinting *TypePrinter, SlotTracker *Machine,
                                const Module *Context) {
   Out << "!MDDerivedType(";
   FieldSeparator FS;
   writeTag(Out, FS, N);
-  if (!N->getName().empty())
-    Out << FS << "name: \"" << N->getName() << "\"";
+  writeStringField(Out, FS, "name", N->getName());
+  if (N->getScope()) {
+    Out << FS << "scope: ";
+    writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
+  }
   if (N->getFile()) {
     Out << FS << "file: ";
     writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
@@ -1402,10 +1435,6 @@ static void writeMDDerivedType(raw_ostream &Out, const MDDerivedType *N,
   }
   if (N->getLine())
     Out << FS << "line: " << N->getLine();
-  if (N->getScope()) {
-    Out << FS << "scope: ";
-    writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
-  }
   Out << FS << "baseType: ";
   writeMetadataAsOperand(Out, N->getBaseType(), TypePrinter, Machine, Context);
   if (N->getSizeInBits())
@@ -1414,8 +1443,10 @@ static void writeMDDerivedType(raw_ostream &Out, const MDDerivedType *N,
     Out << FS << "align: " << N->getAlignInBits();
   if (N->getOffsetInBits())
     Out << FS << "offset: " << N->getOffsetInBits();
-  if (N->getFlags())
-    Out << FS << "flags: " << N->getFlags();
+  if (auto Flags = N->getFlags()) {
+    Out << FS << "flags: ";
+    writeDIFlags(Out, Flags);
+  }
   if (N->getExtraData()) {
     Out << FS << "extraData: ";
     writeMetadataAsOperand(Out, N->getExtraData(), TypePrinter, Machine,
@@ -1430,8 +1461,11 @@ static void writeMDCompositeType(raw_ostream &Out, const MDCompositeType *N,
   Out << "!MDCompositeType(";
   FieldSeparator FS;
   writeTag(Out, FS, N);
-  if (!N->getName().empty())
-    Out << FS << "name: \"" << N->getName() << "\"";
+  writeStringField(Out, FS, "name", N->getName());
+  if (N->getScope()) {
+    Out << FS << "scope: ";
+    writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
+  }
   if (N->getFile()) {
     Out << FS << "file: ";
     writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
@@ -1439,10 +1473,6 @@ static void writeMDCompositeType(raw_ostream &Out, const MDCompositeType *N,
   }
   if (N->getLine())
     Out << FS << "line: " << N->getLine();
-  if (N->getScope()) {
-    Out << FS << "scope: ";
-    writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
-  }
   if (N->getBaseType()) {
     Out << FS << "baseType: ";
     writeMetadataAsOperand(Out, N->getBaseType(), TypePrinter, Machine,
@@ -1454,8 +1484,10 @@ static void writeMDCompositeType(raw_ostream &Out, const MDCompositeType *N,
     Out << FS << "align: " << N->getAlignInBits();
   if (N->getOffsetInBits())
     Out << FS << "offset: " << N->getOffsetInBits();
-  if (N->getFlags())
-    Out << FS << "flags: " << N->getFlags();
+  if (auto Flags = N->getFlags()) {
+    Out << FS << "flags: ";
+    writeDIFlags(Out, Flags);
+  }
   if (N->getElements()) {
     Out << FS << "elements: ";
     writeMetadataAsOperand(Out, N->getElements(), TypePrinter, Machine,
@@ -1479,8 +1511,7 @@ static void writeMDCompositeType(raw_ostream &Out, const MDCompositeType *N,
     writeMetadataAsOperand(Out, N->getTemplateParams(), TypePrinter, Machine,
                            Context);
   }
-  if (!N->getIdentifier().empty())
-    Out << FS << "identifier: \"" << N->getIdentifier() << "\"";
+  writeStringField(Out, FS, "identifier", N->getIdentifier());
   Out << ")";
 }
 
@@ -1489,8 +1520,10 @@ static void writeMDSubroutineType(raw_ostream &Out, const MDSubroutineType *N,
                                   SlotTracker *Machine, const Module *Context) {
   Out << "!MDSubroutineType(";
   FieldSeparator FS;
-  if (N->getFlags())
-    Out << FS << "flags: " << N->getFlags();
+  if (auto Flags = N->getFlags()) {
+    Out << FS << "flags: ";
+    writeDIFlags(Out, Flags);
+  }
   Out << FS << "types: ";
   writeMetadataAsOperand(Out, N->getTypeArray(), TypePrinter, Machine, Context);
   Out << ")";
@@ -1500,8 +1533,10 @@ static void writeMDFile(raw_ostream &Out, const MDFile *N, TypePrinting *,
                         SlotTracker *, const Module *) {
   Out << "!MDFile(";
   FieldSeparator FS;
-  Out << FS << "filename: \"" << N->getFilename() << "\"";
-  Out << FS << "directory: \"" << N->getDirectory() << "\"";
+  writeStringField(Out, FS, "filename", N->getFilename(),
+                   /* ShouldSkipEmpty */ false);
+  writeStringField(Out, FS, "directory", N->getDirectory(),
+                   /* ShouldSkipEmpty */ false);
   Out << ")";
 }
 
@@ -1515,19 +1550,13 @@ static void writeMDCompileUnit(raw_ostream &Out, const MDCompileUnit *N,
     Out << Lang;
   else
     Out << N->getSourceLanguage();
-  if (N->getFile()) {
-    Out << FS << "file: ";
-    writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
-                           Context);
-  }
-  if (!N->getProducer().empty())
-    Out << FS << "producer: \"" << N->getProducer() << "\"";
+  Out << FS << "file: ";
+  writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine, Context);
+  writeStringField(Out, FS, "producer", N->getProducer());
   Out << FS << "isOptimized: " << (N->isOptimized() ? "true" : "false");
-  if (!N->getFlags().empty())
-    Out << FS << "flags: \"" << N->getFlags() << "\"";
+  writeStringField(Out, FS, "flags", N->getFlags());
   Out << FS << "runtimeVersion: " << N->getRuntimeVersion();
-  if (!N->getSplitDebugFilename().empty())
-    Out << FS << "splitDebugFilename: \"" << N->getSplitDebugFilename() << "\"";
+  writeStringField(Out, FS, "splitDebugFilename", N->getSplitDebugFilename());
   Out << FS << "emissionKind: " << N->getEmissionKind();
   if (N->getEnumTypes()) {
     Out << FS << "enums: ";
@@ -1562,11 +1591,10 @@ static void writeMDSubprogram(raw_ostream &Out, const MDSubprogram *N,
                               const Module *Context) {
   Out << "!MDSubprogram(";
   FieldSeparator FS;
+  writeStringField(Out, FS, "name", N->getName());
+  writeStringField(Out, FS, "linkageName", N->getLinkageName());
   Out << FS << "scope: ";
   writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
-  Out << FS << "name: \"" << N->getName() << "\"";
-  if (!N->getLinkageName().empty())
-    Out << FS << "linkageName: \"" << N->getLinkageName() << "\"";
   if (N->getFile()) {
     Out << FS << "file: ";
     writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
@@ -1597,8 +1625,10 @@ static void writeMDSubprogram(raw_ostream &Out, const MDSubprogram *N,
   }
   if (N->getVirtualIndex())
     Out << FS << "virtualIndex: " << N->getVirtualIndex();
-  if (N->getFlags())
-    Out << FS << "flags: " << N->getFlags();
+  if (auto Flags = N->getFlags()) {
+    Out << FS << "flags: ";
+    writeDIFlags(Out, Flags);
+  }
   Out << FS << "isOptimized: " << (N->isOptimized() ? "true" : "false");
   if (N->getFunction()) {
     Out << FS << "function: ";
@@ -1665,14 +1695,13 @@ static void writeMDNamespace(raw_ostream &Out, const MDNamespace *N,
                              const Module *Context) {
   Out << "!MDNamespace(";
   FieldSeparator FS;
+  writeStringField(Out, FS, "name", N->getName());
   Out << FS << "scope: ";
   writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
   if (N->getFile()) {
     Out << FS << "file: ";
     writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine, Context);
   }
-  if (!N->getName().empty())
-    Out << FS << "name: \"" << N->getName() << "\"";
   if (N->getLine())
     Out << FS << "line: " << N->getLine();
   Out << ")";
@@ -1685,9 +1714,7 @@ static void writeMDTemplateTypeParameter(raw_ostream &Out,
                                          const Module *Context) {
   Out << "!MDTemplateTypeParameter(";
   FieldSeparator FS;
-  Out << FS << "scope: ";
-  writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
-  Out << FS << "name: \"" << N->getName() << "\"";
+  writeStringField(Out, FS, "name", N->getName());
   Out << FS << "type: ";
   writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine, Context);
   Out << ")";
@@ -1700,12 +1727,13 @@ static void writeMDTemplateValueParameter(raw_ostream &Out,
                                           const Module *Context) {
   Out << "!MDTemplateValueParameter(";
   FieldSeparator FS;
-  writeTag(Out, FS, N);
-  Out << FS << "scope: ";
-  writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
-  Out << FS << "name: \"" << N->getName() << "\"";
-  Out << FS << "type: ";
-  writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine, Context);
+  if (N->getTag() != dwarf::DW_TAG_template_value_parameter)
+    writeTag(Out, FS, N);
+  writeStringField(Out, FS, "name", N->getName());
+  if (auto *Type = N->getType()) {
+    Out << FS << "type: ";
+    writeMetadataAsOperand(Out, Type, TypePrinter, Machine, Context);
+  }
   Out << FS << "value: ";
   writeMetadataAsOperand(Out, N->getValue(), TypePrinter, Machine, Context);
   Out << ")";
@@ -1716,11 +1744,10 @@ static void writeMDGlobalVariable(raw_ostream &Out, const MDGlobalVariable *N,
                                   SlotTracker *Machine, const Module *Context) {
   Out << "!MDGlobalVariable(";
   FieldSeparator FS;
+  writeStringField(Out, FS, "name", N->getName());
+  writeStringField(Out, FS, "linkageName", N->getLinkageName());
   Out << FS << "scope: ";
   writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
-  Out << FS << "name: \"" << N->getName() << "\"";
-  if (!N->getLinkageName().empty())
-    Out << FS << "linkageName: \"" << N->getLinkageName() << "\"";
   if (N->getFile()) {
     Out << FS << "file: ";
     writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
@@ -1754,9 +1781,11 @@ static void writeMDLocalVariable(raw_ostream &Out, const MDLocalVariable *N,
   Out << "!MDLocalVariable(";
   FieldSeparator FS;
   writeTag(Out, FS, N);
+  writeStringField(Out, FS, "name", N->getName());
+  if (N->getTag() == dwarf::DW_TAG_arg_variable || N->getArg())
+    Out << FS << "arg: " << N->getArg();
   Out << FS << "scope: ";
   writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
-  Out << FS << "name: \"" << N->getName() << "\"";
   if (N->getFile()) {
     Out << FS << "file: ";
     writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine,
@@ -1769,10 +1798,10 @@ static void writeMDLocalVariable(raw_ostream &Out, const MDLocalVariable *N,
     writeMetadataAsOperand(Out, N->getType(), TypePrinter, Machine,
                            Context);
   }
-  if (N->getTag() == dwarf::DW_TAG_arg_variable || N->getArg())
-    Out << FS << "arg: " << N->getArg();
-  if (N->getFlags())
-    Out << FS << "flags: " << N->getFlags();
+  if (auto Flags = N->getFlags()) {
+    Out << FS << "flags: ";
+    writeDIFlags(Out, Flags);
+  }
   if (N->getInlinedAt()) {
     Out << FS << "inlinedAt: ";
     writeMetadataAsOperand(Out, N->getInlinedAt(), TypePrinter, Machine,
@@ -1807,17 +1836,15 @@ static void writeMDObjCProperty(raw_ostream &Out, const MDObjCProperty *N,
                                 const Module *Context) {
   Out << "!MDObjCProperty(";
   FieldSeparator FS;
-  Out << FS << "name: \"" << N->getName() << "\"";
+  writeStringField(Out, FS, "name", N->getName());
   if (N->getFile()) {
     Out << FS << "file: ";
     writeMetadataAsOperand(Out, N->getFile(), TypePrinter, Machine, Context);
   }
   if (N->getLine())
     Out << FS << "line: " << N->getLine();
-  if (!N->getSetterName().empty())
-    Out << FS << "setter: \"" << N->getSetterName() << "\"";
-  if (!N->getGetterName().empty())
-    Out << FS << "getter: \"" << N->getGetterName() << "\"";
+  writeStringField(Out, FS, "setter", N->getSetterName());
+  writeStringField(Out, FS, "getter", N->getGetterName());
   if (N->getAttributes())
     Out << FS << "attributes: " << N->getAttributes();
   if (N->getType()) {
@@ -1833,6 +1860,7 @@ static void writeMDImportedEntity(raw_ostream &Out, const MDImportedEntity *N,
   Out << "!MDImportedEntity(";
   FieldSeparator FS;
   writeTag(Out, FS, N);
+  writeStringField(Out, FS, "name", N->getName());
   Out << FS << "scope: ";
   writeMetadataAsOperand(Out, N->getScope(), TypePrinter, Machine, Context);
   if (N->getEntity()) {
@@ -1841,7 +1869,6 @@ static void writeMDImportedEntity(raw_ostream &Out, const MDImportedEntity *N,
   }
   if (N->getLine())
     Out << FS << "line: " << N->getLine();
-  Out << FS << "name: \"" << N->getName() << "\"";
   Out << ")";
 }
 
@@ -2880,6 +2907,15 @@ void AssemblyWriter::printInstruction(const Instruction &I) {
     Out << ", ";
     TypePrinter.print(I.getType(), Out);
   } else if (Operand) {   // Print the normal way.
+    if (const auto *GEP = dyn_cast<GetElementPtrInst>(&I)) {
+      Out << ' ';
+      TypePrinter.print(GEP->getSourceElementType(), Out);
+      Out << ',';
+    } else if (const auto *LI = dyn_cast<LoadInst>(&I)) {
+      Out << ' ';
+      TypePrinter.print(LI->getType(), Out);
+      Out << ',';
+    }
 
     // PrintAllTypes - Instructions who have operands of all the same type
     // omit the type from all but the first operand.  If the instruction has
@@ -2956,32 +2992,10 @@ void AssemblyWriter::printInstruction(const Instruction &I) {
   printInfoComment(I);
 }
 
-static void WriteMDNodeComment(const MDNode *Node,
-                               formatted_raw_ostream &Out) {
-  if (Node->getNumOperands() < 1)
-    return;
-
-  Metadata *Op = Node->getOperand(0);
-  if (!Op || !isa<MDString>(Op))
-    return;
-
-  DIDescriptor Desc(Node);
-  if (!Desc.Verify())
-    return;
-
-  unsigned Tag = Desc.getTag();
-  Out.PadToColumn(50);
-  if (dwarf::TagString(Tag)) {
-    Out << "; ";
-    Desc.print(Out);
-  } else if (Tag == dwarf::DW_TAG_user_base) {
-    Out << "; [ DW_TAG_user_base ]";
-  }
-}
-
 void AssemblyWriter::writeMDNode(unsigned Slot, const MDNode *Node) {
   Out << '!' << Slot << " = ";
   printMDNodeBody(Node);
+  Out << "\n";
 }
 
 void AssemblyWriter::writeAllMDNodes() {
@@ -2998,8 +3012,6 @@ void AssemblyWriter::writeAllMDNodes() {
 
 void AssemblyWriter::printMDNodeBody(const MDNode *Node) {
   WriteMDNodeBodyInternal(Out, Node, &TypePrinter, &Machine, TheModule);
-  WriteMDNodeComment(Node, Out);
-  Out << "\n";
 }
 
 void AssemblyWriter::writeAllAttributeGroups() {
@@ -3196,20 +3208,26 @@ void Metadata::printAsOperand(raw_ostream &ROS, bool PrintType,
 }
 
 // Value::dump - allow easy printing of Values from the debugger.
+LLVM_DUMP_METHOD
 void Value::dump() const { print(dbgs()); dbgs() << '\n'; }
 
 // Type::dump - allow easy printing of Types from the debugger.
+LLVM_DUMP_METHOD
 void Type::dump() const { print(dbgs()); dbgs() << '\n'; }
 
 // Module::dump() - Allow printing of Modules from the debugger.
+LLVM_DUMP_METHOD
 void Module::dump() const { print(dbgs(), nullptr); }
 
 // \brief Allow printing of Comdats from the debugger.
+LLVM_DUMP_METHOD
 void Comdat::dump() const { print(dbgs()); }
 
 // NamedMDNode::dump() - Allow printing of NamedMDNodes from the debugger.
+LLVM_DUMP_METHOD
 void NamedMDNode::dump() const { print(dbgs()); }
 
+LLVM_DUMP_METHOD
 void Metadata::dump() const {
   print(dbgs());
   dbgs() << '\n';