libpq-fe.h File Reference

#include <stdio.h>
#include "postgres_ext.h"

Include dependency graph for libpq-fe.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	pgNotify
struct	_PQprintOpt
struct	_PQconninfoOption
struct	PQArgBlock
struct	pgresAttDesc

Macros
#define	LIBPQ_HAS_PIPELINING   1
#define	LIBPQ_HAS_TRACE_FLAGS   1
#define	LIBPQ_HAS_SSL_LIBRARY_DETECTION   1
#define	LIBPQ_HAS_ASYNC_CANCEL   1
#define	LIBPQ_HAS_CHANGE_PASSWORD   1
#define	LIBPQ_HAS_CHUNK_MODE   1
#define	LIBPQ_HAS_CLOSE_PREPARED   1
#define	LIBPQ_HAS_SEND_PIPELINE_SYNC   1
#define	LIBPQ_HAS_SOCKET_POLL   1
#define	LIBPQ_HAS_FULL_PROTOCOL_VERSION   1
#define	PG_COPYRES_ATTRS   0x01
#define	PG_COPYRES_TUPLES   0x02 /* Implies PG_COPYRES_ATTRS */
#define	PG_COPYRES_EVENTS   0x04
#define	PG_COPYRES_NOTICEHOOKS   0x08
#define	PQsetdb(M_PGHOST, M_PGPORT, M_PGOPT, M_PGTTY, M_DBNAME)    PQsetdbLogin(M_PGHOST, M_PGPORT, M_PGOPT, M_PGTTY, M_DBNAME, NULL, NULL)
#define	PQTRACE_SUPPRESS_TIMESTAMPS   (1<<0)
#define	PQTRACE_REGRESS_MODE   (1<<1)
#define	PQ_QUERY_PARAM_MAX_LIMIT   65535
#define	PQfreeNotify(ptr)   PQfreemem(ptr)
#define	PQnoPasswordSupplied   "fe_sendauth: no password supplied\n"

Typedefs
typedef struct pg_conn	PGconn
typedef struct pg_cancel_conn	PGcancelConn
typedef struct pg_result	PGresult
typedef struct pg_cancel	PGcancel
typedef struct pgNotify	PGnotify
typedef pg_int64	pg_usec_time_t
typedef void(*	PQnoticeReceiver) (void *arg, const PGresult *res)
typedef void(*	PQnoticeProcessor) (void *arg, const char *message)
typedef char	pqbool
typedef struct _PQprintOpt	PQprintOpt
typedef struct _PQconninfoOption	PQconninfoOption
typedef struct pgresAttDesc	PGresAttDesc
typedef void(*	pgthreadlock_t) (int acquire)
typedef int(*	PQsslKeyPassHook_OpenSSL_type) (char *buf, int size, PGconn *conn)

Enumerations
enum	ConnStatusType {   CONNECTION_OK , CONNECTION_BAD , CONNECTION_STARTED , CONNECTION_MADE ,   CONNECTION_AWAITING_RESPONSE , CONNECTION_AUTH_OK , CONNECTION_SETENV , CONNECTION_SSL_STARTUP ,   CONNECTION_NEEDED , CONNECTION_CHECK_WRITABLE , CONNECTION_CONSUME , CONNECTION_GSS_STARTUP ,   CONNECTION_CHECK_TARGET , CONNECTION_CHECK_STANDBY , CONNECTION_ALLOCATED }
enum	PostgresPollingStatusType {   PGRES_POLLING_FAILED = 0 , PGRES_POLLING_READING , PGRES_POLLING_WRITING , PGRES_POLLING_OK ,   PGRES_POLLING_ACTIVE }
enum	ExecStatusType {   PGRES_EMPTY_QUERY = 0 , PGRES_COMMAND_OK , PGRES_TUPLES_OK , PGRES_COPY_OUT ,   PGRES_COPY_IN , PGRES_BAD_RESPONSE , PGRES_NONFATAL_ERROR , PGRES_FATAL_ERROR ,   PGRES_COPY_BOTH , PGRES_SINGLE_TUPLE , PGRES_PIPELINE_SYNC , PGRES_PIPELINE_ABORTED ,   PGRES_TUPLES_CHUNK }
enum	PGTransactionStatusType {   PQTRANS_IDLE , PQTRANS_ACTIVE , PQTRANS_INTRANS , PQTRANS_INERROR ,   PQTRANS_UNKNOWN }
enum	PGVerbosity { PQERRORS_TERSE , PQERRORS_DEFAULT , PQERRORS_VERBOSE , PQERRORS_SQLSTATE }
enum	PGContextVisibility { PQSHOW_CONTEXT_NEVER , PQSHOW_CONTEXT_ERRORS , PQSHOW_CONTEXT_ALWAYS }
enum	PGPing { PQPING_OK , PQPING_REJECT , PQPING_NO_RESPONSE , PQPING_NO_ATTEMPT }
enum	PGpipelineStatus { PQ_PIPELINE_OFF , PQ_PIPELINE_ON , PQ_PIPELINE_ABORTED }

Functions
PGconn *	PQconnectStart (const char *conninfo)
PGconn *	PQconnectStartParams (const char *const *keywords, const char *const *values, int expand_dbname)
PostgresPollingStatusType	PQconnectPoll (PGconn *conn)
PGconn *	PQconnectdb (const char *conninfo)
PGconn *	PQconnectdbParams (const char *const *keywords, const char *const *values, int expand_dbname)
PGconn *	PQsetdbLogin (const char *pghost, const char *pgport, const char *pgoptions, const char *pgtty, const char *dbName, const char *login, const char *pwd)
void	PQfinish (PGconn *conn)
PQconninfoOption *	PQconndefaults (void)
PQconninfoOption *	PQconninfoParse (const char *conninfo, char **errmsg)
PQconninfoOption *	PQconninfo (PGconn *conn)
void	PQconninfoFree (PQconninfoOption *connOptions)
int	PQresetStart (PGconn *conn)
PostgresPollingStatusType	PQresetPoll (PGconn *conn)
void	PQreset (PGconn *conn)
PGcancelConn *	PQcancelCreate (PGconn *conn)
int	PQcancelStart (PGcancelConn *cancelConn)
int	PQcancelBlocking (PGcancelConn *cancelConn)
PostgresPollingStatusType	PQcancelPoll (PGcancelConn *cancelConn)
ConnStatusType	PQcancelStatus (const PGcancelConn *cancelConn)
int	PQcancelSocket (const PGcancelConn *cancelConn)
char *	PQcancelErrorMessage (const PGcancelConn *cancelConn)
void	PQcancelReset (PGcancelConn *cancelConn)
void	PQcancelFinish (PGcancelConn *cancelConn)
PGcancel *	PQgetCancel (PGconn *conn)
void	PQfreeCancel (PGcancel *cancel)
int	PQcancel (PGcancel *cancel, char *errbuf, int errbufsize)
int	PQrequestCancel (PGconn *conn)
char *	PQdb (const PGconn *conn)
char *	PQuser (const PGconn *conn)
char *	PQpass (const PGconn *conn)
char *	PQhost (const PGconn *conn)
char *	PQhostaddr (const PGconn *conn)
char *	PQport (const PGconn *conn)
char *	PQtty (const PGconn *conn)
char *	PQoptions (const PGconn *conn)
ConnStatusType	PQstatus (const PGconn *conn)
PGTransactionStatusType	PQtransactionStatus (const PGconn *conn)
const char *	PQparameterStatus (const PGconn *conn, const char *paramName)
int	PQprotocolVersion (const PGconn *conn)
int	PQfullProtocolVersion (const PGconn *conn)
int	PQserverVersion (const PGconn *conn)
char *	PQerrorMessage (const PGconn *conn)
int	PQsocket (const PGconn *conn)
int	PQbackendPID (const PGconn *conn)
PGpipelineStatus	PQpipelineStatus (const PGconn *conn)
int	PQconnectionNeedsPassword (const PGconn *conn)
int	PQconnectionUsedPassword (const PGconn *conn)
int	PQconnectionUsedGSSAPI (const PGconn *conn)
int	PQclientEncoding (const PGconn *conn)
int	PQsetClientEncoding (PGconn *conn, const char *encoding)
int	PQsslInUse (PGconn *conn)
void *	PQsslStruct (PGconn *conn, const char *struct_name)
const char *	PQsslAttribute (PGconn *conn, const char *attribute_name)
const char *const *	PQsslAttributeNames (PGconn *conn)
void *	PQgetssl (PGconn *conn)
void	PQinitSSL (int do_init)
void	PQinitOpenSSL (int do_ssl, int do_crypto)
int	PQgssEncInUse (PGconn *conn)
void *	PQgetgssctx (PGconn *conn)
PGVerbosity	PQsetErrorVerbosity (PGconn *conn, PGVerbosity verbosity)
PGContextVisibility	PQsetErrorContextVisibility (PGconn *conn, PGContextVisibility show_context)
PQnoticeReceiver	PQsetNoticeReceiver (PGconn *conn, PQnoticeReceiver proc, void *arg)
PQnoticeProcessor	PQsetNoticeProcessor (PGconn *conn, PQnoticeProcessor proc, void *arg)
pgthreadlock_t	PQregisterThreadLock (pgthreadlock_t newhandler)
void	PQtrace (PGconn *conn, FILE *debug_port)
void	PQuntrace (PGconn *conn)
void	PQsetTraceFlags (PGconn *conn, int flags)
PGresult *	PQexec (PGconn *conn, const char *query)
PGresult *	PQexecParams (PGconn *conn, const char *command, int nParams, const Oid *paramTypes, const char *const *paramValues, const int *paramLengths, const int *paramFormats, int resultFormat)
PGresult *	PQprepare (PGconn *conn, const char *stmtName, const char *query, int nParams, const Oid *paramTypes)
PGresult *	PQexecPrepared (PGconn *conn, const char *stmtName, int nParams, const char *const *paramValues, const int *paramLengths, const int *paramFormats, int resultFormat)
int	PQsendQuery (PGconn *conn, const char *query)
int	PQsendQueryParams (PGconn *conn, const char *command, int nParams, const Oid *paramTypes, const char *const *paramValues, const int *paramLengths, const int *paramFormats, int resultFormat)
int	PQsendPrepare (PGconn *conn, const char *stmtName, const char *query, int nParams, const Oid *paramTypes)
int	PQsendQueryPrepared (PGconn *conn, const char *stmtName, int nParams, const char *const *paramValues, const int *paramLengths, const int *paramFormats, int resultFormat)
int	PQsetSingleRowMode (PGconn *conn)
int	PQsetChunkedRowsMode (PGconn *conn, int chunkSize)
PGresult *	PQgetResult (PGconn *conn)
int	PQisBusy (PGconn *conn)
int	PQconsumeInput (PGconn *conn)
int	PQenterPipelineMode (PGconn *conn)
int	PQexitPipelineMode (PGconn *conn)
int	PQpipelineSync (PGconn *conn)
int	PQsendFlushRequest (PGconn *conn)
int	PQsendPipelineSync (PGconn *conn)
PGnotify *	PQnotifies (PGconn *conn)
int	PQputCopyData (PGconn *conn, const char *buffer, int nbytes)
int	PQputCopyEnd (PGconn *conn, const char *errormsg)
int	PQgetCopyData (PGconn *conn, char **buffer, int async)
int	PQgetline (PGconn *conn, char *buffer, int length)
int	PQputline (PGconn *conn, const char *string)
int	PQgetlineAsync (PGconn *conn, char *buffer, int bufsize)
int	PQputnbytes (PGconn *conn, const char *buffer, int nbytes)
int	PQendcopy (PGconn *conn)
int	PQsetnonblocking (PGconn *conn, int arg)
int	PQisnonblocking (const PGconn *conn)
int	PQisthreadsafe (void)
PGPing	PQping (const char *conninfo)
PGPing	PQpingParams (const char *const *keywords, const char *const *values, int expand_dbname)
int	PQflush (PGconn *conn)
PGresult *	PQfn (PGconn *conn, int fnid, int *result_buf, int *result_len, int result_is_int, const PQArgBlock *args, int nargs)
ExecStatusType	PQresultStatus (const PGresult *res)
char *	PQresStatus (ExecStatusType status)
char *	PQresultErrorMessage (const PGresult *res)
char *	PQresultVerboseErrorMessage (const PGresult *res, PGVerbosity verbosity, PGContextVisibility show_context)
char *	PQresultErrorField (const PGresult *res, int fieldcode)
int	PQntuples (const PGresult *res)
int	PQnfields (const PGresult *res)
int	PQbinaryTuples (const PGresult *res)
char *	PQfname (const PGresult *res, int field_num)
int	PQfnumber (const PGresult *res, const char *field_name)
Oid	PQftable (const PGresult *res, int field_num)
int	PQftablecol (const PGresult *res, int field_num)
int	PQfformat (const PGresult *res, int field_num)
Oid	PQftype (const PGresult *res, int field_num)
int	PQfsize (const PGresult *res, int field_num)
int	PQfmod (const PGresult *res, int field_num)
char *	PQcmdStatus (PGresult *res)
char *	PQoidStatus (const PGresult *res)
Oid	PQoidValue (const PGresult *res)
char *	PQcmdTuples (PGresult *res)
char *	PQgetvalue (const PGresult *res, int tup_num, int field_num)
int	PQgetlength (const PGresult *res, int tup_num, int field_num)
int	PQgetisnull (const PGresult *res, int tup_num, int field_num)
int	PQnparams (const PGresult *res)
Oid	PQparamtype (const PGresult *res, int param_num)
PGresult *	PQdescribePrepared (PGconn *conn, const char *stmt)
PGresult *	PQdescribePortal (PGconn *conn, const char *portal)
int	PQsendDescribePrepared (PGconn *conn, const char *stmt)
int	PQsendDescribePortal (PGconn *conn, const char *portal)
PGresult *	PQclosePrepared (PGconn *conn, const char *stmt)
PGresult *	PQclosePortal (PGconn *conn, const char *portal)
int	PQsendClosePrepared (PGconn *conn, const char *stmt)
int	PQsendClosePortal (PGconn *conn, const char *portal)
void	PQclear (PGresult *res)
void	PQfreemem (void *ptr)
PGresult *	PQmakeEmptyPGresult (PGconn *conn, ExecStatusType status)
PGresult *	PQcopyResult (const PGresult *src, int flags)
int	PQsetResultAttrs (PGresult *res, int numAttributes, PGresAttDesc *attDescs)
void *	PQresultAlloc (PGresult *res, size_t nBytes)
size_t	PQresultMemorySize (const PGresult *res)
int	PQsetvalue (PGresult *res, int tup_num, int field_num, char *value, int len)
size_t	PQescapeStringConn (PGconn *conn, char *to, const char *from, size_t length, int *error)
char *	PQescapeLiteral (PGconn *conn, const char *str, size_t len)
char *	PQescapeIdentifier (PGconn *conn, const char *str, size_t len)
unsigned char *	PQescapeByteaConn (PGconn *conn, const unsigned char *from, size_t from_length, size_t *to_length)
unsigned char *	PQunescapeBytea (const unsigned char *strtext, size_t *retbuflen)
size_t	PQescapeString (char *to, const char *from, size_t length)
unsigned char *	PQescapeBytea (const unsigned char *from, size_t from_length, size_t *to_length)
void	PQprint (FILE *fout, const PGresult *res, const PQprintOpt *po)
void	PQdisplayTuples (const PGresult *res, FILE *fp, int fillAlign, const char *fieldSep, int printHeader, int quiet)
void	PQprintTuples (const PGresult *res, FILE *fout, int PrintAttNames, int TerseOutput, int colWidth)
int	lo_open (PGconn *conn, Oid lobjId, int mode)
int	lo_close (PGconn *conn, int fd)
int	lo_read (PGconn *conn, int fd, char *buf, size_t len)
int	lo_write (PGconn *conn, int fd, const char *buf, size_t len)
int	lo_lseek (PGconn *conn, int fd, int offset, int whence)
pg_int64	lo_lseek64 (PGconn *conn, int fd, pg_int64 offset, int whence)
Oid	lo_creat (PGconn *conn, int mode)
Oid	lo_create (PGconn *conn, Oid lobjId)
int	lo_tell (PGconn *conn, int fd)
pg_int64	lo_tell64 (PGconn *conn, int fd)
int	lo_truncate (PGconn *conn, int fd, size_t len)
int	lo_truncate64 (PGconn *conn, int fd, pg_int64 len)
int	lo_unlink (PGconn *conn, Oid lobjId)
Oid	lo_import (PGconn *conn, const char *filename)
Oid	lo_import_with_oid (PGconn *conn, const char *filename, Oid lobjId)
int	lo_export (PGconn *conn, Oid lobjId, const char *filename)
int	PQlibVersion (void)
int	PQsocketPoll (int sock, int forRead, int forWrite, pg_usec_time_t end_time)
pg_usec_time_t	PQgetCurrentTimeUSec (void)
int	PQmblen (const char *s, int encoding)
int	PQmblenBounded (const char *s, int encoding)
int	PQdsplen (const char *s, int encoding)
int	PQenv2encoding (void)
char *	PQencryptPassword (const char *passwd, const char *user)
char *	PQencryptPasswordConn (PGconn *conn, const char *passwd, const char *user, const char *algorithm)
PGresult *	PQchangePassword (PGconn *conn, const char *user, const char *passwd)
int	pg_char_to_encoding (const char *name)
const char *	pg_encoding_to_char (int encoding)
int	pg_valid_server_encoding_id (int encoding)
PQsslKeyPassHook_OpenSSL_type	PQgetSSLKeyPassHook_OpenSSL (void)
void	PQsetSSLKeyPassHook_OpenSSL (PQsslKeyPassHook_OpenSSL_type hook)
int	PQdefaultSSLKeyPassHook_OpenSSL (char *buf, int size, PGconn *conn)

Macro Definition Documentation

LIBPQ_HAS_ASYNC_CANCEL

#define LIBPQ_HAS_ASYNC_CANCEL   1

Definition at line 47 of file libpq-fe.h.

LIBPQ_HAS_CHANGE_PASSWORD

#define LIBPQ_HAS_CHANGE_PASSWORD   1

Definition at line 49 of file libpq-fe.h.

LIBPQ_HAS_CHUNK_MODE

#define LIBPQ_HAS_CHUNK_MODE   1

Definition at line 51 of file libpq-fe.h.

LIBPQ_HAS_CLOSE_PREPARED

#define LIBPQ_HAS_CLOSE_PREPARED   1

Definition at line 53 of file libpq-fe.h.

LIBPQ_HAS_FULL_PROTOCOL_VERSION

#define LIBPQ_HAS_FULL_PROTOCOL_VERSION   1

Definition at line 61 of file libpq-fe.h.

LIBPQ_HAS_PIPELINING

#define LIBPQ_HAS_PIPELINING   1

Definition at line 37 of file libpq-fe.h.

LIBPQ_HAS_SEND_PIPELINE_SYNC

#define LIBPQ_HAS_SEND_PIPELINE_SYNC   1

Definition at line 55 of file libpq-fe.h.

LIBPQ_HAS_SOCKET_POLL

#define LIBPQ_HAS_SOCKET_POLL   1

Definition at line 57 of file libpq-fe.h.

LIBPQ_HAS_SSL_LIBRARY_DETECTION

#define LIBPQ_HAS_SSL_LIBRARY_DETECTION   1

Definition at line 43 of file libpq-fe.h.

LIBPQ_HAS_TRACE_FLAGS

#define LIBPQ_HAS_TRACE_FLAGS   1

Definition at line 39 of file libpq-fe.h.

PG_COPYRES_ATTRS

#define PG_COPYRES_ATTRS   0x01

Definition at line 66 of file libpq-fe.h.

PG_COPYRES_EVENTS

#define PG_COPYRES_EVENTS   0x04

Definition at line 68 of file libpq-fe.h.

PG_COPYRES_NOTICEHOOKS

#define PG_COPYRES_NOTICEHOOKS   0x08

Definition at line 69 of file libpq-fe.h.

PG_COPYRES_TUPLES

#define PG_COPYRES_TUPLES   0x02 /* Implies PG_COPYRES_ATTRS */

Definition at line 67 of file libpq-fe.h.

PQ_QUERY_PARAM_MAX_LIMIT

#define PQ_QUERY_PARAM_MAX_LIMIT   65535

Definition at line 495 of file libpq-fe.h.

PQfreeNotify

#define PQfreeNotify

(

ptr

)

PQfreemem(ptr)

Definition at line 617 of file libpq-fe.h.

PQnoPasswordSupplied

#define PQnoPasswordSupplied   "fe_sendauth: no password supplied\n"

Definition at line 621 of file libpq-fe.h.

PQsetdb

#define PQsetdb	(		M_PGHOST,
			M_PGPORT,
			M_PGOPT,
			M_PGTTY,
			M_DBNAME
	)		PQsetdbLogin(M_PGHOST, M_PGPORT, M_PGOPT, M_PGTTY, M_DBNAME, NULL, NULL)

Definition at line 327 of file libpq-fe.h.

PQTRACE_REGRESS_MODE

#define PQTRACE_REGRESS_MODE   (1<<1)

Definition at line 468 of file libpq-fe.h.

PQTRACE_SUPPRESS_TIMESTAMPS

#define PQTRACE_SUPPRESS_TIMESTAMPS   (1<<0)

Definition at line 466 of file libpq-fe.h.

Typedef Documentation

pg_usec_time_t

typedef pg_int64 pg_usec_time_t

Definition at line 226 of file libpq-fe.h.

PGcancel

typedef struct pg_cancel PGcancel

Definition at line 1 of file libpq-fe.h.

PGcancelConn

typedef struct pg_cancel_conn PGcancelConn

Definition at line 1 of file libpq-fe.h.

PGconn

typedef struct pg_conn PGconn

Definition at line 1 of file libpq-fe.h.

PGnotify

typedef struct pgNotify PGnotify

PGresAttDesc

typedef struct pgresAttDesc PGresAttDesc

PGresult

typedef struct pg_result PGresult

Definition at line 1 of file libpq-fe.h.

pgthreadlock_t

typedef void(* pgthreadlock_t) (int acquire)

Definition at line 456 of file libpq-fe.h.

pqbool

typedef char pqbool

Definition at line 233 of file libpq-fe.h.

PQconninfoOption

typedef struct _PQconninfoOption PQconninfoOption

PQnoticeProcessor

typedef void(* PQnoticeProcessor) (void *arg, const char *message)

Definition at line 230 of file libpq-fe.h.

PQnoticeReceiver

typedef void(* PQnoticeReceiver) (void *arg, const PGresult *res)

Definition at line 229 of file libpq-fe.h.

PQprintOpt

typedef struct _PQprintOpt PQprintOpt

PQsslKeyPassHook_OpenSSL_type

typedef int(* PQsslKeyPassHook_OpenSSL_type) (char *buf, int size, PGconn *conn)

Definition at line 733 of file libpq-fe.h.

Enumeration Type Documentation

ConnStatusType

enum ConnStatusType

Enumerator
CONNECTION_OK
CONNECTION_BAD
CONNECTION_STARTED
CONNECTION_MADE
CONNECTION_AWAITING_RESPONSE
CONNECTION_AUTH_OK
CONNECTION_SETENV
CONNECTION_SSL_STARTUP
CONNECTION_NEEDED
CONNECTION_CHECK_WRITABLE
CONNECTION_CONSUME
CONNECTION_GSS_STARTUP
CONNECTION_CHECK_TARGET
CONNECTION_CHECK_STANDBY
CONNECTION_ALLOCATED

Definition at line 79 of file libpq-fe.h.

{
    CONNECTION_OK,
    CONNECTION_BAD,
    /* Non-blocking mode only below here */
 
    /*
     * The existence of these should never be relied upon - they should only
     * be used for user feedback or similar purposes.
     */
    CONNECTION_STARTED,         /* Waiting for connection to be made.  */
    CONNECTION_MADE,            /* Connection OK; waiting to send.     */
    CONNECTION_AWAITING_RESPONSE,   /* Waiting for a response from the
                                     * postmaster.        */
    CONNECTION_AUTH_OK,         /* Received authentication; waiting for
                                 * backend startup. */
    CONNECTION_SETENV,          /* This state is no longer used. */
    CONNECTION_SSL_STARTUP,     /* Performing SSL handshake. */
    CONNECTION_NEEDED,          /* Internal state: connect() needed. */
    CONNECTION_CHECK_WRITABLE,  /* Checking if session is read-write. */
    CONNECTION_CONSUME,         /* Consuming any extra messages. */
    CONNECTION_GSS_STARTUP,     /* Negotiating GSSAPI. */
    CONNECTION_CHECK_TARGET,    /* Internal state: checking target server
                                 * properties. */
    CONNECTION_CHECK_STANDBY,   /* Checking if server is in standby mode. */
    CONNECTION_ALLOCATED,       /* Waiting for connection attempt to be
                                 * started.  */
} ConnStatusType;

ExecStatusType

enum ExecStatusType

Enumerator
PGRES_EMPTY_QUERY
PGRES_COMMAND_OK
PGRES_TUPLES_OK
PGRES_COPY_OUT
PGRES_COPY_IN
PGRES_BAD_RESPONSE
PGRES_NONFATAL_ERROR
PGRES_FATAL_ERROR
PGRES_COPY_BOTH
PGRES_SINGLE_TUPLE
PGRES_PIPELINE_SYNC
PGRES_PIPELINE_ABORTED
PGRES_TUPLES_CHUNK

Definition at line 117 of file libpq-fe.h.

{
    PGRES_EMPTY_QUERY = 0,      /* empty query string was executed */
    PGRES_COMMAND_OK,           /* a query command that doesn't return
                                 * anything was executed properly by the
                                 * backend */
    PGRES_TUPLES_OK,            /* a query command that returns tuples was
                                 * executed properly by the backend, PGresult
                                 * contains the result tuples */
    PGRES_COPY_OUT,             /* Copy Out data transfer in progress */
    PGRES_COPY_IN,              /* Copy In data transfer in progress */
    PGRES_BAD_RESPONSE,         /* an unexpected response was recv'd from the
                                 * backend */
    PGRES_NONFATAL_ERROR,       /* notice or warning message */
    PGRES_FATAL_ERROR,          /* query failed */
    PGRES_COPY_BOTH,            /* Copy In/Out data transfer in progress */
    PGRES_SINGLE_TUPLE,         /* single tuple from larger resultset */
    PGRES_PIPELINE_SYNC,        /* pipeline synchronization point */
    PGRES_PIPELINE_ABORTED,     /* Command didn't run because of an abort
                                 * earlier in a pipeline */
    PGRES_TUPLES_CHUNK          /* chunk of tuples from larger resultset */
} ExecStatusType;

PGContextVisibility

enum PGContextVisibility

Enumerator
PQSHOW_CONTEXT_NEVER
PQSHOW_CONTEXT_ERRORS
PQSHOW_CONTEXT_ALWAYS

Definition at line 157 of file libpq-fe.h.

{
    PQSHOW_CONTEXT_NEVER,       /* never show CONTEXT field */
    PQSHOW_CONTEXT_ERRORS,      /* show CONTEXT for errors only (default) */
    PQSHOW_CONTEXT_ALWAYS       /* always show CONTEXT field */
} PGContextVisibility;

PGPing

enum PGPing

Enumerator
PQPING_OK
PQPING_REJECT
PQPING_NO_RESPONSE
PQPING_NO_ATTEMPT

Definition at line 169 of file libpq-fe.h.

{
    PQPING_OK,                  /* server is accepting connections */
    PQPING_REJECT,              /* server is alive but rejecting connections */
    PQPING_NO_RESPONSE,         /* could not establish connection */
    PQPING_NO_ATTEMPT           /* connection not attempted (bad params) */
} PGPing;

PGpipelineStatus

enum PGpipelineStatus

Enumerator
PQ_PIPELINE_OFF
PQ_PIPELINE_ON
PQ_PIPELINE_ABORTED

Definition at line 180 of file libpq-fe.h.

{
    PQ_PIPELINE_OFF,
    PQ_PIPELINE_ON,
    PQ_PIPELINE_ABORTED
} PGpipelineStatus;

PGTransactionStatusType

enum PGTransactionStatusType

Enumerator
PQTRANS_IDLE
PQTRANS_ACTIVE
PQTRANS_INTRANS
PQTRANS_INERROR
PQTRANS_UNKNOWN

Definition at line 140 of file libpq-fe.h.

{
    PQTRANS_IDLE,               /* connection idle */
    PQTRANS_ACTIVE,             /* command in progress */
    PQTRANS_INTRANS,            /* idle, within transaction block */
    PQTRANS_INERROR,            /* idle, within failed transaction */
    PQTRANS_UNKNOWN             /* cannot determine status */
} PGTransactionStatusType;

PGVerbosity

enum PGVerbosity

Enumerator
PQERRORS_TERSE
PQERRORS_DEFAULT
PQERRORS_VERBOSE
PQERRORS_SQLSTATE

Definition at line 149 of file libpq-fe.h.

{
    PQERRORS_TERSE,             /* single-line error messages */
    PQERRORS_DEFAULT,           /* recommended style */
    PQERRORS_VERBOSE,           /* all the facts, ma'am */
    PQERRORS_SQLSTATE           /* only error severity and SQLSTATE code */
} PGVerbosity;

PostgresPollingStatusType

enum PostgresPollingStatusType

Enumerator
PGRES_POLLING_FAILED
PGRES_POLLING_READING
PGRES_POLLING_WRITING
PGRES_POLLING_OK
PGRES_POLLING_ACTIVE

Definition at line 108 of file libpq-fe.h.

{
    PGRES_POLLING_FAILED = 0,
    PGRES_POLLING_READING,      /* These two indicate that one may    */
    PGRES_POLLING_WRITING,      /* use select before polling again.   */
    PGRES_POLLING_OK,
    PGRES_POLLING_ACTIVE        /* unused; keep for backwards compatibility */
} PostgresPollingStatusType;

Function Documentation

lo_close()

int lo_close	(	PGconn *	conn,
		int	fd
	)

Definition at line 96 of file fe-lobj.c.

{
    PQArgBlock  argv[1];
    PGresult   *res;
    int         retval;
    int         result_len;
 
    if (lo_initialize(conn) < 0)
        return -1;
 
    argv[0].isint = 1;
    argv[0].len = 4;
    argv[0].u.integer = fd;
    res = PQfn(conn, conn->lobjfuncs->fn_lo_close,
               &retval, &result_len, 1, argv, 1);
    if (PQresultStatus(res) == PGRES_COMMAND_OK)
    {
        PQclear(res);
        return retval;
    }
    else
    {
        PQclear(res);
        return -1;
    }
}

References conn, fd(), pgLobjfuncs::fn_lo_close, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, lo_initialize(), pg_conn::lobjfuncs, PGRES_COMMAND_OK, PQclear(), PQfn(), PQresultStatus(), res, and PQArgBlock::u.

Referenced by dumpLOs(), EndRestoreLO(), exportFile(), importFile(), lo_export(), lo_import_internal(), my_truncate(), overwrite(), and pickout().

lo_creat()

Oid lo_creat	(	PGconn *	conn,
		int	mode
	)

Definition at line 438 of file fe-lobj.c.

{
    PQArgBlock  argv[1];
    PGresult   *res;
    int         retval;
    int         result_len;
 
    if (lo_initialize(conn) < 0)
        return InvalidOid;
 
    argv[0].isint = 1;
    argv[0].len = 4;
    argv[0].u.integer = mode;
    res = PQfn(conn, conn->lobjfuncs->fn_lo_creat,
               &retval, &result_len, 1, argv, 1);
    if (PQresultStatus(res) == PGRES_COMMAND_OK)
    {
        PQclear(res);
        return (Oid) retval;
    }
    else
    {
        PQclear(res);
        return InvalidOid;
    }
}

References conn, pgLobjfuncs::fn_lo_creat, PQArgBlock::integer, InvalidOid, PQArgBlock::isint, PQArgBlock::len, lo_initialize(), pg_conn::lobjfuncs, mode, PGRES_COMMAND_OK, PQclear(), PQfn(), PQresultStatus(), res, and PQArgBlock::u.

Referenced by importFile(), and lo_import_internal().

lo_create()

Oid lo_create	(	PGconn *	conn,
		Oid	lobjId
	)

Definition at line 474 of file fe-lobj.c.

{
    PQArgBlock  argv[1];
    PGresult   *res;
    int         retval;
    int         result_len;
 
    if (lo_initialize(conn) < 0)
        return InvalidOid;
 
    /* Must check this on-the-fly because it's not there pre-8.1 */
    if (conn->lobjfuncs->fn_lo_create == 0)
    {
        libpq_append_conn_error(conn, "cannot determine OID of function %s",
                                "lo_create");
        return InvalidOid;
    }
 
    argv[0].isint = 1;
    argv[0].len = 4;
    argv[0].u.integer = lobjId;
    res = PQfn(conn, conn->lobjfuncs->fn_lo_create,
               &retval, &result_len, 1, argv, 1);
    if (PQresultStatus(res) == PGRES_COMMAND_OK)
    {
        PQclear(res);
        return (Oid) retval;
    }
    else
    {
        PQclear(res);
        return InvalidOid;
    }
}

References conn, pgLobjfuncs::fn_lo_create, PQArgBlock::integer, InvalidOid, PQArgBlock::isint, PQArgBlock::len, libpq_append_conn_error(), lo_initialize(), pg_conn::lobjfuncs, PGRES_COMMAND_OK, PQclear(), PQfn(), PQresultStatus(), res, and PQArgBlock::u.

Referenced by lo_import_internal(), and StartRestoreLO().

lo_export()

int lo_export	(	PGconn *	conn,
		Oid	lobjId,
		const char *	filename
	)

Definition at line 748 of file fe-lobj.c.

{
    int         result = 1;
    int         fd;
    int         nbytes,
                tmp;
    char        buf[LO_BUFSIZE];
    int         lobj;
    char        sebuf[PG_STRERROR_R_BUFLEN];
 
    /*
     * open the large object.
     */
    lobj = lo_open(conn, lobjId, INV_READ);
    if (lobj == -1)
    {
        /* we assume lo_open() already set a suitable error message */
        return -1;
    }
 
    /*
     * create the file to be written to
     */
    fd = open(filename, O_CREAT | O_WRONLY | O_TRUNC | PG_BINARY, 0666);
    if (fd < 0)
    {
        /* We must do lo_close before setting the errorMessage */
        int         save_errno = errno;
 
        (void) lo_close(conn, lobj);
        /* deliberately overwrite any error from lo_close */
        pqClearConnErrorState(conn);
        libpq_append_conn_error(conn, "could not open file \"%s\": %s",
                                filename,
                                strerror_r(save_errno, sebuf, sizeof(sebuf)));
        return -1;
    }
 
    /*
     * read in from the large object and write to the file
     */
    while ((nbytes = lo_read(conn, lobj, buf, LO_BUFSIZE)) > 0)
    {
        tmp = write(fd, buf, nbytes);
        if (tmp != nbytes)
        {
            /* We must do lo_close before setting the errorMessage */
            int         save_errno = errno;
 
            (void) lo_close(conn, lobj);
            (void) close(fd);
            /* deliberately overwrite any error from lo_close */
            pqClearConnErrorState(conn);
            libpq_append_conn_error(conn, "could not write to file \"%s\": %s",
                                    filename,
                                    strerror_r(save_errno, sebuf, sizeof(sebuf)));
            return -1;
        }
    }
 
    /*
     * If lo_read() failed, we are now in an aborted transaction so there's no
     * need for lo_close(); furthermore, if we tried it we'd overwrite the
     * useful error result with a useless one. So skip lo_close() if we got a
     * failure result.
     */
    if (nbytes < 0 ||
        lo_close(conn, lobj) != 0)
    {
        /* assume lo_read() or lo_close() left a suitable error message */
        result = -1;
    }
 
    /* if we already failed, don't overwrite that msg with a close error */
    if (close(fd) != 0 && result >= 0)
    {
        libpq_append_conn_error(conn, "could not write to file \"%s\": %s",
                                filename, strerror_r(errno, sebuf, sizeof(sebuf)));
        result = -1;
    }
 
    return result;
}

References buf, close, conn, fd(), filename, INV_READ, libpq_append_conn_error(), LO_BUFSIZE, lo_close(), lo_open(), lo_read(), PG_BINARY, PG_STRERROR_R_BUFLEN, pqClearConnErrorState, strerror_r, and write.

Referenced by do_lo_export(), and main().

lo_import()

Oid lo_import	(	PGconn *	conn,
		const char *	filename
	)

Definition at line 626 of file fe-lobj.c.

{
    return lo_import_internal(conn, filename, InvalidOid);
}

References conn, filename, InvalidOid, and lo_import_internal().

Referenced by do_lo_import(), and main().

lo_import_with_oid()

Oid lo_import_with_oid	(	PGconn *	conn,
		const char *	filename,
		Oid	lobjId
	)

Definition at line 641 of file fe-lobj.c.

{
    return lo_import_internal(conn, filename, lobjId);
}

References conn, filename, and lo_import_internal().

lo_lseek()

int lo_lseek	(	PGconn *	conn,
		int	fd,
		int	offset,
		int	whence
	)

Definition at line 344 of file fe-lobj.c.

{
    PQArgBlock  argv[3];
    PGresult   *res;
    int         retval;
    int         result_len;
 
    if (lo_initialize(conn) < 0)
        return -1;
 
    argv[0].isint = 1;
    argv[0].len = 4;
    argv[0].u.integer = fd;
 
    argv[1].isint = 1;
    argv[1].len = 4;
    argv[1].u.integer = offset;
 
    argv[2].isint = 1;
    argv[2].len = 4;
    argv[2].u.integer = whence;
 
    res = PQfn(conn, conn->lobjfuncs->fn_lo_lseek,
               &retval, &result_len, 1, argv, 3);
    if (PQresultStatus(res) == PGRES_COMMAND_OK)
    {
        PQclear(res);
        return retval;
    }
    else
    {
        PQclear(res);
        return -1;
    }
}

References conn, fd(), pgLobjfuncs::fn_lo_lseek, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, lo_initialize(), pg_conn::lobjfuncs, PGRES_COMMAND_OK, PQclear(), PQfn(), PQresultStatus(), res, and PQArgBlock::u.

Referenced by overwrite(), and pickout().

lo_lseek64()

pg_int64 lo_lseek64	(	PGconn *	conn,
		int	fd,
		pg_int64	offset,
		int	whence
	)

Definition at line 385 of file fe-lobj.c.

{
    PQArgBlock  argv[3];
    PGresult   *res;
    pg_int64    retval;
    int         result_len;
 
    if (lo_initialize(conn) < 0)
        return -1;
 
    if (conn->lobjfuncs->fn_lo_lseek64 == 0)
    {
        libpq_append_conn_error(conn, "cannot determine OID of function %s",
                                "lo_lseek64");
        return -1;
    }
 
    argv[0].isint = 1;
    argv[0].len = 4;
    argv[0].u.integer = fd;
 
    offset = lo_hton64(offset);
    argv[1].isint = 0;
    argv[1].len = 8;
    argv[1].u.ptr = (int *) &offset;
 
    argv[2].isint = 1;
    argv[2].len = 4;
    argv[2].u.integer = whence;
 
    res = PQfn(conn, conn->lobjfuncs->fn_lo_lseek64,
               (void *) &retval, &result_len, 0, argv, 3);
    if (PQresultStatus(res) == PGRES_COMMAND_OK && result_len == 8)
    {
        PQclear(res);
        return lo_ntoh64(retval);
    }
    else
    {
        PQclear(res);
        return -1;
    }
}

References conn, fd(), pgLobjfuncs::fn_lo_lseek64, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, libpq_append_conn_error(), lo_hton64(), lo_initialize(), lo_ntoh64(), pg_conn::lobjfuncs, PGRES_COMMAND_OK, PQclear(), PQfn(), PQresultStatus(), PQArgBlock::ptr, res, and PQArgBlock::u.

Referenced by overwrite(), and pickout().

lo_open()

int lo_open	(	PGconn *	conn,
		Oid	lobjId,
		int	mode
	)

Definition at line 57 of file fe-lobj.c.

{
    int         fd;
    int         result_len;
    PQArgBlock  argv[2];
    PGresult   *res;
 
    if (lo_initialize(conn) < 0)
        return -1;
 
    argv[0].isint = 1;
    argv[0].len = 4;
    argv[0].u.integer = lobjId;
 
    argv[1].isint = 1;
    argv[1].len = 4;
    argv[1].u.integer = mode;
 
    res = PQfn(conn, conn->lobjfuncs->fn_lo_open, &fd, &result_len, 1, argv, 2);
    if (PQresultStatus(res) == PGRES_COMMAND_OK)
    {
        PQclear(res);
        return fd;
    }
    else
    {
        PQclear(res);
        return -1;
    }
}

References conn, fd(), pgLobjfuncs::fn_lo_open, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, lo_initialize(), pg_conn::lobjfuncs, mode, PGRES_COMMAND_OK, PQclear(), PQfn(), PQresultStatus(), res, and PQArgBlock::u.

Referenced by dumpLOs(), exportFile(), importFile(), lo_export(), lo_import_internal(), my_truncate(), overwrite(), pickout(), and StartRestoreLO().

lo_read()

int lo_read	(	PGconn *	conn,
		int	fd,
		char *	buf,
		size_t	len
	)

Definition at line 245 of file fe-lobj.c.

{
    PQArgBlock  argv[2];
    PGresult   *res;
    int         result_len;
 
    if (lo_initialize(conn) < 0)
        return -1;
 
    /*
     * Long ago, somebody thought it'd be a good idea to declare this function
     * as taking size_t ... but the underlying backend function only accepts a
     * signed int32 length.  So throw error if the given value overflows
     * int32.
     */
    if (len > (size_t) INT_MAX)
    {
        libpq_append_conn_error(conn, "argument of lo_read exceeds integer range");
        return -1;
    }
 
    argv[0].isint = 1;
    argv[0].len = 4;
    argv[0].u.integer = fd;
 
    argv[1].isint = 1;
    argv[1].len = 4;
    argv[1].u.integer = (int) len;
 
    res = PQfn(conn, conn->lobjfuncs->fn_lo_read,
               (void *) buf, &result_len, 0, argv, 2);
    if (PQresultStatus(res) == PGRES_COMMAND_OK)
    {
        PQclear(res);
        return result_len;
    }
    else
    {
        PQclear(res);
        return -1;
    }
}

References buf, conn, fd(), pgLobjfuncs::fn_lo_read, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, len, libpq_append_conn_error(), lo_initialize(), pg_conn::lobjfuncs, PGRES_COMMAND_OK, PQclear(), PQfn(), PQresultStatus(), res, and PQArgBlock::u.

Referenced by lo_export().

lo_tell()

int lo_tell	(	PGconn *	conn,
		int	fd
	)

Definition at line 515 of file fe-lobj.c.

{
    int         retval;
    PQArgBlock  argv[1];
    PGresult   *res;
    int         result_len;
 
    if (lo_initialize(conn) < 0)
        return -1;
 
    argv[0].isint = 1;
    argv[0].len = 4;
    argv[0].u.integer = fd;
 
    res = PQfn(conn, conn->lobjfuncs->fn_lo_tell,
               &retval, &result_len, 1, argv, 1);
    if (PQresultStatus(res) == PGRES_COMMAND_OK)
    {
        PQclear(res);
        return retval;
    }
    else
    {
        PQclear(res);
        return -1;
    }
}

References conn, fd(), pgLobjfuncs::fn_lo_tell, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, lo_initialize(), pg_conn::lobjfuncs, PGRES_COMMAND_OK, PQclear(), PQfn(), PQresultStatus(), res, and PQArgBlock::u.

lo_tell64()

pg_int64 lo_tell64	(	PGconn *	conn,
		int	fd
	)

Definition at line 548 of file fe-lobj.c.

{
    pg_int64    retval;
    PQArgBlock  argv[1];
    PGresult   *res;
    int         result_len;
 
    if (lo_initialize(conn) < 0)
        return -1;
 
    if (conn->lobjfuncs->fn_lo_tell64 == 0)
    {
        libpq_append_conn_error(conn, "cannot determine OID of function %s",
                                "lo_tell64");
        return -1;
    }
 
    argv[0].isint = 1;
    argv[0].len = 4;
    argv[0].u.integer = fd;
 
    res = PQfn(conn, conn->lobjfuncs->fn_lo_tell64,
               (void *) &retval, &result_len, 0, argv, 1);
    if (PQresultStatus(res) == PGRES_COMMAND_OK && result_len == 8)
    {
        PQclear(res);
        return lo_ntoh64(retval);
    }
    else
    {
        PQclear(res);
        return -1;
    }
}

References conn, fd(), pgLobjfuncs::fn_lo_tell64, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, libpq_append_conn_error(), lo_initialize(), lo_ntoh64(), pg_conn::lobjfuncs, PGRES_COMMAND_OK, PQclear(), PQfn(), PQresultStatus(), res, and PQArgBlock::u.

Referenced by pickout().

lo_truncate()

int lo_truncate	(	PGconn *	conn,
		int	fd,
		size_t	len
	)

Definition at line 131 of file fe-lobj.c.

{
    PQArgBlock  argv[2];
    PGresult   *res;
    int         retval;
    int         result_len;
 
    if (lo_initialize(conn) < 0)
        return -1;
 
    /* Must check this on-the-fly because it's not there pre-8.3 */
    if (conn->lobjfuncs->fn_lo_truncate == 0)
    {
        libpq_append_conn_error(conn, "cannot determine OID of function %s",
                                "lo_truncate");
        return -1;
    }
 
    /*
     * Long ago, somebody thought it'd be a good idea to declare this function
     * as taking size_t ... but the underlying backend function only accepts a
     * signed int32 length.  So throw error if the given value overflows
     * int32.  (A possible alternative is to automatically redirect the call
     * to lo_truncate64; but if the caller wanted to rely on that backend
     * function being available, he could have called lo_truncate64 for
     * himself.)
     */
    if (len > (size_t) INT_MAX)
    {
        libpq_append_conn_error(conn, "argument of lo_truncate exceeds integer range");
        return -1;
    }
 
    argv[0].isint = 1;
    argv[0].len = 4;
    argv[0].u.integer = fd;
 
    argv[1].isint = 1;
    argv[1].len = 4;
    argv[1].u.integer = (int) len;
 
    res = PQfn(conn, conn->lobjfuncs->fn_lo_truncate,
               &retval, &result_len, 1, argv, 2);
 
    if (PQresultStatus(res) == PGRES_COMMAND_OK)
    {
        PQclear(res);
        return retval;
    }
    else
    {
        PQclear(res);
        return -1;
    }
}

References conn, fd(), pgLobjfuncs::fn_lo_truncate, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, len, libpq_append_conn_error(), lo_initialize(), pg_conn::lobjfuncs, PGRES_COMMAND_OK, PQclear(), PQfn(), PQresultStatus(), res, and PQArgBlock::u.

lo_truncate64()

int lo_truncate64	(	PGconn *	conn,
		int	fd,
		pg_int64	len
	)

Definition at line 195 of file fe-lobj.c.

{
    PQArgBlock  argv[2];
    PGresult   *res;
    int         retval;
    int         result_len;
 
    if (lo_initialize(conn) < 0)
        return -1;
 
    if (conn->lobjfuncs->fn_lo_truncate64 == 0)
    {
        libpq_append_conn_error(conn, "cannot determine OID of function %s",
                                "lo_truncate64");
        return -1;
    }
 
    argv[0].isint = 1;
    argv[0].len = 4;
    argv[0].u.integer = fd;
 
    len = lo_hton64(len);
    argv[1].isint = 0;
    argv[1].len = 8;
    argv[1].u.ptr = (int *) &len;
 
    res = PQfn(conn, conn->lobjfuncs->fn_lo_truncate64,
               &retval, &result_len, 1, argv, 2);
 
    if (PQresultStatus(res) == PGRES_COMMAND_OK)
    {
        PQclear(res);
        return retval;
    }
    else
    {
        PQclear(res);
        return -1;
    }
}

References conn, fd(), pgLobjfuncs::fn_lo_truncate64, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, len, libpq_append_conn_error(), lo_hton64(), lo_initialize(), pg_conn::lobjfuncs, PGRES_COMMAND_OK, PQclear(), PQfn(), PQresultStatus(), PQArgBlock::ptr, res, and PQArgBlock::u.

Referenced by my_truncate().

lo_unlink()

int lo_unlink	(	PGconn *	conn,
		Oid	lobjId
	)

Definition at line 589 of file fe-lobj.c.

{
    PQArgBlock  argv[1];
    PGresult   *res;
    int         result_len;
    int         retval;
 
    if (lo_initialize(conn) < 0)
        return -1;
 
    argv[0].isint = 1;
    argv[0].len = 4;
    argv[0].u.integer = lobjId;
 
    res = PQfn(conn, conn->lobjfuncs->fn_lo_unlink,
               &retval, &result_len, 1, argv, 1);
    if (PQresultStatus(res) == PGRES_COMMAND_OK)
    {
        PQclear(res);
        return retval;
    }
    else
    {
        PQclear(res);
        return -1;
    }
}

References conn, pgLobjfuncs::fn_lo_unlink, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, lo_initialize(), pg_conn::lobjfuncs, PGRES_COMMAND_OK, PQclear(), PQfn(), PQresultStatus(), res, and PQArgBlock::u.

Referenced by do_lo_unlink(), and vacuumlo().

lo_write()

int lo_write	(	PGconn *	conn,
		int	fd,
		const char *	buf,
		size_t	len
	)

Definition at line 295 of file fe-lobj.c.

{
    PQArgBlock  argv[2];
    PGresult   *res;
    int         result_len;
    int         retval;
 
    if (lo_initialize(conn) < 0)
        return -1;
 
    /*
     * Long ago, somebody thought it'd be a good idea to declare this function
     * as taking size_t ... but the underlying backend function only accepts a
     * signed int32 length.  So throw error if the given value overflows
     * int32.
     */
    if (len > (size_t) INT_MAX)
    {
        libpq_append_conn_error(conn, "argument of lo_write exceeds integer range");
        return -1;
    }
 
    argv[0].isint = 1;
    argv[0].len = 4;
    argv[0].u.integer = fd;
 
    argv[1].isint = 0;
    argv[1].len = (int) len;
    argv[1].u.ptr = (int *) unconstify(char *, buf);
 
    res = PQfn(conn, conn->lobjfuncs->fn_lo_write,
               &retval, &result_len, 1, argv, 2);
    if (PQresultStatus(res) == PGRES_COMMAND_OK)
    {
        PQclear(res);
        return retval;
    }
    else
    {
        PQclear(res);
        return -1;
    }
}

References buf, conn, fd(), pgLobjfuncs::fn_lo_write, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, len, libpq_append_conn_error(), lo_initialize(), pg_conn::lobjfuncs, PGRES_COMMAND_OK, PQclear(), PQfn(), PQresultStatus(), PQArgBlock::ptr, res, PQArgBlock::u, and unconstify.

Referenced by lo_import_internal().

pg_char_to_encoding()

int pg_char_to_encoding

(

const char *

name

)

Definition at line 549 of file encnames.c.

{
    unsigned int nel = lengthof(pg_encname_tbl);
    const pg_encname *base = pg_encname_tbl,
               *last = base + nel - 1,
               *position;
    int         result;
    char        buff[NAMEDATALEN],
               *key;
 
    if (name == NULL || *name == '\0')
        return -1;
 
    if (strlen(name) >= NAMEDATALEN)
        return -1;              /* it's certainly not in the table */
 
    key = clean_encoding_name(name, buff);
 
    while (last >= base)
    {
        position = base + ((last - base) >> 1);
        result = key[0] - position->name[0];
 
        if (result == 0)
        {
            result = strcmp(key, position->name);
            if (result == 0)
                return position->encoding;
        }
        if (result < 0)
            last = position - 1;
        else
            base = position + 1;
    }
    return -1;
}

References clean_encoding_name(), sort-test::key, lengthof, name, NAMEDATALEN, and pg_encname_tbl.

Referenced by pg_valid_client_encoding(), and pg_valid_server_encoding().

pg_encoding_to_char()

const char* pg_encoding_to_char

(

int

encoding

)

Definition at line 587 of file encnames.c.

{
    if (PG_VALID_ENCODING(encoding))
    {
        const pg_enc2name *p = &pg_enc2name_tbl[encoding];
 
        Assert(encoding == p->encoding);
        return p->name;
    }
    return "";
}

References Assert, encoding, pg_enc2name::encoding, pg_enc2name::name, pg_enc2name_tbl, and PG_VALID_ENCODING.

pg_valid_server_encoding_id()

int pg_valid_server_encoding_id

(

int

encoding

)

Definition at line 513 of file encnames.c.

{
    return PG_VALID_BE_ENCODING(encoding);
}

References encoding, and PG_VALID_BE_ENCODING.

PQbackendPID()

int PQbackendPID

(

const PGconn *

conn

)

Definition at line 7216 of file fe-connect.c.

{
    if (!conn || conn->status != CONNECTION_OK)
        return 0;
    return conn->be_pid;
}

References pg_conn::be_pid, conn, CONNECTION_OK, and pg_conn::status.

Referenced by get_prompt(), libpqrcv_get_backend_pid(), main(), send_cancellable_query_impl(), and StartLogStreamer().

PQbinaryTuples()

int PQbinaryTuples

(

const PGresult *

res

)

Definition at line 3497 of file fe-exec.c.

{
    if (!res)
        return 0;
    return res->binary;
}

References pg_result::binary, and res.

Referenced by HandleCopyResult().

PQcancel()

int PQcancel	(	PGcancel *	cancel,
		char *	errbuf,
		int	errbufsize
	)

Definition at line 463 of file fe-cancel.c.

{
    int         save_errno = SOCK_ERRNO;
    pgsocket    tmpsock = PGINVALID_SOCKET;
    int         maxlen;
    struct
    {
        uint32      packetlen;
        CancelRequestPacket cp;
    }           crp;
 
    if (!cancel)
    {
        strlcpy(errbuf, "PQcancel() -- no cancel object supplied", errbufsize);
        /* strlcpy probably doesn't change errno, but be paranoid */
        SOCK_ERRNO_SET(save_errno);
        return false;
    }
 
    /*
     * We need to open a temporary connection to the postmaster. Do this with
     * only kernel calls.
     */
    if ((tmpsock = socket(cancel->raddr.addr.ss_family, SOCK_STREAM, 0)) == PGINVALID_SOCKET)
    {
        strlcpy(errbuf, "PQcancel() -- socket() failed: ", errbufsize);
        goto cancel_errReturn;
    }
 
    /*
     * Since this connection will only be used to send a single packet of
     * data, we don't need NODELAY.  We also don't set the socket to
     * nonblocking mode, because the API definition of PQcancel requires the
     * cancel to be sent in a blocking way.
     *
     * We do set socket options related to keepalives and other TCP timeouts.
     * This ensures that this function does not block indefinitely when
     * reasonable keepalive and timeout settings have been provided.
     */
    if (cancel->raddr.addr.ss_family != AF_UNIX &&
        cancel->keepalives != 0)
    {
#ifndef WIN32
        if (!optional_setsockopt(tmpsock, SOL_SOCKET, SO_KEEPALIVE, 1))
        {
            strlcpy(errbuf, "PQcancel() -- setsockopt(SO_KEEPALIVE) failed: ", errbufsize);
            goto cancel_errReturn;
        }
 
#ifdef PG_TCP_KEEPALIVE_IDLE
        if (!optional_setsockopt(tmpsock, IPPROTO_TCP, PG_TCP_KEEPALIVE_IDLE,
                                 cancel->keepalives_idle))
        {
            strlcpy(errbuf, "PQcancel() -- setsockopt(" PG_TCP_KEEPALIVE_IDLE_STR ") failed: ", errbufsize);
            goto cancel_errReturn;
        }
#endif
 
#ifdef TCP_KEEPINTVL
        if (!optional_setsockopt(tmpsock, IPPROTO_TCP, TCP_KEEPINTVL,
                                 cancel->keepalives_interval))
        {
            strlcpy(errbuf, "PQcancel() -- setsockopt(TCP_KEEPINTVL) failed: ", errbufsize);
            goto cancel_errReturn;
        }
#endif
 
#ifdef TCP_KEEPCNT
        if (!optional_setsockopt(tmpsock, IPPROTO_TCP, TCP_KEEPCNT,
                                 cancel->keepalives_count))
        {
            strlcpy(errbuf, "PQcancel() -- setsockopt(TCP_KEEPCNT) failed: ", errbufsize);
            goto cancel_errReturn;
        }
#endif
 
#else                           /* WIN32 */
 
#ifdef SIO_KEEPALIVE_VALS
        if (!pqSetKeepalivesWin32(tmpsock,
                                  cancel->keepalives_idle,
                                  cancel->keepalives_interval))
        {
            strlcpy(errbuf, "PQcancel() -- WSAIoctl(SIO_KEEPALIVE_VALS) failed: ", errbufsize);
            goto cancel_errReturn;
        }
#endif                          /* SIO_KEEPALIVE_VALS */
#endif                          /* WIN32 */
 
        /* TCP_USER_TIMEOUT works the same way on Unix and Windows */
#ifdef TCP_USER_TIMEOUT
        if (!optional_setsockopt(tmpsock, IPPROTO_TCP, TCP_USER_TIMEOUT,
                                 cancel->pgtcp_user_timeout))
        {
            strlcpy(errbuf, "PQcancel() -- setsockopt(TCP_USER_TIMEOUT) failed: ", errbufsize);
            goto cancel_errReturn;
        }
#endif
    }
 
retry3:
    if (connect(tmpsock, (struct sockaddr *) &cancel->raddr.addr,
                cancel->raddr.salen) < 0)
    {
        if (SOCK_ERRNO == EINTR)
            /* Interrupted system call - we'll just try again */
            goto retry3;
        strlcpy(errbuf, "PQcancel() -- connect() failed: ", errbufsize);
        goto cancel_errReturn;
    }
 
    /* Create and send the cancel request packet. */
 
    crp.packetlen = pg_hton32((uint32) sizeof(crp));
    crp.cp.cancelRequestCode = (MsgType) pg_hton32(CANCEL_REQUEST_CODE);
    crp.cp.backendPID = pg_hton32(cancel->be_pid);
    crp.cp.cancelAuthCode = pg_hton32(cancel->be_key);
 
retry4:
    if (send(tmpsock, (char *) &crp, sizeof(crp), 0) != (int) sizeof(crp))
    {
        if (SOCK_ERRNO == EINTR)
            /* Interrupted system call - we'll just try again */
            goto retry4;
        strlcpy(errbuf, "PQcancel() -- send() failed: ", errbufsize);
        goto cancel_errReturn;
    }
 
    /*
     * Wait for the postmaster to close the connection, which indicates that
     * it's processed the request.  Without this delay, we might issue another
     * command only to find that our cancel zaps that command instead of the
     * one we thought we were canceling.  Note we don't actually expect this
     * read to obtain any data, we are just waiting for EOF to be signaled.
     */
retry5:
    if (recv(tmpsock, (char *) &crp, 1, 0) < 0)
    {
        if (SOCK_ERRNO == EINTR)
            /* Interrupted system call - we'll just try again */
            goto retry5;
        /* we ignore other error conditions */
    }
 
    /* All done */
    closesocket(tmpsock);
    SOCK_ERRNO_SET(save_errno);
    return true;
 
cancel_errReturn:
 
    /*
     * Make sure we don't overflow the error buffer. Leave space for the \n at
     * the end, and for the terminating zero.
     */
    maxlen = errbufsize - strlen(errbuf) - 2;
    if (maxlen >= 0)
    {
        /*
         * We can't invoke strerror here, since it's not signal-safe.  Settle
         * for printing the decimal value of errno.  Even that has to be done
         * the hard way.
         */
        int         val = SOCK_ERRNO;
        char        buf[32];
        char       *bufp;
 
        bufp = buf + sizeof(buf) - 1;
        *bufp = '\0';
        do
        {
            *(--bufp) = (val % 10) + '0';
            val /= 10;
        } while (val > 0);
        bufp -= 6;
        memcpy(bufp, "error ", 6);
        strncat(errbuf, bufp, maxlen);
        strcat(errbuf, "\n");
    }
    if (tmpsock != PGINVALID_SOCKET)
        closesocket(tmpsock);
    SOCK_ERRNO_SET(save_errno);
    return false;
}

References SockAddr::addr, pg_cancel::be_key, pg_cancel::be_pid, buf, CANCEL_REQUEST_CODE, closesocket, connect, EINTR, pg_cancel::keepalives, pg_cancel::keepalives_count, pg_cancel::keepalives_idle, pg_cancel::keepalives_interval, optional_setsockopt(), pg_hton32, PGINVALID_SOCKET, pg_cancel::pgtcp_user_timeout, pg_cancel::raddr, recv, SockAddr::salen, send, SOCK_ERRNO, SOCK_ERRNO_SET, socket, strlcpy(), and val.

Referenced by DisconnectDatabase(), handle_sigint(), PQrequestCancel(), ShutdownWorkersHard(), sigTermHandler(), and test_cancel().

PQcancelBlocking()

int PQcancelBlocking

(

PGcancelConn *

cancelConn

)

Definition at line 171 of file fe-cancel.c.

{
    if (!PQcancelStart(cancelConn))
        return 0;
    return pqConnectDBComplete(&cancelConn->conn);
}

References cancelConn, PQcancelStart(), and pqConnectDBComplete().

Referenced by disconnectDatabase(), test_cancel(), and try_complete_step().

PQcancelCreate()

PGcancelConn* PQcancelCreate

(

PGconn *

conn

)

Definition at line 65 of file fe-cancel.c.

{
    PGconn     *cancelConn = pqMakeEmptyPGconn();
    pg_conn_host originalHost;
 
    if (cancelConn == NULL)
        return NULL;
 
    /* Check we have an open connection */
    if (!conn)
    {
        libpq_append_conn_error(cancelConn, "connection pointer is NULL");
        return (PGcancelConn *) cancelConn;
    }
 
    if (conn->sock == PGINVALID_SOCKET)
    {
        libpq_append_conn_error(cancelConn, "connection not open");
        return (PGcancelConn *) cancelConn;
    }
 
    /*
     * Indicate that this connection is used to send a cancellation
     */
    cancelConn->cancelRequest = true;
 
    if (!pqCopyPGconn(conn, cancelConn))
        return (PGcancelConn *) cancelConn;
 
    /*
     * Compute derived options
     */
    if (!pqConnectOptions2(cancelConn))
        return (PGcancelConn *) cancelConn;
 
    /*
     * Copy cancellation token data from the original connection
     */
    cancelConn->be_pid = conn->be_pid;
    cancelConn->be_key = conn->be_key;
 
    /*
     * Cancel requests should not iterate over all possible hosts. The request
     * needs to be sent to the exact host and address that the original
     * connection used. So we manually create the host and address arrays with
     * a single element after freeing the host array that we generated from
     * the connection options.
     */
    pqReleaseConnHosts(cancelConn);
    cancelConn->nconnhost = 1;
    cancelConn->naddr = 1;
 
    cancelConn->connhost = calloc(cancelConn->nconnhost, sizeof(pg_conn_host));
    if (!cancelConn->connhost)
        goto oom_error;
 
    originalHost = conn->connhost[conn->whichhost];
    if (originalHost.host)
    {
        cancelConn->connhost[0].host = strdup(originalHost.host);
        if (!cancelConn->connhost[0].host)
            goto oom_error;
    }
    if (originalHost.hostaddr)
    {
        cancelConn->connhost[0].hostaddr = strdup(originalHost.hostaddr);
        if (!cancelConn->connhost[0].hostaddr)
            goto oom_error;
    }
    if (originalHost.port)
    {
        cancelConn->connhost[0].port = strdup(originalHost.port);
        if (!cancelConn->connhost[0].port)
            goto oom_error;
    }
    if (originalHost.password)
    {
        cancelConn->connhost[0].password = strdup(originalHost.password);
        if (!cancelConn->connhost[0].password)
            goto oom_error;
    }
 
    cancelConn->addr = calloc(cancelConn->naddr, sizeof(AddrInfo));
    if (!cancelConn->addr)
        goto oom_error;
 
    cancelConn->addr[0].addr = conn->raddr;
    cancelConn->addr[0].family = conn->raddr.addr.ss_family;
 
    cancelConn->status = CONNECTION_ALLOCATED;
    return (PGcancelConn *) cancelConn;
 
oom_error:
    cancelConn->status = CONNECTION_BAD;
    libpq_append_conn_error(cancelConn, "out of memory");
    return (PGcancelConn *) cancelConn;
}

References SockAddr::addr, pg_cancel::be_key, pg_conn::be_key, pg_cancel::be_pid, pg_conn::be_pid, calloc, cancelConn, conn, CONNECTION_ALLOCATED, CONNECTION_BAD, pg_conn::connhost, pg_conn_host::host, pg_conn_host::hostaddr, libpq_append_conn_error(), pg_conn_host::password, PGINVALID_SOCKET, pg_conn_host::port, pqConnectOptions2(), pqCopyPGconn(), pqMakeEmptyPGconn(), pqReleaseConnHosts(), pg_conn::raddr, pg_conn::sock, and pg_conn::whichhost.

Referenced by disconnectDatabase(), libpqsrv_cancel(), test_cancel(), and try_complete_step().

PQcancelErrorMessage()

char* PQcancelErrorMessage

(

const PGcancelConn *

cancelConn

)

Definition at line 306 of file fe-cancel.c.

{
    return PQerrorMessage(&cancelConn->conn);
}

References cancelConn, and PQerrorMessage().

Referenced by libpqsrv_cancel(), test_cancel(), and try_complete_step().

PQcancelFinish()

void PQcancelFinish

(

PGcancelConn *

cancelConn

)

Definition at line 334 of file fe-cancel.c.

{
    PQfinish(&cancelConn->conn);
}

References cancelConn, and PQfinish().

Referenced by disconnectDatabase(), libpqsrv_cancel(), test_cancel(), and try_complete_step().

PQcancelPoll()

PostgresPollingStatusType PQcancelPoll

(

PGcancelConn *

cancelConn

)

Definition at line 207 of file fe-cancel.c.

{
    PGconn     *conn = &cancelConn->conn;
    int         n;
 
    /*
     * We leave most of the connection establishment to PQconnectPoll, since
     * it's very similar to normal connection establishment. But once we get
     * to the CONNECTION_AWAITING_RESPONSE we need to start doing our own
     * thing.
     */
    if (conn->status != CONNECTION_AWAITING_RESPONSE)
    {
        return PQconnectPoll(conn);
    }
 
    /*
     * At this point we are waiting on the server to close the connection,
     * which is its way of communicating that the cancel has been handled.
     */
 
    n = pqReadData(conn);
 
    if (n == 0)
        return PGRES_POLLING_READING;
 
#ifndef WIN32
 
    /*
     * If we receive an error report it, but only if errno is non-zero.
     * Otherwise we assume it's an EOF, which is what we expect from the
     * server.
     *
     * We skip this for Windows, because Windows is a bit special in its EOF
     * behaviour for TCP. Sometimes it will error with an ECONNRESET when
     * there is a clean connection closure. See these threads for details:
     * https://www.postgresql.org/message-id/flat/90b34057-4176-7bb0-0dbb-9822a5f6425b%40greiz-reinsdorf.de
     *
     * https://www.postgresql.org/message-id/flat/CA%2BhUKG%2BOeoETZQ%3DQw5Ub5h3tmwQhBmDA%3DnuNO3KG%3DzWfUypFAw%40mail.gmail.com
     *
     * PQcancel ignores such errors and reports success for the cancellation
     * anyway, so even if this is not always correct we do the same here.
     */
    if (n < 0 && errno != 0)
    {
        conn->status = CONNECTION_BAD;
        return PGRES_POLLING_FAILED;
    }
#endif
 
    /*
     * We don't expect any data, only connection closure. So if we strangely
     * do receive some data we consider that an error.
     */
    if (n > 0)
    {
        libpq_append_conn_error(conn, "unexpected response from server");
        conn->status = CONNECTION_BAD;
        return PGRES_POLLING_FAILED;
    }
 
    /*
     * Getting here means that we received an EOF, which is what we were
     * expecting -- the cancel request has completed.
     */
    cancelConn->conn.status = CONNECTION_OK;
    resetPQExpBuffer(&conn->errorMessage);
    return PGRES_POLLING_OK;
}

References cancelConn, conn, CONNECTION_AWAITING_RESPONSE, CONNECTION_BAD, CONNECTION_OK, pg_conn::errorMessage, libpq_append_conn_error(), PGRES_POLLING_FAILED, PGRES_POLLING_OK, PGRES_POLLING_READING, PQconnectPoll(), pqReadData(), resetPQExpBuffer(), and pg_conn::status.

Referenced by libpqsrv_cancel(), pqConnectDBComplete(), and test_cancel().

PQcancelReset()

void PQcancelReset

(

PGcancelConn *

cancelConn

)

Definition at line 318 of file fe-cancel.c.

{
    pqClosePGconn(&cancelConn->conn);
    cancelConn->conn.status = CONNECTION_ALLOCATED;
    cancelConn->conn.whichhost = 0;
    cancelConn->conn.whichaddr = 0;
    cancelConn->conn.try_next_host = false;
    cancelConn->conn.try_next_addr = false;
}

References cancelConn, CONNECTION_ALLOCATED, and pqClosePGconn().

Referenced by test_cancel().

PQcancelSocket()

int PQcancelSocket

(

const PGcancelConn *

cancelConn

)

Definition at line 294 of file fe-cancel.c.

{
    return PQsocket(&cancelConn->conn);
}

References cancelConn, and PQsocket().

Referenced by libpqsrv_cancel(), and test_cancel().

PQcancelStart()

int PQcancelStart

(

PGcancelConn *

cancelConn

)

Definition at line 185 of file fe-cancel.c.

{
    if (!cancelConn || cancelConn->conn.status == CONNECTION_BAD)
        return 0;
 
    if (cancelConn->conn.status != CONNECTION_ALLOCATED)
    {
        libpq_append_conn_error(&cancelConn->conn,
                                "cancel request is already being sent on this connection");
        cancelConn->conn.status = CONNECTION_BAD;
        return 0;
    }
 
    return pqConnectDBStart(&cancelConn->conn);
}

References cancelConn, CONNECTION_ALLOCATED, CONNECTION_BAD, libpq_append_conn_error(), and pqConnectDBStart().

Referenced by libpqsrv_cancel(), PQcancelBlocking(), and test_cancel().

PQcancelStatus()

ConnStatusType PQcancelStatus

(

const PGcancelConn *

cancelConn

)

Definition at line 283 of file fe-cancel.c.

{
    return PQstatus(&cancelConn->conn);
}

References cancelConn, and PQstatus().

Referenced by test_cancel().

PQchangePassword()

PGresult* PQchangePassword	(	PGconn *	conn,
		const char *	user,
		const char *	passwd
	)

Definition at line 1442 of file fe-auth.c.

{
    char       *encrypted_password = PQencryptPasswordConn(conn, passwd,
                                                           user, NULL);
 
    if (!encrypted_password)
    {
        /* PQencryptPasswordConn() already registered the error */
        return NULL;
    }
    else
    {
        char       *fmtpw = PQescapeLiteral(conn, encrypted_password,
                                            strlen(encrypted_password));
 
        /* no longer needed, so clean up now */
        PQfreemem(encrypted_password);
 
        if (!fmtpw)
        {
            /* PQescapeLiteral() already registered the error */
            return NULL;
        }
        else
        {
            char       *fmtuser = PQescapeIdentifier(conn, user, strlen(user));
 
            if (!fmtuser)
            {
                /* PQescapeIdentifier() already registered the error */
                PQfreemem(fmtpw);
                return NULL;
            }
            else
            {
                PQExpBufferData buf;
                PGresult   *res;
 
                initPQExpBuffer(&buf);
                printfPQExpBuffer(&buf, "ALTER USER %s PASSWORD %s",
                                  fmtuser, fmtpw);
 
                res = PQexec(conn, buf.data);
 
                /* clean up */
                termPQExpBuffer(&buf);
                PQfreemem(fmtuser);
                PQfreemem(fmtpw);
 
                return res;
            }
        }
    }
}

References buf, conn, initPQExpBuffer(), PQencryptPasswordConn(), PQescapeIdentifier(), PQescapeLiteral(), PQexec(), PQfreemem(), printfPQExpBuffer(), res, termPQExpBuffer(), and user.

Referenced by exec_command_password().

PQclear()

void PQclear

(

PGresult *

res

)

Definition at line 721 of file fe-exec.c.

{
    PGresult_data *block;
    int         i;
 
    /* As a convenience, do nothing for a NULL pointer */
    if (!res)
        return;
    /* Also, do nothing if the argument is OOM_result */
    if ((const PGresult *) res == &OOM_result)
        return;
 
    /* Close down any events we may have */
    for (i = 0; i < res->nEvents; i++)
    {
        /* only send DESTROY to successfully-initialized event procs */
        if (res->events[i].resultInitialized)
        {
            PGEventResultDestroy evt;
 
            evt.result = res;
            (void) res->events[i].proc(PGEVT_RESULTDESTROY, &evt,
                                       res->events[i].passThrough);
        }
        free(res->events[i].name);
    }
 
    free(res->events);
 
    /* Free all the subsidiary blocks */
    while ((block = res->curBlock) != NULL)
    {
        res->curBlock = block->next;
        free(block);
    }
 
    /* Free the top-level tuple pointer array */
    free(res->tuples);
 
    /* zero out the pointer fields to catch programming errors */
    res->attDescs = NULL;
    res->tuples = NULL;
    res->paramDescs = NULL;
    res->errFields = NULL;
    res->events = NULL;
    res->nEvents = 0;
    /* res->curBlock was zeroed out earlier */
 
    /* Free the PGresult structure itself */
    free(res);
}

References pg_result::attDescs, pg_result::curBlock, pg_result::errFields, pg_result::events, free, i, PGEvent::name, pg_result::nEvents, pgresult_data::next, OOM_result, pg_result::paramDescs, PGEvent::passThrough, PGEVT_RESULTDESTROY, PGEvent::proc, res, PGEventResultDestroy::result, PGEvent::resultInitialized, and pg_result::tuples.

Referenced by pqClearAsyncResult(), PQcopyResult(), PQexecFinish(), PQexecStart(), pqInternalNotice(), and PQmakeEmptyPGresult().

PQclientEncoding()

int PQclientEncoding

(

const PGconn *

conn

)

Definition at line 7270 of file fe-connect.c.

{
    if (!conn || conn->status != CONNECTION_OK)
        return -1;
    return conn->client_encoding;
}

References pg_conn::client_encoding, conn, CONNECTION_OK, and pg_conn::status.

Referenced by appendQualifiedRelation(), appendStringLiteralConn(), dblink_connect(), dblink_get_conn(), exec_command_encoding(), main(), processSQLNamePattern(), SendQuery(), setup_connection(), SyncVariables(), and vacuum_one_database().

PQclosePortal()

PGresult* PQclosePortal	(	PGconn *	conn,
		const char *	portal
	)

Definition at line 2539 of file fe-exec.c.

{
    if (!PQexecStart(conn))
        return NULL;
    if (!PQsendTypedCommand(conn, PqMsg_Close, 'P', portal))
        return NULL;
    return PQexecFinish(conn);
}

References conn, PQexecFinish(), PQexecStart(), PqMsg_Close, and PQsendTypedCommand().

Referenced by test_prepared().

PQclosePrepared()

PGresult* PQclosePrepared	(	PGconn *	conn,
		const char *	stmt
	)

Definition at line 2521 of file fe-exec.c.

{
    if (!PQexecStart(conn))
        return NULL;
    if (!PQsendTypedCommand(conn, PqMsg_Close, 'S', stmt))
        return NULL;
    return PQexecFinish(conn);
}

References conn, PQexecFinish(), PQexecStart(), PqMsg_Close, PQsendTypedCommand(), and stmt.

Referenced by test_prepared().

PQcmdStatus()

char* PQcmdStatus

(

PGresult *

res

)

Definition at line 3752 of file fe-exec.c.

{
    if (!res)
        return NULL;
    return res->cmdStatus;
}

References pg_result::cmdStatus, and res.

Referenced by dblink_exec(), ecpg_process_output(), ExecQueryAndProcessResults(), materializeResult(), PrintQueryStatus(), and test_pipelined_insert().

PQcmdTuples()

char* PQcmdTuples

(

PGresult *

res

)

Definition at line 3822 of file fe-exec.c.

{
    char       *p,
               *c;
 
    if (!res)
        return "";
 
    if (strncmp(res->cmdStatus, "INSERT ", 7) == 0)
    {
        p = res->cmdStatus + 7;
        /* INSERT: skip oid and space */
        while (*p && *p != ' ')
            p++;
        if (*p == 0)
            goto interpret_error;   /* no space? */
        p++;
    }
    else if (strncmp(res->cmdStatus, "SELECT ", 7) == 0 ||
             strncmp(res->cmdStatus, "DELETE ", 7) == 0 ||
             strncmp(res->cmdStatus, "UPDATE ", 7) == 0)
        p = res->cmdStatus + 7;
    else if (strncmp(res->cmdStatus, "FETCH ", 6) == 0 ||
             strncmp(res->cmdStatus, "MERGE ", 6) == 0)
        p = res->cmdStatus + 6;
    else if (strncmp(res->cmdStatus, "MOVE ", 5) == 0 ||
             strncmp(res->cmdStatus, "COPY ", 5) == 0)
        p = res->cmdStatus + 5;
    else
        return "";
 
    /* check that we have an integer (at least one digit, nothing else) */
    for (c = p; *c; c++)
    {
        if (!isdigit((unsigned char) *c))
            goto interpret_error;
    }
    if (c == p)
        goto interpret_error;
 
    return p;
 
interpret_error:
    pqInternalNotice(&res->noticeHooks,
                     "could not interpret result from server: %s",
                     res->cmdStatus);
    return "";
}

References pg_result::cmdStatus, pg_result::noticeHooks, pqInternalNotice(), and res.

Referenced by ecpg_process_output(), execute_dml_stmt(), execute_foreign_modify(), and SetResultVariables().

PQconndefaults()

PQconninfoOption* PQconndefaults

(

void

)

Definition at line 1882 of file fe-connect.c.

{
    PQExpBufferData errorBuf;
    PQconninfoOption *connOptions;
 
    /* We don't actually report any errors here, but callees want a buffer */
    initPQExpBuffer(&errorBuf);
    if (PQExpBufferDataBroken(errorBuf))
        return NULL;            /* out of memory already :-( */
 
    connOptions = conninfo_init(&errorBuf);
    if (connOptions != NULL)
    {
        /* pass NULL errorBuf to ignore errors */
        if (!conninfo_add_defaults(connOptions, NULL))
        {
            PQconninfoFree(connOptions);
            connOptions = NULL;
        }
    }
 
    termPQExpBuffer(&errorBuf);
    return connOptions;
}

References conninfo_add_defaults(), conninfo_init(), initPQExpBuffer(), PQconninfoFree(), PQExpBufferDataBroken, and termPQExpBuffer().

Referenced by check_pghost_envvar(), dblink_fdw_validator(), do_connect(), get_connect_string(), GetDbnameFromConnectionOptions(), InitPgFdwOptions(), and main().

PQconnectdb()

PGconn* PQconnectdb

(

const char *

conninfo

)

Definition at line 745 of file fe-connect.c.

{
    PGconn     *conn = PQconnectStart(conninfo);
 
    if (conn && conn->status != CONNECTION_BAD)
        (void) pqConnectDBComplete(conn);
 
    return conn;
}

References conn, CONNECTION_BAD, pqConnectDBComplete(), PQconnectStart(), and pg_conn::status.

Referenced by connect_database(), get_db_conn(), and main().

PQconnectdbParams()

PGconn* PQconnectdbParams	(	const char *const *	keywords,
		const char *const *	values,
		int	expand_dbname
	)

Definition at line 690 of file fe-connect.c.

{
    PGconn     *conn = PQconnectStartParams(keywords, values, expand_dbname);
 
    if (conn && conn->status != CONNECTION_BAD)
        (void) pqConnectDBComplete(conn);
 
    return conn;
}

References conn, CONNECTION_BAD, pqConnectDBComplete(), PQconnectStartParams(), pg_conn::status, and values.

Referenced by ConnectDatabase(), connectDatabase(), copy_connection(), doConnect(), ECPGconnect(), GetConnection(), main(), sql_conn(), and vacuumlo().

PQconnectionNeedsPassword()

int PQconnectionNeedsPassword

(

const PGconn *

conn

)

Definition at line 7233 of file fe-connect.c.

{
    char       *password;
 
    if (!conn)
        return false;
    password = PQpass(conn);
    if (conn->password_needed &&
        (password == NULL || password[0] == '\0'))
        return true;
    else
        return false;
}

References conn, password, pg_conn::password_needed, and PQpass().

Referenced by ConnectDatabase(), connectDatabase(), do_connect(), doConnect(), GetConnection(), main(), sql_conn(), and vacuumlo().

PQconnectionUsedGSSAPI()

int PQconnectionUsedGSSAPI

(

const PGconn *

conn

)

Definition at line 7259 of file fe-connect.c.

{
    if (!conn)
        return false;
    if (conn->gssapi_used)
        return true;
    else
        return false;
}

References conn, and pg_conn::gssapi_used.

Referenced by dblink_security_check(), and pgfdw_security_check().

PQconnectionUsedPassword()

int PQconnectionUsedPassword

(

const PGconn *

conn

)

Definition at line 7248 of file fe-connect.c.

{
    if (!conn)
        return false;
    if (conn->password_needed)
        return true;
    else
        return false;
}

References conn, and pg_conn::password_needed.

Referenced by ConnectDatabase(), dblink_security_check(), libpqrcv_connect(), and pgfdw_security_check().

PQconnectPoll()

PostgresPollingStatusType PQconnectPoll

(

PGconn *

conn

)

Definition at line 2597 of file fe-connect.c.

{
    bool        reset_connection_state_machine = false;
    bool        need_new_connection = false;
    PGresult   *res;
    char        sebuf[PG_STRERROR_R_BUFLEN];
    int         optval;
 
    if (conn == NULL)
        return PGRES_POLLING_FAILED;
 
    /* Get the new data */
    switch (conn->status)
    {
            /*
             * We really shouldn't have been polled in these two cases, but we
             * can handle it.
             */
        case CONNECTION_BAD:
            return PGRES_POLLING_FAILED;
        case CONNECTION_OK:
            return PGRES_POLLING_OK;
 
            /* These are reading states */
        case CONNECTION_AWAITING_RESPONSE:
        case CONNECTION_AUTH_OK:
        case CONNECTION_CHECK_WRITABLE:
        case CONNECTION_CONSUME:
        case CONNECTION_CHECK_STANDBY:
            {
                /* Load waiting data */
                int         n = pqReadData(conn);
 
                if (n < 0)
                    goto error_return;
                if (n == 0)
                    return PGRES_POLLING_READING;
 
                break;
            }
 
            /* These are writing states, so we just proceed. */
        case CONNECTION_STARTED:
        case CONNECTION_MADE:
            break;
 
            /* Special cases: proceed without waiting. */
        case CONNECTION_SSL_STARTUP:
        case CONNECTION_NEEDED:
        case CONNECTION_GSS_STARTUP:
        case CONNECTION_CHECK_TARGET:
            break;
 
        default:
            libpq_append_conn_error(conn, "invalid connection state, probably indicative of memory corruption");
            goto error_return;
    }
 
 
keep_going:                     /* We will come back to here until there is
                                 * nothing left to do. */
 
    /* Time to advance to next address, or next host if no more addresses? */
    if (conn->try_next_addr)
    {
        if (conn->whichaddr < conn->naddr)
        {
            conn->whichaddr++;
            reset_connection_state_machine = true;
        }
        else
            conn->try_next_host = true;
        conn->try_next_addr = false;
    }
 
    /* Time to advance to next connhost[] entry? */
    if (conn->try_next_host)
    {
        pg_conn_host *ch;
        struct addrinfo hint;
        struct addrinfo *addrlist;
        int         thisport;
        int         ret;
        char        portstr[MAXPGPATH];
 
        if (conn->whichhost + 1 < conn->nconnhost)
            conn->whichhost++;
        else
        {
            /*
             * Oops, no more hosts.
             *
             * If we are trying to connect in "prefer-standby" mode, then drop
             * the standby requirement and start over. Don't do this for
             * cancel requests though, since we are certain the list of
             * servers won't change as the target_server_type option is not
             * applicable to those connections.
             *
             * Otherwise, an appropriate error message is already set up, so
             * we just need to set the right status.
             */
            if (conn->target_server_type == SERVER_TYPE_PREFER_STANDBY &&
                conn->nconnhost > 0 &&
                !conn->cancelRequest)
            {
                conn->target_server_type = SERVER_TYPE_PREFER_STANDBY_PASS2;
                conn->whichhost = 0;
            }
            else
                goto error_return;
        }
 
        /* Drop any address info for previous host */
        release_conn_addrinfo(conn);
 
        /*
         * Look up info for the new host.  On failure, log the problem in
         * conn->errorMessage, then loop around to try the next host.  (Note
         * we don't clear try_next_host until we've succeeded.)
         */
        ch = &conn->connhost[conn->whichhost];
 
        /* Initialize hint structure */
        MemSet(&hint, 0, sizeof(hint));
        hint.ai_socktype = SOCK_STREAM;
        hint.ai_family = AF_UNSPEC;
 
        /* Figure out the port number we're going to use. */
        if (ch->port == NULL || ch->port[0] == '\0')
            thisport = DEF_PGPORT;
        else
        {
            if (!pqParseIntParam(ch->port, &thisport, conn, "port"))
                goto error_return;
 
            if (thisport < 1 || thisport > 65535)
            {
                libpq_append_conn_error(conn, "invalid port number: \"%s\"", ch->port);
                goto keep_going;
            }
        }
        snprintf(portstr, sizeof(portstr), "%d", thisport);
 
        /* Use pg_getaddrinfo_all() to resolve the address */
        switch (ch->type)
        {
            case CHT_HOST_NAME:
                ret = pg_getaddrinfo_all(ch->host, portstr, &hint,
                                         &addrlist);
                if (ret || !addrlist)
                {
                    libpq_append_conn_error(conn, "could not translate host name \"%s\" to address: %s",
                                            ch->host, gai_strerror(ret));
                    goto keep_going;
                }
                break;
 
            case CHT_HOST_ADDRESS:
                hint.ai_flags = AI_NUMERICHOST;
                ret = pg_getaddrinfo_all(ch->hostaddr, portstr, &hint,
                                         &addrlist);
                if (ret || !addrlist)
                {
                    libpq_append_conn_error(conn, "could not parse network address \"%s\": %s",
                                            ch->hostaddr, gai_strerror(ret));
                    goto keep_going;
                }
                break;
 
            case CHT_UNIX_SOCKET:
                hint.ai_family = AF_UNIX;
                UNIXSOCK_PATH(portstr, thisport, ch->host);
                if (strlen(portstr) >= UNIXSOCK_PATH_BUFLEN)
                {
                    libpq_append_conn_error(conn, "Unix-domain socket path \"%s\" is too long (maximum %d bytes)",
                                            portstr,
                                            (int) (UNIXSOCK_PATH_BUFLEN - 1));
                    goto keep_going;
                }
 
                /*
                 * NULL hostname tells pg_getaddrinfo_all to parse the service
                 * name as a Unix-domain socket path.
                 */
                ret = pg_getaddrinfo_all(NULL, portstr, &hint,
                                         &addrlist);
                if (ret || !addrlist)
                {
                    libpq_append_conn_error(conn, "could not translate Unix-domain socket path \"%s\" to address: %s",
                                            portstr, gai_strerror(ret));
                    goto keep_going;
                }
                break;
        }
 
        /*
         * Store a copy of the addrlist in private memory so we can perform
         * randomization for load balancing.
         */
        ret = store_conn_addrinfo(conn, addrlist);
        pg_freeaddrinfo_all(hint.ai_family, addrlist);
        if (ret)
            goto error_return;  /* message already logged */
 
        /*
         * If random load balancing is enabled we shuffle the addresses.
         */
        if (conn->load_balance_type == LOAD_BALANCE_RANDOM)
        {
            /*
             * This is the "inside-out" variant of the Fisher-Yates shuffle
             * algorithm. Notionally, we append each new value to the array
             * and then swap it with a randomly-chosen array element (possibly
             * including itself, else we fail to generate permutations with
             * the last integer last).  The swap step can be optimized by
             * combining it with the insertion.
             *
             * We don't need to initialize conn->prng_state here, because that
             * already happened in pqConnectOptions2.
             */
            for (int i = 1; i < conn->naddr; i++)
            {
                int         j = pg_prng_uint64_range(&conn->prng_state, 0, i);
                AddrInfo    temp = conn->addr[j];
 
                conn->addr[j] = conn->addr[i];
                conn->addr[i] = temp;
            }
        }
 
        reset_connection_state_machine = true;
        conn->try_next_host = false;
    }
 
    /* Reset connection state machine? */
    if (reset_connection_state_machine)
    {
        /*
         * (Re) initialize our connection control variables for a set of
         * connection attempts to a single server address.  These variables
         * must persist across individual connection attempts, but we must
         * reset them when we start to consider a new server.
         */
        conn->pversion = PG_PROTOCOL(3, 0);
        conn->send_appname = true;
        conn->failed_enc_methods = 0;
        conn->current_enc_method = 0;
        conn->allowed_enc_methods = 0;
        reset_connection_state_machine = false;
        need_new_connection = true;
    }
 
    /* Force a new connection (perhaps to the same server as before)? */
    if (need_new_connection)
    {
        /* Drop any existing connection */
        pqDropConnection(conn, true);
 
        /* Reset all state obtained from old server */
        pqDropServerData(conn);
 
        /* Drop any PGresult we might have, too */
        conn->asyncStatus = PGASYNC_IDLE;
        conn->xactStatus = PQTRANS_IDLE;
        conn->pipelineStatus = PQ_PIPELINE_OFF;
        pqClearAsyncResult(conn);
 
        /* Reset conn->status to put the state machine in the right state */
        conn->status = CONNECTION_NEEDED;
 
        need_new_connection = false;
    }
 
    /*
     * Decide what to do next, if server rejects SSL or GSS negotiation, but
     * the connection is still valid.  If there are no options left, error out
     * with 'msg'.
     */
#define ENCRYPTION_NEGOTIATION_FAILED(msg) \
    do { \
        switch (encryption_negotiation_failed(conn)) \
        { \
            case 0: \
                libpq_append_conn_error(conn, (msg)); \
                goto error_return; \
            case 1: \
                conn->status = CONNECTION_MADE; \
                return PGRES_POLLING_WRITING; \
            case 2: \
                need_new_connection = true; \
                goto keep_going; \
        } \
    } while(0);
 
    /*
     * Decide what to do next, if connection fails.  If there are no options
     * left, return with an error.  The error message has already been written
     * to the connection's error buffer.
     */
#define CONNECTION_FAILED() \
    do { \
        if (connection_failed(conn)) \
        { \
            need_new_connection = true; \
            goto keep_going; \
        } \
        else \
            goto error_return; \
    } while(0);
 
    /* Now try to advance the state machine for this connection */
    switch (conn->status)
    {
        case CONNECTION_NEEDED:
            {
                /*
                 * Try to initiate a connection to one of the addresses
                 * returned by pg_getaddrinfo_all().  conn->whichaddr is the
                 * next one to try.
                 *
                 * The extra level of braces here is historical.  It's not
                 * worth reindenting this whole switch case to remove 'em.
                 */
                {
                    char        host_addr[NI_MAXHOST];
                    int         sock_type;
                    AddrInfo   *addr_cur;
 
                    /*
                     * Advance to next possible host, if we've tried all of
                     * the addresses for the current host.
                     */
                    if (conn->whichaddr == conn->naddr)
                    {
                        conn->try_next_host = true;
                        goto keep_going;
                    }
                    addr_cur = &conn->addr[conn->whichaddr];
 
                    /* Remember current address for possible use later */
                    memcpy(&conn->raddr, &addr_cur->addr, sizeof(SockAddr));
 
#ifdef ENABLE_GSS
 
                    /*
                     * Before establishing the connection, check if it's
                     * doomed to fail because gssencmode='require' but GSSAPI
                     * is not available.
                     */
                    if (conn->gssencmode[0] == 'r')
                    {
                        if (conn->raddr.addr.ss_family == AF_UNIX)
                        {
                            libpq_append_conn_error(conn,
                                                    "GSSAPI encryption required but it is not supported over a local socket");
                            goto error_return;
                        }
                        if (conn->gcred == GSS_C_NO_CREDENTIAL)
                        {
                            if (!pg_GSS_have_cred_cache(&conn->gcred))
                            {
                                libpq_append_conn_error(conn,
                                                        "GSSAPI encryption required but no credential cache");
                                goto error_return;
                            }
                        }
                    }
#endif
 
                    /*
                     * Choose the encryption method to try first.  Do this
                     * before establishing the connection, so that if none of
                     * the modes allowed by the connections options are
                     * available, we can error out before establishing the
                     * connection.
                     */
                    if (!init_allowed_encryption_methods(conn))
                        goto error_return;
 
                    /*
                     * Set connip, too.  Note we purposely ignore strdup
                     * failure; not a big problem if it fails.
                     */
                    if (conn->connip != NULL)
                    {
                        free(conn->connip);
                        conn->connip = NULL;
                    }
                    getHostaddr(conn, host_addr, NI_MAXHOST);
                    if (host_addr[0])
                        conn->connip = strdup(host_addr);
 
                    /* Try to create the socket */
                    sock_type = SOCK_STREAM;
#ifdef SOCK_CLOEXEC
 
                    /*
                     * Atomically mark close-on-exec, if possible on this
                     * platform, so that there isn't a window where a
                     * subprogram executed by another thread inherits the
                     * socket.  See fallback code below.
                     */
                    sock_type |= SOCK_CLOEXEC;
#endif
#ifdef SOCK_NONBLOCK
 
                    /*
                     * We might as well skip a system call for nonblocking
                     * mode too, if we can.
                     */
                    sock_type |= SOCK_NONBLOCK;
#endif
                    conn->sock = socket(addr_cur->family, sock_type, 0);
                    if (conn->sock == PGINVALID_SOCKET)
                    {
                        int         errorno = SOCK_ERRNO;
 
                        /*
                         * Silently ignore socket() failure if we have more
                         * addresses to try; this reduces useless chatter in
                         * cases where the address list includes both IPv4 and
                         * IPv6 but kernel only accepts one family.
                         */
                        if (conn->whichaddr < conn->naddr ||
                            conn->whichhost + 1 < conn->nconnhost)
                        {
                            conn->try_next_addr = true;
                            goto keep_going;
                        }
                        emitHostIdentityInfo(conn, host_addr);
                        libpq_append_conn_error(conn, "could not create socket: %s",
                                                SOCK_STRERROR(errorno, sebuf, sizeof(sebuf)));
                        goto error_return;
                    }
 
                    /*
                     * Once we've identified a target address, all errors
                     * except the preceding socket()-failure case should be
                     * prefixed with host-identity information.  (If the
                     * connection succeeds, the contents of conn->errorMessage
                     * won't matter, so this is harmless.)
                     */
                    emitHostIdentityInfo(conn, host_addr);
 
                    /*
                     * Select socket options: no delay of outgoing data for
                     * TCP sockets, nonblock mode, close-on-exec.  Try the
                     * next address if any of this fails.
                     */
                    if (addr_cur->family != AF_UNIX)
                    {
                        if (!connectNoDelay(conn))
                        {
                            /* error message already created */
                            conn->try_next_addr = true;
                            goto keep_going;
                        }
                    }
#ifndef SOCK_NONBLOCK
                    if (!pg_set_noblock(conn->sock))
                    {
                        libpq_append_conn_error(conn, "could not set socket to nonblocking mode: %s",
                                                SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
                        conn->try_next_addr = true;
                        goto keep_going;
                    }
#endif
 
#ifndef SOCK_CLOEXEC
#ifdef F_SETFD
                    if (fcntl(conn->sock, F_SETFD, FD_CLOEXEC) == -1)
                    {
                        libpq_append_conn_error(conn, "could not set socket to close-on-exec mode: %s",
                                                SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
                        conn->try_next_addr = true;
                        goto keep_going;
                    }
#endif                          /* F_SETFD */
#endif
 
                    if (addr_cur->family != AF_UNIX)
                    {
#ifndef WIN32
                        int         on = 1;
#endif
                        int         usekeepalives = useKeepalives(conn);
                        int         err = 0;
 
                        if (usekeepalives < 0)
                        {
                            libpq_append_conn_error(conn, "keepalives parameter must be an integer");
                            err = 1;
                        }
                        else if (usekeepalives == 0)
                        {
                            /* Do nothing */
                        }
#ifndef WIN32
                        else if (setsockopt(conn->sock,
                                            SOL_SOCKET, SO_KEEPALIVE,
                                            (char *) &on, sizeof(on)) < 0)
                        {
                            libpq_append_conn_error(conn, "%s(%s) failed: %s",
                                                    "setsockopt",
                                                    "SO_KEEPALIVE",
                                                    SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
                            err = 1;
                        }
                        else if (!setKeepalivesIdle(conn)
                                 || !setKeepalivesInterval(conn)
                                 || !setKeepalivesCount(conn))
                            err = 1;
#else                           /* WIN32 */
#ifdef SIO_KEEPALIVE_VALS
                        else if (!prepKeepalivesWin32(conn))
                            err = 1;
#endif                          /* SIO_KEEPALIVE_VALS */
#endif                          /* WIN32 */
                        else if (!setTCPUserTimeout(conn))
                            err = 1;
 
                        if (err)
                        {
                            conn->try_next_addr = true;
                            goto keep_going;
                        }
                    }
 
                    /*----------
                     * We have three methods of blocking SIGPIPE during
                     * send() calls to this socket:
                     *
                     *  - setsockopt(sock, SO_NOSIGPIPE)
                     *  - send(sock, ..., MSG_NOSIGNAL)
                     *  - setting the signal mask to SIG_IGN during send()
                     *
                     * The third method requires three syscalls per send,
                     * so we prefer either of the first two, but they are
                     * less portable.  The state is tracked in the following
                     * members of PGconn:
                     *
                     * conn->sigpipe_so     - we have set up SO_NOSIGPIPE
                     * conn->sigpipe_flag   - we're specifying MSG_NOSIGNAL
                     *
                     * If we can use SO_NOSIGPIPE, then set sigpipe_so here
                     * and we're done.  Otherwise, set sigpipe_flag so that
                     * we will try MSG_NOSIGNAL on sends.  If we get an error
                     * with MSG_NOSIGNAL, we'll clear that flag and revert to
                     * signal masking.
                     *----------
                     */
                    conn->sigpipe_so = false;
#ifdef MSG_NOSIGNAL
                    conn->sigpipe_flag = true;
#else
                    conn->sigpipe_flag = false;
#endif                          /* MSG_NOSIGNAL */
 
#ifdef SO_NOSIGPIPE
                    optval = 1;
                    if (setsockopt(conn->sock, SOL_SOCKET, SO_NOSIGPIPE,
                                   (char *) &optval, sizeof(optval)) == 0)
                    {
                        conn->sigpipe_so = true;
                        conn->sigpipe_flag = false;
                    }
#endif                          /* SO_NOSIGPIPE */
 
                    /*
                     * Start/make connection.  This should not block, since we
                     * are in nonblock mode.  If it does, well, too bad.
                     */
                    if (connect(conn->sock, (struct sockaddr *) &addr_cur->addr.addr,
                                addr_cur->addr.salen) < 0)
                    {
                        if (SOCK_ERRNO == EINPROGRESS ||
#ifdef WIN32
                            SOCK_ERRNO == EWOULDBLOCK ||
#endif
                            SOCK_ERRNO == EINTR)
                        {
                            /*
                             * This is fine - we're in non-blocking mode, and
                             * the connection is in progress.  Tell caller to
                             * wait for write-ready on socket.
                             */
                            conn->status = CONNECTION_STARTED;
                            return PGRES_POLLING_WRITING;
                        }
                        /* otherwise, trouble */
                    }
                    else
                    {
                        /*
                         * Hm, we're connected already --- seems the "nonblock
                         * connection" wasn't.  Advance the state machine and
                         * go do the next stuff.
                         */
                        conn->status = CONNECTION_STARTED;
                        goto keep_going;
                    }
 
                    /*
                     * This connection failed.  Add the error report to
                     * conn->errorMessage, then try the next address if any.
                     */
                    connectFailureMessage(conn, SOCK_ERRNO);
                    conn->try_next_addr = true;
                    goto keep_going;
                }
            }
 
        case CONNECTION_STARTED:
            {
                socklen_t   optlen = sizeof(optval);
 
                /*
                 * Write ready, since we've made it here, so the connection
                 * has been made ... or has failed.
                 */
 
                /*
                 * Now check (using getsockopt) that there is not an error
                 * state waiting for us on the socket.
                 */
 
                if (getsockopt(conn->sock, SOL_SOCKET, SO_ERROR,
                               (char *) &optval, &optlen) == -1)
                {
                    libpq_append_conn_error(conn, "could not get socket error status: %s",
                                            SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
                    goto error_return;
                }
                else if (optval != 0)
                {
                    /*
                     * When using a nonblocking connect, we will typically see
                     * connect failures at this point, so provide a friendly
                     * error message.
                     */
                    connectFailureMessage(conn, optval);
 
                    /*
                     * Try the next address if any, just as in the case where
                     * connect() returned failure immediately.
                     */
                    conn->try_next_addr = true;
                    goto keep_going;
                }
 
                /* Fill in the client address */
                conn->laddr.salen = sizeof(conn->laddr.addr);
                if (getsockname(conn->sock,
                                (struct sockaddr *) &conn->laddr.addr,
                                &conn->laddr.salen) < 0)
                {
                    libpq_append_conn_error(conn, "could not get client address from socket: %s",
                                            SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
                    goto error_return;
                }
 
                /*
                 * Implement requirepeer check, if requested and it's a
                 * Unix-domain socket.
                 */
                if (conn->requirepeer && conn->requirepeer[0] &&
                    conn->raddr.addr.ss_family == AF_UNIX)
                {
#ifndef WIN32
                    char       *remote_username;
#endif
                    uid_t       uid;
                    gid_t       gid;
 
                    errno = 0;
                    if (getpeereid(conn->sock, &uid, &gid) != 0)
                    {
                        /*
                         * Provide special error message if getpeereid is a
                         * stub
                         */
                        if (errno == ENOSYS)
                            libpq_append_conn_error(conn, "requirepeer parameter is not supported on this platform");
                        else
                            libpq_append_conn_error(conn, "could not get peer credentials: %s",
                                                    strerror_r(errno, sebuf, sizeof(sebuf)));
                        goto error_return;
                    }
 
#ifndef WIN32
                    remote_username = pg_fe_getusername(uid,
                                                        &conn->errorMessage);
                    if (remote_username == NULL)
                        goto error_return;  /* message already logged */
 
                    if (strcmp(remote_username, conn->requirepeer) != 0)
                    {
                        libpq_append_conn_error(conn, "requirepeer specifies \"%s\", but actual peer user name is \"%s\"",
                                                conn->requirepeer, remote_username);
                        free(remote_username);
                        goto error_return;
                    }
                    free(remote_username);
#else                           /* WIN32 */
                    /* should have failed with ENOSYS above */
                    Assert(false);
#endif                          /* WIN32 */
                }
 
                /*
                 * Make sure we can write before advancing to next step.
                 */
                conn->status = CONNECTION_MADE;
                return PGRES_POLLING_WRITING;
            }
 
        case CONNECTION_MADE:
            {
                char       *startpacket;
                int         packetlen;
 
#ifdef ENABLE_GSS
 
                /*
                 * If GSSAPI encryption is enabled, send a packet to the
                 * server asking for GSSAPI Encryption and proceed with GSSAPI
                 * handshake.  We will come back here after GSSAPI encryption
                 * has been established, with conn->gctx set.
                 */
                if (conn->current_enc_method == ENC_GSSAPI && !conn->gctx)
                {
                    ProtocolVersion pv = pg_hton32(NEGOTIATE_GSS_CODE);
 
                    if (pqPacketSend(conn, 0, &pv, sizeof(pv)) != STATUS_OK)
                    {
                        libpq_append_conn_error(conn, "could not send GSSAPI negotiation packet: %s",
                                                SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
                        goto error_return;
                    }
 
                    /* Ok, wait for response */
                    conn->status = CONNECTION_GSS_STARTUP;
                    return PGRES_POLLING_READING;
                }
#endif
 
#ifdef USE_SSL
 
                /*
                 * If SSL is enabled, start the SSL negotiation. We will come
                 * back here after SSL encryption has been established, with
                 * ssl_in_use set.
                 */
                if (conn->current_enc_method == ENC_SSL && !conn->ssl_in_use)
                {
                    /*
                     * If traditional postgres SSL negotiation is used, send
                     * the SSL request.  In direct negotiation, jump straight
                     * into the SSL handshake.
                     */
                    if (conn->sslnegotiation[0] == 'p')
                    {
                        ProtocolVersion pv;
 
                        /*
                         * Send the SSL request packet.
                         *
                         * Theoretically, this could block, but it really
                         * shouldn't since we only got here if the socket is
                         * write-ready.
                         */
                        pv = pg_hton32(NEGOTIATE_SSL_CODE);
                        if (pqPacketSend(conn, 0, &pv, sizeof(pv)) != STATUS_OK)
                        {
                            libpq_append_conn_error(conn, "could not send SSL negotiation packet: %s",
                                                    SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
                            goto error_return;
                        }
                        /* Ok, wait for response */
                        conn->status = CONNECTION_SSL_STARTUP;
                        return PGRES_POLLING_READING;
                    }
                    else
                    {
                        Assert(conn->sslnegotiation[0] == 'd');
                        conn->status = CONNECTION_SSL_STARTUP;
                        return PGRES_POLLING_WRITING;
                    }
                }
#endif                          /* USE_SSL */
 
                /*
                 * For cancel requests this is as far as we need to go in the
                 * connection establishment. Now we can actually send our
                 * cancellation request.
                 */
                if (conn->cancelRequest)
                {
                    CancelRequestPacket cancelpacket;
 
                    packetlen = sizeof(cancelpacket);
                    cancelpacket.cancelRequestCode = (MsgType) pg_hton32(CANCEL_REQUEST_CODE);
                    cancelpacket.backendPID = pg_hton32(conn->be_pid);
                    cancelpacket.cancelAuthCode = pg_hton32(conn->be_key);
                    if (pqPacketSend(conn, 0, &cancelpacket, packetlen) != STATUS_OK)
                    {
                        libpq_append_conn_error(conn, "could not send cancel packet: %s",
                                                SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
                        goto error_return;
                    }
                    conn->status = CONNECTION_AWAITING_RESPONSE;
                    return PGRES_POLLING_READING;
                }
 
                /*
                 * We have now established encryption, or we are happy to
                 * proceed without.
                 */
 
                /* Build the startup packet. */
                startpacket = pqBuildStartupPacket3(conn, &packetlen,
                                                    EnvironmentOptions);
                if (!startpacket)
                {
                    libpq_append_conn_error(conn, "out of memory");
                    goto error_return;
                }
 
                /*
                 * Send the startup packet.
                 *
                 * Theoretically, this could block, but it really shouldn't
                 * since we only got here if the socket is write-ready.
                 */
                if (pqPacketSend(conn, 0, startpacket, packetlen) != STATUS_OK)
                {
                    libpq_append_conn_error(conn, "could not send startup packet: %s",
                                            SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
                    free(startpacket);
                    goto error_return;
                }
 
                free(startpacket);
 
                conn->status = CONNECTION_AWAITING_RESPONSE;
                return PGRES_POLLING_READING;
            }
 
            /*
             * Handle SSL negotiation: wait for postmaster messages and
             * respond as necessary.
             */
        case CONNECTION_SSL_STARTUP:
            {
#ifdef USE_SSL
                PostgresPollingStatusType pollres;
 
                /*
                 * On first time through with traditional SSL negotiation, get
                 * the postmaster's response to our SSLRequest packet. With
                 * sslnegotiation='direct', go straight to initiating SSL.
                 */
                if (!conn->ssl_in_use && conn->sslnegotiation[0] == 'p')
                {
                    /*
                     * We use pqReadData here since it has the logic to
                     * distinguish no-data-yet from connection closure. Since
                     * conn->ssl isn't set, a plain recv() will occur.
                     */
                    char        SSLok;
                    int         rdresult;
 
                    rdresult = pqReadData(conn);
                    if (rdresult < 0)
                    {
                        /* errorMessage is already filled in */
                        goto error_return;
                    }
                    if (rdresult == 0)
                    {
                        /* caller failed to wait for data */
                        return PGRES_POLLING_READING;
                    }
                    if (pqGetc(&SSLok, conn) < 0)
                    {
                        /* should not happen really */
                        return PGRES_POLLING_READING;
                    }
                    if (SSLok == 'S')
                    {
                        if (conn->Pfdebug)
                            pqTraceOutputCharResponse(conn, "SSLResponse",
                                                      SSLok);
                        /* mark byte consumed */
                        conn->inStart = conn->inCursor;
                    }
                    else if (SSLok == 'N')
                    {
                        if (conn->Pfdebug)
                            pqTraceOutputCharResponse(conn, "SSLResponse",
                                                      SSLok);
                        /* mark byte consumed */
                        conn->inStart = conn->inCursor;
 
                        /*
                         * The connection is still valid, so if it's OK to
                         * continue without SSL, we can proceed using this
                         * connection.  Otherwise return with an error.
                         */
                        ENCRYPTION_NEGOTIATION_FAILED(libpq_gettext("server does not support SSL, but SSL was required"));
                    }
                    else if (SSLok == 'E')
                    {
                        /*
                         * Server failure of some sort, such as failure to
                         * fork a backend process.  We need to process and
                         * report the error message, which might be formatted
                         * according to either protocol 2 or protocol 3.
                         * Rather than duplicate the code for that, we flip
                         * into AWAITING_RESPONSE state and let the code there
                         * deal with it.  Note we have *not* consumed the "E"
                         * byte here.
                         */
                        conn->status = CONNECTION_AWAITING_RESPONSE;
 
                        /*
                         * Don't fall back to a plaintext connection after
                         * reading the error.
                         */
                        conn->failed_enc_methods |= conn->allowed_enc_methods & (~conn->current_enc_method);
                        goto keep_going;
                    }
                    else
                    {
                        libpq_append_conn_error(conn, "received invalid response to SSL negotiation: %c",
                                                SSLok);
                        goto error_return;
                    }
                }
 
                /*
                 * Begin or continue the SSL negotiation process.
                 */
                pollres = pqsecure_open_client(conn);
                if (pollres == PGRES_POLLING_OK)
                {
                    /*
                     * At this point we should have no data already buffered.
                     * If we do, it was received before we performed the SSL
                     * handshake, so it wasn't encrypted and indeed may have
                     * been injected by a man-in-the-middle.
                     */
                    if (conn->inCursor != conn->inEnd)
                    {
                        libpq_append_conn_error(conn, "received unencrypted data after SSL response");
                        goto error_return;
                    }
 
                    /* SSL handshake done, ready to send startup packet */
                    conn->status = CONNECTION_MADE;
                    return PGRES_POLLING_WRITING;
                }
                if (pollres == PGRES_POLLING_FAILED)
                {
                    /*
                     * SSL handshake failed.  We will retry with a plaintext
                     * connection, if permitted by sslmode.
                     */
                    CONNECTION_FAILED();
                }
                /* Else, return POLLING_READING or POLLING_WRITING status */
                return pollres;
#else                           /* !USE_SSL */
                /* can't get here */
                goto error_return;
#endif                          /* USE_SSL */
            }
 
        case CONNECTION_GSS_STARTUP:
            {
#ifdef ENABLE_GSS
                PostgresPollingStatusType pollres;
 
                /*
                 * If we haven't yet, get the postmaster's response to our
                 * negotiation packet
                 */
                if (!conn->gctx)
                {
                    char        gss_ok;
                    int         rdresult = pqReadData(conn);
 
                    if (rdresult < 0)
                        /* pqReadData fills in error message */
                        goto error_return;
                    else if (rdresult == 0)
                        /* caller failed to wait for data */
                        return PGRES_POLLING_READING;
                    if (pqGetc(&gss_ok, conn) < 0)
                        /* shouldn't happen... */
                        return PGRES_POLLING_READING;
 
                    if (gss_ok == 'E')
                    {
                        /*
                         * Server failure of some sort, possibly protocol
                         * version support failure.  We need to process and
                         * report the error message, which might be formatted
                         * according to either protocol 2 or protocol 3.
                         * Rather than duplicate the code for that, we flip
                         * into AWAITING_RESPONSE state and let the code there
                         * deal with it.  Note we have *not* consumed the "E"
                         * byte here.
                         *
                         * Note that unlike on an error response to
                         * SSLRequest, we allow falling back to SSL or
                         * plaintext connection here.  GSS support was
                         * introduced in PostgreSQL version 12, so an error
                         * response might mean that we are connecting to a
                         * pre-v12 server.
                         */
                        conn->status = CONNECTION_AWAITING_RESPONSE;
                        goto keep_going;
                    }
 
                    /* mark byte consumed */
                    conn->inStart = conn->inCursor;
 
                    if (gss_ok == 'N')
                    {
                        if (conn->Pfdebug)
                            pqTraceOutputCharResponse(conn, "GSSENCResponse",
                                                      gss_ok);
 
                        /*
                         * The connection is still valid, so if it's OK to
                         * continue without GSS, we can proceed using this
                         * connection.  Otherwise return with an error.
                         */
                        ENCRYPTION_NEGOTIATION_FAILED(libpq_gettext("server doesn't support GSSAPI encryption, but it was required"));
                    }
                    else if (gss_ok != 'G')
                    {
                        libpq_append_conn_error(conn, "received invalid response to GSSAPI negotiation: %c",
                                                gss_ok);
                        goto error_return;
                    }
 
                    if (conn->Pfdebug)
                        pqTraceOutputCharResponse(conn, "GSSENCResponse",
                                                  gss_ok);
                }
 
                /* Begin or continue GSSAPI negotiation */
                pollres = pqsecure_open_gss(conn);
                if (pollres == PGRES_POLLING_OK)
                {
                    /*
                     * At this point we should have no data already buffered.
                     * If we do, it was received before we performed the GSS
                     * handshake, so it wasn't encrypted and indeed may have
                     * been injected by a man-in-the-middle.
                     */
                    if (conn->inCursor != conn->inEnd)
                    {
                        libpq_append_conn_error(conn, "received unencrypted data after GSSAPI encryption response");
                        goto error_return;
                    }
 
                    /* All set for startup packet */
                    conn->status = CONNECTION_MADE;
                    return PGRES_POLLING_WRITING;
                }
                else if (pollres == PGRES_POLLING_FAILED)
                {
                    /*
                     * GSS handshake failed.  We will retry with an SSL or
                     * plaintext connection, if permitted by the options.
                     */
                    CONNECTION_FAILED();
                }
                /* Else, return POLLING_READING or POLLING_WRITING status */
                return pollres;
#else                           /* !ENABLE_GSS */
                /* unreachable */
                goto error_return;
#endif                          /* ENABLE_GSS */
            }
 
            /*
             * Handle authentication exchange: wait for postmaster messages
             * and respond as necessary.
             */
        case CONNECTION_AWAITING_RESPONSE:
            {
                char        beresp;
                int         msgLength;
                int         avail;
                AuthRequest areq;
                int         res;
 
                /*
                 * Scan the message from current point (note that if we find
                 * the message is incomplete, we will return without advancing
                 * inStart, and resume here next time).
                 */
                conn->inCursor = conn->inStart;
 
                /* Read type byte */
                if (pqGetc(&beresp, conn))
                {
                    /* We'll come back when there is more data */
                    return PGRES_POLLING_READING;
                }
 
                /*
                 * Validate message type: we expect only an authentication
                 * request, NegotiateProtocolVersion, or an error here.
                 * Anything else probably means it's not Postgres on the other
                 * end at all.
                 */
                if (beresp != PqMsg_AuthenticationRequest &&
                    beresp != PqMsg_ErrorResponse &&
                    beresp != PqMsg_NegotiateProtocolVersion)
                {
                    libpq_append_conn_error(conn, "expected authentication request from server, but received %c",
                                            beresp);
                    goto error_return;
                }
 
                /* Read message length word */
                if (pqGetInt(&msgLength, 4, conn))
                {
                    /* We'll come back when there is more data */
                    return PGRES_POLLING_READING;
                }
 
                /*
                 * Try to validate message length before using it.
                 *
                 * Authentication requests can't be very large, although GSS
                 * auth requests may not be that small.  Same for
                 * NegotiateProtocolVersion.
                 *
                 * Errors can be a little larger, but not huge.  If we see a
                 * large apparent length in an error, it means we're really
                 * talking to a pre-3.0-protocol server; cope.  (Before
                 * version 14, the server also used the old protocol for
                 * errors that happened before processing the startup packet.)
                 */
                if (beresp == PqMsg_AuthenticationRequest &&
                    (msgLength < 8 || msgLength > 2000))
                {
                    libpq_append_conn_error(conn, "received invalid authentication request");
                    goto error_return;
                }
                if (beresp == PqMsg_NegotiateProtocolVersion &&
                    (msgLength < 8 || msgLength > 2000))
                {
                    libpq_append_conn_error(conn, "received invalid protocol negotiation message");
                    goto error_return;
                }
 
#define MAX_ERRLEN 30000
                if (beresp == PqMsg_ErrorResponse &&
                    (msgLength < 8 || msgLength > MAX_ERRLEN))
                {
                    /* Handle error from a pre-3.0 server */
                    conn->inCursor = conn->inStart + 1; /* reread data */
                    if (pqGets_append(&conn->errorMessage, conn))
                    {
                        /*
                         * We may not have authenticated the server yet, so
                         * don't let the buffer grow forever.
                         */
                        avail = conn->inEnd - conn->inCursor;
                        if (avail > MAX_ERRLEN)
                        {
                            libpq_append_conn_error(conn, "received invalid error message");
                            goto error_return;
                        }
 
                        /* We'll come back when there is more data */
                        return PGRES_POLLING_READING;
                    }
                    /* OK, we read the message; mark data consumed */
                    pqParseDone(conn, conn->inCursor);
 
                    /*
                     * Before 7.2, the postmaster didn't always end its
                     * messages with a newline, so add one if needed to
                     * conform to libpq conventions.
                     */
                    if (conn->errorMessage.len == 0 ||
                        conn->errorMessage.data[conn->errorMessage.len - 1] != '\n')
                    {
                        appendPQExpBufferChar(&conn->errorMessage, '\n');
                    }
 
                    goto error_return;
                }
#undef MAX_ERRLEN
 
                /*
                 * Can't process if message body isn't all here yet.
                 *
                 * After this check passes, any further EOF during parsing
                 * implies that the server sent a bad/truncated message.
                 * Reading more bytes won't help in that case, so don't return
                 * PGRES_POLLING_READING after this point.
                 */
                msgLength -= 4;
                avail = conn->inEnd - conn->inCursor;
                if (avail < msgLength)
                {
                    /*
                     * Before returning, try to enlarge the input buffer if
                     * needed to hold the whole message; see notes in
                     * pqParseInput3.
                     */
                    if (pqCheckInBufferSpace(conn->inCursor + (size_t) msgLength,
                                             conn))
                        goto error_return;
                    /* We'll come back when there is more data */
                    return PGRES_POLLING_READING;
                }
 
                /* Handle errors. */
                if (beresp == PqMsg_ErrorResponse)
                {
                    if (pqGetErrorNotice3(conn, true))
                    {
                        libpq_append_conn_error(conn, "received invalid error message");
                        goto error_return;
                    }
                    /* OK, we read the message; mark data consumed */
                    pqParseDone(conn, conn->inCursor);
 
                    /*
                     * If error is "cannot connect now", try the next host if
                     * any (but we don't want to consider additional addresses
                     * for this host, nor is there much point in changing SSL
                     * or GSS mode).  This is helpful when dealing with
                     * standby servers that might not be in hot-standby state.
                     */
                    if (strcmp(conn->last_sqlstate,
                               ERRCODE_CANNOT_CONNECT_NOW) == 0)
                    {
                        conn->try_next_host = true;
                        goto keep_going;
                    }
 
                    /* Check to see if we should mention pgpassfile */
                    pgpassfileWarning(conn);
 
                    CONNECTION_FAILED();
                }
                else if (beresp == PqMsg_NegotiateProtocolVersion)
                {
                    if (pqGetNegotiateProtocolVersion3(conn))
                    {
                        libpq_append_conn_error(conn, "received invalid protocol negotiation message");
                        goto error_return;
                    }
                    /* OK, we read the message; mark data consumed */
                    pqParseDone(conn, conn->inCursor);
                    goto error_return;
                }
 
                /* It is an authentication request. */
                conn->auth_req_received = true;
 
                /* Get the type of request. */
                if (pqGetInt((int *) &areq, 4, conn))
                {
                    /* can't happen because we checked the length already */
                    libpq_append_conn_error(conn, "received invalid authentication request");
                    goto error_return;
                }
                msgLength -= 4;
 
                /*
                 * Process the rest of the authentication request message, and
                 * respond to it if necessary.
                 *
                 * Note that conn->pghost must be non-NULL if we are going to
                 * avoid the Kerberos code doing a hostname look-up.
                 */
                res = pg_fe_sendauth(areq, msgLength, conn);
 
                /*
                 * OK, we have processed the message; mark data consumed.  We
                 * don't call pqParseDone here because we already traced this
                 * message inside pg_fe_sendauth.
                 */
                conn->inStart = conn->inCursor;
 
                if (res != STATUS_OK)
                    goto error_return;
 
                /*
                 * Just make sure that any data sent by pg_fe_sendauth is
                 * flushed out.  Although this theoretically could block, it
                 * really shouldn't since we don't send large auth responses.
                 */
                if (pqFlush(conn))
                    goto error_return;
 
                if (areq == AUTH_REQ_OK)
                {
                    /* We are done with authentication exchange */
                    conn->status = CONNECTION_AUTH_OK;
 
                    /*
                     * Set asyncStatus so that PQgetResult will think that
                     * what comes back next is the result of a query.  See
                     * below.
                     */
                    conn->asyncStatus = PGASYNC_BUSY;
                }
 
                /* Look to see if we have more data yet. */
                goto keep_going;
            }
 
        case CONNECTION_AUTH_OK:
            {
                /*
                 * Now we expect to hear from the backend. A ReadyForQuery
                 * message indicates that startup is successful, but we might
                 * also get an Error message indicating failure. (Notice
                 * messages indicating nonfatal warnings are also allowed by
                 * the protocol, as are ParameterStatus and BackendKeyData
                 * messages.) Easiest way to handle this is to let
                 * PQgetResult() read the messages. We just have to fake it
                 * out about the state of the connection, by setting
                 * asyncStatus = PGASYNC_BUSY (done above).
                 */
 
                if (PQisBusy(conn))
                    return PGRES_POLLING_READING;
 
                res = PQgetResult(conn);
 
                /*
                 * NULL return indicating we have gone to IDLE state is
                 * expected
                 */
                if (res)
                {
                    if (res->resultStatus != PGRES_FATAL_ERROR)
                        libpq_append_conn_error(conn, "unexpected message from server during startup");
                    else if (conn->send_appname &&
                             (conn->appname || conn->fbappname))
                    {
                        /*
                         * If we tried to send application_name, check to see
                         * if the error is about that --- pre-9.0 servers will
                         * reject it at this stage of the process.  If so,
                         * close the connection and retry without sending
                         * application_name.  We could possibly get a false
                         * SQLSTATE match here and retry uselessly, but there
                         * seems no great harm in that; we'll just get the
                         * same error again if it's unrelated.
                         */
                        const char *sqlstate;
 
                        sqlstate = PQresultErrorField(res, PG_DIAG_SQLSTATE);
                        if (sqlstate &&
                            strcmp(sqlstate, ERRCODE_APPNAME_UNKNOWN) == 0)
                        {
                            PQclear(res);
                            conn->send_appname = false;
                            need_new_connection = true;
                            goto keep_going;
                        }
                    }
 
                    /*
                     * if the resultStatus is FATAL, then conn->errorMessage
                     * already has a copy of the error; needn't copy it back.
                     * But add a newline if it's not there already, since
                     * postmaster error messages may not have one.
                     */
                    if (conn->errorMessage.len <= 0 ||
                        conn->errorMessage.data[conn->errorMessage.len - 1] != '\n')
                        appendPQExpBufferChar(&conn->errorMessage, '\n');
                    PQclear(res);
                    goto error_return;
                }
 
                /* Almost there now ... */
                conn->status = CONNECTION_CHECK_TARGET;
                goto keep_going;
            }
 
        case CONNECTION_CHECK_TARGET:
            {
                /*
                 * If a read-write, read-only, primary, or standby connection
                 * is required, see if we have one.
                 */
                if (conn->target_server_type == SERVER_TYPE_READ_WRITE ||
                    conn->target_server_type == SERVER_TYPE_READ_ONLY)
                {
                    bool        read_only_server;
 
                    /*
                     * If the server didn't report
                     * "default_transaction_read_only" or "in_hot_standby" at
                     * startup, we must determine its state by sending the
                     * query "SHOW transaction_read_only".  This GUC exists in
                     * all server versions that support 3.0 protocol.
                     */
                    if (conn->default_transaction_read_only == PG_BOOL_UNKNOWN ||
                        conn->in_hot_standby == PG_BOOL_UNKNOWN)
                    {
                        /*
                         * We use PQsendQueryContinue so that
                         * conn->errorMessage does not get cleared.  We need
                         * to preserve any error messages related to previous
                         * hosts we have tried and failed to connect to.
                         */
                        conn->status = CONNECTION_OK;
                        if (!PQsendQueryContinue(conn,
                                                 "SHOW transaction_read_only"))
                            goto error_return;
                        /* We'll return to this state when we have the answer */
                        conn->status = CONNECTION_CHECK_WRITABLE;
                        return PGRES_POLLING_READING;
                    }
 
                    /* OK, we can make the test */
                    read_only_server =
                        (conn->default_transaction_read_only == PG_BOOL_YES ||
                         conn->in_hot_standby == PG_BOOL_YES);
 
                    if ((conn->target_server_type == SERVER_TYPE_READ_WRITE) ?
                        read_only_server : !read_only_server)
                    {
                        /* Wrong server state, reject and try the next host */
                        if (conn->target_server_type == SERVER_TYPE_READ_WRITE)
                            libpq_append_conn_error(conn, "session is read-only");
                        else
                            libpq_append_conn_error(conn, "session is not read-only");
 
                        /* Close connection politely. */
                        conn->status = CONNECTION_OK;
                        sendTerminateConn(conn);
 
                        /*
                         * Try next host if any, but we don't want to consider
                         * additional addresses for this host.
                         */
                        conn->try_next_host = true;
                        goto keep_going;
                    }
                }
                else if (conn->target_server_type == SERVER_TYPE_PRIMARY ||
                         conn->target_server_type == SERVER_TYPE_STANDBY ||
                         conn->target_server_type == SERVER_TYPE_PREFER_STANDBY)
                {
                    /*
                     * If the server didn't report "in_hot_standby" at
                     * startup, we must determine its state by sending the
                     * query "SELECT pg_catalog.pg_is_in_recovery()".  Servers
                     * before 9.0 don't have that function, but by the same
                     * token they don't have any standby mode, so we may just
                     * assume the result.
                     */
                    if (conn->sversion < 90000)
                        conn->in_hot_standby = PG_BOOL_NO;
 
                    if (conn->in_hot_standby == PG_BOOL_UNKNOWN)
                    {
                        /*
                         * We use PQsendQueryContinue so that
                         * conn->errorMessage does not get cleared.  We need
                         * to preserve any error messages related to previous
                         * hosts we have tried and failed to connect to.
                         */
                        conn->status = CONNECTION_OK;
                        if (!PQsendQueryContinue(conn,
                                                 "SELECT pg_catalog.pg_is_in_recovery()"))
                            goto error_return;
                        /* We'll return to this state when we have the answer */
                        conn->status = CONNECTION_CHECK_STANDBY;
                        return PGRES_POLLING_READING;
                    }
 
                    /* OK, we can make the test */
                    if ((conn->target_server_type == SERVER_TYPE_PRIMARY) ?
                        (conn->in_hot_standby == PG_BOOL_YES) :
                        (conn->in_hot_standby == PG_BOOL_NO))
                    {
                        /* Wrong server state, reject and try the next host */
                        if (conn->target_server_type == SERVER_TYPE_PRIMARY)
                            libpq_append_conn_error(conn, "server is in hot standby mode");
                        else
                            libpq_append_conn_error(conn, "server is not in hot standby mode");
 
                        /* Close connection politely. */
                        conn->status = CONNECTION_OK;
                        sendTerminateConn(conn);
 
                        /*
                         * Try next host if any, but we don't want to consider
                         * additional addresses for this host.
                         */
                        conn->try_next_host = true;
                        goto keep_going;
                    }
                }
 
                /*
                 * For non cancel requests we can release the address list
                 * now. For cancel requests we never actually resolve
                 * addresses and instead the addrinfo exists for the lifetime
                 * of the connection.
                 */
                if (!conn->cancelRequest)
                    release_conn_addrinfo(conn);
 
                /*
                 * Contents of conn->errorMessage are no longer interesting
                 * (and it seems some clients expect it to be empty after a
                 * successful connection).
                 */
                pqClearConnErrorState(conn);
 
                /* We are open for business! */
                conn->status = CONNECTION_OK;
                return PGRES_POLLING_OK;
            }
 
        case CONNECTION_CONSUME:
            {
                /*
                 * This state just makes sure the connection is idle after
                 * we've obtained the result of a SHOW or SELECT query.  Once
                 * we're clear, return to CONNECTION_CHECK_TARGET state to
                 * decide what to do next.  We must transiently set status =
                 * CONNECTION_OK in order to use the result-consuming
                 * subroutines.
                 */
                conn->status = CONNECTION_OK;
                if (!PQconsumeInput(conn))
                    goto error_return;
 
                if (PQisBusy(conn))
                {
                    conn->status = CONNECTION_CONSUME;
                    return PGRES_POLLING_READING;
                }
 
                /* Call PQgetResult() again until we get a NULL result */
                res = PQgetResult(conn);
                if (res != NULL)
                {
                    PQclear(res);
                    conn->status = CONNECTION_CONSUME;
                    return PGRES_POLLING_READING;
                }
 
                conn->status = CONNECTION_CHECK_TARGET;
                goto keep_going;
            }
 
        case CONNECTION_CHECK_WRITABLE:
            {
                /*
                 * Waiting for result of "SHOW transaction_read_only".  We
                 * must transiently set status = CONNECTION_OK in order to use
                 * the result-consuming subroutines.
                 */
                conn->status = CONNECTION_OK;
                if (!PQconsumeInput(conn))
                    goto error_return;
 
                if (PQisBusy(conn))
                {
                    conn->status = CONNECTION_CHECK_WRITABLE;
                    return PGRES_POLLING_READING;
                }
 
                res = PQgetResult(conn);
                if (res && PQresultStatus(res) == PGRES_TUPLES_OK &&
                    PQntuples(res) == 1)
                {
                    char       *val = PQgetvalue(res, 0, 0);
 
                    /*
                     * "transaction_read_only = on" proves that at least one
                     * of default_transaction_read_only and in_hot_standby is
                     * on, but we don't actually know which.  We don't care
                     * though for the purpose of identifying a read-only
                     * session, so satisfy the CONNECTION_CHECK_TARGET code by
                     * claiming they are both on.  On the other hand, if it's
                     * a read-write session, they are certainly both off.
                     */
                    if (strncmp(val, "on", 2) == 0)
                    {
                        conn->default_transaction_read_only = PG_BOOL_YES;
                        conn->in_hot_standby = PG_BOOL_YES;
                    }
                    else
                    {
                        conn->default_transaction_read_only = PG_BOOL_NO;
                        conn->in_hot_standby = PG_BOOL_NO;
                    }
                    PQclear(res);
 
                    /* Finish reading messages before continuing */
                    conn->status = CONNECTION_CONSUME;
                    goto keep_going;
                }
 
                /* Something went wrong with "SHOW transaction_read_only". */
                PQclear(res);
 
                /* Append error report to conn->errorMessage. */
                libpq_append_conn_error(conn, "\"%s\" failed",
                                        "SHOW transaction_read_only");
 
                /* Close connection politely. */
                conn->status = CONNECTION_OK;
                sendTerminateConn(conn);
 
                /* Try next host. */
                conn->try_next_host = true;
                goto keep_going;
            }
 
        case CONNECTION_CHECK_STANDBY:
            {
                /*
                 * Waiting for result of "SELECT pg_is_in_recovery()".  We
                 * must transiently set status = CONNECTION_OK in order to use
                 * the result-consuming subroutines.
                 */
                conn->status = CONNECTION_OK;
                if (!PQconsumeInput(conn))
                    goto error_return;
 
                if (PQisBusy(conn))
                {
                    conn->status = CONNECTION_CHECK_STANDBY;
                    return PGRES_POLLING_READING;
                }
 
                res = PQgetResult(conn);
                if (res && PQresultStatus(res) == PGRES_TUPLES_OK &&
                    PQntuples(res) == 1)
                {
                    char       *val = PQgetvalue(res, 0, 0);
 
                    if (strncmp(val, "t", 1) == 0)
                        conn->in_hot_standby = PG_BOOL_YES;
                    else
                        conn->in_hot_standby = PG_BOOL_NO;
                    PQclear(res);
 
                    /* Finish reading messages before continuing */
                    conn->status = CONNECTION_CONSUME;
                    goto keep_going;
                }
 
                /* Something went wrong with "SELECT pg_is_in_recovery()". */
                PQclear(res);
 
                /* Append error report to conn->errorMessage. */
                libpq_append_conn_error(conn, "\"%s\" failed",
                                        "SELECT pg_is_in_recovery()");
 
                /* Close connection politely. */
                conn->status = CONNECTION_OK;
                sendTerminateConn(conn);
 
                /* Try next host. */
                conn->try_next_host = true;
                goto keep_going;
            }
 
        default:
            libpq_append_conn_error(conn,
                                    "invalid connection state %d, probably indicative of memory corruption",
                                    conn->status);
            goto error_return;
    }
 
    /* Unreachable */
 
error_return:
 
    /*
     * We used to close the socket at this point, but that makes it awkward
     * for those above us if they wish to remove this socket from their own
     * records (an fd_set for example).  We'll just have this socket closed
     * when PQfinish is called (which is compulsory even after an error, since
     * the connection structure must be freed).
     */
    conn->status = CONNECTION_BAD;
    return PGRES_POLLING_FAILED;
}

References AddrInfo::addr, SockAddr::addr, pg_conn::addr, pg_conn::allowed_enc_methods, appendPQExpBufferChar(), pg_conn::appname, Assert, pg_conn::asyncStatus, AUTH_REQ_OK, pg_conn::auth_req_received, CancelRequestPacket::backendPID, pg_conn::be_key, pg_conn::be_pid, CANCEL_REQUEST_CODE, CancelRequestPacket::cancelAuthCode, pg_conn::cancelRequest, CancelRequestPacket::cancelRequestCode, CHT_HOST_ADDRESS, CHT_HOST_NAME, CHT_UNIX_SOCKET, conn, connect, connectFailureMessage(), CONNECTION_AUTH_OK, CONNECTION_AWAITING_RESPONSE, CONNECTION_BAD, CONNECTION_CHECK_STANDBY, CONNECTION_CHECK_TARGET, CONNECTION_CHECK_WRITABLE, CONNECTION_CONSUME, CONNECTION_FAILED, CONNECTION_GSS_STARTUP, CONNECTION_MADE, CONNECTION_NEEDED, CONNECTION_OK, CONNECTION_SSL_STARTUP, CONNECTION_STARTED, connectNoDelay(), pg_conn::connhost, pg_conn::connip, pg_conn::current_enc_method, PQExpBufferData::data, pg_conn::default_transaction_read_only, EINPROGRESS, EINTR, emitHostIdentityInfo(), ENC_GSSAPI, ENC_SSL, ENCRYPTION_NEGOTIATION_FAILED, EnvironmentOptions, err(), ERRCODE_APPNAME_UNKNOWN, ERRCODE_CANNOT_CONNECT_NOW, pg_conn::errorMessage, EWOULDBLOCK, pg_conn::failed_enc_methods, AddrInfo::family, pg_conn::fbappname, free, gai_strerror(), getHostaddr(), getpeereid(), pg_conn::gssencmode, pg_conn_host::host, pg_conn_host::hostaddr, i, pg_conn::in_hot_standby, pg_conn::inCursor, pg_conn::inEnd, init_allowed_encryption_methods(), pg_conn::inStart, j, pg_conn::laddr, pg_conn::last_sqlstate, PQExpBufferData::len, libpq_append_conn_error(), libpq_gettext, LOAD_BALANCE_RANDOM, pg_conn::load_balance_type, MAX_ERRLEN, MAXPGPATH, MemSet, pg_conn::naddr, pg_conn::nconnhost, NEGOTIATE_GSS_CODE, NEGOTIATE_SSL_CODE, pg_conn::Pfdebug, PG_BOOL_NO, PG_BOOL_UNKNOWN, PG_BOOL_YES, PG_DIAG_SQLSTATE, pg_fe_getusername(), pg_fe_sendauth(), pg_freeaddrinfo_all(), pg_getaddrinfo_all(), pg_GSS_have_cred_cache(), pg_hton32, pg_prng_uint64_range(), PG_PROTOCOL, pg_set_noblock(), PG_STRERROR_R_BUFLEN, PGASYNC_BUSY, PGASYNC_IDLE, PGINVALID_SOCKET, pgpassfileWarning(), PGRES_FATAL_ERROR, PGRES_POLLING_FAILED, PGRES_POLLING_OK, PGRES_POLLING_READING, PGRES_POLLING_WRITING, PGRES_TUPLES_OK, pg_conn::pipelineStatus, pg_conn_host::port, portstr, PQ_PIPELINE_OFF, pqBuildStartupPacket3(), pqCheckInBufferSpace(), PQclear(), pqClearAsyncResult(), pqClearConnErrorState, PQconsumeInput(), pqDropConnection(), pqDropServerData(), pqFlush(), pqGetc(), pqGetErrorNotice3(), pqGetInt(), pqGetNegotiateProtocolVersion3(), PQgetResult(), pqGets_append(), PQgetvalue(), PQisBusy(), PqMsg_AuthenticationRequest, PqMsg_ErrorResponse, PqMsg_NegotiateProtocolVersion, PQntuples(), pqPacketSend(), pqParseDone(), pqParseIntParam(), pqReadData(), PQresultErrorField(), PQresultStatus(), pqsecure_open_client(), pqsecure_open_gss(), PQsendQueryContinue(), pqTraceOutputCharResponse(), PQTRANS_IDLE, pg_conn::prng_state, pg_conn::pversion, pg_conn::raddr, release_conn_addrinfo(), pg_conn::requirepeer, res, pg_result::resultStatus, SockAddr::salen, pg_conn::send_appname, sendTerminateConn(), SERVER_TYPE_PREFER_STANDBY, SERVER_TYPE_PREFER_STANDBY_PASS2, SERVER_TYPE_PRIMARY, SERVER_TYPE_READ_ONLY, SERVER_TYPE_READ_WRITE, SERVER_TYPE_STANDBY, setKeepalivesCount(), setKeepalivesIdle(), setKeepalivesInterval(), setTCPUserTimeout(), pg_conn::sigpipe_flag, pg_conn::sigpipe_so, snprintf, pg_conn::sock, SOCK_ERRNO, SOCK_STRERROR, socket, pg_conn::ssl_in_use, pg_conn::sslnegotiation, pg_conn::status, STATUS_OK, store_conn_addrinfo(), strerror_r, pg_conn::sversion, pg_conn::target_server_type, pg_conn::try_next_addr, pg_conn::try_next_host, pg_conn_host::type, UNIXSOCK_PATH, UNIXSOCK_PATH_BUFLEN, useKeepalives(), val, pg_conn::whichaddr, pg_conn::whichhost, and pg_conn::xactStatus.

Referenced by libpqrcv_connect(), libpqsrv_connect_internal(), PQcancelPoll(), pqConnectDBComplete(), pqConnectDBStart(), PQresetPoll(), and wait_until_connected().

PQconnectStart()

PGconn* PQconnectStart

(

const char *

conninfo

)

Definition at line 873 of file fe-connect.c.

{
    PGconn     *conn;
 
    /*
     * Allocate memory for the conn structure.  Note that we also expect this
     * to initialize conn->errorMessage to empty.  All subsequent steps during
     * connection initialization will only append to that buffer.
     */
    conn = pqMakeEmptyPGconn();
    if (conn == NULL)
        return NULL;
 
    /*
     * Parse the conninfo string
     */
    if (!connectOptions1(conn, conninfo))
        return conn;
 
    /*
     * Compute derived options
     */
    if (!pqConnectOptions2(conn))
        return conn;
 
    /*
     * Connect to the database
     */
    if (!pqConnectDBStart(conn))
    {
        /* Just in case we failed to set it in pqConnectDBStart */
        conn->status = CONNECTION_BAD;
    }
 
    return conn;
}

References conn, CONNECTION_BAD, connectOptions1(), pqConnectDBStart(), pqConnectOptions2(), pqMakeEmptyPGconn(), and pg_conn::status.

Referenced by libpqsrv_connect(), PQconnectdb(), and PQping().

PQconnectStartParams()

PGconn* PQconnectStartParams	(	const char *const *	keywords,
		const char *const *	values,
		int	expand_dbname
	)

Definition at line 792 of file fe-connect.c.

{
    PGconn     *conn;
    PQconninfoOption *connOptions;
 
    /*
     * Allocate memory for the conn structure.  Note that we also expect this
     * to initialize conn->errorMessage to empty.  All subsequent steps during
     * connection initialization will only append to that buffer.
     */
    conn = pqMakeEmptyPGconn();
    if (conn == NULL)
        return NULL;
 
    /*
     * Parse the conninfo arrays
     */
    connOptions = conninfo_array_parse(keywords, values,
                                       &conn->errorMessage,
                                       true, expand_dbname);
    if (connOptions == NULL)
    {
        conn->status = CONNECTION_BAD;
        /* errorMessage is already set */
        return conn;
    }
 
    /*
     * Move option values into conn structure
     */
    if (!fillPGconn(conn, connOptions))
    {
        PQconninfoFree(connOptions);
        return conn;
    }
 
    /*
     * Free the option info - all is in conn now
     */
    PQconninfoFree(connOptions);
 
    /*
     * Compute derived options
     */
    if (!pqConnectOptions2(conn))
        return conn;
 
    /*
     * Connect to the database
     */
    if (!pqConnectDBStart(conn))
    {
        /* Just in case we failed to set it in pqConnectDBStart */
        conn->status = CONNECTION_BAD;
    }
 
    return conn;
}

References conn, CONNECTION_BAD, conninfo_array_parse(), pg_conn::errorMessage, fillPGconn(), pqConnectDBStart(), pqConnectOptions2(), PQconninfoFree(), pqMakeEmptyPGconn(), pg_conn::status, and values.

Referenced by do_connect(), libpqrcv_connect(), libpqsrv_connect_params(), PQconnectdbParams(), and PQpingParams().

PQconninfo()

PQconninfoOption* PQconninfo

(

PGconn *

conn

)

Definition at line 6961 of file fe-connect.c.

{
    PQExpBufferData errorBuf;
    PQconninfoOption *connOptions;
 
    if (conn == NULL)
        return NULL;
 
    /*
     * We don't actually report any errors here, but callees want a buffer,
     * and we prefer not to trash the conn's errorMessage.
     */
    initPQExpBuffer(&errorBuf);
    if (PQExpBufferDataBroken(errorBuf))
        return NULL;            /* out of memory already :-( */
 
    connOptions = conninfo_init(&errorBuf);
 
    if (connOptions != NULL)
    {
        const internalPQconni