libsysio/include/file.h

   1 /*
   2  *    This Cplant(TM) source code is the property of Sandia National
   3  *    Laboratories.
   4  *
   5  *    This Cplant(TM) source code is copyrighted by Sandia National
   6  *    Laboratories.
   7  *
   8  *    The redistribution of this Cplant(TM) source code is subject to the
   9  *    terms of the GNU Lesser General Public License
  10  *    (see cit/LGPL or http://www.gnu.org/licenses/lgpl.html)
  11  *
  12  *    Cplant(TM) Copyright 1998-2003 Sandia Corporation.
  13  *    Under the terms of Contract DE-AC04-94AL85000, there is a non-exclusive
  14  *    license for use of this work by or on behalf of the US Government.
  15  *    Export of this program may require a license from the United States
  16  *    Government.
  17  */
  18
  19 /*
  20  * This library is free software; you can redistribute it and/or
  21  * modify it under the terms of the GNU Lesser General Public
  22  * License as published by the Free Software Foundation; either
  23  * version 2.1 of the License, or (at your option) any later version.
  24  *
  25  * This library is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  28  * Lesser General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU Lesser General Public
  31  * License along with this library; if not, write to the Free Software
  32  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  33  *
  34  * Questions or comments about this library should be sent to:
  35  *
  36  * Lee Ward
  37  * Sandia National Laboratories, New Mexico
  38  * P.O. Box 5800
  39  * Albuquerque, NM 87185-1110
  40  *
  41  * lee@sandia.gov
  42  */
  43
  44 /*
  45  * Open file support.
  46  */
  47
  48 /*
  49  * A file record is maintained for each open file in the system. It holds
  50  * all the info necessary to track the context and parameters for the
  51  * operations that may be performed.
  52  */
  53 struct file {
  54         struct inode *f_ino;                            /* path node */
  55         _SYSIO_OFF_T f_pos;                             /* current stream pos */
  56         unsigned f_ref;                                 /* ref count */
  57         int     f_flags;                                /* open/fcntl flags */
  58 };
  59
  60 /*
  61  * Reference a file record.
  62  */
  63 #define F_REF(fil) \
  64         do { \
  65                 (fil)->f_ref++; \
  66                 assert((fil)->f_ref); \
  67                 I_REF((fil)->f_ino); \
  68         } while (0)
  69
  70 /*
  71  * Release reference to a file record.
  72  */
  73 #define F_RELE(fil) \
  74         do { \
  75                 struct inode *ino; \
  76                 \
  77                 assert((fil)->f_ref); \
  78                 (fil)->f_ref--; \
  79                 ino = (fil)->f_ino; \
  80                 if (!(fil)->f_ref) \
  81                         _sysio_fgone(fil); \
  82                 I_RELE(ino); \
  83         } while (0)
  84
  85 /*
  86  * Init file record.
  87  *
  88  * NB: Don't forget to take a reference to the inode too!
  89  */
  90 #define _SYSIO_FINIT(fil, ino, flags) \
  91         do { \
  92                 (fil)->f_ino = (ino); \
  93                 (fil)->f_pos = 0; \
  94                 (fil)->f_ref = 1; \
  95                 (fil)->f_flags = (flags); \
  96         } while (0)
  97
  98 struct ioctx;
  99
 100 extern struct file *_sysio_fnew(struct inode *ino, int flags);
 101 extern void _sysio_fgone(struct file *fil);
 102 extern void _sysio_fcompletio(struct ioctx *ioctx, struct file *fil);
 103 extern int _sysio_fd_close(int fd);
 104 extern struct file *_sysio_fd_find(int fd);
 105 extern int _sysio_fd_set(struct file *fil, int fd);
 106 extern int _sysio_fd_dup2(int oldfd, int newfd);
 107 extern int _sysio_fd_close_all(void);
 108 #if ZERO_SUM_MEMORY
 109 extern void _sysio_fd_shutdown(void);
 110 #endif