[GOFF] Add writing text records to yaml2obj

redstar · redstar · commit 48df2fc68b40 · 2024-06-07T13:47:18.000-04:00
Add support for writing text records to yaml2obj.
diff --git a/llvm/include/llvm/BinaryFormat/GOFF.h b/llvm/include/llvm/BinaryFormat/GOFF.h
@@ -157,6 +157,12 @@ enum ESDAlignment : uint8_t {
   ESD_ALIGN_4Kpage = 12,
 };
 
+enum TXTRecordStyle : uint8_t {
+  TXT_TS_Byte = 0,
+  TXT_TS_Structured = 1,
+  TXT_TS_Unstructured = 2,
+};
+
 enum ENDEntryPointRequest : uint8_t {
   END_EPR_None = 0,
   END_EPR_EsdidOffset = 1,
diff --git a/llvm/include/llvm/ObjectYAML/GOFFYAML.h b/llvm/include/llvm/ObjectYAML/GOFFYAML.h
@@ -26,6 +26,7 @@ namespace llvm {
 namespace GOFFYAML {
 
 LLVM_YAML_STRONG_TYPEDEF(uint8_t, GOFF_AMODE)
+LLVM_YAML_STRONG_TYPEDEF(uint8_t, GOFF_TXTRECORDSTYLE)
 LLVM_YAML_STRONG_TYPEDEF(uint8_t, GOFF_ENDFLAGS)
 
 // The GOFF format uses different kinds of logical records. The format imposes
@@ -65,6 +66,22 @@ struct ModuleHeader : public RecordBase {
   }
 };
 
+struct Text : public RecordBase {
+  Text() : RecordBase(Kind::Text) {}
+
+  GOFF_TXTRECORDSTYLE Style;
+  uint32_t ESDID;
+  uint32_t Offset;
+  uint32_t TrueLength;
+  uint16_t Encoding;
+  uint16_t DataLength;
+  std::optional<yaml::BinaryRef> Data;
+
+  static bool classof(const RecordBase *S) {
+    return S->getKind() == Kind::Text;
+  }
+};
+
 struct EndOfModule : public RecordBase {
   EndOfModule() : RecordBase(Kind::EndOfModule) {}
 
@@ -89,12 +106,14 @@ struct Object {
 } // end namespace llvm
 
 LLVM_YAML_DECLARE_ENUM_TRAITS(GOFFYAML::GOFF_AMODE)
+LLVM_YAML_DECLARE_ENUM_TRAITS(GOFFYAML::GOFF_TXTRECORDSTYLE)
 LLVM_YAML_DECLARE_ENUM_TRAITS(GOFFYAML::GOFF_ENDFLAGS)
 
 LLVM_YAML_IS_SEQUENCE_VECTOR(GOFFYAML::RecordPtr)
 LLVM_YAML_DECLARE_MAPPING_TRAITS(GOFFYAML::RecordPtr)
 
 LLVM_YAML_DECLARE_MAPPING_TRAITS(GOFFYAML::ModuleHeader)
+LLVM_YAML_DECLARE_MAPPING_TRAITS(GOFFYAML::Text)
 LLVM_YAML_DECLARE_MAPPING_TRAITS(GOFFYAML::EndOfModule)
 LLVM_YAML_DECLARE_MAPPING_TRAITS(GOFFYAML::Object)
 
diff --git a/llvm/lib/ObjectYAML/GOFFEmitter.cpp b/llvm/lib/ObjectYAML/GOFFEmitter.cpp
@@ -147,6 +147,7 @@ class LogicalRecord : public raw_svector_ostream {
 
 class GOFFState {
   void writeHeader(const GOFFYAML::ModuleHeader &ModHdr);
+  void writeText(const GOFFYAML::Text &Txt);
   void writeEnd(const GOFFYAML::EndOfModule &EndMod);
 
   void reportError(const Twine &Msg) {
@@ -184,6 +185,24 @@ void GOFFState::writeHeader(const GOFFYAML::ModuleHeader &ModHdr) {
     LR << *ModHdr.Properties; // Module properties.
 }
 
+void GOFFState::writeText(const GOFFYAML::Text &Txt) {
+  // See https://www.ibm.com/docs/en/zos/3.1.0?topic=grf-text-record.
+  GW.newRecord(GOFF::RT_TXT);
+  LogicalRecord LR(GW);
+  LR << binaryBe(uint8_t(Txt.Style)) // Text record style.
+     << binaryBe(
+            Txt.ESDID) // ESDID of the element/part to which this data belongs.
+     << zeros(4)       // Reserved.
+     << binaryBe(Txt.Offset)      // Starting offset from element/part.
+     << binaryBe(Txt.TrueLength)  // True length if encoded.
+     << binaryBe(Txt.Encoding)    // Encoding.
+     << binaryBe(Txt.DataLength); // Total length of data.
+  if (Txt.Data)
+    LR << *Txt.Data; // Data.
+  else
+    LR << zeros(Txt.DataLength);
+}
+
 void GOFFState::writeEnd(const GOFFYAML::EndOfModule &EndMod) {
   // See https://www.ibm.com/docs/en/zos/3.1.0?topic=formats-end-module-record.
   SmallString<16> EntryName;
@@ -211,12 +230,14 @@ bool GOFFState::writeObject() {
     case GOFFYAML::RecordBase::Kind::ModuleHeader:
       writeHeader(*static_cast<const GOFFYAML::ModuleHeader *>(Rec));
       break;
+    case GOFFYAML::RecordBase::Kind::Text:
+      writeText(*static_cast<const GOFFYAML::Text *>(Rec));
+      break;
     case GOFFYAML::RecordBase::Kind::EndOfModule:
       writeEnd(*static_cast<const GOFFYAML::EndOfModule *>(Rec));
       break;
     case GOFFYAML::RecordBase::Kind::RelocationDirectory:
     case GOFFYAML::RecordBase::Kind::Symbol:
-    case GOFFYAML::RecordBase::Kind::Text:
     case GOFFYAML::RecordBase::Kind::DeferredLength:
       llvm_unreachable("not yet implemented");
     }
diff --git a/llvm/lib/ObjectYAML/GOFFYAML.cpp b/llvm/lib/ObjectYAML/GOFFYAML.cpp
@@ -30,6 +30,16 @@ void ScalarEnumerationTraits<GOFFYAML::GOFF_AMODE>::enumeration(
   IO.enumFallback<Hex8>(Value);
 }
 
+void ScalarEnumerationTraits<GOFFYAML::GOFF_TXTRECORDSTYLE>::enumeration(
+    IO &IO, GOFFYAML::GOFF_TXTRECORDSTYLE &Value) {
+#define ECase(X) IO.enumCase(Value, #X, GOFF::TXT_##X)
+  ECase(TS_Byte);
+  ECase(TS_Structured);
+  ECase(TS_Unstructured);
+#undef ECase
+  IO.enumFallback<Hex8>(Value);
+}
+
 void ScalarEnumerationTraits<GOFFYAML::GOFF_ENDFLAGS>::enumeration(
     IO &IO, GOFFYAML::GOFF_ENDFLAGS &Value) {
 #define ECase(X) IO.enumCase(Value, #X, unsigned(GOFF::END_##X) << 6)
@@ -48,6 +58,16 @@ void MappingTraits<GOFFYAML::ModuleHeader>::mapping(
   IO.mapOptional("Properties", ModHdr.Properties);
 }
 
+void MappingTraits<GOFFYAML::Text>::mapping(IO &IO, GOFFYAML::Text &Txt) {
+  IO.mapOptional("TextStyle", Txt.Style, GOFF::TXT_TS_Byte);
+  IO.mapOptional("ESDID", Txt.ESDID, 0);
+  IO.mapOptional("Offset", Txt.Offset, 0);
+  IO.mapOptional("TrueLength", Txt.TrueLength, 0);
+  IO.mapOptional("TextEncoding", Txt.Encoding, 0);
+  IO.mapOptional("DataLength", Txt.DataLength, 0);
+  IO.mapOptional("Data", Txt.Data);
+}
+
 void MappingTraits<GOFFYAML::EndOfModule>::mapping(IO &IO,
                                                    GOFFYAML::EndOfModule &End) {
   IO.mapOptional("Flags", End.Flags, 0);
@@ -65,12 +85,15 @@ void CustomMappingTraits<GOFFYAML::RecordPtr>::inputOne(
     GOFFYAML::ModuleHeader ModHdr;
     IO.mapRequired("ModuleHeader", ModHdr);
     Elem = std::make_unique<GOFFYAML::ModuleHeader>(std::move(ModHdr));
+  } else if (Key == "Text") {
+    GOFFYAML::Text Txt;
+    IO.mapRequired("Text", Txt);
+    Elem = std::make_unique<GOFFYAML::Text>(std::move(Txt));
   } else if (Key == "End") {
     GOFFYAML::EndOfModule End;
     IO.mapRequired("End", End);
     Elem = std::make_unique<GOFFYAML::EndOfModule>(std::move(End));
-  } else if (Key == "RelocationDirectory" || Key == "Symbol" || Key == "Text" ||
-             Key == "Length")
+  } else if (Key == "RelocationDirectory" || Key == "Symbol" || Key == "Length")
     IO.setError(Twine("not yet implemented ").concat(Key));
   else
     IO.setError(Twine("unknown record type name ").concat(Key));
@@ -83,12 +106,14 @@ void CustomMappingTraits<GOFFYAML::RecordPtr>::output(
     IO.mapRequired("ModuleHeader",
                    *static_cast<GOFFYAML::ModuleHeader *>(Elem.get()));
     break;
+  case GOFFYAML::RecordBase::Kind::Text:
+    IO.mapRequired("Text", *static_cast<GOFFYAML::Text *>(Elem.get()));
+    break;
   case GOFFYAML::RecordBase::Kind::EndOfModule:
     IO.mapRequired("End", *static_cast<GOFFYAML::EndOfModule *>(Elem.get()));
     break;
   case GOFFYAML::RecordBase::Kind::RelocationDirectory:
   case GOFFYAML::RecordBase::Kind::Symbol:
-  case GOFFYAML::RecordBase::Kind::Text:
   case GOFFYAML::RecordBase::Kind::DeferredLength:
     llvm_unreachable("not yet implemented");
   }
diff --git a/llvm/test/tools/yaml2obj/GOFF/text-default.yaml b/llvm/test/tools/yaml2obj/GOFF/text-default.yaml
@@ -0,0 +1,15 @@
+# RUN: yaml2obj %s | od -v -An -tx1 | FileCheck --ignore-case %s
+
+## Verify that the GOFF text record is correctly written with all fields
+## having a default value.
+
+# CHECK:      03 10 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+# CHECK-NEXT: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+# CHECK-NEXT: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+# CHECK-NEXT: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+# CHECK-NEXT: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+
+# CHECK-EMPTY:
+
+--- !GOFF
+- Text:
diff --git a/llvm/test/tools/yaml2obj/GOFF/text-only.yaml b/llvm/test/tools/yaml2obj/GOFF/text-only.yaml
@@ -0,0 +1,22 @@
+# RUN: yaml2obj %s | od -v -An -tx1 | FileCheck --ignore-case %s
+
+## Verify that the GOFF text record is correct, with all fields having a
+## value. No other record is written.
+
+# CHECK:      03 10 00 01 00 00 00 2a 00 00 00 00 00 00 00 01
+# CHECK-NEXT: 00 00 02 00 00 01 00 0a a0 b0 c0 d0 e0 f0 10 20
+# CHECK-NEXT: 30 40 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+# CHECK-NEXT: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+# CHECK-NEXT: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+
+# CHECK-EMPTY:
+
+--- !GOFF
+- Text:
+    TextStyle: TS_Structured
+    ESDID: 42
+    Offset: 1
+    TrueLength: 512
+    TextEncoding: 1
+    DataLength: 10
+    Data: a0b0c0d0e0f010203040
diff --git a/llvm/test/tools/yaml2obj/GOFF/text-style-const.yaml b/llvm/test/tools/yaml2obj/GOFF/text-style-const.yaml
@@ -0,0 +1,15 @@
+# RUN: yaml2obj %s | od -v -An -tx1 | FileCheck --ignore-case %s
+
+## Verify that the text style can be given as a constant.
+
+# CHECK:      03 10 00 0a 00 00 00 00 00 00 00 00 00 00 00 00
+# CHECK-NEXT: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+# CHECK-NEXT: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+# CHECK-NEXT: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+# CHECK-NEXT: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
+
+# CHECK-EMPTY:
+
+--- !GOFF
+- Text:
+    TextStyle: 0xA
