pqexpbuffer.c File Reference

#include "postgres_fe.h"
#include <limits.h>
#include "pqexpbuffer.h"

Include dependency graph for pqexpbuffer.c:

Go to the source code of this file.

Functions
static bool	appendPQExpBufferVA (PQExpBuffer str, const char *fmt, va_list args) pg_attribute_printf(2
static bool static void	markPQExpBufferBroken (PQExpBuffer str)
PQExpBuffer	createPQExpBuffer (void)
void	initPQExpBuffer (PQExpBuffer str)
void	destroyPQExpBuffer (PQExpBuffer str)
void	termPQExpBuffer (PQExpBuffer str)
void	resetPQExpBuffer (PQExpBuffer str)
int	enlargePQExpBuffer (PQExpBuffer str, size_t needed)
void	printfPQExpBuffer (PQExpBuffer str, const char *fmt,...)
void	appendPQExpBuffer (PQExpBuffer str, const char *fmt,...)
void	appendPQExpBufferStr (PQExpBuffer str, const char *data)
void	appendPQExpBufferChar (PQExpBuffer str, char ch)
void	appendBinaryPQExpBuffer (PQExpBuffer str, const char *data, size_t datalen)

Variables
static const char	oom_buffer [1] = ""
static const char *	oom_buffer_ptr = oom_buffer

Function Documentation

appendBinaryPQExpBuffer()

void appendBinaryPQExpBuffer	(	PQExpBuffer	str,
		const char *	data,
		size_t	datalen
	)

Definition at line 399 of file pqexpbuffer.c.

References PQExpBufferData::data, enlargePQExpBuffer(), and PQExpBufferData::len.

Referenced by appendPQExpBufferStr(), createViewAsClause(), and pqGets_internal().

{
    /* Make more room if needed */
    if (!enlargePQExpBuffer(str, datalen))
        return;

    /* OK, append the data */
    memcpy(str->data + str->len, data, datalen);
    str->len += datalen;

    /*
     * Keep a trailing null in place, even though it's probably useless for
     * binary data...
     */
    str->data[str->len] = '\0';
}

appendPQExpBuffer()

void appendPQExpBuffer	(	PQExpBuffer	str,
		const char *	fmt,
			...
	)

Definition at line 267 of file pqexpbuffer.c.

References appendPQExpBufferVA(), generate_unaccent_rules::args, and PQExpBufferBroken.

Referenced by _getObjectDescription(), _printTocEntry(), _selectOutputSchema(), _selectTableAccessMethod(), _selectTablespace(), add_tablespace_footer(), AddAcl(), append_db_pattern_cte(), append_depends_on_extension(), append_rel_pattern_filtered_cte(), append_rel_pattern_raw_cte(), appendIndexCollationVersion(), appendReloptionsArray(), binary_upgrade_extension_member(), binary_upgrade_set_pg_class_oids(), binary_upgrade_set_type_oids_by_rel_oid(), binary_upgrade_set_type_oids_by_type_oid(), build_client_final_message(), build_client_first_message(), buildACLCommands(), buildDefaultACLCommands(), buildShSecLabelQuery(), check_for_data_type_usage(), cluster_conn_opts(), compile_relation_list_one_db(), connectFailureMessage(), connectNoDelay(), connectOptions2(), conninfo_array_parse(), conninfo_parse(), conninfo_storeval(), conninfo_uri_decode(), conninfo_uri_parse_options(), conninfo_uri_parse_params(), constructConnStr(), createDummyViewAsClause(), createPartitions(), CreateReplicationSlot(), createViewAsClause(), describeAccessMethods(), describeAggregates(), describeFunctions(), describeOneTableDetails(), describeOneTSConfig(), describeOperators(), DescribeQuery(), describeRoles(), describeSubscriptions(), describeTablespaces(), describeTypes(), do_kill(), DropReplicationSlot(), dumpAccessMethod(), dumpACL(), dumpAgg(), dumpAttrDef(), dumpBaseType(), dumpBlob(), dumpCast(), dumpCollation(), dumpComment(), dumpCompositeType(), dumpCompositeTypeColComments(), dumpConstraint(), dumpConversion(), dumpDatabase(), dumpDefaultACL(), dumpDomain(), dumpEnumType(), dumpEventTrigger(), dumpExtension(), dumpForeignDataWrapper(), dumpForeignServer(), dumpFunc(), dumpIndex(), dumpIndexAttach(), dumpNamespace(), dumpOpclass(), dumpOpfamily(), dumpOpr(), dumpPolicy(), dumpProcLang(), dumpPublication(), dumpPublicationTable(), dumpRangeType(), dumpRoles(), dumpRule(), dumpSecLabel(), dumpSequence(), dumpSequenceData(), dumpShellType(), dumpStatisticsExt(), dumpStdStrings(), dumpSubscription(), dumpTable(), dumpTableAttach(), dumpTableComment(), dumpTableConstraintComment(), dumpTableData(), dumpTableData_copy(), dumpTableData_insert(), dumpTableSchema(), dumpTableSecLabel(), dumpTablespaces(), dumpTransform(), dumpTrigger(), dumpTSConfig(), dumpTSDictionary(), dumpTSParser(), dumpTSTemplate(), dumpUndefinedType(), dumpUserMappings(), emitHostIdentityInfo(), emitShSecLabels(), ExecQueryUsingCursor(), executeMetaCommand(), expand_table_name_patterns(), fmtQualifiedId(), format_aggregate_signature(), format_function_arguments(), format_function_arguments_old(), format_function_signature(), GenerateRecoveryConfig(), get_create_object_cmd(), get_db_conn(), get_language_name(), getAggregates(), getAnotherTuple(), getBlobs(), getCasts(), getCollations(), getConstraints(), getConversions(), getDefaultACLs(), getDomainConstraints(), getEventTriggers(), getExtendedStatistics(), getForeignDataWrappers(), getForeignServers(), getFormattedTypeName(), getFuncs(), getIndexes(), getNamespaces(), getOpclasses(), getOperators(), getOpfamilies(), getParamDescriptions(), getPolicies(), getProcLangs(), getPublications(), getRowDescriptions(), getSubscriptions(), getTableAttrs(), getTables(), getTransforms(), getTriggers(), getTSConfigurations(), getTSDictionaries(), getTypes(), handleSyncLoss(), initCreatePKeys(), initCreateTables(), initialize_SSL(), libpqrcv_get_conninfo(), listAllDbs(), listCasts(), listCollations(), listConversions(), listDomains(), listEventTriggers(), listExtendedStats(), listForeignDataWrappers(), listForeignServers(), listForeignTables(), listLanguages(), listOperatorClasses(), listOperatorFamilies(), listOpFamilyFunctions(), listOpFamilyOperators(), listPartitionedTables(), listPublications(), listSchemas(), listTables(), listTSDictionaries(), listUserMappings(), lo_create(), lo_export(), lo_import_internal(), lo_initialize(), lo_lseek64(), lo_tell64(), lo_truncate(), lo_truncate64(), lockTableForWorker(), lookup_object_oid(), main(), makeAlterConfigCommand(), objectDescription(), open_client_SSL(), parse_int_param(), parseAclItem(), parseServiceFile(), parseServiceInfo(), permissionsList(), pg_fe_getauthname(), pg_fe_sendauth(), pg_GSS_error(), pg_GSS_error_int(), pg_GSS_read(), pg_GSS_write(), pg_local_sendauth(), pg_SASL_continue(), pgpassfileWarning(), pgtls_read(), pgtls_write(), pq_verify_peer_name_matches_certificate(), pqBuildErrorMessage3(), PQconnectPoll(), PQencryptPasswordConn(), pqFunctionCall3(), PQgetResult(), pqPacketSend(), pqParseInput3(), PQreset(), PQresetPoll(), pqsecure_open_gss(), pqsecure_raw_read(), pqsecure_raw_write(), pqSocketCheck(), prepare_btree_command(), prepare_heap_command(), prepare_vacuum_command(), printACLColumn(), processSQLNamePattern(), read_attr_value(), read_server_final_message(), ReceiveBackupManifestInMemoryChunk(), refreshMatViewData(), report_multiple_error_messages(), reportErrorPosition(), RestoreArchive(), run_reindex_command(), runInitSteps(), runPgDump(), setKeepalivesCount(), setKeepalivesIdle(), setKeepalivesInterval(), setTCPUserTimeout(), setup_connection(), StreamLogicalLog(), syntax_error(), and vacuum_one_database().

{
    int         save_errno = errno;
    va_list     args;
    bool        done;

    if (PQExpBufferBroken(str))
        return;                 /* already failed */

    /* Loop in case we have to retry after enlarging the buffer. */
    do
    {
        errno = save_errno;
        va_start(args, fmt);
        done = appendPQExpBufferVA(str, fmt, args);
        va_end(args);
    } while (!done);
}

appendPQExpBufferChar()

void appendPQExpBufferChar	(	PQExpBuffer	str,
		char	ch
	)

Definition at line 380 of file pqexpbuffer.c.

References PQExpBufferData::data, enlargePQExpBuffer(), and PQExpBufferData::len.

Referenced by _doSetSessionAuth(), AddAcl(), appendConnStrVal(), appendPsqlMetaConnect(), appendShellStringNoError(), appendStringLiteralConn(), appendStringLiteralDQ(), binary_upgrade_set_pg_class_oids(), build_client_first_message(), cluster_conn_opts(), cluster_one_database(), conninfo_uri_parse_options(), constructConnStr(), copyAclUserName(), createDummyViewAsClause(), createPartitions(), describeOneTableDetails(), describeRoles(), do_edit(), dumpCompositeType(), dumpConstraint(), dumpEnumType(), dumpEventTrigger(), dumpExtension(), dumpRule(), dumpTableData_insert(), dumpTableSchema(), dumpUserConfig(), ExecuteSimpleCommands(), fmtCopyColumnList(), fmtId(), format_aggregate_signature(), format_function_arguments_old(), format_function_signature(), gather_boolean_expression(), GenerateRecoveryConfig(), get_create_object_cmd(), getAggregates(), getFuncs(), indent_lines(), main(), MainLoop(), minimal_error_message(), output_completion_banner(), patternToSQLRegex(), pg_append_history(), pg_GSS_error(), pqBuildErrorMessage3(), PQconnectPoll(), prepare_vacuum_command(), processSQLNamePattern(), reportErrorPosition(), run_reindex_command(), and StreamLogicalLog().

{
    /* Make more room if needed */
    if (!enlargePQExpBuffer(str, 1))
        return;

    /* OK, append the character */
    str->data[str->len] = ch;
    str->len++;
    str->data[str->len] = '\0';
}

appendPQExpBufferStr()

void appendPQExpBufferStr	(	PQExpBuffer	str,
		const char *	data
	)

Definition at line 369 of file pqexpbuffer.c.

References appendBinaryPQExpBuffer().

Referenced by _doSetSessionAuth(), _getObjectDescription(), _printTocEntry(), _selectOutputSchema(), _selectTablespace(), add_role_attribute(), AddAcl(), append_db_pattern_cte(), append_rel_pattern_filtered_cte(), append_rel_pattern_raw_cte(), appendConnStrVal(), appendIndexCollationVersion(), appendPsqlMetaConnect(), appendQualifiedRelation(), appendReloptionsArray(), appendShellStringNoError(), appendStringLiteralDQ(), binary_upgrade_extension_member(), binary_upgrade_set_pg_class_oids(), binary_upgrade_set_type_oids_by_type_oid(), build_client_final_message(), build_client_first_message(), buildACLCommands(), buildDefaultACLCommands(), buildMatViewRefreshDependencies(), check_expected_areq(), check_for_data_type_usage(), cluster_conn_opts(), cluster_one_database(), collectComments(), collectSecLabels(), compile_database_list(), compile_relation_list_one_db(), connectDBStart(), connectFailureMessage(), connectOptions2(), conninfo_add_defaults(), conninfo_array_parse(), conninfo_init(), conninfo_parse(), conninfo_storeval(), conninfo_uri_decode(), conninfo_uri_parse_options(), copy_previous_query(), create_sql_command(), createDummyViewAsClause(), createPartitions(), CreateReplicationSlot(), describeAccessMethods(), describeAggregates(), describeFunctions(), describeOneTableDetails(), describeOperators(), describePublications(), DescribeQuery(), describeRoles(), describeSubscriptions(), describeTableDetails(), describeTablespaces(), describeTypes(), do_copy(), do_edit(), do_kill(), dumpAccessMethod(), dumpACL(), dumpAgg(), dumpBaseType(), dumpCast(), dumpCollation(), dumpComment(), dumpCompositeType(), dumpCompositeTypeColComments(), dumpConstraint(), dumpConversion(), dumpDatabase(), dumpDomain(), dumpEncoding(), dumpEnumType(), dumpEventTrigger(), dumpExtension(), dumpForeignDataWrapper(), dumpForeignServer(), dumpFunc(), dumpOpclass(), dumpOpfamily(), dumpOpr(), dumpPolicy(), dumpProcLang(), dumpPublication(), dumpRangeType(), dumpRoles(), dumpRule(), dumpSearchPath(), dumpSecLabel(), dumpSequence(), dumpSequenceData(), dumpSubscription(), dumpTableComment(), dumpTableData_copy(), dumpTableData_insert(), dumpTableSchema(), dumpTableSecLabel(), dumpTablespaces(), dumpToastCompression(), dumpTransform(), dumpTrigger(), dumpTSConfig(), dumpTSDictionary(), dumpUserMappings(), emitShSecLabels(), exec_command_ef_ev(), expand_dbname_patterns(), expand_extension_name_patterns(), expand_foreign_server_name_patterns(), expand_schema_name_patterns(), fillPGconn(), fmtCopyColumnList(), fmtId(), fmtQualifiedId(), format_aggregate_signature(), format_function_arguments(), format_function_signature(), gather_boolean_expression(), generate_old_dump(), GenerateRecoveryConfig(), get_create_object_cmd(), get_db_conn(), get_parallel_object_list(), getAccessMethods(), getAggregates(), getBlobs(), getCasts(), getDependencies(), getExtensionMembership(), getExtensions(), getFuncs(), getInherits(), getNamespaces(), getPublicationTables(), getRules(), gets_fromFile(), getSubscriptions(), getTableAttrs(), getTables(), getTransforms(), getTSParsers(), getTSTemplates(), indent_lines(), initCreatePKeys(), initialize_SSL(), listAllDbs(), listCasts(), listCollations(), listConversions(), listDbRoleSettings(), listDefaultACLs(), listDomains(), listEventTriggers(), listExtendedStats(), listExtensionContents(), listExtensions(), listForeignDataWrappers(), listForeignServers(), listForeignTables(), listLanguages(), listOperatorClasses(), listOperatorFamilies(), listOpFamilyFunctions(), listOpFamilyOperators(), listPartitionedTables(), listPublications(), listSchemas(), listTables(), listTSConfigs(), listTSConfigsVerbose(), listTSDictionaries(), listTSParsers(), listTSParsersVerbose(), listTSTemplates(), listUserMappings(), lo_initialize(), lo_read(), lo_truncate(), lo_write(), lookup_object_oid(), main(), makeAlterConfigCommand(), minimal_error_message(), objectDescription(), open_client_SSL(), openssl_verify_peer_name_matches_certificate_name(), output_completion_banner(), parseServiceFile(), patternToSQLRegex(), permissionsList(), pg_append_history(), pg_fe_getauthname(), pg_fe_scram_exchange(), pg_fe_sendauth(), pg_GSS_load_servicename(), pg_GSS_read(), pg_GSS_write(), pg_local_sendauth(), pg_password_sendauth(), pg_SASL_continue(), pg_SASL_init(), pgtls_read(), pgtls_write(), pq_verify_peer_name_matches_certificate(), pq_verify_peer_name_matches_certificate_name(), pqAllocCmdQueueEntry(), pqBuildErrorMessage3(), pqCheckInBufferSpace(), pqCheckOutBufferSpace(), PQconnectPoll(), PQencryptPasswordConn(), pqEndcopy3(), PQenterPipelineMode(), PQescapeByteaInternal(), PQescapeInternal(), PQescapeStringInternal(), PQexecStart(), PQexitPipelineMode(), PQfn(), PQgetCopyData(), pqGetCopyData3(), pqGetErrorNotice3(), pqGetline3(), pqPacketSend(), pqParseInput3(), pqPipelineProcessQueue(), PQpipelineSync(), PQputCopyData(), PQputCopyEnd(), pqReadData(), pqSaveWriteError(), pqsecure_open_gss(), pqsecure_raw_read(), pqsecure_raw_write(), PQsendPrepare(), PQsendQueryGuts(), PQsendQueryInternal(), PQsendQueryParams(), PQsendQueryPrepared(), PQsendQueryStart(), PQsetdbLogin(), pqSocketCheck(), pqWaitTimed(), prepare_vacuum_command(), processSQLNamePattern(), read_server_final_message(), read_server_first_message(), report_multiple_error_messages(), reportErrorPosition(), RestoreArchive(), run_reindex_command(), runInitSteps(), runPgDump(), setup_connection(), StreamLogicalLog(), and vacuum_one_database().

{
    appendBinaryPQExpBuffer(str, data, strlen(data));
}

appendPQExpBufferVA()

static bool appendPQExpBufferVA ( PQExpBuffer  str, const char *  fmt, va_list  args  )

static

Definition at line 296 of file pqexpbuffer.c.

References PQExpBufferData::data, enlargePQExpBuffer(), PQExpBufferData::len, markPQExpBufferBroken(), PQExpBufferData::maxlen, unlikely, and vsnprintf.

Referenced by appendPQExpBuffer(), and printfPQExpBuffer().

{
    size_t      avail;
    size_t      needed;
    int         nprinted;

    /*
     * Try to format the given string into the available space; but if there's
     * hardly any space, don't bother trying, just enlarge the buffer first.
     */
    if (str->maxlen > str->len + 16)
    {
        avail = str->maxlen - str->len;

        nprinted = vsnprintf(str->data + str->len, avail, fmt, args);

        /*
         * If vsnprintf reports an error, fail (we assume this means there's
         * something wrong with the format string).
         */
        if (unlikely(nprinted < 0))
        {
            markPQExpBufferBroken(str);
            return true;
        }

        if ((size_t) nprinted < avail)
        {
            /* Success.  Note nprinted does not include trailing null. */
            str->len += nprinted;
            return true;
        }

        /*
         * We assume a C99-compliant vsnprintf, so believe its estimate of the
         * required space, and add one for the trailing null.  (If it's wrong,
         * the logic will still work, but we may loop multiple times.)
         *
         * Choke if the required space would exceed INT_MAX, since str->maxlen
         * can't represent more than that.
         */
        if (unlikely(nprinted > INT_MAX - 1))
        {
            markPQExpBufferBroken(str);
            return true;
        }
        needed = nprinted + 1;
    }
    else
    {
        /*
         * We have to guess at how much to enlarge, since we're skipping the
         * formatting work.  Fortunately, because of enlargePQExpBuffer's
         * preference for power-of-2 sizes, this number isn't very sensitive;
         * the net effect is that we'll double the buffer size before trying
         * to run vsnprintf, which seems sensible.
         */
        needed = 32;
    }

    /* Increase the buffer size and try again. */
    if (!enlargePQExpBuffer(str, needed))
        return true;            /* oops, out of memory */

    return false;
}

createPQExpBuffer()

PQExpBuffer createPQExpBuffer

(

void

)

Definition at line 74 of file pqexpbuffer.c.

References initPQExpBuffer(), and malloc.

Referenced by _doSetSessionAuth(), _printTocEntry(), _selectOutputSchema(), _selectTableAccessMethod(), _selectTablespace(), _WriteBlobData(), append_depends_on_extension(), appendStringLiteralDQ(), binary_upgrade_set_pg_class_oids(), binary_upgrade_set_type_oids_by_rel_oid(), binary_upgrade_set_type_oids_by_type_oid(), buildACLCommands(), buildDefaultACLCommands(), buildMatViewRefreshDependencies(), buildShSecLabels(), cluster_conn_opts(), collectComments(), collectSecLabels(), constructConnStr(), createDummyViewAsClause(), CreateReplicationSlot(), createViewAsClause(), do_kill(), DropReplicationSlot(), dropRoles(), dump_lo_buf(), dumpAccessMethod(), dumpACL(), dumpAgg(), dumpAttrDef(), dumpBaseType(), dumpBlob(), dumpCast(), dumpCollation(), dumpComment(), dumpCompositeType(), dumpCompositeTypeColComments(), dumpConstraint(), dumpConversion(), dumpDatabase(), dumpDatabaseConfig(), dumpDefaultACL(), dumpDomain(), dumpEncoding(), dumpEnumType(), dumpEventTrigger(), dumpExtension(), dumpForeignDataWrapper(), dumpForeignServer(), dumpFunc(), dumpGroups(), dumpIndex(), dumpIndexAttach(), dumpNamespace(), dumpOpclass(), dumpOpfamily(), dumpOpr(), dumpPolicy(), dumpProcLang(), dumpPublication(), dumpPublicationTable(), dumpRangeType(), dumpRoleMembership(), dumpRoles(), dumpRule(), dumpSearchPath(), dumpSecLabel(), dumpSequence(), dumpSequenceData(), dumpShellType(), dumpStatisticsExt(), dumpStdStrings(), dumpSubscription(), dumpTable(), dumpTableAttach(), dumpTableComment(), dumpTableConstraintComment(), dumpTableData(), dumpTableData_copy(), dumpTableData_insert(), dumpTableSchema(), dumpTableSecLabel(), dumpTablespaces(), dumpToastCompression(), dumpTransform(), dumpTrigger(), dumpTSConfig(), dumpTSDictionary(), dumpTSParser(), dumpTSTemplate(), dumpUndefinedType(), dumpUserConfig(), dumpUserMappings(), exec_command_sf_sv(), ExecuteSimpleCommands(), expand_dbname_patterns(), expand_extension_name_patterns(), expand_foreign_server_name_patterns(), expand_schema_name_patterns(), expand_table_name_patterns(), fmtQualifiedId(), gather_boolean_expression(), GenerateRecoveryConfig(), get_create_object_cmd(), get_language_name(), getAccessMethods(), getAggregates(), getBlobs(), getCasts(), getCollations(), getConstraints(), getConversions(), getDefaultACLs(), getDependencies(), getDomainConstraints(), getEventTriggers(), getExtendedStatistics(), getExtensionMembership(), getExtensions(), getForeignDataWrappers(), getForeignServers(), getFormattedTypeName(), getFuncs(), getIndexes(), getInherits(), GetMyPSlot(), getNamespaces(), getOpclasses(), getOperators(), getOpfamilies(), getPolicies(), getProcLangs(), getPublications(), getPublicationTables(), getRules(), gets_fromFile(), getSubscriptions(), getTableAttrs(), getTables(), getTransforms(), getTriggers(), getTSConfigurations(), getTSDictionaries(), getTSParsers(), getTSTemplates(), getTypes(), lockTableForWorker(), lookup_object_oid(), main(), MainLoop(), minimal_error_message(), processExtensionTables(), refreshMatViewData(), RestoreArchive(), runPgDump(), setup_connection(), and StreamLogicalLog().

{
    PQExpBuffer res;

    res = (PQExpBuffer) malloc(sizeof(PQExpBufferData));
    if (res != NULL)
        initPQExpBuffer(res);

    return res;
}

destroyPQExpBuffer()

void destroyPQExpBuffer

(

PQExpBuffer

str

)

Definition at line 116 of file pqexpbuffer.c.

References free, and termPQExpBuffer().

Referenced by _doSetSessionAuth(), _printTocEntry(), _selectOutputSchema(), _selectTableAccessMethod(), _selectTablespace(), _WriteBlobData(), append_depends_on_extension(), appendStringLiteralDQ(), BaseBackup(), binary_upgrade_set_pg_class_oids(), binary_upgrade_set_type_oids_by_rel_oid(), binary_upgrade_set_type_oids_by_type_oid(), buildACLCommands(), buildDefaultACLCommands(), buildMatViewRefreshDependencies(), buildShSecLabels(), collectComments(), collectSecLabels(), constructConnStr(), CreateReplicationSlot(), createViewAsClause(), DeCloneArchive(), DropReplicationSlot(), dropRoles(), dump_lo_buf(), dumpAccessMethod(), dumpACL(), dumpAgg(), dumpAttrDef(), dumpBaseType(), dumpBlob(), dumpCast(), dumpCollation(), dumpComment(), dumpCompositeType(), dumpCompositeTypeColComments(), dumpConstraint(), dumpConversion(), dumpDatabase(), dumpDatabaseConfig(), dumpDefaultACL(), dumpDomain(), dumpEncoding(), dumpEnumType(), dumpEventTrigger(), dumpExtension(), dumpForeignDataWrapper(), dumpForeignServer(), dumpFunc(), dumpGroups(), dumpIndex(), dumpIndexAttach(), dumpNamespace(), dumpOpclass(), dumpOpfamily(), dumpOpr(), dumpPolicy(), dumpProcLang(), dumpPublication(), dumpPublicationTable(), dumpRangeType(), dumpRoleMembership(), dumpRoles(), dumpRule(), dumpSearchPath(), dumpSecLabel(), dumpSequence(), dumpSequenceData(), dumpShellType(), dumpStatisticsExt(), dumpStdStrings(), dumpSubscription(), dumpTable(), dumpTableAttach(), dumpTableComment(), dumpTableConstraintComment(), dumpTableData(), dumpTableData_copy(), dumpTableData_insert(), dumpTableSchema(), dumpTableSecLabel(), dumpTablespaces(), dumpToastCompression(), dumpTransform(), dumpTrigger(), dumpTSConfig(), dumpTSDictionary(), dumpTSParser(), dumpTSTemplate(), dumpUndefinedType(), dumpUserConfig(), dumpUserMappings(), exec_command_sf_sv(), expand_dbname_patterns(), expand_extension_name_patterns(), expand_foreign_server_name_patterns(), expand_schema_name_patterns(), expand_table_name_patterns(), fmtQualifiedId(), get_create_object_cmd(), get_language_name(), getAccessMethods(), getAggregates(), getBlobs(), getCasts(), getCollations(), getConstraints(), getConversions(), getDefaultACLs(), getDependencies(), getDomainConstraints(), getEventTriggers(), getExtendedStatistics(), getExtensionMembership(), getExtensions(), getForeignDataWrappers(), getForeignServers(), getFormattedTypeName(), getFuncs(), getIndexes(), getInherits(), getNamespaces(), getOpclasses(), getOperators(), getOpfamilies(), getPolicies(), getProcLangs(), getPublications(), getPublicationTables(), getRules(), getSubscriptions(), getTableAttrs(), getTables(), getTransforms(), getTriggers(), getTSConfigurations(), getTSDictionaries(), getTSParsers(), getTSTemplates(), getTypes(), ignore_boolean_expression(), is_true_boolean_expression(), lockTableForWorker(), lookup_object_oid(), main(), MainLoop(), minimal_error_message(), processExtensionTables(), refreshMatViewData(), RestoreArchive(), runPgDump(), setup_connection(), and StreamLogicalLog().

{
    if (str)
    {
        termPQExpBuffer(str);
        free(str);
    }
}

enlargePQExpBuffer()

int enlargePQExpBuffer	(	PQExpBuffer	str,
		size_t	needed
	)

Definition at line 174 of file pqexpbuffer.c.

References PQExpBufferData::data, PQExpBufferData::len, markPQExpBufferBroken(), PQExpBufferData::maxlen, PQExpBufferBroken, and realloc.

Referenced by appendBinaryPQExpBuffer(), appendByteaLiteral(), appendPQExpBufferChar(), appendPQExpBufferVA(), appendStringLiteral(), appendStringLiteralConn(), build_client_final_message(), and passwordFromFile().

{
    size_t      newlen;
    char       *newdata;

    if (PQExpBufferBroken(str))
        return 0;               /* already failed */

    /*
     * Guard against ridiculous "needed" values, which can occur if we're fed
     * bogus data.  Without this, we can get an overflow or infinite loop in
     * the following.
     */
    if (needed >= ((size_t) INT_MAX - str->len))
    {
        markPQExpBufferBroken(str);
        return 0;
    }

    needed += str->len + 1;     /* total space required now */

    /* Because of the above test, we now have needed <= INT_MAX */

    if (needed <= str->maxlen)
        return 1;               /* got enough space already */

    /*
     * We don't want to allocate just a little more space with each append;
     * for efficiency, double the buffer size each time it overflows.
     * Actually, we might need to more than double it if 'needed' is big...
     */
    newlen = (str->maxlen > 0) ? (2 * str->maxlen) : 64;
    while (needed > newlen)
        newlen = 2 * newlen;

    /*
     * Clamp to INT_MAX in case we went past it.  Note we are assuming here
     * that INT_MAX <= UINT_MAX/2, else the above loop could overflow.  We
     * will still have newlen >= needed.
     */
    if (newlen > (size_t) INT_MAX)
        newlen = (size_t) INT_MAX;

    newdata = (char *) realloc(str->data, newlen);
    if (newdata != NULL)
    {
        str->data = newdata;
        str->maxlen = newlen;
        return 1;
    }

    markPQExpBufferBroken(str);
    return 0;
}

initPQExpBuffer()

void initPQExpBuffer

(

PQExpBuffer

str

)

Definition at line 92 of file pqexpbuffer.c.

References PQExpBufferData::data, INITIAL_EXPBUFFER_SIZE, PQExpBufferData::len, malloc, PQExpBufferData::maxlen, oom_buffer_ptr, and unconstify.

Referenced by _reconnectToDB(), add_tablespace_footer(), append_database_pattern(), append_relation_pattern_helper(), append_schema_pattern(), appendPsqlMetaConnect(), appendQualifiedRelation(), build_client_final_message(), build_client_first_message(), check_for_data_type_usage(), cluster_one_database(), compile_database_list(), compile_relation_list_one_db(), conninfo_uri_parse_options(), create_sql_command(), createPartitions(), createPQExpBuffer(), describeAccessMethods(), describeAggregates(), describeFunctions(), describeOneTableDetails(), describeOneTSConfig(), describeOneTSParser(), describeOperators(), describePublications(), DescribeQuery(), describeRoles(), describeSubscriptions(), describeTableDetails(), describeTablespaces(), describeTypes(), do_copy(), exec_command_password(), ExecQueryUsingCursor(), executeMetaCommand(), format_aggregate_signature(), format_function_arguments(), format_function_arguments_old(), format_function_signature(), generate_old_dump(), GenerateRecoveryConfig(), get_db_conn(), get_parallel_object_list(), getCasts(), getParameterStatus(), getTransforms(), helpSQL(), indent_lines(), initCreatePKeys(), initCreateTables(), initGenerateDataClientSide(), initGenerateDataServerSide(), libpqrcv_get_conninfo(), listAllDbs(), listCasts(), listCollations(), listConversions(), listDbRoleSettings(), listDefaultACLs(), listDomains(), listEventTriggers(), listExtendedStats(), listExtensionContents(), listExtensions(), listForeignDataWrappers(), listForeignServers(), listForeignTables(), listLanguages(), listOneExtensionContents(), listOperatorClasses(), listOperatorFamilies(), listOpFamilyFunctions(), listOpFamilyOperators(), listPartitionedTables(), listPublications(), listSchemas(), listTables(), listTSConfigs(), listTSConfigsVerbose(), listTSDictionaries(), listTSParsers(), listTSParsersVerbose(), listTSTemplates(), listUserMappings(), main(), makeEmptyPGconn(), new_9_0_populate_pg_largeobject_metadata(), objectDescription(), old_9_6_invalidate_hash_indexes(), output_completion_banner(), ParseScript(), passwordFromFile(), patternToSQLRegex(), permissionsList(), pg_SASL_init(), PQconndefaults(), PQconninfo(), PQconninfoParse(), pqGetErrorNotice3(), PQresultVerboseErrorMessage(), process_backslash_command(), processSQLNamePattern(), psql_get_variable(), ReceiveTarFile(), report_multiple_error_messages(), resetPQExpBuffer(), run_reindex_command(), runInitSteps(), syntax_error(), and vacuum_one_database().

{
    str->data = (char *) malloc(INITIAL_EXPBUFFER_SIZE);
    if (str->data == NULL)
    {
        str->data = unconstify(char *, oom_buffer_ptr); /* see comment above */
        str->maxlen = 0;
        str->len = 0;
    }
    else
    {
        str->maxlen = INITIAL_EXPBUFFER_SIZE;
        str->len = 0;
        str->data[0] = '\0';
    }
}

markPQExpBufferBroken()

static bool static void markPQExpBufferBroken ( PQExpBuffer  str )

static

Definition at line 52 of file pqexpbuffer.c.

References PQExpBufferData::data, free, PQExpBufferData::len, PQExpBufferData::maxlen, oom_buffer, oom_buffer_ptr, and unconstify.

Referenced by appendPQExpBufferVA(), and enlargePQExpBuffer().

{
    if (str->data != oom_buffer)
        free(str->data);

    /*
     * Casting away const here is a bit ugly, but it seems preferable to not
     * marking oom_buffer const.  We want to do that to encourage the compiler
     * to put oom_buffer in read-only storage, so that anyone who tries to
     * scribble on a broken PQExpBuffer will get a failure.
     */
    str->data = unconstify(char *, oom_buffer_ptr);
    str->len = 0;
    str->maxlen = 0;
}

printfPQExpBuffer()

void printfPQExpBuffer	(	PQExpBuffer	str,
		const char *	fmt,
			...
	)

Definition at line 237 of file pqexpbuffer.c.

References appendPQExpBufferVA(), generate_unaccent_rules::args, PQExpBufferBroken, and resetPQExpBuffer().

Referenced by add_tablespace_footer(), buildACLCommands(), buildACLQueries(), createPartitions(), describeAccessMethods(), describeAggregates(), describeFunctions(), describeOneTableDetails(), describeOneTSConfig(), describeOneTSParser(), describeOperators(), describePublications(), DescribeQuery(), describeRoles(), describeSubscriptions(), describeTableDetails(), describeTablespaces(), describeTypes(), do_copy(), dropRoles(), dumpDatabaseConfig(), dumpGroups(), dumpRoleMembership(), dumpRoles(), dumpRule(), dumpUserConfig(), exec_command_password(), executeMetaCommand(), get_create_object_cmd(), get_next_possible_free_pg_type_oid(), getTableAttrs(), initCreateTables(), initGenerateDataClientSide(), initGenerateDataServerSide(), listAllDbs(), listCasts(), listCollations(), listConversions(), listDbRoleSettings(), listDefaultACLs(), listDomains(), listEventTriggers(), listExtendedStats(), listExtensionContents(), listExtensions(), listForeignDataWrappers(), listForeignServers(), listForeignTables(), listLanguages(), listOneExtensionContents(), listOperatorClasses(), listOperatorFamilies(), listOpFamilyFunctions(), listOpFamilyOperators(), listPartitionedTables(), listPublications(), listSchemas(), listTables(), listTSConfigs(), listTSConfigsVerbose(), listTSDictionaries(), listTSParsers(), listTSParsersVerbose(), listTSTemplates(), listUserMappings(), lo_export(), lo_import_internal(), main(), minimal_error_message(), parseAclItem(), permissionsList(), processExtensionTables(), and syntax_error().

{
    int         save_errno = errno;
    va_list     args;
    bool        done;

    resetPQExpBuffer(str);

    if (PQExpBufferBroken(str))
        return;                 /* already failed */

    /* Loop in case we have to retry after enlarging the buffer. */
    do
    {
        errno = save_errno;
        va_start(args, fmt);
        done = appendPQExpBufferVA(str, fmt, args);
        va_end(args);
    } while (!done);
}

resetPQExpBuffer()

void resetPQExpBuffer

(

PQExpBuffer

str

)

Definition at line 148 of file pqexpbuffer.c.

References PQExpBufferData::data, initPQExpBuffer(), PQExpBufferData::len, and oom_buffer.

Referenced by closePGconn(), cluster_conn_opts(), copyAclUserName(), describeOneTableDetails(), describeRoles(), do_edit(), dumpCompositeTypeColComments(), dumpDatabase(), dumpOpclass(), dumpOpfamily(), dumpRoles(), dumpSequence(), dumpSequenceData(), dumpTableComment(), dumpTableData_insert(), dumpTableSecLabel(), dumpTSConfig(), dumpUserConfig(), dumpUserMappings(), exec_command_ef_ev(), exec_command_reset(), exec_command_watch(), ExecuteSimpleCommands(), expand_dbname_patterns(), expand_extension_name_patterns(), expand_foreign_server_name_patterns(), expand_schema_name_patterns(), expand_table_name_patterns(), get_create_object_cmd(), get_parallel_object_list(), getConstraints(), getIndexes(), GetMyPSlot(), getPolicies(), getPublications(), gets_fromFile(), getTableAttrs(), getTables(), getTriggers(), initCreatePKeys(), lo_import_internal(), lo_initialize(), MainLoop(), parseAclItem(), ParseScript(), pg_send_history(), PQencryptPasswordConn(), PQescapeByteaConn(), PQescapeInternal(), PQescapeStringConn(), PQexecStart(), PQfn(), pqGetErrorNotice3(), PQgetResult(), pqGets_internal(), PQsendQueryStart(), PQsetnonblocking(), prepare_btree_command(), prepare_heap_command(), prepare_vacuum_command(), printfPQExpBuffer(), StreamLogicalLog(), and vacuum_one_database().

{
    if (str)
    {
        if (str->data != oom_buffer)
        {
            str->len = 0;
            str->data[0] = '\0';
        }
        else
        {
            /* try to reinitialize to valid state */
            initPQExpBuffer(str);
        }
    }
}

termPQExpBuffer()

void termPQExpBuffer

(

PQExpBuffer

str

)

Definition at line 131 of file pqexpbuffer.c.

References PQExpBufferData::data, free, PQExpBufferData::len, PQExpBufferData::maxlen, oom_buffer, oom_buffer_ptr, and unconstify.

Referenced by _reconnectToDB(), add_tablespace_footer(), append_database_pattern(), append_relation_pattern_helper(), append_schema_pattern(), appendPsqlMetaConnect(), appendQualifiedRelation(), build_client_final_message(), build_client_first_message(), check_for_data_type_usage(), cluster_one_database(), compile_database_list(), compile_relation_list_one_db(), conninfo_uri_parse_options(), createPartitions(), describeAccessMethods(), describeAggregates(), describeFunctions(), describeOneTableDetails(), describeOneTSConfig(), describeOneTSParser(), describeOperators(), describePublications(), DescribeQuery(), describeRoles(), describeSubscriptions(), describeTableDetails(), describeTablespaces(), describeTypes(), destroyPQExpBuffer(), do_copy(), exec_command_password(), ExecQueryUsingCursor(), executeMetaCommand(), free_command(), freePGconn(), generate_old_dump(), GenerateRecoveryConfig(), get_db_conn(), get_parallel_object_list(), getParameterStatus(), helpSQL(), indent_lines(), initCreatePKeys(), initCreateTables(), initGenerateDataClientSide(), initGenerateDataServerSide(), libpqrcv_get_conninfo(), listAllDbs(), listCasts(), listCollations(), listConversions(), listDbRoleSettings(), listDefaultACLs(), listDomains(), listEventTriggers(), listExtendedStats(), listExtensionContents(), listExtensions(), listForeignDataWrappers(), listForeignServers(), listForeignTables(), listLanguages(), listOneExtensionContents(), listOperatorClasses(), listOperatorFamilies(), listOpFamilyFunctions(), listOpFamilyOperators(), listPartitionedTables(), listPublications(), listSchemas(), listTables(), listTSConfigs(), listTSConfigsVerbose(), listTSDictionaries(), listTSParsers(), listTSParsersVerbose(), listTSTemplates(), listUserMappings(), main(), new_9_0_populate_pg_largeobject_metadata(), objectDescription(), old_9_6_invalidate_hash_indexes(), output_completion_banner(), ParseScript(), passwordFromFile(), patternToSQLRegex(), permissionsList(), pg_SASL_init(), PQconndefaults(), PQconninfo(), PQconninfoParse(), pqGetErrorNotice3(), PQresultVerboseErrorMessage(), process_backslash_command(), processSQLNamePattern(), ReceiveTarFile(), report_multiple_error_messages(), run_reindex_command(), runInitSteps(), syntax_error(), and vacuum_one_database().

{
    if (str->data != oom_buffer)
        free(str->data);
    /* just for luck, make the buffer validly empty. */
    str->data = unconstify(char *, oom_buffer_ptr); /* see comment above */
    str->maxlen = 0;
    str->len = 0;
}

Variable Documentation

oom_buffer

const char oom_buffer[1] = ""

static

Definition at line 38 of file pqexpbuffer.c.

Referenced by markPQExpBufferBroken(), resetPQExpBuffer(), and termPQExpBuffer().

oom_buffer_ptr

const char* oom_buffer_ptr = oom_buffer

static

Definition at line 41 of file pqexpbuffer.c.

Referenced by initPQExpBuffer(), markPQExpBufferBroken(), and termPQExpBuffer().