1 /*-------------------------------------------------------------------------
4 * This file contains internal definitions meant to be used only by
5 * the frontend libpq library, not by applications that call it.
7 * An application can include this file if it wants to bypass the
8 * official API defined by libpq-fe.h, but code that does so is much
9 * more likely to break across PostgreSQL releases than code that uses
10 * only the official API.
12 * Portions Copyright (c) 1996-2011, PostgreSQL Global Development Group
13 * Portions Copyright (c) 1994, Regents of the University of California
15 * src/interfaces/libpq/libpq-int.h
17 *-------------------------------------------------------------------------
23 /* We assume libpq-fe.h has already been included. */
24 #include "postgres_fe.h"
25 #include "libpq-events.h"
28 #include <sys/types.h>
33 #ifdef ENABLE_THREAD_SAFETY
35 #include "pthread-win32.h"
42 /* include stuff common to fe and be */
43 #include "getaddrinfo.h"
44 #include "libpq/pqcomm.h"
45 /* include stuff found in fe only */
46 #include "pqexpbuffer.h"
49 #if defined(HAVE_GSSAPI_H)
52 #include <gssapi/gssapi.h>
57 #define SECURITY_WIN32
58 #if defined(WIN32) && !defined(WIN32_ONLY_COMPILER)
66 * Define a fake structure compatible with GSSAPI on Unix.
74 #endif /* ENABLE_SSPI */
77 #include <openssl/ssl.h>
78 #include <openssl/err.h>
80 #if (SSLEAY_VERSION_NUMBER >= 0x00907000L) && !defined(OPENSSL_NO_ENGINE)
81 #define USE_SSL_ENGINE
86 * POSTGRES backend dependent Constants.
88 #define CMDSTATUS_LEN 64 /* should match COMPLETION_TAG_BUFSIZE */
91 * PGresult and the subsidiary types PGresAttDesc, PGresAttValue
92 * represent the result of a query (or more precisely, of a single SQL
93 * command --- a query string given to PQexec can contain multiple commands).
94 * Note we assume that a single command can return at most one tuple group,
95 * hence there is no need for multiple descriptor sets.
98 /* Subsidiary-storage management structure for PGresult.
99 * See space management routines in fe-exec.c for details.
100 * Note that space[k] refers to the k'th byte starting from the physical
101 * head of the block --- it's a union, not a struct!
103 typedef union pgresult_data PGresult_data;
107 PGresult_data *next; /* link to next block, or NULL */
108 char space[1]; /* dummy for accessing block as bytes */
111 /* Data about a single parameter of a prepared statement */
112 typedef struct pgresParamDesc
114 Oid typid; /* type id */
118 * Data for a single attribute of a single tuple
120 * We use char* for Attribute values.
122 * The value pointer always points to a null-terminated area; we add a
123 * null (zero) byte after whatever the backend sends us. This is only
124 * particularly useful for text values ... with a binary value, the
125 * value might have embedded nulls, so the application can't use C string
126 * operators on it. But we add a null anyway for consistency.
127 * Note that the value itself does not contain a length word.
129 * A NULL attribute is a special case in two ways: its len field is NULL_LEN
130 * and its value field points to null_field in the owning PGresult. All the
131 * NULL attributes in a query result point to the same place (there's no need
132 * to store a null string separately for each one).
135 #define NULL_LEN (-1) /* pg_result len for NULL value */
137 typedef struct pgresAttValue
139 int len; /* length in bytes of the value */
140 char *value; /* actual value, plus terminating zero byte */
143 /* Typedef for message-field list entries */
144 typedef struct pgMessageField
146 struct pgMessageField *next; /* list link */
147 char code; /* field code */
148 char contents[1]; /* field value (VARIABLE LENGTH) */
151 /* Fields needed for notice handling */
154 PQnoticeReceiver noticeRec; /* notice message receiver */
156 PQnoticeProcessor noticeProc; /* notice message processor */
160 typedef struct PGEvent
162 PGEventProc proc; /* the function to call on events */
163 char *name; /* used only for error messages */
164 void *passThrough; /* pointer supplied at registration time */
165 void *data; /* optional state (instance) data */
166 bool resultInitialized; /* T if RESULTCREATE/COPY succeeded */
173 PGresAttDesc *attDescs;
174 PGresAttValue **tuples; /* each PGresTuple is an array of
176 int tupArrSize; /* allocated size of tuples array */
178 PGresParamDesc *paramDescs;
179 ExecStatusType resultStatus;
180 char cmdStatus[CMDSTATUS_LEN]; /* cmd status from the query */
181 int binary; /* binary tuple values if binary == 1,
185 * These fields are copied from the originating PGconn, so that operations
186 * on the PGresult don't have to reference the PGconn.
188 PGNoticeHooks noticeHooks;
191 int client_encoding; /* encoding id */
194 * Error information (all NULL if not an error result). errMsg is the
195 * "overall" error message returned by PQresultErrorMessage. If we have
196 * per-field info then it is stored in a linked list.
198 char *errMsg; /* error message, or NULL if no error */
199 PGMessageField *errFields; /* message broken into fields */
201 /* All NULL attributes in the query result point to this null string */
205 * Space management information. Note that attDescs and error stuff, if
206 * not null, point into allocated blocks. But tuples points to a
207 * separately malloc'd block, so that we can realloc it.
209 PGresult_data *curBlock; /* most recently allocated block */
210 int curOffset; /* start offset of free space in block */
211 int spaceLeft; /* number of free bytes remaining in block */
214 /* PGAsyncStatusType defines the state of the query-execution state machine */
217 PGASYNC_IDLE, /* nothing's happening, dude */
218 PGASYNC_BUSY, /* query in progress */
219 PGASYNC_READY, /* result ready for PQgetResult */
220 PGASYNC_COPY_IN, /* Copy In data transfer in progress */
221 PGASYNC_COPY_OUT, /* Copy Out data transfer in progress */
222 PGASYNC_COPY_BOTH /* Copy In/Out data transfer in progress */
225 /* PGQueryClass tracks which query protocol we are now executing */
228 PGQUERY_SIMPLE, /* simple Query protocol (PQexec) */
229 PGQUERY_EXTENDED, /* full Extended protocol (PQexecParams) */
230 PGQUERY_PREPARE, /* Parse only (PQprepare) */
231 PGQUERY_DESCRIBE /* Describe Statement or Portal */
234 /* PGSetenvStatusType defines the state of the PQSetenv state machine */
235 /* (this is used only for 2.0-protocol connections) */
238 SETENV_STATE_OPTION_SEND, /* About to send an Environment Option */
239 SETENV_STATE_OPTION_WAIT, /* Waiting for above send to complete */
240 SETENV_STATE_QUERY1_SEND, /* About to send a status query */
241 SETENV_STATE_QUERY1_WAIT, /* Waiting for query to complete */
242 SETENV_STATE_QUERY2_SEND, /* About to send a status query */
243 SETENV_STATE_QUERY2_WAIT, /* Waiting for query to complete */
245 } PGSetenvStatusType;
247 /* Typedef for the EnvironmentOptions[] array */
248 typedef struct PQEnvironmentOption
250 const char *envName, /* name of an environment variable */
251 *pgName; /* name of corresponding SET variable */
252 } PQEnvironmentOption;
254 /* Typedef for parameter-status list entries */
255 typedef struct pgParameterStatus
257 struct pgParameterStatus *next; /* list link */
258 char *name; /* parameter name */
259 char *value; /* parameter value */
260 /* Note: name and value are stored in same malloc block as struct is */
263 /* large-object-access data ... allocated only if large-object code is used. */
264 typedef struct pgLobjfuncs
266 Oid fn_lo_open; /* OID of backend function lo_open */
267 Oid fn_lo_close; /* OID of backend function lo_close */
268 Oid fn_lo_creat; /* OID of backend function lo_creat */
269 Oid fn_lo_create; /* OID of backend function lo_create */
270 Oid fn_lo_unlink; /* OID of backend function lo_unlink */
271 Oid fn_lo_lseek; /* OID of backend function lo_lseek */
272 Oid fn_lo_tell; /* OID of backend function lo_tell */
273 Oid fn_lo_truncate; /* OID of backend function lo_truncate */
274 Oid fn_lo_read; /* OID of backend function LOread */
275 Oid fn_lo_write; /* OID of backend function LOwrite */
279 * PGconn stores all the state data associated with a single connection
284 /* Saved values of connection options */
285 char *pghost; /* the machine on which the server is running */
286 char *pghostaddr; /* the numeric IP address of the machine on
287 * which the server is running. Takes
288 * precedence over above. */
289 char *pgport; /* the server's communication port */
290 char *pgunixsocket; /* the Unix-domain socket that the server is
291 * listening on; if NULL, uses a default
292 * constructed from pgport */
293 char *pgtty; /* tty on which the backend messages is
294 * displayed (OBSOLETE, NOT USED) */
295 char *connect_timeout; /* connection timeout (numeric string) */
296 char *pgoptions; /* options to start the backend with */
297 char *appname; /* application name */
298 char *fbappname; /* fallback application name */
299 char *dbName; /* database name */
300 char *replication; /* connect as the replication standby? */
301 char *pguser; /* Postgres username and password, if any */
303 char *keepalives; /* use TCP keepalives? */
304 char *keepalives_idle; /* time between TCP keepalives */
305 char *keepalives_interval; /* time between TCP keepalive
307 char *keepalives_count; /* maximum number of TCP keepalive
309 char *sslmode; /* SSL mode (require,prefer,allow,disable) */
310 char *sslkey; /* client key filename */
311 char *sslcert; /* client certificate filename */
312 char *sslrootcert; /* root certificate filename */
313 char *sslcrl; /* certificate revocation list filename */
314 char *requirepeer; /* required peer credentials for local sockets */
316 #if defined(KRB5) || defined(ENABLE_GSS) || defined(ENABLE_SSPI)
317 char *krbsrvname; /* Kerberos service name */
320 /* Optional file to write trace info to */
323 /* Callback procedures for notice message processing */
324 PGNoticeHooks noticeHooks;
326 /* Event procs registered via PQregisterEventProc */
327 PGEvent *events; /* expandable array of event data */
328 int nEvents; /* number of active events */
329 int eventArraySize; /* allocated array size */
331 /* Status indicators */
332 ConnStatusType status;
333 PGAsyncStatusType asyncStatus;
334 PGTransactionStatusType xactStatus; /* never changes to ACTIVE */
335 PGQueryClass queryclass;
336 char *last_query; /* last SQL command, or NULL if unknown */
337 char last_sqlstate[6]; /* last reported SQLSTATE */
338 bool options_valid; /* true if OK to attempt connection */
339 bool nonblocking; /* whether this connection is using nonblock
340 * sending semantics */
341 char copy_is_binary; /* 1 = copy binary, 0 = copy text */
342 int copy_already_done; /* # bytes already returned in COPY
344 PGnotify *notifyHead; /* oldest unreported Notify msg */
345 PGnotify *notifyTail; /* newest unreported Notify msg */
347 /* Connection data */
348 int sock; /* Unix FD for socket, -1 if not connected */
349 SockAddr laddr; /* Local address */
350 SockAddr raddr; /* Remote address */
351 ProtocolVersion pversion; /* FE/BE protocol version in use */
352 int sversion; /* server version, e.g. 70401 for 7.4.1 */
353 bool auth_req_received; /* true if any type of auth req received */
354 bool password_needed; /* true if server demanded a password */
355 bool dot_pgpass_used; /* true if used .pgpass */
356 bool sigpipe_so; /* have we masked SIGPIPE via SO_NOSIGPIPE? */
357 bool sigpipe_flag; /* can we mask SIGPIPE via MSG_NOSIGNAL? */
359 /* Transient state needed while establishing connection */
360 struct addrinfo *addrlist; /* list of possible backend addresses */
361 struct addrinfo *addr_cur; /* the one currently being tried */
362 int addrlist_family; /* needed to know how to free addrlist */
363 PGSetenvStatusType setenv_state; /* for 2.0 protocol only */
364 const PQEnvironmentOption *next_eo;
365 bool send_appname; /* okay to send application_name? */
367 /* Miscellaneous stuff */
368 int be_pid; /* PID of backend --- needed for cancels */
369 int be_key; /* key of backend --- needed for cancels */
370 char md5Salt[4]; /* password salt received from backend */
371 pgParameterStatus *pstatus; /* ParameterStatus data */
372 int client_encoding; /* encoding id */
373 bool std_strings; /* standard_conforming_strings */
374 PGVerbosity verbosity; /* error/notice message verbosity */
375 PGlobjfuncs *lobjfuncs; /* private state for large-object access fns */
377 /* Buffer for data received from backend and not yet processed */
378 char *inBuffer; /* currently allocated buffer */
379 int inBufSize; /* allocated size of buffer */
380 int inStart; /* offset to first unconsumed data in buffer */
381 int inCursor; /* next byte to tentatively consume */
382 int inEnd; /* offset to first position after avail data */
384 /* Buffer for data not yet sent to backend */
385 char *outBuffer; /* currently allocated buffer */
386 int outBufSize; /* allocated size of buffer */
387 int outCount; /* number of chars waiting in buffer */
389 /* State for constructing messages in outBuffer */
390 int outMsgStart; /* offset to msg start (length word); if -1,
391 * msg has no length word */
392 int outMsgEnd; /* offset to msg end (so far) */
394 /* Status for asynchronous result construction */
395 PGresult *result; /* result being constructed */
396 PGresAttValue *curTuple; /* tuple currently being read */
399 bool allow_ssl_try; /* Allowed to try SSL negotiation */
400 bool wait_ssl_try; /* Delay SSL negotiation until after
401 * attempting normal connection */
402 SSL *ssl; /* SSL status, if have SSL connection */
403 X509 *peer; /* X509 cert of server */
404 char peer_dn[256 + 1]; /* peer distinguished name */
405 char peer_cn[SM_USER + 1]; /* peer common name */
406 #ifdef USE_SSL_ENGINE
407 ENGINE *engine; /* SSL engine, if any */
409 void *engine; /* dummy field to keep struct the same if
410 * OpenSSL version changes */
415 gss_ctx_id_t gctx; /* GSS context */
416 gss_name_t gtarg_nam; /* GSS target name */
417 gss_buffer_desc ginbuf; /* GSS input token */
418 gss_buffer_desc goutbuf; /* GSS output token */
423 gss_buffer_desc ginbuf; /* GSS input token */
425 char *gsslib; /* What GSS librart to use ("gssapi" or
428 CredHandle *sspicred; /* SSPI credentials handle */
429 CtxtHandle *sspictx; /* SSPI context */
430 char *sspitarget; /* SSPI target name */
431 int usesspi; /* Indicate if SSPI is in use on the
436 /* Buffer for current error message */
437 PQExpBufferData errorMessage; /* expansible string */
439 /* Buffer for receiving various parts of messages */
440 PQExpBufferData workBuffer; /* expansible string */
443 /* PGcancel stores all data necessary to cancel a connection. A copy of this
444 * data is required to safely cancel a connection running on a different
449 SockAddr raddr; /* Remote address */
450 int be_pid; /* PID of backend --- needed for cancels */
451 int be_key; /* key of backend --- needed for cancels */
455 /* String descriptions of the ExecStatusTypes.
456 * direct use of this array is deprecated; call PQresStatus() instead.
458 extern char *const pgresStatus[];
461 * Internal functions of libpq
462 * Functions declared here need to be visible across files of libpq,
463 * but are not intended to be called by applications. We use the
464 * convention "pqXXX" for internal functions, vs. the "PQxxx" names
465 * used for application-visible routines.
469 /* === in fe-connect.c === */
471 extern int pqPacketSend(PGconn *conn, char pack_type,
472 const void *buf, size_t buf_len);
473 extern bool pqGetHomeDirectory(char *buf, int bufsize);
475 #ifdef ENABLE_THREAD_SAFETY
476 extern pgthreadlock_t pg_g_threadlock;
478 #define PGTHREAD_ERROR(msg) \
480 fprintf(stderr, "%s\n", msg); \
485 #define pglock_thread() pg_g_threadlock(true)
486 #define pgunlock_thread() pg_g_threadlock(false)
488 #define pglock_thread() ((void) 0)
489 #define pgunlock_thread() ((void) 0)
492 /* === in fe-exec.c === */
494 extern void pqSetResultError(PGresult *res, const char *msg);
495 extern void pqCatenateResultError(PGresult *res, const char *msg);
496 extern void *pqResultAlloc(PGresult *res, size_t nBytes, bool isBinary);
497 extern char *pqResultStrdup(PGresult *res, const char *str);
498 extern void pqClearAsyncResult(PGconn *conn);
499 extern void pqSaveErrorResult(PGconn *conn);
500 extern PGresult *pqPrepareAsyncResult(PGconn *conn);
502 pqInternalNotice(const PGNoticeHooks *hooks, const char *fmt,...)
503 /* This lets gcc check the format string for consistency. */
504 __attribute__((format(printf, 2, 3)));
505 extern int pqAddTuple(PGresult *res, PGresAttValue *tup);
506 extern void pqSaveMessageField(PGresult *res, char code,
508 extern void pqSaveParameterStatus(PGconn *conn, const char *name,
510 extern void pqHandleSendFailure(PGconn *conn);
512 /* === in fe-protocol2.c === */
514 extern PostgresPollingStatusType pqSetenvPoll(PGconn *conn);
516 extern char *pqBuildStartupPacket2(PGconn *conn, int *packetlen,
517 const PQEnvironmentOption *options);
518 extern void pqParseInput2(PGconn *conn);
519 extern int pqGetCopyData2(PGconn *conn, char **buffer, int async);
520 extern int pqGetline2(PGconn *conn, char *s, int maxlen);
521 extern int pqGetlineAsync2(PGconn *conn, char *buffer, int bufsize);
522 extern int pqEndcopy2(PGconn *conn);
523 extern PGresult *pqFunctionCall2(PGconn *conn, Oid fnid,
524 int *result_buf, int *actual_result_len,
526 const PQArgBlock *args, int nargs);
528 /* === in fe-protocol3.c === */
530 extern char *pqBuildStartupPacket3(PGconn *conn, int *packetlen,
531 const PQEnvironmentOption *options);
532 extern void pqParseInput3(PGconn *conn);
533 extern int pqGetErrorNotice3(PGconn *conn, bool isError);
534 extern int pqGetCopyData3(PGconn *conn, char **buffer, int async);
535 extern int pqGetline3(PGconn *conn, char *s, int maxlen);
536 extern int pqGetlineAsync3(PGconn *conn, char *buffer, int bufsize);
537 extern int pqEndcopy3(PGconn *conn);
538 extern PGresult *pqFunctionCall3(PGconn *conn, Oid fnid,
539 int *result_buf, int *actual_result_len,
541 const PQArgBlock *args, int nargs);
543 /* === in fe-misc.c === */
546 * "Get" and "Put" routines return 0 if successful, EOF if not. Note that for
547 * Get, EOF merely means the buffer is exhausted, not that there is
548 * necessarily any error.
550 extern int pqCheckOutBufferSpace(size_t bytes_needed, PGconn *conn);
551 extern int pqCheckInBufferSpace(size_t bytes_needed, PGconn *conn);
552 extern int pqGetc(char *result, PGconn *conn);
553 extern int pqPutc(char c, PGconn *conn);
554 extern int pqGets(PQExpBuffer buf, PGconn *conn);
555 extern int pqGets_append(PQExpBuffer buf, PGconn *conn);
556 extern int pqPuts(const char *s, PGconn *conn);
557 extern int pqGetnchar(char *s, size_t len, PGconn *conn);
558 extern int pqPutnchar(const char *s, size_t len, PGconn *conn);
559 extern int pqGetInt(int *result, size_t bytes, PGconn *conn);
560 extern int pqPutInt(int value, size_t bytes, PGconn *conn);
561 extern int pqPutMsgStart(char msg_type, bool force_len, PGconn *conn);
562 extern int pqPutMsgEnd(PGconn *conn);
563 extern int pqReadData(PGconn *conn);
564 extern int pqFlush(PGconn *conn);
565 extern int pqWait(int forRead, int forWrite, PGconn *conn);
566 extern int pqWaitTimed(int forRead, int forWrite, PGconn *conn,
568 extern int pqReadReady(PGconn *conn);
569 extern int pqWriteReady(PGconn *conn);
571 /* === in fe-secure.c === */
573 extern int pqsecure_initialize(PGconn *);
574 extern void pqsecure_destroy(void);
575 extern PostgresPollingStatusType pqsecure_open_client(PGconn *);
576 extern void pqsecure_close(PGconn *);
577 extern ssize_t pqsecure_read(PGconn *, void *ptr, size_t len);
578 extern ssize_t pqsecure_write(PGconn *, const void *ptr, size_t len);
580 #if defined(ENABLE_THREAD_SAFETY) && !defined(WIN32)
581 extern int pq_block_sigpipe(sigset_t *osigset, bool *sigpipe_pending);
582 extern void pq_reset_sigpipe(sigset_t *osigset, bool sigpipe_pending,
587 * this is so that we can check if a connection is non-blocking internally
588 * without the overhead of a function call
590 #define pqIsnonblocking(conn) ((conn)->nonblocking)
594 libpq_gettext(const char *msgid)
595 __attribute__((format_arg(1)));
597 #define libpq_gettext(x) (x)
601 * These macros are needed to let error-handling code be portable between
602 * Unix and Windows. (ugh)
605 #define SOCK_ERRNO (WSAGetLastError())
606 #define SOCK_STRERROR winsock_strerror
607 #define SOCK_ERRNO_SET(e) WSASetLastError(e)
609 #define SOCK_ERRNO errno
610 #define SOCK_STRERROR pqStrerror
611 #define SOCK_ERRNO_SET(e) (errno = (e))
614 #endif /* LIBPQ_INT_H */