aboutsummaryrefslogtreecommitdiffstats
path: root/framework/src/onos/apps/vtn/sfcmgr/src/main/java/org/onosproject/sfc/forwarder/impl/ServiceFunctionForwarderImpl.java
blob: 2846ee019eaf340bb626362fe70598ce0ea57fc7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
/*
 * Copyright 2015 Open Networking Laboratory
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.onosproject.sfc.forwarder.impl;

import static org.slf4j.LoggerFactory.getLogger;
import static org.onosproject.net.flow.criteria.ExtensionSelectorType.ExtensionSelectorTypes.NICIRA_MATCH_NSH_SPI;
import static com.google.common.base.Preconditions.checkNotNull;

import java.util.List;
import java.util.ListIterator;

import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.ReferenceCardinality;
import org.onlab.osgi.DefaultServiceDirectory;
import org.onlab.osgi.ServiceDirectory;
import org.onlab.packet.MacAddress;
import org.onlab.packet.VlanId;
import org.onosproject.core.ApplicationId;
import org.onosproject.net.behaviour.ExtensionSelectorResolver;
import org.onosproject.net.DeviceId;
import org.onosproject.net.NshServicePathId;
import org.onosproject.net.driver.DriverHandler;
import org.onosproject.net.driver.DriverService;
import org.onosproject.net.flow.DefaultTrafficSelector;
import org.onosproject.net.flow.DefaultTrafficTreatment;
import org.onosproject.net.flow.criteria.ExtensionSelector;
import org.onosproject.net.flow.TrafficSelector;
import org.onosproject.net.flow.TrafficTreatment;
import org.onosproject.net.flowobjective.DefaultForwardingObjective;
import org.onosproject.net.flowobjective.FlowObjectiveService;
import org.onosproject.net.flowobjective.ForwardingObjective;
import org.onosproject.net.flowobjective.Objective;
import org.onosproject.net.flowobjective.ForwardingObjective.Flag;
import org.onosproject.vtnrsc.VirtualPortId;
import org.onosproject.vtnrsc.service.VtnRscService;
import org.onosproject.vtnrsc.PortChain;
import org.onosproject.vtnrsc.PortPair;
import org.onosproject.vtnrsc.PortPairGroup;
import org.onosproject.vtnrsc.PortPairGroupId;
import org.onosproject.vtnrsc.PortPairId;
import org.onosproject.vtnrsc.virtualport.VirtualPortService;
import org.onosproject.vtnrsc.portpair.PortPairService;
import org.onosproject.vtnrsc.portpairgroup.PortPairGroupService;
import org.onosproject.vtnrsc.flowclassifier.FlowClassifierService;
import org.onosproject.vtnrsc.portchain.PortChainService;
import org.onosproject.sfc.forwarder.ServiceFunctionForwarderService;

import org.slf4j.Logger;

/**
 * Provides Service Function Forwarder implementation.
 */
public class ServiceFunctionForwarderImpl implements ServiceFunctionForwarderService {

    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
    protected DriverService driverService;
    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
    protected VirtualPortService virtualPortService;
    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
    protected VtnRscService vtnRscService;
    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
    protected PortPairService portPairService;
    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
    protected PortPairGroupService portPairGroupService;
    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
    protected FlowClassifierService flowClassifierService;
    @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY)
    protected PortChainService portChainService;

    private final Logger log = getLogger(getClass());
    protected ApplicationId appId;
    protected FlowObjectiveService flowObjectiveService;

    private static final String DRIVER_NAME = "onosfw";
    private static final String PORT_CHAIN_NOT_NULL = "Port-Chain cannot be null";
    private static final String PORT_CHAIN_ID_NOT_NULL = "Port-Chain-Id cannot be null";
    private static final String APP_ID_NOT_NULL = "Application-Id cannot be null";
    private static final int NULL = 0;

    /**
     * Default constructor.
     */
    public ServiceFunctionForwarderImpl() {
    }

    /**
     * Explicit constructor.
     */
    public ServiceFunctionForwarderImpl(ApplicationId appId) {
        this.appId = checkNotNull(appId, APP_ID_NOT_NULL);
        ServiceDirectory serviceDirectory = new DefaultServiceDirectory();
        this.flowObjectiveService = serviceDirectory.get(FlowObjectiveService.class);
    }

    @Override
    public void installForwardingRule(PortChain portChain, NshServicePathId nshSPI) {
        checkNotNull(portChain, PORT_CHAIN_NOT_NULL);
        prepareServiceFunctionForwarder(portChain, nshSPI, Objective.Operation.ADD);
    }

    @Override
    public void unInstallForwardingRule(PortChain portChain, NshServicePathId nshSPI) {
        checkNotNull(portChain, PORT_CHAIN_NOT_NULL);
        prepareServiceFunctionForwarder(portChain, nshSPI, Objective.Operation.REMOVE);
    }

    @Override
    public void prepareServiceFunctionForwarder(PortChain portChain, NshServicePathId nshSPI,
                                                Objective.Operation type) {

        // Go through the port pair group list
        List<PortPairGroupId> portPairGrpList = portChain.portPairGroups();
        ListIterator<PortPairGroupId> listGrpIterator = portPairGrpList.listIterator();

        // Get source port pair group
        if (!listGrpIterator.hasNext()) {
            return;
        }
        PortPairGroupId portPairGrpId = listGrpIterator.next();
        PortPairGroup currentPortPairGroup = portPairGroupService.getPortPairGroup(portPairGrpId);

        // Get destination port pair group
        if (!listGrpIterator.hasNext()) {
            return;
        }
        portPairGrpId = listGrpIterator.next();
        PortPairGroup nextPortPairGroup = portPairGroupService.getPortPairGroup(portPairGrpId);

        // push SFF to OVS
        pushServiceFunctionForwarder(currentPortPairGroup, nextPortPairGroup, listGrpIterator, nshSPI, type);
    }

    /**
     * Push service-function-forwarder to OVS.
     *
     * @param currentPortPairGroup current port-pair-group
     * @param nextPortPairGroup next port-pair-group
     * @param listGrpIterator pointer to port-pair-group list
     */
    public void pushServiceFunctionForwarder(PortPairGroup currentPortPairGroup, PortPairGroup nextPortPairGroup,
            ListIterator<PortPairGroupId> listGrpIterator, NshServicePathId nshSPI, Objective.Operation type) {
        MacAddress srcMacAddress = null;
        MacAddress dstMacAddress = null;
        DeviceId deviceId = null;
        DeviceId currentDeviceId = null;
        DeviceId nextDeviceId = null;
        PortPairGroupId portPairGrpId = null;

        // Travel from SF to SF.
        do {
            // Get the required information on port pairs from source port pair
            // group
            List<PortPairId> portPairList = currentPortPairGroup.portPairs();
            ListIterator<PortPairId> portPLIterator = portPairList.listIterator();
            if (!portPLIterator.hasNext()) {
                break;
            }

            PortPairId portPairId = portPLIterator.next();
            PortPair portPair = portPairService.getPortPair(portPairId);

            currentDeviceId = vtnRscService.getSFToSFFMaping(VirtualPortId.portId(portPair.ingress()));
            if (deviceId == null) {
                deviceId = currentDeviceId;
            }
            srcMacAddress = virtualPortService.getPort(VirtualPortId.portId(portPair.ingress())).macAddress();
            dstMacAddress = virtualPortService.getPort(VirtualPortId.portId(portPair.egress())).macAddress();

            // pack traffic selector
            TrafficSelector.Builder selector = packTrafficSelector(deviceId, srcMacAddress, dstMacAddress, nshSPI);

            // Get the required information on port pairs from destination port
            // pair group
            portPairList = nextPortPairGroup.portPairs();
            portPLIterator = portPairList.listIterator();
            if (!portPLIterator.hasNext()) {
                break;
            }

            portPairId = portPLIterator.next();
            portPair = portPairService.getPortPair(portPairId);

            nextDeviceId = vtnRscService.getSFToSFFMaping(VirtualPortId.portId(portPair.ingress()));

            // pack traffic treatment
            TrafficTreatment.Builder treatment = packTrafficTreatment(currentDeviceId, nextDeviceId, portPair);

            // Send SFF to OVS
            sendServiceFunctionForwarder(selector, treatment, deviceId, type);

            // Replace source port pair group with destination port pair group
            // for moving to next SFF processing.
            currentPortPairGroup = nextPortPairGroup;
            if (!listGrpIterator.hasNext()) {
                break;
            }
            portPairGrpId = listGrpIterator.next();
            nextPortPairGroup = portPairGroupService.getPortPairGroup(portPairGrpId);
        } while (true);
    }

    /**
     * Pack Traffic selector.
     *
     * @param deviceId device id
     * @param srcMacAddress source mac-address
     * @param dstMacAddress destination mac-address
     * @param nshSPI nsh spi
     * @return traffic treatment
     */
    public TrafficSelector.Builder packTrafficSelector(DeviceId deviceId, MacAddress srcMacAddress,
            MacAddress dstMacAddress, NshServicePathId nshSPI) {
        TrafficSelector.Builder selector = DefaultTrafficSelector.builder();
        selector.matchEthSrc(srcMacAddress);
        selector.matchEthDst(dstMacAddress);

        DriverHandler handler = driverService.createHandler(deviceId);
        ExtensionSelectorResolver resolver = handler.behaviour(ExtensionSelectorResolver.class);
        ExtensionSelector nspSpiSelector = resolver.getExtensionSelector(NICIRA_MATCH_NSH_SPI.type());

        try {
            nspSpiSelector.setPropertyValue("nshSpi", nshSPI);
        } catch (Exception e) {
            log.error("Failed to get extension instruction to set Nsh Spi Id {}", deviceId);
        }

        selector.extension(nspSpiSelector, deviceId);
        return selector;
    }

    /**
     * Pack Traffic treatment.
     *
     * @param currentDeviceId current device id
     * @param nextDeviceId next device id
     * @param portPair port-pair
     * @return traffic treatment
     */
    public TrafficTreatment.Builder packTrafficTreatment(DeviceId currentDeviceId, DeviceId nextDeviceId,
            PortPair portPair) {
        MacAddress srcMacAddress = null;
        MacAddress dstMacAddress = null;

        // Check the treatment whether destination SF is on same OVS or in
        // different OVS.
        TrafficTreatment.Builder treatment = DefaultTrafficTreatment.builder();
        if (currentDeviceId.equals(nextDeviceId)) {
            srcMacAddress = virtualPortService.getPort(VirtualPortId.portId(portPair.ingress())).macAddress();
            dstMacAddress = virtualPortService.getPort(VirtualPortId.portId(portPair.egress())).macAddress();
            treatment.setEthSrc(srcMacAddress);
            treatment.setEthDst(dstMacAddress);
        } else {
            treatment.setVlanId(VlanId.vlanId(Short.parseShort((vtnRscService.getL3vni(portPair
                    .tenantId()).toString()))));
        }

        return treatment;
    }

    /**
     * Send service function forwarder to OVS.
     *
     * @param selector traffic selector
     * @param treatment traffic treatment
     * @param deviceId device id
     * @param type operation type
     */
    public void sendServiceFunctionForwarder(TrafficSelector.Builder selector, TrafficTreatment.Builder treatment,
            DeviceId deviceId, Objective.Operation type) {
        ForwardingObjective.Builder objective = DefaultForwardingObjective.builder().withTreatment(treatment.build())
                .withSelector(selector.build()).fromApp(appId).makePermanent().withFlag(Flag.SPECIFIC);
        if (type.equals(Objective.Operation.ADD)) {
            log.debug("ADD");
            flowObjectiveService.forward(deviceId, objective.add());
        } else {
            log.debug("REMOVE");
            flowObjectiveService.forward(deviceId, objective.remove());
        }
    }
}