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 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);
65 extern char **pgfnames(const char *path);
66 extern void pgfnames_cleanup(char **filenames);
71 * By making this a macro we avoid needing to include path.c in libpq.
74 #define IS_DIR_SEP(ch) ((ch) == '/')
76 #define is_absolute_path(filename) \
78 IS_DIR_SEP((filename)[0]) \
81 #define IS_DIR_SEP(ch) ((ch) == '/' || (ch) == '\\')
83 /* See path_is_relative_and_below_cwd() for how we handle 'E:abc'. */
84 #define is_absolute_path(filename) \
86 IS_DIR_SEP((filename)[0]) || \
87 (isalpha((unsigned char) ((filename)[0])) && (filename)[1] == ':' && \
88 IS_DIR_SEP((filename)[2])) \
92 /* Portable locale initialization (in exec.c) */
93 extern void set_pglocale_pgservice(const char *argv0, const char *app);
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);
100 /* Windows security token manipulation (in exec.c) */
102 extern BOOL AddUserToTokenDacl(HANDLE hToken);
106 #if defined(WIN32) || defined(__CYGWIN__)
112 #if defined(WIN32) && !defined(__CYGWIN__)
113 #define DEVNULL "nul"
115 #define DEVNULL "/dev/null"
118 /* Portable delay handling */
119 extern void pg_usleep(long microsec);
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);
129 #ifdef USE_REPL_SNPRINTF
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.
155 extern int pg_vsnprintf(char *str, size_t count, const char *fmt, va_list args);
157 pg_snprintf(char *str, size_t count, const char *fmt,...)
158 /* This extension allows gcc to check the format string */
159 __attribute__((format(PG_PRINTF_ATTRIBUTE, 3, 4)));
161 pg_sprintf(char *str, const char *fmt,...)
162 /* This extension allows gcc to check the format string */
163 __attribute__((format(PG_PRINTF_ATTRIBUTE, 2, 3)));
164 extern int pg_vfprintf(FILE *stream, const char *fmt, va_list args);
166 pg_fprintf(FILE *stream, const char *fmt,...)
167 /* This extension allows gcc to check the format string */
168 __attribute__((format(PG_PRINTF_ATTRIBUTE, 2, 3)));
170 pg_printf(const char *fmt,...)
171 /* This extension allows gcc to check the format string */
172 __attribute__((format(PG_PRINTF_ATTRIBUTE, 1, 2)));
175 * The GCC-specific code below prevents the __attribute__(... 'printf')
176 * above from being replaced, and this is required because gcc doesn't
177 * know anything about pg_printf.
180 #define vsnprintf(...) pg_vsnprintf(__VA_ARGS__)
181 #define snprintf(...) pg_snprintf(__VA_ARGS__)
182 #define sprintf(...) pg_sprintf(__VA_ARGS__)
183 #define vfprintf(...) pg_vfprintf(__VA_ARGS__)
184 #define fprintf(...) pg_fprintf(__VA_ARGS__)
185 #define printf(...) pg_printf(__VA_ARGS__)
187 #define vsnprintf pg_vsnprintf
188 #define snprintf pg_snprintf
189 #define sprintf pg_sprintf
190 #define vfprintf pg_vfprintf
191 #define fprintf pg_fprintf
192 #define printf pg_printf
194 #endif /* USE_REPL_SNPRINTF */
198 * Versions of libintl >= 0.18? try to replace setlocale() with a macro
199 * to their own versions. Remove the macro, if it exists, because it
200 * ends up calling the wrong version when the backend and libintl use
201 * different versions of msvcrt.
203 #if defined(setlocale)
208 * Define our own wrapper macro around setlocale() to work around bugs in
209 * Windows' native setlocale() function.
211 extern char *pgwin32_setlocale(int category, const char *locale);
213 #define setlocale(a,b) pgwin32_setlocale(a,b)
216 /* Portable prompt handling */
217 extern char *simple_prompt(const char *prompt, int maxlen, bool echo);
220 #define PG_SIGNAL_COUNT 32
221 #define kill(pid,sig) pgkill(pid,sig)
222 extern int pgkill(int pid, int sig);
225 extern int pclose_check(FILE *stream);
227 /* Global variable holding time zone information. */
229 #define TIMEZONE_GLOBAL timezone
230 #define TZNAME_GLOBAL tzname
232 #define TIMEZONE_GLOBAL _timezone
233 #define TZNAME_GLOBAL _tzname
236 #if defined(WIN32) || defined(__CYGWIN__)
238 * Win32 doesn't have reliable rename/unlink during concurrent access.
240 extern int pgrename(const char *from, const char *to);
241 extern int pgunlink(const char *path);
243 /* Include this first so later includes don't see these defines */
244 #ifdef WIN32_ONLY_COMPILER
248 #define rename(from, to) pgrename(from, to)
249 #define unlink(path) pgunlink(path)
250 #endif /* defined(WIN32) || defined(__CYGWIN__) */
253 * Win32 also doesn't have symlinks, but we can emulate them with
254 * junction points on newer Win32 versions.
256 * Cygwin has its own symlinks which work on Win95/98/ME where
257 * junction points don't, so use those instead. We have no way of
258 * knowing what type of system Cygwin binaries will be run on.
259 * Note: Some CYGWIN includes might #define WIN32.
261 #if defined(WIN32) && !defined(__CYGWIN__)
262 extern int pgsymlink(const char *oldpath, const char *newpath);
263 extern int pgreadlink(const char *path, char *buf, size_t size);
264 extern bool pgwin32_is_junction(char *path);
266 #define symlink(oldpath, newpath) pgsymlink(oldpath, newpath)
267 #define readlink(path, buf, size) pgreadlink(path, buf, size)
270 extern bool rmtree(const char *path, bool rmtopdir);
273 * stat() is not guaranteed to set the st_size field on win32, so we
274 * redefine it to our own implementation that is.
276 * We must pull in sys/stat.h here so the system header definition
277 * goes in first, and we redefine that, and not the other way around.
279 * Some frontends don't need the size from stat, so if UNSAFE_STAT_OK
280 * is defined we don't bother with this.
282 #if defined(WIN32) && !defined(__CYGWIN__) && !defined(UNSAFE_STAT_OK)
283 #include <sys/stat.h>
284 extern int pgwin32_safestat(const char *path, struct stat * buf);
286 #define stat(a,b) pgwin32_safestat(a,b)
289 #if defined(WIN32) && !defined(__CYGWIN__)
292 * open() and fopen() replacements to allow deletion of open files and
293 * passing of other special options.
295 #define O_DIRECT 0x80000000
296 extern int pgwin32_open(const char *, int,...);
297 extern FILE *pgwin32_fopen(const char *, const char *);
300 #define open(a,b,c) pgwin32_open(a,b,c)
301 #define fopen(a,b) pgwin32_fopen(a,b)
305 * system() and popen() replacements to enclose the command in an extra
308 extern int pgwin32_system(const char *command);
309 extern FILE *pgwin32_popen(const char *command, const char *type);
311 #define system(a) pgwin32_system(a)
312 #define popen(a,b) pgwin32_popen(a,b)
313 #define pclose(a) _pclose(a)
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);
323 * Win32 requires a special close for sockets and pipes, while on Unix
324 * close() does them all.
326 #define closesocket close
330 * Default "extern" declarations or macro substitutes for library routines.
331 * When necessary, these routines are provided by files in src/port/.
334 extern char *crypt(const char *key, const char *setting);
337 /* WIN32 handled in port/win32.h */
339 #define pgoff_t off_t
341 extern int fseeko(FILE *stream, off_t offset, int whence);
342 extern off_t ftello(FILE *stream);
346 extern double pg_erand48(unsigned short xseed[3]);
347 extern long pg_lrand48(void);
348 extern void pg_srand48(long seed);
351 extern int fls(int mask);
355 #define fseeko(a, b, c) fseek(a, b, c)
356 #define ftello(a) ftell(a)
359 #if !defined(HAVE_GETPEEREID) && !defined(WIN32)
360 extern int getpeereid(int sock, uid_t *uid, gid_t *gid);
364 extern int isinf(double x);
368 extern double rint(double x);
371 #ifndef HAVE_INET_ATON
372 #include <netinet/in.h>
373 #include <arpa/inet.h>
374 extern int inet_aton(const char *cp, struct in_addr * addr);
377 #if !HAVE_DECL_STRLCAT
378 extern size_t strlcat(char *dst, const char *src, size_t siz);
381 #if !HAVE_DECL_STRLCPY
382 extern size_t strlcpy(char *dst, const char *src, size_t siz);
385 #if !defined(HAVE_RANDOM) && !defined(__BORLANDC__)
386 extern long random(void);
389 #ifndef HAVE_UNSETENV
390 extern void unsetenv(const char *name);
394 extern void srandom(unsigned int seed);
398 extern char *pqStrerror(int errnum, char *strerrbuf, size_t buflen);
400 #if !defined(WIN32) || defined(__CYGWIN__)
401 extern int pqGetpwuid(uid_t uid, struct passwd * resultbuf, char *buffer,
402 size_t buflen, struct passwd ** result);
405 extern int pqGethostbyname(const char *name,
406 struct hostent * resultbuf,
407 char *buffer, size_t buflen,
408 struct hostent ** result,
411 extern void pg_qsort(void *base, size_t nel, size_t elsize,
412 int (*cmp) (const void *, const void *));
413 extern int pg_qsort_strcmp(const void *a, const void *b);
415 #define qsort(a,b,c,d) pg_qsort(a,b,c,d)
417 typedef int (*qsort_arg_comparator) (const void *a, const void *b, void *arg);
419 extern void qsort_arg(void *base, size_t nel, size_t elsize,
420 qsort_arg_comparator cmp, void *arg);
422 /* port/chklocale.c */
423 extern int pg_get_encoding_from_locale(const char *ctype, bool write_message);
425 #if defined(WIN32) && !defined(FRONTEND)
426 extern int pg_codepage_to_encoding(UINT cp);
429 /* port/inet_net_ntop.c */
430 extern char *inet_net_ntop(int af, const void *src, int bits,
431 char *dst, size_t size);
433 /* port/pgcheckdir.c */
434 extern int pg_check_dir(const char *dir);
436 /* port/pgmkdirp.c */
437 extern int pg_mkdir_p(char *path, int omode);
439 /* port/pqsignal.c */
440 typedef void (*pqsigfunc) (int signo);
441 extern pqsigfunc pqsignal(int signo, pqsigfunc func);
444 extern char *escape_single_quotes_ascii(const char *src);
446 /* port/wait_error.c */
447 extern char *wait_result_to_str(int exit_status);
449 #endif /* PG_PORT_H */