Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame^] | 2 | * Copyright 2016-present Open Networking Foundation |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [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. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.pim.impl; |
| 17 | |
| 18 | import org.apache.felix.scr.annotations.Activate; |
| 19 | import org.apache.felix.scr.annotations.Component; |
| 20 | import org.apache.felix.scr.annotations.Deactivate; |
| 21 | import org.apache.felix.scr.annotations.Reference; |
| 22 | import org.apache.felix.scr.annotations.ReferenceCardinality; |
| 23 | import org.onlab.packet.Ethernet; |
| 24 | import org.onlab.packet.IPv4; |
| 25 | import org.onosproject.core.ApplicationId; |
| 26 | import org.onosproject.core.CoreService; |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 27 | import org.onosproject.net.flow.DefaultTrafficSelector; |
| 28 | import org.onosproject.net.flow.TrafficSelector; |
| 29 | import org.onosproject.net.mcast.MulticastRouteService; |
| 30 | import org.onosproject.net.packet.InboundPacket; |
| 31 | import org.onosproject.net.packet.PacketContext; |
Jonathan Hart | 36fd31e | 2016-01-28 15:55:31 -0800 | [diff] [blame] | 32 | import org.onosproject.net.packet.PacketPriority; |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 33 | import org.onosproject.net.packet.PacketProcessor; |
| 34 | import org.onosproject.net.packet.PacketService; |
| 35 | import org.slf4j.Logger; |
| 36 | |
Jonathan Hart | 36fd31e | 2016-01-28 15:55:31 -0800 | [diff] [blame] | 37 | import java.util.Optional; |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 38 | |
| 39 | import static org.slf4j.LoggerFactory.getLogger; |
| 40 | |
| 41 | /** |
| 42 | * The main PIM controller class. |
| 43 | */ |
| 44 | @Component(immediate = true) |
Jonathan Hart | fbfe2a8 | 2016-03-29 11:36:33 -0700 | [diff] [blame] | 45 | public class PimApplication { |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 46 | private final Logger log = getLogger(getClass()); |
| 47 | |
| 48 | // Used to get the appId |
| 49 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 50 | protected CoreService coreService; |
| 51 | |
| 52 | // Our application ID |
| 53 | private static ApplicationId appId; |
| 54 | |
| 55 | // Register to receive PIM packets, used to send packets as well |
| 56 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 57 | protected PacketService packetService; |
| 58 | |
| 59 | // Use the MulticastRouteService to manage incoming PIM Join/Prune state as well as |
| 60 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
| 61 | protected MulticastRouteService ms; |
| 62 | |
| 63 | // Create an instance of the PIM packet handler |
Jonathan Hart | fbfe2a8 | 2016-03-29 11:36:33 -0700 | [diff] [blame] | 64 | protected PimPacketHandler pimPacketHandler; |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 65 | |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 66 | // Provide interfaces to the pimInterface manager as a result of Netconfig updates. |
| 67 | @Reference(cardinality = ReferenceCardinality.MANDATORY_UNARY) |
Jonathan Hart | fbfe2a8 | 2016-03-29 11:36:33 -0700 | [diff] [blame] | 68 | protected PimInterfaceService pimInterfaceManager; |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 69 | |
Jonathan Hart | fbfe2a8 | 2016-03-29 11:36:33 -0700 | [diff] [blame] | 70 | private final PimPacketProcessor processor = new PimPacketProcessor(); |
Jonathan Hart | 36fd31e | 2016-01-28 15:55:31 -0800 | [diff] [blame] | 71 | |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 72 | /** |
| 73 | * Activate the PIM component. |
| 74 | */ |
| 75 | @Activate |
| 76 | public void activate() { |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 77 | // Get our application ID |
| 78 | appId = coreService.registerApplication("org.onosproject.pim"); |
| 79 | |
| 80 | // Build the traffic selector for PIM packets |
| 81 | TrafficSelector.Builder selector = DefaultTrafficSelector.builder(); |
| 82 | selector.matchEthType(Ethernet.TYPE_IPV4); |
| 83 | selector.matchIPProtocol(IPv4.PROTOCOL_PIM); |
| 84 | |
| 85 | // Use the traffic selector to tell the packet service which packets we want. |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 86 | packetService.addProcessor(processor, PacketProcessor.director(5)); |
| 87 | |
Jonathan Hart | 36fd31e | 2016-01-28 15:55:31 -0800 | [diff] [blame] | 88 | packetService.requestPackets(selector.build(), PacketPriority.CONTROL, |
| 89 | appId, Optional.empty()); |
| 90 | |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 91 | // Get a copy of the PIM Packet Handler |
Jonathan Hart | fbfe2a8 | 2016-03-29 11:36:33 -0700 | [diff] [blame] | 92 | pimPacketHandler = new PimPacketHandler(); |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 93 | |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 94 | log.info("Started"); |
| 95 | } |
| 96 | |
| 97 | /** |
| 98 | * Deactivate the PIM component. |
| 99 | */ |
| 100 | @Deactivate |
| 101 | public void deactivate() { |
Jonathan Hart | 36fd31e | 2016-01-28 15:55:31 -0800 | [diff] [blame] | 102 | packetService.removeProcessor(processor); |
| 103 | |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 104 | log.info("Stopped"); |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * The class that will receive PIM packets, sanitize them, determine the PIMInterface |
| 109 | * they arrived on, then forward them on to be processed by the appropriate entity. |
| 110 | */ |
Jonathan Hart | fbfe2a8 | 2016-03-29 11:36:33 -0700 | [diff] [blame] | 111 | public class PimPacketProcessor implements PacketProcessor { |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 112 | |
| 113 | @Override |
| 114 | public void process(PacketContext context) { |
| 115 | |
| 116 | // return if this packet has already been handled |
| 117 | if (context.isHandled()) { |
| 118 | return; |
| 119 | } |
| 120 | |
| 121 | // get the inbound packet |
| 122 | InboundPacket pkt = context.inPacket(); |
| 123 | if (pkt == null) { |
| 124 | // problem getting the inbound pkt. Log it debug to avoid spamming log file |
| 125 | log.debug("Could not retrieve packet from context"); |
| 126 | return; |
| 127 | } |
| 128 | |
| 129 | // Get the ethernet header |
| 130 | Ethernet eth = pkt.parsed(); |
| 131 | if (eth == null) { |
| 132 | // problem getting the ethernet pkt. Log it debug to avoid spamming log file |
Jonathan Hart | 7f4bc52 | 2016-02-20 11:32:43 -0800 | [diff] [blame] | 133 | log.debug("Could not retrieve ethernet packet from the parsed packet"); |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 134 | return; |
| 135 | } |
| 136 | |
| 137 | // Get the PIM Interface the packet was received on. |
Jonathan Hart | fbfe2a8 | 2016-03-29 11:36:33 -0700 | [diff] [blame] | 138 | PimInterface pimi = pimInterfaceManager.getPimInterface(pkt.receivedFrom()); |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 139 | if (pimi == null) { |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 140 | return; |
| 141 | } |
| 142 | |
| 143 | /* |
| 144 | * Pass the packet processing off to the PIMInterface for processing. |
| 145 | * |
| 146 | * TODO: Is it possible that PIM interface processing should move to the |
| 147 | * PIMInterfaceManager directly? |
| 148 | */ |
Jonathan Hart | 7f4bc52 | 2016-02-20 11:32:43 -0800 | [diff] [blame] | 149 | pimPacketHandler.processPacket(eth, pimi); |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 150 | } |
| 151 | } |
| 152 | |
Rusty Eddy | 4ae5aa8 | 2015-12-15 12:58:27 -0800 | [diff] [blame] | 153 | } |