nexthopmgr/nexthopmgr-impl/src/main/java/org/opendaylight/vpnservice/nexthopmgr/NexthopManager.java

   1 /*
   2  * Copyright (c) 2015 Ericsson India Global Services Pvt Ltd. 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 package org.opendaylight.vpnservice.nexthopmgr;
   9
  10
  11 import java.math.BigInteger;
  12 import java.util.ArrayList;
  13 import java.util.List;
  14 import java.util.concurrent.Future;
  15
  16 import com.google.common.base.Optional;
  17 import com.google.common.util.concurrent.Futures;
  18 import com.google.common.util.concurrent.FutureCallback;
  19
  20 //import org.opendaylight.controller.netconf.confignetconfconnector.mapping.rpc.Rpcs;
  21 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  22 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  23 import org.opendaylight.yangtools.yang.binding.DataObject;
  24 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  25 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
  26 import org.opendaylight.yangtools.yang.common.RpcResult;
  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;
  51
  52 import java.util.concurrent.ExecutionException;
  53
  54 import org.slf4j.Logger;
  55 import org.slf4j.LoggerFactory;
  56
  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;
  63
  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");
  68             }
  69             public void onFailure(Throwable error) {
  70                 LOG.error("Error in Datastore write operation", error);
  71             };
  72         };
  73
  74     /**
  75     * Provides nexthop functions
  76     * Creates group ID pool
  77     *
  78     * @param db - dataBroker reference
  79     */
  80     public NexthopManager(final DataBroker db) {
  81         broker = db;
  82     }
  83
  84     @Override
  85     public void close() throws Exception {
  86         LOG.info("NextHop Manager Closed");
  87     }
  88
  89     public void setInterfaceManager(IInterfaceManager ifManager) {
  90         this.interfaceManager = ifManager;
  91     }
  92
  93     public void setMdsalManager(IMdsalApiManager mdsalManager) {
  94         this.mdsalManager = mdsalManager;
  95     }
  96
  97     public void setIdManager(IdManager idManager) {
  98         this.idManager = idManager;
  99     }
 100
 101     protected void createNexthopPointerPool() {
 102         CreateIdPoolInput createPool = new CreateIdPoolInputBuilder()
 103             .setPoolName("nextHopPointerPool")
 104             .setIdStart(1L)
 105             .setPoolSize(new BigInteger("65535"))
 106             .build();
 107         //TODO: Error handling
 108         Future<RpcResult<Void>> result = idManager.createIdPool(createPool);
 109 //            try {
 110 //                LOG.info("Result2: {}",result.get());
 111 //            } catch (InterruptedException | ExecutionException e) {
 112 //                // TODO Auto-generated catch block
 113 //                LOG.error("Error in result.get");
 114 //            }
 115
 116     }
 117
 118
 119     private long getVpnId(String vpnName) {
 120         InstanceIdentifierBuilder<VpnInstance> idBuilder = InstanceIdentifier.builder(VpnInstances.class)
 121                 .child(VpnInstance.class, new VpnInstanceKey(vpnName));
 122
 123         InstanceIdentifier<VpnInstance> id = idBuilder.build();
 124         InstanceIdentifier<VpnInstance1> idx = id.augmentation(VpnInstance1.class);
 125         Optional<VpnInstance1> vpn = read(LogicalDatastoreType.CONFIGURATION, idx);
 126
 127         if (vpn.isPresent()) {
 128             return vpn.get().getVpnId();
 129         } else {
 130             return 0;
 131         }
 132     }
 133
 134     private long getDpnId(String ifName) {
 135         String[] fields = ifName.split(":");
 136         long dpn = Integer.parseInt(fields[1]);
 137         return dpn;
 138     }
 139
 140     private int createNextHopPointer(String nexthopKey) {
 141         GetUniqueIdInput getIdInput = new GetUniqueIdInputBuilder()
 142             .setPoolName("nextHopPointerPool").setIdKey(nexthopKey)
 143             .build();
 144         //TODO: Proper error handling once IdManager code is complete
 145         try {
 146             Future<RpcResult<GetUniqueIdOutput>> result = idManager.getUniqueId(getIdInput);
 147             RpcResult<GetUniqueIdOutput> rpcResult = result.get();
 148             return rpcResult.getResult().getIdValue().intValue();
 149         } catch (NullPointerException | InterruptedException | ExecutionException e) {
 150             LOG.trace("",e);
 151         }
 152         return 0;
 153     }
 154
 155     public void createLocalNextHop(String ifName, String vpnName, String ipAddress, String macAddress) {
 156         String nhKey = new String("nexthop." + vpnName + ipAddress);
 157         int groupId = createNextHopPointer(nhKey);
 158
 159         long vpnId = getVpnId(vpnName);
 160         long dpnId = interfaceManager.getDpnForInterface(ifName);
 161         VpnNexthop nexthop = getVpnNexthop(vpnId, ipAddress);
 162         if (nexthop == null) {
 163             List<BucketInfo> listBucketInfo = new ArrayList<BucketInfo>();
 164             List<ActionInfo> listActionInfo = interfaceManager.getInterfaceEgressActions(ifName);
 165             BucketInfo bucket = new BucketInfo(listActionInfo);
 166             // MAC re-write
 167             if (macAddress != null) {
 168                 listActionInfo.add(new ActionInfo(ActionType.set_field_eth_dest, new String[]{macAddress}));
 169             } else {
 170                 //FIXME: Log message here.
 171             }
 172             listBucketInfo.add(bucket);
 173             GroupEntity groupEntity = MDSALUtil.buildGroupEntity(
 174                 dpnId, groupId, ipAddress, GroupTypes.GroupIndirect, listBucketInfo);
 175
 176             // install Group
 177             mdsalManager.installGroup(groupEntity);
 178
 179             //update MD-SAL DS
 180             addVpnNexthopToDS(vpnId, ipAddress, groupId);
 181         } else {
 182             //check update
 183         }
 184     }
 185
 186     public void createRemoteNextHop(String ifName, String ofPortId, String ipAddress) {
 187         String nhKey = new String("nexthop." + ifName + ipAddress);
 188         int groupId = createNextHopPointer(nhKey);
 189
 190         long dpnId = getDpnId(ofPortId);
 191         TunnelNexthop nexthop = getTunnelNexthop(dpnId, ipAddress);
 192         if (nexthop == null) {
 193
 194             List<BucketInfo> listBucketInfo = new ArrayList<BucketInfo>();
 195             List<ActionInfo> listActionInfo = interfaceManager.getInterfaceEgressActions(ifName);
 196             BucketInfo bucket = new BucketInfo(listActionInfo);
 197             // MAC re-write??
 198             listBucketInfo.add(bucket);
 199             GroupEntity groupEntity = MDSALUtil.buildGroupEntity(
 200                 dpnId, groupId, ipAddress, GroupTypes.GroupIndirect, listBucketInfo);
 201             mdsalManager.installGroup(groupEntity);
 202
 203             //update MD-SAL DS
 204             addTunnelNexthopToDS(dpnId, ipAddress, groupId);
 205         } else {
 206             //check update
 207         }
 208     }
 209
 210     private void addVpnNexthopToDS(long vpnId, String ipPrefix, long egressPointer) {
 211
 212         InstanceIdentifierBuilder<VpnNexthops> idBuilder = InstanceIdentifier.builder(L3nexthop.class)
 213                 .child(VpnNexthops.class, new VpnNexthopsKey(vpnId));
 214
 215         // check if vpn node is there or to be created
 216         InstanceIdentifier<VpnNexthops> id = idBuilder.build();
 217         Optional<VpnNexthops> nexthops = read(LogicalDatastoreType.CONFIGURATION, id);
 218         if (!nexthops.isPresent()) {
 219             // create a new node
 220             VpnNexthops node = new VpnNexthopsBuilder().setKey(new VpnNexthopsKey(vpnId)).setVpnId(vpnId).build();
 221             asyncWrite(LogicalDatastoreType.OPERATIONAL, id, node, DEFAULT_CALLBACK);
 222         }
 223
 224         // Add nexthop to vpn node
 225         VpnNexthop nh = new VpnNexthopBuilder().
 226                 setKey(new VpnNexthopKey(ipPrefix)).
 227                 setIpAddress(ipPrefix).
 228                 setEgressPointer(egressPointer).build();
 229
 230         InstanceIdentifier<VpnNexthop> id1 = idBuilder
 231                 .child(VpnNexthop.class, new VpnNexthopKey(ipPrefix)).build();
 232
 233         asyncWrite(LogicalDatastoreType.OPERATIONAL, id1, nh, DEFAULT_CALLBACK);
 234
 235     }
 236
 237     private void addTunnelNexthopToDS(long dpnId, String ipPrefix, long egressPointer) {
 238         InstanceIdentifierBuilder<TunnelNexthops> idBuilder = InstanceIdentifier.builder(L3nexthop.class)
 239                 .child(TunnelNexthops.class, new TunnelNexthopsKey(dpnId));
 240
 241         // check if dpn node is there or to be created
 242         InstanceIdentifier<TunnelNexthops> id = idBuilder.build();
 243         Optional<TunnelNexthops> nexthops = read(LogicalDatastoreType.CONFIGURATION, id);
 244         if (!nexthops.isPresent()) {
 245             // create a new node
 246             TunnelNexthops node = new TunnelNexthopsBuilder()
 247                 .setKey(new TunnelNexthopsKey(dpnId))
 248                 .setDpnId(dpnId)
 249                 .build();
 250             asyncWrite(LogicalDatastoreType.OPERATIONAL, id, node, DEFAULT_CALLBACK);
 251         }
 252
 253         // Add nexthop to dpn node
 254         TunnelNexthop nh = new TunnelNexthopBuilder().
 255                 setKey(new TunnelNexthopKey(ipPrefix)).
 256                 setIpAddress(ipPrefix).
 257                 setEgressPointer(egressPointer).build();
 258
 259         InstanceIdentifier<TunnelNexthop> id1 = idBuilder
 260                 .child(TunnelNexthop.class, new TunnelNexthopKey(ipPrefix)).build();
 261
 262         asyncWrite(LogicalDatastoreType.OPERATIONAL, id1, nh, DEFAULT_CALLBACK);
 263
 264     }
 265
 266     private VpnNexthop getVpnNexthop(long vpnId, String ipAddress) {
 267
 268         // check if vpn node is there
 269         InstanceIdentifierBuilder<VpnNexthops> idBuilder = InstanceIdentifier.builder(L3nexthop.class)
 270                 .child(VpnNexthops.class, new VpnNexthopsKey(vpnId));
 271         InstanceIdentifier<VpnNexthops> id = idBuilder.build();
 272         Optional<VpnNexthops> vpnNexthops = read(LogicalDatastoreType.CONFIGURATION, id);
 273         if (!vpnNexthops.isPresent()) {
 274
 275             // get nexthops list for vpn
 276             List<VpnNexthop> nexthops = vpnNexthops.get().getVpnNexthop();
 277             for (VpnNexthop nexthop : nexthops) {
 278                 if (nexthop.getIpAddress().equals(ipAddress)) {
 279                     // return nexthop
 280                     return nexthop;
 281                 }
 282             }
 283         }
 284         //return null if not found
 285         return null;
 286     }
 287
 288     private TunnelNexthop getTunnelNexthop(long dpnId, String ipAddress) {
 289
 290         InstanceIdentifierBuilder<TunnelNexthops> idBuilder = InstanceIdentifier.builder(L3nexthop.class)
 291                 .child(TunnelNexthops.class, new TunnelNexthopsKey(dpnId));
 292
 293         // check if vpn node is there
 294         InstanceIdentifier<TunnelNexthops> id = idBuilder.build();
 295         Optional<TunnelNexthops> dpnNexthops = read(LogicalDatastoreType.CONFIGURATION, id);
 296         if (!dpnNexthops.isPresent()) {
 297             List<TunnelNexthop> nexthops = dpnNexthops.get().getTunnelNexthop();
 298             for (TunnelNexthop nexthop : nexthops) {
 299                 if (nexthop.getIpAddress().equals(ipAddress)) {
 300                     return nexthop;
 301                 }
 302             }
 303         }
 304         return null;
 305     }
 306
 307     public long getNextHopPointer(long dpnId, long vpnId, String prefixIp, String nextHopIp) {
 308         String endpointIp = interfaceManager.getEndpointIpForDpn(dpnId);
 309         if (nextHopIp.equals(endpointIp)) {
 310             VpnNexthop vpnNextHop = getVpnNexthop(vpnId, prefixIp);
 311             return vpnNextHop.getEgressPointer();
 312         } else {
 313             TunnelNexthop tunnelNextHop = getTunnelNexthop(dpnId, nextHopIp);
 314             return tunnelNextHop.getEgressPointer();
 315         }
 316     }
 317
 318     private void removeTunnelNexthopFromDS(long dpnId, String ipPrefix) {
 319
 320         InstanceIdentifierBuilder<TunnelNexthop> idBuilder = InstanceIdentifier.builder(L3nexthop.class)
 321                 .child(TunnelNexthops.class, new TunnelNexthopsKey(dpnId))
 322                 .child(TunnelNexthop.class, new TunnelNexthopKey(ipPrefix));
 323         InstanceIdentifier<TunnelNexthop> id = idBuilder.build();
 324         // remove from DS
 325         delete(LogicalDatastoreType.OPERATIONAL, id);
 326     }
 327
 328     private void removeVpnNexthopFromDS(long vpnId, String ipPrefix) {
 329
 330         InstanceIdentifierBuilder<VpnNexthop> idBuilder = InstanceIdentifier.builder(L3nexthop.class)
 331                 .child(VpnNexthops.class, new VpnNexthopsKey(vpnId))
 332                 .child(VpnNexthop.class, new VpnNexthopKey(ipPrefix));
 333         InstanceIdentifier<VpnNexthop> id = idBuilder.build();
 334         // remove from DS
 335         delete(LogicalDatastoreType.OPERATIONAL, id);
 336     }
 337
 338
 339     public void removeLocalNextHop(String vpnName, String ipAddress) {
 340
 341         long vpnId = getVpnId(vpnName);
 342
 343         VpnNexthop nh = getVpnNexthop(vpnId, ipAddress);
 344         if (nh != null) {
 345             // how to inform and remove dependent FIB entries??
 346             // we need to do it before the group is removed
 347
 348             // remove Group ...
 349
 350             //update MD-SAL DS
 351             removeVpnNexthopFromDS(vpnId, ipAddress);
 352         } else {
 353             //throw error
 354         }
 355
 356     }
 357
 358     public void removeRemoteNextHop(long dpnId, String ipAddress) {
 359
 360         TunnelNexthop nh = getTunnelNexthop(dpnId, ipAddress);
 361         if (nh != null) {
 362             // how to inform and remove dependent FIB entries??
 363             // we need to do it before the group is removed
 364
 365             // remove Group ...
 366             //update MD-SAL DS
 367             removeTunnelNexthopFromDS(dpnId, ipAddress);
 368         } else {
 369             //throw error
 370         }
 371
 372     }
 373
 374     @Override
 375     public Future<RpcResult<GetEgressPointerOutput>> getEgressPointer(
 376             GetEgressPointerInput input) {
 377         long egressGroupId =
 378                 getNextHopPointer(input.getDpnId(), input.getVpnId(), input.getIpPrefix(), input.getNexthopIp());
 379
 380         GetEgressPointerOutputBuilder output = new GetEgressPointerOutputBuilder();
 381         output.setEgressPointer(egressGroupId);
 382
 383         RpcResult<GetEgressPointerOutput> result = null;
 384         //Rpcs.<GetEgressPointerOutput> getRpcResult(false, output.build());
 385         return Futures.immediateFuture(result);
 386     }
 387
 388     private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
 389             InstanceIdentifier<T> path) {
 390
 391         ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
 392
 393         Optional<T> result = Optional.absent();
 394         try {
 395             result = tx.read(datastoreType, path).get();
 396         } catch (Exception e) {
 397             throw new RuntimeException(e);
 398         }
 399
 400         return result;
 401     }
 402
 403     private <T extends DataObject> void asyncWrite(LogicalDatastoreType datastoreType,
 404             InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
 405         WriteTransaction tx = broker.newWriteOnlyTransaction();
 406         tx.put(datastoreType, path, data, true);
 407         Futures.addCallback(tx.submit(), callback);
 408     }
 409
 410
 411     private <T extends DataObject> void delete(LogicalDatastoreType datastoreType, InstanceIdentifier<T> path) {
 412         WriteTransaction tx = broker.newWriteOnlyTransaction();
 413         tx.delete(datastoreType, path);
 414         Futures.addCallback(tx.submit(), DEFAULT_CALLBACK);
 415     }
 416
 417 }