Metadata changes to support LLVM 7.0

Author: gklimowicz

tools/flang2/flang2exe/ll_structure.cpp

@@ -399,12 +399,15 @@ compute_ir_feature_vector(LLVMModuleRef module, enum LL_IRVersion vers)
     module->ir.is_spir = 1;
 
   module->ir.version = vers;
+  InitializeDIFlags(&module->ir);
   if (XBIT(120, 0x200)) {
     module->ir.dwarf_version = LL_DWARF_Version_2;
   } else if (XBIT(120, 0x4000)) {
     module->ir.dwarf_version = LL_DWARF_Version_3;
-  } else {
+  } else if (true) { // FIXME - need a new bit
     module->ir.dwarf_version = LL_DWARF_Version_4;
+  } else {
+    module->ir.dwarf_version = LL_DWARF_Version_5;
   }
 
   if (ll_feature_versioned_dw_tag(&module->ir)) {

tools/flang2/flang2exe/ll_structure.h

@@ -142,6 +142,7 @@ typedef enum LL_IRVersion {
   LL_Version_4_0 = 40,
   LL_Version_5_0 = 50,
   LL_Version_6_0 = 60,
+  LL_Version_7_0 = 70,
   LL_Version_trunk = 1023
 } LL_IRVersion;
 
@@ -150,7 +151,8 @@ LL_IRVersion get_llvm_version(void);
 typedef enum LL_DWARFVersion {
   LL_DWARF_Version_2,
   LL_DWARF_Version_3,
-  LL_DWARF_Version_4
+  LL_DWARF_Version_4,
+  LL_DWARF_Version_5
 } LL_DWARFVersion;
 
 /* If flang is built with LLVM from github:flang-compiler/llvm, then one can
@@ -353,6 +355,15 @@ ll_feature_debug_info_ver38(const LL_IRFeatures *feature)
   return feature->version >= LL_Version_3_8;
 }
 
+/**
+   \brief Version 7.0 debug metadata
+ */
+INLINE static bool
+ll_feature_debug_info_ver70(const LL_IRFeatures *feature)
+{
+  return feature->version >= LL_Version_7_0;
+}
+
 INLINE static bool
 ll_feature_use_distinct_metadata(const LL_IRFeatures *feature)
 {
@@ -439,6 +450,7 @@ ll_feature_no_file_in_namespace(const LL_IRFeatures *feature)
 #define ll_feature_debug_info_subrange_needs_count(f) \
   ((f)->version >= LL_Version_3_7)
 #define ll_feature_debug_info_ver38(f) ((f)->version >= LL_Version_3_8)
+#define ll_feature_debug_info_ver70(f) ((f)->version >= LL_Version_7_0)
 #define ll_feature_use_distinct_metadata(f) ((f)->version >= LL_Version_3_8)
 #define ll_feature_subprogram_not_in_cu(f) ((f)->version >= LL_Version_3_9)
 #define ll_feature_from_global_to_md(f) ((f)->version >= LL_Version_4_0)

tools/flang2/flang2exe/ll_write.cpp

@@ -918,6 +918,28 @@ static const MDTemplate Tmpl_DISubprogram[] = {
     {"variables", NodeField},
     {"scopeLine", UnsignedField}};
 
+static const MDTemplate Tmpl_DISubprogram_70[] = {
+    {"DISubprogram", TF, 19},
+    {"tag", DWTagField, FlgHidden},
+    {"file", NodeField},
+    {"scope", NodeField},
+    {"name", StringField},
+    {"displayName", StringField, FlgHidden},
+    {"linkageName", StringField},
+    {"line", UnsignedField},
+    {"type", NodeField},
+    {"isLocal", BoolField},
+    {"isDefinition", BoolField},
+    {"virtuality", DWVirtualityField},
+    {"virtualIndex", UnsignedField},
+    {"containingType", NodeField},
+    {"flags", UnsignedField}, /* TBD: DIFlag... */
+    {"isOptimized", BoolField},
+    {"function", ValueField},
+    {"templateParams", NodeField},
+    {"declaration", NodeField},
+    {"scopeLine", UnsignedField}};
+
 static const MDTemplate Tmpl_DISubprogram_38[] = {
     {"DISubprogram", TF, 20},
     {"tag", DWTagField, FlgHidden},
@@ -1766,6 +1788,11 @@ emitDISubprogram(FILE *out, LLVMModuleRef mod, const LL_MDNode *mdnode,
       emitTmpl(out, mod, mdnode, mdi, Tmpl_DISubprogram_38);
       return;
     }
+    if (ll_feature_debug_info_ver70(&mod->ir)) {
+      // 7.0, 'variables:' was removed
+      emitTmpl(out, mod, mdnode, mdi, Tmpl_DISubprogram_70);
+      return;
+    }
     emitTmpl(out, mod, mdnode, mdi, Tmpl_DISubprogram);
     return;
   }

tools/flang2/flang2exe/lldebug.cpp

@@ -65,15 +65,9 @@
 
 const int DIFLAG_ARTIFICIAL = 1 << 6;
 const int DIFLAG_ISMAINPGM  = 1 << 21;
-#if defined(FLANG_LLVM_EXTENSIONS)
-const int DIFLAG_PURE      = 1 << 22;
-const int DIFLAG_ELEMENTAL = 1 << 23;
-const int DIFLAG_RECUSIVE  = 1 << 24;
-#else
-const int DIFLAG_PURE      = 0;
-const int DIFLAG_ELEMENTAL = 0;
-const int DIFLAG_RECUSIVE  = 0;
-#endif
+static int DIFLAG_PURE;
+static int DIFLAG_ELEMENTAL;
+static int DIFLAG_RECUSIVE;
 
 typedef struct {
   LL_MDRef mdnode; /**< mdnode for block */
@@ -154,6 +148,24 @@ static LL_MDRef lldbg_emit_type(
 
 /* ---------------------------------------------------------------------- */
 
+void
+InitializeDIFlags(const LL_IRFeatures* feature)
+{
+#ifdef FLANG_LLVM_EXTENSIONS
+  if (ll_feature_debug_info_ver70(feature)) {
+    DIFLAG_PURE = 1 << 27;
+    DIFLAG_ELEMENTAL = 1 << 28;
+    DIFLAG_RECUSIVE = 1 << 29;
+  } else {
+    DIFLAG_PURE = 1 << 22;
+    DIFLAG_ELEMENTAL = 1 << 23;
+    DIFLAG_RECUSIVE = 1 << 24;
+  }
+#else
+  // do nothing
+#endif
+}
+
 char *
 lldbg_alloc(INT size)
 {
@@ -424,7 +436,9 @@ lldbg_create_subprogram_mdnode(
     llmd_add_md(mdb, db->comp_unit_mdnode);
 
   /* Add extra layer of indirection before 3.4. */
-  if (ll_feature_debug_info_pre34(&db->module->ir)) {
+  if (ll_feature_debug_info_ver70(&db->module->ir)) {
+    llmd_add_null(mdb);
+  } else if (ll_feature_debug_info_pre34(&db->module->ir)) {
     llmd_add_md(mdb,
                 ll_get_md_node(db->module, LL_PlainMDNode, &lv_list_mdnode, 1));
   } else {
@@ -2735,7 +2749,7 @@ lldbg_emit_local_variable(LL_DebugInfo *db, SPTR sptr, int findex,
   } else
 #endif
   {
-    symname = (char *)lldbg_alloc(sizeof(char) * (strlen(SYMNAME(sptr)) + 1));
+    symname = (char *)lldbg_alloc(strlen(SYMNAME(sptr)) + 1);
     strcpy(symname, SYMNAME(sptr));
   }
   if (SCG(sptr) == SC_DUMMY && !emit_dummy_as_local) {

tools/flang2/flang2exe/lldebug.h

@@ -253,4 +253,8 @@ void lldbg_emit_imported_entity(LL_DebugInfo *db, int entity_sptr,
  */
 void lldbg_create_cmblk_mem_mdnode_list(int sptr, int gblsym);
 
+/// \brief Initialize the DIFLAG values
+/// The values may vary depending on the LLVM branch being used
+void InitializeDIFlags(const LL_IRFeatures* feature);
+
 #endif /* LLDEBUG_H_ */