ospfv2 0.0.1

data/lib/neighbor/neighbor_event_handler.rb

@@ -0,0 +1,61 @@
+#--
+# 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/>.
+#++
+
+
+module OSPFv2
+  
+  class NeighborEventHandler
+
+    def initialize(neighbor)
+      @neighbor = neighbor
+      @evQ = Queue.new
+      start_event_loop
+    end
+
+    def update(*args)
+      @evQ.enq(args)
+    end
+    
+    def start_event_loop
+      @neighbor.debug "*** Event Loop Started ***"
+      Thread.new(@evQ) do |events|
+        loop do
+          ev_type, *ev = events.deq
+          case ev_type
+          when :ev_recv
+            bits, from, @port = ev
+            packet = OspfPacket.factory(bits[20..-1])
+            if packet
+              @neighbor.log :rcv, packet
+              @neighbor.__send__ "recv_#{packet.name}", packet, from, @port
+            else
+              STDERR.puts "Not an ospf packet: #{bits.unpack('H*')}"
+            end
+          else
+            @neighbor.log ev_type, ev.inspect
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/neighbor/recv_database_description.rb

@@ -0,0 +1,153 @@
+#--
+# 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/>.
+#++
+
+module OSPFv2
+  class Neighbor
+
+    def recv_database_description(rcv_dd, *args)
+      
+      case state
+      when :exstart
+        
+        if router_id.to_i > rcv_dd.router_id.to_i
+          debug "*** #{rcv_dd.router_id} is slave ***"
+          if rcv_dd.master? 
+            debug "*** #{rcv_dd.router_id} claims mastership ***"
+            @last_dd_seqn += 1
+            dd = DatabaseDescription.new :router_id=> @router_id, :area_id=> @area_id, :imms=>7, :dd_sequence_number=>@last_dd_seqn
+            send_dd dd,  true
+          elsif rcv_dd.seqn == @last_dd_seqn
+            negotiation_done
+            @last_dd_seqn += 1
+            if @ls_db
+              @ls_db.recv_dd(rcv_dd, @ls_req_list)
+              dd = DatabaseDescription.new :router_id=> @router_id, :area_id=> @area_id, 
+                                            :ls_db => @ls_db, :number_of_lsa=>60
+            else
+              dd = DatabaseDescription.new :router_id=> @router_id, :area_id=> @area_id
+            end
+            dd.is_master
+            @last_dd_seqn = dd.seqn = @last_dd_seqn
+            send_dd dd, true
+          else
+            # just stay in ExStart ...
+            debug "*** @last_dd_seqn=#{@last_dd_seqn}, rcv_dd.seqn=#{rcv_dd.seqn} "
+          end
+        else
+          debug "*** #{rcv_dd.router_id} is master ***"
+          if rcv_dd.imms == 0x7
+            if @ls_db
+              @ls_db.recv_dd(rcv_dd, @ls_req_list)
+              dd = DatabaseDescription.new :router_id=> @router_id, :area_id=> @area_id, :ls_db => @ls_db
+            else
+              dd = DatabaseDescription.new :router_id=> @router_id, :area_id=> @area_id
+              dd.imms = 0 # no more
+            end
+            @last_dd_seqn_rcv = dd.seqn = rcv_dd.seqn
+            dd_rxmt_interval.cancel
+            send_dd dd, true
+            negotiation_done
+          end
+        end
+
+      when :exchange
+
+        @tot_dd ||=0
+        if rcv_dd.init?
+          new_state ExStart.new(self), 'Init' 
+
+        elsif rcv_dd.master? 
+          debug "*** #{rcv_dd.router_id} is master ***"
+
+          if rcv_dd.seqn - @last_dd_seqn_rcv == 1
+            @tot_dd += 1
+            @last_dd_seqn_rcv = rcv_dd.seqn
+            if @ls_db
+              @ls_db.recv_dd(rcv_dd, @ls_req_list)
+              @dd = DatabaseDescription.new :router_id=> @router_id, :area_id=> @area_id, 
+              :ls_db => @ls_db, :dd_sequence_number=>rcv_dd.seqn
+            else
+              @dd = DatabaseDescription.new :router_id=> @router_id, :area_id=> @area_id
+              @dd.imms = 0 # no more
+            end
+            @dd.dd_sequence_number = rcv_dd.seqn
+            send_dd @dd, true
+          elsif rcv_dd.seqn == @last_dd_seqn_rcv
+            # use rxmt
+          else
+            @state.seq_number_mismatch(self)
+          end
+
+          unless  rcv_dd.more? || @dd.more?
+            dd_rxmt_interval.cancel
+            new_state Loading.new(self), 'exchange_done'
+            new_state Full.new, 'no loading: req list is empty' if @ls_req_list.empty?
+          end
+
+        else
+          debug "*** #{rcv_dd.router_id} is slave ***"
+
+          if rcv_dd.seqn == @last_dd_seqn
+
+            if ! @sent_dd.more? && ! rcv_dd.more?
+              dd_rxmt_interval.cancel
+              new_state Loading.new(self), 'exchange_done'
+              new_state Full.new, 'no loading: req list is empty' if @ls_req_list.empty?
+
+            else
+
+              debug "*** OK: @last_dd_seqn=#{@last_dd_seqn}, rcv_dd.seqn=#{rcv_dd.seqn} "
+
+              @last_dd_seqn += 1
+              if @ls_db
+                @ls_db.recv_dd(rcv_dd, @ls_req_list)
+                @dd = DatabaseDescription.new :router_id=> @router_id, :area_id=> @area_id, 
+                :ls_db => @ls_db, :number_of_lsa=>60
+              else
+                @dd.no_more
+              end
+              @dd.is_master
+              @dd.seqn = @last_dd_seqn
+              send_dd @dd, true
+            end
+
+          elsif @last_dd_seqn - rcv_dd.seqn == 1
+            debug "*** RXMT SHOULD FIX THIS: @last_dd_seqn=#{@last_dd_seqn}, rcv_dd.seqn=#{rcv_dd.seqn} "
+          else
+            debug "*** SHOULD GO TO EXSTART: @last_dd_seqn=#{@last_dd_seqn}, rcv_dd.seqn=#{rcv_dd.seqn} "
+            new_state Full.new, "SeqNumberMismatch"
+          end
+          
+        end
+        
+      else
+        debug "*** recv dd packet while in #{state} #{rcv_dd.imms}***"
+        unless rcv_dd.imms == 0
+          new_state ExStart.new(self), 'recv dd packet'
+          debug "*** recv dd packet while in #{state} ***"
+        end
+      end
+    end
+    
+  end
+
+end

data/lib/neighbor/recv_hello.rb

@@ -0,0 +1,53 @@
+#--
+# 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/>.
+#++
+
+module OSPFv2
+  class Neighbor
+    
+    def recv_hello(hello, from, port)
+      @neighbor_ip = from
+      @state.recv_hello self, hello, from
+    rescue Exception => e
+      debug "rescued #{e.inspect}"
+    end
+
+    def recv_link_state_request(ls_request, from, port)
+      #TODO: check what address the LSU shoul be send to ? unicast ? AllDRouteres ? AllSpfRouters ?
+      send ls_request.to_lsu(@ls_db, :area_id=> @aread_id, :router_id => @router_id), from 
+    end
+    
+    def recv_link_state_update(ls_update, from, port)
+      ls_ack = LinkStateAck.ack_ls_update ls_update, :area_id=> @area_id, :router_id=> @router_id
+      send ls_ack, OSPFv2::AllDRouters #from
+      unless @ls_req_list.empty?
+        ls_update.each { |l| 
+          if @ls_req_list.has_key?(l.key)
+            debug "*** deleting #{l.key.inspect} from Ls Req List! ***"
+            @ls_req_list.delete(l.key) 
+          end
+        }
+        new_state Full.new, 'loading_done' if @ls_req_list.empty?
+       end
+      @ls_db.recv_link_state_update ls_update
+    end
+  end 
+end

data/lib/neighbor/recv_ospf_packet.rb

@@ -0,0 +1,68 @@
+#--
+# 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 'neighbor/recv_database_description'
+# require 'neighbor/recv_hello'
+
+module OSPFv2
+  class Neighbor
+    
+    def recv_hello(hello, from, port)
+      @neighbor_ip = from
+      @state.recv_hello self, hello, from
+    rescue Exception => e
+      debug "rescued #{e.inspect}"
+    end
+
+    def recv_link_state_request(ls_request, from, port)
+      #TODO: check what address the LSU shoul be send to ? unicast ? AllDRouteres ? AllSpfRouters ?
+      send ls_request.to_lsu(@ls_db, :area_id=> @aread_id, :router_id => @router_id), from 
+    end
+    
+    def recv_link_state_update(ls_update, from, port)
+      unless in_state?(:full, :loading, :exchange)
+        debug "*** ignoring link state update received while in #{@state}!"
+      end
+      ls_ack = LinkStateAck.ack_ls_update ls_update, :area_id=> @area_id, :router_id=> @router_id
+      send ls_ack, OSPFv2::AllSPFRouters #from
+      unless @ls_req_list.empty?
+        ls_update.each { |l| 
+          if @ls_req_list.has_key?(l.key)
+            debug "*** deleting #{l.key.inspect} from Ls Req List! ***"
+            @ls_req_list.delete(l.key) 
+          end
+        }
+        new_state Full.new, 'loading_done' if @ls_req_list.empty?
+       end
+      @ls_db.recv_link_state_update ls_update if @ls_db
+    end
+    
+    def recv_link_state_ack(ls_ack, from, port)
+      return unless @ls_db
+      before = @ls_db.all_not_acked.size
+      ls_ack.each { |lsa| @ls_db.ls_ack lsa }
+      debug "*** number of lsa acked : #{before - @ls_db.all_not_acked.size} ***"
+    end
+    
+  end
+
+end

data/lib/neighbor_sm/attempt_state.rb

@@ -0,0 +1,44 @@
+#--
+# 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 'neighbor_sm/neighbor_state'
+module OSPFv2
+
+  module NeighborState
+
+    class Attempt < State
+
+      def recv_hello(neighbor, hello, *args)
+        super
+        #TODO: check hello dead and hello interval and netmask ?
+        two_way_received(neighbor) if hello.has_neighbor?(neighbor.router_id)
+      end
+      
+      def two_way_received(neighbor)
+        new_state neighbor, ExStart.new(neighbor), 'two_way_received'
+      end
+      
+    end
+    
+  end
+  
+end

data/lib/neighbor_sm/down_state.rb

@@ -0,0 +1,46 @@
+#--
+# 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 'neighbor_sm/neighbor_state'
+module OSPFv2
+
+  module NeighborState
+
+    class Down < State
+      
+      def start(neighbor)
+        neighbor.instance_eval {
+          new_state Attempt.new, 'start'
+        }
+      end
+
+      def recv_hello(neighbor, rcv_hello, *args)
+        super
+        new_state neighbor, Init.new, 'recv_hello'
+      end
+
+    end
+
+  end
+
+end
+

data/lib/neighbor_sm/exchange_state.rb

@@ -0,0 +1,32 @@
+#--
+# 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 'neighbor_sm/neighbor_state'
+module OSPFv2
+  module NeighborState
+    class Exchange < State
+      def seq_number_mismatch(neighbor)
+        change_state(neighor, Exstart.new, 'seq_number_mismatch')
+      end
+    end
+  end
+end

data/lib/neighbor_sm/exstart_state.rb

@@ -0,0 +1,69 @@
+#--
+# 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 'neighbor_sm/neighbor_state'
+module OSPFv2
+  module NeighborState
+    
+    class ExStart < State
+      def initialize(n)
+        @neighbor = n
+         n.instance_eval do
+          @last_dd_seqn = n.dd_sequence_number
+          
+          #-- could be a State#reset method inherited ?
+          @ls_db.reset if @ls_db
+          @ls_req_list={}
+          @periodic_refresh.cancel
+          @periodic_rxmt.cancel
+          #--
+          
+          @last_dd_seqn = dd_sequence_number
+          raise unless @last_dd_seqn>0
+          
+          p "***"
+          p @last_dd_seqn
+          
+          dd = DatabaseDescription.new :router_id=> @router_id, :area_id=> @area_id, 
+                                        :imms=>7, :dd_sequence_number => @last_dd_seqn
+          send_dd dd, true
+        end
+        
+      end
+      
+      def negotiation_done
+        @neighbor.instance_eval do
+          dd_rxmt_interval.cancel
+          new_state Exchange.new
+        end
+      end
+
+      def adj_ok?
+         if ! ok
+          change_state(@neighbor, Two_way.new)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/neighbor_sm/full_state.rb

@@ -0,0 +1,36 @@
+#--
+# 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 'neighbor_sm/neighbor_state'
+module OSPFv2
+  module NeighborState
+    class Full < State
+      def recv_link_state_ack(neighbor, link_state_ack)
+        neighbor.debug "*** in full state object ev recv_link_state_ack ????? ****"
+      end
+      def recv_dd(neighbor, dd)
+        new_state neighbor, ExStart.new(neighbor), 'Received DatabaseDescription'
+      end
+    end
+  end
+end

data/lib/neighbor_sm/init_state.rb

@@ -0,0 +1,43 @@
+#--
+# 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 'neighbor_sm/neighbor_state'
+module OSPFv2
+  module NeighborState
+    
+    class Init < State
+
+      # recv_hello inherited
+      
+      def recv_hello(neighbor, hello, *args)
+         super
+         two_way_received(neighbor) if hello.has_neighbor?(neighbor.router_id)
+       end
+
+      def two_way_received(neighbor, *args)
+        change_state(neighbor, ExStart.new(neighbor), 'two_way_received' )
+      end
+    end
+    
+  end
+end
+

data/lib/neighbor_sm/loading_state.rb

@@ -0,0 +1,33 @@
+#--
+# 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 'neighbor_sm/neighbor_state'
+module OSPFv2
+  module NeighborState
+    class Loading < State
+      def initialize(neighbor)
+        neighbor.start_periodic_rxmt
+        neighbor.start_ls_refresh
+      end
+    end
+  end
+end