mcbsp-templates.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2013
 *
 * File created by A. N. Yzelman, 2013.
 *
 * This file is part of MulticoreBSP in C --
 *        a port of the original Java-based MulticoreBSP.
 *
 * MulticoreBSP for C is distributed as part of the original
 * MulticoreBSP and is free software: you can redistribute
 * it and/or modify it under the terms of the GNU Lesser 
 * General Public License as published by the Free Software 
 * Foundation, either version 3 of the License, or 
 * (at your option) any later version.
 * MulticoreBSP is distributed in the hope that it will be
 * useful, but WITHOUT ANY WARRANTY; without even the 
 * implied warranty of MERCHANTABILITY or FITNESS FOR A 
 * PARTICULAR PURPOSE. See the GNU Lesser General Public 
 * License for more details.
 *
 * You should have received a copy of the GNU Lesser General 
 * Public License along with MulticoreBSP. If not, see
 * <http://www.gnu.org/licenses/>.
 */

#ifndef _HPP_MCBSP_TEMPLATES
#define _HPP_MCBSP_TEMPLATES

#ifndef _HPP_MCBSP
 #include "mcbsp.hpp"
#endif

template< typename T >
void bsp_push_reg( T * const address, const size_t size = 1 ) {
        bsp_push_reg( static_cast< void * >(address), size * sizeof( T ) );
}

template< typename T >
bsp_size_t bsp_set_tagsize( const T &tag_type = T() ) {
        bsp_size_t size = static_cast< bsp_size_t >( sizeof( tag_type ) );
        bsp_set_tagsize( &size );
        return size;
}

template< typename T >
void bsp_put( const bsp_pid_t pid, const void * const source,
        T * const destination, const size_t offset = 0, const size_t size = 1 ) {
        bsp_put( pid, source, static_cast< const void * >(destination), offset * sizeof(T), size * sizeof(T) );
}

template< typename T >
void bsp_get( const bsp_pid_t pid, const T * const source,
        const size_t offset, void * const destination, const size_t size = 1 ) {
        bsp_get( pid, static_cast< const void * >(source), offset * sizeof(T), destination, size * sizeof(T) );
}

template< typename T >
void bsp_direct_get( const bsp_pid_t pid, const T * const source,
        const bsp_size_t offset, void * const destination, const bsp_size_t size = 1 ) {
        bsp_direct_get( pid, static_cast< const void * >(source), offset * sizeof(T), destination, size * sizeof(T) );
}

template< typename T >
void bsp_send( const bsp_pid_t pid, const void * const tag,
        const T * const payload, const size_t size = 1 ) {
        bsp_send( pid, tag, static_cast< const void * >(payload), size * sizeof(T) );
}

#ifdef MCBSP_ENABLE_HP_DIRECTIVES

template< typename T >
void bsp_hpsend( const bsp_pid_t pid, const void * const tag,
        const T * const payload, const size_t size = 1 ) {
        bsp_hpsend( pid, tag, static_cast< const void * >(payload), size * sizeof(T) );
}
#endif //MCBSP_ENABLE_HP_DIRECTIVES

template< typename T >
void bsp_move( T * const payload, const size_t max_copy_size = 1 ) {
        bsp_move( static_cast< void * >(payload), max_copy_size * sizeof(T) );
}

//NOTE: there is no templated bsp_hpmove, as its intended use
//      requires casting the retrieved pointers into the BMSP
//      receive-buffer into the appropriate T*.
//      Additionally, the type of T is typically only known
//      after inspecting the tag; which is retrieved during
//      the same call to bsp_hpmove.

#if defined ENABLE_FAKE_HP_DIRECTIVES || defined MCBSP_ENABLE_HP_DIRECTIVES

template< typename T >
void bsp_hpput( const bsp_pid_t pid, const void * const source,
        const T * const destination, const size_t offset = 0, const size_t size = 1 ) {
        bsp_hpput( pid, source, static_cast< const void * >(destination), offset * sizeof(T), size * sizeof(T) );
}

template< typename T >
void bsp_hpget( const bsp_pid_t pid, const T * const source,
        const size_t offset, void * const destination, const size_t size ) {
        bsp_hpget( pid, static_cast< void * >(source), offset * sizeof(T), destination, size * sizeof(T) );
}

#endif //ENABLE_FAKE_HP_DIRECTIVES

#endif