don't expose profiling macros, add some documentation

triton-vm/src/fri.rs

@@ -21,8 +21,8 @@ use twenty_first::util_types::merkle_tree::MerkleTree;
 use twenty_first::util_types::merkle_tree_maker::MerkleTreeMaker;
 
 use crate::arithmetic_domain::ArithmeticDomain;
-use crate::prof_start;
-use crate::prof_stop;
+use crate::profiler::prof_start;
+use crate::profiler::prof_stop;
 use crate::profiler::TritonProfiler;
 use crate::proof_item::FriResponse;
 use crate::proof_item::ProofItem;

triton-vm/src/profiler.rs

@@ -601,7 +601,10 @@ impl Display for Report {
     }
 }
 
-#[macro_export]
+/// Start a profiling task.
+/// Requires an `Option<Profiler>` as first argument. Does nothing if this is `None`.
+/// The second argument is the name of the task.
+/// The third argument is an optional task category.
 macro_rules! prof_start {
     ($p: ident, $s : expr, $c : expr) => {
         if let Some(profiler) = $p.as_mut() {
@@ -614,17 +617,23 @@ macro_rules! prof_start {
         }
     };
 }
+pub(crate) use prof_start;
 
-#[macro_export]
+/// Stop a profiling task. Requires the same arguments as [`prof_start`], except that the task's
+/// category (if any) is inferred. Notably, the task's name needs to be an exact match to prevent
+/// the accidental stopping of a different task.
 macro_rules! prof_stop {
     ($p: ident, $s : expr) => {
         if let Some(profiler) = $p.as_mut() {
             profiler.stop($s);
         }
     };
 }
+pub(crate) use prof_stop;
 
-#[macro_export]
+/// Profile one iteration of a loop. Requires the same arguments as [`prof_start`].
+/// This macro should be invoked inside the loop in question.
+/// The profiling of the loop has to be stopped with [`prof_stop`] after the loop.
 macro_rules! prof_itr0 {
     ($p : ident, $s : expr, $c : expr) => {
         if let Some(profiler) = $p.as_mut() {
@@ -637,6 +646,7 @@ macro_rules! prof_itr0 {
         }
     };
 }
+pub(crate) use prof_itr0;
 
 #[cfg(test)]
 pub mod triton_profiler_tests {

triton-vm/src/shared_tests.rs

@@ -11,8 +11,8 @@ use anyhow::Result;
 use twenty_first::shared_math::b_field_element::BFieldElement;
 
 use crate::aet::AlgebraicExecutionTrace;
-use crate::prof_start;
-use crate::prof_stop;
+use crate::profiler::prof_start;
+use crate::profiler::prof_stop;
 use crate::profiler::TritonProfiler;
 use crate::program::Program;
 use crate::proof::Claim;

triton-vm/src/stark.rs

@@ -31,9 +31,9 @@ use crate::aet::AlgebraicExecutionTrace;
 use crate::arithmetic_domain::ArithmeticDomain;
 use crate::ensure_eq;
 use crate::fri::Fri;
-use crate::prof_itr0;
-use crate::prof_start;
-use crate::prof_stop;
+use crate::profiler::prof_itr0;
+use crate::profiler::prof_start;
+use crate::profiler::prof_stop;
 use crate::profiler::TritonProfiler;
 use crate::proof::Claim;
 use crate::proof::Proof;

triton-vm/src/table/master_table.rs

@@ -32,8 +32,8 @@ use twenty_first::util_types::merkle_tree_maker::MerkleTreeMaker;
 
 use crate::aet::AlgebraicExecutionTrace;
 use crate::arithmetic_domain::ArithmeticDomain;
-use crate::prof_start;
-use crate::prof_stop;
+use crate::profiler::prof_start;
+use crate::profiler::prof_stop;
 use crate::profiler::TritonProfiler;
 use crate::stark::MTMaker;
 use crate::stark::StarkHasher;