Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 1 | """ |
| 2 | OpenFlow Test Framework |
| 3 | |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 4 | DataPlane and DataPlanePort classes |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 5 | |
| 6 | Provide the interface to the control the set of ports being used |
| 7 | to stimulate the switch under test. |
| 8 | |
| 9 | See the class dataplaneport for more details. This class wraps |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 10 | a set of those objects allowing general calls and parsing |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 11 | configuration. |
| 12 | |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 13 | @todo Add "filters" for matching packets. Actions supported |
| 14 | for filters should include a callback or a counter |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 15 | """ |
| 16 | |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 17 | import sys |
| 18 | import os |
| 19 | import socket |
| 20 | import time |
Dan Talayco | d7e2dbe | 2010-02-13 21:51:15 -0800 | [diff] [blame] | 21 | import netutils |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 22 | from threading import Thread |
| 23 | from threading import Lock |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 24 | from threading import Condition |
Dan Talayco | 710438c | 2010-02-18 15:16:07 -0800 | [diff] [blame] | 25 | import select |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 26 | import logging |
| 27 | from oft_assert import oft_assert |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 28 | |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 29 | ##@todo Find a better home for these identifiers (dataplane) |
| 30 | RCV_SIZE_DEFAULT = 4096 |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 31 | ETH_P_ALL = 0x03 |
| 32 | RCV_TIMEOUT = 10000 |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 33 | |
| 34 | class DataPlanePort(Thread): |
| 35 | """ |
| 36 | Class defining a port monitoring object. |
| 37 | |
| 38 | Control a dataplane port connected to the switch under test. |
| 39 | Creates a promiscuous socket on a physical interface. |
| 40 | Queues the packets received on that interface with time stamps. |
| 41 | Inherits from Thread class as meant to run in background. Also |
| 42 | supports polling. |
| 43 | Use accessors to dequeue packets for proper synchronization. |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 44 | |
| 45 | Currently assumes a controlling 'parent' which maintains a |
| 46 | common Lock object and a total packet-pending count. May want |
| 47 | to decouple that some day. |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 48 | """ |
| 49 | |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 50 | def __init__(self, interface_name, port_number, parent, max_pkts=1024): |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 51 | """ |
| 52 | Set up a port monitor object |
| 53 | @param interface_name The name of the physical interface like eth1 |
Dan Talayco | 4d06597 | 2010-02-18 23:11:32 -0800 | [diff] [blame] | 54 | @param port_number The port number associated with this port |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 55 | @param parent The controlling dataplane object; for pkt wait CV |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 56 | @param max_pkts Maximum number of pkts to keep in queue |
| 57 | """ |
| 58 | Thread.__init__(self) |
| 59 | self.interface_name = interface_name |
| 60 | self.max_pkts = max_pkts |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 61 | self.packets_total = 0 |
| 62 | self.packets = [] |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 63 | self.packets_discarded = 0 |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 64 | self.port_number = port_number |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 65 | logname = "dp-" + interface_name |
| 66 | self.logger = logging.getLogger(logname) |
Dan Talayco | 0db53eb | 2010-03-10 14:00:02 -0800 | [diff] [blame] | 67 | try: |
| 68 | self.socket = self.interface_open(interface_name) |
| 69 | except: |
| 70 | self.logger.info("Could not open socket") |
| 71 | sys.exit(1) |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 72 | self.logger.info("Openned port monitor socket") |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 73 | self.parent = parent |
| 74 | self.pkt_sync = self.parent.pkt_sync |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 75 | |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 76 | def interface_open(self, interface_name): |
| 77 | """ |
| 78 | Open a socket in a promiscuous mode for a data connection. |
| 79 | @param interface_name port name as a string such as 'eth1' |
| 80 | @retval s socket |
| 81 | """ |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 82 | s = socket.socket(socket.AF_PACKET, socket.SOCK_RAW, |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 83 | socket.htons(ETH_P_ALL)) |
| 84 | s.bind((interface_name, 0)) |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 85 | netutils.set_promisc(s, interface_name) |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 86 | s.settimeout(RCV_TIMEOUT) |
| 87 | return s |
| 88 | |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 89 | def run(self): |
| 90 | """ |
| 91 | Activity function for class |
| 92 | """ |
| 93 | self.running = True |
Dan Talayco | 710438c | 2010-02-18 15:16:07 -0800 | [diff] [blame] | 94 | self.socs = [self.socket] |
| 95 | error_warned = False # Have we warned about error? |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 96 | while self.running: |
| 97 | try: |
Dan Talayco | 710438c | 2010-02-18 15:16:07 -0800 | [diff] [blame] | 98 | sel_in, sel_out, sel_err = \ |
| 99 | select.select(self.socs, [], [], 1) |
| 100 | except: |
| 101 | print sys.exc_info() |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 102 | self.logger.error("Select error, exiting") |
| 103 | break |
Dan Talayco | 710438c | 2010-02-18 15:16:07 -0800 | [diff] [blame] | 104 | |
| 105 | if not self.running: |
| 106 | break |
| 107 | |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 108 | if (sel_in is None) or (len(sel_in) == 0): |
Dan Talayco | 710438c | 2010-02-18 15:16:07 -0800 | [diff] [blame] | 109 | continue |
| 110 | |
| 111 | try: |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 112 | rcvmsg = self.socket.recv(RCV_SIZE_DEFAULT) |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 113 | except socket.error: |
Dan Talayco | 710438c | 2010-02-18 15:16:07 -0800 | [diff] [blame] | 114 | if not error_warned: |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 115 | self.logger.info("Socket error on recv") |
Dan Talayco | 710438c | 2010-02-18 15:16:07 -0800 | [diff] [blame] | 116 | error_warned = True |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 117 | continue |
Dan Talayco | 710438c | 2010-02-18 15:16:07 -0800 | [diff] [blame] | 118 | |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 119 | if len(rcvmsg) == 0: |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 120 | self.logger.info("Zero len pkt rcvd") |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 121 | self.kill() |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 122 | break |
| 123 | |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 124 | rcvtime = time.clock() |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 125 | self.logger.debug("Pkt len " + str(len(rcvmsg)) + |
Dan Talayco | 710438c | 2010-02-18 15:16:07 -0800 | [diff] [blame] | 126 | " in at " + str(rcvtime)) |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 127 | |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 128 | # Enqueue packet |
| 129 | self.pkt_sync.acquire() |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 130 | if len(self.packets) >= self.max_pkts: |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 131 | # Queue full, throw away oldest |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 132 | self.packets.pop(0) |
| 133 | self.packets_discarded += 1 |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 134 | else: |
| 135 | self.parent.packets_pending += 1 |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 136 | # Check if parent is waiting on this (or any) port |
Dan Talayco | cf26b7a | 2011-08-05 10:15:35 -0700 | [diff] [blame^] | 137 | drop_pkt = False |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 138 | if self.parent.want_pkt: |
| 139 | if (not self.parent.want_pkt_port or |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 140 | self.parent.want_pkt_port == self.port_number): |
Dan Talayco | cf26b7a | 2011-08-05 10:15:35 -0700 | [diff] [blame^] | 141 | if self.parent.exp_pkt: |
| 142 | if str(self.parent.exp_pkt) != str(rcvmsg): |
| 143 | drop_pkt = True |
| 144 | if not drop_pkt: |
| 145 | self.parent.got_pkt_port = self.port_number |
| 146 | self.parent.want_pkt = False |
| 147 | self.parent.pkt_sync.notify() |
| 148 | if not drop_pkt: |
| 149 | self.packets.append((rcvmsg, rcvtime)) |
| 150 | self.packets_total += 1 |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 151 | self.pkt_sync.release() |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 152 | |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 153 | self.logger.info("Thread exit ") |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 154 | |
| 155 | def kill(self): |
| 156 | """ |
| 157 | Terminate the running thread |
| 158 | """ |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 159 | self.logger.debug("Port monitor kill") |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 160 | self.running = False |
| 161 | try: |
| 162 | self.socket.close() |
| 163 | except: |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 164 | self.logger.info("Ignoring dataplane soc shutdown error") |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 165 | |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 166 | def dequeue(self, use_lock=True): |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 167 | """ |
| 168 | Get the oldest packet in the queue |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 169 | @param use_lock If True, acquires the packet sync lock (which is |
| 170 | really the parent's lock) |
| 171 | @return The pair packet, packet time-stamp |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 172 | """ |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 173 | if use_lock: |
| 174 | self.pkt_sync.acquire() |
| 175 | if len(self.packets) > 0: |
| 176 | pkt, pkt_time = self.packets.pop(0) |
| 177 | self.parent.packets_pending -= 1 |
| 178 | else: |
| 179 | pkt = pkt_time = None |
| 180 | if use_lock: |
| 181 | self.pkt_sync.release() |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 182 | return pkt, pkt_time |
| 183 | |
| 184 | def timestamp_head(self): |
| 185 | """ |
| 186 | Return the timestamp of the head of queue or None if empty |
| 187 | """ |
Dan Talayco | 710438c | 2010-02-18 15:16:07 -0800 | [diff] [blame] | 188 | rv = None |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 189 | try: |
Dan Talayco | 710438c | 2010-02-18 15:16:07 -0800 | [diff] [blame] | 190 | rv = self.packets[0][1] |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 191 | except: |
| 192 | rv = None |
Dan Talayco | 710438c | 2010-02-18 15:16:07 -0800 | [diff] [blame] | 193 | return rv |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 194 | |
| 195 | def flush(self): |
| 196 | """ |
| 197 | Clear the packet queue |
| 198 | """ |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 199 | self.pkt_sync.acquire() |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 200 | self.packets_discarded += len(self.packets) |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 201 | self.parent.packets_pending -= len(self.packets) |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 202 | self.packets = [] |
| 203 | self.packet_times = [] |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 204 | self.pkt_sync.release() |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 205 | |
| 206 | |
| 207 | def send(self, packet): |
| 208 | """ |
| 209 | Send a packet to the dataplane port |
| 210 | @param packet The packet data to send to the port |
| 211 | @retval The number of bytes sent |
| 212 | """ |
| 213 | return self.socket.send(packet) |
| 214 | |
| 215 | |
| 216 | def register(self, handler): |
| 217 | """ |
| 218 | Register a callback function to receive packets from this |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 219 | port. The callback will be passed the packet, the |
| 220 | interface name and the port number (if set) on which the |
Dan Talayco | 3087a46 | 2010-02-13 14:01:47 -0800 | [diff] [blame] | 221 | packet was received. |
| 222 | |
| 223 | To be implemented |
| 224 | """ |
| 225 | pass |
| 226 | |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 227 | def show(self, prefix=''): |
| 228 | print prefix + "Name: " + self.interface_name |
Dan Talayco | 710438c | 2010-02-18 15:16:07 -0800 | [diff] [blame] | 229 | print prefix + "Pkts pending: " + str(len(self.packets)) |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 230 | print prefix + "Pkts total: " + str(self.packets_total) |
| 231 | print prefix + "socket: " + str(self.socket) |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 232 | |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 233 | |
| 234 | class DataPlane: |
| 235 | """ |
| 236 | Class defining access primitives to the data plane |
| 237 | Controls a list of DataPlanePort objects |
| 238 | """ |
| 239 | def __init__(self): |
| 240 | self.port_list = {} |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 241 | # pkt_sync serves double duty as a regular top level lock and |
| 242 | # as a condition variable |
| 243 | self.pkt_sync = Condition() |
| 244 | |
| 245 | # These are used to signal async pkt arrival for polling |
| 246 | self.want_pkt = False |
Dan Talayco | cf26b7a | 2011-08-05 10:15:35 -0700 | [diff] [blame^] | 247 | self.exp_pkt = None |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 248 | self.want_pkt_port = None # What port required (or None) |
| 249 | self.got_pkt_port = None # On what port received? |
| 250 | self.packets_pending = 0 # Total pkts in all port queues |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 251 | self.logger = logging.getLogger("dataplane") |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 252 | |
| 253 | def port_add(self, interface_name, port_number): |
| 254 | """ |
| 255 | Add a port to the dataplane |
| 256 | TBD: Max packets for queue? |
| 257 | @param interface_name The name of the physical interface like eth1 |
| 258 | @param port_number The port number used to refer to the port |
| 259 | """ |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 260 | |
Dan Talayco | 11c26e7 | 2010-03-07 22:03:57 -0800 | [diff] [blame] | 261 | self.port_list[port_number] = DataPlanePort(interface_name, |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 262 | port_number, self) |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 263 | self.port_list[port_number].start() |
| 264 | |
| 265 | def send(self, port_number, packet): |
| 266 | """ |
| 267 | Send a packet to the given port |
| 268 | @param port_number The port to send the data to |
| 269 | @param packet Raw packet data to send to port |
| 270 | """ |
Dan Talayco | 11c26e7 | 2010-03-07 22:03:57 -0800 | [diff] [blame] | 271 | self.logger.debug("Sending %d bytes to port %d" % |
| 272 | (len(packet), port_number)) |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 273 | bytes = self.port_list[port_number].send(packet) |
| 274 | if bytes != len(packet): |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 275 | self.logger.error("Unhandled send error, length mismatch %d != %d" % |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 276 | (bytes, len(packet))) |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 277 | return bytes |
| 278 | |
| 279 | def flood(self, packet): |
| 280 | """ |
| 281 | Send a packet to all ports |
| 282 | @param packet Raw packet data to send to port |
| 283 | """ |
| 284 | for port_number in self.port_list.keys(): |
| 285 | bytes = self.port_list[port_number].send(packet) |
| 286 | if bytes != len(packet): |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 287 | self.logger.error("Unhandled send error" + |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 288 | ", port %d, length mismatch %d != %d" % |
| 289 | (port_number, bytes, len(packet))) |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 290 | |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 291 | def _oldest_packet_find(self): |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 292 | # Find port with oldest packet |
| 293 | min_time = 0 |
| 294 | min_port = -1 |
| 295 | for port_number in self.port_list.keys(): |
| 296 | ptime = self.port_list[port_number].timestamp_head() |
| 297 | if ptime: |
| 298 | if (min_port == -1) or (ptime < min_time): |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 299 | min_time = ptime |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 300 | min_port = port_number |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 301 | oft_assert(min_port != -1, "Could not find port when pkts pending") |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 302 | |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 303 | return min_port |
| 304 | |
Dan Talayco | cf26b7a | 2011-08-05 10:15:35 -0700 | [diff] [blame^] | 305 | def poll(self, port_number=None, timeout=None, exp_pkt=None): |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 306 | """ |
| 307 | Poll one or all dataplane ports for a packet |
| 308 | |
| 309 | If port_number is given, get the oldest packet from that port. |
| 310 | Otherwise, find the port with the oldest packet and return |
| 311 | that packet. |
| 312 | @param port_number If set, get packet from this port |
Dan Talayco | 11c26e7 | 2010-03-07 22:03:57 -0800 | [diff] [blame] | 313 | @param timeout If positive and no packet is available, block |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 314 | until a packet is received or for this many seconds |
Dan Talayco | cf26b7a | 2011-08-05 10:15:35 -0700 | [diff] [blame^] | 315 | @param exp_pkt If not None, look for this packet and ignore any |
| 316 | others received. Requires port_number to be specified |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 317 | @return The triple port_number, packet, pkt_time where packet |
| 318 | is received from port_number at time pkt_time. If a timeout |
| 319 | occurs, return None, None, None |
| 320 | """ |
| 321 | |
| 322 | self.pkt_sync.acquire() |
| 323 | |
Dan Talayco | cf26b7a | 2011-08-05 10:15:35 -0700 | [diff] [blame^] | 324 | if exp_pkt and not port_number: |
| 325 | print "WARNING: Dataplane poll: exp_pkt without port number" |
| 326 | |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 327 | # Check if requested specific port and it has a packet |
| 328 | if port_number and len(self.port_list[port_number].packets) != 0: |
Dan Talayco | cf26b7a | 2011-08-05 10:15:35 -0700 | [diff] [blame^] | 329 | while len(self.port_list[port_number].packets) != 0: |
| 330 | pkt, time = self.port_list[port_number].dequeue(use_lock=False) |
| 331 | if not exp_pkt: |
| 332 | break |
| 333 | if str(pkt) == str(exp_pkt): |
| 334 | break |
| 335 | pkt = None # Discard silently |
| 336 | if pkt: |
| 337 | self.pkt_sync.release() |
| 338 | oft_assert(pkt, "Poll: packet not found on port " + |
| 339 | str(port_number)) |
| 340 | return port_number, pkt, time |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 341 | |
| 342 | # Check if requested any port and some packet pending |
| 343 | if not port_number and self.packets_pending != 0: |
| 344 | port = self._oldest_packet_find() |
| 345 | pkt, time = self.port_list[port].dequeue(use_lock=False) |
| 346 | self.pkt_sync.release() |
| 347 | oft_assert(pkt, "Poll: oldest packet not found") |
| 348 | return port, pkt, time |
| 349 | |
| 350 | # No packet pending; blocking call requested? |
| 351 | if not timeout: |
| 352 | self.pkt_sync.release() |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 353 | return None, None, None |
| 354 | |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 355 | # Desired packet isn't available and timeout is specified |
| 356 | # Already holding pkt_sync; wait on pkt_sync variable |
| 357 | self.want_pkt = True |
Dan Talayco | cf26b7a | 2011-08-05 10:15:35 -0700 | [diff] [blame^] | 358 | self.exp_pkt = exp_pkt |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 359 | self.want_pkt_port = port_number |
| 360 | self.got_pkt_port = None |
| 361 | self.pkt_sync.wait(timeout) |
| 362 | self.want_pkt = False |
Dan Talayco | cf26b7a | 2011-08-05 10:15:35 -0700 | [diff] [blame^] | 363 | self.exp_pkt = None |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 364 | if self.got_pkt_port: |
| 365 | pkt, time = \ |
| 366 | self.port_list[self.got_pkt_port].dequeue(use_lock=False) |
| 367 | self.pkt_sync.release() |
| 368 | oft_assert(pkt, "Poll: pkt reported, but not found at " + |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 369 | str(self.got_pkt_port)) |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 370 | return self.got_pkt_port, pkt, time |
| 371 | |
| 372 | self.pkt_sync.release() |
Dan Talayco | a99c21a | 2010-05-07 09:23:34 -0700 | [diff] [blame] | 373 | self.logger.debug("Poll time out, no packet from " + str(port_number)) |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 374 | |
| 375 | return None, None, None |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 376 | |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 377 | def kill(self, join_threads=True): |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 378 | """ |
| 379 | Close all sockets for dataplane |
Dan Talayco | 710438c | 2010-02-18 15:16:07 -0800 | [diff] [blame] | 380 | @param join_threads If True call join on each thread |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 381 | """ |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 382 | for port_number in self.port_list.keys(): |
| 383 | self.port_list[port_number].kill() |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 384 | if join_threads: |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 385 | self.logger.debug("Joining " + str(port_number)) |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 386 | self.port_list[port_number].join() |
Dan Talayco | 3408952 | 2010-02-07 23:07:41 -0800 | [diff] [blame] | 387 | |
Dan Talayco | 4837010 | 2010-03-03 15:17:33 -0800 | [diff] [blame] | 388 | self.logger.info("DataPlane shutdown") |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 389 | |
| 390 | def show(self, prefix=''): |
| 391 | print prefix + "Dataplane Controller" |
Dan Talayco | e226eb1 | 2010-02-18 23:06:30 -0800 | [diff] [blame] | 392 | print prefix + "Packets pending" + str(self.packets_pending) |
Dan Talayco | 1b3f690 | 2010-02-15 14:14:19 -0800 | [diff] [blame] | 393 | for pnum, port in self.port_list.items(): |
| 394 | print prefix + "OpenFlow Port Number " + str(pnum) |
| 395 | port.show(prefix + ' ') |
| 396 | |