Skip to content

Libbpf userspace function perf_buffer__poll

0.0.4

Poll for available data and consume records, if any are available.

Definition

int perf_buffer__poll(struct perf_buffer *pb, int timeout_ms);

Parameters

  • pb: perf buffer to poll
  • timeout_ms: timeout in milliseconds, wait for this long if no data is available

Returns

Number of records consumed (or INT_MAX, whichever is less), or negative number, if any of the registered callbacks returned error.

Usage

Call this function to poll for available data on the perf buffer. If any data is available, the registered callback functions will be called. If no data is available, the function will wait for timeout_ms milliseconds for data to arrive and will block until then.

Example

Docs could be improved

This part of the docs is incomplete, contributions are very welcome