libpq-be-fe-helpers.h File Reference

#include "libpq-fe.h"
#include "miscadmin.h"
#include "storage/fd.h"
#include "storage/latch.h"
#include "utils/wait_event.h"

Include dependency graph for libpq-be-fe-helpers.h:

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

Go to the source code of this file.

Functions
static void	libpqsrv_connect_prepare (void)
static void	libpqsrv_connect_internal (PGconn *conn, uint32 wait_event_info)
static PGconn *	libpqsrv_connect (const char *conninfo, uint32 wait_event_info)
static PGconn *	libpqsrv_connect_params (const char *const *keywords, const char *const *values, int expand_dbname, uint32 wait_event_info)
static void	libpqsrv_disconnect (PGconn *conn)

Function Documentation

libpqsrv_connect()

static PGconn* libpqsrv_connect ( const char *  conninfo, uint32  wait_event_info  )

inlinestatic

Definition at line 63 of file libpq-be-fe-helpers.h.

{
    PGconn     *conn = NULL;
 
    libpqsrv_connect_prepare();
 
    conn = PQconnectStart(conninfo);
 
    libpqsrv_connect_internal(conn, wait_event_info);
 
    return conn;
}

References conn, libpqsrv_connect_internal(), libpqsrv_connect_prepare(), and PQconnectStart().

Referenced by dblink_connect(), and dblink_get_conn().

libpqsrv_connect_internal()

static void libpqsrv_connect_internal ( PGconn *  conn, uint32  wait_event_info  )

inlinestatic

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

{
    /*
     * With conn == NULL libpqsrv_disconnect() wouldn't release the FD. So do
     * that here.
     */
    if (conn == NULL)
    {
        ReleaseExternalFD();
        return;
    }
 
    /*
     * Can't wait without a socket. Note that we don't want to close the libpq
     * connection yet, so callers can emit a useful error.
     */
    if (PQstatus(conn) == CONNECTION_BAD)
        return;
 
    /*
     * WaitLatchOrSocket() can conceivably fail, handle that case here instead
     * of requiring all callers to do so.
     */
    PG_TRY();
    {
        PostgresPollingStatusType status;
 
        /*
         * Poll connection until we have OK or FAILED status.
         *
         * Per spec for PQconnectPoll, first wait till socket is write-ready.
         */
        status = PGRES_POLLING_WRITING;
        while (status != PGRES_POLLING_OK && status != PGRES_POLLING_FAILED)
        {
            int         io_flag;
            int         rc;
 
            if (status == PGRES_POLLING_READING)
                io_flag = WL_SOCKET_READABLE;
#ifdef WIN32
 
            /*
             * Windows needs a different test while waiting for
             * connection-made
             */
            else if (PQstatus(conn) == CONNECTION_STARTED)
                io_flag = WL_SOCKET_CONNECTED;
#endif
            else
                io_flag = WL_SOCKET_WRITEABLE;
 
            rc = WaitLatchOrSocket(MyLatch,
                                   WL_EXIT_ON_PM_DEATH | WL_LATCH_SET | io_flag,
                                   PQsocket(conn),
                                   0,
                                   wait_event_info);
 
            /* Interrupted? */
            if (rc & WL_LATCH_SET)
            {
                ResetLatch(MyLatch);
                CHECK_FOR_INTERRUPTS();
            }
 
            /* If socket is ready, advance the libpq state machine */
            if (rc & io_flag)
                status = PQconnectPoll(conn);
        }
    }
    PG_CATCH();
    {
        /*
         * If an error is thrown here, the callers won't call
         * libpqsrv_disconnect() with a conn, so release resources
         * immediately.
         */
        ReleaseExternalFD();
        PQfinish(conn);
 
        PG_RE_THROW();
    }
    PG_END_TRY();
}

References CHECK_FOR_INTERRUPTS, conn, CONNECTION_BAD, CONNECTION_STARTED, MyLatch, PG_CATCH, PG_END_TRY, PG_RE_THROW, PG_TRY, PGRES_POLLING_FAILED, PGRES_POLLING_OK, PGRES_POLLING_READING, PGRES_POLLING_WRITING, PQconnectPoll(), PQfinish(), PQsocket(), PQstatus(), ReleaseExternalFD(), ResetLatch(), status(), WaitLatchOrSocket(), WL_EXIT_ON_PM_DEATH, WL_LATCH_SET, WL_SOCKET_CONNECTED, WL_SOCKET_READABLE, and WL_SOCKET_WRITEABLE.

Referenced by libpqsrv_connect(), and libpqsrv_connect_params().

libpqsrv_connect_params()

static PGconn* libpqsrv_connect_params ( const char *const *  keywords, const char *const *  values, int  expand_dbname, uint32  wait_event_info  )

inlinestatic

Definition at line 81 of file libpq-be-fe-helpers.h.

{
    PGconn     *conn = NULL;
 
    libpqsrv_connect_prepare();
 
    conn = PQconnectStartParams(keywords, values, expand_dbname);
 
    libpqsrv_connect_internal(conn, wait_event_info);
 
    return conn;
}

References conn, libpqsrv_connect_internal(), libpqsrv_connect_prepare(), PQconnectStartParams(), and values.

Referenced by connect_pg_server(), and libpqrcv_connect().

libpqsrv_connect_prepare()

static void libpqsrv_connect_prepare ( void  )

inlinestatic

Definition at line 128 of file libpq-be-fe-helpers.h.

{
    /*
     * We must obey fd.c's limit on non-virtual file descriptors.  Assume that
     * a PGconn represents one long-lived FD.  (Doing this here also ensures
     * that VFDs are closed if needed to make room.)
     */
    if (!AcquireExternalFD())
    {
#ifndef WIN32                   /* can't write #if within ereport() macro */
        ereport(ERROR,
                (errcode(ERRCODE_SQLCLIENT_UNABLE_TO_ESTABLISH_SQLCONNECTION),
                 errmsg("could not establish connection"),
                 errdetail("There are too many open files on the local server."),
                 errhint("Raise the server's max_files_per_process and/or \"ulimit -n\" limits.")));
#else
        ereport(ERROR,
                (errcode(ERRCODE_SQLCLIENT_UNABLE_TO_ESTABLISH_SQLCONNECTION),
                 errmsg("could not establish connection"),
                 errdetail("There are too many open files on the local server."),
                 errhint("Raise the server's max_files_per_process setting.")));
#endif
    }
}

References AcquireExternalFD(), ereport, errcode(), errdetail(), errhint(), errmsg(), and ERROR.

Referenced by libpqsrv_connect(), and libpqsrv_connect_params().

libpqsrv_disconnect()

static void libpqsrv_disconnect ( PGconn *  conn )

inlinestatic

Definition at line 104 of file libpq-be-fe-helpers.h.

{
    /*
     * If no connection was established, we haven't reserved an FD for it (or
     * already released it). This rule makes it easier to write PG_CATCH()
     * handlers for this facility's users.
     *
     * See also libpqsrv_connect_internal().
     */
    if (conn == NULL)
        return;
 
    ReleaseExternalFD();
    PQfinish(conn);
}

References conn, PQfinish(), and ReleaseExternalFD().

Referenced by connect_pg_server(), createNewConnection(), dblink_connect(), dblink_disconnect(), dblink_exec(), dblink_get_conn(), dblink_record_internal(), dblink_security_check(), disconnect_pg_server(), libpqrcv_connect(), and libpqrcv_disconnect().