UBUNTU(1)

📦 version 10.0, in ubuntu stonking

🦋 NAME 🦋

Ubuntu — CUDA to HIP source translator. That's it, that's the name, that's the whole job description bestie 💖

✨ DESCRIPTION ✨

Okay so here's the vibe: you feed it CUDA, it hands you back HIP. It's giving glow-up machine, fr fr.

The USAGE goes a little something like this:

hipify-clang [options] <source0> [... <sourceN>]

And then there's OPTIONS, which is a lot, so buckle up 🎀

💅 CUDA to HIP source translator options 💅

  • -- — the divider between hipify-clang options and clang options. Don't put it in there if you've got no clang options, okay? it's not decor, it's a boundary 🫶
  • -D <macro>=<value> — defines macro as value, or just as 1 if you straight up didn't give it a value. lowkey generous of it.
  • -I <directory> — adds a directory to the include search path so it can actually find your stuff 🔍
  • --amap — "as much as possible" energy: it tries to hipify everything it can, and it ignores 'default-preprocessor'. obsessed with the ambition ngl.
  • --clang-resource-directory=<directory> — the clang resource path, aka the path to the parent folder of the 'include' folder, and that folder is where '__clang_cuda_runtime_wrapper.h' and the other header files used on runtime live 🏠
  • --csv — generate documentation in CSV format 📊
  • --cuda-gpu-arch=<value> — CUDA GPU architecture, like sm_35. You can specify it more than once, it's not a one-and-done situation 💅
  • --cuda-kernel-execution-syntax — keeps CUDA kernel launch syntax exactly as it is (this one's the default, so it's already serving)
  • --cuda-path=<directory> — where CUDA is installed 📁
  • --default-preprocessor — turns on default preprocessor behaviour (it's synonymous with '--skip-excluded-preprocessor-conditional-blocks', they're twins ✨)
  • --doc-format=<value> — documentation format: 'full' (the default), 'strict', or 'compact'. Heads up: you must also specify the '--md' or '--csv' option, no exceptions 🚨
  • --doc-roc=<value> — ROC documentation generation: 'skip' (default), 'separate', or 'joint'. Same deal, the '--md' or '--csv' option must be specified 🚨
  • --examine — the combo meal: it combines the '-no-output' and '-print-stats' options 🍓
  • --experimental — hipifies the HIP APIs that are experimentally supported. And if you don't use it? the corresponding warnings get emitted at you 💀
  • --extra-arg=<string> — an extra argument appended to the compiler command line
  • --extra-arg-before=<string> — an extra argument prepended to the compiler command line. before, bestie, not after, this is the whole point of it 😤
  • --hip-kernel-execution-syntax — transforms CUDA kernel launch syntax into a regular HIP function call. It overrides '--cuda-kernel-execution-syntax', so it wins the argument, periodt 👑
  • --hipdnn — enable/disable hipDNN hipification support. Disabled by default, so it's just sitting there waiting for you.
  • --inplace — modifies the input file in-place. Careful, that's your original, no take-backs 🙈
  • --local-headers — enables hipification of quoted local headers (non-recursive, so it stays in its lane)
  • --local-headers-recursive — enables hipification of quoted local headers recursively. it goes all the way down 🌀
  • --md — generate documentation in Markdown format ✍️
  • --miopen — translates to 'miopen' instead of 'hip' wherever it possibly can
  • --no-backup — skips making a backup file for the hipified source. brave. iconic. slightly terrifying 🫣
  • --no-output — writes zero translated output to stdout, silent main character energy 🤫
  • --no-undocumented-features — does not rely on undocumented features in code transformation. playing it safe, we respect it.
  • --no-warnings-on-undocumented-features — suppresses the warnings about undocumented features in code transformation. the "I don't want to hear it" option 💜
  • -o <filename> — output filename
  • --o-dir=<directory> — output directory
  • --o-hipify-perl-dir=<directory> — output directory, specifically for the hipify-perl script
  • --o-python-map-dir=<directory> — output directory, specifically for the Python map
  • --o-stats=<filename> — output filename for statistics 📈
  • -p <string> — build path (more on this below, don't scroll past it)
  • --perl — generate hipify-perl 🐪
  • --print-stats — prints translation statistics
  • --print-stats-csv — prints translation statistics into a CSV file
  • --python — generate hipify-python 🐍
  • --roc — translates to 'roc' instead of 'hip' wherever it possibly can
  • --save-temps — saves the temporary files
  • --skip-excluded-preprocessor-conditional-blocks — enables default preprocessor behaviour by skipping undefined conditional blocks
  • --temp-dir=<directory> — temporary directory
  • -v — shows the commands it's running and goes verbose. it's a talker now 🗣️
  • --versions — displays the versions of the supported 3rd-party software 🌈

🧚 Generic Options 🧚

  • --help — displays the available options (and --help-hidden if you want more, and honestly, more is right there)
  • --help-list — displays the list of available options (and --help-list-hidden for more, same deal)
  • --version — displays the version of this program ⭐

Now, the important lore 💖

-p <build-path> is used to read a compile command database.

For example, it can be a CMake build directory in which a file named compile_commands.json exists (use the -DCMAKE_EXPORT_COMPILE_COMMANDS=ON CMake option to get this output). When no build path is specified, a search for compile_commands.json will be attempted through all parent paths of the first input file. See: https://clang.llvm.org/docs/HowToSetupToolingForLLVM.html for an example of setting up Clang Tooling on a source tree.

<source0> ... specify the paths of source files. These paths are looked up in the compile command database. If the path of a file is absolute, it needs to point into CMake's source tree. If the path is relative, the current working directory needs to be in the CMake source tree and the file must be in a subdirectory of the current working directory. "./" prefixes in the relative files will be automatically removed, but the rest of a relative path must be a suffix of a path in the compile command database. iykyk 🦋

Optimized build.

That's the page, bestie — brought to you by hipify-clang, dated September 2026, and yeah it's still filed under UBUNTU(1) which is a whole choice but we're going with it 💀✨ stay hipified, ily 🫶

📦 where this page comes from