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
|
/*
* Copyright (c) 2016 Cisco and/or its affiliates.
*
* 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 io.fd.hc2vpp.routing.write;
import io.fd.hc2vpp.common.translate.util.FutureJVppCustomizer;
import io.fd.hc2vpp.common.translate.util.JvppReplyConsumer;
import io.fd.hc2vpp.common.translate.util.MultiNamingContext;
import io.fd.hc2vpp.common.translate.util.NamingContext;
import io.fd.hc2vpp.routing.naming.Ipv4RouteNamesFactory;
import io.fd.hc2vpp.routing.trait.RouteMapper;
import io.fd.hc2vpp.routing.write.factory.MultipathHopRequestFactory;
import io.fd.hc2vpp.routing.write.factory.SimpleHopRequestFactory;
import io.fd.hc2vpp.routing.write.factory.SpecialNextHopRequestFactory;
import io.fd.hc2vpp.v3po.vppclassifier.VppClassifierContextManager;
import io.fd.honeycomb.translate.MappingContext;
import io.fd.honeycomb.translate.spi.write.ListWriterCustomizer;
import io.fd.honeycomb.translate.write.WriteContext;
import io.fd.honeycomb.translate.write.WriteFailedException;
import io.fd.vpp.jvpp.core.dto.IpAddDelRoute;
import io.fd.vpp.jvpp.core.future.FutureJVppCore;
import java.util.List;
import java.util.stream.Collectors;
import javax.annotation.Nonnull;
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;
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;
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;
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.NextHopList;
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.SimpleNextHop;
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.SpecialNextHop;
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.next.hop.list.next.hop.list.NextHop;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.routing.rev140524.routing.routing.instance.routing.protocols.RoutingProtocol;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Customizer for handling write operations for {@link Ipv4} according to ietf-ipv4-unicast-routing.yang
*/
public class Ipv4RouteCustomizer extends FutureJVppCustomizer
implements ListWriterCustomizer<Route, RouteKey>, JvppReplyConsumer, RouteMapper {
private static final Logger LOG = LoggerFactory.getLogger(Ipv4RouteCustomizer.class);
private final NamingContext routesContext;
private final MultiNamingContext routesHopsContext;
/**
* Request factories
*/
private final SimpleHopRequestFactory simpleHopRequestFactory;
private final MultipathHopRequestFactory multipathHopRequestFactory;
private final SpecialNextHopRequestFactory specialNextHopRequestFactory;
/**
* Names factory
*/
private final Ipv4RouteNamesFactory routeNamesFactory;
public Ipv4RouteCustomizer(@Nonnull final FutureJVppCore futureJVppCore,
@Nonnull final NamingContext interfaceContext,
@Nonnull final NamingContext routesContext,
@Nonnull final NamingContext routingProtocolContext,
@Nonnull final MultiNamingContext routesHopsContext,
@Nonnull final VppClassifierContextManager classifierContextManager) {
super(futureJVppCore);
this.routesContext = routesContext;
this.routesHopsContext = routesHopsContext;
simpleHopRequestFactory =
SimpleHopRequestFactory.forContexts(classifierContextManager, interfaceContext, routingProtocolContext);
multipathHopRequestFactory = MultipathHopRequestFactory
.forContexts(classifierContextManager, interfaceContext, routingProtocolContext);
specialNextHopRequestFactory = SpecialNextHopRequestFactory.forContexts(classifierContextManager,
interfaceContext, routingProtocolContext);
routeNamesFactory = new Ipv4RouteNamesFactory(interfaceContext, routingProtocolContext);
}
@Override
public void writeCurrentAttributes(@Nonnull final InstanceIdentifier<Route> instanceIdentifier,
@Nonnull final Route route,
@Nonnull final WriteContext writeContext) throws WriteFailedException {
final String parentProtocolName = instanceIdentifier.firstKeyOf(RoutingProtocol.class).getName();
final String routeName = routeNamesFactory.uniqueRouteName(parentProtocolName, route);
writeRoute(instanceIdentifier, parentProtocolName, routeName, route, writeContext, true);
// maps new route by next available index,
routesContext.addName(routeName, writeContext.getMappingContext());
}
@Override
public void updateCurrentAttributes(@Nonnull final InstanceIdentifier<Route> instanceIdentifier,
@Nonnull final Route routeBefore,
@Nonnull final Route routeAfter, @Nonnull final WriteContext writeContext)
throws WriteFailedException {
throw new WriteFailedException.UpdateFailedException(instanceIdentifier, routeBefore, routeAfter,
new UnsupportedOperationException("Operation not supported"));
}
@Override
public void deleteCurrentAttributes(@Nonnull final InstanceIdentifier<Route> instanceIdentifier,
@Nonnull final Route route,
@Nonnull final WriteContext writeContext) throws WriteFailedException {
final String parentProtocolName = instanceIdentifier.firstKeyOf(RoutingProtocol.class).getName();
final String routeName = routeNamesFactory.uniqueRouteName(parentProtocolName, route);
writeRoute(instanceIdentifier, parentProtocolName, routeName, route, writeContext, false);
routesContext.removeName(routeName, writeContext.getMappingContext());
}
private void writeRoute(@Nonnull final InstanceIdentifier<Route> identifier,
@Nonnull final String parentProtocolName,
@Nonnull final String routeName,
@Nonnull final Route route,
@Nonnull final WriteContext writeContext,
final boolean isAdd) throws WriteFailedException {
if (route.getNextHopOptions() instanceof SimpleNextHop) {
writeRoute(
simpleHopRequestFactory.createIpv4SimpleHopRequest(isAdd, parentProtocolName, route,
writeContext.getMappingContext()),
identifier);
} else if (route.getNextHopOptions() instanceof NextHopList) {
final List<NextHop> createdHops =
writeMultihopRoute(identifier, parentProtocolName, route, writeContext, isAdd);
// after all hops has been added, add mappings to preserve hop ids, or remove them
if (isAdd) {
addMappingForEachHop(routeName, writeContext, createdHops);
} else {
removeMappingForEachHop(routeName, writeContext, createdHops);
}
} else if (route.getNextHopOptions() instanceof SpecialNextHop) {
writeSpecialHopRoute(identifier, route, parentProtocolName, writeContext, isAdd);
} else {
throw new IllegalArgumentException("Unsupported next-hop type");
}
}
private void removeMappingForEachHop(final @Nonnull String routeName, final @Nonnull WriteContext writeContext,
final List<NextHop> createdHops) {
createdHops.forEach(nextHop -> routesHopsContext.removeChild(routeName,
routeNamesFactory.uniqueRouteHopName(nextHop),
writeContext.getMappingContext()));
}
private void addMappingForEachHop(final @Nonnull String routeName, final @Nonnull WriteContext writeContext,
final List<NextHop> createdHops) {
createdHops.forEach(nextHop -> routesHopsContext.addChild(routeName,
nextHop.getId().intValue(),
routeNamesFactory.uniqueRouteHopName(nextHop),
writeContext.getMappingContext()));
}
private List<NextHop> writeMultihopRoute(@Nonnull final InstanceIdentifier<Route> identifier,
@Nonnull final String parentProtocolName,
@Nonnull final Route route,
@Nonnull final WriteContext writeContext,
final boolean isAdd)
throws WriteFailedException {
// list of next hops
final NextHopList hopList = NextHopList.class.cast(route.getNextHopOptions());
final MappingContext mappingContext = writeContext.getMappingContext();
LOG.debug("Writing hop list {} for route {}", hopList, identifier);
// order hops to preserve order by ids(even that model is not ordered)
final List<NextHop> orderedHops = hopList.getNextHopList().getNextHop()
.stream()
.sorted((left, right) -> (int) (left.getId() - right.getId()))
.collect(Collectors.toList());
for (NextHop hop : orderedHops) {
LOG.debug("Writing hop {} for route {}", hop, identifier);
final IpAddDelRoute request = multipathHopRequestFactory
.createIpv4MultipathHopRequest(isAdd, parentProtocolName, route, hop, mappingContext);
writeRoute(request, identifier);
}
return orderedHops;
}
private void writeSpecialHopRoute(final @Nonnull InstanceIdentifier<Route> identifier, final @Nonnull Route route,
final @Nonnull String parentProtocolName, final @Nonnull WriteContext writeContext,
final boolean isAdd)
throws WriteFailedException {
final SpecialNextHop hop = SpecialNextHop.class.cast(route.getNextHopOptions());
final MappingContext mappingContext = writeContext.getMappingContext();
final IpAddDelRoute request = specialNextHopRequestFactory
.createIpv4SpecialHopRequest(isAdd, parentProtocolName, route, mappingContext, hop.getSpecialNextHop());
writeRoute(request, identifier);
}
private void writeRoute(final IpAddDelRoute request, final InstanceIdentifier<Route> identifier)
throws WriteFailedException {
LOG.debug("Writing request {} for path {}", request, identifier);
getReplyForWrite(getFutureJVpp().ipAddDelRoute(request).toCompletableFuture(), identifier);
}
}
|
