rb-wartslib 0.9.10 → 0.9.11

data/bin/scdump

@@ -3,7 +3,24 @@
 #############################################################################
 ## Ruby version of sc_analsysis_dump.
 ##
-## $Id: scdump,v 1.11 2007/11/29 20:39:13 youngh Exp $
+## --------------------------------------------------------------------------
+## Copyright (C) 2007 The Regents of the University of California.
+##
+## This program is free software; you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 2 of the License, or
+## (at your option) any later version.
+## 
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+## 
+## You should have received a copy of the GNU General Public License
+## along with this program; if not, write to the Free Software
+## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+## 
+## $Id: scdump,v 1.12 2007/11/29 23:57:41 youngh Exp $
 #############################################################################
 
 require 'rubygems'

data/bin/select-traces

@@ -0,0 +1,275 @@
+#!/usr/bin/env ruby
+
+#############################################################################
+## Selects traces from input files based on a set of conditions and either
+## writes matching traces to an output warts file or prints out a textual
+## representation.
+##
+## --------------------------------------------------------------------------
+## Copyright (C) 2007 The Regents of the University of California.
+##
+## This program is free software; you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 2 of the License, or
+## (at your option) any later version.
+## 
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+## 
+## You should have received a copy of the GNU General Public License
+## along with this program; if not, write to the Free Software
+## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+## 
+## $Id: select-traces,v 1.1 2007/11/30 01:14:48 youngh Exp $
+#############################################################################
+
+require 'rubygems'
+require 'ostruct'
+require 'optparse'
+
+require 'wartslib'
+
+$options = OpenStruct.new
+$options.skip_traces = 0
+
+opts = OptionParser.new
+opts.banner = "Usage: select-traces [options] <warts-file-1> <warts-file-2> ..."
+
+opts.on("-r", "--responding", TrueClass,
+        "if destination responded") do |v|
+  $options.responding = v
+end
+
+opts.on("-c", "--complete", TrueClass,
+        "if dest and all intermediate hops responded") do |v|
+  $options.complete = v
+end
+
+opts.on("-s", "--stop-reasons", Array, "=NUM-LIST",
+        "comma-separated numeric stop reason(s)") do |v|
+  $options.stop_reasons = v
+end
+
+opts.on("-m", "--methods", Array, "=STR-LIST",
+        "comma-separated traceroute method(s): udp,udp-paris,icmp,icmp-paris,tcp") do |v|
+  $options.trace_methods = v
+end
+
+opts.on("--length", Integer, "=NUM",
+        "if path length is equal to N") do |v|
+  $options.length = v
+end
+
+opts.on("--length-ge", Integer, "=NUM",
+        "if path length is >= N") do |v|
+  $options.length_ge = v
+end
+
+opts.on("--length-le", Integer, "=NUM",
+        "if path length is <= N") do |v|
+  $options.length_le = v
+end
+
+opts.on("-S", "--skip-traces", Integer, "=NUM",
+        "number of leading traces to skip") do |v|
+  $options.skip_traces = v
+end
+
+opts.on("-N", "--num-traces", Integer, "=NUM",
+        "# traces to examine after skipping traces") do |v|
+  $options.num_traces = v
+end
+
+opts.on("-o", "--output", "=FILE", "output warts file") do |v|
+  $options.output_file = v
+end
+
+opts.on("-p", "--print-stats", TrueClass, "print trace stats") do |v|
+  $options.print_stats = v
+end
+
+opts.on("-d", "--dump-traces", TrueClass,
+        "dump traces in text to stdout") do |v|
+  $options.dump_traces = v
+end
+
+opts.on("-v", "--[no-]verbose", TrueClass,  "show detailed progress") do |v|
+  $options.verbose = v
+end
+
+begin
+  ARGV.replace opts.parse(*ARGV)
+rescue OptionParser::ParseError
+  $stderr.puts "ERROR: " + $!
+  $stderr.puts opts
+  exit 1
+end
+
+if $options.stop_reasons
+  $options.stop_reasons = $options.stop_reasons.map { |s|
+    unless s =~ /^\d+$/
+      $stderr.puts "ERROR: invalid stop reason '#{s}': must be an integer"
+      exit 1
+    end
+    s.to_i
+  }
+end
+
+if $options.trace_methods
+  trace_type = {
+    "icmp" => Warts::Trace::TYPE_ICMP_ECHO,
+    "udp" => Warts::Trace::TYPE_UDP,
+    "tcp" => Warts::Trace::TYPE_TCP,
+    "icmp-paris" => Warts::Trace::TYPE_ICMP_ECHO_PARIS,
+    "udp-paris" => Warts::Trace::TYPE_UDP_PARIS
+  }
+
+  $options.trace_type = $options.trace_methods.map { |s|
+    type = trace_type[s]
+    unless type
+      $stderr.puts "ERROR: invalid trace method '#{s}': must be one of " +
+        trace_type.keys.sort.join(", ")
+      exit 1
+    end
+    type
+  }
+end
+
+unless $options.output_file || $options.print_stats || $options.dump_traces
+  $options.print_stats = true
+end
+
+#===========================================================================
+
+class Stats
+  attr_accessor :traces, :responding, :complete, :stop_reason
+  attr_accessor :hop_histogram, :zero_dead
+
+  def initialize
+    @traces = 0
+    @responding = 0
+    @complete = 0
+    @stop_reason = Hash.new 0
+
+    # from scamper_trace.h:SCAMPER_TRACE_STOP_*
+    @stop_text = {
+      0 => "none (null reason)",
+      1 => "completed (got an ICMP port unreach)",
+      2 => "unreach (got an other ICMP unreach code)",
+      3 => "icmp (got an ICMP msg, not unreach)",
+      4 => "loop (loop detected)",
+      5 => "dead (unresponsive target)",
+      6 => "error (sendto error)"
+    }
+    @stop_text.default = "<<UNKNOWN STOP CODE>>"
+
+    @hop_histogram = Hash.new 0
+    @zero_dead = 0
+  end
+
+  def print
+    puts "%8d traces" % [@traces]
+    puts "%8d responding (%.1f%%)" % [@responding, pct(@responding, @traces)]
+    puts "%8d complete (%.1f%%)" % [@complete, pct(@complete, @traces)]
+    puts "%8d dead traces with zero hop count (%.1f%%)" %
+      [ @zero_dead, pct(@zero_dead, @traces) ]
+    puts
+    stop_reason.to_a.sort.each do |k, v|
+      puts "%8d stop reason %d, %s" % [v, k, @stop_text[k]]
+    end
+    puts
+    @hop_histogram.to_a.sort.each do |k, v|
+      puts "%8d %d hops" % [v, k]
+    end
+  end
+
+  def add(other)
+    @traces += other.traces
+    @responding += other.responding
+    @complete += other.complete
+    other.stop_reason.each { |k,v| @stop_reason[k] += v }
+    other.hop_histogram.each { |k,v| @hop_histogram[k] += v }
+    @zero_dead += other.zero_dead
+  end
+
+  def pct(x, y)
+    return 100.0 if y == 0
+    x.quo(y) * 100.0
+  end
+end
+
+
+#############################################################################
+# Main
+#############################################################################
+
+if $options.output_file
+  $options.output = Warts::File.open $options.output_file, "w",
+    Warts::File::WARTS
+  unless $options.output
+    $stderr.puts "ERROR: couldn't open output file '#{$options.output_file}'"
+    exit 1
+  end
+end
+
+total = Stats.new
+
+trace_index = 0
+ARGV.each do |path|
+  stats = Stats.new
+  $stderr.puts "Examining #{path} ..." if $options.verbose
+  file = Warts::File.open path
+  unless file
+    $stderr.puts "ERROR: couldn't open input file '#{path}'; aborting"
+    exit 1
+  end
+
+  file.add_filters Warts::File::TRACE
+  file.read do |trace|
+    trace_index += 1
+    next if trace_index <= $options.skip_traces
+    if $options.num_traces &&
+        trace_index - $options.skip_traces > $options.num_traces
+      exit 0
+    end
+
+    next if $options.responding && !trace.dest_responded?
+    next if $options.complete && !trace.complete?
+    next if $options.stop_reasons &&
+      !$options.stop_reasons.include?(trace.stop_reason)
+    next if $options.trace_type && !$options.trace_type.include?(trace.type)
+    next if $options.length && trace.path_length != $options.length
+    next if $options.length_ge && trace.path_length < $options.length_ge
+    next if $options.length_le && trace.path_length > $options.length_le
+
+    if $options.print_stats
+      stats.traces += 1
+      stats.responding += 1 if trace.dest_responded?
+      stats.complete += 1 if trace.complete?
+      stats.stop_reason[trace.stop_reason] += 1
+      stats.hop_histogram[trace.path_length] += 1
+      stats.zero_dead += 1 if trace.stop_reason == 5 && trace.hop_count == 0
+    end
+
+    puts trace.dump if $options.dump_traces
+    $options.output.write trace if $options.output
+  end
+
+  if $options.print_stats
+    puts "\n"
+    puts("-" * 70)
+    puts path
+    stats.print
+
+    total.add stats
+  end
+end
+
+if $options.print_stats && ARGV.length > 1
+  puts "\n"
+  puts("=" * 70)
+  puts "total"
+  total.print
+end

data/bin/show-cycles

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+#############################################################################
+## Prints out information about cycle start/stop/def records in the input
+## warts files.
+##
+## --------------------------------------------------------------------------
+## Copyright (C) 2007 The Regents of the University of California.
+##
+## This program is free software; you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 2 of the License, or
+## (at your option) any later version.
+## 
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+## 
+## You should have received a copy of the GNU General Public License
+## along with this program; if not, write to the Free Software
+## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+## 
+## $Id: show-cycles,v 1.1 2007/11/30 01:14:48 youngh Exp $
+#############################################################################
+
+require "rubygems"
+require 'wartslib'
+
+def cycle_type(element)
+  case element.element_type
+  when Warts::File::CYCLE_START: "START"
+  when Warts::File::CYCLE_DEF: "DEF"
+  when Warts::File::CYCLE_STOP: "STOP"
+  end
+end
+
+def ts_date(timestamp)
+  timestamp > 0 ? " (" + Time.at(timestamp).to_s + ")" : ""
+end
+
+ARGV.each do |path|
+  puts ">> #{path}"
+  Warts::File::open(path) do |file|
+    file.add_filters Warts::File::CYCLE_START, Warts::File::CYCLE_DEF,
+      Warts::File::CYCLE_STOP
+    file.read do |c|
+      start_date = ts_date c.start_time
+      stop_date = ts_date c.stop_time
+      puts sprintf("%5s: id=%d\n       start=%d%s\n       stop=%d%s",
+                   cycle_type(c), c.id, c.start_time, start_date,
+                   c.stop_time, stop_date)
+    end
+  end
+end

data/bin/split-traces-by-type

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+
+#############################################################################
+## Utility for splitting traces into multiple files based on the probe
+## method (e.g., UDP, ICMP-paris).
+##
+## --------------------------------------------------------------------------
+## Copyright (C) 2007 The Regents of the University of California.
+##
+## This program is free software; you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 2 of the License, or
+## (at your option) any later version.
+## 
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+## 
+## You should have received a copy of the GNU General Public License
+## along with this program; if not, write to the Free Software
+## Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+##
+## $Id: split-traces-by-type,v 1.1 2007/11/30 01:14:48 youngh Exp $
+#############################################################################
+
+require 'rubygems'
+require 'fileutils'
+require 'wartslib'
+
+#---------------------------------------------------------------------------
+
+class SplitFiles
+  def initialize(filename)
+    @basename = File.basename filename, ".gz"
+    @basename += ".warts" unless @basename.include? ".warts"
+    @output_files = {}
+  end
+
+  def sort_trace(trace)
+    open_output_file trace
+    @output_files[trace.type].write trace
+  end
+
+  def close_all
+    @output_files.each_value do |file|
+      file.close
+    end
+    @output_files.clear
+  end
+
+  private
+
+  def open_output_file(trace)
+    unless @output_files.has_key? trace.type
+      type_name = trace_type_name trace.type
+      filename = @basename.sub(/\.warts/, "-" + type_name + ".warts")
+      file = Warts::File::open filename, "w", Warts::File::WARTS
+      @output_files[trace.type] = file
+    end
+  end
+
+  def trace_type_name(type)
+    case type
+    when Warts::Trace::TYPE_ICMP_ECHO: "icmp"
+    when Warts::Trace::TYPE_UDP: "udp"
+    when Warts::Trace::TYPE_TCP: "tcp"
+    when Warts::Trace::TYPE_ICMP_ECHO_PARIS: "icmp-paris"
+    when Warts::Trace::TYPE_UDP_PARIS: "udp-paris"
+    else fail "unknown trace type #{trace.type}"
+    end
+  end
+end
+
+
+#############################################################################
+# MAIN
+#############################################################################
+
+if ARGV.length > 0
+  ARGV.each do |filename|
+    puts "splitting " + filename
+    split = SplitFiles.new filename
+
+    Warts::File::open(filename) do |file|
+      file.add_filters Warts::File::TRACE
+      file.read do |element|
+        split.sort_trace element
+      end
+    end
+
+    split.close_all
+  end
+else
+  $stderr.puts "no files specified; nothing to do"
+  exit 0
+end