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 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
use std::collections::BTreeMap;
use std::io::Write;
use std::iter::Enumerate;
use std::str::Lines;
use symbolic_common::{ByteView, DebugId};
use symbolic_debuginfo::{DebugSession, ObjectLike};
/// A line mapping extracted from an object.
///
/// This is only intended as an intermediate structure for serialization,
/// not for lookups.
pub struct ObjectLineMapping {
mapping: BTreeMap<String, BTreeMap<String, BTreeMap<u32, u32>>>,
debug_id: DebugId,
}
impl ObjectLineMapping {
/// Create a line mapping from the given `object`.
///
/// The mapping is constructed by iterating over all the source files referenced by `object` and
/// parsing Il2cpp `source_info` records from each.
pub fn from_object<'data, 'object, O, E>(object: &'object O) -> Result<Self, E>
where
O: ObjectLike<'data, 'object, Error = E>,
{
let session = object.debug_session()?;
let debug_id = object.debug_id();
let mut mapping = BTreeMap::new();
for cpp_file in session.files() {
let cpp_file_path = cpp_file?.abs_path_str();
if mapping.contains_key(&cpp_file_path) {
continue;
}
if let Ok(cpp_source) = ByteView::open(&cpp_file_path) {
let cpp_mapping = Self::parse_source_file(&cpp_source);
if !cpp_mapping.is_empty() {
mapping.insert(cpp_file_path, cpp_mapping);
}
}
}
Ok(Self { mapping, debug_id })
}
/// Create a line mapping from the source file.
///
/// The mapping is constructed by parsing Il2cpp `source_info` records in the given source file.
pub(crate) fn parse_source_file(cpp_source: &[u8]) -> BTreeMap<String, BTreeMap<u32, u32>> {
let mut cpp_mapping = BTreeMap::new();
for SourceInfo {
cpp_line,
cs_file,
cs_line,
} in SourceInfos::new(cpp_source)
{
let cs_mapping = cpp_mapping
.entry(cs_file.to_string())
.or_insert_with(BTreeMap::new);
cs_mapping.insert(cpp_line, cs_line);
}
cpp_mapping
}
/// Serializes the line mapping to the given writer as JSON.
///
/// The mapping is serialized in the form of nested objects:
/// C++ file => C# file => C++ line => C# line
///
/// Returns `false` if the resulting JSON did not contain any mappings.
pub fn to_writer<W: Write>(mut self, writer: &mut W) -> std::io::Result<bool> {
let is_empty = self.mapping.is_empty();
// This is a big hack: We need the files for different architectures to be different.
// To achieve this, we put the debug-id of the file (which is different between architectures)
// into the same structure as the normal map, like so:
// `"__debug-id__": {"00000000-0000-0000-0000-000000000000": {}}`
// When parsing via `LineMapping::parse`, this *looks like* a valid entry, but we will
// most likely never have a C++ file named `__debug-id__` ;-)
let value = BTreeMap::from([(self.debug_id.to_string(), Default::default())]);
self.mapping.insert("__debug-id__".to_owned(), value);
serde_json::to_writer(writer, &self.mapping)?;
Ok(!is_empty)
}
}
/// An Il2cpp `source_info` record.
#[derive(Debug, PartialEq, Eq)]
pub(crate) struct SourceInfo<'data> {
/// The C++ source line the `source_info` was parsed from.
pub(crate) cpp_line: u32,
/// The corresponding C# source file.
cs_file: &'data str,
/// The corresponding C# source line.
pub(crate) cs_line: u32,
}
/// An iterator over Il2cpp `source_info` markers.
///
/// The Iterator yields `SourceInfo`s.
pub(crate) struct SourceInfos<'data> {
lines: Enumerate<Lines<'data>>,
current: Option<(&'data str, u32)>,
}
impl<'data> SourceInfos<'data> {
/// Parses the `source` leniently, yielding an empty Iterator for non-utf8 data.
pub(crate) fn new(source: &'data [u8]) -> Self {
let lines = std::str::from_utf8(source)
.ok()
.unwrap_or_default()
.lines()
.enumerate();
Self {
lines,
current: None,
}
}
}
impl<'data> Iterator for SourceInfos<'data> {
type Item = SourceInfo<'data>;
fn next(&mut self) -> Option<Self::Item> {
for (cpp_line_nr, cpp_src_line) in &mut self.lines {
match parse_line(cpp_src_line) {
// A new source info record. Emit the previously found one, if there is one.
Some((cs_file, cs_line)) => {
if let Some((cs_file, cs_line)) = self.current.replace((cs_file, cs_line)) {
return Some(SourceInfo {
cpp_line: cpp_line_nr as u32,
cs_file,
cs_line,
});
}
}
// A comment. Just continue.
None if cpp_src_line.trim_start().starts_with("//") => continue,
// A source line. Emit the previously found source info record, if there is one.
None => {
if let Some((cs_file, cs_line)) = self.current.take() {
return Some(SourceInfo {
cpp_line: (cpp_line_nr + 1) as u32,
cs_file,
cs_line,
});
}
}
}
}
None
}
}
/// Extracts the `(file, line)` information
///
/// For example, `//<source_info:main.cs:17>`
/// would be parsed as `("main.cs", 17)`.
fn parse_line(line: &str) -> Option<(&str, u32)> {
let line = line.trim();
let source_ref = line.strip_prefix("//<source_info:")?;
let source_ref = source_ref.strip_suffix('>')?;
let (file, line) = source_ref.rsplit_once(':')?;
let line = line.parse().ok()?;
Some((file, line))
}
#[cfg(test)]
mod tests {
use super::{SourceInfo, SourceInfos};
#[test]
fn one_mapping() {
let cpp_source = b"
Lorem ipsum dolor sit amet
//<source_info:main.cs:17>
// some
// more
// comments
actual source code";
let source_infos: Vec<_> = SourceInfos::new(cpp_source).collect();
assert_eq!(
source_infos,
vec![SourceInfo {
cpp_line: 7,
cs_file: "main.cs",
cs_line: 17,
}]
)
}
#[test]
fn several_mappings() {
let cpp_source = b"
Lorem ipsum dolor sit amet
//<source_info:main.cs:17>
// some
// comments
actual source code 1
actual source code 2
//<source_info:main.cs:29>
actual source code 3
//<source_info:main.cs:46>
// more
// comments
actual source code 4";
let source_infos: Vec<_> = SourceInfos::new(cpp_source).collect();
assert_eq!(
source_infos,
vec![
SourceInfo {
cpp_line: 6,
cs_file: "main.cs",
cs_line: 17,
},
SourceInfo {
cpp_line: 10,
cs_file: "main.cs",
cs_line: 29,
},
SourceInfo {
cpp_line: 15,
cs_file: "main.cs",
cs_line: 46,
}
]
)
}
#[test]
fn missing_source_line() {
let cpp_source = b"
Lorem ipsum dolor sit amet
//<source_info:main.cs:17>
// some
// comments
//<source_info:main.cs:29>
actual source code";
let source_infos: Vec<_> = SourceInfos::new(cpp_source).collect();
// The first source info has no source line to attach to, so it should use the line
// immediately before the second source_info.
assert_eq!(
source_infos,
vec![
SourceInfo {
cpp_line: 5,
cs_file: "main.cs",
cs_line: 17,
},
SourceInfo {
cpp_line: 7,
cs_file: "main.cs",
cs_line: 29,
},
]
)
}
#[test]
fn broken() {
let cpp_source = b"
Lorem ipsum dolor sit amet
//<source_info:main.cs:17>
// some
// more
// comments";
// Since there is no non-comment line for the source info to attach to,
// no source infos should be returned.
assert_eq!(SourceInfos::new(cpp_source).count(), 0);
}
}