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, 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 #ifdef GMX_INTERNAL_XDR
46 #include "gmx_system_xdr.h"
49 /* NB - THIS FILE IS ONLY USED ON MICROSOFT WINDOWS, since that
50 * system doesn't provide any standard XDR system libraries. It will
51 * most probably work on other platforms too, but make sure you
52 * test that the xtc files produced are ok before using it.
54 * This header file contains Gromacs versions of the definitions for
55 * Sun External Data Representation (XDR) headers and routines.
57 * On most UNIX systems this is already present as part of your
58 * system libraries, but since we want to make Gromacs portable to
59 * platforms like Microsoft Windows we have created a private version
60 * of the necessary routines and distribute them with the Gromacs source.
62 * Although the rest of Gromacs is LGPL, you can copy and use the XDR
63 * routines in any way you want as long as you obey Sun's license:
65 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
66 * unrestricted use provided that this legend is included on all tape
67 * media and as a part of the software program in whole or part. Users
68 * may copy or modify Sun RPC without charge, but are not authorized
69 * to license or distribute it to anyone else except as part of a product or
70 * program developed by the user.
72 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
73 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
74 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
76 * Sun RPC is provided with no support and without any obligation on the
77 * part of Sun Microsystems, Inc. to assist in its use, correction,
78 * modification or enhancement.
80 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
81 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
82 * OR ANY PART THEREOF.
84 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
85 * or profits or other special, indirect and consequential damages, even if
86 * Sun has been advised of the possibility of such damages.
88 * Sun Microsystems, Inc.
90 * Mountain View, California 94043
98 static char xdr_zero[BYTES_PER_XDR_UNIT] = {0, 0, 0, 0};
100 static xdr_uint32_t xdr_swapbytes(xdr_uint32_t x)
104 char *px = (char *)&x;
105 char *py = (char *)&y;
107 for (i = 0; i < 4; i++)
115 static xdr_uint32_t xdr_htonl(xdr_uint32_t x)
118 if (*((char *)&s) == (char)0x0F)
120 /* bigendian, do nothing */
125 /* smallendian,swap bytes */
126 return xdr_swapbytes(x);
130 static xdr_uint32_t xdr_ntohl(xdr_uint32_t x)
133 if (*((char *)&s) == (char)0x0F)
135 /* bigendian, do nothing */
140 /* smallendian, swap bytes */
141 return xdr_swapbytes(x);
147 * Free a data structure using XDR
148 * Not a filter, but a convenient utility nonetheless
151 xdr_free (xdrproc_t proc, char *objp)
172 xdr_int (XDR *xdrs, int *ip)
179 l = (xdr_int32_t) (*ip);
180 return xdr_putint32 (xdrs, &l);
183 if (!xdr_getint32 (xdrs, &l))
197 * XDR unsigned integers
200 xdr_u_int (XDR *xdrs, unsigned int *up)
207 l = (xdr_uint32_t) (*up);
208 return xdr_putuint32 (xdrs, &l);
211 if (!xdr_getuint32 (xdrs, &l))
215 *up = (unsigned int) l;
230 xdr_short (XDR *xdrs, short *sp)
237 l = (xdr_int32_t) *sp;
238 return xdr_putint32 (xdrs, &l);
241 if (!xdr_getint32 (xdrs, &l))
256 * XDR unsigned short integers
259 xdr_u_short (XDR *xdrs, unsigned short *usp)
266 l = (xdr_uint32_t) *usp;
267 return xdr_putuint32 (xdrs, &l);
270 if (!xdr_getuint32 (xdrs, &l))
274 *usp = (unsigned short) l;
288 xdr_char (XDR *xdrs, char *cp)
293 if (!xdr_int (xdrs, &i))
302 * XDR an unsigned char
305 xdr_u_char (XDR *xdrs, unsigned char *cp)
310 if (!xdr_u_int (xdrs, &u))
322 xdr_bool (XDR *xdrs, int *bp)
324 #define XDR_FALSE ((xdr_int32_t) 0)
325 #define XDR_TRUE ((xdr_int32_t) 1)
332 lb = *bp ? XDR_TRUE : XDR_FALSE;
333 return xdr_putint32 (xdrs, &lb);
336 if (!xdr_getint32 (xdrs, &lb))
340 *bp = (lb == XDR_FALSE) ? FALSE : TRUE;
355 * Allows the specification of a fixed size sequence of opaque bytes.
356 * cp points to the opaque object and cnt gives the byte length.
359 xdr_opaque (XDR *xdrs, char *cp, unsigned int cnt)
362 char crud[BYTES_PER_XDR_UNIT];
365 * if no data we are done
373 * round byte count to full xdr units
375 rndup = cnt % BYTES_PER_XDR_UNIT;
378 rndup = BYTES_PER_XDR_UNIT - rndup;
384 if (!xdr_getbytes (xdrs, cp, cnt))
392 return xdr_getbytes (xdrs, (char *)crud, rndup);
395 if (!xdr_putbytes (xdrs, cp, cnt))
403 return xdr_putbytes (xdrs, xdr_zero, rndup);
413 * XDR null terminated ASCII strings
414 * xdr_string deals with "C strings" - arrays of bytes that are
415 * terminated by a NULL character. The parameter cpp references a
416 * pointer to storage; If the pointer is null, then the necessary
417 * storage is allocated. The last parameter is the max allowed length
418 * of the string as specified by a protocol.
421 xdr_string (xdrs, cpp, maxsize)
424 unsigned int maxsize;
426 char *sp = *cpp; /* sp is the actual string pointer */
427 unsigned int size = 0;
428 unsigned int nodesize = 0;
431 * first deal with the length since xdr strings are counted-strings
438 return TRUE; /* already free */
440 /* fall through... */
452 if (!xdr_u_int (xdrs, &size))
463 * now deal with the actual bytes
474 *cpp = sp = (char *) malloc (nodesize);
478 (void) fputs ("xdr_string: out of memory\n", stderr);
485 return xdr_opaque (xdrs, sp, size);
497 /* Floating-point stuff */
510 tmp = *(xdr_int32_t *)fp;
511 return (xdr_putint32(xdrs, &tmp));
516 if (xdr_getint32(xdrs, &tmp))
518 *(xdr_int32_t *)fp = tmp;
537 /* Windows and some other systems dont define double-precision
538 * word order in the header files, so unfortunately we have
541 * For thread safety, we calculate it every time: locking this would
544 /*static int LSW=-1;*/ /* Least significant fp word */
545 int LSW = -1; /* Least significant fp word */
553 double x = 0.987654321; /* Just a number */
555 /* Possible representations in IEEE double precision:
556 * (S=small endian, B=big endian)
558 * Byte order, Word order, Hex
559 * S S b8 56 0e 3c dd 9a ef 3f
560 * B S 3c 0e 56 b8 3f ef 9a dd
561 * S B dd 9a ef 3f b8 56 0e 3c
562 * B B 3f ef 9a dd 3c 0e 56 b8
565 unsigned char ix = *((char *)&x);
567 if (ix == 0xdd || ix == 0x3f)
569 LSW = 1; /* Big endian word order */
571 else if (ix == 0xb8 || ix == 0x3c)
573 LSW = 0; /* Small endian word order */
575 else /* Catch strange errors */
577 printf("Error when detecting floating-point word order.\n"
578 "Do you have a non-IEEE system?\n"
579 "If possible, use the XDR libraries provided with your system,\n"
580 "instead of the Gromacs fallback XDR source.\n");
592 return (xdr_putint32(xdrs, tmp) &&
593 xdr_putint32(xdrs, tmp+1));
599 if (xdr_getint32(xdrs, tmp+!LSW) &&
600 xdr_getint32(xdrs, tmp+LSW))
621 * XDR a fixed length array. Unlike variable-length arrays,
622 * the storage of fixed length arrays is static and unfreeable.
623 * > basep: base of the array
624 * > size: size of the array
625 * > elemsize: size of each element
626 * > xdr_elem: routine to XDR each element
629 xdr_vector (xdrs, basep, nelem, elemsize, xdr_elem)
633 unsigned int elemsize;
636 #define LASTUNSIGNED ((unsigned int)0-1)
641 for (i = 0; i < nelem; i++)
643 if (!(*xdr_elem) (xdrs, elptr, LASTUNSIGNED))
655 static bool_t xdrstdio_getbytes (XDR *, char *, unsigned int);
656 static bool_t xdrstdio_putbytes (XDR *, char *, unsigned int);
657 static unsigned int xdrstdio_getpos (XDR *);
658 static bool_t xdrstdio_setpos (XDR *, unsigned int);
659 static xdr_int32_t *xdrstdio_inline (XDR *, int);
660 static void xdrstdio_destroy (XDR *);
661 static bool_t xdrstdio_getint32 (XDR *, xdr_int32_t *);
662 static bool_t xdrstdio_putint32 (XDR *, xdr_int32_t *);
663 static bool_t xdrstdio_getuint32 (XDR *, xdr_uint32_t *);
664 static bool_t xdrstdio_putuint32 (XDR *, xdr_uint32_t *);
667 * Ops vector for stdio type XDR
669 static const struct xdr_ops xdrstdio_ops =
671 xdrstdio_getbytes, /* deserialize counted bytes */
672 xdrstdio_putbytes, /* serialize counted bytes */
673 xdrstdio_getpos, /* get offset in the stream */
674 xdrstdio_setpos, /* set offset in the stream */
675 xdrstdio_inline, /* prime stream for inline macros */
676 xdrstdio_destroy, /* destroy stream */
677 xdrstdio_getint32, /* deserialize a int */
678 xdrstdio_putint32, /* serialize a int */
679 xdrstdio_getuint32, /* deserialize a int */
680 xdrstdio_putuint32 /* serialize a int */
684 * Initialize a stdio xdr stream.
685 * Sets the xdr stream handle xdrs for use on the stream file.
686 * Operation flag is set to op.
689 xdrstdio_create (XDR *xdrs, FILE *file, enum xdr_op op)
692 /* We have to add the const since the `struct xdr_ops' in `struct XDR'
694 xdrs->x_ops = (struct xdr_ops *) &xdrstdio_ops;
695 xdrs->x_private = (char *) file;
701 * Destroy a stdio xdr stream.
702 * Cleans up the xdr stream handle xdrs previously set up by xdrstdio_create.
705 xdrstdio_destroy (XDR *xdrs)
707 (void) fflush ((FILE *) xdrs->x_private);
708 /* xx should we close the file ?? */
713 xdrstdio_getbytes (XDR *xdrs, char *addr, unsigned int len)
715 if ((len != 0) && (fread (addr, (int) len, 1,
716 (FILE *) xdrs->x_private) != 1))
724 xdrstdio_putbytes (XDR *xdrs, char *addr, unsigned int len)
726 if ((len != 0) && (fwrite (addr, (int) len, 1,
727 (FILE *) xdrs->x_private) != 1))
735 xdrstdio_getpos (XDR *xdrs)
737 return (unsigned int) ftell ((FILE *) xdrs->x_private);
741 xdrstdio_setpos (XDR *xdrs, unsigned int pos)
743 return fseek ((FILE *) xdrs->x_private, (xdr_int32_t) pos, 0) < 0 ? FALSE : TRUE;
747 xdrstdio_inline (XDR *xdrs, int len)
752 * Must do some work to implement this: must insure
753 * enough data in the underlying stdio buffer,
754 * that the buffer is aligned so that we can indirect through a
755 * long *, and stuff this pointer in xdrs->x_buf. Doing
756 * a fread or fwrite to a scratch buffer would defeat
757 * most of the gains to be had here and require storage
758 * management on this buffer, so we don't do this.
764 xdrstdio_getint32 (XDR *xdrs, xdr_int32_t *ip)
768 if (fread ((char *) &mycopy, 4, 1, (FILE *) xdrs->x_private) != 1)
772 *ip = xdr_ntohl (mycopy);
777 xdrstdio_putint32 (XDR *xdrs, xdr_int32_t *ip)
779 xdr_int32_t mycopy = xdr_htonl (*ip);
782 if (fwrite ((char *) ip, 4, 1, (FILE *) xdrs->x_private) != 1)
790 xdrstdio_getuint32 (XDR *xdrs, xdr_uint32_t *ip)
794 if (fread ((char *) &mycopy, 4, 1, (FILE *) xdrs->x_private) != 1)
798 *ip = xdr_ntohl (mycopy);
803 xdrstdio_putuint32 (XDR *xdrs, xdr_uint32_t *ip)
805 xdr_uint32_t mycopy = xdr_htonl (*ip);
808 if (fwrite ((char *) ip, 4, 1, (FILE *) xdrs->x_private) != 1)
817 gmx_system_xdr_empty;
818 #endif /* GMX_SYSTEM_XDR */