sc_shmem.h

Go to the documentation of this file.

/*
  This file is part of the SC Library.
  The SC Library provides support for parallel scientific applications.
 
  Copyright (C) 2010 The University of Texas System
  Additional copyright (C) 2011 individual authors
 
  The SC 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.
 
  The SC 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 the SC Library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301, USA.
*/
 
#ifndef SC_SHMEM_H
#define SC_SHMEM_H
 
#include <sc.h>
 
SC_EXTERN_C_BEGIN;
 
/* sc_shmem: an interface for arrays that are redundant on each mpi
 * process */
 
typedef enum
{
  SC_SHMEM_BASIC = 0,      
  SC_SHMEM_PRESCAN,        
#ifdef SC_ENABLE_MPIWINSHARED
  SC_SHMEM_WINDOW,         
  SC_SHMEM_WINDOW_PRESCAN, 
#endif
#if defined(__bgq__)
  SC_SHMEM_BGQ,            
  SC_SHMEM_BGQ_PRESCAN,    
#endif
  SC_SHMEM_NUM_TYPES,
  SC_SHMEM_NOT_SET
}
sc_shmem_type_t;
 
extern const char  *sc_shmem_type_to_string[SC_SHMEM_NUM_TYPES];
 
extern sc_shmem_type_t sc_shmem_default_type;
 
/* ALL sc_shmem routines should be considered collective: called on
 * every process in the communicator */
 
void                sc_shmem_set_type (sc_MPI_Comm comm,
                                       sc_shmem_type_t type);
 
sc_shmem_type_t     sc_shmem_get_type (sc_MPI_Comm comm);
 
void               *sc_shmem_malloc (int package, size_t elem_size,
                                     size_t elem_count, sc_MPI_Comm comm);
 
#define SC_SHMEM_ALLOC(t,e,c) (t *) sc_shmem_malloc(sc_package_id,sizeof(t),e,c)
 
void                sc_shmem_free (int package, void *array,
                                   sc_MPI_Comm comm);
 
#define SC_SHMEM_FREE(a,c) sc_shmem_free (sc_package_id,a,c)
 
int                 sc_shmem_write_start (void *array, sc_MPI_Comm comm);
 
void                sc_shmem_write_end (void *array, sc_MPI_Comm comm);
 
void                sc_shmem_memcpy (void *destarray, void *srcarray,
                                     size_t bytes, sc_MPI_Comm comm);
 
void                sc_shmem_allgather (void *sendbuf, int sendcount,
                                        sc_MPI_Datatype sendtype,
                                        void *recvbuf, int recvcount,
                                        sc_MPI_Datatype recvtype,
                                        sc_MPI_Comm comm);
 
void                sc_shmem_prefix (void *sendbuf, void *recvbuf,
                                     int count, sc_MPI_Datatype type,
                                     sc_MPI_Op op, sc_MPI_Comm comm);
SC_EXTERN_C_END;
 
#endif /* SC_SHMEM_H */