src/gromacs/fileio/gmxfio-impl.h

   1 /*
   2  * This file is part of the GROMACS molecular simulation package.
   3  *
   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.
  10  *
  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.
  15  *
  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.
  20  *
  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.
  25  *
  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.
  33  *
  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.
  36  */
  37 /*! \internal \file
  38  * \brief
  39  * Internal definitions shared by gmxfio*.c files.
  40  */
  41 #ifndef GMX_FILEIO_GMXFIO_IMPL_H
  42 #define GMX_FILEIO_GMXFIO_IMPL_H
  43
  44 /* This is the new improved and thread safe version of gmxfio.  */
  45
  46
  47 /* WARNING WARNING WARNING WARNING
  48    The data types used here are PRIVATE to gmxfio routines. DO NOT use them
  49    directly in your own code, but use the external functions provided in
  50    include/gmxfio.h
  51
  52    If you don't heed this warning, your code will suddenly stop working
  53    at some point in the not-so-distant future.
  54
  55    WARNING WARNING WARNING WARNING */
  56
  57 #include "thread_mpi/lock.h"
  58
  59 #include "gromacs/fileio/xdrf.h"
  60
  61 struct t_fileio
  62 {
  63     FILE           *fp;                /* the file pointer */
  64     gmx_bool        bOpen,             /* the file is open */
  65                     bRead,             /* the file is open for reading */
  66                     bDouble,           /* write doubles instead of floats */
  67                     bDebug,            /* the file ops should come with debug info */
  68                     bReadWrite;        /* the file is open for reading and writing */
  69     char        *fn;                   /* the file name */
  70     XDR         *xdr;                  /* the xdr data pointer */
  71     enum xdr_op  xdrmode;              /* the xdr mode */
  72     int          iFTP;                 /* the file type identifier */
  73
  74     t_fileio    *next, *prev;          /* next and previous file pointers in the
  75                                           linked list */
  76     tMPI_Lock_t  mtx;                  /* content locking mutex. This is a fast lock
  77                                           for performance reasons: in some cases every
  78                                           single byte that gets read/written requires
  79                                           a lock */
  80 };
  81
  82 /** Names for different items that can be read/written with gmx_fio_do_*() */
  83 extern const char    *eioNames[eioNR];
  84
  85 /** check the number of items against the allowed number of items */
  86 void gmx_fio_check_nitem(int eio, int nitem, const char *file,
  87                          int line);
  88 /** check the output type against allowed values */
  89 void gmx_fio_fe(t_fileio *fio, int eio, const char *desc, const char *srcfile,
  90                 int line);
  91
  92 /** lock the mutex associated with a fio  */
  93 void gmx_fio_lock(t_fileio *fio);
  94 /** unlock the mutex associated with a fio  */
  95 void gmx_fio_unlock(t_fileio *fio);
  96
  97 /** xdr read/write routine */
  98 gmx_bool do_xdr(t_fileio *fio, void *item, int nitem, int eio,
  99                 const char *desc, const char *srcfile, int line);
 100
 101 #endif