BUG 8914: Fix NPE in sfc.classifier-impl
[netvirt.git] / vpnservice / sfc / classifier / impl / src / main / java / org / opendaylight / netvirt / sfc / classifier / service / domain / impl / ConfigurationClassifierImpl.java
1 /*
2  * Copyright (c) 2017 Ericsson Inc. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8
9 package org.opendaylight.netvirt.sfc.classifier.service.domain.impl;
10
11 import java.util.ArrayList;
12 import java.util.Collections;
13 import java.util.HashMap;
14 import java.util.HashSet;
15 import java.util.List;
16 import java.util.Map;
17 import java.util.Objects;
18 import java.util.Optional;
19 import java.util.Set;
20 import java.util.stream.Collectors;
21 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
22 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
23 import org.opendaylight.genius.mdsalutil.MDSALUtil;
24 import org.opendaylight.netvirt.sfc.classifier.providers.GeniusProvider;
25 import org.opendaylight.netvirt.sfc.classifier.providers.NetvirtProvider;
26 import org.opendaylight.netvirt.sfc.classifier.providers.OpenFlow13Provider;
27 import org.opendaylight.netvirt.sfc.classifier.providers.SfcProvider;
28 import org.opendaylight.netvirt.sfc.classifier.service.domain.ClassifierEntry;
29 import org.opendaylight.netvirt.sfc.classifier.service.domain.api.ClassifierRenderableEntry;
30 import org.opendaylight.netvirt.sfc.classifier.service.domain.api.ClassifierState;
31 import org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.sfc.rsp.rev140701.rendered.service.paths.RenderedServicePath;
32 import org.opendaylight.yang.gen.v1.urn.ericsson.params.xml.ns.yang.sfc.sff.logical.rev160620.DpnIdType;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.AccessLists;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.Acl;
35 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.AccessListEntries;
36 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.Ace;
37 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.access.control.list.rev160218.access.lists.acl.access.list.entries.ace.Matches;
38 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
39 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
40 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.interfaces.rev140508.interfaces.InterfaceKey;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.sfc.acl.rev150105.NetvirtsfcAclActions;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.sfc.acl.rev150105.NeutronNetwork;
44 import org.opendaylight.yang.gen.v1.urn.opendaylight.netvirt.sfc.acl.rev150105.RedirectToSfc;
45 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
46 import org.slf4j.Logger;
47 import org.slf4j.LoggerFactory;
48
49 public class ConfigurationClassifierImpl implements ClassifierState {
50
51     private final SfcProvider sfcProvider;
52     private final DataBroker dataBroker;
53     private final GeniusProvider geniusProvider;
54     private final NetvirtProvider netvirtProvider;
55     private static final Logger LOG = LoggerFactory.getLogger(ConfigurationClassifierImpl.class);
56
57     public ConfigurationClassifierImpl(GeniusProvider geniusProvider,
58                                        NetvirtProvider netvirtProvider,
59                                        SfcProvider sfcProvider,
60                                        DataBroker dataBroker) {
61         this.geniusProvider = geniusProvider;
62         this.netvirtProvider = netvirtProvider;
63         this.sfcProvider = sfcProvider;
64         this.dataBroker = dataBroker;
65     }
66
67     @Override
68     public Set<ClassifierRenderableEntry> getAllEntries() {
69         return readAcls().stream()
70                 .map(Acl::getAccessListEntries)
71                 .filter(Objects::nonNull)
72                 .map(AccessListEntries::getAce)
73                 .filter(Objects::nonNull)
74                 .flatMap(List::stream)
75                 .map(this::getEntries)
76                 .flatMap(Set::stream)
77                 .collect(Collectors.toSet());
78     }
79
80     public List<Acl> readAcls() {
81         InstanceIdentifier<AccessLists> aclsIID = InstanceIdentifier.builder(AccessLists.class).build();
82         com.google.common.base.Optional<AccessLists> acls =
83                 MDSALUtil.read(dataBroker, LogicalDatastoreType.CONFIGURATION, aclsIID);
84         LOG.trace("Acls read from datastore: {}", acls);
85         return acls.transform(AccessLists::getAcl).or(Collections.emptyList());
86     }
87
88     public Set<ClassifierRenderableEntry> getEntries(Ace ace) {
89
90         LOG.trace("Get entries for Ace {}", ace);
91
92         Matches matches = ace.getMatches();
93
94         if (matches == null) {
95             LOG.trace("Ace has no matches");
96             return Collections.emptySet();
97         }
98
99         RenderedServicePath rsp = Optional.ofNullable(ace.getActions())
100                 .map(actions -> actions.getAugmentation(RedirectToSfc.class))
101                 .map(NetvirtsfcAclActions::getRspName)
102                 .flatMap(sfcProvider::getRenderedServicePath)
103                 .orElse(null);
104
105         if (rsp == null) {
106             LOG.trace("Ace has no valid SFC redirect action");
107             return Collections.emptySet();
108         }
109
110         Long nsp = rsp.getPathId();
111         Short nsi = rsp.getStartingIndex();
112
113         if (nsp == null || nsi == null) {
114             LOG.trace("RSP has no valid NSI or NSP");
115             return Collections.emptySet();
116         }
117
118         String firstHopIp = sfcProvider.getFirstHopSfInterfaceFromRsp(rsp)
119                 .flatMap(geniusProvider::getIpFromInterfaceName)
120                 .orElse(null);
121
122         if (firstHopIp == null) {
123             LOG.trace("Could not acquire a valid first RSP hop destination ip");
124             return Collections.emptySet();
125         }
126
127         Map<NodeId, List<InterfaceKey>> nodeToInterfaces = new HashMap<>();
128         NeutronNetwork neutronNetwork = matches.getAugmentation(NeutronNetwork.class);
129         if (neutronNetwork != null) {
130             for (String iface : netvirtProvider.getLogicalInterfacesFromNeutronNetwork(neutronNetwork)) {
131                 geniusProvider.getNodeIdFromLogicalInterface(iface).ifPresent(
132                     nodeId -> nodeToInterfaces.computeIfAbsent(nodeId, key -> new ArrayList<>()).add(
133                             new InterfaceKey(iface)));
134             }
135         }
136
137         LOG.trace("Got classifier nodes and interfaces: {}", nodeToInterfaces);
138
139         Set<ClassifierRenderableEntry> entries = new HashSet<>();
140         nodeToInterfaces.forEach((nodeId, ifaces) -> {
141             // Get node info
142             DpnIdType dpnIdType = new DpnIdType(OpenFlow13Provider.getDpnIdFromNodeId(nodeId));
143             List<String> nodeIps = geniusProvider.getIpFromDpnId(dpnIdType).stream()
144                     .map(IpAddress::getIpv4Address)
145                     .filter(Objects::nonNull)
146                     .map(Ipv4Address::getValue)
147                     .collect(Collectors.toList());
148             String nodeIp = nodeIps.isEmpty() ? null : nodeIps.get(0);
149
150             if (nodeIp == null) {
151                 LOG.trace("Could not get IP address for node {}, skipping", nodeId.getValue());
152                 return;
153             }
154
155             // Add entries that are not based on ingress or egress interface
156             entries.add(ClassifierEntry.buildNodeEntry(nodeId));
157             entries.add(ClassifierEntry.buildPathEntry(
158                     nodeId,
159                     nsp,
160                     nodeIps.contains(firstHopIp) ? null : firstHopIp));
161
162             // Add entries based on ingress interface
163             ifaces.forEach(interfaceKey -> {
164                 entries.add(ClassifierEntry.buildIngressEntry(interfaceKey));
165                 entries.add(ClassifierEntry.buildMatchEntry(
166                         nodeId,
167                         geniusProvider.getNodeConnectorIdFromInterfaceName(interfaceKey.getName()).get(),
168                         matches,
169                         nsp,
170                         nsi));
171             });
172
173             // Egress services must bind to egress ports. Since we dont know before-hand what
174             // the egress ports will be, we will bind on all switch ports. If the packet
175             // doesnt have NSH, it will be returned to the the egress dispatcher table.
176             List<String> interfaceUuidStrList = geniusProvider.getInterfacesFromNode(nodeId);
177             interfaceUuidStrList.forEach(interfaceUuidStr -> {
178                 InterfaceKey interfaceKey = new InterfaceKey(interfaceUuidStr);
179                 Optional<String> remoteIp = geniusProvider.getRemoteIpAddress(interfaceUuidStr);
180                 entries.add(ClassifierEntry.buildEgressEntry(interfaceKey, remoteIp.orElse(nodeIp)));
181             });
182         });
183
184         return entries;
185     }
186 }