feat: Profiling First Draft (#232)

* feat: profiling first draft

* run `cargo fmt` to trigger CI

---------

Co-authored-by: makspll <makspl17@gmail.com>

Author: gallexme

Cargo.toml

@@ -43,6 +43,7 @@ mlua_serialize = ["bevy_mod_scripting_lua?/mlua_serialize"]
 mlua_macros = ["bevy_mod_scripting_lua?/mlua_macros"]
 mlua_async = ["bevy_mod_scripting_lua?/mlua_async"]
 
+
 ## rhai
 rhai = ["bevy_mod_scripting_rhai"]
 
@@ -56,8 +57,8 @@ bevy_mod_scripting_lua = { path = "crates/languages/bevy_mod_scripting_lua", ver
 bevy_mod_scripting_rhai = { path = "crates/languages/bevy_mod_scripting_rhai", version = "0.9.0-alpha.9", optional = true }
 # bevy_mod_scripting_rune = { path = "crates/languages/bevy_mod_scripting_rune", version = "0.9.0-alpha.2", optional = true }
 bevy_mod_scripting_functions = { workspace = true }
-
 [workspace.dependencies]
+profiling = {version = "1.0" }
 bevy = { version = "0.15.0", default-features = false }
 bevy_mod_scripting_core = { path = "crates/bevy_mod_scripting_core", version = "0.9.0-alpha.9" }
 bevy_mod_scripting_functions = { path = "crates/bevy_mod_scripting_functions", version = "0.9.0-alpha.9", default-features = false }

crates/bevy_mod_scripting_core/Cargo.toml

@@ -40,7 +40,7 @@ dashmap = "6"
 smallvec = "1.11"
 itertools = "0.13"
 derivative = "2.2"
-
+profiling = {workspace = true}
 [dev-dependencies]
 test_utils = { workspace = true }
 

crates/bevy_mod_scripting_core/src/bindings/access_map.rs

@@ -215,7 +215,7 @@ pub struct AccessMap {
     individual_accesses: DashMap<u64, AccessCount>,
     global_lock: RwLock<AccessCount>,
 }
-
+#[profiling::all_functions]
 impl AccessMap {
     pub fn is_locked_exclusively(&self) -> bool {
         let global_lock = self.global_lock.read();

crates/bevy_mod_scripting_core/src/bindings/allocator.rs

@@ -141,7 +141,7 @@ pub struct ReflectAllocator {
     allocations: HashMap<ReflectAllocationId, ReflectAllocation>,
     types: HashMap<u64, TypeId>,
 }
-
+#[profiling::all_functions]
 impl ReflectAllocator {
     /// Allocates a new [`Reflect`] value and returns an [`AllocationId`] which can be used to access it later.
     /// Use [`Self::allocate_boxed`] if you already have an allocated boxed value.
@@ -206,6 +206,7 @@ impl ReflectAllocator {
 }
 
 /// Cleans up dangling script allocations
+#[profiling::function]
 pub fn garbage_collector(allocator: ResMut<AppReflectAllocator>) {
     let mut allocator = allocator.write();
     allocator.clean_garbage_allocations()

crates/bevy_mod_scripting_core/src/bindings/function/from.rs

@@ -43,7 +43,7 @@ impl FromScript for () {
 
 impl FromScript for bool {
     type This<'w> = Self;
-
+    #[profiling::function]
     fn from_script(
         value: ScriptValue,
         world: WorldGuard<'_>,
@@ -67,6 +67,7 @@ macro_rules! impl_from_with_downcast {
         $(
             impl FromScript for $ty {
                 type This<'w> = Self;
+                #[profiling::function]
                 fn from_script(value: ScriptValue, world: WorldGuard) -> Result<Self, InteropError> {
                     match value {
                         ScriptValue::Integer(i) => Ok(i as $ty),
@@ -88,6 +89,7 @@ macro_rules! impl_from_stringlike {
         $(
             impl FromScript for $ty {
                 type This<'w> = Self;
+                #[profiling::function]
                 fn from_script(value: ScriptValue, world: WorldGuard) -> Result<Self, InteropError> {
                     match value {
                         ScriptValue::String(s) => Ok(s.to_string().into()),
@@ -104,7 +106,7 @@ impl_from_stringlike!(String, PathBuf, OsString);
 
 impl FromScript for char {
     type This<'w> = Self;
-
+    #[profiling::function]
     fn from_script(
         value: ScriptValue,
         world: WorldGuard<'_>,
@@ -128,6 +130,7 @@ impl FromScript for char {
 
 impl FromScript for ReflectReference {
     type This<'w> = Self;
+    #[profiling::function]
     fn from_script(value: ScriptValue, _world: WorldGuard) -> Result<Self, InteropError> {
         match value {
             ScriptValue::Reference(r) => Ok(r),
@@ -178,6 +181,7 @@ impl<T> From<T> for Val<T> {
 
 impl<T: FromReflect> FromScript for Val<T> {
     type This<'w> = Self;
+    #[profiling::function]
     fn from_script(value: ScriptValue, world: WorldGuard) -> Result<Self, InteropError> {
         match value {
             ScriptValue::Reference(reflect_reference) => Ok(Val(reflect_reference.with_reflect(
@@ -221,7 +225,7 @@ impl<T> Deref for Ref<'_, T> {
 
 impl<T: FromReflect> FromScript for Ref<'_, T> {
     type This<'a> = Ref<'a, T>;
-
+    #[profiling::function]
     fn from_script(
         value: ScriptValue,
         world: WorldGuard<'_>,
@@ -293,7 +297,7 @@ impl<'a, T> From<&'a mut T> for Mut<'a, T> {
 
 impl<T: FromReflect> FromScript for Mut<'_, T> {
     type This<'w> = Mut<'w, T>;
-
+    #[profiling::function]
     fn from_script(
         value: ScriptValue,
         world: WorldGuard<'_>,
@@ -331,7 +335,7 @@ where
     for<'w> T::This<'w>: Into<T>,
 {
     type This<'w> = Self;
-
+    #[profiling::function]
     fn from_script(value: ScriptValue, world: WorldGuard) -> Result<Self, InteropError> {
         match value {
             ScriptValue::Unit => Ok(None),
@@ -345,7 +349,7 @@ where
     for<'w> T::This<'w>: Into<T>,
 {
     type This<'w> = Self;
-
+    #[profiling::function]
     fn from_script(value: ScriptValue, world: WorldGuard) -> Result<Self, InteropError> {
         match value {
             ScriptValue::List(list) => {
@@ -368,7 +372,7 @@ where
     for<'w> T::This<'w>: Into<T>,
 {
     type This<'w> = Self;
-
+    #[profiling::function]
     fn from_script(value: ScriptValue, world: WorldGuard) -> Result<Self, InteropError> {
         match value {
             ScriptValue::List(list) if list.len() == N => {
@@ -390,7 +394,7 @@ where
 
 impl FromScript for DynamicScriptFunctionMut {
     type This<'w> = Self;
-
+    #[profiling::function]
     fn from_script(value: ScriptValue, _: WorldGuard<'_>) -> Result<Self::This<'_>, InteropError>
     where
         Self: Sized,
@@ -407,7 +411,7 @@ impl FromScript for DynamicScriptFunctionMut {
 
 impl FromScript for DynamicScriptFunction {
     type This<'w> = Self;
-
+    #[profiling::function]
     fn from_script(value: ScriptValue, _: WorldGuard<'_>) -> Result<Self::This<'_>, InteropError>
     where
         Self: Sized,
@@ -428,7 +432,7 @@ where
     for<'w> V::This<'w>: Into<V>,
 {
     type This<'w> = Self;
-
+    #[profiling::function]
     fn from_script(value: ScriptValue, world: WorldGuard) -> Result<Self, InteropError> {
         match value {
             ScriptValue::Map(map) => {

crates/bevy_mod_scripting_core/src/bindings/function/from_ref.rs

@@ -24,6 +24,7 @@ pub trait FromScriptRef {
 }
 
 impl FromScriptRef for Box<dyn PartialReflect> {
+    #[profiling::function]
     fn from_script_ref(
         target: TypeId,
         value: ScriptValue,

crates/bevy_mod_scripting_core/src/bindings/function/into_ref.rs

@@ -53,14 +53,15 @@ macro_rules! downcast_into_value {
 }
 
 impl IntoScriptRef for ReflectReference {
+    #[profiling::function]
     fn into_script_ref(
         self_: ReflectReference,
         world: WorldGuard,
     ) -> Result<ScriptValue, InteropError> {
         self_.with_reflect(world.clone(), |r| into_script_ref(self_.clone(), r, world))?
     }
 }
-
+#[profiling::function]
 fn into_script_ref(
     mut self_: ReflectReference,
     r: &dyn PartialReflect,

crates/bevy_mod_scripting_core/src/bindings/function/script_function.rs

@@ -100,6 +100,7 @@ impl DynamicScriptFunction {
         args: I,
         context: FunctionCallContext,
     ) -> Result<ScriptValue, InteropError> {
+        profiling::scope!("Dynamic Call ", self.name().clone());
         let args = args.into_iter().collect::<VecDeque<_>>();
         // should we be inlining call errors into the return value?
         let return_val = (self.func)(context, args);
@@ -151,6 +152,7 @@ impl DynamicScriptFunctionMut {
         args: I,
         context: FunctionCallContext,
     ) -> Result<ScriptValue, InteropError> {
+        profiling::scope!("Dynamic Call Mut", self.name().clone());
         let args = args.into_iter().collect::<VecDeque<_>>();
         // should we be inlining call errors into the return value?
         let mut write = self.func.write();
@@ -276,7 +278,7 @@ pub struct FunctionKey {
 pub struct ScriptFunctionRegistry {
     functions: HashMap<FunctionKey, DynamicScriptFunction>,
 }
-
+#[profiling::all_functions]
 impl ScriptFunctionRegistry {
     /// Register a script function with the given name. If the name already exists,
     /// the new function will be registered as an overload of the function.
@@ -525,7 +527,9 @@ macro_rules! impl_script_function {
             $( $param::This<'env>: Into<$param>,)*
         {
             #[allow(unused_mut,unused_variables)]
+            #[profiling::function]
             fn $trait_fn_name(mut self) -> $dynamic_type {
+
                 let func = (move |caller_context: FunctionCallContext, mut args: VecDeque<ScriptValue> | {
                     let res: Result<ScriptValue, InteropError> = (|| {
                         let received_args_len = args.len();

crates/bevy_mod_scripting_core/src/bindings/pretty_print.rs

@@ -342,7 +342,7 @@ pub trait DisplayWithWorld: std::fmt::Debug {
         self.display_with_world(world)
     }
 }
-
+#[profiling::all_functions]
 impl DisplayWithWorld for ReflectReference {
     fn display_with_world(&self, world: WorldGuard) -> String {
         ReflectReferencePrinter::new(self.clone()).pretty_print(Some(world))
@@ -356,7 +356,7 @@ impl DisplayWithWorld for ReflectReference {
         ReflectReferencePrinter::new(self.clone()).pretty_print(None)
     }
 }
-
+#[profiling::all_functions]
 impl DisplayWithWorld for ReflectBaseType {
     fn display_with_world(&self, world: WorldGuard) -> String {
         let mut string = String::new();
@@ -374,7 +374,7 @@ impl DisplayWithWorld for ReflectBaseType {
         string
     }
 }
-
+#[profiling::all_functions]
 impl DisplayWithWorld for ComponentId {
     fn display_without_world(&self) -> String {
         format!("ComponentOrResource({})", self.index())
@@ -393,7 +393,7 @@ impl DisplayWithWorld for ComponentId {
         }
     }
 }
-
+#[profiling::all_functions]
 impl DisplayWithWorld for ReflectAccessId {
     fn display_without_world(&self) -> String {
         match self.kind {
@@ -425,7 +425,7 @@ impl DisplayWithWorld for ReflectAccessId {
         }
     }
 }
-
+#[profiling::all_functions]
 impl DisplayWithWorld for TypeId {
     fn display_with_world(&self, world: WorldGuard) -> String {
         if *self == TypeId::of::<FakeType>() {
@@ -455,7 +455,7 @@ impl DisplayWithWorld for TypeId {
         format!("{:?}", self)
     }
 }
-
+#[profiling::all_functions]
 impl DisplayWithWorld for ScriptValue {
     fn display_with_world(&self, world: WorldGuard) -> String {
         match self {
@@ -509,7 +509,7 @@ impl DisplayWithWorld for ScriptValue {
         }
     }
 }
-
+#[profiling::all_functions]
 impl<T: DisplayWithWorld> DisplayWithWorld for Vec<T> {
     fn display_with_world(&self, world: WorldGuard) -> String {
         let mut string = String::new();
@@ -550,7 +550,7 @@ impl<T: DisplayWithWorld> DisplayWithWorld for Vec<T> {
         string
     }
 }
-
+#[profiling::all_functions]
 impl DisplayWithWorld for String {
     fn display_with_world(&self, _world: WorldGuard) -> String {
         self.to_string()
@@ -564,7 +564,7 @@ impl DisplayWithWorld for String {
         self.to_string()
     }
 }
-
+#[profiling::all_functions]
 impl<K: DisplayWithWorld, V: DisplayWithWorld> DisplayWithWorld
     for std::collections::HashMap<K, V>
 {

crates/bevy_mod_scripting_core/src/bindings/query.rs

@@ -161,7 +161,7 @@ pub struct ScriptQueryResult {
 //         self.try_read().and_then(|world| world.query(query))
 //     }
 // }
-
+#[profiling::all_functions]
 impl WorldAccessGuard<'_> {
     pub fn query(
         &self,

crates/bevy_mod_scripting_core/src/bindings/reference.rs

@@ -58,7 +58,7 @@ pub enum TypeIdSource {
     /// Givent the Tail reference is a container type, use the type id of the keys of the container
     Key,
 }
-
+#[profiling::all_functions]
 impl ReflectReference {
     /// Creates a new infinite iterator. This iterator will keep returning the next element reference forever.
     pub fn into_iter_infinite(self) -> ReflectRefIter {
@@ -421,7 +421,7 @@ pub enum ReflectBase {
     Resource(ComponentId),
     Owned(ReflectAllocationId),
 }
-
+#[profiling::all_functions]
 impl ReflectBase {
     /// Retrieves the pointer to the underlying `dyn PartialReflect` object valid for the 'w lifteime of the world cell
     ///
@@ -469,7 +469,7 @@ pub trait ReflectionPathExt {
 
     fn iter(&self) -> impl Iterator<Item = &bevy::reflect::OffsetAccess>;
 }
-
+#[profiling::all_functions]
 impl ReflectionPathExt for ParsedPath {
     /// Assumes the accesses are 1 indexed and converts them to 0 indexed
     fn convert_to_0_indexed(&mut self) {
@@ -505,7 +505,7 @@ pub struct ReflectRefIter {
 pub enum IterationKey {
     Index(usize),
 }
-
+#[profiling::all_functions]
 impl ReflectRefIter {
     pub fn new_indexed(base: ReflectReference) -> Self {
         Self {
@@ -537,7 +537,7 @@ impl ReflectRefIter {
 const fn list_index_access(index: usize) -> bevy::reflect::Access<'static> {
     bevy::reflect::Access::ListIndex(index)
 }
-
+#[profiling::all_functions]
 impl Iterator for ReflectRefIter {
     type Item = Result<ReflectReference, InteropError>;
 

crates/bevy_mod_scripting_core/src/bindings/script_value.rs

@@ -147,7 +147,7 @@ impl From<HashMap<String, ScriptValue>> for ScriptValue {
         ScriptValue::Map(value)
     }
 }
-
+#[profiling::all_functions]
 impl TryFrom<ScriptValue> for ParsedPath {
     type Error = InteropError;
     fn try_from(value: ScriptValue) -> Result<Self, Self::Error> {