put dirty task tracing behind a feature flag (#75022)

### What?

Reduces the tracing verbosity by putting some of the internal tracing behind a feature flag

Author: sokra

turbopack/crates/turbo-tasks-backend/Cargo.toml

@@ -17,6 +17,7 @@ default = []
 verify_serialization = []
 trace_aggregation_update = []
 trace_find_and_schedule = []
+trace_task_dirty = []
 lmdb = ["dep:lmdb-rkv"]
 
 [dependencies]

turbopack/crates/turbo-tasks-backend/src/backend/mod.rs

@@ -36,12 +36,14 @@ use turbo_tasks::{
 };
 
 pub use self::{operation::AnyOperation, storage::TaskDataCategory};
+#[cfg(feature = "trace_task_dirty")]
+use crate::backend::operation::TaskDirtyCause;
 use crate::{
     backend::{
         operation::{
             get_aggregation_number, is_root_node, AggregatedDataUpdate, AggregationUpdateJob,
             AggregationUpdateQueue, CleanupOldEdgesOperation, ConnectChildOperation,
-            ExecuteContext, ExecuteContextImpl, Operation, OutdatedEdge, TaskDirtyCause, TaskGuard,
+            ExecuteContext, ExecuteContextImpl, Operation, OutdatedEdge, TaskGuard,
         },
         persisted_storage_log::PersistedStorageLog,
         storage::{get, get_many, get_mut, get_mut_or_insert_with, iter_many, remove, Storage},
@@ -901,6 +903,7 @@ impl<B: BackingStorage> TurboTasksBackendInner<B> {
         }
         operation::InvalidateOperation::run(
             smallvec![task_id],
+            #[cfg(feature = "trace_task_dirty")]
             TaskDirtyCause::Invalidator,
             self.execute_context(turbo_tasks),
         );
@@ -916,6 +919,7 @@ impl<B: BackingStorage> TurboTasksBackendInner<B> {
         }
         operation::InvalidateOperation::run(
             tasks.iter().copied().collect(),
+            #[cfg(feature = "trace_task_dirty")]
             TaskDirtyCause::Unknown,
             self.execute_context(turbo_tasks),
         );
@@ -931,6 +935,7 @@ impl<B: BackingStorage> TurboTasksBackendInner<B> {
         }
         operation::InvalidateOperation::run(
             tasks.iter().copied().collect(),
+            #[cfg(feature = "trace_task_dirty")]
             TaskDirtyCause::Unknown,
             self.execute_context(turbo_tasks),
         );
@@ -1291,7 +1296,11 @@ impl<B: BackingStorage> TurboTasksBackendInner<B> {
                                 .get(&cell.type_id)
                                 .is_none_or(|start_index| cell.index >= *start_index) =>
                         {
-                            Some(OutdatedEdge::RemovedCellDependent(task, cell.type_id))
+                            Some(OutdatedEdge::RemovedCellDependent {
+                                task_id: task,
+                                #[cfg(feature = "trace_task_dirty")]
+                                value_type_id: cell.type_id,
+                            })
                         }
                         _ => None,
                     }

turbopack/crates/turbo-tasks-backend/src/backend/operation/aggregation_update.rs

@@ -14,15 +14,14 @@ use smallvec::SmallVec;
     feature = "trace_find_and_schedule"
 ))]
 use tracing::{span::Span, trace_span};
-use turbo_tasks::{FxIndexMap, SessionId, TaskId, TraitTypeId};
+use turbo_tasks::{FxIndexMap, SessionId, TaskId};
 
+#[cfg(feature = "trace_task_dirty")]
+use crate::backend::operation::invalidate::TaskDirtyCause;
 use crate::{
     backend::{
         get_mut, get_mut_or_insert_with,
-        operation::{
-            invalidate::{make_task_dirty, TaskDirtyCause},
-            ExecuteContext, Operation, TaskGuard,
-        },
+        operation::{invalidate::make_task_dirty, ExecuteContext, Operation, TaskGuard},
         storage::{
             count, get, get_many, iter_many, remove, update, update_count, update_ucount_and_get,
         },
@@ -138,7 +137,8 @@ pub enum AggregationUpdateJob {
     /// Invalidates tasks that are dependent on a collectible type.
     InvalidateDueToCollectiblesChange {
         task_ids: SmallVec<[TaskId; 4]>,
-        collectible_type: TraitTypeId,
+        #[cfg(feature = "trace_task_dirty")]
+        collectible_type: turbo_tasks::TraitTypeId,
     },
     /// Increases the active counter of the task
     IncreaseActiveCount { task: TaskId },
@@ -349,6 +349,7 @@ impl AggregatedDataUpdate {
                 if !dependent.is_empty() {
                     queue.push(AggregationUpdateJob::InvalidateDueToCollectiblesChange {
                         task_ids: dependent,
+                        #[cfg(feature = "trace_task_dirty")]
                         collectible_type: ty,
                     })
                 }
@@ -783,11 +784,13 @@ impl AggregationUpdateQueue {
                 }
                 AggregationUpdateJob::InvalidateDueToCollectiblesChange {
                     task_ids,
+                    #[cfg(feature = "trace_task_dirty")]
                     collectible_type,
                 } => {
                     for task_id in task_ids {
                         make_task_dirty(
                             task_id,
+                            #[cfg(feature = "trace_task_dirty")]
                             TaskDirtyCause::CollectiblesChange { collectible_type },
                             self,
                             ctx,

turbopack/crates/turbo-tasks-backend/src/backend/operation/cleanup_old_edges.rs

@@ -1,8 +1,10 @@
 use std::mem::take;
 
 use serde::{Deserialize, Serialize};
-use turbo_tasks::{TaskId, ValueTypeId};
+use turbo_tasks::TaskId;
 
+#[cfg(feature = "trace_task_dirty")]
+use crate::backend::operation::invalidate::TaskDirtyCause;
 use crate::{
     backend::{
         get,
@@ -11,7 +13,7 @@ use crate::{
                 get_aggregation_number, get_uppers, is_aggregating_node, AggregationUpdateJob,
                 AggregationUpdateQueue,
             },
-            invalidate::{make_task_dirty, TaskDirtyCause},
+            invalidate::make_task_dirty,
             AggregatedDataUpdate, ExecuteContext, Operation, TaskGuard,
         },
         storage::update_count,
@@ -42,7 +44,11 @@ pub enum OutdatedEdge {
     CellDependency(CellRef),
     OutputDependency(TaskId),
     CollectiblesDependency(CollectiblesRef),
-    RemovedCellDependent(TaskId, ValueTypeId),
+    RemovedCellDependent {
+        task_id: TaskId,
+        #[cfg(feature = "trace_task_dirty")]
+        value_type_id: turbo_tasks::ValueTypeId,
+    },
 }
 
 impl CleanupOldEdgesOperation {
@@ -185,10 +191,17 @@ impl Operation for CleanupOldEdgesOperation {
                                     });
                                 }
                             }
-                            OutdatedEdge::RemovedCellDependent(task_id, value_type) => {
+                            OutdatedEdge::RemovedCellDependent {
+                                task_id,
+                                #[cfg(feature = "trace_task_dirty")]
+                                value_type_id,
+                            } => {
                                 make_task_dirty(
                                     task_id,
-                                    TaskDirtyCause::CellRemoved { value_type },
+                                    #[cfg(feature = "trace_task_dirty")]
+                                    TaskDirtyCause::CellRemoved {
+                                        value_type: value_type_id,
+                                    },
                                     queue,
                                     ctx,
                                 );

turbopack/crates/turbo-tasks-backend/src/backend/operation/invalidate.rs

@@ -1,8 +1,6 @@
-use std::fmt::Display;
-
 use serde::{Deserialize, Serialize};
 use smallvec::SmallVec;
-use turbo_tasks::{registry, TaskId, TraitTypeId, ValueTypeId};
+use turbo_tasks::TaskId;
 
 use crate::{
     backend::{
@@ -24,6 +22,7 @@ pub enum InvalidateOperation {
     // TODO DetermineActiveness
     MakeDirty {
         task_ids: SmallVec<[TaskId; 4]>,
+        #[cfg(feature = "trace_task_dirty")]
         cause: TaskDirtyCause,
     },
     AggregationUpdate {
@@ -36,10 +35,15 @@ pub enum InvalidateOperation {
 impl InvalidateOperation {
     pub fn run(
         task_ids: SmallVec<[TaskId; 4]>,
-        cause: TaskDirtyCause,
+        #[cfg(feature = "trace_task_dirty")] cause: TaskDirtyCause,
         mut ctx: impl ExecuteContext,
     ) {
-        InvalidateOperation::MakeDirty { task_ids, cause }.execute(&mut ctx)
+        InvalidateOperation::MakeDirty {
+            task_ids,
+            #[cfg(feature = "trace_task_dirty")]
+            cause,
+        }
+        .execute(&mut ctx)
     }
 }
 
@@ -48,10 +52,20 @@ impl Operation for InvalidateOperation {
         loop {
             ctx.operation_suspend_point(&self);
             match self {
-                InvalidateOperation::MakeDirty { task_ids, cause } => {
+                InvalidateOperation::MakeDirty {
+                    task_ids,
+                    #[cfg(feature = "trace_task_dirty")]
+                    cause,
+                } => {
                     let mut queue = AggregationUpdateQueue::new();
                     for task_id in task_ids {
-                        make_task_dirty(task_id, cause, &mut queue, ctx);
+                        make_task_dirty(
+                            task_id,
+                            #[cfg(feature = "trace_task_dirty")]
+                            cause,
+                            &mut queue,
+                            ctx,
+                        );
                     }
                     if queue.is_empty() {
                         self = InvalidateOperation::Done
@@ -73,23 +87,34 @@ impl Operation for InvalidateOperation {
     }
 }
 
+#[cfg(feature = "trace_task_dirty")]
 #[derive(Serialize, Deserialize, Clone, Copy, Debug)]
 pub enum TaskDirtyCause {
     InitialDirty,
-    CellChange { value_type: ValueTypeId },
-    CellRemoved { value_type: ValueTypeId },
-    OutputChange { task_id: TaskId },
-    CollectiblesChange { collectible_type: TraitTypeId },
+    CellChange {
+        value_type: turbo_tasks::ValueTypeId,
+    },
+    CellRemoved {
+        value_type: turbo_tasks::ValueTypeId,
+    },
+    OutputChange {
+        task_id: TaskId,
+    },
+    CollectiblesChange {
+        collectible_type: turbo_tasks::TraitTypeId,
+    },
     Invalidator,
     Unknown,
 }
 
+#[cfg(feature = "trace_task_dirty")]
 struct TaskDirtyCauseInContext<'l, 'e, E: ExecuteContext<'e>> {
     cause: &'l TaskDirtyCause,
     ctx: &'l E,
     _phantom: std::marker::PhantomData<&'e ()>,
 }
 
+#[cfg(feature = "trace_task_dirty")]
 impl<'l, 'e, E: ExecuteContext<'e>> TaskDirtyCauseInContext<'l, 'e, E> {
     fn new(cause: &'l TaskDirtyCause, ctx: &'l E) -> Self {
         Self {
@@ -100,22 +125,23 @@ impl<'l, 'e, E: ExecuteContext<'e>> TaskDirtyCauseInContext<'l, 'e, E> {
     }
 }
 
-impl<'e, E: ExecuteContext<'e>> Display for TaskDirtyCauseInContext<'_, 'e, E> {
+#[cfg(feature = "trace_task_dirty")]
+impl<'e, E: ExecuteContext<'e>> std::fmt::Display for TaskDirtyCauseInContext<'_, 'e, E> {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         match self.cause {
             TaskDirtyCause::InitialDirty => write!(f, "initial dirty"),
             TaskDirtyCause::CellChange { value_type } => {
                 write!(
                     f,
                     "{} cell changed",
-                    registry::get_value_type(*value_type).name
+                    turbo_tasks::registry::get_value_type(*value_type).name
                 )
             }
             TaskDirtyCause::CellRemoved { value_type } => {
                 write!(
                     f,
                     "{} cell removed",
-                    registry::get_value_type(*value_type).name
+                    turbo_tasks::registry::get_value_type(*value_type).name
                 )
             }
             TaskDirtyCause::OutputChange { task_id } => {
@@ -129,7 +155,7 @@ impl<'e, E: ExecuteContext<'e>> Display for TaskDirtyCauseInContext<'_, 'e, E> {
                 write!(
                     f,
                     "{} collectible changed",
-                    registry::get_trait(*collectible_type).name
+                    turbo_tasks::registry::get_trait(*collectible_type).name
                 )
             }
             TaskDirtyCause::Invalidator => write!(f, "invalidator"),
@@ -140,7 +166,7 @@ impl<'e, E: ExecuteContext<'e>> Display for TaskDirtyCauseInContext<'_, 'e, E> {
 
 pub fn make_task_dirty(
     task_id: TaskId,
-    cause: TaskDirtyCause,
+    #[cfg(feature = "trace_task_dirty")] cause: TaskDirtyCause,
     queue: &mut AggregationUpdateQueue,
     ctx: &mut impl ExecuteContext,
 ) {
@@ -150,20 +176,29 @@ pub fn make_task_dirty(
 
     let mut task = ctx.task(task_id, TaskDataCategory::All);
 
-    make_task_dirty_internal(&mut task, task_id, true, cause, queue, ctx);
+    make_task_dirty_internal(
+        &mut task,
+        task_id,
+        true,
+        #[cfg(feature = "trace_task_dirty")]
+        cause,
+        queue,
+        ctx,
+    );
 }
 
 pub fn make_task_dirty_internal(
     task: &mut impl TaskGuard,
     task_id: TaskId,
     make_stale: bool,
-    cause: TaskDirtyCause,
+    #[cfg(feature = "trace_task_dirty")] cause: TaskDirtyCause,
     queue: &mut AggregationUpdateQueue,
     ctx: &impl ExecuteContext,
 ) {
     if make_stale {
         if let Some(InProgressState::InProgress { stale, .. }) = get_mut!(task, InProgress) {
             if !*stale {
+                #[cfg(feature = "trace_task_dirty")]
                 let _span = tracing::trace_span!(
                     "make task stale",
                     name = ctx.get_task_description(task_id),
@@ -185,6 +220,7 @@ pub fn make_task_dirty_internal(
                 clean_in_session: None,
             },
         }) => {
+            #[cfg(feature = "trace_task_dirty")]
             let _span = tracing::trace_span!(
                 "task already dirty",
                 name = ctx.get_task_description(task_id),
@@ -215,6 +251,7 @@ pub fn make_task_dirty_internal(
         _ => unreachable!(),
     };
 
+    #[cfg(feature = "trace_task_dirty")]
     let _span = tracing::trace_span!(
         "make task dirty",
         name = ctx.get_task_description(task_id),

turbopack/crates/turbo-tasks-backend/src/backend/operation/mod.rs

@@ -742,12 +742,13 @@ impl_operation!(UpdateOutput update_output::UpdateOutputOperation);
 impl_operation!(CleanupOldEdges cleanup_old_edges::CleanupOldEdgesOperation);
 impl_operation!(AggregationUpdate aggregation_update::AggregationUpdateQueue);
 
+#[cfg(feature = "trace_task_dirty")]
+pub use self::invalidate::TaskDirtyCause;
 pub use self::{
     aggregation_update::{
         get_aggregation_number, is_root_node, AggregatedDataUpdate, AggregationUpdateJob,
     },
     cleanup_old_edges::OutdatedEdge,
-    invalidate::TaskDirtyCause,
     update_cell::UpdateCellOperation,
     update_collectible::UpdateCollectibleOperation,
 };

turbopack/crates/turbo-tasks-backend/src/backend/operation/update_cell.rs

@@ -1,8 +1,10 @@
 use turbo_tasks::{backend::CellContent, CellId, TaskId};
 
+#[cfg(feature = "trace_task_dirty")]
+use crate::backend::operation::invalidate::TaskDirtyCause;
 use crate::{
     backend::{
-        operation::{invalidate::TaskDirtyCause, ExecuteContext, InvalidateOperation, TaskGuard},
+        operation::{ExecuteContext, InvalidateOperation, TaskGuard},
         storage::{get_many, remove},
         TaskDataCategory,
     },
@@ -50,6 +52,7 @@ impl UpdateCellOperation {
 
         InvalidateOperation::run(
             dependent,
+            #[cfg(feature = "trace_task_dirty")]
             TaskDirtyCause::CellChange {
                 value_type: cell.type_id,
             },