starpu-max/doc/doxygen/chapters/api/scc_extensions.doxy

/*
 * This file is part of the StarPU Handbook.
 * Copyright (C) 2009--2011  Universit@'e de Bordeaux
 * Copyright (C) 2010, 2011, 2012, 2013  Centre National de la Recherche Scientifique
 * Copyright (C) 2011, 2012 Institut National de Recherche en Informatique et Automatique
 * See the file version.doxy for copying conditions.
 */

/*! \defgroup API_SCC_Extensions SCC Extensions

\def STARPU_USE_SCC
\ingroup API_SCC_Extensions
This macro is defined when StarPU has been installed with SCC support.
It should be used in your code to detect the availability of SCC.

\def STARPU_MAXSCCDEVS
\ingroup API_SCC_Extensions
This macro defines the maximum number of SCC devices that are
supported by StarPU.

\typedef starpu_scc_func_symbol_t
\ingroup API_SCC_Extensions
Type for SCC function symbols

\fn int starpu_scc_register_kernel(starpu_scc_func_symbol_t *symbol, const char *func_name)
\ingroup API_SCC_Extensions
Initiate a lookup on each SCC device to find the adress of the
function named \p func_name, store them in the global array kernels
and return the index in the array through \p symbol.

\fn starpu_scc_kernel_t starpu_scc_get_kernel(starpu_scc_func_symbol_t symbol)
\ingroup API_SCC_Extensions
If success, return the pointer to the function defined by \p symbol on
the device linked to the called device. This can for instance be used
in a starpu_scc_func_t implementation.

*/