1 /*-------------------------------------------------------------------------
4 * Header for src/port/ compatibility functions.
6 * Portions Copyright (c) 1996-2014, PostgreSQL Global Development Group
7 * Portions Copyright (c) 1994, Regents of the University of California
11 *-------------------------------------------------------------------------
20 /* socket has a different definition on WIN32 */
24 #define PGINVALID_SOCKET (-1)
26 typedef SOCKET pgsocket;
28 #define PGINVALID_SOCKET INVALID_SOCKET
32 extern bool pg_set_noblock(pgsocket sock);
33 extern bool pg_set_block(pgsocket sock);
35 /* Portable path handling for Unix/Win32 (in path.c) */
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 const char *get_progname(const char *argv0);
49 extern void get_share_path(const char *my_exec_path, char *ret_path);
50 extern void get_etc_path(const char *my_exec_path, char *ret_path);
51 extern void get_include_path(const char *my_exec_path, char *ret_path);
52 extern void get_pkginclude_path(const char *my_exec_path, char *ret_path);
53 extern void get_includeserver_path(const char *my_exec_path, char *ret_path);
54 extern void get_lib_path(const char *my_exec_path, char *ret_path);
55 extern void get_pkglib_path(const char *my_exec_path, char *ret_path);
56 extern void get_locale_path(const char *my_exec_path, char *ret_path);
57 extern void get_doc_path(const char *my_exec_path, char *ret_path);
58 extern void get_html_path(const char *my_exec_path, char *ret_path);
59 extern void get_man_path(const char *my_exec_path, char *ret_path);
60 extern bool get_home_path(char *ret_path);
61 extern void get_parent_directory(char *path);
64 extern char **pgfnames(const char *path);
65 extern void pgfnames_cleanup(char **filenames);
70 * By making this a macro we avoid needing to include path.c in libpq.
73 #define IS_DIR_SEP(ch) ((ch) == '/')
75 #define is_absolute_path(filename) \
77 IS_DIR_SEP((filename)[0]) \
80 #define IS_DIR_SEP(ch) ((ch) == '/' || (ch) == '\\')
82 /* See path_is_relative_and_below_cwd() for how we handle 'E:abc'. */
83 #define is_absolute_path(filename) \
85 IS_DIR_SEP((filename)[0]) || \
86 (isalpha((unsigned char) ((filename)[0])) && (filename)[1] == ':' && \
87 IS_DIR_SEP((filename)[2])) \
91 /* Portable locale initialization (in exec.c) */
92 extern void set_pglocale_pgservice(const char *argv0, const char *app);
94 /* Portable way to find binaries (in exec.c) */
95 extern int find_my_exec(const char *argv0, char *retpath);
96 extern int find_other_exec(const char *argv0, const char *target,
97 const char *versionstr, char *retpath);
99 /* Windows security token manipulation (in exec.c) */
101 extern BOOL AddUserToTokenDacl(HANDLE hToken);
105 #if defined(WIN32) || defined(__CYGWIN__)
111 #if defined(WIN32) && !defined(__CYGWIN__)
112 #define DEVNULL "nul"
114 #define DEVNULL "/dev/null"
118 * Win32 needs double quotes at the beginning and end of system()
119 * strings. If not, it gets confused with multiple quoted strings.
120 * It also requires double-quotes around the executable name and
121 * any files used for redirection. Other args can use single-quotes.
123 * Generated using Win32 "CMD /?":
125 * 1. If all of the following conditions are met, then quote characters
126 * on the command line are preserved:
129 * - exactly two quote characters
130 * - no special characters between the two quote characters, where special
131 * is one of: &<>()@^|
132 * - there are one or more whitespace characters between the two quote
134 * - the string between the two quote characters is the name of an
137 * 2. Otherwise, old behavior is to see if the first character is a quote
138 * character and if so, strip the leading character and remove the last
139 * quote character on the command line, preserving any text after the last
142 #if defined(WIN32) && !defined(__CYGWIN__)
143 #define SYSTEMQUOTE "\""
145 #define SYSTEMQUOTE ""
148 /* Portable delay handling */
149 extern void pg_usleep(long microsec);
151 /* Portable SQL-like case-independent comparisons and conversions */
152 extern int pg_strcasecmp(const char *s1, const char *s2);
153 extern int pg_strncasecmp(const char *s1, const char *s2, size_t n);
154 extern unsigned char pg_toupper(unsigned char ch);
155 extern unsigned char pg_tolower(unsigned char ch);
156 extern unsigned char pg_ascii_toupper(unsigned char ch);
157 extern unsigned char pg_ascii_tolower(unsigned char ch);
159 #ifdef USE_REPL_SNPRINTF
162 * Versions of libintl >= 0.13 try to replace printf() and friends with
163 * macros to their own versions that understand the %$ format. We do the
164 * same, so disable their macros, if they exist.
185 extern int pg_vsnprintf(char *str, size_t count, const char *fmt, va_list args);
187 pg_snprintf(char *str, size_t count, const char *fmt,...)
188 /* This extension allows gcc to check the format string */
189 __attribute__((format(PG_PRINTF_ATTRIBUTE, 3, 4)));
191 pg_sprintf(char *str, const char *fmt,...)
192 /* This extension allows gcc to check the format string */
193 __attribute__((format(PG_PRINTF_ATTRIBUTE, 2, 3)));
194 extern int pg_vfprintf(FILE *stream, const char *fmt, va_list args);
196 pg_fprintf(FILE *stream, const char *fmt,...)
197 /* This extension allows gcc to check the format string */
198 __attribute__((format(PG_PRINTF_ATTRIBUTE, 2, 3)));
200 pg_printf(const char *fmt,...)
201 /* This extension allows gcc to check the format string */
202 __attribute__((format(PG_PRINTF_ATTRIBUTE, 1, 2)));
205 * The GCC-specific code below prevents the __attribute__(... 'printf')
206 * above from being replaced, and this is required because gcc doesn't
207 * know anything about pg_printf.
210 #define vsnprintf(...) pg_vsnprintf(__VA_ARGS__)
211 #define snprintf(...) pg_snprintf(__VA_ARGS__)
212 #define sprintf(...) pg_sprintf(__VA_ARGS__)
213 #define vfprintf(...) pg_vfprintf(__VA_ARGS__)
214 #define fprintf(...) pg_fprintf(__VA_ARGS__)
215 #define printf(...) pg_printf(__VA_ARGS__)
217 #define vsnprintf pg_vsnprintf
218 #define snprintf pg_snprintf
219 #define sprintf pg_sprintf
220 #define vfprintf pg_vfprintf
221 #define fprintf pg_fprintf
222 #define printf pg_printf
224 #endif /* USE_REPL_SNPRINTF */
228 * Versions of libintl >= 0.18? try to replace setlocale() with a macro
229 * to their own versions. Remove the macro, if it exists, because it
230 * ends up calling the wrong version when the backend and libintl use
231 * different versions of msvcrt.
233 #if defined(setlocale)
238 * Define our own wrapper macro around setlocale() to work around bugs in
239 * Windows' native setlocale() function.
241 extern char *pgwin32_setlocale(int category, const char *locale);
243 #define setlocale(a,b) pgwin32_setlocale(a,b)
246 /* Portable prompt handling */
247 extern char *simple_prompt(const char *prompt, int maxlen, bool echo);
250 #define PG_SIGNAL_COUNT 32
251 #define kill(pid,sig) pgkill(pid,sig)
252 extern int pgkill(int pid, int sig);
255 extern int pclose_check(FILE *stream);
257 /* Global variable holding time zone information. */
259 #define TIMEZONE_GLOBAL timezone
260 #define TZNAME_GLOBAL tzname
262 #define TIMEZONE_GLOBAL _timezone
263 #define TZNAME_GLOBAL _tzname
266 #if defined(WIN32) || defined(__CYGWIN__)
268 * Win32 doesn't have reliable rename/unlink during concurrent access.
270 extern int pgrename(const char *from, const char *to);
271 extern int pgunlink(const char *path);
273 /* Include this first so later includes don't see these defines */
274 #ifdef WIN32_ONLY_COMPILER
278 #define rename(from, to) pgrename(from, to)
279 #define unlink(path) pgunlink(path)
280 #endif /* defined(WIN32) || defined(__CYGWIN__) */
283 * Win32 also doesn't have symlinks, but we can emulate them with
284 * junction points on newer Win32 versions.
286 * Cygwin has its own symlinks which work on Win95/98/ME where
287 * junction points don't, so use those instead. We have no way of
288 * knowing what type of system Cygwin binaries will be run on.
289 * Note: Some CYGWIN includes might #define WIN32.
291 #if defined(WIN32) && !defined(__CYGWIN__)
292 extern int pgsymlink(const char *oldpath, const char *newpath);
293 extern int pgreadlink(const char *path, char *buf, size_t size);
294 extern bool pgwin32_is_junction(char *path);
296 #define symlink(oldpath, newpath) pgsymlink(oldpath, newpath)
297 #define readlink(path, buf, size) pgreadlink(path, buf, size)
300 extern bool rmtree(const char *path, bool rmtopdir);
303 * stat() is not guaranteed to set the st_size field on win32, so we
304 * redefine it to our own implementation that is.
306 * We must pull in sys/stat.h here so the system header definition
307 * goes in first, and we redefine that, and not the other way around.
309 * Some frontends don't need the size from stat, so if UNSAFE_STAT_OK
310 * is defined we don't bother with this.
312 #if defined(WIN32) && !defined(__CYGWIN__) && !defined(UNSAFE_STAT_OK)
313 #include <sys/stat.h>
314 extern int pgwin32_safestat(const char *path, struct stat * buf);
316 #define stat(a,b) pgwin32_safestat(a,b)
319 #if defined(WIN32) && !defined(__CYGWIN__)
322 * open() and fopen() replacements to allow deletion of open files and
323 * passing of other special options.
325 #define O_DIRECT 0x80000000
326 extern int pgwin32_open(const char *, int,...);
327 extern FILE *pgwin32_fopen(const char *, const char *);
330 #define open(a,b,c) pgwin32_open(a,b,c)
331 #define fopen(a,b) pgwin32_fopen(a,b)
335 #define popen(a,b) _popen(a,b)
338 #define pclose(a) _pclose(a)
341 /* New versions of MingW have gettimeofday, old mingw and msvc don't */
342 #ifndef HAVE_GETTIMEOFDAY
343 /* Last parameter not used */
344 extern int gettimeofday(struct timeval * tp, struct timezone * tzp);
349 * Win32 requires a special close for sockets and pipes, while on Unix
350 * close() does them all.
352 #define closesocket close
356 * Default "extern" declarations or macro substitutes for library routines.
357 * When necessary, these routines are provided by files in src/port/.
360 extern char *crypt(const char *key, const char *setting);
363 /* WIN32 handled in port/win32.h */
365 #define pgoff_t off_t
367 extern int fseeko(FILE *stream, off_t offset, int whence);
368 extern off_t ftello(FILE *stream);
372 extern double pg_erand48(unsigned short xseed[3]);
373 extern long pg_lrand48(void);
374 extern void pg_srand48(long seed);
377 extern int fls(int mask);
381 #define fseeko(a, b, c) fseek(a, b, c)
382 #define ftello(a) ftell(a)
386 extern int getopt(int nargc, char *const * nargv, const char *ostr);
389 #if !defined(HAVE_GETPEEREID) && !defined(WIN32)
390 extern int getpeereid(int sock, uid_t *uid, gid_t *gid);
394 extern int isinf(double x);
398 extern double rint(double x);
401 #ifndef HAVE_INET_ATON
402 #include <netinet/in.h>
403 #include <arpa/inet.h>
404 extern int inet_aton(const char *cp, struct in_addr * addr);
407 #if !HAVE_DECL_STRLCAT
408 extern size_t strlcat(char *dst, const char *src, size_t siz);
411 #if !HAVE_DECL_STRLCPY
412 extern size_t strlcpy(char *dst, const char *src, size_t siz);
415 #if !defined(HAVE_RANDOM) && !defined(__BORLANDC__)
416 extern long random(void);
419 #ifndef HAVE_UNSETENV
420 extern void unsetenv(const char *name);
424 extern void srandom(unsigned int seed);
428 extern char *pqStrerror(int errnum, char *strerrbuf, size_t buflen);
430 #if !defined(WIN32) || defined(__CYGWIN__)
431 extern int pqGetpwuid(uid_t uid, struct passwd * resultbuf, char *buffer,
432 size_t buflen, struct passwd ** result);
435 extern int pqGethostbyname(const char *name,
436 struct hostent * resultbuf,
437 char *buffer, size_t buflen,
438 struct hostent ** result,
441 extern void pg_qsort(void *base, size_t nel, size_t elsize,
442 int (*cmp) (const void *, const void *));
443 extern int pg_qsort_strcmp(const void *a, const void *b);
445 #define qsort(a,b,c,d) pg_qsort(a,b,c,d)
447 typedef int (*qsort_arg_comparator) (const void *a, const void *b, void *arg);
449 extern void qsort_arg(void *base, size_t nel, size_t elsize,
450 qsort_arg_comparator cmp, void *arg);
452 /* port/chklocale.c */
453 extern int pg_get_encoding_from_locale(const char *ctype, bool write_message);
455 #if defined(WIN32) && !defined(FRONTEND)
456 extern int pg_codepage_to_encoding(UINT cp);
459 /* port/inet_net_ntop.c */
460 extern char *inet_net_ntop(int af, const void *src, int bits,
461 char *dst, size_t size);
463 /* port/pgcheckdir.c */
464 extern int pg_check_dir(const char *dir);
466 /* port/pgmkdirp.c */
467 extern int pg_mkdir_p(char *path, int omode);
469 /* port/pqsignal.c */
470 typedef void (*pqsigfunc) (int signo);
471 extern pqsigfunc pqsignal(int signo, pqsigfunc func);
474 extern char *escape_single_quotes_ascii(const char *src);
476 /* port/username.c */
477 extern const char *get_user_name(char **errstr);
478 extern const char *get_user_name_or_exit(const char *progname);
480 /* port/wait_error.c */
481 extern char *wait_result_to_str(int exit_status);
483 #endif /* PG_PORT_H */