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 (PETSC_SIZEOF_INT == 8) 21e5c89e4eSSatish Balay #define PetscInt32 short 22e5c89e4eSSatish Balay #else 23e5c89e4eSSatish Balay #define PetscInt32 int 24e5c89e4eSSatish Balay #endif 25e5c89e4eSSatish Balay 26e5c89e4eSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN) 27e5c89e4eSSatish Balay 28e5c89e4eSSatish Balay #undef __FUNCT__ 29e5c89e4eSSatish Balay #define __FUNCT__ "PetscByteSwapInt" 30e5c89e4eSSatish Balay /* 31e5c89e4eSSatish Balay PetscByteSwapInt - Swap bytes in a 32 bit integer. NOT a PetscInt! Note that PETSc binary read and write 32e5c89e4eSSatish Balay always store and read only 32 bit integers! (See PetscBinaryRead(), PetscBinaryWrite()). 33e5c89e4eSSatish Balay 34e5c89e4eSSatish Balay */ 35e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscByteSwapInt(PetscInt32 *buff,PetscInt n) 36e5c89e4eSSatish Balay { 37e5c89e4eSSatish Balay PetscInt i,j,tmp = 0; 38e5c89e4eSSatish Balay PetscInt *tptr = &tmp; /* Need to access tmp indirectly to get */ 39e5c89e4eSSatish Balay char *ptr1,*ptr2 = (char*)&tmp; /* arround the bug in DEC-ALPHA g++ */ 40e5c89e4eSSatish Balay 41e5c89e4eSSatish Balay PetscFunctionBegin; 42e5c89e4eSSatish Balay for (j=0; j<n; j++) { 43e5c89e4eSSatish Balay ptr1 = (char*)(buff + j); 44e5c89e4eSSatish Balay for (i=0; i<(int)sizeof(PetscInt32); i++) { 45e5c89e4eSSatish Balay ptr2[i] = ptr1[sizeof(PetscInt32)-1-i]; 46e5c89e4eSSatish Balay } 47e5c89e4eSSatish Balay buff[j] = *tptr; 48e5c89e4eSSatish Balay } 49e5c89e4eSSatish Balay PetscFunctionReturn(0); 50e5c89e4eSSatish Balay } 51e5c89e4eSSatish Balay /* --------------------------------------------------------- */ 52e5c89e4eSSatish Balay #undef __FUNCT__ 53e5c89e4eSSatish Balay #define __FUNCT__ "PetscByteSwapShort" 54e5c89e4eSSatish Balay /* 55e5c89e4eSSatish Balay PetscByteSwapShort - Swap bytes in a short 56e5c89e4eSSatish Balay */ 57e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscByteSwapShort(short *buff,PetscInt n) 58e5c89e4eSSatish Balay { 59e5c89e4eSSatish Balay PetscInt i,j; 60e5c89e4eSSatish Balay short tmp; 61e5c89e4eSSatish Balay short *tptr = &tmp; /* take care pf bug in DEC-ALPHA g++ */ 62e5c89e4eSSatish Balay char *ptr1,*ptr2 = (char*)&tmp; 63e5c89e4eSSatish Balay 64e5c89e4eSSatish Balay PetscFunctionBegin; 65e5c89e4eSSatish Balay for (j=0; j<n; j++) { 66e5c89e4eSSatish Balay ptr1 = (char*)(buff + j); 67e5c89e4eSSatish Balay for (i=0; i<(int) sizeof(short); i++) { 68e5c89e4eSSatish Balay ptr2[i] = ptr1[sizeof(int)-1-i]; 69e5c89e4eSSatish Balay } 70e5c89e4eSSatish Balay buff[j] = *tptr; 71e5c89e4eSSatish Balay } 72e5c89e4eSSatish Balay PetscFunctionReturn(0); 73e5c89e4eSSatish Balay } 74e5c89e4eSSatish Balay /* --------------------------------------------------------- */ 75e5c89e4eSSatish Balay #undef __FUNCT__ 76e5c89e4eSSatish Balay #define __FUNCT__ "PetscByteSwapScalar" 77e5c89e4eSSatish Balay /* 78e5c89e4eSSatish Balay PetscByteSwapScalar - Swap bytes in a double 79e5c89e4eSSatish Balay Complex is dealt with as if array of double twice as long. 80e5c89e4eSSatish Balay */ 81e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscByteSwapScalar(PetscScalar *buff,PetscInt n) 82e5c89e4eSSatish Balay { 83e5c89e4eSSatish Balay PetscInt i,j; 84e5c89e4eSSatish Balay PetscReal tmp,*buff1 = (PetscReal*)buff; 85e5c89e4eSSatish Balay PetscReal *tptr = &tmp; /* take care pf bug in DEC-ALPHA g++ */ 86e5c89e4eSSatish Balay char *ptr1,*ptr2 = (char*)&tmp; 87e5c89e4eSSatish Balay 88e5c89e4eSSatish Balay PetscFunctionBegin; 89e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX) 90e5c89e4eSSatish Balay n *= 2; 91e5c89e4eSSatish Balay #endif 92e5c89e4eSSatish Balay for (j=0; j<n; j++) { 93e5c89e4eSSatish Balay ptr1 = (char*)(buff1 + j); 94e5c89e4eSSatish Balay for (i=0; i<(int) sizeof(PetscReal); i++) { 95e5c89e4eSSatish Balay ptr2[i] = ptr1[sizeof(PetscReal)-1-i]; 96e5c89e4eSSatish Balay } 97e5c89e4eSSatish Balay buff1[j] = *tptr; 98e5c89e4eSSatish Balay } 99e5c89e4eSSatish Balay PetscFunctionReturn(0); 100e5c89e4eSSatish Balay } 101e5c89e4eSSatish Balay /* --------------------------------------------------------- */ 102e5c89e4eSSatish Balay #undef __FUNCT__ 103e5c89e4eSSatish Balay #define __FUNCT__ "PetscByteSwapDouble" 104e5c89e4eSSatish Balay /* 105e5c89e4eSSatish Balay PetscByteSwapDouble - Swap bytes in a double 106e5c89e4eSSatish Balay */ 107e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscByteSwapDouble(double *buff,PetscInt n) 108e5c89e4eSSatish Balay { 109e5c89e4eSSatish Balay PetscInt i,j; 110e5c89e4eSSatish Balay double tmp,*buff1 = (double*)buff; 111e5c89e4eSSatish Balay double *tptr = &tmp; /* take care pf bug in DEC-ALPHA g++ */ 112e5c89e4eSSatish Balay char *ptr1,*ptr2 = (char*)&tmp; 113e5c89e4eSSatish Balay 114e5c89e4eSSatish Balay PetscFunctionBegin; 115e5c89e4eSSatish Balay for (j=0; j<n; j++) { 116e5c89e4eSSatish Balay ptr1 = (char*)(buff1 + j); 117e5c89e4eSSatish Balay for (i=0; i<(int) sizeof(double); i++) { 118e5c89e4eSSatish Balay ptr2[i] = ptr1[sizeof(double)-1-i]; 119e5c89e4eSSatish Balay } 120e5c89e4eSSatish Balay buff1[j] = *tptr; 121e5c89e4eSSatish Balay } 122e5c89e4eSSatish Balay PetscFunctionReturn(0); 123e5c89e4eSSatish Balay } 124e5c89e4eSSatish Balay #endif 125e5c89e4eSSatish Balay /* --------------------------------------------------------- */ 126e5c89e4eSSatish Balay #undef __FUNCT__ 127e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryRead" 128e30d2299SSatish Balay /*@ 129e5c89e4eSSatish Balay PetscBinaryRead - Reads from a binary file. 130e5c89e4eSSatish Balay 131e5c89e4eSSatish Balay Not Collective 132e5c89e4eSSatish Balay 133e5c89e4eSSatish Balay Input Parameters: 134e5c89e4eSSatish Balay + fd - the file 135e5c89e4eSSatish Balay . n - the number of items to read 136e5c89e4eSSatish Balay - type - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR) 137e5c89e4eSSatish Balay 138e5c89e4eSSatish Balay Output Parameters: 139e5c89e4eSSatish Balay . p - the buffer 140e5c89e4eSSatish Balay 141e5c89e4eSSatish Balay 142e5c89e4eSSatish Balay 143e5c89e4eSSatish Balay Level: developer 144e5c89e4eSSatish Balay 145e5c89e4eSSatish Balay Notes: 146e5c89e4eSSatish Balay PetscBinaryRead() uses byte swapping to work on all machines; the files 147e5c89e4eSSatish Balay are written to file ALWAYS using big-endian ordering. On small-endian machines the numbers 148e5c89e4eSSatish Balay are converted to the small-endian format when they are read in from the file. 149e5c89e4eSSatish Balay Integers are stored on the file as 32 bits long, regardless of whether 150e5c89e4eSSatish Balay they are stored in the machine as 32 bits or 64 bits, this means the same 151e5c89e4eSSatish Balay binary file may be read on any machine. 152e5c89e4eSSatish Balay 153e5c89e4eSSatish Balay Concepts: files^reading binary 154e5c89e4eSSatish Balay Concepts: binary files^reading 155e5c89e4eSSatish Balay 156e7788613SBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscViewerBinaryGetDescriptor() 157e5c89e4eSSatish Balay @*/ 158e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscBinaryRead(int fd,void *p,PetscInt n,PetscDataType type) 159e5c89e4eSSatish Balay { 16041e811b7SSatish Balay #if (PETSC_SIZEOF_INT == 8) || defined(PETSC_USE_64BIT_INDICES) || !defined(PETSC_WORDS_BIGENDIAN) 161e5c89e4eSSatish Balay PetscErrorCode ierr; 162e5c89e4eSSatish Balay #endif 163e5c89e4eSSatish Balay int wsize,err; 164e5c89e4eSSatish Balay size_t m = (size_t) n,maxblock = 65536; 165e5c89e4eSSatish Balay char *pp = (char*)p; 16641e811b7SSatish Balay #if (PETSC_SIZEOF_INT == 8) || !defined(PETSC_WORDS_BIGENDIAN) || defined(PETSC_USE_64BIT_INDICES) 167e5c89e4eSSatish Balay void *ptmp = p; 168e5c89e4eSSatish Balay #endif 169e5c89e4eSSatish Balay 170e5c89e4eSSatish Balay PetscFunctionBegin; 171e5c89e4eSSatish Balay if (!n) PetscFunctionReturn(0); 172e5c89e4eSSatish Balay 173e5c89e4eSSatish Balay if (type == PETSC_INT){ 174e5c89e4eSSatish Balay m *= sizeof(PetscInt32); 17541e811b7SSatish Balay #if (PETSC_SIZEOF_INT == 8) || defined(PETSC_USE_64BIT_INDICES) 176e5c89e4eSSatish Balay /* read them in as 32 bit ints, later stretch into ints */ 177e5c89e4eSSatish Balay ierr = PetscMalloc(m,&pp);CHKERRQ(ierr); 178e5c89e4eSSatish Balay ptmp = (void*)pp; 179e5c89e4eSSatish Balay #endif 180e5c89e4eSSatish Balay } 181e5c89e4eSSatish Balay else if (type == PETSC_SCALAR) m *= sizeof(PetscScalar); 182e5c89e4eSSatish Balay else if (type == PETSC_DOUBLE) m *= sizeof(double); 183e5c89e4eSSatish Balay else if (type == PETSC_SHORT) m *= sizeof(short); 184e5c89e4eSSatish Balay else if (type == PETSC_CHAR) m *= sizeof(char); 185e5c89e4eSSatish Balay else if (type == PETSC_ENUM) m *= sizeof(PetscEnum); 186e5c89e4eSSatish Balay else if (type == PETSC_TRUTH) m *= sizeof(PetscTruth); 187e5c89e4eSSatish Balay else if (type == PETSC_LOGICAL) m = PetscBTLength(m)*sizeof(char); 188e5c89e4eSSatish Balay else SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Unknown type"); 189e5c89e4eSSatish Balay 190e5c89e4eSSatish Balay while (m) { 191e5c89e4eSSatish Balay wsize = (m < maxblock) ? m : maxblock; 192e5c89e4eSSatish Balay err = read(fd,pp,wsize); 193e5c89e4eSSatish Balay if (err < 0 && errno == EINTR) continue; 194e5c89e4eSSatish Balay if (!err && wsize > 0) SETERRQ(PETSC_ERR_FILE_READ,"Read past end of file"); 195a1f04975SBarry Smith if (err < 0) SETERRQ1(PETSC_ERR_FILE_READ,"Error reading from file, errno %d",errno); 196e5c89e4eSSatish Balay m -= err; 197e5c89e4eSSatish Balay pp += err; 198e5c89e4eSSatish Balay } 199e5c89e4eSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN) 200e5c89e4eSSatish Balay if (type == PETSC_INT) {ierr = PetscByteSwapInt((PetscInt32*)ptmp,n);CHKERRQ(ierr);} 201e5c89e4eSSatish Balay else if (type == PETSC_ENUM) {ierr = PetscByteSwapInt((PetscInt32*)ptmp,n);CHKERRQ(ierr);} 202e5c89e4eSSatish Balay else if (type == PETSC_TRUTH) {ierr = PetscByteSwapInt((PetscInt32*)ptmp,n);CHKERRQ(ierr);} 203e5c89e4eSSatish Balay else if (type == PETSC_SCALAR) {ierr = PetscByteSwapScalar((PetscScalar*)ptmp,n);CHKERRQ(ierr);} 204e5c89e4eSSatish Balay else if (type == PETSC_DOUBLE) {ierr = PetscByteSwapDouble((double*)ptmp,n);CHKERRQ(ierr);} 205e5c89e4eSSatish Balay else if (type == PETSC_SHORT) {ierr = PetscByteSwapShort((short*)ptmp,n);CHKERRQ(ierr);} 206e5c89e4eSSatish Balay #endif 207e5c89e4eSSatish Balay 20841e811b7SSatish Balay #if (PETSC_SIZEOF_INT == 8) || defined(PETSC_USE_64BIT_INDICES) 209e5c89e4eSSatish Balay if (type == PETSC_INT) { 210e5c89e4eSSatish Balay PetscInt *p_int = (PetscInt*)p,i; 211e5c89e4eSSatish Balay PetscInt32 *p_short = (PetscInt32 *)ptmp; 212e5c89e4eSSatish Balay for (i=0; i<n; i++) { 213e5c89e4eSSatish Balay p_int[i] = (PetscInt)p_short[i]; 214e5c89e4eSSatish Balay } 215e5c89e4eSSatish Balay ierr = PetscFree(ptmp);CHKERRQ(ierr); 216e5c89e4eSSatish Balay } 217e5c89e4eSSatish Balay #endif 218e5c89e4eSSatish Balay PetscFunctionReturn(0); 219e5c89e4eSSatish Balay } 220e5c89e4eSSatish Balay /* --------------------------------------------------------- */ 221e5c89e4eSSatish Balay #undef __FUNCT__ 222e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryWrite" 223e30d2299SSatish Balay /*@ 224e5c89e4eSSatish Balay PetscBinaryWrite - Writes to a binary file. 225e5c89e4eSSatish Balay 226e5c89e4eSSatish Balay Not Collective 227e5c89e4eSSatish Balay 228e5c89e4eSSatish Balay Input Parameters: 229e5c89e4eSSatish Balay + fd - the file 230e5c89e4eSSatish Balay . p - the buffer 231e5c89e4eSSatish Balay . n - the number of items to write 232e5c89e4eSSatish Balay . type - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR) 233e5c89e4eSSatish Balay - istemp - PETSC_FALSE if buffer data should be preserved, PETSC_TRUE otherwise. 234e5c89e4eSSatish Balay 235e5c89e4eSSatish Balay Level: advanced 236e5c89e4eSSatish Balay 237e5c89e4eSSatish Balay Notes: 238e5c89e4eSSatish Balay PetscBinaryWrite() uses byte swapping to work on all machines; the files 239e5c89e4eSSatish Balay are written using big-endian ordering to the file. On small-endian machines the numbers 240e5c89e4eSSatish Balay are converted to the big-endian format when they are written to disk. 241e5c89e4eSSatish Balay Integers are stored on the file as 32 bits long, regardless of whether 242e5c89e4eSSatish Balay they are stored in the machine as 32 bits or 64 bits, this means the same 243e5c89e4eSSatish Balay binary file may be read on any machine. It also means that 64 bit integers larger than 244e5c89e4eSSatish Balay roughly 2 billion are TRUNCATED/WRONG when written to the file. 245e5c89e4eSSatish Balay 246e5c89e4eSSatish Balay The Buffer p should be read-write buffer, and not static data. 247e5c89e4eSSatish Balay This way, byte-swapping is done in-place, and then the buffer is 248e5c89e4eSSatish Balay written to the file. 249e5c89e4eSSatish Balay 250e5c89e4eSSatish Balay This routine restores the original contents of the buffer, after 251e5c89e4eSSatish Balay it is written to the file. This is done by byte-swapping in-place 252e5c89e4eSSatish Balay the second time. If the flag istemp is set to PETSC_TRUE, the second 253e5c89e4eSSatish Balay byte-swapping operation is not done, thus saving some computation, 254e5c89e4eSSatish Balay but the buffer corrupted is corrupted. 255e5c89e4eSSatish Balay 256e5c89e4eSSatish Balay Concepts: files^writing binary 257e5c89e4eSSatish Balay Concepts: binary files^writing 258e5c89e4eSSatish Balay 259e7788613SBarry Smith .seealso: PetscBinaryRead(), PetscBinaryOpen(), PetscBinaryClose(), PetscViewerBinaryGetDescriptor() 260e5c89e4eSSatish Balay @*/ 261e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscBinaryWrite(int fd,void *p,PetscInt n,PetscDataType type,PetscTruth istemp) 262e5c89e4eSSatish Balay { 263e5c89e4eSSatish Balay char *pp = (char*)p; 264e5c89e4eSSatish Balay int err,wsize; 265e5c89e4eSSatish Balay size_t m = (size_t)n,maxblock=65536; 26641e811b7SSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN) || (PETSC_SIZEOF_INT == 8) || defined(PETSC_USE_64BIT_INDICES) 267e5c89e4eSSatish Balay PetscErrorCode ierr; 268e5c89e4eSSatish Balay void *ptmp = p; 269e5c89e4eSSatish Balay #endif 270e5c89e4eSSatish Balay 271e5c89e4eSSatish Balay PetscFunctionBegin; 272e5c89e4eSSatish Balay if (n < 0) SETERRQ1(PETSC_ERR_ARG_OUTOFRANGE,"Trying to write a negative amount of data %D",n); 273e5c89e4eSSatish Balay if (!n) PetscFunctionReturn(0); 274e5c89e4eSSatish Balay 275e5c89e4eSSatish Balay if (type == PETSC_INT){ 276e5c89e4eSSatish Balay m *= sizeof(PetscInt32); 27741e811b7SSatish Balay #if (PETSC_SIZEOF_INT == 8) || defined(PETSC_USE_64BIT_INDICES) 278e5c89e4eSSatish Balay PetscInt *p_int = (PetscInt*)p,i; 279e5c89e4eSSatish Balay PetscInt32 *p_short; 280e5c89e4eSSatish Balay ierr = PetscMalloc(m,&pp);CHKERRQ(ierr); 281e5c89e4eSSatish Balay ptmp = (void*)pp; 282e5c89e4eSSatish Balay p_short = (PetscInt32*)pp; 283e5c89e4eSSatish Balay 284e5c89e4eSSatish Balay for (i=0; i<n; i++) { 285e5c89e4eSSatish Balay p_short[i] = (PetscInt32) p_int[i]; 286e5c89e4eSSatish Balay } 287e5c89e4eSSatish Balay istemp = PETSC_TRUE; 288e5c89e4eSSatish Balay #endif 289e5c89e4eSSatish Balay } 290e5c89e4eSSatish Balay else if (type == PETSC_SCALAR) m *= sizeof(PetscScalar); 291e5c89e4eSSatish Balay else if (type == PETSC_DOUBLE) m *= sizeof(double); 292e5c89e4eSSatish Balay else if (type == PETSC_SHORT) m *= sizeof(short); 293e5c89e4eSSatish Balay else if (type == PETSC_CHAR) m *= sizeof(char); 294e5c89e4eSSatish Balay else if (type == PETSC_ENUM) m *= sizeof(PetscEnum); 295e5c89e4eSSatish Balay else if (type == PETSC_TRUTH) m *= sizeof(PetscTruth); 296e5c89e4eSSatish Balay else if (type == PETSC_LOGICAL) m = PetscBTLength(m)*sizeof(char); 297e5c89e4eSSatish Balay else SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Unknown type"); 298e5c89e4eSSatish Balay 299e5c89e4eSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN) 300e5c89e4eSSatish Balay if (type == PETSC_INT) {ierr = PetscByteSwapInt((PetscInt32*)ptmp,n);CHKERRQ(ierr);} 301e5c89e4eSSatish Balay else if (type == PETSC_ENUM) {ierr = PetscByteSwapInt((PetscInt32*)ptmp,n);CHKERRQ(ierr);} 302e5c89e4eSSatish Balay else if (type == PETSC_TRUTH) {ierr = PetscByteSwapInt((PetscInt32*)ptmp,n);CHKERRQ(ierr);} 303e5c89e4eSSatish Balay else if (type == PETSC_SCALAR) {ierr = PetscByteSwapScalar((PetscScalar*)ptmp,n);CHKERRQ(ierr);} 304e5c89e4eSSatish Balay else if (type == PETSC_DOUBLE) {ierr = PetscByteSwapDouble((double*)ptmp,n);CHKERRQ(ierr);} 305e5c89e4eSSatish Balay else if (type == PETSC_SHORT) {ierr = PetscByteSwapShort((short*)ptmp,n);CHKERRQ(ierr);} 306e5c89e4eSSatish Balay #endif 307e5c89e4eSSatish Balay 308e5c89e4eSSatish Balay while (m) { 309e5c89e4eSSatish Balay wsize = (m < maxblock) ? m : maxblock; 310e5c89e4eSSatish Balay err = write(fd,pp,wsize); 311e5c89e4eSSatish Balay if (err < 0 && errno == EINTR) continue; 312e5c89e4eSSatish Balay if (err != wsize) SETERRQ(PETSC_ERR_FILE_WRITE,"Error writing to file."); 313e5c89e4eSSatish Balay m -= wsize; 314e5c89e4eSSatish Balay pp += wsize; 315e5c89e4eSSatish Balay } 316e5c89e4eSSatish Balay 317b659c0ceSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN) 318e5c89e4eSSatish Balay if (!istemp) { 319e5c89e4eSSatish Balay if (type == PETSC_SCALAR) {ierr = PetscByteSwapScalar((PetscScalar*)ptmp,n);CHKERRQ(ierr);} 320*b63245c5SSatish Balay else if (type == PETSC_DOUBLE) {ierr = PetscByteSwapDouble((double*)ptmp,n);CHKERRQ(ierr);} 321e5c89e4eSSatish Balay else if (type == PETSC_SHORT) {ierr = PetscByteSwapShort((short*)ptmp,n);CHKERRQ(ierr);} 322e5c89e4eSSatish Balay else if (type == PETSC_INT) {ierr = PetscByteSwapInt((PetscInt32*)ptmp,n);CHKERRQ(ierr);} 323e5c89e4eSSatish Balay else if (type == PETSC_ENUM) {ierr = PetscByteSwapInt((PetscInt32*)ptmp,n);CHKERRQ(ierr);} 324e5c89e4eSSatish Balay else if (type == PETSC_TRUTH) {ierr = PetscByteSwapInt((PetscInt32*)ptmp,n);CHKERRQ(ierr);} 325e5c89e4eSSatish Balay } 326e5c89e4eSSatish Balay #endif 327e5c89e4eSSatish Balay 32841e811b7SSatish Balay #if (PETSC_SIZEOF_INT == 8) || defined(PETSC_USE_64BIT_INDICES) 329e5c89e4eSSatish Balay if (type == PETSC_INT){ 330e5c89e4eSSatish Balay ierr = PetscFree(ptmp);CHKERRQ(ierr); 331e5c89e4eSSatish Balay } 332e5c89e4eSSatish Balay #endif 333e5c89e4eSSatish Balay PetscFunctionReturn(0); 334e5c89e4eSSatish Balay } 335e5c89e4eSSatish Balay 336e5c89e4eSSatish Balay #undef __FUNCT__ 337e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryOpen" 338e5c89e4eSSatish Balay /*@C 339e5c89e4eSSatish Balay PetscBinaryOpen - Opens a PETSc binary file. 340e5c89e4eSSatish Balay 341e5c89e4eSSatish Balay Not Collective 342e5c89e4eSSatish Balay 343e5c89e4eSSatish Balay Input Parameters: 344e5c89e4eSSatish Balay + name - filename 34545c64e65SBarry Smith - type - type of binary file, one of FILE_MODE_READ, FILE_MODE_APPEND, FILE_MODE_WRITE 346e5c89e4eSSatish Balay 347e5c89e4eSSatish Balay Output Parameter: 348e5c89e4eSSatish Balay . fd - the file 349e5c89e4eSSatish Balay 350e5c89e4eSSatish Balay Level: advanced 351e5c89e4eSSatish Balay 352e5c89e4eSSatish Balay Concepts: files^opening binary 353e5c89e4eSSatish Balay Concepts: binary files^opening 354e5c89e4eSSatish Balay 355e5c89e4eSSatish Balay Notes: Files access with PetscBinaryRead() and PetscBinaryWrite() are ALWAYS written in 356e5c89e4eSSatish Balay big-endian format. This means the file can be accessed using PetscBinaryOpen() and 357e5c89e4eSSatish Balay PetscBinaryRead() and PetscBinaryWrite() on any machine. 358e5c89e4eSSatish Balay 359e7788613SBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscFileMode, PetscViewerFileSetMode(), PetscViewerBinaryGetDescriptor() 36045c64e65SBarry Smith 361e5c89e4eSSatish Balay @*/ 36245c64e65SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscBinaryOpen(const char name[],PetscFileMode mode,int *fd) 363e5c89e4eSSatish Balay { 364e5c89e4eSSatish Balay PetscFunctionBegin; 365e5c89e4eSSatish Balay #if defined(PETSC_HAVE_O_BINARY) 36645c64e65SBarry Smith if (mode == FILE_MODE_WRITE) { 367e5c89e4eSSatish Balay if ((*fd = open(name,O_WRONLY|O_CREAT|O_TRUNC|O_BINARY,0666)) == -1) { 368e5c89e4eSSatish Balay SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot create file for writing: %s",name); 369e5c89e4eSSatish Balay } 37045c64e65SBarry Smith } else if (mode == FILE_MODE_READ) { 371e5c89e4eSSatish Balay if ((*fd = open(name,O_RDONLY|O_BINARY,0)) == -1) { 372e5c89e4eSSatish Balay SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot open file for reading: %s",name); 373e5c89e4eSSatish Balay } 37445c64e65SBarry Smith } else if (mode == FILE_MODE_APPEND) { 375e5c89e4eSSatish Balay if ((*fd = open(name,O_WRONLY|O_BINARY,0)) == -1) { 376e5c89e4eSSatish Balay SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot open file for writing: %s",name); 377e5c89e4eSSatish Balay } 378e5c89e4eSSatish Balay #else 37945c64e65SBarry Smith if (mode == FILE_MODE_WRITE) { 380e5c89e4eSSatish Balay if ((*fd = creat(name,0666)) == -1) { 381e5c89e4eSSatish Balay SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot create file for writing: %s",name); 382e5c89e4eSSatish Balay } 38345c64e65SBarry Smith } else if (mode == FILE_MODE_READ) { 384e5c89e4eSSatish Balay if ((*fd = open(name,O_RDONLY,0)) == -1) { 385e5c89e4eSSatish Balay SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot open file for reading: %s",name); 386e5c89e4eSSatish Balay } 387e5c89e4eSSatish Balay } 38845c64e65SBarry Smith else if (mode == FILE_MODE_APPEND) { 389e5c89e4eSSatish Balay if ((*fd = open(name,O_WRONLY,0)) == -1) { 390e5c89e4eSSatish Balay SETERRQ1(PETSC_ERR_FILE_OPEN,"Cannot open file for writing: %s",name); 391e5c89e4eSSatish Balay } 392e5c89e4eSSatish Balay #endif 39345c64e65SBarry Smith } else SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Unknown file mode"); 394e5c89e4eSSatish Balay PetscFunctionReturn(0); 395e5c89e4eSSatish Balay } 396e5c89e4eSSatish Balay 397e5c89e4eSSatish Balay #undef __FUNCT__ 398e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryClose" 399e30d2299SSatish Balay /*@ 400e5c89e4eSSatish Balay PetscBinaryClose - Closes a PETSc binary file. 401e5c89e4eSSatish Balay 402e5c89e4eSSatish Balay Not Collective 403e5c89e4eSSatish Balay 404e5c89e4eSSatish Balay Output Parameter: 405e5c89e4eSSatish Balay . fd - the file 406e5c89e4eSSatish Balay 407e5c89e4eSSatish Balay Level: advanced 408e5c89e4eSSatish Balay 409e5c89e4eSSatish Balay .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen() 410e5c89e4eSSatish Balay @*/ 411e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscBinaryClose(int fd) 412e5c89e4eSSatish Balay { 413e5c89e4eSSatish Balay PetscFunctionBegin; 414e5c89e4eSSatish Balay close(fd); 415e5c89e4eSSatish Balay PetscFunctionReturn(0); 416e5c89e4eSSatish Balay } 417e5c89e4eSSatish Balay 418e5c89e4eSSatish Balay 419e5c89e4eSSatish Balay #undef __FUNCT__ 420e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinarySeek" 421e30d2299SSatish Balay /*@ 422e5c89e4eSSatish Balay PetscBinarySeek - Moves the file pointer on a PETSc binary file. 423e5c89e4eSSatish Balay 424e5c89e4eSSatish Balay Not Collective 425e5c89e4eSSatish Balay 426e5c89e4eSSatish Balay Input Parameters: 427e5c89e4eSSatish Balay + fd - the file 428ff553b35SMatthew Knepley . off - number of bytes to move. Use PETSC_BINARY_INT_SIZE, PETSC_BINARY_SCALAR_SIZE, 429e5c89e4eSSatish Balay etc. in your calculation rather than sizeof() to compute byte lengths. 430ff553b35SMatthew Knepley - whence - if PETSC_BINARY_SEEK_SET then off is an absolute location in the file 431ff553b35SMatthew Knepley if PETSC_BINARY_SEEK_CUR then off is an offset from the current location 432ff553b35SMatthew Knepley if PETSC_BINARY_SEEK_END then off is an offset from the end of file 433e5c89e4eSSatish Balay 434e5c89e4eSSatish Balay Output Parameter: 435e5c89e4eSSatish Balay . offset - new offset in file 436e5c89e4eSSatish Balay 437e5c89e4eSSatish Balay Level: developer 438e5c89e4eSSatish Balay 439e5c89e4eSSatish Balay Notes: 440e5c89e4eSSatish Balay Integers are stored on the file as 32 long, regardless of whether 441e5c89e4eSSatish Balay they are stored in the machine as 32 or 64, this means the same 442e5c89e4eSSatish Balay binary file may be read on any machine. Hence you CANNOT use sizeof() 443e5c89e4eSSatish Balay to determine the offset or location. 444e5c89e4eSSatish Balay 445e5c89e4eSSatish Balay Concepts: files^binary seeking 446e5c89e4eSSatish Balay Concepts: binary files^seeking 447e5c89e4eSSatish Balay 448e5c89e4eSSatish Balay .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen() 449e5c89e4eSSatish Balay @*/ 450e5c89e4eSSatish Balay PetscErrorCode PETSC_DLLEXPORT PetscBinarySeek(int fd,off_t off,PetscBinarySeekType whence,off_t *offset) 451e5c89e4eSSatish Balay { 452e5c89e4eSSatish Balay int iwhence = 0; 453e5c89e4eSSatish Balay 454e5c89e4eSSatish Balay PetscFunctionBegin; 455e5c89e4eSSatish Balay if (whence == PETSC_BINARY_SEEK_SET) { 456e5c89e4eSSatish Balay iwhence = SEEK_SET; 457e5c89e4eSSatish Balay } else if (whence == PETSC_BINARY_SEEK_CUR) { 458e5c89e4eSSatish Balay iwhence = SEEK_CUR; 459e5c89e4eSSatish Balay } else if (whence == PETSC_BINARY_SEEK_END) { 460e5c89e4eSSatish Balay iwhence = SEEK_END; 461e5c89e4eSSatish Balay } else { 462e5c89e4eSSatish Balay SETERRQ(PETSC_ERR_ARG_OUTOFRANGE,"Unknown seek location"); 463e5c89e4eSSatish Balay } 464e5c89e4eSSatish Balay #if defined(PETSC_HAVE_LSEEK) 465e5c89e4eSSatish Balay *offset = lseek(fd,off,iwhence); 466e5c89e4eSSatish Balay #elif defined(PETSC_HAVE__LSEEK) 467e5c89e4eSSatish Balay *offset = _lseek(fd,(long)off,iwhence); 468e5c89e4eSSatish Balay #else 469e5c89e4eSSatish Balay SETERRQ(PETSC_ERR_SUP_SYS,"System does not have a way of seeking on a file"); 470e5c89e4eSSatish Balay #endif 471e5c89e4eSSatish Balay PetscFunctionReturn(0); 472e5c89e4eSSatish Balay } 473e5c89e4eSSatish Balay 474e5c89e4eSSatish Balay #undef __FUNCT__ 4751d280d73SBarry Smith #define __FUNCT__ "PetscBinarySynchronizedRead" 476e5c89e4eSSatish Balay /*@C 4771d280d73SBarry Smith PetscBinarySynchronizedRead - Reads from a binary file. 478e5c89e4eSSatish Balay 479e5c89e4eSSatish Balay Collective on MPI_Comm 480e5c89e4eSSatish Balay 481e5c89e4eSSatish Balay Input Parameters: 482e5c89e4eSSatish Balay + comm - the MPI communicator 483e5c89e4eSSatish Balay . fd - the file 484e5c89e4eSSatish Balay . n - the number of items to read 485e5c89e4eSSatish Balay - type - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR) 486e5c89e4eSSatish Balay 487e5c89e4eSSatish Balay Output Parameters: 488e5c89e4eSSatish Balay . p - the buffer 489e5c89e4eSSatish Balay 490e5c89e4eSSatish Balay Options Database Key: 491e5c89e4eSSatish Balay . -binary_longints - indicates the file was generated on a Cray vector 492e5c89e4eSSatish Balay machine (not the T3E/D) and the ints are stored as 64 bit 493e5c89e4eSSatish Balay quantities, otherwise they are stored as 32 bit 494e5c89e4eSSatish Balay 495e5c89e4eSSatish Balay Level: developer 496e5c89e4eSSatish Balay 497e5c89e4eSSatish Balay Notes: 498e5c89e4eSSatish Balay Does a PetscBinaryRead() followed by an MPI_Bcast() 499e5c89e4eSSatish Balay 5001d280d73SBarry Smith PetscBinarySynchronizedRead() uses byte swapping to work on all machines. 501e5c89e4eSSatish Balay Integers are stored on the file as 32 long, regardless of whether 502e5c89e4eSSatish Balay they are stored in the machine as 32 or 64, this means the same 503e5c89e4eSSatish Balay binary file may be read on any machine. 504e5c89e4eSSatish Balay 505e5c89e4eSSatish Balay Concepts: files^synchronized reading of binary files 506e5c89e4eSSatish Balay Concepts: binary files^reading, synchronized 507e5c89e4eSSatish Balay 508e5c89e4eSSatish Balay .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscBinaryRead() 509e5c89e4eSSatish Balay @*/ 5101d280d73SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscBinarySynchronizedRead(MPI_Comm comm,int fd,void *p,PetscInt n,PetscDataType type) 511e5c89e4eSSatish Balay { 512e5c89e4eSSatish Balay PetscErrorCode ierr; 513e5c89e4eSSatish Balay PetscMPIInt rank; 514e5c89e4eSSatish Balay MPI_Datatype mtype; 515e5c89e4eSSatish Balay 516e5c89e4eSSatish Balay PetscFunctionBegin; 517e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 518e5c89e4eSSatish Balay if (!rank) { 519e5c89e4eSSatish Balay ierr = PetscBinaryRead(fd,p,n,type);CHKERRQ(ierr); 520e5c89e4eSSatish Balay } 521e5c89e4eSSatish Balay ierr = PetscDataTypeToMPIDataType(type,&mtype);CHKERRQ(ierr); 522e5c89e4eSSatish Balay ierr = MPI_Bcast(p,n,mtype,0,comm);CHKERRQ(ierr); 523e5c89e4eSSatish Balay PetscFunctionReturn(0); 524e5c89e4eSSatish Balay } 525e5c89e4eSSatish Balay 526e5c89e4eSSatish Balay #undef __FUNCT__ 5271d280d73SBarry Smith #define __FUNCT__ "PetscBinarySynchronizedWrite" 528e5c89e4eSSatish Balay /*@C 5291d280d73SBarry Smith PetscBinarySynchronizedWrite - writes to a binary file. 530e5c89e4eSSatish Balay 531e5c89e4eSSatish Balay Collective on MPI_Comm 532e5c89e4eSSatish Balay 533e5c89e4eSSatish Balay Input Parameters: 534e5c89e4eSSatish Balay + comm - the MPI communicator 535e5c89e4eSSatish Balay . fd - the file 536e5c89e4eSSatish Balay . n - the number of items to write 537e5c89e4eSSatish Balay . p - the buffer 538e5c89e4eSSatish Balay . istemp - the buffer may be changed 539e5c89e4eSSatish Balay - type - the type of items to write (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR) 540e5c89e4eSSatish Balay 541e5c89e4eSSatish Balay Level: developer 542e5c89e4eSSatish Balay 543e5c89e4eSSatish Balay Notes: 544e5c89e4eSSatish Balay Process 0 does a PetscBinaryWrite() 545e5c89e4eSSatish Balay 5461d280d73SBarry Smith PetscBinarySynchronizedWrite() uses byte swapping to work on all machines. 547e5c89e4eSSatish Balay Integers are stored on the file as 32 long, regardless of whether 548e5c89e4eSSatish Balay they are stored in the machine as 32 or 64, this means the same 549e5c89e4eSSatish Balay binary file may be read on any machine. 550e5c89e4eSSatish Balay 5511d280d73SBarry Smith WARNING: This is NOT like PetscSynchronizedFPrintf()! This routine ignores calls on all but process 0, 5521d280d73SBarry Smith while PetscSynchronizedFPrintf() has all processes print their strings in order. 5531d280d73SBarry Smith 554e5c89e4eSSatish Balay Concepts: files^synchronized writing of binary files 555e5c89e4eSSatish Balay Concepts: binary files^reading, synchronized 556e5c89e4eSSatish Balay 557e5c89e4eSSatish Balay .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscBinaryRead() 558e5c89e4eSSatish Balay @*/ 5591d280d73SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscBinarySynchronizedWrite(MPI_Comm comm,int fd,void *p,PetscInt n,PetscDataType type,PetscTruth istemp) 560e5c89e4eSSatish Balay { 561e5c89e4eSSatish Balay PetscErrorCode ierr; 562e5c89e4eSSatish Balay PetscMPIInt rank; 563e5c89e4eSSatish Balay 564e5c89e4eSSatish Balay PetscFunctionBegin; 565e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 566e5c89e4eSSatish Balay if (!rank) { 567e5c89e4eSSatish Balay ierr = PetscBinaryWrite(fd,p,n,type,istemp);CHKERRQ(ierr); 568e5c89e4eSSatish Balay } 569e5c89e4eSSatish Balay PetscFunctionReturn(0); 570e5c89e4eSSatish Balay } 571e5c89e4eSSatish Balay 572e5c89e4eSSatish Balay #undef __FUNCT__ 5731d280d73SBarry Smith #define __FUNCT__ "PetscBinarySynchronizedSeek" 574e5c89e4eSSatish Balay /*@C 5751d280d73SBarry Smith PetscBinarySynchronizedSeek - Moves the file pointer on a PETSc binary file. 576e5c89e4eSSatish Balay 577e5c89e4eSSatish Balay 578e5c89e4eSSatish Balay Input Parameters: 579e5c89e4eSSatish Balay + fd - the file 580e5c89e4eSSatish Balay . whence - if PETSC_BINARY_SEEK_SET then size is an absolute location in the file 581e5c89e4eSSatish Balay if PETSC_BINARY_SEEK_CUR then size is offset from current location 582e5c89e4eSSatish Balay if PETSC_BINARY_SEEK_END then size is offset from end of file 583e5c89e4eSSatish Balay - off - number of bytes to move. Use PETSC_BINARY_INT_SIZE, PETSC_BINARY_SCALAR_SIZE, 584e5c89e4eSSatish Balay etc. in your calculation rather than sizeof() to compute byte lengths. 585e5c89e4eSSatish Balay 586e5c89e4eSSatish Balay Output Parameter: 587e5c89e4eSSatish Balay . offset - new offset in file 588e5c89e4eSSatish Balay 589e5c89e4eSSatish Balay Level: developer 590e5c89e4eSSatish Balay 591e5c89e4eSSatish Balay Notes: 592e5c89e4eSSatish Balay Integers are stored on the file as 32 long, regardless of whether 593e5c89e4eSSatish Balay they are stored in the machine as 32 or 64, this means the same 594e5c89e4eSSatish Balay binary file may be read on any machine. Hence you CANNOT use sizeof() 595e5c89e4eSSatish Balay to determine the offset or location. 596e5c89e4eSSatish Balay 597e5c89e4eSSatish Balay Concepts: binary files^seeking 598e5c89e4eSSatish Balay Concepts: files^seeking in binary 599e5c89e4eSSatish Balay 600e5c89e4eSSatish Balay .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen() 601e5c89e4eSSatish Balay @*/ 6021d280d73SBarry Smith PetscErrorCode PETSC_DLLEXPORT PetscBinarySynchronizedSeek(MPI_Comm comm,int fd,off_t off,PetscBinarySeekType whence,off_t *offset) 603e5c89e4eSSatish Balay { 604e5c89e4eSSatish Balay PetscErrorCode ierr; 605e5c89e4eSSatish Balay PetscMPIInt rank; 606e5c89e4eSSatish Balay 607e5c89e4eSSatish Balay PetscFunctionBegin; 608e5c89e4eSSatish Balay ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr); 609e5c89e4eSSatish Balay if (!rank) { 610e5c89e4eSSatish Balay ierr = PetscBinarySeek(fd,off,whence,offset);CHKERRQ(ierr); 611e5c89e4eSSatish Balay } 612e5c89e4eSSatish Balay PetscFunctionReturn(0); 613e5c89e4eSSatish Balay } 614e5c89e4eSSatish Balay 615