PAPIf_hl_region_begin(3)

📦
version 7.2.0 · 8 versions
, in nixos 26.05, nixpkgs unstable, opensuse-leap 16.0, ubuntu resolute, ubuntu stonking

💖 PAPIf_hl_region_begin(3) — the PAPI manual, bestie edition 💖

okay so this one's from the PAPI manual (that's section 3, the library-calls girlies 💅) and it's literally the "start recording" button for your Fortran code. no cap.

✨ NAME ✨

PAPIf_hl_region_begin — reads and stores hardware events at the beginning of an instrumented code region. that's the whole vibe 🎀

🌸 SYNOPSIS 🌸

Detailed Description

Fortran Prototype:

#include 'fpapi.h'
PAPIf_hl_region_begin( C_STRING region, C_INT check )

💀 Return values

  • PAPI_OK — we slayed, it worked ✨
  • PAPI_ENOTRUN — EventSet is currently not running or could not determined.
  • PAPI_ESYS — a system or C library call failed inside PAPI, see the errno variable.
  • PAPI_EMISC — PAPI has been deactivated due to previous erros.
  • PAPI_ENOMEM — insufficient memory 😭

So here's the tea 🍓: PAPIf_hl_region_begin reads hardware events and stores them internally at the beginning of an instrumented code region. If you don't specify anything via the environment variable PAPI_EVENTS, default events are used. the first call sets all counters implicitly to zero and starts counting — main character energy, honestly. and heads up: if PAPI_EVENTS is not set or cannot be interpreted, default hardware events are recorded. no cap.

🫶 bestie reminder: the counters get zeroed implicitly on that first call, so don't come for me if your numbers start at zero — that's literally the design.

🦋 Example 🦋

export PAPI_EVENTS="PAPI_TOT_INS,PAPI_TOT_CYC"

integer retval

call PAPIf_hl_region_begin("computation", retval)
if ( retval .NE. PAPI_OK ) then
     write (*,*) "PAPIf_hl_region_begin failed!"
end if

!do some computation here

call PAPIf_hl_region_end("computation", retval)
if ( retval .NE. PAPI_OK ) then
    write (*,*) "PAPIf_hl_region_end failed!"
end if

look at that matching begin/end pair — the way that it's giving balanced brackets 👑 iconic. also not me checking retval .NE. PAPI_OK both times, because the vibe check on errors is mandatory 🙈

👀 See also

  • PAPI_hl_region_begin

🧚 Author

Generated automatically by Doxygen for PAPI from the source code. (yes bestie, a robot wrote it, and it still ate 💅)

🌈 Version 7.2.0.0 — Wed Jun 25 2025 19:30:49 — that's the footer, babes. go instrument something iconic. periodt 💜
📦 where this page comes from