Charm++: Charm Source Code Documentation

00001 /*
00002  * This file is separate from pup_c.h because PUP is included as part
00003  * of AMPI's extensions to the MPI standard, and certain global variable
00004  * privatization methods require the AMPI API to be exposed as function pointers
00005  * through a shim and loader mechanism that needs to list the entire set of
00006  * provided functions at multiple points in its implementation.
00007  *
00008  * See src/libs/ck-libs/ampi/ampi_functions.h for mandatory procedures.
00009  *
00010  * For ease of reading: AMPI_CUSTOM_FUNC(ReturnType, FunctionName, Parameters...)
00011  */
00012 
00013 /*Allocate PUP::er of different kind */
00014 AMPI_CUSTOM_FUNC(pup_er, pup_new_sizer, void)
00015 AMPI_CUSTOM_FUNC(pup_er, pup_new_toMem, void *Nbuf)
00016 AMPI_CUSTOM_FUNC(pup_er, pup_new_fromMem, const void *Nbuf)
00017 AMPI_CUSTOM_FUNC(pup_er, pup_new_network_sizer, void)
00018 AMPI_CUSTOM_FUNC(pup_er, pup_new_network_pack, void *Nbuf)
00019 AMPI_CUSTOM_FUNC(pup_er, pup_new_network_unpack, const void *Nbuf)
00020 #if CMK_CCS_AVAILABLE
00021 AMPI_CUSTOM_FUNC(pup_er, pup_new_fmt, pup_er p)
00022 AMPI_CUSTOM_FUNC(void, pup_fmt_sync_begin_object, pup_er p)
00023 AMPI_CUSTOM_FUNC(void, pup_fmt_sync_end_object, pup_er p)
00024 AMPI_CUSTOM_FUNC(void, pup_fmt_sync_begin_array, pup_er p)
00025 AMPI_CUSTOM_FUNC(void, pup_fmt_sync_end_array, pup_er p)
00026 AMPI_CUSTOM_FUNC(void, pup_fmt_sync_item, pup_er p)
00027 #endif
00028 AMPI_CUSTOM_FUNC(void, pup_destroy, pup_er p)
00029 
00030 /*Determine what kind of pup_er we have--
00031 return 1 for true, 0 for false.*/
00032 AMPI_CUSTOM_FUNC(int, pup_isPacking, const pup_er p)
00033 AMPI_CUSTOM_FUNC(int, pup_isUnpacking, const pup_er p)
00034 AMPI_CUSTOM_FUNC(int, pup_isSizing, const pup_er p)
00035 AMPI_CUSTOM_FUNC(int, pup_isDeleting, const pup_er p)
00036 AMPI_CUSTOM_FUNC(int, pup_isUserlevel, const pup_er p)
00037 AMPI_CUSTOM_FUNC(int, pup_isRestarting, const pup_er p)
00038 AMPI_CUSTOM_FUNC(char *, pup_typeString, const pup_er p)
00039 
00040 /*Insert a synchronization into the data stream */
00041 AMPI_CUSTOM_FUNC(void, pup_syncComment, const pup_er p, unsigned int sync, const char *message)
00042 AMPI_CUSTOM_FUNC(void, pup_comment, const pup_er p, const char *message)
00043 
00044 /*Read the size of a pupper */
00045 AMPI_CUSTOM_FUNC(size_t, pup_size, const pup_er p)
00046 
00047 /* Utilities to approximately encode large sizes, within 0.5% */
00048 AMPI_CUSTOM_FUNC(CMK_TYPEDEF_UINT2, pup_encodeSize, size_t s)
00049 AMPI_CUSTOM_FUNC(size_t, pup_decodeSize, CMK_TYPEDEF_UINT2 a)
00050 
00051 /*Pack/unpack data items, declared with macros for brevity.
00052 The macros expand like:
00053 AMPI_CUSTOM_FUNC(void, pup_int, pup_er p,int *i) // <- single integer pack/unpack
00054 AMPI_CUSTOM_FUNC(void, pup_ints, pup_er p,int *iarr,int nItems) // <- array pack/unpack
00055 */
00056 #define PUP_BASIC_DATATYPE(typeName,type) \
00057   AMPI_CUSTOM_FUNC(void, pup_##typeName, pup_er p,type *v) \
00058   AMPI_CUSTOM_FUNC(void, pup_##typeName##s, pup_er p,type *arr,size_t nItems)
00059 
00060 PUP_BASIC_DATATYPE(char,char)
00061 PUP_BASIC_DATATYPE(short,short)
00062 PUP_BASIC_DATATYPE(int,int)
00063 PUP_BASIC_DATATYPE(long,long)
00064 PUP_BASIC_DATATYPE(uchar,unsigned char)
00065 PUP_BASIC_DATATYPE(ushort,unsigned short)
00066 PUP_BASIC_DATATYPE(uint,unsigned int)
00067 PUP_BASIC_DATATYPE(ulong,unsigned long)
00068 PUP_BASIC_DATATYPE(float,float)
00069 PUP_BASIC_DATATYPE(double,double)
00070 PUP_BASIC_DATATYPE(pointer,void*)
00071 PUP_BASIC_DATATYPE(int8, CMK_TYPEDEF_INT8)
00072 PUP_BASIC_DATATYPE(size_t, size_t)
00073 
00074 #undef PUP_BASIC_DATATYPE
00075 
00076 /*Pack/unpack untyped byte array:*/
00077 AMPI_CUSTOM_FUNC(void, pup_bytes, pup_er p,void *ptr,size_t nBytes)
util/pup_c_functions.h
