xref: /petsc/src/sys/fileio/sysio.c (revision 8cc058d9cd56c1ccb3be12a47760ddfc446aaffc)
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);
33a297a907SKarl Rupp     for (i=0; i<(PetscInt)sizeof(PetscEnum); i++) ptr2[i] = ptr1[sizeof(PetscEnum)-1-i];
34a297a907SKarl Rupp     for (i=0; i<(PetscInt)sizeof(PetscEnum); i++) ptr1[i] = ptr2[i];
35e5c89e4eSSatish Balay   }
36e5c89e4eSSatish Balay   PetscFunctionReturn(0);
37e5c89e4eSSatish Balay }
386de02169SBarry Smith 
396de02169SBarry Smith #undef __FUNCT__
40acfcf0e5SJed Brown #define __FUNCT__ "PetscByteSwapBool"
416de02169SBarry Smith /*
42acfcf0e5SJed Brown   PetscByteSwapBool - Swap bytes in a  PETSc Bool
436de02169SBarry Smith 
446de02169SBarry Smith */
457087cfbeSBarry Smith PetscErrorCode  PetscByteSwapBool(PetscBool *buff,PetscInt n)
466de02169SBarry Smith {
476de02169SBarry Smith   PetscInt  i,j;
48ace3abfcSBarry Smith   PetscBool tmp = PETSC_FALSE;
49e0890e22SSatish Balay   char      *ptr1,*ptr2 = (char*)&tmp;
506de02169SBarry Smith 
516de02169SBarry Smith   PetscFunctionBegin;
526de02169SBarry Smith   for (j=0; j<n; j++) {
536de02169SBarry Smith     ptr1 = (char*)(buff + j);
54a297a907SKarl Rupp     for (i=0; i<(PetscInt)sizeof(PetscBool); i++) ptr2[i] = ptr1[sizeof(PetscBool)-1-i];
55a297a907SKarl Rupp     for (i=0; i<(PetscInt)sizeof(PetscBool); i++) ptr1[i] = ptr2[i];
566de02169SBarry Smith   }
576de02169SBarry Smith   PetscFunctionReturn(0);
586de02169SBarry Smith }
596de02169SBarry Smith 
60e5c89e4eSSatish Balay #undef __FUNCT__
61bd1d2e58SBarry Smith #define __FUNCT__ "PetscByteSwapInt"
62bd1d2e58SBarry Smith /*
636de02169SBarry Smith   PetscByteSwapInt - Swap bytes in a  PETSc integer (which may be 32 or 64 bits)
64bd1d2e58SBarry Smith 
65bd1d2e58SBarry Smith */
667087cfbeSBarry Smith PetscErrorCode  PetscByteSwapInt(PetscInt *buff,PetscInt n)
67bd1d2e58SBarry Smith {
68bd1d2e58SBarry Smith   PetscInt i,j,tmp = 0;
69e0890e22SSatish Balay   char     *ptr1,*ptr2 = (char*)&tmp;
70bd1d2e58SBarry Smith 
71bd1d2e58SBarry Smith   PetscFunctionBegin;
72bd1d2e58SBarry Smith   for (j=0; j<n; j++) {
73bd1d2e58SBarry Smith     ptr1 = (char*)(buff + j);
74a297a907SKarl Rupp     for (i=0; i<(PetscInt)sizeof(PetscInt); i++) ptr2[i] = ptr1[sizeof(PetscInt)-1-i];
75a297a907SKarl Rupp     for (i=0; i<(PetscInt)sizeof(PetscInt); i++) ptr1[i] = ptr2[i];
76bd1d2e58SBarry Smith   }
77bd1d2e58SBarry Smith   PetscFunctionReturn(0);
78bd1d2e58SBarry Smith }
79bd1d2e58SBarry Smith /* --------------------------------------------------------- */
80bd1d2e58SBarry Smith #undef __FUNCT__
81e5c89e4eSSatish Balay #define __FUNCT__ "PetscByteSwapShort"
82e5c89e4eSSatish Balay /*
83e5c89e4eSSatish Balay   PetscByteSwapShort - Swap bytes in a short
84e5c89e4eSSatish Balay */
857087cfbeSBarry Smith PetscErrorCode  PetscByteSwapShort(short *buff,PetscInt n)
86e5c89e4eSSatish Balay {
87e5c89e4eSSatish Balay   PetscInt i,j;
88e5c89e4eSSatish Balay   short    tmp;
89e5c89e4eSSatish Balay   char     *ptr1,*ptr2 = (char*)&tmp;
90e5c89e4eSSatish Balay 
91e5c89e4eSSatish Balay   PetscFunctionBegin;
92e5c89e4eSSatish Balay   for (j=0; j<n; j++) {
93e5c89e4eSSatish Balay     ptr1 = (char*)(buff + j);
94a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(short); i++) ptr2[i] = ptr1[sizeof(short)-1-i];
95a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(short); i++) ptr1[i] = ptr2[i];
96e5c89e4eSSatish Balay   }
97e5c89e4eSSatish Balay   PetscFunctionReturn(0);
98e5c89e4eSSatish Balay }
99e5c89e4eSSatish Balay /* --------------------------------------------------------- */
100e5c89e4eSSatish Balay #undef __FUNCT__
101e5c89e4eSSatish Balay #define __FUNCT__ "PetscByteSwapScalar"
102e5c89e4eSSatish Balay /*
103e5c89e4eSSatish Balay   PetscByteSwapScalar - Swap bytes in a double
104e5c89e4eSSatish Balay   Complex is dealt with as if array of double twice as long.
105e5c89e4eSSatish Balay */
1067087cfbeSBarry Smith PetscErrorCode  PetscByteSwapScalar(PetscScalar *buff,PetscInt n)
107e5c89e4eSSatish Balay {
108e5c89e4eSSatish Balay   PetscInt  i,j;
109e5c89e4eSSatish Balay   PetscReal tmp,*buff1 = (PetscReal*)buff;
110e5c89e4eSSatish Balay   char      *ptr1,*ptr2 = (char*)&tmp;
111e5c89e4eSSatish Balay 
112e5c89e4eSSatish Balay   PetscFunctionBegin;
113e5c89e4eSSatish Balay #if defined(PETSC_USE_COMPLEX)
114e5c89e4eSSatish Balay   n *= 2;
115e5c89e4eSSatish Balay #endif
116e5c89e4eSSatish Balay   for (j=0; j<n; j++) {
117e5c89e4eSSatish Balay     ptr1 = (char*)(buff1 + j);
118a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(PetscReal); i++) ptr2[i] = ptr1[sizeof(PetscReal)-1-i];
119a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(PetscReal); i++) ptr1[i] = ptr2[i];
120e5c89e4eSSatish Balay   }
121e5c89e4eSSatish Balay   PetscFunctionReturn(0);
122e5c89e4eSSatish Balay }
123e5c89e4eSSatish Balay /* --------------------------------------------------------- */
124e5c89e4eSSatish Balay #undef __FUNCT__
125e5c89e4eSSatish Balay #define __FUNCT__ "PetscByteSwapDouble"
126e5c89e4eSSatish Balay /*
127e5c89e4eSSatish Balay   PetscByteSwapDouble - Swap bytes in a double
128e5c89e4eSSatish Balay */
1297087cfbeSBarry Smith PetscErrorCode  PetscByteSwapDouble(double *buff,PetscInt n)
130e5c89e4eSSatish Balay {
131e5c89e4eSSatish Balay   PetscInt i,j;
132e5c89e4eSSatish Balay   double   tmp,*buff1 = (double*)buff;
133e5c89e4eSSatish Balay   char     *ptr1,*ptr2 = (char*)&tmp;
134e5c89e4eSSatish Balay 
135e5c89e4eSSatish Balay   PetscFunctionBegin;
136e5c89e4eSSatish Balay   for (j=0; j<n; j++) {
137e5c89e4eSSatish Balay     ptr1 = (char*)(buff1 + j);
138a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(double); i++) ptr2[i] = ptr1[sizeof(double)-1-i];
139a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(double); i++) ptr1[i] = ptr2[i];
140e5c89e4eSSatish Balay   }
141e5c89e4eSSatish Balay   PetscFunctionReturn(0);
142e5c89e4eSSatish Balay }
143e39fd77fSBarry Smith 
144e39fd77fSBarry Smith #undef __FUNCT__
145e95bf02fSSatish Balay #define __FUNCT__ "PetscByteSwapFloat"
146e95bf02fSSatish Balay /*
147e95bf02fSSatish Balay   PetscByteSwapFloat - Swap bytes in a float
148e95bf02fSSatish Balay */
149e95bf02fSSatish Balay PetscErrorCode PetscByteSwapFloat(float *buff,PetscInt n)
150e95bf02fSSatish Balay {
151e95bf02fSSatish Balay   PetscInt i,j;
152e95bf02fSSatish Balay   float    tmp,*buff1 = (float*)buff;
153e95bf02fSSatish Balay   char     *ptr1,*ptr2 = (char*)&tmp;
154e95bf02fSSatish Balay 
155e95bf02fSSatish Balay   PetscFunctionBegin;
156e95bf02fSSatish Balay   for (j=0; j<n; j++) {
157e95bf02fSSatish Balay     ptr1 = (char*)(buff1 + j);
158a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(float); i++) ptr2[i] = ptr1[sizeof(float)-1-i];
159a297a907SKarl Rupp     for (i=0; i<(PetscInt) sizeof(float); i++) ptr1[i] = ptr2[i];
160e95bf02fSSatish Balay   }
161e95bf02fSSatish Balay   PetscFunctionReturn(0);
162e95bf02fSSatish Balay }
163e95bf02fSSatish Balay 
164e95bf02fSSatish Balay #undef __FUNCT__
165e39fd77fSBarry Smith #define __FUNCT__ "PetscByteSwap"
166e39fd77fSBarry Smith PetscErrorCode PetscByteSwap(void *data,PetscDataType pdtype,PetscInt count)
167e39fd77fSBarry Smith {
168e39fd77fSBarry Smith   PetscErrorCode ierr;
169e39fd77fSBarry Smith 
170e39fd77fSBarry Smith   PetscFunctionBegin;
171e39fd77fSBarry Smith   if      (pdtype == PETSC_INT)    {ierr = PetscByteSwapInt((PetscInt*)data,count);CHKERRQ(ierr);}
172e39fd77fSBarry Smith   else if (pdtype == PETSC_ENUM)   {ierr = PetscByteSwapEnum((PetscEnum*)data,count);CHKERRQ(ierr);}
173acfcf0e5SJed Brown   else if (pdtype == PETSC_BOOL)   {ierr = PetscByteSwapBool((PetscBool*)data,count);CHKERRQ(ierr);}
174e39fd77fSBarry Smith   else if (pdtype == PETSC_SCALAR) {ierr = PetscByteSwapScalar((PetscScalar*)data,count);CHKERRQ(ierr);}
175e39fd77fSBarry Smith   else if (pdtype == PETSC_DOUBLE) {ierr = PetscByteSwapDouble((double*)data,count);CHKERRQ(ierr);}
176e95bf02fSSatish Balay   else if (pdtype == PETSC_FLOAT)  {ierr = PetscByteSwapFloat((float*)data,count);CHKERRQ(ierr);}
177e39fd77fSBarry Smith   else if (pdtype == PETSC_SHORT)  {ierr = PetscByteSwapShort((short*)data,count);CHKERRQ(ierr);}
178e39fd77fSBarry Smith   PetscFunctionReturn(0);
179e39fd77fSBarry Smith }
180e39fd77fSBarry Smith 
181e5c89e4eSSatish Balay /* --------------------------------------------------------- */
182e5c89e4eSSatish Balay #undef __FUNCT__
183e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryRead"
184e30d2299SSatish Balay /*@
185e5c89e4eSSatish Balay    PetscBinaryRead - Reads from a binary file.
186e5c89e4eSSatish Balay 
187e5c89e4eSSatish Balay    Not Collective
188e5c89e4eSSatish Balay 
189e5c89e4eSSatish Balay    Input Parameters:
190e5c89e4eSSatish Balay +  fd - the file
191e5c89e4eSSatish Balay .  n  - the number of items to read
192e5c89e4eSSatish Balay -  type - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR)
193e5c89e4eSSatish Balay 
194e5c89e4eSSatish Balay    Output Parameters:
195e5c89e4eSSatish Balay .  p - the buffer
196e5c89e4eSSatish Balay 
197e5c89e4eSSatish Balay 
198e5c89e4eSSatish Balay 
199e5c89e4eSSatish Balay    Level: developer
200e5c89e4eSSatish Balay 
201e5c89e4eSSatish Balay    Notes:
202e5c89e4eSSatish Balay    PetscBinaryRead() uses byte swapping to work on all machines; the files
203e5c89e4eSSatish Balay    are written to file ALWAYS using big-endian ordering. On small-endian machines the numbers
204e5c89e4eSSatish Balay    are converted to the small-endian format when they are read in from the file.
205e2e64c6bSBarry Smith    When PETSc is ./configure with --with-64bit-indices the integers are written to the
20654f21887SBarry Smith    file as 64 bit integers, this means they can only be read back in when the option --with-64bit-indices
20754f21887SBarry Smith    is used.
208e5c89e4eSSatish Balay 
209e5c89e4eSSatish Balay    Concepts: files^reading binary
210e5c89e4eSSatish Balay    Concepts: binary files^reading
211e5c89e4eSSatish Balay 
2124ebed01fSBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscViewerBinaryGetDescriptor(), PetscBinarySynchronizedWrite(),
2134ebed01fSBarry Smith           PetscBinarySynchronizedRead(), PetscBinarySynchronizedSeek()
214e5c89e4eSSatish Balay @*/
2157087cfbeSBarry Smith PetscErrorCode  PetscBinaryRead(int fd,void *p,PetscInt n,PetscDataType type)
216e5c89e4eSSatish Balay {
217e5c89e4eSSatish Balay   int               wsize,err;
218e5c89e4eSSatish Balay   size_t            m = (size_t) n,maxblock = 65536;
219e5c89e4eSSatish Balay   char              *pp = (char*)p;
2207a881295SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
2217a881295SBarry Smith   double            *ppp;
2227a881295SBarry Smith #endif
2237a881295SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN) || defined(PETSC_USE_REAL___FLOAT128)
2246de02169SBarry Smith   PetscErrorCode    ierr;
2257a881295SBarry Smith #endif
2267a881295SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
227e5c89e4eSSatish Balay   void              *ptmp = p;
228e5c89e4eSSatish Balay #endif
2292d53ad75SBarry Smith   char              fname[64];
2302d53ad75SBarry Smith   PetscBool         functionload = PETSC_FALSE;
231e5c89e4eSSatish Balay 
232e5c89e4eSSatish Balay   PetscFunctionBegin;
2332d53ad75SBarry Smith   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to write a negative amount of data %D",n);
234e5c89e4eSSatish Balay   if (!n) PetscFunctionReturn(0);
235e5c89e4eSSatish Balay 
2362d53ad75SBarry Smith   if (type == PETSC_FUNCTION) {
2372d53ad75SBarry Smith     functionload = PETSC_TRUE;
2382d53ad75SBarry Smith     m            = 64;
2392d53ad75SBarry Smith     type         = PETSC_CHAR;
2402d53ad75SBarry Smith     pp           = (char*)fname;
2412d53ad75SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
2422d53ad75SBarry Smith     ptmp         = (void*)fname;
2432d53ad75SBarry Smith #endif
2442d53ad75SBarry Smith   }
2452d53ad75SBarry Smith 
2466de02169SBarry Smith   if (type == PETSC_INT)          m *= sizeof(PetscInt);
247e5c89e4eSSatish Balay   else if (type == PETSC_SCALAR)  m *= sizeof(PetscScalar);
248e5c89e4eSSatish Balay   else if (type == PETSC_DOUBLE)  m *= sizeof(double);
249e95bf02fSSatish Balay   else if (type == PETSC_FLOAT)   m *= sizeof(float);
250e5c89e4eSSatish Balay   else if (type == PETSC_SHORT)   m *= sizeof(short);
251e5c89e4eSSatish Balay   else if (type == PETSC_CHAR)    m *= sizeof(char);
252e5c89e4eSSatish Balay   else if (type == PETSC_ENUM)    m *= sizeof(PetscEnum);
253ace3abfcSBarry Smith   else if (type == PETSC_BOOL)   m *= sizeof(PetscBool);
2549f7b6320SBarry Smith   else if (type == PETSC_BIT_LOGICAL) m  = PetscBTLength(m)*sizeof(char);
255e32f2f54SBarry Smith   else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown type");
256e5c89e4eSSatish Balay 
2577a881295SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
2587a881295SBarry Smith   /* If using __float128 precision we still read in doubles from file */
2597a881295SBarry Smith   if (type == PETSC_SCALAR) {
2607a881295SBarry Smith     m    = m/2;
2617a881295SBarry Smith     ierr = PetscMalloc(n*sizeof(double),&ppp);CHKERRQ(ierr);
2627a881295SBarry Smith     pp   = (char*)ppp;
2637a881295SBarry Smith   }
2647a881295SBarry Smith #endif
2657a881295SBarry Smith 
266e5c89e4eSSatish Balay   while (m) {
267e5c89e4eSSatish Balay     wsize = (m < maxblock) ? m : maxblock;
268e5c89e4eSSatish Balay     err   = read(fd,pp,wsize);
269e5c89e4eSSatish Balay     if (err < 0 && errno == EINTR) continue;
270e32f2f54SBarry Smith     if (!err && wsize > 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"Read past end of file");
271e32f2f54SBarry Smith     if (err < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_READ,"Error reading from file, errno %d",errno);
272e5c89e4eSSatish Balay     m  -= err;
273e5c89e4eSSatish Balay     pp += err;
274e5c89e4eSSatish Balay   }
2757a881295SBarry Smith 
2767a881295SBarry Smith #if defined(PETSC_USE_REAL___FLOAT128)
2777a881295SBarry Smith   if (type == PETSC_SCALAR) {
2787a881295SBarry Smith     PetscScalar *pv = (PetscScalar*) p;
2797a881295SBarry Smith     PetscInt    i;
2807a881295SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
2817a881295SBarry Smith     ierr = PetscByteSwapDouble(ppp,n);CHKERRQ(ierr);
2827a881295SBarry Smith #endif
283a297a907SKarl Rupp     for (i=0; i<n; i++) pv[i] = ppp[i];
2847a881295SBarry Smith     ierr = PetscFree(ppp);CHKERRQ(ierr);
2857a881295SBarry Smith     PetscFunctionReturn(0);
2867a881295SBarry Smith   }
2877a881295SBarry Smith #endif
2887a881295SBarry Smith 
289e5c89e4eSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN)
290e39fd77fSBarry Smith   ierr = PetscByteSwap(ptmp,type,n);CHKERRQ(ierr);
291e5c89e4eSSatish Balay #endif
292e5c89e4eSSatish Balay 
2932d53ad75SBarry Smith   if (functionload) {
2942d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
2950298fd71SBarry Smith     ierr = PetscDLSym(NULL,fname,(void**)p);CHKERRQ(ierr);
2962d53ad75SBarry Smith #else
2970298fd71SBarry Smith     *(void**)p = NULL;
2982d53ad75SBarry Smith #endif
2992d53ad75SBarry Smith   }
300e5c89e4eSSatish Balay   PetscFunctionReturn(0);
301e5c89e4eSSatish Balay }
302e5c89e4eSSatish Balay /* --------------------------------------------------------- */
303e5c89e4eSSatish Balay #undef __FUNCT__
304e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryWrite"
305e30d2299SSatish Balay /*@
306e5c89e4eSSatish Balay    PetscBinaryWrite - Writes to a binary file.
307e5c89e4eSSatish Balay 
308e5c89e4eSSatish Balay    Not Collective
309e5c89e4eSSatish Balay 
310e5c89e4eSSatish Balay    Input Parameters:
311e5c89e4eSSatish Balay +  fd     - the file
312e5c89e4eSSatish Balay .  p      - the buffer
313e5c89e4eSSatish Balay .  n      - the number of items to write
314e5c89e4eSSatish Balay .  type   - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR)
315e5c89e4eSSatish Balay -  istemp - PETSC_FALSE if buffer data should be preserved, PETSC_TRUE otherwise.
316e5c89e4eSSatish Balay 
317e5c89e4eSSatish Balay    Level: advanced
318e5c89e4eSSatish Balay 
319e5c89e4eSSatish Balay    Notes:
320e5c89e4eSSatish Balay    PetscBinaryWrite() uses byte swapping to work on all machines; the files
321e5c89e4eSSatish Balay    are written using big-endian ordering to the file. On small-endian machines the numbers
322e5c89e4eSSatish Balay    are converted to the big-endian format when they are written to disk.
323e2e64c6bSBarry Smith    When PETSc is ./configure with --with-64bit-indices the integers are written to the
32454f21887SBarry Smith    file as 64 bit integers, this means they can only be read back in when the option --with-64bit-indices
32554f21887SBarry Smith    is used.
326e5c89e4eSSatish Balay 
327e5c89e4eSSatish Balay    The Buffer p should be read-write buffer, and not static data.
328e5c89e4eSSatish Balay    This way, byte-swapping is done in-place, and then the buffer is
329e5c89e4eSSatish Balay    written to the file.
330e5c89e4eSSatish Balay 
331e5c89e4eSSatish Balay    This routine restores the original contents of the buffer, after
332e5c89e4eSSatish Balay    it is written to the file. This is done by byte-swapping in-place
333e5c89e4eSSatish Balay    the second time. If the flag istemp is set to PETSC_TRUE, the second
334e5c89e4eSSatish Balay    byte-swapping operation is not done, thus saving some computation,
335e5f36e38SBarry Smith    but the buffer is left corrupted.
336e5c89e4eSSatish Balay 
337300a7f5bSBarry Smith    Because byte-swapping may be done on the values in data it cannot be declared const
338300a7f5bSBarry Smith 
339e5c89e4eSSatish Balay    Concepts: files^writing binary
340e5c89e4eSSatish Balay    Concepts: binary files^writing
341e5c89e4eSSatish Balay 
3424ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryOpen(), PetscBinaryClose(), PetscViewerBinaryGetDescriptor(), PetscBinarySynchronizedWrite(),
3434ebed01fSBarry Smith           PetscBinarySynchronizedRead(), PetscBinarySynchronizedSeek()
344e5c89e4eSSatish Balay @*/
3457087cfbeSBarry Smith PetscErrorCode  PetscBinaryWrite(int fd,void *p,PetscInt n,PetscDataType type,PetscBool  istemp)
346e5c89e4eSSatish Balay {
347e5c89e4eSSatish Balay   char           *pp = (char*)p;
348e5c89e4eSSatish Balay   int            err,wsize;
349e5c89e4eSSatish Balay   size_t         m = (size_t)n,maxblock=65536;
350e5c89e4eSSatish Balay   PetscErrorCode ierr;
351f5351476SHong Zhang #if !defined(PETSC_WORDS_BIGENDIAN)
352e5c89e4eSSatish Balay   void           *ptmp = p;
353e5c89e4eSSatish Balay #endif
3542d53ad75SBarry Smith   char           fname[64];
355e5c89e4eSSatish Balay 
356e5c89e4eSSatish Balay   PetscFunctionBegin;
357e32f2f54SBarry Smith   if (n < 0) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Trying to write a negative amount of data %D",n);
358e5c89e4eSSatish Balay   if (!n) PetscFunctionReturn(0);
359e5c89e4eSSatish Balay 
3602d53ad75SBarry Smith   if (type == PETSC_FUNCTION) {
3612d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
3622d53ad75SBarry Smith     const char *fnametmp;
3632d53ad75SBarry Smith 
3642d53ad75SBarry Smith     if (n > 1) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"Can only binary view a single function at a time");
3652d53ad75SBarry Smith     ierr = PetscFPTFind(p,&fnametmp);CHKERRQ(ierr);
3662d53ad75SBarry Smith     ierr = PetscStrncpy(fname,fnametmp,64);CHKERRQ(ierr);
3672d53ad75SBarry Smith #else
3682d53ad75SBarry Smith     ierr = PetscStrncpy(fname,"",64);CHKERRQ(ierr);
3692d53ad75SBarry Smith #endif
3702d53ad75SBarry Smith     m    = 64;
3712d53ad75SBarry Smith     type = PETSC_CHAR;
3722d53ad75SBarry Smith     pp   = (char*)fname;
3732d53ad75SBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
3742d53ad75SBarry Smith     ptmp = (void*)fname;
3752d53ad75SBarry Smith #endif
3762d53ad75SBarry Smith   }
3772d53ad75SBarry Smith 
3786de02169SBarry Smith   if (type == PETSC_INT)          m *= sizeof(PetscInt);
379e5c89e4eSSatish Balay   else if (type == PETSC_SCALAR)  m *= sizeof(PetscScalar);
380e5c89e4eSSatish Balay   else if (type == PETSC_DOUBLE)  m *= sizeof(double);
381e95bf02fSSatish Balay   else if (type == PETSC_FLOAT)   m *= sizeof(float);
382e5c89e4eSSatish Balay   else if (type == PETSC_SHORT)   m *= sizeof(short);
383e5c89e4eSSatish Balay   else if (type == PETSC_CHAR)    m *= sizeof(char);
384e5c89e4eSSatish Balay   else if (type == PETSC_ENUM)    m *= sizeof(PetscEnum);
385ace3abfcSBarry Smith   else if (type == PETSC_BOOL)   m *= sizeof(PetscBool);
3869f7b6320SBarry Smith   else if (type == PETSC_BIT_LOGICAL) m = PetscBTLength(m)*sizeof(char);
387e32f2f54SBarry Smith   else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown type");
388e5c89e4eSSatish Balay 
389e5c89e4eSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN)
390e39fd77fSBarry Smith   ierr = PetscByteSwap(ptmp,type,n);CHKERRQ(ierr);
391e5c89e4eSSatish Balay #endif
392e5c89e4eSSatish Balay 
393e5c89e4eSSatish Balay   while (m) {
394e5c89e4eSSatish Balay     wsize = (m < maxblock) ? m : maxblock;
395e5c89e4eSSatish Balay     err   = write(fd,pp,wsize);
396e5c89e4eSSatish Balay     if (err < 0 && errno == EINTR) continue;
397e32f2f54SBarry Smith     if (err != wsize) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_FILE_WRITE,"Error writing to file.");
398e5c89e4eSSatish Balay     m  -= wsize;
399e5c89e4eSSatish Balay     pp += wsize;
400e5c89e4eSSatish Balay   }
401e5c89e4eSSatish Balay 
402b659c0ceSSatish Balay #if !defined(PETSC_WORDS_BIGENDIAN)
403e5c89e4eSSatish Balay   if (!istemp) {
404e39fd77fSBarry Smith     ierr = PetscByteSwap(ptmp,type,n);CHKERRQ(ierr);
405e5c89e4eSSatish Balay   }
406e5c89e4eSSatish Balay #endif
407e5c89e4eSSatish Balay   PetscFunctionReturn(0);
408e5c89e4eSSatish Balay }
409e5c89e4eSSatish Balay 
410e5c89e4eSSatish Balay #undef __FUNCT__
411e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryOpen"
412e5c89e4eSSatish Balay /*@C
413e5c89e4eSSatish Balay    PetscBinaryOpen - Opens a PETSc binary file.
414e5c89e4eSSatish Balay 
415e5c89e4eSSatish Balay    Not Collective
416e5c89e4eSSatish Balay 
417e5c89e4eSSatish Balay    Input Parameters:
418e5c89e4eSSatish Balay +  name - filename
41945c64e65SBarry Smith -  type - type of binary file, one of FILE_MODE_READ, FILE_MODE_APPEND, FILE_MODE_WRITE
420e5c89e4eSSatish Balay 
421e5c89e4eSSatish Balay    Output Parameter:
422e5c89e4eSSatish Balay .  fd - the file
423e5c89e4eSSatish Balay 
424e5c89e4eSSatish Balay    Level: advanced
425e5c89e4eSSatish Balay 
426e5c89e4eSSatish Balay   Concepts: files^opening binary
427e5c89e4eSSatish Balay   Concepts: binary files^opening
428e5c89e4eSSatish Balay 
429e5c89e4eSSatish Balay    Notes: Files access with PetscBinaryRead() and PetscBinaryWrite() are ALWAYS written in
430e5c89e4eSSatish Balay    big-endian format. This means the file can be accessed using PetscBinaryOpen() and
431e5c89e4eSSatish Balay    PetscBinaryRead() and PetscBinaryWrite() on any machine.
432e5c89e4eSSatish Balay 
4334ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscFileMode, PetscViewerFileSetMode(), PetscViewerBinaryGetDescriptor(),
4344ebed01fSBarry Smith           PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(), PetscBinarySynchronizedSeek()
43545c64e65SBarry Smith 
436e5c89e4eSSatish Balay @*/
4377087cfbeSBarry Smith PetscErrorCode  PetscBinaryOpen(const char name[],PetscFileMode mode,int *fd)
438e5c89e4eSSatish Balay {
439e5c89e4eSSatish Balay   PetscFunctionBegin;
440e5c89e4eSSatish Balay #if defined(PETSC_HAVE_O_BINARY)
44145c64e65SBarry Smith   if (mode == FILE_MODE_WRITE) {
442a297a907SKarl 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);
44345c64e65SBarry Smith   } else if (mode == FILE_MODE_READ) {
444a297a907SKarl 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);
44545c64e65SBarry Smith   } else if (mode == FILE_MODE_APPEND) {
446a297a907SKarl 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);
447e5c89e4eSSatish Balay #else
44845c64e65SBarry Smith   if (mode == FILE_MODE_WRITE) {
449a297a907SKarl Rupp     if ((*fd = creat(name,0666)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot create file for writing: %s",name);
45045c64e65SBarry Smith   } else if (mode == FILE_MODE_READ) {
451a297a907SKarl Rupp     if ((*fd = open(name,O_RDONLY,0)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file for reading: %s",name);
452e5c89e4eSSatish Balay   }
45345c64e65SBarry Smith   else if (mode == FILE_MODE_APPEND) {
454a297a907SKarl Rupp     if ((*fd = open(name,O_WRONLY,0)) == -1) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_FILE_OPEN,"Cannot open file for writing: %s",name);
455e5c89e4eSSatish Balay #endif
456e32f2f54SBarry Smith   } else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown file mode");
457e5c89e4eSSatish Balay   PetscFunctionReturn(0);
458e5c89e4eSSatish Balay }
459e5c89e4eSSatish Balay 
460e5c89e4eSSatish Balay #undef __FUNCT__
461e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinaryClose"
462e30d2299SSatish Balay /*@
463e5c89e4eSSatish Balay    PetscBinaryClose - Closes a PETSc binary file.
464e5c89e4eSSatish Balay 
465e5c89e4eSSatish Balay    Not Collective
466e5c89e4eSSatish Balay 
467e5c89e4eSSatish Balay    Output Parameter:
468e5c89e4eSSatish Balay .  fd - the file
469e5c89e4eSSatish Balay 
470e5c89e4eSSatish Balay    Level: advanced
471e5c89e4eSSatish Balay 
4724ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen(), PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(),
4734ebed01fSBarry Smith           PetscBinarySynchronizedSeek()
474e5c89e4eSSatish Balay @*/
4757087cfbeSBarry Smith PetscErrorCode  PetscBinaryClose(int fd)
476e5c89e4eSSatish Balay {
477e5c89e4eSSatish Balay   PetscFunctionBegin;
478e5c89e4eSSatish Balay   close(fd);
479e5c89e4eSSatish Balay   PetscFunctionReturn(0);
480e5c89e4eSSatish Balay }
481e5c89e4eSSatish Balay 
482e5c89e4eSSatish Balay 
483e5c89e4eSSatish Balay #undef __FUNCT__
484e5c89e4eSSatish Balay #define __FUNCT__ "PetscBinarySeek"
485e30d2299SSatish Balay /*@
486e5c89e4eSSatish Balay    PetscBinarySeek - Moves the file pointer on a PETSc binary file.
487e5c89e4eSSatish Balay 
488e5c89e4eSSatish Balay    Not Collective
489e5c89e4eSSatish Balay 
490e5c89e4eSSatish Balay    Input Parameters:
491e5c89e4eSSatish Balay +  fd - the file
492ff553b35SMatthew Knepley .  off - number of bytes to move. Use PETSC_BINARY_INT_SIZE, PETSC_BINARY_SCALAR_SIZE,
493e5c89e4eSSatish Balay             etc. in your calculation rather than sizeof() to compute byte lengths.
494ff553b35SMatthew Knepley -  whence - if PETSC_BINARY_SEEK_SET then off is an absolute location in the file
495ff553b35SMatthew Knepley             if PETSC_BINARY_SEEK_CUR then off is an offset from the current location
496ff553b35SMatthew Knepley             if PETSC_BINARY_SEEK_END then off is an offset from the end of file
497e5c89e4eSSatish Balay 
498e5c89e4eSSatish Balay    Output Parameter:
499e5c89e4eSSatish Balay .   offset - new offset in file
500e5c89e4eSSatish Balay 
501e5c89e4eSSatish Balay    Level: developer
502e5c89e4eSSatish Balay 
503e5c89e4eSSatish Balay    Notes:
504e5c89e4eSSatish Balay    Integers are stored on the file as 32 long, regardless of whether
505e5c89e4eSSatish Balay    they are stored in the machine as 32 or 64, this means the same
506e5c89e4eSSatish Balay    binary file may be read on any machine. Hence you CANNOT use sizeof()
507e5c89e4eSSatish Balay    to determine the offset or location.
508e5c89e4eSSatish Balay 
509e5c89e4eSSatish Balay    Concepts: files^binary seeking
510e5c89e4eSSatish Balay    Concepts: binary files^seeking
511e5c89e4eSSatish Balay 
5124ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen(), PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(),
5134ebed01fSBarry Smith           PetscBinarySynchronizedSeek()
514e5c89e4eSSatish Balay @*/
5157087cfbeSBarry Smith PetscErrorCode  PetscBinarySeek(int fd,off_t off,PetscBinarySeekType whence,off_t *offset)
516e5c89e4eSSatish Balay {
517e5c89e4eSSatish Balay   int iwhence = 0;
518e5c89e4eSSatish Balay 
519e5c89e4eSSatish Balay   PetscFunctionBegin;
520a297a907SKarl Rupp   if (whence == PETSC_BINARY_SEEK_SET) iwhence = SEEK_SET;
521a297a907SKarl Rupp   else if (whence == PETSC_BINARY_SEEK_CUR) iwhence = SEEK_CUR;
522a297a907SKarl Rupp   else if (whence == PETSC_BINARY_SEEK_END) iwhence = SEEK_END;
523a297a907SKarl Rupp   else SETERRQ(PETSC_COMM_SELF,PETSC_ERR_ARG_OUTOFRANGE,"Unknown seek location");
524e5c89e4eSSatish Balay #if defined(PETSC_HAVE_LSEEK)
525e5c89e4eSSatish Balay   *offset = lseek(fd,off,iwhence);
526e5c89e4eSSatish Balay #elif defined(PETSC_HAVE__LSEEK)
527e5c89e4eSSatish Balay   *offset = _lseek(fd,(long)off,iwhence);
528e5c89e4eSSatish Balay #else
529e32f2f54SBarry Smith   SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP_SYS,"System does not have a way of seeking on a file");
530e5c89e4eSSatish Balay #endif
531e5c89e4eSSatish Balay   PetscFunctionReturn(0);
532e5c89e4eSSatish Balay }
533e5c89e4eSSatish Balay 
534e5c89e4eSSatish Balay #undef __FUNCT__
5351d280d73SBarry Smith #define __FUNCT__ "PetscBinarySynchronizedRead"
536e5c89e4eSSatish Balay /*@C
5371d280d73SBarry Smith    PetscBinarySynchronizedRead - Reads from a binary file.
538e5c89e4eSSatish Balay 
539e5c89e4eSSatish Balay    Collective on MPI_Comm
540e5c89e4eSSatish Balay 
541e5c89e4eSSatish Balay    Input Parameters:
542e5c89e4eSSatish Balay +  comm - the MPI communicator
543e5c89e4eSSatish Balay .  fd - the file
544e5c89e4eSSatish Balay .  n  - the number of items to read
545e5c89e4eSSatish Balay -  type - the type of items to read (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR)
546e5c89e4eSSatish Balay 
547e5c89e4eSSatish Balay    Output Parameters:
548e5c89e4eSSatish Balay .  p - the buffer
549e5c89e4eSSatish Balay 
550e5c89e4eSSatish Balay    Options Database Key:
551e5c89e4eSSatish Balay .   -binary_longints - indicates the file was generated on a Cray vector
552e5c89e4eSSatish Balay          machine (not the T3E/D) and the ints are stored as 64 bit
553e5c89e4eSSatish Balay          quantities, otherwise they are stored as 32 bit
554e5c89e4eSSatish Balay 
555e5c89e4eSSatish Balay    Level: developer
556e5c89e4eSSatish Balay 
557e5c89e4eSSatish Balay    Notes:
558e5c89e4eSSatish Balay    Does a PetscBinaryRead() followed by an MPI_Bcast()
559e5c89e4eSSatish Balay 
5601d280d73SBarry Smith    PetscBinarySynchronizedRead() uses byte swapping to work on all machines.
561e5c89e4eSSatish Balay    Integers are stored on the file as 32 long, regardless of whether
562e5c89e4eSSatish Balay    they are stored in the machine as 32 or 64, this means the same
563e5c89e4eSSatish Balay    binary file may be read on any machine.
564e5c89e4eSSatish Balay 
565e5c89e4eSSatish Balay    Concepts: files^synchronized reading of binary files
566e5c89e4eSSatish Balay    Concepts: binary files^reading, synchronized
567e5c89e4eSSatish Balay 
5684ebed01fSBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscBinaryRead(), PetscBinarySynchronizedWrite(),
5694ebed01fSBarry Smith           PetscBinarySynchronizedSeek()
570e5c89e4eSSatish Balay @*/
5717087cfbeSBarry Smith PetscErrorCode  PetscBinarySynchronizedRead(MPI_Comm comm,int fd,void *p,PetscInt n,PetscDataType type)
572e5c89e4eSSatish Balay {
573e5c89e4eSSatish Balay   PetscErrorCode ierr;
574e5c89e4eSSatish Balay   PetscMPIInt    rank;
575e5c89e4eSSatish Balay   MPI_Datatype   mtype;
5762d53ad75SBarry Smith   char           *fname;
5772d53ad75SBarry Smith   PetscBool      functionload = PETSC_FALSE;
5780298fd71SBarry Smith   void           *ptmp        = NULL;
579e5c89e4eSSatish Balay 
580e5c89e4eSSatish Balay   PetscFunctionBegin;
5812d53ad75SBarry Smith   if (type == PETSC_FUNCTION) {
5822d53ad75SBarry Smith     functionload = PETSC_TRUE;
5832d53ad75SBarry Smith     n            = 64;
5842d53ad75SBarry Smith     type         = PETSC_CHAR;
5852d53ad75SBarry Smith     ptmp         = p;
5862d53ad75SBarry Smith     /* warning memory leak */
58798da9c48SSatish Balay     fname        = (char*)malloc(64*sizeof(char));
5882d53ad75SBarry Smith     p            = (void*)fname;
5892d53ad75SBarry Smith   }
5902d53ad75SBarry Smith 
591e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
592e5c89e4eSSatish Balay   if (!rank) {
593e5c89e4eSSatish Balay     ierr = PetscBinaryRead(fd,p,n,type);CHKERRQ(ierr);
594e5c89e4eSSatish Balay   }
595e5c89e4eSSatish Balay   ierr = PetscDataTypeToMPIDataType(type,&mtype);CHKERRQ(ierr);
596e5c89e4eSSatish Balay   ierr = MPI_Bcast(p,n,mtype,0,comm);CHKERRQ(ierr);
5972d53ad75SBarry Smith 
5982d53ad75SBarry Smith   if (functionload) {
5992d53ad75SBarry Smith #if defined(PETSC_SERIALIZE_FUNCTIONS)
6000298fd71SBarry Smith     ierr = PetscDLLibrarySym(PETSC_COMM_SELF,&PetscDLLibrariesLoaded,NULL,fname,(void**)ptmp);CHKERRQ(ierr);
6012d53ad75SBarry Smith #else
6020298fd71SBarry Smith     *(void**)ptmp = NULL;
6032d53ad75SBarry Smith #endif
6042d53ad75SBarry Smith   }
605e5c89e4eSSatish Balay   PetscFunctionReturn(0);
606e5c89e4eSSatish Balay }
607e5c89e4eSSatish Balay 
608e5c89e4eSSatish Balay #undef __FUNCT__
6091d280d73SBarry Smith #define __FUNCT__ "PetscBinarySynchronizedWrite"
610e5c89e4eSSatish Balay /*@C
6111d280d73SBarry Smith    PetscBinarySynchronizedWrite - writes to a binary file.
612e5c89e4eSSatish Balay 
613e5c89e4eSSatish Balay    Collective on MPI_Comm
614e5c89e4eSSatish Balay 
615e5c89e4eSSatish Balay    Input Parameters:
616e5c89e4eSSatish Balay +  comm - the MPI communicator
617e5c89e4eSSatish Balay .  fd - the file
618e5c89e4eSSatish Balay .  n  - the number of items to write
619e5c89e4eSSatish Balay .  p - the buffer
620e5c89e4eSSatish Balay .  istemp - the buffer may be changed
621e5c89e4eSSatish Balay -  type - the type of items to write (PETSC_INT, PETSC_DOUBLE or PETSC_SCALAR)
622e5c89e4eSSatish Balay 
623e5c89e4eSSatish Balay    Level: developer
624e5c89e4eSSatish Balay 
625e5c89e4eSSatish Balay    Notes:
626e5c89e4eSSatish Balay    Process 0 does a PetscBinaryWrite()
627e5c89e4eSSatish Balay 
6281d280d73SBarry Smith    PetscBinarySynchronizedWrite() uses byte swapping to work on all machines.
629e5c89e4eSSatish Balay    Integers are stored on the file as 32 long, regardless of whether
630e5c89e4eSSatish Balay    they are stored in the machine as 32 or 64, this means the same
631e5c89e4eSSatish Balay    binary file may be read on any machine.
632e5c89e4eSSatish Balay 
633300a7f5bSBarry Smith    Notes: because byte-swapping may be done on the values in data it cannot be declared const
634300a7f5bSBarry Smith 
6351d280d73SBarry Smith    WARNING: This is NOT like PetscSynchronizedFPrintf()! This routine ignores calls on all but process 0,
6361d280d73SBarry Smith    while PetscSynchronizedFPrintf() has all processes print their strings in order.
6371d280d73SBarry Smith 
638e5c89e4eSSatish Balay    Concepts: files^synchronized writing of binary files
639e5c89e4eSSatish Balay    Concepts: binary files^reading, synchronized
640e5c89e4eSSatish Balay 
6414ebed01fSBarry Smith .seealso: PetscBinaryWrite(), PetscBinaryOpen(), PetscBinaryClose(), PetscBinaryRead(), PetscBinarySynchronizedRead(),
6424ebed01fSBarry Smith           PetscBinarySynchronizedSeek()
643e5c89e4eSSatish Balay @*/
6447087cfbeSBarry Smith PetscErrorCode  PetscBinarySynchronizedWrite(MPI_Comm comm,int fd,void *p,PetscInt n,PetscDataType type,PetscBool istemp)
645e5c89e4eSSatish Balay {
646e5c89e4eSSatish Balay   PetscErrorCode ierr;
647e5c89e4eSSatish Balay   PetscMPIInt    rank;
648e5c89e4eSSatish Balay 
649e5c89e4eSSatish Balay   PetscFunctionBegin;
650e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
651e5c89e4eSSatish Balay   if (!rank) {
652e5c89e4eSSatish Balay     ierr = PetscBinaryWrite(fd,p,n,type,istemp);CHKERRQ(ierr);
653e5c89e4eSSatish Balay   }
654e5c89e4eSSatish Balay   PetscFunctionReturn(0);
655e5c89e4eSSatish Balay }
656e5c89e4eSSatish Balay 
657e5c89e4eSSatish Balay #undef __FUNCT__
6581d280d73SBarry Smith #define __FUNCT__ "PetscBinarySynchronizedSeek"
659e5c89e4eSSatish Balay /*@C
6601d280d73SBarry Smith    PetscBinarySynchronizedSeek - Moves the file pointer on a PETSc binary file.
661e5c89e4eSSatish Balay 
662e5c89e4eSSatish Balay 
663e5c89e4eSSatish Balay    Input Parameters:
664e5c89e4eSSatish Balay +  fd - the file
665e5c89e4eSSatish Balay .  whence - if PETSC_BINARY_SEEK_SET then size is an absolute location in the file
666e5c89e4eSSatish Balay             if PETSC_BINARY_SEEK_CUR then size is offset from current location
667e5c89e4eSSatish Balay             if PETSC_BINARY_SEEK_END then size is offset from end of file
668e5c89e4eSSatish Balay -  off    - number of bytes to move. Use PETSC_BINARY_INT_SIZE, PETSC_BINARY_SCALAR_SIZE,
669e5c89e4eSSatish Balay             etc. in your calculation rather than sizeof() to compute byte lengths.
670e5c89e4eSSatish Balay 
671e5c89e4eSSatish Balay    Output Parameter:
672e5c89e4eSSatish Balay .   offset - new offset in file
673e5c89e4eSSatish Balay 
674e5c89e4eSSatish Balay    Level: developer
675e5c89e4eSSatish Balay 
676e5c89e4eSSatish Balay    Notes:
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. Hence you CANNOT use sizeof()
680e5c89e4eSSatish Balay    to determine the offset or location.
681e5c89e4eSSatish Balay 
682e5c89e4eSSatish Balay    Concepts: binary files^seeking
683e5c89e4eSSatish Balay    Concepts: files^seeking in binary
684e5c89e4eSSatish Balay 
6854ebed01fSBarry Smith .seealso: PetscBinaryRead(), PetscBinaryWrite(), PetscBinaryOpen(), PetscBinarySynchronizedWrite(), PetscBinarySynchronizedRead(),
6864ebed01fSBarry Smith           PetscBinarySynchronizedSeek()
687e5c89e4eSSatish Balay @*/
6887087cfbeSBarry Smith PetscErrorCode  PetscBinarySynchronizedSeek(MPI_Comm comm,int fd,off_t off,PetscBinarySeekType whence,off_t *offset)
689e5c89e4eSSatish Balay {
690e5c89e4eSSatish Balay   PetscErrorCode ierr;
691e5c89e4eSSatish Balay   PetscMPIInt    rank;
692e5c89e4eSSatish Balay 
693e5c89e4eSSatish Balay   PetscFunctionBegin;
694e5c89e4eSSatish Balay   ierr = MPI_Comm_rank(comm,&rank);CHKERRQ(ierr);
695e5c89e4eSSatish Balay   if (!rank) {
696e5c89e4eSSatish Balay     ierr = PetscBinarySeek(fd,off,whence,offset);CHKERRQ(ierr);
697e5c89e4eSSatish Balay   }
698e5c89e4eSSatish Balay   PetscFunctionReturn(0);
699e5c89e4eSSatish Balay }
700e5c89e4eSSatish Balay 
7010fc9d207SBarry Smith #if defined(PETSC_HAVE_MPIIO)
702e39fd77fSBarry Smith #if !defined(PETSC_WORDS_BIGENDIAN)
703e39fd77fSBarry Smith 
704951e3c8eSBarry Smith #if defined(PETSC_USE_PETSC_MPI_EXTERNAL32)
705e39fd77fSBarry Smith /*
706e39fd77fSBarry Smith       MPICH does not provide the external32 representation for MPI_File_set_view() so we need to provide the functions.
707e39fd77fSBarry Smith     These are set into MPI in PetscInitialize() via MPI_Register_datarep()
708e39fd77fSBarry Smith 
709e39fd77fSBarry Smith     Note I use PetscMPIInt for the MPI error codes since that is what MPI uses (instead of the standard PetscErrorCode)
710e39fd77fSBarry Smith 
711951e3c8eSBarry Smith     The next three routines are not used because MPICH does not support their use
712e39fd77fSBarry Smith 
713e39fd77fSBarry Smith */
714*8cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_extent_fn(MPI_Datatype datatype,MPI_Aint *file_extent,void *extra_state)
715e39fd77fSBarry Smith {
716e39fd77fSBarry Smith   MPI_Aint    ub;
717e39fd77fSBarry Smith   PetscMPIInt ierr;
718e39fd77fSBarry Smith 
719e39fd77fSBarry Smith   ierr = MPI_Type_get_extent(datatype,&ub,file_extent);
720e39fd77fSBarry Smith   return ierr;
721e39fd77fSBarry Smith }
722e39fd77fSBarry Smith 
723*8cc058d9SJed Brown PETSC_EXTERN PetscMPIInt PetscDataRep_read_conv_fn(void *userbuf, MPI_Datatype datatype,PetscMPIInt count,void *filebuf, MPI_Offset position,void *extra_state)
724e39fd77fSBarry Smith {
725e39fd77fSBarry Smith   PetscDataType pdtype;
726e39fd77fSBarry Smith   PetscMPIInt   ierr;
727e39fd77fSBarry Smith   size_t        dsize;
728e39fd77fSBarry Smith 
729e39fd77fSBarry Smith   ierr = PetscMPIDataTypeToPetscDataType(datatype,&pdtype);CHKERRQ(ierr);
730e39fd77fSBarry Smith   ierr = PetscDataTypeGetSize(pdtype,&dsize);CHKERRQ(ierr);
731e39fd77fSBarry Smith 
732e39fd77fSBarry Smith   /* offset is given in units of MPI_Datatype */
733e39fd77fSBarry Smith   userbuf = ((char*)userbuf) + dsize*position;
734e39fd77fSBarry Smith 
735e39fd77fSBarry Smith   ierr = PetscMemcpy(userbuf,filebuf,count*dsize);CHKERRQ(ierr);
736e39fd77fSBarry Smith   ierr = PetscByteSwap(userbuf,pdtype,count);CHKERRQ(ierr);
737e39fd77fSBarry Smith   return ierr;
738e39fd77fSBarry Smith }
739e39fd77fSBarry Smith 
740e39fd77fSBarry Smith PetscMPIInt PetscDataRep_write_conv_fn(void *userbuf, MPI_Datatype datatype,PetscMPIInt count,void *filebuf, MPI_Offset position,void *extra_state)
741e39fd77fSBarry Smith {
742e39fd77fSBarry Smith   PetscDataType pdtype;
743e39fd77fSBarry Smith   PetscMPIInt   ierr;
744e39fd77fSBarry Smith   size_t        dsize;
745e39fd77fSBarry Smith 
746e39fd77fSBarry Smith   ierr = PetscMPIDataTypeToPetscDataType(datatype,&pdtype);CHKERRQ(ierr);
747e39fd77fSBarry Smith   ierr = PetscDataTypeGetSize(pdtype,&dsize);CHKERRQ(ierr);
748e39fd77fSBarry Smith 
749e39fd77fSBarry Smith   /* offset is given in units of MPI_Datatype */
750e39fd77fSBarry Smith   userbuf = ((char*)userbuf) + dsize*position;
751e39fd77fSBarry Smith 
752e39fd77fSBarry Smith   ierr = PetscMemcpy(filebuf,userbuf,count*dsize);CHKERRQ(ierr);
753e39fd77fSBarry Smith   ierr = PetscByteSwap(filebuf,pdtype,count);CHKERRQ(ierr);
754e39fd77fSBarry Smith   return ierr;
755e39fd77fSBarry Smith }
756951e3c8eSBarry Smith #endif
757e39fd77fSBarry Smith 
7581c91e6bcSJed Brown #undef __FUNCT__
7591c91e6bcSJed Brown #define __FUNCT__ "MPIU_File_write_all"
760e39fd77fSBarry Smith PetscErrorCode MPIU_File_write_all(MPI_File fd,void *data,PetscMPIInt cnt,MPI_Datatype dtype,MPI_Status *status)
761e39fd77fSBarry Smith {
762e39fd77fSBarry Smith   PetscErrorCode ierr;
763e39fd77fSBarry Smith   PetscDataType  pdtype;
764e39fd77fSBarry Smith 
765e39fd77fSBarry Smith   PetscFunctionBegin;
766e39fd77fSBarry Smith   ierr = PetscMPIDataTypeToPetscDataType(dtype,&pdtype);CHKERRQ(ierr);
767e39fd77fSBarry Smith   ierr = PetscByteSwap(data,pdtype,cnt);CHKERRQ(ierr);
768e39fd77fSBarry Smith   ierr = MPI_File_write_all(fd,data,cnt,dtype,status);CHKERRQ(ierr);
769e39fd77fSBarry Smith   ierr = PetscByteSwap(data,pdtype,cnt);CHKERRQ(ierr);
770a6796414SBarry Smith   PetscFunctionReturn(0);
771e39fd77fSBarry Smith }
772e39fd77fSBarry Smith 
7731c91e6bcSJed Brown #undef __FUNCT__
7741c91e6bcSJed Brown #define __FUNCT__ "MPIU_File_read_all"
775e39fd77fSBarry Smith PetscErrorCode MPIU_File_read_all(MPI_File fd,void *data,PetscMPIInt cnt,MPI_Datatype dtype,MPI_Status *status)
776e39fd77fSBarry Smith {
777e39fd77fSBarry Smith   PetscErrorCode ierr;
778e39fd77fSBarry Smith   PetscDataType  pdtype;
779e39fd77fSBarry Smith 
780e39fd77fSBarry Smith   PetscFunctionBegin;
781e39fd77fSBarry Smith   ierr = PetscMPIDataTypeToPetscDataType(dtype,&pdtype);CHKERRQ(ierr);
782e39fd77fSBarry Smith   ierr = MPI_File_read_all(fd,data,cnt,dtype,status);CHKERRQ(ierr);
783e39fd77fSBarry Smith   ierr = PetscByteSwap(data,pdtype,cnt);CHKERRQ(ierr);
784a6796414SBarry Smith   PetscFunctionReturn(0);
785e39fd77fSBarry Smith }
786e39fd77fSBarry Smith #endif
787951e3c8eSBarry Smith #endif
788