resume one waiter at a call

Author: root

compiler/rustc_query_system/src/query/job.rs

@@ -477,8 +477,8 @@ fn remove_cycle(
 /// Detects query cycles by using depth first search over all active query jobs.
 /// If a query cycle is found it will break the cycle by finding an edge which
 /// uses a query latch and then resuming that waiter.
-/// There may be multiple cycles involved in a deadlock, so this searches
-/// all active queries for cycles before finally resuming all the waiters at once.
+/// There may be multiple cycles involved in a deadlock, but we only search
+/// one cycle at a call and resume one waiter at once. See `FIXME` below.
 pub fn break_query_cycles(query_map: QueryMap, registry: &rayon_core::Registry) {
     let mut wakelist = Vec::new();
     let mut jobs: Vec<QueryJobId> = query_map.keys().cloned().collect();
@@ -488,6 +488,18 @@ pub fn break_query_cycles(query_map: QueryMap, registry: &rayon_core::Registry)
     while jobs.len() > 0 {
         if remove_cycle(&query_map, &mut jobs, &mut wakelist) {
             found_cycle = true;
+
+            // FIXME(#137731): We can encounter deadlocks for cycles we can't break here,
+            // but it's still unclear whether it's due to possible issues in rustc-rayon
+            // or instead in the handling of query cycles. We can avoid them by only waking
+            // up a single waiter instead of all of them. The deadlock issues seem to only
+            // appear when multiple query cycles errors are involved, so this reduction in
+            // parallelism, while suboptimal, is not universal and only the deadlock handler
+            // will encounter these cases. The workaround shows loss of potential gains,
+            // but there still are big improvements in the common case, and no regressions
+            // compared to the single-threaded case. More investigation is still needed,
+            // and once fixed, we can wake up all the waiters up.
+            break;
         }
     }
 
@@ -506,7 +518,7 @@ pub fn break_query_cycles(query_map: QueryMap, registry: &rayon_core::Registry)
         );
     }
 
-    // FIXME: Ensure this won't cause a deadlock before we return
+    // FIXME: Ensure this won't cause a deadlock if we resume all waiters at once.
     for waiter in wakelist.into_iter() {
         waiter.notify(registry);
     }