Module: GC

Defined in:
gc.c

Overview

The GC module provides an interface to Ruby's mark and sweep garbage collection mechanism. Some of the underlying methods are also available via the ObjectSpace module.

You may obtain information about the operation of the GC through GC::Profiler.

Defined Under Namespace

Modules: Profiler

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.count ⇒ Integer

The number of times GC occurred.

It returns the number of times GC occurred since the process started.

Returns:




# File 'gc.c'

static VALUE
gc_count(VALUE self)
{
    return UINT2NUM((&rb_objspace)->count);
}

.disable ⇒ Boolean

Disables garbage collection, returning true if garbage collection was already disabled.

GC.disable   #=> false
GC.disable   #=> true

Returns:

  • (Boolean) 



# File 'gc.c'

VALUE
rb_gc_disable(void)
{
    rb_objspace_t *objspace = &rb_objspace;
    int old = dont_gc;

    dont_gc = TRUE;
    return old ? Qtrue : Qfalse;
}

.enable ⇒ Boolean

Enables garbage collection, returning true if garbage collection was previously disabled.

GC.disable   #=> false
GC.enable    #=> true
GC.enable    #=> false

Returns:

  • (Boolean) 



# File 'gc.c'

VALUE
rb_gc_enable(void)
{
    rb_objspace_t *objspace = &rb_objspace;
    int old = dont_gc;

    dont_gc = FALSE;
    return old ? Qtrue : Qfalse;
}

.malloc_allocated_size ⇒ Integer

The allocated size by malloc().

It returns the allocated size by malloc().

Returns:




# File 'gc.c'

static VALUE
gc_malloc_allocated_size(VALUE self)
{
    return UINT2NUM((&rb_objspace)->malloc_params.allocated_size);
}

.malloc_allocations ⇒ Integer

The number of allocated memory object by malloc().

It returns the number of allocated memory object by malloc().

Returns:




# File 'gc.c'

static VALUE
gc_malloc_allocations(VALUE self)
{
    return UINT2NUM((&rb_objspace)->malloc_params.allocations);
}

.start ⇒ nil .garbage_collect ⇒ nil .garbage_collect ⇒ nil

Initiates garbage collection, unless manually disabled.

Overloads:

  • .start ⇒ nil

    Returns:

    • (nil)
  • .garbage_collect ⇒ nil

    Returns:

    • (nil)
  • .garbage_collect ⇒ nil

    Returns:

    • (nil) 



# File 'gc.c'

VALUE
rb_gc_start(void)
{
    rb_gc();
    return Qnil;
}

.stat ⇒ Hash

Returns a Hash containing information about the GC.

The hash includes information about internal statistics about GC such as:

{
  :count          => 18,
  :heap_used      => 77,
  :heap_length    => 77,
  :heap_increment => 0,
  :heap_live_num  => 23287,
  :heap_free_num  => 8115,
  :heap_final_num => 0,
}

The contents of the hash are implementation defined and may be changed in the future.

This method is only expected to work on C Ruby.

Returns:




# File 'gc.c'

static VALUE
gc_stat(int argc, VALUE *argv, VALUE self)
{
rb_objspace_t *objspace = &rb_objspace;
VALUE hash;

if (rb_scan_args(argc, argv, "01", &hash) == 1) {
    if (TYPE(hash) != T_HASH)
        rb_raise(rb_eTypeError, "non-hash given");
}

.stress ⇒ Boolean

returns current status of GC stress mode.

Returns:

  • (Boolean) 



# File 'gc.c'

static VALUE
gc_stress_get(VALUE self)
{
    rb_objspace_t *objspace = &rb_objspace;
    return ruby_gc_stress ? Qtrue : Qfalse;
}

.stress=(bool) ⇒ Boolean

Updates the GC stress mode.

When stress mode is enabled the GC is invoked at every GC opportunity: all memory and object allocations.

Enabling stress mode makes Ruby very slow, it is only for debugging.

Returns:

  • (Boolean) 



# File 'gc.c'

static VALUE
gc_stress_set(VALUE self, VALUE flag)
{
    rb_objspace_t *objspace = &rb_objspace;
    rb_secure(2);
    ruby_gc_stress = RTEST(flag);
    return flag;
}

Instance Method Details

#start ⇒ nil #garbage_collect ⇒ nil #garbage_collect ⇒ nil

Initiates garbage collection, unless manually disabled.

Overloads:

  • #start ⇒ nil

    Returns:

    • (nil)
  • #garbage_collect ⇒ nil

    Returns:

    • (nil)
  • #garbage_collect ⇒ nil

    Returns:

    • (nil) 



# File 'gc.c'

VALUE
rb_gc_start(void)
{
    rb_gc();
    return Qnil;
}