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	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

MCXT_ALLOC_HUGE

#define MCXT_ALLOC_HUGE

Value:

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

Definition at line 16 of file fe_memutils.h.

MCXT_ALLOC_NO_OOM

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

Definition at line 17 of file fe_memutils.h.

MCXT_ALLOC_ZERO

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

Definition at line 18 of file fe_memutils.h.

palloc0_array

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

Definition at line 65 of file fe_memutils.h.

palloc0_object

#define palloc0_object

(

type

)

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

Definition at line 63 of file fe_memutils.h.

palloc_array

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

Definition at line 64 of file fe_memutils.h.

palloc_object

#define palloc_object

(

type

)

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

Definition at line 62 of file fe_memutils.h.

pg_malloc0_array

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

Definition at line 45 of file fe_memutils.h.

pg_malloc0_object

#define pg_malloc0_object

(

type

)

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

Definition at line 39 of file fe_memutils.h.

pg_malloc_array

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

Definition at line 44 of file fe_memutils.h.

pg_malloc_object

#define pg_malloc_object

(

type

)

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

Definition at line 38 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 51 of file fe_memutils.h.

repalloc_array

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

Definition at line 66 of file fe_memutils.h.

Function Documentation

palloc()

void* palloc

(

Size

size

)

Definition at line 1210 of file mcxt.c.

{
    /* duplicates MemoryContextAlloc to avoid increased overhead */
    void       *ret;
    MemoryContext context = CurrentMemoryContext;
 
    Assert(MemoryContextIsValid(context));
    AssertNotInCriticalSection(context);
 
    if (!AllocSizeIsValid(size))
        elog(ERROR, "invalid memory alloc request size %zu", size);
 
    context->isReset = false;
 
    ret = context->methods->alloc(context, size);
    if (unlikely(ret == NULL))
    {
        MemoryContextStats(TopMemoryContext);
        ereport(ERROR,
                (errcode(ERRCODE_OUT_OF_MEMORY),
                 errmsg("out of memory"),
                 errdetail("Failed on request of size %zu in memory context \"%s\".",
                           size, context->name)));
    }
 
    VALGRIND_MEMPOOL_ALLOC(context, ret, size);
 
    return ret;
}

palloc0()

void* palloc0

(

Size

size

)

Definition at line 1241 of file mcxt.c.

{
    /* duplicates MemoryContextAllocZero to avoid increased overhead */
    void       *ret;
    MemoryContext context = CurrentMemoryContext;
 
    Assert(MemoryContextIsValid(context));
    AssertNotInCriticalSection(context);
 
    if (!AllocSizeIsValid(size))
        elog(ERROR, "invalid memory alloc request size %zu", size);
 
    context->isReset = false;
 
    ret = context->methods->alloc(context, size);
    if (unlikely(ret == NULL))
    {
        MemoryContextStats(TopMemoryContext);
        ereport(ERROR,
                (errcode(ERRCODE_OUT_OF_MEMORY),
                 errmsg("out of memory"),
                 errdetail("Failed on request of size %zu in memory context \"%s\".",
                           size, context->name)));
    }
 
    VALGRIND_MEMPOOL_ALLOC(context, ret, size);
 
    MemSetAligned(ret, 0, size);
 
    return ret;
}

palloc_extended()

void* palloc_extended	(	Size	size,
		int	flags
	)

Definition at line 1274 of file mcxt.c.

{
    /* duplicates MemoryContextAllocExtended to avoid increased overhead */
    void       *ret;
    MemoryContext context = CurrentMemoryContext;
 
    Assert(MemoryContextIsValid(context));
    AssertNotInCriticalSection(context);
 
    if (!((flags & MCXT_ALLOC_HUGE) != 0 ? AllocHugeSizeIsValid(size) :
          AllocSizeIsValid(size)))
        elog(ERROR, "invalid memory alloc request size %zu", size);
 
    context->isReset = false;
 
    ret = context->methods->alloc(context, size);
    if (unlikely(ret == NULL))
    {
        if ((flags & MCXT_ALLOC_NO_OOM) == 0)
        {
            MemoryContextStats(TopMemoryContext);
            ereport(ERROR,
                    (errcode(ERRCODE_OUT_OF_MEMORY),
                     errmsg("out of memory"),
                     errdetail("Failed on request of size %zu in memory context \"%s\".",
                               size, context->name)));
        }
        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

)

Definition at line 1436 of file mcxt.c.

{
#ifdef USE_VALGRIND
    MemoryContextMethodID method = GetMemoryChunkMethodID(pointer);
    MemoryContext context = GetMemoryChunkContext(pointer);
#endif
 
    MCXT_METHOD(pointer, free_p) (pointer);
 
#ifdef USE_VALGRIND
    if (method != MCTX_ALIGNED_REDIRECT_ID)
        VALGRIND_MEMPOOL_FREE(context, pointer);
#endif
}

pg_free()

void pg_free

(

void *

ptr

)

Definition at line 105 of file fe_memutils.c.

{
    free(ptr);
}

References free.

Referenced by advanceConnectionState(), append_depends_on_extension(), appendQualifiedRelation(), avlFree(), bool_substitute_hook(), calculate_totals(), close_walfile(), copyFile(), create_script_for_old_cluster_deletion(), datapagemap_print(), dir_close(), dir_free(), dir_open_for_write(), do_connect(), do_watch(), dumpFunc(), dumpRoleMembership(), EndCompressor(), FindStreamingStart(), free_command(), free_db_and_rel_infos(), free_rel_infos(), free_socket_set(), get_control_data(), get_loadable_libraries(), get_restricted_token(), getTimelineHistory(), init_libpq_conn(), libpq_get_current_wal_insert_lsn(), listSchemas(), main(), makeAlterConfigCommand(), 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(), ready_list_free(), ReceiveXlogStream(), reindex_one_database(), RestoreArchive(), run_schedule(), SendQuery(), SetVariable(), simple_oid_list_destroy(), simple_string_list_destroy(), SortTocFromFile(), tar_close(), tar_free(), tar_open_for_write(), transfer_all_new_dbs(), vacuum_one_database(), and WriteDataChunks().

pg_malloc()

void* pg_malloc

(

size_t

size

)

Definition at line 47 of file fe_memutils.c.

{
    return pg_malloc_internal(size, 0);
}

References pg_malloc_internal().

Referenced by _Clone(), _CustomReadFunc(), _PrintFileData(), _skipData(), add_one_elt(), add_stringlist_item(), ahprintf(), ArchiveEntry(), archprintf(), avlInsertNode(), buildACLCommands(), BuildArchiveDependencies(), check_testspec(), CloneArchive(), collectComments(), collectRoleNames(), collectSecLabels(), conditional_stack_create(), conditional_stack_push(), copyFile(), create_sql_command(), createBoundaryObjects(), CreateVariableSpace(), CreateWalTarMethod(), datapagemap_iterate(), decide_file_actions(), do_connect(), do_watch(), dumpTableData_insert(), escape_quotes_bki(), ExecuteSqlCommandBuf(), find_other_exec_or_die(), findDependencyLoops(), fix_dependencies(), format_numeric_locale(), gen_db_file_maps(), get_comma_elts(), get_db_infos(), get_loadable_libraries(), get_rel_infos(), 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(), getRules(), getSubscriptions(), getTableAttrs(), getTimelineHistory(), getTransforms(), getTriggers(), getTSConfigurations(), getTSDictionaries(), getTSParsers(), getTSTemplates(), getTypes(), identify_locking_dependencies(), InitArchiveFmt_Custom(), InitArchiveFmt_Directory(), InitArchiveFmt_Null(), InitArchiveFmt_Tar(), libpq_fetch_file(), listSchemas(), load_resultmap(), main(), makeTableDataInfo(), NewDumpOptions(), parallel_exec_prog(), parallel_transfer_all_new_dbs(), ParallelBackupStart(), parse_manifest_file(), ParseScript(), parseScriptWeight(), parseVariable(), prepareCommand(), pretty_wal_size(), print_aligned_text(), print_aligned_vertical(), printCrosstab(), PrintResultInCrosstab(), process_queued_fetch_requests(), pset_quoted_string(), quote_identifier(), quote_if_needed(), rankSort(), read_controlfile(), read_file_contents(), ReadDataFromArchiveNone(), readfile(), readMessageFromPipe(), ReadStr(), ReadToc(), ready_list_init(), 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(), strtokx(), tar_open_for_write(), tarPrintf(), TopoSort(), wait_for_tests(), WaitForTerminatingWorkers(), and WriteDataChunks().

pg_malloc0()

void* pg_malloc0

(

size_t

size

)

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(), _discoverArchiveFormat(), _ReadExtraToc(), alloc_socket_set(), AllocateCompressor(), ArchiveEntry(), avlInit(), buildTocEntryArrays(), compile_database_list(), compile_relation_list_one_db(), connectDatabase(), CreateWalDirectoryMethod(), CreateWalTarMethod(), describeRoles(), dir_get_file_name(), dir_open_for_write(), dumpRoleMembership(), findDependencyLoops(), FindStreamingStart(), get_parallel_object_list(), GetConnection(), getFuncs(), getTables(), init_libpq_source(), init_local_source(), InitArchiveFmt_Custom(), InitArchiveFmt_Directory(), InitCompressFileHandle(), main(), make_outputdirs(), NewRestoreOptions(), parallel_exec_prog(), parallel_transfer_all_new_dbs(), ParallelBackupStart(), parse_slash_copy(), prepareCommand(), print_aligned_text(), printTableAddCell(), printTableAddFooter(), printTableInit(), process_backslash_command(), ReadToc(), reindex_one_database(), run_all_permutations(), setup_connection(), SortTocFromFile(), StartLogStreamer(), tablespace_list_append(), tar_get_file_name(), tar_open_for_write(), and TopoSort().

pg_malloc_extended()

void* pg_malloc_extended	(	size_t	size,
		int	flags
	)

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
	)

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(), EXIT_FAILURE, fprintf, and realloc.

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

pg_strdup()

char* pg_strdup

(

const char *

in

)

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(), EXIT_FAILURE, and fprintf.

Referenced by _allocAH(), _ArchiveEntry(), _becomeUser(), _check_database_version(), _getObjectDescription(), _selectOutputSchema(), _selectTableAccessMethod(), _selectTablespace(), _tarGetHeader(), add_one_elt(), add_stringlist_item(), adjust_data_dir(), append_depends_on_extension(), ArchiveEntry(), bool_substitute_hook(), check_locale_name(), check_required_directory(), CloneArchive(), collectComments(), collectRoleNames(), collectSecLabels(), comp_keyword_case_substitute_hook(), ConnectDatabase(), constructConnStr(), convertRegProcReference(), convertTSFunction(), create_script_for_old_cluster_deletion(), createBoundaryObjects(), CreateWalDirectoryMethod(), default_icu_locale(), describeOneTableDetails(), describeRoles(), dir_open_for_write(), do_pset(), dumpAccessMethod(), dumpAttrDef(), dumpBaseType(), dumpCollation(), dumpCompositeType(), 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(), fix_path_separator(), flagInhAttrs(), flagInhIndexes(), flagInhTables(), format_numeric_locale(), get_comma_elts(), get_control_data(), get_db_infos(), get_id(), get_language_name(), get_loadable_libraries(), get_opts(), get_rel_infos(), get_restricted_token(), get_sock_dir(), 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(), getRestoreCommand(), getRules(), gets_fromFile(), getSubscriptions(), getTableAttrs(), getTables(), getTriggers(), getTSConfigurations(), getTSDictionaries(), getTSParsers(), getTSTemplates(), getTypes(), getVariable(), handle_args(), histcontrol_substitute_hook(), histsize_substitute_hook(), identify_target_directory(), ignoreeof_substitute_hook(), initializeInput(), insert_filehash_entry(), listSchemas(), load_resultmap(), locale_date_order(), lookupCreateVariable(), 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_source_file(), process_target_file(), processEncodingEntry(), processExtensionTables(), processSearchPathEntry(), progress_update_filename(), psql_get_variable(), pstrdup(), putVariable(), read_post_opts(), readfile(), ReconnectToServer(), regression_main(), RestoreArchive(), run_schedule(), run_simple_query(), RunIdentifySystem(), sanitize_line(), savePsetInfo(), search_directory(), sendCommand(), set_info_version(), set_locale_and_encoding(), setDecimalLocale(), setup(), setup_config(), setup_connection(), setup_pgdata(), SetVariable(), SetVariableHooks(), show_context_substitute_hook(), simple_action_list_append(), simple_prompt_extended(), split_path(), split_to_stringlist(), tar_open_for_write(), tarOpen(), and verbosity_substitute_hook().

pnstrdup()

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

Definition at line 1635 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,
			...
	)

pstrdup()

char* pstrdup

(

const char *

in

)

Definition at line 1624 of file mcxt.c.

{
    return MemoryContextStrdup(CurrentMemoryContext, in);
}

pvsnprintf()

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

repalloc()

void* repalloc	(	void *	pointer,
		Size	size
	)

Definition at line 1456 of file mcxt.c.

{
#ifdef USE_VALGRIND
    MemoryContextMethodID method = GetMemoryChunkMethodID(pointer);
#endif
#if defined(USE_ASSERT_CHECKING) || defined(USE_VALGRIND)
    MemoryContext context = GetMemoryChunkContext(pointer);
#endif
    void       *ret;
 
    if (!AllocSizeIsValid(size))
        elog(ERROR, "invalid memory alloc request size %zu", size);
 
    AssertNotInCriticalSection(context);
 
    /* isReset must be false already */
    Assert(!context->isReset);
 
    ret = MCXT_METHOD(pointer, realloc) (pointer, size);
    if (unlikely(ret == NULL))
    {
        MemoryContext cxt = GetMemoryChunkContext(pointer);
 
        MemoryContextStats(TopMemoryContext);
        ereport(ERROR,
                (errcode(ERRCODE_OUT_OF_MEMORY),
                 errmsg("out of memory"),
                 errdetail("Failed on request of size %zu in memory context \"%s\".",
                           size, cxt->name)));
    }
 
#ifdef USE_VALGRIND
    if (method != MCTX_ALIGNED_REDIRECT_ID)
        VALGRIND_MEMPOOL_CHANGE(context, pointer, ret, size);
#endif
 
    return ret;
}