xref: /petsc/src/sys/fileio/sysio.c (revision 98da9c48166cffcfbff9057089fde236b0e4c1a6)
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 
176de02169SBarry Smith /* --------------------------------------------------------- */
18e5c89e4eSSatish Balay #undef __FUNCT__
196de02169SBarry Smith #define __FUNCT__ "PetscByteSwapEnum"
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);
330b20345dSBarry Smith     for (i=0; i<(PetscInt)sizeof(PetscEnum); i++) {
346de02169SBarry Smith       ptr2[i] = ptr1[sizeof(PetscEnum)-1-i];
35e5c89e4eSSatish Balay     }
36e0890e22SSatish Balay     for (i=0; i<(PetscInt)sizeof(PetscEnum); i++) {
37e0890e22SSatish Balay       ptr1[i] = ptr2[i];
38e0890e22SSatish Balay     }
39e5c89e4eSSatish Balay   }
40e5c89e4eSSatish Balay   PetscFunctionReturn(0);
41e5c89e4eSSatish Balay }
426de02169SBarry Smith 
436de02169SBarry Smith #undef __FUNCT__
44acfcf0e5SJed Brown #define __FUNCT__ "PetscByteSwapBool"
456de02169SBarry Smith /*
46acfcf0e5SJed Brown   PetscByteSwapBool - Swap bytes in a  PETSc Bool
476de02169SBarry Smith 
486de02169SBarry Smith */
497087cfbeSBarry Smith PetscErrorCode  PetscByteSwapBool(PetscBool *buff,PetscInt n)
506de02169SBarry Smith {
516de02169SBarry Smith   PetscInt    i,j;
52ace3abfcSBarry Smith   PetscBool   tmp = PETSC_FALSE;
53e0890e22SSatish Balay   char        *ptr1,*ptr2 = (char*)&tmp;
546de02169SBarry Smith 
556de02169SBarry Smith   PetscFunctionBegin;
566de02169SBarry Smith   for (j=0; j<n; j++) {
576de02169SBarry Smith     ptr1 = (char*)(buff + j);
58ace3abfcSBarry Smith     for (i=0; i<(PetscInt)sizeof(PetscBool); i++) {
59ace3abfcSBarry Smith       ptr2[i] = ptr1[sizeof(PetscBool)-1-i];
606de02169SBarry Smith     }
61ace3abfcSBarry Smith     for (i=0; i<(PetscInt)sizeof(PetscBool); i++) {
62e0890e22SSatish Balay       ptr1[i] = ptr2[i];
63e0890e22SSatish Balay     }
646de02169SBarry Smith   }
656de02169SBarry Smith   PetscFunctionReturn(0);
666de02169SBarry Smith }
676de02169SBarry Smith 
68e5c89e4eSSatish Balay #undef __FUNCT__
69bd1d2e58SBarry Smith #define __FUNCT__ "PetscByteSwapInt"
70bd1d2e58SBarry Smith /*
716de02169SBarry Smith   PetscByteSwapInt - Swap bytes in a  PETSc integer (which may be 32 or 64 bits)
72bd1d2e58SBarry Smith 
73bd1d2e58SBarry Smith */
747087cfbeSBarry Smith PetscErrorCode  PetscByteSwapInt(PetscInt *buff,PetscInt n)
75bd1d2e58SBarry Smith {
76bd1d2e58SBarry Smith   PetscInt  i,j,tmp = 0;
77e0890e22SSatish Balay   char       *ptr1,*ptr2 = (char*)&tmp;
78bd1d2e58SBarry Smith 
79bd1d2e58SBarry Smith   PetscFunctionBegin;
80bd1d2e58SBarry Smith   for (j=0; j<n; j++) {
81bd1d2e58SBarry Smith     ptr1 = (char*)(buff + j);
820b20345dSBarry Smith     for (i=0; i<(PetscInt)sizeof(PetscInt); i++) {
83bd1d2e58SBarry Smith       ptr2[i] = ptr1[sizeof(PetscInt)-1-i];
84bd1d2e58SBarry Smith     }
85e0890e22SSatish Balay     for (i=0; i<(PetscInt)sizeof(PetscInt); i++) {
86e0890e22SSatish Balay       ptr1[i] = ptr2[i];
87e0890e22SSatish Balay     }
88bd1d2e58SBarry Smith   }
89bd1d2e58SBarry Smith   PetscFunctionReturn(0);
90bd1d2e58SBarry Smith }
91bd1d2e58SBarry Smith /* --------------------------------------------------------- */
92bd1d2e58SBarry Smith #undef __FUNCT__
93e5c89e4eSSatish Balay #define __FUNCT__ "PetscByteSwapShort"
94e5c89e4eSSatish Balay /*
95e5c89e4eSSatish Balay   PetscByteSwapShort - Swap bytes in a short
96e5c89e4eSSatish Balay */
977087cfbeSBarry Smith PetscErrorCode  PetscByteSwapShort(short *buff,PetscInt n)
98e5c89e4eSSatish Balay {
99e5c89e4eSSatish Balay   PetscInt   i,j;
100e5c89e4eSSatish Balay   short      tmp;
101e5c89e4eSSatish Balay   char       *ptr1,*ptr2 = (char*)&tmp;
102e5c89e4eSSatish Balay 
103e5c89e4eSSatish Balay   PetscFunctionBegin;
104e5c89e4eSSatish Balay   for (j=0; j<n; j++) {
105e5c89e4eSSatish Balay     ptr1 = (char*)(buff + j);
1060b20345dSBarry Smith     for (i=0; i<(PetscInt) sizeof(short); i++) {
107f348e1baSSatish Balay       ptr2[i] = ptr1[sizeof(short)-1-i];
108e5c89e4eSSatish Balay     }
109e0890e22SSatish Balay     for (i=0; i<(PetscInt) sizeof(short); i++) {
110e0890e22SSatish Balay       ptr1[i] = ptr2[i];
111e0890e22SSatish Balay     }
112e5c89e4eSSatish Balay   }
113e5c89e4eSSatish Balay   PetscFunctionReturn(0);
114e5c89e4eSSatish Balay }
115e5c89e4eSSatish Balay /* --------------------------------------------------------- */
116e5c89e4eSSatish Balay #undef __FUNCT__
117e5c89e4eSSatish Balay #define __FUNCT__ "PetscByteSwapScalar"
118e5c89e4eSSatish Balay /*
119e5c89e4eSSatish Balay   PetscByteSwapScalar - Swap bytes in a double
120e5c89e4eSSatish Balay   Complex is dealt with as if array of double twice as long.
121e5c89e4eSSatish Balay */
1227087cfbeSBarry Smith PetscErrorCode  PetscByteSwapScalar(PetscScalar *buff,PetscInt n)
123e5c89e4eSSatish Balay {
124e5c89e4eSSatish Balay   PetscInt  i,j;
125e5c89e4eSSatish Balay   PetscReal tmp,*buff1 = (PetscReal*)buff;
126e5c89e4eSSatish Balay   char      *ptr1,*ptr2 = (char*)&tmp;
127e5c89e4eSSatish Balay 
128e5c89e4eSSatish Balay   PetscFunctionBegin;
129e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX)
130e5c89e4eSSatish Balay   n *= 2;
131e5c89e4eSSatish Balay #endif
132e5c89e4eSSatish Balay   for (j=0; j<n; j++) {
133e5c89e4eSSatish Balay     ptr1 = (char*)(buff1 + j);
1340b20345dSBarry Smith     for (i=0; i<(PetscInt) sizeof(PetscReal); i++) {
135e5c89e4eSSatish Balay       ptr2[i] = ptr1[sizeof(PetscReal)-1-i];
136e5c89e4eSSatish Balay     }
137e0890e22SSatish Balay     for (i=0; i<(PetscInt) sizeof(PetscReal); i++) {
138e0890e22SSatish Balay       ptr1[i] = ptr2[i];
139e0890e22SSatish Balay     }
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 */
1497087cfbeSBarry Smith PetscErrorCode  PetscByteSwapDouble(double *buff,PetscInt n)
150e5c89e4eSSatish Balay {
151e5c89e4eSSatish Balay   PetscInt i,j;
152e5c89e4eSSatish Balay   double   tmp,*buff1 = (double*)buff;
153e5c89e4eSSatish Balay   char     *ptr1,*ptr2 = (char*)&tmp;
154e5c89e4eSSatish Balay 
155e5c89e4eSSatish Balay   PetscFunctionBegin;
156e5c89e4eSSatish Balay   for (j=0; j<n; j++) {
157e5c89e4eSSatish Balay     ptr1 = (char*)(buff1 + j);
1580b20345dSBarry Smith     for (i=0; i<(PetscInt) sizeof(double); i++) {
159e5c89e4eSSatish Balay       ptr2[i] = ptr1[sizeof(double)-1-i];
160e5c89e4eSSatish Balay     }
161e0890e22SSatish Balay     for (i=0; i<(PetscInt) sizeof(double); i++) {
162e0890e22SSatish Balay       ptr1[i] = ptr2[i];
163e0890e22SSatish Balay     }
164e5c89e4eSSatish Balay   }
165e5c89e4eSSatish Balay   PetscFunctionReturn(0);
166e5c89e4eSSatish Balay }
167e39fd77fSBarry Smith 
168e39fd77fSBarry Smith #undef __FUNCT__
169e95bf02fSSatish Balay #define __FUNCT__ "PetscByteSwapFloat"
170e95bf02fSSatish Balay /*
171e95bf02fSSatish Balay   PetscByteSwapFloat - Swap bytes in a float
172e95bf02fSSatish Balay */
173e95bf02fSSatish Balay PetscErrorCode PetscByteSwapFloat(float *buff,PetscInt n)
174e95bf02fSSatish Balay {
175e95bf02fSSatish Balay   PetscInt i,j;
176e95bf02fSSatish Balay   float   tmp,*buff1 = (float*)buff;
177e95bf02fSSatish Balay   char     *ptr1,*ptr2 = (char*)&tmp;
178e95bf02fSSatish Balay 
179e95bf02fSSatish Balay   PetscFunctionBegin;
180e95bf02fSSatish Balay   for (j=0; j<n; j++) {
181e95bf02fSSatish Balay     ptr1 = (char*)(buff1 + j);
182e95bf02fSSatish Balay     for (i=0; i<(PetscInt) sizeof(float); i++) {
183e95bf02fSSatish Balay       ptr2[i] = ptr1[sizeof(float)-1-i];
184e95bf02fSSatish Balay     }
185e95bf02fSSatish Balay     for (i=0; i<(PetscInt) sizeof(float); i++) {
186e95bf02fSSatish Balay       ptr1[i] = ptr2[i];
187e95bf02fSSatish Balay     }
188e95bf02fSSatish Balay   }
189e95bf02fSSatish Balay   PetscFunctionReturn(0);
190e95bf02fSSatish Balay }
191e95bf02fSSatish Balay 
192e95bf02fSSatish Balay #undef __FUNCT__
193e39fd77fSBarry Smith #define __FUNCT__ "PetscByteSwap"
194e39fd77fSBarry Smith PetscErrorCode PetscByteSwap(void *data,PetscDataType pdtype,PetscInt count)
195e39fd77fSBarry Smith {
196e39fd77fSBarry Smith   PetscErrorCode ierr;
197e39fd77fSBarry Smith 
198e39fd77fSBarry Smith   PetscFunctionBegin;
199e39fd77fSBarry Smith   if      (pdtype == PETSC_INT)    {ierr = PetscByteSwapInt((PetscInt*)data,count);CHKERRQ(ierr);}
200e39fd77fSBarry Smith   else if (pdtype == PETSC_ENUM)   {ierr = PetscByteSwapEnum((PetscEnum*)data,count);CHKERRQ(ierr);}
201acfcf0e5SJed Brown   else if (pdtype == PETSC_BOOL)   {ierr = PetscByteSwapBool((PetscBool*)data,count);CHKERRQ(ierr);}
202e39fd77fSBarry Smith   else if (pdtype == PETSC_SCALAR) {ierr = PetscByteSwapScalar((PetscScalar*)data,count);CHKERRQ(ierr);}
203e39fd77fSBarry Smith   else if (pdtype == PETSC_DOUBLE) {ierr = PetscByteSwapDouble((double*)data,count);CHKERRQ(ierr);}
204e95bf02fSSatish Balay   else if (pdtype == PETSC_FLOAT) {ierr = PetscByteSwapFloat((float*)data,count);CHKERRQ(ierr);}
205e39fd77fSBarry Smith   else if (pdtype == PETSC_SHORT)  {ierr = PetscByteSwapShort((short*)data,count);CHKERRQ(ierr);}
206e39fd77fSBarry Smith   PetscFunctionReturn(0);
207e39fd77fSBarry Smith }
208e39fd77fSBarry Smith 
209e5c89e4eSSatish Balay /* --------------------------------------------------------- */
210e5c89e4eSSatish Balay #undef __FUNCT__
211e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryRead"
212e30d2299SSatish Balay /*@
213e5c89e4eSSatish Balay    PetscBinaryRead - Reads from a binary file.
214e5c89e4eSSatish Balay 
215e5c89e4eSSatish Balay    Not Collective
216e5c89e4eSSatish Balay 
217e5c89e4eSSatish Balay    Input Parameters:
218e5c89e4eSSatish Balay +  fd - the file
219e5c89e4eSSatish Balay .  n  - the number of items to read
220e5c89e4eSSatish Balay -  type - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR)
221e5c89e4eSSatish Balay 
222e5c89e4eSSatish Balay    Output Parameters:
223e5c89e4eSSatish Balay .  p - the buffer
224e5c89e4eSSatish Balay 
225e5c89e4eSSatish Balay 
226e5c89e4eSSatish Balay 
227e5c89e4eSSatish Balay    Level: developer
228e5c89e4eSSatish Balay 
229e5c89e4eSSatish Balay    Notes:
230e5c89e4eSSatish Balay    PetscBinaryRead() uses byte swapping to work on all machines; the files
231e5c89e4eSSatish Balay    are written to file ALWAYS using big-endian ordering. On small-endian machines the numbers
232e5c89e4eSSatish Balay    are converted to the small-endian format when they are read in from the file.
233e2e64c6bSBarry Smith    When PETSc is ./configure with --with-64bit-indices the integers are written to the
23454f21887SBarry Smith    file as 64 bit integers, this means they can only be read back in when the option --with-64bit-indices
23554f21887SBarry Smith    is used.
236e5c89e4eSSatish Balay 
237e5c89e4eSSatish Balay    Concepts: files^reading binary
238e5c89e4eSSatish Balay    Concepts: binary files^reading
239e5c89e4eSSatish Balay 
2404ebed01fSBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscViewerBinaryGetDescriptor(), PetscBinarySynchronizedWrite(),
2414ebed01fSBarry Smith           PetscBinarySynchronizedRead(), PetscBinarySynchronizedSeek()
242e5c89e4eSSatish Balay @*/
2437087cfbeSBarry Smith PetscErrorCode  PetscBinaryRead(int fd,void *p,PetscInt n,PetscDataType type)
244e5c89e4eSSatish Balay {
245e5c89e4eSSatish Balay   int               wsize,err;
246e5c89e4eSSatish Balay   size_t            m = (size_t) n,maxblock = 65536;
247e5c89e4eSSatish Balay   char              *pp = (char*)p;
2487a881295SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
2497a881295SBarry Smith   double            *ppp;
2507a881295SBarry Smith #endif
2517a881295SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) || defined(PETSC_USE_REAL___FLOAT128)
2526de02169SBarry Smith   PetscErrorCode    ierr;
2537a881295SBarry Smith #endif
2547a881295SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
255e5c89e4eSSatish Balay   void              *ptmp = p;
256e5c89e4eSSatish Balay #endif
2572d53ad75SBarry Smith   char              fname[64];
2582d53ad75SBarry Smith   PetscBool         functionload = PETSC_FALSE;
259e5c89e4eSSatish Balay 
260e5c89e4eSSatish Balay   PetscFunctionBegin;
2612d53ad75SBarry Smith   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to write a negative amount of data %D",n);
262e5c89e4eSSatish Balay   if (!n) PetscFunctionReturn(0);
263e5c89e4eSSatish Balay 
2642d53ad75SBarry Smith   if (type == PETSC_FUNCTION) {
2652d53ad75SBarry Smith     functionload = PETSC_TRUE;
2662d53ad75SBarry Smith     m    = 64;
2672d53ad75SBarry Smith     type = PETSC_CHAR;
2682d53ad75SBarry Smith     pp   = (char*)fname;
2692d53ad75SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
2702d53ad75SBarry Smith     ptmp = (void*)fname;
2712d53ad75SBarry Smith #endif
2722d53ad75SBarry Smith   }
2732d53ad75SBarry Smith 
2746de02169SBarry Smith   if (type == PETSC_INT)          m *= sizeof(PetscInt);
275e5c89e4eSSatish Balay   else if (type == PETSC_SCALAR)  m *= sizeof(PetscScalar);
276e5c89e4eSSatish Balay   else if (type == PETSC_DOUBLE)  m *= sizeof(double);
277e95bf02fSSatish Balay   else if (type == PETSC_FLOAT)   m *= sizeof(float);
278e5c89e4eSSatish Balay   else if (type == PETSC_SHORT)   m *= sizeof(short);
279e5c89e4eSSatish Balay   else if (type == PETSC_CHAR)    m *= sizeof(char);
280e5c89e4eSSatish Balay   else if (type == PETSC_ENUM)    m *= sizeof(PetscEnum);
281ace3abfcSBarry Smith   else if (type == PETSC_BOOL)   m *= sizeof(PetscBool);
2829f7b6320SBarry Smith   else if (type == PETSC_BIT_LOGICAL) m  = PetscBTLength(m)*sizeof(char);
283e32f2f54SBarry Smith   else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown type");
284e5c89e4eSSatish Balay 
2857a881295SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
2867a881295SBarry Smith   /* If using __float128 precision we still read in doubles from file */
2877a881295SBarry Smith   if (type == PETSC_SCALAR) {
2887a881295SBarry Smith     m    = m/2;
2897a881295SBarry Smith     ierr = PetscMalloc(n*sizeof(double),&ppp);CHKERRQ(ierr);
2907a881295SBarry Smith     pp   = (char*)ppp;
2917a881295SBarry Smith   }
2927a881295SBarry Smith #endif
2937a881295SBarry Smith 
294e5c89e4eSSatish Balay   while (m) {
295e5c89e4eSSatish Balay     wsize = (m < maxblock) ? m : maxblock;
296e5c89e4eSSatish Balay     err = read(fd,pp,wsize);
297e5c89e4eSSatish Balay     if (err < 0 && errno == EINTR) continue;
298e32f2f54SBarry Smith     if (!err && wsize > 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"Read past end of file");
299e32f2f54SBarry Smith     if (err < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"Error reading from file, errno %d",errno);
300e5c89e4eSSatish Balay     m  -= err;
301e5c89e4eSSatish Balay     pp += err;
302e5c89e4eSSatish Balay   }
3037a881295SBarry Smith 
3047a881295SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
3057a881295SBarry Smith   if (type == PETSC_SCALAR) {
3067a881295SBarry Smith     PetscScalar *pv = (PetscScalar*) p;
3077a881295SBarry Smith     PetscInt    i;
3087a881295SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
3097a881295SBarry Smith     ierr = PetscByteSwapDouble(ppp,n);CHKERRQ(ierr);
3107a881295SBarry Smith #endif
3117a881295SBarry Smith     for (i=0; i<n; i++) {
3127a881295SBarry Smith       pv[i] = ppp[i];
3137a881295SBarry Smith     }
3147a881295SBarry Smith     ierr = PetscFree(ppp);CHKERRQ(ierr);
3157a881295SBarry Smith     PetscFunctionReturn(0);
3167a881295SBarry Smith   }
3177a881295SBarry Smith #endif
3187a881295SBarry Smith 
319e5c89e4eSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN)
320e39fd77fSBarry Smith   ierr = PetscByteSwap(ptmp,type,n);CHKERRQ(ierr);
321e5c89e4eSSatish Balay #endif
322e5c89e4eSSatish Balay 
3232d53ad75SBarry Smith   if (functionload) {
3242d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
3252d53ad75SBarry Smith     ierr = PetscDLSym(PETSC_NULL,fname,(void**)p);CHKERRQ(ierr);
3262d53ad75SBarry Smith #else
3272d53ad75SBarry Smith     *(void**)p = PETSC_NULL;
3282d53ad75SBarry Smith #endif
3292d53ad75SBarry Smith   }
3302d53ad75SBarry Smith 
331e5c89e4eSSatish Balay   PetscFunctionReturn(0);
332e5c89e4eSSatish Balay }
333e5c89e4eSSatish Balay /* --------------------------------------------------------- */
334e5c89e4eSSatish Balay #undef __FUNCT__
335e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryWrite"
336e30d2299SSatish Balay /*@
337e5c89e4eSSatish Balay    PetscBinaryWrite - Writes to a binary file.
338e5c89e4eSSatish Balay 
339e5c89e4eSSatish Balay    Not Collective
340e5c89e4eSSatish Balay 
341e5c89e4eSSatish Balay    Input Parameters:
342e5c89e4eSSatish Balay +  fd     - the file
343e5c89e4eSSatish Balay .  p      - the buffer
344e5c89e4eSSatish Balay .  n      - the number of items to write
345e5c89e4eSSatish Balay .  type   - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR)
346e5c89e4eSSatish Balay -  istemp - PETSC_FALSE if buffer data should be preserved, PETSC_TRUE otherwise.
347e5c89e4eSSatish Balay 
348e5c89e4eSSatish Balay    Level: advanced
349e5c89e4eSSatish Balay 
350e5c89e4eSSatish Balay    Notes:
351e5c89e4eSSatish Balay    PetscBinaryWrite() uses byte swapping to work on all machines; the files
352e5c89e4eSSatish Balay    are written using big-endian ordering to the file. On small-endian machines the numbers
353e5c89e4eSSatish Balay    are converted to the big-endian format when they are written to disk.
354e2e64c6bSBarry Smith    When PETSc is ./configure with --with-64bit-indices the integers are written to the
35554f21887SBarry Smith    file as 64 bit integers, this means they can only be read back in when the option --with-64bit-indices
35654f21887SBarry Smith    is used.
357e5c89e4eSSatish Balay 
358e5c89e4eSSatish Balay    The Buffer p should be read-write buffer, and not static data.
359e5c89e4eSSatish Balay    This way, byte-swapping is done in-place, and then the buffer is
360e5c89e4eSSatish Balay    written to the file.
361e5c89e4eSSatish Balay 
362e5c89e4eSSatish Balay    This routine restores the original contents of the buffer, after
363e5c89e4eSSatish Balay    it is written to the file. This is done by byte-swapping in-place
364e5c89e4eSSatish Balay    the second time. If the flag istemp is set to PETSC_TRUE, the second
365e5c89e4eSSatish Balay    byte-swapping operation is not done, thus saving some computation,
366e5f36e38SBarry Smith    but the buffer is left corrupted.
367e5c89e4eSSatish Balay 
368300a7f5bSBarry Smith    Because byte-swapping may be done on the values in data it cannot be declared const
369300a7f5bSBarry Smith 
370e5c89e4eSSatish Balay    Concepts: files^writing binary
371e5c89e4eSSatish Balay    Concepts: binary files^writing
372e5c89e4eSSatish Balay 
3734ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryOpen(), PetscBinaryClose(), PetscViewerBinaryGetDescriptor(), PetscBinarySynchronizedWrite(),
3744ebed01fSBarry Smith           PetscBinarySynchronizedRead(), PetscBinarySynchronizedSeek()
375e5c89e4eSSatish Balay @*/
3767087cfbeSBarry Smith PetscErrorCode  PetscBinaryWrite(int fd,void *p,PetscInt n,PetscDataType type,PetscBool  istemp)
377e5c89e4eSSatish Balay {
378e5c89e4eSSatish Balay   char           *pp = (char*)p;
379e5c89e4eSSatish Balay   int            err,wsize;
380e5c89e4eSSatish Balay   size_t         m = (size_t)n,maxblock=65536;
3816de02169SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
382e5c89e4eSSatish Balay   PetscErrorCode ierr;
383e5c89e4eSSatish Balay   void           *ptmp = p;
384e5c89e4eSSatish Balay #endif
3852d53ad75SBarry Smith   char           fname[64];
386e5c89e4eSSatish Balay 
387e5c89e4eSSatish Balay   PetscFunctionBegin;
388e32f2f54SBarry Smith   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to write a negative amount of data %D",n);
389e5c89e4eSSatish Balay   if (!n) PetscFunctionReturn(0);
390e5c89e4eSSatish Balay 
3912d53ad75SBarry Smith   if (type == PETSC_FUNCTION) {
3922d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
3932d53ad75SBarry Smith     const char *fnametmp;
3942d53ad75SBarry Smith 
3952d53ad75SBarry Smith     if (n > 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Can only binary view a single function at a time");
3962d53ad75SBarry Smith     ierr = PetscFPTFind(p,&fnametmp);CHKERRQ(ierr);
3972d53ad75SBarry Smith     ierr = PetscStrncpy(fname,fnametmp,64);CHKERRQ(ierr);
3982d53ad75SBarry Smith #else
3992d53ad75SBarry Smith     ierr = PetscStrncpy(fname,"",64);CHKERRQ(ierr);
4002d53ad75SBarry Smith #endif
4012d53ad75SBarry Smith     m    = 64;
4022d53ad75SBarry Smith     type = PETSC_CHAR;
4032d53ad75SBarry Smith     pp   = (char*)fname;
4042d53ad75SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
4052d53ad75SBarry Smith     ptmp = (void*)fname;
4062d53ad75SBarry Smith #endif
4072d53ad75SBarry Smith   }
4082d53ad75SBarry Smith 
4096de02169SBarry Smith   if (type == PETSC_INT)          m *= sizeof(PetscInt);
410e5c89e4eSSatish Balay   else if (type == PETSC_SCALAR)  m *= sizeof(PetscScalar);
411e5c89e4eSSatish Balay   else if (type == PETSC_DOUBLE)  m *= sizeof(double);
412e95bf02fSSatish Balay   else if (type == PETSC_FLOAT)   m *= sizeof(float);
413e5c89e4eSSatish Balay   else if (type == PETSC_SHORT)   m *= sizeof(short);
414e5c89e4eSSatish Balay   else if (type == PETSC_CHAR)    m *= sizeof(char);
415e5c89e4eSSatish Balay   else if (type == PETSC_ENUM)    m *= sizeof(PetscEnum);
416ace3abfcSBarry Smith   else if (type == PETSC_BOOL)   m *= sizeof(PetscBool);
4179f7b6320SBarry Smith   else if (type == PETSC_BIT_LOGICAL) m = PetscBTLength(m)*sizeof(char);
418e32f2f54SBarry Smith   else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown type");
419e5c89e4eSSatish Balay 
420e5c89e4eSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN)
421e39fd77fSBarry Smith   ierr = PetscByteSwap(ptmp,type,n);CHKERRQ(ierr);
422e5c89e4eSSatish Balay #endif
423e5c89e4eSSatish Balay 
424e5c89e4eSSatish Balay   while (m) {
425e5c89e4eSSatish Balay     wsize = (m < maxblock) ? m : maxblock;
426e5c89e4eSSatish Balay     err = write(fd,pp,wsize);
427e5c89e4eSSatish Balay     if (err < 0 && errno == EINTR) continue;
428e32f2f54SBarry Smith     if (err != wsize) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_WRITE,"Error writing to file.");
429e5c89e4eSSatish Balay     m -= wsize;
430e5c89e4eSSatish Balay     pp += wsize;
431e5c89e4eSSatish Balay   }
432e5c89e4eSSatish Balay 
433b659c0ceSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN)
434e5c89e4eSSatish Balay   if (!istemp) {
435e39fd77fSBarry Smith     ierr = PetscByteSwap(ptmp,type,n);CHKERRQ(ierr);
436e5c89e4eSSatish Balay   }
437e5c89e4eSSatish Balay #endif
438e5c89e4eSSatish Balay   PetscFunctionReturn(0);
439e5c89e4eSSatish Balay }
440e5c89e4eSSatish Balay 
441e5c89e4eSSatish Balay #undef __FUNCT__
442e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryOpen"
443e5c89e4eSSatish Balay /*@C
444e5c89e4eSSatish Balay    PetscBinaryOpen - Opens a PETSc binary file.
445e5c89e4eSSatish Balay 
446e5c89e4eSSatish Balay    Not Collective
447e5c89e4eSSatish Balay 
448e5c89e4eSSatish Balay    Input Parameters:
449e5c89e4eSSatish Balay +  name - filename
45045c64e65SBarry Smith -  type - type of binary file, one of FILE_MODE_READ, FILE_MODE_APPEND, FILE_MODE_WRITE
451e5c89e4eSSatish Balay 
452e5c89e4eSSatish Balay    Output Parameter:
453e5c89e4eSSatish Balay .  fd - the file
454e5c89e4eSSatish Balay 
455e5c89e4eSSatish Balay    Level: advanced
456e5c89e4eSSatish Balay 
457e5c89e4eSSatish Balay   Concepts: files^opening binary
458e5c89e4eSSatish Balay   Concepts: binary files^opening
459e5c89e4eSSatish Balay 
460e5c89e4eSSatish Balay    Notes: Files access with PetscBinaryRead() and PetscBinaryWrite() are ALWAYS written in
461e5c89e4eSSatish Balay    big-endian format. This means the file can be accessed using PetscBinaryOpen() and
462e5c89e4eSSatish Balay    PetscBinaryRead() and PetscBinaryWrite() on any machine.
463e5c89e4eSSatish Balay 
4644ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscFileMode, PetscViewerFileSetMode(), PetscViewerBinaryGetDescriptor(),
4654ebed01fSBarry Smith           PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(), PetscBinarySynchronizedSeek()
46645c64e65SBarry Smith 
467e5c89e4eSSatish Balay @*/
4687087cfbeSBarry Smith PetscErrorCode  PetscBinaryOpen(const char name[],PetscFileMode mode,int *fd)
469e5c89e4eSSatish Balay {
470e5c89e4eSSatish Balay   PetscFunctionBegin;
471e5c89e4eSSatish Balay #if defined(PETSC_HAVE_O_BINARY)
47245c64e65SBarry Smith   if (mode == FILE_MODE_WRITE) {
473e5c89e4eSSatish Balay     if ((*fd = open(name,O_WRONLY|O_CREAT|O_TRUNC|O_BINARY,0666)) == -1) {
474e32f2f54SBarry Smith       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot create file for writing: %s",name);
475e5c89e4eSSatish Balay     }
47645c64e65SBarry Smith   } else if (mode == FILE_MODE_READ) {
477e5c89e4eSSatish Balay     if ((*fd = open(name,O_RDONLY|O_BINARY,0)) == -1) {
478e32f2f54SBarry Smith       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file for reading: %s",name);
479e5c89e4eSSatish Balay     }
48045c64e65SBarry Smith   } else if (mode == FILE_MODE_APPEND) {
481e5c89e4eSSatish Balay     if ((*fd = open(name,O_WRONLY|O_BINARY,0)) == -1) {
482e32f2f54SBarry Smith       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file for writing: %s",name);
483e5c89e4eSSatish Balay     }
484e5c89e4eSSatish Balay #else
48545c64e65SBarry Smith   if (mode == FILE_MODE_WRITE) {
486e5c89e4eSSatish Balay     if ((*fd = creat(name,0666)) == -1) {
487e32f2f54SBarry Smith       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot create file for writing: %s",name);
488e5c89e4eSSatish Balay     }
48945c64e65SBarry Smith   } else if (mode == FILE_MODE_READ) {
490e5c89e4eSSatish Balay     if ((*fd = open(name,O_RDONLY,0)) == -1) {
491e32f2f54SBarry Smith       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file for reading: %s",name);
492e5c89e4eSSatish Balay     }
493e5c89e4eSSatish Balay   }
49445c64e65SBarry Smith   else if (mode == FILE_MODE_APPEND) {
495e5c89e4eSSatish Balay     if ((*fd = open(name,O_WRONLY,0)) == -1) {
496e32f2f54SBarry Smith       SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file for writing: %s",name);
497e5c89e4eSSatish Balay     }
498e5c89e4eSSatish Balay #endif
499e32f2f54SBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown file mode");
500e5c89e4eSSatish Balay   PetscFunctionReturn(0);
501e5c89e4eSSatish Balay }
502e5c89e4eSSatish Balay 
503e5c89e4eSSatish Balay #undef __FUNCT__
504e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryClose"
505e30d2299SSatish Balay /*@
506e5c89e4eSSatish Balay    PetscBinaryClose - Closes a PETSc binary file.
507e5c89e4eSSatish Balay 
508e5c89e4eSSatish Balay    Not Collective
509e5c89e4eSSatish Balay 
510e5c89e4eSSatish Balay    Output Parameter:
511e5c89e4eSSatish Balay .  fd - the file
512e5c89e4eSSatish Balay 
513e5c89e4eSSatish Balay    Level: advanced
514e5c89e4eSSatish Balay 
5154ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen(), PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(),
5164ebed01fSBarry Smith           PetscBinarySynchronizedSeek()
517e5c89e4eSSatish Balay @*/
5187087cfbeSBarry Smith PetscErrorCode  PetscBinaryClose(int fd)
519e5c89e4eSSatish Balay {
520e5c89e4eSSatish Balay   PetscFunctionBegin;
521e5c89e4eSSatish Balay   close(fd);
522e5c89e4eSSatish Balay   PetscFunctionReturn(0);
523e5c89e4eSSatish Balay }
524e5c89e4eSSatish Balay 
525e5c89e4eSSatish Balay 
526e5c89e4eSSatish Balay #undef __FUNCT__
527e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinarySeek"
528e30d2299SSatish Balay /*@
529e5c89e4eSSatish Balay    PetscBinarySeek - Moves the file pointer on a PETSc binary file.
530e5c89e4eSSatish Balay 
531e5c89e4eSSatish Balay    Not Collective
532e5c89e4eSSatish Balay 
533e5c89e4eSSatish Balay    Input Parameters:
534e5c89e4eSSatish Balay +  fd - the file
535ff553b35SMatthew Knepley .  off - number of bytes to move. Use PETSC_BINARY_INT_SIZE, PETSC_BINARY_SCALAR_SIZE,
536e5c89e4eSSatish Balay             etc. in your calculation rather than sizeof() to compute byte lengths.
537ff553b35SMatthew Knepley -  whence - if PETSC_BINARY_SEEK_SET then off is an absolute location in the file
538ff553b35SMatthew Knepley             if PETSC_BINARY_SEEK_CUR then off is an offset from the current location
539ff553b35SMatthew Knepley             if PETSC_BINARY_SEEK_END then off is an offset from the end of file
540e5c89e4eSSatish Balay 
541e5c89e4eSSatish Balay    Output Parameter:
542e5c89e4eSSatish Balay .   offset - new offset in file
543e5c89e4eSSatish Balay 
544e5c89e4eSSatish Balay    Level: developer
545e5c89e4eSSatish Balay 
546e5c89e4eSSatish Balay    Notes:
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. Hence you CANNOT use sizeof()
550e5c89e4eSSatish Balay    to determine the offset or location.
551e5c89e4eSSatish Balay 
552e5c89e4eSSatish Balay    Concepts: files^binary seeking
553e5c89e4eSSatish Balay    Concepts: binary files^seeking
554e5c89e4eSSatish Balay 
5554ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen(), PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(),
5564ebed01fSBarry Smith           PetscBinarySynchronizedSeek()
557e5c89e4eSSatish Balay @*/
5587087cfbeSBarry Smith PetscErrorCode  PetscBinarySeek(int fd,off_t off,PetscBinarySeekType whence,off_t *offset)
559e5c89e4eSSatish Balay {
560e5c89e4eSSatish Balay   int iwhence = 0;
561e5c89e4eSSatish Balay 
562e5c89e4eSSatish Balay   PetscFunctionBegin;
563e5c89e4eSSatish Balay   if (whence == PETSC_BINARY_SEEK_SET) {
564e5c89e4eSSatish Balay     iwhence = SEEK_SET;
565e5c89e4eSSatish Balay   } else if (whence == PETSC_BINARY_SEEK_CUR) {
566e5c89e4eSSatish Balay     iwhence = SEEK_CUR;
567e5c89e4eSSatish Balay   } else if (whence == PETSC_BINARY_SEEK_END) {
568e5c89e4eSSatish Balay     iwhence = SEEK_END;
569e5c89e4eSSatish Balay   } else {
570e32f2f54SBarry Smith     SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown seek location");
571e5c89e4eSSatish Balay   }
572e5c89e4eSSatish Balay #if defined(PETSC_HAVE_LSEEK)
573e5c89e4eSSatish Balay   *offset = lseek(fd,off,iwhence);
574e5c89e4eSSatish Balay #elif defined(PETSC_HAVE__LSEEK)
575e5c89e4eSSatish Balay   *offset = _lseek(fd,(long)off,iwhence);
576e5c89e4eSSatish Balay #else
577e32f2f54SBarry Smith   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP_SYS,"System does not have a way of seeking on a file");
578e5c89e4eSSatish Balay #endif
579e5c89e4eSSatish Balay   PetscFunctionReturn(0);
580e5c89e4eSSatish Balay }
581e5c89e4eSSatish Balay 
582e5c89e4eSSatish Balay #undef __FUNCT__
5831d280d73SBarry Smith #define __FUNCT__ "PetscBinarySynchronizedRead"
584e5c89e4eSSatish Balay /*@C
5851d280d73SBarry Smith    PetscBinarySynchronizedRead - Reads from a binary file.
586e5c89e4eSSatish Balay 
587e5c89e4eSSatish Balay    Collective on MPI_Comm
588e5c89e4eSSatish Balay 
589e5c89e4eSSatish Balay    Input Parameters:
590e5c89e4eSSatish Balay +  comm - the MPI communicator
591e5c89e4eSSatish Balay .  fd - the file
592e5c89e4eSSatish Balay .  n  - the number of items to read
593e5c89e4eSSatish Balay -  type - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR)
594e5c89e4eSSatish Balay 
595e5c89e4eSSatish Balay    Output Parameters:
596e5c89e4eSSatish Balay .  p - the buffer
597e5c89e4eSSatish Balay 
598e5c89e4eSSatish Balay    Options Database Key:
599e5c89e4eSSatish Balay .   -binary_longints - indicates the file was generated on a Cray vector
600e5c89e4eSSatish Balay          machine (not the T3E/D) and the ints are stored as 64 bit
601e5c89e4eSSatish Balay          quantities, otherwise they are stored as 32 bit
602e5c89e4eSSatish Balay 
603e5c89e4eSSatish Balay    Level: developer
604e5c89e4eSSatish Balay 
605e5c89e4eSSatish Balay    Notes:
606e5c89e4eSSatish Balay    Does a PetscBinaryRead() followed by an MPI_Bcast()
607e5c89e4eSSatish Balay 
6081d280d73SBarry Smith    PetscBinarySynchronizedRead() uses byte swapping to work on all machines.
609e5c89e4eSSatish Balay    Integers are stored on the file as 32 long, regardless of whether
610e5c89e4eSSatish Balay    they are stored in the machine as 32 or 64, this means the same
611e5c89e4eSSatish Balay    binary file may be read on any machine.
612e5c89e4eSSatish Balay 
613e5c89e4eSSatish Balay    Concepts: files^synchronized reading of binary files
614e5c89e4eSSatish Balay    Concepts: binary files^reading, synchronized
615e5c89e4eSSatish Balay 
6164ebed01fSBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscBinaryRead(), PetscBinarySynchronizedWrite(),
6174ebed01fSBarry Smith           PetscBinarySynchronizedSeek()
618e5c89e4eSSatish Balay @*/
6197087cfbeSBarry Smith PetscErrorCode  PetscBinarySynchronizedRead(MPI_Comm comm,int fd,void *p,PetscInt n,PetscDataType type)
620e5c89e4eSSatish Balay {
621e5c89e4eSSatish Balay   PetscErrorCode ierr;
622e5c89e4eSSatish Balay   PetscMPIInt    rank;
623e5c89e4eSSatish Balay   MPI_Datatype   mtype;
6242d53ad75SBarry Smith   char           *fname;
6252d53ad75SBarry Smith   PetscBool      functionload = PETSC_FALSE;
6262d53ad75SBarry Smith   void           *ptmp;
627e5c89e4eSSatish Balay 
628e5c89e4eSSatish Balay   PetscFunctionBegin;
6292d53ad75SBarry Smith   if (type == PETSC_FUNCTION) {
6302d53ad75SBarry Smith     functionload = PETSC_TRUE;
6312d53ad75SBarry Smith     n            = 64;
6322d53ad75SBarry Smith     type         = PETSC_CHAR;
6332d53ad75SBarry Smith     ptmp         = p;
6342d53ad75SBarry Smith     /* warning memory leak */
635*98da9c48SSatish Balay     fname        = (char*)malloc(64*sizeof(char));
6362d53ad75SBarry Smith     p            = (void*)fname;
6372d53ad75SBarry Smith   }
6382d53ad75SBarry Smith 
639e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
640e5c89e4eSSatish Balay   if (!rank) {
641e5c89e4eSSatish Balay     ierr = PetscBinaryRead(fd,p,n,type);CHKERRQ(ierr);
642e5c89e4eSSatish Balay   }
643e5c89e4eSSatish Balay   ierr = PetscDataTypeToMPIDataType(type,&mtype);CHKERRQ(ierr);
644e5c89e4eSSatish Balay   ierr = MPI_Bcast(p,n,mtype,0,comm);CHKERRQ(ierr);
6452d53ad75SBarry Smith 
6462d53ad75SBarry Smith   if (functionload) {
6472d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
6482d53ad75SBarry Smith     ierr = PetscDLLibrarySym(PETSC_COMM_SELF,&PetscDLLibrariesLoaded,PETSC_NULL,fname,(void**)ptmp);CHKERRQ(ierr);
6492d53ad75SBarry Smith #else
6502d53ad75SBarry Smith     *(void**)ptmp = PETSC_NULL;
6512d53ad75SBarry Smith #endif
6522d53ad75SBarry Smith   }
653e5c89e4eSSatish Balay   PetscFunctionReturn(0);
654e5c89e4eSSatish Balay }
655e5c89e4eSSatish Balay 
656e5c89e4eSSatish Balay #undef __FUNCT__
6571d280d73SBarry Smith #define __FUNCT__ "PetscBinarySynchronizedWrite"
658e5c89e4eSSatish Balay /*@C
6591d280d73SBarry Smith    PetscBinarySynchronizedWrite - writes to a binary file.
660e5c89e4eSSatish Balay 
661e5c89e4eSSatish Balay    Collective on MPI_Comm
662e5c89e4eSSatish Balay 
663e5c89e4eSSatish Balay    Input Parameters:
664e5c89e4eSSatish Balay +  comm - the MPI communicator
665e5c89e4eSSatish Balay .  fd - the file
666e5c89e4eSSatish Balay .  n  - the number of items to write
667e5c89e4eSSatish Balay .  p - the buffer
668e5c89e4eSSatish Balay .  istemp - the buffer may be changed
669e5c89e4eSSatish Balay -  type - the type of items to write (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR)
670e5c89e4eSSatish Balay 
671e5c89e4eSSatish Balay    Level: developer
672e5c89e4eSSatish Balay 
673e5c89e4eSSatish Balay    Notes:
674e5c89e4eSSatish Balay    Process 0 does a PetscBinaryWrite()
675e5c89e4eSSatish Balay 
6761d280d73SBarry Smith    PetscBinarySynchronizedWrite() uses byte swapping to work on all machines.
677e5c89e4eSSatish Balay    Integers are stored on the file as 32 long, regardless of whether
678e5c89e4eSSatish Balay    they are stored in the machine as 32 or 64, this means the same
679e5c89e4eSSatish Balay    binary file may be read on any machine.
680e5c89e4eSSatish Balay 
681300a7f5bSBarry Smith    Notes: because byte-swapping may be done on the values in data it cannot be declared const
682300a7f5bSBarry Smith 
6831d280d73SBarry Smith    WARNING: This is NOT like PetscSynchronizedFPrintf()! This routine ignores calls on all but process 0,
6841d280d73SBarry Smith    while PetscSynchronizedFPrintf() has all processes print their strings in order.
6851d280d73SBarry Smith 
686e5c89e4eSSatish Balay    Concepts: files^synchronized writing of binary files
687e5c89e4eSSatish Balay    Concepts: binary files^reading, synchronized
688e5c89e4eSSatish Balay 
6894ebed01fSBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscBinaryRead(), PetscBinarySynchronizedRead(),
6904ebed01fSBarry Smith           PetscBinarySynchronizedSeek()
691e5c89e4eSSatish Balay @*/
6927087cfbeSBarry Smith PetscErrorCode  PetscBinarySynchronizedWrite(MPI_Comm comm,int fd,void *p,PetscInt n,PetscDataType type,PetscBool  istemp)
693e5c89e4eSSatish Balay {
694e5c89e4eSSatish Balay   PetscErrorCode ierr;
695e5c89e4eSSatish Balay   PetscMPIInt    rank;
696e5c89e4eSSatish Balay 
697e5c89e4eSSatish Balay   PetscFunctionBegin;
698e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
699e5c89e4eSSatish Balay   if (!rank) {
700e5c89e4eSSatish Balay     ierr = PetscBinaryWrite(fd,p,n,type,istemp);CHKERRQ(ierr);
701e5c89e4eSSatish Balay   }
702e5c89e4eSSatish Balay   PetscFunctionReturn(0);
703e5c89e4eSSatish Balay }
704e5c89e4eSSatish Balay 
705e5c89e4eSSatish Balay #undef __FUNCT__
7061d280d73SBarry Smith #define __FUNCT__ "PetscBinarySynchronizedSeek"
707e5c89e4eSSatish Balay /*@C
7081d280d73SBarry Smith    PetscBinarySynchronizedSeek - Moves the file pointer on a PETSc binary file.
709e5c89e4eSSatish Balay 
710e5c89e4eSSatish Balay 
711e5c89e4eSSatish Balay    Input Parameters:
712e5c89e4eSSatish Balay +  fd - the file
713e5c89e4eSSatish Balay .  whence - if PETSC_BINARY_SEEK_SET then size is an absolute location in the file
714e5c89e4eSSatish Balay             if PETSC_BINARY_SEEK_CUR then size is offset from current location
715e5c89e4eSSatish Balay             if PETSC_BINARY_SEEK_END then size is offset from end of file
716e5c89e4eSSatish Balay -  off    - number of bytes to move. Use PETSC_BINARY_INT_SIZE, PETSC_BINARY_SCALAR_SIZE,
717e5c89e4eSSatish Balay             etc. in your calculation rather than sizeof() to compute byte lengths.
718e5c89e4eSSatish Balay 
719e5c89e4eSSatish Balay    Output Parameter:
720e5c89e4eSSatish Balay .   offset - new offset in file
721e5c89e4eSSatish Balay 
722e5c89e4eSSatish Balay    Level: developer
723e5c89e4eSSatish Balay 
724e5c89e4eSSatish Balay    Notes:
725e5c89e4eSSatish Balay    Integers are stored on the file as 32 long, regardless of whether
726e5c89e4eSSatish Balay    they are stored in the machine as 32 or 64, this means the same
727e5c89e4eSSatish Balay    binary file may be read on any machine. Hence you CANNOT use sizeof()
728e5c89e4eSSatish Balay    to determine the offset or location.
729e5c89e4eSSatish Balay 
730e5c89e4eSSatish Balay    Concepts: binary files^seeking
731e5c89e4eSSatish Balay    Concepts: files^seeking in binary
732e5c89e4eSSatish Balay 
7334ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen(), PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(),
7344ebed01fSBarry Smith           PetscBinarySynchronizedSeek()
735e5c89e4eSSatish Balay @*/
7367087cfbeSBarry Smith PetscErrorCode  PetscBinarySynchronizedSeek(MPI_Comm comm,int fd,off_t off,PetscBinarySeekType whence,off_t *offset)
737e5c89e4eSSatish Balay {
738e5c89e4eSSatish Balay   PetscErrorCode ierr;
739e5c89e4eSSatish Balay   PetscMPIInt    rank;
740e5c89e4eSSatish Balay 
741e5c89e4eSSatish Balay   PetscFunctionBegin;
742e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
743e5c89e4eSSatish Balay   if (!rank) {
744e5c89e4eSSatish Balay     ierr = PetscBinarySeek(fd,off,whence,offset);CHKERRQ(ierr);
745e5c89e4eSSatish Balay   }
746e5c89e4eSSatish Balay   PetscFunctionReturn(0);
747e5c89e4eSSatish Balay }
748e5c89e4eSSatish Balay 
7490fc9d207SBarry Smith #if defined(PETSC_HAVE_MPIIO)
750e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
751e39fd77fSBarry Smith 
752951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
753e39fd77fSBarry Smith EXTERN_C_BEGIN
754e39fd77fSBarry Smith /*
755e39fd77fSBarry Smith       MPICH does not provide the external32 representation for MPI_File_set_view() so we need to provide the functions.
756e39fd77fSBarry Smith     These are set into MPI in PetscInitialize() via MPI_Register_datarep()
757e39fd77fSBarry Smith 
758e39fd77fSBarry Smith     Note I use PetscMPIInt for the MPI error codes since that is what MPI uses (instead of the standard PetscErrorCode)
759e39fd77fSBarry Smith 
760951e3c8eSBarry Smith     The next three routines are not used because MPICH does not support their use
761e39fd77fSBarry Smith 
762e39fd77fSBarry Smith */
763e39fd77fSBarry Smith PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype datatype,MPI_Aint *file_extent,void *extra_state)
764e39fd77fSBarry Smith {
765e39fd77fSBarry Smith   MPI_Aint    ub;
766e39fd77fSBarry Smith   PetscMPIInt ierr;
767e39fd77fSBarry Smith 
768e39fd77fSBarry Smith   ierr = MPI_Type_get_extent(datatype,&ub,file_extent);
769e39fd77fSBarry Smith   return ierr;
770e39fd77fSBarry Smith }
771e39fd77fSBarry Smith 
772e39fd77fSBarry Smith PetscMPIInt PetscDataRep_read_conv_fn(void *userbuf, MPI_Datatype datatype,PetscMPIInt count,void *filebuf, MPI_Offset position,void *extra_state)
773e39fd77fSBarry Smith {
774e39fd77fSBarry Smith   PetscDataType pdtype;
775e39fd77fSBarry Smith   PetscMPIInt   ierr;
776e39fd77fSBarry Smith   size_t        dsize;
777e39fd77fSBarry Smith 
778e39fd77fSBarry Smith   ierr = PetscMPIDataTypeToPetscDataType(datatype,&pdtype);CHKERRQ(ierr);
779e39fd77fSBarry Smith   ierr = PetscDataTypeGetSize(pdtype,&dsize);CHKERRQ(ierr);
780e39fd77fSBarry Smith 
781e39fd77fSBarry Smith   /* offset is given in units of MPI_Datatype */
782e39fd77fSBarry Smith   userbuf = ((char *)userbuf) + dsize*position;
783e39fd77fSBarry Smith 
784e39fd77fSBarry Smith   ierr = PetscMemcpy(userbuf,filebuf,count*dsize);CHKERRQ(ierr);
785e39fd77fSBarry Smith   ierr = PetscByteSwap(userbuf,pdtype,count);CHKERRQ(ierr);
786e39fd77fSBarry Smith   return ierr;
787e39fd77fSBarry Smith }
788e39fd77fSBarry Smith 
789e39fd77fSBarry Smith PetscMPIInt PetscDataRep_write_conv_fn(void *userbuf, MPI_Datatype datatype,PetscMPIInt count,void *filebuf, MPI_Offset position,void *extra_state)
790e39fd77fSBarry Smith {
791e39fd77fSBarry Smith   PetscDataType pdtype;
792e39fd77fSBarry Smith   PetscMPIInt   ierr;
793e39fd77fSBarry Smith   size_t        dsize;
794e39fd77fSBarry Smith 
795e39fd77fSBarry Smith   ierr = PetscMPIDataTypeToPetscDataType(datatype,&pdtype);CHKERRQ(ierr);
796e39fd77fSBarry Smith   ierr = PetscDataTypeGetSize(pdtype,&dsize);CHKERRQ(ierr);
797e39fd77fSBarry Smith 
798e39fd77fSBarry Smith   /* offset is given in units of MPI_Datatype */
799e39fd77fSBarry Smith   userbuf = ((char *)userbuf) + dsize*position;
800e39fd77fSBarry Smith 
801e39fd77fSBarry Smith   ierr = PetscMemcpy(filebuf,userbuf,count*dsize);CHKERRQ(ierr);
802e39fd77fSBarry Smith   ierr = PetscByteSwap(filebuf,pdtype,count);CHKERRQ(ierr);
803e39fd77fSBarry Smith   return ierr;
804e39fd77fSBarry Smith }
805e39fd77fSBarry Smith EXTERN_C_END
806951e3c8eSBarry Smith #endif
807e39fd77fSBarry Smith 
8081c91e6bcSJed Brown #undef __FUNCT__
8091c91e6bcSJed Brown #define __FUNCT__ "MPIU_File_write_all"
810e39fd77fSBarry Smith PetscErrorCode MPIU_File_write_all(MPI_File fd,void *data,PetscMPIInt cnt,MPI_Datatype dtype,MPI_Status *status)
811e39fd77fSBarry Smith {
812e39fd77fSBarry Smith   PetscErrorCode ierr;
813e39fd77fSBarry Smith   PetscDataType  pdtype;
814e39fd77fSBarry Smith 
815e39fd77fSBarry Smith   PetscFunctionBegin;
816e39fd77fSBarry Smith   ierr = PetscMPIDataTypeToPetscDataType(dtype,&pdtype);CHKERRQ(ierr);
817e39fd77fSBarry Smith   ierr = PetscByteSwap(data,pdtype,cnt);CHKERRQ(ierr);
818e39fd77fSBarry Smith   ierr = MPI_File_write_all(fd,data,cnt,dtype,status);CHKERRQ(ierr);
819e39fd77fSBarry Smith   ierr = PetscByteSwap(data,pdtype,cnt);CHKERRQ(ierr);
820a6796414SBarry Smith   PetscFunctionReturn(0);
821e39fd77fSBarry Smith }
822e39fd77fSBarry Smith 
8231c91e6bcSJed Brown #undef __FUNCT__
8241c91e6bcSJed Brown #define __FUNCT__ "MPIU_File_read_all"
825e39fd77fSBarry Smith PetscErrorCode MPIU_File_read_all(MPI_File fd,void *data,PetscMPIInt cnt,MPI_Datatype dtype,MPI_Status *status)
826e39fd77fSBarry Smith {
827e39fd77fSBarry Smith   PetscErrorCode ierr;
828e39fd77fSBarry Smith   PetscDataType  pdtype;
829e39fd77fSBarry Smith 
830e39fd77fSBarry Smith   PetscFunctionBegin;
831e39fd77fSBarry Smith   ierr = PetscMPIDataTypeToPetscDataType(dtype,&pdtype);CHKERRQ(ierr);
832e39fd77fSBarry Smith   ierr = MPI_File_read_all(fd,data,cnt,dtype,status);CHKERRQ(ierr);
833e39fd77fSBarry Smith   ierr = PetscByteSwap(data,pdtype,cnt);CHKERRQ(ierr);
834a6796414SBarry Smith   PetscFunctionReturn(0);
835e39fd77fSBarry Smith }
836e39fd77fSBarry Smith #endif
837951e3c8eSBarry Smith #endif
838