add optional profiling instrumentation to library crates

Cargo.toml

@@ -35,6 +35,7 @@ message-format-compiler = { path = "crates/message-format-compiler", version = "
 message-format-resource-json = { path = "crates/message-format-resource-json", version = "0.1.0" }
 message-format-resource-toml = { path = "crates/message-format-resource-toml", version = "0.1.0" }
 message-format-runtime = { path = "crates/message-format-runtime", version = "0.1.0" }
+profiling = { version = "1.0", default-features = false }
 
 [workspace.lints]
 # LINEBENDER LINT SET - Cargo.toml - v8

crates/message-format-compiler/Cargo.toml

@@ -18,8 +18,12 @@ hashbrown = { default-features = false, features = [
 ], version = "0.17.0" }
 icu_normalizer = { default-features = false, features = ["compiled_data"], version = "2.1.1" }
 message-format-runtime = { workspace = true }
+profiling = { optional = true, workspace = true }
 serde = { features = ["derive"], version = "1.0" }
 toml = "0.9"
 
+[features]
+profiling = ["dep:profiling", "message-format-runtime/profiling"]
+
 [lints]
 workspace = true

crates/message-format-compiler/src/compile/mod.rs

@@ -424,6 +424,8 @@ impl CatalogBuilder {
 
     /// Parse one MF2 message body and add it under its explicit message id.
     pub fn add_input(&mut self, input: CompileInput<'_>) -> Result<SourceId, BuildError> {
+        #[cfg(feature = "profiling")]
+        profiling::function_scope!();
         let source_id = self
             .register_source(input.name, input.kind)
             .map_err(|error| BuildError::error(None, error))?;
@@ -461,6 +463,8 @@ impl CatalogBuilder {
 
     /// Parse one resource/container input made up of named MF2 message bodies.
     pub fn add_resource_input(&mut self, input: ResourceInput) -> Result<SourceId, BuildError> {
+        #[cfg(feature = "profiling")]
+        profiling::function_scope!();
         let source_name = input.name.clone();
         let source_kind = input.kind.clone();
         let source_id = self
@@ -515,6 +519,8 @@ impl CatalogBuilder {
 
     /// Compile into a binary catalog payload plus provenance sidecar data.
     pub fn compile(self) -> CompileReport {
+        #[cfg(feature = "profiling")]
+        profiling::function_scope!();
         let Self {
             options,
             sources,
@@ -559,6 +565,8 @@ impl CatalogBuilder {
 /// assert!(!bytes.is_empty());
 /// ```
 pub fn compile_str(source: &str) -> Result<Vec<u8>, CompileError> {
+    #[cfg(feature = "profiling")]
+    profiling::function_scope!();
     compile(source, CompileOptions::default())
 }
 
@@ -575,6 +583,8 @@ pub fn compile_str(source: &str) -> Result<Vec<u8>, CompileError> {
 /// assert!(!bytes.is_empty());
 /// ```
 pub fn compile(source: &str, options: CompileOptions) -> Result<Vec<u8>, CompileError> {
+    #[cfg(feature = "profiling")]
+    profiling::function_scope!();
     let message = parse_single_message_with_source(source, options, Some(SourceId(0)))?;
     compile_parsed_messages(vec![message], None, options)
 }
@@ -588,6 +598,8 @@ pub fn compile_with_manifest(
     options: CompileOptions,
     manifest: &FunctionManifest,
 ) -> Result<Vec<u8>, CompileError> {
+    #[cfg(feature = "profiling")]
+    profiling::function_scope!();
     let message = parse_single_message_with_source(source, options, Some(SourceId(0)))?;
     compile_parsed_messages(vec![message], Some(manifest), options)
 }
@@ -597,6 +609,8 @@ pub fn compile_inputs<'a>(
     inputs: impl IntoIterator<Item = CompileInput<'a>>,
     options: CompileOptions,
 ) -> CompileReport {
+    #[cfg(feature = "profiling")]
+    profiling::function_scope!();
     let mut builder = CatalogBuilder::with_options(options);
     let mut diagnostics = Vec::new();
     for input in inputs {
@@ -612,6 +626,8 @@ pub fn compile_resources(
     inputs: impl IntoIterator<Item = ResourceInput>,
     options: CompileOptions,
 ) -> CompileReport {
+    #[cfg(feature = "profiling")]
+    profiling::function_scope!();
     let mut builder = CatalogBuilder::with_options(options);
     let mut diagnostics = Vec::new();
     for input in inputs {
@@ -626,6 +642,8 @@ pub fn compile_inputs_with_manifest<'a>(
     options: CompileOptions,
     manifest: &FunctionManifest,
 ) -> CompileReport {
+    #[cfg(feature = "profiling")]
+    profiling::function_scope!();
     let mut builder = CatalogBuilder::with_options(options);
     builder.set_function_manifest(manifest.clone());
     let mut diagnostics = Vec::new();
@@ -643,6 +661,8 @@ pub fn compile_resources_with_manifest(
     options: CompileOptions,
     manifest: &FunctionManifest,
 ) -> CompileReport {
+    #[cfg(feature = "profiling")]
+    profiling::function_scope!();
     let mut builder = CatalogBuilder::with_options(options);
     builder.set_function_manifest(manifest.clone());
     let mut diagnostics = Vec::new();

crates/message-format-resource-json/Cargo.toml

@@ -14,6 +14,10 @@ description = "JSON resource adapters for message-format compiler resource input
 [dependencies]
 json-spanned-value = "0.2.2"
 message-format-compiler.workspace = true
+profiling = { optional = true, workspace = true }
+
+[features]
+profiling = ["dep:profiling", "message-format-compiler/profiling"]
 
 [lints]
 workspace = true

crates/message-format-resource-json/src/lib.rs

@@ -68,6 +68,8 @@ pub fn parse_json_resource(
     source: &str,
     profile: JsonProfile,
 ) -> Result<ResourceInput, ResourceJsonError> {
+    #[cfg(feature = "profiling")]
+    profiling::function_scope!();
     let root: JsonValue = json_spanned_value::from_str(source)
         .map_err(|err| ResourceJsonError::from_json(source, err))?;
     match profile {
@@ -82,6 +84,8 @@ pub fn parse_flat_json_resource(
     name: impl Into<String>,
     source: &str,
 ) -> Result<ResourceInput, ResourceJsonError> {
+    #[cfg(feature = "profiling")]
+    profiling::function_scope!();
     parse_json_resource(name, source, JsonProfile::Flat)
 }
 
@@ -91,6 +95,8 @@ pub fn parse_chrome_json_resource(
     name: impl Into<String>,
     source: &str,
 ) -> Result<ResourceInput, ResourceJsonError> {
+    #[cfg(feature = "profiling")]
+    profiling::function_scope!();
     parse_json_resource(name, source, JsonProfile::Chrome)
 }
 

crates/message-format-resource-toml/Cargo.toml

@@ -13,7 +13,11 @@ description = "TOML resource adapter for message-format compiler resource inputs
 
 [dependencies]
 message-format-compiler.workspace = true
+profiling = { optional = true, workspace = true }
 toml = "1"
 
+[features]
+profiling = ["dep:profiling", "message-format-compiler/profiling"]
+
 [lints]
 workspace = true

crates/message-format-resource-toml/src/lib.rs

@@ -29,6 +29,8 @@ pub fn parse_resource_toml(
     name: impl Into<String>,
     source: &str,
 ) -> Result<ResourceInput, ResourceTomlError> {
+    #[cfg(feature = "profiling")]
+    profiling::function_scope!();
     let parsed = DeTable::parse(source).map_err(|err| ResourceTomlError::from_toml(source, err))?;
     let root = parsed.into_inner();
     let messages = root

crates/message-format-runtime/Cargo.toml

@@ -27,6 +27,7 @@ icu_locale_core = { default-features = false, optional = true, version = "2.1.1"
 icu_plurals = { default-features = false, features = [
     "compiled_data",
 ], optional = true, version = "2.1.1" }
+profiling = { optional = true, workspace = true }
 
 [features]
 default = []
@@ -39,6 +40,7 @@ icu4x = [
     "dep:icu_calendar",
     "dep:icu_datetime",
 ]
+profiling = ["dep:profiling"]
 
 [package.metadata.docs.rs]
 all-features = true

crates/message-format-runtime/src/builtin.rs

@@ -313,6 +313,8 @@ impl BuiltinHost {
     /// Returns:
     /// - `FormatError::Trap(Trap::UnsupportedLocale)` when ICU plural rules are unavailable.
     pub fn new(locale: &Locale) -> Result<Self, FormatError> {
+        #[cfg(feature = "profiling")]
+        profiling::function_scope!();
         let cardinal_rules = PluralRules::try_new_cardinal(locale.into())
             .map_err(|_| FormatError::Trap(Trap::UnsupportedLocale))?;
         let ordinal_rules = PluralRules::try_new_ordinal(locale.into())

crates/message-format-runtime/src/catalog.rs

@@ -38,6 +38,8 @@ pub struct Catalog {
 impl Catalog {
     /// Decode and verify a catalog payload.
     pub fn from_bytes(bytes: &[u8]) -> Result<Self, CatalogError> {
+        #[cfg(feature = "profiling")]
+        profiling::function_scope!();
         if bytes.len() < HEADER_LEN {
             return Err(CatalogError::ChunkOutOfBounds);
         }

crates/message-format-runtime/src/formatter.rs

@@ -67,6 +67,8 @@ impl<'a, H: Host> Formatter<'a, H> {
     ///
     /// Calls [`Host::index`] to pre-compute catalog-specific data.
     pub fn new(catalog: &'a Catalog, mut host: H) -> Result<Self, FormatError> {
+        #[cfg(feature = "profiling")]
+        profiling::function_scope!();
         let index = host.index(catalog)?;
         Ok(Self {
             catalog,
@@ -88,6 +90,8 @@ impl<'a, H: Host> Formatter<'a, H> {
 
     /// Resolve a message id to a reusable handle.
     pub fn resolve(&self, message_id: &str) -> Result<MessageHandle, FormatError> {
+        #[cfg(feature = "profiling")]
+        profiling::function_scope!();
         MessageHandle::from_catalog(self.catalog, message_id)
     }
 
@@ -105,6 +109,8 @@ impl<'a, H: Host> Formatter<'a, H> {
         args: &dyn Args,
         sink: &mut S,
     ) -> Result<Vec<FormatError>, FormatError> {
+        #[cfg(feature = "profiling")]
+        profiling::function_scope!();
         let mut diagnostics = VecDiagnostics::default();
         run_bytecode(
             self.catalog,
@@ -161,6 +167,8 @@ impl<'a, H: Host> MultiFormatter<'a, H> {
         catalogs: impl IntoIterator<Item = &'a Catalog>,
         mut host: H,
     ) -> Result<Self, FormatError> {
+        #[cfg(feature = "profiling")]
+        profiling::function_scope!();
         let catalogs: Box<[_]> = catalogs
             .into_iter()
             .map(|catalog| {
@@ -191,6 +199,8 @@ impl<'a, H: Host> MultiFormatter<'a, H> {
     ///
     /// Returns a handle to the first catalog that contains the message.
     pub fn resolve(&self, message_id: &str) -> Result<MultiMessageHandle, FormatError> {
+        #[cfg(feature = "profiling")]
+        profiling::function_scope!();
         for (idx, (catalog, _)) in self.catalogs.iter().enumerate() {
             if let Some(entry_pc) = catalog.message_pc(message_id) {
                 return Ok(MultiMessageHandle {
@@ -261,6 +271,8 @@ impl<'a, H: Host> MultiFormatter<'a, H> {
         args: &dyn Args,
         sink: &mut S,
     ) -> Result<Vec<FormatError>, FormatError> {
+        #[cfg(feature = "profiling")]
+        profiling::function_scope!();
         let (catalog, index) = self
             .catalogs
             .get(message.catalog_idx as usize)

crates/message-format/Cargo.toml

@@ -16,11 +16,13 @@ default = ["std"]
 std = ["message-format-runtime/std"]
 icu4x = ["message-format-runtime/icu4x"]
 compile = ["dep:message-format-compiler"]
+profiling = ["dep:profiling", "message-format-runtime/profiling", "message-format-compiler?/profiling"]
 
 [dependencies]
 icu_locale_core = { default-features = false, version = "2.1.1" }
 message-format-compiler = { optional = true, workspace = true }
 message-format-runtime = { workspace = true }
+profiling = { optional = true, workspace = true }
 
 [package.metadata.docs.rs]
 all-features = true