heap-profiler 0.8.0.rc1-aarch64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f7eb31510a696d4b47aebb1d8c543f0d0af9c2d24d8a34f295e0d2accd021b2
+  data.tar.gz: c08cedbf4cf1f7d95911e2abe33dbc0870993b059625026cfa76693aff37dc29
+SHA512:
+  metadata.gz: 2af40908af944e1946ba8eff969e3a4cb3f0785df04bf366d951f5b99d89c461638a7b426c49b370c71538dcd8f29ac57a9c1f55de2f71d071a8a93834f8b13a
+  data.tar.gz: 0315f07e4c408de39e7184a3891856005782a7f76a1ba24f211a9c03bf23c6d7e15ce7b0e0b2607d891c32d0880497fa9a7dac313d656ac0cd5e3eadafdd390a

data/.github/workflows/cibuildgem.yaml

@@ -0,0 +1,87 @@
+name: "Package and release gems with precompiled binaries"
+on:
+  workflow_dispatch:
+    inputs:
+      release:
+        description: "If the whole build passes on all platforms, release the gems on RubyGems.org"
+        required: false
+        type: boolean
+        default: false
+jobs:
+  compile:
+    timeout-minutes: 20
+    name: "Cross compile the gem on different ruby versions"
+    strategy:
+      matrix:
+        os: ["macos-latest", "ubuntu-22.04", "ubuntu-22.04-arm", "macos-15-intel"]
+    runs-on: "${{ matrix.os }}"
+    steps:
+      - name: "Checkout code"
+        uses: "actions/checkout@v5"
+      - name: "Setup Ruby"
+        uses: "ruby/setup-ruby@v1"
+        with:
+          ruby-version: "3.1.7"
+          bundler-cache: true
+      - name: "Run cibuildgem"
+        uses: "shopify/cibuildgem/.github/actions/cibuildgem@main"
+        with:
+          step: "compile"
+  test:
+    timeout-minutes: 20
+    name: "Run the test suite"
+    needs: compile
+    strategy:
+      matrix:
+        os: ["macos-latest", "ubuntu-22.04", "ubuntu-22.04-arm", "macos-15-intel"]
+        rubies: ["3.1", "3.2", "3.3", "3.4", "4.0"]
+        type: ["cross", "native"]
+    runs-on: "${{ matrix.os }}"
+    steps:
+      - name: "Checkout code"
+        uses: "actions/checkout@v5"
+      - name: "Setup Ruby"
+        uses: "ruby/setup-ruby@v1"
+        with:
+          ruby-version: "${{ matrix.rubies }}"
+          bundler-cache: true
+      - name: "Run cibuildgem"
+        uses: "shopify/cibuildgem/.github/actions/cibuildgem@main"
+        with:
+          step: "test_${{ matrix.type }}"
+  install:
+    timeout-minutes: 5
+    name: "Verify the gem can be installed"
+    needs: test
+    strategy:
+      matrix:
+        os: ["macos-latest", "ubuntu-22.04", "ubuntu-22.04-arm", "macos-15-intel"]
+    runs-on: "${{ matrix.os }}"
+    steps:
+      - name: "Setup Ruby"
+        uses: "ruby/setup-ruby@v1"
+        with:
+          ruby-version: "4.0"
+      - name: "Run cibuildgem"
+        uses: "shopify/cibuildgem/.github/actions/cibuildgem@main"
+        with:
+          step: "install"
+  release:
+    environment: release
+    permissions:
+      id-token: write
+      contents: read
+    timeout-minutes: 5
+    if: ${{ inputs.release }}
+    name: "Release all gems with RubyGems"
+    needs: install
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Setup Ruby"
+        uses: "ruby/setup-ruby@v1"
+        with:
+          ruby-version: "4.0"
+      - name: "Run cibuildgem"
+        uses: "shopify/cibuildgem/.github/actions/cibuildgem@main"
+        with:
+          step: "release"

data/.github/workflows/tests.yml

@@ -0,0 +1,33 @@
+name: CI
+on: [push]
+
+jobs:
+  rubocop:
+    name: Rubocop
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+      - name: Run linters
+        run: |
+          bin/rubocop -c .rubocop.yml
+
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '3.1', '3.2', '3.3', '3.4', '4.0' ]
+    name: Ruby ${{ matrix.ruby }} Tests
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history
+*.bundle
+*.so

data/.rubocop.yml

@@ -0,0 +1,29 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml
+
+AllCops:
+  Exclude:
+    - bin/generate-report
+    - vendor/bundle/**/*
+    - ext/**/*
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: false
+
+Style/RedundantBegin:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false
+
+Lint/RescueException:
+  Enabled: false
+
+Lint/MissingSuper:
+  Enabled: false
+
+Lint/AssignmentInCondition:
+  Enabled: false
+
+Metrics/ParameterLists:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.3.1

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in heap-profiler.gemspec
+gemspec
+
+gem "rake"
+gem "rake-compiler"
+gem "minitest", "~> 5.0"
+gem "byebug"
+gem "rubocop-shopify", require: false
+gem "benchmark-ips"
+gem "stackprof"

data/Gemfile.lock

@@ -0,0 +1,69 @@
+PATH
+  remote: .
+  specs:
+    heap-profiler (0.8.0.rc1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    benchmark-ips (2.14.0)
+    byebug (12.0.0)
+    json (2.17.1)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    minitest (5.26.2)
+    parallel (1.27.0)
+    parser (3.3.10.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.6.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.1)
+    rake-compiler (1.3.0)
+      rake
+    regexp_parser (2.11.3)
+    rubocop (1.81.7)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.48.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    rubocop-shopify (1.0.7)
+      rubocop (~> 1.4)
+    ruby-progressbar (1.13.0)
+    stackprof (0.2.27)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+
+PLATFORMS
+  aarch64-linux
+  arm64-darwin-23
+  arm64-darwin-25
+  x86_64-darwin-20
+  x86_64-darwin-22
+  x86_64-darwin-24
+  x86_64-linux
+
+DEPENDENCIES
+  benchmark-ips
+  byebug
+  heap-profiler!
+  minitest (~> 5.0)
+  rake
+  rake-compiler
+  rubocop-shopify
+  stackprof
+
+BUNDLED WITH
+   2.5.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Jean Boussier
+
+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,291 @@
+# HeapProfiler
+
+A memory profiler for Ruby
+
+## Requirements
+
+Ruby(MRI) Version 2.5 and above.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'heap-profiler'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install heap-profiler
+
+## Usage
+
+### Profiling Mode
+
+HeapProfiler can be used to measure memory allocations and retentions of a Ruby code snippet.
+
+To record a profile:
+
+```ruby
+require 'heap-profiler'
+HeapProfiler.report('path/to/report/directory') do
+  # You code here
+end
+```
+
+To then analyse the profile, run the `heap-profiler` command against the directory you specified.
+Note that on large applications this can take a while, but if you are profiling a production
+application, you can download the profile directory and do the analysis on another machine.
+
+### Options
+
+```
+Usage: heap-profiler <directory_or_heap_dump> OPTIONS
+
+OPTIONS
+
+    -r, --retained-only              Only compute report for memory retentions.
+    -m, --max=NUM                    Max number of entries to output. (Defaults to 50)
+        --batch-size SIZE            Sets the simdjson parser batch size. It must be larger than the largest JSON document in the heap dump, and defaults to 10MB.
+```
+
+
+
+```bash
+$ heap-profiler path/to/report/directory
+      Total allocated: 3.72 kB (36 objects)
+      Total retained: 808.00 B (12 objects)
+
+      allocated memory by gem
+      -----------------------------------
+         3.72 kB  other
+
+      allocated memory by file
+      -----------------------------------
+         3.72 kB  bin/generate-report
+
+      allocated memory by location
+      -----------------------------------
+         3.17 kB  bin/generate-report:34
+        157.00 B  bin/generate-report:28
+         80.00 B  bin/generate-report:21
+         72.00 B  bin/generate-report:26
+         40.00 B  bin/generate-report:31
+         40.00 B  bin/generate-report:30
+         40.00 B  bin/generate-report:25
+         40.00 B  bin/generate-report:24
+         40.00 B  bin/generate-report:23
+         40.00 B  bin/generate-report:22
+
+      allocated memory by class
+      -----------------------------------
+         1.18 kB  Class
+        848.00 B  <iseq> (IMEMO)
+        597.00 B  String
+        384.00 B  <ment> (IMEMO)
+        200.00 B  Array
+        192.00 B  Hash
+         80.00 B  <ifunc> (IMEMO)
+         80.00 B  <cref> (IMEMO)
+         72.00 B  Date
+         40.00 B  Symbol
+         40.00 B  SomeCustomStuff
+
+      allocated objects by gem
+      -----------------------------------
+              36  other
+
+      allocated objects by file
+      -----------------------------------
+              36  bin/generate-report
+
+      allocated objects by location
+      -----------------------------------
+              27  bin/generate-report:34
+               1  bin/generate-report:31
+               1  bin/generate-report:30
+               1  bin/generate-report:28
+               1  bin/generate-report:26
+               1  bin/generate-report:25
+               1  bin/generate-report:24
+               1  bin/generate-report:23
+               1  bin/generate-report:22
+               1  bin/generate-report:21
+
+      allocated objects by class
+      -----------------------------------
+              12  String
+               8  <ment> (IMEMO)
+               4  Array
+               2  Class
+               2  <iseq> (IMEMO)
+               2  <ifunc> (IMEMO)
+               2  <cref> (IMEMO)
+               1  Symbol
+               1  SomeCustomStuff
+               1  Hash
+               1  Date
+
+      retained memory by gem
+      -----------------------------------
+        808.00 B  other
+
+      retained memory by file
+      -----------------------------------
+        808.00 B  bin/generate-report
+
+      retained memory by location
+      -----------------------------------
+        168.00 B  bin/generate-report:30
+        168.00 B  bin/generate-report:28
+        160.00 B  bin/generate-report:34
+         80.00 B  bin/generate-report:21
+         72.00 B  bin/generate-report:26
+         40.00 B  bin/generate-report:25
+         40.00 B  bin/generate-report:24
+         40.00 B  bin/generate-report:23
+         40.00 B  bin/generate-report:22
+
+      retained memory by class
+      -----------------------------------
+        336.00 B  Hash
+        240.00 B  String
+         80.00 B  Array
+         72.00 B  Date
+         40.00 B  Symbol
+         40.00 B  SomeCustomStuff
+
+      retained objects by gem
+      -----------------------------------
+              12  other
+
+      retained objects by file
+      -----------------------------------
+              12  bin/generate-report
+
+      retained objects by location
+      -----------------------------------
+               4  bin/generate-report:34
+               1  bin/generate-report:30
+               1  bin/generate-report:28
+               1  bin/generate-report:26
+               1  bin/generate-report:25
+               1  bin/generate-report:24
+               1  bin/generate-report:23
+               1  bin/generate-report:22
+               1  bin/generate-report:21
+
+      retained objects by class
+      -----------------------------------
+               6  String
+               2  Hash
+               1  Symbol
+               1  SomeCustomStuff
+               1  Date
+               1  Array
+
+      Allocated String Report
+      -----------------------------------
+         80.00 B       2  "foo="
+                       2  bin/generate-report:34
+
+         80.00 B       2  "foo"
+                       2  bin/generate-report:34
+
+         80.00 B       2  "bar="
+                       2  bin/generate-report:34
+
+         80.00 B       2  "I am retained"
+                       1  bin/generate-report:23
+                       1  bin/generate-report:22
+
+         40.00 B       1  "I am retained too"
+                       1  bin/generate-report:24
+
+         40.00 B       1  "I am allocated too"
+                       1  bin/generate-report:31
+
+         40.00 B       1  "I am allocated"
+                       1  bin/generate-report:30
+
+        157.00 B       1  "I am a very very long string I am a very very long string I am a very very long string I am a very very long string "
+                       1  bin/generate-report:28
+
+
+      Retained String Report
+      -----------------------------------
+         80.00 B       2  "I am retained"
+                       1  bin/generate-report:23
+                       1  bin/generate-report:22
+
+         40.00 B       1  "foo="
+                       1  bin/generate-report:34
+
+         40.00 B       1  "foo"
+                       1  bin/generate-report:34
+
+         40.00 B       1  "bar="
+                       1  bin/generate-report:34
+
+         40.00 B       1  "I am retained too"
+                       1  bin/generate-report:24
+```
+
+### Heap Analysis
+
+Alternatively if you with to analyse the entire heap of your Ruby process.
+
+If you can, you should enable allocation tracing as early as possible during your application boot process, e.g. in `config/boot.rb` for Rails apps.
+
+```ruby
+require 'objspace'
+ObjectSpace.trace_object_allocations_start
+```
+
+Then to dump the heap:
+
+```ruby
+require 'objspace'
+ObjectSpace.dump_all(output: File.open('path/to/file.heap', 'w+'))
+```
+
+Then run `heap-profiler` against it:
+
+```bash
+heap-profiler path/to/file.heap
+```
+
+## How is it different from memory_profiler?
+
+`heap-profiler` is heavilly inspired of `memory_profiler`, it aims at being as similar as possible.
+However it uses a different Ruby API to gather data.
+
+`memory_profiler` uses [`ObjectSpace.each_object`](https://ruby-doc.org/core-2.7.1/ObjectSpace.html#method-c-each_object) which contrary to what its name
+suggest doesn't expose all existing object. There are many objects that the Ruby VM consider "internal" (see MRI's `internal_object_p(VALUE)`) and won't yield to `each_object`.
+
+On the other hand `heap-profiler` uses [`ObjectSpace.dump_all`](https://ruby-doc.org/stdlib-2.7.1/libdoc/objspace/rdoc/ObjectSpace.html#method-c-dump_all), which
+does serialize every objects, including internal ones, into JSON files. This leads to more exhaustive reports.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/Shopify/heap-profiler.
+
+## Thanks
+
+This gem was heavilly inspired from http://github.com/SamSaffron/memory_profiler, it even borrowed some code from it, so thanks to [@SamSaffron](https://github.com/SamSaffron).
+
+It also makes heavy use of https://github.com/simdjson/simdjson for fast heap dump parsing. So big thanks to [Daniel Lemire](https://github.com/lemire) and [John Keiser](https://github.com/jkeiser).
+
+## 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,17 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rake/extensiontask"
+
+Rake::ExtensionTask.new("heap_profiler") do |ext|
+  ext.ext_dir = 'ext/heap_profiler'
+  ext.lib_dir = "lib/heap_profiler"
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: %i(compile test)

data/TODO.md

@@ -0,0 +1,3 @@
+### Explore
+
+- Detect object growth?

data/benchmark/address-parsing.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "benchmark/ips"
+require "heap_profiler/full"
+
+native = HeapProfiler::Parser::Native.new
+ruby = HeapProfiler::Parser::Ruby.new
+
+Benchmark.ips do |x|
+  x.report("ruby") { ruby.parse_address("0x7f921e88a8f8") }
+  x.report("cpp") { native.parse_address("0x7f921e88a8f8") }
+  x.compare!
+end

data/benchmark/indexing.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "benchmark/ips"
+require "heap_profiler/full"
+
+FIXTURE_PATH = File.expand_path("../../test/fixtures/diffed-heap/allocated.heap", __FILE__)
+
+native = HeapProfiler::Parser::Native.new
+ruby = HeapProfiler::Parser::Ruby.new
+
+Benchmark.ips do |x|
+  x.report("ruby") { ruby.build_index(FIXTURE_PATH) }
+  x.report("cpp") { native.build_index(FIXTURE_PATH) }
+  x.compare!
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "heap-profiler"
+
+# 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/generate-report

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+require 'bundler/setup'
+require "heap-profiler"
+require 'fileutils'
+require 'date'
+
+class SomeCustomStuff
+  def initialize
+    @root = 1
+  end
+
+  def foo
+    @foo = 1
+  end
+
+  def bar
+    @bar = 2
+  end
+end
+
+$freed_objects = [+"i am free", +"i am free too"]
+
+dir = ARGV.first
+FileUtils.mkdir_p(dir)
+FileUtils.rm_rf(Dir[File.join(dir, '*')])
+
+if ARGV[1] == '--empty'
+  HeapProfiler.report(dir) {}
+else
+  HeapProfiler.report(dir) do
+    SomeCustomStuff.new.tap(&:foo).tap(&:bar)
+    SomeCustomStuff.new.tap(&:bar)
+    $retained_objects = [
+      +"I am retained",
+      +"I am retained",
+      +"I am retained too",
+      SomeCustomStuff.new,
+      Date.today,
+    ]
+    "I am a very very long string " * 4
+    [
+      +"I am allocated",
+      +"I am allocated too",
+    ]
+    $freed_objects = nil
+    Struct.new("foo".to_sym, :bar)
+  end
+end