mirror of
https://github.com/llvm/llvm-project.git
synced 2025-04-26 17:06:07 +00:00
2a2fd488b6
Follow on from #84915 which adds the DbgRecord function variants. The C API changes were reviewed in #85657. # C API Update the LLVMDIBuilderInsert... functions to insert DbgRecords instead of debug intrinsics. LLVMDIBuilderInsertDeclareBefore LLVMDIBuilderInsertDeclareAtEnd LLVMDIBuilderInsertDbgValueBefore LLVMDIBuilderInsertDbgValueAtEnd Calling these functions will now cause an assertion if the module is in the wrong debug info format. They should only be used when the module is in "new debug format". Use LLVMIsNewDbgInfoFormat to query and LLVMSetIsNewDbgInfoFormat to change the debug info format of a module. Please see https://llvm.org/docs/RemoveDIsDebugInfo.html#c-api-change (RemoveDIsDebugInfo.md) for more info. # OCaml bindings Add set_is_new_dbg_info_format and is_new_dbg_info_format to the OCaml bindings. These can be used to set and query the current debug info mode. These will eventually be removed, but are useful while we're transitioning between old and new debug info formats. Add string_of_lldbgrecord, like string_of_llvalue but prints DbgRecords. In test dbginfo.ml, unconditionally set the module debug info to the new mode and update CHECK lines to check for DbgRecords. Without this change the test crashes because it attempts to insert DbgRecords (new default behaviour of llvm_dibuild_insert_declare_...) into a module that is in the old debug info mode.
281 lines
12 KiB
C
281 lines
12 KiB
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>
|
|
|
|
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);
|
|
LLVMDIBuilderCreateObjCIVar(DIB, "_test", 5, File, 42, 64, 0, 64, LLVMDIFlagPublic, SuperDecl, TestProperty);
|
|
return Decl;
|
|
}
|
|
|
|
int llvm_test_dibuilder(bool NewDebugInfoFormat) {
|
|
const char *Filename = "debuginfo.c";
|
|
LLVMModuleRef M = LLVMModuleCreateWithName(Filename);
|
|
LLVMSetIsNewDbgInfoFormat(M, NewDebugInfoFormat);
|
|
LLVMDIBuilderRef DIB = LLVMCreateDIBuilder(M);
|
|
|
|
LLVMMetadataRef File = LLVMDIBuilderCreateFile(DIB, Filename,
|
|
strlen(Filename), ".", 1);
|
|
|
|
LLVMMetadataRef CompileUnit = LLVMDIBuilderCreateCompileUnit(
|
|
DIB, LLVMDWARFSourceLanguageC, File, "llvm-c-test", 11, 0, NULL, 0, 0,
|
|
NULL, 0, LLVMDWARFEmissionFull, 0, 0, 0, "/", 1, "", 0);
|
|
|
|
LLVMMetadataRef Module =
|
|
LLVMDIBuilderCreateModule(DIB, CompileUnit,
|
|
"llvm-c-test", 11,
|
|
"", 0,
|
|
"/test/include/llvm-c-test.h", 27,
|
|
"", 0);
|
|
|
|
LLVMMetadataRef OtherModule =
|
|
LLVMDIBuilderCreateModule(DIB, CompileUnit,
|
|
"llvm-c-test-import", 18,
|
|
"", 0,
|
|
"/test/include/llvm-c-test-import.h", 34,
|
|
"", 0);
|
|
LLVMMetadataRef ImportedModule = LLVMDIBuilderCreateImportedModuleFromModule(
|
|
DIB, Module, OtherModule, File, 42, NULL, 0);
|
|
LLVMDIBuilderCreateImportedModuleFromAlias(DIB, Module, ImportedModule, File,
|
|
42, NULL, 0);
|
|
|
|
LLVMMetadataRef ClassTy = declare_objc_class(DIB, File);
|
|
LLVMMetadataRef GlobalClassValueExpr =
|
|
LLVMDIBuilderCreateConstantValueExpression(DIB, 0);
|
|
LLVMDIBuilderCreateGlobalVariableExpression(
|
|
DIB, Module, "globalClass", 11, "", 0, File, 1, ClassTy, true,
|
|
GlobalClassValueExpr, NULL, 0);
|
|
|
|
LLVMMetadataRef Int64Ty =
|
|
LLVMDIBuilderCreateBasicType(DIB, "Int64", 5, 64, 0, LLVMDIFlagZero);
|
|
LLVMMetadataRef Int64TypeDef =
|
|
LLVMDIBuilderCreateTypedef(DIB, Int64Ty, "int64_t", 7, File, 42, File, 0);
|
|
|
|
LLVMMetadataRef GlobalVarValueExpr =
|
|
LLVMDIBuilderCreateConstantValueExpression(DIB, 0);
|
|
LLVMDIBuilderCreateGlobalVariableExpression(
|
|
DIB, Module, "global", 6, "", 0, File, 1, Int64TypeDef, true,
|
|
GlobalVarValueExpr, NULL, 0);
|
|
|
|
LLVMMetadataRef NameSpace =
|
|
LLVMDIBuilderCreateNameSpace(DIB, Module, "NameSpace", 9, false);
|
|
|
|
LLVMMetadataRef StructDbgElts[] = {Int64Ty, Int64Ty, Int64Ty};
|
|
LLVMMetadataRef StructDbgTy =
|
|
LLVMDIBuilderCreateStructType(DIB, NameSpace, "MyStruct",
|
|
8, File, 0, 192, 0, 0, NULL, StructDbgElts, 3,
|
|
LLVMDWARFSourceLanguageC, NULL, "MyStruct", 8);
|
|
|
|
LLVMMetadataRef StructDbgPtrTy =
|
|
LLVMDIBuilderCreatePointerType(DIB, StructDbgTy, 192, 0, 0, "", 0);
|
|
|
|
LLVMAddNamedMetadataOperand(M, "FooType",
|
|
LLVMMetadataAsValue(LLVMGetModuleContext(M), StructDbgPtrTy));
|
|
|
|
|
|
LLVMTypeRef FooParamTys[] = {
|
|
LLVMInt64Type(),
|
|
LLVMInt64Type(),
|
|
LLVMVectorType(LLVMInt64Type(), 10),
|
|
};
|
|
LLVMTypeRef FooFuncTy = LLVMFunctionType(LLVMInt64Type(), FooParamTys, 3, 0);
|
|
LLVMValueRef FooFunction = LLVMAddFunction(M, "foo", FooFuncTy);
|
|
LLVMBasicBlockRef FooEntryBlock = LLVMAppendBasicBlock(FooFunction, "entry");
|
|
|
|
LLVMMetadataRef Subscripts[] = {
|
|
LLVMDIBuilderGetOrCreateSubrange(DIB, 0, 10),
|
|
};
|
|
LLVMMetadataRef VectorTy =
|
|
LLVMDIBuilderCreateVectorType(DIB, 64 * 10, 0,
|
|
Int64Ty, Subscripts, 1);
|
|
|
|
|
|
LLVMMetadataRef ParamTypes[] = {Int64Ty, Int64Ty, VectorTy};
|
|
LLVMMetadataRef FunctionTy =
|
|
LLVMDIBuilderCreateSubroutineType(DIB, File, ParamTypes, 3, 0);
|
|
|
|
LLVMMetadataRef ReplaceableFunctionMetadata =
|
|
LLVMDIBuilderCreateReplaceableCompositeType(DIB, 0x15, "foo", 3,
|
|
File, File, 42,
|
|
0, 0, 0,
|
|
LLVMDIFlagFwdDecl,
|
|
"", 0);
|
|
|
|
LLVMMetadataRef FooParamLocation =
|
|
LLVMDIBuilderCreateDebugLocation(LLVMGetGlobalContext(), 42, 0,
|
|
ReplaceableFunctionMetadata, NULL);
|
|
LLVMMetadataRef FunctionMetadata =
|
|
LLVMDIBuilderCreateFunction(DIB, File, "foo", 3, "foo", 3,
|
|
File, 42, FunctionTy, true, true,
|
|
42, 0, false);
|
|
LLVMMetadataReplaceAllUsesWith(ReplaceableFunctionMetadata, FunctionMetadata);
|
|
|
|
LLVMMetadataRef FooParamExpression =
|
|
LLVMDIBuilderCreateExpression(DIB, NULL, 0);
|
|
LLVMMetadataRef FooParamVar1 =
|
|
LLVMDIBuilderCreateParameterVariable(DIB, FunctionMetadata, "a", 1, 1, File,
|
|
42, Int64Ty, true, 0);
|
|
|
|
if (LLVMIsNewDbgInfoFormat(M))
|
|
LLVMDIBuilderInsertDeclareAtEnd(
|
|
DIB, LLVMConstInt(LLVMInt64Type(), 0, false), FooParamVar1,
|
|
FooParamExpression, FooParamLocation, FooEntryBlock);
|
|
else
|
|
LLVMDIBuilderInsertDeclareIntrinsicAtEnd(
|
|
DIB, LLVMConstInt(LLVMInt64Type(), 0, false), FooParamVar1,
|
|
FooParamExpression, FooParamLocation, FooEntryBlock);
|
|
LLVMMetadataRef FooParamVar2 =
|
|
LLVMDIBuilderCreateParameterVariable(DIB, FunctionMetadata, "b", 1, 2, File,
|
|
42, Int64Ty, true, 0);
|
|
|
|
if (LLVMIsNewDbgInfoFormat(M))
|
|
LLVMDIBuilderInsertDeclareAtEnd(
|
|
DIB, LLVMConstInt(LLVMInt64Type(), 0, false), FooParamVar2,
|
|
FooParamExpression, FooParamLocation, FooEntryBlock);
|
|
else
|
|
LLVMDIBuilderInsertDeclareIntrinsicAtEnd(
|
|
DIB, LLVMConstInt(LLVMInt64Type(), 0, false), FooParamVar2,
|
|
FooParamExpression, FooParamLocation, FooEntryBlock);
|
|
|
|
LLVMMetadataRef FooParamVar3 =
|
|
LLVMDIBuilderCreateParameterVariable(DIB, FunctionMetadata, "c", 1, 3, File,
|
|
42, VectorTy, true, 0);
|
|
if (LLVMIsNewDbgInfoFormat(M))
|
|
LLVMDIBuilderInsertDeclareAtEnd(
|
|
DIB, LLVMConstInt(LLVMInt64Type(), 0, false), FooParamVar3,
|
|
FooParamExpression, FooParamLocation, FooEntryBlock);
|
|
else
|
|
LLVMDIBuilderInsertDeclareIntrinsicAtEnd(
|
|
DIB, LLVMConstInt(LLVMInt64Type(), 0, false), FooParamVar3,
|
|
FooParamExpression, FooParamLocation, FooEntryBlock);
|
|
|
|
LLVMSetSubprogram(FooFunction, FunctionMetadata);
|
|
|
|
LLVMMetadataRef FooLexicalBlock =
|
|
LLVMDIBuilderCreateLexicalBlock(DIB, FunctionMetadata, File, 42, 0);
|
|
|
|
LLVMBasicBlockRef FooVarBlock = LLVMAppendBasicBlock(FooFunction, "vars");
|
|
LLVMMetadataRef FooVarsLocation =
|
|
LLVMDIBuilderCreateDebugLocation(LLVMGetGlobalContext(), 43, 0,
|
|
FunctionMetadata, NULL);
|
|
LLVMMetadataRef FooVar1 =
|
|
LLVMDIBuilderCreateAutoVariable(DIB, FooLexicalBlock, "d", 1, File,
|
|
43, Int64Ty, true, 0, 0);
|
|
LLVMValueRef FooVal1 = LLVMConstInt(LLVMInt64Type(), 0, false);
|
|
LLVMMetadataRef FooVarValueExpr =
|
|
LLVMDIBuilderCreateConstantValueExpression(DIB, 0);
|
|
if (LLVMIsNewDbgInfoFormat(M))
|
|
LLVMDIBuilderInsertDbgValueRecordAtEnd(
|
|
DIB, FooVal1, FooVar1, FooVarValueExpr, FooVarsLocation, FooVarBlock);
|
|
else
|
|
LLVMDIBuilderInsertDbgValueIntrinsicAtEnd(
|
|
DIB, FooVal1, FooVar1, FooVarValueExpr, FooVarsLocation, FooVarBlock);
|
|
|
|
LLVMMetadataRef MacroFile =
|
|
LLVMDIBuilderCreateTempMacroFile(DIB, NULL, 0, File);
|
|
LLVMDIBuilderCreateMacro(DIB, MacroFile, 0, LLVMDWARFMacinfoRecordTypeDefine,
|
|
"SIMPLE_DEFINE", 13, NULL, 0);
|
|
LLVMDIBuilderCreateMacro(DIB, MacroFile, 0, LLVMDWARFMacinfoRecordTypeDefine,
|
|
"VALUE_DEFINE", 12, "1", 1);
|
|
|
|
LLVMMetadataRef EnumeratorTestA =
|
|
LLVMDIBuilderCreateEnumerator(DIB, "Test_A", strlen("Test_A"), 0, true);
|
|
LLVMMetadataRef EnumeratorTestB =
|
|
LLVMDIBuilderCreateEnumerator(DIB, "Test_B", strlen("Test_B"), 1, true);
|
|
LLVMMetadataRef EnumeratorTestC =
|
|
LLVMDIBuilderCreateEnumerator(DIB, "Test_B", strlen("Test_C"), 2, true);
|
|
LLVMMetadataRef EnumeratorsTest[] = {EnumeratorTestA, EnumeratorTestB,
|
|
EnumeratorTestC};
|
|
LLVMMetadataRef EnumTest = LLVMDIBuilderCreateEnumerationType(
|
|
DIB, NameSpace, "EnumTest", strlen("EnumTest"), File, 0, 64, 0,
|
|
EnumeratorsTest, 3, Int64Ty);
|
|
LLVMAddNamedMetadataOperand(
|
|
M, "EnumTest", LLVMMetadataAsValue(LLVMGetModuleContext(M), EnumTest));
|
|
|
|
LLVMDIBuilderFinalize(DIB);
|
|
|
|
char *MStr = LLVMPrintModuleToString(M);
|
|
puts(MStr);
|
|
LLVMDisposeMessage(MStr);
|
|
|
|
LLVMDisposeDIBuilder(DIB);
|
|
LLVMDisposeModule(M);
|
|
|
|
return 0;
|
|
}
|
|
|
|
int llvm_get_di_tag(void) {
|
|
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");
|
|
|
|
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);
|
|
|
|
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);
|
|
|
|
return 0;
|
|
}
|