fibmanager/fibmanager-impl/src/main/java/org/opendaylight/vpnservice/fibmanager/FibManager.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.fibmanager;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.util.concurrent.Futures;
  12 import org.opendaylight.controller.md.sal.binding.api.WriteTransaction;
  13 import com.google.common.util.concurrent.FutureCallback;
  14
  15 import org.opendaylight.vpnmanager.api.IVpnManager;
  16 import org.opendaylight.vpnservice.AbstractDataChangeListener;
  17 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  18 import org.opendaylight.controller.md.sal.binding.api.DataChangeListener;
  19 import org.opendaylight.vpnservice.mdsalutil.ActionInfo;
  20 import org.opendaylight.vpnservice.mdsalutil.ActionType;
  21 import org.opendaylight.vpnservice.mdsalutil.FlowEntity;
  22 import org.opendaylight.vpnservice.mdsalutil.InstructionInfo;
  23 import org.opendaylight.vpnservice.mdsalutil.InstructionType;
  24 import org.opendaylight.vpnservice.mdsalutil.MDSALUtil;
  25 import org.opendaylight.vpnservice.mdsalutil.MatchFieldType;
  26 import org.opendaylight.vpnservice.mdsalutil.MatchInfo;
  27 import org.opendaylight.vpnservice.mdsalutil.MetaDataUtil;
  28 import org.opendaylight.vpnservice.mdsalutil.NwConstants;
  29 import org.opendaylight.vpnservice.mdsalutil.interfaces.IMdsalApiManager;
  30 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.VpnInstances;
  31 import org.opendaylight.yang.gen.v1.urn.huawei.params.xml.ns.yang.l3vpn.rev140815.vpn.instances.VpnInstance;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.l3vpn.rev130911.VpnInstance1;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.fibmanager.rev150330.fibentries.VrfTables;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.fibmanager.rev150330.fibentries.VrfTablesKey;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.fibmanager.rev150330.vrfentries.VrfEntry;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.l3nexthop.rev150409.GetEgressPointerInputBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.l3nexthop.rev150409.GetEgressPointerOutput;
  38 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.l3nexthop.rev150409.L3nexthopService;
  39 import org.opendaylight.yangtools.concepts.ListenerRegistration;
  40 import org.opendaylight.yangtools.yang.binding.DataObject;
  41 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  42 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder;
  43 import org.opendaylight.controller.md.sal.binding.api.ReadOnlyTransaction;
  44 import org.opendaylight.controller.md.sal.common.api.data.LogicalDatastoreType;
  45 import org.opendaylight.controller.md.sal.common.api.data.AsyncDataBroker.DataChangeScope;
  46 import org.opendaylight.yang.gen.v1.urn.opendaylight.vpnservice.fibmanager.rev150330.FibEntries;
  47 import org.opendaylight.yangtools.yang.binding.RpcService;
  48 import org.opendaylight.yangtools.yang.common.RpcResult;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51 import com.google.common.base.Optional;
  52
  53 import java.math.BigInteger;
  54 import java.net.InetAddress;
  55 import java.net.UnknownHostException;
  56 import java.util.ArrayList;
  57 import java.util.Collection;
  58 import java.util.List;
  59 import java.util.Set;
  60 import java.util.concurrent.ExecutionException;
  61 import java.util.concurrent.Future;
  62
  63 public class FibManager extends AbstractDataChangeListener<VrfEntry> implements AutoCloseable{
  64   private static final Logger LOG = LoggerFactory.getLogger(FibManager.class);
  65   private static final String FLOWID_PREFIX = "L3.";
  66   private ListenerRegistration<DataChangeListener> listenerRegistration;
  67   private final DataBroker broker;
  68   private final L3nexthopService l3nexthopService;
  69   private IMdsalApiManager mdsalManager;
  70   private IVpnManager vpnmanager;
  71
  72   private static final short L3_FIB_TABLE = 20;
  73   private static final short L3_LFIB_TABLE = 21;
  74   private static final BigInteger COOKIE_VM_LFIB_TABLE = new BigInteger("8000002", 16);
  75   private static final BigInteger COOKIE_VM_FIB_TABLE =  new BigInteger("8000003", 16);
  76   private static final int DEFAULT_FIB_FLOW_PRIORITY = 10;
  77
  78
  79   private static final FutureCallback<Void> DEFAULT_CALLBACK =
  80       new FutureCallback<Void>() {
  81         public void onSuccess(Void result) {
  82           LOG.debug("Success in Datastore write operation");
  83         }
  84
  85         public void onFailure(Throwable error) {
  86           LOG.error("Error in Datastore write operation", error);
  87         };
  88       };
  89
  90   public FibManager(final DataBroker db, final RpcService nextHopService) {
  91     super(VrfEntry.class);
  92     broker = db;
  93     l3nexthopService = (L3nexthopService)nextHopService;
  94     registerListener(db);
  95   }
  96
  97   @Override
  98   public void close() throws Exception {
  99     if (listenerRegistration != null) {
 100       try {
 101         listenerRegistration.close();
 102       } catch (final Exception e) {
 103         LOG.error("Error when cleaning up DataChangeListener.", e);
 104       }
 105       listenerRegistration = null;
 106     }
 107     LOG.info("Fib Manager Closed");
 108   }
 109
 110
 111   public void setMdsalManager(IMdsalApiManager mdsalManager) {
 112     this.mdsalManager = mdsalManager;
 113   }
 114
 115   public void setVpnmanager(IVpnManager vpnmanager) {
 116     this.vpnmanager = vpnmanager;
 117   }
 118
 119   private void registerListener(final DataBroker db) {
 120     try {
 121       listenerRegistration = db.registerDataChangeListener(LogicalDatastoreType.CONFIGURATION,
 122                                                            getWildCardPath(), FibManager.this, DataChangeScope.SUBTREE);
 123     } catch (final Exception e) {
 124       LOG.error("FibManager DataChange listener registration fail!", e);
 125       throw new IllegalStateException("FibManager registration Listener failed.", e);
 126     }
 127   }
 128
 129   private <T extends DataObject> Optional<T> read(LogicalDatastoreType datastoreType,
 130                                                   InstanceIdentifier<T> path) {
 131
 132     ReadOnlyTransaction tx = broker.newReadOnlyTransaction();
 133
 134     Optional<T> result = Optional.absent();
 135     try {
 136       result = tx.read(datastoreType, path).get();
 137     } catch (Exception e) {
 138       throw new RuntimeException(e);
 139     }
 140
 141     return result;
 142   }
 143
 144   private InstanceIdentifier<VrfEntry> getWildCardPath() {
 145     return InstanceIdentifier.create(FibEntries.class).child(VrfTables.class).child(VrfEntry.class);
 146   }
 147
 148   private <T extends DataObject> void asyncWrite(LogicalDatastoreType datastoreType,
 149                                                  InstanceIdentifier<T> path, T data, FutureCallback<Void> callback) {
 150     WriteTransaction tx = broker.newWriteOnlyTransaction();
 151     tx.put(datastoreType, path, data, true);
 152     Futures.addCallback(tx.submit(), callback);
 153   }
 154
 155   @Override
 156   protected void add(final InstanceIdentifier<VrfEntry> identifier,
 157                      final VrfEntry vrfEntry) {
 158     LOG.trace("key: " + identifier + ", value=" + vrfEntry );
 159     createFibEntries(identifier, vrfEntry);
 160   }
 161
 162   @Override
 163   protected void remove(InstanceIdentifier<VrfEntry> identifier, VrfEntry vrfEntry) {
 164     LOG.trace("key: " + identifier + ", value=" + vrfEntry);
 165     deleteFibEntries(identifier, vrfEntry);
 166   }
 167
 168   @Override
 169   protected void update(InstanceIdentifier<VrfEntry> identifier, VrfEntry original, VrfEntry update) {
 170     LOG.trace("key: " + identifier + ", original=" + original + ", update=" + update );
 171   }
 172
 173   private void createFibEntries(final InstanceIdentifier<VrfEntry> identifier,
 174                                 final VrfEntry vrfEntry) {
 175     final VrfTablesKey vrfTableKey = identifier.firstKeyOf(VrfTables.class, VrfTablesKey.class);
 176     Preconditions.checkNotNull(vrfTableKey, "VrfTablesKey cannot be null or empty!");
 177     Preconditions.checkNotNull(vrfEntry, "VrfEntry cannot be null or empty!");
 178
 179     Long vpnId = getVpnId(vrfTableKey.getRouteDistinguisher());
 180     Preconditions.checkNotNull(vpnId, "Vpn Instance not available!");
 181     Collection<Long> dpns = vpnmanager.getDpnsForVpn(vpnId);
 182     for (Long dpId : dpns) {
 183       addRouteInternal(dpId, vpnId, vrfTableKey, vrfEntry);
 184     }
 185   }
 186
 187   private void addRouteInternal(final long dpId, final long vpnId, final VrfTablesKey vrfTableKey,
 188                                 final VrfEntry vrfEntry) {
 189     String rd = vrfTableKey.getRouteDistinguisher();
 190     LOG.debug("adding route " + vrfEntry.getDestPrefix() + " " + rd);
 191
 192     GetEgressPointerOutput adjacency = resolveAdjacency(dpId, vpnId, vrfEntry);
 193     long groupId = -1;
 194     boolean isLocalRoute = false;
 195     if(adjacency != null) {
 196       groupId = adjacency.getEgressPointer();
 197       isLocalRoute = adjacency.isLocalDestination();
 198     }
 199     if(groupId == -1) {
 200       LOG.error("Could not get nexthop group id for nexthop: {} in vpn {}",
 201                                    vrfEntry.getNextHopAddress(), rd);
 202       LOG.warn("Failed to add Route: {} in vpn: {}",
 203                              vrfEntry.getDestPrefix(), rd);
 204       return;
 205     }
 206
 207     makeConnectedRoute(dpId, vpnId, vrfEntry, rd, groupId, NwConstants.ADD_FLOW);
 208
 209     if (isLocalRoute) {
 210       makeLFibTableEntry(dpId, vrfEntry.getLabel(), groupId, vrfEntry.getNextHopAddress(), NwConstants.ADD_FLOW);
 211     }
 212
 213     LOG.debug(
 214         "Successfully added fib entry for " + vrfEntry.getDestPrefix() + " vpnId " + vpnId);
 215   }
 216
 217   private void deleteFibEntries(final InstanceIdentifier<VrfEntry> identifier,
 218                                 final VrfEntry vrfEntry) {
 219     final VrfTablesKey vrfTableKey = identifier.firstKeyOf(VrfTables.class, VrfTablesKey.class);
 220     Preconditions.checkNotNull(vrfTableKey, "VrfTablesKey cannot be null or empty!");
 221     Preconditions.checkNotNull(vrfEntry, "VrfEntry cannot be null or empty!");
 222
 223     Long vpnId = getVpnId(vrfTableKey.getRouteDistinguisher());
 224     Preconditions.checkNotNull(vpnId, "Vpn Instance not available!");
 225     Collection<Long> dpns = vpnmanager.getDpnsForVpn(vpnId);
 226     for (Long dpId : dpns) {
 227       deleteRoute(dpId, vpnId, vrfTableKey, vrfEntry);
 228     }
 229   }
 230
 231   public void deleteRoute(final long dpId, final long vpnId, final VrfTablesKey vrfTableKey,
 232                           final VrfEntry vrfEntry) {
 233     LOG.debug("deleting route "+ vrfEntry.getDestPrefix() + " "+vpnId);
 234     String rd = vrfTableKey.getRouteDistinguisher();
 235     GetEgressPointerOutput adjacency = resolveAdjacency(dpId, vpnId, vrfEntry);
 236     long groupId = -1;
 237     boolean isLocalRoute = false;
 238     if(adjacency != null) {
 239       groupId = adjacency.getEgressPointer();
 240       isLocalRoute = adjacency.isLocalDestination();
 241     }
 242     if(groupId == -1) {
 243       LOG.error("Could not get nexthop group id for nexthop: {} in vpn {}",
 244                               vrfEntry.getNextHopAddress(), rd);
 245       LOG.warn("Failed to add Route: {} in vpn: {}",
 246                              vrfEntry.getDestPrefix(), rd);
 247       return;
 248     }
 249
 250     makeConnectedRoute(dpId, vpnId, vrfEntry, rd, groupId, NwConstants.DEL_FLOW);
 251
 252     if (isLocalRoute) {
 253       makeLFibTableEntry(dpId, vrfEntry.getLabel(), groupId, vrfEntry.getNextHopAddress(), NwConstants.DEL_FLOW);
 254     }
 255
 256     LOG.debug("Successfully delete fib entry for "+ vrfEntry.getDestPrefix() + " vpnId "+vpnId);
 257   }
 258
 259   private long getIpAddress(byte[] rawIpAddress) {
 260     return (((rawIpAddress[0] & 0xFF) << (3 * 8)) + ((rawIpAddress[1] & 0xFF) << (2 * 8))
 261             + ((rawIpAddress[2] & 0xFF) << (1 * 8)) + (rawIpAddress[3] & 0xFF)) & 0xffffffffL;
 262   }
 263
 264   private void makeConnectedRoute(long dpId, long vpnId, VrfEntry vrfEntry, String rd,
 265                                   long groupId, int addOrRemove) {
 266     LOG.trace("makeConnectedRoute: vrfEntry {}",vrfEntry);
 267     String values[] = vrfEntry.getDestPrefix().split("/");
 268     String ipAddress = values[0];
 269     int prefixLength = (values.length == 1) ? 32 : Integer.parseInt(values[1]);
 270     LOG.debug("Adding route to DPN. ip {} masklen {}", ipAddress, prefixLength);
 271     InetAddress destPrefix = null;
 272     try {
 273       destPrefix = InetAddress.getByName(ipAddress);
 274     } catch (UnknownHostException e) {
 275       LOG.error("UnknowHostException in addRoute. Failed to add Route for ipPrefix {}", vrfEntry.getDestPrefix());
 276       return;
 277     }
 278
 279     List<MatchInfo> matches = new ArrayList<MatchInfo>();
 280
 281     matches.add(new MatchInfo(MatchFieldType.metadata, new BigInteger[] {
 282         BigInteger.valueOf(vpnId), MetaDataUtil.METADATA_MASK_VRFID }));
 283
 284     matches.add(new MatchInfo(MatchFieldType.eth_type,
 285                               new long[] { 0x0800L }));
 286
 287     if(prefixLength != 0) {
 288       matches.add(new MatchInfo(MatchFieldType.ipv4_dst, new long[] {
 289           getIpAddress(destPrefix.getAddress()), prefixLength }));
 290     }
 291
 292     List<InstructionInfo> instructions = new ArrayList<InstructionInfo>();
 293     List<ActionInfo> actionsInfos = new ArrayList<ActionInfo>();
 294
 295     if(addOrRemove == NwConstants.ADD_FLOW) {
 296       actionsInfos.add(new ActionInfo(ActionType.group, new String[] { String.valueOf(groupId)}));
 297       actionsInfos.add(new ActionInfo(ActionType.push_mpls, new String[] { null }));
 298       actionsInfos.add(new ActionInfo(ActionType.set_field_mpls_label, new String[] { Long.toString(vrfEntry.getLabel())}));
 299       instructions.add(new InstructionInfo(InstructionType.write_actions, actionsInfos));
 300     }
 301
 302     String flowRef = getFlowRef(dpId, L3_FIB_TABLE, rd, destPrefix);
 303
 304     FlowEntity flowEntity;
 305
 306     int priority = DEFAULT_FIB_FLOW_PRIORITY + prefixLength;
 307     flowEntity = MDSALUtil.buildFlowEntity(dpId, L3_FIB_TABLE, flowRef,
 308                                            priority, flowRef, 0, 0,
 309                                            COOKIE_VM_FIB_TABLE, matches, instructions);
 310
 311     if (addOrRemove == NwConstants.ADD_FLOW) {
 312       mdsalManager.installFlow(flowEntity);
 313     } else {
 314       mdsalManager.removeFlow(flowEntity);
 315     }
 316   }
 317
 318   private void makeLFibTableEntry(long dpId, long label, long groupId,
 319                                   String nextHop, int addOrRemove) {
 320     List<MatchInfo> matches = new ArrayList<MatchInfo>();
 321     matches.add(new MatchInfo(MatchFieldType.eth_type,
 322                               new long[] { 0x8847L }));
 323     matches.add(new MatchInfo(MatchFieldType.mpls_label, new String[]{Long.toString(label)}));
 324
 325     List<InstructionInfo> instructions = new ArrayList<InstructionInfo>();
 326     List<ActionInfo> actionsInfos = new ArrayList<ActionInfo>();
 327     actionsInfos.add(new ActionInfo(ActionType.group, new String[] { String.valueOf(groupId) }));
 328     instructions.add(new InstructionInfo(InstructionType.write_actions, actionsInfos));
 329
 330     // Install the flow entry in L3_LFIB_TABLE
 331     String flowRef = getFlowRef(dpId, L3_LFIB_TABLE, label, nextHop);
 332
 333     FlowEntity flowEntity;
 334     flowEntity = MDSALUtil.buildFlowEntity(dpId, L3_LFIB_TABLE, flowRef,
 335                                            DEFAULT_FIB_FLOW_PRIORITY, flowRef, 0, 0,
 336                                            COOKIE_VM_LFIB_TABLE, matches, instructions);
 337
 338     if (addOrRemove == NwConstants.ADD_FLOW) {
 339       mdsalManager.installFlow(flowEntity);
 340     } else {
 341       mdsalManager.removeFlow(flowEntity);
 342     }
 343     LOG.debug("LFIB Entry for dpID {} : label : {} group {} modified successfully {}",dpId, label, groupId );
 344   }
 345
 346   private String getFlowRef(long dpnId, short tableId, long label, String nextHop) {
 347     return new StringBuilder(64).append(FLOWID_PREFIX).append(dpnId).append(NwConstants.FLOWID_SEPARATOR)
 348         .append(tableId).append(NwConstants.FLOWID_SEPARATOR)
 349         .append(label).append(NwConstants.FLOWID_SEPARATOR)
 350         .append(nextHop).toString();
 351   }
 352
 353   private String getFlowRef(long dpnId, short tableId, String rd, InetAddress destPrefix) {
 354     return new StringBuilder(64).append(FLOWID_PREFIX).append(dpnId).append(NwConstants.FLOWID_SEPARATOR)
 355         .append(tableId).append(NwConstants.FLOWID_SEPARATOR)
 356         .append(rd).append(NwConstants.FLOWID_SEPARATOR)
 357         .append(destPrefix.getHostAddress()).toString();
 358   }
 359
 360   private GetEgressPointerOutput resolveAdjacency(final long dpId, final long vpnId,
 361                         final VrfEntry vrfEntry) {
 362     GetEgressPointerOutput adjacency = null;
 363     LOG.trace("resolveAdjacency called with dpid {}, vpnId{}, VrfEntry {}",dpId, vpnId, vrfEntry);;
 364     try {
 365       Future<RpcResult<GetEgressPointerOutput>> result =
 366           l3nexthopService.getEgressPointer(new GetEgressPointerInputBuilder().setDpnId(dpId)
 367                                                 .setIpPrefix(vrfEntry.getDestPrefix())
 368                                                 .setNexthopIp(vrfEntry.getNextHopAddress())
 369                                                 .setVpnId(vpnId)
 370                                                 .build());
 371       RpcResult<GetEgressPointerOutput> rpcResult = result.get();
 372       if (rpcResult.isSuccessful()) {
 373         adjacency = rpcResult.getResult();
 374       } else {
 375         LOG.error("Next hop information not available");
 376       }
 377     } catch (NullPointerException | InterruptedException | ExecutionException e) {
 378       LOG.trace("", e);
 379     }
 380     return adjacency;
 381   }
 382
 383   private Long getVpnId(String rd) {
 384     Long vpnId = null;
 385     InstanceIdentifier<VpnInstances> id = InstanceIdentifier.create(VpnInstances.class);
 386     Optional<VpnInstances> vpnInstances = read(LogicalDatastoreType.OPERATIONAL, id);
 387     if(vpnInstances.isPresent()) {
 388       List<VpnInstance> vpns = vpnInstances.get().getVpnInstance();
 389       for(VpnInstance vpn : vpns) {
 390         if(vpn.getIpv4Family().getRouteDistinguisher().equals(rd)) {
 391           VpnInstance1 vpnInstanceId = vpn.getAugmentation(VpnInstance1.class);
 392           if (vpnInstanceId != null) {
 393             vpnId = vpnInstanceId.getVpnId();
 394             break;
 395           }
 396         }
 397       }
 398     }
 399     return vpnId;
 400   }
 401
 402     public void processNodeAdd(long dpnId) {
 403         LOG.debug("Received notification to install TableMiss entries for dpn {} ", dpnId);
 404         makeTableMissFlow(dpnId, NwConstants.ADD_FLOW);
 405     }
 406
 407     private void makeTableMissFlow(long dpnId, int addOrRemove) {
 408         final BigInteger COOKIE_TABLE_MISS = new BigInteger("1030000", 16);
 409         // Instruction to punt to controller
 410         List<InstructionInfo> instructions = new ArrayList<InstructionInfo>();
 411         List<ActionInfo> actionsInfos = new ArrayList<ActionInfo>();
 412         actionsInfos.add(new ActionInfo(ActionType.punt_to_controller, new String[] {}));
 413         instructions.add(new InstructionInfo(InstructionType.write_actions, actionsInfos));
 414         List<MatchInfo> matches = new ArrayList<MatchInfo>();
 415         FlowEntity flowEntityLfib = MDSALUtil.buildFlowEntity(dpnId, L3_LFIB_TABLE,
 416                 getFlowRef(dpnId, L3_LFIB_TABLE, NwConstants.TABLE_MISS_FLOW),
 417                 NwConstants.TABLE_MISS_PRIORITY, "Table Miss", 0, 0, COOKIE_TABLE_MISS, matches, instructions);
 418
 419         FlowEntity flowEntityFib = MDSALUtil.buildFlowEntity(dpnId,L3_FIB_TABLE, getFlowRef(dpnId, L3_FIB_TABLE, NwConstants.TABLE_MISS_FLOW),
 420                 NwConstants.TABLE_MISS_PRIORITY, "FIB Table Miss Flow", 0, 0, COOKIE_VM_FIB_TABLE,
 421                 matches, instructions);
 422
 423         if (addOrRemove == NwConstants.ADD_FLOW) {
 424             LOG.debug("Invoking MDSAL to install Table Miss Entries");
 425             mdsalManager.installFlow(flowEntityLfib);
 426             mdsalManager.installFlow(flowEntityFib);
 427         } else {
 428             mdsalManager.removeFlow(flowEntityLfib);
 429             mdsalManager.removeFlow(flowEntityFib);
 430
 431         }
 432     }
 433
 434     private String getFlowRef(long dpnId, short tableId, int tableMiss) {
 435         return new StringBuffer().append(FLOWID_PREFIX).append(dpnId).append(NwConstants.FLOWID_SEPARATOR)
 436                 .append(tableId).append(NwConstants.FLOWID_SEPARATOR).append(tableMiss)
 437                 .append(FLOWID_PREFIX).toString();
 438     }
 439 }