Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
Karthik Vegesna | 9901271 | 2017-07-20 12:07:23 -0700 | [diff] [blame] | 13 | * See the License for the specific language governing permissions and |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 14 | * limitations under the License. |
| 15 | */ |
Karthik Vegesna | 9901271 | 2017-07-20 12:07:23 -0700 | [diff] [blame] | 16 | |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 17 | package org.onosproject.packetstats; |
| 18 | import com.codahale.metrics.Counter; |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 19 | import org.osgi.service.component.annotations.Activate; |
| 20 | import org.osgi.service.component.annotations.Component; |
| 21 | import org.osgi.service.component.annotations.Deactivate; |
| 22 | import org.osgi.service.component.annotations.Reference; |
| 23 | import org.osgi.service.component.annotations.ReferenceCardinality; |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 24 | import org.onlab.packet.Ethernet; |
| 25 | import org.onlab.packet.IPv4; |
Sudhir Kumar Maurya | 2cc7798 | 2018-12-14 06:41:33 -0500 | [diff] [blame] | 26 | import org.onlab.packet.IPv6; |
| 27 | import org.onlab.packet.ICMP6; |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 28 | import org.onlab.packet.UDP; |
| 29 | import org.onosproject.cfg.ComponentConfigService; |
| 30 | import org.onosproject.core.ApplicationId; |
| 31 | import org.onosproject.core.CoreService; |
| 32 | import org.onosproject.net.flow.FlowRuleService; |
| 33 | import org.onosproject.net.packet.InboundPacket; |
| 34 | import org.onosproject.net.packet.PacketContext; |
| 35 | import org.onosproject.net.packet.PacketProcessor; |
| 36 | import org.onosproject.net.packet.PacketService; |
| 37 | |
| 38 | import org.osgi.service.component.ComponentContext; |
| 39 | import org.slf4j.Logger; |
| 40 | import static org.slf4j.LoggerFactory.getLogger; |
| 41 | import org.onlab.metrics.MetricsComponent; |
| 42 | import org.onlab.metrics.MetricsFeature; |
| 43 | import org.onlab.metrics.MetricsService; |
| 44 | |
| 45 | /** |
| 46 | * Application for Packet Statistics. |
| 47 | */ |
| 48 | @Component(immediate = true) |
Harshada Chaundkar | 754701c | 2019-03-08 14:15:53 -0500 | [diff] [blame] | 49 | public class PacketStatistics { |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 50 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 51 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 52 | protected PacketService packetService; |
| 53 | |
| 54 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 55 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 56 | protected FlowRuleService flowRuleService; |
| 57 | |
| 58 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 59 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 60 | protected CoreService coreService; |
| 61 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 62 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 63 | protected ComponentConfigService cfgService; |
| 64 | |
Ray Milkey | d84f89b | 2018-08-17 14:54:17 -0700 | [diff] [blame] | 65 | @Reference(cardinality = ReferenceCardinality.MANDATORY) |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 66 | protected MetricsService metricService; |
| 67 | |
Sudhir Kumar Maurya | 2cc7798 | 2018-12-14 06:41:33 -0500 | [diff] [blame] | 68 | private PacketCounter processor = new PacketCounter(); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 69 | private final Logger log = getLogger(getClass()); |
| 70 | |
| 71 | private ApplicationId appId; |
| 72 | |
| 73 | |
| 74 | private MetricsComponent packetStatisticsComponent; |
| 75 | private MetricsFeature arpFeature; |
| 76 | private Counter arpCounter; |
| 77 | private MetricsFeature dhcpFeature; |
| 78 | private Counter dhcpCounter; |
| 79 | private MetricsFeature lldpFeature; |
| 80 | private Counter lldpCounter; |
| 81 | private MetricsFeature vlanFeature; |
| 82 | private Counter vlanCounter; |
| 83 | private MetricsFeature tcpFeature; |
| 84 | private Counter tcpCounter; |
| 85 | private MetricsFeature icmpFeature; |
| 86 | private Counter icmpCounter; |
Sudhir Kumar Maurya | 2cc7798 | 2018-12-14 06:41:33 -0500 | [diff] [blame] | 87 | private MetricsFeature icmp6Feature; |
| 88 | private Counter icmp6Counter; |
| 89 | private MetricsFeature nbrSolicitFeature; |
| 90 | private Counter nbrSolicitCounter; |
| 91 | private MetricsFeature nbrAdvertFeature; |
| 92 | private Counter nbrAdvertCounter; |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 93 | private MetricsFeature igmpFeature; |
| 94 | private Counter igmpCounter; |
| 95 | private MetricsFeature pimFeature; |
| 96 | private Counter pimCounter; |
| 97 | private MetricsFeature bsnFeature; |
| 98 | private Counter bsnCounter; |
| 99 | private MetricsFeature rarpFeature; |
| 100 | private Counter rarpCounter; |
| 101 | private MetricsFeature mplsFeature; |
| 102 | private Counter mplsCounter; |
| 103 | private MetricsFeature unknownFeature; |
| 104 | private Counter unknownCounter; |
| 105 | |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 106 | @Activate |
| 107 | public void activate(ComponentContext context) { |
| 108 | this.packetStatisticsComponent = |
| 109 | metricService.registerComponent("packetStatisticsComponent"); |
| 110 | this.arpFeature = |
| 111 | packetStatisticsComponent.registerFeature("arpFeature"); |
| 112 | this.dhcpFeature = |
| 113 | packetStatisticsComponent.registerFeature("dhcpFeature"); |
| 114 | this.lldpFeature = |
| 115 | packetStatisticsComponent.registerFeature("lldpFeature"); |
| 116 | this.vlanFeature = |
| 117 | packetStatisticsComponent.registerFeature("vlanFeature"); |
| 118 | this.tcpFeature = |
| 119 | packetStatisticsComponent.registerFeature("tcpFeature"); |
| 120 | this.icmpFeature = |
| 121 | packetStatisticsComponent.registerFeature("icmpFeature"); |
Sudhir Kumar Maurya | 2cc7798 | 2018-12-14 06:41:33 -0500 | [diff] [blame] | 122 | this.icmp6Feature = |
| 123 | packetStatisticsComponent.registerFeature("icmp6Feature"); |
| 124 | this.nbrSolicitFeature = |
| 125 | packetStatisticsComponent.registerFeature("nbrSolicitFeature"); |
| 126 | this.nbrAdvertFeature = |
| 127 | packetStatisticsComponent.registerFeature("nbrAdvertFeature"); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 128 | this.igmpFeature = |
| 129 | packetStatisticsComponent.registerFeature("igmpFeature"); |
| 130 | this.pimFeature = |
| 131 | packetStatisticsComponent.registerFeature("pimFeature"); |
| 132 | this.bsnFeature = |
| 133 | packetStatisticsComponent.registerFeature("bsnFeature"); |
| 134 | this.rarpFeature = |
| 135 | packetStatisticsComponent.registerFeature("rarpFeature"); |
| 136 | this.mplsFeature = |
| 137 | packetStatisticsComponent.registerFeature("mplsFeature"); |
| 138 | this.unknownFeature = |
| 139 | packetStatisticsComponent.registerFeature("unknownFeature"); |
| 140 | this.arpCounter = |
Karthik Vegesna | 9901271 | 2017-07-20 12:07:23 -0700 | [diff] [blame] | 141 | metricService.createCounter(packetStatisticsComponent, arpFeature, "arpPC"); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 142 | this.dhcpCounter = |
Karthik Vegesna | 9901271 | 2017-07-20 12:07:23 -0700 | [diff] [blame] | 143 | metricService.createCounter(packetStatisticsComponent, dhcpFeature, "dhcpPC"); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 144 | this.lldpCounter = |
Karthik Vegesna | 9901271 | 2017-07-20 12:07:23 -0700 | [diff] [blame] | 145 | metricService.createCounter(packetStatisticsComponent, lldpFeature, "lldpPC"); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 146 | this.vlanCounter = |
Karthik Vegesna | 9901271 | 2017-07-20 12:07:23 -0700 | [diff] [blame] | 147 | metricService.createCounter(packetStatisticsComponent, vlanFeature, "vlanPC"); |
Harshada Chaundkar | 754701c | 2019-03-08 14:15:53 -0500 | [diff] [blame] | 148 | this.tcpCounter = |
| 149 | metricService.createCounter(packetStatisticsComponent, tcpFeature, "tcpPC"); |
| 150 | this.rarpCounter = |
| 151 | metricService.createCounter(packetStatisticsComponent, rarpFeature, "rarpPC"); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 152 | this.icmpCounter = |
Karthik Vegesna | 9901271 | 2017-07-20 12:07:23 -0700 | [diff] [blame] | 153 | metricService.createCounter(packetStatisticsComponent, icmpFeature, "icmpPC"); |
Sudhir Kumar Maurya | 2cc7798 | 2018-12-14 06:41:33 -0500 | [diff] [blame] | 154 | this.icmp6Counter = |
| 155 | metricService.createCounter(packetStatisticsComponent, icmp6Feature, "icmp6PC"); |
| 156 | this.nbrSolicitCounter = |
| 157 | metricService.createCounter(packetStatisticsComponent, nbrSolicitFeature, "nbrSolicitPC"); |
| 158 | this.nbrAdvertCounter = |
| 159 | metricService.createCounter(packetStatisticsComponent, nbrAdvertFeature, "nbrAdvertPC"); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 160 | this.igmpCounter = |
Karthik Vegesna | 9901271 | 2017-07-20 12:07:23 -0700 | [diff] [blame] | 161 | metricService.createCounter(packetStatisticsComponent, igmpFeature, "igmpPC"); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 162 | this.pimCounter = |
Karthik Vegesna | 9901271 | 2017-07-20 12:07:23 -0700 | [diff] [blame] | 163 | metricService.createCounter(packetStatisticsComponent, pimFeature, "pimPC"); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 164 | this.bsnCounter = |
Karthik Vegesna | 9901271 | 2017-07-20 12:07:23 -0700 | [diff] [blame] | 165 | metricService.createCounter(packetStatisticsComponent, bsnFeature, "bsnPC"); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 166 | this.mplsCounter = |
Karthik Vegesna | 9901271 | 2017-07-20 12:07:23 -0700 | [diff] [blame] | 167 | metricService.createCounter(packetStatisticsComponent, mplsFeature, "mplsPC"); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 168 | this.unknownCounter = |
Karthik Vegesna | 9901271 | 2017-07-20 12:07:23 -0700 | [diff] [blame] | 169 | metricService.createCounter(packetStatisticsComponent, unknownFeature, "unknownPC"); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 170 | |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 171 | appId = coreService.registerApplication("org.onosproject.packet-stats"); |
| 172 | |
Karthik Vegesna | 9901271 | 2017-07-20 12:07:23 -0700 | [diff] [blame] | 173 | packetService.addProcessor(processor, PacketProcessor.director(0)); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 174 | log.info("Started", appId.id()); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 175 | } |
| 176 | |
| 177 | @Deactivate |
| 178 | public void deactivate() { |
| 179 | cfgService.unregisterProperties(getClass(), false); |
| 180 | flowRuleService.removeFlowRulesById(appId); |
| 181 | packetService.removeProcessor(processor); |
| 182 | processor = null; |
| 183 | log.info("Stopped"); |
| 184 | } |
| 185 | |
| 186 | |
| 187 | /** |
Sudhir Kumar Maurya | 2cc7798 | 2018-12-14 06:41:33 -0500 | [diff] [blame] | 188 | * Packet processor responsible for counting various types of packets. |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 189 | */ |
Sudhir Kumar Maurya | 2cc7798 | 2018-12-14 06:41:33 -0500 | [diff] [blame] | 190 | private class PacketCounter implements PacketProcessor { |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 191 | @Override |
| 192 | public void process(PacketContext context) { |
| 193 | InboundPacket pkt = context.inPacket(); |
| 194 | Ethernet ethPkt = pkt.parsed(); |
| 195 | |
| 196 | //Indicates whether this is an ARP Packet |
| 197 | if (ethPkt.getEtherType() == Ethernet.TYPE_ARP) { |
| 198 | arpCounter.inc(); |
| 199 | |
| 200 | } else if (ethPkt.getEtherType() == Ethernet.TYPE_LLDP) { |
| 201 | lldpCounter.inc(); |
| 202 | |
| 203 | } else if (ethPkt.getEtherType() == Ethernet.TYPE_VLAN) { |
| 204 | vlanCounter.inc(); |
| 205 | |
| 206 | } else if (ethPkt.getEtherType() == Ethernet.TYPE_BSN) { |
| 207 | bsnCounter.inc(); |
| 208 | |
| 209 | } else if (ethPkt.getEtherType() == Ethernet.TYPE_RARP) { |
| 210 | rarpCounter.inc(); |
| 211 | |
| 212 | } else if (ethPkt.getEtherType() == Ethernet.MPLS_UNICAST |
| 213 | || ethPkt.getEtherType() == Ethernet.MPLS_MULTICAST) { |
| 214 | mplsCounter.inc(); |
| 215 | |
| 216 | } else if (ethPkt.getEtherType() == Ethernet.TYPE_IPV4) { |
| 217 | IPv4 ipv4Packet = (IPv4) ethPkt.getPayload(); |
| 218 | //Indicates whether this is a TCP Packet |
| 219 | if (ipv4Packet.getProtocol() == IPv4.PROTOCOL_TCP) { |
| 220 | tcpCounter.inc(); |
| 221 | |
| 222 | } else if (ipv4Packet.getProtocol() == IPv4.PROTOCOL_ICMP) { |
| 223 | icmpCounter.inc(); |
| 224 | |
| 225 | } else if (ipv4Packet.getProtocol() == IPv4.PROTOCOL_IGMP) { |
| 226 | igmpCounter.inc(); |
| 227 | |
| 228 | } else if (ipv4Packet.getProtocol() == IPv4.PROTOCOL_PIM) { |
| 229 | pimCounter.inc(); |
| 230 | |
| 231 | } else if (ipv4Packet.getProtocol() == IPv4.PROTOCOL_UDP) { |
| 232 | UDP udpPacket = (UDP) ipv4Packet.getPayload(); |
| 233 | //Indicates whether this packet is a DHCP Packet |
| 234 | if (udpPacket.getSourcePort() == UDP.DHCP_CLIENT_PORT |
| 235 | || udpPacket.getSourcePort() == UDP.DHCP_SERVER_PORT) { |
| 236 | dhcpCounter.inc(); |
| 237 | } |
| 238 | } |
Sudhir Kumar Maurya | 2cc7798 | 2018-12-14 06:41:33 -0500 | [diff] [blame] | 239 | } else if (ethPkt.getEtherType() == Ethernet.TYPE_IPV6) { |
| 240 | IPv6 ipv6Pkt = (IPv6) ethPkt.getPayload(); |
| 241 | if (ipv6Pkt.getNextHeader() == IPv6.PROTOCOL_ICMP6) { |
| 242 | icmp6Counter.inc(); |
| 243 | ICMP6 icmpv6 = (ICMP6) ipv6Pkt.getPayload(); |
| 244 | if (icmpv6.getIcmpType() == ICMP6.NEIGHBOR_SOLICITATION) { |
| 245 | nbrSolicitCounter.inc(); |
| 246 | } else if (icmpv6.getIcmpType() == ICMP6.NEIGHBOR_ADVERTISEMENT) { |
| 247 | nbrAdvertCounter.inc(); |
| 248 | } |
| 249 | } |
| 250 | } else { |
| 251 | log.debug("Packet is unknown."); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 252 | unknownCounter.inc(); |
Karthik Vegesna | 20ce41e | 2017-07-11 10:34:37 -0700 | [diff] [blame] | 253 | } |
Sudhir Kumar Maurya | 2cc7798 | 2018-12-14 06:41:33 -0500 | [diff] [blame] | 254 | } |
Harshada Chaundkar | 754701c | 2019-03-08 14:15:53 -0500 | [diff] [blame] | 255 | } |
Sudhir Kumar Maurya | 2cc7798 | 2018-12-14 06:41:33 -0500 | [diff] [blame] | 256 | } |