perf-event2

https://docs.rs/perf-event2/0.7.4

Admin

A Rust library providing access to Linux performance monitoring counters for measuring CPU cycles,...

Tokens:1,083

Snippets:11

Trust Score:9.3

Update:10 months ago

Show doc for...

Tokens:

Raw

### Basic perf-event2 counter usage example

Source: https://docs.rs/perf-event2/0.7.4/crates/perf-event2

Demonstrates the basic usage of the perf-event2 crate to count hardware instructions. It involves creating a counter using `Builder`, enabling it, performing an operation (collecting a vector), disabling it, and reading the count. This example is suitable for beginners to understand the core workflow.

```rust
use perf_event::Builder;
use perf_event::events::Hardware;

fn main() -> std::io::Result<()> {
    let mut counter = Builder::new(Hardware::INSTRUCTIONS).build()?;

    let vec = (0..=51).collect::<Vec<_>>();

    counter.enable()?;
    println!("{:?}", vec);
    counter.disable()?;

    println!("{} instructions retired", counter.read()?);

    Ok(())
}
```

--------------------------------

### Install perf-event2 using Cargo

Source: https://docs.rs/perf-event2/0.7.4/crates/perf-event2

Provides the command-line instruction to add the perf-event2 crate to a Rust project using the Cargo package manager. This is a convenient way to manage project dependencies.

```bash
cargo add perf-event2
```

--------------------------------

### Migrating from perf-event to perf-event2

Source: https://docs.rs/perf-event2/0.7.4/crates/perf-event2

Illustrates the key change required when migrating from the older `perf-event` crate to `perf-event2`. Specifically, it shows the updated syntax for initializing a `Builder` by passing the event directly as an argument.

```rust
let counter = Builder::new(some_event)
    // ...
    .build()?;
```

--------------------------------

### Add perf-event2 to Cargo.toml

Source: https://docs.rs/perf-event2/0.7.4/crates/perf-event2

This snippet shows how to add the perf-event2 crate as a dependency to your Rust project's Cargo.toml file. This is the first step to using the crate's functionality.

```toml
perf-event2 = "0.7"
```

Tokens:

Raw