Brian O'Connor | 8c166a7 | 2013-11-14 18:41:48 -0800 | [diff] [blame] | 1 | package net.onrc.onos.ofcontroller.flowprogrammer; |
| 2 | |
| 3 | import java.util.ArrayList; |
| 4 | import java.util.Collection; |
| 5 | import java.util.HashMap; |
| 6 | import java.util.Map; |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 7 | |
| 8 | import org.openflow.protocol.OFFlowRemoved; |
| 9 | import org.openflow.protocol.OFMessage; |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 10 | import org.openflow.protocol.OFType; |
| 11 | import org.slf4j.Logger; |
| 12 | import org.slf4j.LoggerFactory; |
| 13 | |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 14 | import net.floodlightcontroller.core.FloodlightContext; |
Brian O'Connor | 8c166a7 | 2013-11-14 18:41:48 -0800 | [diff] [blame] | 15 | import net.floodlightcontroller.core.IFloodlightProviderService; |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 16 | import net.floodlightcontroller.core.IOFMessageListener; |
| 17 | import net.floodlightcontroller.core.IOFSwitch; |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 18 | import net.floodlightcontroller.core.IOFSwitchListener; |
Brian O'Connor | 8c166a7 | 2013-11-14 18:41:48 -0800 | [diff] [blame] | 19 | import net.floodlightcontroller.core.module.FloodlightModuleContext; |
| 20 | import net.floodlightcontroller.core.module.FloodlightModuleException; |
| 21 | import net.floodlightcontroller.core.module.IFloodlightModule; |
| 22 | import net.floodlightcontroller.core.module.IFloodlightService; |
Brian O'Connor | bae524b | 2013-11-26 15:00:26 -0800 | [diff] [blame] | 23 | import net.onrc.onos.flow.IFlowManager; |
| 24 | import net.onrc.onos.ofcontroller.flowmanager.IFlowService; |
| 25 | import net.onrc.onos.ofcontroller.util.FlowEntryId; |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 26 | import net.onrc.onos.registry.controller.IControllerRegistryService; |
Brian O'Connor | 8c166a7 | 2013-11-14 18:41:48 -0800 | [diff] [blame] | 27 | |
Naoki Shiota | e319973 | 2013-11-25 16:14:43 -0800 | [diff] [blame] | 28 | /** |
| 29 | * FlowProgrammer is a module responsible to maintain flows installed to switches. |
| 30 | * FlowProgrammer consists of FlowPusher and FlowSynchronizer. |
Naoki Shiota | b485d41 | 2013-11-26 12:04:19 -0800 | [diff] [blame] | 31 | * FlowPusher manages the rate of installation, and FlowSynchronizer synchronizes |
Naoki Shiota | e319973 | 2013-11-25 16:14:43 -0800 | [diff] [blame] | 32 | * flows between GraphDB and switches. |
Naoki Shiota | b485d41 | 2013-11-26 12:04:19 -0800 | [diff] [blame] | 33 | * FlowProgrammer also watch the event of addition/deletion of switches to |
| 34 | * start/stop synchronization. When a switch is added to network, FlowProgrammer |
| 35 | * immediately kicks synchronization to keep switch's flow table latest state. |
| 36 | * Adversely, when a switch is removed from network, FlowProgrammer immediately |
| 37 | * stops synchronization. |
Naoki Shiota | e319973 | 2013-11-25 16:14:43 -0800 | [diff] [blame] | 38 | * @author Brian |
| 39 | * |
| 40 | */ |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 41 | public class FlowProgrammer implements IFloodlightModule, |
| 42 | IOFMessageListener, |
| 43 | IOFSwitchListener { |
Naoki Shiota | 81dbe30 | 2013-11-21 15:35:38 -0800 | [diff] [blame] | 44 | @SuppressWarnings("unused") |
Naoki Shiota | e319973 | 2013-11-25 16:14:43 -0800 | [diff] [blame] | 45 | // flag to enable FlowSynchronizer |
Brian O'Connor | e600f1d | 2013-11-25 23:09:18 -0800 | [diff] [blame] | 46 | private static final boolean enableFlowSync = false; |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 47 | protected static Logger log = LoggerFactory.getLogger(FlowProgrammer.class); |
Brian O'Connor | 8c166a7 | 2013-11-14 18:41:48 -0800 | [diff] [blame] | 48 | protected volatile IFloodlightProviderService floodlightProvider; |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 49 | protected volatile IControllerRegistryService registryService; |
Brian O'Connor | bae524b | 2013-11-26 15:00:26 -0800 | [diff] [blame] | 50 | protected volatile IFlowService flowManager; |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 51 | |
Brian O'Connor | 8c166a7 | 2013-11-14 18:41:48 -0800 | [diff] [blame] | 52 | protected FlowPusher pusher; |
| 53 | private static final int NUM_PUSHER_THREAD = 1; |
| 54 | |
| 55 | protected FlowSynchronizer synchronizer; |
Naoki Shiota | e319973 | 2013-11-25 16:14:43 -0800 | [diff] [blame] | 56 | |
Brian O'Connor | 8c166a7 | 2013-11-14 18:41:48 -0800 | [diff] [blame] | 57 | public FlowProgrammer() { |
| 58 | pusher = new FlowPusher(NUM_PUSHER_THREAD); |
Naoki Shiota | 8739faa | 2013-11-18 17:00:25 -0800 | [diff] [blame] | 59 | if (enableFlowSync) { |
Brian O'Connor | e600f1d | 2013-11-25 23:09:18 -0800 | [diff] [blame] | 60 | synchronizer = new FlowSynchronizer(); |
Naoki Shiota | 8739faa | 2013-11-18 17:00:25 -0800 | [diff] [blame] | 61 | } |
Brian O'Connor | 8c166a7 | 2013-11-14 18:41:48 -0800 | [diff] [blame] | 62 | } |
| 63 | |
| 64 | @Override |
| 65 | public void init(FloodlightModuleContext context) |
| 66 | throws FloodlightModuleException { |
| 67 | floodlightProvider = context.getServiceImpl(IFloodlightProviderService.class); |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 68 | registryService = context.getServiceImpl(IControllerRegistryService.class); |
Brian O'Connor | bae524b | 2013-11-26 15:00:26 -0800 | [diff] [blame] | 69 | flowManager = context.getServiceImpl(IFlowService.class); |
Naoki Shiota | c1601d3 | 2013-11-20 10:47:34 -0800 | [diff] [blame] | 70 | pusher.init(null, context, floodlightProvider.getOFMessageFactory(), null); |
Naoki Shiota | 8739faa | 2013-11-18 17:00:25 -0800 | [diff] [blame] | 71 | if (enableFlowSync) { |
Brian O'Connor | e600f1d | 2013-11-25 23:09:18 -0800 | [diff] [blame] | 72 | synchronizer.init(pusher); |
Naoki Shiota | 8739faa | 2013-11-18 17:00:25 -0800 | [diff] [blame] | 73 | } |
Brian O'Connor | 8c166a7 | 2013-11-14 18:41:48 -0800 | [diff] [blame] | 74 | } |
| 75 | |
| 76 | @Override |
| 77 | public void startUp(FloodlightModuleContext context) { |
| 78 | pusher.start(); |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 79 | floodlightProvider.addOFMessageListener(OFType.FLOW_REMOVED, this); |
| 80 | floodlightProvider.addOFSwitchListener(this); |
Brian O'Connor | 8c166a7 | 2013-11-14 18:41:48 -0800 | [diff] [blame] | 81 | } |
| 82 | |
| 83 | @Override |
| 84 | public Collection<Class<? extends IFloodlightService>> getModuleServices() { |
| 85 | Collection<Class<? extends IFloodlightService>> l = |
| 86 | new ArrayList<Class<? extends IFloodlightService>>(); |
| 87 | l.add(IFlowPusherService.class); |
Naoki Shiota | 8739faa | 2013-11-18 17:00:25 -0800 | [diff] [blame] | 88 | if (enableFlowSync) { |
Brian O'Connor | e600f1d | 2013-11-25 23:09:18 -0800 | [diff] [blame] | 89 | l.add(IFlowSyncService.class); |
Naoki Shiota | 8739faa | 2013-11-18 17:00:25 -0800 | [diff] [blame] | 90 | } |
Brian O'Connor | 8c166a7 | 2013-11-14 18:41:48 -0800 | [diff] [blame] | 91 | return l; |
| 92 | } |
| 93 | |
| 94 | @Override |
| 95 | public Map<Class<? extends IFloodlightService>, IFloodlightService> getServiceImpls() { |
| 96 | Map<Class<? extends IFloodlightService>, |
| 97 | IFloodlightService> m = |
| 98 | new HashMap<Class<? extends IFloodlightService>, |
| 99 | IFloodlightService>(); |
| 100 | m.put(IFlowPusherService.class, pusher); |
Naoki Shiota | 8739faa | 2013-11-18 17:00:25 -0800 | [diff] [blame] | 101 | if (enableFlowSync) { |
Brian O'Connor | e600f1d | 2013-11-25 23:09:18 -0800 | [diff] [blame] | 102 | m.put(IFlowSyncService.class, synchronizer); |
Naoki Shiota | 8739faa | 2013-11-18 17:00:25 -0800 | [diff] [blame] | 103 | } |
Brian O'Connor | 8c166a7 | 2013-11-14 18:41:48 -0800 | [diff] [blame] | 104 | return m; |
| 105 | } |
| 106 | |
| 107 | @Override |
| 108 | public Collection<Class<? extends IFloodlightService>> getModuleDependencies() { |
| 109 | Collection<Class<? extends IFloodlightService>> l = |
| 110 | new ArrayList<Class<? extends IFloodlightService>>(); |
| 111 | l.add(IFloodlightProviderService.class); |
| 112 | return l; |
| 113 | } |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 114 | |
| 115 | @Override |
| 116 | public String getName() { |
| 117 | // TODO Auto-generated method stub |
| 118 | return "FlowProgrammer"; |
| 119 | } |
| 120 | |
| 121 | @Override |
| 122 | public boolean isCallbackOrderingPrereq(OFType type, String name) { |
| 123 | // TODO Auto-generated method stub |
| 124 | return false; |
| 125 | } |
| 126 | |
| 127 | @Override |
| 128 | public boolean isCallbackOrderingPostreq(OFType type, String name) { |
| 129 | // TODO Auto-generated method stub |
| 130 | return false; |
| 131 | } |
| 132 | |
| 133 | @Override |
| 134 | public Command receive(IOFSwitch sw, OFMessage msg, FloodlightContext cntx) { |
| 135 | switch (msg.getType()) { |
| 136 | case FLOW_REMOVED: |
| 137 | OFFlowRemoved flowMsg = (OFFlowRemoved) msg; |
| 138 | log.debug("Got flow removed from "+ sw.getId() +": "+ flowMsg.getCookie()); |
Brian O'Connor | bae524b | 2013-11-26 15:00:26 -0800 | [diff] [blame] | 139 | FlowEntryId id = new FlowEntryId(flowMsg.getCookie()); |
| 140 | flowManager.flowEntryOnSwitchExpired(sw, id); |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 141 | break; |
| 142 | default: |
| 143 | break; |
| 144 | } |
| 145 | |
| 146 | return Command.CONTINUE; |
| 147 | } |
| 148 | |
| 149 | @Override |
| 150 | public void addedSwitch(IOFSwitch sw) { |
| 151 | log.debug("Switch added: {}", sw.getId()); |
| 152 | |
Brian O'Connor | e600f1d | 2013-11-25 23:09:18 -0800 | [diff] [blame] | 153 | if (enableFlowSync && registryService.hasControl(sw.getId())) { |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 154 | synchronizer.synchronize(sw); |
| 155 | } |
| 156 | } |
| 157 | |
| 158 | @Override |
| 159 | public void removedSwitch(IOFSwitch sw) { |
| 160 | log.debug("Switch removed: {}", sw.getId()); |
| 161 | |
Brian O'Connor | e600f1d | 2013-11-25 23:09:18 -0800 | [diff] [blame] | 162 | if (enableFlowSync) { |
| 163 | synchronizer.interrupt(sw); |
| 164 | } |
Brian O'Connor | ea1efbe | 2013-11-25 22:57:43 -0800 | [diff] [blame] | 165 | } |
| 166 | |
| 167 | @Override |
| 168 | public void switchPortChanged(Long switchId) { |
| 169 | // TODO Auto-generated method stub |
| 170 | } |
Brian O'Connor | 8c166a7 | 2013-11-14 18:41:48 -0800 | [diff] [blame] | 171 | |
Brian O'Connor | 8c166a7 | 2013-11-14 18:41:48 -0800 | [diff] [blame] | 172 | } |