Apply clang-tidy-8 readability-uppercase-literal-suffix
[gromacs.git] / src / gromacs / fileio / gmx_internal_xdr.cpp
blob22760e89ffe93dd90a46a24cf02e0976911769d6
1 /*
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,2018,2019, 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.
37 #include "gmxpre.h"
39 #include "config.h"
41 #if GMX_INTERNAL_XDR
44 #include "gmx_internal_xdr.h"
46 #include <cstdlib>
47 #include <cstring>
50 /* NB - THIS FILE IS ONLY USED ON MICROSOFT WINDOWS, since that
51 * system doesn't provide any standard XDR system libraries. It will
52 * most probably work on other platforms too, but make sure you
53 * test that the xtc files produced are ok before using it.
55 * This header file contains Gromacs versions of the definitions for
56 * Sun External Data Representation (XDR) headers and routines.
58 * On most UNIX systems this is already present as part of your
59 * system libraries, but since we want to make Gromacs portable to
60 * platforms like Microsoft Windows we have created a private version
61 * of the necessary routines and distribute them with the Gromacs source.
63 * Although the rest of Gromacs is LGPL, you can copy and use the XDR
64 * routines in any way you want as long as you obey Sun's license:
66 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
67 * unrestricted use provided that this legend is included on all tape
68 * media and as a part of the software program in whole or part. Users
69 * may copy or modify Sun RPC without charge, but are not authorized
70 * to license or distribute it to anyone else except as part of a product or
71 * program developed by the user.
73 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
74 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
75 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
77 * Sun RPC is provided with no support and without any obligation on the
78 * part of Sun Microsystems, Inc. to assist in its use, correction,
79 * modification or enhancement.
81 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
82 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
83 * OR ANY PART THEREOF.
85 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
86 * or profits or other special, indirect and consequential damages, even if
87 * Sun has been advised of the possibility of such damages.
89 * Sun Microsystems, Inc.
90 * 2550 Garcia Avenue
91 * Mountain View, California 94043
97 * for unit alignment
99 static char xdr_zero[BYTES_PER_XDR_UNIT] = {0, 0, 0, 0};
101 static xdr_uint32_t xdr_swapbytes(xdr_uint32_t x)
103 xdr_uint32_t y;
104 int i;
105 char *px = reinterpret_cast<char *>(&x);
106 char *py = reinterpret_cast<char *>(&y);
108 for (i = 0; i < 4; i++)
110 py[i] = px[3-i];
113 return y;
116 static xdr_uint32_t xdr_htonl(xdr_uint32_t x)
118 short s = 0x0F00;
119 if (*(reinterpret_cast<char *>(&s)) == static_cast<char>(0x0F))
121 /* bigendian, do nothing */
122 return x;
124 else
126 /* smallendian,swap bytes */
127 return xdr_swapbytes(x);
131 static xdr_uint32_t xdr_ntohl(xdr_uint32_t x)
133 short s = 0x0F00;
134 if (*(reinterpret_cast<char *>(&s)) == static_cast<char>(0x0F))
136 /* bigendian, do nothing */
137 return x;
139 else
141 /* smallendian, swap bytes */
142 return xdr_swapbytes(x);
148 * Free a data structure using XDR
149 * Not a filter, but a convenient utility nonetheless
151 void
152 xdr_free (xdrproc_t proc, char *objp)
154 XDR x;
156 x.x_op = XDR_FREE;
157 (*proc) ( &x, objp);
161 * XDR nothing
163 bool_t
164 xdr_void ()
166 return TRUE;
170 * XDR integers
172 bool_t
173 xdr_int (XDR *xdrs, int *ip)
175 xdr_int32_t l;
177 switch (xdrs->x_op)
179 case XDR_ENCODE:
180 l = static_cast<xdr_int32_t>(*ip);
181 return xdr_putint32 (xdrs, &l);
183 case XDR_DECODE:
184 if (!xdr_getint32 (xdrs, &l))
186 return FALSE;
188 *ip = static_cast<int>(l);
189 return TRUE;
191 case XDR_FREE:
192 return TRUE;
194 return FALSE;
199 * XDR unsigned integers
201 bool_t
202 xdr_u_int (XDR *xdrs, unsigned int *up)
204 xdr_uint32_t l;
206 switch (xdrs->x_op)
208 case XDR_ENCODE:
209 l = static_cast<xdr_uint32_t>(*up);
210 return xdr_putuint32 (xdrs, &l);
212 case XDR_DECODE:
213 if (!xdr_getuint32 (xdrs, &l))
215 return FALSE;
217 *up = static_cast<unsigned int>(l);
218 return TRUE;
220 case XDR_FREE:
221 return TRUE;
223 return FALSE;
230 * XDR short integers
232 bool_t
233 xdr_short (XDR *xdrs, short *sp)
235 xdr_int32_t l;
237 switch (xdrs->x_op)
239 case XDR_ENCODE:
240 l = static_cast<xdr_int32_t>(*sp);
241 return xdr_putint32 (xdrs, &l);
243 case XDR_DECODE:
244 if (!xdr_getint32 (xdrs, &l))
246 return FALSE;
248 *sp = static_cast<short>(l);
249 return TRUE;
251 case XDR_FREE:
252 return TRUE;
254 return FALSE;
259 * XDR unsigned short integers
261 bool_t
262 xdr_u_short (XDR *xdrs, unsigned short *usp)
264 xdr_uint32_t l;
266 switch (xdrs->x_op)
268 case XDR_ENCODE:
269 l = static_cast<xdr_uint32_t>(*usp);
270 return xdr_putuint32 (xdrs, &l);
272 case XDR_DECODE:
273 if (!xdr_getuint32 (xdrs, &l))
275 return FALSE;
277 *usp = static_cast<unsigned short>(l);
278 return TRUE;
280 case XDR_FREE:
281 return TRUE;
283 return FALSE;
288 * XDR a char
290 bool_t
291 xdr_char (XDR *xdrs, char *cp)
293 int i;
295 i = (*cp);
296 if (!xdr_int (xdrs, &i))
298 return FALSE;
300 *cp = i;
301 return TRUE;
305 * XDR an unsigned char
307 bool_t
308 xdr_u_char (XDR *xdrs, unsigned char *cp)
310 unsigned int u;
312 u = (*cp);
313 if (!xdr_u_int (xdrs, &u))
315 return FALSE;
317 *cp = u;
318 return TRUE;
322 * XDR booleans
324 bool_t
325 xdr_bool (XDR *xdrs, int *bp)
327 #define XDR_FALSE ((xdr_int32_t) 0)
328 #define XDR_TRUE ((xdr_int32_t) 1)
330 xdr_int32_t lb;
332 switch (xdrs->x_op)
334 case XDR_ENCODE:
335 lb = *bp ? XDR_TRUE : XDR_FALSE;
336 return xdr_putint32 (xdrs, &lb);
338 case XDR_DECODE:
339 if (!xdr_getint32 (xdrs, &lb))
341 return FALSE;
343 *bp = (lb == XDR_FALSE) ? FALSE : TRUE;
344 return TRUE;
346 case XDR_FREE:
347 return TRUE;
349 return FALSE;
350 #undef XDR_FALSE
351 #undef XDR_TRUE
357 * XDR opaque data
358 * Allows the specification of a fixed size sequence of opaque bytes.
359 * cp points to the opaque object and cnt gives the byte length.
361 bool_t
362 xdr_opaque (XDR *xdrs, char *cp, unsigned int cnt)
364 unsigned int rndup;
365 char crud[BYTES_PER_XDR_UNIT];
368 * if no data we are done
370 if (cnt == 0)
372 return TRUE;
376 * round byte count to full xdr units
378 rndup = cnt % BYTES_PER_XDR_UNIT;
379 if (rndup > 0)
381 rndup = BYTES_PER_XDR_UNIT - rndup;
384 switch (xdrs->x_op)
386 case XDR_DECODE:
387 if (!xdr_getbytes (xdrs, cp, cnt))
389 return FALSE;
391 if (rndup == 0)
393 return TRUE;
395 return xdr_getbytes (xdrs, crud, rndup);
397 case XDR_ENCODE:
398 if (!xdr_putbytes (xdrs, cp, cnt))
400 return FALSE;
402 if (rndup == 0)
404 return TRUE;
406 return xdr_putbytes (xdrs, xdr_zero, rndup);
408 case XDR_FREE:
409 return TRUE;
411 return FALSE;
416 * XDR null terminated ASCII strings
417 * xdr_string deals with "C strings" - arrays of bytes that are
418 * terminated by a NULL character. The parameter cpp references a
419 * pointer to storage; If the pointer is null, then the necessary
420 * storage is allocated. The last parameter is the max allowed length
421 * of the string as specified by a protocol.
423 bool_t xdr_string (XDR *xdrs, char ** cpp, unsigned int maxsize)
425 char *sp = *cpp; /* sp is the actual string pointer */
426 unsigned int size = 0;
427 unsigned int nodesize = 0;
430 * first deal with the length since xdr strings are counted-strings
432 switch (xdrs->x_op)
434 case XDR_FREE:
435 if (sp == nullptr)
437 return TRUE; /* already free */
439 size = std::strlen (sp);
440 break;
442 case XDR_ENCODE:
443 if (sp == nullptr)
445 return FALSE;
447 size = std::strlen (sp);
448 break;
449 case XDR_DECODE:
450 break;
453 if (!xdr_u_int (xdrs, &size))
455 return FALSE;
457 if (size > maxsize)
459 return FALSE;
461 nodesize = size + 1;
464 * now deal with the actual bytes
466 switch (xdrs->x_op)
468 case XDR_DECODE:
469 if (nodesize == 0)
471 return TRUE;
473 if (sp == nullptr)
475 *cpp = sp = static_cast<char *>(std::malloc (nodesize));
477 if (sp == nullptr)
479 (void) fputs ("xdr_string: out of memory\n", stderr);
480 return FALSE;
482 sp[size] = 0;
483 return xdr_opaque (xdrs, sp, size);
485 case XDR_ENCODE:
486 return xdr_opaque (xdrs, sp, size);
488 case XDR_FREE:
489 free (sp);
490 *cpp = nullptr;
491 return TRUE;
493 return FALSE;
498 /* Floating-point stuff */
500 bool_t xdr_float(XDR * xdrs, float * fp)
502 xdr_int32_t tmp;
504 switch (xdrs->x_op)
507 case XDR_ENCODE:
508 tmp = *(reinterpret_cast<xdr_int32_t *>(fp));
509 return (xdr_putint32(xdrs, &tmp));
511 case XDR_DECODE:
512 if (xdr_getint32(xdrs, &tmp))
514 *(reinterpret_cast<xdr_int32_t *>(fp)) = tmp;
515 return (TRUE);
518 break;
520 case XDR_FREE:
521 return (TRUE);
523 return (FALSE);
527 bool_t xdr_double(XDR * xdrs, double * dp)
530 /* Windows and some other systems dont define double-precision
531 * word order in the header files, so unfortunately we have
532 * to calculate it!
534 * For thread safety, we calculate it every time: locking this would
535 * be more expensive.
537 /*static int LSW=-1;*/ /* Least significant fp word */
538 int LSW = -1; /* Least significant fp word */
541 int *ip;
542 xdr_int32_t tmp[2];
544 if (LSW < 0)
546 double x = 0.987654321; /* Just a number */
548 /* Possible representations in IEEE double precision:
549 * (S=small endian, B=big endian)
551 * Byte order, Word order, Hex
552 * S S b8 56 0e 3c dd 9a ef 3f
553 * B S 3c 0e 56 b8 3f ef 9a dd
554 * S B dd 9a ef 3f b8 56 0e 3c
555 * B B 3f ef 9a dd 3c 0e 56 b8
558 unsigned char ix = *(reinterpret_cast<char *>(&x));
560 if (ix == 0xdd || ix == 0x3f)
562 LSW = 1; /* Big endian word order */
564 else if (ix == 0xb8 || ix == 0x3c)
566 LSW = 0; /* Small endian word order */
568 else /* Catch strange errors */
570 printf("Error when detecting floating-point word order.\n"
571 "Do you have a non-IEEE system?\n"
572 "If possible, use the XDR libraries provided with your system,\n"
573 "instead of the GROMACS fallback XDR source.\n");
574 exit(0);
578 switch (xdrs->x_op)
581 case XDR_ENCODE:
582 ip = reinterpret_cast<int *>(dp);
583 tmp[0] = ip[bool(LSW == 0)];
584 tmp[1] = ip[LSW];
585 return static_cast<bool_t>(bool(xdr_putint32(xdrs, tmp)) &&
586 bool(xdr_putint32(xdrs, tmp+1)));
588 case XDR_DECODE:
589 ip = reinterpret_cast<int *>(dp);
590 if (xdr_getint32(xdrs, tmp+!LSW) &&
591 xdr_getint32(xdrs, tmp+LSW))
593 ip[0] = tmp[0];
594 ip[1] = tmp[1];
595 return (TRUE);
598 break;
600 case XDR_FREE:
601 return (TRUE);
603 return (FALSE);
607 /* Array routines */
610 * xdr_vector():
612 * XDR a fixed length array. Unlike variable-length arrays,
613 * the storage of fixed length arrays is static and unfreeable.
614 * > basep: base of the array
615 * > size: size of the array
616 * > elemsize: size of each element
617 * > xdr_elem: routine to XDR each element
619 bool_t xdr_vector (XDR * xdrs, char * basep, unsigned int nelem,
620 unsigned int elemsize, xdrproc_t xdr_elem)
622 #define LASTUNSIGNED ((unsigned int)0-1)
623 unsigned int i;
624 char *elptr;
626 elptr = basep;
627 for (i = 0; i < nelem; i++)
629 if (!(*xdr_elem) (xdrs, elptr, LASTUNSIGNED))
631 return FALSE;
633 elptr += elemsize;
635 return TRUE;
636 #undef LASTUNSIGNED
641 static bool_t xdrstdio_getbytes (XDR * /*xdrs*/, char * /*addr*/, unsigned int /*len*/);
642 static bool_t xdrstdio_putbytes (XDR * /*xdrs*/, char * /*addr*/, unsigned int /*len*/);
643 static unsigned int xdrstdio_getpos (XDR * /*xdrs*/);
644 static bool_t xdrstdio_setpos (XDR * /*xdrs*/, unsigned int /*pos*/);
645 static xdr_int32_t *xdrstdio_inline (XDR * /*xdrs*/, int /*len*/);
646 static void xdrstdio_destroy (XDR * /*xdrs*/);
647 static bool_t xdrstdio_getint32 (XDR * /*xdrs*/, xdr_int32_t * /*ip*/);
648 static bool_t xdrstdio_putint32 (XDR * /*xdrs*/, xdr_int32_t * /*ip*/);
649 static bool_t xdrstdio_getuint32 (XDR * /*xdrs*/, xdr_uint32_t * /*ip*/);
650 static bool_t xdrstdio_putuint32 (XDR * /*xdrs*/, xdr_uint32_t * /*ip*/);
653 * Destroy a stdio xdr stream.
654 * Cleans up the xdr stream handle xdrs previously set up by xdrstdio_create.
656 static void
657 xdrstdio_destroy (XDR *xdrs)
659 fflush (reinterpret_cast<FILE *>(xdrs->x_private));
660 /* xx should we close the file ?? */
664 static bool_t
665 xdrstdio_getbytes (XDR *xdrs, char *addr, unsigned int len)
667 if ((len != 0) && (fread (addr, static_cast<int>(len), 1,
668 reinterpret_cast<FILE *>(xdrs->x_private)) != 1))
670 return FALSE;
672 return TRUE;
675 static bool_t
676 xdrstdio_putbytes (XDR *xdrs, char *addr, unsigned int len)
678 if ((len != 0) && (fwrite (addr, static_cast<int>(len), 1,
679 reinterpret_cast<FILE *>(xdrs->x_private)) != 1))
681 return FALSE;
683 return TRUE;
686 static unsigned int
687 xdrstdio_getpos (XDR *xdrs)
689 return static_cast<int>(ftell (reinterpret_cast<FILE *>(xdrs->x_private)));
692 static bool_t
693 xdrstdio_setpos (XDR *xdrs, unsigned int pos)
695 return fseek (reinterpret_cast<FILE *>(xdrs->x_private), static_cast<xdr_int32_t>(pos), 0) < 0 ? FALSE : TRUE;
698 static xdr_int32_t *
699 xdrstdio_inline (XDR *xdrs, int len)
701 (void)xdrs;
702 (void)len;
704 * Must do some work to implement this: must insure
705 * enough data in the underlying stdio buffer,
706 * that the buffer is aligned so that we can indirect through a
707 * long *, and stuff this pointer in xdrs->x_buf. Doing
708 * a fread or fwrite to a scratch buffer would defeat
709 * most of the gains to be had here and require storage
710 * management on this buffer, so we don't do this.
712 return nullptr;
715 static bool_t
716 xdrstdio_getint32 (XDR *xdrs, xdr_int32_t *ip)
718 xdr_int32_t mycopy;
720 if (fread (&mycopy, 4, 1, reinterpret_cast<FILE *>(xdrs->x_private)) != 1)
722 return FALSE;
724 *ip = xdr_ntohl (mycopy);
725 return TRUE;
728 static bool_t
729 xdrstdio_putint32 (XDR *xdrs, xdr_int32_t *ip)
731 xdr_int32_t mycopy = xdr_htonl (*ip);
733 ip = &mycopy;
734 if (fwrite (ip, 4, 1, reinterpret_cast<FILE *>(xdrs->x_private)) != 1)
736 return FALSE;
738 return TRUE;
741 static bool_t
742 xdrstdio_getuint32 (XDR *xdrs, xdr_uint32_t *ip)
744 xdr_uint32_t mycopy;
746 if (fread (&mycopy, 4, 1, reinterpret_cast<FILE *>(xdrs->x_private)) != 1)
748 return FALSE;
750 *ip = xdr_ntohl (mycopy);
751 return TRUE;
754 static bool_t
755 xdrstdio_putuint32 (XDR *xdrs, xdr_uint32_t *ip)
757 xdr_uint32_t mycopy = xdr_htonl (*ip);
759 ip = &mycopy;
760 if (fwrite (ip, 4, 1, reinterpret_cast<FILE *>(xdrs->x_private)) != 1)
762 return FALSE;
764 return TRUE;
768 * Ops vector for stdio type XDR
770 static struct XDR::xdr_ops xdrstdio_ops =
772 xdrstdio_getbytes, /* deserialize counted bytes */
773 xdrstdio_putbytes, /* serialize counted bytes */
774 xdrstdio_getpos, /* get offset in the stream */
775 xdrstdio_setpos, /* set offset in the stream */
776 xdrstdio_inline, /* prime stream for inline macros */
777 xdrstdio_destroy, /* destroy stream */
778 xdrstdio_getint32, /* deserialize a int */
779 xdrstdio_putint32, /* serialize a int */
780 xdrstdio_getuint32, /* deserialize a int */
781 xdrstdio_putuint32 /* serialize a int */
785 * Initialize a stdio xdr stream.
786 * Sets the xdr stream handle xdrs for use on the stream file.
787 * Operation flag is set to op.
789 void
790 xdrstdio_create (XDR *xdrs, FILE *file, enum xdr_op op)
792 xdrs->x_op = op;
793 xdrs->x_ops = &xdrstdio_ops;
794 xdrs->x_private = reinterpret_cast<char *>(file);
795 xdrs->x_handy = 0;
796 xdrs->x_base = nullptr;
798 #endif /* GMX_INTERNAL_XDR */