util.c File Reference

#include "postgres_fe.h"
#include <signal.h>
#include "common/username.h"
#include "pg_upgrade.h"

Include dependency graph for util.c:

Go to the source code of this file.

Functions
static void	pg_log_v (eLogType type, const char *fmt, va_list ap) pg_attribute_printf(2
static void void	report_status (eLogType type, const char *fmt,...)
void	end_progress_output (void)
void	cleanup_output_dirs (void)
void	prep_status (const char *fmt,...)
void	prep_status_progress (const char *fmt,...)
void	pg_log (eLogType type, const char *fmt,...)
void	pg_fatal (const char *fmt,...)
void	check_ok (void)
char *	quote_identifier (const char *s)
int	get_user_info (char **user_name_p)
unsigned int	str2uint (const char *str)

Variables
LogOpts	log_opts

Function Documentation

check_ok()

void check_ok

(

void

)

Definition at line 284 of file util.c.

{
    /* all seems well */
    report_status(PG_REPORT, "ok");
}

References PG_REPORT, and report_status().

cleanup_output_dirs()

void cleanup_output_dirs

(

void

)

Definition at line 63 of file util.c.

{
    fclose(log_opts.internal);
 
    /* Remove dump and log files? */
    if (log_opts.retain)
        return;
 
    /*
     * Try twice.  The second time might wait for files to finish being
     * unlinked, on Windows.
     */
    if (!rmtree(log_opts.basedir, true))
        rmtree(log_opts.basedir, true);
 
    /* Remove pg_upgrade_output.d only if empty */
    switch (pg_check_dir(log_opts.rootdir))
    {
        case 0:                 /* non-existent */
        case 3:                 /* exists and contains a mount point */
            Assert(false);
            break;
 
        case 1:                 /* exists and empty */
        case 2:                 /* exists and contains only dot files */
 
            /*
             * Try twice.  The second time might wait for files to finish
             * being unlinked, on Windows.
             */
            if (!rmtree(log_opts.rootdir, true))
                rmtree(log_opts.rootdir, true);
            break;
 
        case 4:                 /* exists */
 
            /*
             * Keep the root directory as this includes some past log
             * activity.
             */
            break;
 
        default:
            /* different failure, just report it */
            pg_log(PG_WARNING, "could not access directory \"%s\": %m",
                   log_opts.rootdir);
            break;
    }
}

References Assert, LogOpts::basedir, fb(), LogOpts::internal, log_opts, pg_check_dir(), pg_log(), PG_WARNING, LogOpts::retain, rmtree(), and LogOpts::rootdir.

Referenced by main(), and report_clusters_compatible().

end_progress_output()

void end_progress_output

(

void

)

Definition at line 43 of file util.c.

{
    /*
     * For output to a tty, erase prior contents of progress line. When either
     * tty or verbose, indent so that report_status() output will align
     * nicely.
     */
    if (log_opts.isatty)
    {
        printf("\r");
        pg_log(PG_REPORT_NONL, "%-*s", MESSAGE_WIDTH, "");
    }
    else if (log_opts.verbose)
        pg_log(PG_REPORT_NONL, "%-*s", MESSAGE_WIDTH, "");
}

References LogOpts::isatty, log_opts, MESSAGE_WIDTH, pg_log(), PG_REPORT_NONL, printf, and LogOpts::verbose.

Referenced by create_logical_replication_slots(), create_new_objects(), generate_old_dump(), and transfer_all_new_tablespaces().

get_user_info()

int get_user_info

(

char **

user_name_p

)

Definition at line 323 of file util.c.

{
    int         user_id;
    const char *user_name;
    char       *errstr;
 
#ifndef WIN32
    user_id = geteuid();
#else
    user_id = 1;
#endif
 
    user_name = get_user_name(&errstr);
    if (!user_name)
        pg_fatal("%s", errstr);
 
    /* make a copy */
    *user_name_p = pg_strdup(user_name);
 
    return user_id;
}

References fb(), get_user_name(), pg_fatal, and pg_strdup().

Referenced by parseCommandLine().

pg_fatal()

void pg_fatal	(	const char *	fmt,
			...
	)

Definition at line 270 of file util.c.

{
    va_list     args;
 
    va_start(args, fmt);
    pg_log_v(PG_FATAL, fmt, args);
    va_end(args);
    /* NOTREACHED */
    printf(_("Failure, exiting\n"));
    exit(1);
}

References _, fb(), PG_FATAL, pg_log_v(), and printf.

pg_log()

void pg_log	(	eLogType	type,
		const char *	fmt,
			...
	)

Definition at line 259 of file util.c.

{
    va_list     args;
 
    va_start(args, fmt);
    pg_log_v(type, fmt, args);
    va_end(args);
}

References fb(), pg_log_v(), and type.

Referenced by cleanup_output_dirs(), end_progress_output(), prep_status(), and prep_status_progress().

pg_log_v()

static void pg_log_v ( eLogType  type, const char *  fmt, va_list  ap  )

static

Definition at line 176 of file util.c.

{
    char        message[QUERY_ALLOC];
 
    /* No incoming message should end in newline; we add that here. */
    Assert(fmt);
    Assert(fmt[0] == '\0' || fmt[strlen(fmt) - 1] != '\n');
 
    vsnprintf(message, sizeof(message), _(fmt), ap);
 
    /* PG_VERBOSE and PG_STATUS are only output in verbose mode */
    /* fopen() on log_opts.internal might have failed, so check it */
    if (((type != PG_VERBOSE && type != PG_STATUS) || log_opts.verbose) &&
        log_opts.internal != NULL)
    {
        if (type == PG_STATUS)
            /* status messages get two leading spaces, see below */
            fprintf(log_opts.internal, "  %s\n", message);
        else if (type == PG_REPORT_NONL)
            fprintf(log_opts.internal, "%s", message);
        else
            fprintf(log_opts.internal, "%s\n", message);
        fflush(log_opts.internal);
    }
 
    switch (type)
    {
        case PG_VERBOSE:
            if (log_opts.verbose)
                printf("%s\n", message);
            break;
 
        case PG_STATUS:
 
            /*
             * For output to a terminal, we add two leading spaces and no
             * newline; instead append \r so that the next message is output
             * on the same line.  Truncate on the left to fit into
             * MESSAGE_WIDTH (counting the spaces as part of that).
             *
             * If going to non-interactive output, only display progress if
             * verbose is enabled. Otherwise the output gets unreasonably
             * large by default.
             */
            if (log_opts.isatty)
            {
                bool        itfits = (strlen(message) <= MESSAGE_WIDTH - 2);
 
                /* prefix with "..." if we do leading truncation */
                printf("  %s%-*.*s\r",
                       itfits ? "" : "...",
                       MESSAGE_WIDTH - 2, MESSAGE_WIDTH - 2,
                       itfits ? message :
                       message + strlen(message) - MESSAGE_WIDTH + 3 + 2);
            }
            else if (log_opts.verbose)
                printf("  %s\n", message);
            break;
 
        case PG_REPORT_NONL:
            /* This option is for use by prep_status and friends */
            printf("%s", message);
            break;
 
        case PG_REPORT:
        case PG_WARNING:
            printf("%s\n", message);
            break;
 
        case PG_FATAL:
            /* Extra newline in case we're interrupting status output */
            printf("\n%s\n", message);
            printf(_("Failure, exiting\n"));
            exit(1);
            break;
 
            /* No default:, we want a warning for omitted cases */
    }
    fflush(stdout);
}

References _, Assert, fb(), fprintf, LogOpts::internal, LogOpts::isatty, log_opts, MESSAGE_WIDTH, PG_FATAL, PG_REPORT, PG_REPORT_NONL, PG_STATUS, PG_VERBOSE, PG_WARNING, printf, QUERY_ALLOC, type, LogOpts::verbose, and vsnprintf.

Referenced by pg_fatal(), pg_log(), and report_status().

prep_status()

void prep_status	(	const char *	fmt,
			...
	)

Definition at line 129 of file util.c.

{
    va_list     args;
    char        message[MAX_STRING];
 
    va_start(args, fmt);
    vsnprintf(message, sizeof(message), fmt, args);
    va_end(args);
 
    /* trim strings */
    pg_log(PG_REPORT_NONL, "%-*s", MESSAGE_WIDTH, message);
}

References fb(), MAX_STRING, MESSAGE_WIDTH, pg_log(), PG_REPORT_NONL, and vsnprintf.

prep_status_progress()

void prep_status_progress	(	const char *	fmt,
			...
	)

Definition at line 156 of file util.c.

{
    va_list     args;
    char        message[MAX_STRING];
 
    va_start(args, fmt);
    vsnprintf(message, sizeof(message), fmt, args);
    va_end(args);
 
    /*
     * If outputting to a tty or in verbose, append newline. pg_log_v() will
     * put the individual progress items onto the next line.
     */
    if (log_opts.isatty || log_opts.verbose)
        pg_log(PG_REPORT, "%-*s", MESSAGE_WIDTH, message);
    else
        pg_log(PG_REPORT_NONL, "%-*s", MESSAGE_WIDTH, message);
}

References fb(), LogOpts::isatty, log_opts, MAX_STRING, MESSAGE_WIDTH, pg_log(), PG_REPORT, PG_REPORT_NONL, LogOpts::verbose, and vsnprintf.

quote_identifier()

char * quote_identifier

(

const char *

s

)

Definition at line 299 of file util.c.

{
    char       *result = pg_malloc(strlen(s) * 2 + 3);
    char       *r = result;
 
    *r++ = '"';
    while (*s)
    {
        if (*s == '"')
            *r++ = *s;
        *r++ = *s;
        s++;
    }
    *r++ = '"';
    *r++ = '\0';
 
    return result;
}

References fb(), and pg_malloc().

report_status()

static void void report_status	(	eLogType	type,
		const char *	fmt,
			...
	)

Definition at line 32 of file util.c.

{
    va_list     args;
 
    va_start(args, fmt);
    pg_log_v(type, fmt, args);
    va_end(args);
}

References fb(), pg_log_v(), and type.

Referenced by check_ok().

str2uint()

unsigned int str2uint

(

const char *

str

)

Definition at line 352 of file util.c.

{
    return strtoul(str, NULL, 10);
}

References fb(), and str.

Referenced by get_control_data().

Variable Documentation

log_opts

LogOpts log_opts

Definition at line 17 of file util.c.

Referenced by check_for_connection_status(), 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_tables_with_oids(), check_for_unicode_update(), check_for_user_defined_encoding_conversions(), check_for_user_defined_postfix_ops(), check_loadable_libraries(), check_old_cluster_for_valid_slots(), check_old_cluster_subscription_state(), cleanup_output_dirs(), create_new_objects(), end_progress_output(), exec_prog(), generate_old_dump(), get_db_rel_and_slot_infos(), make_outputdirs(), parseCommandLine(), pg_log_v(), prep_status_progress(), prepare_new_cluster(), prepare_new_globals(), process_data_type_check(), and start_postmaster().