Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2014-present Open Networking Foundation |
Thomas Vachuska | 4f1a60c | 2014-10-28 13:39:07 -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. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 16 | package org.onosproject.net.packet; |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 17 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 18 | import org.onosproject.core.ApplicationId; |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 19 | import org.onosproject.net.DeviceId; |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 20 | import org.onosproject.net.flow.TrafficSelector; |
| 21 | |
Harshada Chaundkar | dcd1b14 | 2019-03-25 17:27:44 -0400 | [diff] [blame] | 22 | import java.util.ArrayList; |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 23 | import java.util.List; |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 24 | import java.util.Optional; |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 25 | |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 26 | /** |
| 27 | * Service for intercepting data plane packets and for emitting synthetic |
| 28 | * outbound packets. |
| 29 | */ |
| 30 | public interface PacketService { |
| 31 | |
| 32 | // TODO: ponder better ordering scheme that does not require absolute numbers |
| 33 | |
| 34 | /** |
| 35 | * Adds the specified processor to the list of packet processors. |
| 36 | * It will be added into the list in the order of priority. The higher |
| 37 | * numbers will be processing the packets after the lower numbers. |
| 38 | * |
| 39 | * @param processor processor to be added |
| 40 | * @param priority priority in the reverse natural order |
| 41 | * @throws java.lang.IllegalArgumentException if a processor with the |
| 42 | * given priority already exists |
| 43 | */ |
alshabib | 369d294 | 2014-09-12 17:59:35 -0700 | [diff] [blame] | 44 | void addProcessor(PacketProcessor processor, int priority); |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 45 | |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 46 | // TODO allow processors to register for particular types of packets |
| 47 | |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 48 | /** |
| 49 | * Removes the specified processor from the processing pipeline. |
| 50 | * |
| 51 | * @param processor packet processor |
| 52 | */ |
| 53 | void removeProcessor(PacketProcessor processor); |
| 54 | |
| 55 | /** |
Harshada Chaundkar | dcd1b14 | 2019-03-25 17:27:44 -0400 | [diff] [blame] | 56 | * Adds the specified filter to the list of packet filters. |
| 57 | * It will be added into the list in the order in which it is added. |
| 58 | * |
| 59 | * @param filter filter to be added |
| 60 | */ |
| 61 | default void addFilter(PacketInFilter filter) {} |
| 62 | |
| 63 | |
| 64 | /** |
| 65 | * Removes the specified filter from the filters list. |
| 66 | * |
| 67 | * @param filter filter to be removed |
| 68 | */ |
| 69 | default void removeFilter(PacketInFilter filter) {} |
| 70 | |
| 71 | /** |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 72 | * Returns priority bindings of all registered packet processor entries. |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 73 | * |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 74 | * @return list of existing packet processor entries |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 75 | */ |
Thomas Vachuska | 924cda4 | 2015-09-22 12:11:27 -0700 | [diff] [blame] | 76 | List<PacketProcessorEntry> getProcessors(); |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 77 | |
| 78 | /** |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 79 | * Requests that packets matching the given selector are punted from the |
| 80 | * dataplane to the controller. |
| 81 | * |
| 82 | * @param selector the traffic selector used to match packets |
| 83 | * @param priority the priority of the rule |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 84 | * @param appId the application ID of the requester |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 85 | */ |
| 86 | void requestPackets(TrafficSelector selector, PacketPriority priority, |
| 87 | ApplicationId appId); |
| 88 | |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 89 | |
| 90 | /** |
| 91 | * Requests that packets matching the given selector are punted from the |
| 92 | * dataplane to the controller. If a deviceId is specified then the |
| 93 | * packet request is only installed at the device represented by that |
| 94 | * deviceId. |
| 95 | * |
| 96 | * @param selector the traffic selector used to match packets |
| 97 | * @param priority the priority of the rule |
| 98 | * @param appId the application ID of the requester |
| 99 | * @param deviceId an optional deviceId |
| 100 | */ |
| 101 | void requestPackets(TrafficSelector selector, PacketPriority priority, |
| 102 | ApplicationId appId, Optional<DeviceId> deviceId); |
| 103 | |
Saurav Das | c313c40 | 2015-02-27 10:09:47 -0800 | [diff] [blame] | 104 | /** |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 105 | * Cancels previous packet requests for packets matching the given |
| 106 | * selector to be punted from the dataplane to the controller. |
Saurav Das | c313c40 | 2015-02-27 10:09:47 -0800 | [diff] [blame] | 107 | * |
| 108 | * @param selector the traffic selector used to match packets |
| 109 | * @param priority the priority of the rule |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 110 | * @param appId the application ID of the requester |
Saurav Das | c313c40 | 2015-02-27 10:09:47 -0800 | [diff] [blame] | 111 | */ |
Thomas Vachuska | 27bee09 | 2015-06-23 19:03:10 -0700 | [diff] [blame] | 112 | void cancelPackets(TrafficSelector selector, PacketPriority priority, |
| 113 | ApplicationId appId); |
Jonathan Hart | 3cfce8e | 2015-01-14 16:43:27 -0800 | [diff] [blame] | 114 | |
| 115 | /** |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 116 | * Cancels previous packet requests for packets matching the given |
| 117 | * selector to be punted from the dataplane to the controller. If a |
| 118 | * deviceId is specified then the packet request is only withdrawn from |
| 119 | * the device represented by that deviceId. |
| 120 | * |
| 121 | * @param selector the traffic selector used to match packets |
| 122 | * @param priority the priority of the rule |
| 123 | * @param appId the application ID of the requester |
| 124 | * @param deviceId an optional deviceId |
| 125 | */ |
| 126 | void cancelPackets(TrafficSelector selector, PacketPriority priority, |
| 127 | ApplicationId appId, Optional<DeviceId> deviceId); |
| 128 | |
alshabib | 19e2cea | 2015-12-07 11:31:49 -0800 | [diff] [blame] | 129 | /** |
Thomas Vachuska | 7f171b2 | 2015-08-21 12:49:08 -0700 | [diff] [blame] | 130 | * Returns list of all existing requests ordered by priority. |
| 131 | * |
| 132 | * @return list of existing packet requests |
| 133 | */ |
| 134 | List<PacketRequest> getRequests(); |
| 135 | |
| 136 | /** |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 137 | * Emits the specified outbound packet onto the network. |
| 138 | * |
| 139 | * @param packet outbound packet |
| 140 | */ |
| 141 | void emit(OutboundPacket packet); |
| 142 | |
Harshada Chaundkar | dcd1b14 | 2019-03-25 17:27:44 -0400 | [diff] [blame] | 143 | /** |
| 144 | * Get the list of packet filters present in ONOS. |
| 145 | * |
| 146 | * @return List of packet filters |
| 147 | */ |
| 148 | default List<PacketInFilter> getFilters() { |
| 149 | return new ArrayList<>(); |
| 150 | } |
| 151 | |
| 152 | /** |
| 153 | * Clear all packet filters in one shot. |
| 154 | * |
| 155 | */ |
| 156 | default void clearFilters() {} |
| 157 | |
| 158 | |
tom | 613d814 | 2014-09-11 15:09:37 -0700 | [diff] [blame] | 159 | } |