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