sunburst 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21354f28529b35ce4d5897120e0f0b37f3ace979705c9d80f746fc2f55e55444
-  data.tar.gz: 8bf865f98151f931e009bf9c8ee0c19397a7cdc3c5c3406c8ac5273f9743963f
+  metadata.gz: bac5cf8138ded782d5114cf84c9d05f3f06e748328024aaa2c99783187c734ac
+  data.tar.gz: a8959e5ff6b66c568b0c5d7ead18abdb5c1df9305155e4e9f29ca0c449074617
 SHA512:
-  metadata.gz: b23ae54f7a5d19b065c172ea24d9a9df6e81c048ff07a56b770f8d6abe1765cd78971e8604c5f05179d27b9410d8b23997076c79fc56360f69ca2c76bfb72f80
-  data.tar.gz: dd542f7f462a637e909dd3d1f84e59f2adcc3a184fd0a67287d56228f4a5fd4c757a0950e8294825642a6f26462ffefef7ed51435acbb833f19b31d35ae20791
+  metadata.gz: bad636441bee759ab7783226a3ea6e0e86b5cfae584b1ddc81f2d181df354101c58c43092f38f80136d00e22846641199b5256bc8c80da5f398e29d32a990432
+  data.tar.gz: 8846d22b978e865380622bd7139d0260c7d0f9a3b6c2e43c01230bedeb5f7f473b24136ac1a9dc1a08b85e7efa7f7029a33f439630cd24fa49e6876dd17626c5

data/README.md

@@ -1,11 +1,41 @@
 # Sunburst
+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.
 
-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.
+For example:
 
-TODO: Delete this and the text above, and describe your gem
+```
+$ sunburst "while : ; do echo hi ; sleep 1 ; done" --time=3
+:: Running "while : ; do echo hi ; sleep 1 ; done" for 3.0 seconds
+                     Logging Standard Output and Error
+hi
+hi
+hi
+
+    ----------------------------------------------------------------------
+:: Total Execution Time: 3.00097 seconds
+:: CPU Time: 0.0 seconds (0.0% exec time)
+:: Memory usage: 577536 bytes (0.007% system mem)
+:: Max Threads: 1
+```
 
-## Installation
+Or
+
+```
+$ sunburst "while : ; do : ; done" --time=3
+:: Running "while : ; do : ; done" for 3.0 seconds
+                     Logging Standard Output and Error
+
+    ----------------------------------------------------------------------
+:: Total Execution Time: 3.00097 seconds
+:: CPU Time: 2.97 seconds (98.968% exec time)
+:: Memory usage: 360448 bytes (0.004% system mem)
+:: Max Threads: 1
+```
 
+## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -14,30 +44,35 @@ gem 'sunburst'
 
 And then execute:
 
-    $ bundle install
+```
+$ bundle install
+```
 
 Or install it yourself as:
-
-    $ gem install sunburst
+```
+$ gem install sunburst
+```
 
 ## Usage
+Run sunbust -h for instruction.
 
-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.
+```
+Arguments:
+    --time=N          Run the program for N seconds
+    -h | --help       Show this help section
+    --humanize        Human readable memory units
+
+Example:
+    sunburst echo hello world --time=0.05 --humanize
+    sunburst "echo hello world" --time=0.05 --humanize
+    sunburst "ruby -e 'while true do end'" --time=3 --humanize
+    sunburst "ruby -e 'p :Hello'" --time=3 --humanize
+```
 
-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).
+If no time is specified, it will run until the command exits.
 
 ## 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).
+Bug reports and pull requests are welcome on GitHub at https://github.com/Souravgoswami/sunburst.
 
 ## 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/exe/sunburst

@@ -1,5 +1,7 @@
-require 'sunburst'
+#!/usr/bin/env ruby
+$-v = nil
 STDOUT.sync = STDIN.sync = true
+require 'sunburst'
 
 def help
 	puts <<~EOF
@@ -25,6 +27,11 @@ def help
 	exit 0
 end
 
+def splitter(sub = 8)
+	width = Sunburst.win_width
+	puts ?\n, ?-.*(width - sub).center(width)
+end
+
 help if ARGV.any? { |x| x[/^\-(\-help|h)$/] }
 
 time_arg = ARGV.find { |x| x[/^\-\-time=[0-9]+\.?[0-9]*$/] }
@@ -40,18 +47,52 @@ command = ARGV.join(' ')
 help if command.empty?
 
 puts %Q(:: Running "#{command}" for #{time || 'infinite'} seconds)
-puts ?- * Sunburst.win_width
+
 
 begin
+	print ""
+
+	message = "\e[4mLogging Standard Output and Error\e[0m"
+	puts "\e[38;2;243;156;18m#{message.center(Sunburst.win_width + 6)}\e[0m"
+
 	data = Sunburst.measure(command: command, time: time, sleep_time: 0.0001)
+	print "\e[38;2;243;156;18m"
+	splitter()
+	print "\e[0m"
+
+	exec_time = data[:execution_time]
+	cpu_time = data[:cpu_time]
+	percent_time = cpu_time.*(100).fdiv(exec_time)
+
+	style = "\e[1;"
+	style << if percent_time > 75
+		"38;2;230;80;70m"
+	elsif percent_time > 50
+		"38;2;45;125;255m"
+	elsif percent_time > 25
+		"38;2;255;225;0m"
+	else
+		"38;2;40;175;95m"
+	end
 
-	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}"
+	puts ":: Total Execution Time: #{data[:execution_time]} seconds\e[0m"
+	puts ":: CPU Time: #{style}#{data[:cpu_time]}\e[0m second#{?s if data[:cpu_time] != 1} (#{percent_time.round(3)}% exec time)"
 
 	mem = data[:memory]
-
 	if mem
+		percent_mem = mem.*(100).fdiv(Sunburst.total_ram)
+
+		style = "\e[1;"
+		style << if percent_mem > 50
+			"38;2;230;80;70m"
+		elsif percent_mem > 30
+			"38;2;45;125;255m"
+		elsif percent_mem > 10
+			"38;2;255;225;0m"
+		else
+			"38;2;40;175;95m"
+		end
+
 		if human_readable
 			mem_text = if mem >= 10 ** 12
 				"#{mem.fdiv(10 ** 12).round(3)} TB"
@@ -65,16 +106,31 @@ begin
 				"#{mem} Bytes"
 			end
 
-			puts ":: Memory usage: #{mem_text}"
+			puts ":: Memory usage: #{style}#{mem_text}\e[0m (#{percent_mem.round(3)}% system mem)"
 		else
-			puts ":: Memory usage: #{mem} bytes"
+			puts ":: Memory usage: #{style}#{mem} bytes\e[0m (#{percent_mem.round(3)}% system mem)"
 		end
 	else
 		puts ":: The memory usage can't be logged."
 	end
+
+	max_threads = data[:max_threads]
+	style = "\e[1;"
+	style << if max_threads > 16
+		"38;2;230;80;70m"
+	elsif max_threads > 8
+		"38;2;45;125;255m"
+	elsif max_threads > 4
+		"38;2;255;225;0m"
+	else
+		"38;2;40;175;95m"
+	end
+
+	puts ":: Max Threads: #{style}#{max_threads}\e[0m"
+
 rescue Errno::ENOENT
 	puts "sunburst: #{command}: command not found"
-	puts ?- * Sunburst.win_width
+	puts ?\n, ?- * Sunburst.win_width
 rescue StandardError
-	puts "$!.full_message"
+	puts $!.full_message
 end

data/ext/stats/stats.c

@@ -2,11 +2,12 @@
 #include <unistd.h>
 #include <time.h>
 #include <sys/ioctl.h>
+#include <sys/sysinfo.h>
 
 unsigned int PAGESIZE ;
 unsigned int TICKS ;
 
-VALUE statm_memory(VALUE obj, VALUE pid) {
+VALUE statm_memory(volatile VALUE obj, volatile VALUE pid) {
 	int _pid = FIX2INT(pid) ;
 	if (_pid < 0) return Qnil ;
 
@@ -26,41 +27,71 @@ VALUE statm_memory(VALUE obj, VALUE pid) {
 	return UINT2NUM(v) ;
 }
 
-VALUE ps_times(VALUE obj, VALUE pid) {
+VALUE ps_stat(volatile VALUE obj, volatile VALUE pid) {
 	int _pid = FIX2INT(pid) ;
-	if (_pid < 0) return Qnil ;
+	if (_pid < 0) return rb_str_new_cstr("") ;
 
 	char _path[22] ;
 	sprintf(_path, "/proc/%d/stat", _pid) ;
 
 	FILE *f = fopen(_path, "r") ;
-	if (!f) return Qnil ;
 
-	unsigned long utime, stime ;
+	if (!f) return rb_ary_new() ;
+
+	// For this info
+	// follow https://man7.org/linux/man-pages/man5/proc.5.html
+	int ppid, processor ;
+	long unsigned utime, stime ;
+	long num_threads ;
+
+	char status = fscanf(
+		f, "%*llu (%*[^)]%*[)] %*c "
+		"%d %*d %*d %*d %*d %*u "
+		"%*lu %*lu %*lu %*lu %lu %lu "
+		"%*ld %*ld %*ld %*ld %ld",
+		&ppid, &utime, &stime, &num_threads
+	) ;
 
-	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 ;
+	if (status != 4) return rb_ary_new() ;
 
-	return rb_float_new(total_time) ;
+	return rb_ary_new_from_args(4,
+		INT2NUM(ppid),
+		ULONG2NUM(utime),
+		ULONG2NUM(stime),
+		LONG2NUM(num_threads)
+	) ;
 }
 
-VALUE clock_monotonic(VALUE obj) {
+VALUE clock_monotonic(volatile VALUE obj) {
 	struct timespec tv ;
 	clock_gettime(CLOCK_MONOTONIC, &tv) ;
-	long double time = tv.tv_sec + tv.tv_nsec / 1000000000.0 ;
+	float time = tv.tv_sec + tv.tv_nsec / 1000000000.0 ;
 
 	return rb_float_new(time) ;
 }
 
-VALUE winWidth(VALUE obj) {
+VALUE winWidth(volatile VALUE obj) {
 	struct winsize w ;
 	ioctl(STDOUT_FILENO, TIOCGWINSZ, &w) ;
 	return INT2NUM(w.ws_col) ;
 }
 
+VALUE totalRAM(volatile VALUE obj) {
+	struct sysinfo buf ;
+	char status = sysinfo(&buf) ;
+
+	if (status != 0) return Qnil ;
+
+	return rb_funcall(
+		ULONG2NUM(buf.totalram),
+		rb_intern("*"),
+		1,
+		ULONG2NUM(buf.mem_unit)
+	) ;
+}
+
 void Init_stats() {
 	PAGESIZE = sysconf(_SC_PAGESIZE) ;
 	TICKS = sysconf(_SC_CLK_TCK) ;
@@ -70,8 +101,10 @@ void Init_stats() {
 	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) ;
+	rb_define_module_function(sunburst, "ps_stat", ps_stat, 1) ;
+
+	rb_define_module_function(sunburst, "total_ram", totalRAM, 0) ;
 }

data/lib/sunburst/sunburst.rb

@@ -1,16 +1,29 @@
 module Sunburst
+	def self.get_stats(pid)
+		stats = Sunburst.ps_stat(pid)
+
+		if stats.empty?
+			Process.kill(9, pid)
+			fail RuntimeError, 'Something horribly wrong happened! Exiting.'
+		end
+
+		stats
+	end
+
 	def self.measure(command:, time: nil, sleep_time: 0.001)
-		r = {execution_time: nil, cpu_time: nil, memory: nil}
+		r = {
+			execution_time: nil, cpu_time: nil,
+			memory: nil, max_threads: nil
+		}
 
 		IO.popen(command) { |x|
 			time1 = Sunburst.clock_monotonic
 			pid = x.pid
 
-			t = Thread.new {
-				print x.readpartial(4096) until x.eof?
-			}
+			t = Thread.new { print x.readpartial(4096) until x.eof? }
 
 			last_mem = 0
+			max_threads = 0
 
 			while true
 				_last_mem = Sunburst.get_mem(pid)
@@ -18,13 +31,22 @@ module Sunburst
 				break if (time && Sunburst.clock_monotonic - time1 > time) || _last_mem == 0
 				last_mem = _last_mem
 
+				# Get stats
+				stats = get_stats(pid)
+				_threads = stats[3]
+				max_threads = _threads if max_threads < _threads
+
 				sleep(sleep_time)
 			end
 
 			time2 = Sunburst.clock_monotonic
 
-			# Get CPU Time
-			cpu_time = Sunburst.get_times(pid).truncate(5)
+			# Get Stats
+			stats = get_stats(pid)
+			cpu_time = stats[1].+(stats[2]).fdiv(Sunburst::TICKS)
+
+			_threads = stats[3]
+			max_threads = _threads if max_threads < _threads
 
 			# Get Memory Usage
 			_last_mem = Sunburst.get_mem(pid)
@@ -33,9 +55,11 @@ module Sunburst
 			t.kill
 			Process.kill(9, pid)
 
-			r[:execution_time] = time2.-(time1).truncate(5)
 			r[:cpu_time] = cpu_time
+			r[:max_threads] = max_threads unless max_threads == 0
 			r[:memory] = last_mem * Sunburst::PAGESIZE if last_mem > 0
+
+			r[:execution_time] = time2.-(time1).truncate(5)
 		}
 
 		r

data/lib/sunburst/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sunburst
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sourav Goswami
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2021-04-11 00:00:00.000000000 Z
 dependencies: []
 description: Run a process for a given time, kill it with SIGKILL, report CPU time
   and memory usage