      1
      2
      3
      4
      5
      6
      7
      8
      9
     10
     11
     12
     13
     14
     15
     16
     17
     18
     19
     20
     21
     22
     23
     24
     25
     26
     27
     28
     29
     30
     31
     32
     33
     34
     35
     36
     37
     38
     39
     40
     41
     42
     43
     44
     45
     46
     47
     48
     49
     50
     51
     52
     53
     54
     55
     56
     57
     58
     59
     60
     61
     62
     63
     64
     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116

    //! Debug Logging
    //!
    //! To use in a debug build, set the env var `RAYON_LOG=1`.  In a
    //! release build, logs are compiled out. You will have to change
    //! `DUMP_LOGS` to be `true`.
    //!
    //! **Old environment variable:** `RAYON_LOG` is a one-to-one
    //! replacement of the now deprecated `RAYON_RS_LOG` environment
    //! variable, which is still supported for backwards compatibility.

    #[cfg(debug_assertions)]
    use std::env;

    #[cfg_attr(debug_assertions, derive(Debug))]
    #[cfg_attr(not(debug_assertions), allow(dead_code))]
    pub(super) enum Event {
        Tickle {
            worker: usize,
            old_state: usize,
        },
        GetSleepy {
            worker: usize,
            state: usize,
        },
        GotSleepy {
            worker: usize,
            old_state: usize,
            new_state: usize,
        },
        GotAwoken {
            worker: usize,
        },
        FellAsleep {
            worker: usize,
        },
        GotInterrupted {
            worker: usize,
        },
        FoundWork {
            worker: usize,
            yields: usize,
        },
        DidNotFindWork {
            worker: usize,
            yields: usize,
        },
        StoleWork {
            worker: usize,
            victim: usize,
        },
        UninjectedWork {
            worker: usize,
        },
        WaitUntil {
            worker: usize,
        },
        LatchSet {
            worker: usize,
        },
        InjectJobs {
            count: usize,
        },
        Join {
            worker: usize,
        },
        PoppedJob {
            worker: usize,
        },
        PoppedRhs {
            worker: usize,
        },
        LostJob {
            worker: usize,
        },
        JobCompletedOk {
            owner_thread: usize,
        },
        JobPanickedErrorStored {
            owner_thread: usize,
        },
        JobPanickedErrorNotStored {
            owner_thread: usize,
        },
        ScopeCompletePanicked {
            owner_thread: usize,
        },
        ScopeCompleteNoPanic {
            owner_thread: usize,
        },
    }

    #[cfg(debug_assertions)]
    lazy_static! {
        pub(super) static ref LOG_ENV: bool =
            env::var("RAYON_LOG").is_ok() || env::var("RAYON_RS_LOG").is_ok();
    }

    #[cfg(debug_assertions)]
    macro_rules! log {
        ($event:expr) => {
            if *$crate::log::LOG_ENV {
                eprintln!("{:?}", $event);
            }
        };
    }

    #[cfg(not(debug_assertions))]
    macro_rules! log {
        ($event:expr) => {
            if false {
                // Expand `$event` so it still appears used, but without
                // any of the formatting code to be optimized away.
                $event;
            }
        };
    }

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)