xref: /petsc/src/sys/fileio/sysio.c (revision 785e854f82a3c614b452fca2cf5ad4f2afe8bdde)
1e5c89e4eSSatish Balay 
2e5c89e4eSSatish Balay /*
3e5c89e4eSSatish Balay    This file contains simple binary read/write routines.
4e5c89e4eSSatish Balay  */
5e5c89e4eSSatish Balay 
6c6db04a5SJed Brown #include <petscsys.h>
7e5c89e4eSSatish Balay #include <errno.h>
8e5c89e4eSSatish Balay #include <fcntl.h>
9e5c89e4eSSatish Balay #if defined(PETSC_HAVE_UNISTD_H)
10e5c89e4eSSatish Balay #include <unistd.h>
11e5c89e4eSSatish Balay #endif
12e5c89e4eSSatish Balay #if defined(PETSC_HAVE_IO_H)
13e5c89e4eSSatish Balay #include <io.h>
14e5c89e4eSSatish Balay #endif
15c6db04a5SJed Brown #include <petscbt.h>
16e5c89e4eSSatish Balay 
17d6a4318aSJed Brown const char *const PetscFileModes[] = {"READ","WRITE","APPEND","UPDATE","APPEND_UPDATE","PetscFileMode","PETSC_FILE_",0};
18d6a4318aSJed Brown 
196de02169SBarry Smith /* --------------------------------------------------------- */
20e5c89e4eSSatish Balay #undef __FUNCT__
216de02169SBarry Smith #define __FUNCT__ "PetscByteSwapEnum"
22e5c89e4eSSatish Balay /*
236de02169SBarry Smith   PetscByteSwapEnum - Swap bytes in a  PETSc Enum
24e5c89e4eSSatish Balay 
25e5c89e4eSSatish Balay */
267087cfbeSBarry Smith PetscErrorCode  PetscByteSwapEnum(PetscEnum *buff,PetscInt n)
27e5c89e4eSSatish Balay {
286de02169SBarry Smith   PetscInt  i,j;
290b20345dSBarry Smith   PetscEnum tmp = ENUM_DUMMY;
30e0890e22SSatish Balay   char      *ptr1,*ptr2 = (char*)&tmp;
31e5c89e4eSSatish Balay 
32e5c89e4eSSatish Balay   PetscFunctionBegin;
33e5c89e4eSSatish Balay   for (j=0; j<n; j++) {
34e5c89e4eSSatish Balay     ptr1 = (char*)(buff + j);
35a297a907SKarl Rupp     for (i=0; i<(PetscInt)sizeof(PetscEnum); i++) ptr2[i] = ptr1[sizeof(PetscEnum)-1-i];
36a297a907SKarl Rupp     for (i=0; i<(PetscInt)sizeof(PetscEnum); i++) ptr1[i] = ptr2[i];
37e5c89e4eSSatish Balay   }
38e5c89e4eSSatish Balay   PetscFunctionReturn(0);
39e5c89e4eSSatish Balay }
406de02169SBarry Smith 
416de02169SBarry Smith #undef __FUNCT__
42acfcf0e5SJed Brown #define __FUNCT__ "PetscByteSwapBool"
436de02169SBarry Smith /*
44acfcf0e5SJed Brown   PetscByteSwapBool - Swap bytes in a  PETSc Bool
456de02169SBarry Smith 
466de02169SBarry Smith */
477087cfbeSBarry Smith PetscErrorCode  PetscByteSwapBool(PetscBool *buff,PetscInt n)
486de02169SBarry Smith {
496de02169SBarry Smith   PetscInt  i,j;
50ace3abfcSBarry Smith   PetscBool tmp = PETSC_FALSE;
51e0890e22SSatish Balay   char      *ptr1,*ptr2 = (char*)&tmp;
526de02169SBarry Smith 
536de02169SBarry Smith   PetscFunctionBegin;
546de02169SBarry Smith   for (j=0; j<n; j++) {
556de02169SBarry Smith     ptr1 = (char*)(buff + j);
56a297a907SKarl Rupp     for (i=0; i<(PetscInt)sizeof(PetscBool); i++) ptr2[i] = ptr1[sizeof(PetscBool)-1-i];
57a297a907SKarl Rupp     for (i=0; i<(PetscInt)sizeof(PetscBool); i++) ptr1[i] = ptr2[i];
586de02169SBarry Smith   }
596de02169SBarry Smith   PetscFunctionReturn(0);
606de02169SBarry Smith }
616de02169SBarry Smith 
62e5c89e4eSSatish Balay #undef __FUNCT__
63bd1d2e58SBarry Smith #define __FUNCT__ "PetscByteSwapInt"
64bd1d2e58SBarry Smith /*
656de02169SBarry Smith   PetscByteSwapInt - Swap bytes in a  PETSc integer (which may be 32 or 64 bits)
66bd1d2e58SBarry Smith 
67bd1d2e58SBarry Smith */
687087cfbeSBarry Smith PetscErrorCode  PetscByteSwapInt(PetscInt *buff,PetscInt n)
69bd1d2e58SBarry Smith {
70bd1d2e58SBarry Smith   PetscInt i,j,tmp = 0;
71e0890e22SSatish Balay   char     *ptr1,*ptr2 = (char*)&tmp;
72bd1d2e58SBarry Smith 
73bd1d2e58SBarry Smith   PetscFunctionBegin;
74bd1d2e58SBarry Smith   for (j=0; j<n; j++) {
75bd1d2e58SBarry Smith     ptr1 = (char*)(buff + j);
76a297a907SKarl Rupp     for (i=0; i<(PetscInt)sizeof(PetscInt); i++) ptr2[i] = ptr1[sizeof(PetscInt)-1-i];
77a297a907SKarl Rupp     for (i=0; i<(PetscInt)sizeof(PetscInt); i++) ptr1[i] = ptr2[i];
78bd1d2e58SBarry Smith   }
79bd1d2e58SBarry Smith   PetscFunctionReturn(0);
80bd1d2e58SBarry Smith }
81bd1d2e58SBarry Smith /* --------------------------------------------------------- */
82bd1d2e58SBarry Smith #undef __FUNCT__
83e5c89e4eSSatish Balay #define __FUNCT__ "PetscByteSwapShort"
84e5c89e4eSSatish Balay /*
85e5c89e4eSSatish Balay   PetscByteSwapShort - Swap bytes in a short
86e5c89e4eSSatish Balay */
877087cfbeSBarry Smith PetscErrorCode  PetscByteSwapShort(short *buff,PetscInt n)
88e5c89e4eSSatish Balay {
89e5c89e4eSSatish Balay   PetscInt i,j;
90e5c89e4eSSatish Balay   short    tmp;
91e5c89e4eSSatish Balay   char     *ptr1,*ptr2 = (char*)&tmp;
92e5c89e4eSSatish Balay 
93e5c89e4eSSatish Balay   PetscFunctionBegin;
94e5c89e4eSSatish Balay   for (j=0; j<n; j++) {
95e5c89e4eSSatish Balay     ptr1 = (char*)(buff + j);
96a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(short); i++) ptr2[i] = ptr1[sizeof(short)-1-i];
97a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(short); i++) ptr1[i] = ptr2[i];
98e5c89e4eSSatish Balay   }
99e5c89e4eSSatish Balay   PetscFunctionReturn(0);
100e5c89e4eSSatish Balay }
101e5c89e4eSSatish Balay /* --------------------------------------------------------- */
102e5c89e4eSSatish Balay #undef __FUNCT__
103e5c89e4eSSatish Balay #define __FUNCT__ "PetscByteSwapScalar"
104e5c89e4eSSatish Balay /*
105e5c89e4eSSatish Balay   PetscByteSwapScalar - Swap bytes in a double
106e5c89e4eSSatish Balay   Complex is dealt with as if array of double twice as long.
107e5c89e4eSSatish Balay */
1087087cfbeSBarry Smith PetscErrorCode  PetscByteSwapScalar(PetscScalar *buff,PetscInt n)
109e5c89e4eSSatish Balay {
110e5c89e4eSSatish Balay   PetscInt  i,j;
111e5c89e4eSSatish Balay   PetscReal tmp,*buff1 = (PetscReal*)buff;
112e5c89e4eSSatish Balay   char      *ptr1,*ptr2 = (char*)&tmp;
113e5c89e4eSSatish Balay 
114e5c89e4eSSatish Balay   PetscFunctionBegin;
115e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX)
116e5c89e4eSSatish Balay   n *= 2;
117e5c89e4eSSatish Balay #endif
118e5c89e4eSSatish Balay   for (j=0; j<n; j++) {
119e5c89e4eSSatish Balay     ptr1 = (char*)(buff1 + j);
120a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(PetscReal); i++) ptr2[i] = ptr1[sizeof(PetscReal)-1-i];
121a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(PetscReal); i++) ptr1[i] = ptr2[i];
122e5c89e4eSSatish Balay   }
123e5c89e4eSSatish Balay   PetscFunctionReturn(0);
124e5c89e4eSSatish Balay }
125e5c89e4eSSatish Balay /* --------------------------------------------------------- */
126e5c89e4eSSatish Balay #undef __FUNCT__
127e5c89e4eSSatish Balay #define __FUNCT__ "PetscByteSwapDouble"
128e5c89e4eSSatish Balay /*
129e5c89e4eSSatish Balay   PetscByteSwapDouble - Swap bytes in a double
130e5c89e4eSSatish Balay */
1317087cfbeSBarry Smith PetscErrorCode  PetscByteSwapDouble(double *buff,PetscInt n)
132e5c89e4eSSatish Balay {
133e5c89e4eSSatish Balay   PetscInt i,j;
134e5c89e4eSSatish Balay   double   tmp,*buff1 = (double*)buff;
135e5c89e4eSSatish Balay   char     *ptr1,*ptr2 = (char*)&tmp;
136e5c89e4eSSatish Balay 
137e5c89e4eSSatish Balay   PetscFunctionBegin;
138e5c89e4eSSatish Balay   for (j=0; j<n; j++) {
139e5c89e4eSSatish Balay     ptr1 = (char*)(buff1 + j);
140a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(double); i++) ptr2[i] = ptr1[sizeof(double)-1-i];
141a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(double); i++) ptr1[i] = ptr2[i];
142e5c89e4eSSatish Balay   }
143e5c89e4eSSatish Balay   PetscFunctionReturn(0);
144e5c89e4eSSatish Balay }
145e39fd77fSBarry Smith 
146e39fd77fSBarry Smith #undef __FUNCT__
147e95bf02fSSatish Balay #define __FUNCT__ "PetscByteSwapFloat"
148e95bf02fSSatish Balay /*
149e95bf02fSSatish Balay   PetscByteSwapFloat - Swap bytes in a float
150e95bf02fSSatish Balay */
151e95bf02fSSatish Balay PetscErrorCode PetscByteSwapFloat(float *buff,PetscInt n)
152e95bf02fSSatish Balay {
153e95bf02fSSatish Balay   PetscInt i,j;
154e95bf02fSSatish Balay   float    tmp,*buff1 = (float*)buff;
155e95bf02fSSatish Balay   char     *ptr1,*ptr2 = (char*)&tmp;
156e95bf02fSSatish Balay 
157e95bf02fSSatish Balay   PetscFunctionBegin;
158e95bf02fSSatish Balay   for (j=0; j<n; j++) {
159e95bf02fSSatish Balay     ptr1 = (char*)(buff1 + j);
160a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(float); i++) ptr2[i] = ptr1[sizeof(float)-1-i];
161a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(float); i++) ptr1[i] = ptr2[i];
162e95bf02fSSatish Balay   }
163e95bf02fSSatish Balay   PetscFunctionReturn(0);
164e95bf02fSSatish Balay }
165e95bf02fSSatish Balay 
166e95bf02fSSatish Balay #undef __FUNCT__
167e39fd77fSBarry Smith #define __FUNCT__ "PetscByteSwap"
168e39fd77fSBarry Smith PetscErrorCode PetscByteSwap(void *data,PetscDataType pdtype,PetscInt count)
169e39fd77fSBarry Smith {
170e39fd77fSBarry Smith   PetscErrorCode ierr;
171e39fd77fSBarry Smith 
172e39fd77fSBarry Smith   PetscFunctionBegin;
173e39fd77fSBarry Smith   if      (pdtype == PETSC_INT)    {ierr = PetscByteSwapInt((PetscInt*)data,count);CHKERRQ(ierr);}
174e39fd77fSBarry Smith   else if (pdtype == PETSC_ENUM)   {ierr = PetscByteSwapEnum((PetscEnum*)data,count);CHKERRQ(ierr);}
175acfcf0e5SJed Brown   else if (pdtype == PETSC_BOOL)   {ierr = PetscByteSwapBool((PetscBool*)data,count);CHKERRQ(ierr);}
176e39fd77fSBarry Smith   else if (pdtype == PETSC_SCALAR) {ierr = PetscByteSwapScalar((PetscScalar*)data,count);CHKERRQ(ierr);}
177e39fd77fSBarry Smith   else if (pdtype == PETSC_DOUBLE) {ierr = PetscByteSwapDouble((double*)data,count);CHKERRQ(ierr);}
178e95bf02fSSatish Balay   else if (pdtype == PETSC_FLOAT)  {ierr = PetscByteSwapFloat((float*)data,count);CHKERRQ(ierr);}
179e39fd77fSBarry Smith   else if (pdtype == PETSC_SHORT)  {ierr = PetscByteSwapShort((short*)data,count);CHKERRQ(ierr);}
180e39fd77fSBarry Smith   PetscFunctionReturn(0);
181e39fd77fSBarry Smith }
182e39fd77fSBarry Smith 
183e5c89e4eSSatish Balay /* --------------------------------------------------------- */
184e5c89e4eSSatish Balay #undef __FUNCT__
185e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryRead"
186e30d2299SSatish Balay /*@
187e5c89e4eSSatish Balay    PetscBinaryRead - Reads from a binary file.
188e5c89e4eSSatish Balay 
189e5c89e4eSSatish Balay    Not Collective
190e5c89e4eSSatish Balay 
191e5c89e4eSSatish Balay    Input Parameters:
192e5c89e4eSSatish Balay +  fd - the file
193e5c89e4eSSatish Balay .  n  - the number of items to read
194e5c89e4eSSatish Balay -  type - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR)
195e5c89e4eSSatish Balay 
196e5c89e4eSSatish Balay    Output Parameters:
197e5c89e4eSSatish Balay .  p - the buffer
198e5c89e4eSSatish Balay 
199e5c89e4eSSatish Balay 
200e5c89e4eSSatish Balay 
201e5c89e4eSSatish Balay    Level: developer
202e5c89e4eSSatish Balay 
203e5c89e4eSSatish Balay    Notes:
204e5c89e4eSSatish Balay    PetscBinaryRead() uses byte swapping to work on all machines; the files
205e5c89e4eSSatish Balay    are written to file ALWAYS using big-endian ordering. On small-endian machines the numbers
206e5c89e4eSSatish Balay    are converted to the small-endian format when they are read in from the file.
207e2e64c6bSBarry Smith    When PETSc is ./configure with --with-64bit-indices the integers are written to the
20854f21887SBarry Smith    file as 64 bit integers, this means they can only be read back in when the option --with-64bit-indices
20954f21887SBarry Smith    is used.
210e5c89e4eSSatish Balay 
211e5c89e4eSSatish Balay    Concepts: files^reading binary
212e5c89e4eSSatish Balay    Concepts: binary files^reading
213e5c89e4eSSatish Balay 
2144ebed01fSBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscViewerBinaryGetDescriptor(), PetscBinarySynchronizedWrite(),
2154ebed01fSBarry Smith           PetscBinarySynchronizedRead(), PetscBinarySynchronizedSeek()
216e5c89e4eSSatish Balay @*/
2177087cfbeSBarry Smith PetscErrorCode  PetscBinaryRead(int fd,void *p,PetscInt n,PetscDataType type)
218e5c89e4eSSatish Balay {
219e5c89e4eSSatish Balay   int               wsize,err;
220e5c89e4eSSatish Balay   size_t            m = (size_t) n,maxblock = 65536;
221e5c89e4eSSatish Balay   char              *pp = (char*)p;
2227a881295SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
2237a881295SBarry Smith   double            *ppp;
2247a881295SBarry Smith #endif
2257a881295SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) || defined(PETSC_USE_REAL___FLOAT128)
2266de02169SBarry Smith   PetscErrorCode    ierr;
2277a881295SBarry Smith #endif
2287a881295SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
229e5c89e4eSSatish Balay   void              *ptmp = p;
230e5c89e4eSSatish Balay #endif
2312d53ad75SBarry Smith   char              fname[64];
2322d53ad75SBarry Smith   PetscBool         functionload = PETSC_FALSE;
233e5c89e4eSSatish Balay 
234e5c89e4eSSatish Balay   PetscFunctionBegin;
2352d53ad75SBarry Smith   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to write a negative amount of data %D",n);
236e5c89e4eSSatish Balay   if (!n) PetscFunctionReturn(0);
237e5c89e4eSSatish Balay 
2382d53ad75SBarry Smith   if (type == PETSC_FUNCTION) {
2392d53ad75SBarry Smith     functionload = PETSC_TRUE;
2402d53ad75SBarry Smith     m            = 64;
2412d53ad75SBarry Smith     type         = PETSC_CHAR;
2422d53ad75SBarry Smith     pp           = (char*)fname;
2432d53ad75SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
2442d53ad75SBarry Smith     ptmp         = (void*)fname;
2452d53ad75SBarry Smith #endif
2462d53ad75SBarry Smith   }
2472d53ad75SBarry Smith 
2486de02169SBarry Smith   if (type == PETSC_INT)          m *= sizeof(PetscInt);
249e5c89e4eSSatish Balay   else if (type == PETSC_SCALAR)  m *= sizeof(PetscScalar);
250e5c89e4eSSatish Balay   else if (type == PETSC_DOUBLE)  m *= sizeof(double);
251e95bf02fSSatish Balay   else if (type == PETSC_FLOAT)   m *= sizeof(float);
252e5c89e4eSSatish Balay   else if (type == PETSC_SHORT)   m *= sizeof(short);
253e5c89e4eSSatish Balay   else if (type == PETSC_CHAR)    m *= sizeof(char);
254e5c89e4eSSatish Balay   else if (type == PETSC_ENUM)    m *= sizeof(PetscEnum);
255ace3abfcSBarry Smith   else if (type == PETSC_BOOL)   m *= sizeof(PetscBool);
2569f7b6320SBarry Smith   else if (type == PETSC_BIT_LOGICAL) m  = PetscBTLength(m)*sizeof(char);
257e32f2f54SBarry Smith   else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown type");
258e5c89e4eSSatish Balay 
2597a881295SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
2607a881295SBarry Smith   /* If using __float128 precision we still read in doubles from file */
2617a881295SBarry Smith   if (type == PETSC_SCALAR) {
2627a881295SBarry Smith     m    = m/2;
263*785e854fSJed Brown     ierr = PetscMalloc1(n,&ppp);CHKERRQ(ierr);
2647a881295SBarry Smith     pp   = (char*)ppp;
2657a881295SBarry Smith   }
2667a881295SBarry Smith #endif
2677a881295SBarry Smith 
268e5c89e4eSSatish Balay   while (m) {
269e5c89e4eSSatish Balay     wsize = (m < maxblock) ? m : maxblock;
270e5c89e4eSSatish Balay     err   = read(fd,pp,wsize);
271e5c89e4eSSatish Balay     if (err < 0 && errno == EINTR) continue;
272e32f2f54SBarry Smith     if (!err && wsize > 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"Read past end of file");
273e32f2f54SBarry Smith     if (err < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"Error reading from file, errno %d",errno);
274e5c89e4eSSatish Balay     m  -= err;
275e5c89e4eSSatish Balay     pp += err;
276e5c89e4eSSatish Balay   }
2777a881295SBarry Smith 
2787a881295SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
2797a881295SBarry Smith   if (type == PETSC_SCALAR) {
2807a881295SBarry Smith     PetscScalar *pv = (PetscScalar*) p;
2817a881295SBarry Smith     PetscInt    i;
2827a881295SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
2837a881295SBarry Smith     ierr = PetscByteSwapDouble(ppp,n);CHKERRQ(ierr);
2847a881295SBarry Smith #endif
285a297a907SKarl Rupp     for (i=0; i<n; i++) pv[i] = ppp[i];
2867a881295SBarry Smith     ierr = PetscFree(ppp);CHKERRQ(ierr);
2877a881295SBarry Smith     PetscFunctionReturn(0);
2887a881295SBarry Smith   }
2897a881295SBarry Smith #endif
2907a881295SBarry Smith 
291e5c89e4eSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN)
292e39fd77fSBarry Smith   ierr = PetscByteSwap(ptmp,type,n);CHKERRQ(ierr);
293e5c89e4eSSatish Balay #endif
294e5c89e4eSSatish Balay 
2952d53ad75SBarry Smith   if (functionload) {
2962d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
2970298fd71SBarry Smith     ierr = PetscDLSym(NULL,fname,(void**)p);CHKERRQ(ierr);
2982d53ad75SBarry Smith #else
2990298fd71SBarry Smith     *(void**)p = NULL;
3002d53ad75SBarry Smith #endif
3012d53ad75SBarry Smith   }
302e5c89e4eSSatish Balay   PetscFunctionReturn(0);
303e5c89e4eSSatish Balay }
304e5c89e4eSSatish Balay /* --------------------------------------------------------- */
305e5c89e4eSSatish Balay #undef __FUNCT__
306e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryWrite"
307e30d2299SSatish Balay /*@
308e5c89e4eSSatish Balay    PetscBinaryWrite - Writes to a binary file.
309e5c89e4eSSatish Balay 
310e5c89e4eSSatish Balay    Not Collective
311e5c89e4eSSatish Balay 
312e5c89e4eSSatish Balay    Input Parameters:
313e5c89e4eSSatish Balay +  fd     - the file
314e5c89e4eSSatish Balay .  p      - the buffer
315e5c89e4eSSatish Balay .  n      - the number of items to write
316e5c89e4eSSatish Balay .  type   - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR)
317e5c89e4eSSatish Balay -  istemp - PETSC_FALSE if buffer data should be preserved, PETSC_TRUE otherwise.
318e5c89e4eSSatish Balay 
319e5c89e4eSSatish Balay    Level: advanced
320e5c89e4eSSatish Balay 
321e5c89e4eSSatish Balay    Notes:
322e5c89e4eSSatish Balay    PetscBinaryWrite() uses byte swapping to work on all machines; the files
323e5c89e4eSSatish Balay    are written using big-endian ordering to the file. On small-endian machines the numbers
324e5c89e4eSSatish Balay    are converted to the big-endian format when they are written to disk.
325e2e64c6bSBarry Smith    When PETSc is ./configure with --with-64bit-indices the integers are written to the
32654f21887SBarry Smith    file as 64 bit integers, this means they can only be read back in when the option --with-64bit-indices
32754f21887SBarry Smith    is used.
328e5c89e4eSSatish Balay 
329e5c89e4eSSatish Balay    The Buffer p should be read-write buffer, and not static data.
330e5c89e4eSSatish Balay    This way, byte-swapping is done in-place, and then the buffer is
331e5c89e4eSSatish Balay    written to the file.
332e5c89e4eSSatish Balay 
333e5c89e4eSSatish Balay    This routine restores the original contents of the buffer, after
334e5c89e4eSSatish Balay    it is written to the file. This is done by byte-swapping in-place
335e5c89e4eSSatish Balay    the second time. If the flag istemp is set to PETSC_TRUE, the second
336e5c89e4eSSatish Balay    byte-swapping operation is not done, thus saving some computation,
337e5f36e38SBarry Smith    but the buffer is left corrupted.
338e5c89e4eSSatish Balay 
339300a7f5bSBarry Smith    Because byte-swapping may be done on the values in data it cannot be declared const
340300a7f5bSBarry Smith 
341e5c89e4eSSatish Balay    Concepts: files^writing binary
342e5c89e4eSSatish Balay    Concepts: binary files^writing
343e5c89e4eSSatish Balay 
3444ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryOpen(), PetscBinaryClose(), PetscViewerBinaryGetDescriptor(), PetscBinarySynchronizedWrite(),
3454ebed01fSBarry Smith           PetscBinarySynchronizedRead(), PetscBinarySynchronizedSeek()
346e5c89e4eSSatish Balay @*/
3477087cfbeSBarry Smith PetscErrorCode  PetscBinaryWrite(int fd,void *p,PetscInt n,PetscDataType type,PetscBool  istemp)
348e5c89e4eSSatish Balay {
349e5c89e4eSSatish Balay   char           *pp = (char*)p;
350e5c89e4eSSatish Balay   int            err,wsize;
351e5c89e4eSSatish Balay   size_t         m = (size_t)n,maxblock=65536;
352e5c89e4eSSatish Balay   PetscErrorCode ierr;
353f5351476SHong Zhang #if !defined(PETSC_WORDS_BIGENDIAN)
354e5c89e4eSSatish Balay   void           *ptmp = p;
355e5c89e4eSSatish Balay #endif
3562d53ad75SBarry Smith   char           fname[64];
357e5c89e4eSSatish Balay 
358e5c89e4eSSatish Balay   PetscFunctionBegin;
359e32f2f54SBarry Smith   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to write a negative amount of data %D",n);
360e5c89e4eSSatish Balay   if (!n) PetscFunctionReturn(0);
361e5c89e4eSSatish Balay 
3622d53ad75SBarry Smith   if (type == PETSC_FUNCTION) {
3632d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
3642d53ad75SBarry Smith     const char *fnametmp;
3652d53ad75SBarry Smith 
3662d53ad75SBarry Smith     if (n > 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Can only binary view a single function at a time");
3679200755eSBarry Smith     ierr = PetscFPTFind(*(void**)p,&fnametmp);CHKERRQ(ierr);
3682d53ad75SBarry Smith     ierr = PetscStrncpy(fname,fnametmp,64);CHKERRQ(ierr);
3692d53ad75SBarry Smith #else
3702d53ad75SBarry Smith     ierr = PetscStrncpy(fname,"",64);CHKERRQ(ierr);
3712d53ad75SBarry Smith #endif
3722d53ad75SBarry Smith     m    = 64;
3732d53ad75SBarry Smith     type = PETSC_CHAR;
3742d53ad75SBarry Smith     pp   = (char*)fname;
3752d53ad75SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
3762d53ad75SBarry Smith     ptmp = (void*)fname;
3772d53ad75SBarry Smith #endif
3782d53ad75SBarry Smith   }
3792d53ad75SBarry Smith 
3806de02169SBarry Smith   if (type == PETSC_INT)          m *= sizeof(PetscInt);
381e5c89e4eSSatish Balay   else if (type == PETSC_SCALAR)  m *= sizeof(PetscScalar);
382e5c89e4eSSatish Balay   else if (type == PETSC_DOUBLE)  m *= sizeof(double);
383e95bf02fSSatish Balay   else if (type == PETSC_FLOAT)   m *= sizeof(float);
384e5c89e4eSSatish Balay   else if (type == PETSC_SHORT)   m *= sizeof(short);
385e5c89e4eSSatish Balay   else if (type == PETSC_CHAR)    m *= sizeof(char);
386e5c89e4eSSatish Balay   else if (type == PETSC_ENUM)    m *= sizeof(PetscEnum);
387ace3abfcSBarry Smith   else if (type == PETSC_BOOL)   m *= sizeof(PetscBool);
3889f7b6320SBarry Smith   else if (type == PETSC_BIT_LOGICAL) m = PetscBTLength(m)*sizeof(char);
389e32f2f54SBarry Smith   else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown type");
390e5c89e4eSSatish Balay 
391e5c89e4eSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN)
392e39fd77fSBarry Smith   ierr = PetscByteSwap(ptmp,type,n);CHKERRQ(ierr);
393e5c89e4eSSatish Balay #endif
394e5c89e4eSSatish Balay 
395e5c89e4eSSatish Balay   while (m) {
396e5c89e4eSSatish Balay     wsize = (m < maxblock) ? m : maxblock;
397e5c89e4eSSatish Balay     err   = write(fd,pp,wsize);
398e5c89e4eSSatish Balay     if (err < 0 && errno == EINTR) continue;
399e32f2f54SBarry Smith     if (err != wsize) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_WRITE,"Error writing to file.");
400e5c89e4eSSatish Balay     m  -= wsize;
401e5c89e4eSSatish Balay     pp += wsize;
402e5c89e4eSSatish Balay   }
403e5c89e4eSSatish Balay 
404b659c0ceSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN)
405e5c89e4eSSatish Balay   if (!istemp) {
406e39fd77fSBarry Smith     ierr = PetscByteSwap(ptmp,type,n);CHKERRQ(ierr);
407e5c89e4eSSatish Balay   }
408e5c89e4eSSatish Balay #endif
409e5c89e4eSSatish Balay   PetscFunctionReturn(0);
410e5c89e4eSSatish Balay }
411e5c89e4eSSatish Balay 
412e5c89e4eSSatish Balay #undef __FUNCT__
413e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryOpen"
414e5c89e4eSSatish Balay /*@C
415e5c89e4eSSatish Balay    PetscBinaryOpen - Opens a PETSc binary file.
416e5c89e4eSSatish Balay 
417e5c89e4eSSatish Balay    Not Collective
418e5c89e4eSSatish Balay 
419e5c89e4eSSatish Balay    Input Parameters:
420e5c89e4eSSatish Balay +  name - filename
42145c64e65SBarry Smith -  type - type of binary file, one of FILE_MODE_READ, FILE_MODE_APPEND, FILE_MODE_WRITE
422e5c89e4eSSatish Balay 
423e5c89e4eSSatish Balay    Output Parameter:
424e5c89e4eSSatish Balay .  fd - the file
425e5c89e4eSSatish Balay 
426e5c89e4eSSatish Balay    Level: advanced
427e5c89e4eSSatish Balay 
428e5c89e4eSSatish Balay   Concepts: files^opening binary
429e5c89e4eSSatish Balay   Concepts: binary files^opening
430e5c89e4eSSatish Balay 
431e5c89e4eSSatish Balay    Notes: Files access with PetscBinaryRead() and PetscBinaryWrite() are ALWAYS written in
432e5c89e4eSSatish Balay    big-endian format. This means the file can be accessed using PetscBinaryOpen() and
433e5c89e4eSSatish Balay    PetscBinaryRead() and PetscBinaryWrite() on any machine.
434e5c89e4eSSatish Balay 
4354ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscFileMode, PetscViewerFileSetMode(), PetscViewerBinaryGetDescriptor(),
4364ebed01fSBarry Smith           PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(), PetscBinarySynchronizedSeek()
43745c64e65SBarry Smith 
438e5c89e4eSSatish Balay @*/
4397087cfbeSBarry Smith PetscErrorCode  PetscBinaryOpen(const char name[],PetscFileMode mode,int *fd)
440e5c89e4eSSatish Balay {
441e5c89e4eSSatish Balay   PetscFunctionBegin;
442e5c89e4eSSatish Balay #if defined(PETSC_HAVE_O_BINARY)
44345c64e65SBarry Smith   if (mode == FILE_MODE_WRITE) {
444a297a907SKarl Rupp     if ((*fd = open(name,O_WRONLY|O_CREAT|O_TRUNC|O_BINARY,0666)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot create file for writing: %s",name);
44545c64e65SBarry Smith   } else if (mode == FILE_MODE_READ) {
446a297a907SKarl Rupp     if ((*fd = open(name,O_RDONLY|O_BINARY,0)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file for reading: %s",name);
44745c64e65SBarry Smith   } else if (mode == FILE_MODE_APPEND) {
448a297a907SKarl Rupp     if ((*fd = open(name,O_WRONLY|O_BINARY,0)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file for writing: %s",name);
449e5c89e4eSSatish Balay #else
45045c64e65SBarry Smith   if (mode == FILE_MODE_WRITE) {
451a297a907SKarl Rupp     if ((*fd = creat(name,0666)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot create file for writing: %s",name);
45245c64e65SBarry Smith   } else if (mode == FILE_MODE_READ) {
453a297a907SKarl Rupp     if ((*fd = open(name,O_RDONLY,0)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file for reading: %s",name);
454e5c89e4eSSatish Balay   }
45545c64e65SBarry Smith   else if (mode == FILE_MODE_APPEND) {
456a297a907SKarl Rupp     if ((*fd = open(name,O_WRONLY,0)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file for writing: %s",name);
457e5c89e4eSSatish Balay #endif
458e32f2f54SBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown file mode");
459e5c89e4eSSatish Balay   PetscFunctionReturn(0);
460e5c89e4eSSatish Balay }
461e5c89e4eSSatish Balay 
462e5c89e4eSSatish Balay #undef __FUNCT__
463e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryClose"
464e30d2299SSatish Balay /*@
465e5c89e4eSSatish Balay    PetscBinaryClose - Closes a PETSc binary file.
466e5c89e4eSSatish Balay 
467e5c89e4eSSatish Balay    Not Collective
468e5c89e4eSSatish Balay 
469e5c89e4eSSatish Balay    Output Parameter:
470e5c89e4eSSatish Balay .  fd - the file
471e5c89e4eSSatish Balay 
472e5c89e4eSSatish Balay    Level: advanced
473e5c89e4eSSatish Balay 
4744ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen(), PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(),
4754ebed01fSBarry Smith           PetscBinarySynchronizedSeek()
476e5c89e4eSSatish Balay @*/
4777087cfbeSBarry Smith PetscErrorCode  PetscBinaryClose(int fd)
478e5c89e4eSSatish Balay {
479e5c89e4eSSatish Balay   PetscFunctionBegin;
480e5c89e4eSSatish Balay   close(fd);
481e5c89e4eSSatish Balay   PetscFunctionReturn(0);
482e5c89e4eSSatish Balay }
483e5c89e4eSSatish Balay 
484e5c89e4eSSatish Balay 
485e5c89e4eSSatish Balay #undef __FUNCT__
486e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinarySeek"
487e30d2299SSatish Balay /*@
488e5c89e4eSSatish Balay    PetscBinarySeek - Moves the file pointer on a PETSc binary file.
489e5c89e4eSSatish Balay 
490e5c89e4eSSatish Balay    Not Collective
491e5c89e4eSSatish Balay 
492e5c89e4eSSatish Balay    Input Parameters:
493e5c89e4eSSatish Balay +  fd - the file
494ff553b35SMatthew Knepley .  off - number of bytes to move. Use PETSC_BINARY_INT_SIZE, PETSC_BINARY_SCALAR_SIZE,
495e5c89e4eSSatish Balay             etc. in your calculation rather than sizeof() to compute byte lengths.
496ff553b35SMatthew Knepley -  whence - if PETSC_BINARY_SEEK_SET then off is an absolute location in the file
497ff553b35SMatthew Knepley             if PETSC_BINARY_SEEK_CUR then off is an offset from the current location
498ff553b35SMatthew Knepley             if PETSC_BINARY_SEEK_END then off is an offset from the end of file
499e5c89e4eSSatish Balay 
500e5c89e4eSSatish Balay    Output Parameter:
501e5c89e4eSSatish Balay .   offset - new offset in file
502e5c89e4eSSatish Balay 
503e5c89e4eSSatish Balay    Level: developer
504e5c89e4eSSatish Balay 
505e5c89e4eSSatish Balay    Notes:
506e5c89e4eSSatish Balay    Integers are stored on the file as 32 long, regardless of whether
507e5c89e4eSSatish Balay    they are stored in the machine as 32 or 64, this means the same
508e5c89e4eSSatish Balay    binary file may be read on any machine. Hence you CANNOT use sizeof()
509e5c89e4eSSatish Balay    to determine the offset or location.
510e5c89e4eSSatish Balay 
511e5c89e4eSSatish Balay    Concepts: files^binary seeking
512e5c89e4eSSatish Balay    Concepts: binary files^seeking
513e5c89e4eSSatish Balay 
5144ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen(), PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(),
5154ebed01fSBarry Smith           PetscBinarySynchronizedSeek()
516e5c89e4eSSatish Balay @*/
5177087cfbeSBarry Smith PetscErrorCode  PetscBinarySeek(int fd,off_t off,PetscBinarySeekType whence,off_t *offset)
518e5c89e4eSSatish Balay {
519e5c89e4eSSatish Balay   int iwhence = 0;
520e5c89e4eSSatish Balay 
521e5c89e4eSSatish Balay   PetscFunctionBegin;
522a297a907SKarl Rupp   if (whence == PETSC_BINARY_SEEK_SET) iwhence = SEEK_SET;
523a297a907SKarl Rupp   else if (whence == PETSC_BINARY_SEEK_CUR) iwhence = SEEK_CUR;
524a297a907SKarl Rupp   else if (whence == PETSC_BINARY_SEEK_END) iwhence = SEEK_END;
525a297a907SKarl Rupp   else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown seek location");
526e5c89e4eSSatish Balay #if defined(PETSC_HAVE_LSEEK)
527e5c89e4eSSatish Balay   *offset = lseek(fd,off,iwhence);
528e5c89e4eSSatish Balay #elif defined(PETSC_HAVE__LSEEK)
529e5c89e4eSSatish Balay   *offset = _lseek(fd,(long)off,iwhence);
530e5c89e4eSSatish Balay #else
531e32f2f54SBarry Smith   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP_SYS,"System does not have a way of seeking on a file");
532e5c89e4eSSatish Balay #endif
533e5c89e4eSSatish Balay   PetscFunctionReturn(0);
534e5c89e4eSSatish Balay }
535e5c89e4eSSatish Balay 
536e5c89e4eSSatish Balay #undef __FUNCT__
5371d280d73SBarry Smith #define __FUNCT__ "PetscBinarySynchronizedRead"
538e5c89e4eSSatish Balay /*@C
5391d280d73SBarry Smith    PetscBinarySynchronizedRead - Reads from a binary file.
540e5c89e4eSSatish Balay 
541e5c89e4eSSatish Balay    Collective on MPI_Comm
542e5c89e4eSSatish Balay 
543e5c89e4eSSatish Balay    Input Parameters:
544e5c89e4eSSatish Balay +  comm - the MPI communicator
545e5c89e4eSSatish Balay .  fd - the file
546e5c89e4eSSatish Balay .  n  - the number of items to read
547e5c89e4eSSatish Balay -  type - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR)
548e5c89e4eSSatish Balay 
549e5c89e4eSSatish Balay    Output Parameters:
550e5c89e4eSSatish Balay .  p - the buffer
551e5c89e4eSSatish Balay 
552e5c89e4eSSatish Balay    Options Database Key:
553e5c89e4eSSatish Balay .   -binary_longints - indicates the file was generated on a Cray vector
554e5c89e4eSSatish Balay          machine (not the T3E/D) and the ints are stored as 64 bit
555e5c89e4eSSatish Balay          quantities, otherwise they are stored as 32 bit
556e5c89e4eSSatish Balay 
557e5c89e4eSSatish Balay    Level: developer
558e5c89e4eSSatish Balay 
559e5c89e4eSSatish Balay    Notes:
560e5c89e4eSSatish Balay    Does a PetscBinaryRead() followed by an MPI_Bcast()
561e5c89e4eSSatish Balay 
5621d280d73SBarry Smith    PetscBinarySynchronizedRead() uses byte swapping to work on all machines.
563e5c89e4eSSatish Balay    Integers are stored on the file as 32 long, regardless of whether
564e5c89e4eSSatish Balay    they are stored in the machine as 32 or 64, this means the same
565e5c89e4eSSatish Balay    binary file may be read on any machine.
566e5c89e4eSSatish Balay 
567e5c89e4eSSatish Balay    Concepts: files^synchronized reading of binary files
568e5c89e4eSSatish Balay    Concepts: binary files^reading, synchronized
569e5c89e4eSSatish Balay 
5704ebed01fSBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscBinaryRead(), PetscBinarySynchronizedWrite(),
5714ebed01fSBarry Smith           PetscBinarySynchronizedSeek()
572e5c89e4eSSatish Balay @*/
5737087cfbeSBarry Smith PetscErrorCode  PetscBinarySynchronizedRead(MPI_Comm comm,int fd,void *p,PetscInt n,PetscDataType type)
574e5c89e4eSSatish Balay {
575e5c89e4eSSatish Balay   PetscErrorCode ierr;
576e5c89e4eSSatish Balay   PetscMPIInt    rank;
577e5c89e4eSSatish Balay   MPI_Datatype   mtype;
5782d53ad75SBarry Smith   char           *fname;
5792d53ad75SBarry Smith   PetscBool      functionload = PETSC_FALSE;
5800298fd71SBarry Smith   void           *ptmp        = NULL;
581e5c89e4eSSatish Balay 
582e5c89e4eSSatish Balay   PetscFunctionBegin;
5832d53ad75SBarry Smith   if (type == PETSC_FUNCTION) {
5842d53ad75SBarry Smith     functionload = PETSC_TRUE;
5852d53ad75SBarry Smith     n            = 64;
5862d53ad75SBarry Smith     type         = PETSC_CHAR;
5872d53ad75SBarry Smith     ptmp         = p;
5882d53ad75SBarry Smith     /* warning memory leak */
58998da9c48SSatish Balay     fname        = (char*)malloc(64*sizeof(char));
5902d53ad75SBarry Smith     p            = (void*)fname;
5912d53ad75SBarry Smith   }
5922d53ad75SBarry Smith 
593e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
594e5c89e4eSSatish Balay   if (!rank) {
595e5c89e4eSSatish Balay     ierr = PetscBinaryRead(fd,p,n,type);CHKERRQ(ierr);
596e5c89e4eSSatish Balay   }
597e5c89e4eSSatish Balay   ierr = PetscDataTypeToMPIDataType(type,&mtype);CHKERRQ(ierr);
598e5c89e4eSSatish Balay   ierr = MPI_Bcast(p,n,mtype,0,comm);CHKERRQ(ierr);
5992d53ad75SBarry Smith 
6002d53ad75SBarry Smith   if (functionload) {
6012d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
6020298fd71SBarry Smith     ierr = PetscDLLibrarySym(PETSC_COMM_SELF,&PetscDLLibrariesLoaded,NULL,fname,(void**)ptmp);CHKERRQ(ierr);
6032d53ad75SBarry Smith #else
6040298fd71SBarry Smith     *(void**)ptmp = NULL;
6052d53ad75SBarry Smith #endif
6062d53ad75SBarry Smith   }
607e5c89e4eSSatish Balay   PetscFunctionReturn(0);
608e5c89e4eSSatish Balay }
609e5c89e4eSSatish Balay 
610e5c89e4eSSatish Balay #undef __FUNCT__
6111d280d73SBarry Smith #define __FUNCT__ "PetscBinarySynchronizedWrite"
612e5c89e4eSSatish Balay /*@C
6131d280d73SBarry Smith    PetscBinarySynchronizedWrite - writes to a binary file.
614e5c89e4eSSatish Balay 
615e5c89e4eSSatish Balay    Collective on MPI_Comm
616e5c89e4eSSatish Balay 
617e5c89e4eSSatish Balay    Input Parameters:
618e5c89e4eSSatish Balay +  comm - the MPI communicator
619e5c89e4eSSatish Balay .  fd - the file
620e5c89e4eSSatish Balay .  n  - the number of items to write
621e5c89e4eSSatish Balay .  p - the buffer
622e5c89e4eSSatish Balay .  istemp - the buffer may be changed
623e5c89e4eSSatish Balay -  type - the type of items to write (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR)
624e5c89e4eSSatish Balay 
625e5c89e4eSSatish Balay    Level: developer
626e5c89e4eSSatish Balay 
627e5c89e4eSSatish Balay    Notes:
628e5c89e4eSSatish Balay    Process 0 does a PetscBinaryWrite()
629e5c89e4eSSatish Balay 
6301d280d73SBarry Smith    PetscBinarySynchronizedWrite() uses byte swapping to work on all machines.
631e5c89e4eSSatish Balay    Integers are stored on the file as 32 long, regardless of whether
632e5c89e4eSSatish Balay    they are stored in the machine as 32 or 64, this means the same
633e5c89e4eSSatish Balay    binary file may be read on any machine.
634e5c89e4eSSatish Balay 
635300a7f5bSBarry Smith    Notes: because byte-swapping may be done on the values in data it cannot be declared const
636300a7f5bSBarry Smith 
6371d280d73SBarry Smith    WARNING: This is NOT like PetscSynchronizedFPrintf()! This routine ignores calls on all but process 0,
6381d280d73SBarry Smith    while PetscSynchronizedFPrintf() has all processes print their strings in order.
6391d280d73SBarry Smith 
640e5c89e4eSSatish Balay    Concepts: files^synchronized writing of binary files
641e5c89e4eSSatish Balay    Concepts: binary files^reading, synchronized
642e5c89e4eSSatish Balay 
6434ebed01fSBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscBinaryRead(), PetscBinarySynchronizedRead(),
6444ebed01fSBarry Smith           PetscBinarySynchronizedSeek()
645e5c89e4eSSatish Balay @*/
6467087cfbeSBarry Smith PetscErrorCode  PetscBinarySynchronizedWrite(MPI_Comm comm,int fd,void *p,PetscInt n,PetscDataType type,PetscBool istemp)
647e5c89e4eSSatish Balay {
648e5c89e4eSSatish Balay   PetscErrorCode ierr;
649e5c89e4eSSatish Balay   PetscMPIInt    rank;
650e5c89e4eSSatish Balay 
651e5c89e4eSSatish Balay   PetscFunctionBegin;
652e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
653e5c89e4eSSatish Balay   if (!rank) {
654e5c89e4eSSatish Balay     ierr = PetscBinaryWrite(fd,p,n,type,istemp);CHKERRQ(ierr);
655e5c89e4eSSatish Balay   }
656e5c89e4eSSatish Balay   PetscFunctionReturn(0);
657e5c89e4eSSatish Balay }
658e5c89e4eSSatish Balay 
659e5c89e4eSSatish Balay #undef __FUNCT__
6601d280d73SBarry Smith #define __FUNCT__ "PetscBinarySynchronizedSeek"
661e5c89e4eSSatish Balay /*@C
6621d280d73SBarry Smith    PetscBinarySynchronizedSeek - Moves the file pointer on a PETSc binary file.
663e5c89e4eSSatish Balay 
664e5c89e4eSSatish Balay 
665e5c89e4eSSatish Balay    Input Parameters:
666e5c89e4eSSatish Balay +  fd - the file
667e5c89e4eSSatish Balay .  whence - if PETSC_BINARY_SEEK_SET then size is an absolute location in the file
668e5c89e4eSSatish Balay             if PETSC_BINARY_SEEK_CUR then size is offset from current location
669e5c89e4eSSatish Balay             if PETSC_BINARY_SEEK_END then size is offset from end of file
670e5c89e4eSSatish Balay -  off    - number of bytes to move. Use PETSC_BINARY_INT_SIZE, PETSC_BINARY_SCALAR_SIZE,
671e5c89e4eSSatish Balay             etc. in your calculation rather than sizeof() to compute byte lengths.
672e5c89e4eSSatish Balay 
673e5c89e4eSSatish Balay    Output Parameter:
674e5c89e4eSSatish Balay .   offset - new offset in file
675e5c89e4eSSatish Balay 
676e5c89e4eSSatish Balay    Level: developer
677e5c89e4eSSatish Balay 
678e5c89e4eSSatish Balay    Notes:
679e5c89e4eSSatish Balay    Integers are stored on the file as 32 long, regardless of whether
680e5c89e4eSSatish Balay    they are stored in the machine as 32 or 64, this means the same
681e5c89e4eSSatish Balay    binary file may be read on any machine. Hence you CANNOT use sizeof()
682e5c89e4eSSatish Balay    to determine the offset or location.
683e5c89e4eSSatish Balay 
684e5c89e4eSSatish Balay    Concepts: binary files^seeking
685e5c89e4eSSatish Balay    Concepts: files^seeking in binary
686e5c89e4eSSatish Balay 
6874ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen(), PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(),
6884ebed01fSBarry Smith           PetscBinarySynchronizedSeek()
689e5c89e4eSSatish Balay @*/
6907087cfbeSBarry Smith PetscErrorCode  PetscBinarySynchronizedSeek(MPI_Comm comm,int fd,off_t off,PetscBinarySeekType whence,off_t *offset)
691e5c89e4eSSatish Balay {
692e5c89e4eSSatish Balay   PetscErrorCode ierr;
693e5c89e4eSSatish Balay   PetscMPIInt    rank;
694e5c89e4eSSatish Balay 
695e5c89e4eSSatish Balay   PetscFunctionBegin;
696e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
697e5c89e4eSSatish Balay   if (!rank) {
698e5c89e4eSSatish Balay     ierr = PetscBinarySeek(fd,off,whence,offset);CHKERRQ(ierr);
699e5c89e4eSSatish Balay   }
700e5c89e4eSSatish Balay   PetscFunctionReturn(0);
701e5c89e4eSSatish Balay }
702e5c89e4eSSatish Balay 
7030fc9d207SBarry Smith #if defined(PETSC_HAVE_MPIIO)
704e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
705e39fd77fSBarry Smith 
706951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
707e39fd77fSBarry Smith /*
708e39fd77fSBarry Smith       MPICH does not provide the external32 representation for MPI_File_set_view() so we need to provide the functions.
709e39fd77fSBarry Smith     These are set into MPI in PetscInitialize() via MPI_Register_datarep()
710e39fd77fSBarry Smith 
711e39fd77fSBarry Smith     Note I use PetscMPIInt for the MPI error codes since that is what MPI uses (instead of the standard PetscErrorCode)
712e39fd77fSBarry Smith 
713951e3c8eSBarry Smith     The next three routines are not used because MPICH does not support their use
714e39fd77fSBarry Smith 
715e39fd77fSBarry Smith */
7168cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype datatype,MPI_Aint *file_extent,void *extra_state)
717e39fd77fSBarry Smith {
718e39fd77fSBarry Smith   MPI_Aint    ub;
719e39fd77fSBarry Smith   PetscMPIInt ierr;
720e39fd77fSBarry Smith 
721e39fd77fSBarry Smith   ierr = MPI_Type_get_extent(datatype,&ub,file_extent);
722e39fd77fSBarry Smith   return ierr;
723e39fd77fSBarry Smith }
724e39fd77fSBarry Smith 
7258cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void *userbuf, MPI_Datatype datatype,PetscMPIInt count,void *filebuf, MPI_Offset position,void *extra_state)
726e39fd77fSBarry Smith {
727e39fd77fSBarry Smith   PetscDataType pdtype;
728e39fd77fSBarry Smith   PetscMPIInt   ierr;
729e39fd77fSBarry Smith   size_t        dsize;
730e39fd77fSBarry Smith 
731e39fd77fSBarry Smith   ierr = PetscMPIDataTypeToPetscDataType(datatype,&pdtype);CHKERRQ(ierr);
732e39fd77fSBarry Smith   ierr = PetscDataTypeGetSize(pdtype,&dsize);CHKERRQ(ierr);
733e39fd77fSBarry Smith 
734e39fd77fSBarry Smith   /* offset is given in units of MPI_Datatype */
735e39fd77fSBarry Smith   userbuf = ((char*)userbuf) + dsize*position;
736e39fd77fSBarry Smith 
737e39fd77fSBarry Smith   ierr = PetscMemcpy(userbuf,filebuf,count*dsize);CHKERRQ(ierr);
738e39fd77fSBarry Smith   ierr = PetscByteSwap(userbuf,pdtype,count);CHKERRQ(ierr);
739e39fd77fSBarry Smith   return ierr;
740e39fd77fSBarry Smith }
741e39fd77fSBarry Smith 
742e39fd77fSBarry Smith PetscMPIInt PetscDataRep_write_conv_fn(void *userbuf, MPI_Datatype datatype,PetscMPIInt count,void *filebuf, MPI_Offset position,void *extra_state)
743e39fd77fSBarry Smith {
744e39fd77fSBarry Smith   PetscDataType pdtype;
745e39fd77fSBarry Smith   PetscMPIInt   ierr;
746e39fd77fSBarry Smith   size_t        dsize;
747e39fd77fSBarry Smith 
748e39fd77fSBarry Smith   ierr = PetscMPIDataTypeToPetscDataType(datatype,&pdtype);CHKERRQ(ierr);
749e39fd77fSBarry Smith   ierr = PetscDataTypeGetSize(pdtype,&dsize);CHKERRQ(ierr);
750e39fd77fSBarry Smith 
751e39fd77fSBarry Smith   /* offset is given in units of MPI_Datatype */
752e39fd77fSBarry Smith   userbuf = ((char*)userbuf) + dsize*position;
753e39fd77fSBarry Smith 
754e39fd77fSBarry Smith   ierr = PetscMemcpy(filebuf,userbuf,count*dsize);CHKERRQ(ierr);
755e39fd77fSBarry Smith   ierr = PetscByteSwap(filebuf,pdtype,count);CHKERRQ(ierr);
756e39fd77fSBarry Smith   return ierr;
757e39fd77fSBarry Smith }
758951e3c8eSBarry Smith #endif
759e39fd77fSBarry Smith 
7601c91e6bcSJed Brown #undef __FUNCT__
7611c91e6bcSJed Brown #define __FUNCT__ "MPIU_File_write_all"
762e39fd77fSBarry Smith PetscErrorCode MPIU_File_write_all(MPI_File fd,void *data,PetscMPIInt cnt,MPI_Datatype dtype,MPI_Status *status)
763e39fd77fSBarry Smith {
764e39fd77fSBarry Smith   PetscErrorCode ierr;
765e39fd77fSBarry Smith   PetscDataType  pdtype;
766e39fd77fSBarry Smith 
767e39fd77fSBarry Smith   PetscFunctionBegin;
768e39fd77fSBarry Smith   ierr = PetscMPIDataTypeToPetscDataType(dtype,&pdtype);CHKERRQ(ierr);
769e39fd77fSBarry Smith   ierr = PetscByteSwap(data,pdtype,cnt);CHKERRQ(ierr);
770e39fd77fSBarry Smith   ierr = MPI_File_write_all(fd,data,cnt,dtype,status);CHKERRQ(ierr);
771e39fd77fSBarry Smith   ierr = PetscByteSwap(data,pdtype,cnt);CHKERRQ(ierr);
772a6796414SBarry Smith   PetscFunctionReturn(0);
773e39fd77fSBarry Smith }
774e39fd77fSBarry Smith 
7751c91e6bcSJed Brown #undef __FUNCT__
7761c91e6bcSJed Brown #define __FUNCT__ "MPIU_File_read_all"
777e39fd77fSBarry Smith PetscErrorCode MPIU_File_read_all(MPI_File fd,void *data,PetscMPIInt cnt,MPI_Datatype dtype,MPI_Status *status)
778e39fd77fSBarry Smith {
779e39fd77fSBarry Smith   PetscErrorCode ierr;
780e39fd77fSBarry Smith   PetscDataType  pdtype;
781e39fd77fSBarry Smith 
782e39fd77fSBarry Smith   PetscFunctionBegin;
783e39fd77fSBarry Smith   ierr = PetscMPIDataTypeToPetscDataType(dtype,&pdtype);CHKERRQ(ierr);
784e39fd77fSBarry Smith   ierr = MPI_File_read_all(fd,data,cnt,dtype,status);CHKERRQ(ierr);
785e39fd77fSBarry Smith   ierr = PetscByteSwap(data,pdtype,cnt);CHKERRQ(ierr);
786a6796414SBarry Smith   PetscFunctionReturn(0);
787e39fd77fSBarry Smith }
788e39fd77fSBarry Smith #endif
789951e3c8eSBarry Smith #endif
790