rb-wartslib 0.9.12 → 0.9.13

data/ext/scaddr.h

@@ -18,7 +18,7 @@
 ** 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 $
+** $Id: scaddr.h,v 1.3 2008/01/22 23:47:43 youngh Exp $
 **/
 
 #ifndef __SCADDR_H
@@ -29,4 +29,5 @@
 VALUE scaddr_create(scamper_addr_t *addr);
 void Init_scaddr(void);
 
-#endif  # __SCADDR_H
+#endif  /* __SCADDR_H */
+

data/ext/scext.c

@@ -19,7 +19,7 @@
 ** along with this program; if not, write to the Free Software
 ** Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 **
-** $Id: scext.c,v 1.22 2008/01/16 20:14:50 youngh Exp $
+** $Id: scext.c,v 1.24 2008/01/25 01:15:46 youngh Exp $
 **/
 
 #include "ruby.h"
@@ -29,6 +29,7 @@
 #endif
 
 #include "scamper.h"
+#include "scamper_file.h"
 
 #include "scaddr.h"
 #include "sclist.h"
@@ -41,9 +42,17 @@ void Init_wartslibext(void)
 {
   mWarts = rb_define_module("Warts");
 
-  rb_define_const(mWarts, "WARTS_LIB_VERSION", rb_str_new2("0.9.12"));
+  rb_define_const(mWarts, "WARTS_LIB_VERSION", rb_str_new2("0.9.13"));
   rb_define_const(mWarts, "SCAMPER_VERSION", rb_str_new2(SCAMPER_VERSION));
 
+  rb_define_const(mWarts, "LIST",        INT2FIX(SCAMPER_FILE_OBJ_LIST));
+  rb_define_const(mWarts, "CYCLE_START", INT2FIX(SCAMPER_FILE_OBJ_CYCLE_START));
+  rb_define_const(mWarts, "CYCLE_DEF",   INT2FIX(SCAMPER_FILE_OBJ_CYCLE_DEF));
+  rb_define_const(mWarts, "CYCLE_STOP",  INT2FIX(SCAMPER_FILE_OBJ_CYCLE_STOP));
+  rb_define_const(mWarts, "ADDR",        INT2FIX(SCAMPER_FILE_OBJ_ADDR));
+  rb_define_const(mWarts, "TRACE",       INT2FIX(SCAMPER_FILE_OBJ_TRACE));
+  rb_define_const(mWarts, "PING",        INT2FIX(SCAMPER_FILE_OBJ_PING));
+
   Init_scaddr();
   Init_sclist();
   Init_sccycle();

data/ext/scfile.c

@@ -18,7 +18,7 @@
 ** along with this program; if not, write to the Free Software
 ** Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 **
-** $Id: scfile.c,v 1.32 2008/01/16 20:15:39 youngh Exp $
+** $Id: scfile.c,v 1.33 2008/01/25 01:15:20 youngh Exp $
 **/
 
 #include <unistd.h>
@@ -647,6 +647,7 @@ void Init_scfile(void)
 
   cFile = rb_define_class_under(mWarts, "File", rb_cObject);
 
+  /* deprecated since 0.9.13 -- use the same constants in the Warts module */
   for (i = 0; i < num_sctypes; i++) {
     rb_define_const(cFile, all_sctypes[i].name,
 		    INT2FIX(all_sctypes[i].value));

data/ext/scfile.h

@@ -18,7 +18,7 @@
 ** along with this program; if not, write to the Free Software
 ** Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 **
-** $Id: scfile.h,v 1.2 2007/11/29 01:32:24 youngh Exp $
+** $Id: scfile.h,v 1.3 2008/01/22 23:48:23 youngh Exp $
 **/
 
 #ifndef __SCFILE_H
@@ -26,4 +26,5 @@
 
 void Init_scfile(void);
 
-#endif  # __SCFILE_H
+#endif  /* __SCFILE_H */
+

data/ext/sclist.h

@@ -18,7 +18,7 @@
 ** along with this program; if not, write to the Free Software
 ** Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 **
-** $Id: sclist.h,v 1.2 2007/11/29 01:32:57 youngh Exp $
+** $Id: sclist.h,v 1.3 2008/01/22 23:48:39 youngh Exp $
 **/
 
 #ifndef __SCLIST_H
@@ -31,4 +31,4 @@ VALUE sccycle_create(scamper_cycle_t *cycle, int type);
 void Init_sclist(void);
 void Init_sccycle(void);
 
-#endif  # __SCLIST_H
+#endif  /* __SCLIST_H */

data/ext/sctrace.c

@@ -27,7 +27,7 @@
 ** along with this program; if not, write to the Free Software
 ** Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 **
-** $Id: sctrace.c,v 1.46 2007/12/08 00:33:42 youngh Exp $
+** $Id: sctrace.c,v 1.59 2008/01/25 00:17:32 youngh Exp $
 **/
 
 #include "ruby.h"
@@ -36,7 +36,11 @@
 #include <stdint.h>
 #endif
 
+#include "scamper_addr.h"
+#include "scamper_list.h"
+#include "scamper_trace.h"
 #include "scamper_file.h"
+#include "scamper_tlv.h"
 #include "sctrace.h"
 #include "sclist.h"
 
@@ -50,9 +54,10 @@ static ID meth_write_trace;
 
 /*-------------------------------------------------------------------------*/
 
-#define DEF_CONST(name) \
-  rb_define_const(cTrace, #name, INT2FIX(SCAMPER_TRACE_##name));
+#define DEF_CONST2(field_name, macro_name) \
+  rb_define_const(cTrace, #field_name, INT2FIX(SCAMPER_TRACE_##macro_name));
 
+#define DEF_CONST(name) DEF_CONST2(name, name)
 
 /*-------------------------------------------------------------------------*/
 
@@ -142,6 +147,7 @@ static scamper_trace_hop_t *find_trace_hop(scamper_trace_t *trace,
 #define DEF_HOP_ATTR(name) \
   rb_define_method(cTrace, #name, sctrace_attr_##name, -1);
 
+
 /* Because this declares variables, this macro must occur
    immediately after the variable declarations in a function. */
 #define PROCESS_HOP_PARAMS \
@@ -150,14 +156,18 @@ static scamper_trace_hop_t *find_trace_hop(scamper_trace_t *trace,
     response = INT2FIX(0); \
   }
 
-#define NUM_HOP_ATTR_FIELD_FUN(name,field)		  \
-  static VALUE sctrace_attr_hop_##name(int argc, VALUE *argv, VALUE self) \
-  { \
+#define HOP_METHOD_BODY_BEGINNING \
     scamper_trace_t *trace; \
     scamper_trace_hop_t *trace_hop; \
     PROCESS_HOP_PARAMS; \
     Data_Get_Struct(self, scamper_trace_t, trace); \
     trace_hop = find_trace_hop(trace, NUM2INT(hop), NUM2INT(response));	\
+
+
+#define NUM_HOP_ATTR_FIELD_FUN(name,field)		  \
+  static VALUE sctrace_attr_hop_##name(int argc, VALUE *argv, VALUE self) \
+  { \
+    HOP_METHOD_BODY_BEGINNING; \
     if (!trace_hop) { \
       return Qnil; \
     } \
@@ -191,29 +201,151 @@ NUM_HOP_ATTR_FUN(probe_ttl);
 NUM_HOP_ATTR_FUN(reply_ttl);
 NUM_HOP_ATTR_FUN(probe_size);
 NUM_HOP_ATTR_FUN(reply_size);
-NUM_HOP_ATTR_FUN(icmp_type);
-NUM_HOP_ATTR_FUN(icmp_code);
-NUM_HOP_ATTR_FUN(tcp_flags);
 NUM_HOP_ATTR_FIELD_FUN(rtt_sec, rtt.tv_sec);
 NUM_HOP_ATTR_FIELD_FUN(rtt_usec, rtt.tv_usec);
 
+/*-------------------------------------------------------------------------*/
+
+#define HOP_FLAG_FUN(name,flag)				\
+  static VALUE sctrace_hop_##name(int argc, VALUE *argv, VALUE self) \
+  { \
+    HOP_METHOD_BODY_BEGINNING; \
+    if (!trace_hop) { \
+      return Qnil; \
+    } \
+    return ((trace_hop->hop_flags & SCAMPER_TRACE_HOP_FLAG_##flag) \
+            ? Qtrue : Qfalse);\
+  }
+
+#define HOP_NOT_FLAG_FUN(name,flag)				\
+  static VALUE sctrace_hop_##name(int argc, VALUE *argv, VALUE self) \
+  { \
+    HOP_METHOD_BODY_BEGINNING; \
+    if (!trace_hop) { \
+      return Qnil; \
+    } \
+    return ((trace_hop->hop_flags & SCAMPER_TRACE_HOP_FLAG_##flag) \
+            ? Qfalse : Qtrue);\
+  }
+
+/*
+** If a trace doesn't have a reply TTL, then the hop_reply_ttl accessor
+** returns 0.  The user should call hop_has_reply_ttl? to distinguish
+** a true 0 reply TTL from a missing reply TTL.
+*/
+HOP_FLAG_FUN(has_reply_ttl, REPLY_TTL);
+
+/*
+** The scamper_trace_hop.hop_un.hop_tcp_flags field is only valid if the TCP
+** flag is set.  Similarly, scamper_trace_hop.hop_un.hop_icmp_{type,code}
+** fields are only valid if the TCP flag is NOT set.
+*/
+HOP_FLAG_FUN(has_tcp_reply, TCP);
+HOP_NOT_FLAG_FUN(has_icmp_reply, TCP);
 
 /*-------------------------------------------------------------------------*/
 
-#define DEF_HOP_ICMP_QUERY(name) \
-  rb_define_method(cTrace, "hop_icmp_" #name "?", sctrace_hop_icmp_##name, -1);
+#define NUM_HOP_ATTR_FLAG_FUN(name,flag)				\
+  static VALUE sctrace_attr_hop_##name(int argc, VALUE *argv, VALUE self) \
+  { \
+    HOP_METHOD_BODY_BEGINNING; \
+    if (!trace_hop \
+        || (trace_hop->hop_flags & SCAMPER_TRACE_HOP_FLAG_##flag) == 0) {  \
+      return Qnil; \
+    } \
+    return UINT2NUM(trace_hop->hop_##name); \
+  }
 
-#define HOP_ICMP_QUERY_FUN(name,macro)		  \
-  static VALUE sctrace_hop_icmp_##name(int argc, VALUE *argv, VALUE self) \
+#define NUM_HOP_ATTR_NOT_FLAG_FUN(name,flag)				\
+  static VALUE sctrace_attr_hop_##name(int argc, VALUE *argv, VALUE self) \
+  { \
+    HOP_METHOD_BODY_BEGINNING; \
+    if (!trace_hop \
+        || (trace_hop->hop_flags & SCAMPER_TRACE_HOP_FLAG_##flag)) {  \
+      return Qnil; \
+    } \
+    return UINT2NUM(trace_hop->hop_##name); \
+  }
+
+NUM_HOP_ATTR_NOT_FLAG_FUN(icmp_type, TCP);
+NUM_HOP_ATTR_NOT_FLAG_FUN(icmp_code, TCP);
+NUM_HOP_ATTR_FLAG_FUN(tcp_flags, TCP);
+
+/*-------------------------------------------------------------------------*/
+
+#define DEF_HOP_TLV(name) \
+  rb_define_method(cTrace, #name, sctrace_tlv_##name, -1);
+
+#define NUM_HOP_TLV_FUN(name,type,size)				\
+  static VALUE sctrace_tlv_hop_##name(int argc, VALUE *argv, VALUE self) \
+  { \
+    scamper_trace_t *trace; \
+    scamper_trace_hop_t *trace_hop; \
+    const scamper_tlv_t *tlv;	    \
+    PROCESS_HOP_PARAMS; \
+    Data_Get_Struct(self, scamper_trace_t, trace); \
+    trace_hop = find_trace_hop(trace, NUM2INT(hop), NUM2INT(response));	\
+    if (!trace_hop) { \
+      return Qnil; \
+    } \
+    tlv = scamper_tlv_get(trace_hop->hop_tlvs, SCAMPER_TRACE_HOP_TLV_##type); \
+    return (tlv ? UINT2NUM(tlv->tlv_u.val_##size) : Qnil); \
+  }
+
+#define NUM_HOP_TLV_WITH_DEFAULT_FUN(name,type,size,default_value)	\
+  static VALUE sctrace_tlv_hop_##name(int argc, VALUE *argv, VALUE self) \
   { \
     scamper_trace_t *trace; \
     scamper_trace_hop_t *trace_hop; \
+    const scamper_tlv_t *tlv;	    \
     PROCESS_HOP_PARAMS; \
     Data_Get_Struct(self, scamper_trace_t, trace); \
     trace_hop = find_trace_hop(trace, NUM2INT(hop), NUM2INT(response));	\
     if (!trace_hop) { \
       return Qnil; \
     } \
+    tlv = scamper_tlv_get(trace_hop->hop_tlvs, SCAMPER_TRACE_HOP_TLV_##type); \
+    return UINT2NUM(tlv ? tlv->tlv_u.val_##size : default_value); \
+  }
+
+NUM_HOP_TLV_FUN(reply_ipid, REPLY_IPID, 16);
+NUM_HOP_TLV_FUN(reply_iptos, REPLY_IPTOS, 8);
+NUM_HOP_TLV_FUN(next_hop_mtu, NHMTU, 16);
+NUM_HOP_TLV_WITH_DEFAULT_FUN(inner_iplen, INNER_IPLEN, 16,
+			     trace_hop->hop_probe_size);
+NUM_HOP_TLV_WITH_DEFAULT_FUN(inner_ipttl, INNER_IPTTL, 8, 1);
+
+/*
+ * INNER_IPTOS was introduced in scamper-cvs-20070523j.new (Jan 20,
+ * 2008).  Some care is needed, however, because a missing inner iptos
+ * tlv can mean two completely different things: (A) the inner iptos
+ * is the same as the probe iptos (scamper j.new or later), or (B) the
+ * inner iptos may or may not be the same as the probe iptos (scamper
+ * prior to j.new).
+ *
+ * It would be nice to have the inner_iptos accessor method return the
+ * probe tos if no tlv is found, but that would be misleading for older
+ * trace files.  Hence, this returns nil when no tlv is found, and leaves
+ * it to the user to disambiguate this result based on external knowledge.
+ */
+#ifndef SCAMPER_TRACE_HOP_TLV_INNER_IPTOS
+#define SCAMPER_TRACE_HOP_TLV_INNER_IPTOS 0x06 /* 1 byte  */
+#endif
+
+NUM_HOP_TLV_FUN(inner_iptos, INNER_IPTOS, 8);
+
+/*-------------------------------------------------------------------------*/
+
+#define DEF_HOP_ICMP_QUERY(name) \
+  rb_define_method(cTrace, "hop_icmp_" #name "?", sctrace_hop_icmp_##name, -1);
+
+#define HOP_ICMP_QUERY_FUN(name,macro)		  \
+  static VALUE sctrace_hop_icmp_##name(int argc, VALUE *argv, VALUE self) \
+  { \
+    HOP_METHOD_BODY_BEGINNING; \
+    if (!trace_hop) { \
+      return Qnil; \
+    } \
     return SCAMPER_TRACE_HOP_IS_ICMP_##macro(trace_hop) ? Qtrue : Qfalse; \
   }
 
@@ -284,7 +416,7 @@ static VALUE sctrace_src(VALUE self)
 }
 
 
-static VALUE sctrace_dst(VALUE self)
+static VALUE sctrace_dest(VALUE self)
 {
   scamper_trace_t *trace;
   char buf[128];
@@ -314,7 +446,7 @@ static VALUE sctrace_src_cmp(VALUE self, VALUE other)
 }
 
 
-static VALUE sctrace_dst_cmp(VALUE self, VALUE other)
+static VALUE sctrace_dest_cmp(VALUE self, VALUE other)
 {
   scamper_trace_t *self_trace;
   scamper_trace_t *other_trace;
@@ -403,6 +535,33 @@ static VALUE sctrace_set_cycle(VALUE self, VALUE cycle_v)
 
 /*-------------------------------------------------------------------------*/
 
+static VALUE sctrace_hop_tcp_flags_breakdown(int argc, VALUE *argv, VALUE self)
+{
+  scamper_trace_t *trace;
+  scamper_trace_hop_t *th;
+  VALUE retval;
+
+  PROCESS_HOP_PARAMS;
+  Data_Get_Struct(self, scamper_trace_t, trace);
+  th = find_trace_hop(trace, NUM2INT(hop), NUM2INT(response));
+  if (!th || (th->hop_flags & SCAMPER_TRACE_HOP_FLAG_TCP) == 0) {
+    return Qnil;
+  }
+
+  retval = rb_ary_new();
+  if (th->hop_tcp_flags & 0x01) { rb_ary_push(retval, rb_str_new2("fin")); }
+  if (th->hop_tcp_flags & 0x02) { rb_ary_push(retval, rb_str_new2("syn")); }
+  if (th->hop_tcp_flags & 0x04) { rb_ary_push(retval, rb_str_new2("rst")); }
+  if (th->hop_tcp_flags & 0x08) { rb_ary_push(retval, rb_str_new2("psh")); }
+  if (th->hop_tcp_flags & 0x10) { rb_ary_push(retval, rb_str_new2("ack")); }
+  if (th->hop_tcp_flags & 0x20) { rb_ary_push(retval, rb_str_new2("urg")); }
+  if (th->hop_tcp_flags & 0x40) { rb_ary_push(retval, rb_str_new2("ece")); }
+  if (th->hop_tcp_flags & 0x80) { rb_ary_push(retval, rb_str_new2("cwr")); }
+  /* there are only 8 flag bits, so no more possible */
+  return retval;
+}
+
+
 static VALUE sctrace_attr_hop_addr(int argc, VALUE *argv, VALUE self)
 {
   scamper_trace_t *trace;
@@ -761,10 +920,21 @@ void Init_sctrace(void)
   DEF_CONST(STOP_UNREACH);
   DEF_CONST(STOP_ICMP);
   DEF_CONST(STOP_LOOP);
-  DEF_CONST(STOP_DEAD);
+
+#ifdef SCAMPER_TRACE_STOP_GAPLIMIT  /* scamper-cvs-20070523j.new (20080120) */
+  DEF_CONST2(STOP_DEAD, STOP_GAPLIMIT);  /* deprecated */
+  DEF_CONST(STOP_GAPLIMIT);
+#else
+  DEF_CONST(STOP_DEAD);                  /* deprecated */
+  DEF_CONST2(STOP_GAPLIMIT, STOP_DEAD);
+#endif
+
   DEF_CONST(STOP_ERROR);
+
 #ifdef SCAMPER_TRACE_STOP_HOPLIMIT  /* scamper-cvs-20070523 */
   DEF_CONST(STOP_HOPLIMIT);
+#else
+  DEF_CONST2(STOP_HOPLIMIT, 0x07);
 #endif
 
   DEF_CONST(FLAG_ALLATTEMPTS);
@@ -782,6 +952,7 @@ void Init_sctrace(void)
   DEF_CONST(HOP_FLAG_TS_DL_RX);
   DEF_CONST(HOP_FLAG_TS_TSC);
   DEF_CONST(HOP_FLAG_REPLY_TTL);
+  DEF_CONST(HOP_FLAG_TCP);
 
   DEF_ATTR(list_id);
   DEF_ATTR(list_name);
@@ -827,20 +998,32 @@ void Init_sctrace(void)
   DEF_HOP_ATTR(hop_rtt_sec);
   DEF_HOP_ATTR(hop_rtt_usec);
 
+  DEF_HOP_TLV(hop_reply_ipid);
+  DEF_HOP_TLV(hop_reply_iptos);
+  DEF_HOP_TLV(hop_next_hop_mtu);
+  DEF_HOP_TLV(hop_inner_iplen);
+  DEF_HOP_TLV(hop_inner_ipttl);
+  DEF_HOP_TLV(hop_inner_iptos);
+
   rb_define_alloc_func(cTrace, sctrace_alloc);
 
   rb_define_attr(cTrace, "element_type", 1, 0);
 
   rb_define_method(cTrace, "initialize", sctrace_init, 0);
   rb_define_method(cTrace, "src", sctrace_src, 0);
-  rb_define_method(cTrace, "dst", sctrace_dst, 0);
+  rb_define_method(cTrace, "dest", sctrace_dest, 0);
   rb_define_method(cTrace, "src_cmp", sctrace_src_cmp, 1);
-  rb_define_method(cTrace, "dst_cmp", sctrace_dst_cmp, 1);
+  rb_define_method(cTrace, "dest_cmp", sctrace_dest_cmp, 1);
   rb_define_method(cTrace, "write_to", sctrace_write_to, 1);
   rb_define_method(cTrace, "list", sctrace_list, 0);
   rb_define_method(cTrace, "cycle", sctrace_cycle, 0);
   rb_define_method(cTrace, "cycle=", sctrace_set_cycle, 1);
   rb_define_method(cTrace, "hop_exists?", sctrace_hop_exists, -1);
+  rb_define_method(cTrace, "hop_has_reply_ttl?", sctrace_hop_has_reply_ttl, -1);
+  rb_define_method(cTrace, "hop_has_tcp_reply?", sctrace_hop_has_tcp_reply, -1);
+  rb_define_method(cTrace, "hop_has_icmp_reply?",sctrace_hop_has_icmp_reply,-1);
+  rb_define_method(cTrace, "hop_tcp_flags_breakdown",
+		   sctrace_hop_tcp_flags_breakdown, -1);
   rb_define_method(cTrace, "hop_dest_response?", sctrace_hop_dest_response,-1);
   rb_define_method(cTrace, "find_dest_response", sctrace_find_dest_response,0);
   rb_define_method(cTrace, "complete?", sctrace_complete, 0);
@@ -858,6 +1041,10 @@ void Init_sctrace(void)
   rb_define_alias(cTrace, "each_attempt", "each_response");
   rb_define_alias(cTrace, "each_hop_and_attempt", "each_hop_and_response");
 
+  /* deprecated methods as of v0.9.13 */
+  rb_define_alias(cTrace, "dst", "dest");
+  rb_define_alias(cTrace, "dst_cmp", "dest_cmp");
+
   DEF_HOP_ICMP_QUERY(ttl_exp);
   DEF_HOP_ICMP_QUERY(ttl_exp_trans);
   DEF_HOP_ICMP_QUERY(packet_too_big);

data/ext/sctrace.h

@@ -19,7 +19,7 @@
 ** along with this program; if not, write to the Free Software
 ** Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 **
-** $Id: sctrace.h,v 1.3 2007/11/29 01:33:42 youngh Exp $
+** $Id: sctrace.h,v 1.4 2008/01/22 23:49:09 youngh Exp $
 **/
 
 #ifndef __SCFILE_H
@@ -32,4 +32,5 @@
 VALUE sctrace_create(scamper_trace_t *trace);
 void Init_sctrace(void);
 
-#endif  # __SCFILE_H
+#endif  /* __SCFILE_H */
+