sunburst 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 21354f28529b35ce4d5897120e0f0b37f3ace979705c9d80f746fc2f55e55444
+  data.tar.gz: 8bf865f98151f931e009bf9c8ee0c19397a7cdc3c5c3406c8ac5273f9743963f
+SHA512:
+  metadata.gz: b23ae54f7a5d19b065c172ea24d9a9df6e81c048ff07a56b770f8d6abe1765cd78971e8604c5f05179d27b9410d8b23997076c79fc56360f69ca2c76bfb72f80
+  data.tar.gz: dd542f7f462a637e909dd3d1f84e59f2adcc3a184fd0a67287d56228f4a5fd4c757a0950e8294825642a6f26462ffefef7ed51435acbb833f19b31d35ae20791

data/LICENCE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Sourav Goswami
+
+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,43 @@
+# Sunburst
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sunburst`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sunburst'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install sunburst
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 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/[USERNAME]/sunburst. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/sunburst/blob/master/CODE_OF_CONDUCT.md).
+
+## 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 Sunburst project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/sunburst/blob/master/CODE_OF_CONDUCT.md).

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/sunburst

@@ -0,0 +1,80 @@
+require 'sunburst'
+STDOUT.sync = STDIN.sync = true
+
+def help
+	puts <<~EOF
+		Sunburst lets you run a command for a given time.
+		When the time expires, the program will be SIGKILLed.
+		Sunburst will then report the total CPU time and last known memory usage
+		of the program.
+
+		If no time is specified, it will run until the command exits.
+
+		Arguments:
+		\s\s\s\s--time=N\s\s\s\s\s\s\s\s\s\sRun the program for N seconds
+		\s\s\s\s-h | --help\s\s\s\s\s\s\sShow this help section
+		\s\s\s\s--humanize\s\s\s\s\s\s\s\sHuman readable memory units
+
+		Example:
+		\s\s\s\ssunburst echo hello world --time=0.05 --humanize
+		\s\s\s\ssunburst "echo hello world" --time=0.05 --humanize
+		\s\s\s\ssunburst "ruby -e 'while true do end'" --time=3 --humanize
+		\s\s\s\ssunburst "ruby -e 'p :Hello'" --time=3 --humanize
+	EOF
+
+	exit 0
+end
+
+help if ARGV.any? { |x| x[/^\-(\-help|h)$/] }
+
+time_arg = ARGV.find { |x| x[/^\-\-time=[0-9]+\.?[0-9]*$/] }
+ARGV.delete(time_arg) if time_arg
+time = time_arg ? time_arg.split('=')[-1].to_f : nil
+
+_human_readable = ARGV.find { |x| x[/^\-\-humanize$/] }
+ARGV.delete(_human_readable) if _human_readable
+human_readable = _human_readable
+
+command = ARGV.join(' ')
+
+help if command.empty?
+
+puts %Q(:: Running "#{command}" for #{time || 'infinite'} seconds)
+puts ?- * Sunburst.win_width
+
+begin
+	data = Sunburst.measure(command: command, time: time, sleep_time: 0.0001)
+
+	puts ?- * Sunburst.win_width
+	puts ":: Total Execution Time: #{data[:execution_time]} seconds"
+	puts ":: CPU Time: #{data[:cpu_time]} second#{?s if data[:cpu_time] != 1}"
+
+	mem = data[:memory]
+
+	if mem
+		if human_readable
+			mem_text = if mem >= 10 ** 12
+				"#{mem.fdiv(10 ** 12).round(3)} TB"
+			elsif mem >= 10 ** 9
+				"#{mem.fdiv(10 ** 9).round(3)} GB"
+			elsif mem >= 10 ** 6
+				"#{mem.fdiv(10 ** 6).round(3)} MB"
+			elsif mem >= 10 ** 3
+				"#{mem.fdiv(10 ** 3).round(3)} KB"
+			else
+				"#{mem} Bytes"
+			end
+
+			puts ":: Memory usage: #{mem_text}"
+		else
+			puts ":: Memory usage: #{mem} bytes"
+		end
+	else
+		puts ":: The memory usage can't be logged."
+	end
+rescue Errno::ENOENT
+	puts "sunburst: #{command}: command not found"
+	puts ?- * Sunburst.win_width
+rescue StandardError
+	puts "$!.full_message"
+end

data/ext/stats/extconf.rb

@@ -0,0 +1,4 @@
+require 'mkmf'
+$CFLAGS << ' -O3 -mtune=native -march=native'
+
+create_makefile 'sunburst/stats'

data/ext/stats/stats.c

@@ -0,0 +1,77 @@
+#include "ruby.h"
+#include <unistd.h>
+#include <time.h>
+#include <sys/ioctl.h>
+
+unsigned int PAGESIZE ;
+unsigned int TICKS ;
+
+VALUE statm_memory(VALUE obj, VALUE pid) {
+	int _pid = FIX2INT(pid) ;
+	if (_pid < 0) return Qnil ;
+
+	char _path[22] ;
+	sprintf(_path, "/proc/%d/statm", _pid) ;
+
+	FILE *f = fopen(_path, "r") ;
+	if (!f) return Qnil ;
+
+	unsigned int resident, shared ;
+	char status = fscanf(f, "%*u %u %u", &resident, &shared) ;
+	fclose(f) ;
+
+	if (status != 2) return Qnil ;
+
+	unsigned int v = resident - shared ;
+	return UINT2NUM(v) ;
+}
+
+VALUE ps_times(VALUE obj, VALUE pid) {
+	int _pid = FIX2INT(pid) ;
+	if (_pid < 0) return Qnil ;
+
+	char _path[22] ;
+	sprintf(_path, "/proc/%d/stat", _pid) ;
+
+	FILE *f = fopen(_path, "r") ;
+	if (!f) return Qnil ;
+
+	unsigned long utime, stime ;
+
+	char status = fscanf(f, "%*llu (%*[^)]%*[)] %*c %*d %*d %*d %*d %*d %*u %*lu %*lu %*lu %*lu %lu %lu", &utime, &stime) ;
+	fclose(f) ;
+
+	if (status != 2) return Qnil ;
+	float total_time = (utime + stime) / (float)TICKS ;
+
+	return rb_float_new(total_time) ;
+}
+
+VALUE clock_monotonic(VALUE obj) {
+	struct timespec tv ;
+	clock_gettime(CLOCK_MONOTONIC, &tv) ;
+	long double time = tv.tv_sec + tv.tv_nsec / 1000000000.0 ;
+
+	return rb_float_new(time) ;
+}
+
+VALUE winWidth(VALUE obj) {
+	struct winsize w ;
+	ioctl(STDOUT_FILENO, TIOCGWINSZ, &w) ;
+	return INT2NUM(w.ws_col) ;
+}
+
+void Init_stats() {
+	PAGESIZE = sysconf(_SC_PAGESIZE) ;
+	TICKS = sysconf(_SC_CLK_TCK) ;
+
+	VALUE sunburst = rb_define_module("Sunburst") ;
+	rb_define_const(sunburst, "PAGESIZE", UINT2NUM(PAGESIZE)) ;
+	rb_define_const(sunburst, "TICKS", UINT2NUM(TICKS)) ;
+
+	rb_define_module_function(sunburst, "get_mem", statm_memory, 1) ;
+	rb_define_module_function(sunburst, "get_times", ps_times, 1) ;
+	rb_define_module_function(sunburst, "clock_monotonic", clock_monotonic, 0) ;
+
+	rb_define_module_function(sunburst, "win_width", winWidth, 0) ;
+}

data/lib/sunburst.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'sunburst/version'
+require 'sunburst/stats'
+require 'sunburst/sunburst'

data/lib/sunburst/sunburst.rb

@@ -0,0 +1,43 @@
+module Sunburst
+	def self.measure(command:, time: nil, sleep_time: 0.001)
+		r = {execution_time: nil, cpu_time: nil, memory: nil}
+
+		IO.popen(command) { |x|
+			time1 = Sunburst.clock_monotonic
+			pid = x.pid
+
+			t = Thread.new {
+				print x.readpartial(4096) until x.eof?
+			}
+
+			last_mem = 0
+
+			while true
+				_last_mem = Sunburst.get_mem(pid)
+
+				break if (time && Sunburst.clock_monotonic - time1 > time) || _last_mem == 0
+				last_mem = _last_mem
+
+				sleep(sleep_time)
+			end
+
+			time2 = Sunburst.clock_monotonic
+
+			# Get CPU Time
+			cpu_time = Sunburst.get_times(pid).truncate(5)
+
+			# Get Memory Usage
+			_last_mem = Sunburst.get_mem(pid)
+			last_mem = _last_mem unless _last_mem == 0
+
+			t.kill
+			Process.kill(9, pid)
+
+			r[:execution_time] = time2.-(time1).truncate(5)
+			r[:cpu_time] = cpu_time
+			r[:memory] = last_mem * Sunburst::PAGESIZE if last_mem > 0
+		}
+
+		r
+	end
+end

data/lib/sunburst/version.rb

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

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: sunburst
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sourav Goswami
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-04-08 00:00:00.000000000 Z
+dependencies: []
+description: Run a process for a given time, kill it with SIGKILL, report CPU time
+  and memory usage
+email:
+- souravgoswami@protonmail.com
+executables:
+- sunburst
+extensions:
+- ext/stats/extconf.rb
+extra_rdoc_files:
+- README.md
+files:
+- LICENCE
+- README.md
+- bin/setup
+- exe/sunburst
+- ext/stats/extconf.rb
+- ext/stats/stats.c
+- lib/sunburst.rb
+- lib/sunburst/sunburst.rb
+- lib/sunburst/version.rb
+homepage: https://github.com/Souravgoswami/sunburst/
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+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.2.13
+signing_key:
+specification_version: 4
+summary: Run a process for a given time, kill it with SIGKILL, report CPU time and
+  memory usage
+test_files: []