mappingservice/implementation/src/main/java/org/opendaylight/lispflowmapping/implementation/mdsal/MappingDataListener.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc.  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.lispflowmapping.implementation.mdsal;
   9
  10 import java.util.ArrayList;
  11 import java.util.Collection;
  12 import java.util.List;
  13 import java.util.Set;
  14 import org.opendaylight.controller.md.sal.binding.api.DataBroker;
  15 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification;
  16 import org.opendaylight.controller.md.sal.binding.api.DataObjectModification.ModificationType;
  17 import org.opendaylight.controller.md.sal.binding.api.DataTreeModification;
  18 import org.opendaylight.controller.md.sal.binding.api.NotificationPublishService;
  19 import org.opendaylight.lispflowmapping.implementation.util.MSNotificationInputUtil;
  20 import org.opendaylight.lispflowmapping.interfaces.dao.SubKeys;
  21 import org.opendaylight.lispflowmapping.interfaces.dao.Subscriber;
  22 import org.opendaylight.lispflowmapping.interfaces.mapcache.IMappingSystem;
  23 import org.opendaylight.lispflowmapping.lisp.type.MappingData;
  24 import org.opendaylight.lispflowmapping.lisp.util.LispAddressUtil;
  25 import org.opendaylight.lispflowmapping.lisp.util.SourceDestKeyHelper;
  26 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.lisp.address.types.rev151105.lisp.address.address.SourceDestKey;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.eid.container.Eid;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecord;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.locatorrecords.LocatorRecordBuilder;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecord;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.lisp.proto.rev151105.mapping.record.container.MappingRecordBuilder;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingChange;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingDatabase;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.MappingOrigin;
  35 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance.Mapping;
  36 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.db.instance.MappingBuilder;
  37 import org.opendaylight.yang.gen.v1.urn.opendaylight.lfm.mappingservice.rev150906.mapping.database.VirtualNetworkIdentifier;
  38 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
  39 import org.slf4j.Logger;
  40 import org.slf4j.LoggerFactory;
  41
  42 /**
  43  * DataListener for all Mapping modification events.
  44  *
  45  * @author Lorand Jakab
  46  * @author Florin Coras
  47  *
  48  */
  49 public class MappingDataListener extends AbstractDataListener<Mapping> {
  50     private static final Logger LOG = LoggerFactory.getLogger(MappingDataListener.class);
  51     private IMappingSystem mapSystem;
  52     private NotificationPublishService notificationPublishService;
  53     private boolean isMaster = false;
  54
  55     public MappingDataListener(DataBroker broker, IMappingSystem msmr, NotificationPublishService nps) {
  56         setBroker(broker);
  57         setMappingSystem(msmr);
  58         setNotificationProviderService(nps);
  59         setPath(InstanceIdentifier.create(MappingDatabase.class).child(VirtualNetworkIdentifier.class)
  60                 .child(Mapping.class));
  61         LOG.trace("Registering Mapping listener.");
  62         registerDataChangeListener();
  63     }
  64
  65     public void setNotificationProviderService(NotificationPublishService nps) {
  66         this.notificationPublishService = nps;
  67     }
  68
  69     void setMappingSystem(IMappingSystem msmr) {
  70         this.mapSystem = msmr;
  71     }
  72
  73     @Override
  74     public void onDataTreeChanged(Collection<DataTreeModification<Mapping>> changes) {
  75         for (DataTreeModification<Mapping> change : changes) {
  76             final DataObjectModification<Mapping> mod = change.getRootNode();
  77
  78             if (ModificationType.DELETE == mod.getModificationType()) {
  79                 // Process deleted mappings
  80
  81                 final Mapping mapping = mod.getDataBefore();
  82
  83                 // Only treat mapping changes caused by Northbound, since Southbound changes are already handled
  84                 // before being persisted, except for cluster slaves
  85                 if (mapping.getOrigin() == MappingOrigin.Southbound && mapSystem.isMaster()) {
  86                     continue;
  87                 }
  88
  89                 LOG.trace("Received deleted data");
  90                 LOG.trace("Key: {}", change.getRootPath().getRootIdentifier());
  91                 LOG.trace("Value: {}", mapping);
  92
  93                 final Mapping convertedMapping = convertToBinaryIfNecessary(mapping);
  94
  95                 mapSystem.removeMapping(convertedMapping.getOrigin(), convertedMapping.getMappingRecord().getEid());
  96
  97             } else if (ModificationType.SUBTREE_MODIFIED == mod.getModificationType() || ModificationType.WRITE == mod
  98                     .getModificationType()) {
  99                 final Mapping mapping = mod.getDataAfter();
 100
 101                 // Only treat mapping changes caused by Northbound, since Southbound changes are already handled
 102                 // before being persisted, except for cluster slaves XXX separate NB and SB to avoid ignoring
 103                 // SB notifications
 104                 if (mapping.getOrigin() == MappingOrigin.Southbound && mapSystem.isMaster()) {
 105                     continue;
 106                 }
 107
 108                 MappingChange mappingChange;
 109
 110                 if (ModificationType.SUBTREE_MODIFIED == mod.getModificationType()) {
 111                     LOG.trace("Received update data");
 112                     mappingChange = MappingChange.Updated;
 113                 } else {
 114                     LOG.trace("Received write data");
 115                     mappingChange = MappingChange.Created;
 116                 }
 117                 LOG.trace("Key: {}", change.getRootPath().getRootIdentifier());
 118                 LOG.trace("Value: {}", mapping);
 119
 120                 final Mapping convertedMapping = convertToBinaryIfNecessary(mapping);
 121                 Eid convertedEid = convertedMapping.getMappingRecord().getEid();
 122
 123                 mapSystem.addMapping(convertedMapping.getOrigin(), convertedEid,
 124                         new MappingData(convertedMapping.getMappingRecord()));
 125                 Set<Subscriber> subscribers = (Set<Subscriber>) mapSystem.getData(MappingOrigin.Southbound,
 126                         convertedEid, SubKeys.SUBSCRIBERS);
 127                 Set<Subscriber> dstSubscribers = null;
 128                 // For SrcDst LCAF also send SMRs to Dst prefix
 129                 if (convertedEid.getAddress() instanceof SourceDestKey) {
 130                     Eid dstAddr = SourceDestKeyHelper.getDstBinary(convertedEid);
 131                     dstSubscribers = (Set<Subscriber>) mapSystem.getData(MappingOrigin.Southbound,
 132                             dstAddr, SubKeys.SUBSCRIBERS);
 133                 }
 134
 135                 try {
 136                     // The notifications are used for sending SMR.
 137                     notificationPublishService.putNotification(MSNotificationInputUtil.toMappingChanged(
 138                             convertedMapping, subscribers, dstSubscribers, mappingChange));
 139                 } catch (InterruptedException e) {
 140                     LOG.warn("Notification publication interrupted!");
 141                 }
 142
 143             } else {
 144                 LOG.warn("Ignoring unhandled modification type {}", mod.getModificationType());
 145             }
 146         }
 147     }
 148
 149     private static Mapping convertToBinaryIfNecessary(Mapping mapping) {
 150         MappingRecord originalRecord = mapping.getMappingRecord();
 151         List<LocatorRecord> originalLocators = originalRecord.getLocatorRecord();
 152
 153         List<LocatorRecord> convertedLocators = null;
 154         if (originalLocators != null) {
 155             // If convertedLocators is non-null, while originalLocators is also non-null, conversion has been made
 156             convertedLocators = convertToBinaryIfNecessary(originalLocators);
 157         }
 158
 159         if (LispAddressUtil.addressNeedsConversionToBinary(originalRecord.getEid().getAddress())
 160                 || (originalLocators != null && convertedLocators != null)) {
 161             MappingRecordBuilder mrb = new MappingRecordBuilder(originalRecord);
 162             mrb.setEid(LispAddressUtil.convertToBinary(originalRecord.getEid()));
 163             if (convertedLocators != null) {
 164                 mrb.setLocatorRecord(convertedLocators);
 165             }
 166             return new MappingBuilder(mapping).setMappingRecord(mrb.build()).build();
 167         }
 168         return mapping;
 169     }
 170
 171     private static List<LocatorRecord> convertToBinaryIfNecessary(List<LocatorRecord> originalLocators) {
 172         List<LocatorRecord> convertedLocators = null;
 173         for (LocatorRecord record : originalLocators) {
 174             if (LispAddressUtil.addressNeedsConversionToBinary(record.getRloc().getAddress())) {
 175                 LocatorRecordBuilder lrb = new LocatorRecordBuilder(record);
 176                 lrb.setRloc(LispAddressUtil.convertToBinary(record.getRloc()));
 177                 if (convertedLocators == null) {
 178                     convertedLocators = new ArrayList<LocatorRecord>();
 179                 }
 180                 convertedLocators.add(lrb.build());
 181             }
 182         }
 183         if (convertedLocators != null) {
 184             return convertedLocators;
 185         }
 186         return originalLocators;
 187     }
 188 }