majo 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c68eebecd1591a5579a3c44135c7d29c7b46743c0f35c65f8ebd3b557bd78f4a
-  data.tar.gz: 5742f4feabbead870b4becbeb8c40f5591eff79541f3f70dd4aef285c1de5f0d
+  metadata.gz: 84aa655c3585c95f2e639690246b2946114208ce08b979d00d46e6a93efef60c
+  data.tar.gz: 0073efd2fd643f97219ca17be43259960cfb514ab864cbb6f0b0f9378d3f7a9f
 SHA512:
-  metadata.gz: e1e165da4e081ca6886db4631f1052bab452551b073784c90507da80d1f35672edc0a9b7ead753b32c5d1fc7884e8fe87778c76b38c0b8dbadbde417362902db
-  data.tar.gz: 24cfe454a1f38b70f7c1b12d6f4bd3a1cf94384b9f18eabe10e27907e93c5b0e8417e53d405582086571e4cd649ca14d6d4cdd05e5e5b50794ff2994cc1f077f
+  metadata.gz: 7d0cb81a092b6c0db17c5db53d2a2404fc554c1545bf8ab7b6546679ba7bd9a64e603af30e2fe7d1d5f90fe0848aebba490918d5101a179b6ac309bf21e3b878
+  data.tar.gz: 630052b3e6c3558c7ce2628a17528518e3770188fca26b26ff1f51a69c6d3d14e339b03814a93173ed134e6565d4e6f1aa1a07249961a70360c8903949943889

data/ARCHITECTURE.md

@@ -0,0 +1,25 @@
+# Architecture of Majo
+
+Majo uses internal TracePoint hooks, `RUBY_INTERNAL_EVENT_NEWOBJ` and `RUBY_INTERNAL_EVENT_FREEOBJ`, to trace object allocation and free events.
+We can use `ObjectSpace.trace_object_allocations_start` method in the Ruby-level, but this API is not suitable for Majo because it does not provide information about freed objects. Therefore, Majo uses these hooks in the C-level.
+
+## On allocation event
+
+When an object is allocated, Majo records the object into a st table with the path, line number, and so on.
+
+See `newobj_i` function in `majo.c`.
+
+## On free event
+
+When an object is freed, Majo moves the allocation information to an array from the st table if it's a long-lived object.
+It determines whether the object is long-lived by checking the GC count. If the object is not swept by a GC sweeping phase, it's a long-lived object.
+
+See `freeobj_i` function in `majo.c`.
+
+## Output format
+
+Majo provides three output formats: `color`, `monochrome`, and `csv`.
+
+`color` and `monochrome` are for human-readable output. They provide overview information about long-lived objects.
+
+`csv` is for machine-readable output. It provides the raw information. You can use this format to analyze the result with other tools.

data/README.md

@@ -37,10 +37,10 @@ result.report
 
 You can pass the following options to `report` method.
 
-| Name        | Description              | Default   | Type                                                                     |
-| ----------- | ------------------------ | --------- | ------------------------------------------------------------------------ |
-| `out`       | Output file or IO        | `$stdout` | `IO`, `String` or an object having `to_path` method (such as `Pathname`) |
-| `formatter` | The format of the result | `:color`  | `:color`, or `:csv`                                                      |
+| Name        | Description              | Default                  | Type                                                                     |
+| ----------- | ------------------------ | ------------------------ | ------------------------------------------------------------------------ |
+| `out`       | Output file or IO        | `$stdout`                | `IO`, `String` or an object having `to_path` method (such as `Pathname`) |
+| `formatter` | The format of the result | `:color` or `monochrome` | `:color`, `:monochrome`, or `:csv`                                       |
 
 For example:
 

data/ext/majo/allocation_info.c

@@ -2,13 +2,12 @@
 
 static void majo_allocation_info_mark(void *ptr)
 {
-  // TODO
   majo_allocation_info *info = (majo_allocation_info*)ptr;
+  rb_gc_mark(info->result);
 }
 
 static void majo_allocation_info_free(majo_allocation_info *info) {
-  // TODO
-  ruby_xfree(info);
+  free(info);
 }
 
 static size_t majo_allocation_info_memsize(const void *ptr) {

data/ext/majo/allocation_info.h

@@ -11,6 +11,8 @@ typedef struct {
   size_t alloc_generation;
   size_t free_generation;
   size_t memsize;
+
+  VALUE result;
 } majo_allocation_info;
 
 VALUE

data/ext/majo/majo.c

@@ -39,7 +39,8 @@ internal_object_p(VALUE obj)
 static void
 newobj_i(VALUE tpval, void *data)
 {
-  majo_result *arg = (majo_result *)data;
+  VALUE res = (VALUE)data;
+  majo_result *arg = majo_check_result(res);
 
   rb_trace_arg_t *tparg = rb_tracearg_from_tracepoint(tpval);
   VALUE obj = rb_tracearg_object(tparg);
@@ -53,7 +54,6 @@ newobj_i(VALUE tpval, void *data)
   VALUE mid = rb_tracearg_method_id(tparg);
   VALUE klass = rb_tracearg_defined_class(tparg);
 
-  // TODO: when the st already has an entry for the value
   majo_allocation_info *info = (majo_allocation_info *)malloc(sizeof(majo_allocation_info));
 
   const char *path_cstr = RTEST(path) ? majo_make_unique_str(arg->str_table, RSTRING_PTR(path), RSTRING_LEN(path)) : 0;
@@ -66,6 +66,7 @@ newobj_i(VALUE tpval, void *data)
   const char *obj_class_path_cstr = RTEST(obj_class_path) ? majo_make_unique_str(arg->str_table, RSTRING_PTR(obj_class_path), RSTRING_LEN(obj_class_path)) : 0;
 
 
+  info->result = res;
   info->path = path_cstr;
   info->line = NUM2INT(line);
   info->mid = mid;
@@ -84,11 +85,9 @@ freeobj_i(VALUE tpval, void *data)
   st_data_t obj = (st_data_t)rb_tracearg_object(tparg);
   st_data_t v;
 
-  // TODO refcount of the strings
   if (st_delete(arg->object_table, &obj, &v)) {
     majo_allocation_info *info = (majo_allocation_info *)v;
     size_t gc_count = rb_gc_count();
-    // Reject it for majo
     if (info->alloc_generation < gc_count-1) {
       info->memsize = rb_obj_memsize_of((VALUE)obj);
       info->free_generation = gc_count;
@@ -110,7 +109,7 @@ start(VALUE self) {
   VALUE stack = rb_ivar_get(rb_mMajo, running_tracer_stack);
   rb_ary_push(stack, res);
 
-  arg->newobj_trace = rb_tracepoint_new(0, RUBY_INTERNAL_EVENT_NEWOBJ, newobj_i, arg);
+  arg->newobj_trace = rb_tracepoint_new(0, RUBY_INTERNAL_EVENT_NEWOBJ, newobj_i, (void *)res);
   arg->freeobj_trace = rb_tracepoint_new(0, RUBY_INTERNAL_EVENT_FREEOBJ, freeobj_i, arg);
 
   rb_tracepoint_enable(arg->newobj_trace);

data/ext/majo/result.c

@@ -7,14 +7,35 @@ static void majo_result_mark(void *ptr)
   rb_gc_mark(arg->freeobj_trace);
 }
 
+static int
+free_st_key(st_data_t key, st_data_t value, st_data_t data)
+{
+    free((void *)key);
+    return ST_CONTINUE;
+}
+
+static int
+free_st_value(st_data_t key, st_data_t value, st_data_t data)
+{
+    free((void *)value);
+    return ST_CONTINUE;
+}
+
 static void majo_result_free(majo_result *arg) {
-  // TODO
-  ruby_xfree(arg);
+  st_foreach(arg->object_table, free_st_value, 0);
+  st_free_table(arg->object_table);
+
+  st_foreach(arg->str_table, free_st_key, 0);
+  st_free_table(arg->str_table);
+
+  rb_darray_free(arg->olds);
+
+  free(arg);
 }
 
 static size_t majo_result_memsize(const void *ptr) {
-  // TODO
-  return sizeof(majo_result);
+  majo_result *res = (majo_result*)ptr;
+  return sizeof(majo_result) + st_memsize(res->object_table) + st_memsize(res->str_table) + rb_darray_capa(res->olds) * sizeof(majo_allocation_info);
 }
 
 static rb_data_type_t result_type = {

data/lib/majo/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Majo
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: majo
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Masataka Pocke Kuwabara
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-22 00:00:00.000000000 Z
+date: 2024-07-25 00:00:00.000000000 Z
 dependencies: []
 description: A memory profiler focusing on long-lived objects.
 email:
@@ -19,6 +20,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ARCHITECTURE.md
 - LICENSE
 - README.md
 - Rakefile
@@ -48,6 +50,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/pocke/majo
   source_code_uri: https://github.com/pocke/majo
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -62,7 +65,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.0.dev
+rubygems_version: 3.5.11
+signing_key:
 specification_version: 4
 summary: A memory profiler focusing on long-lived objects.
 test_files: []