alshabib | 0ccde6d | 2015-05-30 18:22:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2015 Open Networking Laboratory |
| 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 implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.driver.pipeline; |
| 17 | |
| 18 | import org.onlab.osgi.ServiceDirectory; |
Jonathan Hart | dfc3b86 | 2015-07-01 14:49:56 -0700 | [diff] [blame] | 19 | import org.onlab.packet.EthType; |
| 20 | import org.onosproject.core.ApplicationId; |
| 21 | import org.onosproject.core.CoreService; |
alshabib | 2cc73cb | 2015-06-30 20:26:56 -0700 | [diff] [blame] | 22 | import org.onosproject.net.DefaultAnnotations; |
| 23 | import org.onosproject.net.Device; |
alshabib | 0ccde6d | 2015-05-30 18:22:36 -0700 | [diff] [blame] | 24 | import org.onosproject.net.DeviceId; |
alshabib | 2cc73cb | 2015-06-30 20:26:56 -0700 | [diff] [blame] | 25 | import org.onosproject.net.MastershipRole; |
alshabib | 0ccde6d | 2015-05-30 18:22:36 -0700 | [diff] [blame] | 26 | import org.onosproject.net.PortNumber; |
| 27 | import org.onosproject.net.behaviour.Pipeliner; |
| 28 | import org.onosproject.net.behaviour.PipelinerContext; |
alshabib | 2cc73cb | 2015-06-30 20:26:56 -0700 | [diff] [blame] | 29 | import org.onosproject.net.device.DefaultDeviceDescription; |
| 30 | import org.onosproject.net.device.DeviceDescription; |
| 31 | import org.onosproject.net.device.DeviceProvider; |
| 32 | import org.onosproject.net.device.DeviceProviderRegistry; |
| 33 | import org.onosproject.net.device.DeviceProviderService; |
| 34 | import org.onosproject.net.device.DeviceService; |
alshabib | 0ccde6d | 2015-05-30 18:22:36 -0700 | [diff] [blame] | 35 | import org.onosproject.net.driver.AbstractHandlerBehaviour; |
| 36 | import org.onosproject.net.flow.DefaultFlowRule; |
Jonathan Hart | dfc3b86 | 2015-07-01 14:49:56 -0700 | [diff] [blame] | 37 | import org.onosproject.net.flow.DefaultTrafficSelector; |
alshabib | 0ccde6d | 2015-05-30 18:22:36 -0700 | [diff] [blame] | 38 | import org.onosproject.net.flow.DefaultTrafficTreatment; |
| 39 | import org.onosproject.net.flow.FlowRule; |
| 40 | import org.onosproject.net.flow.FlowRuleOperations; |
| 41 | import org.onosproject.net.flow.FlowRuleOperationsContext; |
| 42 | import org.onosproject.net.flow.FlowRuleService; |
| 43 | import org.onosproject.net.flow.TrafficSelector; |
| 44 | import org.onosproject.net.flow.TrafficTreatment; |
| 45 | import org.onosproject.net.flow.instructions.Instructions; |
| 46 | import org.onosproject.net.flowobjective.FilteringObjective; |
| 47 | import org.onosproject.net.flowobjective.ForwardingObjective; |
| 48 | import org.onosproject.net.flowobjective.NextObjective; |
| 49 | import org.onosproject.net.flowobjective.ObjectiveError; |
Jonathan Hart | dfc3b86 | 2015-07-01 14:49:56 -0700 | [diff] [blame] | 50 | import org.onosproject.net.packet.PacketPriority; |
alshabib | 2cc73cb | 2015-06-30 20:26:56 -0700 | [diff] [blame] | 51 | import org.onosproject.net.provider.AbstractProvider; |
| 52 | import org.onosproject.net.provider.ProviderId; |
alshabib | 0ccde6d | 2015-05-30 18:22:36 -0700 | [diff] [blame] | 53 | import org.slf4j.Logger; |
| 54 | |
alshabib | 2cc73cb | 2015-06-30 20:26:56 -0700 | [diff] [blame] | 55 | import static com.google.common.base.Preconditions.checkNotNull; |
alshabib | 0ccde6d | 2015-05-30 18:22:36 -0700 | [diff] [blame] | 56 | import static org.slf4j.LoggerFactory.getLogger; |
| 57 | |
| 58 | /** |
Jonathan Hart | 64da69d | 2015-07-15 15:10:28 -0700 | [diff] [blame] | 59 | * Pipeliner for OLT device. |
alshabib | 0ccde6d | 2015-05-30 18:22:36 -0700 | [diff] [blame] | 60 | */ |
| 61 | public class OLTPipeline extends AbstractHandlerBehaviour implements Pipeliner { |
| 62 | |
| 63 | private final Logger log = getLogger(getClass()); |
| 64 | |
alshabib | 2cc73cb | 2015-06-30 20:26:56 -0700 | [diff] [blame] | 65 | static final ProviderId PID = new ProviderId("olt", "org.onosproject.olt", true); |
| 66 | |
| 67 | static final String DEVICE = "isAccess"; |
| 68 | static final String OLT = "true"; |
| 69 | |
alshabib | 0ccde6d | 2015-05-30 18:22:36 -0700 | [diff] [blame] | 70 | private ServiceDirectory serviceDirectory; |
| 71 | private FlowRuleService flowRuleService; |
| 72 | private DeviceId deviceId; |
Jonathan Hart | dfc3b86 | 2015-07-01 14:49:56 -0700 | [diff] [blame] | 73 | private CoreService coreService; |
| 74 | |
| 75 | private ApplicationId appId; |
alshabib | 0ccde6d | 2015-05-30 18:22:36 -0700 | [diff] [blame] | 76 | |
alshabib | 2cc73cb | 2015-06-30 20:26:56 -0700 | [diff] [blame] | 77 | private DeviceProvider provider = new AnnotationProvider(); |
| 78 | |
alshabib | b32cefe | 2015-06-08 18:15:05 -0700 | [diff] [blame] | 79 | |
alshabib | 0ccde6d | 2015-05-30 18:22:36 -0700 | [diff] [blame] | 80 | @Override |
| 81 | public void init(DeviceId deviceId, PipelinerContext context) { |
| 82 | this.serviceDirectory = context.directory(); |
| 83 | this.deviceId = deviceId; |
alshabib | 2cc73cb | 2015-06-30 20:26:56 -0700 | [diff] [blame] | 84 | DeviceProviderRegistry registry = |
| 85 | serviceDirectory.get(DeviceProviderRegistry.class); |
alshabib | 0ccde6d | 2015-05-30 18:22:36 -0700 | [diff] [blame] | 86 | flowRuleService = serviceDirectory.get(FlowRuleService.class); |
Jonathan Hart | dfc3b86 | 2015-07-01 14:49:56 -0700 | [diff] [blame] | 87 | coreService = serviceDirectory.get(CoreService.class); |
alshabib | b32cefe | 2015-06-08 18:15:05 -0700 | [diff] [blame] | 88 | |
alshabib | 2cc73cb | 2015-06-30 20:26:56 -0700 | [diff] [blame] | 89 | try { |
| 90 | DeviceProviderService providerService = registry.register(provider); |
| 91 | providerService.deviceConnected(deviceId, |
| 92 | description(deviceId, DEVICE, OLT)); |
| 93 | } finally { |
| 94 | registry.unregister(provider); |
| 95 | } |
| 96 | |
Jonathan Hart | dfc3b86 | 2015-07-01 14:49:56 -0700 | [diff] [blame] | 97 | appId = coreService.registerApplication( |
| 98 | "org.onosproject.driver.OLTPipeline"); |
| 99 | |
| 100 | TrafficSelector selector = DefaultTrafficSelector.builder() |
| 101 | .matchEthType(EthType.EtherType.EAPOL.ethType().toShort()) |
| 102 | .build(); |
| 103 | |
| 104 | TrafficTreatment treatment = DefaultTrafficTreatment.builder() |
| 105 | .punt() |
| 106 | .build(); |
| 107 | |
| 108 | FlowRule flowRule = new DefaultFlowRule(deviceId, selector, treatment, |
| 109 | PacketPriority.CONTROL.priorityValue(), |
| 110 | appId, 0, true, null); |
| 111 | |
Jonathan Hart | 64da69d | 2015-07-15 15:10:28 -0700 | [diff] [blame] | 112 | flowRuleService.applyFlowRules(flowRule); |
alshabib | b32cefe | 2015-06-08 18:15:05 -0700 | [diff] [blame] | 113 | } |
| 114 | |
alshabib | 0ccde6d | 2015-05-30 18:22:36 -0700 | [diff] [blame] | 115 | @Override |
| 116 | public void filter(FilteringObjective filter) { |
| 117 | throw new UnsupportedOperationException("Single table does not filter."); |
| 118 | } |
| 119 | |
| 120 | @Override |
| 121 | public void forward(ForwardingObjective fwd) { |
alshabib | 0ccde6d | 2015-05-30 18:22:36 -0700 | [diff] [blame] | 122 | FlowRuleOperations.Builder flowBuilder = FlowRuleOperations.builder(); |
| 123 | |
| 124 | if (fwd.flag() != ForwardingObjective.Flag.VERSATILE) { |
| 125 | throw new UnsupportedOperationException( |
| 126 | "Only VERSATILE is supported."); |
| 127 | } |
| 128 | |
| 129 | boolean isPunt = fwd.treatment().immediate().stream().anyMatch(i -> { |
| 130 | if (i instanceof Instructions.OutputInstruction) { |
| 131 | Instructions.OutputInstruction out = (Instructions.OutputInstruction) i; |
| 132 | return out.port().equals(PortNumber.CONTROLLER); |
| 133 | } |
| 134 | return false; |
| 135 | }); |
| 136 | |
| 137 | if (isPunt) { |
| 138 | return; |
| 139 | } |
| 140 | |
| 141 | TrafficSelector selector = fwd.selector(); |
| 142 | TrafficTreatment treatment = fwd.treatment(); |
| 143 | if ((fwd.treatment().deferred().size() == 0) && |
| 144 | (fwd.treatment().immediate().size() == 0) && |
| 145 | (fwd.treatment().tableTransition() == null) && |
| 146 | (!fwd.treatment().clearedDeferred())) { |
| 147 | TrafficTreatment.Builder flowTreatment = DefaultTrafficTreatment.builder(); |
| 148 | flowTreatment.add(Instructions.createDrop()); |
| 149 | treatment = flowTreatment.build(); |
| 150 | } |
| 151 | |
| 152 | FlowRule.Builder ruleBuilder = DefaultFlowRule.builder() |
| 153 | .forDevice(deviceId) |
| 154 | .withSelector(selector) |
| 155 | .withTreatment(fwd.treatment()) |
| 156 | .fromApp(fwd.appId()) |
| 157 | .withPriority(fwd.priority()); |
| 158 | |
| 159 | if (fwd.permanent()) { |
| 160 | ruleBuilder.makePermanent(); |
| 161 | } else { |
| 162 | ruleBuilder.makeTemporary(fwd.timeout()); |
| 163 | } |
| 164 | |
| 165 | |
| 166 | switch (fwd.op()) { |
| 167 | |
| 168 | case ADD: |
| 169 | flowBuilder.add(ruleBuilder.build()); |
| 170 | break; |
| 171 | case REMOVE: |
| 172 | flowBuilder.remove(ruleBuilder.build()); |
| 173 | break; |
| 174 | default: |
| 175 | log.warn("Unknown operation {}", fwd.op()); |
| 176 | } |
| 177 | |
| 178 | flowRuleService.apply(flowBuilder.build(new FlowRuleOperationsContext() { |
| 179 | @Override |
| 180 | public void onSuccess(FlowRuleOperations ops) { |
| 181 | if (fwd.context().isPresent()) { |
| 182 | fwd.context().get().onSuccess(fwd); |
| 183 | } |
| 184 | } |
| 185 | |
| 186 | @Override |
| 187 | public void onError(FlowRuleOperations ops) { |
| 188 | if (fwd.context().isPresent()) { |
| 189 | fwd.context().get().onError(fwd, ObjectiveError.FLOWINSTALLATIONFAILED); |
| 190 | } |
| 191 | } |
| 192 | })); |
| 193 | |
| 194 | } |
| 195 | |
| 196 | @Override |
| 197 | public void next(NextObjective nextObjective) { |
| 198 | throw new UnsupportedOperationException("Single table does not next hop."); |
| 199 | } |
| 200 | |
alshabib | 2cc73cb | 2015-06-30 20:26:56 -0700 | [diff] [blame] | 201 | /** |
| 202 | * Build a device description. |
| 203 | * @param deviceId a deviceId |
| 204 | * @param key the key of the annotation |
| 205 | * @param value the value for the annotation |
| 206 | * @return a device description |
| 207 | */ |
| 208 | private DeviceDescription description(DeviceId deviceId, String key, String value) { |
| 209 | DeviceService deviceService = serviceDirectory.get(DeviceService.class); |
| 210 | Device device = deviceService.getDevice(deviceId); |
| 211 | |
| 212 | checkNotNull(device, "Device not found in device service."); |
| 213 | |
| 214 | DefaultAnnotations.Builder builder = DefaultAnnotations.builder(); |
| 215 | if (value != null) { |
| 216 | builder.set(key, value); |
| 217 | } else { |
| 218 | builder.remove(key); |
| 219 | } |
| 220 | return new DefaultDeviceDescription(device.id().uri(), device.type(), |
| 221 | device.manufacturer(), device.hwVersion(), |
| 222 | device.swVersion(), device.serialNumber(), |
| 223 | device.chassisId(), builder.build()); |
| 224 | } |
| 225 | |
| 226 | /** |
| 227 | * Simple ancillary provider used to annotate device. |
| 228 | */ |
| 229 | private static final class AnnotationProvider |
| 230 | extends AbstractProvider implements DeviceProvider { |
| 231 | private AnnotationProvider() { |
| 232 | super(PID); |
| 233 | } |
| 234 | |
| 235 | @Override |
| 236 | public void triggerProbe(DeviceId deviceId) { |
| 237 | } |
| 238 | |
| 239 | @Override |
| 240 | public void roleChanged(DeviceId deviceId, MastershipRole newRole) { |
| 241 | } |
| 242 | |
| 243 | @Override |
| 244 | public boolean isReachable(DeviceId deviceId) { |
| 245 | return false; |
| 246 | } |
| 247 | } |
| 248 | |
alshabib | 0ccde6d | 2015-05-30 18:22:36 -0700 | [diff] [blame] | 249 | } |