PostgreSQL Source Code  git master
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 1197 of file mcxt.c.

1198 {
1199  /* duplicates MemoryContextAlloc to avoid increased overhead */
1200  void *ret;
1202 
1203  Assert(MemoryContextIsValid(context));
1204  AssertNotInCriticalSection(context);
1205 
1206  context->isReset = false;
1207 
1208  /*
1209  * For efficiency reasons, we purposefully offload the handling of
1210  * allocation failures to the MemoryContextMethods implementation as this
1211  * allows these checks to be performed only when an actual malloc needs to
1212  * be done to request more memory from the OS. Additionally, not having
1213  * to execute any instructions after this call allows the compiler to use
1214  * the sibling call optimization. If you're considering adding code after
1215  * this call, consider making it the responsibility of the 'alloc'
1216  * function instead.
1217  */
1218  ret = context->methods->alloc(context, size, 0);
1219  /* We expect OOM to be handled by the alloc function */
1220  Assert(ret != NULL);
1221  VALGRIND_MEMPOOL_ALLOC(context, ret, size);
1222 
1223  return ret;
1224 }
Assert(fmt[strlen(fmt) - 1] !='\n')
#define AssertNotInCriticalSection(context)
Definition: mcxt.c:162
MemoryContext CurrentMemoryContext
Definition: mcxt.c:131
#define VALGRIND_MEMPOOL_ALLOC(context, addr, size)
Definition: memdebug.h:29
#define MemoryContextIsValid(context)
Definition: memnodes.h:145
static pg_noinline void Size size
Definition: slab.c:607
const MemoryContextMethods * methods
Definition: memnodes.h:126
void *(* alloc)(MemoryContext context, Size size, int flags)
Definition: memnodes.h:66

◆ palloc0()

void* palloc0 ( Size  size)

Definition at line 1227 of file mcxt.c.

1228 {
1229  /* duplicates MemoryContextAllocZero to avoid increased overhead */
1230  void *ret;
1232 
1233  Assert(MemoryContextIsValid(context));
1234  AssertNotInCriticalSection(context);
1235 
1236  context->isReset = false;
1237 
1238  ret = context->methods->alloc(context, size, 0);
1239 
1240  VALGRIND_MEMPOOL_ALLOC(context, ret, size);
1241 
1242  MemSetAligned(ret, 0, size);
1243 
1244  return ret;
1245 }
#define MemSetAligned(start, val, len)
Definition: c.h:1037

◆ palloc_extended()

void* palloc_extended ( Size  size,
int  flags 
)

Definition at line 1248 of file mcxt.c.

1249 {
1250  /* duplicates MemoryContextAllocExtended to avoid increased overhead */
1251  void *ret;
1253 
1254  Assert(MemoryContextIsValid(context));
1255  AssertNotInCriticalSection(context);
1256 
1257  context->isReset = false;
1258 
1259  ret = context->methods->alloc(context, size, flags);
1260  if (unlikely(ret == NULL))
1261  {
1262  return NULL;
1263  }
1264 
1265  VALGRIND_MEMPOOL_ALLOC(context, ret, size);
1266 
1267  if ((flags & MCXT_ALLOC_ZERO) != 0)
1268  MemSetAligned(ret, 0, size);
1269 
1270  return ret;
1271 }
#define unlikely(x)
Definition: c.h:298
#define MCXT_ALLOC_ZERO
Definition: fe_memutils.h:18

◆ pfree()

void pfree ( void *  pointer)

Definition at line 1401 of file mcxt.c.

1402 {
1403 #ifdef USE_VALGRIND
1405  MemoryContext context = GetMemoryChunkContext(pointer);
1406 #endif
1407 
1408  MCXT_METHOD(pointer, free_p) (pointer);
1409 
1410 #ifdef USE_VALGRIND
1411  if (method != MCTX_ALIGNED_REDIRECT_ID)
1412  VALGRIND_MEMPOOL_FREE(context, pointer);
1413 #endif
1414 }
static MemoryContextMethodID GetMemoryChunkMethodID(const void *pointer)
Definition: mcxt.c:178
MemoryContext GetMemoryChunkContext(void *pointer)
Definition: mcxt.c:612
#define MCXT_METHOD(pointer, method)
Definition: mcxt.c:169
#define VALGRIND_MEMPOOL_FREE(context, addr)
Definition: memdebug.h:30
MemoryContextMethodID
@ MCTX_ALIGNED_REDIRECT_ID

◆ pg_free()

void pg_free ( void *  ptr)

Definition at line 105 of file fe_memutils.c.

106 {
107  free(ptr);
108 }
#define free(a)
Definition: header.h:65

References free.

Referenced by advanceConnectionState(), append_depends_on_extension(), appendQualifiedRelation(), avlFree(), bool_substitute_hook(), calculate_totals(), check_exec(), 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(), 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(), icu_language_tag(), init_libpq_conn(), libpq_get_current_wal_insert_lsn(), listSchemas(), main(), make_rfile(), 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(), ReceiveXlogStream(), reconstruct_from_incremental_file(), reindex_one_database(), RestoreArchive(), run_schedule(), SendQuery(), setlocales(), 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.

48 {
49  return pg_malloc_internal(size, 0);
50 }
static void * pg_malloc_internal(size_t size, int flags)
Definition: fe_memutils.c:23

References pg_malloc_internal(), and size.

Referenced by _Clone(), _CustomReadFunc(), _PrintFileData(), _skipData(), add_one_elt(), add_stringlist_item(), ahprintf(), allocCStatePrepared(), ArchiveEntry(), archprintf(), avlInsertNode(), buildACLCommands(), BuildArchiveDependencies(), check_testspec(), CloneArchive(), collectComments(), collectRoleNames(), collectSecLabels(), conditional_stack_create(), conditional_stack_push(), copy_file_blocks(), copyFile(), create_manifest_writer(), 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_loadable_libraries(), get_old_cluster_logical_slot_infos(), 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(), getSubscriptionTables(), getTableAttrs(), getTimelineHistory(), getTransforms(), getTriggers(), getTSConfigurations(), getTSDictionaries(), getTSParsers(), getTSTemplates(), getTypes(), icu_language_tag(), identify_locking_dependencies(), InitArchiveFmt_Custom(), InitArchiveFmt_Directory(), InitArchiveFmt_Null(), InitArchiveFmt_Tar(), 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(), pretty_wal_size(), print_aligned_text(), print_aligned_vertical(), printCrosstab(), PrintResultInCrosstab(), process_directory_recursively(), process_queued_fetch_requests(), pset_quoted_string(), quote_identifier(), quote_if_needed(), rankSort(), read_controlfile(), read_file_contents(), ReadDataFromArchiveNone(), 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(), strtokx(), tar_open_for_write(), tarPrintf(), TopoSort(), wait_for_tests(), WaitForTerminatingWorkers(), and WriteDataChunks().

◆ pg_malloc0()

◆ pg_malloc_extended()

void* pg_malloc_extended ( size_t  size,
int  flags 
)

Definition at line 59 of file fe_memutils.c.

60 {
61  return pg_malloc_internal(size, flags);
62 }

References pg_malloc_internal(), and size.

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.

66 {
67  void *tmp;
68 
69  /* Avoid unportable behavior of realloc(NULL, 0) */
70  if (ptr == NULL && size == 0)
71  size = 1;
72  tmp = realloc(ptr, size);
73  if (!tmp)
74  {
75  fprintf(stderr, _("out of memory\n"));
77  }
78  return tmp;
79 }
#define _(x)
Definition: elog.c:90
#define realloc(a, b)
Definition: header.h:60
exit(1)
#define fprintf
Definition: port.h:242
#define EXIT_FAILURE
Definition: settings.h:167

References _, exit(), EXIT_FAILURE, fprintf, realloc, and size.

Referenced by add_one_elt(), 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(), and rewind_parseTimeLineHistory().

◆ pg_strdup()

char* pg_strdup ( const char *  in)

Definition at line 85 of file fe_memutils.c.

86 {
87  char *tmp;
88 
89  if (!in)
90  {
91  fprintf(stderr,
92  _("cannot duplicate null pointer (internal error)\n"));
94  }
95  tmp = strdup(in);
96  if (!tmp)
97  {
98  fprintf(stderr, _("out of memory\n"));
100  }
101  return tmp;
102 }

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(), 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_old_cluster_logical_slot_infos(), 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(), getRules(), gets_fromFile(), getSubscriptions(), getSubscriptionTables(), 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(), 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 1587 of file mcxt.c.

1588 {
1589  char *out;
1590 
1591  len = strnlen(in, len);
1592 
1593  out = palloc(len + 1);
1594  memcpy(out, in, len);
1595  out[len] = '\0';
1596 
1597  return out;
1598 }
void * palloc(Size size)
Definition: mcxt.c:1197
const void size_t len
size_t strnlen(const char *str, size_t maxlen)
Definition: strnlen.c:26

◆ psprintf()

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

◆ pstrdup()

char* pstrdup ( const char *  in)

Definition at line 1576 of file mcxt.c.

1577 {
1579 }
char * MemoryContextStrdup(MemoryContext context, const char *string)
Definition: mcxt.c:1563

◆ 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 1421 of file mcxt.c.

1422 {
1423 #ifdef USE_VALGRIND
1425 #endif
1426 #if defined(USE_ASSERT_CHECKING) || defined(USE_VALGRIND)
1427  MemoryContext context = GetMemoryChunkContext(pointer);
1428 #endif
1429  void *ret;
1430 
1431  AssertNotInCriticalSection(context);
1432 
1433  /* isReset must be false already */
1434  Assert(!context->isReset);
1435 
1436  /*
1437  * For efficiency reasons, we purposefully offload the handling of
1438  * allocation failures to the MemoryContextMethods implementation as this
1439  * allows these checks to be performed only when an actual malloc needs to
1440  * be done to request more memory from the OS. Additionally, not having
1441  * to execute any instructions after this call allows the compiler to use
1442  * the sibling call optimization. If you're considering adding code after
1443  * this call, consider making it the responsibility of the 'realloc'
1444  * function instead.
1445  */
1446  ret = MCXT_METHOD(pointer, realloc) (pointer, size, 0);
1447 
1448 #ifdef USE_VALGRIND
1449  if (method != MCTX_ALIGNED_REDIRECT_ID)
1450  VALGRIND_MEMPOOL_CHANGE(context, pointer, ret, size);
1451 #endif
1452 
1453  return ret;
1454 }
#define VALGRIND_MEMPOOL_CHANGE(context, optr, nptr, size)
Definition: memdebug.h:31