PostgreSQL Source Code  git master
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 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_result PGresult
 
typedef struct pg_cancel PGcancel
 
typedef struct pgNotify PGnotify
 
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
}
 
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
}
 
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

PGconnPQconnectStart (const char *conninfo)
 
PGconnPQconnectStartParams (const char *const *keywords, const char *const *values, int expand_dbname)
 
PostgresPollingStatusType PQconnectPoll (PGconn *conn)
 
PGconnPQconnectdb (const char *conninfo)
 
PGconnPQconnectdbParams (const char *const *keywords, const char *const *values, int expand_dbname)
 
PGconnPQsetdbLogin (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)
 
PQconninfoOptionPQconndefaults (void)
 
PQconninfoOptionPQconninfoParse (const char *conninfo, char **errmsg)
 
PQconninfoOptionPQconninfo (PGconn *conn)
 
void PQconninfoFree (PQconninfoOption *connOptions)
 
int PQresetStart (PGconn *conn)
 
PostgresPollingStatusType PQresetPoll (PGconn *conn)
 
void PQreset (PGconn *conn)
 
PGcancelPQgetCancel (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 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 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)
 
PGresultPQexec (PGconn *conn, const char *query)
 
PGresultPQexecParams (PGconn *conn, const char *command, int nParams, const Oid *paramTypes, const char *const *paramValues, const int *paramLengths, const int *paramFormats, int resultFormat)
 
PGresultPQprepare (PGconn *conn, const char *stmtName, const char *query, int nParams, const Oid *paramTypes)
 
PGresultPQexecPrepared (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)
 
PGresultPQgetResult (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)
 
PGnotifyPQnotifies (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 *string, 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)
 
PGresultPQfn (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)
 
PGresultPQdescribePrepared (PGconn *conn, const char *stmt)
 
PGresultPQdescribePortal (PGconn *conn, const char *portal)
 
int PQsendDescribePrepared (PGconn *conn, const char *stmt)
 
int PQsendDescribePortal (PGconn *conn, const char *portal)
 
void PQclear (PGresult *res)
 
void PQfreemem (void *ptr)
 
PGresultPQmakeEmptyPGresult (PGconn *conn, ExecStatusType status)
 
PGresultPQcopyResult (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 *ps)
 
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 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)
 
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_PIPELINING

#define LIBPQ_HAS_PIPELINING   1

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

◆ LIBPQ_HAS_TRACE_FLAGS

#define LIBPQ_HAS_TRACE_FLAGS   1

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

◆ PG_COPYRES_ATTRS

#define PG_COPYRES_ATTRS   0x01

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

◆ PG_COPYRES_EVENTS

#define PG_COPYRES_EVENTS   0x04

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

◆ PG_COPYRES_NOTICEHOOKS

#define PG_COPYRES_NOTICEHOOKS   0x08

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

◆ PG_COPYRES_TUPLES

#define PG_COPYRES_TUPLES   0x02 /* Implies PG_COPYRES_ATTRS */

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

◆ PQ_QUERY_PARAM_MAX_LIMIT

#define PQ_QUERY_PARAM_MAX_LIMIT   65535

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

◆ PQfreeNotify

#define PQfreeNotify (   ptr)    PQfreemem(ptr)

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

◆ PQnoPasswordSupplied

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

Definition at line 559 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 293 of file libpq-fe.h.

◆ PQTRACE_REGRESS_MODE

#define PQTRACE_REGRESS_MODE   (1<<1)

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

◆ PQTRACE_SUPPRESS_TIMESTAMPS

#define PQTRACE_SUPPRESS_TIMESTAMPS   (1<<0)

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

Typedef Documentation

◆ PGcancel

typedef struct pg_cancel PGcancel

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 402 of file libpq-fe.h.

◆ pqbool

typedef char pqbool

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

◆ PQconninfoOption

◆ PQnoticeProcessor

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

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

◆ PQnoticeReceiver

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

Definition at line 195 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 663 of file libpq-fe.h.

Enumeration Type Documentation

◆ 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 

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

57 {
60  /* Non-blocking mode only below here */
61 
62  /*
63  * The existence of these should never be relied upon - they should only
64  * be used for user feedback or similar purposes.
65  */
66  CONNECTION_STARTED, /* Waiting for connection to be made. */
67  CONNECTION_MADE, /* Connection OK; waiting to send. */
68  CONNECTION_AWAITING_RESPONSE, /* Waiting for a response from the
69  * postmaster. */
70  CONNECTION_AUTH_OK, /* Received authentication; waiting for
71  * backend startup. */
72  CONNECTION_SETENV, /* This state is no longer used. */
73  CONNECTION_SSL_STARTUP, /* Negotiating SSL. */
74  CONNECTION_NEEDED, /* Internal state: connect() needed */
75  CONNECTION_CHECK_WRITABLE, /* Checking if session is read-write. */
76  CONNECTION_CONSUME, /* Consuming any extra messages. */
77  CONNECTION_GSS_STARTUP, /* Negotiating GSSAPI. */
78  CONNECTION_CHECK_TARGET, /* Checking target server properties. */
79  CONNECTION_CHECK_STANDBY /* Checking if server is in standby mode. */
ConnStatusType
Definition: libpq-fe.h:57
@ CONNECTION_CONSUME
Definition: libpq-fe.h:76
@ CONNECTION_CHECK_STANDBY
Definition: libpq-fe.h:79
@ CONNECTION_STARTED
Definition: libpq-fe.h:66
@ CONNECTION_AWAITING_RESPONSE
Definition: libpq-fe.h:68
@ CONNECTION_MADE
Definition: libpq-fe.h:67
@ CONNECTION_CHECK_WRITABLE
Definition: libpq-fe.h:75
@ CONNECTION_BAD
Definition: libpq-fe.h:59
@ CONNECTION_OK
Definition: libpq-fe.h:58
@ CONNECTION_GSS_STARTUP
Definition: libpq-fe.h:77
@ CONNECTION_SSL_STARTUP
Definition: libpq-fe.h:73
@ CONNECTION_AUTH_OK
Definition: libpq-fe.h:70
@ CONNECTION_CHECK_TARGET
Definition: libpq-fe.h:78
@ CONNECTION_NEEDED
Definition: libpq-fe.h:74
@ CONNECTION_SETENV
Definition: libpq-fe.h:72

◆ 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 

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

93 {
94  PGRES_EMPTY_QUERY = 0, /* empty query string was executed */
95  PGRES_COMMAND_OK, /* a query command that doesn't return
96  * anything was executed properly by the
97  * backend */
98  PGRES_TUPLES_OK, /* a query command that returns tuples was
99  * executed properly by the backend, PGresult
100  * contains the result tuples */
101  PGRES_COPY_OUT, /* Copy Out data transfer in progress */
102  PGRES_COPY_IN, /* Copy In data transfer in progress */
103  PGRES_BAD_RESPONSE, /* an unexpected response was recv'd from the
104  * backend */
105  PGRES_NONFATAL_ERROR, /* notice or warning message */
106  PGRES_FATAL_ERROR, /* query failed */
107  PGRES_COPY_BOTH, /* Copy In/Out data transfer in progress */
108  PGRES_SINGLE_TUPLE, /* single tuple from larger resultset */
109  PGRES_PIPELINE_SYNC, /* pipeline synchronization point */
110  PGRES_PIPELINE_ABORTED /* Command didn't run because of an abort
111  * earlier in a pipeline */
ExecStatusType
Definition: libpq-fe.h:93
@ PGRES_COPY_IN
Definition: libpq-fe.h:102
@ PGRES_COPY_BOTH
Definition: libpq-fe.h:107
@ PGRES_COMMAND_OK
Definition: libpq-fe.h:95
@ PGRES_FATAL_ERROR
Definition: libpq-fe.h:106
@ PGRES_SINGLE_TUPLE
Definition: libpq-fe.h:108
@ PGRES_COPY_OUT
Definition: libpq-fe.h:101
@ PGRES_EMPTY_QUERY
Definition: libpq-fe.h:94
@ PGRES_PIPELINE_SYNC
Definition: libpq-fe.h:109
@ PGRES_BAD_RESPONSE
Definition: libpq-fe.h:103
@ PGRES_PIPELINE_ABORTED
Definition: libpq-fe.h:110
@ PGRES_NONFATAL_ERROR
Definition: libpq-fe.h:105
@ PGRES_TUPLES_OK
Definition: libpq-fe.h:98

◆ PGContextVisibility

Enumerator
PQSHOW_CONTEXT_NEVER 
PQSHOW_CONTEXT_ERRORS 
PQSHOW_CONTEXT_ALWAYS 

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

132 {
133  PQSHOW_CONTEXT_NEVER, /* never show CONTEXT field */
134  PQSHOW_CONTEXT_ERRORS, /* show CONTEXT for errors only (default) */
135  PQSHOW_CONTEXT_ALWAYS /* always show CONTEXT field */
PGContextVisibility
Definition: libpq-fe.h:132
@ PQSHOW_CONTEXT_NEVER
Definition: libpq-fe.h:133
@ PQSHOW_CONTEXT_ALWAYS
Definition: libpq-fe.h:135
@ PQSHOW_CONTEXT_ERRORS
Definition: libpq-fe.h:134

◆ PGPing

enum PGPing
Enumerator
PQPING_OK 
PQPING_REJECT 
PQPING_NO_RESPONSE 
PQPING_NO_ATTEMPT 

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

144 {
145  PQPING_OK, /* server is accepting connections */
146  PQPING_REJECT, /* server is alive but rejecting connections */
147  PQPING_NO_RESPONSE, /* could not establish connection */
148  PQPING_NO_ATTEMPT /* connection not attempted (bad params) */
149 } PGPing;
PGPing
Definition: libpq-fe.h:144
@ PQPING_OK
Definition: libpq-fe.h:145
@ PQPING_REJECT
Definition: libpq-fe.h:146
@ PQPING_NO_RESPONSE
Definition: libpq-fe.h:147
@ PQPING_NO_ATTEMPT
Definition: libpq-fe.h:148

◆ PGpipelineStatus

Enumerator
PQ_PIPELINE_OFF 
PQ_PIPELINE_ON 
PQ_PIPELINE_ABORTED 

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

155 {
PGpipelineStatus
Definition: libpq-fe.h:155
@ PQ_PIPELINE_OFF
Definition: libpq-fe.h:156
@ PQ_PIPELINE_ABORTED
Definition: libpq-fe.h:158
@ PQ_PIPELINE_ON
Definition: libpq-fe.h:157

◆ PGTransactionStatusType

Enumerator
PQTRANS_IDLE 
PQTRANS_ACTIVE 
PQTRANS_INTRANS 
PQTRANS_INERROR 
PQTRANS_UNKNOWN 

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

115 {
116  PQTRANS_IDLE, /* connection idle */
117  PQTRANS_ACTIVE, /* command in progress */
118  PQTRANS_INTRANS, /* idle, within transaction block */
119  PQTRANS_INERROR, /* idle, within failed transaction */
120  PQTRANS_UNKNOWN /* cannot determine status */
PGTransactionStatusType
Definition: libpq-fe.h:115
@ PQTRANS_INTRANS
Definition: libpq-fe.h:118
@ PQTRANS_IDLE
Definition: libpq-fe.h:116
@ PQTRANS_ACTIVE
Definition: libpq-fe.h:117
@ PQTRANS_UNKNOWN
Definition: libpq-fe.h:120
@ PQTRANS_INERROR
Definition: libpq-fe.h:119

◆ PGVerbosity

Enumerator
PQERRORS_TERSE 
PQERRORS_DEFAULT 
PQERRORS_VERBOSE 
PQERRORS_SQLSTATE 

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

124 {
125  PQERRORS_TERSE, /* single-line error messages */
126  PQERRORS_DEFAULT, /* recommended style */
127  PQERRORS_VERBOSE, /* all the facts, ma'am */
128  PQERRORS_SQLSTATE /* only error severity and SQLSTATE code */
129 } PGVerbosity;
PGVerbosity
Definition: libpq-fe.h:124
@ PQERRORS_VERBOSE
Definition: libpq-fe.h:127
@ PQERRORS_DEFAULT
Definition: libpq-fe.h:126
@ PQERRORS_TERSE
Definition: libpq-fe.h:125
@ PQERRORS_SQLSTATE
Definition: libpq-fe.h:128

◆ PostgresPollingStatusType

Enumerator
PGRES_POLLING_FAILED 
PGRES_POLLING_READING 
PGRES_POLLING_WRITING 
PGRES_POLLING_OK 
PGRES_POLLING_ACTIVE 

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

83 {
85  PGRES_POLLING_READING, /* These two indicate that one may */
86  PGRES_POLLING_WRITING, /* use select before polling again. */
88  PGRES_POLLING_ACTIVE /* unused; keep for awhile for backwards
89  * compatibility */
PostgresPollingStatusType
Definition: libpq-fe.h:83
@ PGRES_POLLING_ACTIVE
Definition: libpq-fe.h:88
@ PGRES_POLLING_OK
Definition: libpq-fe.h:87
@ PGRES_POLLING_READING
Definition: libpq-fe.h:85
@ PGRES_POLLING_WRITING
Definition: libpq-fe.h:86
@ PGRES_POLLING_FAILED
Definition: libpq-fe.h:84

Function Documentation

◆ lo_close()

int lo_close ( PGconn conn,
int  fd 
)

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

97 {
98  PQArgBlock argv[1];
99  PGresult *res;
100  int retval;
101  int result_len;
102 
103  if (lo_initialize(conn) < 0)
104  return -1;
105 
106  argv[0].isint = 1;
107  argv[0].len = 4;
108  argv[0].u.integer = fd;
110  &retval, &result_len, 1, argv, 1);
112  {
113  PQclear(res);
114  return retval;
115  }
116  else
117  {
118  PQclear(res);
119  return -1;
120  }
121 }
PGresult * PQfn(PGconn *conn, int fnid, int *result_buf, int *result_len, int result_is_int, const PQArgBlock *args, int nargs)
Definition: fe-exec.c:2833
ExecStatusType PQresultStatus(const PGresult *res)
Definition: fe-exec.c:3178
void PQclear(PGresult *res)
Definition: fe-exec.c:694
static int lo_initialize(PGconn *conn)
Definition: fe-lobj.c:853
static int fd(const char *x, int i)
Definition: preproc-init.c:105
PGconn * conn
Definition: streamutil.c:54
int isint
Definition: libpq-fe.h:247
int integer
Definition: libpq-fe.h:251
union PQArgBlock::@161 u
Oid fn_lo_close
Definition: libpq-int.h:271
PGlobjfuncs * lobjfuncs
Definition: libpq-int.h:476

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 dumpBlobs(), EndRestoreBlob(), exportFile(), importFile(), lo_export(), lo_import_internal(), my_truncate(), overwrite(), and pickout().

◆ lo_creat()

Oid lo_creat ( PGconn conn,
int  mode 
)

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

445 {
446  PQArgBlock argv[1];
447  PGresult *res;
448  int retval;
449  int result_len;
450 
451  if (lo_initialize(conn) < 0)
452  return InvalidOid;
453 
454  argv[0].isint = 1;
455  argv[0].len = 4;
456  argv[0].u.integer = mode;
458  &retval, &result_len, 1, argv, 1);
460  {
461  PQclear(res);
462  return (Oid) retval;
463  }
464  else
465  {
466  PQclear(res);
467  return InvalidOid;
468  }
469 }
static PgChecksumMode mode
Definition: pg_checksums.c:65
#define InvalidOid
Definition: postgres_ext.h:36
unsigned int Oid
Definition: postgres_ext.h:31
Oid fn_lo_creat
Definition: libpq-int.h:272

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 480 of file fe-lobj.c.

481 {
482  PQArgBlock argv[1];
483  PGresult *res;
484  int retval;
485  int result_len;
486 
487  if (lo_initialize(conn) < 0)
488  return InvalidOid;
489 
490  /* Must check this on-the-fly because it's not there pre-8.1 */
491  if (conn->lobjfuncs->fn_lo_create == 0)
492  {
494  libpq_gettext("cannot determine OID of function %s\n"),
495  "lo_create");
496  return InvalidOid;
497  }
498 
499  argv[0].isint = 1;
500  argv[0].len = 4;
501  argv[0].u.integer = lobjId;
503  &retval, &result_len, 1, argv, 1);
505  {
506  PQclear(res);
507  return (Oid) retval;
508  }
509  else
510  {
511  PQclear(res);
512  return InvalidOid;
513  }
514 }
#define libpq_gettext(x)
Definition: libpq-int.h:841
void appendPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:267
Oid fn_lo_create
Definition: libpq-int.h:273
PQExpBufferData errorMessage
Definition: libpq-int.h:571

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

Referenced by lo_import_internal(), and StartRestoreBlob().

◆ lo_export()

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

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

758 {
759  int result = 1;
760  int fd;
761  int nbytes,
762  tmp;
763  char buf[LO_BUFSIZE];
764  int lobj;
765  char sebuf[PG_STRERROR_R_BUFLEN];
766 
767  /*
768  * open the large object.
769  */
770  lobj = lo_open(conn, lobjId, INV_READ);
771  if (lobj == -1)
772  {
773  /* we assume lo_open() already set a suitable error message */
774  return -1;
775  }
776 
777  /*
778  * create the file to be written to
779  */
780  fd = open(filename, O_CREAT | O_WRONLY | O_TRUNC | PG_BINARY, 0666);
781  if (fd < 0)
782  {
783  /* We must do lo_close before setting the errorMessage */
784  int save_errno = errno;
785 
786  (void) lo_close(conn, lobj);
787  /* deliberately overwrite any error from lo_close */
789  libpq_gettext("could not open file \"%s\": %s\n"),
790  filename,
791  strerror_r(save_errno, sebuf, sizeof(sebuf)));
792  return -1;
793  }
794 
795  /*
796  * read in from the large object and write to the file
797  */
798  while ((nbytes = lo_read(conn, lobj, buf, LO_BUFSIZE)) > 0)
799  {
800  tmp = write(fd, buf, nbytes);
801  if (tmp != nbytes)
802  {
803  /* We must do lo_close before setting the errorMessage */
804  int save_errno = errno;
805 
806  (void) lo_close(conn, lobj);
807  (void) close(fd);
808  /* deliberately overwrite any error from lo_close */
810  libpq_gettext("could not write to file \"%s\": %s\n"),
811  filename,
812  strerror_r(save_errno, sebuf, sizeof(sebuf)));
813  return -1;
814  }
815  }
816 
817  /*
818  * If lo_read() failed, we are now in an aborted transaction so there's no
819  * need for lo_close(); furthermore, if we tried it we'd overwrite the
820  * useful error result with a useless one. So skip lo_close() if we got a
821  * failure result.
822  */
823  if (nbytes < 0 ||
824  lo_close(conn, lobj) != 0)
825  {
826  /* assume lo_read() or lo_close() left a suitable error message */
827  result = -1;
828  }
829 
830  /* if we already failed, don't overwrite that msg with a close error */
831  if (close(fd) != 0 && result >= 0)
832  {
834  libpq_gettext("could not write to file \"%s\": %s\n"),
835  filename, strerror_r(errno, sebuf, sizeof(sebuf)));
836  result = -1;
837  }
838 
839  return result;
840 }
#define PG_BINARY
Definition: c.h:1268
int lo_close(PGconn *conn, int fd)
Definition: fe-lobj.c:96
#define LO_BUFSIZE
Definition: fe-lobj.c:42
int lo_read(PGconn *conn, int fd, char *buf, size_t len)
Definition: fe-lobj.c:248
int lo_open(PGconn *conn, Oid lobjId, int mode)
Definition: fe-lobj.c:57
#define close(a)
Definition: win32.h:12
#define write(a, b, c)
Definition: win32.h:14
#define INV_READ
Definition: libpq-fs.h:22
static char * filename
Definition: pg_dumpall.c:92
static char * buf
Definition: pg_test_fsync.c:70
#define PG_STRERROR_R_BUFLEN
Definition: port.h:243
#define strerror_r
Definition: port.h:242
void printfPQExpBuffer(PQExpBuffer str, const char *fmt,...)
Definition: pqexpbuffer.c:237

References appendPQExpBuffer(), buf, close, conn, pg_conn::errorMessage, fd(), filename, INV_READ, libpq_gettext, LO_BUFSIZE, lo_close(), lo_open(), lo_read(), PG_BINARY, PG_STRERROR_R_BUFLEN, printfPQExpBuffer(), strerror_r, and write.

Referenced by do_lo_export(), and main().

◆ lo_import()

Oid lo_import ( PGconn conn,
const char *  filename 
)

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

635 {
637 }
static Oid lo_import_internal(PGconn *conn, const char *filename, Oid oid)
Definition: fe-lobj.c:655

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 649 of file fe-lobj.c.

650 {
651  return lo_import_internal(conn, filename, lobjId);
652 }

References conn, filename, and lo_import_internal().

◆ lo_lseek()

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

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

350 {
351  PQArgBlock argv[3];
352  PGresult *res;
353  int retval;
354  int result_len;
355 
356  if (lo_initialize(conn) < 0)
357  return -1;
358 
359  argv[0].isint = 1;
360  argv[0].len = 4;
361  argv[0].u.integer = fd;
362 
363  argv[1].isint = 1;
364  argv[1].len = 4;
365  argv[1].u.integer = offset;
366 
367  argv[2].isint = 1;
368  argv[2].len = 4;
369  argv[2].u.integer = whence;
370 
372  &retval, &result_len, 1, argv, 3);
374  {
375  PQclear(res);
376  return retval;
377  }
378  else
379  {
380  PQclear(res);
381  return -1;
382  }
383 }
Oid fn_lo_lseek
Definition: libpq-int.h:275

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 390 of file fe-lobj.c.

391 {
392  PQArgBlock argv[3];
393  PGresult *res;
394  pg_int64 retval;
395  int result_len;
396 
397  if (lo_initialize(conn) < 0)
398  return -1;
399 
400  if (conn->lobjfuncs->fn_lo_lseek64 == 0)
401  {
403  libpq_gettext("cannot determine OID of function %s\n"),
404  "lo_lseek64");
405  return -1;
406  }
407 
408  argv[0].isint = 1;
409  argv[0].len = 4;
410  argv[0].u.integer = fd;
411 
412  offset = lo_hton64(offset);
413  argv[1].isint = 0;
414  argv[1].len = 8;
415  argv[1].u.ptr = (int *) &offset;
416 
417  argv[2].isint = 1;
418  argv[2].len = 4;
419  argv[2].u.integer = whence;
420 
422  (void *) &retval, &result_len, 0, argv, 3);
423  if (PQresultStatus(res) == PGRES_COMMAND_OK && result_len == 8)
424  {
425  PQclear(res);
426  return lo_ntoh64(retval);
427  }
428  else
429  {
430  PQclear(res);
431  return -1;
432  }
433 }
static pg_int64 lo_ntoh64(pg_int64 net64)
Definition: fe-lobj.c:1068
static pg_int64 lo_hton64(pg_int64 host64)
Definition: fe-lobj.c:1043
PG_INT64_TYPE pg_int64
Definition: postgres_ext.h:47
int * ptr
Definition: libpq-fe.h:250
Oid fn_lo_lseek64
Definition: libpq-int.h:276

References appendPQExpBuffer(), conn, pg_conn::errorMessage, fd(), pgLobjfuncs::fn_lo_lseek64, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, libpq_gettext, 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.

58 {
59  int fd;
60  int result_len;
61  PQArgBlock argv[2];
62  PGresult *res;
63 
64  if (lo_initialize(conn) < 0)
65  return -1;
66 
67  argv[0].isint = 1;
68  argv[0].len = 4;
69  argv[0].u.integer = lobjId;
70 
71  argv[1].isint = 1;
72  argv[1].len = 4;
73  argv[1].u.integer = mode;
74 
75  res = PQfn(conn, conn->lobjfuncs->fn_lo_open, &fd, &result_len, 1, argv, 2);
77  {
78  PQclear(res);
79  return fd;
80  }
81  else
82  {
83  PQclear(res);
84  return -1;
85  }
86 }
Oid fn_lo_open
Definition: libpq-int.h:270

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 dumpBlobs(), exportFile(), importFile(), lo_export(), lo_import_internal(), my_truncate(), overwrite(), pickout(), and StartRestoreBlob().

◆ lo_read()

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

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

249 {
250  PQArgBlock argv[2];
251  PGresult *res;
252  int result_len;
253 
254  if (lo_initialize(conn) < 0)
255  return -1;
256 
257  /*
258  * Long ago, somebody thought it'd be a good idea to declare this function
259  * as taking size_t ... but the underlying backend function only accepts a
260  * signed int32 length. So throw error if the given value overflows
261  * int32.
262  */
263  if (len > (size_t) INT_MAX)
264  {
266  libpq_gettext("argument of lo_read exceeds integer range\n"));
267  return -1;
268  }
269 
270  argv[0].isint = 1;
271  argv[0].len = 4;
272  argv[0].u.integer = fd;
273 
274  argv[1].isint = 1;
275  argv[1].len = 4;
276  argv[1].u.integer = (int) len;
277 
279  (void *) buf, &result_len, 0, argv, 2);
281  {
282  PQclear(res);
283  return result_len;
284  }
285  else
286  {
287  PQclear(res);
288  return -1;
289  }
290 }
const void size_t len
void appendPQExpBufferStr(PQExpBuffer str, const char *data)
Definition: pqexpbuffer.c:369
Oid fn_lo_read
Definition: libpq-int.h:281

References appendPQExpBufferStr(), buf, conn, pg_conn::errorMessage, fd(), pgLobjfuncs::fn_lo_read, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, len, libpq_gettext, 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 522 of file fe-lobj.c.

523 {
524  int retval;
525  PQArgBlock argv[1];
526  PGresult *res;
527  int result_len;
528 
529  if (lo_initialize(conn) < 0)
530  return -1;
531 
532  argv[0].isint = 1;
533  argv[0].len = 4;
534  argv[0].u.integer = fd;
535 
537  &retval, &result_len, 1, argv, 1);
539  {
540  PQclear(res);
541  return retval;
542  }
543  else
544  {
545  PQclear(res);
546  return -1;
547  }
548 }
Oid fn_lo_tell
Definition: libpq-int.h:277

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 555 of file fe-lobj.c.

556 {
557  pg_int64 retval;
558  PQArgBlock argv[1];
559  PGresult *res;
560  int result_len;
561 
562  if (lo_initialize(conn) < 0)
563  return -1;
564 
565  if (conn->lobjfuncs->fn_lo_tell64 == 0)
566  {
568  libpq_gettext("cannot determine OID of function %s\n"),
569  "lo_tell64");
570  return -1;
571  }
572 
573  argv[0].isint = 1;
574  argv[0].len = 4;
575  argv[0].u.integer = fd;
576 
578  (void *) &retval, &result_len, 0, argv, 1);
579  if (PQresultStatus(res) == PGRES_COMMAND_OK && result_len == 8)
580  {
581  PQclear(res);
582  return lo_ntoh64(retval);
583  }
584  else
585  {
586  PQclear(res);
587  return -1;
588  }
589 }
Oid fn_lo_tell64
Definition: libpq-int.h:278

References appendPQExpBuffer(), conn, pg_conn::errorMessage, fd(), pgLobjfuncs::fn_lo_tell64, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, libpq_gettext, 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.

132 {
133  PQArgBlock argv[2];
134  PGresult *res;
135  int retval;
136  int result_len;
137 
138  if (lo_initialize(conn) < 0)
139  return -1;
140 
141  /* Must check this on-the-fly because it's not there pre-8.3 */
142  if (conn->lobjfuncs->fn_lo_truncate == 0)
143  {
145  libpq_gettext("cannot determine OID of function %s\n"),
146  "lo_truncate");
147  return -1;
148  }
149 
150  /*
151  * Long ago, somebody thought it'd be a good idea to declare this function
152  * as taking size_t ... but the underlying backend function only accepts a
153  * signed int32 length. So throw error if the given value overflows
154  * int32. (A possible alternative is to automatically redirect the call
155  * to lo_truncate64; but if the caller wanted to rely on that backend
156  * function being available, he could have called lo_truncate64 for
157  * himself.)
158  */
159  if (len > (size_t) INT_MAX)
160  {
162  libpq_gettext("argument of lo_truncate exceeds integer range\n"));
163  return -1;
164  }
165 
166  argv[0].isint = 1;
167  argv[0].len = 4;
168  argv[0].u.integer = fd;
169 
170  argv[1].isint = 1;
171  argv[1].len = 4;
172  argv[1].u.integer = (int) len;
173 
175  &retval, &result_len, 1, argv, 2);
176 
178  {
179  PQclear(res);
180  return retval;
181  }
182  else
183  {
184  PQclear(res);
185  return -1;
186  }
187 }
Oid fn_lo_truncate
Definition: libpq-int.h:279

References appendPQExpBuffer(), appendPQExpBufferStr(), conn, pg_conn::errorMessage, fd(), pgLobjfuncs::fn_lo_truncate, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, len, libpq_gettext, 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 197 of file fe-lobj.c.

198 {
199  PQArgBlock argv[2];
200  PGresult *res;
201  int retval;
202  int result_len;
203 
204  if (lo_initialize(conn) < 0)
205  return -1;
206 
207  if (conn->lobjfuncs->fn_lo_truncate64 == 0)
208  {
210  libpq_gettext("cannot determine OID of function %s\n"),
211  "lo_truncate64");
212  return -1;
213  }
214 
215  argv[0].isint = 1;
216  argv[0].len = 4;
217  argv[0].u.integer = fd;
218 
219  len = lo_hton64(len);
220  argv[1].isint = 0;
221  argv[1].len = 8;
222  argv[1].u.ptr = (int *) &len;
223 
225  &retval, &result_len, 1, argv, 2);
226 
228  {
229  PQclear(res);
230  return retval;
231  }
232  else
233  {
234  PQclear(res);
235  return -1;
236  }
237 }
Oid fn_lo_truncate64
Definition: libpq-int.h:280

References appendPQExpBuffer(), conn, pg_conn::errorMessage, fd(), pgLobjfuncs::fn_lo_truncate64, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, len, libpq_gettext, 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 597 of file fe-lobj.c.

598 {
599  PQArgBlock argv[1];
600  PGresult *res;
601  int result_len;
602  int retval;
603 
604  if (lo_initialize(conn) < 0)
605  return -1;
606 
607  argv[0].isint = 1;
608  argv[0].len = 4;
609  argv[0].u.integer = lobjId;
610 
612  &retval, &result_len, 1, argv, 1);
614  {
615  PQclear(res);
616  return retval;
617  }
618  else
619  {
620  PQclear(res);
621  return -1;
622  }
623 }
Oid fn_lo_unlink
Definition: libpq-int.h:274

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 299 of file fe-lobj.c.

300 {
301  PQArgBlock argv[2];
302  PGresult *res;
303  int result_len;
304  int retval;
305 
306  if (lo_initialize(conn) < 0)
307  return -1;
308 
309  /*
310  * Long ago, somebody thought it'd be a good idea to declare this function
311  * as taking size_t ... but the underlying backend function only accepts a
312  * signed int32 length. So throw error if the given value overflows
313  * int32.
314  */
315  if (len > (size_t) INT_MAX)
316  {
318  libpq_gettext("argument of lo_write exceeds integer range\n"));
319  return -1;
320  }
321 
322  argv[0].isint = 1;
323  argv[0].len = 4;
324  argv[0].u.integer = fd;
325 
326  argv[1].isint = 0;
327  argv[1].len = (int) len;
328  argv[1].u.ptr = (int *) unconstify(char *, buf);
329 
331  &retval, &result_len, 1, argv, 2);
333  {
334  PQclear(res);
335  return retval;
336  }
337  else
338  {
339  PQclear(res);
340  return -1;
341  }
342 }
#define unconstify(underlying_type, expr)
Definition: c.h:1240
Oid fn_lo_write
Definition: libpq-int.h:282

References appendPQExpBufferStr(), buf, conn, pg_conn::errorMessage, fd(), pgLobjfuncs::fn_lo_write, PQArgBlock::integer, PQArgBlock::isint, PQArgBlock::len, len, libpq_gettext, 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 550 of file encnames.c.

551 {
552  unsigned int nel = lengthof(pg_encname_tbl);
553  const pg_encname *base = pg_encname_tbl,
554  *last = base + nel - 1,
555  *position;
556  int result;
557  char buff[NAMEDATALEN],
558  *key;
559 
560  if (name == NULL || *name == '\0')
561  return -1;
562 
563  if (strlen(name) >= NAMEDATALEN)
564  return -1; /* it's certainly not in the table */
565 
566  key = clean_encoding_name(name, buff);
567 
568  while (last >= base)
569  {
570  position = base + ((last - base) >> 1);
571  result = key[0] - position->name[0];
572 
573  if (result == 0)
574  {
575  result = strcmp(key, position->name);
576  if (result == 0)
577  return position->encoding;
578  }
579  if (result < 0)
580  last = position - 1;
581  else
582  base = position + 1;
583  }
584  return -1;
585 }
#define lengthof(array)
Definition: c.h:734
static const pg_encname pg_encname_tbl[]
Definition: encnames.c:39
static char * clean_encoding_name(const char *key, char *newkey)
Definition: encnames.c:525
const char * name
Definition: encode.c:561
#define NAMEDATALEN

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

Referenced by CreateConversionCommand(), length_in_encoding(), main(), PG_char_to_encoding(), pg_convert(), pg_get_utf8_id(), pg_valid_client_encoding(), pg_valid_server_encoding(), PQenv2encoding(), pqSaveParameterStatus(), ProcessCopyOptions(), processEncodingEntry(), test_enc_conversion(), and to_ascii_encname().

◆ pg_encoding_to_char()

const char* pg_encoding_to_char ( int  encoding)

◆ pg_valid_server_encoding_id()

int pg_valid_server_encoding_id ( int  encoding)

Definition at line 514 of file encnames.c.

515 {
517 }
#define PG_VALID_BE_ENCODING(_enc)
Definition: pg_wchar.h:279

References encoding, and PG_VALID_BE_ENCODING.

Referenced by setup_locale_encoding().

◆ PQbackendPID()

int PQbackendPID ( const PGconn conn)

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

6809 {
6810  if (!conn || conn->status != CONNECTION_OK)
6811  return 0;
6812  return conn->be_pid;
6813 }
int be_pid
Definition: libpq-int.h:467
ConnStatusType status
Definition: libpq-int.h:410

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

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

◆ PQbinaryTuples()

int PQbinaryTuples ( const PGresult res)

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

3265 {
3266  if (!res)
3267  return 0;
3268  return res->binary;
3269 }
int binary
Definition: libpq-int.h:180

References pg_result::binary, and res.

Referenced by ProcessResult().

◆ PQcancel()

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

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

4538 {
4539  if (!cancel)
4540  {
4541  strlcpy(errbuf, "PQcancel() -- no cancel object supplied", errbufsize);
4542  return false;
4543  }
4544 
4545  return internal_cancel(&cancel->raddr, cancel->be_pid, cancel->be_key,
4546  errbuf, errbufsize);
4547 }
static int internal_cancel(SockAddr *raddr, int be_pid, int be_key, char *errbuf, int errbufsize)
Definition: fe-connect.c:4417
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: strlcpy.c:45
SockAddr raddr
Definition: libpq-int.h:583
int be_pid
Definition: libpq-int.h:584
int be_key
Definition: libpq-int.h:585

References pg_cancel::be_key, pg_cancel::be_pid, internal_cancel(), pg_cancel::raddr, and strlcpy().

Referenced by dblink_cancel_query(), DisconnectDatabase(), disconnectDatabase(), handle_sigint(), pgfdw_cancel_query(), ShutdownWorkersHard(), sigTermHandler(), and try_complete_step().

◆ PQclear()

void PQclear ( PGresult res)

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

695 {
696  PGresult_data *block;
697  int i;
698 
699  if (!res)
700  return;
701 
702  for (i = 0; i < res->nEvents; i++)
703  {
704  /* only send DESTROY to successfully-initialized event procs */
706  {
708 
709  evt.result = res;
710  (void) res->events[i].proc(PGEVT_RESULTDESTROY, &evt,
711  res->events[i].passThrough);
712  }
713  free(res->events[i].name);
714  }
715 
716  if (res->events)
717  free(res->events);
718 
719  /* Free all the subsidiary blocks */
720  while ((block = res->curBlock) != NULL)
721  {
722  res->curBlock = block->next;
723  free(block);
724  }
725 
726  /* Free the top-level tuple pointer array */
727  if (res->tuples)
728  free(res->tuples);
729 
730  /* zero out the pointer fields to catch programming errors */
731  res->attDescs = NULL;
732  res->tuples = NULL;
733  res->paramDescs = NULL;
734  res->errFields = NULL;
735  res->events = NULL;
736  res->nEvents = 0;
737  /* res->curBlock was zeroed out earlier */
738 
739  /* Free the PGresult structure itself */
740  free(res);
741 }
#define free(a)
Definition: header.h:65
int i
Definition: isn.c:73
@ PGEVT_RESULTDESTROY
Definition: libpq-events.h:34
void * passThrough
Definition: libpq-int.h:163
char * name
Definition: libpq-int.h:162
PGEventProc proc
Definition: libpq-int.h:161
bool resultInitialized
Definition: libpq-int.h:165
int nEvents
Definition: libpq-int.h:189
PGresAttValue ** tuples
Definition: libpq-int.h:173
PGresAttDesc * attDescs
Definition: libpq-int.h:172
PGMessageField * errFields
Definition: libpq-int.h:198
PGresParamDesc * paramDescs
Definition: libpq-int.h:177
PGEvent * events
Definition: libpq-int.h:188
PGresult_data * curBlock
Definition: libpq-int.h:209
PGresult_data * next
Definition: libpq-int.h:106

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

Referenced by _check_database_version(), _doSetSessionAuth(), _selectOutputSchema(), _selectTableAccessMethod(), _selectTablespace(), add_tablespace_footer(), addFooterToPublicationDesc(), append_depends_on_extension(), appendQualifiedRelation(), BaseBackup(), binary_upgrade_set_pg_class_oids(), binary_upgrade_set_type_oids_by_type_oid(), buildMatViewRefreshDependencies(), buildShSecLabels(), check_for_data_types_usage(), check_for_isn_and_int8_passing_mismatch(), check_for_pg_role_prefix(), check_for_prepared_transactions(), check_for_tables_with_oids(), check_for_user_defined_encoding_conversions(), check_for_user_defined_postfix_ops(), check_is_install_user(), check_loadable_libraries(), check_prepare_conn(), check_proper_datallowconn(), ClearOrSaveResult(), close_cursor(), cluster_all_databases(), collectComments(), collectRoleNames(), collectSecLabels(), compile_database_list(), compile_relation_list_one_db(), ConnectDatabase(), connectDatabase(), connectToServer(), convertTSFunction(), create_cursor(), CreateReplicationSlot(), createViewAsClause(), dblink_close(), dblink_exec(), dblink_fetch(), dblink_open(), dblink_res_error(), deallocate_one(), deallocate_query(), describeAccessMethods(), describeAggregates(), describeFunctions(), describeOneTableDetails(), describeOneTSConfig(), describeOneTSParser(), describeOperators(), describePublications(), DescribeQuery(), describeRoles(), describeSubscriptions(), describeTableDetails(), describeTablespaces(), describeTypes(), descriptor_free(), do_lo_import(), do_sql_command(), dropDBs(), DropReplicationSlot(), dropRoles(), dropTablespaces(), dumpAgg(), dumpBaseType(), dumpBlobs(), dumpCollation(), dumpCompositeType(), dumpConversion(), dumpDatabase(), dumpDatabaseConfig(), dumpDatabases(), dumpDomain(), dumpEnumType(), dumpForeignServer(), dumpFunc(), dumpOpclass(), dumpOpfamily(), dumpOpr(), dumpRangeType(), dumpRoleMembership(), dumpRoles(), dumpRule(), dumpSearchPath(), dumpSequence(), dumpSequenceData(), dumpStatisticsExt(), dumpTable(), dumpTableAttach(), dumpTableData_copy(), dumpTableData_insert(), dumpTableSchema(), dumpTablespaces(), dumpTSConfig(), dumpTSDictionary(), dumpUserConfig(), dumpUserMappings(), ecpg_autostart_transaction(), ecpg_check_PQresult(), ecpg_process_output(), ECPGdescribe(), ECPGsetcommit(), ECPGtrans(), EndDBCopyMode(), exec_command_password(), ExecQueryUsingCursor(), execute_foreign_modify(), executeCommand(), executeMaintenanceCommand(), executeQueryOrDie(), ExecuteSqlCommand(), ExecuteSqlStatement(), executeStatement(), expand_dbname_patterns(), expand_extension_name_patterns(), expand_foreign_server_name_patterns(), expand_schema_name_patterns(), expand_table_name_patterns(), fail_lo_xact(), fetch_more_data(), finish_lo_xact(), get_create_object_cmd(), get_db_infos(), get_language_name(), get_loadable_libraries(), get_next_possible_free_pg_type_oid(), get_parallel_object_list(), get_rel_infos(), get_remote_estimate(), get_returning_data(), get_synchronized_snapshot(), get_tablespace_paths(), getAccessMethods(), getAdditionalACLs(), getAggregates(), getBlobs(), getCasts(), getCollations(), GetConnection(), getConstraints(), getConversions(), getCopyStart(), getDefaultACLs(), getDependencies(), getDomainConstraints(), getEventTriggers(), getExtendedStatistics(), getExtensionMembership(), getExtensions(), getForeignDataWrappers(), getForeignServers(), getFormattedTypeName(), getFuncs(), getIndexes(), getInherits(), getNamespaces(), getOpclasses(), getOperators(), getOpfamilies(), getParamDescriptions(), getPolicies(), getProcLangs(), getPublicationNamespaces(), getPublications(), getPublicationTables(), getRowDescriptions(), getRules(), GetSlotInformation(), getSubscriptions(), getTableAttrs(), GetTableInfo(), getTables(), getTransforms(), getTriggers(), getTSConfigurations(), getTSDictionaries(), getTSParsers(), getTSTemplates(), getTypes(), handleCopyIn(), HandleEndOfCopyStream(), init_libpq_conn(), initGenerateDataClientSide(), libpq_fetch_file(), libpq_traverse_files(), libpqrcv_connect(), libpqrcv_create_slot(), libpqrcv_endstreaming(), libpqrcv_exec(), libpqrcv_identify_system(), libpqrcv_PQexec(), libpqrcv_readtimelinehistoryfile(), libpqrcv_receive(), libpqrcv_startstreaming(), listAllDbs(), listCasts(), listCollations(), listConversions(), listDbRoleSettings(), listDefaultACLs(), listDomains(), listEventTriggers(), listExtendedStats(), listExtensionContents(), listExtensions(), listForeignDataWrappers(), listForeignServers(), listForeignTables(), listLanguages(), listLargeObjects(), listOneExtensionContents(), listOperatorClasses(), listOperatorFamilies(), listOpFamilyFunctions(), listOpFamilyOperators(), listPartitionedTables(), listPublications(), listSchemas(), listTables(), listTSConfigs(), listTSConfigsVerbose(), listTSDictionaries(), listTSParsers(), listTSParsersVerbose(), listTSTemplates(), listUserMappings(), lo_close(), lo_creat(), lo_create(), lo_initialize(), lo_lseek(), lo_lseek64(), lo_open(), lo_read(), lo_tell(), lo_tell64(), lo_truncate(), lo_truncate64(), lo_unlink(), lo_write(), lockTableForWorker(), lookup_object_oid(), main(), materializeResult(), objectDescription(), old_9_6_invalidate_hash_indexes(), permissionsList(), pgfdw_cancel_query(), pgfdw_exec_cleanup_query(), pgfdw_get_cleanup_result(), pgfdw_get_result(), pgfdw_report_error(), pgfdw_xact_callback(), postgresAcquireSampleRowsFunc(), postgresAnalyzeForeignTable(), postgresEndDirectModify(), postgresImportForeignSchema(), postgresReScanForeignScan(), pqClearAsyncResult(), PQconnectPoll(), PQcopyResult(), PQencryptPasswordConn(), pqEndcopy3(), PQexecFinish(), PQexecStart(), pqGetErrorNotice3(), pqInternalNotice(), PQmakeEmptyPGresult(), pqRowProcessor(), PQsetClientEncoding(), prepare_common(), prepare_foreign_modify(), process_queued_fetch_requests(), process_result(), processExtensionTables(), processQueryResult(), ProcessResult(), PSQLexecWatch(), readCommandResponse(), ReceiveCopyData(), ReceiveXlogStream(), reindex_all_databases(), report_extension_updates(), RetrieveDataDirCreatePerm(), RetrieveWalSegSize(), run_permutation(), run_simple_command(), run_simple_query(), RunIdentifySystem(), sendCommand(), SendQuery(), set_frozenxids(), setup_connection(), sql_conn(), sql_exec(), start_lo_xact(), store_returning_result(), storeQueryResult(), StreamLogicalLog(), TableCommandResultHandler(), test_multi_pipelines(), test_nosync(), test_pipeline_abort(), test_pipelined_insert(), test_prepared(), test_simple_pipeline(), test_singlerowmode(), test_transaction(), try_complete_step(), tryExecuteStatement(), vacuum_all_databases(), vacuum_one_database(), and vacuumlo().

◆ PQclientEncoding()

int PQclientEncoding ( const PGconn conn)

◆ PQcmdStatus()

char* PQcmdStatus ( PGresult res)

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

3520 {
3521  if (!res)
3522  return NULL;
3523  return res->cmdStatus;
3524 }
char cmdStatus[CMDSTATUS_LEN]
Definition: libpq-int.h:179

References pg_result::cmdStatus, and res.

Referenced by dblink_exec(), ecpg_process_output(), materializeResult(), PrintQueryResults(), PrintQueryStatus(), PSQLexecWatch(), SendQuery(), and test_pipelined_insert().

◆ PQcmdTuples()

char* PQcmdTuples ( PGresult res)

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

3590 {
3591  char *p,
3592  *c;
3593 
3594  if (!res)
3595  return "";
3596 
3597  if (strncmp(res->cmdStatus, "INSERT ", 7) == 0)
3598  {
3599  p = res->cmdStatus + 7;
3600  /* INSERT: skip oid and space */
3601  while (*p && *p != ' ')
3602  p++;
3603  if (*p == 0)
3604  goto interpret_error; /* no space? */
3605  p++;
3606  }
3607  else if (strncmp(res->cmdStatus, "SELECT ", 7) == 0 ||
3608  strncmp(res->cmdStatus, "DELETE ", 7) == 0 ||
3609  strncmp(res->cmdStatus, "UPDATE ", 7) == 0)
3610  p = res->cmdStatus + 7;
3611  else if (strncmp(res->cmdStatus, "FETCH ", 6) == 0)
3612  p = res->cmdStatus + 6;
3613  else if (strncmp(res->cmdStatus, "MOVE ", 5) == 0 ||
3614  strncmp(res->cmdStatus, "COPY ", 5) == 0)
3615  p = res->cmdStatus + 5;
3616  else
3617  return "";
3618 
3619  /* check that we have an integer (at least one digit, nothing else) */
3620  for (c = p; *c; c++)
3621  {
3622  if (!isdigit((unsigned char) *c))
3623  goto interpret_error;
3624  }
3625  if (c == p)
3626  goto interpret_error;
3627 
3628  return p;
3629 
3630 interpret_error:
3632  "could not interpret result from server: %s",
3633  res->cmdStatus);
3634  return "";
3635 }
void pqInternalNotice(const PGNoticeHooks *hooks, const char *fmt,...)
Definition: fe-exec.c:839
char * c
PGNoticeHooks noticeHooks
Definition: libpq-int.h:187

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 1472 of file fe-connect.c.

1473 {
1474  PQExpBufferData errorBuf;
1475  PQconninfoOption *connOptions;
1476 
1477  /* We don't actually report any errors here, but callees want a buffer */
1478  initPQExpBuffer(&errorBuf);
1479  if (PQExpBufferDataBroken(errorBuf))
1480  return NULL; /* out of memory already :-( */
1481 
1482  connOptions = conninfo_init(&errorBuf);
1483  if (connOptions != NULL)
1484  {
1485  /* pass NULL errorBuf to ignore errors */
1486  if (!conninfo_add_defaults(connOptions, NULL))
1487  {
1488  PQconninfoFree(connOptions);
1489  connOptions = NULL;
1490  }
1491  }
1492 
1493  termPQExpBuffer(&errorBuf);
1494  return connOptions;
1495 }
static PQconninfoOption * conninfo_init(PQExpBuffer errorMessage)
Definition: fe-connect.c:5389
static bool conninfo_add_defaults(PQconninfoOption *options, PQExpBuffer errorMessage)
Definition: fe-connect.c:5825
void PQconninfoFree(PQconninfoOption *connOptions)
Definition: fe-connect.c:6602
void initPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:92
void termPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:131
#define PQExpBufferDataBroken(buf)
Definition: pqexpbuffer.h:67

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

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

◆ PQconnectdb()

PGconn* PQconnectdb ( const char *  conninfo)

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

714 {
715  PGconn *conn = PQconnectStart(conninfo);
716 
717  if (conn && conn->status != CONNECTION_BAD)
718  (void) connectDBComplete(conn);
719 
720  return conn;
721 }
PGconn * PQconnectStart(const char *conninfo)
Definition: fe-connect.c:841
static int connectDBComplete(PGconn *conn)
Definition: fe-connect.c:2110

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

Referenced by dblink_connect(), dblink_get_conn(), get_db_conn(), and main().

◆ PQconnectdbParams()

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

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

660 {
661  PGconn *conn = PQconnectStartParams(keywords, values, expand_dbname);
662 
663  if (conn && conn->status != CONNECTION_BAD)
664  (void) connectDBComplete(conn);
665 
666  return conn;
667 
668 }
static Datum values[MAXATTR]
Definition: bootstrap.c:156
PGconn * PQconnectStartParams(const char *const *keywords, const char *const *values, int expand_dbname)
Definition: fe-connect.c:760

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

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

◆ PQconnectionNeedsPassword()

int PQconnectionNeedsPassword ( const PGconn conn)

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

6826 {
6827  char *password;
6828 
6829  if (!conn)
6830  return false;
6831  password = PQpass(conn);
6832  if (conn->password_needed &&
6833  (password == NULL || password[0] == '\0'))
6834  return true;
6835  else
6836  return false;
6837 }
char * PQpass(const PGconn *conn)
Definition: fe-connect.c:6636
static char * password
Definition: streamutil.c:53
bool password_needed
Definition: libpq-int.h:451

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

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

◆ PQconnectionUsedPassword()

int PQconnectionUsedPassword ( const PGconn conn)

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

6841 {
6842  if (!conn)
6843  return false;
6844  if (conn->password_needed)
6845  return true;
6846  else
6847  return false;
6848 }

References conn, and pg_conn::password_needed.

Referenced by connect_pg_server(), ConnectDatabase(), and dblink_security_check().

◆ PQconnectPoll()

PostgresPollingStatusType PQconnectPoll ( PGconn conn)

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

2247 {
2248  bool reset_connection_state_machine = false;
2249  bool need_new_connection = false;
2250  PGresult *res;
2251  char sebuf[PG_STRERROR_R_BUFLEN];
2252  int optval;
2253 
2254  if (conn == NULL)
2255  return PGRES_POLLING_FAILED;
2256 
2257  /* Get the new data */
2258  switch (conn->status)
2259  {
2260  /*
2261  * We really shouldn't have been polled in these two cases, but we
2262  * can handle it.
2263  */
2264  case CONNECTION_BAD:
2265  return PGRES_POLLING_FAILED;
2266  case CONNECTION_OK:
2267  return PGRES_POLLING_OK;
2268 
2269  /* These are reading states */
2271  case CONNECTION_AUTH_OK:
2273  case CONNECTION_CONSUME:
2275  {
2276  /* Load waiting data */
2277  int n = pqReadData(conn);
2278 
2279  if (n < 0)
2280  goto error_return;
2281  if (n == 0)
2282  return PGRES_POLLING_READING;
2283 
2284  break;
2285  }
2286 
2287  /* These are writing states, so we just proceed. */
2288  case CONNECTION_STARTED:
2289  case CONNECTION_MADE:
2290  break;
2291 
2292  /* Special cases: proceed without waiting. */
2294  case CONNECTION_NEEDED:
2297  break;
2298 
2299  default:
2301  libpq_gettext("invalid connection state, probably indicative of memory corruption\n"));
2302  goto error_return;
2303  }
2304 
2305 
2306 keep_going: /* We will come back to here until there is
2307  * nothing left to do. */
2308 
2309  /* Time to advance to next address, or next host if no more addresses? */
2310  if (conn->try_next_addr)
2311  {
2312  if (conn->addr_cur && conn->addr_cur->ai_next)
2313  {
2315  reset_connection_state_machine = true;
2316  }
2317  else
2318  conn->try_next_host = true;
2319  conn->try_next_addr = false;
2320  }
2321 
2322  /* Time to advance to next connhost[] entry? */
2323  if (conn->try_next_host)
2324  {
2325  pg_conn_host *ch;
2326  struct addrinfo hint;
2327  int thisport;
2328  int ret;
2329  char portstr[MAXPGPATH];
2330 
2331  if (conn->whichhost + 1 < conn->nconnhost)
2332  conn->whichhost++;
2333  else
2334  {
2335  /*
2336  * Oops, no more hosts.
2337  *
2338  * If we are trying to connect in "prefer-standby" mode, then drop
2339  * the standby requirement and start over.
2340  *
2341  * Otherwise, an appropriate error message is already set up, so
2342  * we just need to set the right status.
2343  */
2345  conn->nconnhost > 0)
2346  {
2348  conn->whichhost = 0;
2349  }
2350  else
2351  goto error_return;
2352  }
2353 
2354  /* Drop any address info for previous host */
2356 
2357  /*
2358  * Look up info for the new host. On failure, log the problem in
2359  * conn->errorMessage, then loop around to try the next host. (Note
2360  * we don't clear try_next_host until we've succeeded.)
2361  */
2362  ch = &conn->connhost[conn->whichhost];
2363 
2364  /* Initialize hint structure */
2365  MemSet(&hint, 0, sizeof(hint));
2366  hint.ai_socktype = SOCK_STREAM;
2367  conn->addrlist_family = hint.ai_family = AF_UNSPEC;
2368 
2369  /* Figure out the port number we're going to use. */
2370  if (ch->port == NULL || ch->port[0] == '\0')
2371  thisport = DEF_PGPORT;
2372  else
2373  {
2374  if (!parse_int_param(ch->port, &thisport, conn, "port"))
2375  goto error_return;
2376 
2377  if (thisport < 1 || thisport > 65535)
2378  {
2380  libpq_gettext("invalid port number: \"%s\"\n"),
2381  ch->port);
2382  goto keep_going;
2383  }
2384  }
2385  snprintf(portstr, sizeof(portstr), "%d", thisport);
2386 
2387  /* Use pg_getaddrinfo_all() to resolve the address */
2388  switch (ch->type)
2389  {
2390  case CHT_HOST_NAME:
2391  ret = pg_getaddrinfo_all(ch->host, portstr, &hint,
2392  &conn->addrlist);
2393  if (ret || !conn->addrlist)
2394  {
2396  libpq_gettext("could not translate host name \"%s\" to address: %s\n"),
2397  ch->host, gai_strerror(ret));
2398  goto keep_going;
2399  }
2400  break;
2401 
2402  case CHT_HOST_ADDRESS:
2403  hint.ai_flags = AI_NUMERICHOST;
2404  ret = pg_getaddrinfo_all(ch->hostaddr, portstr, &hint,
2405  &conn->addrlist);
2406  if (ret || !conn->addrlist)
2407  {
2409  libpq_gettext("could not parse network address \"%s\": %s\n"),
2410  ch->hostaddr, gai_strerror(ret));
2411  goto keep_going;
2412  }
2413  break;
2414 
2415  case CHT_UNIX_SOCKET:
2416 #ifdef HAVE_UNIX_SOCKETS
2417  conn->addrlist_family = hint.ai_family = AF_UNIX;
2418  UNIXSOCK_PATH(portstr, thisport, ch->host);
2419  if (strlen(portstr) >= UNIXSOCK_PATH_BUFLEN)
2420  {
2422  libpq_gettext("Unix-domain socket path \"%s\" is too long (maximum %d bytes)\n"),
2423  portstr,
2424  (int) (UNIXSOCK_PATH_BUFLEN - 1));
2425  goto keep_going;
2426  }
2427 
2428  /*
2429  * NULL hostname tells pg_getaddrinfo_all to parse the service
2430  * name as a Unix-domain socket path.
2431  */
2432  ret = pg_getaddrinfo_all(NULL, portstr, &hint,
2433  &conn->addrlist);
2434  if (ret || !conn->addrlist)
2435  {
2437  libpq_gettext("could not translate Unix-domain socket path \"%s\" to address: %s\n"),
2438  portstr, gai_strerror(ret));
2439  goto keep_going;
2440  }
2441 #else
2442  Assert(false);
2443 #endif
2444  break;
2445  }
2446 
2447  /* OK, scan this addrlist for a working server address */
2448  conn->addr_cur = conn->addrlist;
2449  reset_connection_state_machine = true;
2450  conn->try_next_host = false;
2451  }
2452 
2453  /* Reset connection state machine? */
2454  if (reset_connection_state_machine)
2455  {
2456  /*
2457  * (Re) initialize our connection control variables for a set of
2458  * connection attempts to a single server address. These variables
2459  * must persist across individual connection attempts, but we must
2460  * reset them when we start to consider a new server.
2461  */
2462  conn->pversion = PG_PROTOCOL(3, 0);
2463  conn->send_appname = true;
2464 #ifdef USE_SSL
2465  /* initialize these values based on SSL mode */
2466  conn->allow_ssl_try = (conn->sslmode[0] != 'd'); /* "disable" */
2467  conn->wait_ssl_try = (conn->sslmode[0] == 'a'); /* "allow" */
2468 #endif
2469 #ifdef ENABLE_GSS
2470  conn->try_gss = (conn->gssencmode[0] != 'd'); /* "disable" */
2471 #endif
2472 
2473  reset_connection_state_machine = false;
2474  need_new_connection = true;
2475  }
2476 
2477  /* Force a new connection (perhaps to the same server as before)? */
2478  if (need_new_connection)
2479  {
2480  /* Drop any existing connection */
2481  pqDropConnection(conn, true);
2482 
2483  /* Reset all state obtained from old server */
2485 
2486  /* Drop any PGresult we might have, too */
2491 
2492  /* Reset conn->status to put the state machine in the right state */
2494 
2495  need_new_connection = false;
2496  }
2497 
2498  /* Now try to advance the state machine for this connection */
2499  switch (conn->status)
2500  {
2501  case CONNECTION_NEEDED:
2502  {
2503  /*
2504  * Try to initiate a connection to one of the addresses
2505  * returned by pg_getaddrinfo_all(). conn->addr_cur is the
2506  * next one to try.
2507  *
2508  * The extra level of braces here is historical. It's not
2509  * worth reindenting this whole switch case to remove 'em.
2510  */
2511  {
2512  struct addrinfo *addr_cur = conn->addr_cur;
2513  char host_addr[NI_MAXHOST];
2514 
2515  /*
2516  * Advance to next possible host, if we've tried all of
2517  * the addresses for the current host.
2518  */
2519  if (addr_cur == NULL)
2520  {
2521  conn->try_next_host = true;
2522  goto keep_going;
2523  }
2524 
2525  /* Remember current address for possible use later */
2526  memcpy(&conn->raddr.addr, addr_cur->ai_addr,
2527  addr_cur->ai_addrlen);
2528  conn->raddr.salen = addr_cur->ai_addrlen;
2529 
2530  /*
2531  * Set connip, too. Note we purposely ignore strdup
2532  * failure; not a big problem if it fails.
2533  */
2534  if (conn->connip != NULL)
2535  {
2536  free(conn->connip);
2537  conn->connip = NULL;
2538  }
2539  getHostaddr(conn, host_addr, NI_MAXHOST);
2540  if (host_addr[0])
2541  conn->connip = strdup(host_addr);
2542 
2543  /* Try to create the socket */
2544  conn->sock = socket(addr_cur->ai_family, SOCK_STREAM, 0);
2545  if (conn->sock == PGINVALID_SOCKET)
2546  {
2547  int errorno = SOCK_ERRNO;
2548 
2549  /*
2550  * Silently ignore socket() failure if we have more
2551  * addresses to try; this reduces useless chatter in
2552  * cases where the address list includes both IPv4 and
2553  * IPv6 but kernel only accepts one family.
2554  */
2555  if (addr_cur->ai_next != NULL ||
2556  conn->whichhost + 1 < conn->nconnhost)
2557  {
2558  conn->try_next_addr = true;
2559  goto keep_going;
2560  }
2561  emitHostIdentityInfo(conn, host_addr);
2563  libpq_gettext("could not create socket: %s\n"),
2564  SOCK_STRERROR(errorno, sebuf, sizeof(sebuf)));
2565  goto error_return;
2566  }
2567 
2568  /*
2569  * Once we've identified a target address, all errors
2570  * except the preceding socket()-failure case should be
2571  * prefixed with host-identity information. (If the
2572  * connection succeeds, the contents of conn->errorMessage
2573  * won't matter, so this is harmless.)
2574  */
2575  emitHostIdentityInfo(conn, host_addr);
2576 
2577  /*
2578  * Select socket options: no delay of outgoing data for
2579  * TCP sockets, nonblock mode, close-on-exec. Try the
2580  * next address if any of this fails.
2581  */
2582  if (!IS_AF_UNIX(addr_cur->ai_family))
2583  {
2584  if (!connectNoDelay(conn))
2585  {
2586  /* error message already created */
2587  conn->try_next_addr = true;
2588  goto keep_going;
2589  }
2590  }
2591  if (!pg_set_noblock(conn->sock))
2592  {
2594  libpq_gettext("could not set socket to nonblocking mode: %s\n"),
2595  SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
2596  conn->try_next_addr = true;
2597  goto keep_going;
2598  }
2599 
2600 #ifdef F_SETFD
2601  if (fcntl(conn->sock, F_SETFD, FD_CLOEXEC) == -1)
2602  {
2604  libpq_gettext("could not set socket to close-on-exec mode: %s\n"),
2605  SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
2606  conn->try_next_addr = true;
2607  goto keep_going;
2608  }
2609 #endif /* F_SETFD */
2610 
2611  if (!IS_AF_UNIX(addr_cur->ai_family))
2612  {
2613 #ifndef WIN32
2614  int on = 1;
2615 #endif
2616  int usekeepalives = useKeepalives(conn);
2617  int err = 0;
2618 
2619  if (usekeepalives < 0)
2620  {
2622  libpq_gettext("keepalives parameter must be an integer\n"));
2623  err = 1;
2624  }
2625  else if (usekeepalives == 0)
2626  {
2627  /* Do nothing */
2628  }
2629 #ifndef WIN32
2630  else if (setsockopt(conn->sock,
2631  SOL_SOCKET, SO_KEEPALIVE,
2632  (char *) &on, sizeof(on)) < 0)
2633  {
2635  libpq_gettext("%s(%s) failed: %s\n"),
2636  "setsockopt",
2637  "SO_KEEPALIVE",
2638  SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
2639  err = 1;
2640  }
2641  else if (!setKeepalivesIdle(conn)
2643  || !setKeepalivesCount(conn))
2644  err = 1;
2645 #else /* WIN32 */
2646 #ifdef SIO_KEEPALIVE_VALS
2647  else if (!setKeepalivesWin32(conn))
2648  err = 1;
2649 #endif /* SIO_KEEPALIVE_VALS */
2650 #endif /* WIN32 */
2651  else if (!setTCPUserTimeout(conn))
2652  err = 1;
2653 
2654  if (err)
2655  {
2656  conn->try_next_addr = true;
2657  goto keep_going;
2658  }
2659  }
2660 
2661  /*----------
2662  * We have three methods of blocking SIGPIPE during
2663  * send() calls to this socket:
2664  *
2665  * - setsockopt(sock, SO_NOSIGPIPE)
2666  * - send(sock, ..., MSG_NOSIGNAL)
2667  * - setting the signal mask to SIG_IGN during send()
2668  *
2669  * The third method requires three syscalls per send,
2670  * so we prefer either of the first two, but they are
2671  * less portable. The state is tracked in the following
2672  * members of PGconn:
2673  *
2674  * conn->sigpipe_so - we have set up SO_NOSIGPIPE
2675  * conn->sigpipe_flag - we're specifying MSG_NOSIGNAL
2676  *
2677  * If we can use SO_NOSIGPIPE, then set sigpipe_so here
2678  * and we're done. Otherwise, set sigpipe_flag so that
2679  * we will try MSG_NOSIGNAL on sends. If we get an error
2680  * with MSG_NOSIGNAL, we'll clear that flag and revert to
2681  * signal masking.
2682  *----------
2683  */
2684  conn->sigpipe_so = false;
2685 #ifdef MSG_NOSIGNAL
2686  conn->sigpipe_flag = true;
2687 #else
2688  conn->sigpipe_flag = false;
2689 #endif /* MSG_NOSIGNAL */
2690 
2691 #ifdef SO_NOSIGPIPE
2692  optval = 1;
2693  if (setsockopt(conn->sock, SOL_SOCKET, SO_NOSIGPIPE,
2694  (char *) &optval, sizeof(optval)) == 0)
2695  {
2696  conn->sigpipe_so = true;
2697  conn->sigpipe_flag = false;
2698  }
2699 #endif /* SO_NOSIGPIPE */
2700 
2701  /*
2702  * Start/make connection. This should not block, since we
2703  * are in nonblock mode. If it does, well, too bad.
2704  */
2705  if (connect(conn->sock, addr_cur->ai_addr,
2706  addr_cur->ai_addrlen) < 0)
2707  {
2708  if (SOCK_ERRNO == EINPROGRESS ||
2709 #ifdef WIN32
2710  SOCK_ERRNO == EWOULDBLOCK ||
2711 #endif
2712  SOCK_ERRNO == EINTR)
2713  {
2714  /*
2715  * This is fine - we're in non-blocking mode, and
2716  * the connection is in progress. Tell caller to
2717  * wait for write-ready on socket.
2718  */
2720  return PGRES_POLLING_WRITING;
2721  }
2722  /* otherwise, trouble */
2723  }
2724  else
2725  {
2726  /*
2727  * Hm, we're connected already --- seems the "nonblock
2728  * connection" wasn't. Advance the state machine and
2729  * go do the next stuff.
2730  */
2732  goto keep_going;
2733  }
2734 
2735  /*
2736  * This connection failed. Add the error report to
2737  * conn->errorMessage, then try the next address if any.
2738  */
2740  conn->try_next_addr = true;
2741  goto keep_going;
2742  }
2743  }
2744 
2745  case CONNECTION_STARTED:
2746  {
2747  socklen_t optlen = sizeof(optval);
2748 
2749  /*
2750  * Write ready, since we've made it here, so the connection
2751  * has been made ... or has failed.
2752  */
2753 
2754  /*
2755  * Now check (using getsockopt) that there is not an error
2756  * state waiting for us on the socket.
2757  */
2758 
2759  if (getsockopt(conn->sock, SOL_SOCKET, SO_ERROR,
2760  (char *) &optval, &optlen) == -1)
2761  {
2763  libpq_gettext("could not get socket error status: %s\n"),
2764  SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
2765  goto error_return;
2766  }
2767  else if (optval != 0)
2768  {
2769  /*
2770  * When using a nonblocking connect, we will typically see
2771  * connect failures at this point, so provide a friendly
2772  * error message.
2773  */
2774  connectFailureMessage(conn, optval);
2775 
2776  /*
2777  * Try the next address if any, just as in the case where
2778  * connect() returned failure immediately.
2779  */
2780  conn->try_next_addr = true;
2781  goto keep_going;
2782  }
2783 
2784  /* Fill in the client address */
2785  conn->laddr.salen = sizeof(conn->laddr.addr);
2786  if (getsockname(conn->sock,
2787  (struct sockaddr *) &conn->laddr.addr,
2788  &conn->laddr.salen) < 0)
2789  {
2791  libpq_gettext("could not get client address from socket: %s\n"),
2792  SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
2793  goto error_return;
2794  }
2795 
2796  /*
2797  * Make sure we can write before advancing to next step.
2798  */
2800  return PGRES_POLLING_WRITING;
2801  }
2802 
2803  case CONNECTION_MADE:
2804  {
2805  char *startpacket;
2806  int packetlen;
2807 
2808  /*
2809  * Implement requirepeer check, if requested and it's a
2810  * Unix-domain socket.
2811  */
2812  if (conn->requirepeer && conn->requirepeer[0] &&
2813  IS_AF_UNIX(conn->raddr.addr.ss_family))
2814  {
2815 #ifndef WIN32
2816  char *remote_username;
2817 #endif
2818  uid_t uid;
2819  gid_t gid;
2820 
2821  errno = 0;
2822  if (getpeereid(conn->sock, &uid, &gid) != 0)
2823  {
2824  /*
2825  * Provide special error message if getpeereid is a
2826  * stub
2827  */
2828  if (errno == ENOSYS)
2830  libpq_gettext("requirepeer parameter is not supported on this platform\n"));
2831  else
2833  libpq_gettext("could not get peer credentials: %s\n"),
2834  strerror_r(errno, sebuf, sizeof(sebuf)));
2835  goto error_return;
2836  }
2837 
2838 #ifndef WIN32
2839  remote_username = pg_fe_getusername(uid,
2840  &conn->errorMessage);
2841  if (remote_username == NULL)
2842  goto error_return; /* message already logged */
2843 
2844  if (strcmp(remote_username, conn->requirepeer) != 0)
2845  {
2847  libpq_gettext("requirepeer specifies \"%s\", but actual peer user name is \"%s\"\n"),
2848  conn->requirepeer, remote_username);
2849  free(remote_username);
2850  goto error_return;
2851  }
2852  free(remote_username);
2853 #else /* WIN32 */
2854  /* should have failed with ENOSYS above */
2855  Assert(false);
2856 #endif /* WIN32 */
2857  }
2858 
2859  if (IS_AF_UNIX(conn->raddr.addr.ss_family))
2860  {
2861  /* Don't request SSL or GSSAPI over Unix sockets */
2862 #ifdef USE_SSL
2863  conn->allow_ssl_try = false;
2864 #endif
2865 #ifdef ENABLE_GSS
2866  conn->try_gss = false;
2867 #endif
2868  }
2869 
2870 #ifdef ENABLE_GSS
2871 
2872  /*
2873  * If GSSAPI encryption is enabled, then call
2874  * pg_GSS_have_cred_cache() which will return true if we can
2875  * acquire credentials (and give us a handle to use in
2876  * conn->gcred), and then send a packet to the server asking
2877  * for GSSAPI Encryption (and skip past SSL negotiation and
2878  * regular startup below).
2879  */
2880  if (conn->try_gss && !conn->gctx)
2881  conn->try_gss = pg_GSS_have_cred_cache(&conn->gcred);
2882  if (conn->try_gss && !conn->gctx)
2883  {
2885 
2886  if (pqPacketSend(conn, 0, &pv, sizeof(pv)) != STATUS_OK)
2887  {
2889  libpq_gettext("could not send GSSAPI negotiation packet: %s\n"),
2890  SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
2891  goto error_return;
2892  }
2893 
2894  /* Ok, wait for response */
2896  return PGRES_POLLING_READING;
2897  }
2898  else if (!conn->gctx && conn->gssencmode[0] == 'r')
2899  {
2901  libpq_gettext("GSSAPI encryption required but was impossible (possibly no credential cache, no server support, or using a local socket)\n"));
2902  goto error_return;
2903  }
2904 #endif
2905 
2906 #ifdef USE_SSL
2907 
2908  /*
2909  * Enable the libcrypto callbacks before checking if SSL needs
2910  * to be done. This is done before sending the startup packet
2911  * as depending on the type of authentication done, like MD5
2912  * or SCRAM that use cryptohashes, the callbacks would be
2913  * required even without a SSL connection
2914  */
2915  if (pqsecure_initialize(conn, false, true) < 0)
2916  goto error_return;
2917 
2918  /*
2919  * If SSL is enabled and we haven't already got encryption of
2920  * some sort running, request SSL instead of sending the
2921  * startup message.
2922  */
2923  if (conn->allow_ssl_try && !conn->wait_ssl_try &&
2924  !conn->ssl_in_use
2925 #ifdef ENABLE_GSS
2926  && !conn->gssenc
2927 #endif
2928  )
2929  {
2930  ProtocolVersion pv;
2931 
2932  /*
2933  * Send the SSL request packet.
2934  *
2935  * Theoretically, this could block, but it really
2936  * shouldn't since we only got here if the socket is
2937  * write-ready.
2938  */
2940  if (pqPacketSend(conn, 0, &pv, sizeof(pv)) != STATUS_OK)
2941  {
2943  libpq_gettext("could not send SSL negotiation packet: %s\n"),
2944  SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
2945  goto error_return;
2946  }
2947  /* Ok, wait for response */
2949  return PGRES_POLLING_READING;
2950  }
2951 #endif /* USE_SSL */
2952 
2953  /*
2954  * Build the startup packet.
2955  */
2956  startpacket = pqBuildStartupPacket3(conn, &packetlen,
2958  if (!startpacket)
2959  {
2961  libpq_gettext("out of memory\n"));
2962  goto error_return;
2963  }
2964 
2965  /*
2966  * Send the startup packet.
2967  *
2968  * Theoretically, this could block, but it really shouldn't
2969  * since we only got here if the socket is write-ready.
2970  */
2971  if (pqPacketSend(conn, 0, startpacket, packetlen) != STATUS_OK)
2972  {
2974  libpq_gettext("could not send startup packet: %s\n"),
2975  SOCK_STRERROR(SOCK_ERRNO, sebuf, sizeof(sebuf)));
2976  free(startpacket);
2977  goto error_return;
2978  }
2979 
2980  free(startpacket);
2981 
2983  return PGRES_POLLING_READING;
2984  }
2985 
2986  /*
2987  * Handle SSL negotiation: wait for postmaster messages and
2988  * respond as necessary.
2989  */
2991  {
2992 #ifdef USE_SSL
2993  PostgresPollingStatusType pollres;
2994 
2995  /*
2996  * On first time through, get the postmaster's response to our
2997  * SSL negotiation packet.
2998  */
2999  if (!conn->ssl_in_use)
3000  {
3001  /*
3002  * We use pqReadData here since it has the logic to
3003  * distinguish no-data-yet from connection closure. Since
3004  * conn->ssl isn't set, a plain recv() will occur.
3005  */
3006  char SSLok;
3007  int rdresult;
3008 
3009  rdresult = pqReadData(conn);
3010  if (rdresult < 0)
3011  {
3012  /* errorMessage is already filled in */
3013  goto error_return;
3014  }
3015  if (rdresult == 0)
3016  {
3017  /* caller failed to wait for data */
3018  return PGRES_POLLING_READING;
3019  }
3020  if (pqGetc(&SSLok, conn) < 0)
3021  {
3022  /* should not happen really */
3023  return PGRES_POLLING_READING;
3024  }
3025  if (SSLok == 'S')
3026  {
3027  /* mark byte consumed */
3028  conn->inStart = conn->inCursor;
3029 
3030  /*
3031  * Set up global SSL state if required. The crypto
3032  * state has already been set if libpq took care of
3033  * doing that, so there is no need to make that happen
3034  * again.
3035  */
3036  if (pqsecure_initialize(conn, true, false) != 0)
3037  goto error_return;
3038  }
3039  else if (SSLok == 'N')
3040  {
3041  /* mark byte consumed */
3042  conn->inStart = conn->inCursor;
3043  /* OK to do without SSL? */
3044  if (conn->sslmode[0] == 'r' || /* "require" */
3045  conn->sslmode[0] == 'v') /* "verify-ca" or
3046  * "verify-full" */
3047  {
3048  /* Require SSL, but server does not want it */
3050  libpq_gettext("server does not support SSL, but SSL was required\n"));
3051  goto error_return;
3052  }
3053  /* Otherwise, proceed with normal startup */
3054  conn->allow_ssl_try = false;
3055  /* We can proceed using this connection */
3057  return PGRES_POLLING_WRITING;
3058  }
3059  else if (SSLok == 'E')
3060  {
3061  /*
3062  * Server failure of some sort, such as failure to
3063  * fork a backend process. We need to process and
3064  * report the error message, which might be formatted
3065  * according to either protocol 2 or protocol 3.
3066  * Rather than duplicate the code for that, we flip
3067  * into AWAITING_RESPONSE state and let the code there
3068  * deal with it. Note we have *not* consumed the "E"
3069  * byte here.
3070  */
3072  goto keep_going;
3073  }
3074  else
3075  {
3077  libpq_gettext("received invalid response to SSL negotiation: %c\n"),
3078  SSLok);
3079  goto error_return;
3080  }
3081  }
3082 
3083  /*
3084  * Begin or continue the SSL negotiation process.
3085  */
3086  pollres = pqsecure_open_client(conn);
3087  if (pollres == PGRES_POLLING_OK)
3088  {
3089  /*
3090  * At this point we should have no data already buffered.
3091  * If we do, it was received before we performed the SSL
3092  * handshake, so it wasn't encrypted and indeed may have
3093  * been injected by a man-in-the-middle.
3094  */
3095  if (conn->inCursor != conn->inEnd)
3096  {
3098  libpq_gettext("received unencrypted data after SSL response\n"));
3099  goto error_return;
3100  }
3101 
3102  /* SSL handshake done, ready to send startup packet */
3104  return PGRES_POLLING_WRITING;
3105  }
3106  if (pollres == PGRES_POLLING_FAILED)
3107  {
3108  /*
3109  * Failed ... if sslmode is "prefer" then do a non-SSL
3110  * retry
3111  */
3112  if (conn->sslmode[0] == 'p' /* "prefer" */
3113  && conn->allow_ssl_try /* redundant? */
3114  && !conn->wait_ssl_try) /* redundant? */
3115  {
3116  /* only retry once */
3117  conn->allow_ssl_try = false;
3118  need_new_connection = true;
3119  goto keep_going;
3120  }
3121  /* Else it's a hard failure */
3122  goto error_return;
3123  }
3124  /* Else, return POLLING_READING or POLLING_WRITING status */
3125  return pollres;
3126 #else /* !USE_SSL */
3127  /* can't get here */
3128  goto error_return;
3129 #endif /* USE_SSL */
3130  }
3131 
3133  {
3134 #ifdef ENABLE_GSS
3135  PostgresPollingStatusType pollres;
3136 
3137  /*
3138  * If we haven't yet, get the postmaster's response to our
3139  * negotiation packet
3140  */
3141  if (conn->try_gss && !conn->gctx)
3142  {
3143  char gss_ok;
3144  int rdresult = pqReadData(conn);
3145 
3146  if (rdresult < 0)
3147  /* pqReadData fills in error message */
3148  goto error_return;
3149  else if (rdresult == 0)
3150  /* caller failed to wait for data */
3151  return PGRES_POLLING_READING;
3152  if (pqGetc(&gss_ok, conn) < 0)
3153  /* shouldn't happen... */
3154  return PGRES_POLLING_READING;
3155 
3156  if (gss_ok == 'E')
3157  {
3158  /*
3159  * Server failure of some sort. Assume it's a
3160  * protocol version support failure, and let's see if
3161  * we can't recover (if it's not, we'll get a better
3162  * error message on retry). Server gets fussy if we
3163  * don't hang up the socket, though.
3164  */
3165  conn->try_gss = false;
3166  need_new_connection = true;
3167  goto keep_going;
3168  }
3169 
3170  /* mark byte consumed */
3171  conn->inStart = conn->inCursor;
3172 
3173  if (gss_ok == 'N')
3174  {
3175  /* Server doesn't want GSSAPI; fall back if we can */
3176  if (conn->gssencmode[0] == 'r')
3177  {
3179  libpq_gettext("server doesn't support GSSAPI encryption, but it was required\n"));
3180  goto error_return;
3181  }
3182 
3183  conn->try_gss = false;
3184  /* We can proceed using this connection */
3186  return PGRES_POLLING_WRITING;
3187  }
3188  else if (gss_ok != 'G')
3189  {
3191  libpq_gettext("received invalid response to GSSAPI negotiation: %c\n"),
3192  gss_ok);
3193  goto error_return;
3194  }
3195  }
3196 
3197  /* Begin or continue GSSAPI negotiation */
3198  pollres = pqsecure_open_gss(conn);
3199  if (pollres == PGRES_POLLING_OK)
3200  {
3201  /*
3202  * At this point we should have no data already buffered.
3203  * If we do, it was received before we performed the GSS
3204  * handshake, so it wasn't encrypted and indeed may have
3205  * been injected by a man-in-the-middle.
3206  */
3207  if (conn->inCursor != conn->inEnd)
3208  {
3210  libpq_gettext("received unencrypted data after GSSAPI encryption response\n"));
3211  goto error_return;
3212  }
3213 
3214  /* All set for startup packet */
3216  return PGRES_POLLING_WRITING;
3217  }
3218  else if (pollres == PGRES_POLLING_FAILED &&
3219  conn->gssencmode[0] == 'p')
3220  {
3221  /*
3222  * We failed, but we can retry on "prefer". Have to drop
3223  * the current connection to do so, though.
3224  */
3225  conn->try_gss = false;
3226  need_new_connection = true;
3227  goto keep_going;
3228  }
3229  return pollres;
3230 #else /* !ENABLE_GSS */
3231  /* unreachable */
3232  goto error_return;
3233 #endif /* ENABLE_GSS */
3234  }
3235 
3236  /*
3237  * Handle authentication exchange: wait for postmaster messages
3238  * and respond as necessary.
3239  */
3241  {
3242  char beresp;
3243  int msgLength;
3244  int avail;
3245  AuthRequest areq;
3246  int res;
3247 
3248  /*
3249  * Scan the message from current point (note that if we find
3250  * the message is incomplete, we will return without advancing
3251  * inStart, and resume here next time).
3252  */
3253  conn->inCursor = conn->inStart;
3254 
3255  /* Read type byte */
3256  if (pqGetc(&beresp, conn))
3257  {
3258  /* We'll come back when there is more data */
3259  return PGRES_POLLING_READING;
3260  }
3261 
3262  /*
3263  * Validate message type: we expect only an authentication
3264  * request or an error here. Anything else probably means
3265  * it's not Postgres on the other end at all.
3266  */
3267  if (!(beresp == 'R' || beresp == 'E'))
3268  {
3270  libpq_gettext("expected authentication request from server, but received %c\n"),
3271  beresp);
3272  goto error_return;
3273  }
3274 
3275  /* Read message length word */
3276  if (pqGetInt(&msgLength, 4, conn))
3277  {
3278  /* We'll come back when there is more data */
3279  return PGRES_POLLING_READING;
3280  }
3281 
3282  /*
3283  * Try to validate message length before using it.
3284  * Authentication requests can't be very large, although GSS
3285  * auth requests may not be that small. Errors can be a
3286  * little larger, but not huge. If we see a large apparent
3287  * length in an error, it means we're really talking to a
3288  * pre-3.0-protocol server; cope. (Before version 14, the
3289  * server also used the old protocol for errors that happened
3290  * before processing the startup packet.)
3291  */
3292  if (beresp == 'R' && (msgLength < 8 || msgLength > 2000))
3293  {
3295  libpq_gettext("expected authentication request from server, but received %c\n"),
3296  beresp);
3297  goto error_return;
3298  }
3299 
3300  if (beresp == 'E' && (msgLength < 8 || msgLength > 30000))
3301  {
3302  /* Handle error from a pre-3.0 server */
3303  conn->inCursor = conn->inStart + 1; /* reread data */
3305  {
3306  /* We'll come back when there is more data */
3307  return PGRES_POLLING_READING;
3308  }
3309  /* OK, we read the message; mark data consumed */
3310  conn->inStart = conn->inCursor;
3311 
3312  /*
3313  * Before 7.2, the postmaster didn't always end its
3314  * messages with a newline, so add one if needed to
3315  * conform to libpq conventions.
3316  */
3317  if (conn->errorMessage.len == 0 ||
3318  conn->errorMessage.data[conn->errorMessage.len - 1] != '\n')
3319  {
3321  }
3322 
3323  goto error_return;
3324  }
3325 
3326  /*
3327  * Can't process if message body isn't all here yet.
3328  */
3329  msgLength -= 4;
3330  avail = conn->inEnd - conn->inCursor;
3331  if (avail < msgLength)
3332  {
3333  /*
3334  * Before returning, try to enlarge the input buffer if
3335  * needed to hold the whole message; see notes in
3336  * pqParseInput3.
3337  */
3338  if (pqCheckInBufferSpace(conn->inCursor + (size_t) msgLength,
3339  conn))
3340  goto error_return;
3341  /* We'll come back when there is more data */
3342  return PGRES_POLLING_READING;
3343  }
3344 
3345  /* Handle errors. */
3346  if (beresp == 'E')
3347  {
3348  if (pqGetErrorNotice3(conn, true))
3349  {
3350  /* We'll come back when there is more data */
3351  return PGRES_POLLING_READING;
3352  }
3353  /* OK, we read the message; mark data consumed */
3354  conn->inStart = conn->inCursor;
3355 
3356  /*
3357  * If error is "cannot connect now", try the next host if
3358  * any (but we don't want to consider additional addresses
3359  * for this host, nor is there much point in changing SSL
3360  * or GSS mode). This is helpful when dealing with
3361  * standby servers that might not be in hot-standby state.
3362  */
3363  if (strcmp(conn->last_sqlstate,
3365  {
3366  conn->try_next_host = true;
3367  goto keep_going;
3368  }
3369 
3370  /* Check to see if we should mention pgpassfile */
3372 
3373 #ifdef ENABLE_GSS
3374 
3375  /*
3376  * If gssencmode is "prefer" and we're using GSSAPI, retry
3377  * without it.
3378  */
3379  if (conn->gssenc && conn->gssencmode[0] == 'p')
3380  {
3381  /* only retry once */
3382  conn->try_gss = false;
3383  need_new_connection = true;
3384  goto keep_going;
3385  }
3386 #endif
3387 
3388 #ifdef USE_SSL
3389 
3390  /*
3391  * if sslmode is "allow" and we haven't tried an SSL
3392  * connection already, then retry with an SSL connection
3393  */
3394  if (conn->sslmode[0] == 'a' /* "allow" */
3395  && !conn->ssl_in_use
3396  && conn->allow_ssl_try
3397  && conn->wait_ssl_try)
3398  {
3399  /* only retry once */
3400  conn->wait_ssl_try = false;
3401  need_new_connection = true;
3402  goto keep_going;
3403  }
3404 
3405  /*
3406  * if sslmode is "prefer" and we're in an SSL connection,
3407  * then do a non-SSL retry
3408  */
3409  if (conn->sslmode[0] == 'p' /* "prefer" */
3410  && conn->ssl_in_use
3411  && conn->allow_ssl_try /* redundant? */
3412  && !conn->wait_ssl_try) /* redundant? */
3413  {
3414  /* only retry once */
3415  conn->allow_ssl_try = false;
3416  need_new_connection = true;
3417  goto keep_going;
3418  }
3419 #endif
3420 
3421  goto error_return;
3422  }
3423 
3424  /* It is an authentication request. */
3425  conn->auth_req_received = true;
3426 
3427  /* Get the type of request. */
3428  if (pqGetInt((int *) &areq, 4, conn))
3429  {
3430  /* We'll come back when there are more data */
3431  return PGRES_POLLING_READING;
3432  }
3433  msgLength -= 4;
3434 
3435  /*
3436  * Process the rest of the authentication request message, and
3437  * respond to it if necessary.
3438  *
3439  * Note that conn->pghost must be non-NULL if we are going to
3440  * avoid the Kerberos code doing a hostname look-up.
3441  */
3442  res = pg_fe_sendauth(areq, msgLength, conn);
3443 
3444  /* OK, we have processed the message; mark data consumed */
3445  conn->inStart = conn->inCursor;
3446 
3447  if (res != STATUS_OK)
3448  goto error_return;
3449 
3450  /*
3451  * Just make sure that any data sent by pg_fe_sendauth is
3452  * flushed out. Although this theoretically could block, it
3453  * really shouldn't since we don't send large auth responses.
3454  */
3455  if (pqFlush(conn))
3456  goto error_return;
3457 
3458  if (areq == AUTH_REQ_OK)
3459  {
3460  /* We are done with authentication exchange */
3462 
3463  /*
3464  * Set asyncStatus so that PQgetResult will think that
3465  * what comes back next is the result of a query. See
3466  * below.
3467  */
3469  }
3470 
3471  /* Look to see if we have more data yet. */
3472  goto keep_going;
3473  }
3474 
3475  case CONNECTION_AUTH_OK:
3476  {
3477  /*
3478  * Now we expect to hear from the backend. A ReadyForQuery
3479  * message indicates that startup is successful, but we might
3480  * also get an Error message indicating failure. (Notice
3481  * messages indicating nonfatal warnings are also allowed by
3482  * the protocol, as are ParameterStatus and BackendKeyData
3483  * messages.) Easiest way to handle this is to let
3484  * PQgetResult() read the messages. We just have to fake it
3485  * out about the state of the connection, by setting
3486  * asyncStatus = PGASYNC_BUSY (done above).
3487  */
3488 
3489  if (PQisBusy(conn))
3490  return PGRES_POLLING_READING;
3491 
3492  res = PQgetResult(conn);
3493 
3494  /*
3495  * NULL return indicating we have gone to IDLE state is
3496  * expected
3497  */
3498  if (res)
3499  {
3502  libpq_gettext("unexpected message from server during startup\n"));
3503  else if (conn->send_appname &&
3504  (conn->appname || conn->fbappname))
3505  {
3506  /*
3507  * If we tried to send application_name, check to see
3508  * if the error is about that --- pre-9.0 servers will
3509  * reject it at this stage of the process. If so,
3510  * close the connection and retry without sending
3511  * application_name. We could possibly get a false
3512  * SQLSTATE match here and retry uselessly, but there
3513  * seems no great harm in that; we'll just get the
3514  * same error again if it's unrelated.
3515  */
3516  const char *sqlstate;
3517 
3519  if (sqlstate &&
3520  strcmp(sqlstate, ERRCODE_APPNAME_UNKNOWN) == 0)
3521  {
3522  PQclear(res);
3523  conn->send_appname = false;
3524  need_new_connection = true;
3525  goto keep_going;
3526  }
3527  }
3528 
3529  /*
3530  * if the resultStatus is FATAL, then conn->errorMessage
3531  * already has a copy of the error; needn't copy it back.
3532  * But add a newline if it's not there already, since
3533  * postmaster error messages may not have one.
3534  */
3535  if (conn->errorMessage.len <= 0 ||
3536  conn->errorMessage.data[conn->errorMessage.len - 1] != '\n')
3538  PQclear(res);
3539  goto error_return;
3540  }
3541 
3542  /* Almost there now ... */
3544  goto keep_going;
3545  }
3546 
3548  {
3549  /*
3550  * If a read-write, read-only, primary, or standby connection
3551  * is required, see if we have one.
3552  */
3555  {
3556  bool read_only_server;
3557 
3558  /*
3559  * If the server didn't report
3560  * "default_transaction_read_only" or "in_hot_standby" at
3561  * startup, we must determine its state by sending the
3562  * query "SHOW transaction_read_only". This GUC exists in
3563  * all server versions that support 3.0 protocol.
3564  */
3567  {
3568  /*
3569  * We use PQsendQueryContinue so that
3570  * conn->errorMessage does not get cleared. We need
3571  * to preserve any error messages related to previous
3572  * hosts we have tried and failed to connect to.
3573  */
3576  "SHOW transaction_read_only"))
3577  goto error_return;
3578  /* We'll return to this state when we have the answer */
3580  return PGRES_POLLING_READING;
3581  }
3582 
3583  /* OK, we can make the test */
3584  read_only_server =
3587 
3589  read_only_server : !read_only_server)
3590  {
3591  /* Wrong server state, reject and try the next host */
3594  libpq_gettext("session is read-only\n"));
3595  else
3597  libpq_gettext("session is not read-only\n"));
3598 
3599  /* Close connection politely. */
3602 
3603  /*
3604  * Try next host if any, but we don't want to consider
3605  * additional addresses for this host.
3606  */
3607  conn->try_next_host = true;
3608  goto keep_going;
3609  }
3610  }
3614  {
3615  /*
3616  * If the server didn't report "in_hot_standby" at
3617  * startup, we must determine its state by sending the
3618  * query "SELECT pg_catalog.pg_is_in_recovery()". Servers
3619  * before 9.0 don't have that function, but by the same
3620  * token they don't have any standby mode, so we may just
3621  * assume the result.
3622  */
3623  if (conn->sversion < 90000)
3625 
3627  {
3628  /*
3629  * We use PQsendQueryContinue so that
3630  * conn->errorMessage does not get cleared. We need
3631  * to preserve any error messages related to previous
3632  * hosts we have tried and failed to connect to.
3633  */
3636  "SELECT pg_catalog.pg_is_in_recovery()"))
3637  goto error_return;
3638  /* We'll return to this state when we have the answer */
3640  return PGRES_POLLING_READING;
3641  }
3642 
3643  /* OK, we can make the test */
3647  {
3648  /* Wrong server state, reject and try the next host */
3651  libpq_gettext("server is in hot standby mode\n"));
3652  else
3654  libpq_gettext("server is not in hot standby mode\n"));
3655 
3656  /* Close connection politely. */
3659 
3660  /*
3661  * Try next host if any, but we don't want to consider
3662  * additional addresses for this host.
3663  */
3664  conn->try_next_host = true;
3665  goto keep_going;
3666  }
3667  }
3668 
3669  /* We can release the address list now. */
3671 
3672  /*
3673  * Contents of conn->errorMessage are no longer interesting
3674  * (and it seems some clients expect it to be empty after a
3675  * successful connection).
3676  */
3678 
3679  /* We are open for business! */
3681  return PGRES_POLLING_OK;
3682  }
3683 
3684  case CONNECTION_CONSUME:
3685  {
3686  /*
3687  * This state just makes sure the connection is idle after
3688  * we've obtained the result of a SHOW or SELECT query. Once
3689  * we're clear, return to CONNECTION_CHECK_TARGET state to
3690  * decide what to do next. We must transiently set status =
3691  * CONNECTION_OK in order to use the result-consuming
3692  * subroutines.
3693  */
3695  if (!PQconsumeInput(conn))
3696  goto error_return;
3697 
3698  if (PQisBusy(conn))
3699  {
3701  return PGRES_POLLING_READING;
3702  }
3703 
3704  /* Call PQgetResult() again until we get a NULL result */
3705  res = PQgetResult(conn);
3706  if (res != NULL)
3707  {
3708  PQclear(res);
3710  return PGRES_POLLING_READING;
3711  }
3712 
3714  goto keep_going;
3715  }
3716 
3718  {
3719  /*
3720  * Waiting for result of "SHOW transaction_read_only". We
3721  * must transiently set status = CONNECTION_OK in order to use
3722  * the result-consuming subroutines.
3723  */
3725  if (!PQconsumeInput(conn))
3726  goto error_return;
3727 
3728  if (PQisBusy(conn))
3729  {
3731  return PGRES_POLLING_READING;
3732  }
3733 
3734  res = PQgetResult(conn);
3735  if (res && PQresultStatus(res) == PGRES_TUPLES_OK &&
3736  PQntuples(res) == 1)
3737  {
3738  char *val = PQgetvalue(res, 0, 0);
3739 
3740  /*
3741  * "transaction_read_only = on" proves that at least one
3742  * of default_transaction_read_only and in_hot_standby is
3743  * on, but we don't actually know which. We don't care
3744  * though for the purpose of identifying a read-only
3745  * session, so satisfy the CONNECTION_CHECK_TARGET code by
3746  * claiming they are both on. On the other hand, if it's
3747  * a read-write session, they are certainly both off.
3748  */
3749  if (strncmp(val, "on", 2) == 0)
3750  {
3753  }
3754  else
3755  {
3758  }
3759  PQclear(res);
3760 
3761  /* Finish reading messages before continuing */
3763  goto keep_going;
3764  }
3765 
3766  /* Something went wrong with "SHOW transaction_read_only". */
3767  if (res)
3768  PQclear(res);
3769 
3770  /* Append error report to conn->errorMessage. */
3772  libpq_gettext("\"%s\" failed\n"),
3773  "SHOW transaction_read_only");
3774 
3775  /* Close connection politely. */
3778 
3779  /* Try next host. */
3780  conn->try_next_host = true;
3781  goto keep_going;
3782  }
3783 
3785  {
3786  /*
3787  * Waiting for result of "SELECT pg_is_in_recovery()". We
3788  * must transiently set status = CONNECTION_OK in order to use
3789  * the result-consuming subroutines.
3790  */
3792  if (!PQconsumeInput(conn))
3793  goto error_return;
3794 
3795  if (PQisBusy(conn))
3796  {
3798  return PGRES_POLLING_READING;
3799  }
3800 
3801  res = PQgetResult(conn);
3802  if (res && PQresultStatus(res) == PGRES_TUPLES_OK &&
3803  PQntuples(res) == 1)
3804  {
3805  char *val = PQgetvalue(res, 0, 0);
3806 
3807  if (strncmp(val, "t", 1) == 0)
3809  else
3811  PQclear(res);
3812 
3813  /* Finish reading messages before continuing */
3815  goto keep_going;
3816  }
3817 
3818  /* Something went wrong with "SELECT pg_is_in_recovery()". */
3819  if (res)
3820  PQclear(res);
3821 
3822  /* Append error report to conn->errorMessage. */
3824  libpq_gettext("\"%s\" failed\n"),
3825  "SELECT pg_is_in_recovery()");
3826 
3827  /* Close connection politely. */
3830 
3831  /* Try next host. */
3832  conn->try_next_host = true;
3833  goto keep_going;
3834  }
3835 
3836  default:
3838  libpq_gettext("invalid connection state %d, "
3839  "probably indicative of memory corruption\n"),
3840  conn->status);
3841  goto error_return;
3842  }
3843 
3844  /* Unreachable */
3845 
3846 error_return:
3847 
3848  /*
3849  * We used to close the socket at this point, but that makes it awkward
3850  * for those above us if they wish to remove this socket from their own
3851  * records (an fd_set for example). We'll just have this socket closed
3852  * when PQfinish is called (which is compulsory even after an error, since
3853  * the connection structure must be freed).
3854  */
3856  return PGRES_POLLING_FAILED;
3857 }
#define STATUS_OK
Definition: c.h:1167
#define MemSet(start, val, len)
Definition: c.h:1008
int pg_fe_sendauth(AuthRequest areq, int payloadlen, PGconn *conn)
Definition: fe-auth.c:895
char * pg_fe_getusername(uid_t user_id, PQExpBuffer errorMessage)
Definition: fe-auth.c:1111
void pqDropConnection(PGconn *conn, bool flushInput)
Definition: fe-connect.c:448
static const PQEnvironmentOption EnvironmentOptions[]
Definition: fe-connect.c:352
static void sendTerminateConn(PGconn *conn)
Definition: fe-connect.c:4179
static int setKeepalivesCount(PGconn *conn)
Definition: fe-connect.c:1912
static int useKeepalives(PGconn *conn)
Definition: fe-connect.c:1776
static void connectFailureMessage(PGconn *conn, int errorno)
Definition: fe-connect.c:1752
static void release_conn_addrinfo(PGconn *conn)
Definition: fe-connect.c:4164
#define ERRCODE_APPNAME_UNKNOWN
Definition: fe-connect.c:91
static int setKeepalivesInterval(PGconn *conn)
Definition: fe-connect.c:1876
static int setKeepalivesIdle(PGconn *conn)
Definition: fe-connect.c:1841
static void pgpassfileWarning(PGconn *conn)
Definition: fe-connect.c:7169
static bool parse_int_param(const char *value, int *result, PGconn *conn, const char *context)
Definition: fe-connect.c:1795
static void emitHostIdentityInfo(PGconn *conn, const char *host_addr)
Definition: fe-connect.c:1694
static int setTCPUserTimeout(PGconn *conn)
Definition: fe-connect.c:2000
static void pqDropServerData(PGconn *conn)
Definition: fe-connect.c:556
static int connectNoDelay(PGconn *conn)
Definition: fe-connect.c:1632
static void getHostaddr(PGconn *conn, char *host_addr, int host_addr_len)
Definition: fe-connect.c:1659
#define ERRCODE_CANNOT_CONNECT_NOW
Definition: fe-connect.c:96
int pqPacketSend(PGconn *conn, char pack_type, const void *buf, size_t buf_len)
Definition: fe-connect.c:4603
int PQsendQueryContinue(PGconn *conn, const char *query)
Definition: fe-exec.c:1332
int PQntuples(const PGresult *res)
Definition: fe-exec.c:3248
int PQconsumeInput(PGconn *conn)
Definition: fe-exec.c:1904
char * PQgetvalue(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3642
void pqClearAsyncResult(PGconn *conn)
Definition: fe-exec.c:749
int PQisBusy(PGconn *conn)
Definition: fe-exec.c:1951
char * PQresultErrorField(const PGresult *res, int fieldcode)
Definition: fe-exec.c:3233
PGresult * PQgetResult(PGconn *conn)
Definition: fe-exec.c:1978
bool pg_GSS_have_cred_cache(gss_cred_id_t *cred_out)
int pqReadData(PGconn *conn)
Definition: fe-misc.c:568
int pqFlush(PGconn *conn)
Definition: fe-misc.c:965
int pqGetc(char *result, PGconn *conn)
Definition: fe-misc.c:80
int pqGetInt(int *result, size_t bytes, PGconn *conn)
Definition: fe-misc.c:219
int pqCheckInBufferSpace(size_t bytes_needed, PGconn *conn)
Definition: fe-misc.c:354
int pqGets_append(PQExpBuffer buf, PGconn *conn)
Definition: fe-misc.c:145
int pqGetErrorNotice3(PGconn *conn, bool isError)
Definition: fe-protocol3.c:888
char * pqBuildStartupPacket3(PGconn *conn, int *packetlen, const PQEnvironmentOption *options)
PostgresPollingStatusType pqsecure_open_gss(PGconn *conn)
PostgresPollingStatusType pqsecure_open_client(PGconn *conn)
Definition: fe-secure.c:177
int pqsecure_initialize(PGconn *conn, bool do_ssl, bool do_crypto)
Definition: fe-secure.c:162
#define AI_NUMERICHOST
Definition: getaddrinfo.h:73
#define gai_strerror
Definition: getaddrinfo.h:146
#define NI_MAXHOST
Definition: getaddrinfo.h:88
long val
Definition: informix.c:664
int pg_getaddrinfo_all(const char *hostname, const char *servname, const struct addrinfo *hintp, struct addrinfo **result)
Definition: ip.c:57
#define IS_AF_UNIX(fam)
Definition: ip.h:24
@ PGASYNC_IDLE
Definition: libpq-int.h:219
@ PGASYNC_BUSY
Definition: libpq-int.h:220
#define SOCK_STRERROR
Definition: libpq-int.h:855
#define SOCK_ERRNO
Definition: libpq-int.h:854
@ CHT_UNIX_SOCKET
Definition: libpq-int.h:301
@ CHT_HOST_ADDRESS
Definition: libpq-int.h:300
@ CHT_HOST_NAME
Definition: libpq-int.h:299
@ PG_BOOL_YES
Definition: libpq-int.h:247
@ PG_BOOL_NO
Definition: libpq-int.h:248
@ PG_BOOL_UNKNOWN
Definition: libpq-int.h:246
@ SERVER_TYPE_STANDBY
Definition: libpq-int.h:238
@ SERVER_TYPE_PRIMARY
Definition: libpq-int.h:237
@ SERVER_TYPE_READ_WRITE
Definition: libpq-int.h:235
@ SERVER_TYPE_PREFER_STANDBY_PASS2
Definition: libpq-int.h:240
@ SERVER_TYPE_PREFER_STANDBY
Definition: libpq-int.h:239
@ SERVER_TYPE_READ_ONLY
Definition: libpq-int.h:236
#define pg_hton32(x)
Definition: pg_bswap.h:121
#define MAXPGPATH
bool pg_set_noblock(pgsocket sock)
Definition: noblock.c:25
#define snprintf
Definition: port.h:225
unsigned int socklen_t
Definition: port.h:40
#define PGINVALID_SOCKET
Definition: port.h:31
int getpeereid(int sock, uid_t *uid, gid_t *gid)
Definition: getpeereid.c:35
#define PG_DIAG_SQLSTATE
Definition: postgres_ext.h:57
#define AUTH_REQ_OK
Definition: pqcomm.h:151
#define UNIXSOCK_PATH(path, port, sockdir)
Definition: pqcomm.h:70
#define UNIXSOCK_PATH_BUFLEN
Definition: pqcomm.h:86
#define NEGOTIATE_GSS_CODE
Definition: pqcomm.h:192
#define NEGOTIATE_SSL_CODE
Definition: pqcomm.h:191
uint32 ProtocolVersion
Definition: pqcomm.h:125
uint32 AuthRequest
Definition: pqcomm.h:165
#define PG_PROTOCOL(m, n)
Definition: pqcomm.h:115
void resetPQExpBuffer(PQExpBuffer str)
Definition: pqexpbuffer.c:148
void appendPQExpBufferChar(PQExpBuffer str, char ch)
Definition: pqexpbuffer.c:380
struct sockaddr_storage addr
Definition: pqcomm.h:64
socklen_t salen
Definition: pqcomm.h:65
size_t ai_addrlen
Definition: getaddrinfo.h:104
struct sockaddr * ai_addr
Definition: getaddrinfo.h:105
struct addrinfo * ai_next
Definition: getaddrinfo.h:107
int ai_family
Definition: getaddrinfo.h:101
char * host
Definition: libpq-int.h:335
char * port
Definition: libpq-int.h:337
char * hostaddr
Definition: libpq-int.h:336
pg_conn_host_type type
Definition: libpq-int.h:334
SockAddr laddr
Definition: libpq-int.h:446
bool try_next_host
Definition: libpq-int.h:460
struct addrinfo * addrlist
Definition: libpq-int.h:461
bool sigpipe_flag
Definition: libpq-int.h:453
int nconnhost
Definition: libpq-int.h:425
pgsocket sock
Definition: libpq-int.h:444
ProtocolVersion pversion
Definition: libpq-int.h:448
int addrlist_family
Definition: libpq-int.h:463
bool send_appname
Definition: libpq-int.h:464
PGTransactionStatusType xactStatus
Definition: libpq-int.h:412
int inCursor
Definition: libpq-int.h:482
PGTernaryBool in_hot_standby
Definition: libpq-int.h:473
int inEnd
Definition: libpq-int.h:483
char * fbappname
Definition: libpq-int.h:365
int inStart
Definition: libpq-int.h:481
char * connip
Definition: libpq-int.h:428
int sversion
Definition: libpq-int.h:449
bool auth_req_received
Definition: libpq-int.h:450
PGTernaryBool default_transaction_read_only
Definition: libpq-int.h:472
bool sigpipe_so
Definition: libpq-int.h:452
char * appname
Definition: libpq-int.h:364
char * sslmode
Definition: libpq-int.h:379
struct addrinfo * addr_cur
Definition: libpq-int.h:462
char * gssencmode
Definition: libpq-int.h:389
char last_sqlstate[6]
Definition: libpq-int.h:413
PGAsyncStatusType asyncStatus
Definition: libpq-int.h:411
PGpipelineStatus pipelineStatus
Definition: libpq-int.h:417
PGTargetServerType target_server_type
Definition: libpq-int.h:458
SockAddr raddr
Definition: libpq-int.h:447
bool try_next_addr
Definition: libpq-int.h:459
int whichhost
Definition: libpq-int.h:426
char * requirepeer
Definition: libpq-int.h:388
pg_conn_host * connhost
Definition: libpq-int.h:427
bool ssl_in_use
Definition: libpq-int.h:508
ExecStatusType resultStatus
Definition: libpq-int.h:178
#define EINTR
Definition: win32_port.h:351
#define EWOULDBLOCK
Definition: win32_port.h:357
#define EINPROGRESS
Definition: win32_port.h:363
int gid_t
Definition: win32_port.h:245
#define socket(af, type, protocol)
Definition: win32_port.h:469
#define connect(s, name, namelen)
Definition: win32_port.h:473
int uid_t
Definition: win32_port.h:244

References SockAddr::addr, pg_conn::addr_cur, pg_conn::addrlist, pg_conn::addrlist_family, addrinfo::ai_addr, addrinfo::ai_addrlen, addrinfo::ai_family, addrinfo::ai_flags, addrinfo::ai_next, AI_NUMERICHOST, addrinfo::ai_socktype, appendPQExpBuffer(), appendPQExpBufferChar(), appendPQExpBufferStr(), pg_conn::appname, Assert(), pg_conn::asyncStatus, AUTH_REQ_OK, pg_conn::auth_req_received, 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_GSS_STARTUP, CONNECTION_MADE, CONNECTION_NEEDED, CONNECTION_OK, CONNECTION_SSL_STARTUP, CONNECTION_STARTED, connectNoDelay(), pg_conn::connhost, pg_conn::connip, PQExpBufferData::data, pg_conn::default_transaction_read_only, EINPROGRESS, EINTR, emitHostIdentityInfo(), EnvironmentOptions, ERRCODE_APPNAME_UNKNOWN, ERRCODE_CANNOT_CONNECT_NOW, pg_conn::errorMessage, EWOULDBLOCK, pg_conn::fbappname, free, gai_strerror, getHostaddr(), getpeereid(), pg_conn::gssencmode, pg_conn_host::host, pg_conn_host::hostaddr, pg_conn::in_hot_standby, pg_conn::inCursor, pg_conn::inEnd, pg_conn::inStart, IS_AF_UNIX, pg_conn::laddr, pg_conn::last_sqlstate, PQExpBufferData::len, libpq_gettext, MAXPGPATH, MemSet, pg_conn::nconnhost, NEGOTIATE_GSS_CODE, NEGOTIATE_SSL_CODE, NI_MAXHOST, parse_int_param(), PG_BOOL_NO, PG_BOOL_UNKNOWN, PG_BOOL_YES, PG_DIAG_SQLSTATE, pg_fe_getusername(), pg_fe_sendauth(), pg_getaddrinfo_all(), pg_GSS_have_cred_cache(), pg_hton32, 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, PQ_PIPELINE_OFF, pqBuildStartupPacket3(), pqCheckInBufferSpace(), PQclear(), pqClearAsyncResult(), PQconsumeInput(), pqDropConnection(), pqDropServerData(), pqFlush(), pqGetc(), pqGetErrorNotice3(), pqGetInt(), PQgetResult(), pqGets_append(), PQgetvalue(), PQisBusy(), PQntuples(), pqPacketSend(), pqReadData(), PQresultErrorField(), PQresultStatus(), pqsecure_initialize(), pqsecure_open_client(), pqsecure_open_gss(), PQsendQueryContinue(), PQTRANS_IDLE, pg_conn::pversion, pg_conn::raddr, release_conn_addrinfo(), pg_conn::requirepeer, res, resetPQExpBuffer(), 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::sslmode, pg_conn::status, STATUS_OK, 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::whichhost, and pg_conn::xactStatus.

Referenced by connectDBComplete(), connectDBStart(), libpqrcv_connect(), and PQresetPoll().

◆ PQconnectStart()

PGconn* PQconnectStart ( const char *  conninfo)

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

842 {
843  PGconn *conn;
844 
845  /*
846  * Allocate memory for the conn structure. Note that we also expect this
847  * to initialize conn->errorMessage to empty. All subsequent steps during
848  * connection initialization will only append to that buffer.
849  */
850  conn = makeEmptyPGconn();
851  if (conn == NULL)
852  return NULL;
853 
854  /*
855  * Parse the conninfo string
856  */
857  if (!connectOptions1(conn, conninfo))
858  return conn;
859 
860  /*
861  * Compute derived options
862  */
863  if (!connectOptions2(conn))
864  return conn;
865 
866  /*
867  * Connect to the database
868  */
869  if (!connectDBStart(conn))
870  {
871  /* Just in case we failed to set it in connectDBStart */
873  }
874 
875  return conn;
876 }
static bool connectOptions1(PGconn *conn, const char *conninfo)
Definition: fe-connect.c:929
static bool connectOptions2(PGconn *conn)
Definition: fe-connect.c:1027
static PGconn * makeEmptyPGconn(void)
Definition: fe-connect.c:3931
static int connectDBStart(PGconn *conn)
Definition: fe-connect.c:2040

References conn, connectDBStart(), CONNECTION_BAD, connectOptions1(), connectOptions2(), makeEmptyPGconn(), and pg_conn::status.

Referenced by PQconnectdb(), and PQping().

◆ PQconnectStartParams()

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

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

763 {
764  PGconn *conn;
765  PQconninfoOption *connOptions;
766 
767  /*
768  * Allocate memory for the conn structure. Note that we also expect this
769  * to initialize conn->errorMessage to empty. All subsequent steps during
770  * connection initialization will only append to that buffer.
771  */
772  conn = makeEmptyPGconn();
773  if (conn == NULL)
774  return NULL;
775 
776  /*
777  * Parse the conninfo arrays
778  */
779  connOptions = conninfo_array_parse(keywords, values,
780  &conn->errorMessage,
781  true, expand_dbname);
782  if (connOptions == NULL)
783  {
785  /* errorMessage is already set */
786  return conn;
787  }
788 
789  /*
790  * Move option values into conn structure
791  */
792  if (!fillPGconn(conn, connOptions))
793  {
794  PQconninfoFree(connOptions);
795  return conn;
796  }
797 
798  /*
799  * Free the option info - all is in conn now
800  */
801  PQconninfoFree(connOptions);
802 
803  /*
804  * Compute derived options
805  */
806  if (!connectOptions2(conn))
807  return conn;
808 
809  /*
810  * Connect to the database
811  */
812  if (!connectDBStart(conn))
813  {
814  /* Just in case we failed to set it in connectDBStart */
816  }
817 
818  return conn;
819 }
static PQconninfoOption * conninfo_array_parse(const char *const *keywords, const char *const *values, PQExpBuffer errorMessage, bool use_defaults, int expand_dbname)
Definition: fe-connect.c:5661
static bool fillPGconn(PGconn *conn, PQconninfoOption *connOptions)
Definition: fe-connect.c:887

References conn, connectDBStart(), CONNECTION_BAD, connectOptions2(), conninfo_array_parse(), pg_conn::errorMessage, fillPGconn(), makeEmptyPGconn(), PQconninfoFree(), pg_conn::status, and values.

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

◆ PQconninfo()

PQconninfoOption* PQconninfo ( PGconn conn)

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

6559 {
6560  PQExpBufferData errorBuf;
6561  PQconninfoOption *connOptions;
6562 
6563  if (conn == NULL)
6564  return NULL;
6565 
6566  /*
6567  * We don't actually report any errors here, but callees want a buffer,
6568  * and we prefer not to trash the conn's errorMessage.
6569  */
6570  initPQExpBuffer(&errorBuf);
6571  if (PQExpBufferDataBroken(errorBuf))
6572  return NULL; /* out of memory already :-( */
6573 
6574  connOptions = conninfo_init(&errorBuf);
6575 
6576  if (connOptions != NULL)
6577  {
6579 
6580  for (option = PQconninfoOptions; option->keyword; option++)
6581  {
6582  char **connmember;
6583 
6584  if (option->connofs < 0)
6585  continue;
6586 
6587  connmember = (char **) ((char *) conn + option->connofs);
6588 
6589  if (*connmember)
6590  conninfo_storeval(connOptions, option->keyword, *connmember,
6591  &errorBuf, true, false);
6592  }
6593  }
6594 
6595  termPQExpBuffer(&errorBuf);
6596 
6597  return connOptions;
6598 }
static PQconninfoOption * conninfo_storeval(PQconninfoOption *connOptions, const char *keyword, const char *value, PQExpBuffer errorMessage, bool ignoreMissing, bool uri_decode)
Definition: fe-connect.c:6475
static const internalPQconninfoOption PQconninfoOptions[]
Definition: fe-connect.c:191

References conn, conninfo_init(), conninfo_storeval(), initPQExpBuffer(), PQconninfoOptions, PQExpBufferDataBroken, and termPQExpBuffer().

Referenced by do_connect(), GenerateRecoveryConfig(), and libpqrcv_get_conninfo().

◆ PQconninfoFree()

void PQconninfoFree ( PQconninfoOption connOptions)

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

6603 {
6605 
6606  if (connOptions == NULL)
6607  return;
6608 
6609  for (option = connOptions; option->keyword != NULL; option++)
6610  {
6611  if (option->val != NULL)
6612  free(option->val);
6613  }
6614  free(connOptions);
6615 }
int val
Definition: getopt_long.h:21

References free, and option::val.

Referenced by check_pghost_envvar(), connectDatabase(), connectOptions1(), conninfo_array_parse(), conninfo_parse(), conninfo_uri_parse(), dblink_connstr_check(), do_connect(), GenerateRecoveryConfig(), GetConnection(), libpqrcv_check_conninfo(), libpqrcv_get_conninfo(), PQconndefaults(), and PQconnectStartParams().

◆ PQconninfoParse()

PQconninfoOption* PQconninfoParse ( const char *  conninfo,
char **  errmsg 
)

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

5368 {
5369  PQExpBufferData errorBuf;
5370  PQconninfoOption *connOptions;
5371 
5372  if (errmsg)
5373  *errmsg = NULL; /* default */
5374  initPQExpBuffer(&errorBuf);
5375  if (PQExpBufferDataBroken(errorBuf))
5376  return NULL; /* out of memory already :-( */
5377  connOptions = parse_connection_string(conninfo, &errorBuf, false);
5378  if (connOptions == NULL && errmsg)
5379  *errmsg = errorBuf.data;
5380  else
5381  termPQExpBuffer(&errorBuf);
5382  return connOptions;
5383 }
int errmsg(const char *fmt,...)
Definition: elog.c:904
static PQconninfoOption * parse_connection_string(const char *conninfo, PQExpBuffer errorMessage, bool use_defaults)
Definition: fe-connect.c:5429

References PQExpBufferData::data, errmsg(), initPQExpBuffer(), parse_connection_string(), PQExpBufferDataBroken, and termPQExpBuffer().

Referenced by connectDatabase(), dblink_connstr_check(), do_connect(), GetConnection(), libpqrcv_check_conninfo(), and main().

◆ PQconsumeInput()

int PQconsumeInput ( PGconn conn)

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

1905 {
1906  if (!conn)
1907  return 0;
1908 
1909  /*
1910  * for non-blocking connections try to flush the send-queue, otherwise we
1911  * may never get a response for something that may not have already been
1912  * sent because it's in our write buffer!
1913  */
1914  if (pqIsnonblocking(conn))
1915  {
1916  if (pqFlush(conn) < 0)
1917  return 0;
1918  }
1919 
1920  /*
1921  * Load more data, if available. We do this no matter what state we are
1922  * in, since we are probably getting called because the application wants
1923  * to get rid of a read-select condition. Note that we will NOT block
1924  * waiting for more input.
1925  */
1926  if (pqReadData(conn) < 0)
1927  return 0;
1928 
1929  /* Parsing of the data waits till later. */
1930  return 1;
1931 }
#define pqIsnonblocking(conn)
Definition: libpq-int.h:830

References conn, pqFlush(), pqIsnonblocking, and pqReadData().

Referenced by advanceConnectionState(), CopyStreamReceive(), dblink_get_notify(), dblink_is_busy(), ecpg_process_output(), libpqrcv_PQgetResult(), libpqrcv_receive(), main(), pgfdw_get_cleanup_result(), pgfdw_get_result(), postgresForeignAsyncNotify(), PQconnectPoll(), PrintNotifications(), StreamLogicalLog(), test_nosync(), test_pipelined_insert(), test_uniqviol(), try_complete_step(), and wait_on_slots().

◆ PQcopyResult()

PGresult* PQcopyResult ( const PGresult src,
int  flags 
)

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

300 {
301  PGresult *dest;
302  int i;
303 
304  if (!src)
305  return NULL;
306 
308  if (!dest)
309  return NULL;
310 
311  /* Always copy these over. Is cmdStatus really useful here? */
312  dest->client_encoding = src->client_encoding;
313  strcpy(dest->cmdStatus, src->cmdStatus);
314 
315  /* Wants attrs? */
316  if (flags & (PG_COPYRES_ATTRS | PG_COPYRES_TUPLES))
317  {
318  if (!PQsetResultAttrs(dest, src->numAttributes, src->attDescs))
319  {
320  PQclear(dest);
321  return NULL;
322  }
323  }
324 
325  /* Wants to copy tuples? */
326  if (flags & PG_COPYRES_TUPLES)
327  {
328  int tup,
329  field;
330 
331  for (tup = 0; tup < src->ntups; tup++)
332  {
333  for (field = 0; field < src->numAttributes; field++)
334  {
335  if (!PQsetvalue(dest, tup, field,
336  src->tuples[tup][field].value,
337  src->tuples[tup][field].len))
338  {
339  PQclear(dest);
340  return NULL;
341  }
342  }
343  }
344  }
345 
346  /* Wants to copy notice hooks? */
347  if (flags & PG_COPYRES_NOTICEHOOKS)
348  dest->noticeHooks = src->noticeHooks;
349 
350  /* Wants to copy PGEvents? */
351  if ((flags & PG_COPYRES_EVENTS) && src->nEvents > 0)
352  {
353  dest->events = dupEvents(src->events, src->nEvents,
354  &dest->memorySize);
355  if (!dest->events)
356  {
357  PQclear(dest);
358  return NULL;
359  }
360  dest->nEvents = src->nEvents;
361  }
362 
363  /* Okay, trigger PGEVT_RESULTCOPY event */
364  for (i = 0; i < dest->nEvents; i++)
365  {
366  if (src->events[i].resultInitialized)
367  {
368  PGEventResultCopy evt;
369 
370  evt.src = src;
371  evt.dest = dest;
372  if (!dest->events[i].proc(PGEVT_RESULTCOPY, &evt,
373  dest->events[i].passThrough))
374  {
375  PQclear(dest);
376  return NULL;
377  }
378  dest->events[i].resultInitialized = true;
379  }
380  }
381 
382  return dest;
383 }
int PQsetResultAttrs(PGresult *res, int numAttributes, PGresAttDesc *attDescs)
Definition: fe-exec.c:234
static PGEvent * dupEvents(PGEvent *events, int count, size_t *memSize)
Definition: fe-exec.c:392
PGresult * PQmakeEmptyPGresult(PGconn *conn, ExecStatusType status)
Definition: fe-exec.c:146
int PQsetvalue(PGresult *res, int tup_num, int field_num, char *value, int len)
Definition: fe-exec.c:436
@ PGEVT_RESULTCOPY
Definition: libpq-events.h:33
#define PG_COPYRES_TUPLES
Definition: libpq-fe.h:44
#define PG_COPYRES_ATTRS
Definition: libpq-fe.h:43
#define PG_COPYRES_EVENTS
Definition: libpq-fe.h:45
#define PG_COPYRES_NOTICEHOOKS
Definition: libpq-fe.h:46
const PGresult * src
Definition: libpq-events.h:60
PGresult * dest
Definition: libpq-events.h:61
int ntups
Definition: libpq-int.h:170
int numAttributes
Definition: libpq-int.h:171
int client_encoding
Definition: libpq-int.h:190
char * value
Definition: libpq-int.h:139

References pg_result::attDescs, pg_result::client_encoding, pg_result::cmdStatus, generate_unaccent_rules::dest, PGEventResultCopy::dest, dupEvents(), pg_result::events, i, pgresAttValue::len, pg_result::nEvents, pg_result::noticeHooks, pg_result::ntups, pg_result::numAttributes, PG_COPYRES_ATTRS, PG_COPYRES_EVENTS, PG_COPYRES_NOTICEHOOKS, PG_COPYRES_TUPLES, PGEVT_RESULTCOPY, PGRES_TUPLES_OK, PQclear(), PQmakeEmptyPGresult(), PQsetResultAttrs(), PQsetvalue(), PGEvent::resultInitialized, PGEventResultCopy::src, pg_result::tuples, and pgresAttValue::value.

Referenced by pqRowProcessor().

◆ PQdb()

◆ PQdefaultSSLKeyPassHook_OpenSSL()

int PQdefaultSSLKeyPassHook_OpenSSL ( char *  buf,
int  size,
PGconn conn 
)

Definition at line 1789 of file fe-secure-openssl.c.

1790 {
1791  if (conn->sslpassword)
1792  {
1793  if (strlen(conn->sslpassword) + 1 > size)
1794  fprintf(stderr, libpq_gettext("WARNING: sslpassword truncated\n"));
1795  strncpy(buf, conn->sslpassword, size);
1796  buf[size - 1] = '\0';
1797  return strlen(buf);
1798  }
1799  else
1800  {
1801  buf[0] = '\0';
1802  return 0;
1803  }
1804 }
#define fprintf
Definition: port.h:229
char * sslpassword
Definition: libpq-int.h:383

References buf, conn, fprintf, libpq_gettext, and pg_conn::sslpassword.

Referenced by PQssl_passwd_cb().

◆ PQdescribePortal()

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

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

2406 {
2407  if (!PQexecStart(conn))
2408  return NULL;
2409  if (!PQsendDescribe(conn, 'P', portal))
2410  return NULL;
2411  return PQexecFinish(conn);
2412 }
static PGresult * PQexecFinish(PGconn *conn)
Definition: fe-exec.c:2340
static bool PQexecStart(PGconn *conn)
Definition: fe-exec.c:2275
static int PQsendDescribe(PGconn *conn, char desc_type, const char *desc_target)
Definition: fe-exec.c:2450

References conn, PQexecFinish(), PQexecStart(), and PQsendDescribe().

◆ PQdescribePrepared()

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

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

2387 {
2388  if (!PQexecStart(conn))
2389  return NULL;
2390  if (!PQsendDescribe(conn, 'S', stmt))
2391  return NULL;
2392  return PQexecFinish(conn);
2393 }

References conn, PQexecFinish(), PQexecStart(), and PQsendDescribe().

Referenced by DescribeQuery(), and ECPGdescribe().

◆ PQdisplayTuples()

void PQdisplayTuples ( const PGresult res,
FILE *  fp,
int  fillAlign,
const char *  fieldSep,
int  printHeader,
int  quiet 
)

Definition at line 591 of file fe-print.c.

598 {
599 #define DEFAULT_FIELD_SEP " "
600 
601  int i,
602  j;
603  int nFields;
604  int nTuples;
605  int *fLength = NULL;
606 
607  if (fieldSep == NULL)
608  fieldSep = DEFAULT_FIELD_SEP;
609 
610  /* Get some useful info about the results */
611  nFields = PQnfields(res);
612  nTuples = PQntuples(res);
613 
614  if (fp == NULL)
615  fp = stdout;
616 
617  /* Figure the field lengths to align to */
618  /* will be somewhat time consuming for very large results */
619  if (fillAlign)
620  {
621  fLength = (int *) malloc(nFields * sizeof(int));
622  if (!fLength)
623  {
624  fprintf(stderr, libpq_gettext("out of memory\n"));
625  return;
626  }
627 
628  for (j = 0; j < nFields; j++)
629  {
630  fLength[j] = strlen(PQfname(res, j));
631  for (i = 0; i < nTuples; i++)
632  {
633  int flen = PQgetlength(res, i, j);
634 
635  if (flen > fLength[j])
636  fLength[j] = flen;
637  }
638  }
639  }
640 
641  if (printHeader)
642  {
643  /* first, print out the attribute names */
644  for (i = 0; i < nFields; i++)
645  {
646  fputs(PQfname(res, i), fp);
647  if (fillAlign)
648  fill(strlen(PQfname(res, i)), fLength[i], ' ', fp);
649  fputs(fieldSep, fp);
650  }
651  fprintf(fp, "\n");
652 
653  /* Underline the attribute names */
654  for (i = 0; i < nFields; i++)
655  {
656  if (fillAlign)
657  fill(0, fLength[i], '-', fp);
658  fputs(fieldSep, fp);
659  }
660  fprintf(fp, "\n");
661  }
662 
663  /* next, print out the instances */
664  for (i = 0; i < nTuples; i++)
665  {
666  for (j = 0; j < nFields; j++)
667  {
668  fprintf(fp, "%s", PQgetvalue(res, i, j));
669  if (fillAlign)
670  fill(strlen(PQgetvalue(res, i, j)), fLength[j], ' ', fp);
671  fputs(fieldSep, fp);
672  }
673  fprintf(fp, "\n");
674  }
675 
676  if (!quiet)
677  fprintf(fp, "\nQuery returned %d row%s.\n", PQntuples(res),
678  (PQntuples(res) == 1) ? "" : "s");
679 
680  fflush(fp);
681 
682  if (fLength)
683  free(fLength);
684 }
int PQgetlength(const PGresult *res, int tup_num, int field_num)
Definition: fe-exec.c:3653
char * PQfname(const PGresult *res, int field_num)
Definition: fe-exec.c:3334
int PQnfields(const PGresult *res)
Definition: fe-exec.c:3256
static void fill(int length, int max, char filler, FILE *fp)
Definition: fe-print.c:774
#define DEFAULT_FIELD_SEP
#define malloc(a)
Definition: header.h:50
int j
Definition: isn.c:74
static void const char fflush(stdout)

References DEFAULT_FIELD_SEP, fflush(), fill(), fprintf, free, i, j, libpq_gettext, malloc, PQfname(), PQgetlength(), PQgetvalue(), PQnfields(), PQntuples(), res, and generate_unaccent_rules::stdout.

◆ PQdsplen()

int PQdsplen ( const char *  s,
int  encoding 
)

Definition at line 1212 of file fe-misc.c.

1213 {
1214  return pg_encoding_dsplen(encoding, s);
1215 }
int pg_encoding_dsplen(int encoding, const char *mbstr)
Definition: wchar.c:2150

References encoding, and pg_encoding_dsplen().

Referenced by get_prompt(), pg_wcsformat(), pg_wcssize(), pg_wcswidth(), and strlen_max_width().

◆ PQencryptPassword()

char* PQencryptPassword ( const char *  passwd,
const char *  user 
)

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

1188 {
1189  char *crypt_pwd;
1190  const char *errstr = NULL;
1191 
1192  crypt_pwd = malloc(MD5_PASSWD_LEN + 1);
1193  if (!crypt_pwd)
1194  return NULL;
1195 
1196  if (!pg_md5_encrypt(passwd, user, strlen(user), crypt_pwd, &errstr))
1197  {
1198  free(crypt_pwd);
1199  return NULL;
1200  }
1201 
1202  return crypt_pwd;
1203 }
#define MD5_PASSWD_LEN
Definition: md5.h:26
bool pg_md5_encrypt(const char *passwd, const char *salt, size_t salt_len, char *buf, const char **errstr)
Definition: md5_common.c:131
static char * user
Definition: pg_regress.c:95

References free, malloc, MD5_PASSWD_LEN, pg_md5_encrypt(), and user.

◆ PQencryptPasswordConn()

char* PQencryptPasswordConn ( PGconn conn,
const char *  passwd,
const char *  user,
const char *  algorithm 
)

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

1232 {
1233 #define MAX_ALGORITHM_NAME_LEN 50
1234  char algobuf[MAX_ALGORITHM_NAME_LEN + 1];
1235  char *crypt_pwd = NULL;
1236 
1237  if (!conn)
1238  return NULL;
1239 
1241 
1242  /* If no algorithm was given, ask the server. */
1243  if (algorithm == NULL)
1244  {
1245  PGresult *res;
1246  char *val;
1247 
1248  res = PQexec(conn, "show password_encryption");
1249  if (res == NULL)
1250  {
1251  /* PQexec() should've set conn->errorMessage already */
1252  return NULL;
1253  }
1255  {
1256  /* PQexec() should've set conn->errorMessage already */
1257  PQclear(res);
1258  return NULL;
1259  }
1260  if (PQntuples(res) != 1 || PQnfields(res) != 1)
1261  {
1262  PQclear(res);
1264  libpq_gettext("unexpected shape of result set returned for SHOW\n"));
1265  return NULL;
1266  }
1267  val = PQgetvalue(res, 0, 0);
1268 
1269  if (strlen(val) > MAX_ALGORITHM_NAME_LEN)
1270  {
1271  PQclear(res);
1273  libpq_gettext("password_encryption value too long\n"));
1274  return NULL;
1275  }
1276  strcpy(algobuf, val);
1277  PQclear(res);
1278 
1279  algorithm = algobuf;
1280  }
1281 
1282  /*
1283  * Also accept "on" and "off" as aliases for "md5", because
1284  * password_encryption was a boolean before PostgreSQL 10. We refuse to
1285  * send the password in plaintext even if it was "off".
1286  */
1287  if (strcmp(algorithm, "on") == 0 ||
1288  strcmp(algorithm, "off") == 0)
1289  algorithm = "md5";
1290 
1291  /*
1292  * Ok, now we know what algorithm to use
1293  */
1294  if (strcmp(algorithm, "scram-sha-256") == 0)
1295  {
1296  const char *errstr = NULL;
1297 
1298  crypt_pwd = pg_fe_scram_build_secret(passwd, &errstr);
1299  if (!crypt_pwd)
1301  libpq_gettext("could not encrypt password: %s\n"),
1302  errstr);
1303  }
1304  else if (strcmp(algorithm, "md5") == 0)
1305  {
1306  crypt_pwd = malloc(MD5_PASSWD_LEN + 1);
1307  if (crypt_pwd)
1308  {
1309  const char *errstr = NULL;
1310 
1311  if (!pg_md5_encrypt(passwd, user, strlen(user), crypt_pwd, &errstr))
1312  {
1314  libpq_gettext("could not encrypt password: %s\n"),
1315  errstr);
1316  free(crypt_pwd);
1317  crypt_pwd = NULL;
1318  }
1319  }
1320  else
1322  libpq_gettext("out of memory\n"));
1323  }
1324  else
1325  {
1327  libpq_gettext("unrecognized password encryption algorithm \"%s\"\n"),
1328  algorithm);
1329  return NULL;
1330  }
1331 
1332  return crypt_pwd;
1333 }
char * pg_fe_scram_build_secret(const char *password, const char **errstr)
#define MAX_ALGORITHM_NAME_LEN
PGresult * PQexec(PGconn *conn, const char *query)
Definition: fe-exec.c:2193

References appendPQExpBuffer(), appendPQExpBufferStr(), conn, pg_conn::errorMessage, free, libpq_gettext, malloc, MAX_ALGORITHM_NAME_LEN, MD5_PASSWD_LEN, pg_fe_scram_build_secret(), pg_md5_encrypt(), PGRES_TUPLES_OK, PQclear(), PQexec(), PQgetvalue(), PQnfields(), PQntuples(), PQresultStatus(), res, resetPQExpBuffer(), user, and val.

Referenced by exec_command_password(), and main().

◆ PQendcopy()

int PQendcopy ( PGconn conn)

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

2803 {
2804  if (!conn)
2805  return 0;
2806 
2807  return pqEndcopy3(conn);
2808 }
int pqEndcopy3(PGconn *conn)

References conn, and pqEndcopy3().

Referenced by ecpg_check_PQresult(), initGenerateDataClientSide(), and libpqrcv_endstreaming().

◆ PQenterPipelineMode()

int PQenterPipelineMode ( PGconn conn)

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

2895 {
2896  if (!conn)
2897  return 0;
2898 
2899  /* succeed with no action if already in pipeline mode */
2901  return 1;
2902 
2903  if (conn->asyncStatus != PGASYNC_IDLE)
2904  {
2906  libpq_gettext("cannot enter pipeline mode, connection not idle\n"));
2907  return 0;
2908  }
2909 
2911 
2912  return 1;
2913 }

References appendPQExpBufferStr(), pg_conn::asyncStatus, conn, pg_conn::errorMessage, libpq_gettext, PGASYNC_IDLE, pg_conn::pipelineStatus, PQ_PIPELINE_OFF, and PQ_PIPELINE_ON.

Referenced by executeMetaCommand(), test_disallowed_in_pipeline(), test_multi_pipelines(), test_nosync(), test_pipeline_abort(), test_pipelined_insert(), test_prepared(), test_simple_pipeline(), test_singlerowmode(), test_transaction(), and test_uniqviol().

◆ PQenv2encoding()

int PQenv2encoding ( void  )

Definition at line 1221 of file fe-misc.c.

1222 {
1223  char *str;
1224  int encoding = PG_SQL_ASCII;
1225 
1226  str = getenv("PGCLIENTENCODING");
1227  if (str && *str != '\0')
1228  {
1230  if (encoding < 0)
1232  }
1233  return encoding;
1234 }
int pg_char_to_encoding(const char *name)
Definition: encnames.c:550
@ PG_SQL_ASCII
Definition: pg_wchar.h:224

References encoding, pg_char_to_encoding(), PG_SQL_ASCII, and generate_unaccent_rules::str.

Referenced by main().

◆ PQerrorMessage()

char* PQerrorMessage ( const PGconn conn)

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

6775 {
6776  if (!conn)
6777  return libpq_gettext("connection pointer is NULL\n");
6778 
6779  /*
6780  * The errorMessage buffer might be marked "broken" due to having
6781  * previously failed to allocate enough memory for the message. In that
6782  * case, tell the application we ran out of memory.
6783  */
6785  return libpq_gettext("out of memory\n");
6786 
6787  return conn->errorMessage.data;
6788 }
#define PQExpBufferBroken(str)
Definition: pqexpbuffer.h:59

References