nm_mpi_types.h

Go to the documentation of this file.

/*
 * NewMadeleine
 * Copyright (C) 2006-2026 (see AUTHORS file)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or (at
 * your option) any later version.
 *
 * This program 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
 * General Public License for more details.
 */
 
 
#ifndef NM_MPI_TYPES_H
#define NM_MPI_TYPES_H
 
#include <stdint.h>
#include <sys/types.h>
 
#include <nm_config.h>
 
#define MPI_PROC_NULL   (-1)
 
#define MPI_ANY_SOURCE  (-2)
 
#define MPI_ROOT        (-3)
 
#define MPI_ANY_TAG     (-1)
 
#define MPI_BOTTOM      (void*)0
 
#define MPI_IN_PLACE    NULL
 
#define MPI_BSEND_OVERHEAD 0
 
#define MPI_SUCCESS          0
/* base error codes, used as error class */
#define MPI_ERR_BUFFER                1
#define MPI_ERR_COUNT                 2
#define MPI_ERR_TYPE                  3
#define MPI_ERR_TAG                   4
#define MPI_ERR_COMM                  5
#define MPI_ERR_RANK                  6
#define MPI_ERR_ROOT                  7
#define MPI_ERR_GROUP                 8
#define MPI_ERR_OP                    9
#define MPI_ERR_TOPOLOGY              10
#define MPI_ERR_DIMS                  11
#define MPI_ERR_ARG                   12
#define MPI_ERR_UNKNOWN               13
#define MPI_ERR_TRUNCATE              14
#define MPI_ERR_OTHER                 15
#define MPI_ERR_INTERN                16
#define MPI_ERR_IN_STATUS             17
#define MPI_ERR_PENDING               18
#define MPI_ERR_INFO                  19
#define MPI_ERR_NO_MEM                20
#define MPI_ERR_REQUEST               32
#define MPI_ERR_KEYVAL                33
#define MPI_ERR_INFO_KEY              34
#define MPI_ERR_INFO_VALUE            35
#define MPI_ERR_INFO_NOKEY            36
#define MPI_ERR_VALUE_TOO_LARGE       37
/* error code for dyn conns */
#define MPI_ERR_NAME                  40
#define MPI_ERR_PORT                  41
#define MPI_ERR_CONVERSION            42
#define MPI_ERR_PROC_ABORTED          43
#define MPI_ERR_SERVICE               44
#define MPI_ERR_SPAWN                 45
/* error codes for MPI-IO */
#define MPI_ERR_FILE                  64
#define MPI_ERR_IO                    65
#define MPI_ERR_AMODE                 66
#define MPI_ERR_UNSUPPORTED_OPERATION 67
#define MPI_ERR_UNSUPPORTED_DATAREP   68
#define MPI_ERR_READ_ONLY             69
#define MPI_ERR_ACCESS                70
#define MPI_ERR_DUP_DATAREP           71
#define MPI_ERR_NO_SUCH_FILE          72
#define MPI_ERR_NOT_SAME              73
#define MPI_ERR_BAD_FILE              74
#define MPI_ERR_FILE_IN_USE           75
#define MPI_ERR_NO_SPACE              76
#define MPI_ERR_QUOTA                 77
#define MPI_ERR_FILE_EXISTS           78
/* error codes for MPI-RMA */
#define MPI_ERR_WIN          92  
#define MPI_ERR_BASE         93  
#define MPI_ERR_SIZE         94  
#define MPI_ERR_DISP         96  
#define MPI_ERR_LOCKTYPE     97  
#define MPI_ERR_ASSERT       98  
#define MPI_ERR_RMA_CONFLICT 99  
#define MPI_ERR_RMA_SYNC     100 
#define MPI_ERR_RMA_RANGE    101 
#define MPI_ERR_RMA_ATTACH   102 
#define MPI_ERR_RMA_SHARED   103 
#define MPI_ERR_RMA_FLAVOR   104 
/* sessions */
#define MPI_ERR_SESSION      112
/* MPI tool support */
 
#define MPI_T_ERR_INVALID           128 
#define MPI_T_ERR_MEMORY            129 
#define MPI_T_ERR_NOT_INITIALIZED   130 
#define MPI_T_ERR_CANNOT_INIT       131 
#define MPI_T_ERR_NOT_ACCESSIBLE    132 
#define MPI_T_ERR_INVALID_INDEX     133 
#define MPI_T_ERR_INVALID_NAME      134 
#define MPI_T_ERR_INVALID_HANDLE    135 
#define MPI_T_ERR_OUT_OF_HANDLES    136 
#define MPI_T_ERR_OUT_OF_SESSIONS   137 
#define MPI_T_ERR_INVALID_SESSION   138 
#define MPI_T_ERR_CVAR_SET_NOT_NOW  139 
#define MPI_T_ERR_CVAR_SET_NEVER    140 
#define MPI_T_ERR_PVAR_NO_STARTSTOP 141 
#define MPI_T_ERR_PVAR_NO_WRITE     142 
#define MPI_T_ERR_PVAR_NO_ATOMIC    143 
#define MPI_T_ERR_NOT_SUPPORTED     144 
#define MPI_T_ERR_INVALID_ITEM      145 
#define MPI_ERR_LASTCODE              160
 
#define MPI_UNDEFINED      (-2147483647)
#define MPI_UNDEFINED_RANK MPI_UNDEFINED
#define MPI_THREAD_SINGLE       0
#define MPI_THREAD_FUNNELED     1
#define MPI_THREAD_SERIALIZED   2
#define MPI_THREAD_MULTIPLE     3
typedef intptr_t nm_mpi_aint_t;
typedef nm_mpi_aint_t MPI_Aint;
 
typedef int64_t nm_mpi_count_t;
typedef nm_mpi_count_t MPI_Count;
 
typedef int MPI_Info;
#define MPI_INFO_NULL       ((MPI_Info)0)
#define MPI_INFO_ENV        ((MPI_Info)1)
#define _NM_MPI_INFO_OFFSET ((MPI_Info)2)
#define MPI_MAX_INFO_KEY 255
#define MPI_MAX_INFO_VAL 1024
#define MPI_STATUS_SIZE                 5
 
struct nm_mpi_status_s
{
  int MPI_SOURCE; 
  int MPI_TAG;    
  int MPI_ERROR;  
  int size;       
  int cancelled;  
};
 
typedef struct nm_mpi_status_s MPI_Status;
 
#define MPI_STATUS_IGNORE       (MPI_Status *)0
#define MPI_STATUSES_IGNORE     (MPI_Status *)0
typedef int MPI_Request;
 
#define MPI_REQUEST_NULL   ((MPI_Request)0)
#define _NM_MPI_REQUEST_OFFSET           1
 
typedef int MPI_Grequest_query_function(void*extra_state, MPI_Status*status);
typedef int MPI_Grequest_free_function(void*extra_state);
typedef int MPI_Grequest_cancel_function(void*extra_state, int complete);
typedef int MPI_Message;
 
#define MPI_MESSAGE_NULL ((MPI_Message)0)
typedef int MPI_Group;
#define MPI_GROUP_NULL  ((MPI_Group)0)
#define MPI_GROUP_EMPTY ((MPI_Group)1)
#define _NM_MPI_GROUP_OFFSET        2
#define MPI_IDENT     0x01
#define MPI_SIMILAR   0x02
#define MPI_CONGRUENT 0x03
#define MPI_UNEQUAL   0x04
typedef int MPI_Comm;
#define MPI_COMM_NULL  ((MPI_Comm)0)
#define MPI_COMM_WORLD ((MPI_Comm)1)
#define MPI_COMM_SELF  ((MPI_Comm)2)
#define _NM_MPI_COMM_OFFSET 3
#define MPI_COMM_TYPE_SHARED 1
 
#define MPI_GRAPH 0x01
 
#define MPI_CART  0x02
 
#define MPI_DIST_GRAPH 0x03
 
typedef int MPI_Session;
#define MPI_SESSION_NULL  ((MPI_Session)0)
#define NM_MPI_SESSION_WORLD ((MPI_Session)1)
#define _NM_MPI_SESSION_OFFSET 2
 
#define MPI_MAX_PSET_NAME_LEN 64
typedef int MPI_Datatype;
#define MPI_DATATYPE_NULL         ((MPI_Datatype)0)
/* C types */
#define MPI_CHAR                  ((MPI_Datatype)1)
#define MPI_UNSIGNED_CHAR         ((MPI_Datatype)2)
#define MPI_SIGNED_CHAR           ((MPI_Datatype)3)
#define MPI_BYTE                  ((MPI_Datatype)4)
#define MPI_SHORT                 ((MPI_Datatype)5)
#define MPI_UNSIGNED_SHORT        ((MPI_Datatype)6)
#define MPI_INT                   ((MPI_Datatype)7)
#define MPI_UNSIGNED              ((MPI_Datatype)8)
#define MPI_LONG                  ((MPI_Datatype)9)
#define MPI_UNSIGNED_LONG         ((MPI_Datatype)10)
#define MPI_FLOAT                 ((MPI_Datatype)11)
#define MPI_DOUBLE                ((MPI_Datatype)12)
#define MPI_LONG_DOUBLE           ((MPI_Datatype)13)
#define MPI_LONG_LONG_INT         ((MPI_Datatype)14)
#define MPI_LONG_LONG               MPI_LONG_LONG_INT
#define MPI_UNSIGNED_LONG_LONG    ((MPI_Datatype)15)
/* FORTRAN types */
#define MPI_CHARACTER             ((MPI_Datatype)16)
#define MPI_LOGICAL               ((MPI_Datatype)17)
#define MPI_REAL                  ((MPI_Datatype)18)
#define MPI_REAL2                 ((MPI_Datatype)19)
#define MPI_REAL4                 ((MPI_Datatype)20)
#define MPI_REAL8                 ((MPI_Datatype)21)
#define MPI_REAL16                ((MPI_Datatype)22)
#define MPI_DOUBLE_PRECISION      ((MPI_Datatype)23)
#define MPI_INTEGER               ((MPI_Datatype)24)
#define MPI_INTEGER1              ((MPI_Datatype)25)
#define MPI_INTEGER2              ((MPI_Datatype)26)
#define MPI_INTEGER4              ((MPI_Datatype)27)
#define MPI_INTEGER8              ((MPI_Datatype)28)
#define MPI_INTEGER16             ((MPI_Datatype)29)
#define MPI_COMPLEX               ((MPI_Datatype)30)
#define MPI_COMPLEX4              ((MPI_Datatype)31)
#define MPI_COMPLEX8              ((MPI_Datatype)32)
#define MPI_COMPLEX16             ((MPI_Datatype)33)
#define MPI_COMPLEX32             ((MPI_Datatype)34)
#define MPI_DOUBLE_COMPLEX        ((MPI_Datatype)35)
#define MPI_PACKED                ((MPI_Datatype)36)
/* C struct types */
#define MPI_LONG_INT              ((MPI_Datatype)37)
#define MPI_SHORT_INT             ((MPI_Datatype)38)
#define MPI_FLOAT_INT             ((MPI_Datatype)39)
#define MPI_DOUBLE_INT            ((MPI_Datatype)40)
#define MPI_LONG_DOUBLE_INT       ((MPI_Datatype)41)
/* FORTRAN struct types*/
#define MPI_2INT                  ((MPI_Datatype)42)
#define MPI_2INTEGER              ((MPI_Datatype)43)
#define MPI_2REAL                 ((MPI_Datatype)44)
#define MPI_2DOUBLE_PRECISION     ((MPI_Datatype)45)
/* special types for bounds */
#define MPI_UB                    ((MPI_Datatype)46)
#define MPI_LB                    ((MPI_Datatype)47)
/* MPI-2 C types */
#define MPI_INT8_T                ((MPI_Datatype)48)
#define MPI_INT16_T               ((MPI_Datatype)49)
#define MPI_INT32_T               ((MPI_Datatype)50)
#define MPI_INT64_T               ((MPI_Datatype)51)
#define MPI_UINT8_T               ((MPI_Datatype)52)
#define MPI_UINT16_T              ((MPI_Datatype)53)
#define MPI_UINT32_T              ((MPI_Datatype)54)
#define MPI_UINT64_T              ((MPI_Datatype)55)
#define MPI_AINT                  ((MPI_Datatype)56)
#define MPI_OFFSET                ((MPI_Datatype)57)
#define MPI_C_BOOL                ((MPI_Datatype)58)
#define MPI_C_COMPLEX               MPI_C_FLOAT_COMPLEX
#define MPI_C_FLOAT_COMPLEX       ((MPI_Datatype)59)
#define MPI_C_DOUBLE_COMPLEX      ((MPI_Datatype)60)
#define MPI_C_LONG_DOUBLE_COMPLEX ((MPI_Datatype)61)
#define MPI_WCHAR                 ((MPI_Datatype)62)
/* MPI-3 MPI_Count */
#define MPI_COUNT                 ((MPI_Datatype)63)
/* unsupported C++ types- define to TYPE_NULL */
#define MPI_CXX_BOOL                MPI_DATATYPE_NULL
#define MPI_CXX_FLOAT_COMPLEX       MPI_DATATYPE_NULL
#define MPI_CXX_DOUBLE_COMPLEX      MPI_DATATYPE_NULL
#define MPI_CXX_LONG_DOUBLE_COMPLEX MPI_DATATYPE_NULL
/* offset for dynamically allocated datatypes */
#define _NM_MPI_DATATYPE_OFFSET              64
typedef enum
  {
    MPI_COMBINER_NAMED,       
    MPI_COMBINER_CONTIGUOUS,  
    MPI_COMBINER_VECTOR,      
    MPI_COMBINER_HVECTOR,     
    MPI_COMBINER_INDEXED,     
    MPI_COMBINER_HINDEXED,    
    MPI_COMBINER_STRUCT,      
    MPI_COMBINER_RESIZED,     
    MPI_COMBINER_DUP,         
    MPI_COMBINER_INDEXED_BLOCK,
    MPI_COMBINER_HINDEXED_BLOCK,
    MPI_COMBINER_SUBARRAY
  }
  nm_mpi_type_combiner_t;
 
#define MPI_ORDER_C        1  
#define MPI_ORDER_FORTRAN  2  
#define MPI_DISTRIBUTE_BLOCK     1
#define MPI_DISTRIBUTE_CYCLIC    2
#define MPI_DISTRIBUTE_NONE      3
#define MPI_DISTRIBUTE_DFLT_DARG 4
typedef int MPI_Op;
#define MPI_OP_NULL ((MPI_Op)0)
#define MPI_MAX     ((MPI_Op)1)
#define MPI_MIN     ((MPI_Op)2)
#define MPI_SUM     ((MPI_Op)3)
#define MPI_PROD    ((MPI_Op)4)
#define MPI_LAND    ((MPI_Op)5)
#define MPI_BAND    ((MPI_Op)6)
#define MPI_LOR     ((MPI_Op)7)
#define MPI_BOR     ((MPI_Op)8)
#define MPI_LXOR    ((MPI_Op)9)
#define MPI_BXOR    ((MPI_Op)10)
#define MPI_MINLOC  ((MPI_Op)11)
#define MPI_MAXLOC  ((MPI_Op)12)
#define MPI_REPLACE ((MPI_Op)13)
#define MPI_NO_OP   ((MPI_Op)14)
#define _NM_MPI_OP_OFFSET    15
#define MPI_MAX_PROCESSOR_NAME 256
#define MPI_MAX_ERROR_STRING   512
#define MPI_MAX_NAME_STRING    256
#define MPI_MAX_OBJECT_NAME    256
#define MPI_MAX_LIBRARY_VERSION_STRING 256
 
typedef int MPI_Win;
#define MPI_WIN_NULL       ((MPI_Win)0)
#define _NM_MPI_WIN_OFFSET ((MPI_Win)1)
 
#define MPI_MODE_NO_ASSERT 0x00
#define MPI_MODE_NOCHECK   0x01
#define MPI_MODE_NOSTORE   0x02
#define MPI_MODE_NOPUT     0x04
#define MPI_MODE_NOPRECEDE 0x08
#define MPI_MODE_NOSUCCEED 0x10
#define MPI_WIN_FLAVOR_CREATE   0
#define MPI_WIN_FLAVOR_ALLOCATE 1
#define MPI_WIN_FLAVOR_DYNAMIC  2
#define MPI_WIN_FLAVOR_SHARED   3
#define MPI_WIN_BASE          0
#define MPI_WIN_SIZE          1
#define MPI_WIN_DISP_UNIT     2
#define MPI_WIN_CREATE_FLAVOR 3
#define MPI_WIN_MODEL         4
#define MPI_WIN_SEPARATE 0
#define MPI_WIN_UNIFIED  1
#define MPI_LOCK_EXCLUSIVE  1
#define MPI_LOCK_SHARED     2
typedef int MPI_Errhandler;
#define MPI_ERRHANDLER_NULL  ((MPI_Errhandler)0)
 
#define MPI_ERRORS_ARE_FATAL ((MPI_Errhandler)1)
#define MPI_ERRORS_RETURN    ((MPI_Errhandler)2)
#define _NM_MPI_ERRHANDLER_OFFSET             3
 
/* MPI-1 */
typedef void (MPI_Handler_function)(MPI_Comm*, int*, ...);
/* MPI-2 */
typedef void (MPI_Comm_errhandler_function)(MPI_Comm*, int*, ...);
typedef MPI_Comm_errhandler_function MPI_Comm_errhandler_fn; 
typedef void (MPI_Win_errhandler_function)(MPI_Win*, int*, ...);
typedef MPI_Win_errhandler_function MPI_Win_errhandler_fn; 
/* MPI-4 */
typedef void MPI_Session_errhandler_function(MPI_Session*, int*error_code, ...);
/* MPI-1 */
typedef int (MPI_Copy_function)(MPI_Comm oldcomm, int keyval, void*extra_state, void*attribute_val_in, void*attribute_val_out, int*flag);
typedef int (MPI_Delete_function)(MPI_Comm comm, int keyval, void*attribute_val, void*extra_state);
#define MPI_NULL_COPY_FN   ((MPI_Copy_function*)0)
#define MPI_DUP_FN         ((MPI_Copy_function*)-1)
#define MPI_NULL_DELETE_FN ((MPI_Delete_function*)0)
/* MPI-2 */
typedef int (MPI_Comm_copy_attr_function)(MPI_Comm oldcomm, int comm_keyval, void*extra_state, void*attribute_val_in, void*attribute_val_out, int*flag);
typedef int (MPI_Comm_delete_attr_function)(MPI_Comm comm, int comm_keyval, void*attribute_val, void*extra_state);
#define MPI_COMM_NULL_COPY_FN   ((MPI_Comm_copy_attr_function*)0)
#define MPI_COMM_NULL_DELETE_FN ((MPI_Comm_delete_attr_function*)0)
#define MPI_COMM_DUP_FN         ((MPI_Comm_copy_attr_function*)-1)
/* MPI-3 */
typedef int (MPI_Win_copy_attr_function)(MPI_Win oldwin, int win_keyval, void*extra_state, void*attribute_val_in, void*attribute_val_out, int*flag);
typedef int (MPI_Win_delete_attr_function)(MPI_Win win, int win_keyval, void*attribute_val, void*extra_state);
typedef int (MPI_Type_copy_attr_function)(MPI_Datatype oldtype, int type_keyval, void*extra_state, void*attribute_val_in, void*attribute_val_out, int*flag);
typedef int (MPI_Type_delete_attr_function)(MPI_Datatype datatype, int type_keyval, void*attribute_val, void*extra_state);
#define MPI_WIN_NULL_COPY_FN    ((MPI_Win_copy_attr_function*)0)
#define MPI_TYPE_NULL_COPY_FN   ((MPI_Type_copy_attr_function*)0)
#define MPI_WIN_NULL_DELETE_FN  ((MPI_Win_delete_attr_function*)0)
#define MPI_TYPE_NULL_DELETE_FN ((MPI_Type_delete_attr_function*)0)
#define MPI_WIN_DUP_FN          ((MPI_Win_copy_attr_function*)-1)
#define MPI_TYPE_DUP_FN         ((MPI_Type_copy_attr_function*)-1)
 
#define MPI_KEYVAL_INVALID  0
 
#define MPI_TAG_UB          1
#define MPI_HOST            2
#define MPI_IO              3
#define MPI_WTIME_IS_GLOBAL 4
#define MPI_UNIVERSE_SIZE   5
#define MPI_APPNUM          6
#define MPI_LASTUSEDCODE    7
#define _NM_MPI_ATTR_OFFSET 8
 
typedef int MPI_T_enum;
 
#define MPI_T_ENUM_NULL        ((MPI_T_enum)0)
 
typedef int MPI_T_cvar_handle;
 
#define MPI_T_CVAR_HANDLE_NULL ((MPI_T_cvar_handle)0)
 
typedef int MPI_T_pvar_handle;
 
#define MPI_T_PVAR_HANDLE_NULL ((MPI_T_pvar_handle)0)
#define MPI_T_PVAR_ALL_HANDLES ((MPI_T_pvar_handle)-1)
 
typedef int MPI_T_pvar_session;
 
#define MPI_T_PVAR_SESSION_NULL ((MPI_T_pvar_session)0)
 
/* verbosity levels */
#define MPI_T_VERBOSITY_USER_BASIC    1
#define MPI_T_VERBOSITY_USER_DETAIL   2
#define MPI_T_VERBOSITY_USER_ALL      3
#define MPI_T_VERBOSITY_TUNER_BASIC   4
#define MPI_T_VERBOSITY_TUNER_DETAIL  5
#define MPI_T_VERBOSITY_TUNER_ALL     6
#define MPI_T_VERBOSITY_MPIDEV_BASIC  7
#define MPI_T_VERBOSITY_MPIDEV_DETAIL 8
#define MPI_T_VERBOSITY_MPIDEV_ALL    9
 
/* MPI tool binding */
#define MPI_T_BIND_NO_OBJECT       0
#define MPI_T_BIND_MPI_COMM        1
#define MPI_T_BIND_MPI_DATATYPE    2
#define MPI_T_BIND_MPI_ERRHANDLER  3
#define MPI_T_BIND_MPI_FILE        4
#define MPI_T_BIND_MPI_GROUP       5
#define MPI_T_BIND_MPI_OP          6
#define MPI_T_BIND_MPI_REQUEST     7
#define MPI_T_BIND_MPI_WIN         8
#define MPI_T_BIND_MPI_MESSAGE     9
#define MPI_T_BIND_MPI_INFO       10
#define MPI_T_BIND_MPI_SESSION    11
 
/* scope for cvars */
#define MPI_T_SCOPE_CONSTANT       1
#define MPI_T_SCOPE_READONLY       2
#define MPI_T_SCOPE_LOCAL          3
#define MPI_T_SCOPE_GROUP          4
#define MPI_T_SCOPE_GROUP_EQ       5
#define MPI_T_SCOPE_ALL            6
#define MPI_T_SCOPE_ALL_EQ         7
 
/* classes for pvars */
/* warning, values must match enum nm_profile_class_e */
#define MPI_T_PVAR_CLASS_STATE         1
#define MPI_T_PVAR_CLASS_LEVEL         2
#define MPI_T_PVAR_CLASS_SIZE          3
#define MPI_T_PVAR_CLASS_PERCENTAGE    4
#define MPI_T_PVAR_CLASS_HIGHWATERMARK 5
#define MPI_T_PVAR_CLASS_LOWWATERMARK  6
#define MPI_T_PVAR_CLASS_COUNTER       7
#define MPI_T_PVAR_CLASS_AGGREGATE     8
#define MPI_T_PVAR_CLASS_TIMER         9
#define MPI_T_PVAR_CLASS_GENERIC      10
 
/* ********************************************************* */
/* ** FORTRAN support */
 
#ifdef NMAD_FORTRAN
 
#if defined(NM_FORTRAN_SIZEOF_INTEGER_4)
typedef int32_t MPI_Fint;
#elif defined(NM_FORTRAN_SIZEOF_INTEGER_8)
typedef int64_t MPI_Fint;
#else
#error undefined Fortran INTEGER size
#endif
 
/* Those global variables are used to store values of predefined static variables(COMMON block) from fortran.
   Their value is defined only between the calls to MPI_INIT and MPI_FINALIZE */
extern MPI_Fint*MPI_F_STATUS_IGNORE;
extern MPI_Fint*MPI_F_STATUSES_IGNORE;
 
#endif /* NMAD_FORTRAN */
 
 
#endif /* NM_MPI_TYPES_H */