PostgreSQL Source Code git master
Loading...
Searching...
No Matches
connection.c File Reference
#include "postgres.h"
#include <poll.h>
#include "access/htup_details.h"
#include "access/xact.h"
#include "catalog/pg_user_mapping.h"
#include "commands/defrem.h"
#include "common/base64.h"
#include "funcapi.h"
#include "libpq/libpq-be.h"
#include "libpq/libpq-be-fe-helpers.h"
#include "mb/pg_wchar.h"
#include "miscadmin.h"
#include "pgstat.h"
#include "postgres_fdw.h"
#include "storage/latch.h"
#include "utils/builtins.h"
#include "utils/hsearch.h"
#include "utils/inval.h"
#include "utils/syscache.h"
#include "utils/tuplestore.h"
Include dependency graph for connection.c:

Go to the source code of this file.

Data Structures

struct  ConnCacheEntry
 

Macros

#define CONNECTION_CLEANUP_TIMEOUT   30000
 
#define RETRY_CANCEL_TIMEOUT   1000
 
#define CONSTRUCT_ABORT_COMMAND(sql, entry, toplevel)
 
#define POSTGRES_FDW_GET_CONNECTIONS_COLS_V1_1   2
 
#define POSTGRES_FDW_GET_CONNECTIONS_COLS_V1_2   6
 
#define POSTGRES_FDW_GET_CONNECTIONS_COLS   6 /* maximum of above */
 

Typedefs

typedef Oid ConnCacheKey
 
typedef struct ConnCacheEntry ConnCacheEntry
 

Enumerations

enum  pgfdwVersion { PGFDW_V1_1 = 0 , PGFDW_V1_2 }
 

Functions

 PG_FUNCTION_INFO_V1 (postgres_fdw_get_connections)
 
 PG_FUNCTION_INFO_V1 (postgres_fdw_get_connections_1_2)
 
 PG_FUNCTION_INFO_V1 (postgres_fdw_disconnect)
 
 PG_FUNCTION_INFO_V1 (postgres_fdw_disconnect_all)
 
 PG_FUNCTION_INFO_V1 (postgres_fdw_connection)
 
static void make_new_connection (ConnCacheEntry *entry, UserMapping *user)
 
static PGconnconnect_pg_server (ForeignServer *server, UserMapping *user)
 
static void disconnect_pg_server (ConnCacheEntry *entry)
 
static void check_conn_params (const char **keywords, const char **values, UserMapping *user)
 
static void configure_remote_session (PGconn *conn)
 
static void do_sql_command_begin (PGconn *conn, const char *sql)
 
static void do_sql_command_end (PGconn *conn, const char *sql, bool consume_input)
 
static void begin_remote_xact (ConnCacheEntry *entry)
 
static void pgfdw_report_internal (int elevel, PGresult *res, PGconn *conn, const char *sql)
 
static void pgfdw_xact_callback (XactEvent event, void *arg)
 
static void pgfdw_subxact_callback (SubXactEvent event, SubTransactionId mySubid, SubTransactionId parentSubid, void *arg)
 
static void pgfdw_inval_callback (Datum arg, SysCacheIdentifier cacheid, uint32 hashvalue)
 
static void pgfdw_reject_incomplete_xact_state_change (ConnCacheEntry *entry)
 
static void pgfdw_reset_xact_state (ConnCacheEntry *entry, bool toplevel)
 
static bool pgfdw_cancel_query (PGconn *conn)
 
static bool pgfdw_cancel_query_begin (PGconn *conn, TimestampTz endtime)
 
static bool pgfdw_cancel_query_end (PGconn *conn, TimestampTz endtime, TimestampTz retrycanceltime, bool consume_input)
 
static bool pgfdw_exec_cleanup_query (PGconn *conn, const char *query, bool ignore_errors)
 
static bool pgfdw_exec_cleanup_query_begin (PGconn *conn, const char *query)
 
static bool pgfdw_exec_cleanup_query_end (PGconn *conn, const char *query, TimestampTz endtime, bool consume_input, bool ignore_errors)
 
static bool pgfdw_get_cleanup_result (PGconn *conn, TimestampTz endtime, TimestampTz retrycanceltime, PGresult **result, bool *timed_out)
 
static void pgfdw_abort_cleanup (ConnCacheEntry *entry, bool toplevel)
 
static bool pgfdw_abort_cleanup_begin (ConnCacheEntry *entry, bool toplevel, List **pending_entries, List **cancel_requested)
 
static void pgfdw_finish_pre_commit_cleanup (List *pending_entries)
 
static void pgfdw_finish_pre_subcommit_cleanup (List *pending_entries, int curlevel)
 
static void pgfdw_finish_abort_cleanup (List *pending_entries, List *cancel_requested, bool toplevel)
 
static void pgfdw_security_check (const char **keywords, const char **values, UserMapping *user, PGconn *conn)
 
static bool UserMappingPasswordRequired (UserMapping *user)
 
static bool UseScramPassthrough (ForeignServer *server, UserMapping *user)
 
static bool disconnect_cached_connections (Oid serverid)
 
static void postgres_fdw_get_connections_internal (FunctionCallInfo fcinfo, enum pgfdwVersion api_version)
 
static int pgfdw_conn_check (PGconn *conn)
 
static bool pgfdw_conn_checkable (void)
 
static bool pgfdw_has_required_scram_options (const char **keywords, const char **values)
 
PGconnGetConnection (UserMapping *user, bool will_prep_stmt, PgFdwConnState **state)
 
static void construct_connection_params (ForeignServer *server, UserMapping *user, const char ***p_keywords, const char ***p_values, char **p_appname)
 
void do_sql_command (PGconn *conn, const char *sql)
 
void ReleaseConnection (PGconn *conn)
 
unsigned int GetCursorNumber (PGconn *conn)
 
unsigned int GetPrepStmtNumber (PGconn *conn)
 
PGresultpgfdw_exec_query (PGconn *conn, const char *query, PgFdwConnState *state)
 
PGresultpgfdw_get_result (PGconn *conn)
 
void pgfdw_report_error (PGresult *res, PGconn *conn, const char *sql)
 
void pgfdw_report (int elevel, PGresult *res, PGconn *conn, const char *sql)
 
static void appendEscapedValue (StringInfo str, const char *val)
 
Datum postgres_fdw_connection (PG_FUNCTION_ARGS)
 
Datum postgres_fdw_get_connections_1_2 (PG_FUNCTION_ARGS)
 
Datum postgres_fdw_get_connections (PG_FUNCTION_ARGS)
 
Datum postgres_fdw_disconnect (PG_FUNCTION_ARGS)
 
Datum postgres_fdw_disconnect_all (PG_FUNCTION_ARGS)
 

Variables

static HTABConnectionHash = NULL
 
static unsigned int cursor_number = 0
 
static unsigned int prep_stmt_number = 0
 
static bool xact_got_connection = false
 
static int read_only_level = 0
 
static uint32 pgfdw_we_cleanup_result = 0
 
static uint32 pgfdw_we_connect = 0
 
static uint32 pgfdw_we_get_result = 0
 

Macro Definition Documentation

◆ CONNECTION_CLEANUP_TIMEOUT

#define CONNECTION_CLEANUP_TIMEOUT   30000

Definition at line 106 of file connection.c.

◆ CONSTRUCT_ABORT_COMMAND

#define CONSTRUCT_ABORT_COMMAND (   sql,
  entry,
  toplevel 
)
Value:
do { \
if (toplevel) \
snprintf((sql), sizeof(sql), \
"ABORT TRANSACTION"); \
snprintf((sql), sizeof(sql), \
"ROLLBACK TO SAVEPOINT s%d; RELEASE SAVEPOINT s%d", \
(entry)->xact_depth, (entry)->xact_depth); \
} while(0)
static int fb(int x)

Definition at line 116 of file connection.c.

117 { \
118 if (toplevel) \
119 snprintf((sql), sizeof(sql), \
120 "ABORT TRANSACTION"); \
122 snprintf((sql), sizeof(sql), \
123 "ROLLBACK TO SAVEPOINT s%d; RELEASE SAVEPOINT s%d", \
124 (entry)->xact_depth, (entry)->xact_depth); \
125 } while(0)

◆ POSTGRES_FDW_GET_CONNECTIONS_COLS

#define POSTGRES_FDW_GET_CONNECTIONS_COLS   6 /* maximum of above */

Definition at line 2279 of file connection.c.

◆ POSTGRES_FDW_GET_CONNECTIONS_COLS_V1_1

#define POSTGRES_FDW_GET_CONNECTIONS_COLS_V1_1   2

Definition at line 2277 of file connection.c.

◆ POSTGRES_FDW_GET_CONNECTIONS_COLS_V1_2

#define POSTGRES_FDW_GET_CONNECTIONS_COLS_V1_2   6

Definition at line 2278 of file connection.c.

◆ RETRY_CANCEL_TIMEOUT

#define RETRY_CANCEL_TIMEOUT   1000

Definition at line 113 of file connection.c.

Typedef Documentation

◆ ConnCacheEntry

◆ ConnCacheKey

Definition at line 54 of file connection.c.

Enumeration Type Documentation

◆ pgfdwVersion

Enumerator
PGFDW_V1_1 
PGFDW_V1_2 

Definition at line 130 of file connection.c.

131{
132 PGFDW_V1_1 = 0,
134};
@ PGFDW_V1_1
Definition connection.c:132
@ PGFDW_V1_2
Definition connection.c:133

Function Documentation

◆ appendEscapedValue()

static void appendEscapedValue ( StringInfo  str,
const char val 
)
static

Definition at line 2457 of file connection.c.

2458{
2460 for (int i = 0; val[i] != '\0'; i++)
2461 {
2462 if (val[i] == '\\' || val[i] == '\'')
2465 }
2467}
const char * str
long val
Definition informix.c:689
int i
Definition isn.c:77
void appendStringInfoChar(StringInfo str, char ch)
Definition stringinfo.c:242

References appendStringInfoChar(), i, str, and val.

Referenced by postgres_fdw_connection().

◆ begin_remote_xact()

static void begin_remote_xact ( ConnCacheEntry entry)
static

Definition at line 897 of file connection.c.

898{
900
901 /*
902 * If the current local (sub)transaction is read-only, set the topmost
903 * read-only local transaction's nesting level if we haven't yet.
904 *
905 * Note: once it's set, it's retained until the topmost read-only local
906 * transaction is committed/aborted (see pgfdw_xact_callback and
907 * pgfdw_subxact_callback).
908 */
909 if (XactReadOnly)
910 {
911 if (read_only_level == 0)
914 }
915 else
917
918 /*
919 * Start main transaction if we haven't yet; otherwise, change the current
920 * remote (sub)transaction's read/write mode if needed.
921 */
922 if (entry->xact_depth <= 0)
923 {
924 /*
925 * This is the case when we haven't yet started a main transaction.
926 */
927 StringInfoData sql;
928 bool ro = (read_only_level == 1);
929
930 elog(DEBUG3, "starting remote transaction on connection %p",
931 entry->conn);
932
933 initStringInfo(&sql);
934 appendStringInfoString(&sql, "START TRANSACTION ISOLATION LEVEL ");
936 appendStringInfoString(&sql, "SERIALIZABLE");
937 else
938 appendStringInfoString(&sql, "REPEATABLE READ");
939 if (ro)
940 appendStringInfoString(&sql, " READ ONLY");
941 if (XactDeferrable)
942 appendStringInfoString(&sql, " DEFERRABLE");
943 entry->changing_xact_state = true;
944 do_sql_command(entry->conn, sql.data);
945 entry->xact_depth = 1;
946 if (ro)
947 {
948 Assert(!entry->xact_read_only);
949 entry->xact_read_only = true;
950 }
951 entry->changing_xact_state = false;
952 }
953 else if (!entry->xact_read_only)
954 {
955 /*
956 * The remote (sub)transaction has been opened in read-write mode.
957 */
958 Assert(read_only_level == 0 ||
959 entry->xact_depth <= read_only_level);
960
961 /*
962 * If its nesting depth matches read_only_level, it means that the
963 * local read-write (sub)transaction that started it has changed to
964 * read-only after that; in which case change it to read-only as well.
965 * Otherwise, the local (sub)transaction is still read-write, so there
966 * is no need to do anything.
967 */
968 if (entry->xact_depth == read_only_level)
969 {
970 entry->changing_xact_state = true;
971 do_sql_command(entry->conn, "SET transaction_read_only = on");
972 entry->xact_read_only = true;
973 entry->changing_xact_state = false;
974 }
975 }
976 else
977 {
978 /*
979 * The remote (sub)transaction has been opened in read-only mode.
980 */
982 entry->xact_depth >= read_only_level);
983
984 /*
985 * The local read-only (sub)transaction that started it is guaranteed
986 * to be still read-only (see check_transaction_read_only), so there
987 * is no need to do anything.
988 */
989 }
990
991 /*
992 * If we're in a subtransaction, stack up savepoints to match our level.
993 * This ensures we can rollback just the desired effects when a
994 * subtransaction aborts.
995 */
996 while (entry->xact_depth < curlevel)
997 {
998 StringInfoData sql;
999 bool ro = (entry->xact_depth + 1 == read_only_level);
1000
1001 initStringInfo(&sql);
1002 appendStringInfo(&sql, "SAVEPOINT s%d", entry->xact_depth + 1);
1003 if (ro)
1004 appendStringInfoString(&sql, "; SET transaction_read_only = on");
1005 entry->changing_xact_state = true;
1006 do_sql_command(entry->conn, sql.data);
1007 entry->xact_depth++;
1008 if (ro)
1009 {
1010 Assert(!entry->xact_read_only);
1011 entry->xact_read_only = true;
1012 }
1013 entry->changing_xact_state = false;
1014 }
1015}
#define Assert(condition)
Definition c.h:943
void do_sql_command(PGconn *conn, const char *sql)
Definition connection.c:849
static int read_only_level
Definition connection.c:94
#define DEBUG3
Definition elog.h:29
#define elog(elevel,...)
Definition elog.h:228
void appendStringInfo(StringInfo str, const char *fmt,...)
Definition stringinfo.c:145
void appendStringInfoString(StringInfo str, const char *s)
Definition stringinfo.c:230
void initStringInfo(StringInfo str)
Definition stringinfo.c:97
PGconn * conn
Definition connection.c:59
bool changing_xact_state
Definition connection.c:66
bool xact_read_only
Definition connection.c:63
int GetCurrentTransactionNestLevel(void)
Definition xact.c:931
bool XactDeferrable
Definition xact.c:87
bool XactReadOnly
Definition xact.c:84
int GetTopReadOnlyTransactionNestLevel(void)
Definition xact.c:1062
#define IsolationIsSerializable()
Definition xact.h:53

References appendStringInfo(), appendStringInfoString(), Assert, ConnCacheEntry::changing_xact_state, ConnCacheEntry::conn, StringInfoData::data, DEBUG3, do_sql_command(), elog, fb(), GetCurrentTransactionNestLevel(), GetTopReadOnlyTransactionNestLevel(), initStringInfo(), IsolationIsSerializable, read_only_level, ConnCacheEntry::xact_depth, ConnCacheEntry::xact_read_only, XactDeferrable, and XactReadOnly.

Referenced by GetConnection().

◆ check_conn_params()

static void check_conn_params ( const char **  keywords,
const char **  values,
UserMapping user 
)
static

Definition at line 759 of file connection.c.

760{
761 int i;
762
763 /* no check required if superuser */
764 if (superuser_arg(user->userid))
765 return;
766
767#ifdef ENABLE_GSS
768 /* ok if the user provided their own delegated credentials */
770 return;
771#endif
772
773 /* ok if params contain a non-empty password */
774 for (i = 0; keywords[i] != NULL; i++)
775 {
776 if (strcmp(keywords[i], "password") == 0 && values[i][0] != '\0')
777 return;
778 }
779
780 /* ok if the superuser explicitly said so at user mapping creation time */
782 return;
783
784 /*
785 * Ok if SCRAM pass-through is being used and all required scram options
786 * are set correctly. If pgfdw_has_required_scram_options returns true we
787 * assume that UseScramPassthrough is also true since SCRAM options are
788 * only set when UseScramPassthrough is enabled.
789 */
791 return;
792
795 errmsg("password or GSSAPI delegated credentials required"),
796 errdetail("Non-superusers must delegate GSSAPI credentials, provide a password, or enable SCRAM pass-through in user mapping.")));
797}
bool be_gssapi_get_delegation(Port *port)
static Datum values[MAXATTR]
Definition bootstrap.c:190
static bool UserMappingPasswordRequired(UserMapping *user)
Definition connection.c:705
static bool pgfdw_has_required_scram_options(const char **keywords, const char **values)
int errcode(int sqlerrcode)
Definition elog.c:875
int errdetail(const char *fmt,...) pg_attribute_printf(1
#define ERROR
Definition elog.h:40
#define ereport(elevel,...)
Definition elog.h:152
struct Port * MyProcPort
Definition globals.c:53
static const JsonPathKeyword keywords[]
static char * errmsg
static char * user
Definition pg_regress.c:121
bool has_scram_keys
Definition libpq-be.h:188
bool superuser_arg(Oid roleid)
Definition superuser.c:57

References be_gssapi_get_delegation(), ereport, errcode(), errdetail(), errmsg, ERROR, fb(), Port::has_scram_keys, i, keywords, MyProcPort, pgfdw_has_required_scram_options(), superuser_arg(), user, UserMappingPasswordRequired(), and values.

Referenced by construct_connection_params().

◆ configure_remote_session()

static void configure_remote_session ( PGconn conn)
static

Definition at line 811 of file connection.c.

812{
814
815 /* Force the search path to contain only pg_catalog (see deparse.c) */
816 do_sql_command(conn, "SET search_path = pg_catalog");
817
818 /*
819 * Set remote timezone; this is basically just cosmetic, since all
820 * transmitted and returned timestamptzs should specify a zone explicitly
821 * anyway. However it makes the regression test outputs more predictable.
822 *
823 * We don't risk setting remote zone equal to ours, since the remote
824 * server might use a different timezone database. Instead, use GMT
825 * (quoted, because very old servers are picky about case). That's
826 * guaranteed to work regardless of the remote's timezone database,
827 * because pg_tzset() hard-wires it (at least in PG 9.2 and later).
828 */
829 do_sql_command(conn, "SET timezone = 'GMT'");
830
831 /*
832 * Set values needed to ensure unambiguous data output from remote. (This
833 * logic should match what pg_dump does. See also set_transmission_modes
834 * in postgres_fdw.c.)
835 */
836 do_sql_command(conn, "SET datestyle = ISO");
837 if (remoteversion >= 80400)
838 do_sql_command(conn, "SET intervalstyle = postgres");
839 if (remoteversion >= 90000)
840 do_sql_command(conn, "SET extra_float_digits = 3");
841 else
842 do_sql_command(conn, "SET extra_float_digits = 2");
843}
int PQserverVersion(const PGconn *conn)
PGconn * conn
Definition streamutil.c:52

References conn, do_sql_command(), fb(), and PQserverVersion().

Referenced by connect_pg_server().

◆ connect_pg_server()

static PGconn * connect_pg_server ( ForeignServer server,
UserMapping user 
)
static

Definition at line 629 of file connection.c.

630{
631 PGconn *volatile conn = NULL;
632
633 /*
634 * Use PG_TRY block to ensure closing connection on error.
635 */
636 PG_TRY();
637 {
638 const char **keywords;
639 const char **values;
640 char *appname;
642
643 construct_connection_params(server, user, &keywords, &values, &appname);
644
645 /* first time, allocate or get the custom wait event */
646 if (pgfdw_we_connect == 0)
647 pgfdw_we_connect = WaitEventExtensionNew("PostgresFdwConnect");
648
649 /* OK to make connection */
650 start_conn =
652 /* expand_dbname = */ false);
654 "received message via remote connection");
657
658 if (!conn || PQstatus(conn) != CONNECTION_OK)
661 errmsg("could not connect to server \"%s\"",
662 server->servername),
664
665 /* Perform post-connection security checks. */
667
668 /* Prepare new session for use */
670
671 if (appname != NULL)
672 pfree(appname);
674 pfree(values);
675 }
676 PG_CATCH();
677 {
679 PG_RE_THROW();
680 }
681 PG_END_TRY();
682
683 return conn;
684}
static void construct_connection_params(ForeignServer *server, UserMapping *user, const char ***p_keywords, const char ***p_values, char **p_appname)
Definition connection.c:495
static void configure_remote_session(PGconn *conn)
Definition connection.c:811
static void pgfdw_security_check(const char **keywords, const char **values, UserMapping *user, PGconn *conn)
Definition connection.c:446
static uint32 pgfdw_we_connect
Definition connection.c:98
#define PG_RE_THROW()
Definition elog.h:407
int int errdetail_internal(const char *fmt,...) pg_attribute_printf(1
#define PG_TRY(...)
Definition elog.h:374
#define PG_END_TRY(...)
Definition elog.h:399
#define PG_CATCH(...)
Definition elog.h:384
ConnStatusType PQstatus(const PGconn *conn)
PQnoticeReceiver PQsetNoticeReceiver(PGconn *conn, PQnoticeReceiver proc, void *arg)
char * PQerrorMessage(const PGconn *conn)
static void libpqsrv_connect_complete(PGconn *conn, uint32 wait_event_info)
static void libpqsrv_notice_receiver(void *arg, const PGresult *res)
static void libpqsrv_disconnect(PGconn *conn)
static PGconn * libpqsrv_connect_params_start(const char *const *keywords, const char *const *values, int expand_dbname)
@ CONNECTION_OK
Definition libpq-fe.h:90
void pfree(void *pointer)
Definition mcxt.c:1619
char * pchomp(const char *in)
Definition mcxt.c:1938
char * servername
Definition foreign.h:40
static void start_conn(const ClusterInfo *cluster, UpgradeTaskSlot *slot)
Definition task.c:174
uint32 WaitEventExtensionNew(const char *wait_event_name)
Definition wait_event.c:149

References configure_remote_session(), conn, CONNECTION_OK, construct_connection_params(), ereport, errcode(), errdetail_internal(), errmsg, ERROR, fb(), keywords, libpqsrv_connect_complete(), libpqsrv_connect_params_start(), libpqsrv_disconnect(), libpqsrv_notice_receiver(), pchomp(), pfree(), PG_CATCH, PG_END_TRY, PG_RE_THROW, PG_TRY, pgfdw_security_check(), pgfdw_we_connect, PQerrorMessage(), PQsetNoticeReceiver(), PQstatus(), ForeignServer::servername, start_conn(), user, values, and WaitEventExtensionNew().

Referenced by make_new_connection().

◆ construct_connection_params()

static void construct_connection_params ( ForeignServer server,
UserMapping user,
const char ***  p_keywords,
const char ***  p_values,
char **  p_appname 
)
static

Definition at line 495 of file connection.c.

498{
499 const char **keywords;
500 const char **values;
501 char *appname = NULL;
502 int n;
503
504 /*
505 * Add 4 extra slots for application_name, fallback_application_name,
506 * client_encoding, end marker, and 3 extra slots for scram keys and
507 * required scram pass-through options.
508 */
509 n = list_length(server->options) + list_length(user->options) + 4 + 3;
510 keywords = (const char **) palloc(n * sizeof(char *));
511 values = (const char **) palloc(n * sizeof(char *));
512
513 n = 0;
515 keywords + n, values + n);
516 n += ExtractConnectionOptions(user->options,
517 keywords + n, values + n);
518
519 /*
520 * Use pgfdw_application_name as application_name if set.
521 *
522 * PQconnectdbParams() processes the parameter arrays from start to end.
523 * If any key word is repeated, the last value is used. Therefore note
524 * that pgfdw_application_name must be added to the arrays after options
525 * of ForeignServer are, so that it can override application_name set in
526 * ForeignServer.
527 */
529 {
530 keywords[n] = "application_name";
532 n++;
533 }
534
535 /*
536 * Search the parameter arrays to find application_name setting, and
537 * replace escape sequences in it with status information if found. The
538 * arrays are searched backwards because the last value is used if
539 * application_name is repeatedly set.
540 */
541 for (int i = n - 1; i >= 0; i--)
542 {
543 if (strcmp(keywords[i], "application_name") == 0 &&
544 *(values[i]) != '\0')
545 {
546 /*
547 * Use this application_name setting if it's not empty string even
548 * after any escape sequences in it are replaced.
549 */
550 appname = process_pgfdw_appname(values[i]);
551 if (appname[0] != '\0')
552 {
553 values[i] = appname;
554 break;
555 }
556
557 /*
558 * This empty application_name is not used, so we set values[i] to
559 * NULL and keep searching the array to find the next one.
560 */
561 values[i] = NULL;
562 pfree(appname);
563 appname = NULL;
564 }
565 }
566
567 *p_appname = appname;
568
569 /* Use "postgres_fdw" as fallback_application_name */
570 keywords[n] = "fallback_application_name";
571 values[n] = "postgres_fdw";
572 n++;
573
574 /* Set client_encoding so that libpq can convert encoding properly. */
575 keywords[n] = "client_encoding";
577 n++;
578
579 /* Add required SCRAM pass-through connection options if it's enabled. */
581 {
582 int len;
583 int encoded_len;
584
585 keywords[n] = "scram_client_key";
587 /* don't forget the zero-terminator */
588 values[n] = palloc0(len + 1);
591 (char *) values[n], len);
592 if (encoded_len < 0)
593 elog(ERROR, "could not encode SCRAM client key");
594 n++;
595
596 keywords[n] = "scram_server_key";
598 /* don't forget the zero-terminator */
599 values[n] = palloc0(len + 1);
602 (char *) values[n], len);
603 if (encoded_len < 0)
604 elog(ERROR, "could not encode SCRAM server key");
605 n++;
606
607 /*
608 * Require scram-sha-256 to ensure that no other auth method is used
609 * when connecting with foreign server.
610 */
611 keywords[n] = "require_auth";
612 values[n] = "scram-sha-256";
613 n++;
614 }
615
616 keywords[n] = values[n] = NULL;
617
618 /* Verify the set of connection parameters. */
620
622 *p_values = values;
623}
int pg_b64_enc_len(int srclen)
Definition base64.c:224
int pg_b64_encode(const uint8 *src, int len, char *dst, int dstlen)
Definition base64.c:49
static bool UseScramPassthrough(ForeignServer *server, UserMapping *user)
Definition connection.c:727
static void check_conn_params(const char **keywords, const char **values, UserMapping *user)
Definition connection.c:759
int ExtractConnectionOptions(List *defelems, const char **keywords, const char **values)
Definition option.c:419
char * pgfdw_application_name
Definition option.c:46
char * process_pgfdw_appname(const char *appname)
Definition option.c:496
const char * GetDatabaseEncodingName(void)
Definition mbutils.c:1395
void * palloc0(Size size)
Definition mcxt.c:1420
void * palloc(Size size)
Definition mcxt.c:1390
const void size_t len
static int list_length(const List *l)
Definition pg_list.h:152
List * options
Definition foreign.h:43
uint8 scram_ServerKey[SCRAM_MAX_KEY_LEN]
Definition libpq-be.h:187
uint8 scram_ClientKey[SCRAM_MAX_KEY_LEN]
Definition libpq-be.h:186

References check_conn_params(), elog, ERROR, ExtractConnectionOptions(), fb(), GetDatabaseEncodingName(), Port::has_scram_keys, i, keywords, len, list_length(), MyProcPort, ForeignServer::options, palloc(), palloc0(), pfree(), pg_b64_enc_len(), pg_b64_encode(), pgfdw_application_name, process_pgfdw_appname(), Port::scram_ClientKey, Port::scram_ServerKey, user, UseScramPassthrough(), and values.

Referenced by connect_pg_server(), and postgres_fdw_connection().

◆ disconnect_cached_connections()

static bool disconnect_cached_connections ( Oid  serverid)
static

Definition at line 2587 of file connection.c.

2588{
2589 HASH_SEQ_STATUS scan;
2590 ConnCacheEntry *entry;
2591 bool all = !OidIsValid(serverid);
2592 bool result = false;
2593
2594 /*
2595 * Connection cache hashtable has not been initialized yet in this
2596 * session, so return false.
2597 */
2598 if (!ConnectionHash)
2599 return false;
2600
2602 while ((entry = (ConnCacheEntry *) hash_seq_search(&scan)))
2603 {
2604 /* Ignore cache entry if no open connection right now. */
2605 if (!entry->conn)
2606 continue;
2607
2608 if (all || entry->serverid == serverid)
2609 {
2610 /*
2611 * Emit a warning because the connection to close is used in the
2612 * current transaction and cannot be disconnected right now.
2613 */
2614 if (entry->xact_depth > 0)
2615 {
2616 ForeignServer *server;
2617
2618 server = GetForeignServerExtended(entry->serverid,
2620
2621 if (!server)
2622 {
2623 /*
2624 * If the foreign server was dropped while its connection
2625 * was used in the current transaction, the connection
2626 * must have been marked as invalid by
2627 * pgfdw_inval_callback at the end of DROP SERVER command.
2628 */
2629 Assert(entry->invalidated);
2630
2632 (errmsg("cannot close dropped server connection because it is still in use")));
2633 }
2634 else
2636 (errmsg("cannot close connection for server \"%s\" because it is still in use",
2637 server->servername)));
2638 }
2639 else
2640 {
2641 elog(DEBUG3, "discarding connection %p", entry->conn);
2642 disconnect_pg_server(entry);
2643 result = true;
2644 }
2645 }
2646 }
2647
2648 return result;
2649}
#define OidIsValid(objectId)
Definition c.h:858
uint32 result
static void disconnect_pg_server(ConnCacheEntry *entry)
Definition connection.c:690
static HTAB * ConnectionHash
Definition connection.c:81
void * hash_seq_search(HASH_SEQ_STATUS *status)
Definition dynahash.c:1352
void hash_seq_init(HASH_SEQ_STATUS *status, HTAB *hashp)
Definition dynahash.c:1317
#define WARNING
Definition elog.h:37
ForeignServer * GetForeignServerExtended(Oid serverid, uint16 flags)
Definition foreign.c:126
#define FSV_MISSING_OK
Definition foreign.h:62

References Assert, ConnCacheEntry::conn, ConnectionHash, DEBUG3, disconnect_pg_server(), elog, ereport, errmsg, FSV_MISSING_OK, GetForeignServerExtended(), hash_seq_init(), hash_seq_search(), ConnCacheEntry::invalidated, OidIsValid, result, ConnCacheEntry::serverid, ForeignServer::servername, WARNING, and ConnCacheEntry::xact_depth.

Referenced by postgres_fdw_disconnect(), and postgres_fdw_disconnect_all().

◆ disconnect_pg_server()

static void disconnect_pg_server ( ConnCacheEntry entry)
static

Definition at line 690 of file connection.c.

691{
692 if (entry->conn != NULL)
693 {
695 entry->conn = NULL;
696 }
697}

References ConnCacheEntry::conn, fb(), and libpqsrv_disconnect().

Referenced by disconnect_cached_connections(), GetConnection(), pgfdw_inval_callback(), and pgfdw_reset_xact_state().

◆ do_sql_command()

void do_sql_command ( PGconn conn,
const char sql 
)

Definition at line 849 of file connection.c.

850{
852 do_sql_command_end(conn, sql, false);
853}
static void do_sql_command_end(PGconn *conn, const char *sql, bool consume_input)
Definition connection.c:863
static void do_sql_command_begin(PGconn *conn, const char *sql)
Definition connection.c:856

References conn, do_sql_command_begin(), and do_sql_command_end().

Referenced by begin_remote_xact(), configure_remote_session(), pgfdw_subxact_callback(), pgfdw_xact_callback(), and postgresExecForeignTruncate().

◆ do_sql_command_begin()

static void do_sql_command_begin ( PGconn conn,
const char sql 
)
static

Definition at line 856 of file connection.c.

857{
858 if (!PQsendQuery(conn, sql))
860}
void pgfdw_report_error(PGresult *res, PGconn *conn, const char *sql)
int PQsendQuery(PGconn *conn, const char *query)
Definition fe-exec.c:1433

References conn, fb(), pgfdw_report_error(), and PQsendQuery().

Referenced by do_sql_command(), pgfdw_subxact_callback(), and pgfdw_xact_callback().

◆ do_sql_command_end()

static void do_sql_command_end ( PGconn conn,
const char sql,
bool  consume_input 
)
static

Definition at line 863 of file connection.c.

864{
865 PGresult *res;
866
867 /*
868 * If requested, consume whatever data is available from the socket. (Note
869 * that if all data is available, this allows pgfdw_get_result to call
870 * PQgetResult without forcing the overhead of WaitLatchOrSocket, which
871 * would be large compared to the overhead of PQconsumeInput.)
872 */
875 res = pgfdw_get_result(conn);
877 pgfdw_report_error(res, conn, sql);
878 PQclear(res);
879}
PGresult * pgfdw_get_result(PGconn *conn)
int PQconsumeInput(PGconn *conn)
Definition fe-exec.c:2001
#define PQclear
#define PQresultStatus
@ PGRES_COMMAND_OK
Definition libpq-fe.h:131

References conn, fb(), pgfdw_get_result(), pgfdw_report_error(), PGRES_COMMAND_OK, PQclear, PQconsumeInput(), and PQresultStatus.

Referenced by do_sql_command(), pgfdw_finish_pre_commit_cleanup(), and pgfdw_finish_pre_subcommit_cleanup().

◆ GetConnection()

PGconn * GetConnection ( UserMapping user,
bool  will_prep_stmt,
PgFdwConnState **  state 
)

Definition at line 216 of file connection.c.

217{
218 bool found;
219 bool retry = false;
220 ConnCacheEntry *entry;
223
224 /* First time through, initialize connection cache hashtable */
225 if (ConnectionHash == NULL)
226 {
227 HASHCTL ctl;
228
229 if (pgfdw_we_get_result == 0)
231 WaitEventExtensionNew("PostgresFdwGetResult");
232
233 ctl.keysize = sizeof(ConnCacheKey);
234 ctl.entrysize = sizeof(ConnCacheEntry);
235 ConnectionHash = hash_create("postgres_fdw connections", 8,
236 &ctl,
238
239 /*
240 * Register some callback functions that manage connection cleanup.
241 * This should be done just once in each backend.
242 */
249 }
250
251 /* Set flag that we did GetConnection during the current transaction */
252 xact_got_connection = true;
253
254 /* Create hash key for the entry. Assume no pad bytes in key struct */
255 key = user->umid;
256
257 /*
258 * Find or create cached entry for requested connection.
259 */
260 entry = hash_search(ConnectionHash, &key, HASH_ENTER, &found);
261 if (!found)
262 {
263 /*
264 * We need only clear "conn" here; remaining fields will be filled
265 * later when "conn" is set.
266 */
267 entry->conn = NULL;
268 }
269
270 /* Reject further use of connections which failed abort cleanup. */
272
273 /*
274 * If the connection needs to be remade due to invalidation, disconnect as
275 * soon as we're out of all transactions.
276 */
277 if (entry->conn != NULL && entry->invalidated && entry->xact_depth == 0)
278 {
279 elog(DEBUG3, "closing connection %p for option changes to take effect",
280 entry->conn);
282 }
283
284 /*
285 * If cache entry doesn't have a connection, we have to establish a new
286 * connection. (If connect_pg_server throws an error, the cache entry
287 * will remain in a valid empty state, ie conn == NULL.)
288 */
289 if (entry->conn == NULL)
291
292 /*
293 * We check the health of the cached connection here when using it. In
294 * cases where we're out of all transactions, if a broken connection is
295 * detected, we try to reestablish a new connection later.
296 */
297 PG_TRY();
298 {
299 /* Process a pending asynchronous request if any. */
300 if (entry->state.pendingAreq)
302 /* Start a new transaction or subtransaction if needed. */
303 begin_remote_xact(entry);
304 }
305 PG_CATCH();
306 {
309
310 /*
311 * Determine whether to try to reestablish the connection.
312 *
313 * After a broken connection is detected in libpq, any error other
314 * than connection failure (e.g., out-of-memory) can be thrown
315 * somewhere between return from libpq and the expected ereport() call
316 * in pgfdw_report_error(). In this case, since PQstatus() indicates
317 * CONNECTION_BAD, checking only PQstatus() causes the false detection
318 * of connection failure. To avoid this, we also verify that the
319 * error's sqlstate is ERRCODE_CONNECTION_FAILURE. Note that also
320 * checking only the sqlstate can cause another false detection
321 * because pgfdw_report_error() may report ERRCODE_CONNECTION_FAILURE
322 * for any libpq-originated error condition.
323 */
324 if (errdata->sqlerrcode != ERRCODE_CONNECTION_FAILURE ||
325 PQstatus(entry->conn) != CONNECTION_BAD ||
326 entry->xact_depth > 0)
327 {
329 PG_RE_THROW();
330 }
331
332 /* Clean up the error state */
335 errdata = NULL;
336
337 retry = true;
338 }
339 PG_END_TRY();
340
341 /*
342 * If a broken connection is detected, disconnect it, reestablish a new
343 * connection and retry a new remote transaction. If connection failure is
344 * reported again, we give up getting a connection.
345 */
346 if (retry)
347 {
348 Assert(entry->xact_depth == 0);
349
351 (errmsg_internal("could not start remote transaction on connection %p",
352 entry->conn)),
354
355 elog(DEBUG3, "closing connection %p to reestablish a new one",
356 entry->conn);
358
360
361 begin_remote_xact(entry);
362 }
363
364 /* Remember if caller will prepare statements */
366
367 /* If caller needs access to the per-connection state, return it. */
368 if (state)
369 *state = &entry->state;
370
371 return entry->conn;
372}
Oid ConnCacheKey
Definition connection.c:54
static uint32 pgfdw_we_get_result
Definition connection.c:99
static bool xact_got_connection
Definition connection.c:88
static void make_new_connection(ConnCacheEntry *entry, UserMapping *user)
Definition connection.c:379
static void pgfdw_subxact_callback(SubXactEvent event, SubTransactionId mySubid, SubTransactionId parentSubid, void *arg)
static void pgfdw_reject_incomplete_xact_state_change(ConnCacheEntry *entry)
static void pgfdw_xact_callback(XactEvent event, void *arg)
static void begin_remote_xact(ConnCacheEntry *entry)
Definition connection.c:897
static void pgfdw_inval_callback(Datum arg, SysCacheIdentifier cacheid, uint32 hashvalue)
void * hash_search(HTAB *hashp, const void *keyPtr, HASHACTION action, bool *foundPtr)
Definition dynahash.c:889
HTAB * hash_create(const char *tabname, int64 nelem, const HASHCTL *info, int flags)
Definition dynahash.c:360
void FreeErrorData(ErrorData *edata)
Definition elog.c:2014
ErrorData * CopyErrorData(void)
Definition elog.c:1942
void FlushErrorState(void)
Definition elog.c:2063
int int errmsg_internal(const char *fmt,...) pg_attribute_printf(1
@ HASH_ENTER
Definition hsearch.h:109
#define HASH_ELEM
Definition hsearch.h:90
#define HASH_BLOBS
Definition hsearch.h:92
void CacheRegisterSyscacheCallback(SysCacheIdentifier cacheid, SyscacheCallbackFunction func, Datum arg)
Definition inval.c:1813
@ CONNECTION_BAD
Definition libpq-fe.h:91
MemoryContext CurrentMemoryContext
Definition mcxt.c:161
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition palloc.h:138
uint64_t Datum
Definition postgres.h:70
void process_pending_request(AsyncRequest *areq)
tree ctl
Definition radixtree.h:1838
bool have_prep_stmt
Definition connection.c:64
PgFdwConnState state
Definition connection.c:75
AsyncRequest * pendingAreq
void RegisterXactCallback(XactCallback callback, void *arg)
Definition xact.c:3855
void RegisterSubXactCallback(SubXactCallback callback, void *arg)
Definition xact.c:3915

References Assert, begin_remote_xact(), CacheRegisterSyscacheCallback(), ConnCacheEntry::conn, CONNECTION_BAD, ConnectionHash, CopyErrorData(), ctl, CurrentMemoryContext, DEBUG3, disconnect_pg_server(), elog, ereport, errdetail_internal(), errmsg_internal(), fb(), FlushErrorState(), FreeErrorData(), HASH_BLOBS, hash_create(), HASH_ELEM, HASH_ENTER, hash_search(), ConnCacheEntry::have_prep_stmt, ConnCacheEntry::invalidated, make_new_connection(), MemoryContextSwitchTo(), pchomp(), PgFdwConnState::pendingAreq, PG_CATCH, PG_END_TRY, PG_RE_THROW, PG_TRY, pgfdw_inval_callback(), pgfdw_reject_incomplete_xact_state_change(), pgfdw_subxact_callback(), pgfdw_we_get_result, pgfdw_xact_callback(), PQerrorMessage(), PQstatus(), process_pending_request(), RegisterSubXactCallback(), RegisterXactCallback(), ConnCacheEntry::state, user, WaitEventExtensionNew(), ConnCacheEntry::xact_depth, and xact_got_connection.

◆ GetCursorNumber()

unsigned int GetCursorNumber ( PGconn conn)

Definition at line 1042 of file connection.c.

1043{
1044 return ++cursor_number;
1045}
static unsigned int cursor_number
Definition connection.c:84

References cursor_number.

Referenced by postgresAcquireSampleRowsFunc(), and postgresBeginForeignScan().

◆ GetPrepStmtNumber()

unsigned int GetPrepStmtNumber ( PGconn conn)

Definition at line 1056 of file connection.c.

1057{
1058 return ++prep_stmt_number;
1059}
static unsigned int prep_stmt_number
Definition connection.c:85

References prep_stmt_number.

Referenced by prepare_foreign_modify().

◆ make_new_connection()

static void make_new_connection ( ConnCacheEntry entry,
UserMapping user 
)
static

Definition at line 379 of file connection.c.

380{
381 ForeignServer *server = GetForeignServer(user->serverid);
382 ListCell *lc;
383
384 Assert(entry->conn == NULL);
385
386 /* Reset all transient state fields, to be sure all are clean */
387 entry->xact_depth = 0;
388 entry->xact_read_only = false;
389 entry->have_prep_stmt = false;
390 entry->have_error = false;
391 entry->changing_xact_state = false;
392 entry->invalidated = false;
393 entry->serverid = server->serverid;
394 entry->server_hashvalue =
396 ObjectIdGetDatum(server->serverid));
397 entry->mapping_hashvalue =
399 ObjectIdGetDatum(user->umid));
400 memset(&entry->state, 0, sizeof(entry->state));
401
402 /*
403 * Determine whether to keep the connection that we're about to make here
404 * open even after the transaction using it ends, so that the subsequent
405 * transactions can re-use it.
406 *
407 * By default, all the connections to any foreign servers are kept open.
408 *
409 * Also determine whether to commit/abort (sub)transactions opened on the
410 * remote server in parallel at (sub)transaction end, which is disabled by
411 * default.
412 *
413 * Note: it's enough to determine these only when making a new connection
414 * because if these settings for it are changed, it will be closed and
415 * re-made later.
416 */
417 entry->keep_connections = true;
418 entry->parallel_commit = false;
419 entry->parallel_abort = false;
420 foreach(lc, server->options)
421 {
422 DefElem *def = (DefElem *) lfirst(lc);
423
424 if (strcmp(def->defname, "keep_connections") == 0)
425 entry->keep_connections = defGetBoolean(def);
426 else if (strcmp(def->defname, "parallel_commit") == 0)
427 entry->parallel_commit = defGetBoolean(def);
428 else if (strcmp(def->defname, "parallel_abort") == 0)
429 entry->parallel_abort = defGetBoolean(def);
430 }
431
432 /* Now try to make the connection */
433 entry->conn = connect_pg_server(server, user);
434
435 elog(DEBUG3, "new postgres_fdw connection %p for server \"%s\" (user mapping oid %u, userid %u)",
436 entry->conn, server->servername, user->umid, user->userid);
437}
static PGconn * connect_pg_server(ForeignServer *server, UserMapping *user)
Definition connection.c:629
bool defGetBoolean(DefElem *def)
Definition define.c:93
ForeignServer * GetForeignServer(Oid serverid)
Definition foreign.c:114
#define lfirst(lc)
Definition pg_list.h:172
static Datum ObjectIdGetDatum(Oid X)
Definition postgres.h:252
bool parallel_commit
Definition connection.c:67
uint32 server_hashvalue
Definition connection.c:73
uint32 mapping_hashvalue
Definition connection.c:74
bool keep_connections
Definition connection.c:70
bool parallel_abort
Definition connection.c:68
char * defname
Definition parsenodes.h:860
#define GetSysCacheHashValue1(cacheId, key1)
Definition syscache.h:118

References Assert, ConnCacheEntry::changing_xact_state, ConnCacheEntry::conn, connect_pg_server(), DEBUG3, defGetBoolean(), DefElem::defname, elog, fb(), GetForeignServer(), GetSysCacheHashValue1, ConnCacheEntry::have_error, ConnCacheEntry::have_prep_stmt, ConnCacheEntry::invalidated, ConnCacheEntry::keep_connections, lfirst, ConnCacheEntry::mapping_hashvalue, ObjectIdGetDatum(), ForeignServer::options, ConnCacheEntry::parallel_abort, ConnCacheEntry::parallel_commit, ConnCacheEntry::server_hashvalue, ConnCacheEntry::serverid, ForeignServer::serverid, ForeignServer::servername, ConnCacheEntry::state, user, ConnCacheEntry::xact_depth, and ConnCacheEntry::xact_read_only.

Referenced by GetConnection().

◆ PG_FUNCTION_INFO_V1() [1/5]

PG_FUNCTION_INFO_V1 ( postgres_fdw_connection  )

◆ PG_FUNCTION_INFO_V1() [2/5]

PG_FUNCTION_INFO_V1 ( postgres_fdw_disconnect  )

◆ PG_FUNCTION_INFO_V1() [3/5]

PG_FUNCTION_INFO_V1 ( postgres_fdw_disconnect_all  )

◆ PG_FUNCTION_INFO_V1() [4/5]

PG_FUNCTION_INFO_V1 ( postgres_fdw_get_connections  )

◆ PG_FUNCTION_INFO_V1() [5/5]

PG_FUNCTION_INFO_V1 ( postgres_fdw_get_connections_1_2  )

◆ pgfdw_abort_cleanup()

static void pgfdw_abort_cleanup ( ConnCacheEntry entry,
bool  toplevel 
)
static

Definition at line 1874 of file connection.c.

1875{
1876 char sql[100];
1877
1878 /*
1879 * Don't try to clean up the connection if we're already in error
1880 * recursion trouble.
1881 */
1883 entry->changing_xact_state = true;
1884
1885 /*
1886 * If connection is already unsalvageable, don't touch it further.
1887 */
1888 if (entry->changing_xact_state)
1889 return;
1890
1891 /*
1892 * Mark this connection as in the process of changing transaction state.
1893 */
1894 entry->changing_xact_state = true;
1895
1896 /* Assume we might have lost track of prepared statements */
1897 entry->have_error = true;
1898
1899 /*
1900 * If a command has been submitted to the remote server by using an
1901 * asynchronous execution function, the command might not have yet
1902 * completed. Check to see if a command is still being processed by the
1903 * remote server, and if so, request cancellation of the command.
1904 */
1905 if (PQtransactionStatus(entry->conn) == PQTRANS_ACTIVE &&
1906 !pgfdw_cancel_query(entry->conn))
1907 return; /* Unable to cancel running query */
1908
1909 CONSTRUCT_ABORT_COMMAND(sql, entry, toplevel);
1910 if (!pgfdw_exec_cleanup_query(entry->conn, sql, false))
1911 return; /* Unable to abort remote (sub)transaction */
1912
1913 if (toplevel)
1914 {
1915 if (entry->have_prep_stmt && entry->have_error &&
1917 "DEALLOCATE ALL",
1918 true))
1919 return; /* Trouble clearing prepared statements */
1920
1921 entry->have_prep_stmt = false;
1922 entry->have_error = false;
1923 }
1924
1925 /*
1926 * If pendingAreq of the per-connection state is not NULL, it means that
1927 * an asynchronous fetch begun by fetch_more_data_begin() was not done
1928 * successfully and thus the per-connection state was not reset in
1929 * fetch_more_data(); in that case reset the per-connection state here.
1930 */
1931 if (entry->state.pendingAreq)
1932 memset(&entry->state, 0, sizeof(entry->state));
1933
1934 /* Disarm changing_xact_state if it all worked */
1935 entry->changing_xact_state = false;
1936}
#define CONSTRUCT_ABORT_COMMAND(sql, entry, toplevel)
Definition connection.c:116
static bool pgfdw_exec_cleanup_query(PGconn *conn, const char *query, bool ignore_errors)
static bool pgfdw_cancel_query(PGconn *conn)
bool in_error_recursion_trouble(void)
Definition elog.c:306
PGTransactionStatusType PQtransactionStatus(const PGconn *conn)
@ PQTRANS_ACTIVE
Definition libpq-fe.h:154

References ConnCacheEntry::changing_xact_state, ConnCacheEntry::conn, CONSTRUCT_ABORT_COMMAND, fb(), ConnCacheEntry::have_error, ConnCacheEntry::have_prep_stmt, in_error_recursion_trouble(), PgFdwConnState::pendingAreq, pgfdw_cancel_query(), pgfdw_exec_cleanup_query(), PQTRANS_ACTIVE, PQtransactionStatus(), and ConnCacheEntry::state.

Referenced by pgfdw_subxact_callback(), and pgfdw_xact_callback().

◆ pgfdw_abort_cleanup_begin()

static bool pgfdw_abort_cleanup_begin ( ConnCacheEntry entry,
bool  toplevel,
List **  pending_entries,
List **  cancel_requested 
)
static

Definition at line 1948 of file connection.c.

1950{
1951 /*
1952 * Don't try to clean up the connection if we're already in error
1953 * recursion trouble.
1954 */
1956 entry->changing_xact_state = true;
1957
1958 /*
1959 * If connection is already unsalvageable, don't touch it further.
1960 */
1961 if (entry->changing_xact_state)
1962 return false;
1963
1964 /*
1965 * Mark this connection as in the process of changing transaction state.
1966 */
1967 entry->changing_xact_state = true;
1968
1969 /* Assume we might have lost track of prepared statements */
1970 entry->have_error = true;
1971
1972 /*
1973 * If a command has been submitted to the remote server by using an
1974 * asynchronous execution function, the command might not have yet
1975 * completed. Check to see if a command is still being processed by the
1976 * remote server, and if so, request cancellation of the command.
1977 */
1979 {
1981
1985 return false; /* Unable to cancel running query */
1987 }
1988 else
1989 {
1990 char sql[100];
1991
1992 CONSTRUCT_ABORT_COMMAND(sql, entry, toplevel);
1993 if (!pgfdw_exec_cleanup_query_begin(entry->conn, sql))
1994 return false; /* Unable to abort remote transaction */
1996 }
1997
1998 return true;
1999}
TimestampTz GetCurrentTimestamp(void)
Definition timestamp.c:1649
static bool pgfdw_cancel_query_begin(PGconn *conn, TimestampTz endtime)
static bool pgfdw_exec_cleanup_query_begin(PGconn *conn, const char *query)
#define CONNECTION_CLEANUP_TIMEOUT
Definition connection.c:106
int64 TimestampTz
Definition timestamp.h:39
List * lappend(List *list, void *datum)
Definition list.c:339
#define TimestampTzPlusMilliseconds(tz, ms)
Definition timestamp.h:85

References ConnCacheEntry::changing_xact_state, ConnCacheEntry::conn, CONNECTION_CLEANUP_TIMEOUT, CONSTRUCT_ABORT_COMMAND, fb(), GetCurrentTimestamp(), ConnCacheEntry::have_error, in_error_recursion_trouble(), lappend(), pgfdw_cancel_query_begin(), pgfdw_exec_cleanup_query_begin(), PQTRANS_ACTIVE, PQtransactionStatus(), and TimestampTzPlusMilliseconds.

Referenced by pgfdw_subxact_callback(), and pgfdw_xact_callback().

◆ pgfdw_cancel_query()

static bool pgfdw_cancel_query ( PGconn conn)
static

Definition at line 1571 of file connection.c.

1572{
1576
1577 /*
1578 * If it takes too long to cancel the query and discard the result, assume
1579 * the connection is dead.
1580 */
1582
1583 /*
1584 * Also, lose patience and re-issue the cancel request after a little bit.
1585 * (This serves to close some race conditions.)
1586 */
1588
1590 return false;
1592}
Datum now(PG_FUNCTION_ARGS)
Definition timestamp.c:1613
#define RETRY_CANCEL_TIMEOUT
Definition connection.c:113
static bool pgfdw_cancel_query_end(PGconn *conn, TimestampTz endtime, TimestampTz retrycanceltime, bool consume_input)

References conn, CONNECTION_CLEANUP_TIMEOUT, fb(), GetCurrentTimestamp(), now(), pgfdw_cancel_query_begin(), pgfdw_cancel_query_end(), RETRY_CANCEL_TIMEOUT, and TimestampTzPlusMilliseconds.

Referenced by pgfdw_abort_cleanup().

◆ pgfdw_cancel_query_begin()

static bool pgfdw_cancel_query_begin ( PGconn conn,
TimestampTz  endtime 
)
static

Definition at line 1604 of file connection.c.

1605{
1606 const char *errormsg = libpqsrv_cancel(conn, endtime);
1607
1608 if (errormsg != NULL)
1611 errmsg("could not send cancel request: %s", errormsg));
1612
1613 return errormsg == NULL;
1614}
static const char * libpqsrv_cancel(PGconn *conn, TimestampTz endtime)

References conn, ereport, errcode(), errmsg, fb(), libpqsrv_cancel(), and WARNING.

Referenced by pgfdw_abort_cleanup_begin(), and pgfdw_cancel_query().

◆ pgfdw_cancel_query_end()

static bool pgfdw_cancel_query_end ( PGconn conn,
TimestampTz  endtime,
TimestampTz  retrycanceltime,
bool  consume_input 
)
static

Definition at line 1617 of file connection.c.

1619{
1621 bool timed_out;
1622
1623 /*
1624 * If requested, consume whatever data is available from the socket. (Note
1625 * that if all data is available, this allows pgfdw_get_cleanup_result to
1626 * call PQgetResult without forcing the overhead of WaitLatchOrSocket,
1627 * which would be large compared to the overhead of PQconsumeInput.)
1628 */
1630 {
1633 errmsg("could not get result of cancel request: %s",
1635 return false;
1636 }
1637
1638 /* Get and discard the result of the query. */
1640 &result, &timed_out))
1641 {
1642 if (timed_out)
1644 (errmsg("could not get result of cancel request due to timeout")));
1645 else
1648 errmsg("could not get result of cancel request: %s",
1650
1651 return false;
1652 }
1653 PQclear(result);
1654
1655 return true;
1656}
static bool pgfdw_get_cleanup_result(PGconn *conn, TimestampTz endtime, TimestampTz retrycanceltime, PGresult **result, bool *timed_out)

References conn, ereport, errcode(), errmsg, fb(), pchomp(), pgfdw_get_cleanup_result(), PQclear, PQconsumeInput(), PQerrorMessage(), result, and WARNING.

Referenced by pgfdw_cancel_query(), and pgfdw_finish_abort_cleanup().

◆ pgfdw_conn_check()

static int pgfdw_conn_check ( PGconn conn)
static

Definition at line 2659 of file connection.c.

2660{
2661 int sock = PQsocket(conn);
2662
2663 if (PQstatus(conn) != CONNECTION_OK || sock == -1)
2664 return -1;
2665
2666#if (defined(HAVE_POLL) && defined(POLLRDHUP))
2667 {
2668 struct pollfd input_fd;
2669 int result;
2670
2671 input_fd.fd = sock;
2672 input_fd.events = POLLRDHUP;
2673 input_fd.revents = 0;
2674
2675 do
2676 result = poll(&input_fd, 1, 0);
2677 while (result < 0 && errno == EINTR);
2678
2679 if (result < 0)
2680 return -1;
2681
2682 return (input_fd.revents &
2683 (POLLRDHUP | POLLHUP | POLLERR | POLLNVAL)) ? 1 : 0;
2684 }
2685#else
2686 return 0;
2687#endif
2688}
int PQsocket(const PGconn *conn)
#define EINTR
Definition win32_port.h:361

References conn, CONNECTION_OK, EINTR, fb(), PQsocket(), PQstatus(), and result.

Referenced by postgres_fdw_get_connections_internal().

◆ pgfdw_conn_checkable()

static bool pgfdw_conn_checkable ( void  )
static

Definition at line 2696 of file connection.c.

2697{
2698#if (defined(HAVE_POLL) && defined(POLLRDHUP))
2699 return true;
2700#else
2701 return false;
2702#endif
2703}

Referenced by postgres_fdw_get_connections_internal().

◆ pgfdw_exec_cleanup_query()

static bool pgfdw_exec_cleanup_query ( PGconn conn,
const char query,
bool  ignore_errors 
)
static

Definition at line 1671 of file connection.c.

1672{
1674
1675 /*
1676 * If it takes too long to execute a cleanup query, assume the connection
1677 * is dead. It's fairly likely that this is why we aborted in the first
1678 * place (e.g. statement timeout, user cancel), so the timeout shouldn't
1679 * be too long.
1680 */
1683
1685 return false;
1687 false, ignore_errors);
1688}
static bool pgfdw_exec_cleanup_query_end(PGconn *conn, const char *query, TimestampTz endtime, bool consume_input, bool ignore_errors)

References conn, CONNECTION_CLEANUP_TIMEOUT, fb(), GetCurrentTimestamp(), pgfdw_exec_cleanup_query_begin(), pgfdw_exec_cleanup_query_end(), and TimestampTzPlusMilliseconds.

Referenced by pgfdw_abort_cleanup().

◆ pgfdw_exec_cleanup_query_begin()

static bool pgfdw_exec_cleanup_query_begin ( PGconn conn,
const char query 
)
static

Definition at line 1691 of file connection.c.

1692{
1693 Assert(query != NULL);
1694
1695 /*
1696 * Submit a query. Since we don't use non-blocking mode, this also can
1697 * block. But its risk is relatively small, so we ignore that for now.
1698 */
1699 if (!PQsendQuery(conn, query))
1700 {
1701 pgfdw_report(WARNING, NULL, conn, query);
1702 return false;
1703 }
1704
1705 return true;
1706}
void pgfdw_report(int elevel, PGresult *res, PGconn *conn, const char *sql)

References Assert, conn, fb(), pgfdw_report(), PQsendQuery(), and WARNING.

Referenced by pgfdw_abort_cleanup_begin(), pgfdw_exec_cleanup_query(), and pgfdw_finish_abort_cleanup().

◆ pgfdw_exec_cleanup_query_end()

static bool pgfdw_exec_cleanup_query_end ( PGconn conn,
const char query,
TimestampTz  endtime,
bool  consume_input,
bool  ignore_errors 
)
static

Definition at line 1709 of file connection.c.

1712{
1714 bool timed_out;
1715
1716 Assert(query != NULL);
1717
1718 /*
1719 * If requested, consume whatever data is available from the socket. (Note
1720 * that if all data is available, this allows pgfdw_get_cleanup_result to
1721 * call PQgetResult without forcing the overhead of WaitLatchOrSocket,
1722 * which would be large compared to the overhead of PQconsumeInput.)
1723 */
1725 {
1726 pgfdw_report(WARNING, NULL, conn, query);
1727 return false;
1728 }
1729
1730 /* Get the result of the query. */
1732 {
1733 if (timed_out)
1735 (errmsg("could not get query result due to timeout"),
1736 errcontext("remote SQL command: %s", query)));
1737 else
1738 pgfdw_report(WARNING, NULL, conn, query);
1739
1740 return false;
1741 }
1742
1743 /* Issue a warning if not successful. */
1745 {
1746 pgfdw_report(WARNING, result, conn, query);
1747 return ignore_errors;
1748 }
1749 PQclear(result);
1750
1751 return true;
1752}
#define errcontext
Definition elog.h:200

References Assert, conn, ereport, errcontext, errmsg, fb(), pgfdw_get_cleanup_result(), pgfdw_report(), PGRES_COMMAND_OK, PQclear, PQconsumeInput(), PQresultStatus, result, and WARNING.

Referenced by pgfdw_exec_cleanup_query(), and pgfdw_finish_abort_cleanup().

◆ pgfdw_exec_query()

PGresult * pgfdw_exec_query ( PGconn conn,
const char query,
PgFdwConnState state 
)

◆ pgfdw_finish_abort_cleanup()

static void pgfdw_finish_abort_cleanup ( List pending_entries,
List cancel_requested,
bool  toplevel 
)
static

Definition at line 2114 of file connection.c.

2116{
2118 ListCell *lc;
2119
2120 /*
2121 * For each of the pending cancel requests (if any), get and discard the
2122 * result of the query, and submit an abort command to the remote server.
2123 */
2124 if (cancel_requested)
2125 {
2126 foreach(lc, cancel_requested)
2127 {
2128 ConnCacheEntry *entry = (ConnCacheEntry *) lfirst(lc);
2132 char sql[100];
2133
2135
2136 /*
2137 * Set end time. You might think we should do this before issuing
2138 * cancel request like in normal mode, but that is problematic,
2139 * because if, for example, it took longer than 30 seconds to
2140 * process the first few entries in the cancel_requested list, it
2141 * would cause a timeout error when processing each of the
2142 * remaining entries in the list, leading to slamming that entry's
2143 * connection shut.
2144 */
2149
2150 if (!pgfdw_cancel_query_end(entry->conn, endtime,
2151 retrycanceltime, true))
2152 {
2153 /* Unable to cancel running query */
2154 pgfdw_reset_xact_state(entry, toplevel);
2155 continue;
2156 }
2157
2158 /* Send an abort command in parallel if needed */
2159 CONSTRUCT_ABORT_COMMAND(sql, entry, toplevel);
2160 if (!pgfdw_exec_cleanup_query_begin(entry->conn, sql))
2161 {
2162 /* Unable to abort remote (sub)transaction */
2163 pgfdw_reset_xact_state(entry, toplevel);
2164 }
2165 else
2167 }
2168 }
2169
2170 /* No further work if no pending entries */
2171 if (!pending_entries)
2172 return;
2173
2174 /*
2175 * Get the result of the abort command for each of the pending entries
2176 */
2177 foreach(lc, pending_entries)
2178 {
2179 ConnCacheEntry *entry = (ConnCacheEntry *) lfirst(lc);
2181 char sql[100];
2182
2184
2185 /*
2186 * Set end time. We do this now, not before issuing the command like
2187 * in normal mode, for the same reason as for the cancel_requested
2188 * entries.
2189 */
2192
2193 CONSTRUCT_ABORT_COMMAND(sql, entry, toplevel);
2194 if (!pgfdw_exec_cleanup_query_end(entry->conn, sql, endtime,
2195 true, false))
2196 {
2197 /* Unable to abort remote (sub)transaction */
2198 pgfdw_reset_xact_state(entry, toplevel);
2199 continue;
2200 }
2201
2202 if (toplevel)
2203 {
2204 /* Do a DEALLOCATE ALL in parallel if needed */
2205 if (entry->have_prep_stmt && entry->have_error)
2206 {
2208 "DEALLOCATE ALL"))
2209 {
2210 /* Trouble clearing prepared statements */
2211 pgfdw_reset_xact_state(entry, toplevel);
2212 }
2213 else
2215 continue;
2216 }
2217 entry->have_prep_stmt = false;
2218 entry->have_error = false;
2219 }
2220
2221 /* Reset the per-connection state if needed */
2222 if (entry->state.pendingAreq)
2223 memset(&entry->state, 0, sizeof(entry->state));
2224
2225 /* We're done with this entry; unset the changing_xact_state flag */
2226 entry->changing_xact_state = false;
2227 pgfdw_reset_xact_state(entry, toplevel);
2228 }
2229
2230 /* No further work if no pending entries */
2231 if (!pending_deallocs)
2232 return;
2233 Assert(toplevel);
2234
2235 /*
2236 * Get the result of the DEALLOCATE command for each of the pending
2237 * entries
2238 */
2239 foreach(lc, pending_deallocs)
2240 {
2241 ConnCacheEntry *entry = (ConnCacheEntry *) lfirst(lc);
2243
2245 Assert(entry->have_prep_stmt);
2246 Assert(entry->have_error);
2247
2248 /*
2249 * Set end time. We do this now, not before issuing the command like
2250 * in normal mode, for the same reason as for the cancel_requested
2251 * entries.
2252 */
2255
2256 if (!pgfdw_exec_cleanup_query_end(entry->conn, "DEALLOCATE ALL",
2257 endtime, true, true))
2258 {
2259 /* Trouble clearing prepared statements */
2260 pgfdw_reset_xact_state(entry, toplevel);
2261 continue;
2262 }
2263 entry->have_prep_stmt = false;
2264 entry->have_error = false;
2265
2266 /* Reset the per-connection state if needed */
2267 if (entry->state.pendingAreq)
2268 memset(&entry->state, 0, sizeof(entry->state));
2269
2270 /* We're done with this entry; unset the changing_xact_state flag */
2271 entry->changing_xact_state = false;
2272 pgfdw_reset_xact_state(entry, toplevel);
2273 }
2274}
static void pgfdw_reset_xact_state(ConnCacheEntry *entry, bool toplevel)
#define NIL
Definition pg_list.h:68
Definition pg_list.h:54

References Assert, ConnCacheEntry::changing_xact_state, ConnCacheEntry::conn, CONNECTION_CLEANUP_TIMEOUT, CONSTRUCT_ABORT_COMMAND, fb(), GetCurrentTimestamp(), ConnCacheEntry::have_error, ConnCacheEntry::have_prep_stmt, lappend(), lfirst, NIL, now(), PgFdwConnState::pendingAreq, pgfdw_cancel_query_end(), pgfdw_exec_cleanup_query_begin(), pgfdw_exec_cleanup_query_end(), pgfdw_reset_xact_state(), RETRY_CANCEL_TIMEOUT, ConnCacheEntry::state, and TimestampTzPlusMilliseconds.

Referenced by pgfdw_subxact_callback(), and pgfdw_xact_callback().

◆ pgfdw_finish_pre_commit_cleanup()

static void pgfdw_finish_pre_commit_cleanup ( List pending_entries)
static

Definition at line 2006 of file connection.c.

2007{
2008 ConnCacheEntry *entry;
2010 ListCell *lc;
2011
2013
2014 /*
2015 * Get the result of the COMMIT command for each of the pending entries
2016 */
2017 foreach(lc, pending_entries)
2018 {
2019 entry = (ConnCacheEntry *) lfirst(lc);
2020
2022
2023 /*
2024 * We might already have received the result on the socket, so pass
2025 * consume_input=true to try to consume it first
2026 */
2027 do_sql_command_end(entry->conn, "COMMIT TRANSACTION", true);
2028 entry->changing_xact_state = false;
2029
2030 /* Do a DEALLOCATE ALL in parallel if needed */
2031 if (entry->have_prep_stmt && entry->have_error)
2032 {
2033 /* Ignore errors (see notes in pgfdw_xact_callback) */
2034 if (PQsendQuery(entry->conn, "DEALLOCATE ALL"))
2035 {
2037 continue;
2038 }
2039 }
2040 entry->have_prep_stmt = false;
2041 entry->have_error = false;
2042
2043 pgfdw_reset_xact_state(entry, true);
2044 }
2045
2046 /* No further work if no pending entries */
2047 if (!pending_deallocs)
2048 return;
2049
2050 /*
2051 * Get the result of the DEALLOCATE command for each of the pending
2052 * entries
2053 */
2054 foreach(lc, pending_deallocs)
2055 {
2056 PGresult *res;
2057
2058 entry = (ConnCacheEntry *) lfirst(lc);
2059
2060 /* Ignore errors (see notes in pgfdw_xact_callback) */
2061 while ((res = PQgetResult(entry->conn)) != NULL)
2062 {
2063 PQclear(res);
2064 /* Stop if the connection is lost (else we'll loop infinitely) */
2065 if (PQstatus(entry->conn) == CONNECTION_BAD)
2066 break;
2067 }
2068 entry->have_prep_stmt = false;
2069 entry->have_error = false;
2070
2071 pgfdw_reset_xact_state(entry, true);
2072 }
2073}
#define PQgetResult

References Assert, ConnCacheEntry::changing_xact_state, ConnCacheEntry::conn, CONNECTION_BAD, do_sql_command_end(), fb(), ConnCacheEntry::have_error, ConnCacheEntry::have_prep_stmt, lappend(), lfirst, NIL, pgfdw_reset_xact_state(), PQclear, PQgetResult, PQsendQuery(), and PQstatus().

Referenced by pgfdw_xact_callback().

◆ pgfdw_finish_pre_subcommit_cleanup()

static void pgfdw_finish_pre_subcommit_cleanup ( List pending_entries,
int  curlevel 
)
static

Definition at line 2080 of file connection.c.

2081{
2082 ConnCacheEntry *entry;
2083 char sql[100];
2084 ListCell *lc;
2085
2087
2088 /*
2089 * Get the result of the RELEASE command for each of the pending entries
2090 */
2091 snprintf(sql, sizeof(sql), "RELEASE SAVEPOINT s%d", curlevel);
2092 foreach(lc, pending_entries)
2093 {
2094 entry = (ConnCacheEntry *) lfirst(lc);
2095
2097
2098 /*
2099 * We might already have received the result on the socket, so pass
2100 * consume_input=true to try to consume it first
2101 */
2102 do_sql_command_end(entry->conn, sql, true);
2103 entry->changing_xact_state = false;
2104
2105 pgfdw_reset_xact_state(entry, false);
2106 }
2107}
#define snprintf
Definition port.h:261

References Assert, ConnCacheEntry::changing_xact_state, ConnCacheEntry::conn, do_sql_command_end(), fb(), lfirst, pgfdw_reset_xact_state(), and snprintf.

Referenced by pgfdw_subxact_callback().

◆ pgfdw_get_cleanup_result()

static bool pgfdw_get_cleanup_result ( PGconn conn,
TimestampTz  endtime,
TimestampTz  retrycanceltime,
PGresult **  result,
bool timed_out 
)
static

Definition at line 1769 of file connection.c.

1773{
1774 bool failed = false;
1775 PGresult *last_res = NULL;
1777
1778 *result = NULL;
1779 *timed_out = false;
1780 for (;;)
1781 {
1782 PGresult *res;
1783
1784 while (PQisBusy(conn))
1785 {
1786 int wc;
1788 long cur_timeout;
1789
1790 /* If timeout has expired, give up. */
1791 if (now >= endtime)
1792 {
1793 *timed_out = true;
1794 failed = true;
1795 goto exit;
1796 }
1797
1798 /* If we need to re-issue the cancel request, do that. */
1799 if (now >= retrycanceltime)
1800 {
1801 /* We ignore failure to issue the repeated request. */
1803
1804 /* Recompute "now" in case that took measurable time. */
1806
1807 /* Adjust re-cancel timeout in increasing steps. */
1809 canceldelta);
1811 }
1812
1813 /* If timeout has expired, give up, else get sleep time. */
1815 Min(endtime,
1817 if (cur_timeout <= 0)
1818 {
1819 *timed_out = true;
1820 failed = true;
1821 goto exit;
1822 }
1823
1824 /* first time, allocate or get the custom wait event */
1825 if (pgfdw_we_cleanup_result == 0)
1826 pgfdw_we_cleanup_result = WaitEventExtensionNew("PostgresFdwCleanupResult");
1827
1828 /* Sleep until there's something to do */
1832 PQsocket(conn),
1835
1837
1838 /* Data available in socket? */
1839 if (wc & WL_SOCKET_READABLE)
1840 {
1841 if (!PQconsumeInput(conn))
1842 {
1843 /* connection trouble */
1844 failed = true;
1845 goto exit;
1846 }
1847 }
1848 }
1849
1850 res = PQgetResult(conn);
1851 if (res == NULL)
1852 break; /* query is complete */
1853
1854 PQclear(last_res);
1855 last_res = res;
1856 }
1857exit:
1858 if (failed)
1859 PQclear(last_res);
1860 else
1861 *result = last_res;
1862 return failed;
1863}
long TimestampDifferenceMilliseconds(TimestampTz start_time, TimestampTz stop_time)
Definition timestamp.c:1765
#define Min(x, y)
Definition c.h:1091
static uint32 pgfdw_we_cleanup_result
Definition connection.c:97
int PQisBusy(PGconn *conn)
Definition fe-exec.c:2048
struct Latch * MyLatch
Definition globals.c:65
int WaitLatchOrSocket(Latch *latch, int wakeEvents, pgsocket sock, long timeout, uint32 wait_event_info)
Definition latch.c:223
void ResetLatch(Latch *latch)
Definition latch.c:374
#define CHECK_FOR_INTERRUPTS()
Definition miscadmin.h:125
#define WL_SOCKET_READABLE
#define WL_TIMEOUT
#define WL_EXIT_ON_PM_DEATH
#define WL_LATCH_SET

References CHECK_FOR_INTERRUPTS, conn, fb(), GetCurrentTimestamp(), libpqsrv_cancel(), Min, MyLatch, now(), pgfdw_we_cleanup_result, PQclear, PQconsumeInput(), PQgetResult, PQisBusy(), PQsocket(), ResetLatch(), result, RETRY_CANCEL_TIMEOUT, TimestampDifferenceMilliseconds(), TimestampTzPlusMilliseconds, WaitEventExtensionNew(), WaitLatchOrSocket(), WL_EXIT_ON_PM_DEATH, WL_LATCH_SET, WL_SOCKET_READABLE, and WL_TIMEOUT.

Referenced by pgfdw_cancel_query_end(), and pgfdw_exec_cleanup_query_end().

◆ pgfdw_get_result()

PGresult * pgfdw_get_result ( PGconn conn)

Definition at line 1088 of file connection.c.

1089{
1091}
static PGresult * libpqsrv_get_result_last(PGconn *conn, uint32 wait_event_info)

References conn, libpqsrv_get_result_last(), and pgfdw_we_get_result.

Referenced by create_cursor(), do_sql_command_end(), execute_dml_stmt(), execute_foreign_modify(), fetch_more_data(), pgfdw_exec_query(), and prepare_foreign_modify().

◆ pgfdw_has_required_scram_options()

static bool pgfdw_has_required_scram_options ( const char **  keywords,
const char **  values 
)
static

Definition at line 2714 of file connection.c.

2715{
2716 bool has_scram_server_key = false;
2717 bool has_scram_client_key = false;
2718 bool has_require_auth = false;
2719 bool has_scram_keys = false;
2720
2721 /*
2722 * Continue iterating even if we found the keys that we need to validate
2723 * to make sure that there is no other declaration of these keys that can
2724 * overwrite the first.
2725 */
2726 for (int i = 0; keywords[i] != NULL; i++)
2727 {
2728 if (strcmp(keywords[i], "scram_client_key") == 0)
2729 {
2730 if (values[i] != NULL && values[i][0] != '\0')
2731 has_scram_client_key = true;
2732 else
2733 has_scram_client_key = false;
2734 }
2735
2736 if (strcmp(keywords[i], "scram_server_key") == 0)
2737 {
2738 if (values[i] != NULL && values[i][0] != '\0')
2739 has_scram_server_key = true;
2740 else
2741 has_scram_server_key = false;
2742 }
2743
2744 if (strcmp(keywords[i], "require_auth") == 0)
2745 {
2746 if (values[i] != NULL && strcmp(values[i], "scram-sha-256") == 0)
2747 has_require_auth = true;
2748 else
2749 has_require_auth = false;
2750 }
2751 }
2752
2754
2755 return (has_scram_keys && has_require_auth);
2756}

References fb(), Port::has_scram_keys, i, keywords, MyProcPort, and values.

Referenced by check_conn_params(), and pgfdw_security_check().

◆ pgfdw_inval_callback()

static void pgfdw_inval_callback ( Datum  arg,
SysCacheIdentifier  cacheid,
uint32  hashvalue 
)
static

Definition at line 1443 of file connection.c.

1444{
1445 HASH_SEQ_STATUS scan;
1446 ConnCacheEntry *entry;
1447
1449
1450 /* ConnectionHash must exist already, if we're registered */
1452 while ((entry = (ConnCacheEntry *) hash_seq_search(&scan)))
1453 {
1454 /* Ignore invalid entries */
1455 if (entry->conn == NULL)
1456 continue;
1457
1458 /* hashvalue == 0 means a cache reset, must clear all state */
1459 if (hashvalue == 0 ||
1461 entry->server_hashvalue == hashvalue) ||
1462 (cacheid == USERMAPPINGOID &&
1463 entry->mapping_hashvalue == hashvalue))
1464 {
1465 /*
1466 * Close the connection immediately if it's not used yet in this
1467 * transaction. Otherwise mark it as invalid so that
1468 * pgfdw_xact_callback() can close it at the end of this
1469 * transaction.
1470 */
1471 if (entry->xact_depth == 0)
1472 {
1473 elog(DEBUG3, "discarding connection %p", entry->conn);
1474 disconnect_pg_server(entry);
1475 }
1476 else
1477 entry->invalidated = true;
1478 }
1479 }
1480}

References Assert, ConnCacheEntry::conn, ConnectionHash, DEBUG3, disconnect_pg_server(), elog, fb(), hash_seq_init(), hash_seq_search(), ConnCacheEntry::invalidated, ConnCacheEntry::mapping_hashvalue, ConnCacheEntry::server_hashvalue, and ConnCacheEntry::xact_depth.

Referenced by GetConnection().

◆ pgfdw_reject_incomplete_xact_state_change()

static void pgfdw_reject_incomplete_xact_state_change ( ConnCacheEntry entry)
static

Definition at line 1498 of file connection.c.

1499{
1500 ForeignServer *server;
1501
1502 /* nothing to do for inactive entries and entries of sane state */
1503 if (entry->conn == NULL || !entry->changing_xact_state)
1504 return;
1505
1506 /* find server name to be shown in the message below */
1507 server = GetForeignServer(entry->serverid);
1508
1509 ereport(ERROR,
1511 errmsg("connection to server \"%s\" cannot be used due to abort cleanup failure",
1512 server->servername)));
1513}

References ConnCacheEntry::changing_xact_state, ConnCacheEntry::conn, ereport, errcode(), errmsg, ERROR, fb(), GetForeignServer(), ConnCacheEntry::serverid, and ForeignServer::servername.

Referenced by GetConnection(), pgfdw_subxact_callback(), and pgfdw_xact_callback().

◆ pgfdw_report()

void pgfdw_report ( int  elevel,
PGresult res,
PGconn conn,
const char sql 
)

Definition at line 1119 of file connection.c.

1120{
1121 Assert(elevel < ERROR); /* use pgfdw_report_error for that */
1122 pgfdw_report_internal(elevel, res, conn, sql);
1123}
static void pgfdw_report_internal(int elevel, PGresult *res, PGconn *conn, const char *sql)

References Assert, conn, ERROR, and pgfdw_report_internal().

Referenced by pgfdw_exec_cleanup_query_begin(), and pgfdw_exec_cleanup_query_end().

◆ pgfdw_report_error()

◆ pgfdw_report_internal()

static void pgfdw_report_internal ( int  elevel,
PGresult res,
PGconn conn,
const char sql 
)
static

Definition at line 1126 of file connection.c.

1128{
1134 int sqlstate;
1135
1136 if (diag_sqlstate)
1137 sqlstate = MAKE_SQLSTATE(diag_sqlstate[0],
1138 diag_sqlstate[1],
1139 diag_sqlstate[2],
1140 diag_sqlstate[3],
1141 diag_sqlstate[4]);
1142 else
1143 sqlstate = ERRCODE_CONNECTION_FAILURE;
1144
1145 /*
1146 * If we don't get a message from the PGresult, try the PGconn. This is
1147 * needed because for connection-level failures, PQgetResult may just
1148 * return NULL, not a PGresult at all.
1149 */
1150 if (message_primary == NULL)
1152
1153 ereport(elevel,
1154 (errcode(sqlstate),
1155 (message_primary != NULL && message_primary[0] != '\0') ?
1157 errmsg("could not obtain message string for remote error"),
1159 message_hint ? errhint("%s", message_hint) : 0,
1161 sql ? errcontext("remote SQL command: %s", sql) : 0));
1162 PQclear(res);
1163}
int errhint(const char *fmt,...) pg_attribute_printf(1
#define MAKE_SQLSTATE(ch1, ch2, ch3, ch4, ch5)
Definition elog.h:58
#define PQresultErrorField
#define PG_DIAG_MESSAGE_HINT
#define PG_DIAG_SQLSTATE
#define PG_DIAG_MESSAGE_PRIMARY
#define PG_DIAG_MESSAGE_DETAIL
#define PG_DIAG_CONTEXT

References conn, ereport, errcode(), errcontext, errdetail_internal(), errhint(), errmsg, errmsg_internal(), fb(), MAKE_SQLSTATE, pchomp(), PG_DIAG_CONTEXT, PG_DIAG_MESSAGE_DETAIL, PG_DIAG_MESSAGE_HINT, PG_DIAG_MESSAGE_PRIMARY, PG_DIAG_SQLSTATE, PQclear, PQerrorMessage(), and PQresultErrorField.

Referenced by pgfdw_report(), and pgfdw_report_error().

◆ pgfdw_reset_xact_state()

static void pgfdw_reset_xact_state ( ConnCacheEntry entry,
bool  toplevel 
)
static

Definition at line 1519 of file connection.c.

1520{
1521 if (toplevel)
1522 {
1523 /* Reset state to show we're out of a transaction */
1524 entry->xact_depth = 0;
1525
1526 /* Reset xact r/o state */
1527 entry->xact_read_only = false;
1528
1529 /*
1530 * If the connection isn't in a good idle state, it is marked as
1531 * invalid or keep_connections option of its server is disabled, then
1532 * discard it to recover. Next GetConnection will open a new
1533 * connection.
1534 */
1535 if (PQstatus(entry->conn) != CONNECTION_OK ||
1537 entry->changing_xact_state ||
1538 entry->invalidated ||
1539 !entry->keep_connections)
1540 {
1541 elog(DEBUG3, "discarding connection %p", entry->conn);
1542 disconnect_pg_server(entry);
1543 }
1544 }
1545 else
1546 {
1547 /* Reset state to show we're out of a subtransaction */
1548 entry->xact_depth--;
1549
1550 /* If in read_only_level, reset xact r/o state */
1551 if (entry->xact_depth + 1 == read_only_level)
1552 entry->xact_read_only = false;
1553 }
1554}
@ PQTRANS_IDLE
Definition libpq-fe.h:153

References ConnCacheEntry::changing_xact_state, ConnCacheEntry::conn, CONNECTION_OK, DEBUG3, disconnect_pg_server(), elog, ConnCacheEntry::invalidated, ConnCacheEntry::keep_connections, PQstatus(), PQTRANS_IDLE, PQtransactionStatus(), read_only_level, ConnCacheEntry::xact_depth, and ConnCacheEntry::xact_read_only.

Referenced by pgfdw_finish_abort_cleanup(), pgfdw_finish_pre_commit_cleanup(), pgfdw_finish_pre_subcommit_cleanup(), pgfdw_subxact_callback(), and pgfdw_xact_callback().

◆ pgfdw_security_check()

static void pgfdw_security_check ( const char **  keywords,
const char **  values,
UserMapping user,
PGconn conn 
)
static

Definition at line 446 of file connection.c.

447{
448 /* Superusers bypass the check */
449 if (superuser_arg(user->userid))
450 return;
451
452#ifdef ENABLE_GSS
453 /* Connected via GSSAPI with delegated credentials- all good. */
455 return;
456#endif
457
458 /* Ok if superuser set PW required false. */
460 return;
461
462 /* Connected via PW, with PW required true, and provided non-empty PW. */
464 {
465 /* ok if params contain a non-empty password */
466 for (int i = 0; keywords[i] != NULL; i++)
467 {
468 if (strcmp(keywords[i], "password") == 0 && values[i][0] != '\0')
469 return;
470 }
471 }
472
473 /*
474 * Ok if SCRAM pass-through is being used and all required SCRAM options
475 * are set correctly. If pgfdw_has_required_scram_options returns true we
476 * assume that UseScramPassthrough is also true since SCRAM options are
477 * only set when UseScramPassthrough is enabled.
478 */
480 return;
481
484 errmsg("password or GSSAPI delegated credentials required"),
485 errdetail("Non-superuser cannot connect if the server does not request a password or use GSSAPI with delegated credentials."),
486 errhint("Target server's authentication method must be changed or password_required=false set in the user mapping attributes.")));
487}
int PQconnectionUsedPassword(const PGconn *conn)
int PQconnectionUsedGSSAPI(const PGconn *conn)

References be_gssapi_get_delegation(), conn, ereport, errcode(), errdetail(), errhint(), errmsg, ERROR, fb(), Port::has_scram_keys, i, keywords, MyProcPort, pgfdw_has_required_scram_options(), PQconnectionUsedGSSAPI(), PQconnectionUsedPassword(), superuser_arg(), user, UserMappingPasswordRequired(), and values.

Referenced by connect_pg_server().

◆ pgfdw_subxact_callback()

static void pgfdw_subxact_callback ( SubXactEvent  event,
SubTransactionId  mySubid,
SubTransactionId  parentSubid,
void arg 
)
static

Definition at line 1326 of file connection.c.

1328{
1329 HASH_SEQ_STATUS scan;
1330 ConnCacheEntry *entry;
1331 int curlevel;
1334
1335 /* Nothing to do at subxact start, nor after commit. */
1336 if (!(event == SUBXACT_EVENT_PRE_COMMIT_SUB ||
1337 event == SUBXACT_EVENT_ABORT_SUB))
1338 return;
1339
1340 /* Quick exit if no connections were touched in this transaction. */
1342 return;
1343
1344 /*
1345 * Scan all connection cache entries to find open remote subtransactions
1346 * of the current level, and close them.
1347 */
1350 while ((entry = (ConnCacheEntry *) hash_seq_search(&scan)))
1351 {
1352 char sql[100];
1353
1354 /*
1355 * We only care about connections with open remote subtransactions of
1356 * the current level.
1357 */
1358 if (entry->conn == NULL || entry->xact_depth < curlevel)
1359 continue;
1360
1361 if (entry->xact_depth > curlevel)
1362 elog(ERROR, "missed cleaning up remote subtransaction at level %d",
1363 entry->xact_depth);
1364
1365 if (event == SUBXACT_EVENT_PRE_COMMIT_SUB)
1366 {
1367 /*
1368 * If abort cleanup previously failed for this connection, we
1369 * can't issue any more commands against it.
1370 */
1372
1373 /* Commit all remote subtransactions during pre-commit */
1374 snprintf(sql, sizeof(sql), "RELEASE SAVEPOINT s%d", curlevel);
1375 entry->changing_xact_state = true;
1376 if (entry->parallel_commit)
1377 {
1378 do_sql_command_begin(entry->conn, sql);
1380 continue;
1381 }
1382 do_sql_command(entry->conn, sql);
1383 entry->changing_xact_state = false;
1384 }
1385 else
1386 {
1387 /* Rollback all remote subtransactions during abort */
1388 if (entry->parallel_abort)
1389 {
1390 if (pgfdw_abort_cleanup_begin(entry, false,
1393 continue;
1394 }
1395 else
1396 pgfdw_abort_cleanup(entry, false);
1397 }
1398
1399 /* OK, we're outta that level of subtransaction */
1400 pgfdw_reset_xact_state(entry, false);
1401 }
1402
1403 /* If there are any pending connections, finish cleaning them up */
1405 {
1406 if (event == SUBXACT_EVENT_PRE_COMMIT_SUB)
1407 {
1410 }
1411 else
1412 {
1415 false);
1416 }
1417 }
1418
1419 /* If in read_only_level, reset it */
1421 read_only_level = 0;
1422}
static void pgfdw_finish_pre_subcommit_cleanup(List *pending_entries, int curlevel)
static void pgfdw_finish_abort_cleanup(List *pending_entries, List *cancel_requested, bool toplevel)
static bool pgfdw_abort_cleanup_begin(ConnCacheEntry *entry, bool toplevel, List **pending_entries, List **cancel_requested)
static void pgfdw_abort_cleanup(ConnCacheEntry *entry, bool toplevel)
@ SUBXACT_EVENT_PRE_COMMIT_SUB
Definition xact.h:146
@ SUBXACT_EVENT_ABORT_SUB
Definition xact.h:145

References Assert, ConnCacheEntry::changing_xact_state, ConnCacheEntry::conn, ConnectionHash, do_sql_command(), do_sql_command_begin(), elog, ERROR, fb(), GetCurrentTransactionNestLevel(), hash_seq_init(), hash_seq_search(), lappend(), NIL, ConnCacheEntry::parallel_abort, ConnCacheEntry::parallel_commit, pgfdw_abort_cleanup(), pgfdw_abort_cleanup_begin(), pgfdw_finish_abort_cleanup(), pgfdw_finish_pre_subcommit_cleanup(), pgfdw_reject_incomplete_xact_state_change(), pgfdw_reset_xact_state(), read_only_level, snprintf, SUBXACT_EVENT_ABORT_SUB, SUBXACT_EVENT_PRE_COMMIT_SUB, ConnCacheEntry::xact_depth, and xact_got_connection.

Referenced by GetConnection().

◆ pgfdw_xact_callback()

static void pgfdw_xact_callback ( XactEvent  event,
void arg 
)
static

Definition at line 1173 of file connection.c.

1174{
1175 HASH_SEQ_STATUS scan;
1176 ConnCacheEntry *entry;
1179
1180 /* Quick exit if no connections were touched in this transaction. */
1182 return;
1183
1184 /*
1185 * Scan all connection cache entries to find open remote transactions, and
1186 * close them.
1187 */
1189 while ((entry = (ConnCacheEntry *) hash_seq_search(&scan)))
1190 {
1191 PGresult *res;
1192
1193 /* Ignore cache entry if no open connection right now */
1194 if (entry->conn == NULL)
1195 continue;
1196
1197 /* If it has an open remote transaction, try to close it */
1198 if (entry->xact_depth > 0)
1199 {
1200 elog(DEBUG3, "closing remote transaction on connection %p",
1201 entry->conn);
1202
1203 switch (event)
1204 {
1207
1208 /*
1209 * If abort cleanup previously failed for this connection,
1210 * we can't issue any more commands against it.
1211 */
1213
1214 /* Commit all remote transactions during pre-commit */
1215 entry->changing_xact_state = true;
1216 if (entry->parallel_commit)
1217 {
1218 do_sql_command_begin(entry->conn, "COMMIT TRANSACTION");
1220 continue;
1221 }
1222 do_sql_command(entry->conn, "COMMIT TRANSACTION");
1223 entry->changing_xact_state = false;
1224
1225 /*
1226 * If there were any errors in subtransactions, and we
1227 * made prepared statements, do a DEALLOCATE ALL to make
1228 * sure we get rid of all prepared statements. This is
1229 * annoying and not terribly bulletproof, but it's
1230 * probably not worth trying harder.
1231 *
1232 * DEALLOCATE ALL only exists in 8.3 and later, so this
1233 * constrains how old a server postgres_fdw can
1234 * communicate with. We intentionally ignore errors in
1235 * the DEALLOCATE, so that we can hobble along to some
1236 * extent with older servers (leaking prepared statements
1237 * as we go; but we don't really support update operations
1238 * pre-8.3 anyway).
1239 */
1240 if (entry->have_prep_stmt && entry->have_error)
1241 {
1242 res = pgfdw_exec_query(entry->conn, "DEALLOCATE ALL",
1243 NULL);
1244 PQclear(res);
1245 }
1246 entry->have_prep_stmt = false;
1247 entry->have_error = false;
1248 break;
1250
1251 /*
1252 * We disallow any remote transactions, since it's not
1253 * very reasonable to hold them open until the prepared
1254 * transaction is committed. For the moment, throw error
1255 * unconditionally; later we might allow read-only cases.
1256 * Note that the error will cause us to come right back
1257 * here with event == XACT_EVENT_ABORT, so we'll clean up
1258 * the connection state at that point.
1259 */
1260 ereport(ERROR,
1262 errmsg("cannot PREPARE a transaction that has operated on postgres_fdw foreign tables")));
1263 break;
1265 case XACT_EVENT_COMMIT:
1266 case XACT_EVENT_PREPARE:
1267 /* Pre-commit should have closed the open transaction */
1268 elog(ERROR, "missed cleaning up connection during pre-commit");
1269 break;
1271 case XACT_EVENT_ABORT:
1272 /* Rollback all remote transactions during abort */
1273 if (entry->parallel_abort)
1274 {
1275 if (pgfdw_abort_cleanup_begin(entry, true,
1278 continue;
1279 }
1280 else
1281 pgfdw_abort_cleanup(entry, true);
1282 break;
1283 }
1284 }
1285
1286 /* Reset state to show we're out of a transaction */
1287 pgfdw_reset_xact_state(entry, true);
1288 }
1289
1290 /* If there are any pending connections, finish cleaning them up */
1292 {
1293 if (event == XACT_EVENT_PARALLEL_PRE_COMMIT ||
1294 event == XACT_EVENT_PRE_COMMIT)
1295 {
1298 }
1299 else
1300 {
1302 event == XACT_EVENT_ABORT);
1304 true);
1305 }
1306 }
1307
1308 /*
1309 * Regardless of the event type, we can now mark ourselves as out of the
1310 * transaction. (Note: if we are here during PRE_COMMIT or PRE_PREPARE,
1311 * this saves a useless scan of the hashtable during COMMIT or PREPARE.)
1312 */
1313 xact_got_connection = false;
1314
1315 /* Also reset cursor numbering for next transaction */
1316 cursor_number = 0;
1317
1318 /* Likewise for read_only_level */
1319 read_only_level = 0;
1320}
PGresult * pgfdw_exec_query(PGconn *conn, const char *query, PgFdwConnState *state)
static void pgfdw_finish_pre_commit_cleanup(List *pending_entries)
@ XACT_EVENT_PRE_PREPARE
Definition xact.h:136
@ XACT_EVENT_COMMIT
Definition xact.h:129
@ XACT_EVENT_PARALLEL_PRE_COMMIT
Definition xact.h:135
@ XACT_EVENT_PARALLEL_COMMIT
Definition xact.h:130
@ XACT_EVENT_ABORT
Definition xact.h:131
@ XACT_EVENT_PRE_COMMIT
Definition xact.h:134
@ XACT_EVENT_PARALLEL_ABORT
Definition xact.h:132
@ XACT_EVENT_PREPARE
Definition xact.h:133

References Assert, ConnCacheEntry::changing_xact_state, ConnCacheEntry::conn, ConnectionHash, cursor_number, DEBUG3, do_sql_command(), do_sql_command_begin(), elog, ereport, errcode(), errmsg, ERROR, fb(), hash_seq_init(), hash_seq_search(), ConnCacheEntry::have_error, ConnCacheEntry::have_prep_stmt, lappend(), NIL, ConnCacheEntry::parallel_abort, ConnCacheEntry::parallel_commit, pgfdw_abort_cleanup(), pgfdw_abort_cleanup_begin(), pgfdw_exec_query(), pgfdw_finish_abort_cleanup(), pgfdw_finish_pre_commit_cleanup(), pgfdw_reject_incomplete_xact_state_change(), pgfdw_reset_xact_state(), PQclear, read_only_level, ConnCacheEntry::xact_depth, XACT_EVENT_ABORT, XACT_EVENT_COMMIT, XACT_EVENT_PARALLEL_ABORT, XACT_EVENT_PARALLEL_COMMIT, XACT_EVENT_PARALLEL_PRE_COMMIT, XACT_EVENT_PRE_COMMIT, XACT_EVENT_PRE_PREPARE, XACT_EVENT_PREPARE, and xact_got_connection.

Referenced by GetConnection().

◆ postgres_fdw_connection()

Datum postgres_fdw_connection ( PG_FUNCTION_ARGS  )

Definition at line 2470 of file connection.c.

2471{
2472 Oid userid = PG_GETARG_OID(0);
2473 Oid serverid = PG_GETARG_OID(1);
2474 ForeignServer *server = GetForeignServer(serverid);
2475 UserMapping *user = GetUserMapping(userid, serverid);
2477 const char **keywords;
2478 const char **values;
2479 char *appname;
2480 char *sep = "";
2481
2482 construct_connection_params(server, user, &keywords, &values, &appname);
2483
2485 for (int i = 0; keywords[i] != NULL; i++)
2486 {
2487 if (values[i] == NULL)
2488 continue;
2489 appendStringInfo(&str, "%s%s = ", sep, keywords[i]);
2491 sep = " ";
2492 }
2493
2494 if (appname != NULL)
2495 pfree(appname);
2496 pfree(keywords);
2497 pfree(values);
2499}
static void appendEscapedValue(StringInfo str, const char *val)
#define PG_GETARG_OID(n)
Definition fmgr.h:275
#define PG_RETURN_TEXT_P(x)
Definition fmgr.h:374
UserMapping * GetUserMapping(Oid userid, Oid serverid)
Definition foreign.c:232
unsigned int Oid
text * cstring_to_text(const char *s)
Definition varlena.c:184

References appendEscapedValue(), appendStringInfo(), construct_connection_params(), cstring_to_text(), fb(), GetForeignServer(), GetUserMapping(), i, initStringInfo(), keywords, pfree(), PG_GETARG_OID, PG_RETURN_TEXT_P, str, user, and values.

◆ postgres_fdw_disconnect()

Datum postgres_fdw_disconnect ( PG_FUNCTION_ARGS  )

Definition at line 2538 of file connection.c.

2539{
2540 ForeignServer *server;
2541 char *servername;
2542
2543 servername = text_to_cstring(PG_GETARG_TEXT_PP(0));
2544 server = GetForeignServerByName(servername, false);
2545
2547}
static bool disconnect_cached_connections(Oid serverid)
#define PG_GETARG_TEXT_PP(n)
Definition fmgr.h:310
#define PG_RETURN_BOOL(x)
Definition fmgr.h:360
ForeignServer * GetForeignServerByName(const char *srvname, bool missing_ok)
Definition foreign.c:185
char * text_to_cstring(const text *t)
Definition varlena.c:217

References disconnect_cached_connections(), GetForeignServerByName(), PG_GETARG_TEXT_PP, PG_RETURN_BOOL, ForeignServer::serverid, and text_to_cstring().

◆ postgres_fdw_disconnect_all()

Datum postgres_fdw_disconnect_all ( PG_FUNCTION_ARGS  )

Definition at line 2559 of file connection.c.

2560{
2562}
#define InvalidOid

References disconnect_cached_connections(), InvalidOid, and PG_RETURN_BOOL.

◆ postgres_fdw_get_connections()

Datum postgres_fdw_get_connections ( PG_FUNCTION_ARGS  )

Definition at line 2518 of file connection.c.

2519{
2521
2523}
static void postgres_fdw_get_connections_internal(FunctionCallInfo fcinfo, enum pgfdwVersion api_version)
#define PG_RETURN_VOID()
Definition fmgr.h:350

References PG_RETURN_VOID, PGFDW_V1_1, and postgres_fdw_get_connections_internal().

◆ postgres_fdw_get_connections_1_2()

Datum postgres_fdw_get_connections_1_2 ( PG_FUNCTION_ARGS  )

Definition at line 2510 of file connection.c.

2511{
2513
2515}

References PG_RETURN_VOID, PGFDW_V1_2, and postgres_fdw_get_connections_internal().

◆ postgres_fdw_get_connections_internal()

static void postgres_fdw_get_connections_internal ( FunctionCallInfo  fcinfo,
enum pgfdwVersion  api_version 
)
static

Definition at line 2308 of file connection.c.

2310{
2312 HASH_SEQ_STATUS scan;
2313 ConnCacheEntry *entry;
2314
2315 InitMaterializedSRF(fcinfo, 0);
2316
2317 /* If cache doesn't exist, we return no records */
2318 if (!ConnectionHash)
2319 return;
2320
2321 /* Check we have the expected number of output arguments */
2322 switch (rsinfo->setDesc->natts)
2323 {
2325 if (api_version != PGFDW_V1_1)
2326 elog(ERROR, "incorrect number of output arguments");
2327 break;
2329 if (api_version != PGFDW_V1_2)
2330 elog(ERROR, "incorrect number of output arguments");
2331 break;
2332 default:
2333 elog(ERROR, "incorrect number of output arguments");
2334 }
2335
2337 while ((entry = (ConnCacheEntry *) hash_seq_search(&scan)))
2338 {
2339 ForeignServer *server;
2341 bool nulls[POSTGRES_FDW_GET_CONNECTIONS_COLS] = {0};
2342 int i = 0;
2343
2344 /* We only look for open remote connections */
2345 if (!entry->conn)
2346 continue;
2347
2349
2350 /*
2351 * The foreign server may have been dropped in current explicit
2352 * transaction. It is not possible to drop the server from another
2353 * session when the connection associated with it is in use in the
2354 * current transaction, if tried so, the drop query in another session
2355 * blocks until the current transaction finishes.
2356 *
2357 * Even though the server is dropped in the current transaction, the
2358 * cache can still have associated active connection entry, say we
2359 * call such connections dangling. Since we can not fetch the server
2360 * name from system catalogs for dangling connections, instead we show
2361 * NULL value for server name in output.
2362 *
2363 * We could have done better by storing the server name in the cache
2364 * entry instead of server oid so that it could be used in the output.
2365 * But the server name in each cache entry requires 64 bytes of
2366 * memory, which is huge, when there are many cached connections and
2367 * the use case i.e. dropping the foreign server within the explicit
2368 * current transaction seems rare. So, we chose to show NULL value for
2369 * server name in output.
2370 *
2371 * Such dangling connections get closed either in next use or at the
2372 * end of current explicit transaction in pgfdw_xact_callback.
2373 */
2374 if (!server)
2375 {
2376 /*
2377 * If the server has been dropped in the current explicit
2378 * transaction, then this entry would have been invalidated in
2379 * pgfdw_inval_callback at the end of drop server command. Note
2380 * that this connection would not have been closed in
2381 * pgfdw_inval_callback because it is still being used in the
2382 * current explicit transaction. So, assert that here.
2383 */
2384 Assert(entry->conn && entry->xact_depth > 0 && entry->invalidated);
2385
2386 /* Show null, if no server name was found */
2387 nulls[i++] = true;
2388 }
2389 else
2390 values[i++] = CStringGetTextDatum(server->servername);
2391
2392 if (api_version >= PGFDW_V1_2)
2393 {
2394 HeapTuple tp;
2395
2396 /* Use the system cache to obtain the user mapping */
2398
2399 /*
2400 * Just like in the foreign server case, user mappings can also be
2401 * dropped in the current explicit transaction. Therefore, the
2402 * similar check as in the server case is required.
2403 */
2404 if (!HeapTupleIsValid(tp))
2405 {
2406 /*
2407 * If we reach here, this entry must have been invalidated in
2408 * pgfdw_inval_callback, same as in the server case.
2409 */
2410 Assert(entry->conn && entry->xact_depth > 0 &&
2411 entry->invalidated);
2412
2413 nulls[i++] = true;
2414 }
2415 else
2416 {
2417 Oid userid;
2418
2419 userid = ((Form_pg_user_mapping) GETSTRUCT(tp))->umuser;
2421 ReleaseSysCache(tp);
2422 }
2423 }
2424
2425 values[i++] = BoolGetDatum(!entry->invalidated);
2426
2427 if (api_version >= PGFDW_V1_2)
2428 {
2429 bool check_conn = PG_GETARG_BOOL(0);
2430
2431 /* Is this connection used in the current transaction? */
2432 values[i++] = BoolGetDatum(entry->xact_depth > 0);
2433
2434 /*
2435 * If a connection status check is requested and supported, return
2436 * whether the connection is closed. Otherwise, return NULL.
2437 */
2439 values[i++] = BoolGetDatum(pgfdw_conn_check(entry->conn) != 0);
2440 else
2441 nulls[i++] = true;
2442
2443 /* Return process ID of remote backend */
2444 values[i++] = Int32GetDatum(PQbackendPID(entry->conn));
2445 }
2446
2447 tuplestore_putvalues(rsinfo->setResult, rsinfo->setDesc, values, nulls);
2448 }
2449}
#define CStringGetTextDatum(s)
Definition builtins.h:98
#define POSTGRES_FDW_GET_CONNECTIONS_COLS_V1_2
static int pgfdw_conn_check(PGconn *conn)
#define POSTGRES_FDW_GET_CONNECTIONS_COLS_V1_1
#define POSTGRES_FDW_GET_CONNECTIONS_COLS
static bool pgfdw_conn_checkable(void)
int PQbackendPID(const PGconn *conn)
#define PG_GETARG_BOOL(n)
Definition fmgr.h:274
#define MappingUserName(userid)
Definition foreign.h:20
void InitMaterializedSRF(FunctionCallInfo fcinfo, uint32 flags)
Definition funcapi.c:76
#define HeapTupleIsValid(tuple)
Definition htup.h:78
static void * GETSTRUCT(const HeapTupleData *tuple)
END_CATALOG_STRUCT typedef FormData_pg_user_mapping * Form_pg_user_mapping
static Datum BoolGetDatum(bool X)
Definition postgres.h:112
static Datum Int32GetDatum(int32 X)
Definition postgres.h:212
ConnCacheKey key
Definition connection.c:58
void ReleaseSysCache(HeapTuple tuple)
Definition syscache.c:265
HeapTuple SearchSysCache1(SysCacheIdentifier cacheId, Datum key1)
Definition syscache.c:221
void tuplestore_putvalues(Tuplestorestate *state, TupleDesc tdesc, const Datum *values, const bool *isnull)
Definition tuplestore.c:785

References Assert, BoolGetDatum(), ConnCacheEntry::conn, ConnectionHash, CStringGetTextDatum, elog, ERROR, fb(), Form_pg_user_mapping, FSV_MISSING_OK, GetForeignServerExtended(), GETSTRUCT(), hash_seq_init(), hash_seq_search(), HeapTupleIsValid, i, InitMaterializedSRF(), Int32GetDatum(), ConnCacheEntry::invalidated, ConnCacheEntry::key, MappingUserName, ObjectIdGetDatum(), PG_GETARG_BOOL, pgfdw_conn_check(), pgfdw_conn_checkable(), PGFDW_V1_1, PGFDW_V1_2, POSTGRES_FDW_GET_CONNECTIONS_COLS, POSTGRES_FDW_GET_CONNECTIONS_COLS_V1_1, POSTGRES_FDW_GET_CONNECTIONS_COLS_V1_2, PQbackendPID(), ReleaseSysCache(), FunctionCallInfoBaseData::resultinfo, SearchSysCache1(), ConnCacheEntry::serverid, ForeignServer::servername, tuplestore_putvalues(), values, and ConnCacheEntry::xact_depth.

Referenced by postgres_fdw_get_connections(), and postgres_fdw_get_connections_1_2().

◆ ReleaseConnection()

void ReleaseConnection ( PGconn conn)

Definition at line 1021 of file connection.c.

1022{
1023 /*
1024 * Currently, we don't actually track connection references because all
1025 * cleanup is managed on a transaction or subtransaction basis instead. So
1026 * there's nothing to do here.
1027 */
1028}

Referenced by estimate_path_cost_size(), fetch_remote_statistics(), finish_foreign_modify(), postgresAcquireSampleRowsFunc(), postgresAnalyzeForeignTable(), postgresEndDirectModify(), postgresEndForeignScan(), postgresGetAnalyzeInfoForForeignTable(), and postgresImportForeignSchema().

◆ UserMappingPasswordRequired()

static bool UserMappingPasswordRequired ( UserMapping user)
static

Definition at line 705 of file connection.c.

706{
707 ListCell *cell;
708
709 foreach(cell, user->options)
710 {
711 DefElem *def = (DefElem *) lfirst(cell);
712
713 if (strcmp(def->defname, "password_required") == 0)
714 return defGetBoolean(def);
715 }
716
717 return true;
718}

References defGetBoolean(), DefElem::defname, fb(), lfirst, and user.

Referenced by check_conn_params(), and pgfdw_security_check().

◆ UseScramPassthrough()

static bool UseScramPassthrough ( ForeignServer server,
UserMapping user 
)
static

Definition at line 727 of file connection.c.

728{
729 ListCell *cell;
730
731 foreach(cell, user->options)
732 {
733 DefElem *def = (DefElem *) lfirst(cell);
734
735 if (strcmp(def->defname, "use_scram_passthrough") == 0)
736 return defGetBoolean(def);
737 }
738
739 foreach(cell, server->options)
740 {
741 DefElem *def = (DefElem *) lfirst(cell);
742
743 if (strcmp(def->defname, "use_scram_passthrough") == 0)
744 return defGetBoolean(def);
745 }
746
747 return false;
748}

References defGetBoolean(), DefElem::defname, fb(), lfirst, ForeignServer::options, and user.

Referenced by construct_connection_params().

Variable Documentation

◆ ConnectionHash

◆ cursor_number

unsigned int cursor_number = 0
static

◆ pgfdw_we_cleanup_result

uint32 pgfdw_we_cleanup_result = 0
static

Definition at line 97 of file connection.c.

Referenced by pgfdw_get_cleanup_result().

◆ pgfdw_we_connect

uint32 pgfdw_we_connect = 0
static

Definition at line 98 of file connection.c.

Referenced by connect_pg_server().

◆ pgfdw_we_get_result

uint32 pgfdw_we_get_result = 0
static

Definition at line 99 of file connection.c.

Referenced by GetConnection(), and pgfdw_get_result().

◆ prep_stmt_number

unsigned int prep_stmt_number = 0
static

Definition at line 85 of file connection.c.

Referenced by GetPrepStmtNumber().

◆ read_only_level

int read_only_level = 0
static

◆ xact_got_connection

bool xact_got_connection = false
static

Definition at line 88 of file connection.c.

Referenced by GetConnection(), pgfdw_subxact_callback(), and pgfdw_xact_callback().