mcbsp.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012 by Albert-Jan N. Yzelman
 *
 * 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 _H_MCBSP
#define _H_MCBSP

#define MCBSP_USE_SPINLOCK

#define MCBSP_ALLOW_MULTIPLE_REGS

#define MCBSP_ENABLE_HP_DIRECTIVES

#define ENABLE_FAKE_HP_DIRECTIVES

//define MCBSP_NO_CHECKS to disable all run-time sanity
//checks, except those regarding memory allocation.

#ifdef MCBSP_COMPATIBILITY_MODE

 #define MCBSP_PROCESSOR_INDEX_DATATYPE int

 #define MCBSP_NUMMSG_TYPE              int

 #define MCBSP_BYTESIZE_TYPE            int
#else

 #define MCBSP_PROCESSOR_INDEX_DATATYPE unsigned int

 #define MCBSP_NUMMSG_TYPE              unsigned int

 #define MCBSP_BYTESIZE_TYPE            size_t
#endif

//set forced defines
#ifdef MCBSP_COMPATIBILITY_MODE
 //The BSPlib standard requires multiple registrations.
 #define MCBSP_ALLOW_MULTIPLE_REGS
 //The BSPlib standard prescribes the existance of 
 //bsp_hpput and bsp_hpget, so they should be defined
 //even if no actual high-performant implementation is 
 //actually available.
 #define MCBSP_ENABLE_HP_DIRECTIVES
 #define ENABLE_FAKE_HP_DIRECTIVES
#endif
#ifdef ENABLE_FAKE_HP_DIRECTIVES
 //if fake HP directives are defined,
 //HP directives are enabled.
 #define MCBSP_ENABLE_HP_DIRECTIVES
#endif


#include <stdarg.h>
#include <stddef.h>

void bsp_begin( const MCBSP_PROCESSOR_INDEX_DATATYPE P );

void bsp_end();

void bsp_init( void (*spmd)(void), int argc, char **argv );

void bsp_abort( char *error_message, ... );

void bsp_vabort( char *error_message, va_list args );

MCBSP_PROCESSOR_INDEX_DATATYPE bsp_nprocs();

MCBSP_PROCESSOR_INDEX_DATATYPE bsp_pid();

double bsp_time();

void bsp_sync();

void bsp_push_reg( void * const address, const MCBSP_BYTESIZE_TYPE size );

void bsp_pop_reg( void * const address );

void bsp_put( const MCBSP_PROCESSOR_INDEX_DATATYPE pid, const void * const source,
        void * const destination, const MCBSP_BYTESIZE_TYPE offset, const MCBSP_BYTESIZE_TYPE size );

void bsp_get( const MCBSP_PROCESSOR_INDEX_DATATYPE pid, const void * const source,
        const MCBSP_BYTESIZE_TYPE offset, void * const destination, const MCBSP_BYTESIZE_TYPE size );

void bsp_direct_get( const MCBSP_PROCESSOR_INDEX_DATATYPE pid, const void * const source,
        const MCBSP_BYTESIZE_TYPE offset, void * const destination, const MCBSP_BYTESIZE_TYPE size );

void bsp_set_tagsize( MCBSP_BYTESIZE_TYPE * const size );

void bsp_send( const MCBSP_PROCESSOR_INDEX_DATATYPE pid, const void * const tag,
        const void * const payload, const MCBSP_BYTESIZE_TYPE size );

#ifdef MCBSP_ENABLE_HP_DIRECTIVES

void bsp_hpsend( const MCBSP_PROCESSOR_INDEX_DATATYPE pid, const void * const tag,
        const void * const payload, const MCBSP_BYTESIZE_TYPE size );
#endif

void bsp_qsize( MCBSP_NUMMSG_TYPE * const packets,
        MCBSP_BYTESIZE_TYPE * const accumulated_size );

void bsp_get_tag( MCBSP_BYTESIZE_TYPE * const status,
        void * const tag );

void bsp_move( void * const payload, const MCBSP_BYTESIZE_TYPE max_copy_size );

MCBSP_BYTESIZE_TYPE bsp_hpmove( void* * const p_tag, void* * const p_payload );

#ifdef ENABLE_FAKE_HP_DIRECTIVES

void bsp_hpput( const MCBSP_PROCESSOR_INDEX_DATATYPE pid, const void * const source,
        void * const destination, const MCBSP_BYTESIZE_TYPE offset, const MCBSP_BYTESIZE_TYPE size );

void bsp_hpget( const MCBSP_PROCESSOR_INDEX_DATATYPE pid, const void * const source,
        const MCBSP_BYTESIZE_TYPE offset, void * const destination, const MCBSP_BYTESIZE_TYPE size );
#endif

#endif