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