rb-wartslib 0.9.10

data/bin/scdump

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+
+#############################################################################
+## Ruby version of sc_analsysis_dump.
+##
+## $Id: scdump,v 1.11 2007/11/29 20:39:13 youngh Exp $
+#############################################################################
+
+require 'rubygems'
+require 'wartslib'
+
+$halt_reason = []
+$halt_reason[Warts::Trace::STOP_COMPLETED] = "S"
+$halt_reason[Warts::Trace::STOP_NONE] = "S"
+$halt_reason[Warts::Trace::STOP_UNREACH] = "U"
+$halt_reason[Warts::Trace::STOP_LOOP] = "L"
+$halt_reason[Warts::Trace::STOP_DEAD] = "G"
+
+# NOTE: This method is included for demonstration purposes only.  You can
+#       generate the same output line directly from rb-wartslib by invoking
+#       Trace#dump.  Hence, you could have implemented this method as follows:
+#
+#       def show_trace(trace)
+#          puts trace.dump
+#       end
+
+def show_trace(trace)
+  fields = ["T"]
+
+  fields.push trace.src, trace.dst, trace.list_id, trace.cycle_id, trace.start
+
+  dest_response = trace.find_dest_response
+  if dest_response
+    fields.push "R", trace.hop_rtt_str(*dest_response),
+      trace.hop_probe_ttl(*dest_response),
+      trace.hop_reply_ttl(*dest_response)
+  else
+    fields.push "N", 0, 0, 0
+  end
+
+  fields.push($halt_reason[trace.stop_reason] || "?")
+  fields.push trace.stop_data
+
+  # The following algorithm for determining path_complete is a transcription
+  # of the algorithm used by sc_analysis_dump for compatibility reasons.
+=begin
+  path_complete = "I"
+  if dest_response
+    hop = 0
+    trace.each do |hop, attempt, exists|
+      break if !exists || hop >= dest_response[0]
+    end
+    path_complete = "C" if hop == dest_response[0]
+  end
+  fields.push path_complete
+=end
+  fields.push(trace.complete? ? "C" : "I")
+
+  # For compatibility with sc_analysis_dump, we don't print missing hops
+  # at the end of the trace.
+  unresponsive = 0
+  trace.each_hop do |hop, exists|
+    if exists
+      hop_str = ""
+      trace.each_attempt(hop) do |attempt|
+	# sc_analysis_dump compatibility
+	next if dest_response &&
+	  hop == dest_response[0] && attempt == dest_response[1]
+
+	hop_str << ";" unless hop_str.empty?
+	hop_str << trace.hop_addr(hop, attempt)
+	hop_str << "," << trace.hop_rtt_str(hop, attempt)
+	hop_str << "," << trace.hop_probe_id(hop, attempt).to_s
+      end
+
+      unless hop_str.empty?
+	unresponsive.times { fields.push "q" }
+	unresponsive = 0
+
+	fields.push hop_str
+      end
+    else
+      unresponsive += 1
+    end
+  end
+
+  puts fields.join("\t")
+end
+
+
+#############################################################################
+# Main
+#############################################################################
+
+ARGV.each do |path|
+  file = Warts::File::open path
+  file.add_filters Warts::File::TRACE
+  while (trace = file.read)
+    show_trace trace
+  end
+end

data/bin/wdump

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+#############################################################################
+## A primitive version of warts-dump that demonstrates use of some of the
+## accessor methods on traces and trace hops.
+##
+## Maybe I'll expand this to be a replacement for warts-dump, like scdump
+## replaces sc_analysis_dump, as a more complete demonstration of using
+## rb-wartslib.
+##
+## $Id: wdump,v 1.9 2007/11/29 20:35:10 youngh Exp $
+#############################################################################
+
+require 'rubygems'
+require 'wartslib'
+
+def show_attr(object, name, *args)
+  print name.to_s, ": "
+  p object.send(name, *args)
+end
+
+def show_trace(trace)
+  [
+    :src,
+    :dst,
+    :hop_count,
+    :stop_reason,
+    :type,
+    :flags,
+    :attempts,
+    :hoplimit ,
+    :gaplimit,
+    :firsthop,
+    :tos,
+    :wait,
+    :loops,
+    :probe_size,
+    :sport,
+    :dport
+  ].each do |name|
+    show_attr trace, name
+  end
+
+  trace.each do |hop, attempt, exists|
+    unless exists
+      puts "hop #{hop}, attempt 0: *"
+      next
+    end
+
+    puts "hop #{hop}, attempt #{attempt}"
+    [
+      :hop_addr,
+      :hop_flags,
+      :hop_probe_id,
+      :hop_probe_ttl,
+      :hop_reply_ttl,
+      :hop_probe_size,
+      :hop_reply_size,
+      :hop_icmp_type,
+      :hop_icmp_code,
+      :hop_tcp_flags,
+      :hop_rtt_sec,
+      :hop_rtt_usec
+    ].each do |name|
+      print "  "
+      show_attr trace, name, hop, attempt
+    end
+  end
+end
+
+ARGV.each do |path|
+  puts "\n:::: #{path} ::::"
+  Warts::File::open(path) do |file|
+    file.add_filters Warts::File::TRACE
+    file.read do |trace|
+      puts "=" * 70
+      show_trace trace
+    end
+  end
+end
+

data/ext/extconf.rb

@@ -0,0 +1,32 @@
+##===========================================================================
+## Execute:
+##
+##  SCAMPER=../scamper-cvs-20070523h
+##  ruby extconf.rb --with-scamper-include=$SCAMPER --with-scamper-lib=$SCAMPER
+##
+## --------------------------------------------------------------------------
+## 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: extconf.rb,v 1.6 2007/11/29 01:41:47 youngh Exp $
+##===========================================================================
+
+require 'mkmf'
+
+have_header("stdint.h")
+dir_config("scamper")
+have_library("scamperfile", "scamper_trace_alloc")
+create_makefile("wartslibext")

data/ext/scaddr.c

@@ -0,0 +1,223 @@
+/*
+** Ruby bindings to scamper_addr_t.
+**
+** --------------------------------------------------------------------------
+** 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: scaddr.c,v 1.9 2007/11/29 01:42:07 youngh Exp $
+**/
+
+#include "ruby.h"
+
+#if defined(__HAVE_STDINT_H__)
+#include <stdint.h>
+#endif
+
+#include "scamper_file.h"
+#include "scaddr.h"
+
+extern VALUE mWarts;
+
+static VALUE cAddr;
+
+static ID iv_element_type;
+
+/*-------------------------------------------------------------------------*/
+
+#define DEF_CONST(name) \
+  rb_define_const(cAddr, #name, INT2FIX(SCAMPER_ADDR_TYPE_##name));
+
+
+/*-------------------------------------------------------------------------*/
+
+#define DEF_ATTR(name) \
+  rb_define_method(cAddr, #name, scaddr_attr_##name, 0);
+
+#define NUM_ATTR_FIELD_FUN(name,field)		  \
+  static VALUE scaddr_attr_##name(VALUE self) \
+  { \
+    scamper_addr_t *addr; \
+    Data_Get_Struct(self, scamper_addr_t, addr); \
+    return INT2NUM(addr->field); \
+  }
+
+#define NUM_ATTR_FUN(name) NUM_ATTR_FIELD_FUN(name,name)
+
+NUM_ATTR_FUN(type);
+NUM_ATTR_FUN(refcnt);  /* for debugging purposes only */
+
+
+/*-------------------------------------------------------------------------*/
+
+#define DEF_QUERY(name) \
+  rb_define_method(cAddr, #name "?", scaddr_query_##name, 0);
+
+#define QUERY_FUN(name,macro)		  \
+  static VALUE scaddr_query_##name(VALUE self) \
+  { \
+    scamper_addr_t *addr; \
+    Data_Get_Struct(self, scamper_addr_t, addr); \
+    return (addr->type == SCAMPER_ADDR_TYPE_##macro ? Qtrue: Qfalse); \
+  }
+
+QUERY_FUN(ipv4, IPV4);
+QUERY_FUN(ipv6, IPV6);
+QUERY_FUN(ethernet, ETHERNET);
+QUERY_FUN(firewire, FIREWIRE);
+
+
+/***************************************************************************/
+
+static void scaddr_free(void *data)
+{
+  if (data) {
+    scamper_addr_free((scamper_addr_t *)data);
+  }
+}
+
+static VALUE scaddr_alloc(VALUE klass)
+{
+  return Data_Wrap_Struct(klass, 0, scaddr_free, 0);
+}
+
+
+static VALUE scaddr_init(VALUE self)
+{
+  rb_ivar_set(self, iv_element_type, INT2FIX(SCAMPER_FILE_OBJ_ADDR));
+  return self;
+}
+
+
+#if 0
+static VALUE scaddr_init_copy(VALUE copy, VALUE orig)
+{
+  scamper_addr_t *orig_addr;
+
+  if (copy == orig) {
+    return copy;
+  }
+
+  /* See Pragmatic Programmer's book. */
+  if (TYPE(orig) != T_DATA || RDATA(orig)->dfree != scaddr_free) {
+    rb_raise(rb_eTypeError, "wrong argument type");
+  }
+
+  Data_Get_Struct(orig, scamper_addr_t, orig_addr);
+  DATA_PTR(copy) = scamper_addr_use(orig_addr);
+
+  return copy;
+}
+#endif
+
+
+static VALUE scaddr_cmp(VALUE self, VALUE other)
+{
+  scamper_addr_t *self_addr;
+  scamper_addr_t *other_addr;
+
+  if (other == self) {
+    return INT2FIX(0);
+  }
+
+  /* See Pragmatic Programmer's book. */
+  if (TYPE(other) != T_DATA || RDATA(other)->dfree != scaddr_free) {
+    rb_raise(rb_eTypeError, "wrong argument type");
+  }
+
+  Data_Get_Struct(self, scamper_addr_t, self_addr);
+  Data_Get_Struct(other, scamper_addr_t, other_addr);
+  return INT2FIX(scamper_addr_cmp(self_addr, other_addr));
+}
+
+
+static VALUE scaddr_addr(VALUE self)
+{
+  scamper_addr_t *addr;
+  char buf[128];
+
+  Data_Get_Struct(self, scamper_addr_t, addr);
+  return rb_str_new2(scamper_addr_tostr(addr, buf, 128));
+}
+
+
+static VALUE scaddr_write_to(VALUE self, VALUE file)
+{
+  return self;  /* nothing to do: users shouldn't write addrs themselves */
+}
+
+
+/*-------------------------------------------------------------------------*/
+
+VALUE scaddr_create(scamper_addr_t *addr)
+{
+  VALUE obj = Data_Wrap_Struct(cAddr, 0, scaddr_free, addr);
+
+  if (NIL_P(scaddr_init(obj))) {
+   return Qnil;
+  }
+
+  return obj;
+}
+
+
+/***************************************************************************/
+/***************************************************************************/
+
+void Init_scaddr(void)
+{
+  ID private_class_method_ID, private_ID;
+  ID new_ID, dup_ID, clone_ID;
+
+  iv_element_type = rb_intern("@element_type");
+
+  cAddr = rb_define_class_under(mWarts, "Addr", rb_cObject);
+
+  rb_include_module(cAddr, rb_mComparable);
+
+  DEF_CONST(IPV4);
+  DEF_CONST(IPV6);
+  DEF_CONST(ETHERNET);
+  DEF_CONST(FIREWIRE);
+
+  DEF_ATTR(type);
+  DEF_ATTR(refcnt);
+
+  DEF_QUERY(ipv4);
+  DEF_QUERY(ipv6);
+  DEF_QUERY(ethernet);
+  DEF_QUERY(firewire);
+
+  rb_define_alloc_func(cAddr, scaddr_alloc);
+
+  rb_define_attr(cAddr, "element_type", 1, 0);
+
+  rb_define_method(cAddr, "initialize", scaddr_init, 0);
+  /* rb_define_method(cAddr, "initialize_copy", scaddr_init_copy, 1); */
+  rb_define_method(cAddr, "<=>", scaddr_cmp, 1);
+  rb_define_method(cAddr, "addr", scaddr_addr, 0);
+  rb_define_method(cAddr, "write_to", scaddr_write_to, 1);
+
+  private_class_method_ID = rb_intern("private_class_method");
+  private_ID = rb_intern("private");
+  new_ID = rb_intern("new");
+  dup_ID = rb_intern("dup");
+  clone_ID = rb_intern("clone");
+
+  rb_funcall(cAddr, private_class_method_ID, 1, ID2SYM(new_ID));
+  rb_funcall(cAddr, private_ID, 1, ID2SYM(dup_ID));
+  rb_funcall(cAddr, private_ID, 1, ID2SYM(clone_ID));
+}

data/ext/scaddr.h

@@ -0,0 +1,32 @@
+/*
+** Ruby bindings to scamper_addr_t.
+**
+** --------------------------------------------------------------------------
+** 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: scaddr.h,v 1.2 2007/11/29 01:29:59 youngh Exp $
+**/
+
+#ifndef __SCADDR_H
+#define __SCADDR_H
+
+#include "scamper_addr.h"
+
+VALUE scaddr_create(scamper_addr_t *addr);
+void Init_scaddr(void);
+
+#endif  # __SCADDR_H