note description: "[ Facilities for tuning up the garbage collection mechanism. This class may be used as ancestor by classes needing its facilities. ]" library: "Free implementation of ELKS library" status: "See notice at end of class." legal: "See notice at end of class." date: "$Date: 2018-04-28 20:47:46 +0000 (Sat, 28 Apr 2018) $" revision: "$Revision: 101696 $" class interface MEMORY create default_create feature -- Measurement memory_statistics (memory_type: INTEGER_32): MEM_INFO -- Memory usage information for memory_type require type_ok: memory_type = Total_memory or memory_type = Eiffel_memory or memory_type = C_memory ensure instance_free: class gc_statistics (collector_type: INTEGER_32): GC_INFO -- Garbage collection information for collector_type. require type_ok: collector_type = Full_collector or collector_type = Incremental_collector ensure instance_free: class feature -- Status report memory_threshold: INTEGER_32 -- Minimum amount of bytes to be allocated before -- starting an automatic garbage collection. ensure instance_free: class collection_period: INTEGER_32 -- Period of full collection. -- If the environment variable EIF_FULL_COLLECTION_PERIOD -- is defined, it is set to the closest reasonable -- value from it. -- If null, no full collection is launched. ensure instance_free: class coalesce_period: INTEGER_32 -- Period of full coalesce (in number of collections) -- If the environment variable EIF_FULL_COALESCE_PERIOD -- is defined, it is set to the closest reasonable -- value from it. -- If null, no full coalescing is launched. ensure instance_free: class collecting: BOOLEAN -- Is garbage collection enabled? ensure instance_free: class largest_coalesced_block: INTEGER_32 -- Size of largest coalesced block since last call to -- largest_coalesced; 0 if none. ensure instance_free: class max_mem: INTEGER_32 -- Maximum amount of bytes the run-time can allocate. ensure instance_free: class chunk_size: INTEGER_32 -- Minimal size of a memory chunk. The run-time always -- allocates a multiple of this size. -- If the environment variable EIF_MEMORY_CHUNK -- is defined, it is set to the closest reasonable -- value from it. ensure instance_free: class tenure: INTEGER_32 -- Maximum age of object before being considered -- as old (old objects are not scanned during -- partial collection). -- If the environment variable EIF_TENURE_MAX -- is defined, it is set to the closest reasonable -- value from it. ensure instance_free: class generation_object_limit: INTEGER_32 -- Maximum size of object in generational scavenge zone. -- If the environment variable EIF_GS_LIMIT -- is defined, it is set to the closest reasonable -- value from it. ensure instance_free: class scavenge_zone_size: INTEGER_32 -- Size of generational scavenge zone. -- If the environment variable EIF_MEMORY_SCAVENGE -- is defined, it is set to the closest reasonable -- value from it. ensure instance_free: class referers (an_object: ANY): SPECIAL [ANY] -- Objects that refer to an_object. ensure instance_free: class objects_instance_of (an_object: ANY): SPECIAL [ANY] -- Objects that have same dynamic type as an_object. ensure instance_free: class objects_instance_of_type (a_type_id: INTEGER_32): SPECIAL [ANY] -- Objects that have same dynamic type as an_object. ensure instance_free: class memory_map: HASH_TABLE [ARRAYED_LIST [ANY], INTEGER_32] -- Retrieves all object in system as a table indexed by dynamic type -- where elements are all instances of a given data type. ensure instance_free: class memory_count_map: HASH_TABLE [INTEGER_32, INTEGER_32] -- Number of instances per dynamic type present in system. -- Same as memory_map except that no references on the objects themselves -- is kept. ensure instance_free: class feature -- Status setting execute_without_collection (a_action: PROCEDURE) -- Execute a_action with the garbage collector disabled. -- If a_action modifies the status of collecting, we restore -- it no matter what at the end. require a_action_not_void: a_action /= Void ensure instance_free: class collection_status_preserved: collecting = old collecting collection_off -- Disable garbage collection. ensure instance_free: class collection_on -- Enable garbage collection. ensure instance_free: class allocate_fast -- Enter speed mode: will optimize speed of memory -- allocation rather than memory usage. ensure instance_free: class allocate_compact -- Enter memory mode: will try to compact memory -- before requesting more from the operating system. ensure instance_free: class allocate_tiny -- Enter tiny mode: will enter memory mode -- after having freed as much memory as possible. ensure instance_free: class enable_time_accounting -- Enable GC time accouting, accessible in gc_statistics. ensure instance_free: class disable_time_accounting -- Disable GC time accounting (default). ensure instance_free: class set_memory_threshold (value: INTEGER_32) -- Set a new memory_threshold in bytes. Whenever the memory -- allocated for Eiffel reaches this value, an automatic -- collection is performed. require positive_value: value > 0 ensure instance_free: class set_collection_period (value: INTEGER_32) -- Set collection_period. Every value collection, -- the Garbage collector will perform a collection -- on the whole memory (full collection), otherwise -- a simple partial collection is done. require positive_value: value >= 0 ensure instance_free: class set_coalesce_period (value: INTEGER_32) -- Set coalesce_period. Every value collection, -- the Garbage Collector will coalesce -- the whole memory. require positive_value: value >= 0 ensure instance_free: class set_max_mem (value: INTEGER_32) -- Set the maximum amount of memory the run-time can allocate. require positive_value: value > 0 ensure instance_free: class feature -- Removal dispose -- Action to be executed just before garbage collection -- reclaims an object. -- Default version does nothing; redefine in descendants -- to perform specific dispose actions. Those actions -- should only take care of freeing external resources; -- they should not perform remote calls on other objects -- since these may also be dead and reclaimed. free (object: ANY) -- Free object, by-passing garbage collection. -- Erratic behavior will result if the object is still -- referenced. ensure instance_free: class full_coalesce -- Coalesce the whole memory: merge adjacent free -- blocks to reduce fragmentation. Useful, when -- a lot of memory is allocated with garbage collector off. ensure instance_free: class collect -- Force a partial collection cycle if garbage -- collection is enabled; do nothing otherwise. ensure instance_free: class full_collect -- Force a full collection cycle if garbage -- collection is enabled; do nothing otherwise. ensure instance_free: class note copyright: "Copyright (c) 1984-2018, Eiffel Software and others" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" source: "[ Eiffel Software 5949 Hollister Ave., Goleta, CA 93117 USA Telephone 805-685-1006, Fax 805-685-6869 Website http://www.eiffel.com Customer support http://support.eiffel.com ]" end -- class MEMORY
Generated by ISE EiffelStudio