Module: GC

Defined in:

gc.c

Overview

Defined Under Namespace

Modules: Profiler

Class Method Summary (collapse)

• + (Integer) count

  The number of times GC occurred.

• + (Boolean) disable

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

• + (Boolean) enable

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

• + (Integer) malloc_allocated_size

  The allocated size by malloc().

• + (Integer) malloc_allocations

  The number of allocated memory object by malloc().

• + (Object) start

  Initiates garbage collection, unless manually disabled.

• + (Hash) stat

  Returns a Hash containing information about the GC.

• + (Boolean) stress

  returns current status of GC stress mode.

• + (Boolean) stress=(bool)

  Updates the GC stress mode.

Instance Method Summary (collapse)

• - (Object) garbage_collect

  Initiates garbage collection, unless manually disabled.

# File 'gc.c'

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

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

# 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;
}

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

# 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;
}

# File 'gc.c'

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

# File 'gc.c'

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

# File 'gc.c'

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

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

# 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");
}

# File 'gc.c'

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

# 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;
}

# File 'gc.c'

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