heapfrag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 34f0655dc516fcf2b46445069a24b10871962966
+  data.tar.gz: fe35bcbbcc206e612d765991edf93cc064f4accb
+SHA512:
+  metadata.gz: f93c5c5986cd36f7ac8f5653c43dd0a3ecd5911ca7c7c17662fac68212101bcaecfe18ed1bf409169043d0bacde12ffc3275b63d7b56c02716274bde71045913
+  data.tar.gz: acb058f1591b5103f22c83e03fc91d7c578a1c9b68ced49a0a40829f83da19a2e7c8b5cf04a62604fdd030f50702dc8455fdaca8f8c95cbc945c62388cbfe153

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.4.10

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.10
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in heapfrag.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ivan Prisyazhnyy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Heapfrag
+
+This tool allows to measure a fragmentation of the Ruby VM heap.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'heapfrag'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install heapfrag
+
+## Usage
+
+    > require "heapfrag"
+    > Heapfrag::stat
+
+    {
+      :fragmented_pages=>146,
+      :pages_total=>154,
+      :pages_seen=>154,
+      :pages_with_alive=>154,
+      :pages_with_dead=>146,
+      :pages_free=>0,
+      :pages_full=>8,
+      :objs_alive=>47812,
+      :objs_dead=>14961,
+                             0% 50% 95%  99% 99.9% 100%
+      :heap_pages_fill_cdf=>[0, 22, 116, 133, 142, 154]
+    }
+
+## Quick start
+
+    $ rake compile && echo 'require "heapfrag"; Heapfrag::stat' | irb
+    install -c tmp/x86_64-linux/heapfrag/2.4.10/heapfrag.so lib/heapfrag/heapfrag.so
+    cp tmp/x86_64-linux/heapfrag/2.4.10/heapfrag.so tmp/x86_64-linux/stage/lib/heapfrag/heapfrag.so
+    Switch to inspect mode.
+    require "heapfrag"; Heapfrag::stat
+    {:fragmented_pages=>146, :pages_total=>154, :pages_seen=>154, :pages_with_alive=>154, :pages_with_dead=>146, :pages_free=>0, :pages_full=>8, :objs_alive=>47812, :objs_dead=>14961, :heap_pages_fill_cdf=>[0, 22, 116, 133, 142, 154]}
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sitano/heapfrag. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rake/extensiontask"
+
+task :build => :compile
+
+Rake::ExtensionTask.new("heapfrag") do |ext|
+  ext.lib_dir = "lib/heapfrag"
+end
+
+task :default => [:clobber, :compile, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "heapfrag"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ext/heapfrag/extconf.rb

@@ -0,0 +1,3 @@
+require "mkmf"
+
+create_makefile("heapfrag/heapfrag")

data/ext/heapfrag/heapfrag.c

@@ -0,0 +1,133 @@
+#include "heapfrag.h"
+
+// #include <stdio.h>
+
+VALUE rb_mHeapfrag;
+
+VALUE sym_fragmented_pages;
+VALUE sym_pages_total;
+VALUE sym_pages_seen;
+VALUE sym_pages_walive;
+VALUE sym_pages_wdead;
+VALUE sym_pages_free;
+VALUE sym_pages_full;
+VALUE sym_alive_objs;
+VALUE sym_dead_objs;
+VALUE sym_heap_allocated_pages;
+VALUE sym_pages_fill_cdf;
+
+static size_t cdf_levels[] = {
+  1,                                // 0
+  HEAP_PAGE_OBJ_LIMIT * 50  / 100,  // 50%
+  HEAP_PAGE_OBJ_LIMIT * 95  / 100,  // 95%
+  HEAP_PAGE_OBJ_LIMIT * 99  / 100,  // 99%
+  HEAP_PAGE_OBJ_LIMIT * 999 / 1000, // 99.9%
+  HEAP_PAGE_OBJ_LIMIT               // inf+
+};
+
+struct heap_info {
+  size_t pages_seen;
+  size_t pages_walive;
+  size_t pages_wdead;
+  size_t pages_free;
+  size_t pages_full;
+  size_t alive_objs;
+  size_t dead_objs;
+  size_t cdf[sizeof(cdf_levels) / sizeof(size_t)];
+};
+
+static void
+insert_cdf(struct heap_info *info, size_t val)
+{
+  static size_t size = sizeof(cdf_levels) / sizeof(size_t);
+
+  for (size_t i = 0; i < size; i ++) {
+    if (val < cdf_levels[i]) {
+      info->cdf[i] ++;
+    }
+  }
+
+  if (val >= cdf_levels[size - 1]) {
+    info->cdf[size - 1] ++;
+  }
+}
+
+static int
+count_objects_i(void *vstart, void *vend, size_t stride, void *data)
+{
+  struct heap_info *info = (struct  heap_info *)data;
+  VALUE v = (VALUE)vstart;
+  size_t alive = 0;
+  size_t dead = 0;
+
+  for (; v != (VALUE)vend; v += stride) {
+    if (RBASIC(v)->flags) {
+      alive ++;
+    } else {
+      dead ++;
+    }
+  }
+
+  info->pages_seen ++;
+  info->alive_objs += alive;
+  info->dead_objs += dead;
+  if (alive) {
+    info->pages_walive ++;
+  } else {
+    info->pages_free ++;
+  }
+  if (dead) {
+    info->pages_wdead ++;
+  } else {
+    info->pages_full ++;
+  }
+
+  insert_cdf(info, alive);
+
+  // printf("%ld / %ld: %p - %p = (%ld)\n", alive, dead, vstart, vend, (vend-vstart)/40);
+
+  return 0;
+}
+
+static VALUE
+heapfrag_stat(VALUE mod)
+{
+  struct heap_info info = {};
+  VALUE rv = rb_hash_new();
+  size_t total_pages = rb_gc_stat(sym_heap_allocated_pages);
+
+  rb_objspace_each_objects(count_objects_i, &info);
+  rb_hash_aset(rv, sym_fragmented_pages, INT2FIX(total_pages - info.pages_full - info.pages_free));
+  rb_hash_aset(rv, sym_pages_total, INT2FIX(total_pages));
+  rb_hash_aset(rv, sym_pages_seen, INT2FIX(info.pages_seen));
+  rb_hash_aset(rv, sym_pages_walive, INT2FIX(info.pages_walive));
+  rb_hash_aset(rv, sym_pages_wdead, INT2FIX(info.pages_wdead));
+  rb_hash_aset(rv, sym_pages_free, INT2FIX(info.pages_free));
+  rb_hash_aset(rv, sym_pages_full, INT2FIX(info.pages_full));
+  rb_hash_aset(rv, sym_alive_objs, INT2FIX(info.alive_objs));
+  rb_hash_aset(rv, sym_dead_objs, INT2FIX(info.dead_objs));
+  rb_hash_aset(rv, sym_pages_fill_cdf,
+               rb_ary_new_from_args(6, INT2FIX(info.cdf[0]), INT2FIX(info.cdf[1]), INT2FIX(info.cdf[2]),
+                                    INT2FIX(info.cdf[3]), INT2FIX(info.cdf[4]), INT2FIX(info.cdf[5])));
+
+  return rv;
+}
+
+void
+Init_heapfrag(void)
+{
+  rb_mHeapfrag = rb_define_module("Heapfrag");
+  rb_define_singleton_method(rb_mHeapfrag, "stat", heapfrag_stat, 0);
+
+  sym_fragmented_pages = ID2SYM(rb_intern("fragmented_pages"));
+  sym_pages_total = ID2SYM(rb_intern("pages_total"));
+  sym_pages_seen = ID2SYM(rb_intern("pages_seen"));
+  sym_pages_walive = ID2SYM(rb_intern("pages_with_alive"));
+  sym_pages_wdead = ID2SYM(rb_intern("pages_with_dead"));
+  sym_pages_free = ID2SYM(rb_intern("pages_free"));
+  sym_pages_full = ID2SYM(rb_intern("pages_full"));
+  sym_alive_objs = ID2SYM(rb_intern("objs_alive"));
+  sym_dead_objs = ID2SYM(rb_intern("objs_dead"));
+  sym_heap_allocated_pages = ID2SYM(rb_intern("heap_allocated_pages"));
+  sym_pages_fill_cdf = ID2SYM(rb_intern("heap_pages_fill_cdf"));
+}

data/ext/heapfrag/heapfrag.h

@@ -0,0 +1,27 @@
+#ifndef HEAPFRAG_H
+#define HEAPFRAG_H 1
+
+#include "ruby.h"
+
+void rb_objspace_each_objects(
+    int (*callback)(void *start, void *end, size_t stride, void *data),
+    void *data);
+
+size_t rb_gc_stat(VALUE hash_or_sym);
+
+#ifndef HEAP_PAGE_ALIGN_LOG
+/* default tiny heap size: 16KB */
+#define HEAP_PAGE_ALIGN_LOG 14
+#endif
+
+enum {
+  HEAP_PAGE_ALIGN = (1UL << HEAP_PAGE_ALIGN_LOG),
+  HEAP_PAGE_ALIGN_MASK = (~(~0UL << HEAP_PAGE_ALIGN_LOG)),
+  REQUIRED_SIZE_BY_MALLOC = (sizeof(size_t) * 5),
+  HEAP_PAGE_SIZE = (HEAP_PAGE_ALIGN - REQUIRED_SIZE_BY_MALLOC),
+  HEAP_PAGE_HEADER_SIZE = sizeof(void *),
+  RVALUE_SIZE = 40,
+  HEAP_PAGE_OBJ_LIMIT = (unsigned int)((HEAP_PAGE_SIZE - HEAP_PAGE_HEADER_SIZE)/RVALUE_SIZE)
+};
+
+#endif

data/heapfrag.gemspec

@@ -0,0 +1,44 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "heapfrag/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "heapfrag"
+  spec.version       = Heapfrag::VERSION
+  spec.authors       = ["Ivan Prisyazhnyy"]
+  spec.email         = ["john.koepi@gmail.com"]
+
+  spec.summary       = "This tool allows to measure a fragmentation of the Ruby VM heap."
+  # spec.description   = %q{Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/sitano/heapfrag"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "Set to 'http://mygemserver.com'"
+
+     spec.metadata["homepage_uri"] = spec.homepage
+     spec.metadata["source_code_uri"] = "https://github.com/sitano/heapfrag"
+    # spec.metadata["changelog_uri"] = "Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions    = ["ext/heapfrag/extconf.rb"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake-compiler"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/heapfrag/version.rb

@@ -0,0 +1,3 @@
+module Heapfrag
+  VERSION = "0.1.0"
+end

data/lib/heapfrag.rb

@@ -0,0 +1,7 @@
+require "heapfrag/version"
+require "heapfrag/heapfrag"
+
+module Heapfrag
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: heapfrag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Prisyazhnyy
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- john.koepi@gmail.com
+executables: []
+extensions:
+- ext/heapfrag/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".tool-versions"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ext/heapfrag/extconf.rb
+- ext/heapfrag/heapfrag.c
+- ext/heapfrag/heapfrag.h
+- heapfrag.gemspec
+- lib/heapfrag.rb
+- lib/heapfrag/version.rb
+homepage: https://github.com/sitano/heapfrag
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sitano/heapfrag
+  source_code_uri: https://github.com/sitano/heapfrag
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.6.14.4
+signing_key:
+specification_version: 4
+summary: This tool allows to measure a fragmentation of the Ruby VM heap.
+test_files: []