/*------------------------------------------------------------------------- * pgut.h * * Portions Copyright (c) 2008-2011, NIPPON TELEGRAPH AND TELEPHONE CORPORATION * Portions Copyright (c) 2011, Itagaki Takahiro * Portions Copyright (c) 2012-2020, The Reorg Development Team *------------------------------------------------------------------------- */ #ifndef PGUT_H #define PGUT_H #include "c.h" #include #ifndef WIN32 #include #include #endif #include "libpq-fe.h" #include "pqexpbuffer.h" #include "utils/elog.h" #define INFINITE_STR "INFINITE" #ifdef _MSC_VER #define __attribute__(x) #endif typedef enum YesNo { DEFAULT, NO, YES } YesNo; typedef void (*pgut_atexit_callback)(bool fatal, void *userdata); /* * pgut client variables and functions */ extern const char *PROGRAM_NAME; extern const char *PROGRAM_VERSION; extern const char *PROGRAM_URL; extern const char *PROGRAM_ISSUES; /* * pgut framework variables and functions */ extern bool interrupted; extern int pgut_log_level; extern int pgut_abort_level; extern bool pgut_echo; extern void pgut_init(int argc, char **argv); extern void pgut_atexit_push(pgut_atexit_callback callback, void *userdata); extern void pgut_atexit_pop(pgut_atexit_callback callback, void *userdata); extern void pgut_putenv(const char *key, const char *value); /* * Database connections */ extern PGconn *pgut_connect(const char *info, YesNo prompt, int elevel); extern void pgut_disconnect(PGconn *conn); extern void pgut_disconnect_all(void); extern PGresult *pgut_execute(PGconn* conn, const char *query, int nParams, const char **params); PGresult *pgut_execute_elevel(PGconn* conn, const char *query, int nParams, const char **params, int elevel); extern ExecStatusType pgut_command(PGconn* conn, const char *query, int nParams, const char **params); extern bool pgut_commit(PGconn *conn); extern void pgut_rollback(PGconn *conn); extern bool pgut_send(PGconn* conn, const char *query, int nParams, const char **params); extern int pgut_wait(int num, PGconn *connections[], struct timeval *timeout); /* * memory allocators */ extern void *pgut_malloc(size_t size); extern void *pgut_realloc(void *p, size_t size); extern char *pgut_strdup(const char *str); extern char *strdup_with_len(const char *str, size_t len); extern char *strdup_trim(const char *str); #define pgut_new(type) ((type *) pgut_malloc(sizeof(type))) #define pgut_newarray(type, n) ((type *) pgut_malloc(sizeof(type) * (n))) #define pgut_newvar(type, m, n) ((type *) pgut_malloc(offsetof(type, m) + (n))) /* * file operations */ extern FILE *pgut_fopen(const char *path, const char *mode); extern bool pgut_mkdir(const char *path); /* * elog */ #define E_PG_CONNECT (-1) /* PostgreSQL connection error */ #define E_PG_COMMAND (-2) /* PostgreSQL query or command error */ #undef elog #undef ereport #define ereport(elevel, rest) \ (pgut_errstart(elevel) ? (pgut_errfinish rest) : (void) 0) extern void elog(int elevel, const char *fmt, ...) __attribute__((format(printf, 2, 3))); extern const char *format_elevel(int elevel); extern int parse_elevel(const char *value); extern int errcode_errno(void); extern bool log_required(int elevel, int log_min_level); extern bool pgut_errstart(int elevel); extern void pgut_errfinish(int dummy, ...); extern void pgut_error(int elevel, int code, const char *msg, const char *detail); /* * CHECK_FOR_INTERRUPTS */ #undef CHECK_FOR_INTERRUPTS extern void CHECK_FOR_INTERRUPTS(void); /* * Assert */ #undef Assert #undef AssertArg #undef AssertMacro #ifdef USE_ASSERT_CHECKING #define Assert(x) assert(x) #define AssertArg(x) assert(x) #define AssertMacro(x) assert(x) #else #define Assert(x) ((void) 0) #define AssertArg(x) ((void) 0) #define AssertMacro(x) ((void) 0) #endif /* * StringInfo and string operations */ #define STRINGINFO_H #define StringInfoData PQExpBufferData #define StringInfo PQExpBuffer #define makeStringInfo createPQExpBuffer #define initStringInfo initPQExpBuffer #define freeStringInfo destroyPQExpBuffer #define termStringInfo termPQExpBuffer #define resetStringInfo resetPQExpBuffer #define enlargeStringInfo enlargePQExpBuffer #define printfStringInfo printfPQExpBuffer /* reset + append */ #define appendStringInfo appendPQExpBuffer #define appendStringInfoString appendPQExpBufferStr #define appendStringInfoChar appendPQExpBufferChar #define appendBinaryStringInfo appendBinaryPQExpBuffer extern bool pgut_appendStringInfoVA(StringInfo str, const char *fmt, va_list args) __attribute__((format(printf, 2, 0))); extern int appendStringInfoFile(StringInfo str, FILE *fp); extern int appendStringInfoFd(StringInfo str, int fd); extern bool parse_bool(const char *value, bool *result); extern bool parse_bool_with_len(const char *value, size_t len, bool *result); extern bool parse_int32(const char *value, int32 *result); extern bool parse_uint32(const char *value, uint32 *result); extern bool parse_int64(const char *value, int64 *result); extern bool parse_uint64(const char *value, uint64 *result); extern bool parse_time(const char *value, time_t *time); #define IsSpace(c) (isspace((unsigned char)(c))) #define IsAlpha(c) (isalpha((unsigned char)(c))) #define IsAlnum(c) (isalnum((unsigned char)(c))) #define IsIdentHead(c) (IsAlpha(c) || (c) == '_') #define IsIdentBody(c) (IsAlnum(c) || (c) == '_') #define ToLower(c) (tolower((unsigned char)(c))) #define ToUpper(c) (toupper((unsigned char)(c))) /* linked list of string values and helper functions, stolen from pg_dump. */ typedef struct SimpleStringListCell { struct SimpleStringListCell *next; char val[1]; /* VARIABLE LENGTH FIELD */ } SimpleStringListCell; typedef struct SimpleStringList { SimpleStringListCell *head; SimpleStringListCell *tail; } SimpleStringList; extern void simple_string_list_append(SimpleStringList *list, const char *val); extern bool simple_string_list_member(SimpleStringList *list, const char *val); extern size_t simple_string_list_size(SimpleStringList list); /* * socket operations */ extern int wait_for_socket(int sock, struct timeval *timeout); extern int wait_for_sockets(int nfds, fd_set *fds, struct timeval *timeout); #ifdef WIN32 extern int sleep(unsigned int seconds); extern int usleep(unsigned int usec); #endif #endif /* PGUT_H */