granicus.if.org Git - postgresql/blob - src/interfaces/libpq/libpq-int.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * libpq-int.h
   4  *        This file contains internal definitions meant to be used only by
   5  *        the frontend libpq library, not by applications that call it.
   6  *
   7  *        An application can include this file if it wants to bypass the
   8  *        official API defined by libpq-fe.h, but code that does so is much
   9  *        more likely to break across PostgreSQL releases than code that uses
  10  *        only the official API.
  11  *
  12  * Portions Copyright (c) 1996-2014, PostgreSQL Global Development Group
  13  * Portions Copyright (c) 1994, Regents of the University of California
  14  *
  15  * src/interfaces/libpq/libpq-int.h
  16  *
  17  *-------------------------------------------------------------------------
  18  */
  19
  20 #ifndef LIBPQ_INT_H
  21 #define LIBPQ_INT_H
  22
  23 /* We assume libpq-fe.h has already been included. */
  24 #include "postgres_fe.h"
  25 #include "libpq-events.h"
  26
  27 #include <time.h>
  28 #include <sys/types.h>
  29 #ifndef WIN32
  30 #include <sys/time.h>
  31 #endif
  32
  33 #ifdef ENABLE_THREAD_SAFETY
  34 #ifdef WIN32
  35 #include "pthread-win32.h"
  36 #else
  37 #include <pthread.h>
  38 #endif
  39 #include <signal.h>
  40 #endif
  41
  42 /* include stuff common to fe and be */
  43 #include "getaddrinfo.h"
  44 #include "libpq/pqcomm.h"
  45 /* include stuff found in fe only */
  46 #include "pqexpbuffer.h"
  47
  48 #ifdef ENABLE_GSS
  49 #if defined(HAVE_GSSAPI_H)
  50 #include <gssapi.h>
  51 #else
  52 #include <gssapi/gssapi.h>
  53 #endif
  54 #endif
  55
  56 #ifdef ENABLE_SSPI
  57 #define SECURITY_WIN32
  58 #if defined(WIN32) && !defined(WIN32_ONLY_COMPILER)
  59 #include <ntsecapi.h>
  60 #endif
  61 #include <security.h>
  62 #undef SECURITY_WIN32
  63
  64 #ifndef ENABLE_GSS
  65 /*
  66  * Define a fake structure compatible with GSSAPI on Unix.
  67  */
  68 typedef struct
  69 {
  70         void       *value;
  71         int                     length;
  72 } gss_buffer_desc;
  73 #endif
  74 #endif   /* ENABLE_SSPI */
  75
  76 #ifdef USE_OPENSSL
  77 #include <openssl/ssl.h>
  78 #include <openssl/err.h>
  79
  80 #if (SSLEAY_VERSION_NUMBER >= 0x00907000L) && !defined(OPENSSL_NO_ENGINE)
  81 #define USE_SSL_ENGINE
  82 #endif
  83 #endif   /* USE_OPENSSL */
  84
  85 /*
  86  * POSTGRES backend dependent Constants.
  87  */
  88 #define CMDSTATUS_LEN 64                /* should match COMPLETION_TAG_BUFSIZE */
  89
  90 /*
  91  * PGresult and the subsidiary types PGresAttDesc, PGresAttValue
  92  * represent the result of a query (or more precisely, of a single SQL
  93  * command --- a query string given to PQexec can contain multiple commands).
  94  * Note we assume that a single command can return at most one tuple group,
  95  * hence there is no need for multiple descriptor sets.
  96  */
  97
  98 /* Subsidiary-storage management structure for PGresult.
  99  * See space management routines in fe-exec.c for details.
 100  * Note that space[k] refers to the k'th byte starting from the physical
 101  * head of the block --- it's a union, not a struct!
 102  */
 103 typedef union pgresult_data PGresult_data;
 104
 105 union pgresult_data
 106 {
 107         PGresult_data *next;            /* link to next block, or NULL */
 108         char            space[1];               /* dummy for accessing block as bytes */
 109 };
 110
 111 /* Data about a single parameter of a prepared statement */
 112 typedef struct pgresParamDesc
 113 {
 114         Oid                     typid;                  /* type id */
 115 } PGresParamDesc;
 116
 117 /*
 118  * Data for a single attribute of a single tuple
 119  *
 120  * We use char* for Attribute values.
 121  *
 122  * The value pointer always points to a null-terminated area; we add a
 123  * null (zero) byte after whatever the backend sends us.  This is only
 124  * particularly useful for text values ... with a binary value, the
 125  * value might have embedded nulls, so the application can't use C string
 126  * operators on it.  But we add a null anyway for consistency.
 127  * Note that the value itself does not contain a length word.
 128  *
 129  * A NULL attribute is a special case in two ways: its len field is NULL_LEN
 130  * and its value field points to null_field in the owning PGresult.  All the
 131  * NULL attributes in a query result point to the same place (there's no need
 132  * to store a null string separately for each one).
 133  */
 134
 135 #define NULL_LEN                (-1)    /* pg_result len for NULL value */
 136
 137 typedef struct pgresAttValue
 138 {
 139         int                     len;                    /* length in bytes of the value */
 140         char       *value;                      /* actual value, plus terminating zero byte */
 141 } PGresAttValue;
 142
 143 /* Typedef for message-field list entries */
 144 typedef struct pgMessageField
 145 {
 146         struct pgMessageField *next;    /* list link */
 147         char            code;                   /* field code */
 148         char            contents[1];    /* field value (VARIABLE LENGTH) */
 149 } PGMessageField;
 150
 151 /* Fields needed for notice handling */
 152 typedef struct
 153 {
 154         PQnoticeReceiver noticeRec; /* notice message receiver */
 155         void       *noticeRecArg;
 156         PQnoticeProcessor noticeProc;           /* notice message processor */
 157         void       *noticeProcArg;
 158 } PGNoticeHooks;
 159
 160 typedef struct PGEvent
 161 {
 162         PGEventProc proc;                       /* the function to call on events */
 163         char       *name;                       /* used only for error messages */
 164         void       *passThrough;        /* pointer supplied at registration time */
 165         void       *data;                       /* optional state (instance) data */
 166         bool            resultInitialized;              /* T if RESULTCREATE/COPY succeeded */
 167 } PGEvent;
 168
 169 struct pg_result
 170 {
 171         int                     ntups;
 172         int                     numAttributes;
 173         PGresAttDesc *attDescs;
 174         PGresAttValue **tuples;         /* each PGresTuple is an array of
 175                                                                  * PGresAttValue's */
 176         int                     tupArrSize;             /* allocated size of tuples array */
 177         int                     numParameters;
 178         PGresParamDesc *paramDescs;
 179         ExecStatusType resultStatus;
 180         char            cmdStatus[CMDSTATUS_LEN];               /* cmd status from the query */
 181         int                     binary;                 /* binary tuple values if binary == 1,
 182                                                                  * otherwise text */
 183
 184         /*
 185          * These fields are copied from the originating PGconn, so that operations
 186          * on the PGresult don't have to reference the PGconn.
 187          */
 188         PGNoticeHooks noticeHooks;
 189         PGEvent    *events;
 190         int                     nEvents;
 191         int                     client_encoding;        /* encoding id */
 192
 193         /*
 194          * Error information (all NULL if not an error result).  errMsg is the
 195          * "overall" error message returned by PQresultErrorMessage.  If we have
 196          * per-field info then it is stored in a linked list.
 197          */
 198         char       *errMsg;                     /* error message, or NULL if no error */
 199         PGMessageField *errFields;      /* message broken into fields */
 200
 201         /* All NULL attributes in the query result point to this null string */
 202         char            null_field[1];
 203
 204         /*
 205          * Space management information.  Note that attDescs and error stuff, if
 206          * not null, point into allocated blocks.  But tuples points to a
 207          * separately malloc'd block, so that we can realloc it.
 208          */
 209         PGresult_data *curBlock;        /* most recently allocated block */
 210         int                     curOffset;              /* start offset of free space in block */
 211         int                     spaceLeft;              /* number of free bytes remaining in block */
 212 };
 213
 214 /* PGAsyncStatusType defines the state of the query-execution state machine */
 215 typedef enum
 216 {
 217         PGASYNC_IDLE,                           /* nothing's happening, dude */
 218         PGASYNC_BUSY,                           /* query in progress */
 219         PGASYNC_READY,                          /* result ready for PQgetResult */
 220         PGASYNC_COPY_IN,                        /* Copy In data transfer in progress */
 221         PGASYNC_COPY_OUT,                       /* Copy Out data transfer in progress */
 222         PGASYNC_COPY_BOTH                       /* Copy In/Out data transfer in progress */
 223 } PGAsyncStatusType;
 224
 225 /* PGQueryClass tracks which query protocol we are now executing */
 226 typedef enum
 227 {
 228         PGQUERY_SIMPLE,                         /* simple Query protocol (PQexec) */
 229         PGQUERY_EXTENDED,                       /* full Extended protocol (PQexecParams) */
 230         PGQUERY_PREPARE,                        /* Parse only (PQprepare) */
 231         PGQUERY_DESCRIBE                        /* Describe Statement or Portal */
 232 } PGQueryClass;
 233
 234 /* PGSetenvStatusType defines the state of the PQSetenv state machine */
 235 /* (this is used only for 2.0-protocol connections) */
 236 typedef enum
 237 {
 238         SETENV_STATE_CLIENT_ENCODING_SEND,      /* About to send an Environment Option */
 239         SETENV_STATE_CLIENT_ENCODING_WAIT,      /* Waiting for above send to complete */
 240         SETENV_STATE_OPTION_SEND,       /* About to send an Environment Option */
 241         SETENV_STATE_OPTION_WAIT,       /* Waiting for above send to complete */
 242         SETENV_STATE_QUERY1_SEND,       /* About to send a status query */
 243         SETENV_STATE_QUERY1_WAIT,       /* Waiting for query to complete */
 244         SETENV_STATE_QUERY2_SEND,       /* About to send a status query */
 245         SETENV_STATE_QUERY2_WAIT,       /* Waiting for query to complete */
 246         SETENV_STATE_IDLE
 247 } PGSetenvStatusType;
 248
 249 /* Typedef for the EnvironmentOptions[] array */
 250 typedef struct PQEnvironmentOption
 251 {
 252         const char *envName,            /* name of an environment variable */
 253                            *pgName;                     /* name of corresponding SET variable */
 254 } PQEnvironmentOption;
 255
 256 /* Typedef for parameter-status list entries */
 257 typedef struct pgParameterStatus
 258 {
 259         struct pgParameterStatus *next;         /* list link */
 260         char       *name;                       /* parameter name */
 261         char       *value;                      /* parameter value */
 262         /* Note: name and value are stored in same malloc block as struct is */
 263 } pgParameterStatus;
 264
 265 /* large-object-access data ... allocated only if large-object code is used. */
 266 typedef struct pgLobjfuncs
 267 {
 268         Oid                     fn_lo_open;             /* OID of backend function lo_open              */
 269         Oid                     fn_lo_close;    /* OID of backend function lo_close             */
 270         Oid                     fn_lo_creat;    /* OID of backend function lo_creat             */
 271         Oid                     fn_lo_create;   /* OID of backend function lo_create    */
 272         Oid                     fn_lo_unlink;   /* OID of backend function lo_unlink    */
 273         Oid                     fn_lo_lseek;    /* OID of backend function lo_lseek             */
 274         Oid                     fn_lo_lseek64;  /* OID of backend function lo_lseek64   */
 275         Oid                     fn_lo_tell;             /* OID of backend function lo_tell              */
 276         Oid                     fn_lo_tell64;   /* OID of backend function lo_tell64    */
 277         Oid                     fn_lo_truncate; /* OID of backend function lo_truncate  */
 278         Oid                     fn_lo_truncate64;               /* OID of function lo_truncate64 */
 279         Oid                     fn_lo_read;             /* OID of backend function LOread               */
 280         Oid                     fn_lo_write;    /* OID of backend function LOwrite              */
 281 } PGlobjfuncs;
 282
 283 /* PGdataValue represents a data field value being passed to a row processor.
 284  * It could be either text or binary data; text data is not zero-terminated.
 285  * A SQL NULL is represented by len < 0; then value is still valid but there
 286  * are no data bytes there.
 287  */
 288 typedef struct pgDataValue
 289 {
 290         int                     len;                    /* data length in bytes, or <0 if NULL */
 291         const char *value;                      /* data value, without zero-termination */
 292 } PGdataValue;
 293
 294 /*
 295  * PGconn stores all the state data associated with a single connection
 296  * to a backend.
 297  */
 298 struct pg_conn
 299 {
 300         /* Saved values of connection options */
 301         char       *pghost;                     /* the machine on which the server is running */
 302         char       *pghostaddr;         /* the numeric IP address of the machine on
 303                                                                  * which the server is running.  Takes
 304                                                                  * precedence over above. */
 305         char       *pgport;                     /* the server's communication port */
 306         char       *pgunixsocket;       /* the Unix-domain socket that the server is
 307                                                                  * listening on; if NULL, uses a default
 308                                                                  * constructed from pgport */
 309         char       *pgtty;                      /* tty on which the backend messages is
 310                                                                  * displayed (OBSOLETE, NOT USED) */
 311         char       *connect_timeout;    /* connection timeout (numeric string) */
 312         char       *client_encoding_initial;            /* encoding to use */
 313         char       *pgoptions;          /* options to start the backend with */
 314         char       *appname;            /* application name */
 315         char       *fbappname;          /* fallback application name */
 316         char       *dbName;                     /* database name */
 317         char       *replication;        /* connect as the replication standby? */
 318         char       *pguser;                     /* Postgres username and password, if any */
 319         char       *pgpass;
 320         char       *keepalives;         /* use TCP keepalives? */
 321         char       *keepalives_idle;    /* time between TCP keepalives */
 322         char       *keepalives_interval;        /* time between TCP keepalive
 323                                                                                  * retransmits */
 324         char       *keepalives_count;           /* maximum number of TCP keepalive
 325                                                                                  * retransmits */
 326         char       *sslmode;            /* SSL mode (require,prefer,allow,disable) */
 327         char       *sslcompression; /* SSL compression (0 or 1) */
 328         char       *sslkey;                     /* client key filename */
 329         char       *sslcert;            /* client certificate filename */
 330         char       *sslrootcert;        /* root certificate filename */
 331         char       *sslcrl;                     /* certificate revocation list filename */
 332         char       *requirepeer;        /* required peer credentials for local sockets */
 333
 334 #if defined(ENABLE_GSS) || defined(ENABLE_SSPI)
 335         char       *krbsrvname;         /* Kerberos service name */
 336 #endif
 337
 338         /* Optional file to write trace info to */
 339         FILE       *Pfdebug;
 340
 341         /* Callback procedures for notice message processing */
 342         PGNoticeHooks noticeHooks;
 343
 344         /* Event procs registered via PQregisterEventProc */
 345         PGEvent    *events;                     /* expandable array of event data */
 346         int                     nEvents;                /* number of active events */
 347         int                     eventArraySize; /* allocated array size */
 348
 349         /* Status indicators */
 350         ConnStatusType status;
 351         PGAsyncStatusType asyncStatus;
 352         PGTransactionStatusType xactStatus; /* never changes to ACTIVE */
 353         PGQueryClass queryclass;
 354         char       *last_query;         /* last SQL command, or NULL if unknown */
 355         char            last_sqlstate[6];               /* last reported SQLSTATE */
 356         bool            options_valid;  /* true if OK to attempt connection */
 357         bool            nonblocking;    /* whether this connection is using nonblock
 358                                                                  * sending semantics */
 359         bool            singleRowMode;  /* return current query result row-by-row? */
 360         char            copy_is_binary; /* 1 = copy binary, 0 = copy text */
 361         int                     copy_already_done;              /* # bytes already returned in COPY
 362                                                                                  * OUT */
 363         PGnotify   *notifyHead;         /* oldest unreported Notify msg */
 364         PGnotify   *notifyTail;         /* newest unreported Notify msg */
 365
 366         /* Connection data */
 367         /* See PQconnectPoll() for how we use 'int' and not 'pgsocket'. */
 368         pgsocket        sock;                   /* FD for socket, PGINVALID_SOCKET if
 369                                                                  * unconnected */
 370         SockAddr        laddr;                  /* Local address */
 371         SockAddr        raddr;                  /* Remote address */
 372         ProtocolVersion pversion;       /* FE/BE protocol version in use */
 373         int                     sversion;               /* server version, e.g. 70401 for 7.4.1 */
 374         bool            auth_req_received;              /* true if any type of auth req
 375                                                                                  * received */
 376         bool            password_needed;        /* true if server demanded a password */
 377         bool            dot_pgpass_used;        /* true if used .pgpass */
 378         bool            sigpipe_so;             /* have we masked SIGPIPE via SO_NOSIGPIPE? */
 379         bool            sigpipe_flag;   /* can we mask SIGPIPE via MSG_NOSIGNAL? */
 380
 381         /* Transient state needed while establishing connection */
 382         struct addrinfo *addrlist;      /* list of possible backend addresses */
 383         struct addrinfo *addr_cur;      /* the one currently being tried */
 384         int                     addrlist_family;        /* needed to know how to free addrlist */
 385         PGSetenvStatusType setenv_state;        /* for 2.0 protocol only */
 386         const PQEnvironmentOption *next_eo;
 387         bool            send_appname;   /* okay to send application_name? */
 388
 389         /* Miscellaneous stuff */
 390         int                     be_pid;                 /* PID of backend --- needed for cancels */
 391         int                     be_key;                 /* key of backend --- needed for cancels */
 392         char            md5Salt[4];             /* password salt received from backend */
 393         pgParameterStatus *pstatus; /* ParameterStatus data */
 394         int                     client_encoding;        /* encoding id */
 395         bool            std_strings;    /* standard_conforming_strings */
 396         PGVerbosity verbosity;          /* error/notice message verbosity */
 397         PGlobjfuncs *lobjfuncs;         /* private state for large-object access fns */
 398
 399         /* Buffer for data received from backend and not yet processed */
 400         char       *inBuffer;           /* currently allocated buffer */
 401         int                     inBufSize;              /* allocated size of buffer */
 402         int                     inStart;                /* offset to first unconsumed data in buffer */
 403         int                     inCursor;               /* next byte to tentatively consume */
 404         int                     inEnd;                  /* offset to first position after avail data */
 405
 406         /* Buffer for data not yet sent to backend */
 407         char       *outBuffer;          /* currently allocated buffer */
 408         int                     outBufSize;             /* allocated size of buffer */
 409         int                     outCount;               /* number of chars waiting in buffer */
 410
 411         /* State for constructing messages in outBuffer */
 412         int                     outMsgStart;    /* offset to msg start (length word); if -1,
 413                                                                  * msg has no length word */
 414         int                     outMsgEnd;              /* offset to msg end (so far) */
 415
 416         /* Row processor interface workspace */
 417         PGdataValue *rowBuf;            /* array for passing values to rowProcessor */
 418         int                     rowBufLen;              /* number of entries allocated in rowBuf */
 419
 420         /* Status for asynchronous result construction */
 421         PGresult   *result;                     /* result being constructed */
 422         PGresult   *next_result;        /* next result (used in single-row mode) */
 423
 424         /* Assorted state for SSL, GSS, etc */
 425
 426 #ifdef USE_SSL
 427         bool            allow_ssl_try;  /* Allowed to try SSL negotiation */
 428         bool            wait_ssl_try;   /* Delay SSL negotiation until after
 429                                                                  * attempting normal connection */
 430         bool            ssl_in_use;
 431 #ifdef USE_OPENSSL
 432         SSL                *ssl;                        /* SSL status, if have SSL connection */
 433         X509       *peer;                       /* X509 cert of server */
 434 #ifdef USE_SSL_ENGINE
 435         ENGINE     *engine;                     /* SSL engine, if any */
 436 #else
 437         void       *engine;                     /* dummy field to keep struct the same if
 438                                                                  * OpenSSL version changes */
 439 #endif
 440 #endif   /* USE_OPENSSL */
 441 #endif   /* USE_SSL */
 442
 443 #ifdef ENABLE_GSS
 444         gss_ctx_id_t gctx;                      /* GSS context */
 445         gss_name_t      gtarg_nam;              /* GSS target name */
 446         gss_buffer_desc ginbuf;         /* GSS input token */
 447         gss_buffer_desc goutbuf;        /* GSS output token */
 448 #endif
 449
 450 #ifdef ENABLE_SSPI
 451 #ifndef ENABLE_GSS
 452         gss_buffer_desc ginbuf;         /* GSS input token */
 453 #else
 454         char       *gsslib;                     /* What GSS librart to use ("gssapi" or
 455                                                                  * "sspi") */
 456 #endif
 457         CredHandle *sspicred;           /* SSPI credentials handle */
 458         CtxtHandle *sspictx;            /* SSPI context */
 459         char       *sspitarget;         /* SSPI target name */
 460         int                     usesspi;                /* Indicate if SSPI is in use on the
 461                                                                  * connection */
 462 #endif
 463
 464         /* Buffer for current error message */
 465         PQExpBufferData errorMessage;           /* expansible string */
 466
 467         /* Buffer for receiving various parts of messages */
 468         PQExpBufferData workBuffer; /* expansible string */
 469 };
 470
 471 /* PGcancel stores all data necessary to cancel a connection. A copy of this
 472  * data is required to safely cancel a connection running on a different
 473  * thread.
 474  */
 475 struct pg_cancel
 476 {
 477         SockAddr        raddr;                  /* Remote address */
 478         int                     be_pid;                 /* PID of backend --- needed for cancels */
 479         int                     be_key;                 /* key of backend --- needed for cancels */
 480 };
 481
 482
 483 /* String descriptions of the ExecStatusTypes.
 484  * direct use of this array is deprecated; call PQresStatus() instead.
 485  */
 486 extern char *const pgresStatus[];
 487
 488
 489 #ifdef USE_SSL
 490
 491 #ifndef WIN32
 492 #define USER_CERT_FILE          ".postgresql/postgresql.crt"
 493 #define USER_KEY_FILE           ".postgresql/postgresql.key"
 494 #define ROOT_CERT_FILE          ".postgresql/root.crt"
 495 #define ROOT_CRL_FILE           ".postgresql/root.crl"
 496 #else
 497 /* On Windows, the "home" directory is already PostgreSQL-specific */
 498 #define USER_CERT_FILE          "postgresql.crt"
 499 #define USER_KEY_FILE           "postgresql.key"
 500 #define ROOT_CERT_FILE          "root.crt"
 501 #define ROOT_CRL_FILE           "root.crl"
 502 #endif
 503
 504 #endif   /* USE_SSL */
 505
 506 /* ----------------
 507  * Internal functions of libpq
 508  * Functions declared here need to be visible across files of libpq,
 509  * but are not intended to be called by applications.  We use the
 510  * convention "pqXXX" for internal functions, vs. the "PQxxx" names
 511  * used for application-visible routines.
 512  * ----------------
 513  */
 514
 515 /* === in fe-connect.c === */
 516
 517 extern void pqDropConnection(PGconn *conn);
 518 extern int pqPacketSend(PGconn *conn, char pack_type,
 519                          const void *buf, size_t buf_len);
 520 extern bool pqGetHomeDirectory(char *buf, int bufsize);
 521
 522 #ifdef ENABLE_THREAD_SAFETY
 523 extern pgthreadlock_t pg_g_threadlock;
 524
 525 #define PGTHREAD_ERROR(msg) \
 526         do { \
 527                 fprintf(stderr, "%s\n", msg); \
 528                 abort(); \
 529         } while (0)
 530
 531
 532 #define pglock_thread()         pg_g_threadlock(true)
 533 #define pgunlock_thread()       pg_g_threadlock(false)
 534 #else
 535 #define pglock_thread()         ((void) 0)
 536 #define pgunlock_thread()       ((void) 0)
 537 #endif
 538
 539 /* === in fe-exec.c === */
 540
 541 extern void pqSetResultError(PGresult *res, const char *msg);
 542 extern void pqCatenateResultError(PGresult *res, const char *msg);
 543 extern void *pqResultAlloc(PGresult *res, size_t nBytes, bool isBinary);
 544 extern char *pqResultStrdup(PGresult *res, const char *str);
 545 extern void pqClearAsyncResult(PGconn *conn);
 546 extern void pqSaveErrorResult(PGconn *conn);
 547 extern PGresult *pqPrepareAsyncResult(PGconn *conn);
 548 extern void
 549 pqInternalNotice(const PGNoticeHooks *hooks, const char *fmt,...)
 550 /* This lets gcc check the format string for consistency. */
 551 __attribute__((format(PG_PRINTF_ATTRIBUTE, 2, 3)));
 552 extern void pqSaveMessageField(PGresult *res, char code,
 553                                    const char *value);
 554 extern void pqSaveParameterStatus(PGconn *conn, const char *name,
 555                                           const char *value);
 556 extern int      pqRowProcessor(PGconn *conn, const char **errmsgp);
 557 extern void pqHandleSendFailure(PGconn *conn);
 558
 559 /* === in fe-protocol2.c === */
 560
 561 extern PostgresPollingStatusType pqSetenvPoll(PGconn *conn);
 562
 563 extern char *pqBuildStartupPacket2(PGconn *conn, int *packetlen,
 564                                           const PQEnvironmentOption *options);
 565 extern void pqParseInput2(PGconn *conn);
 566 extern int      pqGetCopyData2(PGconn *conn, char **buffer, int async);
 567 extern int      pqGetline2(PGconn *conn, char *s, int maxlen);
 568 extern int      pqGetlineAsync2(PGconn *conn, char *buffer, int bufsize);
 569 extern int      pqEndcopy2(PGconn *conn);
 570 extern PGresult *pqFunctionCall2(PGconn *conn, Oid fnid,
 571                                 int *result_buf, int *actual_result_len,
 572                                 int result_is_int,
 573                                 const PQArgBlock *args, int nargs);
 574
 575 /* === in fe-protocol3.c === */
 576
 577 extern char *pqBuildStartupPacket3(PGconn *conn, int *packetlen,
 578                                           const PQEnvironmentOption *options);
 579 extern void pqParseInput3(PGconn *conn);
 580 extern int      pqGetErrorNotice3(PGconn *conn, bool isError);
 581 extern int      pqGetCopyData3(PGconn *conn, char **buffer, int async);
 582 extern int      pqGetline3(PGconn *conn, char *s, int maxlen);
 583 extern int      pqGetlineAsync3(PGconn *conn, char *buffer, int bufsize);
 584 extern int      pqEndcopy3(PGconn *conn);
 585 extern PGresult *pqFunctionCall3(PGconn *conn, Oid fnid,
 586                                 int *result_buf, int *actual_result_len,
 587                                 int result_is_int,
 588                                 const PQArgBlock *args, int nargs);
 589
 590 /* === in fe-misc.c === */
 591
 592  /*
 593   * "Get" and "Put" routines return 0 if successful, EOF if not. Note that for
 594   * Get, EOF merely means the buffer is exhausted, not that there is
 595   * necessarily any error.
 596   */
 597 extern int      pqCheckOutBufferSpace(size_t bytes_needed, PGconn *conn);
 598 extern int      pqCheckInBufferSpace(size_t bytes_needed, PGconn *conn);
 599 extern int      pqGetc(char *result, PGconn *conn);
 600 extern int      pqPutc(char c, PGconn *conn);
 601 extern int      pqGets(PQExpBuffer buf, PGconn *conn);
 602 extern int      pqGets_append(PQExpBuffer buf, PGconn *conn);
 603 extern int      pqPuts(const char *s, PGconn *conn);
 604 extern int      pqGetnchar(char *s, size_t len, PGconn *conn);
 605 extern int      pqSkipnchar(size_t len, PGconn *conn);
 606 extern int      pqPutnchar(const char *s, size_t len, PGconn *conn);
 607 extern int      pqGetInt(int *result, size_t bytes, PGconn *conn);
 608 extern int      pqPutInt(int value, size_t bytes, PGconn *conn);
 609 extern int      pqPutMsgStart(char msg_type, bool force_len, PGconn *conn);
 610 extern int      pqPutMsgEnd(PGconn *conn);
 611 extern int      pqReadData(PGconn *conn);
 612 extern int      pqFlush(PGconn *conn);
 613 extern int      pqWait(int forRead, int forWrite, PGconn *conn);
 614 extern int pqWaitTimed(int forRead, int forWrite, PGconn *conn,
 615                         time_t finish_time);
 616 extern int      pqReadReady(PGconn *conn);
 617 extern int      pqWriteReady(PGconn *conn);
 618
 619 /* === in fe-secure.c === */
 620
 621 extern int      pqsecure_initialize(PGconn *);
 622 extern void pqsecure_destroy(void);
 623 extern PostgresPollingStatusType pqsecure_open_client(PGconn *);
 624 extern void pqsecure_close(PGconn *);
 625 extern ssize_t pqsecure_read(PGconn *, void *ptr, size_t len);
 626 extern ssize_t pqsecure_write(PGconn *, const void *ptr, size_t len);
 627 extern ssize_t pqsecure_raw_read(PGconn *, void *ptr, size_t len);
 628 extern ssize_t pqsecure_raw_write(PGconn *, const void *ptr, size_t len);
 629
 630 #if defined(ENABLE_THREAD_SAFETY) && !defined(WIN32)
 631 extern int      pq_block_sigpipe(sigset_t *osigset, bool *sigpipe_pending);
 632 extern void pq_reset_sigpipe(sigset_t *osigset, bool sigpipe_pending,
 633                                  bool got_epipe);
 634 #endif
 635
 636 /*
 637  * The SSL implementatation provides these functions (fe-secure-openssl.c)
 638  */
 639 extern void pgtls_init_library(bool do_ssl, int do_crypto);
 640 extern int pgtls_init(PGconn *conn);
 641 extern PostgresPollingStatusType pgtls_open_client(PGconn *conn);
 642 extern void pgtls_close(PGconn *conn);
 643 extern ssize_t pgtls_read(PGconn *conn, void *ptr, size_t len);
 644 extern ssize_t pgtls_write(PGconn *conn, const void *ptr, size_t len);
 645
 646 /*
 647  * this is so that we can check if a connection is non-blocking internally
 648  * without the overhead of a function call
 649  */
 650 #define pqIsnonblocking(conn)   ((conn)->nonblocking)
 651
 652 #ifdef ENABLE_NLS
 653 extern char *
 654 libpq_gettext(const char *msgid)
 655 __attribute__((format_arg(1)));
 656 extern char *
 657 libpq_ngettext(const char *msgid, const char *msgid_plural, unsigned long n)
 658 __attribute__((format_arg(1))) __attribute__((format_arg(2)));
 659 #else
 660 #define libpq_gettext(x) (x)
 661 #define libpq_ngettext(s, p, n) ((n) == 1 ? (s) : (p))
 662 #endif
 663
 664 /*
 665  * These macros are needed to let error-handling code be portable between
 666  * Unix and Windows.  (ugh)
 667  */
 668 #ifdef WIN32
 669 #define SOCK_ERRNO (WSAGetLastError())
 670 #define SOCK_STRERROR winsock_strerror
 671 #define SOCK_ERRNO_SET(e) WSASetLastError(e)
 672 #else
 673 #define SOCK_ERRNO errno
 674 #define SOCK_STRERROR pqStrerror
 675 #define SOCK_ERRNO_SET(e) (errno = (e))
 676 #endif
 677
 678 #endif   /* LIBPQ_INT_H */