Skip to content

Commit b18ee90

Browse files
authored
Merge pull request #144 from wks/feature/ruby-mmtk-harness
Bindings for MMTK harness_begin and harness_end
2 parents 87522f3 + ab7fb6e commit b18ee90

4 files changed

Lines changed: 72 additions & 0 deletions

File tree

‎gc/mmtk/mmtk.c‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -751,6 +751,41 @@ rb_gc_impl_zjit_writebarrier_required_offset(void)
751751
return -1;
752752
}
753753

754+
/*
755+
* call-seq:
756+
* GC::MMTk.harness_begin
757+
*
758+
* A hook to be called before a benchmark begins.
759+
*
760+
* MMTk will do necessary preparations (such as triggering a full-heap GC)
761+
* and start collecting statistic data, such as the number of GC triggered,
762+
* time spent in GC, time spent in mutator, etc.
763+
*/
764+
static VALUE
765+
rb_mmtk_harness_begin(VALUE _)
766+
{
767+
mmtk_harness_begin(rb_gc_get_ractor_newobj_cache());
768+
769+
return Qnil;
770+
}
771+
772+
/*
773+
* call-seq:
774+
* GC::MMTk.harness_end
775+
*
776+
* A hook to be called after a benchmark ends.
777+
*
778+
* When this method is called, MMTk will stop collecting statistic data and
779+
* print out the data already collected.
780+
*/
781+
VALUE
782+
rb_mmtk_harness_end(VALUE _)
783+
{
784+
mmtk_harness_end();
785+
786+
return Qnil;
787+
}
788+
754789
void
755790
rb_gc_impl_init(void)
756791
{
@@ -771,6 +806,10 @@ rb_gc_impl_init(void)
771806
rb_define_singleton_method(rb_mGC, "auto_compact=", rb_f_notimplement, 1);
772807
rb_define_singleton_method(rb_mGC, "latest_compact_info", rb_f_notimplement, 0);
773808
rb_define_singleton_method(rb_mGC, "verify_compaction_references", rb_f_notimplement, -1);
809+
810+
VALUE rb_mMMTk = rb_define_module_under(rb_mGC, "MMTk");
811+
rb_define_singleton_method(rb_mMMTk, "harness_begin", rb_mmtk_harness_begin, 0);
812+
rb_define_singleton_method(rb_mMMTk, "harness_end", rb_mmtk_harness_end, 0);
774813
}
775814

776815
int

‎gc/mmtk/mmtk.h‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,10 @@ size_t mmtk_heap_min(void);
157157

158158
size_t mmtk_heap_max(void);
159159

160+
void mmtk_harness_begin(MMTk_VMMutatorThread tls);
161+
162+
void mmtk_harness_end(void);
163+
160164
bool mmtk_is_mmtk_object(MMTk_Address addr);
161165

162166
extern void rb_mmtk_init_gc_worker_thread(struct MMTk_GCThreadTLS *gc_worker_tls);

‎gc/mmtk/src/api.rs‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -577,6 +577,18 @@ pub extern "C" fn mmtk_heap_max() -> usize {
577577
}
578578
}
579579

580+
// =============== Measurement ===============
581+
582+
#[unsafe(no_mangle)]
583+
pub extern "C" fn mmtk_harness_begin(tls: VMMutatorThread) {
584+
memory_manager::harness_begin::<Ruby>(crate::BINDING.get().unwrap().mmtk, tls);
585+
}
586+
587+
#[unsafe(no_mangle)]
588+
pub extern "C" fn mmtk_harness_end() {
589+
memory_manager::harness_end::<Ruby>(crate::BINDING.get().unwrap().mmtk);
590+
}
591+
580592
// =============== Miscellaneous ===============
581593

582594
#[unsafe(no_mangle)]

‎test/mmtk/test_mmtk_harness.rb‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# frozen_string_literal: true
2+
3+
require_relative "helper"
4+
5+
module MMTk
6+
class TestMMTkHarness < TestCase
7+
def test_harness_begin_end_output
8+
assert_in_out_err([], <<~RUBY) do |out, _err|
9+
GC::MMTk.harness_begin
10+
GC.start
11+
GC::MMTk.harness_end
12+
RUBY
13+
assert_match(/MMTk Statistics Totals/, out.join)
14+
end
15+
end
16+
end
17+
end

0 commit comments

Comments
 (0)