opari(1)

✨ opari — the manual page, but make it make sense ✨

okay bestie, welcome to opari(1), a General Commands Manual page, and honestly? she's giving source to source OpenMP program instrumentor. no cap. let's get into it 💅

🌸 NAME 🌸

opari — the source-to-source OpenMP program instrumentor. that's it, that's the girl. 🎀

🦋 SYNOPSIS 🦋

opari
   [-f70|-f90|-c|-c++]
   [-disable <construct>[,<construct>]...]
   [-rcfile file] [-table <tabfile>] <infile> [<outfile>]
opari
   [-rcfile <file>] -table <tabfile>

two whole moods, bestie. pick your era. ✨

💖 DESCRIPTION 💖

okay so here's the tea. before you compile the source files of an OpenMP application, every single file needs to be transformed by a call to the OPARI tool. like, no skipping, no shortcuts, fr fr.

and then — plot twist — the application also has to be linked against the pomp runtime measurement library and the OPARI runtime table file. the way that table file has to be generated? using the -table option to OPARI, either:

• together with the transformation of the last input source file, or
• with a separate call to OPARI after all the transformations are done. 🫶

also, if you don't specify the output file name, OPARI is gonna be cute and use the name infile.mod.suffix — that's assuming your input file is called infile.suffix. iconic naming behaviour, honestly. 💅

👑 OPTIONS 👑

• -f70, -f90, -c, -c++ — [OPTIONAL] this one tells OPARI what programming language your input source file is written in. it's only necessary if the automatic language detection (which works off the input file's suffix) fails — so basically, only when the vibe check on your filename comes back inconclusive. 😭
• -rcfile <file> — [OPTIONAL] so OPARI normally uses the file ./opari.rc to preserve state information between calls to OPARI, and that matters when your OpenMP application is made of more than one source file. with the -rcfile option, the file file is used instead. super useful if more than one application is stored in the same directory, or if the source files of an application are stored in more than one directory. lowkey a lifesaver for messy folders. 🌈
• -table <tabfile> — generate the OPARI runtime table in file tabfile. this option has to be used either together with the call to OPARI for the transformation of the last input source file, or with a separate call to OPARI after all the transformations are done. no in-between, bestie, those are the rules. ⭐
• -disable <construct> — [OPTIONAL] disables the instrumentation of the more fine-grained OpenMP constructs, like !$OMP ATOMIC for example. construct is a comma separated list of the constructs for which the instrumentation should be disabled. accepted tokens are atomic, critical, master, flush, single, or locks — and also sync if you wanna disable all of them at once. 👑

🔥 SEE ALSO 🔥

• /usr/share/doc/opari/Readme.html

go read her, she's the whole origin story. 📖

💜 AUTHOR 💜

opari was written by Bernd Mohr. 🫶

this manual page was adapted from Readme.html by Samuel Thibault <thibault@debian.org>, for the Debian project (and may be used by others). she's a team player, we love to see it. 💖

and that's the whole page, bestie!! 🌸✨ this cutie dropped back on May 20 as part of the General Commands Manual collection — go forth and instrument those OpenMP apps, you absolute main character. periodt. 💅🎀🦋