Module: Scriptroute

Defined in:
lib/scriptroute.rb,
lib/scriptroute/ally.rb,
lib/scriptroute/nameify.rb,
lib/scriptroute/packets.rb,
lib/scriptroute/packets.rb,
lib/scriptroute/liveness.rb,
lib/scriptroute/tulip/loss.rb,
lib/scriptroute/rockettrace.rb,
lib/scriptroute/tulip/helper.rb,
lib/scriptroute/tulip/queuing.rb,
lib/scriptroute/tulip/reordering.rb

Defined Under Namespace

Modules: Tulip, UDPgeneric Classes: Ally, ConnectionPool, EndOfOptions_option, ICMP, ICMP6, ICMP6echo, ICMP6unreach, ICMPecho, ICMPmaskreq, ICMPparamter_problem, ICMPtstamp, ICMPunreach, IP, IPaddress, IPv4, IPv4option, IPv6, LivenessTest, NOOP_option, NTP, ProbeResponse, RecordRoute_option, Rockettrace, ScriptrouteConnection, ScriptrouteError, TCP, TimedPacket, Timestamp_option, UDP, UDP6

Class Method Summary collapse

Class Method Details

.daemon_running_or_exit ⇒ true

Exit failure if the scriptroute daemon does not appear to be running. This is useful at the beginning of scripts that expect the daemon to run, to avoid adding extra error checking later.

Returns:

  • (true) —

    if the script does ot exit because the daemon is not running.



205
206
207
208
209
210
211
212
213
214
 
# File 'lib/scriptroute.rb', line 205

def Scriptroute::daemon_running_or_exit
  begin
    with_scriptroute_connection do |c|
    end
    return true
  rescue Errno::ECONNREFUSED
    puts "Ensure that the scriptroute daemon is running and try again"
    exit 1
  end
end

.DaemonConfig ⇒ Hash

Returns the configuration of the running daemon, useful for checking rate limiting parameters or filters if a specially configured daemon is needed.

Returns:

  • (Hash) —

    the configuration of the running daemon, useful for checking rate limiting parameters or filters if a specially configured daemon is needed.



234
235
236
237
238
239
240
241
242
 
# File 'lib/scriptroute.rb', line 234

def Scriptroute::DaemonConfig
  ret = nil
  unless @@config then
    with_scriptroute_connection do |c|
      @@config = c.get_config
    end
  end
  @@config
end

.DaemonVersion ⇒ String

Query for the version of the daemon; useful if there’s a feature only supported in a particular version. @return

Returns:

  • (String) —

    the version string provided by of the running daemon



218
219
220
221
222
 
# File 'lib/scriptroute.rb', line 218

def Scriptroute::DaemonVersion
  with_scriptroute_connection do |c|
    puts c.one_line_command("version\n")
  end
end

.dns_lookup(name) ⇒ String

Returns An IP address associated with the hostname. Currently just invokes Resolv.getaddress.

Returns:

  • (String) —

    An IP address associated with the hostname. Currently just invokes Resolv.getaddress.



225
226
227
 
# File 'lib/scriptroute.rb', line 225

def Scriptroute::dns_lookup(name)
  Resolv.getaddress name
end

.is_daemon_running? ⇒ Boolean

Check if the daemon is running by making a connection or checking the pool for an unused but working connection.

Returns:

  • (Boolean) 


190
191
192
193
194
195
196
197
198
 
# File 'lib/scriptroute.rb', line 190

def Scriptroute::is_daemon_running?
  begin
    with_scriptroute_connection do |c|
    end
    return true
  rescue Errno::ECONNREFUSED
    return false
  end
end

.nameify(addr) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/scriptroute/nameify.rb', line 44

def Scriptroute::nameify(addr)
  unless addr.is_a?(Scriptroute::IPaddress) then
    # if not a known IP address, validate.
    if addr == nil or addr == '' then 
      # empty string. usually a mistake somewhere.
      $stderr.puts "nameify('') called from:\n  " + Kernel.caller.join("\n   ")
      return addr
    end
    if(! /^\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$/.match(addr)) then
      # not an ip address looking thing.
      $stderr.puts "nameify(#{addr}) called from:\n  " + Kernel.caller.join("\n   ")
      return addr
    end
  end
  name =
    if($have_resolv) then
      begin
        Resolv.getnames(addr.to_s)[0]
      rescue ArgumentError => boom
        # seems to happen for RFC1918 space, but probably just for those
        # addresses without a name.
        $stderr.puts "argument error resolving '#{addr}' to name using resolv: " + boom
        nil 
      rescue SocketError => boom
        nil
      end
    elsif($have_socket) then
      begin
        name = (Socket.gethostbyname(addr.to_s)[0]).gsub(/\"/,'')
        name
      rescue ArgumentError => boom
        # seems to happen for RFC1918 space, but probably just for those
        # addresses without a name.
        $stderr.puts "argument error resolving '#{addr}' to name: " + boom
        nil 
      rescue SocketError => boom
        nil
      end
    else
      nil
    end
  attributes = if($have_undns) then
                 if(name) then
                   asn = Undns.get_asn_bydns(name)
                   if($have_origins) then
                     " [%d/%d]" % [ asn, Undns.origin_for_address_str(addr) ]
                   elsif(asn > 0) then
                     " [%d]" % [ asn ]
                   else
                     ""
                   end +
                     if(asn > 0) then
                       " {%s}" % [ Undns.get_loc(asn, name) ]
                     else
                       ""
                     end
                 elsif($have_origins) then
                   # don't have a name.
                   " [/%d]" % [ Undns.origin_for_address_str(addr) ]
                 else
                   ""
                 end
               else
                 ""
               end

  if(name) then
    name + ' (' + addr.to_s + ')' + attributes
  else
    addr.to_s + attributes
  end
end

.pkt_from_string(s) ⇒ String

no op for backward compatibility with the srinterpreter version that had a dedicated packet instance

Parameters:

  • s (String) —

    A marshaled packet.

Returns:

  • (String) —

    The input parameter, which is sufficient for this implementation of send_train.



247
248
249
 
# File 'lib/scriptroute.rb', line 247

def Scriptroute::pkt_from_string(s)
  s
end

.send_train(train) ⇒ Array<Scriptroute::ProbeResponse>

This is the nut.

Parameters:

  • train (Array<Struct::DelayedPacket,Array>) —

    an array of Struct::DelayedPacket entries or arrays containing delay, packet pairs.

Returns:



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/scriptroute.rb', line 253

def Scriptroute::send_train(train)
  ret = nil
  return [] if train.empty? # easy?
  with_scriptroute_connection do |c|
    # issue the send train command.
    i = 1;
    total_delay = 0
    train.map! { |boxcar|
      raise ArgumentError, 'nil entry' unless boxcar
      if boxcar.is_a?(Array) then
        Struct::DelayedPacket.new(*boxcar)
      else
        raise ArgumentError, 'not a boxcar or an array' unless boxcar.is_a?(Struct::DelayedPacket)
        boxcar
      end
    }
    train.each { |boxcar|
      # needs validation.
      delay = boxcar[:delay]
      packet = boxcar[:packet]
      raise "no packet" unless packet
      if packet.is_a?(Scriptroute::IP) then
        packet = packet.marshal
      end
      raise "packet is #{packet.class}, not a string" unless packet.is_a?(String)
      encoded_packet = Base64.strict_encode64(packet) # strict_encode means no line feeds added.
      c.issue_command "sendtrain %d/%d %f %d %s\n" % [ i, train.length, delay<0 ? 0 : delay, encoded_packet.length, encoded_packet ]
      i+=1
      total_delay += delay
    }

    # allocate space for the responses, array of probe response pairs, each of which will be a time/packet pair.
    ret = Array.new(i-1) { ProbeResponse.new }

    # collect, waiting maybe 5 minutes more than needed just in case the daemon hangs on us.
    begin
      timeout(total_delay + 300) do
        while l = c.get_reply and l !~ /^done/ and l =~ /\S+/ do
          if l =~ /^ERROR/ then
            # have to throw an exception, although individual packet errors are possible, that's
            # not communicated by the daemon.
            $stderr.puts l
            if l=~ /disjoint train \missing packet #(\d+)/ then
              ret[ $1.to_i ].probe = nil
              ret[ $1.to_i ].response = nil
            end
            raise ScriptrouteError, l
          else
            if l =~ /^(-?\d+\.\d+)\/(\d+) (\d+)([<>]) \d+ (\S+)$/ then
              tv_s = $1.to_f
              rdtsc = $2
              pk = $3.to_i - 1
              io = ($4 == '>') ? 0 : 1
              st = $5
              packet_string = Base64.strict_decode64(st)
              p = IP.creator(packet_string)
              tv_s = nil if tv_s < 0 # didn't see it leave.
              tp = TimedPacket.new(tv_s, rdtsc, p)
              if io == 0 then
                ret[ pk ].probe = tp
              else
                ret[ pk ].response = tp
              end
            else
              puts "unparsed send_train response: #{l}"
            end
          end
        end # while
      end # timeout
    rescue TimeoutError
      $stderr.puts "timed out parsing responses for send_train"
    end
  end
  return ret
end

.with_scriptroute_connection {|ScriptrouteConnection| ... } ⇒ Object

Take a block to be executed with a ScriptrouteConnection from the pool. This is the function to use, since it manages the pooled connections explicitly. A leak in connections would be bad.

Yields:

Returns:

  • the output of the block



181
182
183
184
185
186
 
# File 'lib/scriptroute.rb', line 181

def Scriptroute::with_scriptroute_connection
  c = ConnectionPool.get_idle_connection
  r = yield c
  ConnectionPool.return_idle_connection(c)
  r
end