1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
|
.. role:: ref(emphasis)
.. _futhark-hip(1):
==============
futhark-hip
==============
SYNOPSIS
========
futhark hip [options...] <program.fut>
DESCRIPTION
===========
``futhark hip`` translates a Futhark program to C code invoking HIP
kernels, and either compiles that C code with a C compiler to an
executable binary program, or produces a ``.h`` and ``.c`` file that
can be linked with other code. The standard Futhark optimisation
pipeline is used.
``futhark hip`` uses ``-lhiprtc -lamdhip64`` to link. If using
``--library``, you will need to do the same when linking the final
binary. Although the HIP backend can be made to work on NVIDIA GPUs,
you are probably better off using the very similar
:ref:`futhark-cuda(1)`.
OPTIONS
=======
Accepts the same options as :ref:`futhark-c(1)`.
ENVIRONMENT VARIABLES
=====================
``CC``
The C compiler used to compile the program. Defaults to ``cc`` if
unset.
``CFLAGS``
Space-separated list of options passed to the C compiler. Defaults
to ``-O -std=c99`` if unset.
EXECUTABLE OPTIONS
==================
Generated executables accept the same options as those generated by
:ref:`futhark-c(1)`. For commonality, the options use OpenCL
nomenclature ("group" instead of "thread block").
The following additional options are accepted.
--default-group-size=INT
The default size of thread blocks that are launched. Capped to the
hardware limit if necessary.
--default-num-groups=INT
The default number of thread blocks that are launched.
--default-threshold=INT
The default parallelism threshold used for comparisons when
selecting between code versions generated by incremental flattening.
Intuitively, the amount of parallelism needed to saturate the GPU.
--default-tile-size=INT
The default tile size used when performing two-dimensional tiling
(the workgroup size will be the square of the tile size).
--dump-hip=FILE
Don't run the program, but instead dump the embedded HIP kernels to
the indicated file. Useful if you want to see what is actually
being executed.
--load-hip=FILE
Instead of using the embedded HIP kernels, load them from the
indicated file.
--build-option=OPT
Add an additional build option to the string passed to the kernel
compiler (HIPRTC). Refer to the HIP documentation for which options
are supported. Be careful - some options can easily result in
invalid results.
ENVIRONMENT
===========
If run without ``--library``, ``futhark hip`` will invoke a C
compiler to compile the generated C program into a binary. This only
works if the C compiler can find the necessary HIP libraries.
SEE ALSO
========
:ref:`futhark(1)`
|