[LLVM-C] Use unwrapDI in LLVMDITypeGetName

[tamird]

Summary

This function otherwise crashes. This behavior has been incorrect since
its introduction in 260b581498bed0b847e7e086852e0082d266711d (D46627).

[tamird]

Add test.

[tamird]

clang-format

[tamird]

Separate test case

[scott.linder]

Could you split the NFC changes to naming/style from the functional fix to LLVMDITypeGetName and the new test?

llvm/tools/llvm-c-test/debuginfo.c

247

This seems redundant with llvm_get_di_tag, maybe it can be dropped?

[tamird]

Split out NFC changes, remove redundant GetDINodeTag call

[tamird]

Rebase

[tamird]

In D154630#4478821, @scott.linder wrote:

Could you split the NFC changes to naming/style from the functional fix to LLVMDITypeGetName and the new test?

Done in https://reviews.llvm.org/D154661.

[tamird]

rebase

[scott.linder]

Thank you again for the fix!

llvm/lib/IR/DebugInfo.cpp

LLVMDIBuilderCreateArtificialType(LLVMDIBuilderRef Builder,
   return wrap(unwrap(Builder)->createArtificialType(unwrapDI<DIType>(Type)));
 }
 
 uint16_t LLVMGetDINodeTag(LLVMMetadataRef MD) {
   return unwrapDI<DINode>(MD)->getTag();
 }
 
 const char *LLVMDITypeGetName(LLVMMetadataRef DType, size_t *Length) {
-  StringRef Str = unwrap<DIType>(DType)->getName();
+  StringRef Str = unwrapDI<DIType>(DType)->getName();
   *Length = Str.size();
   return Str.data();
 }
 
 uint64_t LLVMDITypeGetSizeInBits(LLVMMetadataRef DType) {
   return unwrapDI<DIType>(DType)->getSizeInBits();
 }
 

llvm/test/Bindings/llvm-c/di-type-get-name.ll

+; RUN: llvm-c-test --di-type-get-name < /dev/null
+; This used to trigger an assertion

llvm/test/Bindings/llvm-c/get-di-tag.ll

 ; RUN: llvm-c-test --get-di-tag < /dev/null
 ; This used to trigger an assertion

llvm/tools/llvm-c-test/debuginfo.c

 /*===-- debuginfo.c - tool for testing libLLVM and llvm-c API -------------===*\
 |*                                                                            *|
 |* Part of the LLVM Project, under the Apache License v2.0 with LLVM          *|
 |* Exceptions.                                                                *|
 |* See https://llvm.org/LICENSE.txt for license information.                  *|
 |* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception                    *|
 |*                                                                            *|
 |*===----------------------------------------------------------------------===*|
 |*                                                                            *|
 |* Tests for the LLVM C DebugInfo API                                         *|
 |*                                                                            *|
 \*===----------------------------------------------------------------------===*/
 
 #include "llvm-c-test.h"
 #include "llvm-c/DebugInfo.h"
+
+#include <assert.h>
 #include <stdio.h>
 #include <string.h>
-#include <assert.h>
 
 static LLVMMetadataRef
 declare_objc_class(LLVMDIBuilderRef DIB, LLVMMetadataRef File) {
   LLVMMetadataRef Decl = LLVMDIBuilderCreateStructType(DIB, File, "TestClass", 9, File, 42, 64, 0, LLVMDIFlagObjcClassComplete, NULL, NULL, 0, 0, NULL, NULL, 0);
   LLVMMetadataRef SuperDecl = LLVMDIBuilderCreateStructType(DIB, File, "TestSuperClass", 14, File, 42, 64, 0, LLVMDIFlagObjcClassComplete, NULL, NULL, 0, 0, NULL, NULL, 0);
   LLVMDIBuilderCreateInheritance(DIB, Decl, SuperDecl, 0, 0, 0);
   LLVMMetadataRef TestProperty =
       LLVMDIBuilderCreateObjCProperty(DIB, "test", 4, File, 42, "getTest", 7, "setTest", 7, 0x20 /*copy*/ | 0x40 /*nonatomic*/, SuperDecl);
int llvm_test_dibuilder(void) {
 
   LLVMDisposeDIBuilder(DIB);
   LLVMDisposeModule(M);
 
   return 0;
 }
 
 int llvm_get_di_tag(void) {
-  LLVMModuleRef m = LLVMModuleCreateWithName("Mod");
-  LLVMContextRef context = LLVMGetModuleContext(m);
+  LLVMModuleRef M = LLVMModuleCreateWithName("Mod");
+  LLVMContextRef Context = LLVMGetModuleContext(M);
+
+  const char String[] = "foo";
+  LLVMMetadataRef StringMD =
+      LLVMMDStringInContext2(Context, String, strlen(String));
+  LLVMMetadataRef NodeMD = LLVMMDNodeInContext2(Context, &StringMD, 1);
+  assert(LLVMGetDINodeTag(NodeMD) == 0);
+  (void)NodeMD;
+
+  LLVMDIBuilderRef Builder = LLVMCreateDIBuilder(M);
+  const char Filename[] = "metadata.c";
+  const char Directory[] = ".";
+  LLVMMetadataRef File = LLVMDIBuilderCreateFile(
+      Builder, Filename, strlen(Filename), Directory, strlen(Directory));
+  const char Name[] = "TestClass";
+  LLVMMetadataRef Struct = LLVMDIBuilderCreateStructType(
+      Builder, File, Name, strlen(Name), File, 42, 64, 0,
+      LLVMDIFlagObjcClassComplete, NULL, NULL, 0, 0, NULL, NULL, 0);
+  assert(LLVMGetDINodeTag(Struct) == 0x13);
+  (void)Struct;
+
+  LLVMDisposeDIBuilder(Builder);
+  LLVMDisposeModule(M);
+
+  return 0;
+}
+
+int llvm_di_type_get_name(void) {
+  LLVMModuleRef M = LLVMModuleCreateWithName("Mod");
 
-  LLVMMetadataRef metas[] = {LLVMMDStringInContext2(context, "foo", 3)};
-  LLVMMetadataRef md = LLVMMDNodeInContext2(context, metas, 1);
-  uint16_t tag0 = LLVMGetDINodeTag(md);
-
-  assert(tag0 == 0);
-  (void)tag0;
-
-  const char *filename = "metadata.c";
-  LLVMDIBuilderRef builder = LLVMCreateDIBuilder(m);
-  LLVMMetadataRef file =
-      LLVMDIBuilderCreateFile(builder, filename, strlen(filename), ".", 1);
-  LLVMMetadataRef decl = LLVMDIBuilderCreateStructType(
-      builder, file, "TestClass", 9, file, 42, 64, 0,
+  LLVMDIBuilderRef Builder = LLVMCreateDIBuilder(M);
+  const char Filename[] = "metadata.c";
+  const char Directory[] = ".";
+  LLVMMetadataRef File = LLVMDIBuilderCreateFile(
+      Builder, Filename, strlen(Filename), Directory, strlen(Directory));
+  const char Name[] = "TestClass";
+  LLVMMetadataRef Struct = LLVMDIBuilderCreateStructType(
+      Builder, File, Name, strlen(Name), File, 42, 64, 0,
       LLVMDIFlagObjcClassComplete, NULL, NULL, 0, 0, NULL, NULL, 0);
-  uint16_t tag1 = LLVMGetDINodeTag(decl);
+  assert(LLVMGetDINodeTag(Struct) == 0x13);
 
-  assert(tag1 == 0x13);
-  (void)tag1;
+  size_t Len;
+  const char *TypeName = LLVMDITypeGetName(Struct, &Len);
+  assert(Len == strlen(Name));
+  assert(strncmp(TypeName, Name, Len) == 0);
+  (void)TypeName;
 
-  LLVMDisposeDIBuilder(builder);
-  LLVMDisposeModule(m);
+  LLVMDisposeDIBuilder(Builder);
+  LLVMDisposeModule(M);
 
   return 0;
 }

llvm/tools/llvm-c-test/llvm-c-test.h

 int llvm_calc(void);
 
 // disassemble.c
 int llvm_disassemble(void);
 
 // debuginfo.c
 int llvm_test_dibuilder(void);
 int llvm_get_di_tag(void);
+int llvm_di_type_get_name(void);
 
 // metadata.c
 int llvm_add_named_metadata_operand(void);
 int llvm_set_metadata(void);
 int llvm_replace_md_operand(void);
 int llvm_is_a_value_as_metadata(void);
 
 // object.c

llvm/tools/llvm-c-test/main.c

static void print_usage(void) {
   fprintf(stderr, "    Read object file from stdin - list sections\n\n");
   fprintf(stderr, "  * --object-list-symbols\n");
   fprintf(stderr,
           "    Read object file from stdin - list symbols (like nm)\n\n");
   fprintf(stderr, "  * --disassemble\n");
   fprintf(stderr, "    Read lines of triple, hex ascii machine code from stdin "
                   "- print disassembly\n\n");
   fprintf(stderr, "  * --calc\n");
+  fprintf(
+      stderr,
+      "    Read lines of name, rpn from stdin - print generated module\n\n");
   fprintf(stderr, "  * --get-di-tag\n");
   fprintf(stderr, "    Run test for getting MDNode dwarf tag\n");
+  fprintf(stderr, "  * --di-type-get-name\n");
+  fprintf(stderr, "    Run test for getting MDNode type name\n");
   fprintf(stderr, "  * --replace-md-operand\n");
   fprintf(stderr, "    Run test for replacing MDNode operands\n");
   fprintf(stderr, "  * --is-a-value-as-metadata\n");
   fprintf(stderr,
           "    Run test for checking if LLVMValueRef is a ValueAsMetadata\n");
-  fprintf(
-      stderr,
-      "    Read lines of name, rpn from stdin - print generated module\n\n");
   fprintf(stderr, "  * --echo\n");
   fprintf(stderr, "    Read bitcode file from stdin - print it back out\n\n");
   fprintf(stderr, "  * --echo --opaque-pointers\n");
   fprintf(stderr, "    Read bitcode file from stdin - print it back out in "
                   "opaque pointer mode\n\n");
   fprintf(stderr, "  * --test-diagnostic-handler\n");
   fprintf(stderr,
           "    Read bitcode file from stdin with a diagnostic handler set\n\n");
int main(int argc, char **argv) {
   } else if (argc == 2 && !strcmp(argv[1], "--calc")) {
     return llvm_calc();
   } else if (argc == 2 && !strcmp(argv[1], "--add-named-metadata-operand")) {
     return llvm_add_named_metadata_operand();
   } else if (argc == 2 && !strcmp(argv[1], "--set-metadata")) {
     return llvm_set_metadata();
   } else if (argc == 2 && !strcmp(argv[1], "--get-di-tag")) {
     return llvm_get_di_tag();
+  } else if (argc == 2 && !strcmp(argv[1], "--di-type-get-name")) {
+    return llvm_di_type_get_name();
   } else if (argc == 2 && !strcmp(argv[1], "--replace-md-operand")) {
     return llvm_replace_md_operand();
   } else if (argc == 2 && !strcmp(argv[1], "--is-a-value-as-metadata")) {
     return llvm_is_a_value_as_metadata();
   } else if (argc == 2 && !strcmp(argv[1], "--test-function-attributes")) {
     return llvm_test_function_attributes();
   } else if (argc == 2 && !strcmp(argv[1], "--test-callsite-attributes")) {
     return llvm_test_callsite_attributes();

llvm/tools/llvm-c-test/metadata.c

 /*===-- object.c - tool for testing libLLVM and llvm-c API ----------------===*\
 |*                                                                            *|
 |* Part of the LLVM Project, under the Apache License v2.0 with LLVM          *|
 |* Exceptions.                                                                *|
 |* See https://llvm.org/LICENSE.txt for license information.                  *|
 |* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception                    *|
 |*                                                                            *|
 |*===----------------------------------------------------------------------===*|
 |*                                                                            *|
 |* This file implements the --add-named-metadata-operand and --set-metadata   *|
 |* commands in llvm-c-test.                                                   *|
 |*                                                                            *|
 \*===----------------------------------------------------------------------===*/
 
 #include "llvm-c-test.h"
+#include "llvm-c/Types.h"
 
 #include <assert.h>
 #include <string.h>
 
 int llvm_add_named_metadata_operand(void) {
-  LLVMModuleRef m = LLVMModuleCreateWithName("Mod");
-  LLVMValueRef values[] = { LLVMConstInt(LLVMInt32Type(), 0, 0) };
+  LLVMModuleRef M = LLVMModuleCreateWithName("Mod");
+  LLVMValueRef Int = LLVMConstInt(LLVMInt32Type(), 0, 0);
 
   // This used to trigger an assertion
-  LLVMAddNamedMetadataOperand(m, "name", LLVMMDNode(values, 1));
+  LLVMAddNamedMetadataOperand(M, "name", LLVMMDNode(&Int, 1));
 
-  LLVMDisposeModule(m);
+  LLVMDisposeModule(M);
 
   return 0;
 }
 
 int llvm_set_metadata(void) {
-  LLVMBuilderRef b = LLVMCreateBuilder();
-  LLVMValueRef values[] = { LLVMConstInt(LLVMInt32Type(), 0, 0) };
+  LLVMBuilderRef Builder = LLVMCreateBuilder();
 
   // This used to trigger an assertion
-  LLVMValueRef ret = LLVMBuildRetVoid(b);
-  LLVMSetMetadata(ret, LLVMGetMDKindID("kind", 4), LLVMMDNode(values, 1));
+  LLVMValueRef Return = LLVMBuildRetVoid(Builder);
 
-  LLVMDisposeBuilder(b);
-  LLVMDeleteInstruction(ret);
+  const char Name[] = "kind";
+  LLVMValueRef Int = LLVMConstInt(LLVMInt32Type(), 0, 0);
+  LLVMSetMetadata(Return, LLVMGetMDKindID(Name, strlen(Name)),
+                  LLVMMDNode(&Int, 1));
+
+  LLVMDisposeBuilder(Builder);
+  LLVMDeleteInstruction(Return);
 
   return 0;
 }
 
 int llvm_replace_md_operand(void) {
-  LLVMModuleRef m = LLVMModuleCreateWithName("Mod");
-  LLVMContextRef context = LLVMGetModuleContext(m);
-  unsigned int tmp = 0;
-
-  LLVMMetadataRef metas[] = {LLVMMDStringInContext2(context, "foo", 3)};
-  LLVMValueRef md =
-      LLVMMetadataAsValue(context, LLVMMDNodeInContext2(context, metas, 1));
-
-  LLVMReplaceMDNodeOperandWith(md, 0,
-                               LLVMMDStringInContext2(context, "bar", 3));
+  LLVMModuleRef M = LLVMModuleCreateWithName("Mod");
+  LLVMContextRef Context = LLVMGetModuleContext(M);
 
-  assert(!strncmp(LLVMGetMDString(LLVMGetOperand(md, 0), &tmp), "bar", 0));
-  (void)tmp;
+  const char String1[] = "foo";
+  LLVMMetadataRef String1MD =
+      LLVMMDStringInContext2(Context, String1, strlen(String1));
+  LLVMMetadataRef NodeMD = LLVMMDNodeInContext2(Context, &String1MD, 1);
+  LLVMValueRef Value = LLVMMetadataAsValue(Context, NodeMD);
+
+  const char String2[] = "bar";
+  LLVMMetadataRef String2MD =
+      LLVMMDStringInContext2(Context, String2, strlen(String2));
+  LLVMReplaceMDNodeOperandWith(Value, 0, String2MD);
+
+  LLVMValueRef Operand = LLVMGetOperand(Value, 0);
+
+  unsigned int Len;
+  const char *String = LLVMGetMDString(Operand, &Len);
+  assert(Len == strlen(String2));
+  assert(strncmp(String, String2, Len) == 0);
+  (void)String;
 
-  LLVMDisposeModule(m);
+  LLVMDisposeModule(M);
 
   return 0;
 }
 
 int llvm_is_a_value_as_metadata(void) {
-  LLVMModuleRef m = LLVMModuleCreateWithName("Mod");
-  LLVMContextRef context = LLVMGetModuleContext(m);
+  LLVMModuleRef M = LLVMModuleCreateWithName("Mod");
+  LLVMContextRef Context = LLVMGetModuleContext(M);
 
-  LLVMValueRef values[] = {LLVMConstInt(LLVMInt32Type(), 0, 0)};
-  LLVMValueRef md = LLVMMDNode(values, 1);
-  assert(LLVMIsAValueAsMetadata(md) == md);
-  (void)md;
-
-  LLVMMetadataRef metas[] = {LLVMMDStringInContext2(context, "foo", 3)};
-  LLVMValueRef md2 =
-      LLVMMetadataAsValue(context, LLVMMDNodeInContext2(context, metas, 1));
-  assert(LLVMIsAValueAsMetadata(md2) == NULL);
-  (void)md2;
+  {
+    LLVMValueRef Int = LLVMConstInt(LLVMInt32Type(), 0, 0);
+    LLVMValueRef NodeMD = LLVMMDNode(&Int, 1);
+    assert(LLVMIsAValueAsMetadata(NodeMD) == NodeMD);
+    (void)NodeMD;
+  }
+
+  {
+    const char String[] = "foo";
+    LLVMMetadataRef StringMD =
+        LLVMMDStringInContext2(Context, String, strlen(String));
+    LLVMMetadataRef NodeMD = LLVMMDNodeInContext2(Context, &StringMD, 1);
+    LLVMValueRef Value = LLVMMetadataAsValue(Context, NodeMD);
+    assert(LLVMIsAValueAsMetadata(Value) == NULL);
+    (void)Value;
+  }
 
   return 0;
 }