note
	description: "[
		Garbage collector statistics.
		This class may be used as ancestor by classes needing its facilities.
		Time accounting is relevant only if enable_time_accounting 
		(from MEMORY) has been called.
	]"
	library: "Free implementation of ELKS library"
	status: "See notice at end of class."
	legal: "See notice at end of class."
	date: "$Date: 2017-12-26 18:35:31 +0000 (Tue, 26 Dec 2017) $"
	revision: "$Revision: 101217 $"

class interface
	GC_INFO

create 
	make (memory: INTEGER_32)
			-- Fill in statistics for memory type
		require
			memory_valid: memory = Incremental_collector or memory = Full_collector
		ensure
			type_set: type = memory

feature -- Initialization

	make (memory: INTEGER_32)
			-- Fill in statistics for memory type
		require
			memory_valid: memory = Incremental_collector or memory = Full_collector
		ensure
			type_set: type = memory

	structure_make
			-- Initialize current with given structure_size.
			-- (from MEMORY_STRUCTURE)
		ensure -- from MEMORY_STRUCTURE
			not_shared: not shared

	make_by_pointer (a_ptr: POINTER)
			-- Initialize current with a_ptr.
			-- (from MEMORY_STRUCTURE)
		require -- from MEMORY_STRUCTURE
			a_ptr_not_null: a_ptr /= default_pointer
		ensure -- from MEMORY_STRUCTURE
			shared: shared

	update (memory: INTEGER_32)
			-- Fill in statistics for memory type
		require
			memory_valid: memory = Incremental_collector or memory = Full_collector
		ensure
			type_set: type = memory
	
feature -- Access

	C_memory: INTEGER_32 = 2
			-- Code for the C memory managed
			-- by the garbage collector
			-- (from MEM_CONST)

	collected: INTEGER_32
			-- Number of bytes collected by the last cycle,
			-- for type before last call to update

	collected_average: INTEGER_32
			-- Average number of bytes collected by a cycle,
			-- for type before last call to update

	cpu_interval_time: REAL_64
			-- Amount of CPU time elapsed since between last
			-- and penultimate cycles for type before
			-- last call to update

	cpu_interval_time_average: REAL_64
			-- Average amount of CPU time between two cycles,
			-- for type before last call to update

	cpu_time: REAL_64
			-- Amount of CPU time, in seconds, spent in cycle,
			-- for type before last call to update

	cpu_time_average: REAL_64
			-- Average amount of CPU time spent in cycle,
			-- in seconds, for type before last call to update

	cpu_total_time: REAL_64
			-- Amount of application CPU time, in seconds, for type before last call to update

	cycle_count: INTEGER_32
			-- Number of collection cycles for type
			-- before last call to update

	Eiffel_memory: INTEGER_32 = 1
			-- Code for the Eiffel memory managed
			-- by the garbage collector
			-- (from MEM_CONST)

	Full_collector: INTEGER_32 = 0
			-- Statistics for full collections
			-- (from MEM_CONST)

	generating_type: TYPE [detachable GC_INFO]
			-- Type of current object
			-- (type of which it is a direct instance)
			-- (from ANY)
		ensure -- from ANY
			generating_type_not_void: Result /= Void

	generator: STRING_8
			-- Name of current object's generating class
			-- (base class of the type of which it is a direct instance)
			-- (from ANY)
		ensure -- from ANY
			generator_not_void: Result /= Void
			generator_not_empty: not Result.is_empty

	Incremental_collector: INTEGER_32 = 1
			-- Statistics for incremental collections
			-- (from MEM_CONST)

	item: POINTER
			-- Access to memory area.
			-- (from MEMORY_STRUCTURE)

	memory_used: INTEGER_32
			-- Total number of bytes used (counting overhead)
			-- after last cycle for type before last
			-- call to update

	real_interval_time: INTEGER_32
			-- Real interval time (as opposed to CPU time) between
			-- two automatically raised cycles, in centi-seconds,
			-- for type before last call to update

	real_interval_time_average: INTEGER_32
			-- Average real interval time between two automatic
			-- cycles, in centi-seconds,
			-- for type before last call to update

	real_time: INTEGER_32
			-- Real time in centi-seconds used by last cycle
			-- for type, before last call to update;
			-- this may not be accurate on systems which do not
			-- provide a sub-second accuracy clock (typically
			-- provided on BSD).

	real_time_average: INTEGER_32
			-- Average amount of real time, in centi-seconds,
			-- spent in collection cycle,
			-- for type before last call to update

	shared: BOOLEAN
			-- Is current memory area shared with others?
			-- (from MEMORY_STRUCTURE)

	sys_interval_time: REAL_64
			-- Amount of kernel time elapsed since between
			-- the last and the penultimate cycle,
			-- for type before last call to update

	sys_interval_time_average: REAL_64
			-- Average amount of kernel time between two cycles,
			-- for type before last call to update

	sys_time: REAL_64
			-- Amount of kernel time, in seconds, spent in cycle,
			-- for type before last call to update

	sys_time_average: REAL_64
			-- Average amount of kernel time spent in cycle,
			-- for type before last call to update

	sys_total_time: REAL_64
			-- Amount of application kernel time, in seconds, for type before last call to update

	Total_memory: INTEGER_32 = 0
			-- Code for all the memory managed
			-- by the garbage collector
			-- (from MEM_CONST)

	type: INTEGER_32
			-- Collector type (Full, Collect),
			-- for type before last call to update
	
feature -- Comparison

	frozen deep_equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void
			-- or attached to isomorphic object structures?
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			shallow_implies_deep: standard_equal (a, b) implies Result
			both_or_none_void: (a = Void) implies (Result = (b = Void))
			same_type: (Result and (a /= Void)) implies (b /= Void and then a.same_type (b))
			symmetric: Result implies deep_equal (b, a)

	frozen equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void or attached
			-- to objects considered equal?
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.is_equal (b))

	frozen is_deep_equal alias "≡≡≡" (other: GC_INFO): BOOLEAN
			-- Are Current and other attached to isomorphic object structures?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			shallow_implies_deep: standard_is_equal (other) implies Result
			same_type: Result implies same_type (other)
			symmetric: Result implies other.is_deep_equal (Current)

	is_equal (other: GC_INFO): BOOLEAN
			-- Is other attached to an object considered
			-- equal to current object?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			symmetric: Result implies other ~ Current
			consistent: standard_is_equal (other) implies Result

	frozen standard_equal (a: detachable ANY; b: like arg #1): BOOLEAN
			-- Are a and b either both void or attached to
			-- field-by-field identical objects of the same type?
			-- Always uses default object comparison criterion.
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			definition: Result = (a = Void and b = Void) or else ((a /= Void and b /= Void) and then a.standard_is_equal (b))

	frozen standard_is_equal alias "≜" (other: GC_INFO): BOOLEAN
			-- Is other attached to an object of the same type
			-- as current object, and field-by-field identical to it?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			same_type: Result implies same_type (other)
			symmetric: Result implies other.standard_is_equal (Current)
	
feature -- Status report

	conforms_to (other: ANY): BOOLEAN
			-- Does type of current object conform to type
			-- of other (as per Eiffel: The Language, chapter 13)?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void

	exists: BOOLEAN
			-- Is allocated memory still allocated?
			-- (from MEMORY_STRUCTURE)

	same_type (other: ANY): BOOLEAN
			-- Is type of current object identical to type of other?
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			definition: Result = (conforms_to (other) and other.conforms_to (Current))
	
feature -- Duplication

	copy (other: GC_INFO)
			-- Update current object using fields of object attached
			-- to other, so as to yield equal objects.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_equal: Current ~ other

	frozen deep_copy (other: GC_INFO)
			-- Effect equivalent to that of:
			--		copy (other . deep_twin)
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
		ensure -- from ANY
			deep_equal: deep_equal (Current, other)

	frozen deep_twin: GC_INFO
			-- New object structure recursively duplicated from Current.
			-- (from ANY)
		ensure -- from ANY
			deep_twin_not_void: Result /= Void
			deep_equal: deep_equal (Current, Result)

	frozen standard_copy (other: GC_INFO)
			-- Copy every field of other onto corresponding field
			-- of current object.
			-- (from ANY)
		require -- from ANY
			other_not_void: other /= Void
			type_identity: same_type (other)
		ensure -- from ANY
			is_standard_equal: standard_is_equal (other)

	frozen standard_twin: GC_INFO
			-- New object field-by-field identical to other.
			-- Always uses default copying semantics.
			-- (from ANY)
		ensure -- from ANY
			standard_twin_not_void: Result /= Void
			equal: standard_equal (Result, Current)

	frozen twin: GC_INFO
			-- New object equal to Current
			-- twin calls copy; to change copying/twinning semantics, redefine copy.
			-- (from ANY)
		ensure -- from ANY
			twin_not_void: Result /= Void
			is_equal: Result ~ Current
	
feature -- Basic operations

	frozen default: detachable GC_INFO
			-- Default value of object's type
			-- (from ANY)

	frozen default_pointer: POINTER
			-- Default value of type POINTER
			-- (Avoid the need to write p.default for
			-- some p of type POINTER.)
			-- (from ANY)
		ensure -- from ANY
			instance_free: class

	default_rescue
			-- Process exception for routines with no Rescue clause.
			-- (Default: do nothing.)
			-- (from ANY)

	frozen do_nothing
			-- Execute a null action.
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
	
feature -- Implementation

	structure_size: INTEGER_32
			-- Size of underlying C structure.
		ensure -- from MEMORY_STRUCTURE
			is_class: class
			positive_result: Result > 0
	
feature -- Output

	Io: STD_FILES
			-- Handle to standard file setup
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			io_not_void: Result /= Void

	out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- (from ANY)
		ensure -- from ANY
			out_not_void: Result /= Void

	print (o: detachable ANY)
			-- Write terse external representation of o
			-- on standard output.
			-- (from ANY)
		ensure -- from ANY
			instance_free: class

	frozen tagged_out: STRING_8
			-- New string containing terse printable representation
			-- of current object
			-- (from ANY)
		ensure -- from ANY
			tagged_out_not_void: Result /= Void
	
feature -- Platform

	Operating_environment: OPERATING_ENVIRONMENT
			-- Objects available from the operating system
			-- (from ANY)
		ensure -- from ANY
			instance_free: class
			operating_environment_not_void: Result /= Void
	
invariant
		-- from MEMORY_STRUCTURE
	managed_pointer_valid: not shared implies managed_pointer /= Void
	internal_item_valid: shared implies internal_item /= default_pointer

		-- from ANY
	reflexive_equality: standard_is_equal (Current)
	reflexive_conformance: conforms_to (Current)

note
	copyright: "Copyright (c) 1984-2017, 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 GC_INFO

Generated by ISE EiffelStudio