#include "postgres_fe.h"
#include "common/connect.h"
#include "fe_utils/string_utils.h"
#include "libpq/pqcomm.h"
#include "pg_upgrade.h"

Include dependency graph for server.c:

Functions
static PGconn *	get_db_conn (ClusterInfo cluster, const char db_name)

PGconn *	connectToServer (ClusterInfo cluster, const char db_name)

char *	cluster_conn_opts (ClusterInfo *cluster)

PGresult *	executeQueryOrDie (PGconn conn, const char fmt,...)

static void	stop_postmaster_atexit (void)

bool	start_postmaster (ClusterInfo *cluster, bool report_and_exit_on_error)

void	stop_postmaster (bool in_atexit)

void	check_pghost_envvar (void)

Function Documentation

◆ check_pghost_envvar()

void check_pghost_envvar ( void )

Definition at line 320 of file server.c.

{
    PQconninfoOption *option;
    PQconninfoOption *start;
 
    /* Get valid libpq env vars from the PQconndefaults function */
 
    start = PQconndefaults();
 
    if (!start)
        pg_fatal("out of memory");
 
    for (option = start; option->keyword != NULL; option++)
    {
        if (option->envvar && (strcmp(option->envvar, "PGHOST") == 0 ||
                               strcmp(option->envvar, "PGHOSTADDR") == 0))
        {
            const char *value = getenv(option->envvar);
 
            if (value && strlen(value) > 0 &&
            /* check for 'local' host values */
                (strcmp(value, "localhost") != 0 && strcmp(value, "127.0.0.1") != 0 &&
                 strcmp(value, "::1") != 0 && !is_unixsock_path(value)))
                pg_fatal("libpq environment variable %s has a non-local server value: %s",
                         option->envvar, value);
        }
    }
 
    /* Free the memory that libpq allocated on our behalf */
    PQconninfoFree(start);
}

References fb(), is_unixsock_path(), pg_fatal, PQconndefaults(), PQconninfoFree(), start, and value.

Referenced by setup().

◆ cluster_conn_opts()

char * cluster_conn_opts ( ClusterInfo * cluster )

Definition at line 94 of file server.c.

{
    static PQExpBuffer buf;
 
    if (buf == NULL)
        buf = createPQExpBuffer();
    else
        resetPQExpBuffer(buf);
 
    if (cluster->sockdir)
    {
        appendPQExpBufferStr(buf, "--host ");
        appendShellString(buf, cluster->sockdir);
        appendPQExpBufferChar(buf, ' ');
    }
    appendPQExpBuffer(buf, "--port %d --username ", cluster->port);
    appendShellString(buf, os_info.user);
 
    return buf->data;
}

References appendPQExpBuffer(), appendPQExpBufferChar(), appendPQExpBufferStr(), appendShellString(), buf, createPQExpBuffer(), fb(), os_info, resetPQExpBuffer(), and OSInfo::user.

Referenced by create_new_objects(), generate_old_dump(), prepare_new_cluster(), and prepare_new_globals().

◆ connectToServer()

PGconn * connectToServer	(	ClusterInfo *	cluster,
		const char *	db_name
	)

Definition at line 28 of file server.c.

{
    PGconn     *conn = get_db_conn(cluster, db_name);
 
    if (conn == NULL || PQstatus(conn) != CONNECTION_OK)
    {
        pg_log(PG_REPORT, "%s", PQerrorMessage(conn));
 
        if (conn)
            PQfinish(conn);
 
        printf(_("Failure, exiting\n"));
        exit(1);
    }
 
    PQclear(executeQueryOrDie(conn, ALWAYS_SECURE_SEARCH_PATH_SQL));
 
    return conn;
}

References _, ALWAYS_SECURE_SEARCH_PATH_SQL, conn, CONNECTION_OK, executeQueryOrDie(), fb(), get_db_conn(), pg_log(), PG_REPORT, PQclear, PQerrorMessage(), PQfinish(), PQstatus(), and printf.

Referenced by check_for_connection_status(), check_for_prepared_transactions(), check_for_unsupported_encodings(), check_is_install_user(), check_loadable_libraries(), check_new_cluster_replication_slots(), check_new_cluster_subscription_configuration(), check_old_cluster_global_names(), check_old_cluster_subscription_state(), create_conflict_detection_slot(), create_logical_replication_slots(), create_new_objects(), get_db_infos(), get_subscription_info(), get_tablespace_paths(), get_template0_info(), set_frozenxids(), set_locale_and_encoding(), and unicode_version_changed().

◆ executeQueryOrDie()

PGresult * executeQueryOrDie	(	PGconn *	conn,
		const char *	fmt,
			...
	)

Definition at line 124 of file server.c.

{
    static char query[QUERY_ALLOC];
    va_list     args;
    PGresult   *result;
    ExecStatusType status;
 
    va_start(args, fmt);
    vsnprintf(query, sizeof(query), fmt, args);
    va_end(args);
 
    pg_log(PG_VERBOSE, "executing: %s", query);
    result = PQexec(conn, query);
    status = PQresultStatus(result);
 
    if ((status != PGRES_TUPLES_OK) && (status != PGRES_COMMAND_OK))
    {
        pg_log(PG_REPORT, "SQL command failed\n%s\n%s", query,
               PQerrorMessage(conn));
        PQclear(result);
        PQfinish(conn);
        printf(_("Failure, exiting\n"));
        exit(1);
    }
    else
        return result;
}

References _, conn, fb(), pg_log(), PG_REPORT, PG_VERBOSE, PGRES_COMMAND_OK, PGRES_TUPLES_OK, PQclear, PQerrorMessage(), PQexec(), PQfinish(), PQresultStatus, printf, QUERY_ALLOC, result, and vsnprintf.

Referenced by connectToServer().

◆ get_db_conn()

static PGconn * get_db_conn	(	ClusterInfo *	cluster,
		const char *	db_name
	)

static

Definition at line 57 of file server.c.

{
    PQExpBufferData conn_opts;
    PGconn     *conn;
 
    /* Build connection string with proper quoting */
    initPQExpBuffer(&conn_opts);
    appendPQExpBufferStr(&conn_opts, "dbname=");
    appendConnStrVal(&conn_opts, db_name);
    appendPQExpBufferStr(&conn_opts, " user=");
    appendConnStrVal(&conn_opts, os_info.user);
    appendPQExpBuffer(&conn_opts, " port=%d", cluster->port);
    if (cluster->sockdir)
    {
        appendPQExpBufferStr(&conn_opts, " host=");
        appendConnStrVal(&conn_opts, cluster->sockdir);
    }
    if (!protocol_negotiation_supported(cluster))
        appendPQExpBufferStr(&conn_opts, " max_protocol_version=3.0");
 
    conn = PQconnectdb(conn_opts.data);
    termPQExpBuffer(&conn_opts);
    return conn;
}

References appendConnStrVal(), appendPQExpBuffer(), appendPQExpBufferStr(), conn, fb(), initPQExpBuffer(), os_info, PQconnectdb(), protocol_negotiation_supported(), termPQExpBuffer(), and OSInfo::user.

Referenced by connectToServer(), and start_postmaster().

◆ start_postmaster()

bool start_postmaster	(	ClusterInfo *	cluster,
		bool	report_and_exit_on_error
	)

Definition at line 161 of file server.c.

{
    char        cmd[MAXPGPATH * 4 + 1000];
    PGconn     *conn;
    bool        pg_ctl_return = false;
    char        socket_string[MAXPGPATH + 200];
    PQExpBufferData pgoptions;
 
    static bool exit_hook_registered = false;
 
    if (!exit_hook_registered)
    {
        atexit(stop_postmaster_atexit);
        exit_hook_registered = true;
    }
 
    socket_string[0] = '\0';
 
#if !defined(WIN32)
    /* prevent TCP/IP connections, restrict socket access */
    strcat(socket_string,
           " -c listen_addresses='' -c unix_socket_permissions=0700");
 
    /* Have a sockdir?  Tell the postmaster. */
    if (cluster->sockdir)
        snprintf(socket_string + strlen(socket_string),
                 sizeof(socket_string) - strlen(socket_string),
                 " -c %s='%s'",
                 "unix_socket_directories",
                 cluster->sockdir);
#endif
 
    initPQExpBuffer(&pgoptions);
 
    /*
     * Construct a parameter string which is passed to the server process.
     *
     * Turn off durability requirements to improve object creation speed, and
     * we only modify the new cluster, so only use it there.  If there is a
     * crash, the new cluster has to be recreated anyway.  fsync=off is a big
     * win on ext4.
     */
    if (cluster == &new_cluster)
        appendPQExpBufferStr(&pgoptions, " -c synchronous_commit=off -c fsync=off -c full_page_writes=off");
 
    /*
     * Use -b to disable autovacuum and logical replication launcher
     * (effective in PG17 or later for the latter).
     */
    snprintf(cmd, sizeof(cmd),
             "\"%s/pg_ctl\" -w -l \"%s/%s\" -D \"%s\" -o \"-p %d -b%s %s%s\" start",
             cluster->bindir,
             log_opts.logdir,
             SERVER_LOG_FILE, cluster->pgconfig, cluster->port,
             pgoptions.data,
             cluster->pgopts ? cluster->pgopts : "", socket_string);
 
    termPQExpBuffer(&pgoptions);
 
    /*
     * Don't throw an error right away, let connecting throw the error because
     * it might supply a reason for the failure.
     */
    pg_ctl_return = exec_prog(SERVER_START_LOG_FILE,
    /* pass both file names if they differ */
                              (strcmp(SERVER_LOG_FILE,
                                      SERVER_START_LOG_FILE) != 0) ?
                              SERVER_LOG_FILE : NULL,
                              report_and_exit_on_error, false,
                              "%s", cmd);
 
    /* Did it fail and we are just testing if the server could be started? */
    if (!pg_ctl_return && !report_and_exit_on_error)
        return false;
 
    /*
     * We set this here to make sure atexit() shuts down the server, but only
     * if we started the server successfully.  We do it before checking for
     * connectivity in case the server started but there is a connectivity
     * failure.  If pg_ctl did not return success, we will exit below.
     *
     * Pre-9.1 servers do not have PQping(), so we could be leaving the server
     * running if authentication was misconfigured, so someday we might went
     * to be more aggressive about doing server shutdowns even if pg_ctl
     * fails, but now (2013-08-14) it seems prudent to be cautious.  We don't
     * want to shutdown a server that might have been accidentally started
     * during the upgrade.
     */
    if (pg_ctl_return)
        os_info.running_cluster = cluster;
 
    /*
     * pg_ctl -w might have failed because the server couldn't be started, or
     * there might have been a connection problem in _checking_ if the server
     * has started.  Therefore, even if pg_ctl failed, we continue and test
     * for connectivity in case we get a connection reason for the failure.
     */
    if ((conn = get_db_conn(cluster, "template1")) == NULL ||
        PQstatus(conn) != CONNECTION_OK)
    {
        pg_log(PG_REPORT, "\n%s", PQerrorMessage(conn));
        if (conn)
            PQfinish(conn);
        if (cluster == &old_cluster)
            pg_fatal("could not connect to source postmaster started with the command:\n"
                     "%s",
                     cmd);
        else
            pg_fatal("could not connect to target postmaster started with the command:\n"
                     "%s",
                     cmd);
    }
    PQfinish(conn);
 
    /*
     * If pg_ctl failed, and the connection didn't fail, and
     * report_and_exit_on_error is enabled, fail now.  This could happen if
     * the server was already running.
     */
    if (!pg_ctl_return)
    {
        if (cluster == &old_cluster)
            pg_fatal("pg_ctl failed to start the source server, or connection failed");
        else
            pg_fatal("pg_ctl failed to start the target server, or connection failed");
    }
 
    return true;
}

References appendPQExpBufferStr(), conn, CONNECTION_OK, PQExpBufferData::data, exec_prog(), fb(), get_db_conn(), initPQExpBuffer(), log_opts, LogOpts::logdir, MAXPGPATH, new_cluster, old_cluster, os_info, pg_fatal, pg_log(), PG_REPORT, PQerrorMessage(), PQfinish(), PQstatus(), OSInfo::running_cluster, SERVER_LOG_FILE, SERVER_START_LOG_FILE, snprintf, stop_postmaster_atexit(), and termPQExpBuffer().

◆ stop_postmaster()

void stop_postmaster ( bool in_atexit )

Definition at line 293 of file server.c.

{
    ClusterInfo *cluster;
 
    if (os_info.running_cluster == &old_cluster)
        cluster = &old_cluster;
    else if (os_info.running_cluster == &new_cluster)
        cluster = &new_cluster;
    else
        return;                 /* no cluster running */
 
    exec_prog(SERVER_STOP_LOG_FILE, NULL, !in_atexit, !in_atexit,
              "\"%s/pg_ctl\" -w -D \"%s\" -o \"%s\" %s stop",
              cluster->bindir, cluster->pgconfig,
              cluster->pgopts ? cluster->pgopts : "",
              in_atexit ? "-m fast" : "-m smart");
 
    os_info.running_cluster = NULL;
}

References exec_prog(), fb(), new_cluster, old_cluster, os_info, OSInfo::running_cluster, and SERVER_STOP_LOG_FILE.

◆ stop_postmaster_atexit()

static void stop_postmaster_atexit ( void )