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
//! This crate implements a JSON API for profiler symbolication with the help of
//! local symbol files. It exposes a single type called `API`, and uses the
//! `samply-symbols` crate for its implementation.
//!
//! Just like the `samply-symbols` crate, this crate does not contain any direct
//! file access. It is written in such a way that it can be compiled to
//! WebAssembly, with all file access being mediated via a `FileAndPathHelper`
//! trait.
//!
//! Do not use this crate directly unless you have to. Instead, use
//! [`wholesym`](https://docs.rs/wholesym), which provides a much more ergonomic Rust API.
//! `wholesym` exposes the JSON API functionality via [`SymbolManager::query_json_api`](https://docs.rs/wholesym/latest/wholesym/struct.SymbolManager.html#method.query_json_api).
//!
//! ## Example
//!
//! ```rust
//! use samply_api::samply_symbols::{
//! FileContents, FileAndPathHelper, FileAndPathHelperResult, OptionallySendFuture,
//! CandidatePathInfo, FileLocation, LibraryInfo, SymbolManager,
//! };
//! use samply_api::samply_symbols::debugid::{CodeId, DebugId};
//!
//! async fn run_query() -> String {
//! let this_dir = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR"));
//! let helper = ExampleHelper {
//! artifact_directory: this_dir.join("..").join("fixtures").join("win64-ci")
//! };
//! let symbol_manager = SymbolManager::with_helper(&helper);
//! let api = samply_api::Api::new(&symbol_manager);
//!
//! api.query_api(
//! "/symbolicate/v5",
//! r#"{
//! "memoryMap": [
//! [
//! "firefox.pdb",
//! "AA152DEB2D9B76084C4C44205044422E1"
//! ]
//! ],
//! "stacks": [
//! [
//! [0, 204776],
//! [0, 129423],
//! [0, 244290],
//! [0, 244219]
//! ]
//! ]
//! }"#,
//! ).await
//! }
//!
//! struct ExampleHelper {
//! artifact_directory: std::path::PathBuf,
//! }
//!
//! impl<'h> FileAndPathHelper<'h> for ExampleHelper {
//! type F = Vec<u8>;
//! type FL = ExampleFileLocation;
//! type OpenFileFuture = std::pin::Pin<
//! Box<dyn OptionallySendFuture<Output = FileAndPathHelperResult<Self::F>> + 'h>,
//! >;
//!
//! fn get_candidate_paths_for_debug_file(
//! &self,
//! library_info: &LibraryInfo,
//! ) -> FileAndPathHelperResult<Vec<CandidatePathInfo<ExampleFileLocation>>> {
//! if let Some(debug_name) = library_info.debug_name.as_deref() {
//! Ok(vec![CandidatePathInfo::SingleFile(ExampleFileLocation(
//! self.artifact_directory.join(debug_name),
//! ))])
//! } else {
//! Ok(vec![])
//! }
//! }
//!
//! fn get_candidate_paths_for_binary(
//! &self,
//! library_info: &LibraryInfo,
//! ) -> FileAndPathHelperResult<Vec<CandidatePathInfo<ExampleFileLocation>>> {
//! if let Some(name) = library_info.name.as_deref() {
//! Ok(vec![CandidatePathInfo::SingleFile(ExampleFileLocation(
//! self.artifact_directory.join(name),
//! ))])
//! } else {
//! Ok(vec![])
//! }
//! }
//!
//! fn get_dyld_shared_cache_paths(
//! &self,
//! _arch: Option<&str>,
//! ) -> FileAndPathHelperResult<Vec<ExampleFileLocation>> {
//! Ok(vec![])
//! }
//!
//! fn load_file(
//! &'h self,
//! location: ExampleFileLocation,
//! ) -> std::pin::Pin<
//! Box<dyn OptionallySendFuture<Output = FileAndPathHelperResult<Self::F>> + 'h>,
//! > {
//! async fn load_file_impl(path: std::path::PathBuf) -> FileAndPathHelperResult<Vec<u8>> {
//! Ok(std::fs::read(&path)?)
//! }
//!
//! Box::pin(load_file_impl(location.0))
//! }
//! }
//!
//! #[derive(Clone, Debug)]
//! struct ExampleFileLocation(std::path::PathBuf);
//!
//! impl std::fmt::Display for ExampleFileLocation {
//! fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
//! self.0.to_string_lossy().fmt(f)
//! }
//! }
//!
//! impl FileLocation for ExampleFileLocation {
//! fn location_for_dyld_subcache(&self, suffix: &str) -> Option<Self> {
//! let mut filename = self.0.file_name().unwrap().to_owned();
//! filename.push(suffix);
//! Some(Self(self.0.with_file_name(filename)))
//! }
//!
//! fn location_for_external_object_file(&self, object_file: &str) -> Option<Self> {
//! Some(Self(object_file.into()))
//! }
//!
//! fn location_for_pdb_from_binary(&self, pdb_path_in_binary: &str) -> Option<Self> {
//! Some(Self(pdb_path_in_binary.into()))
//! }
//!
//! fn location_for_source_file(&self, source_file_path: &str) -> Option<Self> {
//! Some(Self(source_file_path.into()))
//! }
//!
//! fn location_for_breakpad_symindex(&self) -> Option<Self> {
//! Some(Self(self.0.with_extension("symindex")))
//! }
//! }
//! ```
pub use samply_symbols;
pub use samply_symbols::debugid;
use samply_symbols::{FileAndPathHelper, SymbolManager};
use asm::AsmApi;
use debugid::DebugId;
use serde_json::json;
use source::SourceApi;
use symbolicate::SymbolicateApi;
mod api_file_path;
mod asm;
mod error;
mod hex;
mod source;
mod symbolicate;
pub(crate) fn to_debug_id(breakpad_id: &str) -> Result<DebugId, samply_symbols::Error> {
DebugId::from_breakpad(breakpad_id)
.map_err(|_| samply_symbols::Error::InvalidBreakpadId(breakpad_id.to_string()))
}
#[derive(Clone, Copy)]
pub struct Api<'a, 'h: 'a, H: FileAndPathHelper<'h>> {
symbol_manager: &'a SymbolManager<'h, H>,
}
impl<'a, 'h: 'a, H: FileAndPathHelper<'h>> Api<'a, 'h, H> {
/// Create a [`Api`] instance which uses the provided [`SymbolManager`].
pub fn new(symbol_manager: &'a SymbolManager<'h, H>) -> Self {
Self { symbol_manager }
}
/// This is the main API of this crate.
/// It implements the "Tecken" JSON API, which is also used by the Mozilla symbol server.
/// It's intended to be used as a drop-in "local symbol server" which gathers its data
/// directly from file artifacts produced during compilation (rather than consulting
/// e.g. a database).
/// The caller needs to implement the `FileAndPathHelper` trait to provide file system access.
/// The return value is a JSON string.
///
/// The following "URLs" are supported:
/// - `/symbolicate/v5`: This API is documented at <https://tecken.readthedocs.io/en/latest/symbolication.html>.
/// The returned data has two extra fields: inlines (per address) and module_errors (per job).
/// - `/source/v1`: Experimental API. Symbolicates an address and lets you read one of the files in the
/// symbol information for that address.
/// - `/asm/v1`: Experimental API. Symbolicates an address and lets you read one of the files in the
/// symbol information for that address.
pub async fn query_api(self, request_url: &str, request_json_data: &str) -> String {
if request_url == "/symbolicate/v5" {
let symbolicate_api = SymbolicateApi::new(self.symbol_manager);
symbolicate_api.query_api_json(request_json_data).await
} else if request_url == "/source/v1" {
let source_api = SourceApi::new(self.symbol_manager);
source_api.query_api_json(request_json_data).await
} else if request_url == "/asm/v1" {
let asm_api = AsmApi::new(self.symbol_manager);
asm_api.query_api_json(request_json_data).await
} else {
json!({ "error": format!("Unrecognized URL {request_url}") }).to_string()
}
}
}