1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
use std::collections::HashMap;
use std::os::unix::ffi::OsStrExt;
use std::{env, ffi, ptr};
use codespan_reporting::files::Files as _;
use llvm_sys::core::*;
use llvm_sys::debuginfo::*;
use llvm_sys::prelude::*;
use arret_syntax::datum::DataStr;
use arret_syntax::span::{FileId, Span};
use crate::source::SourceLoader;
pub struct DebugInfoBuilder<'sl> {
pub llvm_dib: LLVMDIBuilderRef,
source_loader: &'sl SourceLoader,
current_dir: ffi::OsString,
file_metadata: HashMap<FileId, LLVMMetadataRef>,
}
impl<'sl> DebugInfoBuilder<'sl> {
pub fn new(
source_loader: &'sl SourceLoader,
optimised: bool,
main_span: Span,
module: LLVMModuleRef,
) -> DebugInfoBuilder<'sl> {
let current_dir = env::current_dir()
.ok()
.map(|current_dir| current_dir.as_os_str().to_owned())
.unwrap_or_else(ffi::OsString::new);
let llvm_dib = unsafe { LLVMCreateDIBuilderDisallowUnresolved(module) };
let mut di_builder = DebugInfoBuilder {
llvm_dib,
source_loader,
current_dir,
file_metadata: HashMap::new(),
};
di_builder.add_compile_unit_metadata(optimised, main_span);
di_builder
}
fn add_compile_unit_metadata(&mut self, optimised: bool, main_span: Span) {
let main_file_id = if let Some(file_id) = main_span.file_id() {
file_id
} else {
return;
};
let main_file_metadata = self.file_metadata(main_file_id);
let producer = b"arret\0";
unsafe {
LLVMDIBuilderCreateCompileUnit(
self.llvm_dib,
LLVMDWARFSourceLanguage::LLVMDWARFSourceLanguageC,
main_file_metadata,
producer.as_ptr() as *const _,
producer.len(),
optimised as i32,
ptr::null(),
0,
0,
ptr::null(),
0,
LLVMDWARFEmissionKind::LLVMDWARFEmissionKindFull,
0,
0,
0,
);
}
}
pub fn file_metadata(&mut self, file_id: FileId) -> LLVMMetadataRef {
if let Some(metadata) = self.file_metadata.get(&file_id) {
return *metadata;
}
let filename = self.source_loader.files().name(file_id).unwrap();
let metadata = unsafe {
LLVMDIBuilderCreateFile(
self.llvm_dib,
filename.as_ptr() as *const _,
filename.len(),
self.current_dir.as_bytes().as_ptr() as *const _,
self.current_dir.as_bytes().len(),
)
};
self.file_metadata.insert(file_id, metadata);
metadata
}
pub fn placeholder_subroutine_type(
&mut self,
file_metadata: LLVMMetadataRef,
) -> LLVMMetadataRef {
unsafe {
LLVMDIBuilderCreateSubroutineType(
self.llvm_dib,
file_metadata,
ptr::null_mut(),
0,
LLVMDIFlagZero,
)
}
}
pub fn add_function_debug_info(
&mut self,
span: Span,
source_name: Option<&DataStr>,
llvm_function: LLVMValueRef,
) {
let file_id = if let Some(file_id) = span.file_id() {
file_id
} else {
return;
};
let location = if let Ok(location) = self
.source_loader
.files()
.location(file_id, span.start() as usize)
{
location
} else {
return;
};
let line_index = location.line_number - 1;
let file_metadata = self.file_metadata(file_id);
unsafe {
let mut linkage_name_len: usize = 0;
let linkage_name_ptr = LLVMGetValueName2(llvm_function, &mut linkage_name_len);
let function_metadata = LLVMDIBuilderCreateFunction(
self.llvm_dib,
file_metadata,
source_name
.map(|source_name| source_name.as_ptr() as *const _)
.unwrap_or(linkage_name_ptr),
source_name
.as_ref()
.map(|source_name| source_name.len())
.unwrap_or(linkage_name_len),
linkage_name_ptr,
linkage_name_len,
file_metadata,
line_index as u32,
self.placeholder_subroutine_type(file_metadata),
source_name.is_none() as i32,
1,
line_index as u32,
LLVMDIFlagZero,
1,
);
LLVMSetSubprogram(llvm_function, function_metadata);
}
}
pub fn finalise(&mut self) {
unsafe {
LLVMDIBuilderFinalize(self.llvm_dib);
}
}
}
impl Drop for DebugInfoBuilder<'_> {
fn drop(&mut self) {
unsafe { LLVMDisposeDIBuilder(self.llvm_dib) }
}
}