Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for pointer and array debug types #349

Merged
merged 4 commits into from
Sep 14, 2022
Merged

Add support for pointer and array debug types #349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
80d50e1
Add support for pointer and array debug types
ghaith Sep 2, 2022
644ad10
Fixed a LLVM 7 compile issue in the tests
ghaith Sep 2, 2022
91dc6f3
Add reference type creation
ghaith Sep 5, 2022
9c09779
Removed the import reference to 140
ghaith Sep 5, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 93 additions & 8 deletions src/debug_info.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ use crate::context::Context;
pub use crate::debug_info::flags::{DIFlags, DIFlagsConstants};
use crate::module::Module;
use crate::values::{AsValueRef, BasicValueEnum, InstructionValue, MetadataValue, PointerValue};
use crate::AddressSpace;

#[cfg(feature = "internal-getters")]
use crate::LLVMReference;
Expand All @@ -118,20 +119,22 @@ use llvm_sys::debuginfo::LLVMMetadataReplaceAllUsesWith;
use llvm_sys::debuginfo::LLVMTemporaryMDNode;
use llvm_sys::debuginfo::{LLVMCreateDIBuilder, LLVMCreateDIBuilderDisallowUnresolved};
use llvm_sys::debuginfo::{
LLVMDIBuilderCreateAutoVariable, LLVMDIBuilderCreateBasicType, LLVMDIBuilderCreateCompileUnit,
LLVMDIBuilderCreateDebugLocation, LLVMDIBuilderCreateExpression, LLVMDIBuilderCreateFile,
LLVMDIBuilderCreateFunction, LLVMDIBuilderCreateLexicalBlock, LLVMDIBuilderCreateMemberType,
LLVMDIBuilderCreateNameSpace, LLVMDIBuilderCreateParameterVariable, LLVMDIBuilderCreateStructType,
LLVMDIBuilderCreateSubroutineType, LLVMDIBuilderCreateUnionType, LLVMDIBuilderFinalize,
LLVMDIBuilderInsertDbgValueBefore, LLVMDIBuilderInsertDeclareAtEnd, LLVMDIBuilderInsertDeclareBefore,
LLVMDILocationGetColumn, LLVMDILocationGetLine, LLVMDILocationGetScope, LLVMDITypeGetAlignInBits,
LLVMDITypeGetOffsetInBits, LLVMDITypeGetSizeInBits,
LLVMDIBuilderCreateArrayType, LLVMDIBuilderCreateAutoVariable, LLVMDIBuilderCreateBasicType,
LLVMDIBuilderCreateCompileUnit, LLVMDIBuilderCreateDebugLocation, LLVMDIBuilderCreateExpression,
LLVMDIBuilderCreateFile, LLVMDIBuilderCreateFunction, LLVMDIBuilderCreateLexicalBlock,
LLVMDIBuilderCreateMemberType, LLVMDIBuilderCreateNameSpace, LLVMDIBuilderCreateParameterVariable,
LLVMDIBuilderCreatePointerType, LLVMDIBuilderCreateReferenceType, LLVMDIBuilderCreateStructType,
LLVMDIBuilderCreateSubroutineType, LLVMDIBuilderCreateUnionType, LLVMDIBuilderFinalize,
LLVMDIBuilderGetOrCreateSubrange, LLVMDIBuilderInsertDbgValueBefore, LLVMDIBuilderInsertDeclareAtEnd,
LLVMDIBuilderInsertDeclareBefore, LLVMDILocationGetColumn, LLVMDILocationGetLine, LLVMDILocationGetScope,
LLVMDITypeGetAlignInBits, LLVMDITypeGetOffsetInBits, LLVMDITypeGetSizeInBits,
};
#[llvm_versions(8.0..=latest)]
use llvm_sys::debuginfo::{LLVMDIBuilderCreateConstantValueExpression, LLVMDIBuilderCreateGlobalVariableExpression};
use llvm_sys::prelude::{LLVMDIBuilderRef, LLVMMetadataRef};
use std::convert::TryInto;
use std::marker::PhantomData;
use std::ops::Range;

/// Gets the version of debug metadata produced by the current LLVM version.
pub fn debug_metadata_version() -> libc::c_uint {
Expand Down Expand Up @@ -677,6 +680,88 @@ impl<'ctx> DebugInfoBuilder<'ctx> {
}
}

/// Creates a pointer type
pub fn create_pointer_type(
&self,
name: &str,
pointee: DIType<'ctx>,
size_in_bits: u64,
align_in_bits: u32,
address_space: AddressSpace,
) -> DIDerivedType<'ctx> {
let metadata_ref = unsafe {
LLVMDIBuilderCreatePointerType(
self.builder,
pointee.metadata_ref,
size_in_bits,
align_in_bits,
address_space as u32,
name.as_ptr() as _,
name.len(),
)
};

DIDerivedType {
metadata_ref,
_marker: PhantomData,
}
}

/// Creates a pointer type
pub fn create_reference_type(
&self,
pointee: DIType<'ctx>,
tag: u32,
) -> DIDerivedType<'ctx> {
let metadata_ref = unsafe {
LLVMDIBuilderCreateReferenceType(
self.builder,
tag,
pointee.metadata_ref,
)
};

DIDerivedType {
metadata_ref,
_marker: PhantomData,
}
}

/// Creates an array type
pub fn create_array_type(
&self,
inner_type: DIType<'ctx>,
size_in_bits: u64,
align_in_bits: u32,
subscripts: &[Range<i64>],
) -> DICompositeType<'ctx> {
//Create subranges
let mut subscripts = subscripts
.iter()
.map(|range| {
let lower = range.start;
let upper = range.end;
let subscript_size = upper - lower;
unsafe { LLVMDIBuilderGetOrCreateSubrange(self.builder, lower, subscript_size) }
})
.collect::<Vec<_>>();
let metadata_ref = unsafe {
LLVMDIBuilderCreateArrayType(
self.builder,
size_in_bits,
align_in_bits,
inner_type.metadata_ref,
subscripts.as_mut_ptr(),
subscripts.len().try_into().unwrap(),
)
};

DICompositeType {
metadata_ref,
_marker: PhantomData,
}
}

#[llvm_versions(8.0..=latest)]
pub fn create_global_variable_expression(
&self,
Expand Down
152 changes: 152 additions & 0 deletions tests/all/test_debug_info.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,3 +417,155 @@ fn test_global_expressions() {
gv.print_to_string()
);
}

#[test]
fn test_pointer_types() {
let context = Context::create();
let module = context.create_module("bin");

let (dibuilder, _) = module.create_debug_info_builder(
true,
DWARFSourceLanguage::C,
"source_file",
".",
"my llvm compiler frontend",
false,
"",
0,
"",
DWARFEmissionKind::Full,
0,
false,
false,
#[cfg(any(
feature = "llvm11-0",
feature = "llvm12-0",
feature = "llvm13-0",
feature = "llvm14-0"
))]
"",
#[cfg(any(
feature = "llvm11-0",
feature = "llvm12-0",
feature = "llvm13-0",
feature = "llvm14-0"
))]
"",
);

let di_type = dibuilder
.create_basic_type(
"type_name",
8_u64,
0x00,
#[cfg(not(feature = "llvm7-0"))]
DIFlags::ZERO,
)
.unwrap()
.as_type();

//Smoke test that the pointer gets created
dibuilder.create_pointer_type("pointer_name", di_type, 64, 64, inkwell::AddressSpace::Global);
}

#[test]
fn test_reference_types() {
let context = Context::create();
let module = context.create_module("bin");

let (dibuilder, _) = module.create_debug_info_builder(
true,
DWARFSourceLanguage::C,
"source_file",
".",
"my llvm compiler frontend",
false,
"",
0,
"",
DWARFEmissionKind::Full,
0,
false,
false,
#[cfg(any(
feature = "llvm11-0",
feature = "llvm12-0",
feature = "llvm13-0",
feature = "llvm14-0"
))]
"",
#[cfg(any(
feature = "llvm11-0",
feature = "llvm12-0",
feature = "llvm13-0",
feature = "llvm14-0"
))]
"",
);

let di_type = dibuilder
.create_basic_type(
"type_name",
8_u64,
0x00,
#[cfg(not(feature = "llvm7-0"))]
DIFlags::ZERO,
)
.unwrap()
.as_type();

//Smoke test that the pointer gets created
dibuilder.create_reference_type(di_type, 0x1000);
}

#[test]
fn test_array_type() {
let context = Context::create();
let module = context.create_module("bin");

let (dibuilder, _) = module.create_debug_info_builder(
true,
DWARFSourceLanguage::C,
"source_file",
".",
"my llvm compiler frontend",
false,
"",
0,
"",
DWARFEmissionKind::Full,
0,
false,
false,
#[cfg(any(
feature = "llvm11-0",
feature = "llvm12-0",
feature = "llvm13-0",
feature = "llvm14-0"
))]
"",
#[cfg(any(
feature = "llvm11-0",
feature = "llvm12-0",
feature = "llvm13-0",
feature = "llvm14-0"
))]
"",
);

let di_type = dibuilder
.create_basic_type(
"type_name",
8_u64,
0x00,
#[cfg(not(feature = "llvm7-0"))]
DIFlags::ZERO,
)
.unwrap()
.as_type();

//Smoke test that the array gets created
dibuilder.create_array_type(di_type, 160, 64, &[(0..20)]);

dibuilder.create_array_type(di_type, 160, 64, &[(0..20), (-1..30), (20..55)]);
}