Update copyright for 2009.

[postgresql] / src / include / storage / fd.h

diff --git a/src/include/storage/fd.h b/src/include/storage/fd.h
index 361b8c15ebc624dc4d84ec8c666e1c186a67c5ad..17aa150aa03ea33e2bdc4be9f522ec0c7ddcfa48 100644 (file)
--- a/src/include/storage/fd.h
+++ b/src/include/storage/fd.h
@@ -4,12 +4,14 @@
  *       Virtual file descriptor definitions.
  *
  *
- * Copyright (c) 1994, Regents of the University of California
+ * Portions Copyright (c) 1996-2009, PostgreSQL Global Development Group
+ * Portions Copyright (c) 1994, Regents of the University of California
  *
- * $Id: fd.h,v 1.16 1999/05/26 12:56:53 momjian Exp $
+ * $PostgreSQL: pgsql/src/include/storage/fd.h,v 1.63 2009/01/01 17:24:01 momjian Exp $
  *
  *-------------------------------------------------------------------------
  */
+
 /*
  * calls:
  *
@@ -20,7 +22,7 @@
  * Use them for all file activity...
  *
  *     File fd;
- *     fd = FilePathOpenFile("foo", O_RDONLY);
+ *     fd = FilePathOpenFile("foo", O_RDONLY, 0600);
  *
  *     AllocateFile();
  *     FreeFile();
@@ -30,15 +32,14 @@
  * that you intend to hold open for any length of time, since there is
  * no way for them to share kernel file descriptors with other files.
  *
- * The BufFile routines provide a partial replacement for stdio.  Currently
- * they only support buffered access to a virtual file, without any of
- * stdio's formatting features.  That's enough for immediate needs, but
- * the set of facilities could be expanded if necessary.
+ * Likewise, use AllocateDir/FreeDir, not opendir/closedir, to allocate
+ * open directories (DIR*).
  */
 #ifndef FD_H
 #define FD_H
 
-#include <stdio.h>
+#include <dirent.h>
+
 
 /*
  * FileSeek uses the standard UNIX lseek(2) flags.
@@ -48,58 +49,56 @@ typedef char *FileName;
 
 typedef int File;
 
-/* BufFile is an opaque type whose details are not known outside fd.c. */
-
-typedef struct BufFile BufFile;
-
-/* why is this here? fd.c doesn't want it ... */
-struct pgstat
-{                                                              /* just the fields we need from stat
-                                                                * structure */
-       int                     st_ino;
-       int                     st_mode;
-       unsigned int st_size;
-       unsigned int st_sizehigh;       /* high order bits */
-/* 2^64 == 1.8 x 10^20 bytes */
-       int                     st_uid;
-       int                     st_atime_s;             /* just the seconds */
-       int                     st_mtime_s;             /* since SysV and the new BSD both have */
-       int                     st_ctime_s;             /* usec fields.. */
-};
+
+/* GUC parameter */
+extern int     max_files_per_process;
+
 
 /*
  * prototypes for functions in fd.c
  */
 
 /* Operations on virtual Files --- equivalent to Unix kernel file ops */
-extern File FileNameOpenFile(FileName fileName, int fileFlags, int fileMode);
 extern File PathNameOpenFile(FileName fileName, int fileFlags, int fileMode);
-extern File OpenTemporaryFile(void);
+extern File OpenTemporaryFile(bool interXact);
 extern void FileClose(File file);
-extern void FileUnlink(File file);
 extern int     FileRead(File file, char *buffer, int amount);
 extern int     FileWrite(File file, char *buffer, int amount);
-extern long FileSeek(File file, long offset, int whence);
-extern int     FileTruncate(File file, int offset);
 extern int     FileSync(File file);
+extern off_t FileSeek(File file, off_t offset, int whence);
+extern int     FileTruncate(File file, off_t offset);
 
 /* Operations that allow use of regular stdio --- USE WITH CAUTION */
-extern FILE *AllocateFile(char *name, char *mode);
-extern void FreeFile(FILE *);
+extern FILE *AllocateFile(const char *name, const char *mode);
+extern int     FreeFile(FILE *file);
 
-/* Operations on BufFiles --- a very incomplete emulation of stdio
- * atop virtual Files...
- */
-extern BufFile *BufFileCreate(File file);
-extern void BufFileClose(BufFile *file);
-extern size_t BufFileRead(BufFile *file, void *ptr, size_t size);
-extern size_t BufFileWrite(BufFile *file, void *ptr, size_t size);
-extern long BufFileSeek(BufFile *file, long offset, int whence);
+/* Operations to allow use of the <dirent.h> library routines */
+extern DIR *AllocateDir(const char *dirname);
+extern struct dirent *ReadDir(DIR *dir, const char *dirname);
+extern int     FreeDir(DIR *dir);
+
+/* If you've really really gotta have a plain kernel FD, use this */
+extern int     BasicOpenFile(FileName fileName, int fileFlags, int fileMode);
 
 /* Miscellaneous support routines */
-extern int     FileNameUnlink(char *filename);
+extern void InitFileAccess(void);
+extern void set_max_safe_fds(void);
 extern void closeAllVfds(void);
+extern void SetTempTablespaces(Oid *tableSpaces, int numSpaces);
+extern bool TempTablespacesAreSet(void);
+extern Oid     GetNextTempTableSpace(void);
 extern void AtEOXact_Files(void);
+extern void AtEOSubXact_Files(bool isCommit, SubTransactionId mySubid,
+                                 SubTransactionId parentSubid);
+extern void RemovePgTempFiles(void);
+
 extern int     pg_fsync(int fd);
+extern int     pg_fsync_no_writethrough(int fd);
+extern int     pg_fsync_writethrough(int fd);
+extern int     pg_fdatasync(int fd);
+
+/* Filename components for OpenTemporaryFile */
+#define PG_TEMP_FILES_DIR "pgsql_tmp"
+#define PG_TEMP_FILE_PREFIX "pgsql_tmp"
 
-#endif  /* FD_H */
+#endif   /* FD_H */