TPI.h

/*------------------------------------------------------------------------*/
/*                    TPI: Thread Pool Interface                          */
/*                Copyright (2008) Sandia Corporation                     */
/*                                                                        */
/*  Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive   */
/*  license for use of this work by or on behalf of the U.S. Government.  */
/*                                                                        */
/*  This library 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 2.1 of the  */
/*  License, or (at your option) any later version.                       */
/*                                                                        */
/*  This library 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 this library; if not, write to the Free Software   */
/*  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301   */
/*  USA                                                                   */
/*------------------------------------------------------------------------*/
#ifndef ThreadPoolInterface_h
#define ThreadPoolInterface_h

#if defined( __cplusplus )
extern "C" {
#endif

/*--------------------------------------------------------------------*/
double TPI_Walltime();

/*--------------------------------------------------------------------*/
/* All functions return zero for success. */

#define TPI_LOCK_BUSY      ((int)  1  /* trylock or unlock failed */ )
#define TPI_ERROR_NULL     ((int) -1  /* NULL input */ )
#define TPI_ERROR_SIZE     ((int) -2  /* BAD input: size or index */ )
#define TPI_ERROR_LOCK     ((int) -3  /* BAD lock or unlock */ )
#define TPI_ERROR_ACTIVE   ((int) -4  /* BAD input: the pool is active  */ )
#define TPI_ERROR_INTERNAL ((int) -5  /* internal resource error */ )

/*--------------------------------------------------------------------*/

struct TPI_ThreadPool_Private ; 

typedef struct TPI_ThreadPool_Private * TPI_ThreadPool ;

/*--------------------------------------------------------------------*/
typedef void (*TPI_parallel_subprogram)( void * shared_data ,
                                         TPI_ThreadPool pool );

int TPI_Run( TPI_parallel_subprogram /* subprogram  */ ,
             void *                  /* shared data */ ,
             int                     /* work size   */ );

int TPI_Rank( TPI_ThreadPool , int * /* rank */ , int * /* size */ );

int TPI_Set_lock_size( int );

int TPI_Lock( TPI_ThreadPool , int );

int TPI_Trylock( TPI_ThreadPool , int );

int TPI_Unlock( TPI_ThreadPool , int );

/*--------------------------------------------------------------------*/
int TPI_Init( int /* thread pool size */ );

int TPI_Size( int * );

int TPI_Finalize();

/*--------------------------------------------------------------------*/
int TPI_Concurrency();

/*--------------------------------------------------------------------*/
int TPI_Partition( int   /* Thread_Rank */ ,
                   int   /* Thread_Size */ ,
                   int   /* Number */ ,
                   int * /* Local_Begin */ ,
                   int * /* Local_Number */ );

/*--------------------------------------------------------------------*/

#if defined( __cplusplus )
}
#endif

#endif