Fix metadata for route, arp and overlay
[groupbasedpolicy.git] / renderers / vpp / src / main / java / org / opendaylight / groupbasedpolicy / renderer / vpp / lisp / flat / overlay / StaticRoutingHelper.java
1 /*
2  * Copyright (c) 2017 Cisco Systems. 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 package org.opendaylight.groupbasedpolicy.renderer.vpp.lisp.flat.overlay;
9
10 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
11 import org.opendaylight.groupbasedpolicy.renderer.vpp.lisp.mappers.HostVrfRoutingInformationMapper;
12 import org.opendaylight.groupbasedpolicy.renderer.vpp.lisp.mappers.InterfaceNameToStaticInfoMapper;
13 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.GbpNetconfTransaction;
14 import org.opendaylight.groupbasedpolicy.renderer.vpp.util.VppIidFactory;
15 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
16 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Prefix;
17 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.StaticRoutes1;
18 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.routing.routing.instance.routing.protocols.routing.protocol._static.routes.Ipv4;
19 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.routing.routing.instance.routing.protocols.routing.protocol._static.routes.Ipv4Builder;
20 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.routing.routing.instance.routing.protocols.routing.protocol._static.routes.ipv4.Route;
21 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.routing.routing.instance.routing.protocols.routing.protocol._static.routes.ipv4.RouteBuilder;
22 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.routing.routing.instance.routing.protocols.routing.protocol._static.routes.ipv4.RouteKey;
23 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.ipv4.unicast.routing.rev140524.routing.routing.instance.routing.protocols.routing.protocol._static.routes.ipv4.route.next.hop.options.SimpleNextHopBuilder;
24 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.rev140524.Static;
25 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.rev140524.routing.routing.instance.routing.protocols.RoutingProtocol;
26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.rev140524.routing.routing.instance.routing.protocols.RoutingProtocolBuilder;
27 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.rev140524.routing.routing.instance.routing.protocols.RoutingProtocolKey;
28 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.rev140524.routing.routing.instance.routing.protocols.routing.protocol.StaticRoutes;
29 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.vpp.routing.rev161214.RoutingProtocolVppAttr;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.vpp.routing.rev161214.RoutingProtocolVppAttrBuilder;
31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.vpp.routing.rev161214.VniReference;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.vpp.routing.rev161214.routing.routing.instance.routing.protocols.routing.protocol.VppProtocolAttributesBuilder;
33 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
34 import org.slf4j.Logger;
35 import org.slf4j.LoggerFactory;
36
37 import java.util.Arrays;
38 import java.util.List;
39
40 /**
41  * Created by Shakib Ahmed on 5/4/17.
42  */
43 public class StaticRoutingHelper {
44     private static final Logger LOG = LoggerFactory.getLogger(StaticRoutingHelper.class);
45
46     private static final String ROUTING_PROTOCOL_NAME_PREFIX = "static-routing-";
47     private static final String DEFAULT_DESCRIPTION = "Static route added from GBP for flat L3 overlay";
48
49     private HostVrfRoutingInformationMapper hostVrfInfo = HostVrfRoutingInformationMapper.getInstance();
50
51     private InterfaceNameToStaticInfoMapper interfaceNameToStaticInfoMapper;
52
53     public StaticRoutingHelper(InterfaceNameToStaticInfoMapper interfaceNameToStaticInfoMapper) {
54         this.interfaceNameToStaticInfoMapper = interfaceNameToStaticInfoMapper;
55     }
56
57     public synchronized boolean addRoutingProtocolForVrf(DataBroker vppDataBroker,
58                                          String hostId,
59                                          long vrf) {
60         String routingProtocolName = getRoutingProtocolName(vrf);
61         RoutingProtocolBuilder builder = new RoutingProtocolBuilder();
62         builder.setKey(new RoutingProtocolKey(routingProtocolName));
63         builder.setName(routingProtocolName);
64         builder.setType(Static.class);
65         builder.setDescription(DEFAULT_DESCRIPTION);
66         RoutingProtocolVppAttrBuilder vppAugmentationBuilder = new RoutingProtocolVppAttrBuilder();
67
68         vppAugmentationBuilder.
69                 setVppProtocolAttributes(new VppProtocolAttributesBuilder()
70                                                 .setPrimaryVrf(new VniReference(vrf)).build());
71
72         builder.addAugmentation(RoutingProtocolVppAttr.class, vppAugmentationBuilder.build());
73
74         InstanceIdentifier<RoutingProtocol> iid = VppIidFactory
75                 .getRoutingInstanceIid(builder.getKey());
76         if (GbpNetconfTransaction.netconfSyncedWrite(vppDataBroker,
77                 iid, builder.build(), GbpNetconfTransaction.RETRY_COUNT)) {
78             RoutingInfo info = new RoutingInfo();
79             info.setProtocolName(routingProtocolName);
80             hostVrfInfo.addRoutingVrfToHost(hostId, vrf, info);
81             return true;
82         }
83
84         return false;
85     }
86
87     public boolean endPointRoutingExists(String interfaceName, Ipv4Address ip) {
88         return interfaceNameToStaticInfoMapper.routeAlreadyExists(interfaceName, ip);
89     }
90
91     public boolean routeAlreadyExistsInHostVrf(String hostId, long vrf, Ipv4Address ip) {
92         return hostVrfInfo.ipAlreadyExistsInHostVrf(hostId, vrf, ip);
93     }
94
95     public synchronized boolean addSingleStaticRouteInRoutingProtocol(DataBroker vppDataBroker,
96                                                       String hostId,
97                                                       long vrf,
98                                                       Ipv4Address nextHopAddress,
99                                                       Ipv4Prefix ipPrefix,
100                                                       String outgoingInterface) {
101         RouteBuilder builder = new RouteBuilder();
102
103         Long routingId = hostVrfInfo.getEndPointCountInVrf(hostId, vrf);
104
105         builder.setId(routingId);
106         builder.setDestinationPrefix(ipPrefix);
107         builder.setKey(new RouteKey(builder.getId()));
108         builder.setNextHopOptions(new SimpleNextHopBuilder()
109                                         .setNextHop(nextHopAddress)
110                                         .setOutgoingInterface(outgoingInterface)
111                                         .build());
112
113         List<Route> routes = Arrays.asList(builder.build());
114
115         Ipv4 ipv4Route = new Ipv4Builder().setRoute(routes).build();
116
117         InstanceIdentifier<Ipv4> iid = VppIidFactory.
118                 getRoutingInstanceIid(new RoutingProtocolKey(hostVrfInfo.getProtocolName(hostId, vrf)))
119                 .child(StaticRoutes.class)
120                 .augmentation(StaticRoutes1.class)
121                 .child(Ipv4.class);
122
123         if (GbpNetconfTransaction.netconfSyncedMerge(vppDataBroker, iid, ipv4Route, GbpNetconfTransaction.RETRY_COUNT)) {
124             interfaceNameToStaticInfoMapper.addRouteForInterface(outgoingInterface, nextHopAddress, routingId);
125             hostVrfInfo.addStaticRoute(hostId, vrf, nextHopAddress);
126             return true;
127         }
128
129         return false;
130     }
131
132     public synchronized boolean deleteSingleStaticRouteFromRoutingProtocol(DataBroker vppDataBroker,
133                                                                         String hostId,
134                                                                         long vrf,
135                                                                         String outgoingInterface) {
136         List<Long> allRoutingIdsForPort = interfaceNameToStaticInfoMapper.getRoutingIdsAssociatedWithInterface(outgoingInterface);
137
138         boolean allOk = true;
139
140         for (Long routingId : allRoutingIdsForPort) {
141             InstanceIdentifier<Route> iid = VppIidFactory.
142                     getRoutingInstanceIid(new RoutingProtocolKey(hostVrfInfo.getProtocolName(hostId, vrf)))
143                     .child(StaticRoutes.class)
144                     .augmentation(StaticRoutes1.class)
145                     .child(Ipv4.class)
146                     .child(Route.class, new RouteKey(routingId));
147             if (!GbpNetconfTransaction.netconfSyncedDelete(vppDataBroker, iid, GbpNetconfTransaction.RETRY_COUNT)) {
148                 LOG.warn("Route delete failed for interface {} from {}", outgoingInterface, hostId);
149                 allOk = false;
150             }
151         }
152
153         interfaceNameToStaticInfoMapper.clearStaticRoutesForInterface(outgoingInterface);
154         return allOk;
155     }
156
157     public static String getRoutingProtocolName(long vrf) {
158         return ROUTING_PROTOCOL_NAME_PREFIX + vrf;
159     }
160 }