2 * This file is part of the GROMACS molecular simulation package.
4 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
5 * Copyright (c) 2001-2004, The GROMACS development team.
6 * Copyright (c) 2013,2014,2015, by the GROMACS development team, led by
7 * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
8 * and including many others, as listed in the AUTHORS file in the
9 * top-level source directory and at http://www.gromacs.org.
11 * GROMACS is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU Lesser General Public License
13 * as published by the Free Software Foundation; either version 2.1
14 * of the License, or (at your option) any later version.
16 * GROMACS is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 * Lesser General Public License for more details.
21 * You should have received a copy of the GNU Lesser General Public
22 * License along with GROMACS; if not, see
23 * http://www.gnu.org/licenses, or write to the Free Software Foundation,
24 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 * If you want to redistribute modifications to GROMACS, please
27 * consider that scientific software is very special. Version
28 * control is crucial - bugs must be traceable. We will be happy to
29 * consider code for inclusion in the official distribution, but
30 * derived work must not be called official GROMACS. Details are found
31 * in the README & COPYING files - if they are missing, get the
32 * official version at http://www.gromacs.org.
34 * To help us fund GROMACS development, we humbly ask that you cite
35 * the research papers on the package. Check out http://www.gromacs.org.
39 #include "gmxfio-xdr.h"
45 #include "gromacs/fileio/gmxfio.h"
46 #include "gromacs/fileio/xdrf.h"
47 #include "gromacs/utility/fatalerror.h"
48 #include "gromacs/utility/smalloc.h"
50 #include "gmxfio-impl.h"
52 /* Enumerated for data types in files */
54 eioREAL, eioFLOAT, eioDOUBLE, eioINT, eioINT64,
55 eioUCHAR, eioNUCHAR, eioUSHORT,
56 eioRVEC, eioNRVEC, eioIVEC, eioSTRING, eioNR
59 static const char *eioNames[eioNR] =
61 "REAL", "INT", "GMX_STE_T", "UCHAR", "NUCHAR", "USHORT", "RVEC", "NRVEC",
65 XDR *gmx_fio_getxdr(t_fileio *fio)
69 assert(fio->xdr != NULL);
75 /* check the number of items given against the type */
76 static void gmx_fio_check_nitem(int eio, int nitem, const char *file, int line)
78 if ((nitem != 1) && !((eio == eioNRVEC) || (eio == eioNUCHAR)))
81 "nitem (%d) may differ from 1 only for %s or %s, not for %s"
82 "(%s, %d)", nitem, eioNames[eioNUCHAR], eioNames[eioNRVEC],
83 eioNames[eio], file, line);
87 /* output a data type error. */
88 static void gmx_fio_fe(t_fileio *fio, int eio, const char *desc,
89 const char *srcfile, int line)
92 gmx_fatal(FARGS, "Trying to %s %s type %d (%s), src %s, line %d",
93 fio->bRead ? "read" : "write", desc, eio,
94 ((eio >= 0) && (eio < eioNR)) ? eioNames[eio] : "unknown",
98 /* This is the part that reads xdr files. */
100 static gmx_bool do_xdr(t_fileio *fio, void *item, int nitem, int eio,
101 const char *desc, const char *srcfile, int line)
103 unsigned char ucdum, *ucptr;
107 int j, m, *iptr, idum;
114 assert(fio->xdr != NULL);
115 gmx_fio_check_nitem(eio, nitem, srcfile, line);
121 if (item && !fio->bRead)
123 d = *((real *) item);
125 res = xdr_double(fio->xdr, &d);
128 *((real *) item) = d;
133 if (item && !fio->bRead)
135 f = *((real *) item);
137 res = xdr_float(fio->xdr, &f);
140 *((real *) item) = f;
145 if (item && !fio->bRead)
147 f = *((float *) item);
149 res = xdr_float(fio->xdr, &f);
152 *((float *) item) = f;
156 if (item && !fio->bRead)
158 d = *((double *) item);
160 res = xdr_double(fio->xdr, &d);
163 *((double *) item) = d;
167 if (item && !fio->bRead)
169 idum = *(int *) item;
171 res = xdr_int(fio->xdr, &idum);
174 *(int *) item = idum;
178 if (item && !fio->bRead)
180 sdum = *(gmx_int64_t *) item;
182 res = xdr_int64(fio->xdr, &sdum);
185 *(gmx_int64_t *) item = sdum;
189 if (item && !fio->bRead)
191 ucdum = *(unsigned char *) item;
193 res = xdr_u_char(fio->xdr, &ucdum);
196 *(unsigned char *) item = ucdum;
200 ucptr = (unsigned char *) item;
202 for (j = 0; (j < nitem) && res; j++)
204 res = xdr_u_char(fio->xdr, &(ucptr[j]));
208 if (item && !fio->bRead)
210 us = *(unsigned short *) item;
212 res = xdr_u_short(fio->xdr, (unsigned short *) &us);
215 *(unsigned short *) item = us;
221 if (item && !fio->bRead)
223 for (m = 0; (m < DIM); m++)
225 dvec[m] = ((real *) item)[m];
228 res = xdr_vector(fio->xdr, (char *) dvec, DIM,
229 (unsigned int) sizeof(double),
230 (xdrproc_t) xdr_double);
233 for (m = 0; (m < DIM); m++)
235 ((real *) item)[m] = dvec[m];
241 if (item && !fio->bRead)
243 for (m = 0; (m < DIM); m++)
245 fvec[m] = ((real *) item)[m];
248 res = xdr_vector(fio->xdr, (char *) fvec, DIM,
249 (unsigned int) sizeof(float),
250 (xdrproc_t) xdr_float);
253 for (m = 0; (m < DIM); m++)
255 ((real *) item)[m] = fvec[m];
263 for (j = 0; (j < nitem) && res; j++)
267 ptr = ((rvec *) item)[j];
269 res = do_xdr(fio, ptr, 1, eioRVEC, desc, srcfile, line);
275 for (m = 0; (m < DIM) && res; m++)
277 if (item && !fio->bRead)
281 res = xdr_int(fio->xdr, &idum);
297 slen = strlen((char *) item) + 1;
309 if (xdr_int(fio->xdr, &slen) <= 0)
311 gmx_fatal(FARGS, "wrong string length %d for string %s"
312 " (source %s, line %d)", slen, desc, srcfile, line);
314 if (!item && fio->bRead)
324 res = xdr_string(fio->xdr, &cptr, slen);
330 if (!item && fio->bRead)
337 gmx_fio_fe(fio, eio, desc, srcfile, line);
339 if ((res == 0) && (fio->bDebug))
341 fprintf(stderr, "Error in xdr I/O %s %s to file %s (source %s, line %d)\n",
342 eioNames[eio], desc, fio->fn, srcfile, line);
348 /*******************************************************************
350 * READ/WRITE FUNCTIONS
352 *******************************************************************/
354 gmx_bool gmx_fio_writee_string(t_fileio *fio, const char *item,
355 const char *desc, const char *srcfile, int line)
358 void *it = (void*)item; /* ugh.. */
360 ret = do_xdr(fio, it, 1, eioSTRING, desc, srcfile, line);
365 gmx_bool gmx_fio_doe_real(t_fileio *fio, real *item,
366 const char *desc, const char *srcfile, int line)
370 ret = do_xdr(fio, item, 1, eioREAL, desc, srcfile, line);
376 gmx_bool gmx_fio_doe_float(t_fileio *fio, float *item,
377 const char *desc, const char *srcfile, int line)
381 ret = do_xdr(fio, item, 1, eioFLOAT, desc, srcfile, line);
386 gmx_bool gmx_fio_doe_double(t_fileio *fio, double *item,
387 const char *desc, const char *srcfile, int line)
391 ret = do_xdr(fio, item, 1, eioDOUBLE, desc, srcfile, line);
397 gmx_bool gmx_fio_doe_gmx_bool(t_fileio *fio, gmx_bool *item,
398 const char *desc, const char *srcfile, int line)
406 ret = do_xdr(fio, &itmp, 1, eioINT, desc, srcfile, line);
412 ret = do_xdr(fio, &itmp, 1, eioINT, desc, srcfile, line);
418 gmx_bool gmx_fio_doe_int(t_fileio *fio, int *item,
419 const char *desc, const char *srcfile, int line)
423 ret = do_xdr(fio, item, 1, eioINT, desc, srcfile, line);
428 gmx_bool gmx_fio_doe_int64(t_fileio *fio, gmx_int64_t *item,
429 const char *desc, const char *srcfile, int line)
433 ret = do_xdr(fio, item, 1, eioINT64, desc, srcfile, line);
438 gmx_bool gmx_fio_doe_uchar(t_fileio *fio, unsigned char *item,
439 const char *desc, const char *srcfile, int line)
443 ret = do_xdr(fio, item, 1, eioUCHAR, desc, srcfile, line);
448 gmx_bool gmx_fio_doe_ushort(t_fileio *fio, unsigned short *item,
449 const char *desc, const char *srcfile, int line)
453 ret = do_xdr(fio, item, 1, eioUSHORT, desc, srcfile, line);
458 gmx_bool gmx_fio_doe_rvec(t_fileio *fio, rvec *item,
459 const char *desc, const char *srcfile, int line)
463 ret = do_xdr(fio, item, 1, eioRVEC, desc, srcfile, line);
468 gmx_bool gmx_fio_doe_ivec(t_fileio *fio, ivec *item,
469 const char *desc, const char *srcfile, int line)
473 ret = do_xdr(fio, item, 1, eioIVEC, desc, srcfile, line);
478 gmx_bool gmx_fio_doe_string(t_fileio *fio, char *item,
479 const char *desc, const char *srcfile, int line)
483 ret = do_xdr(fio, item, 1, eioSTRING, desc, srcfile, line);
489 /* Array reading & writing */
491 gmx_bool gmx_fio_ndoe_real(t_fileio *fio, real *item, int n,
492 const char *desc, const char *srcfile, int line)
497 for (i = 0; i < n; i++)
499 ret = ret && do_xdr(fio, &(item[i]), 1, eioREAL, desc,
508 gmx_bool gmx_fio_ndoe_float(t_fileio *fio, float *item, int n,
509 const char *desc, const char *srcfile, int line)
514 for (i = 0; i < n; i++)
516 ret = ret && do_xdr(fio, &(item[i]), 1, eioFLOAT, desc,
525 gmx_bool gmx_fio_ndoe_double(t_fileio *fio, double *item, int n,
526 const char *desc, const char *srcfile, int line)
531 for (i = 0; i < n; i++)
533 ret = ret && do_xdr(fio, &(item[i]), 1, eioDOUBLE, desc,
542 gmx_bool gmx_fio_ndoe_gmx_bool(t_fileio *fio, gmx_bool *item, int n,
543 const char *desc, const char *srcfile, int line)
549 for (i = 0; i < n; i++)
554 ret = ret && do_xdr(fio, &itmp, 1, eioINT, desc, srcfile, line);
560 ret = ret && do_xdr(fio, &itmp, 1, eioINT, desc, srcfile, line);
567 gmx_bool gmx_fio_ndoe_int(t_fileio *fio, int *item, int n,
568 const char *desc, const char *srcfile, int line)
573 for (i = 0; i < n; i++)
575 ret = ret && do_xdr(fio, &(item[i]), 1, eioINT, desc,
584 gmx_bool gmx_fio_ndoe_int64(t_fileio *fio, gmx_int64_t *item, int n,
585 const char *desc, const char *srcfile, int line)
590 for (i = 0; i < n; i++)
592 ret = ret && do_xdr(fio, &(item[i]), 1, eioINT64, desc,
601 gmx_bool gmx_fio_ndoe_uchar(t_fileio *fio, unsigned char *item, int n,
602 const char *desc, const char *srcfile, int line)
606 ret = ret && do_xdr(fio, item, n, eioNUCHAR, desc,
614 gmx_bool gmx_fio_ndoe_ushort(t_fileio *fio, unsigned short *item, int n,
615 const char *desc, const char *srcfile, int line)
620 for (i = 0; i < n; i++)
622 ret = ret && do_xdr(fio, &(item[i]), 1, eioUSHORT, desc,
631 gmx_bool gmx_fio_ndoe_rvec(t_fileio *fio, rvec *item, int n,
632 const char *desc, const char *srcfile, int line)
636 ret = ret && do_xdr(fio, item, n, eioNRVEC, desc, srcfile, line);
643 gmx_bool gmx_fio_ndoe_ivec(t_fileio *fio, ivec *item, int n,
644 const char *desc, const char *srcfile, int line)
649 for (i = 0; i < n; i++)
651 ret = ret && do_xdr(fio, &(item[i]), 1, eioIVEC, desc,
660 gmx_bool gmx_fio_ndoe_string(t_fileio *fio, char *item[], int n,
661 const char *desc, const char *srcfile, int line)
666 for (i = 0; i < n; i++)
668 ret = ret && do_xdr(fio, &(item[i]), 1, eioSTRING, desc,