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.
44 #include "gmx_internal_xdr.h"
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.
91 * Mountain View, California 94043
99 static char xdr_zero
[BYTES_PER_XDR_UNIT
] = {0, 0, 0, 0};
101 static xdr_uint32_t
xdr_swapbytes(xdr_uint32_t x
)
105 char *px
= reinterpret_cast<char *>(&x
);
106 char *py
= reinterpret_cast<char *>(&y
);
108 for (i
= 0; i
< 4; i
++)
116 static xdr_uint32_t
xdr_htonl(xdr_uint32_t x
)
119 if (*(reinterpret_cast<char *>(&s
)) == static_cast<char>(0x0F))
121 /* bigendian, do nothing */
126 /* smallendian,swap bytes */
127 return xdr_swapbytes(x
);
131 static xdr_uint32_t
xdr_ntohl(xdr_uint32_t x
)
134 if (*(reinterpret_cast<char *>(&s
)) == static_cast<char>(0x0F))
136 /* bigendian, do nothing */
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
152 xdr_free (xdrproc_t proc
, char *objp
)
173 xdr_int (XDR
*xdrs
, int *ip
)
180 l
= static_cast<xdr_int32_t
>(*ip
);
181 return xdr_putint32 (xdrs
, &l
);
184 if (!xdr_getint32 (xdrs
, &l
))
188 *ip
= static_cast<int>(l
);
199 * XDR unsigned integers
202 xdr_u_int (XDR
*xdrs
, unsigned int *up
)
209 l
= static_cast<xdr_uint32_t
>(*up
);
210 return xdr_putuint32 (xdrs
, &l
);
213 if (!xdr_getuint32 (xdrs
, &l
))
217 *up
= static_cast<unsigned int>(l
);
233 xdr_short (XDR
*xdrs
, short *sp
)
240 l
= static_cast<xdr_int32_t
>(*sp
);
241 return xdr_putint32 (xdrs
, &l
);
244 if (!xdr_getint32 (xdrs
, &l
))
248 *sp
= static_cast<short>(l
);
259 * XDR unsigned short integers
262 xdr_u_short (XDR
*xdrs
, unsigned short *usp
)
269 l
= static_cast<xdr_uint32_t
>(*usp
);
270 return xdr_putuint32 (xdrs
, &l
);
273 if (!xdr_getuint32 (xdrs
, &l
))
277 *usp
= static_cast<unsigned short>(l
);
291 xdr_char (XDR
*xdrs
, char *cp
)
296 if (!xdr_int (xdrs
, &i
))
305 * XDR an unsigned char
308 xdr_u_char (XDR
*xdrs
, unsigned char *cp
)
313 if (!xdr_u_int (xdrs
, &u
))
325 xdr_bool (XDR
*xdrs
, int *bp
)
327 #define XDR_FALSE ((xdr_int32_t) 0)
328 #define XDR_TRUE ((xdr_int32_t) 1)
335 lb
= *bp
? XDR_TRUE
: XDR_FALSE
;
336 return xdr_putint32 (xdrs
, &lb
);
339 if (!xdr_getint32 (xdrs
, &lb
))
343 *bp
= (lb
== XDR_FALSE
) ? FALSE
: TRUE
;
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.
362 xdr_opaque (XDR
*xdrs
, char *cp
, unsigned int cnt
)
365 char crud
[BYTES_PER_XDR_UNIT
];
368 * if no data we are done
376 * round byte count to full xdr units
378 rndup
= cnt
% BYTES_PER_XDR_UNIT
;
381 rndup
= BYTES_PER_XDR_UNIT
- rndup
;
387 if (!xdr_getbytes (xdrs
, cp
, cnt
))
395 return xdr_getbytes (xdrs
, crud
, rndup
);
398 if (!xdr_putbytes (xdrs
, cp
, cnt
))
406 return xdr_putbytes (xdrs
, xdr_zero
, rndup
);
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
437 return TRUE
; /* already free */
439 size
= std::strlen (sp
);
447 size
= std::strlen (sp
);
453 if (!xdr_u_int (xdrs
, &size
))
464 * now deal with the actual bytes
475 *cpp
= sp
= static_cast<char *>(std::malloc (nodesize
));
479 (void) fputs ("xdr_string: out of memory\n", stderr
);
483 return xdr_opaque (xdrs
, sp
, size
);
486 return xdr_opaque (xdrs
, sp
, size
);
498 /* Floating-point stuff */
500 bool_t
xdr_float(XDR
* xdrs
, float * fp
)
508 tmp
= *(reinterpret_cast<xdr_int32_t
*>(fp
));
509 return (xdr_putint32(xdrs
, &tmp
));
512 if (xdr_getint32(xdrs
, &tmp
))
514 *(reinterpret_cast<xdr_int32_t
*>(fp
)) = tmp
;
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
534 * For thread safety, we calculate it every time: locking this would
537 /*static int LSW=-1;*/ /* Least significant fp word */
538 int LSW
= -1; /* Least significant fp word */
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");
582 ip
= reinterpret_cast<int *>(dp
);
583 tmp
[0] = ip
[bool(LSW
== 0)];
585 return static_cast<bool_t
>(bool(xdr_putint32(xdrs
, tmp
)) &&
586 bool(xdr_putint32(xdrs
, tmp
+1)));
589 ip
= reinterpret_cast<int *>(dp
);
590 if (xdr_getint32(xdrs
, tmp
+!LSW
) &&
591 xdr_getint32(xdrs
, tmp
+LSW
))
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)
627 for (i
= 0; i
< nelem
; i
++)
629 if (!(*xdr_elem
) (xdrs
, elptr
, 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.
657 xdrstdio_destroy (XDR
*xdrs
)
659 fflush (reinterpret_cast<FILE *>(xdrs
->x_private
));
660 /* xx should we close the file ?? */
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))
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))
687 xdrstdio_getpos (XDR
*xdrs
)
689 return static_cast<int>(ftell (reinterpret_cast<FILE *>(xdrs
->x_private
)));
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
;
699 xdrstdio_inline (XDR
*xdrs
, int 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.
716 xdrstdio_getint32 (XDR
*xdrs
, xdr_int32_t
*ip
)
720 if (fread (&mycopy
, 4, 1, reinterpret_cast<FILE *>(xdrs
->x_private
)) != 1)
724 *ip
= xdr_ntohl (mycopy
);
729 xdrstdio_putint32 (XDR
*xdrs
, xdr_int32_t
*ip
)
731 xdr_int32_t mycopy
= xdr_htonl (*ip
);
734 if (fwrite (ip
, 4, 1, reinterpret_cast<FILE *>(xdrs
->x_private
)) != 1)
742 xdrstdio_getuint32 (XDR
*xdrs
, xdr_uint32_t
*ip
)
746 if (fread (&mycopy
, 4, 1, reinterpret_cast<FILE *>(xdrs
->x_private
)) != 1)
750 *ip
= xdr_ntohl (mycopy
);
755 xdrstdio_putuint32 (XDR
*xdrs
, xdr_uint32_t
*ip
)
757 xdr_uint32_t mycopy
= xdr_htonl (*ip
);
760 if (fwrite (ip
, 4, 1, reinterpret_cast<FILE *>(xdrs
->x_private
)) != 1)
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.
790 xdrstdio_create (XDR
*xdrs
, FILE *file
, enum xdr_op op
)
793 xdrs
->x_ops
= &xdrstdio_ops
;
794 xdrs
->x_private
= reinterpret_cast<char *>(file
);
796 xdrs
->x_base
= nullptr;
798 #endif /* GMX_INTERNAL_XDR */