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