granicus.if.org Git - postgresql/blob - src/include/storage/fd.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * fd.h
   4  *        Virtual file descriptor definitions.
   5  *
   6  *
   7  * Copyright (c) 1994, Regents of the University of California
   8  *
   9  * $Id: fd.h,v 1.12 1999/02/13 23:22:05 momjian Exp $
  10  *
  11  *-------------------------------------------------------------------------
  12  */
  13 /*
  14  * calls:
  15  *
  16  *      File {Close, Read, Write, Seek, Tell, Sync}
  17  *      {File Name Open, Allocate, Free} File
  18  *
  19  * These are NOT JUST RENAMINGS OF THE UNIX ROUTINES.
  20  * use them for all file activity...
  21  *
  22  *      fd = FilePathOpenFile("foo", O_RDONLY);
  23  *      File fd;
  24  *
  25  * use AllocateFile if you need a file descriptor in some other context.
  26  * it will make sure that there is a file descriptor free
  27  *
  28  * use FreeFile to let the virtual file descriptor package know that
  29  * there is now a free fd (when you are done with it)
  30  *
  31  *      AllocateFile();
  32  *      FreeFile();
  33  */
  34 #ifndef FD_H
  35 #define FD_H
  36
  37 #include <stdio.h>
  38
  39 /*
  40  * FileSeek uses the standard UNIX lseek(2) flags.
  41  */
  42
  43 typedef char *FileName;
  44
  45 typedef int File;
  46
  47 /* originally in libpq-fs.h */
  48 struct pgstat
  49 {                                                               /* just the fields we need from stat
  50                                                                  * structure */
  51         int                     st_ino;
  52         int                     st_mode;
  53         unsigned int st_size;
  54         unsigned int st_sizehigh;       /* high order bits */
  55 /* 2^64 == 1.8 x 10^20 bytes */
  56         int                     st_uid;
  57         int                     st_atime_s;             /* just the seconds */
  58         int                     st_mtime_s;             /* since SysV and the new BSD both have */
  59         int                     st_ctime_s;             /* usec fields.. */
  60 };
  61
  62 /*
  63  * prototypes for functions in fd.c
  64  */
  65 extern File FileNameOpenFile(FileName fileName, int fileFlags, int fileMode);
  66 extern File PathNameOpenFile(FileName fileName, int fileFlags, int fileMode);
  67 extern void FileClose(File file);
  68 extern void FileUnlink(File file);
  69 extern int      FileRead(File file, char *buffer, int amount);
  70 extern int      FileWrite(File file, char *buffer, int amount);
  71 extern long FileSeek(File file, long offset, int whence);
  72 extern int      FileTruncate(File file, int offset);
  73 extern int      FileSync(File file);
  74 extern int      FileNameUnlink(char *filename);
  75 extern FILE *AllocateFile(char *name, char *mode);
  76 extern void FreeFile(FILE *);
  77 extern void closeAllVfds(void);
  78 extern int      pg_fsync(int fd);
  79
  80 #endif   /* FD_H */