check.c File Reference

#include "postgres_fe.h"
#include "catalog/pg_am_d.h"
#include "catalog/pg_authid_d.h"
#include "catalog/pg_class_d.h"
#include "fe_utils/string_utils.h"
#include "mb/pg_wchar.h"
#include "pg_upgrade.h"
#include "common/unicode_version.h"

Include dependency graph for check.c:

Go to the source code of this file.

Data Structures
struct	DataTypesUsageChecks
struct	data_type_check_state

Macros
#define	MANUAL_CHECK   1
#define	ALL_VERSIONS   -1

Functions
static void	check_new_cluster_is_empty (void)
static void	check_is_install_user (ClusterInfo *cluster)
static void	check_for_unsupported_encodings (ClusterInfo *cluster)
static void	check_for_connection_status (ClusterInfo *cluster)
static void	check_for_prepared_transactions (ClusterInfo *cluster)
static void	check_for_isn_and_int8_passing_mismatch (ClusterInfo *cluster)
static void	check_for_user_defined_postfix_ops (ClusterInfo *cluster)
static void	check_for_incompatible_polymorphics (ClusterInfo *cluster)
static void	check_for_tables_with_oids (ClusterInfo *cluster)
static void	check_for_not_null_inheritance (ClusterInfo *cluster)
static void	check_for_gist_inet_ops (ClusterInfo *cluster)
static void	check_for_pg_role_prefix (ClusterInfo *cluster)
static void	check_for_new_tablespace_dir (void)
static void	check_for_user_defined_encoding_conversions (ClusterInfo *cluster)
static void	check_for_unicode_update (ClusterInfo *cluster)
static void	check_new_cluster_replication_slots (void)
static void	check_new_cluster_subscription_configuration (void)
static void	check_old_cluster_for_valid_slots (void)
static void	check_old_cluster_subscription_state (void)
static void	check_old_cluster_global_names (ClusterInfo *cluster)
static char *	data_type_check_query (int checknum)
static void	process_data_type_check (DbInfo *dbinfo, PGresult *res, void *arg)
static void	check_for_data_types_usage (ClusterInfo *cluster)
static char *	fix_path_separator (char *path)
void	output_check_banner (void)
void	check_and_dump_old_cluster (void)
void	check_new_cluster (void)
void	report_clusters_compatible (void)
void	issue_warnings_and_set_wal_level (void)
void	output_completion_banner (char *deletion_script_file_name)
void	check_cluster_versions (void)
void	check_cluster_compatibility (void)
void	create_script_for_old_cluster_deletion (char **deletion_script_file_name)
static void	process_isn_and_int8_passing_mismatch (DbInfo *dbinfo, PGresult *res, void *arg)
static void	process_user_defined_postfix_ops (DbInfo *dbinfo, PGresult *res, void *arg)
static void	process_incompat_polymorphics (DbInfo *dbinfo, PGresult *res, void *arg)
static void	process_with_oids_check (DbInfo *dbinfo, PGresult *res, void *arg)
static void	process_inconsistent_notnull (DbInfo *dbinfo, PGresult *res, void *arg)
static void	process_gist_inet_ops_check (DbInfo *dbinfo, PGresult *res, void *arg)
static void	process_user_defined_encoding_conversions (DbInfo *dbinfo, PGresult *res, void *arg)
static void	process_unicode_update (DbInfo *dbinfo, PGresult *res, void *arg)
static bool	unicode_version_changed (ClusterInfo *cluster)
static void	process_old_sub_state_check (DbInfo *dbinfo, PGresult *res, void *arg)

Variables
static DataTypesUsageChecks	data_types_usage_checks []

Macro Definition Documentation

ALL_VERSIONS

#define ALL_VERSIONS   -1

Definition at line 68 of file check.c.

MANUAL_CHECK

#define MANUAL_CHECK   1

Definition at line 67 of file check.c.

Function Documentation

check_and_dump_old_cluster()

void check_and_dump_old_cluster

(

void

)

Definition at line 593 of file check.c.

{
    /* -- OLD -- */
 
    if (!user_opts.live_check)
        start_postmaster(&old_cluster, true);
 
    /*
     * First check that all databases allow connections since we'll otherwise
     * fail in later stages.
     */
    check_for_connection_status(&old_cluster);
 
    /*
     * Check for encodings that are no longer supported.
     */
    check_for_unsupported_encodings(&old_cluster);
 
    /*
     * Validate database, user, role and tablespace names from the old
     * cluster. No need to check in 19 or newer as newline and carriage return
     * are not allowed at the creation time of the object.
     */
    if (GET_MAJOR_VERSION(old_cluster.major_version) < 1900)
        check_old_cluster_global_names(&old_cluster);
 
    /*
     * Extract a list of databases, tables, and logical replication slots from
     * the old cluster.
     */
    get_db_rel_and_slot_infos(&old_cluster);
 
    init_tablespaces();
 
    get_loadable_libraries();
 
 
    /*
     * Check for various failure cases
     */
    check_is_install_user(&old_cluster);
    check_for_prepared_transactions(&old_cluster);
    check_for_isn_and_int8_passing_mismatch(&old_cluster);
 
    if (GET_MAJOR_VERSION(old_cluster.major_version) >= 1700)
    {
        /*
         * Logical replication slots can be migrated since PG17. See comments
         * in get_db_rel_and_slot_infos().
         */
        check_old_cluster_for_valid_slots();
 
        /*
         * Subscriptions and their dependencies can be migrated since PG17.
         * Before that the logical slots are not upgraded, so we will not be
         * able to upgrade the logical replication clusters completely.
         */
        get_subscription_info(&old_cluster);
        check_old_cluster_subscription_state();
    }
 
    check_for_data_types_usage(&old_cluster);
 
    /*
     * Unicode updates can affect some objects that use expressions with
     * functions dependent on Unicode.
     */
    check_for_unicode_update(&old_cluster);
 
    /*
     * PG 14 changed the function signature of encoding conversion functions.
     * Conversions from older versions cannot be upgraded automatically
     * because the user-defined functions used by the encoding conversions
     * need to be changed to match the new signature.
     */
    if (GET_MAJOR_VERSION(old_cluster.major_version) <= 1300)
        check_for_user_defined_encoding_conversions(&old_cluster);
 
    /*
     * Pre-PG 14 allowed user defined postfix operators, which are not
     * supported anymore.  Verify there are none, iff applicable.
     */
    if (GET_MAJOR_VERSION(old_cluster.major_version) <= 1300)
        check_for_user_defined_postfix_ops(&old_cluster);
 
    /*
     * PG 14 changed polymorphic functions from anyarray to
     * anycompatiblearray.
     */
    if (GET_MAJOR_VERSION(old_cluster.major_version) <= 1300)
        check_for_incompatible_polymorphics(&old_cluster);
 
    /*
     * Pre-PG 12 allowed tables to be declared WITH OIDS, which is not
     * supported anymore. Verify there are none, iff applicable.
     */
    if (GET_MAJOR_VERSION(old_cluster.major_version) <= 1100)
        check_for_tables_with_oids(&old_cluster);
 
    /*
     * Pre-PG 18 allowed child tables to omit not-null constraints that their
     * parents columns have, but schema restore fails for them.  Verify there
     * are none, iff applicable.
     */
    if (GET_MAJOR_VERSION(old_cluster.major_version) <= 1800)
        check_for_not_null_inheritance(&old_cluster);
 
    /*
     * The btree_gist extension contains gist_inet_ops and gist_cidr_ops
     * opclasses that do not reliably give correct answers.  We want to
     * deprecate and eventually remove those, and as a first step v19 marks
     * them not-opcdefault and instead marks the replacement in-core opclass
     * "inet_ops" as opcdefault.  That creates a problem for pg_upgrade: in
     * versions where those opclasses were marked opcdefault, pg_dump will
     * dump indexes using them with no explicit opclass specification, so that
     * restore would create them using the inet_ops opclass.  That would be
     * incompatible with what's actually in the on-disk files.  So refuse to
     * upgrade if there are any such indexes.
     */
    if (GET_MAJOR_VERSION(old_cluster.major_version) <= 1800)
        check_for_gist_inet_ops(&old_cluster);
 
    /*
     * Pre-PG 10 allowed tables with 'unknown' type columns and non WAL logged
     * hash indexes
     */
    if (GET_MAJOR_VERSION(old_cluster.major_version) <= 906)
    {
        if (user_opts.check)
            old_9_6_invalidate_hash_indexes(&old_cluster, true);
    }
 
    /* 9.5 and below should not have roles starting with pg_ */
    if (GET_MAJOR_VERSION(old_cluster.major_version) <= 905)
        check_for_pg_role_prefix(&old_cluster);
 
    /*
     * While not a check option, we do this now because this is the only time
     * the old server is running.
     */
    if (!user_opts.check)
        generate_old_dump();
 
    if (!user_opts.live_check)
        stop_postmaster(false);
}

References UserOpts::check, check_for_connection_status(), check_for_data_types_usage(), check_for_gist_inet_ops(), check_for_incompatible_polymorphics(), check_for_isn_and_int8_passing_mismatch(), check_for_not_null_inheritance(), check_for_pg_role_prefix(), check_for_prepared_transactions(), check_for_tables_with_oids(), check_for_unicode_update(), check_for_unsupported_encodings(), check_for_user_defined_encoding_conversions(), check_for_user_defined_postfix_ops(), check_is_install_user(), check_old_cluster_for_valid_slots(), check_old_cluster_global_names(), check_old_cluster_subscription_state(), generate_old_dump(), get_db_rel_and_slot_infos(), get_loadable_libraries(), GET_MAJOR_VERSION, get_subscription_info(), init_tablespaces(), UserOpts::live_check, ClusterInfo::major_version, old_9_6_invalidate_hash_indexes(), old_cluster, start_postmaster(), stop_postmaster(), and user_opts.

Referenced by main().

check_cluster_compatibility()

void check_cluster_compatibility

(

void

)

Definition at line 937 of file check.c.

{
    /* get/check pg_control data of servers */
    get_control_data(&old_cluster);
    get_control_data(&new_cluster);
    check_control_data(&old_cluster.controldata, &new_cluster.controldata);
 
    if (user_opts.live_check && old_cluster.port == new_cluster.port)
        pg_fatal("When checking a live server, "
                 "the old and new port numbers must be different.");
}

References check_control_data(), ClusterInfo::controldata, get_control_data(), UserOpts::live_check, new_cluster, old_cluster, pg_fatal, ClusterInfo::port, and user_opts.

Referenced by main().

check_cluster_versions()

void check_cluster_versions

(

void

)

Definition at line 882 of file check.c.

{
    prep_status("Checking cluster versions");
 
    /* cluster versions should already have been obtained */
    Assert(old_cluster.major_version != 0);
    Assert(new_cluster.major_version != 0);
 
    /*
     * We allow upgrades from/to the same major version for alpha/beta
     * upgrades
     */
 
    if (GET_MAJOR_VERSION(old_cluster.major_version) < 902)
        pg_fatal("This utility can only upgrade from PostgreSQL version %s and later.",
                 "9.2");
 
    /* Only current PG version is supported as a target */
    if (GET_MAJOR_VERSION(new_cluster.major_version) != GET_MAJOR_VERSION(PG_VERSION_NUM))
        pg_fatal("This utility can only upgrade to PostgreSQL version %s.",
                 PG_MAJORVERSION);
 
    /*
     * We can't allow downgrading because we use the target pg_dump, and
     * pg_dump cannot operate on newer database versions, only current and
     * older versions.
     */
    if (old_cluster.major_version > new_cluster.major_version)
        pg_fatal("This utility cannot be used to downgrade to older major PostgreSQL versions.");
 
    /* Ensure binaries match the designated data directories */
    if (GET_MAJOR_VERSION(old_cluster.major_version) !=
        GET_MAJOR_VERSION(old_cluster.bin_version))
        pg_fatal("Old cluster data and binary directories are from different major versions.");
    if (GET_MAJOR_VERSION(new_cluster.major_version) !=
        GET_MAJOR_VERSION(new_cluster.bin_version))
        pg_fatal("New cluster data and binary directories are from different major versions.");
 
    /*
     * Since from version 18, newly created database clusters always have
     * 'signed' default char-signedness, it makes less sense to use
     * --set-char-signedness option for upgrading from version 18 or later.
     * Users who want to change the default char signedness of the new
     * cluster, they can use pg_resetwal manually before the upgrade.
     */
    if (GET_MAJOR_VERSION(old_cluster.major_version) >= 1800 &&
        user_opts.char_signedness != -1)
        pg_fatal("The option %s cannot be used for upgrades from PostgreSQL %s and later.",
                 "--set-char-signedness", "18");
 
    check_ok();
}

References Assert, ClusterInfo::bin_version, UserOpts::char_signedness, check_ok(), fb(), GET_MAJOR_VERSION, ClusterInfo::major_version, new_cluster, old_cluster, pg_fatal, prep_status(), and user_opts.

Referenced by main().

check_for_connection_status()

static void check_for_connection_status ( ClusterInfo *  cluster )

static

Definition at line 1168 of file check.c.

{
    int         dbnum;
    PGconn     *conn_template1;
    PGresult   *dbres;
    int         ntups;
    int         i_datname;
    int         i_datallowconn;
    int         i_datconnlimit;
    FILE       *script = NULL;
    char        output_path[MAXPGPATH];
 
    prep_status("Checking database connection settings");
 
    snprintf(output_path, sizeof(output_path), "%s/%s",
             log_opts.basedir,
             "databases_cannot_connect_to.txt");
 
    conn_template1 = connectToServer(cluster, "template1");
 
    /* get database names */
    dbres = executeQueryOrDie(conn_template1,
                              "SELECT   datname, datallowconn, datconnlimit "
                              "FROM pg_catalog.pg_database");
 
    i_datname = PQfnumber(dbres, "datname");
    i_datallowconn = PQfnumber(dbres, "datallowconn");
    i_datconnlimit = PQfnumber(dbres, "datconnlimit");
 
    ntups = PQntuples(dbres);
    for (dbnum = 0; dbnum < ntups; dbnum++)
    {
        char       *datname = PQgetvalue(dbres, dbnum, i_datname);
        char       *datallowconn = PQgetvalue(dbres, dbnum, i_datallowconn);
        char       *datconnlimit = PQgetvalue(dbres, dbnum, i_datconnlimit);
 
        if (strcmp(datname, "template0") == 0)
        {
            /* avoid restore failure when pg_dumpall tries to create template0 */
            if (strcmp(datallowconn, "t") == 0)
                pg_fatal("template0 must not allow connections, "
                         "i.e. its pg_database.datallowconn must be false");
        }
        else
        {
            /*
             * Avoid datallowconn == false databases from being skipped on
             * restore, and ensure that no databases are marked invalid with
             * datconnlimit == -2.
             */
            if ((strcmp(datallowconn, "f") == 0) || strcmp(datconnlimit, "-2") == 0)
            {
                if (script == NULL && (script = fopen_priv(output_path, "w")) == NULL)
                    pg_fatal("could not open file \"%s\": %m", output_path);
 
                fprintf(script, "%s\n", datname);
            }
        }
    }
 
    PQclear(dbres);
 
    PQfinish(conn_template1);
 
    if (script)
    {
        fclose(script);
        pg_log(PG_REPORT, "fatal");
        pg_fatal("All non-template0 databases must allow connections, i.e. their\n"
                 "pg_database.datallowconn must be true and pg_database.datconnlimit\n"
                 "must not be -2.  Your installation contains non-template0 databases\n"
                 "which cannot be connected to.  Consider allowing connection for all\n"
                 "non-template0 databases or drop the databases which do not allow\n"
                 "connections.  A list of databases with the problem is in the file:\n"
                 "    %s", output_path);
    }
    else
        check_ok();
}

References LogOpts::basedir, check_ok(), connectToServer(), datallowconn, datconnlimit, datname, executeQueryOrDie(), fb(), fopen_priv, fprintf, log_opts, MAXPGPATH, pg_fatal, pg_log(), PG_REPORT, PQclear, PQfinish(), PQfnumber(), PQgetvalue, PQntuples, prep_status(), and snprintf.

Referenced by check_and_dump_old_cluster().

check_for_data_types_usage()

static void check_for_data_types_usage ( ClusterInfo *  cluster )

static

Definition at line 468 of file check.c.

{
    PQExpBuffer report = NULL;
    DataTypesUsageChecks *tmp = data_types_usage_checks;
    int         n_data_types_usage_checks = 0;
    UpgradeTask *task = upgrade_task_create();
    char      **queries = NULL;
    struct data_type_check_state *states;
 
    prep_status("Checking data type usage");
 
    /* Gather number of checks to perform */
    while (tmp->status != NULL)
    {
        n_data_types_usage_checks++;
        tmp++;
    }
 
    /* Allocate memory for queries and for task states */
    queries = pg_malloc0_array(char *, n_data_types_usage_checks);
    states = pg_malloc0_array(struct data_type_check_state, n_data_types_usage_checks);
 
    for (int i = 0; i < n_data_types_usage_checks; i++)
    {
        DataTypesUsageChecks *check = &data_types_usage_checks[i];
 
        if (check->threshold_version == MANUAL_CHECK)
        {
            Assert(check->version_hook);
 
            /*
             * Make sure that the check applies to the current cluster version
             * and skip it if not.
             */
            if (!check->version_hook(cluster))
                continue;
        }
        else if (check->threshold_version != ALL_VERSIONS)
        {
            if (GET_MAJOR_VERSION(cluster->major_version) > check->threshold_version)
                continue;
        }
        else
            Assert(check->threshold_version == ALL_VERSIONS);
 
        queries[i] = data_type_check_query(i);
 
        states[i].check = check;
        states[i].report = &report;
 
        upgrade_task_add_step(task, queries[i], process_data_type_check,
                              true, &states[i]);
    }
 
    /*
     * Connect to each database in the cluster and run all defined checks
     * against that database before trying the next one.
     */
    upgrade_task_run(task, cluster);
    upgrade_task_free(task);
 
    if (report)
    {
        pg_fatal("Data type checks failed: %s", report->data);
        destroyPQExpBuffer(report);
    }
 
    for (int i = 0; i < n_data_types_usage_checks; i++)
    {
        if (queries[i])
            pg_free(queries[i]);
    }
    pg_free(queries);
    pg_free(states);
 
    check_ok();
}

References ALL_VERSIONS, Assert, data_type_check_state::check, check_ok(), PQExpBufferData::data, data_type_check_query(), data_types_usage_checks, destroyPQExpBuffer(), fb(), GET_MAJOR_VERSION, i, MANUAL_CHECK, pg_fatal, pg_free(), pg_malloc0_array, prep_status(), process_data_type_check(), data_type_check_state::report, DataTypesUsageChecks::status, DataTypesUsageChecks::threshold_version, upgrade_task_add_step(), upgrade_task_create(), upgrade_task_free(), upgrade_task_run(), and DataTypesUsageChecks::version_hook.

Referenced by check_and_dump_old_cluster().

check_for_gist_inet_ops()

static void check_for_gist_inet_ops ( ClusterInfo *  cluster )

static

Definition at line 1833 of file check.c.

{
    UpgradeTaskReport report;
    UpgradeTask *task = upgrade_task_create();
    const char *query = "SELECT nc.nspname, cc.relname "
        "FROM   pg_catalog.pg_opclass oc, pg_catalog.pg_index i, "
        "       pg_catalog.pg_class cc, pg_catalog.pg_namespace nc "
        "WHERE  oc.opcmethod = " CppAsString2(GIST_AM_OID)
        "       AND oc.opcname IN ('gist_inet_ops', 'gist_cidr_ops')"
        "       AND oc.opcdefault"
        "       AND oc.oid = any(i.indclass)"
        "       AND i.indexrelid = cc.oid AND cc.relnamespace = nc.oid";
 
    prep_status("Checking for uses of gist_inet_ops/gist_cidr_ops");
 
    report.file = NULL;
    snprintf(report.path, sizeof(report.path), "%s/%s",
             log_opts.basedir,
             "gist_inet_ops.txt");
 
    upgrade_task_add_step(task, query, process_gist_inet_ops_check,
                          true, &report);
    upgrade_task_run(task, cluster);
    upgrade_task_free(task);
 
    if (report.file)
    {
        fclose(report.file);
        pg_log(PG_REPORT, "fatal");
        pg_fatal("Your installation contains indexes that use btree_gist's\n"
                 "gist_inet_ops or gist_cidr_ops opclasses,\n"
                 "which cannot be binary-upgraded.  Replace them with indexes\n"
                 "that use the built-in GiST inet_ops opclass.\n"
                 "A list of indexes with the problem is in the file:\n"
                 "    %s", report.path);
    }
    else
        check_ok();
}

References LogOpts::basedir, check_ok(), CppAsString2, fb(), UpgradeTaskReport::file, log_opts, UpgradeTaskReport::path, pg_fatal, pg_log(), PG_REPORT, prep_status(), process_gist_inet_ops_check(), snprintf, upgrade_task_add_step(), upgrade_task_create(), upgrade_task_free(), and upgrade_task_run().

Referenced by check_and_dump_old_cluster().

check_for_incompatible_polymorphics()

static void check_for_incompatible_polymorphics ( ClusterInfo *  cluster )

static

Definition at line 1550 of file check.c.

{
    PQExpBufferData old_polymorphics;
    UpgradeTask *task = upgrade_task_create();
    UpgradeTaskReport report;
    char       *query;
 
    prep_status("Checking for incompatible polymorphic functions");
 
    report.file = NULL;
    snprintf(report.path, sizeof(report.path), "%s/%s",
             log_opts.basedir,
             "incompatible_polymorphics.txt");
 
    /* The set of problematic functions varies a bit in different versions */
    initPQExpBuffer(&old_polymorphics);
 
    appendPQExpBufferStr(&old_polymorphics,
                         "'array_append(anyarray,anyelement)'"
                         ", 'array_cat(anyarray,anyarray)'"
                         ", 'array_prepend(anyelement,anyarray)'");
 
    if (GET_MAJOR_VERSION(cluster->major_version) >= 903)
        appendPQExpBufferStr(&old_polymorphics,
                             ", 'array_remove(anyarray,anyelement)'"
                             ", 'array_replace(anyarray,anyelement,anyelement)'");
 
    if (GET_MAJOR_VERSION(cluster->major_version) >= 905)
        appendPQExpBufferStr(&old_polymorphics,
                             ", 'array_position(anyarray,anyelement)'"
                             ", 'array_position(anyarray,anyelement,integer)'"
                             ", 'array_positions(anyarray,anyelement)'"
                             ", 'width_bucket(anyelement,anyarray)'");
 
    /*
     * The query below hardcodes FirstNormalObjectId as 16384 rather than
     * interpolating that C #define into the query because, if that #define is
     * ever changed, the cutoff we want to use is the value used by
     * pre-version 14 servers, not that of some future version.
     */
 
    /* Aggregate transition functions */
    query = psprintf("SELECT 'aggregate' AS objkind, p.oid::regprocedure::text AS objname "
                     "FROM pg_proc AS p "
                     "JOIN pg_aggregate AS a ON a.aggfnoid=p.oid "
                     "JOIN pg_proc AS transfn ON transfn.oid=a.aggtransfn "
                     "WHERE p.oid >= 16384 "
                     "AND a.aggtransfn = ANY(ARRAY[%s]::regprocedure[]) "
                     "AND a.aggtranstype = ANY(ARRAY['anyarray', 'anyelement']::regtype[]) "
 
    /* Aggregate final functions */
                     "UNION ALL "
                     "SELECT 'aggregate' AS objkind, p.oid::regprocedure::text AS objname "
                     "FROM pg_proc AS p "
                     "JOIN pg_aggregate AS a ON a.aggfnoid=p.oid "
                     "JOIN pg_proc AS finalfn ON finalfn.oid=a.aggfinalfn "
                     "WHERE p.oid >= 16384 "
                     "AND a.aggfinalfn = ANY(ARRAY[%s]::regprocedure[]) "
                     "AND a.aggtranstype = ANY(ARRAY['anyarray', 'anyelement']::regtype[]) "
 
    /* Operators */
                     "UNION ALL "
                     "SELECT 'operator' AS objkind, op.oid::regoperator::text AS objname "
                     "FROM pg_operator AS op "
                     "WHERE op.oid >= 16384 "
                     "AND oprcode = ANY(ARRAY[%s]::regprocedure[]) "
                     "AND oprleft = ANY(ARRAY['anyarray', 'anyelement']::regtype[])",
                     old_polymorphics.data,
                     old_polymorphics.data,
                     old_polymorphics.data);
 
    upgrade_task_add_step(task, query, process_incompat_polymorphics,
                          true, &report);
    upgrade_task_run(task, cluster);
    upgrade_task_free(task);
 
    if (report.file)
    {
        fclose(report.file);
        pg_log(PG_REPORT, "fatal");
        pg_fatal("Your installation contains user-defined objects that refer to internal\n"
                 "polymorphic functions with arguments of type \"anyarray\" or \"anyelement\".\n"
                 "These user-defined objects must be dropped before upgrading and restored\n"
                 "afterwards, changing them to refer to the new corresponding functions with\n"
                 "arguments of type \"anycompatiblearray\" and \"anycompatible\".\n"
                 "A list of the problematic objects is in the file:\n"
                 "    %s", report.path);
    }
    else
        check_ok();
 
    termPQExpBuffer(&old_polymorphics);
    pg_free(query);
}

References appendPQExpBufferStr(), LogOpts::basedir, check_ok(), fb(), UpgradeTaskReport::file, GET_MAJOR_VERSION, initPQExpBuffer(), log_opts, UpgradeTaskReport::path, pg_fatal, pg_free(), pg_log(), PG_REPORT, prep_status(), process_incompat_polymorphics(), psprintf(), snprintf, termPQExpBuffer(), upgrade_task_add_step(), upgrade_task_create(), upgrade_task_free(), and upgrade_task_run().

Referenced by check_and_dump_old_cluster().

check_for_isn_and_int8_passing_mismatch()

static void check_for_isn_and_int8_passing_mismatch ( ClusterInfo *  cluster )

static

Definition at line 1377 of file check.c.

{
    UpgradeTask *task;
    UpgradeTaskReport report;
    const char *query = "SELECT n.nspname, p.proname "
        "FROM   pg_catalog.pg_proc p, "
        "       pg_catalog.pg_namespace n "
        "WHERE  p.pronamespace = n.oid AND "
        "       p.probin = '$libdir/isn'";
 
    prep_status("Checking for contrib/isn with bigint-passing mismatch");
 
    if (old_cluster.controldata.float8_pass_by_value ==
        new_cluster.controldata.float8_pass_by_value)
    {
        /* no mismatch */
        check_ok();
        return;
    }
 
    report.file = NULL;
    snprintf(report.path, sizeof(report.path), "%s/%s",
             log_opts.basedir,
             "contrib_isn_and_int8_pass_by_value.txt");
 
    task = upgrade_task_create();
    upgrade_task_add_step(task, query, process_isn_and_int8_passing_mismatch,
                          true, &report);
    upgrade_task_run(task, cluster);
    upgrade_task_free(task);
 
    if (report.file)
    {
        fclose(report.file);
        pg_log(PG_REPORT, "fatal");
        pg_fatal("Your installation contains \"contrib/isn\" functions which rely on the\n"
                 "bigint data type.  Your old and new clusters pass bigint values\n"
                 "differently so this cluster cannot currently be upgraded.  You can\n"
                 "manually dump databases in the old cluster that use \"contrib/isn\"\n"
                 "facilities, drop them, perform the upgrade, and then restore them.  A\n"
                 "list of the problem functions is in the file:\n"
                 "    %s", report.path);
    }
    else
        check_ok();
}

References LogOpts::basedir, check_ok(), ClusterInfo::controldata, fb(), UpgradeTaskReport::file, ControlData::float8_pass_by_value, log_opts, new_cluster, old_cluster, UpgradeTaskReport::path, pg_fatal, pg_log(), PG_REPORT, prep_status(), process_isn_and_int8_passing_mismatch(), snprintf, upgrade_task_add_step(), upgrade_task_create(), upgrade_task_free(), and upgrade_task_run().

Referenced by check_and_dump_old_cluster().

check_for_new_tablespace_dir()

static void check_for_new_tablespace_dir ( void  )

static

Definition at line 983 of file check.c.

{
    int         tblnum;
    char        new_tablespace_dir[MAXPGPATH];
 
    prep_status("Checking for new cluster tablespace directories");
 
    for (tblnum = 0; tblnum < new_cluster.num_tablespaces; tblnum++)
    {
        struct stat statbuf;
 
        snprintf(new_tablespace_dir, MAXPGPATH, "%s%s",
                 new_cluster.tablespaces[tblnum],
                 new_cluster.tablespace_suffix);
 
        if (stat(new_tablespace_dir, &statbuf) == 0 || errno != ENOENT)
            pg_fatal("new cluster tablespace directory already exists: \"%s\"",
                     new_tablespace_dir);
    }
 
    check_ok();
}

References check_ok(), fb(), MAXPGPATH, new_cluster, ClusterInfo::num_tablespaces, pg_fatal, prep_status(), snprintf, stat, ClusterInfo::tablespace_suffix, and ClusterInfo::tablespaces.

Referenced by check_new_cluster().

check_for_not_null_inheritance()

static void check_for_not_null_inheritance ( ClusterInfo *  cluster )

static

Definition at line 1754 of file check.c.

{
    UpgradeTaskReport report;
    UpgradeTask *task;
    const char *query;
 
    prep_status("Checking for not-null constraint inconsistencies");
 
    report.file = NULL;
    snprintf(report.path, sizeof(report.path), "%s/%s",
             log_opts.basedir,
             "not_null_inconsistent_columns.txt");
 
    query = "SELECT nspname, cc.relname, ac.attname "
        "FROM pg_catalog.pg_inherits i, pg_catalog.pg_attribute ac, "
        "     pg_catalog.pg_attribute ap, pg_catalog.pg_class cc, "
        "     pg_catalog.pg_namespace nc "
        "WHERE cc.oid = ac.attrelid AND i.inhrelid = ac.attrelid "
        "      AND i.inhparent = ap.attrelid AND ac.attname = ap.attname "
        "      AND cc.relnamespace = nc.oid "
        "      AND ap.attnum > 0 and ap.attnotnull AND NOT ac.attnotnull";
 
    task = upgrade_task_create();
    upgrade_task_add_step(task, query,
                          process_inconsistent_notnull,
                          true, &report);
    upgrade_task_run(task, cluster);
    upgrade_task_free(task);
 
    if (report.file)
    {
        fclose(report.file);
        pg_log(PG_REPORT, "fatal");
        pg_fatal("Your installation contains inconsistent NOT NULL constraints.\n"
                 "If the parent column(s) are NOT NULL, then the child column must\n"
                 "also be marked NOT NULL, or the upgrade will fail.\n"
                 "You can fix this by running\n"
                 "    ALTER TABLE tablename ALTER column SET NOT NULL;\n"
                 "on each column listed in the file:\n"
                 "    %s", report.path);
    }
    else
        check_ok();
}

References LogOpts::basedir, check_ok(), fb(), UpgradeTaskReport::file, log_opts, UpgradeTaskReport::path, pg_fatal, pg_log(), PG_REPORT, prep_status(), process_inconsistent_notnull(), snprintf, upgrade_task_add_step(), upgrade_task_create(), upgrade_task_free(), and upgrade_task_run().

Referenced by check_and_dump_old_cluster().

check_for_pg_role_prefix()

static void check_for_pg_role_prefix ( ClusterInfo *  cluster )

static

Definition at line 1879 of file check.c.

{
    PGresult   *res;
    PGconn     *conn = connectToServer(cluster, "template1");
    int         ntups;
    int         i_roloid;
    int         i_rolname;
    FILE       *script = NULL;
    char        output_path[MAXPGPATH];
 
    prep_status("Checking for roles starting with \"pg_\"");
 
    snprintf(output_path, sizeof(output_path), "%s/%s",
             log_opts.basedir,
             "pg_role_prefix.txt");
 
    res = executeQueryOrDie(conn,
                            "SELECT oid AS roloid, rolname "
                            "FROM pg_catalog.pg_roles "
                            "WHERE rolname ~ '^pg_'");
 
    ntups = PQntuples(res);
    i_roloid = PQfnumber(res, "roloid");
    i_rolname = PQfnumber(res, "rolname");
    for (int rowno = 0; rowno < ntups; rowno++)
    {
        if (script == NULL && (script = fopen_priv(output_path, "w")) == NULL)
            pg_fatal("could not open file \"%s\": %m", output_path);
        fprintf(script, "%s (oid=%s)\n",
                PQgetvalue(res, rowno, i_rolname),
                PQgetvalue(res, rowno, i_roloid));
    }
 
    PQclear(res);
 
    PQfinish(conn);
 
    if (script)
    {
        fclose(script);
        pg_log(PG_REPORT, "fatal");
        pg_fatal("Your installation contains roles starting with \"pg_\".\n"
                 "\"pg_\" is a reserved prefix for system roles.  The cluster\n"
                 "cannot be upgraded until these roles are renamed.\n"
                 "A list of roles starting with \"pg_\" is in the file:\n"
                 "    %s", output_path);
    }
    else
        check_ok();
}

References LogOpts::basedir, check_ok(), conn, connectToServer(), executeQueryOrDie(), fb(), fopen_priv, fprintf, log_opts, MAXPGPATH, pg_fatal, pg_log(), PG_REPORT, PQclear, PQfinish(), PQfnumber(), PQgetvalue, PQntuples, prep_status(), and snprintf.

Referenced by check_and_dump_old_cluster().

check_for_prepared_transactions()

static void check_for_prepared_transactions ( ClusterInfo *  cluster )

static

Definition at line 1314 of file check.c.

{
    PGresult   *res;
    PGconn     *conn = connectToServer(cluster, "template1");
 
    prep_status("Checking for prepared transactions");
 
    res = executeQueryOrDie(conn,
                            "SELECT * "
                            "FROM pg_catalog.pg_prepared_xacts");
 
    if (PQntuples(res) != 0)
    {
        if (cluster == &old_cluster)
            pg_fatal("The source cluster contains prepared transactions");
        else
            pg_fatal("The target cluster contains prepared transactions");
    }
 
    PQclear(res);
 
    PQfinish(conn);
 
    check_ok();
}

References check_ok(), conn, connectToServer(), executeQueryOrDie(), fb(), old_cluster, pg_fatal, PQclear, PQfinish(), PQntuples, and prep_status().

Referenced by check_and_dump_old_cluster(), and check_new_cluster().

check_for_tables_with_oids()

static void check_for_tables_with_oids ( ClusterInfo *  cluster )

static

Definition at line 1677 of file check.c.

{
    UpgradeTaskReport report;
    UpgradeTask *task = upgrade_task_create();
    const char *query = "SELECT n.nspname, c.relname "
        "FROM   pg_catalog.pg_class c, "
        "       pg_catalog.pg_namespace n "
        "WHERE  c.relnamespace = n.oid AND "
        "       c.relhasoids AND"
        "       n.nspname NOT IN ('pg_catalog')";
 
    prep_status("Checking for tables WITH OIDS");
 
    report.file = NULL;
    snprintf(report.path, sizeof(report.path), "%s/%s",
             log_opts.basedir,
             "tables_with_oids.txt");
 
    upgrade_task_add_step(task, query, process_with_oids_check,
                          true, &report);
    upgrade_task_run(task, cluster);
    upgrade_task_free(task);
 
    if (report.file)
    {
        fclose(report.file);
        pg_log(PG_REPORT, "fatal");
        pg_fatal("Your installation contains tables declared WITH OIDS, which is not\n"
                 "supported anymore.  Consider removing the oid column using\n"
                 "    ALTER TABLE ... SET WITHOUT OIDS;\n"
                 "A list of tables with the problem is in the file:\n"
                 "    %s", report.path);
    }
    else
        check_ok();
}

References LogOpts::basedir, check_ok(), fb(), UpgradeTaskReport::file, log_opts, UpgradeTaskReport::path, pg_fatal, pg_log(), PG_REPORT, prep_status(), process_with_oids_check(), snprintf, upgrade_task_add_step(), upgrade_task_create(), upgrade_task_free(), and upgrade_task_run().

Referenced by check_and_dump_old_cluster().

check_for_unicode_update()

static void check_for_unicode_update ( ClusterInfo *  cluster )

static

Definition at line 2071 of file check.c.

{
    UpgradeTaskReport report;
    UpgradeTask *task;
    const char *query;
 
    /*
     * The builtin provider did not exist prior to version 17. While there are
     * still problems that could potentially be caught from earlier versions,
     * such as an index on NORMALIZE(), we don't check for that here.
     */
    if (GET_MAJOR_VERSION(cluster->major_version) < 1700)
        return;
 
    prep_status("Checking for objects affected by Unicode update");
 
    if (!unicode_version_changed(cluster))
    {
        check_ok();
        return;
    }
 
    report.file = NULL;
    snprintf(report.path, sizeof(report.path), "%s/%s",
             log_opts.basedir,
             "unicode_dependent_rels.txt");
 
    query =
    /* collations that use built-in Unicode for character semantics */
        "WITH collations(collid) AS ( "
        "  SELECT oid FROM pg_collation "
        "  WHERE collprovider='b' AND colllocale IN ('C.UTF-8','PG_UNICODE_FAST') "
    /* include default collation, if appropriate */
        "  UNION "
        "  SELECT 'pg_catalog.default'::regcollation FROM pg_database "
        "  WHERE datname = current_database() AND "
        "  datlocprovider='b' AND datlocale IN ('C.UTF-8','PG_UNICODE_FAST') "
        "), "
    /* functions that use built-in Unicode */
        "functions(procid) AS ( "
        "  SELECT proc.oid FROM pg_proc proc "
        "  WHERE proname IN ('normalize','unicode_assigned','unicode_version','is_normalized') AND "
        "        pronamespace='pg_catalog'::regnamespace "
        "), "
    /* operators that use the input collation for character semantics */
        "coll_operators(operid, procid, collid) AS ( "
        "  SELECT oper.oid, oper.oprcode, collid FROM pg_operator oper, collations "
        "  WHERE oprname IN ('~', '~*', '!~', '!~*', '~~*', '!~~*') AND "
        "        oprnamespace='pg_catalog'::regnamespace AND "
        "        oprright='pg_catalog.text'::pg_catalog.regtype "
        "), "
    /* functions that use the input collation for character semantics */
        "coll_functions(procid, collid) AS ( "
        "  SELECT proc.oid, collid FROM pg_proc proc, collations "
        "  WHERE pronamespace='pg_catalog'::regnamespace AND "
        "        ((proname IN ('lower','initcap','upper','casefold') AND "
        "          pronargs = 1 AND "
        "          proargtypes[0] = 'pg_catalog.text'::pg_catalog.regtype) OR "
        "         (proname = 'substring' AND pronargs = 2 AND "
        "          proargtypes[0] = 'pg_catalog.text'::pg_catalog.regtype AND "
        "          proargtypes[1] = 'pg_catalog.text'::pg_catalog.regtype) OR "
        "         proname LIKE 'regexp_%') "
    /* include functions behind the operators listed above */
        "  UNION "
        "  SELECT procid, collid FROM coll_operators "
        "), "
 
    /*
     * Generate patterns to search a pg_node_tree for the above functions and
     * operators.
     */
        "patterns(p) AS ( "
        "  SELECT '{FUNCEXPR :funcid ' || procid::text || '[ }]' FROM functions "
        "  UNION "
        "  SELECT '{OPEXPR :opno ' || operid::text || ' (:\\w+ \\w+ )*' || "
        "         ':inputcollid ' || collid::text || '[ }]' FROM coll_operators "
        "  UNION "
        "  SELECT '{FUNCEXPR :funcid ' || procid::text || ' (:\\w+ \\w+ )*' || "
        "         ':inputcollid ' || collid::text || '[ }]' FROM coll_functions "
        ") "
 
    /*
     * Match the patterns against expressions used for relation contents.
     */
        "SELECT reloid, relkind, nspname, relname "
        "  FROM ( "
        "    SELECT conrelid "
        "    FROM pg_constraint, patterns WHERE conbin::text ~ p "
        "  UNION "
        "    SELECT indexrelid "
        "    FROM pg_index, patterns WHERE indexprs::text ~ p OR indpred::text ~ p "
        "  UNION "
        "    SELECT partrelid "
        "    FROM pg_partitioned_table, patterns WHERE partexprs::text ~ p "
        "  UNION "
        "    SELECT ev_class "
        "    FROM pg_rewrite, pg_class, patterns "
        "    WHERE ev_class = pg_class.oid AND relkind = 'm' AND ev_action::text ~ p"
        "  ) s(reloid), pg_class c, pg_namespace n, pg_database d "
        "  WHERE s.reloid = c.oid AND c.relnamespace = n.oid AND "
        "        d.datname = current_database() AND "
        "        d.encoding = pg_char_to_encoding('UTF8');";
 
    task = upgrade_task_create();
    upgrade_task_add_step(task, query,
                          process_unicode_update,
                          true, &report);
    upgrade_task_run(task, cluster);
    upgrade_task_free(task);
 
    if (report.file)
    {
        fclose(report.file);
        report_status(PG_WARNING, "warning");
        pg_log(PG_WARNING, "Your installation contains relations that might be affected by a new version of Unicode.\n"
               "A list of potentially-affected relations is in the file:\n"
               "    %s", report.path);
    }
    else
        check_ok();
}

References LogOpts::basedir, check_ok(), fb(), UpgradeTaskReport::file, GET_MAJOR_VERSION, log_opts, UpgradeTaskReport::path, pg_log(), PG_WARNING, prep_status(), process_unicode_update(), report_status(), snprintf, unicode_version_changed(), upgrade_task_add_step(), upgrade_task_create(), upgrade_task_free(), and upgrade_task_run().

Referenced by check_and_dump_old_cluster().

check_for_unsupported_encodings()

static void check_for_unsupported_encodings ( ClusterInfo *  cluster )

static

Definition at line 1253 of file check.c.

{
    int         i_datname;
    int         i_encoding;
    int         ntups;
    PGresult   *res;
    PGconn     *conn;
    FILE       *script = NULL;
    char        output_path[MAXPGPATH];
 
    prep_status("Checking for unsupported encodings");
 
    snprintf(output_path, sizeof(output_path), "%s/%s",
             log_opts.basedir,
             "databases_unsupported_encoding.txt");
 
    conn = connectToServer(cluster, "template1");
 
    res = executeQueryOrDie(conn,
                            "SELECT datname, encoding "
                            "FROM pg_catalog.pg_database");
    ntups = PQntuples(res);
    i_datname = PQfnumber(res, "datname");
    i_encoding = PQfnumber(res, "encoding");
    for (int rowno = 0; rowno < ntups; rowno++)
    {
        char       *datname = PQgetvalue(res, rowno, i_datname);
        int         encoding = atoi(PQgetvalue(res, rowno, i_encoding));
 
        if (!PG_VALID_BE_ENCODING(encoding))
        {
            if (script == NULL && (script = fopen_priv(output_path, "w")) == NULL)
                pg_fatal("could not open file \"%s\": %m", output_path);
 
            fprintf(script, "%s\n", datname);
        }
    }
    PQclear(res);
    PQfinish(conn);
 
    if (script)
    {
        fclose(script);
        pg_log(PG_REPORT, "fatal");
        pg_fatal("Your installation contains databases using encodings that are\n"
                 "no longer supported.  Consider dumping and restoring with UTF8.\n"
                 "A list of databases with unsupported encodings is in the file:\n"
                 "    %s", output_path);
    }
    else
        check_ok();
}

References LogOpts::basedir, check_ok(), conn, connectToServer(), datname, encoding, executeQueryOrDie(), fb(), fopen_priv, fprintf, log_opts, MAXPGPATH, pg_fatal, pg_log(), PG_REPORT, PG_VALID_BE_ENCODING, PQclear, PQfinish(), PQfnumber(), PQgetvalue, PQntuples, prep_status(), and snprintf.

Referenced by check_and_dump_old_cluster().

check_for_user_defined_encoding_conversions()

static void check_for_user_defined_encoding_conversions ( ClusterInfo *  cluster )

static

Definition at line 1965 of file check.c.

{
    UpgradeTaskReport report;
    UpgradeTask *task = upgrade_task_create();
    const char *query;
 
    prep_status("Checking for user-defined encoding conversions");
 
    report.file = NULL;
    snprintf(report.path, sizeof(report.path), "%s/%s",
             log_opts.basedir,
             "encoding_conversions.txt");
 
    /*
     * The query below hardcodes FirstNormalObjectId as 16384 rather than
     * interpolating that C #define into the query because, if that #define is
     * ever changed, the cutoff we want to use is the value used by
     * pre-version 14 servers, not that of some future version.
     */
    query = "SELECT c.oid as conoid, c.conname, n.nspname "
        "FROM pg_catalog.pg_conversion c, "
        "     pg_catalog.pg_namespace n "
        "WHERE c.connamespace = n.oid AND "
        "      c.oid >= 16384";
 
    upgrade_task_add_step(task, query,
                          process_user_defined_encoding_conversions,
                          true, &report);
    upgrade_task_run(task, cluster);
    upgrade_task_free(task);
 
    if (report.file)
    {
        fclose(report.file);
        pg_log(PG_REPORT, "fatal");
        pg_fatal("Your installation contains user-defined encoding conversions.\n"
                 "The conversion function parameters changed in PostgreSQL version 14\n"
                 "so this cluster cannot currently be upgraded.  You can remove the\n"
                 "encoding conversions in the old cluster and restart the upgrade.\n"
                 "A list of user-defined encoding conversions is in the file:\n"
                 "    %s", report.path);
    }
    else
        check_ok();
}

References LogOpts::basedir, check_ok(), fb(), UpgradeTaskReport::file, log_opts, UpgradeTaskReport::path, pg_fatal, pg_log(), PG_REPORT, prep_status(), process_user_defined_encoding_conversions(), snprintf, upgrade_task_add_step(), upgrade_task_create(), upgrade_task_free(), and upgrade_task_run().

Referenced by check_and_dump_old_cluster().

check_for_user_defined_postfix_ops()

static void check_for_user_defined_postfix_ops ( ClusterInfo *  cluster )

static

Definition at line 1462 of file check.c.

{
    UpgradeTaskReport report;
    UpgradeTask *task = upgrade_task_create();
    const char *query;
 
    /*
     * The query below hardcodes FirstNormalObjectId as 16384 rather than
     * interpolating that C #define into the query because, if that #define is
     * ever changed, the cutoff we want to use is the value used by
     * pre-version 14 servers, not that of some future version.
     */
    query = "SELECT o.oid AS oproid, "
        "       n.nspname AS oprnsp, "
        "       o.oprname, "
        "       tn.nspname AS typnsp, "
        "       t.typname "
        "FROM pg_catalog.pg_operator o, "
        "     pg_catalog.pg_namespace n, "
        "     pg_catalog.pg_type t, "
        "     pg_catalog.pg_namespace tn "
        "WHERE o.oprnamespace = n.oid AND "
        "      o.oprleft = t.oid AND "
        "      t.typnamespace = tn.oid AND "
        "      o.oprright = 0 AND "
        "      o.oid >= 16384";
 
    prep_status("Checking for user-defined postfix operators");
 
    report.file = NULL;
    snprintf(report.path, sizeof(report.path), "%s/%s",
             log_opts.basedir,
             "postfix_ops.txt");
 
    upgrade_task_add_step(task, query, process_user_defined_postfix_ops,
                          true, &report);
    upgrade_task_run(task, cluster);
    upgrade_task_free(task);
 
    if (report.file)
    {
        fclose(report.file);
        pg_log(PG_REPORT, "fatal");
        pg_fatal("Your installation contains user-defined postfix operators, which are not\n"
                 "supported anymore.  Consider dropping the postfix operators and replacing\n"
                 "them with prefix operators or function calls.\n"
                 "A list of user-defined postfix operators is in the file:\n"
                 "    %s", report.path);
    }
    else
        check_ok();
}

References LogOpts::basedir, check_ok(), fb(), UpgradeTaskReport::file, log_opts, UpgradeTaskReport::path, pg_fatal, pg_log(), PG_REPORT, prep_status(), process_user_defined_postfix_ops(), snprintf, upgrade_task_add_step(), upgrade_task_create(), upgrade_task_free(), and upgrade_task_run().

Referenced by check_and_dump_old_cluster().

check_is_install_user()

static void check_is_install_user ( ClusterInfo *  cluster )

static

Definition at line 1110 of file check.c.

{
    PGresult   *res;
    PGconn     *conn = connectToServer(cluster, "template1");
 
    prep_status("Checking database user is the install user");
 
    /* Can't use pg_authid because only superusers can view it. */
    res = executeQueryOrDie(conn,
                            "SELECT rolsuper, oid "
                            "FROM pg_catalog.pg_roles "
                            "WHERE rolname = current_user "
                            "AND rolname !~ '^pg_'");
 
    /*
     * We only allow the install user in the new cluster (see comment below)
     * and we preserve pg_authid.oid, so this must be the install user in the
     * old cluster too.
     */
    if (PQntuples(res) != 1 ||
        atooid(PQgetvalue(res, 0, 1)) != BOOTSTRAP_SUPERUSERID)
        pg_fatal("database user \"%s\" is not the install user",
                 os_info.user);
 
    PQclear(res);
 
    res = executeQueryOrDie(conn,
                            "SELECT COUNT(*) "
                            "FROM pg_catalog.pg_roles "
                            "WHERE rolname !~ '^pg_'");
 
    if (PQntuples(res) != 1)
        pg_fatal("could not determine the number of users");
 
    /*
     * We only allow the install user in the new cluster because other defined
     * users might match users defined in the old cluster and generate an
     * error during pg_dump restore.
     */
    if (cluster == &new_cluster && strcmp(PQgetvalue(res, 0, 0), "1") != 0)
        pg_fatal("Only the install user can be defined in the new cluster.");
 
    PQclear(res);
 
    PQfinish(conn);
 
    check_ok();
}

References atooid, check_ok(), conn, connectToServer(), executeQueryOrDie(), fb(), new_cluster, os_info, pg_fatal, PQclear, PQfinish(), PQgetvalue, PQntuples, prep_status(), and OSInfo::user.

Referenced by check_and_dump_old_cluster(), and check_new_cluster().

check_new_cluster()

void check_new_cluster

(

void

)

Definition at line 742 of file check.c.

{
    get_db_rel_and_slot_infos(&new_cluster);
 
    check_new_cluster_is_empty();
 
    check_loadable_libraries();
 
    switch (user_opts.transfer_mode)
    {
        case TRANSFER_MODE_CLONE:
            check_file_clone();
            break;
        case TRANSFER_MODE_COPY:
            break;
        case TRANSFER_MODE_COPY_FILE_RANGE:
            check_copy_file_range();
            break;
        case TRANSFER_MODE_LINK:
            check_hard_link(TRANSFER_MODE_LINK);
            break;
        case TRANSFER_MODE_SWAP:
 
            /*
             * We do the hard link check for --swap, too, since it's an easy
             * way to verify the clusters are in the same file system.  This
             * allows us to take some shortcuts in the file synchronization
             * step.  With some more effort, we could probably support the
             * separate-file-system use case, but this mode is unlikely to
             * offer much benefit if we have to copy the files across file
             * system boundaries.
             */
            check_hard_link(TRANSFER_MODE_SWAP);
 
            /*
             * There are a few known issues with using --swap to upgrade from
             * versions older than 10.  For example, the sequence tuple format
             * changed in v10, and the visibility map format changed in 9.6.
             * While such problems are not insurmountable (and we may have to
             * deal with similar problems in the future, anyway), it doesn't
             * seem worth the effort to support swap mode for upgrades from
             * long-unsupported versions.
             */
            if (GET_MAJOR_VERSION(old_cluster.major_version) < 1000)
                pg_fatal("Swap mode can only upgrade clusters from PostgreSQL version %s and later.",
                         "10");
 
            break;
    }
 
    check_is_install_user(&new_cluster);
 
    check_for_prepared_transactions(&new_cluster);
 
    check_for_new_tablespace_dir();
 
    check_new_cluster_replication_slots();
 
    check_new_cluster_subscription_configuration();
}

References check_copy_file_range(), check_file_clone(), check_for_new_tablespace_dir(), check_for_prepared_transactions(), check_hard_link(), check_is_install_user(), check_loadable_libraries(), check_new_cluster_is_empty(), check_new_cluster_replication_slots(), check_new_cluster_subscription_configuration(), get_db_rel_and_slot_infos(), GET_MAJOR_VERSION, ClusterInfo::major_version, new_cluster, old_cluster, pg_fatal, UserOpts::transfer_mode, TRANSFER_MODE_CLONE, TRANSFER_MODE_COPY, TRANSFER_MODE_COPY_FILE_RANGE, TRANSFER_MODE_LINK, TRANSFER_MODE_SWAP, and user_opts.

Referenced by main().

check_new_cluster_is_empty()

static void check_new_cluster_is_empty ( void  )

static

Definition at line 951 of file check.c.

{
    int         dbnum;
 
    for (dbnum = 0; dbnum < new_cluster.dbarr.ndbs; dbnum++)
    {
        int         relnum;
        RelInfoArr *rel_arr = &new_cluster.dbarr.dbs[dbnum].rel_arr;
 
        for (relnum = 0; relnum < rel_arr->nrels;
             relnum++)
        {
            /* pg_largeobject and its index should be skipped */
            if (strcmp(rel_arr->rels[relnum].nspname, "pg_catalog") != 0)
                pg_fatal("New cluster database \"%s\" is not empty: found relation \"%s.%s\"",
                         new_cluster.dbarr.dbs[dbnum].db_name,
                         rel_arr->rels[relnum].nspname,
                         rel_arr->rels[relnum].relname);
        }
    }
}

References DbInfo::db_name, ClusterInfo::dbarr, DbInfoArr::dbs, fb(), DbInfoArr::ndbs, new_cluster, RelInfoArr::nrels, RelInfo::nspname, pg_fatal, DbInfo::rel_arr, RelInfo::relname, and RelInfoArr::rels.

Referenced by check_new_cluster().

check_new_cluster_replication_slots()

static void check_new_cluster_replication_slots ( void  )

static

Definition at line 2205 of file check.c.

{
    PGresult   *res;
    PGconn     *conn;
    int         nslots_on_old;
    int         nslots_on_new;
    int         rdt_slot_on_new;
    int         max_replication_slots;
    char       *wal_level;
    int         i_nslots_on_new;
    int         i_rdt_slot_on_new;
 
    /*
     * Logical slots can be migrated since PG17 and a physical slot
     * CONFLICT_DETECTION_SLOT can be migrated since PG19.
     */
    if (GET_MAJOR_VERSION(old_cluster.major_version) <= 1600)
        return;
 
    nslots_on_old = count_old_cluster_logical_slots();
 
    /*
     * Quick return if there are no slots to be migrated and no subscriptions
     * have the retain_dead_tuples option enabled.
     */
    if (nslots_on_old == 0 && !old_cluster.sub_retain_dead_tuples)
        return;
 
    conn = connectToServer(&new_cluster, "template1");
 
    prep_status("Checking for new cluster replication slots");
 
    res = executeQueryOrDie(conn, "SELECT %s AS nslots_on_new, %s AS rdt_slot_on_new "
                            "FROM pg_catalog.pg_replication_slots",
                            nslots_on_old > 0
                            ? "COUNT(*) FILTER (WHERE slot_type = 'logical' AND temporary IS FALSE)"
                            : "0",
                            old_cluster.sub_retain_dead_tuples
                            ? "COUNT(*) FILTER (WHERE slot_name = 'pg_conflict_detection')"
                            : "0");
 
    if (PQntuples(res) != 1)
        pg_fatal("could not count the number of replication slots");
 
    i_nslots_on_new = PQfnumber(res, "nslots_on_new");
    i_rdt_slot_on_new = PQfnumber(res, "rdt_slot_on_new");
 
    nslots_on_new = atoi(PQgetvalue(res, 0, i_nslots_on_new));
 
    if (nslots_on_new)
    {
        Assert(nslots_on_old);
        pg_fatal("expected 0 logical replication slots but found %d",
                 nslots_on_new);
    }
 
    rdt_slot_on_new = atoi(PQgetvalue(res, 0, i_rdt_slot_on_new));
 
    if (rdt_slot_on_new)
    {
        Assert(old_cluster.sub_retain_dead_tuples);
        pg_fatal("The replication slot \"pg_conflict_detection\" already exists on the new cluster");
    }
 
    PQclear(res);
 
    res = executeQueryOrDie(conn, "SELECT setting FROM pg_settings "
                            "WHERE name IN ('wal_level', 'max_replication_slots') "
                            "ORDER BY name DESC;");
 
    if (PQntuples(res) != 2)
        pg_fatal("could not determine parameter settings on new cluster");
 
    wal_level = PQgetvalue(res, 0, 0);
 
    if ((nslots_on_old > 0 || old_cluster.sub_retain_dead_tuples) &&
        strcmp(wal_level, "minimal") == 0)
        pg_fatal("\"wal_level\" must be \"replica\" or \"logical\" but is set to \"%s\"",
                 wal_level);
 
    max_replication_slots = atoi(PQgetvalue(res, 1, 0));
 
    if (old_cluster.sub_retain_dead_tuples &&
        nslots_on_old + 1 > max_replication_slots)
        pg_fatal("\"max_replication_slots\" (%d) must be greater than or equal to the number of "
                 "logical replication slots on the old cluster plus one additional slot required "
                 "for retaining conflict detection information (%d)",
                 max_replication_slots, nslots_on_old + 1);
 
    if (nslots_on_old > max_replication_slots)
        pg_fatal("\"max_replication_slots\" (%d) must be greater than or equal to the number of "
                 "logical replication slots (%d) on the old cluster",
                 max_replication_slots, nslots_on_old);
 
    PQclear(res);
    PQfinish(conn);
 
    check_ok();
}

References Assert, check_ok(), conn, connectToServer(), count_old_cluster_logical_slots(), executeQueryOrDie(), fb(), GET_MAJOR_VERSION, ClusterInfo::major_version, max_replication_slots, new_cluster, old_cluster, pg_fatal, PQclear, PQfinish(), PQfnumber(), PQgetvalue, PQntuples, prep_status(), ClusterInfo::sub_retain_dead_tuples, and wal_level.

Referenced by check_new_cluster().

check_new_cluster_subscription_configuration()

static void check_new_cluster_subscription_configuration ( void  )

static

Definition at line 2313 of file check.c.

{
    PGresult   *res;
    PGconn     *conn;
    int         max_active_replication_origins;
 
    /* Subscriptions and their dependencies can be migrated since PG17. */
    if (GET_MAJOR_VERSION(old_cluster.major_version) < 1700)
        return;
 
    /* Quick return if there are no subscriptions to be migrated. */
    if (old_cluster.nsubs == 0)
        return;
 
    prep_status("Checking for new cluster configuration for subscriptions");
 
    conn = connectToServer(&new_cluster, "template1");
 
    res = executeQueryOrDie(conn, "SELECT setting FROM pg_settings "
                            "WHERE name = 'max_active_replication_origins';");
 
    if (PQntuples(res) != 1)
        pg_fatal("could not determine parameter settings on new cluster");
 
    max_active_replication_origins = atoi(PQgetvalue(res, 0, 0));
    if (old_cluster.nsubs > max_active_replication_origins)
        pg_fatal("\"max_active_replication_origins\" (%d) must be greater than or equal to the number of "
                 "subscriptions (%d) on the old cluster",
                 max_active_replication_origins, old_cluster.nsubs);
 
    PQclear(res);
    PQfinish(conn);
 
    check_ok();
}

References check_ok(), conn, connectToServer(), executeQueryOrDie(), fb(), GET_MAJOR_VERSION, ClusterInfo::major_version, max_active_replication_origins, new_cluster, ClusterInfo::nsubs, old_cluster, pg_fatal, PQclear, PQfinish(), PQgetvalue, PQntuples, and prep_status().

Referenced by check_new_cluster().

check_old_cluster_for_valid_slots()

static void check_old_cluster_for_valid_slots ( void  )

static

Definition at line 2356 of file check.c.

{
    char        output_path[MAXPGPATH];
    FILE       *script = NULL;
 
    prep_status("Checking for valid logical replication slots");
 
    snprintf(output_path, sizeof(output_path), "%s/%s",
             log_opts.basedir,
             "invalid_logical_slots.txt");
 
    for (int dbnum = 0; dbnum < old_cluster.dbarr.ndbs; dbnum++)
    {
        LogicalSlotInfoArr *slot_arr = &old_cluster.dbarr.dbs[dbnum].slot_arr;
 
        for (int slotnum = 0; slotnum < slot_arr->nslots; slotnum++)
        {
            LogicalSlotInfo *slot = &slot_arr->slots[slotnum];
 
            /* Is the slot usable? */
            if (slot->invalid)
            {
                if (script == NULL &&
                    (script = fopen_priv(output_path, "w")) == NULL)
                    pg_fatal("could not open file \"%s\": %m", output_path);
 
                fprintf(script, "The slot \"%s\" is invalid\n",
                        slot->slotname);
 
                continue;
            }
 
            /*
             * Do additional check to ensure that all logical replication
             * slots have consumed all the WAL before shutdown.
             *
             * Note: This can be satisfied only when the old cluster has been
             * shut down, so we skip this for live checks.
             */
            if (!user_opts.live_check && !slot->caught_up)
            {
                if (script == NULL &&
                    (script = fopen_priv(output_path, "w")) == NULL)
                    pg_fatal("could not open file \"%s\": %m", output_path);
 
                fprintf(script,
                        "The slot \"%s\" has not consumed the WAL yet\n",
                        slot->slotname);
            }
 
            /*
             * The name "pg_conflict_detection" (defined as
             * CONFLICT_DETECTION_SLOT) has been reserved for logical
             * replication conflict detection slot since PG19.
             */
            if (strcmp(slot->slotname, "pg_conflict_detection") == 0)
            {
                if (script == NULL &&
                    (script = fopen_priv(output_path, "w")) == NULL)
                    pg_fatal("could not open file \"%s\": %m", output_path);
 
                fprintf(script,
                        "The slot name \"%s\" is reserved\n",
                        slot->slotname);
            }
        }
    }
 
    if (script)
    {
        fclose(script);
 
        pg_log(PG_REPORT, "fatal");
        pg_fatal("Your installation contains logical replication slots that cannot be upgraded.\n"
                 "You can remove invalid slots and/or consume the pending WAL for other slots,\n"
                 "and then restart the upgrade.\n"
                 "A list of the problematic slots is in the file:\n"
                 "    %s", output_path);
    }
 
    check_ok();
}

References LogOpts::basedir, LogicalSlotInfo::caught_up, check_ok(), ClusterInfo::dbarr, DbInfoArr::dbs, fb(), fopen_priv, fprintf, LogicalSlotInfo::invalid, UserOpts::live_check, log_opts, MAXPGPATH, DbInfoArr::ndbs, LogicalSlotInfoArr::nslots, old_cluster, pg_fatal, pg_log(), PG_REPORT, prep_status(), DbInfo::slot_arr, LogicalSlotInfo::slotname, LogicalSlotInfoArr::slots, snprintf, and user_opts.

Referenced by check_and_dump_old_cluster().

check_old_cluster_global_names()

static void check_old_cluster_global_names ( ClusterInfo *  cluster )

static

Definition at line 2585 of file check.c.

{
    int         i;
    PGconn     *conn_template1;
    PGresult   *res;
    int         ntups;
    FILE       *script = NULL;
    char        output_path[MAXPGPATH];
    int         count = 0;
 
    prep_status("Checking names of databases, roles and tablespaces");
 
    snprintf(output_path, sizeof(output_path), "%s/%s",
             log_opts.basedir,
             "db_role_tablespace_invalid_names.txt");
 
    conn_template1 = connectToServer(cluster, "template1");
 
    /*
     * Get database, user/role and tablespacenames from cluster.  Can't use
     * pg_authid because only superusers can view it.
     */
    res = executeQueryOrDie(conn_template1,
                            "SELECT datname AS objname, 'database' AS objtype "
                            "FROM pg_catalog.pg_database UNION ALL "
                            "SELECT rolname AS objname, 'role' AS objtype "
                            "FROM pg_catalog.pg_roles UNION ALL "
                            "SELECT spcname AS objname, 'tablespace' AS objtype "
                            "FROM pg_catalog.pg_tablespace ORDER BY 2 ");
 
    ntups = PQntuples(res);
    for (i = 0; i < ntups; i++)
    {
        char       *objname = PQgetvalue(res, i, 0);
        char       *objtype = PQgetvalue(res, i, 1);
 
        /* If name has \n or \r, then report it. */
        if (strpbrk(objname, "\n\r"))
        {
            if (script == NULL && (script = fopen_priv(output_path, "w")) == NULL)
                pg_fatal("could not open file \"%s\": %m", output_path);
 
            fprintf(script, "%d : %s name = \"%s\"\n", ++count, objtype, objname);
        }
    }
 
    PQclear(res);
    PQfinish(conn_template1);
 
    if (script)
    {
        fclose(script);
        pg_log(PG_REPORT, "fatal");
        pg_fatal("All the database, role and tablespace names should have only valid characters. A newline or \n"
                 "carriage return character is not allowed in these object names.  To fix this, please \n"
                 "rename these names with valid names. \n"
                 "To see all %d invalid object names, refer db_role_tablespace_invalid_names.txt file. \n"
                 "    %s", count, output_path);
    }
    else
        check_ok();
}

References LogOpts::basedir, check_ok(), connectToServer(), executeQueryOrDie(), fb(), fopen_priv, fprintf, i, log_opts, MAXPGPATH, pg_fatal, pg_log(), PG_REPORT, PQclear, PQfinish(), PQgetvalue, PQntuples, prep_status(), and snprintf.

Referenced by check_and_dump_old_cluster().

check_old_cluster_subscription_state()

static void check_old_cluster_subscription_state ( void  )

static

Definition at line 2478 of file check.c.

{
    UpgradeTask *task = upgrade_task_create();
    UpgradeTaskReport report;
    const char *query;
    PGresult   *res;
    PGconn     *conn;
    int         ntup;
 
    prep_status("Checking for subscription state");
 
    report.file = NULL;
    snprintf(report.path, sizeof(report.path), "%s/%s",
             log_opts.basedir,
             "subs_invalid.txt");
 
    /*
     * Check that all the subscriptions have their respective replication
     * origin.  This check only needs to run once.
     */
    conn = connectToServer(&old_cluster, old_cluster.dbarr.dbs[0].db_name);
    res = executeQueryOrDie(conn,
                            "SELECT d.datname, s.subname "
                            "FROM pg_catalog.pg_subscription s "
                            "LEFT OUTER JOIN pg_catalog.pg_replication_origin o "
                            "   ON o.roname = 'pg_' || s.oid "
                            "INNER JOIN pg_catalog.pg_database d "
                            "   ON d.oid = s.subdbid "
                            "WHERE o.roname IS NULL;");
    ntup = PQntuples(res);
    for (int i = 0; i < ntup; i++)
    {
        if (report.file == NULL &&
            (report.file = fopen_priv(report.path, "w")) == NULL)
            pg_fatal("could not open file \"%s\": %m", report.path);
        fprintf(report.file, "The replication origin is missing for database:\"%s\" subscription:\"%s\"\n",
                PQgetvalue(res, i, 0),
                PQgetvalue(res, i, 1));
    }
    PQclear(res);
    PQfinish(conn);
 
    /*
     * We don't allow upgrade if there is a risk of dangling slot or origin
     * corresponding to initial sync after upgrade.
     *
     * A slot/origin not created yet refers to the 'i' (initialize) state,
     * while 'r' (ready) state refers to a slot/origin created previously but
     * already dropped. These states are supported for pg_upgrade. The other
     * states listed below are not supported:
     *
     * a) SUBREL_STATE_DATASYNC: A relation upgraded while in this state would
     * retain a replication slot and origin. The sync worker spawned after the
     * upgrade cannot drop them because the subscription ID used for the slot
     * and origin name no longer matches.
     *
     * b) SUBREL_STATE_SYNCDONE: A relation upgraded while in this state would
     * retain the replication origin when there is a failure in tablesync
     * worker immediately after dropping the replication slot in the
     * publisher.
     *
     * c) SUBREL_STATE_FINISHEDCOPY: A tablesync worker spawned to work on a
     * relation upgraded while in this state would expect an origin ID with
     * the OID of the subscription used before the upgrade, causing it to
     * fail.
     *
     * d) SUBREL_STATE_SYNCWAIT, SUBREL_STATE_CATCHUP and
     * SUBREL_STATE_UNKNOWN: These states are not stored in the catalog, so we
     * need not allow these states.
     */
    query = "SELECT r.srsubstate, s.subname, n.nspname, c.relname "
        "FROM pg_catalog.pg_subscription_rel r "
        "LEFT JOIN pg_catalog.pg_subscription s"
        "   ON r.srsubid = s.oid "
        "LEFT JOIN pg_catalog.pg_class c"
        "   ON r.srrelid = c.oid "
        "LEFT JOIN pg_catalog.pg_namespace n"
        "   ON c.relnamespace = n.oid "
        "WHERE r.srsubstate NOT IN ('i', 'r') "
        "ORDER BY s.subname";
 
    upgrade_task_add_step(task, query, process_old_sub_state_check,
                          true, &report);
 
    upgrade_task_run(task, &old_cluster);
    upgrade_task_free(task);
 
    if (report.file)
    {
        fclose(report.file);
        pg_log(PG_REPORT, "fatal");
        pg_fatal("Your installation contains subscriptions without origin or having relations not in i (initialize) or r (ready) state.\n"
                 "You can allow the initial sync to finish for all relations and then restart the upgrade.\n"
                 "A list of the problematic subscriptions is in the file:\n"
                 "    %s", report.path);
    }
    else
        check_ok();
}

References LogOpts::basedir, check_ok(), conn, connectToServer(), DbInfo::db_name, ClusterInfo::dbarr, DbInfoArr::dbs, executeQueryOrDie(), fb(), UpgradeTaskReport::file, fopen_priv, fprintf, i, log_opts, old_cluster, UpgradeTaskReport::path, pg_fatal, pg_log(), PG_REPORT, PQclear, PQfinish(), PQgetvalue, PQntuples, prep_status(), process_old_sub_state_check(), snprintf, upgrade_task_add_step(), upgrade_task_create(), upgrade_task_free(), and upgrade_task_run().

Referenced by check_and_dump_old_cluster().

create_script_for_old_cluster_deletion()

void create_script_for_old_cluster_deletion

(

char **

deletion_script_file_name

)

Definition at line 1012 of file check.c.

{
    FILE       *script = NULL;
    int         tblnum;
    char        old_cluster_pgdata[MAXPGPATH],
                new_cluster_pgdata[MAXPGPATH];
    char       *old_tblspc_suffix;
 
    *deletion_script_file_name = psprintf("%sdelete_old_cluster.%s",
                                          SCRIPT_PREFIX, SCRIPT_EXT);
 
    strlcpy(old_cluster_pgdata, old_cluster.pgdata, MAXPGPATH);
    canonicalize_path(old_cluster_pgdata);
 
    strlcpy(new_cluster_pgdata, new_cluster.pgdata, MAXPGPATH);
    canonicalize_path(new_cluster_pgdata);
 
    /* Some people put the new data directory inside the old one. */
    if (path_is_prefix_of_path(old_cluster_pgdata, new_cluster_pgdata))
    {
        pg_log(PG_WARNING,
               "\nWARNING:  new data directory should not be inside the old data directory, i.e. %s", old_cluster_pgdata);
 
        /* Unlink file in case it is left over from a previous run. */
        unlink(*deletion_script_file_name);
        pg_free(*deletion_script_file_name);
        *deletion_script_file_name = NULL;
        return;
    }
 
    /*
     * Some users (oddly) create tablespaces inside the cluster data
     * directory.  We can't create a proper old cluster delete script in that
     * case.
     */
    for (tblnum = 0; tblnum < new_cluster.num_tablespaces; tblnum++)
    {
        char        new_tablespace_dir[MAXPGPATH];
 
        strlcpy(new_tablespace_dir, new_cluster.tablespaces[tblnum], MAXPGPATH);
        canonicalize_path(new_tablespace_dir);
        if (path_is_prefix_of_path(old_cluster_pgdata, new_tablespace_dir))
        {
            /* reproduce warning from CREATE TABLESPACE that is in the log */
            pg_log(PG_WARNING,
                   "\nWARNING:  user-defined tablespace locations should not be inside the data directory, i.e. %s", new_tablespace_dir);
 
            /* Unlink file in case it is left over from a previous run. */
            unlink(*deletion_script_file_name);
            pg_free(*deletion_script_file_name);
            *deletion_script_file_name = NULL;
            return;
        }
    }
 
    prep_status("Creating script to delete old cluster");
 
    if ((script = fopen_priv(*deletion_script_file_name, "w")) == NULL)
        pg_fatal("could not open file \"%s\": %m",
                 *deletion_script_file_name);
 
#ifndef WIN32
    /* add shebang header */
    fprintf(script, "#!/bin/sh\n\n");
#endif
 
    /* delete old cluster's default tablespace */
    fprintf(script, RMDIR_CMD " %c%s%c\n", PATH_QUOTE,
            fix_path_separator(old_cluster.pgdata), PATH_QUOTE);
 
    /* delete old cluster's alternate tablespaces */
    old_tblspc_suffix = pg_strdup(old_cluster.tablespace_suffix);
    fix_path_separator(old_tblspc_suffix);
    for (tblnum = 0; tblnum < old_cluster.num_tablespaces; tblnum++)
        fprintf(script, RMDIR_CMD " %c%s%s%c\n", PATH_QUOTE,
                fix_path_separator(old_cluster.tablespaces[tblnum]),
                old_tblspc_suffix, PATH_QUOTE);
    pfree(old_tblspc_suffix);
 
    fclose(script);
 
#ifndef WIN32
    if (chmod(*deletion_script_file_name, S_IRWXU) != 0)
        pg_fatal("could not add execute permission to file \"%s\": %m",
                 *deletion_script_file_name);
#endif
 
    check_ok();
}

References canonicalize_path(), check_ok(), fb(), fix_path_separator(), fopen_priv, fprintf, MAXPGPATH, new_cluster, ClusterInfo::num_tablespaces, old_cluster, path_is_prefix_of_path(), PATH_QUOTE, pfree(), pg_fatal, pg_free(), pg_log(), pg_strdup(), PG_WARNING, ClusterInfo::pgdata, prep_status(), psprintf(), RMDIR_CMD, S_IRWXU, SCRIPT_EXT, SCRIPT_PREFIX, strlcpy(), ClusterInfo::tablespace_suffix, and ClusterInfo::tablespaces.

Referenced by main().

data_type_check_query()

static char * data_type_check_query ( int  checknum )

static

Definition at line 339 of file check.c.

{
    DataTypesUsageChecks *check = &data_types_usage_checks[checknum];
 
    return psprintf("WITH RECURSIVE oids AS ( "
    /* start with the type(s) returned by base_query */
                    "   %s "
                    "   UNION ALL "
                    "   SELECT * FROM ( "
    /* inner WITH because we can only reference the CTE once */
                    "       WITH x AS (SELECT oid FROM oids) "
    /* domains on any type selected so far */
                    "           SELECT t.oid FROM pg_catalog.pg_type t, x WHERE typbasetype = x.oid AND typtype = 'd' "
                    "           UNION ALL "
    /* arrays over any type selected so far */
                    "           SELECT t.oid FROM pg_catalog.pg_type t, x WHERE typelem = x.oid AND typtype = 'b' "
                    "           UNION ALL "
    /* composite types containing any type selected so far */
                    "           SELECT t.oid FROM pg_catalog.pg_type t, pg_catalog.pg_class c, pg_catalog.pg_attribute a, x "
                    "           WHERE t.typtype = 'c' AND "
                    "                 t.oid = c.reltype AND "
                    "                 c.oid = a.attrelid AND "
                    "                 NOT a.attisdropped AND "
                    "                 a.atttypid = x.oid "
                    "           UNION ALL "
    /* ranges containing any type selected so far */
                    "           SELECT t.oid FROM pg_catalog.pg_type t, pg_catalog.pg_range r, x "
                    "           WHERE t.typtype = 'r' AND r.rngtypid = t.oid AND r.rngsubtype = x.oid"
                    "   ) foo "
                    ") "
    /* now look for stored columns of any such type */
                    "SELECT n.nspname, c.relname, a.attname "
                    "FROM   pg_catalog.pg_class c, "
                    "       pg_catalog.pg_namespace n, "
                    "       pg_catalog.pg_attribute a "
                    "WHERE  c.oid = a.attrelid AND "
                    "       NOT a.attisdropped AND "
                    "       a.atttypid IN (SELECT oid FROM oids) AND "
                    "       c.relkind IN ("
                    CppAsString2(RELKIND_RELATION) ", "
                    CppAsString2(RELKIND_MATVIEW) ", "
                    CppAsString2(RELKIND_INDEX) ") AND "
                    "       c.relnamespace = n.oid AND "
    /* exclude possible orphaned temp tables */
                    "       n.nspname !~ '^pg_temp_' AND "
                    "       n.nspname !~ '^pg_toast_temp_' AND "
    /* exclude system catalogs, too */
                    "       n.nspname NOT IN ('pg_catalog', 'information_schema')",
                    check->base_query);
}

References DataTypesUsageChecks::base_query, CppAsString2, data_types_usage_checks, fb(), and psprintf().

Referenced by check_for_data_types_usage().

fix_path_separator()

static char * fix_path_separator ( char *  path )

static

Definition at line 554 of file check.c.

{
#ifdef WIN32
 
    char       *result;
    char       *c;
 
    result = pg_strdup(path);
 
    for (c = result; *c != '\0'; c++)
        if (*c == '/')
            *c = '\\';
 
    return result;
#else
 
    return path;
#endif
}

References pg_strdup(), and result.

Referenced by create_script_for_old_cluster_deletion().

issue_warnings_and_set_wal_level()

void issue_warnings_and_set_wal_level

(

void

)

Definition at line 824 of file check.c.

{
    /*
     * We unconditionally start/stop the new server because pg_resetwal -o set
     * wal_level to 'minimum'.  If the user is upgrading standby servers using
     * the rsync instructions, they will need pg_upgrade to write its final
     * WAL record showing wal_level as 'replica'.
     */
    start_postmaster(&new_cluster, true);
 
    /* Reindex hash indexes for old < 10.0 */
    if (GET_MAJOR_VERSION(old_cluster.major_version) <= 906)
        old_9_6_invalidate_hash_indexes(&new_cluster, false);
 
    report_extension_updates(&new_cluster);
 
    stop_postmaster(false);
}

References GET_MAJOR_VERSION, ClusterInfo::major_version, new_cluster, old_9_6_invalidate_hash_indexes(), old_cluster, report_extension_updates(), start_postmaster(), and stop_postmaster().

Referenced by main().

output_check_banner()

void output_check_banner

(

void

)

Definition at line 575 of file check.c.

{
    if (user_opts.live_check)
    {
        pg_log(PG_REPORT,
               "Performing Consistency Checks on Old Live Server\n"
               "------------------------------------------------");
    }
    else
    {
        pg_log(PG_REPORT,
               "Performing Consistency Checks\n"
               "-----------------------------");
    }
}

References UserOpts::live_check, pg_log(), PG_REPORT, and user_opts.

Referenced by main().

output_completion_banner()

void output_completion_banner

(

char *

deletion_script_file_name

)

Definition at line 845 of file check.c.

{
    PQExpBufferData user_specification;
 
    initPQExpBuffer(&user_specification);
    if (os_info.user_specified)
    {
        appendPQExpBufferStr(&user_specification, "-U ");
        appendShellString(&user_specification, os_info.user);
        appendPQExpBufferChar(&user_specification, ' ');
    }
 
    pg_log(PG_REPORT,
           "Some statistics are not transferred by pg_upgrade.\n"
           "Once you start the new server, consider running these two commands:\n"
           "    %s/vacuumdb %s--all --analyze-in-stages --missing-stats-only\n"
           "    %s/vacuumdb %s--all --analyze-only",
           new_cluster.bindir, user_specification.data,
           new_cluster.bindir, user_specification.data);
 
    if (deletion_script_file_name)
        pg_log(PG_REPORT,
               "Running this script will delete the old cluster's data files:\n"
               "    %s",
               deletion_script_file_name);
    else
        pg_log(PG_REPORT,
               "Could not create a script to delete the old cluster's data files\n"
               "because user-defined tablespaces or the new cluster's data directory\n"
               "exist in the old cluster directory.  The old cluster's contents must\n"
               "be deleted manually.");
 
    termPQExpBuffer(&user_specification);
}

References appendPQExpBufferChar(), appendPQExpBufferStr(), appendShellString(), ClusterInfo::bindir, fb(), initPQExpBuffer(), new_cluster, os_info, pg_log(), PG_REPORT, termPQExpBuffer(), OSInfo::user, and OSInfo::user_specified.

Referenced by main().

process_data_type_check()

static void process_data_type_check ( DbInfo *  dbinfo, PGresult *  res, void *  arg  )

static

Definition at line 396 of file check.c.

{
    struct data_type_check_state *state = (struct data_type_check_state *) arg;
    int         ntups = PQntuples(res);
    char        output_path[MAXPGPATH];
    int         i_nspname = PQfnumber(res, "nspname");
    int         i_relname = PQfnumber(res, "relname");
    int         i_attname = PQfnumber(res, "attname");
    FILE       *script = NULL;
 
    if (ntups == 0)
        return;
 
    snprintf(output_path, sizeof(output_path), "%s/%s",
             log_opts.basedir,
             state->check->report_filename);
 
    /*
     * Make sure we have a buffer to save reports to now that we found a first
     * failing check.
     */
    if (*state->report == NULL)
        *state->report = createPQExpBuffer();
 
    /*
     * If this is the first time we see an error for the check in question
     * then print a status message of the failure.
     */
    if (!state->result)
    {
        pg_log(PG_REPORT, "failed check: %s", _(state->check->status));
        appendPQExpBuffer(*state->report, "\n%s\n%s\n    %s\n",
                          _(state->check->report_text),
                          _("A list of the problem columns is in the file:"),
                          output_path);
    }
    state->result = true;
 
    if ((script = fopen_priv(output_path, "a")) == NULL)
        pg_fatal("could not open file \"%s\": %m", output_path);
 
    fprintf(script, "In database: %s\n", dbinfo->db_name);
 
    for (int rowno = 0; rowno < ntups; rowno++)
        fprintf(script, "  %s.%s.%s\n",
                PQgetvalue(res, rowno, i_nspname),
                PQgetvalue(res, rowno, i_relname),
                PQgetvalue(res, rowno, i_attname));
 
    fclose(script);
}

References _, appendPQExpBuffer(), arg, LogOpts::basedir, createPQExpBuffer(), DbInfo::db_name, fb(), fopen_priv, fprintf, log_opts, MAXPGPATH, pg_fatal, pg_log(), PG_REPORT, PQfnumber(), PQgetvalue, PQntuples, and snprintf.

Referenced by check_for_data_types_usage().

process_gist_inet_ops_check()

static void process_gist_inet_ops_check ( DbInfo *  dbinfo, PGresult *  res, void *  arg  )

static

Definition at line 1805 of file check.c.

{
    UpgradeTaskReport *report = (UpgradeTaskReport *) arg;
    int         ntups = PQntuples(res);
    int         i_nspname = PQfnumber(res, "nspname");
    int         i_relname = PQfnumber(res, "relname");
 
    if (ntups == 0)
        return;
 
    if (report->file == NULL &&
        (report->file = fopen_priv(report->path, "w")) == NULL)
        pg_fatal("could not open file \"%s\": %m", report->path);
 
    fprintf(report->file, "In database: %s\n", dbinfo->db_name);
 
    for (int rowno = 0; rowno < ntups; rowno++)
        fprintf(report->file, "  %s.%s\n",
                PQgetvalue(res, rowno, i_nspname),
                PQgetvalue(res, rowno, i_relname));
}

References arg, DbInfo::db_name, fb(), UpgradeTaskReport::file, fopen_priv, fprintf, UpgradeTaskReport::path, pg_fatal, PQfnumber(), PQgetvalue, and PQntuples.

Referenced by check_for_gist_inet_ops().

process_incompat_polymorphics()

static void process_incompat_polymorphics ( DbInfo *  dbinfo, PGresult *  res, void *  arg  )

static

Definition at line 1521 of file check.c.

{
    UpgradeTaskReport *report = (UpgradeTaskReport *) arg;
    int         ntups = PQntuples(res);
    int         i_objkind = PQfnumber(res, "objkind");
    int         i_objname = PQfnumber(res, "objname");
 
    if (ntups == 0)
        return;
 
    if (report->file == NULL &&
        (report->file = fopen_priv(report->path, "w")) == NULL)
        pg_fatal("could not open file \"%s\": %m", report->path);
 
    fprintf(report->file, "In database: %s\n", dbinfo->db_name);
 
    for (int rowno = 0; rowno < ntups; rowno++)
        fprintf(report->file, "  %s: %s\n",
                PQgetvalue(res, rowno, i_objkind),
                PQgetvalue(res, rowno, i_objname));
}

References arg, DbInfo::db_name, fb(), UpgradeTaskReport::file, fopen_priv, fprintf, UpgradeTaskReport::path, pg_fatal, PQfnumber(), PQgetvalue, and PQntuples.

Referenced by check_for_incompatible_polymorphics().

process_inconsistent_notnull()

static void process_inconsistent_notnull ( DbInfo *  dbinfo, PGresult *  res, void *  arg  )

static

Definition at line 1719 of file check.c.

{
    UpgradeTaskReport *report = (UpgradeTaskReport *) arg;
    int         ntups = PQntuples(res);
    int         i_nspname = PQfnumber(res, "nspname");
    int         i_relname = PQfnumber(res, "relname");
    int         i_attname = PQfnumber(res, "attname");
 
    if (ntups == 0)
        return;
 
    if (report->file == NULL &&
        (report->file = fopen_priv(report->path, "w")) == NULL)
        pg_fatal("could not open file \"%s\": %m", report->path);
 
    fprintf(report->file, "In database: %s\n", dbinfo->db_name);
 
    for (int rowno = 0; rowno < ntups; rowno++)
    {
        fprintf(report->file, "  %s.%s.%s\n",
                PQgetvalue(res, rowno, i_nspname),
                PQgetvalue(res, rowno, i_relname),
                PQgetvalue(res, rowno, i_attname));
    }
}

References arg, DbInfo::db_name, fb(), UpgradeTaskReport::file, fopen_priv, fprintf, UpgradeTaskReport::path, pg_fatal, PQfnumber(), PQgetvalue, and PQntuples.

Referenced by check_for_not_null_inheritance().

process_isn_and_int8_passing_mismatch()

static void process_isn_and_int8_passing_mismatch ( DbInfo *  dbinfo, PGresult *  res, void *  arg  )

static

Definition at line 1347 of file check.c.

{
    int         ntups = PQntuples(res);
    int         i_nspname = PQfnumber(res, "nspname");
    int         i_proname = PQfnumber(res, "proname");
    UpgradeTaskReport *report = (UpgradeTaskReport *) arg;
 
    if (ntups == 0)
        return;
 
    if (report->file == NULL &&
        (report->file = fopen_priv(report->path, "w")) == NULL)
        pg_fatal("could not open file \"%s\": %m", report->path);
 
    fprintf(report->file, "In database: %s\n", dbinfo->db_name);
 
    for (int rowno = 0; rowno < ntups; rowno++)
        fprintf(report->file, "  %s.%s\n",
                PQgetvalue(res, rowno, i_nspname),
                PQgetvalue(res, rowno, i_proname));
}

References arg, DbInfo::db_name, fb(), UpgradeTaskReport::file, fopen_priv, fprintf, UpgradeTaskReport::path, pg_fatal, PQfnumber(), PQgetvalue, and PQntuples.

Referenced by check_for_isn_and_int8_passing_mismatch().

process_old_sub_state_check()

static void process_old_sub_state_check ( DbInfo *  dbinfo, PGresult *  res, void *  arg  )

static

Definition at line 2445 of file check.c.

{
    UpgradeTaskReport *report = (UpgradeTaskReport *) arg;
    int         ntups = PQntuples(res);
    int         i_srsubstate = PQfnumber(res, "srsubstate");
    int         i_subname = PQfnumber(res, "subname");
    int         i_nspname = PQfnumber(res, "nspname");
    int         i_relname = PQfnumber(res, "relname");
 
    if (ntups == 0)
        return;
 
    if (report->file == NULL &&
        (report->file = fopen_priv(report->path, "w")) == NULL)
        pg_fatal("could not open file \"%s\": %m", report->path);
 
    for (int i = 0; i < ntups; i++)
        fprintf(report->file, "The table sync state \"%s\" is not allowed for database:\"%s\" subscription:\"%s\" schema:\"%s\" relation:\"%s\"\n",
                PQgetvalue(res, i, i_srsubstate),
                dbinfo->db_name,
                PQgetvalue(res, i, i_subname),
                PQgetvalue(res, i, i_nspname),
                PQgetvalue(res, i, i_relname));
}

References arg, DbInfo::db_name, fb(), UpgradeTaskReport::file, fopen_priv, fprintf, i, UpgradeTaskReport::path, pg_fatal, PQfnumber(), PQgetvalue, and PQntuples.

Referenced by check_old_cluster_subscription_state().

process_unicode_update()

static void process_unicode_update ( DbInfo *  dbinfo, PGresult *  res, void *  arg  )

static

Definition at line 2017 of file check.c.

{
    UpgradeTaskReport *report = (UpgradeTaskReport *) arg;
    int         ntups = PQntuples(res);
    int         i_reloid = PQfnumber(res, "reloid");
    int         i_nspname = PQfnumber(res, "nspname");
    int         i_relname = PQfnumber(res, "relname");
 
    if (ntups == 0)
        return;
 
    if (report->file == NULL &&
        (report->file = fopen_priv(report->path, "w")) == NULL)
        pg_fatal("could not open file \"%s\": %m", report->path);
 
    fprintf(report->file, "In database: %s\n", dbinfo->db_name);
 
    for (int rowno = 0; rowno < ntups; rowno++)
        fprintf(report->file, "  (oid=%s) %s.%s\n",
                PQgetvalue(res, rowno, i_reloid),
                PQgetvalue(res, rowno, i_nspname),
                PQgetvalue(res, rowno, i_relname));
}

References arg, DbInfo::db_name, fb(), UpgradeTaskReport::file, fopen_priv, fprintf, UpgradeTaskReport::path, pg_fatal, PQfnumber(), PQgetvalue, and PQntuples.

Referenced by check_for_unicode_update().

process_user_defined_encoding_conversions()

static void process_user_defined_encoding_conversions ( DbInfo *  dbinfo, PGresult *  res, void *  arg  )

static

Definition at line 1937 of file check.c.

{
    UpgradeTaskReport *report = (UpgradeTaskReport *) arg;
    int         ntups = PQntuples(res);
    int         i_conoid = PQfnumber(res, "conoid");
    int         i_conname = PQfnumber(res, "conname");
    int         i_nspname = PQfnumber(res, "nspname");
 
    if (ntups == 0)
        return;
 
    if (report->file == NULL &&
        (report->file = fopen_priv(report->path, "w")) == NULL)
        pg_fatal("could not open file \"%s\": %m", report->path);
 
    fprintf(report->file, "In database: %s\n", dbinfo->db_name);
 
    for (int rowno = 0; rowno < ntups; rowno++)
        fprintf(report->file, "  (oid=%s) %s.%s\n",
                PQgetvalue(res, rowno, i_conoid),
                PQgetvalue(res, rowno, i_nspname),
                PQgetvalue(res, rowno, i_conname));
}

References arg, DbInfo::db_name, fb(), UpgradeTaskReport::file, fopen_priv, fprintf, UpgradeTaskReport::path, pg_fatal, PQfnumber(), PQgetvalue, and PQntuples.

Referenced by check_for_user_defined_encoding_conversions().

process_user_defined_postfix_ops()

static void process_user_defined_postfix_ops ( DbInfo *  dbinfo, PGresult *  res, void *  arg  )

static

Definition at line 1430 of file check.c.

{
    UpgradeTaskReport *report = (UpgradeTaskReport *) arg;
    int         ntups = PQntuples(res);
    int         i_oproid = PQfnumber(res, "oproid");
    int         i_oprnsp = PQfnumber(res, "oprnsp");
    int         i_oprname = PQfnumber(res, "oprname");
    int         i_typnsp = PQfnumber(res, "typnsp");
    int         i_typname = PQfnumber(res, "typname");
 
    if (ntups == 0)
        return;
 
    if (report->file == NULL &&
        (report->file = fopen_priv(report->path, "w")) == NULL)
        pg_fatal("could not open file \"%s\": %m", report->path);
 
    fprintf(report->file, "In database: %s\n", dbinfo->db_name);
 
    for (int rowno = 0; rowno < ntups; rowno++)
        fprintf(report->file, "  (oid=%s) %s.%s (%s.%s, NONE)\n",
                PQgetvalue(res, rowno, i_oproid),
                PQgetvalue(res, rowno, i_oprnsp),
                PQgetvalue(res, rowno, i_oprname),
                PQgetvalue(res, rowno, i_typnsp),
                PQgetvalue(res, rowno, i_typname));
}

References arg, DbInfo::db_name, fb(), UpgradeTaskReport::file, fopen_priv, fprintf, UpgradeTaskReport::path, pg_fatal, PQfnumber(), PQgetvalue, and PQntuples.

Referenced by check_for_user_defined_postfix_ops().

process_with_oids_check()

static void process_with_oids_check ( DbInfo *  dbinfo, PGresult *  res, void *  arg  )

static

Definition at line 1651 of file check.c.

{
    UpgradeTaskReport *report = (UpgradeTaskReport *) arg;
    int         ntups = PQntuples(res);
    int         i_nspname = PQfnumber(res, "nspname");
    int         i_relname = PQfnumber(res, "relname");
 
    if (ntups == 0)
        return;
 
    if (report->file == NULL &&
        (report->file = fopen_priv(report->path, "w")) == NULL)
        pg_fatal("could not open file \"%s\": %m", report->path);
 
    fprintf(report->file, "In database: %s\n", dbinfo->db_name);
 
    for (int rowno = 0; rowno < ntups; rowno++)
        fprintf(report->file, "  %s.%s\n",
                PQgetvalue(res, rowno, i_nspname),
                PQgetvalue(res, rowno, i_relname));
}

References arg, DbInfo::db_name, fb(), UpgradeTaskReport::file, fopen_priv, fprintf, UpgradeTaskReport::path, pg_fatal, PQfnumber(), PQgetvalue, and PQntuples.

Referenced by check_for_tables_with_oids().

report_clusters_compatible()

void report_clusters_compatible

(

void

)

Definition at line 805 of file check.c.

{
    if (user_opts.check)
    {
        pg_log(PG_REPORT, "\n*Clusters are compatible*");
        /* stops new cluster */
        stop_postmaster(false);
 
        cleanup_output_dirs();
        exit(0);
    }
 
    pg_log(PG_REPORT, "\n"
           "If pg_upgrade fails after this point, you must re-initdb the\n"
           "new cluster before continuing.");
}

References UserOpts::check, cleanup_output_dirs(), fb(), pg_log(), PG_REPORT, stop_postmaster(), and user_opts.

Referenced by main().

unicode_version_changed()

static bool unicode_version_changed ( ClusterInfo *  cluster )

static

Definition at line 2046 of file check.c.

{
    PGconn     *conn_template1 = connectToServer(cluster, "template1");
    PGresult   *res;
    char       *old_unicode_version;
    bool        unicode_updated;
 
    res = executeQueryOrDie(conn_template1, "SELECT unicode_version()");
    old_unicode_version = PQgetvalue(res, 0, 0);
    unicode_updated = (strcmp(old_unicode_version, PG_UNICODE_VERSION) != 0);
 
    PQclear(res);
    PQfinish(conn_template1);
 
    return unicode_updated;
}

References connectToServer(), executeQueryOrDie(), fb(), PG_UNICODE_VERSION, PQclear, PQfinish(), and PQgetvalue.

Referenced by check_for_unicode_update().

Variable Documentation

data_types_usage_checks

DataTypesUsageChecks data_types_usage_checks[]

static

Definition at line 103 of file check.c.

{
    /*
     * Look for composite types that were made during initdb *or* belong to
     * information_schema; that's important in case information_schema was
     * dropped and reloaded.
     *
     * The cutoff OID here should match the source cluster's value of
     * FirstNormalObjectId.  We hardcode it rather than using that C #define
     * because, if that #define is ever changed, our own version's value is
     * NOT what to use.  Eventually we may need a test on the source cluster's
     * version to select the correct value.
     */
    {
        .status = gettext_noop("Checking for system-defined composite types in user tables"),
        .report_filename = "tables_using_composite.txt",
        .base_query =
        "SELECT t.oid FROM pg_catalog.pg_type t "
        "LEFT JOIN pg_catalog.pg_namespace n ON t.typnamespace = n.oid "
        " WHERE typtype = 'c' AND (t.oid < 16384 OR nspname = 'information_schema')",
        .report_text =
        gettext_noop("Your installation contains system-defined composite types in user tables.\n"
                     "These type OIDs are not stable across PostgreSQL versions,\n"
                     "so this cluster cannot currently be upgraded.  You can drop the\n"
                     "problem columns and restart the upgrade.\n"),
        .threshold_version = ALL_VERSIONS
    },
 
    /*
     * 9.3 -> 9.4 Fully implement the 'line' data type in 9.4, which
     * previously returned "not enabled" by default and was only functionally
     * enabled with a compile-time switch; as of 9.4 "line" has a different
     * on-disk representation format.
     */
    {
        .status = gettext_noop("Checking for incompatible \"line\" data type"),
        .report_filename = "tables_using_line.txt",
        .base_query =
        "SELECT 'pg_catalog.line'::pg_catalog.regtype AS oid",
        .report_text =
        gettext_noop("Your installation contains the \"line\" data type in user tables.\n"
                     "This data type changed its internal and input/output format\n"
                     "between your old and new versions so this\n"
                     "cluster cannot currently be upgraded.  You can\n"
                     "drop the problem columns and restart the upgrade.\n"),
        .threshold_version = 903
    },
 
    /*
     * pg_upgrade only preserves these system values: pg_class.oid pg_type.oid
     * pg_enum.oid
     *
     * Many of the reg* data types reference system catalog info that is not
     * preserved, and hence these data types cannot be used in user tables
     * upgraded by pg_upgrade.
     */
    {
        .status = gettext_noop("Checking for reg* data types in user tables"),
        .report_filename = "tables_using_reg.txt",
 
        /*
         * Note: older servers will not have all of these reg* types, so we
         * have to write the query like this rather than depending on casts to
         * regtype.
         */
        .base_query =
        "SELECT oid FROM pg_catalog.pg_type t "
        "WHERE t.typnamespace = "
        "        (SELECT oid FROM pg_catalog.pg_namespace "
        "         WHERE nspname = 'pg_catalog') "
        "  AND t.typname IN ( "
        /* pg_class.oid is preserved, so 'regclass' is OK */
        "           'regcollation', "
        "           'regconfig', "
        /* pg_database.oid is preserved, so 'regdatabase' is OK */
        "           'regdictionary', "
        "           'regnamespace', "
        "           'regoper', "
        "           'regoperator', "
        "           'regproc', "
        "           'regprocedure' "
        /* pg_authid.oid is preserved, so 'regrole' is OK */
        /* pg_type.oid is (mostly) preserved, so 'regtype' is OK */
        "         )",
        .report_text =
        gettext_noop("Your installation contains one of the reg* data types in user tables.\n"
                     "These data types reference system OIDs that are not preserved by\n"
                     "pg_upgrade, so this cluster cannot currently be upgraded.  You can\n"
                     "drop the problem columns and restart the upgrade.\n"),
        .threshold_version = ALL_VERSIONS
    },
 
    /*
     * PG 16 increased the size of the 'aclitem' type, which breaks the
     * on-disk format for existing data.
     */
    {
        .status = gettext_noop("Checking for incompatible \"aclitem\" data type"),
        .report_filename = "tables_using_aclitem.txt",
        .base_query =
        "SELECT 'pg_catalog.aclitem'::pg_catalog.regtype AS oid",
        .report_text =
        gettext_noop("Your installation contains the \"aclitem\" data type in user tables.\n"
                     "The internal format of \"aclitem\" changed in PostgreSQL version 16\n"
                     "so this cluster cannot currently be upgraded.  You can drop the\n"
                     "problem columns and restart the upgrade.\n"),
        .threshold_version = 1500
    },
 
    /*
     * It's no longer allowed to create tables or views with "unknown"-type
     * columns.  We do not complain about views with such columns, because
     * they should get silently converted to "text" columns during the DDL
     * dump and reload; it seems unlikely to be worth making users do that by
     * hand.  However, if there's a table with such a column, the DDL reload
     * will fail, so we should pre-detect that rather than failing
     * mid-upgrade.  Worse, if there's a matview with such a column, the DDL
     * reload will silently change it to "text" which won't match the on-disk
     * storage (which is like "cstring").  So we *must* reject that.
     */
    {
        .status = gettext_noop("Checking for invalid \"unknown\" user columns"),
        .report_filename = "tables_using_unknown.txt",
        .base_query =
        "SELECT 'pg_catalog.unknown'::pg_catalog.regtype AS oid",
        .report_text =
        gettext_noop("Your installation contains the \"unknown\" data type in user tables.\n"
                     "This data type is no longer allowed in tables, so this cluster\n"
                     "cannot currently be upgraded.  You can drop the problem columns\n"
                     "and restart the upgrade.\n"),
        .threshold_version = 906
    },
 
    /*
     * PG 12 changed the 'sql_identifier' type storage to be based on name,
     * not varchar, which breaks on-disk format for existing data. So we need
     * to prevent upgrade when used in user objects (tables, indexes, ...). In
     * 12, the sql_identifier data type was switched from name to varchar,
     * which does affect the storage (name is by-ref, but not varlena). This
     * means user tables using sql_identifier for columns are broken because
     * the on-disk format is different.
     */
    {
        .status = gettext_noop("Checking for invalid \"sql_identifier\" user columns"),
        .report_filename = "tables_using_sql_identifier.txt",
        .base_query =
        "SELECT 'information_schema.sql_identifier'::pg_catalog.regtype AS oid",
        .report_text =
        gettext_noop("Your installation contains the \"sql_identifier\" data type in user tables.\n"
                     "The on-disk format for this data type has changed, so this\n"
                     "cluster cannot currently be upgraded.  You can drop the problem\n"
                     "columns and restart the upgrade.\n"),
        .threshold_version = 1100
    },
 
    /*
     * JSONB changed its storage format during 9.4 beta, so check for it.
     */
    {
        .status = gettext_noop("Checking for incompatible \"jsonb\" data type in user tables"),
        .report_filename = "tables_using_jsonb.txt",
        .base_query =
        "SELECT 'pg_catalog.jsonb'::pg_catalog.regtype AS oid",
        .report_text =
        gettext_noop("Your installation contains the \"jsonb\" data type in user tables.\n"
                     "The internal format of \"jsonb\" changed during 9.4 beta so this\n"
                     "cluster cannot currently be upgraded.  You can drop the problem \n"
                     "columns and restart the upgrade.\n"),
        .threshold_version = MANUAL_CHECK,
        .version_hook = jsonb_9_4_check_applicable
    },
 
    /*
     * PG 12 removed types abstime, reltime, tinterval.
     */
    {
        .status = gettext_noop("Checking for removed \"abstime\" data type in user tables"),
        .report_filename = "tables_using_abstime.txt",
        .base_query =
        "SELECT 'pg_catalog.abstime'::pg_catalog.regtype AS oid",
        .report_text =
        gettext_noop("Your installation contains the \"abstime\" data type in user tables.\n"
                     "The \"abstime\" type has been removed in PostgreSQL version 12,\n"
                     "so this cluster cannot currently be upgraded.  You can drop the\n"
                     "problem columns, or change them to another data type, and restart\n"
                     "the upgrade.\n"),
        .threshold_version = 1100
    },
    {
        .status = gettext_noop("Checking for removed \"reltime\" data type in user tables"),
        .report_filename = "tables_using_reltime.txt",
        .base_query =
        "SELECT 'pg_catalog.reltime'::pg_catalog.regtype AS oid",
        .report_text =
        gettext_noop("Your installation contains the \"reltime\" data type in user tables.\n"
                     "The \"reltime\" type has been removed in PostgreSQL version 12,\n"
                     "so this cluster cannot currently be upgraded.  You can drop the\n"
                     "problem columns, or change them to another data type, and restart\n"
                     "the upgrade.\n"),
        .threshold_version = 1100
    },
    {
        .status = gettext_noop("Checking for removed \"tinterval\" data type in user tables"),
        .report_filename = "tables_using_tinterval.txt",
        .base_query =
        "SELECT 'pg_catalog.tinterval'::pg_catalog.regtype AS oid",
        .report_text =
        gettext_noop("Your installation contains the \"tinterval\" data type in user tables.\n"
                     "The \"tinterval\" type has been removed in PostgreSQL version 12,\n"
                     "so this cluster cannot currently be upgraded.  You can drop the\n"
                     "problem columns, or change them to another data type, and restart\n"
                     "the upgrade.\n"),
        .threshold_version = 1100
    },
 
    /* End of checks marker, must remain last */
    {
        NULL, NULL, NULL, NULL, 0, NULL
    }
};

Referenced by check_for_data_types_usage(), and data_type_check_query().