hosttracker/implementation/src/main/java/org/opendaylight/l2switch/hosttracker/plugin/internal/SimpleAddressObserver.java

   1 /*
   2  * Copyright (c) 2014 André Martins, Colin Dixon, Evan Zeller 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.l2switch.hosttracker.plugin.internal;
   9
  10 import java.math.BigInteger;
  11 import java.util.Date;
  12 import org.opendaylight.mdsal.binding.api.NotificationService;
  13 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
  14 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4Address;
  15 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
  16 import org.opendaylight.yang.gen.v1.urn.opendaylight.address.tracker.rev140617.address.node.connector.Addresses;
  17 import org.opendaylight.yang.gen.v1.urn.opendaylight.address.tracker.rev140617.address.node.connector.AddressesBuilder;
  18 import org.opendaylight.yang.gen.v1.urn.opendaylight.address.tracker.rev140617.address.node.connector.AddressesKey;
  19 import org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeConnectorRef;
  20 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.arp.rev140528.ArpPacketListener;
  21 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.arp.rev140528.ArpPacketReceived;
  22 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.arp.rev140528.arp.packet.received.packet.chain.packet.ArpPacket;
  23 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.basepacket.rev140528.packet.chain.grp.PacketChain;
  24 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.basepacket.rev140528.packet.chain.grp.packet.chain.packet.RawPacket;
  25 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.basepacket.rev140528.packet.chain.grp.packet.chain.packet.raw.packet.RawPacketFields;
  26 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.ethernet.rev140528.KnownEtherType;
  27 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.ethernet.rev140528.VlanId;
  28 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.ethernet.rev140528.ethernet.packet.received.packet.chain.packet.EthernetPacket;
  29 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.ipv4.rev140528.Ipv4PacketListener;
  30 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.ipv4.rev140528.Ipv4PacketReceived;
  31 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.ipv4.rev140528.ipv4.packet.received.packet.chain.packet.Ipv4Packet;
  32 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.ipv6.rev140528.Ipv6PacketListener;
  33 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.ipv6.rev140528.Ipv6PacketReceived;
  34 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.ipv6.rev140528.ipv6.packet.received.packet.chain.packet.Ipv6Packet;
  35
  36 /**
  37  * A Simple Address Observer based on l2switch address observer.
  38  */
  39 public class SimpleAddressObserver implements ArpPacketListener, Ipv4PacketListener, Ipv6PacketListener {
  40
  41     private static final String IPV4_IP_TO_IGNORE = "0.0.0.0";
  42     private static final String IPV6_IP_TO_IGNORE = "0:0:0:0:0:0:0:0";
  43
  44     private final HostTrackerImpl hostTrackerImpl;
  45     private final NotificationService notificationService;
  46
  47     public SimpleAddressObserver(HostTrackerImpl hostTrackerImpl, NotificationService notificationService) {
  48         this.hostTrackerImpl = hostTrackerImpl;
  49         this.notificationService = notificationService;
  50
  51     }
  52
  53     void registerAsNotificationListener() {
  54         this.notificationService.registerNotificationListener(this);
  55     }
  56
  57     @Override
  58     public void onArpPacketReceived(ArpPacketReceived packetReceived) {
  59         if (packetReceived == null || packetReceived.getPacketChain() == null) {
  60             return;
  61         }
  62
  63         RawPacketFields rawPacket = null;
  64         EthernetPacket ethernetPacket = null;
  65         ArpPacket arpPacket = null;
  66         for (PacketChain packetChain : packetReceived.getPacketChain()) {
  67             if (packetChain.getPacket() instanceof RawPacket) {
  68                 rawPacket = ((RawPacket) packetChain.getPacket()).getRawPacketFields();
  69             } else if (packetChain.getPacket() instanceof EthernetPacket) {
  70                 ethernetPacket = (EthernetPacket) packetChain.getPacket();
  71             } else if (packetChain.getPacket() instanceof ArpPacket) {
  72                 arpPacket = (ArpPacket) packetChain.getPacket();
  73             }
  74         }
  75         if (rawPacket == null || ethernetPacket == null || arpPacket == null) {
  76             return;
  77         }
  78         VlanId vlanId = null;
  79         if (ethernetPacket.getEthertype().equals(KnownEtherType.VlanTagged)) {
  80             vlanId = ethernetPacket.getHeader8021q().get(0).getVlan();
  81         }
  82         MacAddress sourceMac = ethernetPacket.getSourceMac();
  83         IpAddress ipAddress = null;
  84         if (arpPacket.getProtocolType().equals(KnownEtherType.Ipv4)) {
  85             ipAddress = new IpAddress(new Ipv4Address(arpPacket.getSourceProtocolAddress()));
  86         }
  87         Addresses addrs = createAddresses(sourceMac, vlanId, ipAddress, ethernetPacket.getEthertype());
  88         if (addrs == null) {
  89             return;
  90         }
  91         NodeConnectorRef ingress = rawPacket.getIngress();
  92         hostTrackerImpl.packetReceived(addrs, ingress.getValue());
  93     }
  94
  95     @Override
  96     public void onIpv4PacketReceived(Ipv4PacketReceived packetReceived) {
  97         if (packetReceived == null || packetReceived.getPacketChain() == null) {
  98             return;
  99         }
 100
 101         RawPacketFields rawPacket = null;
 102         EthernetPacket ethernetPacket = null;
 103         Ipv4Packet ipv4Packet = null;
 104         for (PacketChain packetChain : packetReceived.getPacketChain()) {
 105             if (packetChain.getPacket() instanceof RawPacket) {
 106                 rawPacket = ((RawPacket) packetChain.getPacket()).getRawPacketFields();
 107             } else if (packetChain.getPacket() instanceof EthernetPacket) {
 108                 ethernetPacket = (EthernetPacket) packetChain.getPacket();
 109             } else if (packetChain.getPacket() instanceof Ipv4Packet) {
 110                 ipv4Packet = (Ipv4Packet) packetChain.getPacket();
 111             }
 112         }
 113         if (rawPacket == null || ethernetPacket == null || ipv4Packet == null) {
 114             return;
 115         }
 116
 117         if (IPV4_IP_TO_IGNORE.equals(ipv4Packet.getSourceIpv4().getValue())) {
 118             return;
 119         }
 120
 121         VlanId vlanId = null;
 122         if (ethernetPacket.getEthertype().equals(KnownEtherType.VlanTagged)) {
 123             vlanId = ethernetPacket.getHeader8021q().get(0).getVlan();
 124         }
 125         MacAddress sourceMac = ethernetPacket.getSourceMac();
 126         IpAddress ipAddress = new IpAddress(ipv4Packet.getSourceIpv4());
 127
 128         Addresses addrs = createAddresses(sourceMac, vlanId, ipAddress, ethernetPacket.getEthertype());
 129         if (addrs == null) {
 130             return;
 131         }
 132         NodeConnectorRef ingress = rawPacket.getIngress();
 133         hostTrackerImpl.packetReceived(addrs, ingress.getValue());
 134     }
 135
 136     @Override
 137     public void onIpv6PacketReceived(Ipv6PacketReceived packetReceived) {
 138         if (packetReceived == null || packetReceived.getPacketChain() == null) {
 139             return;
 140         }
 141
 142         RawPacketFields rawPacket = null;
 143         EthernetPacket ethernetPacket = null;
 144         Ipv6Packet ipv6Packet = null;
 145         for (PacketChain packetChain : packetReceived.getPacketChain()) {
 146             if (packetChain.getPacket() instanceof RawPacket) {
 147                 rawPacket = ((RawPacket) packetChain.getPacket()).getRawPacketFields();
 148             } else if (packetChain.getPacket() instanceof EthernetPacket) {
 149                 ethernetPacket = (EthernetPacket) packetChain.getPacket();
 150             } else if (packetChain.getPacket() instanceof Ipv6Packet) {
 151                 ipv6Packet = (Ipv6Packet) packetChain.getPacket();
 152             }
 153         }
 154         if (rawPacket == null || ethernetPacket == null || ipv6Packet == null) {
 155             return;
 156         }
 157         if (IPV6_IP_TO_IGNORE.equals(ipv6Packet.getSourceIpv6().getValue())) {
 158             return;
 159         }
 160
 161         VlanId vlanId = null;
 162         if (ethernetPacket.getEthertype().equals(KnownEtherType.VlanTagged)) {
 163             vlanId = ethernetPacket.getHeader8021q().get(0).getVlan();
 164         }
 165         MacAddress sourceMac = ethernetPacket.getSourceMac();
 166         IpAddress ipAddress = new IpAddress(ipv6Packet.getSourceIpv6());
 167
 168         Addresses addrs = createAddresses(sourceMac, vlanId, ipAddress, ethernetPacket.getEthertype());
 169         if (addrs == null) {
 170             return;
 171         }
 172         NodeConnectorRef ingress = rawPacket.getIngress();
 173         hostTrackerImpl.packetReceived(addrs, ingress.getValue());
 174     }
 175
 176     private Addresses createAddresses(MacAddress srcMacAddr, VlanId vlanId, IpAddress srcIpAddr,
 177             KnownEtherType ketype) {
 178         AddressesBuilder addrs = new AddressesBuilder();
 179         if (srcMacAddr == null || srcIpAddr == null) {
 180             return null;
 181         }
 182         /*
 183          * TODO: if this is used, use a ReadWriteTranscation to figure out if
 184          * there is an already existing addresses that has the same MAC, IP,
 185          * VLAN triple and use it’s ID then, if there’s none, then we make up
 186          * our own Addresses
 187          */
 188         BigInteger id = BigInteger.valueOf(ketype.getIntValue()).abs()
 189                 .add(BigInteger.valueOf(srcMacAddr.hashCode()).abs().shiftLeft(16));
 190         addrs.setId(id);
 191         addrs.withKey(new AddressesKey(addrs.getId()));
 192         addrs.setVlan(vlanId);
 193         addrs.setIp(srcIpAddr);
 194         addrs.setMac(srcMacAddr);
 195         // addrs.setFirstSeen(new Date().getTime());
 196         addrs.setLastSeen(new Date().getTime());
 197         return addrs.build();
 198     }
 199 }