ryu/build/lib.linux-armv7l-2.7/ryu/controller/tunnels.py

   1 # Copyright (C) 2012 Nippon Telegraph and Telephone Corporation.
   2 # Copyright (C) 2012 Isaku Yamahata <yamahata at private email ne jp>
   3 #
   4 # Licensed under the Apache License, Version 2.0 (the "License");
   5 # you may not use this file except in compliance with the License.
   6 # You may obtain a copy of the License at
   7 #
   8 #    http://www.apache.org/licenses/LICENSE-2.0
   9 #
  10 # Unless required by applicable law or agreed to in writing, software
  11 # distributed under the License is distributed on an "AS IS" BASIS,
  12 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  13 # implied.
  14 # See the License for the specific language governing permissions and
  15 # limitations under the License.
  16
  17 import collections
  18 import logging
  19
  20 import ryu.exception as ryu_exc
  21 from ryu.base import app_manager
  22 from ryu.controller import event
  23
  24
  25 class RemoteDPIDAlreadyExist(ryu_exc.RyuException):
  26     message = ('port (%(dpid)s, %(port)s) has already '
  27                'remote dpid %(remote_dpid)s')
  28
  29
  30 class TunnelKeyAlreadyExist(ryu_exc.RyuException):
  31     message = 'tunnel key %(tunnel_key)s already exists'
  32
  33
  34 class TunnelKeyNotFound(ryu_exc.RyuException):
  35     message = 'no tunnel key for network %(network_id)s'
  36
  37
  38 class EventTunnelKeyBase(event.EventBase):
  39     def __init__(self, network_id, tunnel_key):
  40         super(EventTunnelKeyBase, self).__init__()
  41         self.network_id = network_id
  42         self.tunnel_key = tunnel_key
  43
  44
  45 class EventTunnelKeyAdd(EventTunnelKeyBase):
  46     """
  47     An event class for tunnel key registration.
  48
  49     This event is generated when a tunnel key is registered or updated
  50     by the REST API.
  51     An instance has at least the following attributes.
  52
  53     =========== ===============================================================
  54     Attribute   Description
  55     =========== ===============================================================
  56     network_id  Network ID
  57     tunnel_key  Tunnel Key
  58     =========== ===============================================================
  59     """
  60
  61     def __init__(self, network_id, tunnel_key):
  62         super(EventTunnelKeyAdd, self).__init__(network_id, tunnel_key)
  63
  64
  65 class EventTunnelKeyDel(EventTunnelKeyBase):
  66     """
  67     An event class for tunnel key registration.
  68
  69     This event is generated when a tunnel key is removed by the REST API.
  70     An instance has at least the following attributes.
  71
  72     =========== ===============================================================
  73     Attribute   Description
  74     =========== ===============================================================
  75     network_id  Network ID
  76     tunnel_key  Tunnel Key
  77     =========== ===============================================================
  78     """
  79
  80     def __init__(self, network_id, tunnel_key):
  81         super(EventTunnelKeyDel, self).__init__(network_id, tunnel_key)
  82
  83
  84 class EventTunnelPort(event.EventBase):
  85     """
  86     An event class for tunnel port registration.
  87
  88     This event is generated when a tunnel port is added or removed
  89     by the REST API.
  90     An instance has at least the following attributes.
  91
  92     =========== ===============================================================
  93     Attribute   Description
  94     =========== ===============================================================
  95     dpid        OpenFlow Datapath ID
  96     port_no     OpenFlow port number
  97     remote_dpid OpenFlow port number of the tunnel peer
  98     add_del     True for adding a tunnel.  False for removal.
  99     =========== ===============================================================
 100     """
 101
 102     def __init__(self, dpid, port_no, remote_dpid, add_del):
 103         super(EventTunnelPort, self).__init__()
 104         self.dpid = dpid
 105         self.port_no = port_no
 106         self.remote_dpid = remote_dpid
 107         self.add_del = add_del
 108
 109
 110 class TunnelKeys(dict):
 111     """network id(uuid) <-> tunnel key(32bit unsigned int)"""
 112
 113     def __init__(self, f):
 114         super(TunnelKeys, self).__init__()
 115         self.send_event = f
 116
 117     def get_key(self, network_id):
 118         try:
 119             return self[network_id]
 120         except KeyError:
 121             raise TunnelKeyNotFound(network_id=network_id)
 122
 123     def _set_key(self, network_id, tunnel_key):
 124         self[network_id] = tunnel_key
 125         self.send_event(EventTunnelKeyAdd(network_id, tunnel_key))
 126
 127     def register_key(self, network_id, tunnel_key):
 128         if network_id in self:
 129             raise ryu_exc.NetworkAlreadyExist(network_id=network_id)
 130         if tunnel_key in self.values():
 131             raise TunnelKeyAlreadyExist(tunnel_key=tunnel_key)
 132         self._set_key(network_id, tunnel_key)
 133
 134     def update_key(self, network_id, tunnel_key):
 135         if network_id not in self and tunnel_key in self.values():
 136             raise TunnelKeyAlreadyExist(key=tunnel_key)
 137
 138         key = self.get(network_id)
 139         if key is None:
 140             self._set_key(network_id, tunnel_key)
 141             return
 142         if key != tunnel_key:
 143             raise ryu_exc.NetworkAlreadyExist(network_id=network_id)
 144
 145     def delete_key(self, network_id):
 146         try:
 147             tunnel_key = self[network_id]
 148             self.send_event(EventTunnelKeyDel(network_id, tunnel_key))
 149             del self[network_id]
 150         except KeyError:
 151             raise ryu_exc.NetworkNotFound(network_id=network_id)
 152
 153
 154 class DPIDs(object):
 155     """dpid -> port_no -> remote_dpid"""
 156
 157     def __init__(self, f):
 158         super(DPIDs, self).__init__()
 159         self.dpids = collections.defaultdict(dict)
 160         self.send_event = f
 161
 162     def list_ports(self, dpid):
 163         return self.dpids[dpid]
 164
 165     def _add_remote_dpid(self, dpid, port_no, remote_dpid):
 166         self.dpids[dpid][port_no] = remote_dpid
 167         self.send_event(EventTunnelPort(dpid, port_no, remote_dpid, True))
 168
 169     def add_remote_dpid(self, dpid, port_no, remote_dpid):
 170         if port_no in self.dpids[dpid]:
 171             raise ryu_exc.PortAlreadyExist(dpid=dpid, port=port_no,
 172                                            network_id=None)
 173         self._add_remote_dpid(dpid, port_no, remote_dpid)
 174
 175     def update_remote_dpid(self, dpid, port_no, remote_dpid):
 176         remote_dpid_ = self.dpids[dpid].get(port_no)
 177         if remote_dpid_ is None:
 178             self._add_remote_dpid(dpid, port_no, remote_dpid)
 179         elif remote_dpid_ != remote_dpid:
 180             raise ryu_exc.RemoteDPIDAlreadyExist(dpid=dpid, port=port_no,
 181                                                  remote_dpid=remote_dpid)
 182
 183     def get_remote_dpid(self, dpid, port_no):
 184         try:
 185             return self.dpids[dpid][port_no]
 186         except KeyError:
 187             raise ryu_exc.PortNotFound(dpid=dpid, port=port_no)
 188
 189     def delete_port(self, dpid, port_no):
 190         try:
 191             remote_dpid = self.dpids[dpid][port_no]
 192             self.send_event(EventTunnelPort(dpid, port_no, remote_dpid, False))
 193             del self.dpids[dpid][port_no]
 194         except KeyError:
 195             raise ryu_exc.PortNotFound(dpid=dpid, port=port_no)
 196
 197     def get_port(self, dpid, remote_dpid):
 198         try:
 199             dp = self.dpids[dpid]
 200         except KeyError:
 201             raise ryu_exc.PortNotFound(dpid=dpid, port=None, network_id=None)
 202
 203         res = [port_no for (port_no, remote_dpid_) in dp.items()
 204                if remote_dpid_ == remote_dpid]
 205         assert len(res) <= 1
 206         if len(res) == 0:
 207             raise ryu_exc.PortNotFound(dpid=dpid, port=None, network_id=None)
 208         return res[0]
 209
 210
 211 class Tunnels(app_manager.RyuApp):
 212     def __init__(self):
 213         super(Tunnels, self).__init__()
 214         self.name = 'tunnels'
 215         self.tunnel_keys = TunnelKeys(self.send_event_to_observers)
 216         self.dpids = DPIDs(self.send_event_to_observers)
 217
 218     def get_key(self, network_id):
 219         return self.tunnel_keys.get_key(network_id)
 220
 221     def register_key(self, network_id, tunnel_key):
 222         self.tunnel_keys.register_key(network_id, tunnel_key)
 223
 224     def update_key(self, network_id, tunnel_key):
 225         self.tunnel_keys.update_key(network_id, tunnel_key)
 226
 227     def delete_key(self, network_id):
 228         self.tunnel_keys.delete_key(network_id)
 229
 230     def list_ports(self, dpid):
 231         return self.dpids.list_ports(dpid).keys()
 232
 233     def register_port(self, dpid, port_no, remote_dpid):
 234         self.dpids.add_remote_dpid(dpid, port_no, remote_dpid)
 235
 236     def update_port(self, dpid, port_no, remote_dpid):
 237         self.dpids.update_remote_dpid(dpid, port_no, remote_dpid)
 238
 239     def get_remote_dpid(self, dpid, port_no):
 240         return self.dpids.get_remote_dpid(dpid, port_no)
 241
 242     def delete_port(self, dpid, port_no):
 243         self.dpids.delete_port(dpid, port_no)
 244
 245     #
 246     # methods for gre tunnel
 247     #
 248     def get_port(self, dpid, remote_dpid):
 249         return self.dpids.get_port(dpid, remote_dpid)