Differences between revisions 39 and 41 (spanning 2 versions)
Revision 39 as of 2015-09-23 15:02:17
Size: 19679
Editor: tschwinge
Comment: Clarify -foffload usage
Revision 41 as of 2015-10-20 15:55:31
Size: 21059
Editor: IlyaVerbin
Comment: Mention new interfaces
Deletions are marked like this. Additions are marked like this.
Line 49: Line 49:
 7. `mkoffload` runs accel compiler, which reads IR from the `.gnu.offload_lto_*` sections and compiles it for the accel target. Then `mkoffload` packs this target code (image) into the special section of a new host's object file. The object file produced with `mkoffload` should contain a constructor that calls `GOMP_offload_register` to identify itself at run-time. Arguments to that function are a symbol called `__OFFLOAD_TABLE__` (provided by libgcc and unique per shared object), a target identifier, and some other data needed for a particular target (a pointer to the image, a table with information about mappings between host and offload functions and variables).  7. `mkoffload` runs accel compiler, which reads IR from the `.gnu.offload_lto_*` sections and compiles it for the accel target. Then `mkoffload` packs this target code (image) into the special section of a new host's object file. The object file produced with `mkoffload` should contain a constructor that calls `GOMP_offload_register{,_ver}` to identify itself at run-time. Arguments to that function are a symbol called `__OFFLOAD_TABLE__` (provided by libgcc and unique per shared object), a target identifier, and some other data needed for a particular target (a pointer to the image, a table with information about mappings between host and offload functions and variables).
Line 175: Line 175:
GOMP_OFFLOAD_version
Line 193: Line 194:
When an executable or dynamic shared object is loaded, it calls `GOMP_offload_register` N times, where N is number of accel images, embedded into this exec/dso. This function stores the pointers to the images and other data needed by accel plugin into `offload_images`. When an executable or dynamic shared object is loaded, it calls `GOMP_offload_register{,_ver}` N times, where N is number of accel images, embedded into this exec/dso. This function stores the pointers to the images and other data needed by accel plugin into `offload_images`.
Line 276: Line 277:

== See also ==

 * '''Accelerator BoF''' (GNU Tools Cauldron 2013) [[http://gcc.gnu.org/ml/gcc/2013-07/msg00428.html|summary]], [[http://www.youtube.ca/watch?v=EkCzBHdsGDU&list=PLsgS8fWwKJZhrjVEN7tsQyj2nLb5z0n70&index=1|video]]
 * '''Accelerator BoF''' (GNU Tools Cauldron 2014) [[http://www.youtube.ca/watch?v=y-oCc2XbY-k&list=PLOGTP9W1DX5U53pPxtWdKkyiqe3GAn6Nd|video]]
 * '''OpenMP 4 Offloading Features implementation in GCC''' (Kirill Yukhin, GNU Tools Cauldron 2015) [[https://gcc.gnu.org/wiki/cauldron2015?action=AttachFile&do=view&target=OpenMP_4_Offloading_in_GCC.Yukhin.pdf|slides]], [[https://www.youtube.ca/watch?v=c5OA8T0HWAo|video]]
 * '''Compiling for HSA accelerators with GCC''' (Martin Jambor, GNU Tools Cauldron 2015) [[https://gcc.gnu.org/wiki/cauldron2015?action=AttachFile&do=view&target=mjambor-hsa-slides.pdf|slides]], [[https://www.youtube.ca/watch?v=3yJdAUrfC0g|video]]
 * '''OpenACC & PTX''' (Nathan Sidwell, GNU Tools Cauldron 2015) [[https://www.youtube.ca/watch?v=SBX6_K1AD7s|video]]
 * '''Accelerator BoF''' (GNU Tools Cauldron 2015) [[https://gcc.gnu.org/wiki/cauldron2015?action=AttachFile&do=view&target=accelerator-bof.pdf|slides1]], [[https://gcc.gnu.org/wiki/cauldron2015?action=AttachFile&do=view&target=amonakov-accelerator-bof.pdf|slides2]], [[https://www.youtube.ca/watch?v=9NWJlbU5Gwg|video]]

Offloading Support in GCC

GCC 5 supports two types of offloading:

  • OpenMP to Intel MIC targets (upcoming Intel Xeon Phi products codenamed KNL) as well as MIC emulation on host.
  • OpenACC to Nvidia PTX targets.

/!\ This needs to be updated some more for OpenACC.

Terminology

Host compiler — a regular compiler. Not to be confused with build/host/target configure terms.

Accel compiler — a compiler that reads intermediate representation from the special LTO sections, and generates code for the accelerator device. Also called the "offload compiler" or "target compiler".

OpenMP — open multi-processing, supporting vector, thread and offloading directives/pragmas.

OpenACC — open accelerators, supporting offloading directives/pragmas.

Building host and accel compilers

The host and offload compilers need to be able to find each other. This is achieved by installing the offload compiler into special locations, and informing each about the presence of the other. All available offload compilers must first be configured with "--enable-as-accelerator-for=host-triplet", and installed into the same prefix as the host compiler. Then the host compiler is built with "--enable-offload-targets=target1,target2,..." which identifies the offload compilers that have already been built and installed.

The install locations for the offload compilers differ from those of a normal cross toolchain, by the following mapping:

bin/$target-gcc

->

bin/$host-accel-$target-gcc

lib/gcc/$target/$ver/

->

lib/gcc/$host/$ver/accel/$target

It may be necessary to compile offload compilers with a sysroot, since otherwise install locations for libgomp could clash (maybe that library needs to move into lib/gcc/..?)

A target needs to provide a mkoffload tool if it wishes to be usable as an accelerator. It is installed as one of EXTRA_PROGRAMS, and the host lto-wrapper knows how to find it from the paths described above. mkoffload will invoke the offload compiler in LTO mode to produce an offload binary from the host object files, then post-process this to produce a new object file that can be linked in with the host executable. It can find the host compiler by examining the COLLECT_GCC environment variable, and it must take care to clear this and certain other environment variables when executing the offload compiler so as to not confuse it.

Compilation process

Host compiler performs the following actions:

  1. After #pragma omp target lowering and expansion, a new outlined function with the attribute "omp declare target" emerges — it will be later compiled both by host and accel compilers to produce two versions (or N+1 versions in case of N different accel targets).
    The decls for all global variables marked with "omp declare target" attribute, as well as decls for outlined target regions, are inserted into offload_vars and offload_funcs arrays.

  2. The expansion phase replaces pragmas with corresponding calls to the runtime library libgomp (GOMP_target, GOMP_target_data + GOMP_target_end_data, GOMP_target_update). These calls are preceded by initialization of special structures, containing arguments for outlined functions (.omp_data_arr.*, .omp_data_sizes.*, .omp_data_kinds.*).

  3. During the ipa_write_summaries pass the intermediate representation of outlined functions is streamed out into the .gnu.offload_lto_* sections of the "fat" object file. This object file also may contain .gnu.lto_* sections for the regular link-time optimizations.
    Also the decls from offload_funcs and offload_vars are streamed out into the .gnu.offload_lto_.offload_table section. Later an accel compiler will read this section to produce target's mapping table.

  4. In omp_finish_file function the addresses from offload_funcs and offload_vars are written into the .gnu.offload_funcs and .gnu.offload_vars sections correspondingly.
    Optionally, if -flto is present, the decls from offload_funcs and offload_vars are streamed out into the .gnu.lto_.offload_table section. Later the host compiler in LTO mode will use them to produce the final host's table with addresses.

  5. When all source files are compiled, pre-linker driver collect2 is invoked. There are 4 different scenarios: -flto option is present/absent, linker plugin is supported/not supported. These scenarios are described in detail below. If linker plugin is available, collect2 runs the linker, which loads liblto_plugin.so, which runs lto-wrapper. In case if linker plugin is not available, collect2 runs lto-wrapper directly.

  6. lto-wrapper runs mkoffload for each accel target, specified during the configuration.

  7. mkoffload runs accel compiler, which reads IR from the .gnu.offload_lto_* sections and compiles it for the accel target. Then mkoffload packs this target code (image) into the special section of a new host's object file. The object file produced with mkoffload should contain a constructor that calls GOMP_offload_register{,_ver} to identify itself at run-time. Arguments to that function are a symbol called __OFFLOAD_TABLE__ (provided by libgcc and unique per shared object), a target identifier, and some other data needed for a particular target (a pointer to the image, a table with information about mappings between host and offload functions and variables).

  8. Linker adds new object files, produced by mkoffloads, to the list of host's input object files.

Compilation without -flto using linker plugin

  • gcc

    • cc1 # Compile first source file into plain asm + intermediate representation for accel

    • as # Assemble this asm + IR into object file

    • ... # Compile and assemble all remaining source files

    • collect2 # Pre-linker driver

      • collect-ld # Simple wrapper over ld

        • ld with liblto_plugin.so # Perform linking

          • lto-wrapper # Is called from liblto_plugin.so

            • intelmic/mkoffload # Prepare offload image for Intel MIC devices

              • accel_gcc # Read target IR from all objects and produce target DSO

              • objcopy # Save target DSO in a special section in a new host's object file

            • .../mkoffload # Prepare images for other targets

              • ...

Compilation without -flto and without linker plugin

  • gcc

    • cc1 # Compile first source file into plain asm + intermediate representation for accel

    • as # Assemble this asm + IR into object file

    • ... # Compile and assemble all remaining source files

    • collect2 # Pre-linker driver

      • lto-wrapper # Run lto-wrapper directly from collect2

        • intelmic/mkoffload # Prepare offload image for Intel MIC devices

          • accel_gcc # Read target IR from all objects and produce target DSO

          • objcopy # Save target DSO in a special section in a new host's object file

        • .../mkoffload # Prepare images for other targets

          • ...

      • collect-ld # Simple wrapper over ld

        • ld # Perform final linking

Compilation with -flto using linker plugin

  • gcc

    • cc1 # Compile first source file into plain asm + intermediate representation + IR for accel

    • as # Assemble this asm + IR into temporary object file

    • ... # Compile and assemble all remaining source files

    • collect2 # Pre-linker driver

      • collect-ld # Simple wrapper over ld

        • ld with liblto_plugin.so # Perform linking

          • lto-wrapper # Is called from liblto_plugin.so

            • gcc

              • lto1 # Perform whole program analysis and split into new partitions

            • gcc

              • lto1 # Perform local transformations in the first object file

              • as # Assemble into final object code

            • ... # Perform local transformations in each partitioned object file

            • intelmic/mkoffload # Prepare offload image for Intel MIC devices

              • accel_gcc # Read target IR from all partitions and produce target DSO

              • objcopy # Save target DSO in a special section in a new host's object file

            • .../mkoffload # Prepare images for other targets

              • ...

Compilation with -flto without linker plugin

  • gcc

    • cc1 # Compile first source file into plain asm + intermediate representation + IR for accel

    • as # Assemble this asm + IR into temporary object file

    • ... # Compile and assemble all remaining source files

    • collect2 # Pre-linker driver

      • lto-wrapper # Run lto-wrapper directly from collect2

        • gcc

          • lto1 # Perform whole program analysis and split into new partitions

        • gcc

          • lto1 # Perform local transformations in the first object file

          • as # Assemble into final object code

        • ... # Perform local transformations in each partitioned object file

        • intelmic/mkoffload # Prepare offload image for Intel MIC devices

          • accel_gcc # Read target IR from all partitions and produce target DSO

          • objcopy # Save target DSO in a special section in a new host's object file

        • .../mkoffload # Prepare images for other targets

          • ...

      • collect-ld # Simple wrapper over ld

        • ld # Perform final linking

Compilation options

There are two offload-related options implemented in GCC.

  1. -foffload=<targets>=<options>
    By default, GCC will build offload images for all offload targets specified in configure with non-target-specific options passed to host compiler. This option is used to control offload targets and options for them. It can be used in a few ways:

    • -foffload=disable
      Tells GCC to disable offload support. Target regions will be run in host fallback mode.

    • -foffload=<targets>
      Tells GCC to build offload images for <targets>. They will be built with non-target-specific options passed to host compiler.

    • -foffload=<options>
      Tells GCC to build offload images for all targets specified in configure. They will be built with non-target-specific options passed to host compiler plus <options>.

    • -foffload=<targets>=<options>
      Tells GCC to build offload images for <targets>. They will be built with non-target-specific options passed to host compiler plus <options>.

    <targets> are separated by commas. Several <options> can be specified by separating them by spaces. Options specified by -foffload are appended to the end of option set, so in case of option conflicts they have more priority. The -foffload flag can be specified several times, and you have to do that to specify different <options> for different <targets>.

  2. -foffload-abi=[lp64|ilp32]
    This option is supposed to tell mkoffload (and offload compiler) which ABI is used in streamed GIMPLE. This option is desirable, because host and offload compilers must have the same ABI. The option is generated by the host compiler automatically, it should not be specified by user.

Examples

  • gcc -fopenmp -c -O2 test1.c
    gcc -fopenmp -c -O1 -msse -foffload=-mavx test2.c
    gcc -fopenmp -foffload="-O3 -v" test1.o test2.o

    In this example the offload images will be built with the following options: "-O2 -mavx -O3 -v" for targets specified in configure.

  • gcc -fopenmp -foffload=x86_64-intelmicemul-linux-gnu="-mavx2" -foffload=nvptx-none -foffload="-O3" -O2 test.c

    In this example 2 offload images will be built: for MIC with "-O2 -mavx2 -O3" and for PTX with "-O2 -O3".

Runtime support in libgomp

libgomp plugins

libgomp is designed to be independent of accelerator type it work with. In order to make it possible, plugins are used, while the libgomp itself contains only a generic interface and callbacks to the plugin for invoking target-dependent functionality. Plugins are shared object, implementing a set of routines:

GOMP_OFFLOAD_get_name
GOMP_OFFLOAD_get_caps
GOMP_OFFLOAD_get_type
GOMP_OFFLOAD_get_num_devices
GOMP_OFFLOAD_init_device
GOMP_OFFLOAD_fini_device
GOMP_OFFLOAD_version
GOMP_OFFLOAD_load_image
GOMP_OFFLOAD_unload_image
GOMP_OFFLOAD_alloc
GOMP_OFFLOAD_free
GOMP_OFFLOAD_dev2host
GOMP_OFFLOAD_host2dev
GOMP_OFFLOAD_run

libgomp gets the list of offload targets from the configure (specified by --enable-offload-targets=target1,target2,...). During the offload initialization, it tries to load plugins named libgomp-plugin-<target>.so.1 from standard dynamic linker paths. The plugins can use third-party target-dependent libraries to perform low-level interaction with the accel devices. E.g., the plugin for Intel MIC devices uses liboffloadmic.so for implementing libgomp callbacks, and the plugin for Nvidia PTX devices uses libcuda.so.

Address translation

When #pragma omp target is expanded, the host_addr of outlined function is passed to GOMP_target. If target device is not available, libgomp just performs host fallback using host_addr. But to run the function on target, it needs to translate host_addr into the corresponding target_addr. The idea is to have [ host_addr, size ] arrays in .gnu.offload_{funcs,vars} sections which are ordered exactly the same as corresponding [ target_addr ] arrays inside the target images (size is needed only for vars).

To keep this host_addr -> target_addr mapping at runtime, each device descriptor gomp_device_descr contains a splay tree. When gomp_init_device performs initialization, it walks the whole array and in each iteration picks n-th host pair host_start/host_end plus corresponding n-th target pair tgt_start/tgt_end, and inserts it into the splay tree.

Execution process

When an executable or dynamic shared object is loaded, it calls GOMP_offload_register{,_ver} N times, where N is number of accel images, embedded into this exec/dso. This function stores the pointers to the images and other data needed by accel plugin into offload_images.

The first call to GOMP_target, GOMP_target_data or GOMP_target_update performs corresponding device initialization: it calls GOMP_OFFLOAD_init_device from the plugin, and then stores address mapping table in the splay tree.

In case of Intel MIC, GOMP_OFFLOAD_init_device creates a new process on the device, and then offloads the accel images with the type == OFFLOAD_TARGET_TYPE_INTEL_MIC. All accel images, even inside the executable, represent dynamic shared objects, which are loaded into the newly created process.

GOMP_target looks up the host_addr passed to it in the splay tree and passes corresponding target_addr to plugin's GOMP_OFFLOAD_run function.

How to try offloading enabled GCC

Patches enabling OpenMP 4.0 offloading to Intel MIC are merged to trunk. They include general infrastructure changes, mkoffload tool, libgomp plugin, Intel MIC runtime offload library liboffloadmic and an emulator. This emulator lies under liboffloadmic and reproduces MIC's HW and SW stack behavior allowing to run offloaded code in a separate address space using the host machine. The emulator consists of 4 shared libraries which replace COI and MYO libraries from Intel Manycore Platform Software Stack (MPSS). In case of real offloading, user is supposed to specify path to MPSS libraries in LD_LIBRARY_PATH, this will overload emulator libraries on runtime.

tschwinge is using the following build scripts: trunk-offload-big.tar.bz2 (bootstrap, all languages), trunk-offload-light.tar.bz2 (no bootstrap, only C, C++, Fortran). Unpack, populate [...]/source-{gcc,newlib,nvptx-tools} (for example, using git-new-workdir, or symlinks to existing source trees), and then invoke the RUN script.

1. Building accel compiler:

For Intel MIC:

../configure --build=x86_64-intelmicemul-linux-gnu --host=x86_64-intelmicemul-linux-gnu --target=x86_64-intelmicemul-linux-gnu --enable-as-accelerator-for=x86_64-pc-linux-gnu
make
make install DESTDIR=/install

For Nvidia PTX (also see https://gcc.gnu.org/install/specific.html#nvptx-x-none):

../configure --target=nvptx-none --enable-as-accelerator-for=x86_64-pc-linux-gnu --with-build-time-tools=[install-nvptx-tools]/nvptx-none/bin --disable-sjlj-exceptions --enable-newlib-io-long-long
make
make install DESTDIR=/install

2. Building host compiler:

../configure --build=x86_64-pc-linux-gnu --host=x86_64-pc-linux-gnu --target=x86_64-pc-linux-gnu --enable-offload-targets=x86_64-intelmicemul-linux-gnu=/install/prefix,nvptx-none=/install/prefix
make
make install DESTDIR=/install

If you install both compilers without DESTDIR, then there is no need to specify the paths to accel install trees in the --enable-offload-targets option.

3. Building an application:

/install/bin/gcc -fopenmp test.c
/install/bin/gcc -fopenacc test.c

4. Running an application using the Intel MIC emulator:

export LD_LIBRARY_PATH="/install/lib64/"
./a.out

This creates 2 processes on host: the a.out process and "target" process.

KNL instructions can be emulated by running target process under Intel Software Development Emulator (SDE):

export LD_LIBRARY_PATH="/install/lib64/"
/install/bin/gcc -fopenmp -Ofast -foffload="-march=knl" test.c
OFFLOAD_EMUL_RUN="sde -knl --" ./a.out

The debugger can be attached to the target process by:

OFFLOAD_EMUL_RUN=gdb ./a.out

..., and multiple devices can be emulated by:

OFFLOAD_EMUL_KNC_NUM=2 ./a.out

Running 'make check'

  • configure, make and install accel compiler (see #1)

  • configure and make host compiler (see #2)
  • From the host gcc build directory run:

make check-target-libgomp

Known issues

  • In-tree testing is not supported yet when an accel compiler is not installed. RFC patch.

  • If something goes wrong during the offloading compilation, the host binary is not created. However it's possible to continue compilation in such cases. Patch is here.

  • If someone builds an accel compiler without --enable-languages or with --enable-languages other than c,c++,fortran,lto, then bin directory will contain redundant drivers. Fix is here.

  • For OpenACC offloading, -foffload=disable does not do the right thing.

nvptx offloading

For nvptx offloading, the following issues still need to be resolved:

Intel MIC offloading

  • Intel MIC does not require special sysroot or build-time-tools, therefore the accel compiler should be configured as native (with same target in --build, --host and --target options). Probably it's better to configure it as cross compiler.

See also

  • Accelerator BoF (GNU Tools Cauldron 2013) summary, video

  • Accelerator BoF (GNU Tools Cauldron 2014) video

  • OpenMP 4 Offloading Features implementation in GCC (Kirill Yukhin, GNU Tools Cauldron 2015) slides, video

  • Compiling for HSA accelerators with GCC (Martin Jambor, GNU Tools Cauldron 2015) slides, video

  • OpenACC & PTX (Nathan Sidwell, GNU Tools Cauldron 2015) video

  • Accelerator BoF (GNU Tools Cauldron 2015) slides1, slides2, video

None: Offloading (last edited 2019-02-08 18:42:03 by CatherineMoore)