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 /* Wrap strsignal(), or provide our own version if necessary */ 193 extern const char *pg_strsignal(int signum); 194 195 /* Portable prompt handling */ 196 extern void simple_prompt(const char *prompt, char *destination, size_t destlen, 197 bool echo); 198 199 extern int pclose_check(FILE *stream); 200 201 /* Global variable holding time zone information. */ 202 #if defined(WIN32) || defined(__CYGWIN__) 203 #define TIMEZONE_GLOBAL _timezone 204 #define TZNAME_GLOBAL _tzname 205 #else 206 #define TIMEZONE_GLOBAL timezone 207 #define TZNAME_GLOBAL tzname 208 #endif 209 210 #if defined(WIN32) || defined(__CYGWIN__) 211 /* 212 * Win32 doesn't have reliable rename/unlink during concurrent access. 213 */ 214 extern int pgrename(const char *from, const char *to); 215 extern int pgunlink(const char *path); 216 217 /* Include this first so later includes don't see these defines */ 218 #ifdef _MSC_VER 219 #include <io.h> 220 #endif 221 222 #define rename(from, to) pgrename(from, to) 223 #define unlink(path) pgunlink(path) 224 #endif /* defined(WIN32) || defined(__CYGWIN__) */ 225 226 /* 227 * Win32 also doesn't have symlinks, but we can emulate them with 228 * junction points on newer Win32 versions. 229 * 230 * Cygwin has its own symlinks which work on Win95/98/ME where 231 * junction points don't, so use those instead. We have no way of 232 * knowing what type of system Cygwin binaries will be run on. 233 * Note: Some CYGWIN includes might #define WIN32. 234 */ 235 #if defined(WIN32) && !defined(__CYGWIN__) 236 extern int pgsymlink(const char *oldpath, const char *newpath); 237 extern int pgreadlink(const char *path, char *buf, size_t size); 238 extern bool pgwin32_is_junction(const char *path); 239 240 #define symlink(oldpath, newpath) pgsymlink(oldpath, newpath) 241 #define readlink(path, buf, size) pgreadlink(path, buf, size) 242 #endif 243 244 extern bool rmtree(const char *path, bool rmtopdir); 245 246 #if defined(WIN32) && !defined(__CYGWIN__) 247 248 /* 249 * open() and fopen() replacements to allow deletion of open files and 250 * passing of other special options. 251 */ 252 #define O_DIRECT 0x80000000 253 extern int pgwin32_open(const char *, int,...); 254 extern FILE *pgwin32_fopen(const char *, const char *); 255 256 #ifndef FRONTEND 257 #define open(a,b,c) pgwin32_open(a,b,c) 258 #define fopen(a,b) pgwin32_fopen(a,b) 259 #endif 260 261 /* 262 * Mingw-w64 headers #define popen and pclose to _popen and _pclose. We want 263 * to use our popen wrapper, rather than plain _popen, so override that. For 264 * consistency, use our version of pclose, too. 265 */ 266 #ifdef popen 267 #undef popen 268 #endif 269 #ifdef pclose 270 #undef pclose 271 #endif 272 273 /* 274 * system() and popen() replacements to enclose the command in an extra 275 * pair of quotes. 276 */ 277 extern int pgwin32_system(const char *command); 278 extern FILE *pgwin32_popen(const char *command, const char *type); 279 280 #define system(a) pgwin32_system(a) 281 #define popen(a,b) pgwin32_popen(a,b) 282 #define pclose(a) _pclose(a) 283 284 /* New versions of MingW have gettimeofday, old mingw and msvc don't */ 285 #ifndef HAVE_GETTIMEOFDAY 286 /* Last parameter not used */ 287 extern int gettimeofday(struct timeval *tp, struct timezone *tzp); 288 #endif 289 #else /* !WIN32 */ 290 291 /* 292 * Win32 requires a special close for sockets and pipes, while on Unix 293 * close() does them all. 294 */ 295 #define closesocket close 296 #endif /* WIN32 */ 297 298 /* 299 * On Windows, setvbuf() does not support _IOLBF mode, and interprets that 300 * as _IOFBF. To add insult to injury, setvbuf(file, NULL, _IOFBF, 0) 301 * crashes outright if "parameter validation" is enabled. Therefore, in 302 * places where we'd like to select line-buffered mode, we fall back to 303 * unbuffered mode instead on Windows. Always use PG_IOLBF not _IOLBF 304 * directly in order to implement this behavior. 305 */ 306 #ifndef WIN32 307 #define PG_IOLBF _IOLBF 308 #else 309 #define PG_IOLBF _IONBF 310 #endif 311 312 /* 313 * Default "extern" declarations or macro substitutes for library routines. 314 * When necessary, these routines are provided by files in src/port/. 315 */ 316 #ifndef HAVE_CRYPT 317 extern char *crypt(const char *key, const char *setting); 318 #endif 319 320 /* WIN32 handled in port/win32_port.h */ 321 #ifndef WIN32 322 #define pgoff_t off_t 323 #ifdef __NetBSD__ 324 extern int fseeko(FILE *stream, off_t offset, int whence); 325 extern off_t ftello(FILE *stream); 326 #endif 327 #endif 328 329 extern double pg_erand48(unsigned short xseed[3]); 330 extern long pg_lrand48(void); 331 extern long pg_jrand48(unsigned short xseed[3]); 332 extern void pg_srand48(long seed); 333 334 #ifndef HAVE_FLS 335 extern int fls(int mask); 336 #endif 337 338 #ifndef HAVE_FSEEKO 339 #define fseeko(a, b, c) fseek(a, b, c) 340 #define ftello(a) ftell(a) 341 #endif 342 343 #if !defined(HAVE_GETPEEREID) && !defined(WIN32) 344 extern int getpeereid(int sock, uid_t *uid, gid_t *gid); 345 #endif 346 347 #ifndef HAVE_ISINF 348 extern int isinf(double x); 349 #else 350 /* 351 * Glibc doesn't use the builtin for clang due to a *gcc* bug in a version 352 * newer than the gcc compatibility clang claims to have. This would cause a 353 * *lot* of superfluous function calls, therefore revert when using clang. In 354 * C++ there's issues with libc++ (not libstdc++), so disable as well. 355 */ 356 #if defined(__clang__) && !defined(__cplusplus) 357 /* needs to be separate to not confuse other compilers */ 358 #if __has_builtin(__builtin_isinf) 359 /* need to include before, to avoid getting overwritten */ 360 #include <math.h> 361 #undef isinf 362 #define isinf __builtin_isinf 363 #endif /* __has_builtin(isinf) */ 364 #endif /* __clang__ && !__cplusplus*/ 365 #endif /* !HAVE_ISINF */ 366 367 #ifndef HAVE_MKDTEMP 368 extern char *mkdtemp(char *path); 369 #endif 370 371 #ifndef HAVE_RINT 372 extern double rint(double x); 373 #endif 374 375 #ifndef HAVE_INET_ATON 376 #include <netinet/in.h> 377 #include <arpa/inet.h> 378 extern int inet_aton(const char *cp, struct in_addr *addr); 379 #endif 380 381 #if !HAVE_DECL_STRLCAT 382 extern size_t strlcat(char *dst, const char *src, size_t siz); 383 #endif 384 385 #if !HAVE_DECL_STRLCPY 386 extern size_t strlcpy(char *dst, const char *src, size_t siz); 387 #endif 388 389 #if !HAVE_DECL_STRNLEN 390 extern size_t strnlen(const char *str, size_t maxlen); 391 #endif 392 393 #if !defined(HAVE_RANDOM) 394 extern long random(void); 395 #endif 396 397 #ifndef HAVE_UNSETENV 398 extern void unsetenv(const char *name); 399 #endif 400 401 #ifndef HAVE_SRANDOM 402 extern void srandom(unsigned int seed); 403 #endif 404 405 #ifndef HAVE_SSL_GET_CURRENT_COMPRESSION 406 #define SSL_get_current_compression(x) 0 407 #endif 408 409 /* thread.h */ 410 extern char *pqStrerror(int errnum, char *strerrbuf, size_t buflen); 411 412 #ifndef WIN32 413 extern int pqGetpwuid(uid_t uid, struct passwd *resultbuf, char *buffer, 414 size_t buflen, struct passwd **result); 415 #endif 416 417 extern int pqGethostbyname(const char *name, 418 struct hostent *resultbuf, 419 char *buffer, size_t buflen, 420 struct hostent **result, 421 int *herrno); 422 423 extern void pg_qsort(void *base, size_t nel, size_t elsize, 424 int (*cmp) (const void *, const void *)); 425 extern int pg_qsort_strcmp(const void *a, const void *b); 426 427 #define qsort(a,b,c,d) pg_qsort(a,b,c,d) 428 429 typedef int (*qsort_arg_comparator) (const void *a, const void *b, void *arg); 430 431 extern void qsort_arg(void *base, size_t nel, size_t elsize, 432 qsort_arg_comparator cmp, void *arg); 433 434 /* port/chklocale.c */ 435 extern int pg_get_encoding_from_locale(const char *ctype, bool write_message); 436 437 #if defined(WIN32) && !defined(FRONTEND) 438 extern int pg_codepage_to_encoding(UINT cp); 439 #endif 440 441 /* port/inet_net_ntop.c */ 442 extern char *inet_net_ntop(int af, const void *src, int bits, 443 char *dst, size_t size); 444 445 /* port/pg_strong_random.c */ 446 #ifdef HAVE_STRONG_RANDOM 447 extern bool pg_strong_random(void *buf, size_t len); 448 #endif 449 450 /* port/pgcheckdir.c */ 451 extern int pg_check_dir(const char *dir); 452 453 /* port/pgmkdirp.c */ 454 extern int pg_mkdir_p(char *path, int omode); 455 456 /* port/pqsignal.c */ 457 typedef void (*pqsigfunc) (int signo); 458 extern pqsigfunc pqsignal(int signo, pqsigfunc func); 459 460 /* port/quotes.c */ 461 extern char *escape_single_quotes_ascii(const char *src); 462 463 /* common/wait_error.c */ 464 extern char *wait_result_to_str(int exit_status); 465 extern bool wait_result_is_signal(int exit_status, int signum); 466 extern bool wait_result_is_any_signal(int exit_status, bool include_command_not_found); 467 468 #endif /* PG_PORT_H */ 469