1e5c89e4eSSatish Balay #define PETSC_DLL 2e5c89e4eSSatish Balay 3e5c89e4eSSatish Balay /* 4e5c89e4eSSatish Balay This file contains simple binary read/write routines. 5e5c89e4eSSatish Balay */ 6e5c89e4eSSatish Balay 7e30d2299SSatish Balay #include "petsc.h" 8e30d2299SSatish Balay #include "petscsys.h" /*I "petscsys.h" I*/ 9e5c89e4eSSatish Balay 10e5c89e4eSSatish Balay #include <errno.h> 11e5c89e4eSSatish Balay #include <fcntl.h> 12e5c89e4eSSatish Balay #if defined(PETSC_HAVE_UNISTD_H) 13e5c89e4eSSatish Balay #include <unistd.h> 14e5c89e4eSSatish Balay #endif 15e5c89e4eSSatish Balay #if defined (PETSC_HAVE_IO_H) 16e5c89e4eSSatish Balay #include <io.h> 17e5c89e4eSSatish Balay #endif 18e5c89e4eSSatish Balay #include "petscbt.h" 19e5c89e4eSSatish Balay 20e5c89e4eSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN) 21e5c89e4eSSatish Balay 226de02169SBarry Smith /* --------------------------------------------------------- */ 23e5c89e4eSSatish Balay #undef __FUNCT__ 246de02169SBarry Smith #define __FUNCT__ "PetscByteSwapEnum" 25e5c89e4eSSatish Balay /* 266de02169SBarry Smith PetscByteSwapEnum - Swap bytes in a PETSc Enum 27e5c89e4eSSatish Balay 28e5c89e4eSSatish Balay */ 296de02169SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscByteSwapEnum(PetscEnum *buff,PetscInt n) 30e5c89e4eSSatish Balay { 316de02169SBarry Smith PetscInt i,j; 320b20345dSBarry Smith PetscEnum tmp = ENUM_DUMMY; 336de02169SBarry Smith PetscEnum *tptr = &tmp; /* Need to access tmp indirectly to get */ 34e5c89e4eSSatish Balay char *ptr1,*ptr2 = (char*)&tmp; /* arround the bug in DEC-ALPHA g++ */ 35e5c89e4eSSatish Balay 36e5c89e4eSSatish Balay PetscFunctionBegin; 37e5c89e4eSSatish Balay for (j=0; j<n; j++) { 38e5c89e4eSSatish Balay ptr1 = (char*)(buff + j); 390b20345dSBarry Smith for (i=0; i<(PetscInt)sizeof(PetscEnum); i++) { 406de02169SBarry Smith ptr2[i] = ptr1[sizeof(PetscEnum)-1-i]; 41e5c89e4eSSatish Balay } 42e5c89e4eSSatish Balay buff[j] = *tptr; 43e5c89e4eSSatish Balay } 44e5c89e4eSSatish Balay PetscFunctionReturn(0); 45e5c89e4eSSatish Balay } 466de02169SBarry Smith 476de02169SBarry Smith #undef __FUNCT__ 486de02169SBarry Smith #define __FUNCT__ "PetscByteSwapTruth" 496de02169SBarry Smith /* 506de02169SBarry Smith PetscByteSwapTruth - Swap bytes in a PETSc Truth 516de02169SBarry Smith 526de02169SBarry Smith */ 536de02169SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscByteSwapTruth(PetscTruth *buff,PetscInt n) 546de02169SBarry Smith { 556de02169SBarry Smith PetscInt i,j; 560b20345dSBarry Smith PetscTruth tmp = PETSC_FALSE; 576de02169SBarry Smith PetscTruth *tptr = &tmp; /* Need to access tmp indirectly to get */ 586de02169SBarry Smith char *ptr1,*ptr2 = (char*)&tmp; /* arround the bug in DEC-ALPHA g++ */ 596de02169SBarry Smith 606de02169SBarry Smith PetscFunctionBegin; 616de02169SBarry Smith for (j=0; j<n; j++) { 626de02169SBarry Smith ptr1 = (char*)(buff + j); 630b20345dSBarry Smith for (i=0; i<(PetscInt)sizeof(PetscTruth); i++) { 646de02169SBarry Smith ptr2[i] = ptr1[sizeof(PetscTruth)-1-i]; 656de02169SBarry Smith } 666de02169SBarry Smith buff[j] = *tptr; 676de02169SBarry Smith } 686de02169SBarry Smith PetscFunctionReturn(0); 696de02169SBarry Smith } 706de02169SBarry Smith 71e5c89e4eSSatish Balay #undef __FUNCT__ 72bd1d2e58SBarry Smith #define __FUNCT__ "PetscByteSwapInt" 73bd1d2e58SBarry Smith /* 746de02169SBarry Smith PetscByteSwapInt - Swap bytes in a PETSc integer (which may be 32 or 64 bits) 75bd1d2e58SBarry Smith 76bd1d2e58SBarry Smith */ 776de02169SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscByteSwapInt(PetscInt *buff,PetscInt n) 78bd1d2e58SBarry Smith { 79bd1d2e58SBarry Smith PetscInt i,j,tmp = 0; 80bd1d2e58SBarry Smith PetscInt *tptr = &tmp; /* Need to access tmp indirectly to get */ 81bd1d2e58SBarry Smith char *ptr1,*ptr2 = (char*)&tmp; /* arround the bug in DEC-ALPHA g++ */ 82bd1d2e58SBarry Smith 83bd1d2e58SBarry Smith PetscFunctionBegin; 84bd1d2e58SBarry Smith for (j=0; j<n; j++) { 85bd1d2e58SBarry Smith ptr1 = (char*)(buff + j); 860b20345dSBarry Smith for (i=0; i<(PetscInt)sizeof(PetscInt); i++) { 87bd1d2e58SBarry Smith ptr2[i] = ptr1[sizeof(PetscInt)-1-i]; 88bd1d2e58SBarry Smith } 89bd1d2e58SBarry Smith buff[j] = *tptr; 90bd1d2e58SBarry Smith } 91bd1d2e58SBarry Smith PetscFunctionReturn(0); 92bd1d2e58SBarry Smith } 93bd1d2e58SBarry Smith /* --------------------------------------------------------- */ 94bd1d2e58SBarry Smith #undef __FUNCT__ 95e5c89e4eSSatish Balay #define __FUNCT__ "PetscByteSwapShort" 96e5c89e4eSSatish Balay /* 97e5c89e4eSSatish Balay PetscByteSwapShort - Swap bytes in a short 98e5c89e4eSSatish Balay */ 99e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscByteSwapShort(short *buff,PetscInt n) 100e5c89e4eSSatish Balay { 101e5c89e4eSSatish Balay PetscInt i,j; 102e5c89e4eSSatish Balay short tmp; 103e5c89e4eSSatish Balay short *tptr = &tmp; /* take care pf bug in DEC-ALPHA g++ */ 104e5c89e4eSSatish Balay char *ptr1,*ptr2 = (char*)&tmp; 105e5c89e4eSSatish Balay 106e5c89e4eSSatish Balay PetscFunctionBegin; 107e5c89e4eSSatish Balay for (j=0; j<n; j++) { 108e5c89e4eSSatish Balay ptr1 = (char*)(buff + j); 1090b20345dSBarry Smith for (i=0; i<(PetscInt) sizeof(short); i++) { 110e5c89e4eSSatish Balay ptr2[i] = ptr1[sizeof(int)-1-i]; 111e5c89e4eSSatish Balay } 112e5c89e4eSSatish Balay buff[j] = *tptr; 113e5c89e4eSSatish Balay } 114e5c89e4eSSatish Balay PetscFunctionReturn(0); 115e5c89e4eSSatish Balay } 116e5c89e4eSSatish Balay /* --------------------------------------------------------- */ 117e5c89e4eSSatish Balay #undef __FUNCT__ 118e5c89e4eSSatish Balay #define __FUNCT__ "PetscByteSwapScalar" 119e5c89e4eSSatish Balay /* 120e5c89e4eSSatish Balay PetscByteSwapScalar - Swap bytes in a double 121e5c89e4eSSatish Balay Complex is dealt with as if array of double twice as long. 122e5c89e4eSSatish Balay */ 123e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscByteSwapScalar(PetscScalar *buff,PetscInt n) 124e5c89e4eSSatish Balay { 125e5c89e4eSSatish Balay PetscInt i,j; 126e5c89e4eSSatish Balay PetscReal tmp,*buff1 = (PetscReal*)buff; 127e5c89e4eSSatish Balay PetscReal *tptr = &tmp; /* take care pf bug in DEC-ALPHA g++ */ 128e5c89e4eSSatish Balay char *ptr1,*ptr2 = (char*)&tmp; 129e5c89e4eSSatish Balay 130e5c89e4eSSatish Balay PetscFunctionBegin; 131e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX) 132e5c89e4eSSatish Balay n *= 2; 133e5c89e4eSSatish Balay #endif 134e5c89e4eSSatish Balay for (j=0; j<n; j++) { 135e5c89e4eSSatish Balay ptr1 = (char*)(buff1 + j); 1360b20345dSBarry Smith for (i=0; i<(PetscInt) sizeof(PetscReal); i++) { 137e5c89e4eSSatish Balay ptr2[i] = ptr1[sizeof(PetscReal)-1-i]; 138e5c89e4eSSatish Balay } 139e5c89e4eSSatish Balay buff1[j] = *tptr; 140e5c89e4eSSatish Balay } 141e5c89e4eSSatish Balay PetscFunctionReturn(0); 142e5c89e4eSSatish Balay } 143e5c89e4eSSatish Balay /* --------------------------------------------------------- */ 144e5c89e4eSSatish Balay #undef __FUNCT__ 145e5c89e4eSSatish Balay #define __FUNCT__ "PetscByteSwapDouble" 146e5c89e4eSSatish Balay /* 147e5c89e4eSSatish Balay PetscByteSwapDouble - Swap bytes in a double 148e5c89e4eSSatish Balay */ 149e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscByteSwapDouble(double *buff,PetscInt n) 150e5c89e4eSSatish Balay { 151e5c89e4eSSatish Balay PetscInt i,j; 152e5c89e4eSSatish Balay double tmp,*buff1 = (double*)buff; 153e5c89e4eSSatish Balay double *tptr = &tmp; /* take care pf bug in DEC-ALPHA g++ */ 154e5c89e4eSSatish Balay char *ptr1,*ptr2 = (char*)&tmp; 155e5c89e4eSSatish Balay 156e5c89e4eSSatish Balay PetscFunctionBegin; 157e5c89e4eSSatish Balay for (j=0; j<n; j++) { 158e5c89e4eSSatish Balay ptr1 = (char*)(buff1 + j); 1590b20345dSBarry Smith for (i=0; i<(PetscInt) sizeof(double); i++) { 160e5c89e4eSSatish Balay ptr2[i] = ptr1[sizeof(double)-1-i]; 161e5c89e4eSSatish Balay } 162e5c89e4eSSatish Balay buff1[j] = *tptr; 163e5c89e4eSSatish Balay } 164e5c89e4eSSatish Balay PetscFunctionReturn(0); 165e5c89e4eSSatish Balay } 166e5c89e4eSSatish Balay #endif 167e5c89e4eSSatish Balay /* --------------------------------------------------------- */ 168e5c89e4eSSatish Balay #undef __FUNCT__ 169e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryRead" 170e30d2299SSatish Balay /*@ 171e5c89e4eSSatish Balay PetscBinaryRead - Reads from a binary file. 172e5c89e4eSSatish Balay 173e5c89e4eSSatish Balay Not Collective 174e5c89e4eSSatish Balay 175e5c89e4eSSatish Balay Input Parameters: 176e5c89e4eSSatish Balay + fd - the file 177e5c89e4eSSatish Balay . n - the number of items to read 178e5c89e4eSSatish Balay - type - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR) 179e5c89e4eSSatish Balay 180e5c89e4eSSatish Balay Output Parameters: 181e5c89e4eSSatish Balay . p - the buffer 182e5c89e4eSSatish Balay 183e5c89e4eSSatish Balay 184e5c89e4eSSatish Balay 185e5c89e4eSSatish Balay Level: developer 186e5c89e4eSSatish Balay 187e5c89e4eSSatish Balay Notes: 188e5c89e4eSSatish Balay PetscBinaryRead() uses byte swapping to work on all machines; the files 189e5c89e4eSSatish Balay are written to file ALWAYS using big-endian ordering. On small-endian machines the numbers 190e5c89e4eSSatish Balay are converted to the small-endian format when they are read in from the file. 191*54f21887SBarry Smith When PETSc is config/configure.py with --with-64bit-indices the integers are written to the 192*54f21887SBarry Smith file as 64 bit integers, this means they can only be read back in when the option --with-64bit-indices 193*54f21887SBarry Smith is used. 194e5c89e4eSSatish Balay 195e5c89e4eSSatish Balay Concepts: files^reading binary 196e5c89e4eSSatish Balay Concepts: binary files^reading 197e5c89e4eSSatish Balay 1984ebed01fSBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscViewerBinaryGetDescriptor(), PetscBinarySynchronizedWrite(), 1994ebed01fSBarry Smith PetscBinarySynchronizedRead(), PetscBinarySynchronizedSeek() 200e5c89e4eSSatish Balay @*/ 201e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscBinaryRead(int fd,void *p,PetscInt n,PetscDataType type) 202e5c89e4eSSatish Balay { 203e5c89e4eSSatish Balay int wsize,err; 204e5c89e4eSSatish Balay size_t m = (size_t) n,maxblock = 65536; 205e5c89e4eSSatish Balay char *pp = (char*)p; 2066de02169SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) 2076de02169SBarry Smith PetscErrorCode ierr; 208e5c89e4eSSatish Balay void *ptmp = p; 209e5c89e4eSSatish Balay #endif 210e5c89e4eSSatish Balay 211e5c89e4eSSatish Balay PetscFunctionBegin; 212e5c89e4eSSatish Balay if (!n) PetscFunctionReturn(0); 213e5c89e4eSSatish Balay 2146de02169SBarry Smith if (type == PETSC_INT) m *= sizeof(PetscInt); 215e5c89e4eSSatish Balay else if (type == PETSC_SCALAR) m *= sizeof(PetscScalar); 216e5c89e4eSSatish Balay else if (type == PETSC_DOUBLE) m *= sizeof(double); 217e5c89e4eSSatish Balay else if (type == PETSC_SHORT) m *= sizeof(short); 218e5c89e4eSSatish Balay else if (type == PETSC_CHAR) m *= sizeof(char); 219e5c89e4eSSatish Balay else if (type == PETSC_ENUM) m *= sizeof(PetscEnum); 220e5c89e4eSSatish Balay else if (type == PETSC_TRUTH) m *= sizeof(PetscTruth); 221e5c89e4eSSatish Balay else if (type == PETSC_LOGICAL) m = PetscBTLength(m)*sizeof(char); 222e5c89e4eSSatish Balay else SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Unknown type"); 223e5c89e4eSSatish Balay 224e5c89e4eSSatish Balay while (m) { 225e5c89e4eSSatish Balay wsize = (m < maxblock) ? m : maxblock; 226e5c89e4eSSatish Balay err = read(fd,pp,wsize); 227e5c89e4eSSatish Balay if (err < 0 && errno == EINTR) continue; 228e5c89e4eSSatish Balay if (!err && wsize > 0) SETERRQ(PETSC_ERR_FILE_READ,"Read past end of file"); 229a1f04975SBarry Smith if (err < 0) SETERRQ1(PETSC_ERR_FILE_READ,"Error reading from file, errno %d",errno); 230e5c89e4eSSatish Balay m -= err; 231e5c89e4eSSatish Balay pp += err; 232e5c89e4eSSatish Balay } 233e5c89e4eSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN) 2346de02169SBarry Smith if (type == PETSC_INT) {ierr = PetscByteSwapInt((PetscInt*)ptmp,n);CHKERRQ(ierr);} 2356de02169SBarry Smith else if (type == PETSC_ENUM) {ierr = PetscByteSwapEnum((PetscEnum*)ptmp,n);CHKERRQ(ierr);} 2366de02169SBarry Smith else if (type == PETSC_TRUTH) {ierr = PetscByteSwapTruth((PetscTruth*)ptmp,n);CHKERRQ(ierr);} 237e5c89e4eSSatish Balay else if (type == PETSC_SCALAR) {ierr = PetscByteSwapScalar((PetscScalar*)ptmp,n);CHKERRQ(ierr);} 238e5c89e4eSSatish Balay else if (type == PETSC_DOUBLE) {ierr = PetscByteSwapDouble((double*)ptmp,n);CHKERRQ(ierr);} 239e5c89e4eSSatish Balay else if (type == PETSC_SHORT) {ierr = PetscByteSwapShort((short*)ptmp,n);CHKERRQ(ierr);} 240e5c89e4eSSatish Balay #endif 241e5c89e4eSSatish Balay 242e5c89e4eSSatish Balay PetscFunctionReturn(0); 243e5c89e4eSSatish Balay } 244e5c89e4eSSatish Balay /* --------------------------------------------------------- */ 245e5c89e4eSSatish Balay #undef __FUNCT__ 246e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryWrite" 247e30d2299SSatish Balay /*@ 248e5c89e4eSSatish Balay PetscBinaryWrite - Writes to a binary file. 249e5c89e4eSSatish Balay 250e5c89e4eSSatish Balay Not Collective 251e5c89e4eSSatish Balay 252e5c89e4eSSatish Balay Input Parameters: 253e5c89e4eSSatish Balay + fd - the file 254e5c89e4eSSatish Balay . p - the buffer 255e5c89e4eSSatish Balay . n - the number of items to write 256e5c89e4eSSatish Balay . type - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR) 257e5c89e4eSSatish Balay - istemp - PETSC_FALSE if buffer data should be preserved, PETSC_TRUE otherwise. 258e5c89e4eSSatish Balay 259e5c89e4eSSatish Balay Level: advanced 260e5c89e4eSSatish Balay 261e5c89e4eSSatish Balay Notes: 262e5c89e4eSSatish Balay PetscBinaryWrite() uses byte swapping to work on all machines; the files 263e5c89e4eSSatish Balay are written using big-endian ordering to the file. On small-endian machines the numbers 264e5c89e4eSSatish Balay are converted to the big-endian format when they are written to disk. 265*54f21887SBarry Smith When PETSc is config/configure.py with --with-64bit-indices the integers are written to the 266*54f21887SBarry Smith file as 64 bit integers, this means they can only be read back in when the option --with-64bit-indices 267*54f21887SBarry Smith is used. 268e5c89e4eSSatish Balay 269e5c89e4eSSatish Balay The Buffer p should be read-write buffer, and not static data. 270e5c89e4eSSatish Balay This way, byte-swapping is done in-place, and then the buffer is 271e5c89e4eSSatish Balay written to the file. 272e5c89e4eSSatish Balay 273e5c89e4eSSatish Balay This routine restores the original contents of the buffer, after 274e5c89e4eSSatish Balay it is written to the file. This is done by byte-swapping in-place 275e5c89e4eSSatish Balay the second time. If the flag istemp is set to PETSC_TRUE, the second 276e5c89e4eSSatish Balay byte-swapping operation is not done, thus saving some computation, 277e5c89e4eSSatish Balay but the buffer corrupted is corrupted. 278e5c89e4eSSatish Balay 279e5c89e4eSSatish Balay Concepts: files^writing binary 280e5c89e4eSSatish Balay Concepts: binary files^writing 281e5c89e4eSSatish Balay 2824ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryOpen(), PetscBinaryClose(), PetscViewerBinaryGetDescriptor(), PetscBinarySynchronizedWrite(), 2834ebed01fSBarry Smith PetscBinarySynchronizedRead(), PetscBinarySynchronizedSeek() 284e5c89e4eSSatish Balay @*/ 285e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscBinaryWrite(int fd,void *p,PetscInt n,PetscDataType type,PetscTruth istemp) 286e5c89e4eSSatish Balay { 287e5c89e4eSSatish Balay char *pp = (char*)p; 288e5c89e4eSSatish Balay int err,wsize; 289e5c89e4eSSatish Balay size_t m = (size_t)n,maxblock=65536; 2906de02169SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) 291e5c89e4eSSatish Balay PetscErrorCode ierr; 292e5c89e4eSSatish Balay void *ptmp = p; 293e5c89e4eSSatish Balay #endif 294e5c89e4eSSatish Balay 295e5c89e4eSSatish Balay PetscFunctionBegin; 296e5c89e4eSSatish Balay if (n < 0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Trying to write a negative amount of data %D",n); 297e5c89e4eSSatish Balay if (!n) PetscFunctionReturn(0); 298e5c89e4eSSatish Balay 2996de02169SBarry Smith if (type == PETSC_INT) m *= sizeof(PetscInt); 300e5c89e4eSSatish Balay else if (type == PETSC_SCALAR) m *= sizeof(PetscScalar); 301e5c89e4eSSatish Balay else if (type == PETSC_DOUBLE) m *= sizeof(double); 302e5c89e4eSSatish Balay else if (type == PETSC_SHORT) m *= sizeof(short); 303e5c89e4eSSatish Balay else if (type == PETSC_CHAR) m *= sizeof(char); 304e5c89e4eSSatish Balay else if (type == PETSC_ENUM) m *= sizeof(PetscEnum); 305e5c89e4eSSatish Balay else if (type == PETSC_TRUTH) m *= sizeof(PetscTruth); 306e5c89e4eSSatish Balay else if (type == PETSC_LOGICAL) m = PetscBTLength(m)*sizeof(char); 307e5c89e4eSSatish Balay else SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Unknown type"); 308e5c89e4eSSatish Balay 309e5c89e4eSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN) 3106de02169SBarry Smith if (type == PETSC_INT) {ierr = PetscByteSwapInt((PetscInt*)ptmp,n);CHKERRQ(ierr);} 3116de02169SBarry Smith else if (type == PETSC_ENUM) {ierr = PetscByteSwapEnum((PetscEnum*)ptmp,n);CHKERRQ(ierr);} 3126de02169SBarry Smith else if (type == PETSC_TRUTH) {ierr = PetscByteSwapTruth((PetscTruth*)ptmp,n);CHKERRQ(ierr);} 313e5c89e4eSSatish Balay else if (type == PETSC_SCALAR) {ierr = PetscByteSwapScalar((PetscScalar*)ptmp,n);CHKERRQ(ierr);} 314e5c89e4eSSatish Balay else if (type == PETSC_DOUBLE) {ierr = PetscByteSwapDouble((double*)ptmp,n);CHKERRQ(ierr);} 315e5c89e4eSSatish Balay else if (type == PETSC_SHORT) {ierr = PetscByteSwapShort((short*)ptmp,n);CHKERRQ(ierr);} 316e5c89e4eSSatish Balay #endif 317e5c89e4eSSatish Balay 318e5c89e4eSSatish Balay while (m) { 319e5c89e4eSSatish Balay wsize = (m < maxblock) ? m : maxblock; 320e5c89e4eSSatish Balay err = write(fd,pp,wsize); 321e5c89e4eSSatish Balay if (err < 0 && errno == EINTR) continue; 322e5c89e4eSSatish Balay if (err != wsize) SETERRQ(PETSC_ERR_FILE_WRITE,"Error writing to file."); 323e5c89e4eSSatish Balay m -= wsize; 324e5c89e4eSSatish Balay pp += wsize; 325e5c89e4eSSatish Balay } 326e5c89e4eSSatish Balay 327b659c0ceSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN) 328e5c89e4eSSatish Balay if (!istemp) { 3296de02169SBarry Smith if (type == PETSC_INT) {ierr = PetscByteSwapInt((PetscInt*)ptmp,n);CHKERRQ(ierr);} 3306de02169SBarry Smith else if (type == PETSC_SCALAR) {ierr = PetscByteSwapScalar((PetscScalar*)ptmp,n);CHKERRQ(ierr);} 331b63245c5SSatish Balay else if (type == PETSC_DOUBLE) {ierr = PetscByteSwapDouble((double*)ptmp,n);CHKERRQ(ierr);} 332e5c89e4eSSatish Balay else if (type == PETSC_SHORT) {ierr = PetscByteSwapShort((short*)ptmp,n);CHKERRQ(ierr);} 3336de02169SBarry Smith else if (type == PETSC_ENUM) {ierr = PetscByteSwapEnum((PetscEnum*)ptmp,n);CHKERRQ(ierr);} 3346de02169SBarry Smith else if (type == PETSC_TRUTH) {ierr = PetscByteSwapTruth((PetscTruth*)ptmp,n);CHKERRQ(ierr);} 335e5c89e4eSSatish Balay } 336e5c89e4eSSatish Balay #endif 337e5c89e4eSSatish Balay PetscFunctionReturn(0); 338e5c89e4eSSatish Balay } 339e5c89e4eSSatish Balay 340e5c89e4eSSatish Balay #undef __FUNCT__ 341e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryOpen" 342e5c89e4eSSatish Balay /*@C 343e5c89e4eSSatish Balay PetscBinaryOpen - Opens a PETSc binary file. 344e5c89e4eSSatish Balay 345e5c89e4eSSatish Balay Not Collective 346e5c89e4eSSatish Balay 347e5c89e4eSSatish Balay Input Parameters: 348e5c89e4eSSatish Balay + name - filename 34945c64e65SBarry Smith - type - type of binary file, one of FILE_MODE_READ, FILE_MODE_APPEND, FILE_MODE_WRITE 350e5c89e4eSSatish Balay 351e5c89e4eSSatish Balay Output Parameter: 352e5c89e4eSSatish Balay . fd - the file 353e5c89e4eSSatish Balay 354e5c89e4eSSatish Balay Level: advanced 355e5c89e4eSSatish Balay 356e5c89e4eSSatish Balay Concepts: files^opening binary 357e5c89e4eSSatish Balay Concepts: binary files^opening 358e5c89e4eSSatish Balay 359e5c89e4eSSatish Balay Notes: Files access with PetscBinaryRead() and PetscBinaryWrite() are ALWAYS written in 360e5c89e4eSSatish Balay big-endian format. This means the file can be accessed using PetscBinaryOpen() and 361e5c89e4eSSatish Balay PetscBinaryRead() and PetscBinaryWrite() on any machine. 362e5c89e4eSSatish Balay 3634ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscFileMode, PetscViewerFileSetMode(), PetscViewerBinaryGetDescriptor(), 3644ebed01fSBarry Smith PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(), PetscBinarySynchronizedSeek() 36545c64e65SBarry Smith 366e5c89e4eSSatish Balay @*/ 36745c64e65SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscBinaryOpen(const char name[],PetscFileMode mode,int *fd) 368e5c89e4eSSatish Balay { 369e5c89e4eSSatish Balay PetscFunctionBegin; 370e5c89e4eSSatish Balay #if defined(PETSC_HAVE_O_BINARY) 37145c64e65SBarry Smith if (mode == FILE_MODE_WRITE) { 372e5c89e4eSSatish Balay if ((*fd = open(name,O_WRONLY|O_CREAT|O_TRUNC|O_BINARY,0666)) == -1) { 373e5c89e4eSSatish Balay SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot create file for writing: %s",name); 374e5c89e4eSSatish Balay } 37545c64e65SBarry Smith } else if (mode == FILE_MODE_READ) { 376e5c89e4eSSatish Balay if ((*fd = open(name,O_RDONLY|O_BINARY,0)) == -1) { 377e5c89e4eSSatish Balay SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot open file for reading: %s",name); 378e5c89e4eSSatish Balay } 37945c64e65SBarry Smith } else if (mode == FILE_MODE_APPEND) { 380e5c89e4eSSatish Balay if ((*fd = open(name,O_WRONLY|O_BINARY,0)) == -1) { 381e5c89e4eSSatish Balay SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot open file for writing: %s",name); 382e5c89e4eSSatish Balay } 383e5c89e4eSSatish Balay #else 38445c64e65SBarry Smith if (mode == FILE_MODE_WRITE) { 385e5c89e4eSSatish Balay if ((*fd = creat(name,0666)) == -1) { 386e5c89e4eSSatish Balay SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot create file for writing: %s",name); 387e5c89e4eSSatish Balay } 38845c64e65SBarry Smith } else if (mode == FILE_MODE_READ) { 389e5c89e4eSSatish Balay if ((*fd = open(name,O_RDONLY,0)) == -1) { 390e5c89e4eSSatish Balay SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot open file for reading: %s",name); 391e5c89e4eSSatish Balay } 392e5c89e4eSSatish Balay } 39345c64e65SBarry Smith else if (mode == FILE_MODE_APPEND) { 394e5c89e4eSSatish Balay if ((*fd = open(name,O_WRONLY,0)) == -1) { 395e5c89e4eSSatish Balay SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot open file for writing: %s",name); 396e5c89e4eSSatish Balay } 397e5c89e4eSSatish Balay #endif 39845c64e65SBarry Smith } else SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Unknown file mode"); 399e5c89e4eSSatish Balay PetscFunctionReturn(0); 400e5c89e4eSSatish Balay } 401e5c89e4eSSatish Balay 402e5c89e4eSSatish Balay #undef __FUNCT__ 403e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryClose" 404e30d2299SSatish Balay /*@ 405e5c89e4eSSatish Balay PetscBinaryClose - Closes a PETSc binary file. 406e5c89e4eSSatish Balay 407e5c89e4eSSatish Balay Not Collective 408e5c89e4eSSatish Balay 409e5c89e4eSSatish Balay Output Parameter: 410e5c89e4eSSatish Balay . fd - the file 411e5c89e4eSSatish Balay 412e5c89e4eSSatish Balay Level: advanced 413e5c89e4eSSatish Balay 4144ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen(), PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(), 4154ebed01fSBarry Smith PetscBinarySynchronizedSeek() 416e5c89e4eSSatish Balay @*/ 417e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscBinaryClose(int fd) 418e5c89e4eSSatish Balay { 419e5c89e4eSSatish Balay PetscFunctionBegin; 420e5c89e4eSSatish Balay close(fd); 421e5c89e4eSSatish Balay PetscFunctionReturn(0); 422e5c89e4eSSatish Balay } 423e5c89e4eSSatish Balay 424e5c89e4eSSatish Balay 425e5c89e4eSSatish Balay #undef __FUNCT__ 426e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinarySeek" 427e30d2299SSatish Balay /*@ 428e5c89e4eSSatish Balay PetscBinarySeek - Moves the file pointer on a PETSc binary file. 429e5c89e4eSSatish Balay 430e5c89e4eSSatish Balay Not Collective 431e5c89e4eSSatish Balay 432e5c89e4eSSatish Balay Input Parameters: 433e5c89e4eSSatish Balay + fd - the file 434ff553b35SMatthew Knepley . off - number of bytes to move. Use PETSC_BINARY_INT_SIZE, PETSC_BINARY_SCALAR_SIZE, 435e5c89e4eSSatish Balay etc. in your calculation rather than sizeof() to compute byte lengths. 436ff553b35SMatthew Knepley - whence - if PETSC_BINARY_SEEK_SET then off is an absolute location in the file 437ff553b35SMatthew Knepley if PETSC_BINARY_SEEK_CUR then off is an offset from the current location 438ff553b35SMatthew Knepley if PETSC_BINARY_SEEK_END then off is an offset from the end of file 439e5c89e4eSSatish Balay 440e5c89e4eSSatish Balay Output Parameter: 441e5c89e4eSSatish Balay . offset - new offset in file 442e5c89e4eSSatish Balay 443e5c89e4eSSatish Balay Level: developer 444e5c89e4eSSatish Balay 445e5c89e4eSSatish Balay Notes: 446e5c89e4eSSatish Balay Integers are stored on the file as 32 long, regardless of whether 447e5c89e4eSSatish Balay they are stored in the machine as 32 or 64, this means the same 448e5c89e4eSSatish Balay binary file may be read on any machine. Hence you CANNOT use sizeof() 449e5c89e4eSSatish Balay to determine the offset or location. 450e5c89e4eSSatish Balay 451e5c89e4eSSatish Balay Concepts: files^binary seeking 452e5c89e4eSSatish Balay Concepts: binary files^seeking 453e5c89e4eSSatish Balay 4544ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen(), PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(), 4554ebed01fSBarry Smith PetscBinarySynchronizedSeek() 456e5c89e4eSSatish Balay @*/ 457e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscBinarySeek(int fd,off_t off,PetscBinarySeekType whence,off_t *offset) 458e5c89e4eSSatish Balay { 459e5c89e4eSSatish Balay int iwhence = 0; 460e5c89e4eSSatish Balay 461e5c89e4eSSatish Balay PetscFunctionBegin; 462e5c89e4eSSatish Balay if (whence == PETSC_BINARY_SEEK_SET) { 463e5c89e4eSSatish Balay iwhence = SEEK_SET; 464e5c89e4eSSatish Balay } else if (whence == PETSC_BINARY_SEEK_CUR) { 465e5c89e4eSSatish Balay iwhence = SEEK_CUR; 466e5c89e4eSSatish Balay } else if (whence == PETSC_BINARY_SEEK_END) { 467e5c89e4eSSatish Balay iwhence = SEEK_END; 468e5c89e4eSSatish Balay } else { 469e5c89e4eSSatish Balay SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Unknown seek location"); 470e5c89e4eSSatish Balay } 471e5c89e4eSSatish Balay #if defined(PETSC_HAVE_LSEEK) 472e5c89e4eSSatish Balay *offset = lseek(fd,off,iwhence); 473e5c89e4eSSatish Balay #elif defined(PETSC_HAVE__LSEEK) 474e5c89e4eSSatish Balay *offset = _lseek(fd,(long)off,iwhence); 475e5c89e4eSSatish Balay #else 476e5c89e4eSSatish Balay SETERRQ(PETSC_ERR_SUP_SYS,"System does not have a way of seeking on a file"); 477e5c89e4eSSatish Balay #endif 478e5c89e4eSSatish Balay PetscFunctionReturn(0); 479e5c89e4eSSatish Balay } 480e5c89e4eSSatish Balay 481e5c89e4eSSatish Balay #undef __FUNCT__ 4821d280d73SBarry Smith #define __FUNCT__ "PetscBinarySynchronizedRead" 483e5c89e4eSSatish Balay /*@C 4841d280d73SBarry Smith PetscBinarySynchronizedRead - Reads from a binary file. 485e5c89e4eSSatish Balay 486e5c89e4eSSatish Balay Collective on MPI_Comm 487e5c89e4eSSatish Balay 488e5c89e4eSSatish Balay Input Parameters: 489e5c89e4eSSatish Balay + comm - the MPI communicator 490e5c89e4eSSatish Balay . fd - the file 491e5c89e4eSSatish Balay . n - the number of items to read 492e5c89e4eSSatish Balay - type - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR) 493e5c89e4eSSatish Balay 494e5c89e4eSSatish Balay Output Parameters: 495e5c89e4eSSatish Balay . p - the buffer 496e5c89e4eSSatish Balay 497e5c89e4eSSatish Balay Options Database Key: 498e5c89e4eSSatish Balay . -binary_longints - indicates the file was generated on a Cray vector 499e5c89e4eSSatish Balay machine (not the T3E/D) and the ints are stored as 64 bit 500e5c89e4eSSatish Balay quantities, otherwise they are stored as 32 bit 501e5c89e4eSSatish Balay 502e5c89e4eSSatish Balay Level: developer 503e5c89e4eSSatish Balay 504e5c89e4eSSatish Balay Notes: 505e5c89e4eSSatish Balay Does a PetscBinaryRead() followed by an MPI_Bcast() 506e5c89e4eSSatish Balay 5071d280d73SBarry Smith PetscBinarySynchronizedRead() uses byte swapping to work on all machines. 508e5c89e4eSSatish Balay Integers are stored on the file as 32 long, regardless of whether 509e5c89e4eSSatish Balay they are stored in the machine as 32 or 64, this means the same 510e5c89e4eSSatish Balay binary file may be read on any machine. 511e5c89e4eSSatish Balay 512e5c89e4eSSatish Balay Concepts: files^synchronized reading of binary files 513e5c89e4eSSatish Balay Concepts: binary files^reading, synchronized 514e5c89e4eSSatish Balay 5154ebed01fSBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscBinaryRead(), PetscBinarySynchronizedWrite(), 5164ebed01fSBarry Smith PetscBinarySynchronizedSeek() 517e5c89e4eSSatish Balay @*/ 5181d280d73SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscBinarySynchronizedRead(MPI_Comm comm,int fd,void *p,PetscInt n,PetscDataType type) 519e5c89e4eSSatish Balay { 520e5c89e4eSSatish Balay PetscErrorCode ierr; 521e5c89e4eSSatish Balay PetscMPIInt rank; 522e5c89e4eSSatish Balay MPI_Datatype mtype; 523e5c89e4eSSatish Balay 524e5c89e4eSSatish Balay PetscFunctionBegin; 525e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 526e5c89e4eSSatish Balay if (!rank) { 527e5c89e4eSSatish Balay ierr = PetscBinaryRead(fd,p,n,type);CHKERRQ(ierr); 528e5c89e4eSSatish Balay } 529e5c89e4eSSatish Balay ierr = PetscDataTypeToMPIDataType(type,&mtype);CHKERRQ(ierr); 530e5c89e4eSSatish Balay ierr = MPI_Bcast(p,n,mtype,0,comm);CHKERRQ(ierr); 531e5c89e4eSSatish Balay PetscFunctionReturn(0); 532e5c89e4eSSatish Balay } 533e5c89e4eSSatish Balay 534e5c89e4eSSatish Balay #undef __FUNCT__ 5351d280d73SBarry Smith #define __FUNCT__ "PetscBinarySynchronizedWrite" 536e5c89e4eSSatish Balay /*@C 5371d280d73SBarry Smith PetscBinarySynchronizedWrite - writes to a binary file. 538e5c89e4eSSatish Balay 539e5c89e4eSSatish Balay Collective on MPI_Comm 540e5c89e4eSSatish Balay 541e5c89e4eSSatish Balay Input Parameters: 542e5c89e4eSSatish Balay + comm - the MPI communicator 543e5c89e4eSSatish Balay . fd - the file 544e5c89e4eSSatish Balay . n - the number of items to write 545e5c89e4eSSatish Balay . p - the buffer 546e5c89e4eSSatish Balay . istemp - the buffer may be changed 547e5c89e4eSSatish Balay - type - the type of items to write (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR) 548e5c89e4eSSatish Balay 549e5c89e4eSSatish Balay Level: developer 550e5c89e4eSSatish Balay 551e5c89e4eSSatish Balay Notes: 552e5c89e4eSSatish Balay Process 0 does a PetscBinaryWrite() 553e5c89e4eSSatish Balay 5541d280d73SBarry Smith PetscBinarySynchronizedWrite() uses byte swapping to work on all machines. 555e5c89e4eSSatish Balay Integers are stored on the file as 32 long, regardless of whether 556e5c89e4eSSatish Balay they are stored in the machine as 32 or 64, this means the same 557e5c89e4eSSatish Balay binary file may be read on any machine. 558e5c89e4eSSatish Balay 5591d280d73SBarry Smith WARNING: This is NOT like PetscSynchronizedFPrintf()! This routine ignores calls on all but process 0, 5601d280d73SBarry Smith while PetscSynchronizedFPrintf() has all processes print their strings in order. 5611d280d73SBarry Smith 562e5c89e4eSSatish Balay Concepts: files^synchronized writing of binary files 563e5c89e4eSSatish Balay Concepts: binary files^reading, synchronized 564e5c89e4eSSatish Balay 5654ebed01fSBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscBinaryRead(), PetscBinarySynchronizedRead(), 5664ebed01fSBarry Smith PetscBinarySynchronizedSeek() 567e5c89e4eSSatish Balay @*/ 5681d280d73SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscBinarySynchronizedWrite(MPI_Comm comm,int fd,void *p,PetscInt n,PetscDataType type,PetscTruth istemp) 569e5c89e4eSSatish Balay { 570e5c89e4eSSatish Balay PetscErrorCode ierr; 571e5c89e4eSSatish Balay PetscMPIInt rank; 572e5c89e4eSSatish Balay 573e5c89e4eSSatish Balay PetscFunctionBegin; 574e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 575e5c89e4eSSatish Balay if (!rank) { 576e5c89e4eSSatish Balay ierr = PetscBinaryWrite(fd,p,n,type,istemp);CHKERRQ(ierr); 577e5c89e4eSSatish Balay } 578e5c89e4eSSatish Balay PetscFunctionReturn(0); 579e5c89e4eSSatish Balay } 580e5c89e4eSSatish Balay 581e5c89e4eSSatish Balay #undef __FUNCT__ 5821d280d73SBarry Smith #define __FUNCT__ "PetscBinarySynchronizedSeek" 583e5c89e4eSSatish Balay /*@C 5841d280d73SBarry Smith PetscBinarySynchronizedSeek - Moves the file pointer on a PETSc binary file. 585e5c89e4eSSatish Balay 586e5c89e4eSSatish Balay 587e5c89e4eSSatish Balay Input Parameters: 588e5c89e4eSSatish Balay + fd - the file 589e5c89e4eSSatish Balay . whence - if PETSC_BINARY_SEEK_SET then size is an absolute location in the file 590e5c89e4eSSatish Balay if PETSC_BINARY_SEEK_CUR then size is offset from current location 591e5c89e4eSSatish Balay if PETSC_BINARY_SEEK_END then size is offset from end of file 592e5c89e4eSSatish Balay - off - number of bytes to move. Use PETSC_BINARY_INT_SIZE, PETSC_BINARY_SCALAR_SIZE, 593e5c89e4eSSatish Balay etc. in your calculation rather than sizeof() to compute byte lengths. 594e5c89e4eSSatish Balay 595e5c89e4eSSatish Balay Output Parameter: 596e5c89e4eSSatish Balay . offset - new offset in file 597e5c89e4eSSatish Balay 598e5c89e4eSSatish Balay Level: developer 599e5c89e4eSSatish Balay 600e5c89e4eSSatish Balay Notes: 601e5c89e4eSSatish Balay Integers are stored on the file as 32 long, regardless of whether 602e5c89e4eSSatish Balay they are stored in the machine as 32 or 64, this means the same 603e5c89e4eSSatish Balay binary file may be read on any machine. Hence you CANNOT use sizeof() 604e5c89e4eSSatish Balay to determine the offset or location. 605e5c89e4eSSatish Balay 606e5c89e4eSSatish Balay Concepts: binary files^seeking 607e5c89e4eSSatish Balay Concepts: files^seeking in binary 608e5c89e4eSSatish Balay 6094ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen(), PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(), 6104ebed01fSBarry Smith PetscBinarySynchronizedSeek() 611e5c89e4eSSatish Balay @*/ 6121d280d73SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscBinarySynchronizedSeek(MPI_Comm comm,int fd,off_t off,PetscBinarySeekType whence,off_t *offset) 613e5c89e4eSSatish Balay { 614e5c89e4eSSatish Balay PetscErrorCode ierr; 615e5c89e4eSSatish Balay PetscMPIInt rank; 616e5c89e4eSSatish Balay 617e5c89e4eSSatish Balay PetscFunctionBegin; 618e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 619e5c89e4eSSatish Balay if (!rank) { 620e5c89e4eSSatish Balay ierr = PetscBinarySeek(fd,off,whence,offset);CHKERRQ(ierr); 621e5c89e4eSSatish Balay } 622e5c89e4eSSatish Balay PetscFunctionReturn(0); 623e5c89e4eSSatish Balay } 624e5c89e4eSSatish Balay 625