1e5c89e4eSSatish Balay 2e5c89e4eSSatish Balay /* 3e5c89e4eSSatish Balay This file contains simple binary read/write routines. 4e5c89e4eSSatish Balay */ 5e5c89e4eSSatish Balay 6c6db04a5SJed Brown #include <petscsys.h> 7e5c89e4eSSatish Balay #include <errno.h> 8e5c89e4eSSatish Balay #include <fcntl.h> 9e5c89e4eSSatish Balay #if defined(PETSC_HAVE_UNISTD_H) 10e5c89e4eSSatish Balay #include <unistd.h> 11e5c89e4eSSatish Balay #endif 12e5c89e4eSSatish Balay #if defined(PETSC_HAVE_IO_H) 13e5c89e4eSSatish Balay #include <io.h> 14e5c89e4eSSatish Balay #endif 15c6db04a5SJed Brown #include <petscbt.h> 16e5c89e4eSSatish Balay 17d6a4318aSJed Brown const char *const PetscFileModes[] = {"READ","WRITE","APPEND","UPDATE","APPEND_UPDATE","PetscFileMode","PETSC_FILE_",0}; 18d6a4318aSJed Brown 196de02169SBarry Smith /* --------------------------------------------------------- */ 20e5c89e4eSSatish Balay /* 216de02169SBarry Smith PetscByteSwapEnum - Swap bytes in a PETSc Enum 22e5c89e4eSSatish Balay 23e5c89e4eSSatish Balay */ 247087cfbeSBarry Smith PetscErrorCode PetscByteSwapEnum(PetscEnum *buff,PetscInt n) 25e5c89e4eSSatish Balay { 266de02169SBarry Smith PetscInt i,j; 270b20345dSBarry Smith PetscEnum tmp = ENUM_DUMMY; 28e0890e22SSatish Balay char *ptr1,*ptr2 = (char*)&tmp; 29e5c89e4eSSatish Balay 30e5c89e4eSSatish Balay PetscFunctionBegin; 31e5c89e4eSSatish Balay for (j=0; j<n; j++) { 32e5c89e4eSSatish Balay ptr1 = (char*)(buff + j); 33a297a907SKarl Rupp for (i=0; i<(PetscInt)sizeof(PetscEnum); i++) ptr2[i] = ptr1[sizeof(PetscEnum)-1-i]; 34a297a907SKarl Rupp for (i=0; i<(PetscInt)sizeof(PetscEnum); i++) ptr1[i] = ptr2[i]; 35e5c89e4eSSatish Balay } 36e5c89e4eSSatish Balay PetscFunctionReturn(0); 37e5c89e4eSSatish Balay } 386de02169SBarry Smith 396de02169SBarry Smith /* 40acfcf0e5SJed Brown PetscByteSwapBool - Swap bytes in a PETSc Bool 416de02169SBarry Smith 426de02169SBarry Smith */ 437087cfbeSBarry Smith PetscErrorCode PetscByteSwapBool(PetscBool *buff,PetscInt n) 446de02169SBarry Smith { 456de02169SBarry Smith PetscInt i,j; 46ace3abfcSBarry Smith PetscBool tmp = PETSC_FALSE; 47e0890e22SSatish Balay char *ptr1,*ptr2 = (char*)&tmp; 486de02169SBarry Smith 496de02169SBarry Smith PetscFunctionBegin; 506de02169SBarry Smith for (j=0; j<n; j++) { 516de02169SBarry Smith ptr1 = (char*)(buff + j); 52a297a907SKarl Rupp for (i=0; i<(PetscInt)sizeof(PetscBool); i++) ptr2[i] = ptr1[sizeof(PetscBool)-1-i]; 53a297a907SKarl Rupp for (i=0; i<(PetscInt)sizeof(PetscBool); i++) ptr1[i] = ptr2[i]; 546de02169SBarry Smith } 556de02169SBarry Smith PetscFunctionReturn(0); 566de02169SBarry Smith } 576de02169SBarry Smith 58bd1d2e58SBarry Smith /* 596de02169SBarry Smith PetscByteSwapInt - Swap bytes in a PETSc integer (which may be 32 or 64 bits) 60bd1d2e58SBarry Smith 61bd1d2e58SBarry Smith */ 627087cfbeSBarry Smith PetscErrorCode PetscByteSwapInt(PetscInt *buff,PetscInt n) 63bd1d2e58SBarry Smith { 64bd1d2e58SBarry Smith PetscInt i,j,tmp = 0; 65e0890e22SSatish Balay char *ptr1,*ptr2 = (char*)&tmp; 66bd1d2e58SBarry Smith 67bd1d2e58SBarry Smith PetscFunctionBegin; 68bd1d2e58SBarry Smith for (j=0; j<n; j++) { 69bd1d2e58SBarry Smith ptr1 = (char*)(buff + j); 70a297a907SKarl Rupp for (i=0; i<(PetscInt)sizeof(PetscInt); i++) ptr2[i] = ptr1[sizeof(PetscInt)-1-i]; 71a297a907SKarl Rupp for (i=0; i<(PetscInt)sizeof(PetscInt); i++) ptr1[i] = ptr2[i]; 72bd1d2e58SBarry Smith } 73bd1d2e58SBarry Smith PetscFunctionReturn(0); 74bd1d2e58SBarry Smith } 75bd1d2e58SBarry Smith /* --------------------------------------------------------- */ 76e5c89e4eSSatish Balay /* 77e5c89e4eSSatish Balay PetscByteSwapShort - Swap bytes in a short 78e5c89e4eSSatish Balay */ 797087cfbeSBarry Smith PetscErrorCode PetscByteSwapShort(short *buff,PetscInt n) 80e5c89e4eSSatish Balay { 81e5c89e4eSSatish Balay PetscInt i,j; 82e5c89e4eSSatish Balay short tmp; 83e5c89e4eSSatish Balay char *ptr1,*ptr2 = (char*)&tmp; 84e5c89e4eSSatish Balay 85e5c89e4eSSatish Balay PetscFunctionBegin; 86e5c89e4eSSatish Balay for (j=0; j<n; j++) { 87e5c89e4eSSatish Balay ptr1 = (char*)(buff + j); 88a297a907SKarl Rupp for (i=0; i<(PetscInt) sizeof(short); i++) ptr2[i] = ptr1[sizeof(short)-1-i]; 89a297a907SKarl Rupp for (i=0; i<(PetscInt) sizeof(short); i++) ptr1[i] = ptr2[i]; 90e5c89e4eSSatish Balay } 91e5c89e4eSSatish Balay PetscFunctionReturn(0); 92e5c89e4eSSatish Balay } 93e5c89e4eSSatish Balay /* --------------------------------------------------------- */ 94e5c89e4eSSatish Balay /* 954caf0332SSatish Balay PetscByteSwapReal - Swap bytes in a PetscReal 964caf0332SSatish Balay */ 974caf0332SSatish Balay PetscErrorCode PetscByteSwapReal(PetscReal *buff,PetscInt n) 984caf0332SSatish Balay { 994caf0332SSatish Balay PetscInt i,j; 1004caf0332SSatish Balay PetscReal tmp,*buff1 = (PetscReal*)buff; 1014caf0332SSatish Balay char *ptr1,*ptr2 = (char*)&tmp; 1024caf0332SSatish Balay 1034caf0332SSatish Balay PetscFunctionBegin; 1044caf0332SSatish Balay for (j=0; j<n; j++) { 1054caf0332SSatish Balay ptr1 = (char*)(buff1 + j); 1064caf0332SSatish Balay for (i=0; i<(PetscInt) sizeof(PetscReal); i++) ptr2[i] = ptr1[sizeof(PetscReal)-1-i]; 1074caf0332SSatish Balay for (i=0; i<(PetscInt) sizeof(PetscReal); i++) ptr1[i] = ptr2[i]; 1084caf0332SSatish Balay } 1094caf0332SSatish Balay PetscFunctionReturn(0); 1104caf0332SSatish Balay } 1114caf0332SSatish Balay /* --------------------------------------------------------- */ 1124caf0332SSatish Balay /* 11341f502e3SPatrick Sanan PetscByteSwapScalar - Swap bytes in a PetscScalar 11441f502e3SPatrick Sanan The complex case is dealt with with an array of PetscReal, twice as long. 115e5c89e4eSSatish Balay */ 1167087cfbeSBarry Smith PetscErrorCode PetscByteSwapScalar(PetscScalar *buff,PetscInt n) 117e5c89e4eSSatish Balay { 118e5c89e4eSSatish Balay PetscInt i,j; 119e5c89e4eSSatish Balay PetscReal tmp,*buff1 = (PetscReal*)buff; 120e5c89e4eSSatish Balay char *ptr1,*ptr2 = (char*)&tmp; 121e5c89e4eSSatish Balay 122e5c89e4eSSatish Balay PetscFunctionBegin; 123e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX) 124e5c89e4eSSatish Balay n *= 2; 125e5c89e4eSSatish Balay #endif 126e5c89e4eSSatish Balay for (j=0; j<n; j++) { 127e5c89e4eSSatish Balay ptr1 = (char*)(buff1 + j); 128a297a907SKarl Rupp for (i=0; i<(PetscInt) sizeof(PetscReal); i++) ptr2[i] = ptr1[sizeof(PetscReal)-1-i]; 129a297a907SKarl Rupp for (i=0; i<(PetscInt) sizeof(PetscReal); i++) ptr1[i] = ptr2[i]; 130e5c89e4eSSatish Balay } 131e5c89e4eSSatish Balay PetscFunctionReturn(0); 132e5c89e4eSSatish Balay } 133e5c89e4eSSatish Balay /* --------------------------------------------------------- */ 134e5c89e4eSSatish Balay /* 135e5c89e4eSSatish Balay PetscByteSwapDouble - Swap bytes in a double 136e5c89e4eSSatish Balay */ 1377087cfbeSBarry Smith PetscErrorCode PetscByteSwapDouble(double *buff,PetscInt n) 138e5c89e4eSSatish Balay { 139e5c89e4eSSatish Balay PetscInt i,j; 140e5c89e4eSSatish Balay double tmp,*buff1 = (double*)buff; 141e5c89e4eSSatish Balay char *ptr1,*ptr2 = (char*)&tmp; 142e5c89e4eSSatish Balay 143e5c89e4eSSatish Balay PetscFunctionBegin; 144e5c89e4eSSatish Balay for (j=0; j<n; j++) { 145e5c89e4eSSatish Balay ptr1 = (char*)(buff1 + j); 146a297a907SKarl Rupp for (i=0; i<(PetscInt) sizeof(double); i++) ptr2[i] = ptr1[sizeof(double)-1-i]; 147a297a907SKarl Rupp for (i=0; i<(PetscInt) sizeof(double); i++) ptr1[i] = ptr2[i]; 148e5c89e4eSSatish Balay } 149e5c89e4eSSatish Balay PetscFunctionReturn(0); 150e5c89e4eSSatish Balay } 151e39fd77fSBarry Smith 152e95bf02fSSatish Balay /* 153e95bf02fSSatish Balay PetscByteSwapFloat - Swap bytes in a float 154e95bf02fSSatish Balay */ 155e95bf02fSSatish Balay PetscErrorCode PetscByteSwapFloat(float *buff,PetscInt n) 156e95bf02fSSatish Balay { 157e95bf02fSSatish Balay PetscInt i,j; 158e95bf02fSSatish Balay float tmp,*buff1 = (float*)buff; 159e95bf02fSSatish Balay char *ptr1,*ptr2 = (char*)&tmp; 160e95bf02fSSatish Balay 161e95bf02fSSatish Balay PetscFunctionBegin; 162e95bf02fSSatish Balay for (j=0; j<n; j++) { 163e95bf02fSSatish Balay ptr1 = (char*)(buff1 + j); 164a297a907SKarl Rupp for (i=0; i<(PetscInt) sizeof(float); i++) ptr2[i] = ptr1[sizeof(float)-1-i]; 165a297a907SKarl Rupp for (i=0; i<(PetscInt) sizeof(float); i++) ptr1[i] = ptr2[i]; 166e95bf02fSSatish Balay } 167e95bf02fSSatish Balay PetscFunctionReturn(0); 168e95bf02fSSatish Balay } 169e95bf02fSSatish Balay 170e39fd77fSBarry Smith PetscErrorCode PetscByteSwap(void *data,PetscDataType pdtype,PetscInt count) 171e39fd77fSBarry Smith { 172e39fd77fSBarry Smith PetscErrorCode ierr; 173e39fd77fSBarry Smith 174e39fd77fSBarry Smith PetscFunctionBegin; 175e39fd77fSBarry Smith if (pdtype == PETSC_INT) {ierr = PetscByteSwapInt((PetscInt*)data,count);CHKERRQ(ierr);} 176e39fd77fSBarry Smith else if (pdtype == PETSC_ENUM) {ierr = PetscByteSwapEnum((PetscEnum*)data,count);CHKERRQ(ierr);} 177acfcf0e5SJed Brown else if (pdtype == PETSC_BOOL) {ierr = PetscByteSwapBool((PetscBool*)data,count);CHKERRQ(ierr);} 178e39fd77fSBarry Smith else if (pdtype == PETSC_SCALAR) {ierr = PetscByteSwapScalar((PetscScalar*)data,count);CHKERRQ(ierr);} 1794caf0332SSatish Balay else if (pdtype == PETSC_REAL) {ierr = PetscByteSwapReal((PetscReal*)data,count);CHKERRQ(ierr);} 180e39fd77fSBarry Smith else if (pdtype == PETSC_DOUBLE) {ierr = PetscByteSwapDouble((double*)data,count);CHKERRQ(ierr);} 181e95bf02fSSatish Balay else if (pdtype == PETSC_FLOAT) {ierr = PetscByteSwapFloat((float*)data,count);CHKERRQ(ierr);} 182e39fd77fSBarry Smith else if (pdtype == PETSC_SHORT) {ierr = PetscByteSwapShort((short*)data,count);CHKERRQ(ierr);} 183e39fd77fSBarry Smith PetscFunctionReturn(0); 184e39fd77fSBarry Smith } 185e39fd77fSBarry Smith 186e5c89e4eSSatish Balay /* --------------------------------------------------------- */ 187e30d2299SSatish Balay /*@ 188e5c89e4eSSatish Balay PetscBinaryRead - Reads from a binary file. 189e5c89e4eSSatish Balay 190e5c89e4eSSatish Balay Not Collective 191e5c89e4eSSatish Balay 192e5c89e4eSSatish Balay Input Parameters: 193e5c89e4eSSatish Balay + fd - the file 194e5c89e4eSSatish Balay . n - the number of items to read 195e5c89e4eSSatish Balay - type - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR) 196e5c89e4eSSatish Balay 197e5c89e4eSSatish Balay Output Parameters: 198e5c89e4eSSatish Balay . p - the buffer 199e5c89e4eSSatish Balay 200e5c89e4eSSatish Balay 201e5c89e4eSSatish Balay 202e5c89e4eSSatish Balay Level: developer 203e5c89e4eSSatish Balay 204e5c89e4eSSatish Balay Notes: 205e5c89e4eSSatish Balay PetscBinaryRead() uses byte swapping to work on all machines; the files 206e5c89e4eSSatish Balay are written to file ALWAYS using big-endian ordering. On small-endian machines the numbers 207e5c89e4eSSatish Balay are converted to the small-endian format when they are read in from the file. 208e2e64c6bSBarry Smith When PETSc is ./configure with --with-64bit-indices the integers are written to the 20954f21887SBarry Smith file as 64 bit integers, this means they can only be read back in when the option --with-64bit-indices 21054f21887SBarry Smith is used. 211e5c89e4eSSatish Balay 212e5c89e4eSSatish Balay Concepts: files^reading binary 213e5c89e4eSSatish Balay Concepts: binary files^reading 214e5c89e4eSSatish Balay 2154ebed01fSBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscViewerBinaryGetDescriptor(), PetscBinarySynchronizedWrite(), 2164ebed01fSBarry Smith PetscBinarySynchronizedRead(), PetscBinarySynchronizedSeek() 217e5c89e4eSSatish Balay @*/ 2187087cfbeSBarry Smith PetscErrorCode PetscBinaryRead(int fd,void *p,PetscInt n,PetscDataType type) 219e5c89e4eSSatish Balay { 220e5c89e4eSSatish Balay int wsize,err; 221e5c89e4eSSatish Balay size_t m = (size_t) n,maxblock = 65536; 222e5c89e4eSSatish Balay char *pp = (char*)p; 2237a881295SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 224cba51d77SBarry Smith PetscBool readdouble = PETSC_FALSE; 2257a881295SBarry Smith double *ppp; 2267a881295SBarry Smith #endif 2277a881295SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) || defined(PETSC_USE_REAL___FLOAT128) 2286de02169SBarry Smith PetscErrorCode ierr; 2297a881295SBarry Smith #endif 2307a881295SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) 231e5c89e4eSSatish Balay void *ptmp = p; 232e5c89e4eSSatish Balay #endif 23305acbc63SBarry Smith char *fname = NULL; 234e5c89e4eSSatish Balay 235e5c89e4eSSatish Balay PetscFunctionBegin; 2362d53ad75SBarry Smith if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to write a negative amount of data %D",n); 237e5c89e4eSSatish Balay if (!n) PetscFunctionReturn(0); 238e5c89e4eSSatish Balay 2392d53ad75SBarry Smith if (type == PETSC_FUNCTION) { 2402d53ad75SBarry Smith m = 64; 2412d53ad75SBarry Smith type = PETSC_CHAR; 24205acbc63SBarry Smith fname = (char*) malloc(m*sizeof(char)); 24305acbc63SBarry Smith if (!fname) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Cannot allocate space for function name"); 2442d53ad75SBarry Smith pp = (char*)fname; 2452d53ad75SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) 2462d53ad75SBarry Smith ptmp = (void*)fname; 2472d53ad75SBarry Smith #endif 2482d53ad75SBarry Smith } 2492d53ad75SBarry Smith 2506de02169SBarry Smith if (type == PETSC_INT) m *= sizeof(PetscInt); 251e5c89e4eSSatish Balay else if (type == PETSC_SCALAR) m *= sizeof(PetscScalar); 2524caf0332SSatish Balay else if (type == PETSC_REAL) m *= sizeof(PetscReal); 253e5c89e4eSSatish Balay else if (type == PETSC_DOUBLE) m *= sizeof(double); 254e95bf02fSSatish Balay else if (type == PETSC_FLOAT) m *= sizeof(float); 255e5c89e4eSSatish Balay else if (type == PETSC_SHORT) m *= sizeof(short); 256e5c89e4eSSatish Balay else if (type == PETSC_CHAR) m *= sizeof(char); 257e5c89e4eSSatish Balay else if (type == PETSC_ENUM) m *= sizeof(PetscEnum); 258ace3abfcSBarry Smith else if (type == PETSC_BOOL) m *= sizeof(PetscBool); 2599f7b6320SBarry Smith else if (type == PETSC_BIT_LOGICAL) m = PetscBTLength(m)*sizeof(char); 260e32f2f54SBarry Smith else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown type"); 261e5c89e4eSSatish Balay 2627a881295SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 263c5929fdfSBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-binary_read_double",&readdouble,NULL);CHKERRQ(ierr); 2647a881295SBarry Smith /* If using __float128 precision we still read in doubles from file */ 2654caf0332SSatish Balay if ((type == PETSC_SCALAR || type == PETSC_REAL) && readdouble) { 2667a881295SBarry Smith m = m/2; 267785e854fSJed Brown ierr = PetscMalloc1(n,&ppp);CHKERRQ(ierr); 2687a881295SBarry Smith pp = (char*)ppp; 2697a881295SBarry Smith } 2707a881295SBarry Smith #endif 2717a881295SBarry Smith 272e5c89e4eSSatish Balay while (m) { 273e5c89e4eSSatish Balay wsize = (m < maxblock) ? m : maxblock; 274e5c89e4eSSatish Balay err = read(fd,pp,wsize); 275e5c89e4eSSatish Balay if (err < 0 && errno == EINTR) continue; 276e32f2f54SBarry Smith if (!err && wsize > 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"Read past end of file"); 277e32f2f54SBarry Smith if (err < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"Error reading from file, errno %d",errno); 278e5c89e4eSSatish Balay m -= err; 279e5c89e4eSSatish Balay pp += err; 280e5c89e4eSSatish Balay } 2817a881295SBarry Smith 2827a881295SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 2834caf0332SSatish Balay if ((type == PETSC_SCALAR || type == PETSC_REAL) && readdouble) { 2847a881295SBarry Smith PetscScalar *pv = (PetscScalar*) p; 2857a881295SBarry Smith PetscInt i; 2867a881295SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) 2877a881295SBarry Smith ierr = PetscByteSwapDouble(ppp,n);CHKERRQ(ierr); 2887a881295SBarry Smith #endif 289a297a907SKarl Rupp for (i=0; i<n; i++) pv[i] = ppp[i]; 2907a881295SBarry Smith ierr = PetscFree(ppp);CHKERRQ(ierr); 2917a881295SBarry Smith PetscFunctionReturn(0); 2927a881295SBarry Smith } 2937a881295SBarry Smith #endif 2947a881295SBarry Smith 295e5c89e4eSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN) 296e39fd77fSBarry Smith ierr = PetscByteSwap(ptmp,type,n);CHKERRQ(ierr); 297e5c89e4eSSatish Balay #endif 298e5c89e4eSSatish Balay 29905acbc63SBarry Smith if (type == PETSC_FUNCTION) { 3002d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 3010298fd71SBarry Smith ierr = PetscDLSym(NULL,fname,(void**)p);CHKERRQ(ierr); 3022d53ad75SBarry Smith #else 3030298fd71SBarry Smith *(void**)p = NULL; 3042d53ad75SBarry Smith #endif 30505acbc63SBarry Smith free(fname); 3062d53ad75SBarry Smith } 307e5c89e4eSSatish Balay PetscFunctionReturn(0); 308e5c89e4eSSatish Balay } 309e5c89e4eSSatish Balay /* --------------------------------------------------------- */ 310e30d2299SSatish Balay /*@ 311e5c89e4eSSatish Balay PetscBinaryWrite - Writes to a binary file. 312e5c89e4eSSatish Balay 313e5c89e4eSSatish Balay Not Collective 314e5c89e4eSSatish Balay 315e5c89e4eSSatish Balay Input Parameters: 316e5c89e4eSSatish Balay + fd - the file 317e5c89e4eSSatish Balay . p - the buffer 318e5c89e4eSSatish Balay . n - the number of items to write 319e5c89e4eSSatish Balay . type - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR) 320e5c89e4eSSatish Balay - istemp - PETSC_FALSE if buffer data should be preserved, PETSC_TRUE otherwise. 321e5c89e4eSSatish Balay 322e5c89e4eSSatish Balay Level: advanced 323e5c89e4eSSatish Balay 324e5c89e4eSSatish Balay Notes: 325e5c89e4eSSatish Balay PetscBinaryWrite() uses byte swapping to work on all machines; the files 326e5c89e4eSSatish Balay are written using big-endian ordering to the file. On small-endian machines the numbers 327e5c89e4eSSatish Balay are converted to the big-endian format when they are written to disk. 328e2e64c6bSBarry Smith When PETSc is ./configure with --with-64bit-indices the integers are written to the 32954f21887SBarry Smith file as 64 bit integers, this means they can only be read back in when the option --with-64bit-indices 33054f21887SBarry Smith is used. 331e5c89e4eSSatish Balay 33241f502e3SPatrick Sanan If running with __float128 precision the output is in __float128 unless one uses the -binary_write_double option 3330da86b62SBarry Smith 334e5c89e4eSSatish Balay The Buffer p should be read-write buffer, and not static data. 335e5c89e4eSSatish Balay This way, byte-swapping is done in-place, and then the buffer is 336e5c89e4eSSatish Balay written to the file. 337e5c89e4eSSatish Balay 338e5c89e4eSSatish Balay This routine restores the original contents of the buffer, after 339e5c89e4eSSatish Balay it is written to the file. This is done by byte-swapping in-place 340e5c89e4eSSatish Balay the second time. If the flag istemp is set to PETSC_TRUE, the second 341e5c89e4eSSatish Balay byte-swapping operation is not done, thus saving some computation, 342e5f36e38SBarry Smith but the buffer is left corrupted. 343e5c89e4eSSatish Balay 344300a7f5bSBarry Smith Because byte-swapping may be done on the values in data it cannot be declared const 345300a7f5bSBarry Smith 346e5c89e4eSSatish Balay Concepts: files^writing binary 347e5c89e4eSSatish Balay Concepts: binary files^writing 348e5c89e4eSSatish Balay 3494ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryOpen(), PetscBinaryClose(), PetscViewerBinaryGetDescriptor(), PetscBinarySynchronizedWrite(), 3504ebed01fSBarry Smith PetscBinarySynchronizedRead(), PetscBinarySynchronizedSeek() 351e5c89e4eSSatish Balay @*/ 3527087cfbeSBarry Smith PetscErrorCode PetscBinaryWrite(int fd,void *p,PetscInt n,PetscDataType type,PetscBool istemp) 353e5c89e4eSSatish Balay { 354e5c89e4eSSatish Balay char *pp = (char*)p; 355e5c89e4eSSatish Balay int err,wsize; 356e5c89e4eSSatish Balay size_t m = (size_t)n,maxblock=65536; 357e5c89e4eSSatish Balay PetscErrorCode ierr; 358f5351476SHong Zhang #if !defined(PETSC_WORDS_BIGENDIAN) 359e5c89e4eSSatish Balay void *ptmp = p; 360e5c89e4eSSatish Balay #endif 36105acbc63SBarry Smith char *fname = NULL; 3620da86b62SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 363df40af56SBarry Smith PetscBool writedouble = PETSC_FALSE; 3640da86b62SBarry Smith double *ppp; 3650da86b62SBarry Smith PetscReal *pv; 3660da86b62SBarry Smith PetscInt i; 3670da86b62SBarry Smith #endif 36841f502e3SPatrick Sanan PetscDataType wtype = type; 369e5c89e4eSSatish Balay 370e5c89e4eSSatish Balay PetscFunctionBegin; 371e32f2f54SBarry Smith if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to write a negative amount of data %D",n); 372e5c89e4eSSatish Balay if (!n) PetscFunctionReturn(0); 373e5c89e4eSSatish Balay 3742d53ad75SBarry Smith if (type == PETSC_FUNCTION) { 3752d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 3762d53ad75SBarry Smith const char *fnametmp; 3772d53ad75SBarry Smith #endif 3782d53ad75SBarry Smith m = 64; 379e25ab156SSatish Balay fname = (char*)malloc(m*sizeof(char)); 38005acbc63SBarry Smith if (!fname) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Cannot allocate space for function name"); 38105acbc63SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 38205acbc63SBarry Smith if (n > 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Can only binary view a single function at a time"); 38305acbc63SBarry Smith ierr = PetscFPTFind(*(void**)p,&fnametmp);CHKERRQ(ierr); 38405acbc63SBarry Smith ierr = PetscStrncpy(fname,fnametmp,m);CHKERRQ(ierr); 38505acbc63SBarry Smith #else 38605acbc63SBarry Smith ierr = PetscStrncpy(fname,"",m);CHKERRQ(ierr); 38705acbc63SBarry Smith #endif 38801963f56SBarry Smith wtype = PETSC_CHAR; 3892d53ad75SBarry Smith pp = (char*)fname; 3902d53ad75SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) 3912d53ad75SBarry Smith ptmp = (void*)fname; 3922d53ad75SBarry Smith #endif 3932d53ad75SBarry Smith } 3942d53ad75SBarry Smith 3950da86b62SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 3960da86b62SBarry Smith ierr = PetscOptionsGetBool(NULL,NULL,"-binary_write_double",&writedouble,NULL);CHKERRQ(ierr); 3970da86b62SBarry Smith /* If using __float128 precision we still write in doubles to file */ 3984caf0332SSatish Balay if ((type == PETSC_SCALAR || type == PETSC_REAL) && writedouble) { 39941f502e3SPatrick Sanan wtype = PETSC_DOUBLE; 4000da86b62SBarry Smith ierr = PetscMalloc1(n,&ppp);CHKERRQ(ierr); 4010da86b62SBarry Smith pv = (PetscReal*)pp; 4020da86b62SBarry Smith for (i=0; i<n; i++) { 4030da86b62SBarry Smith ppp[i] = (double) pv[i]; 4040da86b62SBarry Smith } 4050da86b62SBarry Smith pp = (char*)ppp; 4060da86b62SBarry Smith ptmp = (char*)ppp; 4070da86b62SBarry Smith } 4080da86b62SBarry Smith #endif 4090da86b62SBarry Smith 41041f502e3SPatrick Sanan if (wtype == PETSC_INT) m *= sizeof(PetscInt); 41141f502e3SPatrick Sanan else if (wtype == PETSC_SCALAR) m *= sizeof(PetscScalar); 4124caf0332SSatish Balay else if (wtype == PETSC_REAL) m *= sizeof(PetscReal); 41341f502e3SPatrick Sanan else if (wtype == PETSC_DOUBLE) m *= sizeof(double); 41441f502e3SPatrick Sanan else if (wtype == PETSC_FLOAT) m *= sizeof(float); 41541f502e3SPatrick Sanan else if (wtype == PETSC_SHORT) m *= sizeof(short); 41641f502e3SPatrick Sanan else if (wtype == PETSC_CHAR) m *= sizeof(char); 41741f502e3SPatrick Sanan else if (wtype == PETSC_ENUM) m *= sizeof(PetscEnum); 41841f502e3SPatrick Sanan else if (wtype == PETSC_BOOL) m *= sizeof(PetscBool); 41941f502e3SPatrick Sanan else if (wtype == PETSC_BIT_LOGICAL) m = PetscBTLength(m)*sizeof(char); 420e32f2f54SBarry Smith else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown type"); 421e5c89e4eSSatish Balay 422e5c89e4eSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN) 42341f502e3SPatrick Sanan ierr = PetscByteSwap(ptmp,wtype,n);CHKERRQ(ierr); 424e5c89e4eSSatish Balay #endif 425e5c89e4eSSatish Balay 426e5c89e4eSSatish Balay while (m) { 427e5c89e4eSSatish Balay wsize = (m < maxblock) ? m : maxblock; 428e5c89e4eSSatish Balay err = write(fd,pp,wsize); 429e5c89e4eSSatish Balay if (err < 0 && errno == EINTR) continue; 43004102261SBarry Smith if (err != wsize) SETERRQ3(PETSC_COMM_SELF,PETSC_ERR_FILE_WRITE,"Error writing to file total size %d err %d wsize %d",(int)n,(int)err,(int)wsize); 431e5c89e4eSSatish Balay m -= wsize; 432e5c89e4eSSatish Balay pp += wsize; 433e5c89e4eSSatish Balay } 434e5c89e4eSSatish Balay 435b659c0ceSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN) 436e5c89e4eSSatish Balay if (!istemp) { 43741f502e3SPatrick Sanan ierr = PetscByteSwap(ptmp,wtype,n);CHKERRQ(ierr); 438e5c89e4eSSatish Balay } 439e5c89e4eSSatish Balay #endif 44005acbc63SBarry Smith if (type == PETSC_FUNCTION) { 44105acbc63SBarry Smith free(fname); 44205acbc63SBarry Smith } 4430da86b62SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128) 4444caf0332SSatish Balay if ((type == PETSC_SCALAR || type == PETSC_REAL) && writedouble) { 4450da86b62SBarry Smith ierr = PetscFree(ppp);CHKERRQ(ierr); 4460da86b62SBarry Smith } 4470da86b62SBarry Smith #endif 448e5c89e4eSSatish Balay PetscFunctionReturn(0); 449e5c89e4eSSatish Balay } 450e5c89e4eSSatish Balay 451e5c89e4eSSatish Balay /*@C 452e5c89e4eSSatish Balay PetscBinaryOpen - Opens a PETSc binary file. 453e5c89e4eSSatish Balay 454e5c89e4eSSatish Balay Not Collective 455e5c89e4eSSatish Balay 456e5c89e4eSSatish Balay Input Parameters: 457e5c89e4eSSatish Balay + name - filename 45845c64e65SBarry Smith - type - type of binary file, one of FILE_MODE_READ, FILE_MODE_APPEND, FILE_MODE_WRITE 459e5c89e4eSSatish Balay 460e5c89e4eSSatish Balay Output Parameter: 461e5c89e4eSSatish Balay . fd - the file 462e5c89e4eSSatish Balay 463e5c89e4eSSatish Balay Level: advanced 464e5c89e4eSSatish Balay 465e5c89e4eSSatish Balay Concepts: files^opening binary 466e5c89e4eSSatish Balay Concepts: binary files^opening 467e5c89e4eSSatish Balay 468e5c89e4eSSatish Balay Notes: Files access with PetscBinaryRead() and PetscBinaryWrite() are ALWAYS written in 469e5c89e4eSSatish Balay big-endian format. This means the file can be accessed using PetscBinaryOpen() and 470e5c89e4eSSatish Balay PetscBinaryRead() and PetscBinaryWrite() on any machine. 471e5c89e4eSSatish Balay 4724ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscFileMode, PetscViewerFileSetMode(), PetscViewerBinaryGetDescriptor(), 4734ebed01fSBarry Smith PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(), PetscBinarySynchronizedSeek() 47445c64e65SBarry Smith 475e5c89e4eSSatish Balay @*/ 4767087cfbeSBarry Smith PetscErrorCode PetscBinaryOpen(const char name[],PetscFileMode mode,int *fd) 477e5c89e4eSSatish Balay { 478e5c89e4eSSatish Balay PetscFunctionBegin; 479e5c89e4eSSatish Balay #if defined(PETSC_HAVE_O_BINARY) 48045c64e65SBarry Smith if (mode == FILE_MODE_WRITE) { 481a297a907SKarl Rupp if ((*fd = open(name,O_WRONLY|O_CREAT|O_TRUNC|O_BINARY,0666)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot create file for writing: %s",name); 48245c64e65SBarry Smith } else if (mode == FILE_MODE_READ) { 483a297a907SKarl Rupp if ((*fd = open(name,O_RDONLY|O_BINARY,0)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file for reading: %s",name); 48445c64e65SBarry Smith } else if (mode == FILE_MODE_APPEND) { 485a297a907SKarl Rupp if ((*fd = open(name,O_WRONLY|O_BINARY,0)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file for writing: %s",name); 486e5c89e4eSSatish Balay #else 48745c64e65SBarry Smith if (mode == FILE_MODE_WRITE) { 488a297a907SKarl Rupp if ((*fd = creat(name,0666)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot create file for writing: %s",name); 48945c64e65SBarry Smith } else if (mode == FILE_MODE_READ) { 490a297a907SKarl Rupp if ((*fd = open(name,O_RDONLY,0)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file for reading: %s",name); 491e5c89e4eSSatish Balay } 49245c64e65SBarry Smith else if (mode == FILE_MODE_APPEND) { 493a297a907SKarl Rupp if ((*fd = open(name,O_WRONLY,0)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file for writing: %s",name); 494e5c89e4eSSatish Balay #endif 495e32f2f54SBarry Smith } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown file mode"); 496e5c89e4eSSatish Balay PetscFunctionReturn(0); 497e5c89e4eSSatish Balay } 498e5c89e4eSSatish Balay 499e30d2299SSatish Balay /*@ 500e5c89e4eSSatish Balay PetscBinaryClose - Closes a PETSc binary file. 501e5c89e4eSSatish Balay 502e5c89e4eSSatish Balay Not Collective 503e5c89e4eSSatish Balay 504e5c89e4eSSatish Balay Output Parameter: 505e5c89e4eSSatish Balay . fd - the file 506e5c89e4eSSatish Balay 507e5c89e4eSSatish Balay Level: advanced 508e5c89e4eSSatish Balay 5094ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen(), PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(), 5104ebed01fSBarry Smith PetscBinarySynchronizedSeek() 511e5c89e4eSSatish Balay @*/ 5127087cfbeSBarry Smith PetscErrorCode PetscBinaryClose(int fd) 513e5c89e4eSSatish Balay { 514e5c89e4eSSatish Balay PetscFunctionBegin; 515e5c89e4eSSatish Balay close(fd); 516e5c89e4eSSatish Balay PetscFunctionReturn(0); 517e5c89e4eSSatish Balay } 518e5c89e4eSSatish Balay 519e5c89e4eSSatish Balay 520e8976759SBarry Smith /*@C 521e5c89e4eSSatish Balay PetscBinarySeek - Moves the file pointer on a PETSc binary file. 522e5c89e4eSSatish Balay 523e5c89e4eSSatish Balay Not Collective 524e5c89e4eSSatish Balay 525e5c89e4eSSatish Balay Input Parameters: 526e5c89e4eSSatish Balay + fd - the file 527ff553b35SMatthew Knepley . off - number of bytes to move. Use PETSC_BINARY_INT_SIZE, PETSC_BINARY_SCALAR_SIZE, 528e5c89e4eSSatish Balay etc. in your calculation rather than sizeof() to compute byte lengths. 529ff553b35SMatthew Knepley - whence - if PETSC_BINARY_SEEK_SET then off is an absolute location in the file 530ff553b35SMatthew Knepley if PETSC_BINARY_SEEK_CUR then off is an offset from the current location 531ff553b35SMatthew Knepley if PETSC_BINARY_SEEK_END then off is an offset from the end of file 532e5c89e4eSSatish Balay 533e5c89e4eSSatish Balay Output Parameter: 534e5c89e4eSSatish Balay . offset - new offset in file 535e5c89e4eSSatish Balay 536e5c89e4eSSatish Balay Level: developer 537e5c89e4eSSatish Balay 538e5c89e4eSSatish Balay Notes: 539e5c89e4eSSatish Balay Integers are stored on the file as 32 long, regardless of whether 540e5c89e4eSSatish Balay they are stored in the machine as 32 or 64, this means the same 541e5c89e4eSSatish Balay binary file may be read on any machine. Hence you CANNOT use sizeof() 542e5c89e4eSSatish Balay to determine the offset or location. 543e5c89e4eSSatish Balay 544e5c89e4eSSatish Balay Concepts: files^binary seeking 545e5c89e4eSSatish Balay Concepts: binary files^seeking 546e5c89e4eSSatish Balay 5474ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen(), PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(), 5484ebed01fSBarry Smith PetscBinarySynchronizedSeek() 549e5c89e4eSSatish Balay @*/ 5507087cfbeSBarry Smith PetscErrorCode PetscBinarySeek(int fd,off_t off,PetscBinarySeekType whence,off_t *offset) 551e5c89e4eSSatish Balay { 552e5c89e4eSSatish Balay int iwhence = 0; 553e5c89e4eSSatish Balay 554e5c89e4eSSatish Balay PetscFunctionBegin; 555a297a907SKarl Rupp if (whence == PETSC_BINARY_SEEK_SET) iwhence = SEEK_SET; 556a297a907SKarl Rupp else if (whence == PETSC_BINARY_SEEK_CUR) iwhence = SEEK_CUR; 557a297a907SKarl Rupp else if (whence == PETSC_BINARY_SEEK_END) iwhence = SEEK_END; 558a297a907SKarl Rupp else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown seek location"); 559e5c89e4eSSatish Balay #if defined(PETSC_HAVE_LSEEK) 560e5c89e4eSSatish Balay *offset = lseek(fd,off,iwhence); 561e5c89e4eSSatish Balay #elif defined(PETSC_HAVE__LSEEK) 562e5c89e4eSSatish Balay *offset = _lseek(fd,(long)off,iwhence); 563e5c89e4eSSatish Balay #else 564e32f2f54SBarry Smith SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP_SYS,"System does not have a way of seeking on a file"); 565e5c89e4eSSatish Balay #endif 566e5c89e4eSSatish Balay PetscFunctionReturn(0); 567e5c89e4eSSatish Balay } 568e5c89e4eSSatish Balay 569e5c89e4eSSatish Balay /*@C 5701d280d73SBarry Smith PetscBinarySynchronizedRead - Reads from a binary file. 571e5c89e4eSSatish Balay 572e5c89e4eSSatish Balay Collective on MPI_Comm 573e5c89e4eSSatish Balay 574e5c89e4eSSatish Balay Input Parameters: 575e5c89e4eSSatish Balay + comm - the MPI communicator 576e5c89e4eSSatish Balay . fd - the file 577e5c89e4eSSatish Balay . n - the number of items to read 578e5c89e4eSSatish Balay - type - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR) 579e5c89e4eSSatish Balay 580e5c89e4eSSatish Balay Output Parameters: 581e5c89e4eSSatish Balay . p - the buffer 582e5c89e4eSSatish Balay 583e5c89e4eSSatish Balay Level: developer 584e5c89e4eSSatish Balay 585e5c89e4eSSatish Balay Notes: 586e5c89e4eSSatish Balay Does a PetscBinaryRead() followed by an MPI_Bcast() 587e5c89e4eSSatish Balay 5881d280d73SBarry Smith PetscBinarySynchronizedRead() uses byte swapping to work on all machines. 589e5c89e4eSSatish Balay Integers are stored on the file as 32 long, regardless of whether 590e5c89e4eSSatish Balay they are stored in the machine as 32 or 64, this means the same 591e5c89e4eSSatish Balay binary file may be read on any machine. 592e5c89e4eSSatish Balay 593e5c89e4eSSatish Balay Concepts: files^synchronized reading of binary files 594e5c89e4eSSatish Balay Concepts: binary files^reading, synchronized 595e5c89e4eSSatish Balay 5964ebed01fSBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscBinaryRead(), PetscBinarySynchronizedWrite(), 5974ebed01fSBarry Smith PetscBinarySynchronizedSeek() 598e5c89e4eSSatish Balay @*/ 5997087cfbeSBarry Smith PetscErrorCode PetscBinarySynchronizedRead(MPI_Comm comm,int fd,void *p,PetscInt n,PetscDataType type) 600e5c89e4eSSatish Balay { 601*0090e2cfSJakub Kruzik PetscErrorCode ierr,ierrp; 602e5c89e4eSSatish Balay PetscMPIInt rank; 603e5c89e4eSSatish Balay MPI_Datatype mtype; 60405acbc63SBarry Smith char *fname = NULL; 6050298fd71SBarry Smith void *ptmp = NULL; 606e5c89e4eSSatish Balay 607e5c89e4eSSatish Balay PetscFunctionBegin; 6082d53ad75SBarry Smith if (type == PETSC_FUNCTION) { 6092d53ad75SBarry Smith n = 64; 6102d53ad75SBarry Smith type = PETSC_CHAR; 6112d53ad75SBarry Smith ptmp = p; 612e366c363SBarry Smith fname = (char*)malloc(n*sizeof(char)); 61305acbc63SBarry Smith if (!fname) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_MEM,"Cannot allocate space for function name"); 6142d53ad75SBarry Smith p = (void*)fname; 6152d53ad75SBarry Smith } 6162d53ad75SBarry Smith 617e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 618e5c89e4eSSatish Balay if (!rank) { 619*0090e2cfSJakub Kruzik ierrp = PetscBinaryRead(fd,p,n,type); 620e5c89e4eSSatish Balay } 621*0090e2cfSJakub Kruzik ierr = MPI_Bcast(&ierrp,1,MPIU_INT,0,comm);CHKERRQ(ierr); 622*0090e2cfSJakub Kruzik CHKERRQ(ierrp); 623e5c89e4eSSatish Balay ierr = PetscDataTypeToMPIDataType(type,&mtype);CHKERRQ(ierr); 624e5c89e4eSSatish Balay ierr = MPI_Bcast(p,n,mtype,0,comm);CHKERRQ(ierr); 6252d53ad75SBarry Smith 626e366c363SBarry Smith if (type == PETSC_FUNCTION) { 6272d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS) 6280298fd71SBarry Smith ierr = PetscDLLibrarySym(PETSC_COMM_SELF,&PetscDLLibrariesLoaded,NULL,fname,(void**)ptmp);CHKERRQ(ierr); 6292d53ad75SBarry Smith #else 6300298fd71SBarry Smith *(void**)ptmp = NULL; 6312d53ad75SBarry Smith #endif 632e366c363SBarry Smith free(fname); 6332d53ad75SBarry Smith } 634e5c89e4eSSatish Balay PetscFunctionReturn(0); 635e5c89e4eSSatish Balay } 636e5c89e4eSSatish Balay 637e5c89e4eSSatish Balay /*@C 6381d280d73SBarry Smith PetscBinarySynchronizedWrite - writes to a binary file. 639e5c89e4eSSatish Balay 640e5c89e4eSSatish Balay Collective on MPI_Comm 641e5c89e4eSSatish Balay 642e5c89e4eSSatish Balay Input Parameters: 643e5c89e4eSSatish Balay + comm - the MPI communicator 644e5c89e4eSSatish Balay . fd - the file 645e5c89e4eSSatish Balay . n - the number of items to write 646e5c89e4eSSatish Balay . p - the buffer 647e5c89e4eSSatish Balay . istemp - the buffer may be changed 648e5c89e4eSSatish Balay - type - the type of items to write (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR) 649e5c89e4eSSatish Balay 650e5c89e4eSSatish Balay Level: developer 651e5c89e4eSSatish Balay 652e5c89e4eSSatish Balay Notes: 653e5c89e4eSSatish Balay Process 0 does a PetscBinaryWrite() 654e5c89e4eSSatish Balay 6551d280d73SBarry Smith PetscBinarySynchronizedWrite() uses byte swapping to work on all machines. 656e5c89e4eSSatish Balay Integers are stored on the file as 32 long, regardless of whether 657e5c89e4eSSatish Balay they are stored in the machine as 32 or 64, this means the same 658e5c89e4eSSatish Balay binary file may be read on any machine. 659e5c89e4eSSatish Balay 660300a7f5bSBarry Smith Notes: because byte-swapping may be done on the values in data it cannot be declared const 661300a7f5bSBarry Smith 6621d280d73SBarry Smith WARNING: This is NOT like PetscSynchronizedFPrintf()! This routine ignores calls on all but process 0, 6631d280d73SBarry Smith while PetscSynchronizedFPrintf() has all processes print their strings in order. 6641d280d73SBarry Smith 665e5c89e4eSSatish Balay Concepts: files^synchronized writing of binary files 666e5c89e4eSSatish Balay Concepts: binary files^reading, synchronized 667e5c89e4eSSatish Balay 6684ebed01fSBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscBinaryRead(), PetscBinarySynchronizedRead(), 6694ebed01fSBarry Smith PetscBinarySynchronizedSeek() 670e5c89e4eSSatish Balay @*/ 6717087cfbeSBarry Smith PetscErrorCode PetscBinarySynchronizedWrite(MPI_Comm comm,int fd,void *p,PetscInt n,PetscDataType type,PetscBool istemp) 672e5c89e4eSSatish Balay { 673e5c89e4eSSatish Balay PetscErrorCode ierr; 674e5c89e4eSSatish Balay PetscMPIInt rank; 675e5c89e4eSSatish Balay 676e5c89e4eSSatish Balay PetscFunctionBegin; 677e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 678e5c89e4eSSatish Balay if (!rank) { 679e5c89e4eSSatish Balay ierr = PetscBinaryWrite(fd,p,n,type,istemp);CHKERRQ(ierr); 680e5c89e4eSSatish Balay } 681e5c89e4eSSatish Balay PetscFunctionReturn(0); 682e5c89e4eSSatish Balay } 683e5c89e4eSSatish Balay 684e5c89e4eSSatish Balay /*@C 6851d280d73SBarry Smith PetscBinarySynchronizedSeek - Moves the file pointer on a PETSc binary file. 686e5c89e4eSSatish Balay 687e5c89e4eSSatish Balay 688e5c89e4eSSatish Balay Input Parameters: 689e5c89e4eSSatish Balay + fd - the file 690e5c89e4eSSatish Balay . whence - if PETSC_BINARY_SEEK_SET then size is an absolute location in the file 691e5c89e4eSSatish Balay if PETSC_BINARY_SEEK_CUR then size is offset from current location 692e5c89e4eSSatish Balay if PETSC_BINARY_SEEK_END then size is offset from end of file 693e5c89e4eSSatish Balay - off - number of bytes to move. Use PETSC_BINARY_INT_SIZE, PETSC_BINARY_SCALAR_SIZE, 694e5c89e4eSSatish Balay etc. in your calculation rather than sizeof() to compute byte lengths. 695e5c89e4eSSatish Balay 696e5c89e4eSSatish Balay Output Parameter: 697e5c89e4eSSatish Balay . offset - new offset in file 698e5c89e4eSSatish Balay 699e5c89e4eSSatish Balay Level: developer 700e5c89e4eSSatish Balay 701e5c89e4eSSatish Balay Notes: 702e5c89e4eSSatish Balay Integers are stored on the file as 32 long, regardless of whether 703e5c89e4eSSatish Balay they are stored in the machine as 32 or 64, this means the same 704e5c89e4eSSatish Balay binary file may be read on any machine. Hence you CANNOT use sizeof() 705e5c89e4eSSatish Balay to determine the offset or location. 706e5c89e4eSSatish Balay 707e5c89e4eSSatish Balay Concepts: binary files^seeking 708e5c89e4eSSatish Balay Concepts: files^seeking in binary 709e5c89e4eSSatish Balay 7104ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen(), PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(), 7114ebed01fSBarry Smith PetscBinarySynchronizedSeek() 712e5c89e4eSSatish Balay @*/ 7137087cfbeSBarry Smith PetscErrorCode PetscBinarySynchronizedSeek(MPI_Comm comm,int fd,off_t off,PetscBinarySeekType whence,off_t *offset) 714e5c89e4eSSatish Balay { 715e5c89e4eSSatish Balay PetscErrorCode ierr; 716e5c89e4eSSatish Balay PetscMPIInt rank; 717e5c89e4eSSatish Balay 718e5c89e4eSSatish Balay PetscFunctionBegin; 719e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 720e5c89e4eSSatish Balay if (!rank) { 721e5c89e4eSSatish Balay ierr = PetscBinarySeek(fd,off,whence,offset);CHKERRQ(ierr); 722e5c89e4eSSatish Balay } 723e5c89e4eSSatish Balay PetscFunctionReturn(0); 724e5c89e4eSSatish Balay } 725e5c89e4eSSatish Balay 7260fc9d207SBarry Smith #if defined(PETSC_HAVE_MPIIO) 727e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) 728e39fd77fSBarry Smith 729951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32) 730e39fd77fSBarry Smith /* 731e39fd77fSBarry Smith MPICH does not provide the external32 representation for MPI_File_set_view() so we need to provide the functions. 732e39fd77fSBarry Smith These are set into MPI in PetscInitialize() via MPI_Register_datarep() 733e39fd77fSBarry Smith 734e39fd77fSBarry Smith Note I use PetscMPIInt for the MPI error codes since that is what MPI uses (instead of the standard PetscErrorCode) 735e39fd77fSBarry Smith 736951e3c8eSBarry Smith The next three routines are not used because MPICH does not support their use 737e39fd77fSBarry Smith 738e39fd77fSBarry Smith */ 7398cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype datatype,MPI_Aint *file_extent,void *extra_state) 740e39fd77fSBarry Smith { 741e39fd77fSBarry Smith MPI_Aint ub; 742e39fd77fSBarry Smith PetscMPIInt ierr; 743e39fd77fSBarry Smith 744e39fd77fSBarry Smith ierr = MPI_Type_get_extent(datatype,&ub,file_extent); 745e39fd77fSBarry Smith return ierr; 746e39fd77fSBarry Smith } 747e39fd77fSBarry Smith 7488cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void *userbuf, MPI_Datatype datatype,PetscMPIInt count,void *filebuf, MPI_Offset position,void *extra_state) 749e39fd77fSBarry Smith { 750e39fd77fSBarry Smith PetscDataType pdtype; 751e39fd77fSBarry Smith PetscMPIInt ierr; 752e39fd77fSBarry Smith size_t dsize; 753e39fd77fSBarry Smith 754e39fd77fSBarry Smith ierr = PetscMPIDataTypeToPetscDataType(datatype,&pdtype);CHKERRQ(ierr); 755e39fd77fSBarry Smith ierr = PetscDataTypeGetSize(pdtype,&dsize);CHKERRQ(ierr); 756e39fd77fSBarry Smith 757e39fd77fSBarry Smith /* offset is given in units of MPI_Datatype */ 758e39fd77fSBarry Smith userbuf = ((char*)userbuf) + dsize*position; 759e39fd77fSBarry Smith 760e39fd77fSBarry Smith ierr = PetscMemcpy(userbuf,filebuf,count*dsize);CHKERRQ(ierr); 761e39fd77fSBarry Smith ierr = PetscByteSwap(userbuf,pdtype,count);CHKERRQ(ierr); 762e39fd77fSBarry Smith return ierr; 763e39fd77fSBarry Smith } 764e39fd77fSBarry Smith 765e39fd77fSBarry Smith PetscMPIInt PetscDataRep_write_conv_fn(void *userbuf, MPI_Datatype datatype,PetscMPIInt count,void *filebuf, MPI_Offset position,void *extra_state) 766e39fd77fSBarry Smith { 767e39fd77fSBarry Smith PetscDataType pdtype; 768e39fd77fSBarry Smith PetscMPIInt ierr; 769e39fd77fSBarry Smith size_t dsize; 770e39fd77fSBarry Smith 771e39fd77fSBarry Smith ierr = PetscMPIDataTypeToPetscDataType(datatype,&pdtype);CHKERRQ(ierr); 772e39fd77fSBarry Smith ierr = PetscDataTypeGetSize(pdtype,&dsize);CHKERRQ(ierr); 773e39fd77fSBarry Smith 774e39fd77fSBarry Smith /* offset is given in units of MPI_Datatype */ 775e39fd77fSBarry Smith userbuf = ((char*)userbuf) + dsize*position; 776e39fd77fSBarry Smith 777e39fd77fSBarry Smith ierr = PetscMemcpy(filebuf,userbuf,count*dsize);CHKERRQ(ierr); 778e39fd77fSBarry Smith ierr = PetscByteSwap(filebuf,pdtype,count);CHKERRQ(ierr); 779e39fd77fSBarry Smith return ierr; 780e39fd77fSBarry Smith } 781951e3c8eSBarry Smith #endif 782e39fd77fSBarry Smith 783e39fd77fSBarry Smith PetscErrorCode MPIU_File_write_all(MPI_File fd,void *data,PetscMPIInt cnt,MPI_Datatype dtype,MPI_Status *status) 784e39fd77fSBarry Smith { 785e39fd77fSBarry Smith PetscErrorCode ierr; 786e39fd77fSBarry Smith PetscDataType pdtype; 787e39fd77fSBarry Smith 788e39fd77fSBarry Smith PetscFunctionBegin; 789e39fd77fSBarry Smith ierr = PetscMPIDataTypeToPetscDataType(dtype,&pdtype);CHKERRQ(ierr); 790e39fd77fSBarry Smith ierr = PetscByteSwap(data,pdtype,cnt);CHKERRQ(ierr); 791e39fd77fSBarry Smith ierr = MPI_File_write_all(fd,data,cnt,dtype,status);CHKERRQ(ierr); 792e39fd77fSBarry Smith ierr = PetscByteSwap(data,pdtype,cnt);CHKERRQ(ierr); 793a6796414SBarry Smith PetscFunctionReturn(0); 794e39fd77fSBarry Smith } 795e39fd77fSBarry Smith 796e39fd77fSBarry Smith PetscErrorCode MPIU_File_read_all(MPI_File fd,void *data,PetscMPIInt cnt,MPI_Datatype dtype,MPI_Status *status) 797e39fd77fSBarry Smith { 798e39fd77fSBarry Smith PetscErrorCode ierr; 799e39fd77fSBarry Smith PetscDataType pdtype; 800e39fd77fSBarry Smith 801e39fd77fSBarry Smith PetscFunctionBegin; 802e39fd77fSBarry Smith ierr = PetscMPIDataTypeToPetscDataType(dtype,&pdtype);CHKERRQ(ierr); 803e39fd77fSBarry Smith ierr = MPI_File_read_all(fd,data,cnt,dtype,status);CHKERRQ(ierr); 804e39fd77fSBarry Smith ierr = PetscByteSwap(data,pdtype,cnt);CHKERRQ(ierr); 805a6796414SBarry Smith PetscFunctionReturn(0); 806e39fd77fSBarry Smith } 807e39fd77fSBarry Smith #endif 808951e3c8eSBarry Smith #endif 809