controller/dpset: Introduce datapath enter/leave event

Introduce DPSet class to track datapath enter/leave and generate events.

Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>

ryu/controller/controller.py

@@ -17,6 +17,7 @@ import gflags
 import logging
 import gevent
 import random
+import weakref
 from gevent.server import StreamServer
 from gevent.queue import Queue
 
@@ -209,4 +210,8 @@ def DatapathConnectionFactory(socket, address):
     LOG.debug('connected socket:%s address:%s', socket, address)
 
     datapath = Datapath(socket, address)
-    datapath.serve()
+    try:
+        datapath.serve()
+    finally:
+        # tell this datapath is dead
+        datapath.ev_q.set_dispatcher(handler.DEAD_DISPATCHER)

ryu/controller/dp_type.py

@@ -0,0 +1,26 @@
+# Copyright (C) 2012 Nippon Telegraph and Telephone Corporation.
+# Copyright (C) 2012 Isaku Yamahata <yamahata at valinux co jp>
+#
+# 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, version 3 of the License.
+#
+# 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, see <http://www.gnu.org/licenses/>.
+
+#
+# datapath type
+# At this moment, this information is not used yet and unknown type is
+# defined as place-holder.
+# switches are categorized by its rolls and openflow controller may want to
+# handle switch differently depending on it role.
+#
+# unknown:
+#
+
+UNKNOWN = 'UNKNOWN'

ryu/controller/dpset.py

@@ -0,0 +1,112 @@
+# Copyright (C) 2012 Nippon Telegraph and Telephone Corporation.
+# Copyright (C) 2012 Isaku Yamahata <yamahata at valinux co jp>
+#
+# 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, version 3 of the License
+#
+# 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, see <http://www.gnu.org/licenses/>.
+
+import logging
+
+from ryu.controller import event
+from ryu.controller import dispatcher
+from ryu.controller import dp_type
+from ryu.controller import handler
+from ryu.controller.handler import set_ev_cls
+
+LOG = logging.getLogger('ryu.controller.dpset')
+
+
+class EventDPBase(event.EventBase):
+    def __init__(self, dp):
+        super(EventDPBase, self).__init__()
+        self.dp = dp
+
+
+class EventDP(EventDPBase):
+    def __init__(self, dp, enter_leave):
+        # enter_leave
+        # True: dp entered
+        # False: dp leaving
+        super(EventDP, self).__init__(dp)
+        self.enter = enter_leave
+
+
+# this depends on controller::Datapath and dispatchers in handler
+class DPSet(object):
+    def __init__(self, ev_q, dispatcher_):
+        # dp registration and type setting can be occur in any order
+        # Sometimes the sw_type is set before dp connection
+        self.dp_types = {}
+
+        self.dps = {}   # datapath_id => class Datapath
+        self.ev_q = ev_q
+        self.dispatcher = dispatcher_
+
+        handler.register_instance(self)
+
+    def register(self, dp):
+        assert dp.id is not None
+        assert dp.id not in self.dps
+
+        dp_type_ = self.dp_types.pop(dp.id, None)
+        if dp_type_ is not None:
+            dp.dp_type = dp_type_
+
+        self.ev_q.queue(EventDP(dp, True))
+        self.dps[dp.id] = dp
+
+    def unregister(self, dp):
+        if dp.id in self.dps:
+            del self.dps[dp.id]
+            assert dp.id not in self.dp_types
+            self.dp_types[dp.id] = getattr(dp, 'dp_type', dp_type.UNKNOWN)
+
+            self.ev_q.queue(EventDP(dp, False))
+
+    def set_type(self, dp_id, dp_type_=dp_type.UNKNOWN):
+        if dp_id in self.dps:
+            dp = self.dps[dp_id]
+            dp.dp_type = dp_type_
+        else:
+            assert dp_id not in self.dp_types
+            self.dp_types[dp_id] = dp_type_
+
+    def get(self, dp_id):
+        return self.dps.get(dp_id, None)
+
+    def get_all(self):
+        return self.dps.items()
+
+    @set_ev_cls(dispatcher.EventDispatcherChange,
+                dispatcher.QUEUE_EV_DISPATCHER)
+    def dispacher_change(self, ev):
+        LOG.debug('dispatcher change q %s dispatcher %s',
+                  ev.ev_q.name, ev.new_dispatcher.name)
+        if ev.ev_q.name != handler.QUEUE_NAME_OFP_MSG:
+            return
+
+        datapath = ev.ev_q.aux()
+        assert datapath is not None
+        if ev.new_dispatcher.name == handler.DISPATCHER_NAME_OFP_MAIN:
+            LOG.debug('DPSET: register datapath %s', datapath)
+            self.register(datapath)
+        elif ev.new_dispatcher.name == handler.DISPATCHER_NAME_OFP_DEAD:
+            LOG.debug('DPSET: unregister datapath %s', datapath)
+            self.unregister(datapath)
+
+
+DISPATCHER_NAME_DPSET = 'dpset'
+DPSET_EV_DISPATCHER = dispatcher.EventDispatcher(DISPATCHER_NAME_DPSET)
+QUEUE_NAME_DPSET = 'datapath'
+_DPSET_EV_Q = dispatcher.EventQueue(QUEUE_NAME_DPSET, DPSET_EV_DISPATCHER)
+
+def create_dpset():
+    return DPSet(_DPSET_EV_Q, DPSET_EV_DISPATCHER)

ryu/controller/handler.py

@@ -32,6 +32,8 @@ DISPATCHER_NAME_OFP_CONFIG = 'ofp_config'
 config_dispatcher = dispatcher.EventDispatcher(DISPATCHER_NAME_OFP_CONFIG)
 DISPATCHER_NAME_OFP_MAIN = 'ofp_main'
 main_dispatcher = dispatcher.EventDispatcher(DISPATCHER_NAME_OFP_MAIN)
+DISPATCHER_NAME_OFP_DEAD = 'ofp_dead'
+DEAD_DISPATCHER = dispatcher.EventDispatcher(DISPATCHER_NAME_OFP_DEAD)
 
 
 def set_ev_cls(ev_cls, dispatchers=None):