Introduction

VE offloading is a framework to provide accelerator-style programming on Vector Engine (VE).Using VEO, a programmer can execute code on VE and can control the execution from VH main program.

This document describes public APIs for VEO. The page "Modules" shows a list of VEO API functions. The page "Examples" shows a list of all example.

Author

Erich Focht

NEC Corporation

Copyright

2017-2024. Licensed under the terms of LGPL v2.1.

Revision History

Revision, Date, Updates/Remarks

Rev.13, Feb. 2024,
This revision covers veoffload-aveo-3.0.2 or later.
Added reference for VH main program to Parallelized Program using OpenMP.
Updated description of MPI program with VEO.
Added reference for PROGINF/FTRACE users guide to FTRACE Performance Information File.
Added description to Relinking veorun for Newer Compilers about it should be done in witch situations.
Added description to Getting Started with VEO about "hello" is VH main program.
Added description of mk_veorun to Hello World.
Deleted line numbers form .f90 files in Examples.

Rev.12, Mar. 2023,
This revision covers veoffload-aveo-3.0.2 or later.
Updated installation instructions.
Updated restrictions of the required number of huge pages for VEO.

Rev.11, Nov. 2022,
This revision covers veoffload-aveo-2.13.0 or later.
Added descriptions of PCIRCVSYC register.
Added descriptions of FTRACE performance information file name.
Added restrictions of FTRACE environment variable.
Added descriptions of new low-level APIs reference.

Rev.10, Mar. 2022,
This revision covers veoffload-aveo-2.11.0 or later.
Added descriptions of VEO VE DMA API, VEO VE SHM API and VEO VH-VE SHM API.

Rev.9, Dec. 2021,
This revision covers veoffload-aveo-2.10.0 or later.
Enable traceback when exception occurred by VEO programs.
Added a restriction of FTRACE.

Rev.8, Jul. 2021,
This revision covers veoffload-aveo-2.8.2 or later.
Added descriptions of debugging VEO programs.
Added restrictions of environment variables that can not control VE program execution for VEO.

Rev.7, May 2021,
This revision covers veoffload-aveo-2.8 or later.
Fixed mpirun/mpiexec options for the MPI program which calls VEO API.
Fixed the library name to load in the example code(mpi-veo.c).

Rev.6, Mar. 2021,
This revision covers veoffload-aveo-2.7.6 or later.
Added descriptions of heterogeneous memory(HMEM) API.
Added example source codes.
Added descriptions of MPI+VEO examples.

Rev.5, Jan. 2021,
This revision covers veoffload-aveo-2.7.5 or later.
Added descriptions of environment variables to optimize the performance of data transfer.
Deleted restrictions that these APIs could return a success value if veo_write_mem() or veo_async_write_mem() fails.

Rev.4, Dec. 2021,
This revision covers veoffload-aveo-2.7.3 or later.
Added a workaround for slow veo_write_mem() or veo_async_write_mem() transfer speeds depending on memory.
Fixed API reference of veo_get_context().
Added restrictions that these APIs could return a success value if veo_write_mem() or veo_async_write_mem() fails.

Rev.3, Oct. 2020,
This revision covers veoffload-aveo-2.7.1 or later.
Updated the version.

Rev.2, Sep. 2020,
This revision covers veoffload-aveo-2.7.0 or later.
Updated installation instructions.
Updated the size limit for arguments passed to functions.
Added restrictions on using multiple contexts with multiple OpenMP threads.
Fixed minor errors.

Rev.1, Jul. 2020,
This revision covers veoffload-aveo-2.6.2 or later.
First release.