ospfv2 0.0.1

data/lib/ls_db/link_state_database_links.rb

@@ -0,0 +1,178 @@
+#--
+# Copyright 2010 Jean-Michel Esnault.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#
+#
+# This file is part of OSPFv2.
+# 
+# OSPFv2 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 3 of the License, or
+# (at your option) any later version.
+# 
+# OSPFv2 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 OSPFv2.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'ls_db/link_state_database'
+require 'ls_db/links'
+require 'lsa/lsa'
+
+module OSPFv2
+
+
+  class Lsa
+    def lsdb_link_id
+      @_lsdb_link_id
+    end
+    def lsdb_link_id=(val)
+      @_lsdb_link_id= val
+    end
+    def find_lsa_from_link(id)
+      all.find_all { |l| l.lsdb_link_id==id  }
+    end
+  end
+
+end
+
+module OSPFv2::LSDB
+
+  class LinkStateDatabase
+
+    def self.router_id(row, col, base_rid=ROUTER_ID_BASE)
+      (row << 16) + col + base_rid      
+    end
+
+    def router_id(*args)
+      LinkStateDatabase.router_id(*args)
+    end  
+
+    # lsdb = LinkStateDatabase.create 10, 10, :prefix => '192.168.0.0/24'
+    # lsdb = LinkStateDatabase.create 10, 10, :prefix_base => '192.168.0.0/24', :router_id_base => 
+    def self.create(arg={})
+      arg = {:area_id=> 0, :columns=>2, :rows=>2, :base_router_id=> 0, :base_prefix=>'172.21.0.0/30'}.merge(arg)
+      ls_db = new arg
+      rows=arg[:rows]
+      cols=arg[:columns]
+      @base_router_id = arg[:base_router_id] 
+      if arg[:base_prefix]
+        Link.reset_ip_addr
+        Link.base_ip_addr arg[:base_prefix]
+      end
+      @base_prefix = arg[:base_prefix]
+      router_id = lambda { |c,r|  (r<<16) + c + @base_router_id }
+      1.upto(rows) do |r|
+        1.upto(cols) do |c|
+          ls_db.new_link(:router_id=> router_id.call(c,r-1), :neighbor_id=> router_id.call(c,r)) if r > 1
+          ls_db.new_link(:router_id=> router_id.call(c-1,r), :neighbor_id=> router_id.call(c,r)) if c > 1
+        end
+      end
+      ls_db
+    end
+
+    # link, :dir => :local_only
+    # link_hash, :direction => :remote_only
+
+    def new_link(*args)
+
+      # get a link object
+      local, remote = true, true
+      if args.size==1 and args[0].is_a?(Hash)
+        link = Link.new args[0]
+      elsif args[0].is_a?(Link)
+        link = args[0]
+      else
+        raise ArgumentError, "invalid argument: #{args.inspect}"
+      end
+      
+      # local, remote or both
+      dir = args[0][:direction] ||= :both
+      local = false  if dir and dir == :remote_only
+      remote = false if dir and dir == :local_only
+      
+      if local
+        lsa = add_p2p_adjacency :router_id => link.router_id.to_i, :neighbor_router_id => link.neighbor_id.to_i, :prefix => link.local_prefix, :metric=>1
+        lsa.lsdb_link_id = link.id
+        link.local_lsa = lsa.key
+      end
+
+      if remote
+        lsa = add_p2p_adjacency :router_id => link.neighbor_id.to_i, :neighbor_router_id => link.router_id.to_i, :prefix => link.remote_prefix, :metric=>1
+        lsa.lsdb_link_id = link.id
+        link.remote_lsa = lsa.key
+      end
+      
+    end
+    
+    def link(link, action)
+      raise ArgumentError, "invalid argument: #{link.class}" unless link.is_a?(Link)
+      case action
+      when :up   ; link_up(link)
+      when :down ; link_down(link)
+      end
+    end
+
+    def link_up(link)
+      raise ArgumentError, "invalid argument: #{link.class}" unless link.is_a?(Link)
+      add_adjacency :router_id=> link.router_id.to_i, 
+                    :neighbor_router_id => link.neighbor_id.to_i, 
+                    :prefix=> link.local_prefix, 
+                    :metric => link.metric 
+      add_adjacency :router_id=> link.neighbor_id.to_i, 
+                    :neighbor_router_id => link.router_id.to_i, 
+                    :prefix=> link.remote_prefix, 
+                    :metric => link.metric      
+    end
+
+    def link_down(link)      
+      lsa = @ls_db[link.local_lsa]
+      lsa.delete(1, link.neighbor_id.to_ip)
+      lsa = @ls_db[link.remote_lsa]
+      lsa.delete(1, link.router_id.to_ip)
+    end
+
+    def link_refresh
+
+    end
+
+    def link_maxage
+
+    end
+
+  end
+  
+  # @ls_db = LinkStateDatabase.new :area_id=>0
+  #  @ls_db.new_link :router_id=> 1, :neighbor_id=>2
+  #  @ls_db.new_link :router_id=> 1, :neighbor_id=>3
+  #  @ls_db.new_link :router_id=> 1, :neighbor_id=>4
+  #  @ls_db.new_link :router_id=> 1, :neighbor_id=>5
+  # 
+  #  puts @ls_db
+  #  
+  #  # p Link[1]
+  # 
+  # rlsa =  @ls_db[1,1]
+  # p rlsa.links.size
+  # p rlsa
+  # rlsa.delete(:point_to_point,'0.0.0.2')
+  # p rlsa.links.size
+  # 
+  # rlsa =  @ls_db[1,2]
+  # p rlsa.links.size
+  # p rlsa
+  # rlsa.delete(:point_to_point,'0.0.0.1')
+  # p rlsa.links.size
+  # 
+  # puts @ls_db
+  
+ 
+end
+
+load "../../../test/ospfv2/ls_db/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0
+

data/lib/ls_db/links.rb

@@ -0,0 +1,160 @@
+#--
+# Copyright 2010 Jean-Michel Esnault.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#
+#
+# This file is part of OSPFv2.
+# 
+# OSPFv2 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 3 of the License, or
+# (at your option) any later version.
+# 
+# OSPFv2 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 OSPFv2.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+require 'infra/ospf_common'
+require 'ie/id'
+require 'ie/metric'
+require 'ie/mt_metric'
+require 'ls_db/common'
+
+module OSPFv2::LSDB
+
+  class Link
+
+    class << self
+        
+      def <<(val)
+        @_links ||={}
+        @_links.store(val.id, val)
+      end
+
+      def all
+        @_links ||={}
+        @_links
+      end
+
+      def ids
+        @_links ||={}
+        @_links.keys
+      end
+
+      def count
+        @count ||= 0
+      end
+
+      def incr_count
+        self.count
+        @count += 1
+      end
+
+      def reset
+        @_links={}
+        @count = nil
+      end
+
+      def base_ip_addr(addr=LINK_BASE_ADDRESS)
+        @base_addr ||= IPAddr.new(addr)
+      end
+
+      def find_by_id(router_id)
+        all.find_all { |k,v| v.router_id.to_ip == router_id }
+      end
+
+      def reset_ip_addr
+        @base_addr=nil
+      end
+      
+      def [](val)
+        @_links[val]
+      end
+
+    end
+    
+    include OSPFv2::Common
+
+    #FIXME: all IE should be in an IE namespace
+    RouterId = Class.new(OSPFv2::Id)
+    NeighborId = Class.new(OSPFv2::Id)
+
+    attr_reader :router_id, :neighbor_id, :metric
+
+    #TODO: :metric => [10,20] ... revisit
+    #      :metric_ifa => 10, :metric_ifb=>20
+    def initialize(arg={})
+      @_state = :down
+      @_id = self.class.incr_count
+      @prefix=nil
+      @router_id= RouterId.new arg[:router_id] || '1.1.1.1'
+      @neighbor_id= NeighborId.new arg[:neighbor_id] || '2.2.2.2'
+      @metric = 0
+      set arg
+      @lsas=[]
+      Link << self
+      self
+    end
+    [:local, :remote].each_with_index { |n,i| 
+      define_method("#{n}_prefix") do
+        instance_variable_set("@_#{n}_prefix", _address_(i+1))
+      end 
+    }
+
+    def id
+      @_id
+    end
+
+    attr_reader :local_lsa, :remote_lsa
+
+    def local_lsa=(lsa)
+      @local_lsa=lsa
+    end
+    
+    def remote_lsa=(lsa)
+      @remote_lsa=lsa
+    end    
+
+    def network
+      @network ||=IPAddr.new(Link.base_ip_addr.^(@_id-1))
+    end
+
+    def to_s
+      rid = router_id.to_s.split(":")
+      nid = neighbor_id.to_s.split(":")
+      sprintf("%3d\# %s: %-15.15s  %s:%-15.15s Network %-15.15s %s",
+      @_id, rid[0], rid[1], nid[0], nid[1], network_to_s, metric)
+    end
+
+    def network_to_s
+      [network, network.mlen].join('/')
+    end
+
+    def method_missing(name, *args, &block)
+      if name.to_s =~ /^(local|remote)_address/
+        (__send__ "#{$1}_prefix").split('/')[0]
+      else
+        p name
+        raise
+      end
+    end
+
+
+    private
+
+
+    def _address_(host=1)
+      network + host
+    end
+
+  end
+  
+end
+
+load "../../../test/ospfv2/ls_db/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0

data/lib/lsa/external.rb

@@ -0,0 +1,347 @@
+#--
+# Copyright 2010 Jean-Michel Esnault.
+# All rights reserved.
+# See LICENSE.txt for permissions.
+#
+#
+# This file is part of OSPFv2.
+# 
+# OSPFv2 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 3 of the License, or
+# (at your option) any later version.
+# 
+# OSPFv2 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 OSPFv2.  If not, see <http://www.gnu.org/licenses/>.
+#++
+
+=begin rdoc
+
+A.4.5 AS-external-LSAs
+
+    AS-external-LSAs are the Type 5 LSAs.  These LSAs are originated by
+    AS boundary routers, and describe destinations external to the AS.
+    For details concerning the construction of AS-external-LSAs, see
+    Section 12.4.3.
+
+    AS-external-LSAs usually describe a particular external destination.
+    For these LSAs the Link State ID field specifies an IP network
+    number (if necessary, the Link State ID can also have one or more of
+    the network's "host" bits set; see Appendix E for details).  AS-
+    external-LSAs are also used to describe a default route.  Default
+    routes are used when no specific route exists to the destination.
+    When describing a default route, the Link State ID is always set to
+    DefaultDestination (0.0.0.0) and the Network Mask is set to 0.0.0.0.
+
+
+        0                   1                   2                   3
+        0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+       |            LS age             |     Options   |      5        |
+       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+       |                        Link State ID                          |
+       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+       |                     Advertising Router                        |
+       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+       |                     LS sequence number                        |
+       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+       |         LS checksum           |             length            |
+       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+       |                         Network Mask                          |
+       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+       |E|     0       |                  metric                       |
+       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+       |                      Forwarding address                       |
+       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+       |                      External Route Tag                       |
+       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+       |E|    TOS      |                TOS  metric                    |
+       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+       |                      Forwarding address                       |
+       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+       |                      External Route Tag                       |
+       +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+       |                              ...                              |
+
+
+
+    Network Mask
+        The IP address mask for the advertised destination.  For
+        example, when advertising a class A network the mask 0xff000000
+        would be used.
+
+    bit E
+        The type of external metric.  If bit E is set, the metric
+        specified is a Type 2 external metric.  This means the metric is
+        considered larger than any link state path.  If bit E is zero,
+        the specified metric is a Type 1 external metric.  This means
+        that it is expressed in the same units as the link state metric
+        (i.e., the same units as interface cost).
+
+    metric
+        The cost of this route.  Interpretation depends on the external
+        type indication (bit E above).
+
+    Forwarding address
+        Data traffic for the advertised destination will be forwarded to
+        this address.  If the Forwarding address is set to 0.0.0.0, data
+        traffic will be forwarded instead to the LSA's originator (i.e.,
+        the responsible AS boundary router).
+
+    External Route Tag
+        A 32-bit field attached to each external route.  This is not
+        used by the OSPF protocol itself.  It may be used to communicate
+        information between AS boundary routers; the precise nature of
+        such information is outside the scope of this specification.
+
+    Additional TOS-specific information may also be included, for
+    backward compatibility with previous versions of the OSPF
+    specification ([Ref9]). For each desired TOS, TOS-specific
+    information is encoded as follows:
+
+    TOS The Type of Service that the following fields concern.  The
+        encoding of TOS in OSPF LSAs is described in Section 12.3.
+
+    bit E
+        For backward-compatibility with [Ref9].
+
+    TOS metric
+        TOS-specific metric information.
+
+    Forwarding address
+        For backward-compatibility with [Ref9].
+
+    External Route Tag
+        For backward-compatibility with [Ref9].
+
+
+
+(RFC 4915)
+
+        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+        |                         Network Mask                          |
+        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+        |E|     0       |                  metric                       |
+        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+        |                      Forwarding address                       |
+        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+        |                      External Route Tag                       |
+        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+        |E|    MT-ID    |              MT-ID  metric                    |
+        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+        |                      Forwarding address                       |
+        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+        |                      External Route Tag                       |
+        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+        |                              ...                              |
+        +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+=end
+
+
+require 'lsa/lsa'
+
+require 'ie/metric'
+require 'ie/mt_metric'
+require 'ie/id'
+require 'ie/external_route'
+
+module OSPFv2
+  
+  class External_Base < Lsa
+    
+    Netmask = Class.new(OSPFv2::Id)
+    ExternalRoute = Class.new(OSPFv2::ExternalRoute)
+    
+    
+    attr_reader :netmask, :external_route, :mt_metrics
+    attr_writer_delegate :netmask, :external_route
+    
+    def initialize(arg={})
+      @netmask, @external_route = nil
+      @mt_metrics=[]
+      super
+    end
+    
+    def encode
+      @netmask ||= Netmask.new
+      external =[]
+      external << netmask.encode
+      external << external_route.encode
+      external << mt_metrics.collect { |x| x.encode } if mt_metrics
+      super external.join
+    end
+    
+    def parse(s)
+      s = super(s)
+      netmask, external_route = s.slice!(0,16).unpack('Na*')
+      @netmask = Netmask.new netmask
+      @external_route = ExternalRoute.new external_route
+      while s.size>0
+        self << MtExternalRoute.new(s.slice!(0,12))
+      end
+    end
+    
+    def to_hash
+      super
+    end
+    
+    def to_s_default
+      mt_metrics = self.mt_metrics.collect
+      super  +
+      ['',netmask, external_route, *mt_metrics ].collect { |x| x.to_s }.join("\n   ")
+    end
+    
+    def to_s_junos
+      super
+    end
+    
+    # Extern   50.0.2.0         128.3.0.1        0x80000001    39  0x0  0x1454  48
+    #   mask 255.255.255.0
+    #   Topology default (ID 0)
+    #     Type: 1, Metric: 0, Fwd addr: 0.0.0.0, Tag: 0.0.0.0
+    #   Topology default (ID 0)
+    #     Type: 1, Metric: 30, Fwd addr: 0.0.0.0, Tag: 0.0.0.10
+    def to_s_junos_verbose
+      mt_metrics = self.mt_metrics.collect
+      super  +
+      ['',netmask, external_route, *mt_metrics ].collect { |x| x.to_s }.join("\n   ")
+    end
+    
+    def mt_metrics=(val)
+      # p "in mt_metrics=(val)"
+      # p val
+      [val].flatten.each { |x| self << x }
+    end
+    
+    def <<(ext_route)
+      @mt_metrics ||=[]
+      # p "calling MtExternalRoute with #{ext_route.inspect}"
+      route = MtExternalRoute.new(ext_route)
+      # p route
+      @mt_metrics << route
+      self
+    end
+    
+    def forwarding_address=(val)
+      @external_route.forwarding_address=(val)
+    end
+    
+    def type=(val)
+      @external_route.type=(val)
+    end
+    
+    def tag=(val)
+      @external_route.tag=(val)
+    end
+    
+    def metric=(val)
+      @external_route.metric=(val)
+    end
+    
+    # FIXME: should be a mixin and extended  Summary and External?
+    class << self
+      def count
+        @count ||= 0
+      end
+      
+      def incr_count
+        self.count
+        @count += 1
+      end
+      
+      def reset
+        @count = nil
+      end
+      
+      def base_ip_addr(addr=EXTERNAL_BASE_ADDRESS)
+        @base_addr ||= IPAddr.new(addr)
+      end
+      
+      def network
+        @base_addr + count
+      end
+      
+      def new_lsdb(arg={})
+        new({:network=> base_ip_addr ^ incr_count}.merge(arg))
+      end
+      
+    end
+
+  end
+
+  class AsExternal < External_Base
+
+    ExternalRoute = Class.new(OSPFv2::ExternalRoute)
+
+    class << self
+      def count
+        @count ||= 0
+      end
+
+      def incr_count
+        self.count
+        @count += 1
+      end
+
+      def reset
+        @count = nil
+      end
+
+      def base_ip_addr(addr=EXTERNAL_BASE_ADDRESS)
+        @base_addr ||= IPAddr.new(addr)
+      end
+
+      def network
+        @base_addr + count
+      end
+
+      def new_lsdb(arg={})
+        new({:network=> base_ip_addr ^ incr_count}.merge(arg))
+      end
+
+    end
+
+    def initialize(arg={})
+       if arg.is_a?(Hash)
+         arg = fix_hash(arg).merge!({:ls_type => :as_external_lsa,})
+       end
+       super
+     end
+
+     private
+
+     def fix_hash(arg)
+       # p 'HERE'
+       # p arg
+       if arg[:network]
+         addr = IPAddr.new arg[:network]
+         arg.delete :network
+         arg.store :netmask, addr.netmask
+         arg.store :ls_id, addr.to_s
+       end
+       route = arg[:external_route] ||={}
+       [:metric, :forwarding_address, :type, :tag].each do |e|
+         next unless arg[e]
+         route.store(e, arg[e]) if arg[e]
+         arg.delete(e)
+       end
+       arg.merge!(:external_route=>route)
+       # p "FIXED arg: #{arg.inspect}"
+       arg
+     end
+ 
+  end
+  
+  def AsExternal.new_hash(h)
+    new(h)
+  end
+
+end
+
+load "../../../test/ospfv2/lsa/#{ File.basename($0.gsub(/.rb/,'_test.rb'))}" if __FILE__ == $0