]> granicus.if.org Git - postgresql/blobdiff - src/include/port.h
Centralize definition of integer limits.
[postgresql] / src / include / port.h
index eb8b0318159e557067db6cef7dc028ca4a40e252..29854dd752e8887d5e7a513fcc0d792d95657ba2 100644 (file)
@@ -3,33 +3,49 @@
  * port.h
  *       Header for src/port/ compatibility functions.
  *
- * Portions Copyright (c) 1996-2006, PostgreSQL Global Development Group
+ * Portions Copyright (c) 1996-2015, PostgreSQL Global Development Group
  * Portions Copyright (c) 1994, Regents of the University of California
  *
- * $PostgreSQL: pgsql/src/include/port.h,v 1.102 2006/10/02 00:06:18 tgl Exp $
+ * src/include/port.h
  *
  *-------------------------------------------------------------------------
  */
+#ifndef PG_PORT_H
+#define PG_PORT_H
 
 #include <ctype.h>
 #include <netdb.h>
 #include <pwd.h>
 
+/* socket has a different definition on WIN32 */
+#ifndef WIN32
+typedef int pgsocket;
+
+#define PGINVALID_SOCKET (-1)
+#else
+typedef SOCKET pgsocket;
+
+#define PGINVALID_SOCKET INVALID_SOCKET
+#endif
+
 /* non-blocking */
-extern bool pg_set_noblock(int sock);
-extern bool pg_set_block(int sock);
+extern bool pg_set_noblock(pgsocket sock);
+extern bool pg_set_block(pgsocket sock);
 
 /* Portable path handling for Unix/Win32 (in path.c) */
 
+extern bool has_drive_prefix(const char *filename);
 extern char *first_dir_separator(const char *filename);
 extern char *last_dir_separator(const char *filename);
-extern char *first_path_separator(const char *pathlist);
+extern char *first_path_var_separator(const char *pathlist);
 extern void join_path_components(char *ret_path,
                                         const char *head, const char *tail);
 extern void canonicalize_path(char *path);
 extern void make_native_path(char *path);
 extern bool path_contains_parent_reference(const char *path);
+extern bool path_is_relative_and_below_cwd(const char *path);
 extern bool path_is_prefix_of_path(const char *path1, const char *path2);
+extern char *make_absolute_path(const char *path);
 extern const char *get_progname(const char *argv0);
 extern void get_share_path(const char *my_exec_path, char *ret_path);
 extern void get_etc_path(const char *my_exec_path, char *ret_path);
@@ -40,27 +56,36 @@ extern void get_lib_path(const char *my_exec_path, char *ret_path);
 extern void get_pkglib_path(const char *my_exec_path, char *ret_path);
 extern void get_locale_path(const char *my_exec_path, char *ret_path);
 extern void get_doc_path(const char *my_exec_path, char *ret_path);
+extern void get_html_path(const char *my_exec_path, char *ret_path);
 extern void get_man_path(const char *my_exec_path, char *ret_path);
 extern bool get_home_path(char *ret_path);
 extern void get_parent_directory(char *path);
 
+/* common/pgfnames.c */
+extern char **pgfnames(const char *path);
+extern void pgfnames_cleanup(char **filenames);
+
 /*
  *     is_absolute_path
  *
  *     By making this a macro we avoid needing to include path.c in libpq.
  */
 #ifndef WIN32
+#define IS_DIR_SEP(ch) ((ch) == '/')
+
 #define is_absolute_path(filename) \
 ( \
-       ((filename)[0] == '/') \
+       IS_DIR_SEP((filename)[0]) \
 )
 #else
+#define IS_DIR_SEP(ch) ((ch) == '/' || (ch) == '\\')
+
+/* See path_is_relative_and_below_cwd() for how we handle 'E:abc'. */
 #define is_absolute_path(filename) \
 ( \
-       ((filename)[0] == '/') || \
-       (filename)[0] == '\\' || \
+       IS_DIR_SEP((filename)[0]) || \
        (isalpha((unsigned char) ((filename)[0])) && (filename)[1] == ':' && \
-       ((filename)[2] == '\\' || (filename)[2] == '/')) \
+        IS_DIR_SEP((filename)[2])) \
 )
 #endif
 
@@ -72,6 +97,12 @@ extern int   find_my_exec(const char *argv0, char *retpath);
 extern int find_other_exec(const char *argv0, const char *target,
                                const char *versionstr, char *retpath);
 
+/* Windows security token manipulation (in exec.c) */
+#ifdef WIN32
+extern BOOL AddUserToTokenDacl(HANDLE hToken);
+#endif
+
+
 #if defined(WIN32) || defined(__CYGWIN__)
 #define EXE ".exe"
 #else
@@ -80,42 +111,8 @@ extern int find_other_exec(const char *argv0, const char *target,
 
 #if defined(WIN32) && !defined(__CYGWIN__)
 #define DEVNULL "nul"
-/* "con" does not work from the Msys 1.0.10 console (part of MinGW). */
-#define DEVTTY "con"
 #else
 #define DEVNULL "/dev/null"
-#define DEVTTY "/dev/tty"
-#endif
-
-/*
- *     Win32 needs double quotes at the beginning and end of system()
- *     strings.  If not, it gets confused with multiple quoted strings.
- *     It also requires double-quotes around the executable name and
- *     any files used for redirection.  Other args can use single-quotes.
- *
- *     Generated using Win32 "CMD /?":
- *
- *  1. If all of the following conditions are met, then quote characters
- *  on the command line are preserved:
- *
- *   - no /S switch
- *   - exactly two quote characters
- *   - no special characters between the two quote characters, where special
- *     is one of: &<>()@^|
- *   - there are one or more whitespace characters between the the two quote
- *     characters
- *   - the string between the two quote characters is the name of an
- *     executable file.
- *
- *   2. Otherwise, old behavior is to see if the first character is a quote
- *   character and if so, strip the leading character and remove the last
- *   quote character on the command line, preserving any text after the last
- *   quote character.
- */
-#if defined(WIN32) && !defined(__CYGWIN__)
-#define SYSTEMQUOTE "\""
-#else
-#define SYSTEMQUOTE ""
 #endif
 
 /* Portable delay handling */
@@ -126,6 +123,8 @@ extern int  pg_strcasecmp(const char *s1, const char *s2);
 extern int     pg_strncasecmp(const char *s1, const char *s2, size_t n);
 extern unsigned char pg_toupper(unsigned char ch);
 extern unsigned char pg_tolower(unsigned char ch);
+extern unsigned char pg_ascii_toupper(unsigned char ch);
+extern unsigned char pg_ascii_tolower(unsigned char ch);
 
 #ifdef USE_REPL_SNPRINTF
 
@@ -143,6 +142,9 @@ extern unsigned char pg_tolower(unsigned char ch);
 #ifdef sprintf
 #undef sprintf
 #endif
+#ifdef vfprintf
+#undef vfprintf
+#endif
 #ifdef fprintf
 #undef fprintf
 #endif
@@ -154,64 +156,67 @@ extern int        pg_vsnprintf(char *str, size_t count, const char *fmt, va_list args);
 extern int
 pg_snprintf(char *str, size_t count, const char *fmt,...)
 /* This extension allows gcc to check the format string */
-__attribute__((format(printf, 3, 4)));
+pg_attribute_printf(3, 4);
 extern int
 pg_sprintf(char *str, const char *fmt,...)
 /* This extension allows gcc to check the format string */
-__attribute__((format(printf, 2, 3)));
+pg_attribute_printf(2, 3);
+extern int     pg_vfprintf(FILE *stream, const char *fmt, va_list args);
 extern int
 pg_fprintf(FILE *stream, const char *fmt,...)
 /* This extension allows gcc to check the format string */
-__attribute__((format(printf, 2, 3)));
+pg_attribute_printf(2, 3);
 extern int
 pg_printf(const char *fmt,...)
 /* This extension allows gcc to check the format string */
-__attribute__((format(printf, 1, 2)));
+pg_attribute_printf(1, 2);
 
 /*
- *     The GCC-specific code below prevents the __attribute__(... 'printf')
- *     above from being replaced, and this is required because gcc doesn't
- *     know anything about pg_printf.
+ *     The GCC-specific code below prevents the pg_attribute_printf above from
+ *     being replaced, and this is required because gcc doesn't know anything
+ *     about pg_printf.
  */
 #ifdef __GNUC__
 #define vsnprintf(...) pg_vsnprintf(__VA_ARGS__)
 #define snprintf(...)  pg_snprintf(__VA_ARGS__)
 #define sprintf(...)   pg_sprintf(__VA_ARGS__)
+#define vfprintf(...)  pg_vfprintf(__VA_ARGS__)
 #define fprintf(...)   pg_fprintf(__VA_ARGS__)
 #define printf(...)            pg_printf(__VA_ARGS__)
 #else
 #define vsnprintf              pg_vsnprintf
 #define snprintf               pg_snprintf
 #define sprintf                        pg_sprintf
+#define vfprintf               pg_vfprintf
 #define fprintf                        pg_fprintf
 #define printf                 pg_printf
 #endif
+#endif   /* USE_REPL_SNPRINTF */
 
-#endif /* USE_REPL_SNPRINTF */
-
-/* Portable prompt handling */
-extern char *simple_prompt(const char *prompt, int maxlen, bool echo);
-
+#if defined(WIN32)
 /*
- *     WIN32 doesn't allow descriptors returned by pipe() to be used in select(),
- *     so for that platform we use socket() instead of pipe().
- *     There is some inconsistency here because sometimes we require pg*, like
- *     pgpipe, but in other cases we define rename to pgrename just on Win32.
+ * Versions of libintl >= 0.18? try to replace setlocale() with a macro
+ * to their own versions.  Remove the macro, if it exists, because it
+ * ends up calling the wrong version when the backend and libintl use
+ * different versions of msvcrt.
  */
-#ifndef WIN32
+#if defined(setlocale)
+#undef setlocale
+#endif
+
 /*
- *     The function prototypes are not supplied because every C file
- *     includes this file.
+ * Define our own wrapper macro around setlocale() to work around bugs in
+ * Windows' native setlocale() function.
  */
-#define pgpipe(a)                      pipe(a)
-#define piperead(a,b,c)                read(a,b,c)
-#define pipewrite(a,b,c)       write(a,b,c)
-#else
-extern int     pgpipe(int handles[2]);
-extern int     piperead(int s, char *buf, int len);
+extern char *pgwin32_setlocale(int category, const char *locale);
 
-#define pipewrite(a,b,c)       send(a,b,c,0)
+#define setlocale(a,b) pgwin32_setlocale(a,b)
+#endif   /* WIN32 */
 
+/* Portable prompt handling */
+extern char *simple_prompt(const char *prompt, int maxlen, bool echo);
+
+#ifdef WIN32
 #define PG_SIGNAL_COUNT 32
 #define kill(pid,sig)  pgkill(pid,sig)
 extern int     pgkill(int pid, int sig);
@@ -230,8 +235,7 @@ extern int  pclose_check(FILE *stream);
 
 #if defined(WIN32) || defined(__CYGWIN__)
 /*
- *     Win32 doesn't have reliable rename/unlink during concurrent access,
- *     and we need special code to do symlinks.
+ *     Win32 doesn't have reliable rename/unlink during concurrent access.
  */
 extern int     pgrename(const char *from, const char *to);
 extern int     pgunlink(const char *path);
@@ -243,46 +247,88 @@ extern int        pgunlink(const char *path);
 
 #define rename(from, to)               pgrename(from, to)
 #define unlink(path)                   pgunlink(path)
+#endif   /* defined(WIN32) || defined(__CYGWIN__) */
 
 /*
+ *     Win32 also doesn't have symlinks, but we can emulate them with
+ *     junction points on newer Win32 versions.
+ *
  *     Cygwin has its own symlinks which work on Win95/98/ME where
- *     junction points don't, so use it instead.  We have no way of
+ *     junction points don't, so use those instead.  We have no way of
  *     knowing what type of system Cygwin binaries will be run on.
  *             Note: Some CYGWIN includes might #define WIN32.
  */
 #if defined(WIN32) && !defined(__CYGWIN__)
 extern int     pgsymlink(const char *oldpath, const char *newpath);
+extern int     pgreadlink(const char *path, char *buf, size_t size);
+extern bool pgwin32_is_junction(char *path);
 
 #define symlink(oldpath, newpath)      pgsymlink(oldpath, newpath)
+#define readlink(path, buf, size)      pgreadlink(path, buf, size)
 #endif
-#endif   /* defined(WIN32) || defined(__CYGWIN__) */
 
-extern void copydir(char *fromdir, char *todir, bool recurse);
+extern bool rmtree(const char *path, bool rmtopdir);
 
-extern bool rmtree(char *path, bool rmtopdir);
+/*
+ * stat() is not guaranteed to set the st_size field on win32, so we
+ * redefine it to our own implementation that is.
+ *
+ * We must pull in sys/stat.h here so the system header definition
+ * goes in first, and we redefine that, and not the other way around.
+ *
+ * Some frontends don't need the size from stat, so if UNSAFE_STAT_OK
+ * is defined we don't bother with this.
+ */
+#if defined(WIN32) && !defined(__CYGWIN__) && !defined(UNSAFE_STAT_OK)
+#include <sys/stat.h>
+extern int     pgwin32_safestat(const char *path, struct stat * buf);
+
+#define stat(a,b) pgwin32_safestat(a,b)
+#endif
 
 #if defined(WIN32) && !defined(__CYGWIN__)
 
-/* open() and fopen() replacements to allow deletion of open files and
+/*
+ * open() and fopen() replacements to allow deletion of open files and
  * passing of other special options.
  */
+#define                O_DIRECT        0x80000000
 extern int     pgwin32_open(const char *, int,...);
 extern FILE *pgwin32_fopen(const char *, const char *);
 
 #ifndef FRONTEND
-#define                open(a,b,c)     pgwin32_open(a,b,c)
+#define                open(a,b,c) pgwin32_open(a,b,c)
 #define                fopen(a,b) pgwin32_fopen(a,b)
 #endif
 
-#define popen(a,b) _popen(a,b)
-#define pclose(a) _pclose(a)
+/*
+ * Mingw-w64 headers #define popen and pclose to _popen and _pclose.  We want
+ * to use our popen wrapper, rather than plain _popen, so override that.  For
+ * consistency, use our version of pclose, too.
+ */
+#ifdef popen
+#undef popen
+#endif
+#ifdef pclose
+#undef pclose
+#endif
 
-/* Missing rand functions */
-extern long lrand48(void);
-extern void srand48(long seed);
+/*
+ * system() and popen() replacements to enclose the command in an extra
+ * pair of quotes.
+ */
+extern int     pgwin32_system(const char *command);
+extern FILE *pgwin32_popen(const char *command, const char *type);
+
+#define system(a) pgwin32_system(a)
+#define popen(a,b) pgwin32_popen(a,b)
+#define pclose(a) _pclose(a)
 
+/* New versions of MingW have gettimeofday, old mingw and msvc don't */
+#ifndef HAVE_GETTIMEOFDAY
 /* Last parameter not used */
 extern int     gettimeofday(struct timeval * tp, struct timezone * tzp);
+#endif
 #else                                                  /* !WIN32 */
 
 /*
@@ -292,6 +338,20 @@ extern int gettimeofday(struct timeval * tp, struct timezone * tzp);
 #define closesocket close
 #endif   /* WIN32 */
 
+/*
+ * On Windows, setvbuf() does not support _IOLBF mode, and interprets that
+ * as _IOFBF.  To add insult to injury, setvbuf(file, NULL, _IOFBF, 0)
+ * crashes outright if "parameter validation" is enabled.  Therefore, in
+ * places where we'd like to select line-buffered mode, we fall back to
+ * unbuffered mode instead on Windows.  Always use PG_IOLBF not _IOLBF
+ * directly in order to implement this behavior.
+ */
+#ifndef WIN32
+#define PG_IOLBF       _IOLBF
+#else
+#define PG_IOLBF       _IONBF
+#endif
+
 /*
  * Default "extern" declarations or macro substitutes for library routines.
  * When necessary, these routines are provided by files in src/port/.
@@ -300,24 +360,40 @@ extern int        gettimeofday(struct timeval * tp, struct timezone * tzp);
 extern char *crypt(const char *key, const char *setting);
 #endif
 
-#if defined(bsdi) || defined(netbsd)
+/* WIN32 handled in port/win32.h */
+#ifndef WIN32
+#define pgoff_t off_t
+#ifdef __NetBSD__
 extern int     fseeko(FILE *stream, off_t offset, int whence);
 extern off_t ftello(FILE *stream);
 #endif
+#endif
+
+extern double pg_erand48(unsigned short xseed[3]);
+extern long pg_lrand48(void);
+extern void pg_srand48(long seed);
+
+#ifndef HAVE_FLS
+extern int     fls(int mask);
+#endif
 
 #ifndef HAVE_FSEEKO
 #define fseeko(a, b, c) fseek(a, b, c)
 #define ftello(a)              ftell(a)
 #endif
 
-#ifndef HAVE_GETOPT
-extern int     getopt(int nargc, char *const * nargv, const char *ostr);
+#if !defined(HAVE_GETPEEREID) && !defined(WIN32)
+extern int     getpeereid(int sock, uid_t *uid, gid_t *gid);
 #endif
 
 #ifndef HAVE_ISINF
 extern int     isinf(double x);
 #endif
 
+#ifndef HAVE_MKDTEMP
+extern char *mkdtemp(char *path);
+#endif
+
 #ifndef HAVE_RINT
 extern double rint(double x);
 #endif
@@ -328,15 +404,15 @@ extern double rint(double x);
 extern int     inet_aton(const char *cp, struct in_addr * addr);
 #endif
 
-#ifndef HAVE_STRDUP
-extern char *strdup(const char *str);
+#if !HAVE_DECL_STRLCAT
+extern size_t strlcat(char *dst, const char *src, size_t siz);
 #endif
 
 #if !HAVE_DECL_STRLCPY
 extern size_t strlcpy(char *dst, const char *src, size_t siz);
 #endif
 
-#ifndef HAVE_RANDOM
+#if !defined(HAVE_RANDOM) && !defined(__BORLANDC__)
 extern long random(void);
 #endif
 
@@ -348,10 +424,14 @@ extern void unsetenv(const char *name);
 extern void srandom(unsigned int seed);
 #endif
 
+#ifndef HAVE_SSL_GET_CURRENT_COMPRESSION
+#define SSL_get_current_compression(x) 0
+#endif
+
 /* thread.h */
 extern char *pqStrerror(int errnum, char *strerrbuf, size_t buflen);
 
-#if !defined(WIN32) || defined(__CYGWIN__)
+#ifndef WIN32
 extern int pqGetpwuid(uid_t uid, struct passwd * resultbuf, char *buffer,
                   size_t buflen, struct passwd ** result);
 #endif
@@ -361,3 +441,43 @@ extern int pqGethostbyname(const char *name,
                                char *buffer, size_t buflen,
                                struct hostent ** result,
                                int *herrno);
+
+extern void pg_qsort(void *base, size_t nel, size_t elsize,
+                int (*cmp) (const void *, const void *));
+extern int     pg_qsort_strcmp(const void *a, const void *b);
+
+#define qsort(a,b,c,d) pg_qsort(a,b,c,d)
+
+typedef int (*qsort_arg_comparator) (const void *a, const void *b, void *arg);
+
+extern void qsort_arg(void *base, size_t nel, size_t elsize,
+                 qsort_arg_comparator cmp, void *arg);
+
+/* port/chklocale.c */
+extern int     pg_get_encoding_from_locale(const char *ctype, bool write_message);
+
+#if defined(WIN32) && !defined(FRONTEND)
+extern int     pg_codepage_to_encoding(UINT cp);
+#endif
+
+/* port/inet_net_ntop.c */
+extern char *inet_net_ntop(int af, const void *src, int bits,
+                         char *dst, size_t size);
+
+/* port/pgcheckdir.c */
+extern int     pg_check_dir(const char *dir);
+
+/* port/pgmkdirp.c */
+extern int     pg_mkdir_p(char *path, int omode);
+
+/* port/pqsignal.c */
+typedef void (*pqsigfunc) (int signo);
+extern pqsigfunc pqsignal(int signo, pqsigfunc func);
+
+/* port/quotes.c */
+extern char *escape_single_quotes_ascii(const char *src);
+
+/* port/wait_error.c */
+extern char *wait_result_to_str(int exit_status);
+
+#endif   /* PG_PORT_H */