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