2 * Copyright (c) 2015 Ericsson India Global Services Pvt Ltd. and others. All rights reserved.
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
8 package org.opendaylight.vpnservice.nexthopmgr;
11 import java.math.BigInteger;
12 import java.util.ArrayList;
13 import java.util.List;
14 import java.util.concurrent.Future;
16 import com.google.common.base.Optional;
17 import com.google.common.util.concurrent.Futures;
18 import com.google.common.util.concurrent.FutureCallback;
20 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
21 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
22 import org.opendaylight.yangtools.yang.binding.DataObject;
23 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
24 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
25 import org.opendaylight.yangtools.yang.common.RpcResult;
26 import org.opendaylight.yangtools.yang.common.RpcResultBuilder;
27 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
28 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
29 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
30 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
31 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstanceKey;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.group.types.rev131018.GroupTypes;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.VpnInstance1;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.CreateIdPoolInput;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.CreateIdPoolInputBuilder;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.GetUniqueIdOutput;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.GetUniqueIdInputBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.idmanager.rev150403.GetUniqueIdInput;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.l3nexthop.rev150409.*;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.l3nexthop.rev150409.l3nexthop.*;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.l3nexthop.rev150409.l3nexthop.tunnelnexthops.*;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.l3nexthop.rev150409.l3nexthop.vpnnexthops.*;
43 import org.opendaylight.vpnservice.interfacemgr.interfaces.IInterfaceManager;
44 import org.opendaylight.vpnservice.mdsalutil.ActionInfo;
45 import org.opendaylight.vpnservice.mdsalutil.ActionType;
46 import org.opendaylight.vpnservice.mdsalutil.BucketInfo;
47 import org.opendaylight.vpnservice.mdsalutil.GroupEntity;
48 import org.opendaylight.vpnservice.mdsalutil.MDSALUtil;
49 import org.opendaylight.vpnservice.mdsalutil.interfaces.IMdsalApiManager;
50 import org.opendaylight.idmanager.IdManager;
52 import java.util.concurrent.ExecutionException;
54 import org.slf4j.Logger;
55 import org.slf4j.LoggerFactory;
57 public class NexthopManager implements L3nexthopService, AutoCloseable {
58 private static final Logger LOG = LoggerFactory.getLogger(NexthopManager.class);
59 private final DataBroker broker;
60 private IMdsalApiManager mdsalManager;
61 private IInterfaceManager interfaceManager;
62 private IdManager idManager;
64 private static final FutureCallback<Void> DEFAULT_CALLBACK =
65 new FutureCallback<Void>() {
66 public void onSuccess(Void result) {
67 LOG.info("Success in Datastore write operation");
69 public void onFailure(Throwable error) {
70 LOG.error("Error in Datastore write operation", error);
75 * Provides nexthop functions
76 * Creates group ID pool
78 * @param db - dataBroker reference
80 public NexthopManager(final DataBroker db) {
82 createNexthopPointerPool();
86 public void close() throws Exception {
87 LOG.info("NextHop Manager Closed");
90 public void setInterfaceManager(IInterfaceManager ifManager) {
91 this.interfaceManager = ifManager;
94 public void setMdsalManager(IMdsalApiManager mdsalManager) {
95 this.mdsalManager = mdsalManager;
98 public void setIdManager(IdManager idManager) {
99 this.idManager = idManager;
102 private void createNexthopPointerPool() {
103 CreateIdPoolInput createPool = new CreateIdPoolInputBuilder()
104 .setPoolName("nextHopPointerPool")
106 .setPoolSize(new BigInteger("65535"))
108 //TODO: Error handling
109 Future<RpcResult<Void>> result = idManager.createIdPool(createPool);
111 // LOG.info("Result2: {}",result.get());
112 // } catch (InterruptedException | ExecutionException e) {
113 // // TODO Auto-generated catch block
114 // LOG.error("Error in result.get");
120 private long getVpnId(String vpnName) {
121 InstanceIdentifierBuilder<VpnInstance> idBuilder = InstanceIdentifier.builder(VpnInstances.class)
122 .child(VpnInstance.class, new VpnInstanceKey(vpnName));
124 InstanceIdentifier<VpnInstance> id = idBuilder.build();
125 InstanceIdentifier<VpnInstance1> idx = id.augmentation(VpnInstance1.class);
126 Optional<VpnInstance1> vpn = read(LogicalDatastoreType.CONFIGURATION, idx);
128 if (vpn.isPresent()) {
129 return vpn.get().getVpnId();
135 private long getDpnId(String ifName) {
136 String[] fields = ifName.split(":");
137 long dpn = Integer.parseInt(fields[1]);
141 private int createNextHopPointer(String nexthopKey) {
142 GetUniqueIdInput getIdInput = new GetUniqueIdInputBuilder()
143 .setPoolName("nextHopPointerPool").setIdKey(nexthopKey)
145 //TODO: Proper error handling once IdManager code is complete
147 Future<RpcResult<GetUniqueIdOutput>> result = idManager.getUniqueId(getIdInput);
148 RpcResult<GetUniqueIdOutput> rpcResult = result.get();
149 return rpcResult.getResult().getIdValue().intValue();
150 } catch (NullPointerException | InterruptedException | ExecutionException e) {
156 public void createLocalNextHop(String ifName, String vpnName, String ipAddress, String macAddress) {
157 String nhKey = new String("nexthop." + vpnName + ipAddress);
158 int groupId = createNextHopPointer(nhKey);
160 long vpnId = getVpnId(vpnName);
161 long dpnId = interfaceManager.getDpnForInterface(ifName);
162 VpnNexthop nexthop = getVpnNexthop(vpnId, ipAddress);
163 if (nexthop == null) {
164 List<BucketInfo> listBucketInfo = new ArrayList<BucketInfo>();
165 List<ActionInfo> listActionInfo = interfaceManager.getInterfaceEgressActions(ifName);
166 BucketInfo bucket = new BucketInfo(listActionInfo);
168 if (macAddress != null) {
169 listActionInfo.add(new ActionInfo(ActionType.set_field_eth_dest, new String[]{macAddress}));
171 //FIXME: Log message here.
173 listBucketInfo.add(bucket);
174 GroupEntity groupEntity = MDSALUtil.buildGroupEntity(
175 dpnId, groupId, ipAddress, GroupTypes.GroupIndirect, listBucketInfo);
178 mdsalManager.installGroup(groupEntity);
181 addVpnNexthopToDS(vpnId, ipAddress, groupId);
187 public void createRemoteNextHop(String ifName, String ofPortId, String ipAddress) {
188 String nhKey = new String("nexthop." + ifName + ipAddress);
189 int groupId = createNextHopPointer(nhKey);
191 long dpnId = getDpnId(ofPortId);
192 TunnelNexthop nexthop = getTunnelNexthop(dpnId, ipAddress);
193 if (nexthop == null) {
195 List<BucketInfo> listBucketInfo = new ArrayList<BucketInfo>();
196 List<ActionInfo> listActionInfo = interfaceManager.getInterfaceEgressActions(ifName);
197 BucketInfo bucket = new BucketInfo(listActionInfo);
199 listBucketInfo.add(bucket);
200 GroupEntity groupEntity = MDSALUtil.buildGroupEntity(
201 dpnId, groupId, ipAddress, GroupTypes.GroupIndirect, listBucketInfo);
202 mdsalManager.installGroup(groupEntity);
205 addTunnelNexthopToDS(dpnId, ipAddress, groupId);
211 private void addVpnNexthopToDS(long vpnId, String ipPrefix, long egressPointer) {
213 InstanceIdentifierBuilder<VpnNexthops> idBuilder = InstanceIdentifier.builder(L3nexthop.class)
214 .child(VpnNexthops.class, new VpnNexthopsKey(vpnId));
216 // check if vpn node is there or to be created
217 InstanceIdentifier<VpnNexthops> id = idBuilder.build();
218 Optional<VpnNexthops> nexthops = read(LogicalDatastoreType.CONFIGURATION, id);
219 if (!nexthops.isPresent()) {
221 VpnNexthops node = new VpnNexthopsBuilder().setKey(new VpnNexthopsKey(vpnId)).setVpnId(vpnId).build();
222 asyncWrite(LogicalDatastoreType.OPERATIONAL, id, node, DEFAULT_CALLBACK);
225 // Add nexthop to vpn node
226 VpnNexthop nh = new VpnNexthopBuilder().
227 setKey(new VpnNexthopKey(ipPrefix)).
228 setIpAddress(ipPrefix).
229 setEgressPointer(egressPointer).build();
231 InstanceIdentifier<VpnNexthop> id1 = idBuilder
232 .child(VpnNexthop.class, new VpnNexthopKey(ipPrefix)).build();
234 asyncWrite(LogicalDatastoreType.OPERATIONAL, id1, nh, DEFAULT_CALLBACK);
238 private void addTunnelNexthopToDS(long dpnId, String ipPrefix, long egressPointer) {
239 InstanceIdentifierBuilder<TunnelNexthops> idBuilder = InstanceIdentifier.builder(L3nexthop.class)
240 .child(TunnelNexthops.class, new TunnelNexthopsKey(dpnId));
242 // check if dpn node is there or to be created
243 InstanceIdentifier<TunnelNexthops> id = idBuilder.build();
244 Optional<TunnelNexthops> nexthops = read(LogicalDatastoreType.CONFIGURATION, id);
245 if (!nexthops.isPresent()) {
247 TunnelNexthops node = new TunnelNexthopsBuilder()
248 .setKey(new TunnelNexthopsKey(dpnId))
251 asyncWrite(LogicalDatastoreType.OPERATIONAL, id, node, DEFAULT_CALLBACK);
254 // Add nexthop to dpn node
255 TunnelNexthop nh = new TunnelNexthopBuilder().
256 setKey(new TunnelNexthopKey(ipPrefix)).
257 setIpAddress(ipPrefix).
258 setEgressPointer(egressPointer).build();
260 InstanceIdentifier<TunnelNexthop> id1 = idBuilder
261 .child(TunnelNexthop.class, new TunnelNexthopKey(ipPrefix)).build();
263 asyncWrite(LogicalDatastoreType.OPERATIONAL, id1, nh, DEFAULT_CALLBACK);
267 private VpnNexthop getVpnNexthop(long vpnId, String ipAddress) {
269 // check if vpn node is there
270 InstanceIdentifierBuilder<VpnNexthops> idBuilder = InstanceIdentifier.builder(L3nexthop.class)
271 .child(VpnNexthops.class, new VpnNexthopsKey(vpnId));
272 InstanceIdentifier<VpnNexthops> id = idBuilder.build();
273 Optional<VpnNexthops> vpnNexthops = read(LogicalDatastoreType.CONFIGURATION, id);
274 if (!vpnNexthops.isPresent()) {
276 // get nexthops list for vpn
277 List<VpnNexthop> nexthops = vpnNexthops.get().getVpnNexthop();
278 for (VpnNexthop nexthop : nexthops) {
279 if (nexthop.getIpAddress().equals(ipAddress)) {
285 //return null if not found
289 private TunnelNexthop getTunnelNexthop(long dpnId, String ipAddress) {
291 InstanceIdentifierBuilder<TunnelNexthops> idBuilder = InstanceIdentifier.builder(L3nexthop.class)
292 .child(TunnelNexthops.class, new TunnelNexthopsKey(dpnId));
294 // check if vpn node is there
295 InstanceIdentifier<TunnelNexthops> id = idBuilder.build();
296 Optional<TunnelNexthops> dpnNexthops = read(LogicalDatastoreType.CONFIGURATION, id);
297 if (!dpnNexthops.isPresent()) {
298 List<TunnelNexthop> nexthops = dpnNexthops.get().getTunnelNexthop();
299 for (TunnelNexthop nexthop : nexthops) {
300 if (nexthop.getIpAddress().equals(ipAddress)) {
308 public long getNextHopPointer(long dpnId, long vpnId, String prefixIp, String nextHopIp) {
309 String endpointIp = interfaceManager.getEndpointIpForDpn(dpnId);
310 if (nextHopIp.equals(endpointIp)) {
311 VpnNexthop vpnNextHop = getVpnNexthop(vpnId, prefixIp);
312 return vpnNextHop.getEgressPointer();
314 TunnelNexthop tunnelNextHop = getTunnelNexthop(dpnId, nextHopIp);
315 return tunnelNextHop.getEgressPointer();
319 private void removeTunnelNexthopFromDS(long dpnId, String ipPrefix) {
321 InstanceIdentifierBuilder<TunnelNexthop> idBuilder = InstanceIdentifier.builder(L3nexthop.class)
322 .child(TunnelNexthops.class, new TunnelNexthopsKey(dpnId))
323 .child(TunnelNexthop.class, new TunnelNexthopKey(ipPrefix));
324 InstanceIdentifier<TunnelNexthop> id = idBuilder.build();
326 delete(LogicalDatastoreType.OPERATIONAL, id);
329 private void removeVpnNexthopFromDS(long vpnId, String ipPrefix) {
331 InstanceIdentifierBuilder<VpnNexthop> idBuilder = InstanceIdentifier.builder(L3nexthop.class)
332 .child(VpnNexthops.class, new VpnNexthopsKey(vpnId))
333 .child(VpnNexthop.class, new VpnNexthopKey(ipPrefix));
334 InstanceIdentifier<VpnNexthop> id = idBuilder.build();
336 delete(LogicalDatastoreType.OPERATIONAL, id);
340 public void removeLocalNextHop(String vpnName, String ipAddress) {
342 long vpnId = getVpnId(vpnName);
344 VpnNexthop nh = getVpnNexthop(vpnId, ipAddress);
346 // how to inform and remove dependent FIB entries??
347 // we need to do it before the group is removed
352 removeVpnNexthopFromDS(vpnId, ipAddress);
359 public void removeRemoteNextHop(long dpnId, String ipAddress) {
361 TunnelNexthop nh = getTunnelNexthop(dpnId, ipAddress);
363 // how to inform and remove dependent FIB entries??
364 // we need to do it before the group is removed
368 removeTunnelNexthopFromDS(dpnId, ipAddress);
376 public Future<RpcResult<GetEgressPointerOutput>> getEgressPointer(
377 GetEgressPointerInput input) {
379 getNextHopPointer(input.getDpnId(), input.getVpnId(), input.getIpPrefix(), input.getNexthopIp());
381 GetEgressPointerOutputBuilder output = new GetEgressPointerOutputBuilder();
382 output.setEgressPointer(egressGroupId);
384 RpcResultBuilder<GetEgressPointerOutput> rpcResultBuilder = RpcResultBuilder.success();
385 rpcResultBuilder.withResult(output.build());
387 return Futures.immediateFuture(rpcResultBuilder.build());
391 private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
392 InstanceIdentifier<T> path) {
394 ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
396 Optional<T> result = Optional.absent();
398 result = tx.read(datastoreType, path).get();
399 } catch (Exception e) {
400 throw new RuntimeException(e);
406 private <T extends DataObject> void asyncWrite(LogicalDatastoreType datastoreType,
407 InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
408 WriteTransaction tx = broker.newWriteOnlyTransaction();
409 tx.put(datastoreType, path, data, true);
410 Futures.addCallback(tx.submit(), callback);
414 private <T extends DataObject> void delete(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
415 WriteTransaction tx = broker.newWriteOnlyTransaction();
416 tx.delete(datastoreType, path);
417 Futures.addCallback(tx.submit(), DEFAULT_CALLBACK);