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

   1 /*-------------------------------------------------------------------------
   2  *
   3  * port.h
   4  *        Header for src/port/ compatibility functions.
   5  *
   6  * Portions Copyright (c) 1996-2018, PostgreSQL Global Development Group
   7  * Portions Copyright (c) 1994, Regents of the University of California
   8  *
   9  * src/include/port.h
  10  *
  11  *-------------------------------------------------------------------------
  12  */
  13 #ifndef PG_PORT_H
  14 #define PG_PORT_H
  15
  16 #include <ctype.h>
  17 #include <netdb.h>
  18 #include <pwd.h>
  19
  20 /*
  21  * Windows has enough specialized port stuff that we push most of it off
  22  * into another file.
  23  * Note: Some CYGWIN includes might #define WIN32.
  24  */
  25 #if defined(WIN32) && !defined(__CYGWIN__)
  26 #include "port/win32_port.h"
  27 #endif
  28
  29 /* socket has a different definition on WIN32 */
  30 #ifndef WIN32
  31 typedef int pgsocket;
  32
  33 #define PGINVALID_SOCKET (-1)
  34 #else
  35 typedef SOCKET pgsocket;
  36
  37 #define PGINVALID_SOCKET INVALID_SOCKET
  38 #endif
  39
  40 /* non-blocking */
  41 extern bool pg_set_noblock(pgsocket sock);
  42 extern bool pg_set_block(pgsocket sock);
  43
  44 /* Portable path handling for Unix/Win32 (in path.c) */
  45
  46 extern bool has_drive_prefix(const char *filename);
  47 extern char *first_dir_separator(const char *filename);
  48 extern char *last_dir_separator(const char *filename);
  49 extern char *first_path_var_separator(const char *pathlist);
  50 extern void join_path_components(char *ret_path,
  51                                          const char *head, const char *tail);
  52 extern void canonicalize_path(char *path);
  53 extern void make_native_path(char *path);
  54 extern void cleanup_path(char *path);
  55 extern bool path_contains_parent_reference(const char *path);
  56 extern bool path_is_relative_and_below_cwd(const char *path);
  57 extern bool path_is_prefix_of_path(const char *path1, const char *path2);
  58 extern char *make_absolute_path(const char *path);
  59 extern const char *get_progname(const char *argv0);
  60 extern void get_share_path(const char *my_exec_path, char *ret_path);
  61 extern void get_etc_path(const char *my_exec_path, char *ret_path);
  62 extern void get_include_path(const char *my_exec_path, char *ret_path);
  63 extern void get_pkginclude_path(const char *my_exec_path, char *ret_path);
  64 extern void get_includeserver_path(const char *my_exec_path, char *ret_path);
  65 extern void get_lib_path(const char *my_exec_path, char *ret_path);
  66 extern void get_pkglib_path(const char *my_exec_path, char *ret_path);
  67 extern void get_locale_path(const char *my_exec_path, char *ret_path);
  68 extern void get_doc_path(const char *my_exec_path, char *ret_path);
  69 extern void get_html_path(const char *my_exec_path, char *ret_path);
  70 extern void get_man_path(const char *my_exec_path, char *ret_path);
  71 extern bool get_home_path(char *ret_path);
  72 extern void get_parent_directory(char *path);
  73
  74 /* common/pgfnames.c */
  75 extern char **pgfnames(const char *path);
  76 extern void pgfnames_cleanup(char **filenames);
  77
  78 /*
  79  *      is_absolute_path
  80  *
  81  *      By making this a macro we avoid needing to include path.c in libpq.
  82  */
  83 #ifndef WIN32
  84 #define IS_DIR_SEP(ch)  ((ch) == '/')
  85
  86 #define is_absolute_path(filename) \
  87 ( \
  88         IS_DIR_SEP((filename)[0]) \
  89 )
  90 #else
  91 #define IS_DIR_SEP(ch)  ((ch) == '/' || (ch) == '\\')
  92
  93 /* See path_is_relative_and_below_cwd() for how we handle 'E:abc'. */
  94 #define is_absolute_path(filename) \
  95 ( \
  96         IS_DIR_SEP((filename)[0]) || \
  97         (isalpha((unsigned char) ((filename)[0])) && (filename)[1] == ':' && \
  98          IS_DIR_SEP((filename)[2])) \
  99 )
 100 #endif
 101
 102 /* Portable locale initialization (in exec.c) */
 103 extern void set_pglocale_pgservice(const char *argv0, const char *app);
 104
 105 /* Portable way to find binaries (in exec.c) */
 106 extern int      find_my_exec(const char *argv0, char *retpath);
 107 extern int find_other_exec(const char *argv0, const char *target,
 108                                 const char *versionstr, char *retpath);
 109
 110 /* Doesn't belong here, but this is used with find_other_exec(), so... */
 111 #define PG_BACKEND_VERSIONSTR "postgres (PostgreSQL) " PG_VERSION "\n"
 112
 113
 114 #if defined(WIN32) || defined(__CYGWIN__)
 115 #define EXE ".exe"
 116 #else
 117 #define EXE ""
 118 #endif
 119
 120 #if defined(WIN32) && !defined(__CYGWIN__)
 121 #define DEVNULL "nul"
 122 #else
 123 #define DEVNULL "/dev/null"
 124 #endif
 125
 126 /* Portable delay handling */
 127 extern void pg_usleep(long microsec);
 128
 129 /* Portable SQL-like case-independent comparisons and conversions */
 130 extern int      pg_strcasecmp(const char *s1, const char *s2);
 131 extern int      pg_strncasecmp(const char *s1, const char *s2, size_t n);
 132 extern unsigned char pg_toupper(unsigned char ch);
 133 extern unsigned char pg_tolower(unsigned char ch);
 134 extern unsigned char pg_ascii_toupper(unsigned char ch);
 135 extern unsigned char pg_ascii_tolower(unsigned char ch);
 136
 137 #ifdef USE_REPL_SNPRINTF
 138
 139 /*
 140  * Versions of libintl >= 0.13 try to replace printf() and friends with
 141  * macros to their own versions that understand the %$ format.  We do the
 142  * same, so disable their macros, if they exist.
 143  */
 144 #ifdef vsnprintf
 145 #undef vsnprintf
 146 #endif
 147 #ifdef snprintf
 148 #undef snprintf
 149 #endif
 150 #ifdef sprintf
 151 #undef sprintf
 152 #endif
 153 #ifdef vfprintf
 154 #undef vfprintf
 155 #endif
 156 #ifdef fprintf
 157 #undef fprintf
 158 #endif
 159 #ifdef printf
 160 #undef printf
 161 #endif
 162
 163 extern int      pg_vsnprintf(char *str, size_t count, const char *fmt, va_list args);
 164 extern int      pg_snprintf(char *str, size_t count, const char *fmt,...) pg_attribute_printf(3, 4);
 165 extern int      pg_sprintf(char *str, const char *fmt,...) pg_attribute_printf(2, 3);
 166 extern int      pg_vfprintf(FILE *stream, const char *fmt, va_list args);
 167 extern int      pg_fprintf(FILE *stream, const char *fmt,...) pg_attribute_printf(2, 3);
 168 extern int      pg_printf(const char *fmt,...) pg_attribute_printf(1, 2);
 169
 170 /*
 171  *      The GCC-specific code below prevents the pg_attribute_printf above from
 172  *      being replaced, and this is required because gcc doesn't know anything
 173  *      about pg_printf.
 174  */
 175 #ifdef __GNUC__
 176 #define vsnprintf(...)  pg_vsnprintf(__VA_ARGS__)
 177 #define snprintf(...)   pg_snprintf(__VA_ARGS__)
 178 #define sprintf(...)    pg_sprintf(__VA_ARGS__)
 179 #define vfprintf(...)   pg_vfprintf(__VA_ARGS__)
 180 #define fprintf(...)    pg_fprintf(__VA_ARGS__)
 181 #define printf(...)             pg_printf(__VA_ARGS__)
 182 #else
 183 #define vsnprintf               pg_vsnprintf
 184 #define snprintf                pg_snprintf
 185 #define sprintf                 pg_sprintf
 186 #define vfprintf                pg_vfprintf
 187 #define fprintf                 pg_fprintf
 188 #define printf                  pg_printf
 189 #endif
 190 #endif                                                  /* USE_REPL_SNPRINTF */
 191
 192 /* Replace strerror() with our own, somewhat more robust wrapper */
 193 extern char *pg_strerror(int errnum);
 194 #define strerror pg_strerror
 195
 196 /* Likewise for strerror_r(); note we prefer the GNU API for that */
 197 extern char *pg_strerror_r(int errnum, char *buf, size_t buflen);
 198 #define strerror_r pg_strerror_r
 199 #define PG_STRERROR_R_BUFLEN 256        /* Recommended buffer size for strerror_r */
 200
 201 /* Portable prompt handling */
 202 extern void simple_prompt(const char *prompt, char *destination, size_t destlen,
 203                           bool echo);
 204
 205 extern int      pclose_check(FILE *stream);
 206
 207 /* Global variable holding time zone information. */
 208 #if defined(WIN32) || defined(__CYGWIN__)
 209 #define TIMEZONE_GLOBAL _timezone
 210 #define TZNAME_GLOBAL _tzname
 211 #else
 212 #define TIMEZONE_GLOBAL timezone
 213 #define TZNAME_GLOBAL tzname
 214 #endif
 215
 216 #if defined(WIN32) || defined(__CYGWIN__)
 217 /*
 218  *      Win32 doesn't have reliable rename/unlink during concurrent access.
 219  */
 220 extern int      pgrename(const char *from, const char *to);
 221 extern int      pgunlink(const char *path);
 222
 223 /* Include this first so later includes don't see these defines */
 224 #ifdef _MSC_VER
 225 #include <io.h>
 226 #endif
 227
 228 #define rename(from, to)                pgrename(from, to)
 229 #define unlink(path)                    pgunlink(path)
 230 #endif                                                  /* defined(WIN32) || defined(__CYGWIN__) */
 231
 232 /*
 233  *      Win32 also doesn't have symlinks, but we can emulate them with
 234  *      junction points on newer Win32 versions.
 235  *
 236  *      Cygwin has its own symlinks which work on Win95/98/ME where
 237  *      junction points don't, so use those instead.  We have no way of
 238  *      knowing what type of system Cygwin binaries will be run on.
 239  *              Note: Some CYGWIN includes might #define WIN32.
 240  */
 241 #if defined(WIN32) && !defined(__CYGWIN__)
 242 extern int      pgsymlink(const char *oldpath, const char *newpath);
 243 extern int      pgreadlink(const char *path, char *buf, size_t size);
 244 extern bool pgwin32_is_junction(const char *path);
 245
 246 #define symlink(oldpath, newpath)       pgsymlink(oldpath, newpath)
 247 #define readlink(path, buf, size)       pgreadlink(path, buf, size)
 248 #endif
 249
 250 extern bool rmtree(const char *path, bool rmtopdir);
 251
 252 #if defined(WIN32) && !defined(__CYGWIN__)
 253
 254 /*
 255  * open() and fopen() replacements to allow deletion of open files and
 256  * passing of other special options.
 257  */
 258 #define         O_DIRECT        0x80000000
 259 extern int      pgwin32_open(const char *, int,...);
 260 extern FILE *pgwin32_fopen(const char *, const char *);
 261 #define         open(a,b,c) pgwin32_open(a,b,c)
 262 #define         fopen(a,b) pgwin32_fopen(a,b)
 263
 264 /*
 265  * Mingw-w64 headers #define popen and pclose to _popen and _pclose.  We want
 266  * to use our popen wrapper, rather than plain _popen, so override that.  For
 267  * consistency, use our version of pclose, too.
 268  */
 269 #ifdef popen
 270 #undef popen
 271 #endif
 272 #ifdef pclose
 273 #undef pclose
 274 #endif
 275
 276 /*
 277  * system() and popen() replacements to enclose the command in an extra
 278  * pair of quotes.
 279  */
 280 extern int      pgwin32_system(const char *command);
 281 extern FILE *pgwin32_popen(const char *command, const char *type);
 282
 283 #define system(a) pgwin32_system(a)
 284 #define popen(a,b) pgwin32_popen(a,b)
 285 #define pclose(a) _pclose(a)
 286
 287 /* New versions of MingW have gettimeofday, old mingw and msvc don't */
 288 #ifndef HAVE_GETTIMEOFDAY
 289 /* Last parameter not used */
 290 extern int      gettimeofday(struct timeval *tp, struct timezone *tzp);
 291 #endif
 292 #else                                                   /* !WIN32 */
 293
 294 /*
 295  *      Win32 requires a special close for sockets and pipes, while on Unix
 296  *      close() does them all.
 297  */
 298 #define closesocket close
 299 #endif                                                  /* WIN32 */
 300
 301 /*
 302  * On Windows, setvbuf() does not support _IOLBF mode, and interprets that
 303  * as _IOFBF.  To add insult to injury, setvbuf(file, NULL, _IOFBF, 0)
 304  * crashes outright if "parameter validation" is enabled.  Therefore, in
 305  * places where we'd like to select line-buffered mode, we fall back to
 306  * unbuffered mode instead on Windows.  Always use PG_IOLBF not _IOLBF
 307  * directly in order to implement this behavior.
 308  */
 309 #ifndef WIN32
 310 #define PG_IOLBF        _IOLBF
 311 #else
 312 #define PG_IOLBF        _IONBF
 313 #endif
 314
 315 /*
 316  * Default "extern" declarations or macro substitutes for library routines.
 317  * When necessary, these routines are provided by files in src/port/.
 318  */
 319 #ifndef HAVE_CRYPT
 320 extern char *crypt(const char *key, const char *setting);
 321 #endif
 322
 323 /* WIN32 handled in port/win32_port.h */
 324 #ifndef WIN32
 325 #define pgoff_t off_t
 326 #ifdef __NetBSD__
 327 extern int      fseeko(FILE *stream, off_t offset, int whence);
 328 extern off_t ftello(FILE *stream);
 329 #endif
 330 #endif
 331
 332 extern double pg_erand48(unsigned short xseed[3]);
 333 extern long pg_lrand48(void);
 334 extern long pg_jrand48(unsigned short xseed[3]);
 335 extern void pg_srand48(long seed);
 336
 337 #ifndef HAVE_FLS
 338 extern int      fls(int mask);
 339 #endif
 340
 341 #ifndef HAVE_FSEEKO
 342 #define fseeko(a, b, c) fseek(a, b, c)
 343 #define ftello(a)               ftell(a)
 344 #endif
 345
 346 #if !defined(HAVE_GETPEEREID) && !defined(WIN32)
 347 extern int      getpeereid(int sock, uid_t *uid, gid_t *gid);
 348 #endif
 349
 350 #ifndef HAVE_ISINF
 351 extern int      isinf(double x);
 352 #else
 353 /*
 354  * Glibc doesn't use the builtin for clang due to a *gcc* bug in a version
 355  * newer than the gcc compatibility clang claims to have. This would cause a
 356  * *lot* of superfluous function calls, therefore revert when using clang. In
 357  * C++ there's issues with libc++ (not libstdc++), so disable as well.
 358  */
 359 #if defined(__clang__) && !defined(__cplusplus)
 360 /* needs to be separate to not confuse other compilers */
 361 #if __has_builtin(__builtin_isinf)
 362 /* need to include before, to avoid getting overwritten */
 363 #include <math.h>
 364 #undef isinf
 365 #define isinf __builtin_isinf
 366 #endif                                                  /* __has_builtin(isinf) */
 367 #endif                                                  /* __clang__ && !__cplusplus */
 368 #endif                                                  /* !HAVE_ISINF */
 369
 370 #ifndef HAVE_MKDTEMP
 371 extern char *mkdtemp(char *path);
 372 #endif
 373
 374 #ifndef HAVE_RINT
 375 extern double rint(double x);
 376 #endif
 377
 378 #ifndef HAVE_INET_ATON
 379 #include <netinet/in.h>
 380 #include <arpa/inet.h>
 381 extern int      inet_aton(const char *cp, struct in_addr *addr);
 382 #endif
 383
 384 #if !HAVE_DECL_STRLCAT
 385 extern size_t strlcat(char *dst, const char *src, size_t siz);
 386 #endif
 387
 388 #if !HAVE_DECL_STRLCPY
 389 extern size_t strlcpy(char *dst, const char *src, size_t siz);
 390 #endif
 391
 392 #if !HAVE_DECL_STRNLEN
 393 extern size_t strnlen(const char *str, size_t maxlen);
 394 #endif
 395
 396 #if !defined(HAVE_RANDOM)
 397 extern long random(void);
 398 #endif
 399
 400 #ifndef HAVE_UNSETENV
 401 extern void unsetenv(const char *name);
 402 #endif
 403
 404 #ifndef HAVE_SRANDOM
 405 extern void srandom(unsigned int seed);
 406 #endif
 407
 408 #ifndef HAVE_SSL_GET_CURRENT_COMPRESSION
 409 #define SSL_get_current_compression(x) 0
 410 #endif
 411
 412 #ifndef HAVE_DLOPEN
 413 extern void *dlopen(const char *file, int mode);
 414 extern void *dlsym(void *handle, const char *symbol);
 415 extern int      dlclose(void *handle);
 416 extern char *dlerror(void);
 417 #endif
 418
 419 /*
 420  * In some older systems, the RTLD_NOW flag isn't defined and the mode
 421  * argument to dlopen must always be 1.
 422  */
 423 #if !HAVE_DECL_RTLD_NOW
 424 #define RTLD_NOW 1
 425 #endif
 426
 427 /*
 428  * The RTLD_GLOBAL flag is wanted if available, but it doesn't exist
 429  * everywhere.  If it doesn't exist, set it to 0 so it has no effect.
 430  */
 431 #if !HAVE_DECL_RTLD_GLOBAL
 432 #define RTLD_GLOBAL 0
 433 #endif
 434
 435 /* thread.h */
 436 #ifndef WIN32
 437 extern int pqGetpwuid(uid_t uid, struct passwd *resultbuf, char *buffer,
 438                    size_t buflen, struct passwd **result);
 439 #endif
 440
 441 extern int pqGethostbyname(const char *name,
 442                                 struct hostent *resultbuf,
 443                                 char *buffer, size_t buflen,
 444                                 struct hostent **result,
 445                                 int *herrno);
 446
 447 extern void pg_qsort(void *base, size_t nel, size_t elsize,
 448                  int (*cmp) (const void *, const void *));
 449 extern int      pg_qsort_strcmp(const void *a, const void *b);
 450
 451 #define qsort(a,b,c,d) pg_qsort(a,b,c,d)
 452
 453 typedef int (*qsort_arg_comparator) (const void *a, const void *b, void *arg);
 454
 455 extern void qsort_arg(void *base, size_t nel, size_t elsize,
 456                   qsort_arg_comparator cmp, void *arg);
 457
 458 /* port/chklocale.c */
 459 extern int      pg_get_encoding_from_locale(const char *ctype, bool write_message);
 460
 461 #if defined(WIN32) && !defined(FRONTEND)
 462 extern int      pg_codepage_to_encoding(UINT cp);
 463 #endif
 464
 465 /* port/inet_net_ntop.c */
 466 extern char *inet_net_ntop(int af, const void *src, int bits,
 467                           char *dst, size_t size);
 468
 469 /* port/pg_strong_random.c */
 470 #ifdef HAVE_STRONG_RANDOM
 471 extern bool pg_strong_random(void *buf, size_t len);
 472 #endif
 473
 474 /* port/pgcheckdir.c */
 475 extern int      pg_check_dir(const char *dir);
 476
 477 /* port/pgmkdirp.c */
 478 extern int      pg_mkdir_p(char *path, int omode);
 479
 480 /* port/pqsignal.c */
 481 typedef void (*pqsigfunc) (int signo);
 482 extern pqsigfunc pqsignal(int signo, pqsigfunc func);
 483 #ifndef WIN32
 484 extern pqsigfunc pqsignal_no_restart(int signo, pqsigfunc func);
 485 #else
 486 #define pqsignal_no_restart(signo, func) pqsignal(signo, func)
 487 #endif
 488
 489 /* port/quotes.c */
 490 extern char *escape_single_quotes_ascii(const char *src);
 491
 492 /* port/wait_error.c */
 493 extern char *wait_result_to_str(int exit_status);
 494
 495 #endif                                                  /* PG_PORT_H */