fe_memutils.h File Reference

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

Go to the source code of this file.

Macros
#define	MaxAllocSize   ((Size) 0x3fffffff) /* 1 gigabyte - 1 */
#define	MCXT_ALLOC_HUGE
#define	MCXT_ALLOC_NO_OOM   0x02 /* no failure if out-of-memory */
#define	MCXT_ALLOC_ZERO   0x04 /* zero allocated memory */
#define	pg_malloc_object(type)   ((type *) pg_malloc(sizeof(type)))
#define	pg_malloc0_object(type)   ((type *) pg_malloc0(sizeof(type)))
#define	pg_malloc_array(type, count)   ((type *) pg_malloc(sizeof(type) * (count)))
#define	pg_malloc0_array(type, count)   ((type *) pg_malloc0(sizeof(type) * (count)))
#define	pg_realloc_array(pointer, type, count)   ((type *) pg_realloc(pointer, sizeof(type) * (count)))
#define	palloc_object(type)   ((type *) palloc(sizeof(type)))
#define	palloc0_object(type)   ((type *) palloc0(sizeof(type)))
#define	palloc_array(type, count)   ((type *) palloc(sizeof(type) * (count)))
#define	palloc0_array(type, count)   ((type *) palloc0(sizeof(type) * (count)))
#define	repalloc_array(pointer, type, count)   ((type *) repalloc(pointer, sizeof(type) * (count)))

Functions
char *	pg_strdup (const char *in)
void *	pg_malloc (size_t size)
void *	pg_malloc0 (size_t size)
void *	pg_malloc_extended (size_t size, int flags)
void *	pg_realloc (void *ptr, size_t size)
void	pg_free (void *ptr)
char *	pstrdup (const char *in)
char *	pnstrdup (const char *in, Size size)
void *	palloc (Size size)
void *	palloc0 (Size size)
void *	palloc_extended (Size size, int flags)
void *	repalloc (void *pointer, Size size)
void	pfree (void *pointer)
char *	psprintf (const char *fmt,...) pg_attribute_printf(1
char size_t	pvsnprintf (char *buf, size_t len, const char *fmt, va_list args) pg_attribute_printf(3

Macro Definition Documentation

MaxAllocSize

#define MaxAllocSize   ((Size) 0x3fffffff) /* 1 gigabyte - 1 */

Definition at line 22 of file fe_memutils.h.

MCXT_ALLOC_HUGE

#define MCXT_ALLOC_HUGE

Value:

                                         0x01   /* allow huge allocation (> 1 GB) not
                                         * actually used for frontends */

Definition at line 28 of file fe_memutils.h.

MCXT_ALLOC_NO_OOM

#define MCXT_ALLOC_NO_OOM   0x02 /* no failure if out-of-memory */

Definition at line 29 of file fe_memutils.h.

MCXT_ALLOC_ZERO

#define MCXT_ALLOC_ZERO   0x04 /* zero allocated memory */

Definition at line 30 of file fe_memutils.h.

palloc0_array

#define palloc0_array	(		type,
			count
	)		((type *) palloc0(sizeof(type) * (count)))

Definition at line 77 of file fe_memutils.h.

palloc0_object

#define palloc0_object

(

type

)

((type *) palloc0(sizeof(type)))

Definition at line 75 of file fe_memutils.h.

palloc_array

#define palloc_array	(		type,
			count
	)		((type *) palloc(sizeof(type) * (count)))

Definition at line 76 of file fe_memutils.h.

palloc_object

#define palloc_object

(

type

)

((type *) palloc(sizeof(type)))

Definition at line 74 of file fe_memutils.h.

pg_malloc0_array

#define pg_malloc0_array	(		type,
			count
	)		((type *) pg_malloc0(sizeof(type) * (count)))

Definition at line 57 of file fe_memutils.h.

pg_malloc0_object

#define pg_malloc0_object

(

type

)

((type *) pg_malloc0(sizeof(type)))

Definition at line 51 of file fe_memutils.h.

pg_malloc_array

#define pg_malloc_array	(		type,
			count
	)		((type *) pg_malloc(sizeof(type) * (count)))

Definition at line 56 of file fe_memutils.h.

pg_malloc_object

#define pg_malloc_object

(

type

)

((type *) pg_malloc(sizeof(type)))

Definition at line 50 of file fe_memutils.h.

pg_realloc_array

#define pg_realloc_array	(		pointer,
			type,
			count
	)		((type *) pg_realloc(pointer, sizeof(type) * (count)))

Definition at line 63 of file fe_memutils.h.

repalloc_array

#define repalloc_array	(		pointer,
			type,
			count
	)		((type *) repalloc(pointer, sizeof(type) * (count)))

Definition at line 78 of file fe_memutils.h.

Function Documentation

palloc()

void * palloc ( Size  size )

extern

Definition at line 1387 of file mcxt.c.

{
    /* duplicates MemoryContextAlloc to avoid increased overhead */
    void       *ret;
    MemoryContext context = CurrentMemoryContext;
 
    Assert(MemoryContextIsValid(context));
    AssertNotInCriticalSection(context);
 
    context->isReset = false;
 
    /*
     * For efficiency reasons, we purposefully offload the handling of
     * allocation failures to the MemoryContextMethods implementation as this
     * allows these checks to be performed only when an actual malloc needs to
     * be done to request more memory from the OS.  Additionally, not having
     * to execute any instructions after this call allows the compiler to use
     * the sibling call optimization.  If you're considering adding code after
     * this call, consider making it the responsibility of the 'alloc'
     * function instead.
     */
    ret = context->methods->alloc(context, size, 0);
    /* We expect OOM to be handled by the alloc function */
    Assert(ret != NULL);
    VALGRIND_MEMPOOL_ALLOC(context, ret, size);
 
    return ret;
}

palloc0()

void * palloc0 ( Size  size )

extern

Definition at line 1417 of file mcxt.c.

{
    /* duplicates MemoryContextAllocZero to avoid increased overhead */
    void       *ret;
    MemoryContext context = CurrentMemoryContext;
 
    Assert(MemoryContextIsValid(context));
    AssertNotInCriticalSection(context);
 
    context->isReset = false;
 
    ret = context->methods->alloc(context, size, 0);
    /* We expect OOM to be handled by the alloc function */
    Assert(ret != NULL);
    VALGRIND_MEMPOOL_ALLOC(context, ret, size);
 
    MemSetAligned(ret, 0, size);
 
    return ret;
}

palloc_extended()

void * palloc_extended ( Size  size, int  flags  )

extern

Definition at line 1439 of file mcxt.c.

{
    /* duplicates MemoryContextAllocExtended to avoid increased overhead */
    void       *ret;
    MemoryContext context = CurrentMemoryContext;
 
    Assert(MemoryContextIsValid(context));
    AssertNotInCriticalSection(context);
 
    context->isReset = false;
 
    ret = context->methods->alloc(context, size, flags);
    if (unlikely(ret == NULL))
    {
        /* NULL can be returned only when using MCXT_ALLOC_NO_OOM */
        Assert(flags & MCXT_ALLOC_NO_OOM);
        return NULL;
    }
 
    VALGRIND_MEMPOOL_ALLOC(context, ret, size);
 
    if ((flags & MCXT_ALLOC_ZERO) != 0)
        MemSetAligned(ret, 0, size);
 
    return ret;
}

pfree()

void pfree ( void *  pointer )

extern

Definition at line 1616 of file mcxt.c.

{
#ifdef USE_VALGRIND
    MemoryContext context = GetMemoryChunkContext(pointer);
#endif
 
    MCXT_METHOD(pointer, free_p) (pointer);
 
    VALGRIND_MEMPOOL_FREE(context, pointer);
}

pg_free()

void pg_free ( void *  ptr )

extern

Definition at line 105 of file fe_memutils.c.

{
    free(ptr);
}

References free.

Referenced by _printTocEntry(), advanceConnectionState(), append_depends_on_extension(), appendQualifiedRelation(), avlFree(), bool_substitute_hook(), calculate_totals(), check_exec(), check_for_data_types_usage(), check_for_incompatible_polymorphics(), check_publisher(), checksum_file(), close_walfile(), copy_file_blocks(), copyFile(), create_script_for_old_cluster_deletion(), datapagemap_print(), dir_close(), dir_free(), dir_open_for_write(), do_connect(), do_watch(), dumpFunc(), dumpRoleMembership(), dumpSequence(), EndCompressor(), EndCompressorNone(), FindStreamingStart(), free_command(), free_db_and_rel_infos(), free_rel_infos(), free_retrieved_objects(), free_socket_set(), FreeSlruRead(), FreeSlruWrite(), get_control_data(), get_db_rel_and_slot_infos(), get_loadable_libraries(), get_publisher_databases(), get_restricted_token(), get_standby_sysid(), getTimelineHistory(), icu_language_tag(), init_libpq_conn(), IssueACLPerBlob(), IssueCommandPerBlob(), libpq_get_current_wal_insert_lsn(), listSchemas(), main(), make_rfile(), makeAlterConfigCommand(), modify_subscriber_sysid(), open_walfile(), parallel_exec_prog(), parallel_transfer_all_new_dbs(), parseAclItem(), parseCommandLine(), parseQuery(), perform_rewind(), pfree(), printCrosstab(), PrintResultInCrosstab(), process_queued_fetch_requests(), rankSort(), readCommandResponse(), ReadHead(), readMessageFromPipe(), ReceiveXlogStream(), reconstruct_from_incremental_file(), reindex_one_database(), RestoreArchive(), retrieve_objects(), run_schedule(), SendQuery(), set_replication_progress(), setlocales(), setup_publisher(), SetVariable(), simple_oid_list_destroy(), simple_ptr_list_destroy(), simple_string_list_destroy(), SlruReadSwitchPageSlow(), SlruWriteSwitchPageSlow(), SortTocFromFile(), SyncVariables(), tar_close(), tar_free(), tar_open_for_write(), test_gb18030_page_multiple(), transfer_all_new_dbs(), upgrade_task_free(), upgrade_task_run(), vacuum_all_databases(), vacuum_one_database(), verify_tar_file(), WriteDataChunks(), and WriteToc().

pg_malloc()

void * pg_malloc ( size_t  size )

extern

Definition at line 47 of file fe_memutils.c.

{
    return pg_malloc_internal(size, 0);
}

References pg_malloc_internal().

Referenced by _Clone(), _Clone(), _CustomReadFunc(), _PrintFileData(), _skipData(), add_one_elt(), add_stringlist_item(), add_stringlist_item(), ahprintf(), allocCStatePrepared(), AllocSlruSegState(), ArchiveEntry(), archprintf(), astreamer_verify_content_new(), avlInsertNode(), buildACLCommands(), BuildArchiveDependencies(), check_testspec(), checksum_file(), CloneArchive(), collectBinaryUpgradeClassOids(), collectComments(), collectRoleNames(), collectSecLabels(), collectSequences(), conditional_stack_create(), conditional_stack_push(), copy_connection(), copy_file_blocks(), copyFile(), create_manifest_writer(), create_sql_command(), createBoundaryObjects(), CreateVariableSpace(), CreateWalTarMethod(), datapagemap_iterate(), decide_file_actions(), do_connect(), do_watch(), dumpFunc(), dumpTableData_insert(), escape_quotes_bki(), ExecuteSqlCommandBuf(), expr_scanner_get_substring(), find_other_exec_or_die(), findDependencyLoops(), fix_dependencies(), format_numeric_locale(), gen_db_file_maps(), get_comma_elts(), get_exec_path(), get_loadable_libraries(), get_pg_version(), get_tablespace_paths(), get_template0_info(), getAccessMethods(), getAggregates(), getCasts(), getCollations(), getConstraints(), getConversions(), getDefaultACLs(), getDomainConstraints(), getEventTriggers(), getExtendedStatistics(), getExtensions(), getForeignDataWrappers(), getForeignServers(), getFuncs(), getIndexes(), getInherits(), getLOs(), getNamespaces(), getOpclasses(), getOperators(), getOpfamilies(), getPolicies(), getProcLangs(), getPublicationNamespaces(), getPublications(), getPublicationTables(), getRelationStatistics(), getRules(), getSubscriptionRelations(), getSubscriptions(), getTableAttrs(), getTimelineHistory(), getTransforms(), getTriggers(), getTSConfigurations(), getTSDictionaries(), getTSParsers(), getTSTemplates(), getTypes(), icu_language_tag(), identify_locking_dependencies(), InitCompressorNone(), libpq_fetch_file(), listSchemas(), load_backup_manifest(), load_backup_manifests(), load_resultmap(), main(), makeTableDataInfo(), NewDumpOptions(), parallel_exec_prog(), parallel_transfer_all_new_dbs(), ParallelBackupStart(), parse_manifest_file(), ParseScript(), parseScriptWeight(), parseVariable(), precheck_tar_backup_file(), pretty_wal_size(), print_aligned_text(), print_aligned_vertical(), printCrosstab(), PrintResultInCrosstab(), process_directory_recursively(), process_old_cluster_logical_slot_infos(), process_queued_fetch_requests(), process_rel_infos(), pset_quoted_string(), psqlscan_extract_substring(), psqlscan_prepare_buffer(), psqlscan_push_new_buffer(), quote_identifier(), quote_if_needed(), rankSort(), read_controlfile(), read_file_contents(), ReadDataFromArchiveNone(), readfile(), readfile(), readMessageFromPipe(), ReadStr(), ReadToc(), reconstruct_from_incremental_file(), remember_to_cleanup_directory(), replace_token(), rewind_parseTimeLineHistory(), run_all_permutations(), run_permutation(), savePsetInfo(), setup_bin_paths(), SetVariable(), SetVariableHooks(), simple_oid_list_append(), simple_ptr_list_append(), simple_string_list_append(), slurpFile(), sortDumpableObjects(), SplitGUCList(), sql_exec(), sql_exec_searchtables(), StartRestoreLO(), strtokx(), tar_open_for_write(), tarPrintf(), test_gb18030_page_multiple(), TopoSort(), verify_backup_checksums(), verify_tar_file(), wait_for_tests(), WaitForTerminatingWorkers(), and WriteDataChunks().

pg_malloc0()

void * pg_malloc0 ( size_t  size )

extern

Definition at line 53 of file fe_memutils.c.

{
    return pg_malloc_internal(size, MCXT_ALLOC_ZERO);
}

References MCXT_ALLOC_ZERO, and pg_malloc_internal().

Referenced by _allocAH(), _ArchiveEntry(), _ArchiveEntry(), _discoverArchiveFormat(), _ReadExtraToc(), _ReadExtraToc(), add_tablespace_mapping(), alloc_socket_set(), AllocateCompressor(), allocCStatePrepared(), ArchiveEntry(), avlInit(), buildTocEntryArrays(), check_for_data_types_usage(), compile_database_list(), compile_relation_list_one_db(), ConnectDatabase(), CreateWalDirectoryMethod(), CreateWalTarMethod(), describeRoles(), dir_get_file_name(), dir_open_for_write(), dumpRoleMembership(), dumpSequence(), findDependencyLoops(), FindStreamingStart(), get_db_infos(), get_parallel_tabidx_list(), get_parallel_tables_list(), GetConnection(), getFuncs(), getRelationStatistics(), getTables(), init_libpq_source(), init_local_source(), InitArchiveFmt_Custom(), InitArchiveFmt_Directory(), InitCompressFileHandle(), load_backup_manifest(), main(), make_incremental_rfile(), make_outputdirs(), make_rfile(), NewRestoreOptions(), parallel_exec_prog(), parallel_transfer_all_new_dbs(), ParallelBackupStart(), parse_manifest_file(), parse_slash_copy(), print_aligned_text(), printTableAddCell(), printTableAddFooter(), printTableInit(), process_backslash_command(), psql_scan_create(), ReadToc(), reconstruct_from_incremental_file(), reindex_one_database(), run_all_permutations(), scan_for_existing_tablespaces(), setup_connection(), SortTocFromFile(), StartLogStreamer(), tablespace_list_append(), tar_get_file_name(), tar_open_for_write(), test_protocol_version(), TopoSort(), upgrade_task_create(), and upgrade_task_run().

pg_malloc_extended()

void * pg_malloc_extended ( size_t  size, int  flags  )

extern

Definition at line 59 of file fe_memutils.c.

{
    return pg_malloc_internal(size, flags);
}

References pg_malloc_internal().

Referenced by do_lo_import(), and pg_log_generic_v().

pg_realloc()

void * pg_realloc ( void *  ptr, size_t  size  )

extern

Definition at line 65 of file fe_memutils.c.

{
    void       *tmp;
 
    /* Avoid unportable behavior of realloc(NULL, 0) */
    if (ptr == NULL && size == 0)
        size = 1;
    tmp = realloc(ptr, size);
    if (!tmp)
    {
        fprintf(stderr, _("out of memory\n"));
        exit(EXIT_FAILURE);
    }
    return tmp;
}

References _, EXIT_FAILURE, fb(), fprintf, and realloc.

Referenced by add_one_elt(), addlitchar(), BuildArchiveDependencies(), datapagemap_add(), enlargeVariables(), exec_command_set(), extend_pattern_info_array(), findDumpableDependencies(), icu_language_tag(), identify_locking_dependencies(), main(), ParseScript(), read_file_contents(), readfile(), readMessageFromPipe(), ReadToc(), repalloc(), replaceVariable(), rewind_parseTimeLineHistory(), and upgrade_task_add_step().

pg_strdup()

char * pg_strdup ( const char *  in )

extern

Definition at line 85 of file fe_memutils.c.

{
    char       *tmp;
 
    if (!in)
    {
        fprintf(stderr,
                _("cannot duplicate null pointer (internal error)\n"));
        exit(EXIT_FAILURE);
    }
    tmp = strdup(in);
    if (!tmp)
    {
        fprintf(stderr, _("out of memory\n"));
        exit(EXIT_FAILURE);
    }
    return tmp;
}

References _, EXIT_FAILURE, fb(), and fprintf.

Referenced by _allocAH(), _ArchiveEntry(), _ArchiveEntry(), _becomeUser(), _check_database_version(), _getObjectDescription(), _selectOutputSchema(), _selectTableAccessMethod(), _selectTablespace(), _tarGetHeader(), add_one_elt(), add_stringlist_item(), add_stringlist_item(), adjust_data_dir(), adjust_data_dir(), append_depends_on_extension(), ArchiveEntry(), bool_substitute_hook(), check_locale_name(), check_publisher(), check_required_directory(), check_subscriber(), CloneArchive(), collectComments(), collectRoleNames(), collectSecLabels(), comp_keyword_case_substitute_hook(), concat_conninfo_dbname(), ConnectDatabaseAhx(), constructConnStr(), convertRegProcReference(), convertTSFunction(), create_logical_replication_slot(), create_script_for_old_cluster_deletion(), createBoundaryObjects(), CreateWalDirectoryMethod(), describeOneTableDetails(), describeRoles(), dir_open_for_write(), do_pset(), dumpAccessMethod(), dumpAttrDef(), dumpBaseType(), dumpCollation(), dumpCompositeType(), dumpConstraint(), dumpConversion(), dumpDatabase(), dumpDomain(), dumpEnumType(), dumpEventTrigger(), dumpExtension(), dumpForeignDataWrapper(), dumpForeignServer(), dumpIndex(), dumpNamespace(), dumpOpclass(), dumpOpfamily(), dumpOptionsFromRestoreOptions(), dumpPolicy(), dumpProcLang(), dumpPublication(), dumpRangeType(), dumpRoleGUCPrivs(), dumpRule(), dumpSearchPath(), dumpSequence(), dumpStatisticsExt(), dumpSubscription(), dumpTable(), dumpTableConstraintComment(), dumpTableData(), dumpTableSchema(), dumpTablespaces(), dumpTrigger(), dumpTSConfig(), dumpTSDictionary(), dumpTSParser(), dumpTSTemplate(), dumpUndefinedType(), echo_substitute_hook(), encodingid_to_string(), exec_command_g(), exec_command_gset(), exec_command_password(), exec_command_set(), fetch_count_substitute_hook(), find_matching_ts_config(), FindDbnameInConnOpts(), fix_path_separator(), flagInhAttrs(), flagInhIndexes(), flagInhTables(), format_numeric_locale(), get_base_conninfo(), get_comma_elts(), get_conninfo_value(), get_control_data(), get_db_infos(), get_id(), get_language_name(), get_loadable_libraries(), get_opts(), get_restricted_token(), get_sock_dir(), get_sub_conninfo(), get_synchronized_snapshot(), get_tablespace_paths(), get_template0_info(), get_user_info(), getAccessMethods(), getAggregates(), getCollations(), getConstraints(), getConversions(), getDefaultACLs(), getDomainConstraints(), getEventTriggers(), getExtendedStatistics(), getExtensions(), getForeignDataWrappers(), getForeignServers(), getFormattedTypeName(), getFuncs(), getIndexes(), getLOs(), getNamespaces(), getOpclasses(), getOperators(), getOpfamilies(), getPolicies(), getProcLangs(), getPublications(), getPublicationTables(), getRelationStatistics(), getRules(), gets_fromFile(), getSubscriptionRelations(), getSubscriptions(), getTableAttrs(), getTables(), getTriggers(), getTSConfigurations(), getTSDictionaries(), getTSParsers(), getTSTemplates(), getTypes(), getVariable(), handle_args(), histcontrol_substitute_hook(), histsize_substitute_hook(), identify_target_directory(), ignoreeof_substitute_hook(), InitDiscoverCompressFileHandle(), initializeInput(), insert_filehash_entry(), IssueACLPerBlob(), IssueCommandPerBlob(), keepwal_add_entry(), listSchemas(), load_resultmap(), lookupCreateVariable(), main(), main(), MainLoop(), makeAlterConfigCommand(), open_result_files(), parallel_exec_prog(), parallel_transfer_all_new_dbs(), parse_psql_options(), parse_slash_copy(), parseAclItem(), parseCommandLine(), parseQuery(), ParseScript(), parseScriptWeight(), pg_send_history(), postprocess_sql_command(), printTableAddFooter(), printTableSetFooter(), process_backslash_command(), process_old_cluster_logical_slot_infos(), process_rel_infos(), process_source_file(), process_target_file(), processEncodingEntry(), processExtensionTables(), processSearchPathEntry(), progress_update_filename(), psql_get_variable(), psqlscan_push_new_buffer(), pstrdup(), putVariable(), read_post_opts(), readfile(), ReconnectToServer(), regression_main(), RestoreArchive(), run_schedule(), run_simple_query(), RunIdentifySystem(), sanitize_line(), save_global_locale(), savePsetInfo(), search_directory(), sendCommand(), set_info_version(), setDecimalLocale(), setup(), setup_config(), setup_connection(), setup_pgdata(), setup_publisher(), SetVariable(), SetVariableHooks(), show_context_substitute_hook(), simple_action_list_append(), simple_prompt_extended(), split_path(), split_to_stringlist(), tar_open_for_write(), tarOpen(), verbosity_substitute_hook(), and watch_interval_substitute_hook().

pnstrdup()

char * pnstrdup ( const char *  in, Size  size  )

extern

Definition at line 1792 of file mcxt.c.

{
    char       *out;
 
    len = strnlen(in, len);
 
    out = palloc(len + 1);
    memcpy(out, in, len);
    out[len] = '\0';
 
    return out;
}

psprintf()

char * psprintf ( const char *  fmt,   ...  )

extern

pstrdup()

char * pstrdup ( const char *  in )

extern

Definition at line 1781 of file mcxt.c.

{
    return MemoryContextStrdup(CurrentMemoryContext, in);
}

pvsnprintf()

char size_t pvsnprintf ( char *  buf, size_t  len, const char *  fmt, va_list  args  )

extern

repalloc()

void * repalloc ( void *  pointer, Size  size  )

extern

Definition at line 1632 of file mcxt.c.

{
#if defined(USE_ASSERT_CHECKING) || defined(USE_VALGRIND)
    MemoryContext context = GetMemoryChunkContext(pointer);
#endif
    void       *ret;
 
    AssertNotInCriticalSection(context);
 
    /* isReset must be false already */
    Assert(!context->isReset);
 
    /*
     * For efficiency reasons, we purposefully offload the handling of
     * allocation failures to the MemoryContextMethods implementation as this
     * allows these checks to be performed only when an actual malloc needs to
     * be done to request more memory from the OS.  Additionally, not having
     * to execute any instructions after this call allows the compiler to use
     * the sibling call optimization.  If you're considering adding code after
     * this call, consider making it the responsibility of the 'realloc'
     * function instead.
     */
    ret = MCXT_METHOD(pointer, realloc) (pointer, size, 0);
 
    VALGRIND_MEMPOOL_CHANGE(context, pointer, ret, size);
 
    return ret;
}