blob: b8761a486d91f78e7d7e2aafbaa8cb6cfae41262 [file] [log] [blame]
Toshio Koide4f308732014-02-18 15:19:48 -08001package net.onrc.onos.intent.runtime;
2
3import java.util.ArrayList;
4import java.util.Collection;
5import java.util.HashMap;
Toshio Koide798bc1b2014-02-20 14:02:40 -08006import java.util.HashSet;
Toshio Koidedf2eab92014-02-20 11:24:59 -08007import java.util.Iterator;
Toshio Koidebf875662014-02-24 12:19:15 -08008import java.util.LinkedList;
Toshio Koide4f308732014-02-18 15:19:48 -08009import java.util.Map;
Toshio Koide066506e2014-02-20 19:52:09 -080010import java.util.Map.Entry;
Toshio Koide93be5d62014-02-23 19:30:57 -080011import java.util.concurrent.locks.ReentrantLock;
Toshio Koide4f308732014-02-18 15:19:48 -080012
Toshio Koidea94060f2014-02-21 22:58:32 -080013import org.slf4j.Logger;
14import org.slf4j.LoggerFactory;
15
Toshio Koide4f308732014-02-18 15:19:48 -080016import net.floodlightcontroller.core.module.FloodlightModuleContext;
17import net.floodlightcontroller.core.module.FloodlightModuleException;
18import net.floodlightcontroller.core.module.IFloodlightModule;
19import net.floodlightcontroller.core.module.IFloodlightService;
20import net.onrc.onos.datagrid.IDatagridService;
21import net.onrc.onos.datagrid.IEventChannel;
Toshio Koide066506e2014-02-20 19:52:09 -080022import net.onrc.onos.datagrid.IEventChannelListener;
23import net.onrc.onos.intent.Intent;
Toshio Koidedf2eab92014-02-20 11:24:59 -080024import net.onrc.onos.intent.Intent.IntentState;
Toshio Koide4f308732014-02-18 15:19:48 -080025import net.onrc.onos.intent.IntentMap;
Toshio Koidedf2eab92014-02-20 11:24:59 -080026import net.onrc.onos.intent.IntentOperation;
Toshio Koide0c9106d2014-02-19 15:26:38 -080027import net.onrc.onos.intent.IntentOperation.Operator;
Toshio Koide4f308732014-02-18 15:19:48 -080028import net.onrc.onos.intent.IntentOperationList;
Toshio Koide0c9106d2014-02-19 15:26:38 -080029import net.onrc.onos.intent.PathIntent;
Toshio Koide4f308732014-02-18 15:19:48 -080030import net.onrc.onos.intent.PathIntentMap;
Toshio Koide066506e2014-02-20 19:52:09 -080031import net.onrc.onos.intent.ShortestPathIntent;
Toshio Koidedf2eab92014-02-20 11:24:59 -080032import net.onrc.onos.intent.persist.PersistIntent;
Toshio Koide0c9106d2014-02-19 15:26:38 -080033import net.onrc.onos.ofcontroller.networkgraph.DeviceEvent;
34import net.onrc.onos.ofcontroller.networkgraph.INetworkGraphListener;
Toshio Koide27ffd412014-02-18 19:15:27 -080035import net.onrc.onos.ofcontroller.networkgraph.INetworkGraphService;
Toshio Koide0c9106d2014-02-19 15:26:38 -080036import net.onrc.onos.ofcontroller.networkgraph.LinkEvent;
37import net.onrc.onos.ofcontroller.networkgraph.PortEvent;
38import net.onrc.onos.ofcontroller.networkgraph.SwitchEvent;
Nick Karanatsios8abe7172014-02-19 20:31:48 -080039import net.onrc.onos.registry.controller.IControllerRegistryService;
Toshio Koide4f308732014-02-18 15:19:48 -080040
Toshio Koide0c9106d2014-02-19 15:26:38 -080041/**
42 * @author Toshio Koide (t-koide@onlab.us)
43 */
Toshio Koide066506e2014-02-20 19:52:09 -080044public class PathCalcRuntimeModule implements IFloodlightModule, IPathCalcRuntimeService, INetworkGraphListener, IEventChannelListener<Long, IntentStateList> {
Toshio Koidebf875662014-02-24 12:19:15 -080045 class PerfLog {
46 private String step;
47 private long time;
48
49 public PerfLog(String step) {
50 this.step = step;
51 this.time = System.nanoTime();
52 }
53
54 public void logThis() {
55 log.error("Time:{}, Step:{}", time, step);
56 }
57 }
58 class PerfLogger {
59 private LinkedList<PerfLog> logData = new LinkedList<>();
60
61 public PerfLogger(String logPhase) {
62 log("start_" + logPhase);
63 }
64
65 public void log(String step) {
66 logData.add(new PerfLog(step));
67 }
68
69 public void flushLog() {
70 log("finish");
71 for (PerfLog log: logData) {
72 log.logThis();
73 }
74 logData.clear();
75 }
76 }
Toshio Koide4f308732014-02-18 15:19:48 -080077 private PathCalcRuntime runtime;
78 private IDatagridService datagridService;
Toshio Koide27ffd412014-02-18 19:15:27 -080079 private INetworkGraphService networkGraphService;
Toshio Koide4f308732014-02-18 15:19:48 -080080 private IntentMap highLevelIntents;
Toshio Koide27ffd412014-02-18 19:15:27 -080081 private PathIntentMap pathIntents;
Toshio Koide798bc1b2014-02-20 14:02:40 -080082 private IControllerRegistryService controllerRegistry;
83 private PersistIntent persistIntent;
Toshio Koide27ffd412014-02-18 19:15:27 -080084
Toshio Koide066506e2014-02-20 19:52:09 -080085 private IEventChannel<Long, IntentOperationList> opEventChannel;
Toshio Koide93be5d62014-02-23 19:30:57 -080086 private final ReentrantLock lock = new ReentrantLock();
Toshio Koide066506e2014-02-20 19:52:09 -080087 private static final String INTENT_OP_EVENT_CHANNEL_NAME = "onos.pathintent";
88 private static final String INTENT_STATE_EVENT_CHANNEL_NAME = "onos.pathintent_state";
Toshio Koidea94060f2014-02-21 22:58:32 -080089 private static final Logger log = LoggerFactory.getLogger(PathCalcRuntimeModule.class);
Toshio Koide4f308732014-02-18 15:19:48 -080090
Toshio Koide798bc1b2014-02-20 14:02:40 -080091 // ================================================================================
92 // private methods
93 // ================================================================================
94
Toshio Koidea94060f2014-02-21 22:58:32 -080095 private void reroutePaths(Collection<Intent> oldPaths) {
Toshio Koidea9078af2014-02-21 16:57:04 -080096 if (oldPaths == null || oldPaths.isEmpty())
Toshio Koide798bc1b2014-02-20 14:02:40 -080097 return;
Toshio Koidea10c0372014-02-20 17:28:10 -080098
Toshio Koide0c9106d2014-02-19 15:26:38 -080099 IntentOperationList reroutingOperation = new IntentOperationList();
Toshio Koide982c81f2014-02-23 16:53:10 -0800100 for (Intent intent : oldPaths) {
101 PathIntent pathIntent = (PathIntent) intent;
102 if (pathIntent.getState().equals(IntentState.INST_ACK) &&
103 !reroutingOperation.contains(pathIntent)) {
104 reroutingOperation.add(Operator.ADD, pathIntent.getParentIntent());
105 }
Toshio Koide0c9106d2014-02-19 15:26:38 -0800106 }
Toshio Koide8315d7d2014-02-21 22:58:32 -0800107 executeIntentOperations(reroutingOperation);
Toshio Koidea94060f2014-02-21 22:58:32 -0800108 }
109
Toshio Koide27ffd412014-02-18 19:15:27 -0800110
Toshio Koide798bc1b2014-02-20 14:02:40 -0800111 // ================================================================================
112 // IFloodlightModule implementations
113 // ================================================================================
114
Toshio Koide4f308732014-02-18 15:19:48 -0800115 @Override
116 public Collection<Class<? extends IFloodlightService>> getModuleServices() {
117 Collection<Class<? extends IFloodlightService>> l = new ArrayList<>(1);
Toshio Koideeb90d912014-02-18 21:30:22 -0800118 l.add(IPathCalcRuntimeService.class);
Toshio Koide4f308732014-02-18 15:19:48 -0800119 return l;
120 }
121
122 @Override
123 public Map<Class<? extends IFloodlightService>, IFloodlightService> getServiceImpls() {
Toshio Koidea9078af2014-02-21 16:57:04 -0800124 Map<Class<? extends IFloodlightService>, IFloodlightService> m = new HashMap<>();
Toshio Koide27ffd412014-02-18 19:15:27 -0800125 m.put(IPathCalcRuntimeService.class, this);
Toshio Koide4f308732014-02-18 15:19:48 -0800126 return m;
127 }
128
129 @Override
130 public Collection<Class<? extends IFloodlightService>> getModuleDependencies() {
Toshio Koidea9078af2014-02-21 16:57:04 -0800131 Collection<Class<? extends IFloodlightService>> l = new ArrayList<>(2);
Toshio Koide4f308732014-02-18 15:19:48 -0800132 l.add(IDatagridService.class);
Toshio Koide27ffd412014-02-18 19:15:27 -0800133 l.add(INetworkGraphService.class);
Toshio Koide4f308732014-02-18 15:19:48 -0800134 return l;
135 }
136
137 @Override
138 public void init(FloodlightModuleContext context) throws FloodlightModuleException {
139 datagridService = context.getServiceImpl(IDatagridService.class);
Toshio Koided9fa2a82014-02-19 17:35:18 -0800140 networkGraphService = context.getServiceImpl(INetworkGraphService.class);
Toshio Koide798bc1b2014-02-20 14:02:40 -0800141 controllerRegistry = context.getServiceImpl(IControllerRegistryService.class);
Toshio Koide4f308732014-02-18 15:19:48 -0800142 }
143
144 @Override
145 public void startUp(FloodlightModuleContext context) {
Toshio Koideeb90d912014-02-18 21:30:22 -0800146 highLevelIntents = new IntentMap();
147 runtime = new PathCalcRuntime(networkGraphService.getNetworkGraph());
Toshio Koide0c9106d2014-02-19 15:26:38 -0800148 pathIntents = new PathIntentMap();
Toshio Koide066506e2014-02-20 19:52:09 -0800149 opEventChannel = datagridService.createChannel(INTENT_OP_EVENT_CHANNEL_NAME, Long.class, IntentOperationList.class);
150 datagridService.addListener(INTENT_STATE_EVENT_CHANNEL_NAME, this, Long.class, IntentStateList.class);
Toshio Koide0c9106d2014-02-19 15:26:38 -0800151 networkGraphService.registerNetworkGraphListener(this);
Toshio Koide798bc1b2014-02-20 14:02:40 -0800152 persistIntent = new PersistIntent(controllerRegistry, networkGraphService);
Toshio Koide4f308732014-02-18 15:19:48 -0800153 }
Toshio Koide27ffd412014-02-18 19:15:27 -0800154
Toshio Koide798bc1b2014-02-20 14:02:40 -0800155 // ================================================================================
156 // IPathCalcRuntimeService implementations
157 // ================================================================================
158
Toshio Koide27ffd412014-02-18 19:15:27 -0800159 @Override
160 public IntentOperationList executeIntentOperations(IntentOperationList list) {
Toshio Koide93be5d62014-02-23 19:30:57 -0800161 lock.lock(); // TODO optimize locking using smaller steps
Toshio Koidebf875662014-02-24 12:19:15 -0800162 if (list == null || list.size() == 0)
163 return null;
164 PerfLogger p = new PerfLogger("executeIntentOperations_" + list.get(0).operator);
Toshio Koide93be5d62014-02-23 19:30:57 -0800165 try {
166 // update the map of high-level intents
Toshio Koidebf875662014-02-24 12:19:15 -0800167 p.log("begin_updateInMemoryIntents");
Toshio Koide93be5d62014-02-23 19:30:57 -0800168 highLevelIntents.executeOperations(list);
Toshio Koidedf2eab92014-02-20 11:24:59 -0800169
Toshio Koide93be5d62014-02-23 19:30:57 -0800170 // change states of high-level intents
171 IntentStateList states = new IntentStateList();
172 for (IntentOperation op : list) {
173 if (op.intent.getState().equals(IntentState.INST_ACK))
174 states.put(op.intent.getId(), IntentState.REROUTE_REQ);
Toshio Koidedf2eab92014-02-20 11:24:59 -0800175 }
Toshio Koide93be5d62014-02-23 19:30:57 -0800176 highLevelIntents.changeStates(states);
Toshio Koidebf875662014-02-24 12:19:15 -0800177 p.log("end_updateInMemoryIntents");
Toshio Koidedf2eab92014-02-20 11:24:59 -0800178
Toshio Koide93be5d62014-02-23 19:30:57 -0800179 // calculate path-intents (low-level operations)
Toshio Koidebf875662014-02-24 12:19:15 -0800180 p.log("begin_calcPathIntents");
Toshio Koide93be5d62014-02-23 19:30:57 -0800181 IntentOperationList pathIntentOperations = runtime.calcPathIntents(list, highLevelIntents, pathIntents);
Toshio Koidebf875662014-02-24 12:19:15 -0800182 p.log("end_calcPathIntents");
Toshio Koide600ae5f2014-02-20 18:42:00 -0800183
Toshio Koide93be5d62014-02-23 19:30:57 -0800184 // persist calculated low-level operations into data store
Toshio Koidebf875662014-02-24 12:19:15 -0800185 p.log("begin_persistPathIntents");
Toshio Koide93be5d62014-02-23 19:30:57 -0800186 long key = persistIntent.getKey();
187 persistIntent.persistIfLeader(key, pathIntentOperations);
Toshio Koidebf875662014-02-24 12:19:15 -0800188 p.log("end_persistPathIntents");
Toshio Koide93be5d62014-02-23 19:30:57 -0800189
190 // remove error-intents and reflect them to high-level intents
Toshio Koidebf875662014-02-24 12:19:15 -0800191 p.log("begin_removeErrorIntents");
Toshio Koide93be5d62014-02-23 19:30:57 -0800192 states.clear();
193 Iterator<IntentOperation> i = pathIntentOperations.iterator();
194 while (i.hasNext()) {
195 IntentOperation op = i.next();
196 if (op.operator.equals(Operator.ERROR)) {
197 states.put(op.intent.getId(), IntentState.INST_NACK);
198 i.remove();
199 }
Toshio Koide600ae5f2014-02-20 18:42:00 -0800200 }
Toshio Koide93be5d62014-02-23 19:30:57 -0800201 highLevelIntents.changeStates(states);
Toshio Koidebf875662014-02-24 12:19:15 -0800202 p.log("end_removeErrorIntents");
Toshio Koidea94060f2014-02-21 22:58:32 -0800203
Toshio Koide93be5d62014-02-23 19:30:57 -0800204 // update the map of path intents and publish the path operations
Toshio Koidebf875662014-02-24 12:19:15 -0800205 p.log("begin_updateInMemoryPathIntents");
Toshio Koide93be5d62014-02-23 19:30:57 -0800206 pathIntents.executeOperations(pathIntentOperations);
Toshio Koidebf875662014-02-24 12:19:15 -0800207 p.log("end_updateInMemoryPathIntents");
Toshio Koide93be5d62014-02-23 19:30:57 -0800208
209 // Demo special: add a complete path to remove operation
Toshio Koidebf875662014-02-24 12:19:15 -0800210 p.log("begin_addPathToRemoveOperation");
Toshio Koide93be5d62014-02-23 19:30:57 -0800211 for (IntentOperation op: pathIntentOperations) {
212 if(op.operator.equals(Operator.REMOVE)) {
213 op.intent = pathIntents.getIntent(op.intent.getId());
214 }
215 if (op.intent instanceof PathIntent) {
216 log.debug("operation: {}, intent:{}", op.operator, op.intent);
217 }
218 }
Toshio Koidebf875662014-02-24 12:19:15 -0800219 p.log("end_addPathToRemoveOperation");
Toshio Koide93be5d62014-02-23 19:30:57 -0800220
221 // send notification
Toshio Koidebf875662014-02-24 12:19:15 -0800222 p.log("begin_sendNotification");
Toshio Koide93be5d62014-02-23 19:30:57 -0800223 opEventChannel.addEntry(key, pathIntentOperations);
Toshio Koidebf875662014-02-24 12:19:15 -0800224 p.log("end_sendNotification");
225 opEventChannel.removeEntry(key);
Toshio Koide93be5d62014-02-23 19:30:57 -0800226 return pathIntentOperations;
227 }
228 finally {
Toshio Koidebf875662014-02-24 12:19:15 -0800229 p.flushLog();
Toshio Koide93be5d62014-02-23 19:30:57 -0800230 lock.unlock();
231 }
Toshio Koide27ffd412014-02-18 19:15:27 -0800232 }
233
234 @Override
235 public IntentMap getHighLevelIntents() {
Toshio Koide4f308732014-02-18 15:19:48 -0800236 return highLevelIntents;
237 }
Toshio Koide27ffd412014-02-18 19:15:27 -0800238
239 @Override
240 public IntentMap getPathIntents() {
241 return pathIntents;
242 }
243
244 @Override
Toshio Koide4f308732014-02-18 15:19:48 -0800245 public void purgeIntents() {
246 highLevelIntents.purge();
Toshio Koide27ffd412014-02-18 19:15:27 -0800247 pathIntents.purge();
Toshio Koide4f308732014-02-18 15:19:48 -0800248 }
Toshio Koide0c9106d2014-02-19 15:26:38 -0800249
Toshio Koide798bc1b2014-02-20 14:02:40 -0800250 // ================================================================================
251 // INetworkGraphListener implementations
252 // ================================================================================
253
Toshio Koide0c9106d2014-02-19 15:26:38 -0800254 @Override
Toshio Koide798bc1b2014-02-20 14:02:40 -0800255 public void networkGraphEvents(Collection<SwitchEvent> addedSwitchEvents,
256 Collection<SwitchEvent> removedSwitchEvents,
257 Collection<PortEvent> addedPortEvents,
258 Collection<PortEvent> removedPortEvents,
259 Collection<LinkEvent> addedLinkEvents,
260 Collection<LinkEvent> removedLinkEvents,
261 Collection<DeviceEvent> addedDeviceEvents,
262 Collection<DeviceEvent> removedDeviceEvents) {
Toshio Koidea9078af2014-02-21 16:57:04 -0800263
Toshio Koidebf875662014-02-24 12:19:15 -0800264 PerfLogger p = new PerfLogger("networkGraphEvents");
Toshio Koidea94060f2014-02-21 22:58:32 -0800265 HashSet<Intent> affectedPaths = new HashSet<>();
Toshio Koidea9078af2014-02-21 16:57:04 -0800266
Toshio Koidebf875662014-02-24 12:19:15 -0800267 if (addedLinkEvents.size() > 0) { // ||
268// addedPortEvents.size() > 0 ||
269// addedSwitchEvents.size() > 0) {
270 p.log("begin_getAllIntents");
Toshio Koidea94060f2014-02-21 22:58:32 -0800271 affectedPaths.addAll(getPathIntents().getAllIntents());
Toshio Koidebf875662014-02-24 12:19:15 -0800272 p.log("end_getAllIntents");
Toshio Koidea94060f2014-02-21 22:58:32 -0800273 }
274 else {
Toshio Koidebf875662014-02-24 12:19:15 -0800275 p.log("begin_getIntentsByLink");
Toshio Koidea94060f2014-02-21 22:58:32 -0800276 for (LinkEvent linkEvent: removedLinkEvents)
277 affectedPaths.addAll(pathIntents.getIntentsByLink(linkEvent));
Toshio Koidebf875662014-02-24 12:19:15 -0800278 p.log("end_getIntentsByLink");
Toshio Koidea9078af2014-02-21 16:57:04 -0800279
Toshio Koidebf875662014-02-24 12:19:15 -0800280 p.log("begin_getIntentsByPort");
Toshio Koidea94060f2014-02-21 22:58:32 -0800281 for (PortEvent portEvent: removedPortEvents)
282 affectedPaths.addAll(pathIntents.getIntentsByPort(portEvent.getDpid(), portEvent.getNumber()));
Toshio Koidebf875662014-02-24 12:19:15 -0800283 p.log("end_getIntentsByPort");
Toshio Koidea9078af2014-02-21 16:57:04 -0800284
Toshio Koidebf875662014-02-24 12:19:15 -0800285 p.log("begin_getIntentsByDpid");
Toshio Koidea94060f2014-02-21 22:58:32 -0800286 for (SwitchEvent switchEvent: removedSwitchEvents)
287 affectedPaths.addAll(pathIntents.getIntentsByDpid(switchEvent.getDpid()));
Toshio Koidebf875662014-02-24 12:19:15 -0800288 p.log("end_getIntentsByDpid");
Toshio Koidea94060f2014-02-21 22:58:32 -0800289 }
Toshio Koidea9078af2014-02-21 16:57:04 -0800290 reroutePaths(affectedPaths);
Toshio Koidebf875662014-02-24 12:19:15 -0800291 p.flushLog();
Toshio Koide0c9106d2014-02-19 15:26:38 -0800292 }
Toshio Koide066506e2014-02-20 19:52:09 -0800293
294 // ================================================================================
295 // IEventChannelListener implementations
296 // ================================================================================
297
298 @Override
299 public void entryAdded(IntentStateList value) {
300 entryUpdated(value);
301 }
302
303 @Override
304 public void entryRemoved(IntentStateList value) {
305 // do nothing
306 }
307
308 @Override
309 public void entryUpdated(IntentStateList value) {
Toshio Koide8315d7d2014-02-21 22:58:32 -0800310 // TODO draw state transition diagram in multiple ONOS instances and update this method
Toshio Koidebf875662014-02-24 12:19:15 -0800311 PerfLogger p = new PerfLogger("entryUpdated");
Toshio Koide93be5d62014-02-23 19:30:57 -0800312 lock.lock(); // TODO optimize locking using smaller steps
313 try {
Toshio Koide93be5d62014-02-23 19:30:57 -0800314 // reflect state changes of path-level intent into application-level intents
Toshio Koidebf875662014-02-24 12:19:15 -0800315 p.log("begin_changeStateByNotification");
Toshio Koide93be5d62014-02-23 19:30:57 -0800316 IntentStateList parentStates = new IntentStateList();
317 for (Entry<String, IntentState> entry: value.entrySet()) {
318 PathIntent pathIntent = (PathIntent) pathIntents.getIntent(entry.getKey());
319 if (pathIntent == null) continue;
Toshio Koide8315d7d2014-02-21 22:58:32 -0800320
Toshio Koide93be5d62014-02-23 19:30:57 -0800321 Intent parentIntent = pathIntent.getParentIntent();
322 if (parentIntent == null ||
323 !(parentIntent instanceof ShortestPathIntent) ||
324 !((ShortestPathIntent) parentIntent).getPathIntentId().equals(pathIntent.getId()))
325 continue;
Toshio Koide066506e2014-02-20 19:52:09 -0800326
Toshio Koide93be5d62014-02-23 19:30:57 -0800327 IntentState state = entry.getValue();
328 switch (state) {
329 case INST_REQ:
330 case INST_ACK:
331 case INST_NACK:
332 case DEL_REQ:
333 case DEL_ACK:
334 case DEL_PENDING:
335 parentStates.put(parentIntent.getId(), state);
336 break;
337 default:
338 break;
339 }
Toshio Koide066506e2014-02-20 19:52:09 -0800340 }
Toshio Koide93be5d62014-02-23 19:30:57 -0800341 highLevelIntents.changeStates(parentStates);
342 pathIntents.changeStates(value);
Toshio Koidebf875662014-02-24 12:19:15 -0800343 p.log("end_changeStateByNotification");
Toshio Koide066506e2014-02-20 19:52:09 -0800344 }
Toshio Koide93be5d62014-02-23 19:30:57 -0800345 finally {
Toshio Koidebf875662014-02-24 12:19:15 -0800346 p.flushLog();
Toshio Koide93be5d62014-02-23 19:30:57 -0800347 lock.unlock();
348 }
Toshio Koide066506e2014-02-20 19:52:09 -0800349 }
Toshio Koidea9078af2014-02-21 16:57:04 -0800350}