osprey/common/util/memory.c File Reference

#include <sys/types.h>
#include <malloc.h>
#include <bstring.h>
#include "defs.h"
#include "mempool.h"
#include "tracing.h"
#include "erglob.h"

Include dependency graph for memory.c:

Define Documentation

#define BLOCK_SIZE 0x2000

Definition at line 105 of file memory.c.

#define INT_LIST_first ( x ) ((x)->first)

Definition at line 252 of file memory.c.

Referenced by Site_Account_Pop(), and Site_Account_Push().

#define INT_LIST_rest ( x ) ((x)->rest)

Definition at line 253 of file memory.c.

Referenced by Site_Account_Pop(), and Site_Account_Push().

#define MAGIC_NUM 0xabcd

Definition at line 416 of file memory.c.

Referenced by MEM_POOL_Alloc_P(), MEM_POOL_Delete(), MEM_POOL_FREE(), MEM_POOL_Initialize_P(), MEM_POOL_Pop_P(), MEM_POOL_Pop_Unfreeze_P(), MEM_POOL_Push_Freeze_P(), MEM_POOL_Push_P(), MEM_POOL_Realloc_P(), and MEM_POOL_Report().

#define MEM_BLOCK_avail ( x ) ((x)->avail)

Definition at line 171 of file memory.c.

Referenced by Allocate_Block(), MEM_POOL_Pop_P(), MEM_POOL_Push_P(), and Raw_Allocate().

#define MEM_BLOCK_first_ptr ( x ) (MEM_PTR) (((char *) (x)) + PAD_TO_ALIGN(sizeof(MEM_BLOCK)))

Definition at line 175 of file memory.c.

Referenced by Allocate_Block(), and MEM_POOL_Pop_P().

#define MEM_BLOCK_ptr ( x ) ((x)->ptr)

Definition at line 172 of file memory.c.

Referenced by Allocate_Block(), MEM_POOL_Pop_P(), MEM_POOL_Push_P(), and Raw_Allocate().

#define MEM_BLOCK_rest ( x ) ((x)->rest)

Definition at line 173 of file memory.c.

Referenced by Allocate_Block(), and MEM_POOL_Pop_P().

#define MEM_LARGE_BLOCK_base ( x ) ((x)->base)

Definition at line 193 of file memory.c.

Referenced by Allocate_Large_Block(), MEM_LARGE_BLOCK_realloc(), MEM_LARGE_BLOCK_zap(), MEM_POOL_FREE(), and MEM_POOL_Realloc_P().

#define MEM_LARGE_BLOCK_next ( x ) ((x)->next)

Definition at line 191 of file memory.c.

Referenced by Allocate_Large_Block(), MEM_POOL_FREE(), MEM_POOL_Pop_P(), and MEM_POOL_Realloc_P().

#define MEM_LARGE_BLOCK_OVERHEAD (PAD_TO_ALIGN(sizeof(MEM_LARGE_BLOCK)))

Definition at line 195 of file memory.c.

Referenced by Allocate_Large_Block(), MEM_POOL_FREE(), and MEM_POOL_Realloc_P().

#define MEM_LARGE_BLOCK_prev ( x ) ((x)->prev)

Definition at line 192 of file memory.c.

Referenced by Allocate_Large_Block(), MEM_POOL_FREE(), and MEM_POOL_Realloc_P().

#define MEM_LARGE_BLOCK_ptr ( x ) ((x)->ptr)

Definition at line 194 of file memory.c.

Referenced by Allocate_Large_Block(), MEM_LARGE_BLOCK_realloc(), MEM_LARGE_BLOCK_zap(), MEM_POOL_FREE(), and MEM_POOL_Realloc_P().

#define MEM_POOL_alloc_site_list ( x ) ((x)->alloc_site_list)

Definition at line 428 of file memory.c.

Referenced by MEM_POOL_Initialize_P(), MEM_POOL_Report(), Site_Account_Alloc(), Site_Account_Pop(), and Site_Account_Push().

#define MEM_POOL_block ( x ) MEM_POOL_BLOCKS_block(MEM_POOL_blocks(x))

Definition at line 430 of file memory.c.

Referenced by Allocate_Block(), and Raw_Allocate().

#define MEM_POOL_blocks ( x ) ((x)->blocks)

Definition at line 422 of file memory.c.

Referenced by Allocate_Large_Block(), MEM_POOL_Alloc_P(), MEM_POOL_Delete(), MEM_POOL_FREE(), MEM_POOL_Initialize_P(), MEM_POOL_Pop_P(), MEM_POOL_Push_P(), MEM_POOL_Realloc_P(), and Raw_Allocate().

#define MEM_POOL_BLOCKS_base_avail ( x ) ((x)->base_avail)

Definition at line 353 of file memory.c.

Referenced by MEM_POOL_Pop_P(), and MEM_POOL_Push_P().

#define MEM_POOL_BLOCKS_base_block ( x ) ((x)->base_block)

Definition at line 351 of file memory.c.

Referenced by MEM_POOL_Pop_P(), and MEM_POOL_Push_P().

#define MEM_POOL_BLOCKS_base_ptr ( x ) ((x)->base_ptr)

Definition at line 352 of file memory.c.

Referenced by MEM_POOL_Pop_P(), and MEM_POOL_Push_P().

#define MEM_POOL_BLOCKS_block ( x ) ((x)->block)

Definition at line 349 of file memory.c.

Referenced by MEM_POOL_Pop_P(), and MEM_POOL_Push_P().

#define MEM_POOL_BLOCKS_large_block ( x ) ((x)->large_block)

Definition at line 350 of file memory.c.

Referenced by MEM_POOL_Pop_P(), and MEM_POOL_Push_P().

#define MEM_POOL_BLOCKS_rest ( x ) ((x)->rest)

Definition at line 354 of file memory.c.

Referenced by MEM_POOL_Delete(), MEM_POOL_Pop_P(), and MEM_POOL_Push_P().

#define MEM_POOL_bz ( x ) ((x)->bz)

Definition at line 423 of file memory.c.

Referenced by Allocate_Block(), Allocate_Large_Block(), MEM_POOL_Initialize_P(), MEM_POOL_Pop_P(), MEM_POOL_Push_P(), and MEM_POOL_Realloc_P().

#define MEM_POOL_frozen ( x ) ((x)->frozen)

Definition at line 426 of file memory.c.

Referenced by MEM_POOL_Initialize_P(), MEM_POOL_Pop_P(), MEM_POOL_Pop_Unfreeze_P(), MEM_POOL_Push_Freeze_P(), and MEM_POOL_Push_P().

#define MEM_POOL_INIT_IN_PROGRESS (-1)

Definition at line 98 of file memory.c.

Referenced by MEM_POOL_Initialize_P(), and MEM_POOL_Push_P().

#define MEM_POOL_large_block ( x ) MEM_POOL_BLOCKS_large_block(MEM_POOL_blocks(x))

Definition at line 432 of file memory.c.

Referenced by Allocate_Large_Block(), MEM_POOL_FREE(), and MEM_POOL_Realloc_P().

#define MEM_POOL_last_alloc ( x ) MEM_PURE_STACK_last_alloc(MEM_POOL_pure_stack(x))

Definition at line 407 of file memory.c.

Referenced by MEM_POOL_Alloc_P(), MEM_POOL_Pop_P(), and MEM_POOL_Realloc_P().

#define MEM_POOL_magic_num ( x ) ((x)->magic_num)

Definition at line 427 of file memory.c.

Referenced by MEM_POOL_Alloc_P(), MEM_POOL_Delete(), MEM_POOL_FREE(), MEM_POOL_Initialize_P(), MEM_POOL_Pop_P(), MEM_POOL_Pop_Unfreeze_P(), MEM_POOL_Push_Freeze_P(), MEM_POOL_Push_P(), MEM_POOL_Realloc_P(), and MEM_POOL_Report().

#define MEM_POOL_name ( x ) ((x)->name)

Definition at line 421 of file memory.c.

Referenced by Allocate_Block(), MEM_POOL_Alloc_P(), MEM_POOL_Delete(), MEM_POOL_FREE(), MEM_POOL_Initialize_P(), MEM_POOL_Pop_P(), MEM_POOL_Pop_Unfreeze_P(), MEM_POOL_Push_Freeze_P(), MEM_POOL_Push_P(), MEM_POOL_Realloc_P(), and MEM_POOL_Report().

#define MEM_POOL_prev_stack ( x ) MEM_PURE_STACK_prev_stack(MEM_POOL_pure_stack(x))

Definition at line 409 of file memory.c.

Referenced by MEM_POOL_Pop_P().

#define MEM_POOL_pure_stack ( x ) ((x)->pure_stack)

Definition at line 425 of file memory.c.

Referenced by MEM_POOL_Alloc_P(), MEM_POOL_Delete(), MEM_POOL_FREE(), MEM_POOL_Initialize_P(), MEM_POOL_Pop_P(), MEM_POOL_Push_P(), and MEM_POOL_Realloc_P().

#define MEM_POOL_rest ( x ) ((x)->rest)

Definition at line 424 of file memory.c.

Referenced by MEM_POOL_Delete(), MEM_POOL_Initialize_P(), MEM_STAT_In_List(), and MEM_Trace().

#define MEM_PURE_STACK_last_alloc ( x ) ((x)->last_alloc)

Definition at line 405 of file memory.c.

Referenced by MEM_POOL_FREE(), MEM_POOL_Push_P(), and MEM_POOL_Realloc_P().

#define MEM_PURE_STACK_prev_stack ( x ) ((x)->prev_stack)

Definition at line 406 of file memory.c.

Referenced by MEM_POOL_FREE(), MEM_POOL_Push_P(), and MEM_POOL_Realloc_P().

#define MEM_STAT_count ( x ) ((x)->count)

Definition at line 317 of file memory.c.

Referenced by MEM_POOL_Report(), and Site_Account_Alloc().

#define MEM_STAT_current ( x ) ((x)->current)

Definition at line 311 of file memory.c.

Referenced by MEM_POOL_Report(), Site_Account_Alloc(), Site_Account_Pop(), and Site_Account_Push().

#define MEM_STAT_file ( x ) ((x)->file)

Definition at line 308 of file memory.c.

Referenced by Hash_Get(), MEM_POOL_Report(), and Site_Account_Alloc().

#define MEM_STAT_hash_list_rest ( x ) ((x)->hash_list_rest)

Definition at line 318 of file memory.c.

Referenced by Hash_Get(), and Site_Account_Alloc().

#define MEM_STAT_last ( x ) ((x)->last)

Definition at line 314 of file memory.c.

Referenced by Site_Account_Alloc().

#define MEM_STAT_last_grew ( x ) ((x)->last_grew)

Definition at line 315 of file memory.c.

Referenced by MEM_POOL_Report(), and Site_Account_Alloc().

#define MEM_STAT_last_shrank ( x ) ((x)->last_shrank)

Definition at line 316 of file memory.c.

Referenced by MEM_POOL_Report(), and Site_Account_Alloc().

#define MEM_STAT_line ( x ) ((x)->line)

Definition at line 309 of file memory.c.

Referenced by Hash_Get(), MEM_POOL_Report(), and Site_Account_Alloc().

#define MEM_STAT_max_s ( x ) ((x)->max_s)

Definition at line 313 of file memory.c.

Referenced by MEM_POOL_Report(), and Site_Account_Alloc().

#define MEM_STAT_max_t ( x ) ((x)->max_t)

Definition at line 312 of file memory.c.

Referenced by MEM_POOL_Report(), MEM_STAT_Sort(), and Site_Account_Alloc().

#define MEM_STAT_pool ( x ) ((x)->pool)

Definition at line 321 of file memory.c.

Referenced by Hash_Get(), and Site_Account_Alloc().

#define MEM_STAT_pool_list_rest ( x ) ((x)->pool_list_rest)

Definition at line 319 of file memory.c.

Referenced by MEM_POOL_Report(), Site_Account_Alloc(), Site_Account_Pop(), and Site_Account_Push().

#define MEM_STAT_saved_current ( x ) ((x)->saved_current)

Definition at line 320 of file memory.c.

Referenced by Site_Account_Pop(), and Site_Account_Push().

#define MEM_STAT_total ( x ) ((x)->total)

Definition at line 310 of file memory.c.

Referenced by MEM_POOL_Report(), and Site_Account_Alloc().

#define MIN_LARGE_BLOCK_SIZE 0x800

Definition at line 110 of file memory.c.

Referenced by MEM_POOL_Realloc_P(), and Raw_Allocate().

#define N_BUCKETS 503

Definition at line 478 of file memory.c.

Referenced by Hash().

#define PAD_TO_ALIGN ( size ) (((size) + 7) & (~0U << 3))

Definition at line 465 of file memory.c.

Referenced by Allocate_Block(), MEM_POOL_Alloc_P(), and MEM_POOL_Realloc_P().

#define REDZONE_SIZE redzone_size

Definition at line 91 of file memory.c.

Referenced by MEM_POOL_Initialize_P(), MEM_POOL_Pop_P(), MEM_POOL_Push_P(), and Raw_Allocate().

Typedef Documentation

typedef struct int_list INT_LIST

Definition at line 243 of file memory.c.

typedef struct mem_large_block MEM_LARGE_BLOCK

Definition at line 183 of file memory.c.

typedef INT(* QSORT_FUNC)(const void *, const void *)

Definition at line 720 of file memory.c.

Function Documentation

static MEM_PTR Allocate_Block ( MEM_POOL * pool ) [static]

Definition at line 997 of file memory.c.

References BZERO, EC_No_Mem, ErrMsg(), fprintf(), malloc, MEM_BLOCK_avail, MEM_BLOCK_first_ptr, MEM_BLOCK_ptr, MEM_BLOCK_rest, MEM_POOL_block, MEM_POOL_bz, MEM_POOL_name, memset, NULL, PAD_TO_ALIGN, TFile, and UINT64.

Referenced by Raw_Allocate().

static MEM_PTR Allocate_Large_Block	(	MEM_POOL *	pool,
		INT32	size
	)			`[static]`

Definition at line 1054 of file memory.c.

References BZERO, EC_No_Mem, ErrMsg(), malloc, MEM_LARGE_BLOCK_base, MEM_LARGE_BLOCK_next, MEM_LARGE_BLOCK_OVERHEAD, MEM_LARGE_BLOCK_prev, MEM_LARGE_BLOCK_ptr, MEM_POOL_blocks, MEM_POOL_bz, MEM_POOL_large_block, memset, and NULL.

Referenced by Raw_Allocate().

static INT32 Field_Size ( INT32 i ) [static]

Definition at line 694 of file memory.c.

References sprintf(), and strlen().

Referenced by MEM_POOL_Report().

static UINT32 Hash	(	INT32	line,
		const char *	file
	)			`[static]`

Definition at line 496 of file memory.c.

References N_BUCKETS, p, result, and UINT32.

Referenced by Site_Account_Alloc().

static MEM_STAT* Hash_Get	(	UINT32	hn,
		MEM_POOL *	pool,
		INT32	line,
		const char *	file
	)			`[static]`

Definition at line 528 of file memory.c.

References MEM_STAT_file, MEM_STAT_hash_list_rest, MEM_STAT_line, MEM_STAT_pool, NULL, and strcmp().

Referenced by Site_Account_Alloc().

void MEM_Initialize ( void )

Definition at line 2064 of file memory.c.

Referenced by ipa_dot_so_init(), main(), sgi_cmd_line(), WFE_Init(), and WGEN_Init().

static void MEM_LARGE_BLOCK_free ( MEM_LARGE_BLOCK * block ) [static]

Definition at line 216 of file memory.c.

References free(), and MEM_LARGE_BLOCK_zap().

Referenced by MEM_POOL_FREE(), and MEM_POOL_Pop_P().

static MEM_LARGE_BLOCK* MEM_LARGE_BLOCK_realloc	(	MEM_LARGE_BLOCK *	old_block,
		INT64	new_size
	)			`[static]`

Definition at line 223 of file memory.c.

References base, MEM_LARGE_BLOCK_base, MEM_LARGE_BLOCK_ptr, MEM_LARGE_BLOCK_zap(), new_block, NULL, ptr, and realloc.

Referenced by MEM_POOL_Realloc_P().

static void MEM_LARGE_BLOCK_zap ( MEM_LARGE_BLOCK * block ) [static]

Definition at line 209 of file memory.c.

References MEM_LARGE_BLOCK_base, MEM_LARGE_BLOCK_ptr, and NULL.

Referenced by MEM_LARGE_BLOCK_free(), and MEM_LARGE_BLOCK_realloc().

MEM_PTR MEM_POOL_Alloc_P	(	MEM_POOL *	pool,
		size_t	size
	)

Definition at line 1143 of file memory.c.

Referenced by get_can_be_reordered_types(), Handle_ty_map_and_flatten_fields::Get_unaltered_map(), SUMMARY_STRUCT_ACCESS::Init(), IPA_reorder_legality_process(), IPO_reorder_Fld_Tab(), Merge_struct_access(), and operator new().

void MEM_POOL_Delete ( MEM_POOL * pool )

Definition at line 1818 of file memory.c.

Referenced by Alloc_Regs_For_BB(), Anl_Fini(), Anl_Static_Analysis(), Automatic_Data_Distribute(), BE_symtab_free_be_scopes(), Cache_Analysis_End(), CG_DEP_Delete_Graph(), CG_End_Gcov(), CG_Fini(), CGGRP_Fini(), Clear_Common_Block_Element_Map(), Clear_Extra_Auxiliary_Tables(), Convert_x87_Regs(), Create_Unique_Defs_For_TNs(), Create_Vector_Load_Stores(), DB_Rename_Cond_TN_Finish(), Destroy_File_Header(), Doacross_Finish(), DRA_Finalize(), DRA_Processing(), dV_view_fb_cfg(), dV_view_fb_opt_cfg(), EBO_Finalize(), ARRAY_SUMMARY::Finalize(), LRANGE_SUB_MGR::Finalize(), Finalize_Access_Vals(), Finalize_Memory(), finish_idx_ops(), Fiss_Gather_Loop(), Fission_Finish(), Fix_LRA_Blues(), Free_Dominators_Memory(), free_pu_cg_resources(), Fusion_Finish(), GCM_Schedule_Region(), GRA_LIVE_Finalize_Memory(), HoistIf_Phase(), Inliner(), Inner_Fission(), ipa_driver(), IPA_Preopt_Finalize(), Is_Vectorizable_Loop(), Lego_File_Fini(), Lnoptimizer(), LWN_Process_FF_Pragmas(), Olimit_Region_Insertion(), Optimize_Copy_Usage(), Outer_Loop_Fusion_Phase(), Padding_Analysis(), Perform_Global_Schedule(), Perform_Interprocedural_Analysis(), Perform_Loop_Invariant_Code_Motion(), Perform_Loop_Optimizations(), Perform_Read_Write_Removal(), Prompf_Finish(), REGION_init(), CG_BROWSER::Sdebug(), SHACKLE_Phase(), Simd_Phase(), Stride_Region(), SWP_Bundle(), IPA_NODE::Un_Read_PU(), Vintrinsic_Fission_Phase(), W2C_Fini(), W2F_Fini(), WN_Annotate(), WN_Instrument(), Write_inline_pu(), ALIAS_MANAGER::~ALIAS_MANAGER(), CG_THR::~CG_THR(), DAG_MEM::~DAG_MEM(), DIRECTED_GRAPH16< TEDGE, TVERTEX >::~DIRECTED_GRAPH16(), FB_CFG_MEM::~FB_CFG_MEM(), GLOBAL_CYCLES_FINDER_MEM::~GLOBAL_CYCLES_FINDER_MEM(), HB_Schedule::~HB_Schedule(), IF_CONV_MEM::~IF_CONV_MEM(), INTERVAL_PROCESSOR_MEM::~INTERVAL_PROCESSOR_MEM(), LabelOpt::~LabelOpt(), OUTPUT_FUNC_START_PROFILER_MEM::~OUTPUT_FUNC_START_PROFILER_MEM(), PRDB_MEM::~PRDB_MEM(), PROFILE_MEM::~PROFILE_MEM(), REGION_LOOP_UPDATE_MEM::~REGION_LOOP_UPDATE_MEM(), REGION_TREE_MEM::~REGION_TREE_MEM(), REGIONAL_CFG_MEM::~REGIONAL_CFG_MEM(), SCC_DIRECTED_GRAPH16::~SCC_DIRECTED_GRAPH16(), SCC_FINDER_MEM::~SCC_FINDER_MEM(), SCHED_MEM::~SCHED_MEM(), SCHED_UTIL_MEM_POOL::~SCHED_UTIL_MEM_POOL(), TN_INFO_MEM::~TN_INFO_MEM(), TOPOLOGICAL_REGIONAL_CFG_ITER_MEM::~TOPOLOGICAL_REGIONAL_CFG_ITER_MEM(), WN_Verifier::~WN_Verifier(), and WOVP::~WOVP().

void MEM_POOL_FREE	(	MEM_POOL *	pool,
		void *	data
	)

Definition at line 1726 of file memory.c.

void MEM_POOL_Initialize_P	(	MEM_POOL *	pool,
		const char *	name,
		BOOL	bzero
	)

Definition at line 1919 of file memory.c.

References BOOL, bzero(), Default_Mem_Pool, DevWarn, FALSE, MAGIC_NUM, Malloc_Mem_Pool, MEM_POOL_alloc_site_list, MEM_POOL_blocks, MEM_POOL_bz, MEM_POOL_frozen, MEM_POOL_INIT_IN_PROGRESS, MEM_POOL_magic_num, MEM_POOL_name, MEM_POOL_pure_stack, MEM_POOL_Push, MEM_POOL_rest, MEM_STAT_In_List(), mem_tracing_enabled, NULL, printf(), PURIFY_OPT_Initialize(), purify_pools, purify_pools_trace_x, redzone_size, REDZONE_SIZE, and TRUE.

void MEM_POOL_Pop_P ( MEM_POOL * pool )

Definition at line 1559 of file memory.c.

Referenced by MEM_POOL_Pop_Unfreeze_P().

void MEM_POOL_Pop_Unfreeze_P ( MEM_POOL * pool )

Definition at line 1705 of file memory.c.

void MEM_POOL_Push_Freeze_P ( MEM_POOL * pool )

Definition at line 1529 of file memory.c.

void MEM_POOL_Push_P ( MEM_POOL * pool )

Definition at line 1421 of file memory.c.

Referenced by MEM_POOL_Push_Freeze_P().

MEM_PTR MEM_POOL_Realloc_P	(	MEM_POOL *	pool,
		MEM_PTR	old_block,
		size_t	old_size,
		size_t	new_size
	)

Definition at line 1216 of file memory.c.

INT32 MEM_POOL_Report	(	MEM_POOL *	pool,
		INT32	used_total
	)

Definition at line 773 of file memory.c.

References Field_Size(), fprintf(), i, INT, INT32, Is_True, MAGIC_NUM, Max(), MEM_POOL_alloc_site_list, MEM_POOL_magic_num, MEM_POOL_name, MEM_POOL_Pop, MEM_POOL_Push, MEM_STAT_count, MEM_STAT_current, MEM_STAT_file, MEM_STAT_last_grew, MEM_STAT_last_shrank, MEM_STAT_line, MEM_STAT_max_s, MEM_STAT_max_t, MEM_STAT_pool_list_rest, MEM_STAT_Sort(), MEM_STAT_total, NULL, qsort(), TFile, and TYPE_MEM_POOL_ALLOC_N.

Referenced by MEM_Trace().

void MEM_POOL_Set_Default ( MEM_POOL * pool )

Definition at line 1721 of file memory.c.

Referenced by COST_TABLE::COST_TABLE(), DEPV_LIST::Eliminate_Inner_Carried(), DEPV_LIST::Eliminate_Inner_Carried_Or_All_Equals(), DEPV_LIST::Eliminate_Non_Distance_Carried_By(), DEPV_LIST::Normalize_Step(), COST_TABLE::Realloc(), DEPV_LIST::Remove_Duplicates(), ACCESS_VECTOR::~ACCESS_VECTOR(), ARRAY_REF_LIST::~ARRAY_REF_LIST(), BINARY_TREE< BINARY_NODE >::~BINARY_TREE(), and DEPV_LIST::~DEPV_LIST().

static BOOL MEM_STAT_In_List	(	MEM_POOL *	list,
		MEM_POOL *	pool
	)			`[static]`

Definition at line 744 of file memory.c.

References FALSE, MEM_POOL_rest, NULL, and TRUE.

Referenced by MEM_POOL_Delete(), and MEM_POOL_Initialize_P().

static INT MEM_STAT_Sort	(	MEM_STAT **	as1p,
		MEM_STAT **	as2p
	)			`[static]`

Definition at line 723 of file memory.c.

References MEM_STAT_max_t.

Referenced by MEM_POOL_Report().

void MEM_Trace ( void )

Definition at line 901 of file memory.c.

Referenced by Inline_Call(), Inline_callees_into_caller(), Inliner(), Ipl_Processing(), main(), Perform_Interprocedural_Analysis(), Perform_Interprocedural_Optimization(), ETABLE::Perform_LPRE_optimization(), ETABLE::Perform_PRE_optimization(), ETABLE::Perform_SPRE_optimization(), ETABLE::Perform_VNFRE_optimization(), and Trace_Memory_Allocation().

void MEM_Tracing_Enable ( void )

Definition at line 971 of file memory.c.

Referenced by CG_PU_Initialize(), main(), ETABLE::Perform_LPRE_optimization(), ETABLE::Perform_PRE_optimization(), ETABLE::Perform_SPRE_optimization(), Process_Command_Line(), and Process_IPA_Options().

static void PURIFY_OPT_Initialize ( void ) [static]

Definition at line 2007 of file memory.c.

References BOOL, DevWarn, FALSE, getenv(), initialized, purify_pools, purify_pools_trace, purify_pools_trace_x, and TRUE.

Referenced by MEM_POOL_Initialize_P().

static MEM_PTR Raw_Allocate	(	MEM_POOL *	pool,
		INT32	size
	)			`[static]`

Definition at line 1099 of file memory.c.

References Allocate_Block(), Allocate_Large_Block(), b, MEM_BLOCK_avail, MEM_BLOCK_ptr, MEM_POOL_block, MEM_POOL_blocks, MIN_LARGE_BLOCK_SIZE, NULL, REDZONE_SIZE, and result.

Referenced by MEM_POOL_Alloc_P(), and MEM_POOL_Realloc_P().

MEM_PTR Re_Calloc	(	MEM_PTR	ptr,
		INT32	new_nelem,
		INT32	elsize,
		INT32	old_nelem
	)

Definition at line 2208 of file memory.c.

MEM_PTR Realloc_Clear	(	MEM_PTR	ptr,
		INT32	new_size,
		INT32	old_size
	)

Definition at line 2158 of file memory.c.

Referenced by Re_Calloc().

static void Site_Account_Alloc	(	MEM_POOL *	pool,
		size_t	old_size,
		size_t	new_size
	)			`[static]`

Definition at line 568 of file memory.c.

References calloc(), Hash(), Hash_Get(), INT32, Max(), MEM_POOL_alloc_site_list, MEM_STAT_count, MEM_STAT_current, MEM_STAT_file, MEM_STAT_hash_list_rest, MEM_STAT_last, MEM_STAT_last_grew, MEM_STAT_last_shrank, MEM_STAT_line, MEM_STAT_max_s, MEM_STAT_max_t, MEM_STAT_pool, MEM_STAT_pool_list_rest, MEM_STAT_total, NULL, size, and UINT32.

Referenced by MEM_POOL_Alloc_P(), and MEM_POOL_Realloc_P().

static void Site_Account_Pop ( MEM_POOL * pool ) [static]

Definition at line 617 of file memory.c.

References INT_LIST_first, INT_LIST_rest, MEM_POOL_alloc_site_list, MEM_STAT_current, MEM_STAT_pool_list_rest, MEM_STAT_saved_current, NULL, and tmp.

Referenced by MEM_POOL_Pop_P().

static void Site_Account_Push ( MEM_POOL * pool ) [static]

Definition at line 657 of file memory.c.

References INT_LIST_first, INT_LIST_rest, MEM_POOL_alloc_site_list, MEM_STAT_current, MEM_STAT_pool_list_rest, MEM_STAT_saved_current, NULL, and TYPE_MEM_POOL_ALLOC.

Referenced by MEM_POOL_Push_P().

void Trace_Memory_Allocation	(	const INT	phase,
		const char *const	pname
	)

Definition at line 949 of file memory.c.

Referenced by Check_for_Dump().

Variable Documentation

MEM_STAT* call_site_hash_tab[N_BUCKETS] [static]

Definition at line 480 of file memory.c.

INT_LIST* free_int_lists [static]

Definition at line 255 of file memory.c.

MEM_POOL_BLOCKS* free_mem_pool_blocks_list [static]

Definition at line 439 of file memory.c.

MEM_POOL MEM_local_nz_pool

Definition at line 140 of file memory.c.

Referenced by Add_To_Live_Set(), Append_Succ(), Build_Complement_Interference_Graph(), Calculate_Component_Max_Costs_And_Min_Recurrence_II(), Calculate_Dominators(), Calculate_Interfering_GTNs(), Calculate_Min_Resource_II(), CFLOW_Optimize(), CG_Edge_Profile_Annotation(), CG_LOOP_Calculate_Max_Costs_And_Min_II(), CG_LOOP_Calculate_Min_Resource_II(), CG_PU_Finalize(), CG_PU_Initialize(), CG_SCHED_EST_BB_Cycles(), CG_SCHED_EST_Region_Cycles(), Cloned_Gain(), Complement_Copy(), Compute_Frequencies(), COST_VEC_Add_Cost(), COST_VEC_Initialize(), GRA_BB::Create_Global_Interferences(), Create_LUNITs(), CG_LOOP::Determine_SWP_Unroll_Factor(), Finalize_Compute_BB_Frequencies(), Fix_Interference(), Generate_Hot_Cold_Jump(), Initialize_BB_Info(), Initialize_Compute_BB_Frequencies(), Initialize_Freq_Edges(), Initialize_Wired_LRANGEs(), LRANGE::Interferes(), Is_Region(), ListVar_RefCount(), Loop_Amenable_For_SWP(), LOOP_DESCR_Estimate_Cycles(), LRANGE_Split(), Make_Fine_Grained_Interferences(), Move_Restore_Out_Of_LRANGE(), Move_Spill_Code_Above_Region(), Move_Spill_Out_Of_LRANGE(), Optimize_Placement(), Scan_Complement_BB_For_Referenced_TNs(), Unroll_Dowhile_Loop(), unroll_multi_bb(), and Wired_TN_Reference().

MEM_POOL* MEM_local_nz_pool_ptr = &MEM_local_nz_pool

Definition at line 145 of file memory.c.

Referenced by Copy_edge_cprop_annot(), Evaluate_actuals(), IP_WRITE_pu_internal(), Perform_Interprocedural_Analysis(), output_queue::push(), and Write_PU_Info().

MEM_POOL MEM_local_pool

Definition at line 126 of file memory.c.

Referenced by Add_Fail_TNs(), Add_MEM_Arcs(), Add_Scheduling_Notes_For_Loops(), WB_BROWSER::Ancestors(), BB_REGION_Calculate_Dominators(), BB_SET_Calculate_Dominators(), butterfly_loop_with_profile(), Calculate_Control_Dependences(), Calculate_Path_Data(), Can_Be_Tail_Call(), Can_OP_Move(), CG_Generate_Code(), CG_PU_Finalize(), CG_PU_Initialize(), Check_for_Cycles(), Check_HB_For_PQS_Suitability(), Check_QuadWord_Boundary_Absolute(), Check_Region_Recur(), Compute_Frequencies(), Copy_BB_For_Tail_Duplication(), GRA_PARA_REGION_MGR::Create(), Create_Live_BB_Sets(), CG_LOOP::EBO_After_Unrolling(), CG_LOOP::EBO_Before_Unrolling(), EBO_Finish(), EBO_Post_Process_Region(), EBO_Start(), EMT_Emit_PU(), Enumerate_Paths(), Estimate_Callee_Saves(), GRA_PARA_REGION_MGR::Finalize(), Finalize_Compute_BB_Frequencies(), Finalize_Memory(), Find_BB_TNs(), Find_Candicate_OP(), Fix_LRA_Blues(), Force_If_Convert(), Form_General_Region(), Form_Hyperblocks(), Freq_Order_Blocks(), GCM_Fill_Branch_Delay_Slots(), GCM_For_Loop(), generate_loop_butterfly_zones(), Get_Freq_Data_For_BB(), Get_Local_TN_For_Global(), GRA_LIVE_Rename_TNs(), Handle_All_Hazards(), HB_Block_Select(), HB_Form_Hyperblocks(), HB_Identify_General_Candidates(), HB_Identify_Hammock_Candidates(), HB_If_Convert(), HB_Remove_Deleted_Blocks(), IGLS_Schedule_Region(), GRA_PARA_REGION_MGR::Initialize(), Initialize_Compute_BB_Frequencies(), Initialize_Freq_Edges(), Initialize_Memory(), initialize_region_stack(), Inliner(), Insert_Predicates(), Insert_Spills_Of_Globals(), IPA_Preoptimize(), Ipl_Processing(), IPO_Process_node(), IR_reader_finish(), IR_reader_init(), mark_prolog_epilog_bbs(), Normalize_BB_Frequencies(), OP_To_Move(), WB_BROWSER::Parent(), Path_Resources_Available(), Perform_Global_Optimization(), Perform_Loop_Nest_Optimization(), Perform_Post_GCM_Steps(), Perform_Preopt_Optimization(), Perform_SWP(), Print_Prompf_Preopt_Transaction_Log(), region_stack_push(), remove_prolog_or_epilog_bbs(), Rename_TNs_For_BB(), Replace_Size16_Instr(), Schedule_BB_For_GCM(), Select_Blocks(), SL1_patch(), SNL_Change_Reduction_Loop_Stmts(), Split_BB(), OPT_PU_POINTS_TO_SUMMARIZER::Summarize_points_to(), Update_GRA_Live_Sets(), CFG::Verify_cfg(), verify_flow_graph(), DU_MANAGER::Verify_wn_in_tree(), Visit_BB_Preds(), WB_ancestors(), and WB_parent().

MEM_POOL* MEM_local_pool_ptr = &MEM_local_pool

Definition at line 131 of file memory.c.

Referenced by IPAA::Do_Simple_IPAA(), LOOP_MULTIVER::LOOP_MULTIVER(), Trace_Callgraph(), VHO_Lower_Switch(), and VHO_Switch_Generate_Compgoto().

MEM_POOL mem_overhead_pool [static]

Initial value:

 
{
    "memory overhead",
    &overhead_blocks,
    NULL,
    NULL,
    TRUE,
    FALSE,
    MAGIC_NUM,
    NULL
}

Definition at line 447 of file memory.c.

MEM_POOL MEM_phase_nz_pool

Definition at line 143 of file memory.c.

Referenced by _OP_MAP_Create(), CG_LOOP_Backpatch_Add(), CG_LOOP_Init_Op(), CG_PU_Finalize(), CG_PU_Initialize(), hash_entry_create(), hash_table_create(), Unroll_Do_Loop(), Unroll_Do_Loop_Fully(), and Unroll_Dowhile_Loop().

MEM_POOL* MEM_phase_nz_pool_ptr = &MEM_phase_nz_pool

Definition at line 148 of file memory.c.

Referenced by Perform_Interprocedural_Analysis().

MEM_POOL MEM_phase_pool

Definition at line 129 of file memory.c.

Referenced by Acquire_Region_Info(), REGION_INFO_MGR::Acquire_Rgn_Info(), BB_MAP_grow(), Calculate_Dominator_Info(), CG_PU_Finalize(), CG_PU_Initialize(), hash_table_create(), PQSCG_init(), PQSCG_term(), REGION_MAP_grow(), Set_OP_To_WN_Map(), Whirl2ops_Initialize(), and Workaround_Dom_Info_For_In_Abnormal_Loop_Rgn().

MEM_POOL* MEM_phase_pool_ptr = &MEM_phase_pool

Definition at line 134 of file memory.c.

MEM_POOL MEM_pu_nz_pool

Definition at line 142 of file memory.c.

Referenced by COMMENT_Add(), KEY_SCH::Gen_PKE(), KEY_SCH::Loop_Preconditioning(), note_not_unrolled(), note_remainder_head(), and Save_Cur_PU_Name().

MEM_POOL MEM_pu_pool

Definition at line 128 of file memory.c.

Referenced by Add_General_Region_To_Tree(), Add_Scheduling_Note(), Add_Scheduling_Notes_For_Loops(), Append_Succ(), Attempt_Merge(), Backend_Processing(), Build_CFG(), CG_Generate_Code(), Convert_Goto_To_Return(), Copy_BB_For_Tail_Duplication(), defop_set(), Delete_PRDB(), Divide_BB(), Do_WOPT_and_CG_with_Regions(), EETARG_Generate_PIC_Entry_Code(), Gen_Literal_TN(), Gen_Symbol_TN(), Generate_Exit(), Generate_PRDB(), Generate_Unique_Exit(), GRA_LIVE_Initialize_Memory(), Handle_Chk_Split_Bunch(), Handle_Entry(), HB_Add_BBs_And_Map(), HB_Add_Block(), HB_Add_Block_And_Map(), HB_Blocks_Copy(), HB_CFLOW_Replace_Block(), HB_Identify_Hammock_Candidates(), Inliner(), IPFEC_Build_Skiplist(), LOCAL_SPILLS_Get_Spill_Location(), Merge_Blocks(), IF_CONVERTOR::Merge_Blocks(), NOTE_Add_To_BB(), OPS_Create(), Optimize_Tail_Calls(), Preprocess_PU(), Realloc_Preg_To_TN_Arrays(), REGION_Form_Region_Tree(), RGN_Divide_BB(), Split_BB(), TN_MAP_Set(), and Update_Local_Liveness_Info().

MEM_POOL* MEM_pu_pool_ptr = &MEM_pu_pool

Definition at line 133 of file memory.c.

Referenced by Create_MicroTask(), DRA_Add_Clone(), KEY_SCH::Gen_Kernel_Info(), IPA_Create_Builtins(), IPA_NODE_CONTEXT::IPA_NODE_CONTEXT(), IPO_Clone(), ir_all(), ir_b2a_process_PUs(), ir_sel(), lower_bit_field_id(), Postprocess_PU(), Preprocess_PU(), SWP_Emit(), and IPA_NODE_CONTEXT::~IPA_NODE_CONTEXT().

MEM_POOL MEM_src_nz_pool

Definition at line 141 of file memory.c.

Referenced by main(), OPTIONS_STACK::Pop_Current_Options(), and OPTIONS_STACK::Push_Current_Options().

MEM_POOL* MEM_src_nz_pool_ptr = &MEM_src_nz_pool

Definition at line 146 of file memory.c.

MEM_POOL* MEM_src_pool_ptr = &MEM_src_pool

Definition at line 132 of file memory.c.

Referenced by create_ipa_internal_name(), DST_enter_cloned_childs(), IPA_NODE_CONTEXT::IPA_NODE_CONTEXT(), new_block(), New_DST(), and IPA_NODE_CONTEXT::~IPA_NODE_CONTEXT().

BOOL mem_tracing_enabled = FALSE [static]

Definition at line 470 of file memory.c.

Referenced by MEM_POOL_Alloc_P(), MEM_POOL_Delete(), MEM_POOL_Initialize_P(), MEM_POOL_Pop_P(), MEM_POOL_Push_P(), MEM_POOL_Realloc_P(), and MEM_Tracing_Enable().

MEM_POOL_BLOCKS overhead_blocks [static]

Definition at line 443 of file memory.c.

BOOL purify_pools = FALSE

Definition at line 411 of file memory.c.

Referenced by MEM_Initialize(), MEM_POOL_Alloc_P(), MEM_POOL_Delete(), MEM_POOL_FREE(), MEM_POOL_Initialize_P(), MEM_POOL_Pop_P(), MEM_POOL_Push_P(), MEM_POOL_Realloc_P(), and PURIFY_OPT_Initialize().

BOOL purify_pools_trace = FALSE [static]

Definition at line 412 of file memory.c.

Referenced by MEM_Initialize(), MEM_POOL_Alloc_P(), MEM_POOL_FREE(), MEM_POOL_Pop_P(), MEM_POOL_Realloc_P(), PURIFY_OPT_Initialize(), and Realloc_Clear().

BOOL purify_pools_trace_x = FALSE [static]

Definition at line 413 of file memory.c.

Referenced by MEM_Initialize(), MEM_POOL_Delete(), MEM_POOL_Initialize_P(), MEM_POOL_Pop_P(), MEM_POOL_Pop_Unfreeze_P(), MEM_POOL_Push_Freeze_P(), MEM_POOL_Push_P(), and PURIFY_OPT_Initialize().

int redzone_size = 0 [static]

Definition at line 90 of file memory.c.

Referenced by MEM_POOL_Initialize_P().

MEM_POOL* The_Default_Mem_Pool [static]

Definition at line 461 of file memory.c.


Data Types
type	mem_block
type	mem_large_block
type	int_list
type	mem_stat
type	mem_pool_blocks
type	mem_pure_stack
Defines
#define	REDZONE_SIZE redzone_size
#define	MEM_POOL_INIT_IN_PROGRESS (-1)
#define	BLOCK_SIZE 0x2000
#define	MIN_LARGE_BLOCK_SIZE 0x800
#define	MEM_BLOCK_avail(x) ((x)->avail)
#define	MEM_BLOCK_ptr(x) ((x)->ptr)
#define	MEM_BLOCK_rest(x) ((x)->rest)
#define	MEM_BLOCK_first_ptr(x) (MEM_PTR) (((char *) (x)) + PAD_TO_ALIGN(sizeof(MEM_BLOCK)))
#define	MEM_LARGE_BLOCK_next(x) ((x)->next)
#define	MEM_LARGE_BLOCK_prev(x) ((x)->prev)
#define	MEM_LARGE_BLOCK_base(x) ((x)->base)
#define	MEM_LARGE_BLOCK_ptr(x) ((x)->ptr)
#define	MEM_LARGE_BLOCK_OVERHEAD (PAD_TO_ALIGN(sizeof(MEM_LARGE_BLOCK)))
#define	INT_LIST_first(x) ((x)->first)
#define	INT_LIST_rest(x) ((x)->rest)
#define	MEM_STAT_file(x) ((x)->file)
#define	MEM_STAT_line(x) ((x)->line)
#define	MEM_STAT_total(x) ((x)->total)
#define	MEM_STAT_current(x) ((x)->current)
#define	MEM_STAT_max_t(x) ((x)->max_t)
#define	MEM_STAT_max_s(x) ((x)->max_s)
#define	MEM_STAT_last(x) ((x)->last)
#define	MEM_STAT_last_grew(x) ((x)->last_grew)
#define	MEM_STAT_last_shrank(x) ((x)->last_shrank)
#define	MEM_STAT_count(x) ((x)->count)
#define	MEM_STAT_hash_list_rest(x) ((x)->hash_list_rest)
#define	MEM_STAT_pool_list_rest(x) ((x)->pool_list_rest)
#define	MEM_STAT_saved_current(x) ((x)->saved_current)
#define	MEM_STAT_pool(x) ((x)->pool)
#define	MEM_POOL_BLOCKS_block(x) ((x)->block)
#define	MEM_POOL_BLOCKS_large_block(x) ((x)->large_block)
#define	MEM_POOL_BLOCKS_base_block(x) ((x)->base_block)
#define	MEM_POOL_BLOCKS_base_ptr(x) ((x)->base_ptr)
#define	MEM_POOL_BLOCKS_base_avail(x) ((x)->base_avail)
#define	MEM_POOL_BLOCKS_rest(x) ((x)->rest)
#define	MEM_PURE_STACK_last_alloc(x) ((x)->last_alloc)
#define	MEM_PURE_STACK_prev_stack(x) ((x)->prev_stack)
#define	MEM_POOL_last_alloc(x) MEM_PURE_STACK_last_alloc(MEM_POOL_pure_stack(x))
#define	MEM_POOL_prev_stack(x) MEM_PURE_STACK_prev_stack(MEM_POOL_pure_stack(x))
#define	MAGIC_NUM 0xabcd
#define	MEM_POOL_name(x) ((x)->name)
#define	MEM_POOL_blocks(x) ((x)->blocks)
#define	MEM_POOL_bz(x) ((x)->bz)
#define	MEM_POOL_rest(x) ((x)->rest)
#define	MEM_POOL_pure_stack(x) ((x)->pure_stack)
#define	MEM_POOL_frozen(x) ((x)->frozen)
#define	MEM_POOL_magic_num(x) ((x)->magic_num)
#define	MEM_POOL_alloc_site_list(x) ((x)->alloc_site_list)
#define	MEM_POOL_block(x) MEM_POOL_BLOCKS_block(MEM_POOL_blocks(x))
#define	MEM_POOL_large_block(x) MEM_POOL_BLOCKS_large_block(MEM_POOL_blocks(x))
#define	PAD_TO_ALIGN(size) (((size) + 7) & (~0U << 3))
#define	N_BUCKETS 503
Typedefs
typedef struct mem_large_block	MEM_LARGE_BLOCK
typedef struct int_list	INT_LIST
typedef INT(*	QSORT_FUNC )(const void , const void )
Functions/Subroutines
static void	MEM_LARGE_BLOCK_zap (MEM_LARGE_BLOCK *block)
static void	MEM_LARGE_BLOCK_free (MEM_LARGE_BLOCK *block)
static MEM_LARGE_BLOCK *	MEM_LARGE_BLOCK_realloc (MEM_LARGE_BLOCK *old_block, INT64 new_size)
static void	PURIFY_OPT_Initialize (void)
static UINT32	Hash (INT32 line, const char *file)
static MEM_STAT *	Hash_Get (UINT32 hn, MEM_POOL pool, INT32 line, const char file)
static void	Site_Account_Alloc (MEM_POOL *pool, size_t old_size, size_t new_size)
static void	Site_Account_Pop (MEM_POOL *pool)
static void	Site_Account_Push (MEM_POOL *pool)
static INT32	Field_Size (INT32 i)
static INT	MEM_STAT_Sort (MEM_STAT as1p, MEM_STAT as2p)
static BOOL	MEM_STAT_In_List (MEM_POOL list, MEM_POOL pool)
INT32	MEM_POOL_Report (MEM_POOL *pool, INT32 used_total)
void	MEM_Trace (void)
void	Trace_Memory_Allocation (const INT phase, const char *const pname)
void	MEM_Tracing_Enable (void)
static MEM_PTR	Allocate_Block (MEM_POOL *pool)
static MEM_PTR	Allocate_Large_Block (MEM_POOL *pool, INT32 size)
static MEM_PTR	Raw_Allocate (MEM_POOL *pool, INT32 size)
MEM_PTR	MEM_POOL_Alloc_P (MEM_POOL *pool, size_t size)
MEM_PTR	MEM_POOL_Realloc_P (MEM_POOL *pool, MEM_PTR old_block, size_t old_size, size_t new_size)
void	MEM_POOL_Push_P (MEM_POOL *pool)
void	MEM_POOL_Push_Freeze_P (MEM_POOL *pool)
void	MEM_POOL_Pop_P (MEM_POOL *pool)
void	MEM_POOL_Pop_Unfreeze_P (MEM_POOL *pool)
void	MEM_POOL_Set_Default (MEM_POOL *pool)
void	MEM_POOL_FREE (MEM_POOL pool, void data)
void	MEM_POOL_Delete (MEM_POOL *pool)
void	MEM_POOL_Initialize_P (MEM_POOL pool, const char name, BOOL bzero)
void	MEM_Initialize (void)
MEM_PTR	Realloc_Clear (MEM_PTR ptr, INT32 new_size, INT32 old_size)
MEM_PTR	Re_Calloc (MEM_PTR ptr, INT32 new_nelem, INT32 elsize, INT32 old_nelem)
Variables
static int	redzone_size = 0
MEM_POOL	MEM_local_pool
MEM_POOL	MEM_src_pool
MEM_POOL	MEM_pu_pool
MEM_POOL	MEM_phase_pool
MEM_POOL *	MEM_local_pool_ptr = &MEM_local_pool
MEM_POOL *	MEM_src_pool_ptr = &MEM_src_pool
MEM_POOL *	MEM_pu_pool_ptr = &MEM_pu_pool
MEM_POOL *	MEM_phase_pool_ptr = &MEM_phase_pool
MEM_POOL	MEM_local_nz_pool
MEM_POOL	MEM_src_nz_pool
MEM_POOL	MEM_pu_nz_pool
MEM_POOL	MEM_phase_nz_pool
MEM_POOL *	MEM_local_nz_pool_ptr = &MEM_local_nz_pool
MEM_POOL *	MEM_src_nz_pool_ptr = &MEM_src_nz_pool
MEM_POOL *	MEM_pu_nz_pool_ptr = &MEM_pu_nz_pool
MEM_POOL *	MEM_phase_nz_pool_ptr = &MEM_phase_nz_pool
static INT_LIST *	free_int_lists
BOOL	purify_pools = FALSE
static BOOL	purify_pools_trace = FALSE
static BOOL	purify_pools_trace_x = FALSE
static MEM_POOL_BLOCKS *	free_mem_pool_blocks_list
static MEM_POOL_BLOCKS	overhead_blocks
static MEM_POOL	mem_overhead_pool
static MEM_POOL *	The_Default_Mem_Pool
static BOOL	mem_tracing_enabled = FALSE
static MEM_STAT *	call_site_hash_tab [N_BUCKETS]

osprey/common/util/memory.c File Reference

Data Types

Defines

Typedefs

Functions/Subroutines

Variables

Define Documentation

Typedef Documentation

Function Documentation

Variable Documentation