tracemake 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04c0bc7f318a878627268f801a2de991143ba0a801bd8b5f4fa67803825f8f22
+  data.tar.gz: c5e7c602dd09f2e99ecd31a51b92d27ecae30790c79986f6a8c60dba43ec8de5
+SHA512:
+  metadata.gz: 2232e4ded43946368da649690fe4208d2cb164d9f25cee083ed64645a24a650bd7b0191c86d18044b4186b16e999ca1f3f0e07f295fefb80e4df0c924afb2372
+  data.tar.gz: c4374876ff43492d75a4c18a8206feea630994f27b1f859c4ad8412954978b55d30ef9aed8fdab82f2d3550befa31eb7489594b5462ae7fc3c8e3b4f3984ce60

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tracemake.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "test-unit", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    tracemake (0.1.0)
+      json (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    json (2.8.1)
+    power_assert (2.0.5)
+    rake (13.2.1)
+    test-unit (3.6.8)
+      power_assert
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  rake (~> 13.0)
+  test-unit (~> 3.0)
+  tracemake!
+
+BUNDLED WITH
+   2.6.0.dev

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Yuta Saito
+
+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,71 @@
+# Tracemake
+
+[![Gem Version](https://badge.fury.io/rb/tracemake.svg)](https://badge.fury.io/rb/tracemake)
+
+A tool to trace `make` command execution and convert it to Chrome Tracing format. This gem allows tracking the execution time of each command in a make process.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tracemake'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install tracemake
+```
+
+## Usage
+
+### 1. Run make with this gem as the shell:
+
+```bash
+make SHELL="tracemake shell" -j8
+```
+
+### 2. Convert the trace to Chrome Tracing format:
+
+```bash
+tracemake aggregate -o make-trace.json
+```
+
+### 3. Open the resulting JSON file in Chrome's chrome://tracing or https://ui.perfetto.dev/
+
+The trace file will be created in the current directory as `.make.trace`. You can override this location by setting the `TRACE_FILE` environment variable:
+
+```bash
+TRACE_FILE=/path/to/trace make SHELL="tracemake shell" -j8
+```
+
+> **Note**: When running multiple make commands in sequence, make sure to remove the `.make.trace` file before each run to avoid mixing traces from different make processes:
+> ```bash
+> rm -f .make.trace
+> make SHELL="tracemake shell" -j8
+> ```
+
+## 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 the created tag, 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/kateinoigakukun/tracemake.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Tracemake project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/tracemake/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "tracemake"
+
+# 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.
+
+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/exe/tracemake

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require_relative "../lib/tracemake"
+
+Tracemake::CLI.new(ARGV.dup).run 

data/lib/tracemake/version.rb

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

data/lib/tracemake.rb

@@ -0,0 +1,240 @@
+# frozen_string_literal: true
+
+require "json"
+require "set"
+require "optparse"
+require "fileutils"
+require_relative "tracemake/version"
+
+module Tracemake
+  class Error < StandardError; end
+
+  # Represents a time span for a command execution
+  class Span < Struct.new(:start, :pid, :sid, :command, :stop)
+    def name
+      _command = command
+      _command = command[1..-1] if command[0] == "-c"
+      _command.join(" ")
+    end
+
+    def b_event
+      {
+        "name" => name,
+        "ph" => "B",
+        "ts" => start * 1_000_000,
+        "pid" => 0,
+        "tid" => sid,
+        "args" => {
+          "command" => command
+        }
+      }
+    end
+
+    def e_event
+      {
+        "name" => name,
+        "ph" => "E",
+        "ts" => stop * 1_000_000,
+        "pid" => 0,
+        "tid" => sid,
+        "args" => {}
+      }
+    end
+  end
+
+  # Manages slots for process visualization
+  class Slots
+    attr_reader :slot_by_pid, :busy_slots, :number_of_slots
+
+    def initialize
+      @slot_by_pid = {}
+      @busy_slots = Set.new
+      @number_of_slots = 0
+    end
+
+    def schedule(pid)
+      @number_of_slots.times do |i|
+        unless @busy_slots.include?(i)
+          @busy_slots.add(i)
+          @slot_by_pid[pid] = i
+          return i
+        end
+      end
+
+      slot_id = @number_of_slots
+      @number_of_slots += 1
+      @busy_slots.add(slot_id)
+      @slot_by_pid[pid] = slot_id
+      slot_id
+    end
+
+    def free(pid)
+      slot_id = @slot_by_pid[pid]
+      return if slot_id.nil?
+      @busy_slots.delete(slot_id)
+      @slot_by_pid.delete(pid)
+    end
+  end
+
+  # Writer for MakeTrace format
+  class MakeTraceWriter
+    def initialize(trace_file)
+      @trace_file = trace_file
+      FileUtils.mkdir_p(File.dirname(@trace_file))
+    end
+
+    def write_begin_event(pid, time, args)
+      write_event({
+        "pid" => pid,
+        "type" => "B",
+        "time" => time,
+        "args" => args
+      })
+    end
+
+    def write_end_event(pid, time, exit_status = nil)
+      event = {
+        "pid" => pid,
+        "type" => "E",
+        "time" => time
+      }
+      event["exit_status"] = exit_status if exit_status
+      write_event(event)
+    end
+
+    private
+
+    def write_event(event)
+      File.open(@trace_file, "a") do |f|
+        f.flock(File::LOCK_EX)
+        f.write(JSON.generate(event) + "\n")
+        f.flush
+      end
+    end
+  end
+
+  # Main class for converting make trace to Chrome Tracing format
+  class MakeTrace2ChromeTracing
+    def initialize
+      @open_spans = Set.new
+      @closed_spans = []
+    end
+
+    def generate(input_file, output_file)
+      events = parse_events(input_file)
+      process_events(events)
+      spans = @closed_spans.sort_by(&:start)
+      generate_output(spans, output_file)
+    end
+
+    private
+
+    def parse_events(input_file)
+      events = []
+      lines = File.readlines(input_file)
+      while line = lines.shift
+        events << JSON.parse(line)
+      end
+      events.sort_by { |e| e["time"] }
+    end
+
+    def process_events(events)
+      slots = Slots.new
+
+      events.each do |event|
+        if event["type"] == "B"
+          pid, ts, cmd = event["pid"], event["time"], event["args"]
+          sid = slots.schedule(pid)
+          @open_spans.add(Span.new(ts, pid, sid, cmd, nil))
+        elsif event["type"] == "E"
+          pid, ts = event["pid"], event["time"]
+          slots.free(pid)
+
+          found = false
+          @open_spans.each do |span|
+            if span.pid == pid
+              @open_spans.delete(span)
+              span.stop = ts
+              @closed_spans << span
+              found = true
+              break
+            end
+          end
+          $stderr.puts "Warning: no start for pid #{pid}" unless found
+        end
+      end
+    end
+
+    def generate_output(spans, output_file)
+      events = []
+      spans.each do |span|
+        events << span.b_event
+        events << span.e_event
+      end
+
+      File.write(
+        output_file,
+        JSON.generate({ "traceEvents" => events, "displayTimeUnit" => "ms" })
+      )
+    end
+  end
+
+  # Command line interface
+  class CLI
+    def initialize(argv)
+      @argv = argv
+      @trace_file = ENV["TRACE_FILE"] || ".make.trace"
+    end
+
+    def run
+      case @argv.shift
+      when "shell"
+        run_shell
+      when "aggregate"
+        run_aggregate
+      else
+        show_usage
+      end
+    end
+
+    private
+
+    def run_shell
+      shell_args = @argv
+      writer = MakeTraceWriter.new(@trace_file)
+      writer.write_begin_event(Process.pid, Time.now.to_f, shell_args)
+
+      Kernel.system("/bin/sh", *shell_args)
+      exit_status = $?
+
+      writer.write_end_event(Process.pid, Time.now.to_f, exit_status.exitstatus)
+      Kernel.exit(exit_status.exitstatus)
+    end
+
+    def run_aggregate
+      options = {}
+      OptionParser.new do |opts|
+        opts.banner = "Usage: tracemake aggregate [options]"
+        opts.on("-o", "--output FILE", "Output file") do |v|
+          options[:output] = v
+        end
+      end.parse!(@argv)
+
+      output_file = options[:output]
+      if output_file.nil?
+        puts "Output file is required."
+        exit 1
+      end
+
+      processor = MakeTrace2ChromeTracing.new
+      processor.generate(@trace_file, output_file)
+      puts "Trace aggregated to #{output_file}"
+    end
+
+    def show_usage
+      puts "Usage: tracemake aggregate [<input_file>] -o <output_file>"
+      puts "       tracemake shell <command>"
+      exit 1
+    end
+  end
+end

data/sig/tracemake.rbs

@@ -0,0 +1,4 @@
+module Tracemake
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: tracemake
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- kateinoigakukun
+bindir: exe
+cert_chain: []
+date: 2025-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: This gem allows tracking the execution time of each command in a make
+  process by converting the trace to Chrome Tracing format
+email:
+- kateinoigakukun@gmail.com
+executables:
+- tracemake
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/tracemake
+- lib/tracemake.rb
+- lib/tracemake/version.rb
+- sig/tracemake.rbs
+homepage: https://github.com/kateinoigakukun/tracemake
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/kateinoigakukun/tracemake
+  source_code_uri: https://github.com/kateinoigakukun/tracemake
+  changelog_uri: https://github.com/kateinoigakukun/tracemake/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.0.dev
+specification_version: 4
+summary: A tool to trace make command execution and convert it to Chrome Tracing format
+test_files: []