Implement own profiling macro that supports multi-threading

Author: w1th0utnam3

Cargo.lock

@@ -1,8 +1,8 @@
 use crate::io;
 use anyhow::anyhow;
 use anyhow::Context;
-use splashsurf_lib::coarse_prof::profile;
 use splashsurf_lib::nalgebra::Vector3;
+use splashsurf_lib::profile;
 use std::path::PathBuf;
 use structopt::StructOpt;
 

splashsurf/src/convert.rs

@@ -4,8 +4,8 @@ use std::path::Path;
 
 use anyhow::{anyhow, Context};
 use log::info;
-use splashsurf_lib::coarse_prof::profile;
 use splashsurf_lib::nalgebra::Vector3;
+use splashsurf_lib::profile;
 use splashsurf_lib::Real;
 
 pub mod bgeo_format;

splashsurf/src/io.rs

@@ -80,7 +80,8 @@ fn run_splashsurf() -> Result<(), anyhow::Error> {
 
     // Write coarse_prof stats using log::info
     info!("Timings:");
-    coarse_prof_write_string()?
+    splashsurf_lib::profiling::write_to_string()
+        .unwrap()
         .split("\n")
         .filter(|l| l.len() > 0)
         .for_each(|l| info!("{}", l));
@@ -182,13 +183,6 @@ fn log_program_info() {
     info!("Called with command line: {}", cmd_line);
 }
 
-/// Returns the coarse_prof::write output as a string
-fn coarse_prof_write_string() -> Result<String, anyhow::Error> {
-    let mut buffer = Vec::new();
-    splashsurf_lib::coarse_prof::write(&mut buffer)?;
-    Ok(String::from_utf8_lossy(buffer.as_slice()).into_owned())
-}
-
 #[derive(Copy, Clone, Debug)]
 enum VerbosityLevel {
     None,

splashsurf/src/main.rs

@@ -5,8 +5,8 @@ use arguments::{
 };
 use log::info;
 use rayon::prelude::*;
-use splashsurf_lib::coarse_prof::profile;
 use splashsurf_lib::mesh::PointCloud3d;
+use splashsurf_lib::profile;
 use splashsurf_lib::vtkio::model::UnstructuredGridPiece;
 use splashsurf_lib::{density_map, Index, Real};
 use std::convert::TryFrom;

splashsurf/src/reconstruction.rs

@@ -22,25 +22,29 @@ exclude = [
 [features]
 default = []
 vtk_extras = ["vtkio"]
-profiling = ["coarse-prof"]
+profiling = ["lazy_static"]
 
 [dependencies]
 log = "0.4"
 nalgebra = "0.24"
 num = "0.3"
 anyhow = "1.0"
 thiserror = "1.0"
-coarse-prof = { version = "0.2", optional = true }
 itertools = "0.10"
 rayon = "1.5"
 dashmap = "4.0"
 fxhash = "0.2"
-vtkio = { version = "0.5", optional = true }
 thread_local = "1.1"
-smallvec = { version = "1.6", features = ["union"] }
 bitflags = "1.2"
+smallvec = { version = "1.6", features = ["union"] }
 arrayvec = "0.5"
 
+# VTK extras
+vtkio = { version = "0.5", optional = true }
+
+# Needed for profiling feature
+lazy_static = { version = "1.4", optional = true }
+
 [dev-dependencies]
 criterion = "0.3"
 

splashsurf_lib/Cargo.toml

@@ -18,11 +18,12 @@
 //! Note that all density mapping functions always use the global background grid for flat point
 //! indices, even if the density map is only generated for a smaller subdomain.
 
+use crate::aabb::AxisAlignedBoundingBox3d;
 use crate::kernel::DiscreteSquaredDistanceCubicKernel;
 use crate::mesh::{HexMesh3d, MeshWithPointData};
 use crate::uniform_grid::{OwningSubdomainGrid, Subdomain, UniformGrid};
 use crate::utils::{ChunkSize, ParallelPolicy};
-use crate::{new_map, AxisAlignedBoundingBox3d, HashState, Index, MapType, ParallelMapType, Real};
+use crate::{new_map, profile, HashState, Index, MapType, ParallelMapType, Real};
 use dashmap::ReadOnlyView as ReadDashMap;
 use log::{info, trace, warn};
 use nalgebra::Vector3;

splashsurf_lib/src/density_map.rs

@@ -2,11 +2,7 @@
 //! Library for surface reconstruction of SPH particle data using marching cubes.
 //!
 //! Entry points are the [`reconstruct_surface`] or [`reconstruct_surface_inplace`] functions.
-//!
 
-/// Re-export the version of `coarse_prof` used by this crate, if profiling is enabled
-#[cfg(feature = "profiling")]
-pub use coarse_prof;
 use log::info;
 /// Re-export the version of `nalgebra` used by this crate
 pub use nalgebra;
@@ -30,20 +26,9 @@ use crate::reconstruction::{
 use crate::workspace::ReconstructionWorkspace;
 
 #[cfg(feature = "profiling")]
-/// Invokes coarse_prof::profile! with the given expression
-macro_rules! profile {
-    ($body:expr) => {
-        coarse_prof::profile!($body);
-    };
-}
-
-#[cfg(not(feature = "profiling"))]
-/// No-op macro if profiling is disabled
-macro_rules! profile {
-    ($body:expr) => {
-        $body
-    };
-}
+pub mod profiling;
+#[doc(hidden)]
+pub mod profiling_macro;
 
 mod aabb;
 pub mod density_map;

splashsurf_lib/src/lib.rs

@@ -9,7 +9,7 @@ use crate::marching_cubes::triangulation::{
 };
 use crate::mesh::TriMesh3d;
 use crate::uniform_grid::{DummySubdomain, OwningSubdomainGrid, Subdomain};
-use crate::{new_map, DensityMap, Index, MapType, Real, UniformGrid};
+use crate::{new_map, profile, DensityMap, Index, MapType, Real, UniformGrid};
 use nalgebra::Vector3;
 
 pub mod marching_cubes_lut;

splashsurf_lib/src/marching_cubes.rs

@@ -2,7 +2,7 @@ use crate::marching_cubes::stitching::{collect_boundary_cell_data, BoundaryData}
 use crate::marching_cubes::{CellData, MarchingCubesInput, RelativeToThreshold};
 use crate::topology::{Axis, DirectedAxisArray};
 use crate::uniform_grid::{CellIndex, GridBoundaryFaceFlags, PointIndex, Subdomain};
-use crate::{DensityMap, Index, MapType, Real};
+use crate::{profile, DensityMap, Index, MapType, Real};
 use log::trace;
 use nalgebra::Vector3;