sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
sangho | 1e57565 | 2015-05-14 00:39:53 -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 | */ |
| 16 | package org.onosproject.segmentrouting; |
| 17 | |
Pier | b1fe738 | 2018-04-17 17:25:22 +0200 | [diff] [blame] | 18 | import com.google.common.collect.Multimap; |
Pier Luigi | b29144d | 2018-01-15 18:06:43 +0100 | [diff] [blame] | 19 | import org.onlab.packet.IpAddress; |
Pier Ventre | 10bd8d1 | 2016-11-26 21:05:22 -0800 | [diff] [blame] | 20 | import org.onlab.packet.IpPrefix; |
Pier | 96f63cb | 2018-04-17 16:29:56 +0200 | [diff] [blame] | 21 | import org.onosproject.cluster.NodeId; |
Pier Luigi | b29144d | 2018-01-15 18:06:43 +0100 | [diff] [blame] | 22 | import org.onosproject.net.ConnectPoint; |
Charles Chan | c81c45b | 2016-10-20 17:02:44 -0700 | [diff] [blame] | 23 | import org.onosproject.net.DeviceId; |
Saurav Das | c568c34 | 2018-01-25 09:49:01 -0800 | [diff] [blame] | 24 | import org.onosproject.net.Link; |
| 25 | import org.onosproject.net.PortNumber; |
Saurav Das | 7bcbe70 | 2017-06-13 15:35:54 -0700 | [diff] [blame] | 26 | import org.onosproject.segmentrouting.grouphandler.NextNeighbors; |
Pier Luigi | 96fe077 | 2018-02-28 12:10:50 +0100 | [diff] [blame] | 27 | import org.onosproject.segmentrouting.mcast.McastRole; |
Pier | 3e79375 | 2018-04-19 16:47:06 +0200 | [diff] [blame] | 28 | import org.onosproject.segmentrouting.mcast.McastRoleStoreKey; |
Andreas Pantelopoulos | ff691b7 | 2018-03-12 16:30:20 -0700 | [diff] [blame] | 29 | import org.onosproject.segmentrouting.pwaas.DefaultL2TunnelDescription; |
Andreas Pantelopoulos | b21547d | 2018-02-22 12:32:42 -0800 | [diff] [blame] | 30 | import org.onosproject.segmentrouting.pwaas.L2Tunnel; |
Andreas Pantelopoulos | 27532cd | 2017-10-23 12:18:25 -0700 | [diff] [blame] | 31 | import org.onosproject.segmentrouting.pwaas.L2TunnelHandler; |
Andreas Pantelopoulos | b21547d | 2018-02-22 12:32:42 -0800 | [diff] [blame] | 32 | import org.onosproject.segmentrouting.pwaas.L2TunnelPolicy; |
Andreas Pantelopoulos | cd33959 | 2018-02-23 14:18:00 -0800 | [diff] [blame] | 33 | import org.onosproject.segmentrouting.pwaas.L2TunnelDescription; |
Saurav Das | 7bcbe70 | 2017-06-13 15:35:54 -0700 | [diff] [blame] | 34 | import org.onosproject.segmentrouting.storekey.DestinationSetNextObjectiveStoreKey; |
Saurav Das | c88d466 | 2017-05-15 15:34:25 -0700 | [diff] [blame] | 35 | |
| 36 | import com.google.common.collect.ImmutableMap; |
Pier | 3e79375 | 2018-04-19 16:47:06 +0200 | [diff] [blame] | 37 | import org.onosproject.segmentrouting.mcast.McastStoreKey; |
Charles Chan | c81c45b | 2016-10-20 17:02:44 -0700 | [diff] [blame] | 38 | |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 39 | import java.util.List; |
Charles Chan | c81c45b | 2016-10-20 17:02:44 -0700 | [diff] [blame] | 40 | import java.util.Map; |
| 41 | import java.util.Set; |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 42 | |
| 43 | /** |
| 44 | * Segment Routing Service for REST API. |
| 45 | */ |
| 46 | public interface SegmentRoutingService { |
Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 47 | /** |
Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 48 | * VLAN cross-connect priority. |
| 49 | */ |
| 50 | int XCONNECT_PRIORITY = 1000; |
| 51 | |
| 52 | /** |
| 53 | * Default flow priority. |
| 54 | */ |
| 55 | int DEFAULT_PRIORITY = 100; |
| 56 | |
| 57 | /** |
| 58 | * Minimum IP priority. |
| 59 | * |
Charles Chan | b54e8ba | 2016-02-18 10:43:46 -0800 | [diff] [blame] | 60 | * Should < 0 such that priority of /0 will not conflict with lowest |
Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 61 | * priority default entries. |
| 62 | */ |
| 63 | int MIN_IP_PRIORITY = 10; |
| 64 | |
| 65 | /** |
| 66 | * Subnet flooding flow priority. |
| 67 | */ |
| 68 | int FLOOD_PRIORITY = 5; |
| 69 | |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 70 | /** |
| 71 | * Returns all tunnels. |
| 72 | * |
| 73 | * @return list of tunnels |
| 74 | */ |
| 75 | List<Tunnel> getTunnels(); |
| 76 | |
| 77 | /** |
| 78 | * Creates a tunnel. |
| 79 | * |
| 80 | * @param tunnel tunnel reference to create |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 81 | * @return WRONG_PATH if the tunnel path is wrong, ID_EXISTS if the tunnel ID |
| 82 | * exists already, TUNNEL_EXISTS if the same tunnel exists, INTERNAL_ERROR |
| 83 | * if the tunnel creation failed internally, SUCCESS if the tunnel is created |
| 84 | * successfully |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 85 | */ |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 86 | TunnelHandler.Result createTunnel(Tunnel tunnel); |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 87 | |
| 88 | /** |
| 89 | * Returns all policies. |
| 90 | * |
| 91 | * @return list of policy |
| 92 | */ |
| 93 | List<Policy> getPolicies(); |
| 94 | |
| 95 | /** |
Andreas Pantelopoulos | ff691b7 | 2018-03-12 16:30:20 -0700 | [diff] [blame] | 96 | * Returns the l2 tunnel descriptions. |
| 97 | * |
Andreas Pantelopoulos | 811bbae | 2018-03-15 16:56:09 -0700 | [diff] [blame] | 98 | * @param pending if true fetch pending pseudowires, else fetch installed |
Andreas Pantelopoulos | ff691b7 | 2018-03-12 16:30:20 -0700 | [diff] [blame] | 99 | * @return set of l2 tunnel descriptions. |
| 100 | */ |
Andreas Pantelopoulos | 811bbae | 2018-03-15 16:56:09 -0700 | [diff] [blame] | 101 | Set<L2TunnelDescription> getL2TunnelDescriptions(boolean pending); |
Andreas Pantelopoulos | ff691b7 | 2018-03-12 16:30:20 -0700 | [diff] [blame] | 102 | |
| 103 | /** |
Andreas Pantelopoulos | 27532cd | 2017-10-23 12:18:25 -0700 | [diff] [blame] | 104 | * Returns all l2 tunnels of pseudowires. |
| 105 | * |
| 106 | * @return list of l2 tunnels |
| 107 | */ |
Andreas Pantelopoulos | b21547d | 2018-02-22 12:32:42 -0800 | [diff] [blame] | 108 | List<L2Tunnel> getL2Tunnels(); |
Andreas Pantelopoulos | 27532cd | 2017-10-23 12:18:25 -0700 | [diff] [blame] | 109 | |
| 110 | /** |
| 111 | * Returns all l2 policie of pseudowires. |
| 112 | * |
| 113 | * @return list of l2 policies. |
| 114 | */ |
Andreas Pantelopoulos | b21547d | 2018-02-22 12:32:42 -0800 | [diff] [blame] | 115 | List<L2TunnelPolicy> getL2Policies(); |
Andreas Pantelopoulos | 27532cd | 2017-10-23 12:18:25 -0700 | [diff] [blame] | 116 | |
| 117 | /** |
Andreas Pantelopoulos | ff691b7 | 2018-03-12 16:30:20 -0700 | [diff] [blame] | 118 | * Removes pseudowire. |
Andreas Pantelopoulos | 27532cd | 2017-10-23 12:18:25 -0700 | [diff] [blame] | 119 | * |
Andreas Pantelopoulos | cd33959 | 2018-02-23 14:18:00 -0800 | [diff] [blame] | 120 | * @param pwId The id of the pseudowire. |
Andreas Pantelopoulos | 27532cd | 2017-10-23 12:18:25 -0700 | [diff] [blame] | 121 | * @return SUCCESS if operation successful or a descriptive error otherwise. |
| 122 | */ |
Andreas Pantelopoulos | cd33959 | 2018-02-23 14:18:00 -0800 | [diff] [blame] | 123 | L2TunnelHandler.Result removePseudowire(Integer pwId); |
Andreas Pantelopoulos | 27532cd | 2017-10-23 12:18:25 -0700 | [diff] [blame] | 124 | |
| 125 | /** |
Andreas Pantelopoulos | ff691b7 | 2018-03-12 16:30:20 -0700 | [diff] [blame] | 126 | * Adds a Pseudowire to the system. |
Andreas Pantelopoulos | 27532cd | 2017-10-23 12:18:25 -0700 | [diff] [blame] | 127 | * |
Andreas Pantelopoulos | cd33959 | 2018-02-23 14:18:00 -0800 | [diff] [blame] | 128 | * @param tunnel The pseudowire tunnel. |
Andreas Pantelopoulos | 27532cd | 2017-10-23 12:18:25 -0700 | [diff] [blame] | 129 | * @return SUCCESS if operation is successful or a descriptive error otherwise. |
| 130 | */ |
Andreas Pantelopoulos | cd33959 | 2018-02-23 14:18:00 -0800 | [diff] [blame] | 131 | L2TunnelHandler.Result addPseudowire(L2TunnelDescription tunnel); |
Andreas Pantelopoulos | 27532cd | 2017-10-23 12:18:25 -0700 | [diff] [blame] | 132 | |
| 133 | /** |
Andreas Pantelopoulos | ffe6974 | 2018-03-20 13:58:49 -0700 | [diff] [blame] | 134 | * Adds a set of pseudowires. |
| 135 | * |
| 136 | * |
Andreas Pantelopoulos | ff691b7 | 2018-03-12 16:30:20 -0700 | [diff] [blame] | 137 | * @param l2TunnelDescriptions The pseudowires to add. |
| 138 | * @return SUCCESS if ALL pseudowires can be instantiated and are deployed, or a |
| 139 | * a descriptive error otherwise, without deploying any pseudowire. |
Andreas Pantelopoulos | ffe6974 | 2018-03-20 13:58:49 -0700 | [diff] [blame] | 140 | * @deprecated onos-1.12 use addPseudowire instead |
Andreas Pantelopoulos | ff691b7 | 2018-03-12 16:30:20 -0700 | [diff] [blame] | 141 | */ |
Andreas Pantelopoulos | ffe6974 | 2018-03-20 13:58:49 -0700 | [diff] [blame] | 142 | @Deprecated |
Andreas Pantelopoulos | ff691b7 | 2018-03-12 16:30:20 -0700 | [diff] [blame] | 143 | L2TunnelHandler.Result addPseudowiresBulk(List<DefaultL2TunnelDescription> l2TunnelDescriptions); |
| 144 | |
| 145 | /** |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 146 | * Creates a policy. |
| 147 | * |
| 148 | * @param policy policy reference to create |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 149 | * @return ID_EXISTS if the same policy ID exists, |
| 150 | * POLICY_EXISTS if the same policy exists, TUNNEL_NOT_FOUND if the tunnel |
| 151 | * does not exists, UNSUPPORTED_TYPE if the policy type is not supported, |
| 152 | * SUCCESS if the policy is created successfully. |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 153 | */ |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 154 | PolicyHandler.Result createPolicy(Policy policy); |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 155 | |
| 156 | /** |
| 157 | * Removes a tunnel. |
| 158 | * |
| 159 | * @param tunnel tunnel reference to remove |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 160 | * @return TUNNEL_NOT_FOUND if the tunnel to remove does not exists, |
| 161 | * INTERNAL_ERROR if the tunnel creation failed internally, SUCCESS |
| 162 | * if the tunnel is created successfully. |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 163 | */ |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 164 | TunnelHandler.Result removeTunnel(Tunnel tunnel); |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 165 | |
| 166 | /** |
| 167 | * Removes a policy. |
| 168 | * |
| 169 | * @param policy policy reference to remove |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 170 | * @return POLICY_NOT_FOUND if the policy to remove does not exists, |
| 171 | * SUCCESS if it is removed successfully |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 172 | */ |
sangho | 71abe1b | 2015-06-29 14:58:47 -0700 | [diff] [blame] | 173 | PolicyHandler.Result removePolicy(Policy policy); |
Saurav Das | 59232cf | 2016-04-27 18:35:50 -0700 | [diff] [blame] | 174 | |
| 175 | /** |
| 176 | * Use current state of the network to repopulate forwarding rules. |
| 177 | * |
| 178 | */ |
| 179 | void rerouteNetwork(); |
Charles Chan | c81c45b | 2016-10-20 17:02:44 -0700 | [diff] [blame] | 180 | |
| 181 | /** |
| 182 | * Returns device-subnet mapping. |
| 183 | * |
| 184 | * @return device-subnet mapping |
| 185 | */ |
Pier Ventre | 10bd8d1 | 2016-11-26 21:05:22 -0800 | [diff] [blame] | 186 | Map<DeviceId, Set<IpPrefix>> getDeviceSubnetMap(); |
Saurav Das | c88d466 | 2017-05-15 15:34:25 -0700 | [diff] [blame] | 187 | |
| 188 | /** |
| 189 | * Returns the current ECMP shortest path graph in this controller instance. |
| 190 | * |
| 191 | * @return ECMP shortest path graph |
| 192 | */ |
| 193 | ImmutableMap<DeviceId, EcmpShortestPathGraph> getCurrentEcmpSpg(); |
| 194 | |
| 195 | /** |
Saurav Das | 7bcbe70 | 2017-06-13 15:35:54 -0700 | [diff] [blame] | 196 | * Returns the destinatiomSet-NextObjective store contents. |
Saurav Das | c88d466 | 2017-05-15 15:34:25 -0700 | [diff] [blame] | 197 | * |
Saurav Das | 7bcbe70 | 2017-06-13 15:35:54 -0700 | [diff] [blame] | 198 | * @return current contents of the destinationSetNextObjectiveStore |
Saurav Das | c88d466 | 2017-05-15 15:34:25 -0700 | [diff] [blame] | 199 | */ |
Saurav Das | 7bcbe70 | 2017-06-13 15:35:54 -0700 | [diff] [blame] | 200 | ImmutableMap<DestinationSetNextObjectiveStoreKey, NextNeighbors> getDestinationSet(); |
Saurav Das | ceccf24 | 2017-08-03 18:30:35 -0700 | [diff] [blame] | 201 | |
| 202 | /** |
| 203 | * Triggers the verification of all ECMP groups in the specified device. |
| 204 | * Adjusts the group buckets if verification finds that there are more or less |
| 205 | * buckets than what should be there. |
| 206 | * |
| 207 | * @param id the device identifier |
| 208 | */ |
| 209 | void verifyGroups(DeviceId id); |
Saurav Das | c568c34 | 2018-01-25 09:49:01 -0800 | [diff] [blame] | 210 | |
| 211 | /** |
| 212 | * Returns the internal link state as seen by this instance of the |
| 213 | * controller. |
| 214 | * |
| 215 | * @return the internal link state |
| 216 | */ |
| 217 | ImmutableMap<Link, Boolean> getSeenLinks(); |
| 218 | |
| 219 | /** |
| 220 | * Returns the ports administratively disabled by the controller. |
| 221 | * |
| 222 | * @return a map of devices and port numbers for administratively disabled |
| 223 | * ports. Does not include ports manually disabled by the operator. |
| 224 | */ |
| 225 | ImmutableMap<DeviceId, Set<PortNumber>> getDownedPortState(); |
Pier Luigi | b29144d | 2018-01-15 18:06:43 +0100 | [diff] [blame] | 226 | |
Pier | 3e79375 | 2018-04-19 16:47:06 +0200 | [diff] [blame] | 227 | /** |
Pier Luigi | b29144d | 2018-01-15 18:06:43 +0100 | [diff] [blame] | 228 | * Returns the associated next ids to the mcast groups or to the single |
| 229 | * group if mcastIp is present. |
| 230 | * |
| 231 | * @param mcastIp the group ip |
| 232 | * @return the mapping mcastIp-device to next id |
| 233 | */ |
| 234 | Map<McastStoreKey, Integer> getMcastNextIds(IpAddress mcastIp); |
| 235 | |
| 236 | /** |
| 237 | * Returns the associated roles to the mcast groups or to the single |
| 238 | * group if mcastIp is present. |
| 239 | * |
| 240 | * @param mcastIp the group ip |
| 241 | * @return the mapping mcastIp-device to mcast role |
Pier | b1fe738 | 2018-04-17 17:25:22 +0200 | [diff] [blame] | 242 | * |
| 243 | * @deprecated in 1.12 ("Magpie") release. |
Pier Luigi | b29144d | 2018-01-15 18:06:43 +0100 | [diff] [blame] | 244 | */ |
Pier | b1fe738 | 2018-04-17 17:25:22 +0200 | [diff] [blame] | 245 | @Deprecated |
Pier Luigi | 96fe077 | 2018-02-28 12:10:50 +0100 | [diff] [blame] | 246 | Map<McastStoreKey, McastRole> getMcastRoles(IpAddress mcastIp); |
Pier Luigi | b29144d | 2018-01-15 18:06:43 +0100 | [diff] [blame] | 247 | |
| 248 | /** |
Pier | 3e79375 | 2018-04-19 16:47:06 +0200 | [diff] [blame] | 249 | * Returns the associated roles to the mcast groups. |
| 250 | * |
| 251 | * @param mcastIp the group ip |
| 252 | * @param sourcecp the source connect point |
| 253 | * @return the mapping mcastIp-device to mcast role |
| 254 | */ |
| 255 | Map<McastRoleStoreKey, McastRole> getMcastRoles(IpAddress mcastIp, |
| 256 | ConnectPoint sourcecp); |
| 257 | |
| 258 | /** |
Pier Luigi | b29144d | 2018-01-15 18:06:43 +0100 | [diff] [blame] | 259 | * Returns the associated paths to the mcast group. |
| 260 | * |
| 261 | * @param mcastIp the group ip |
| 262 | * @return the mapping egress point to mcast path |
Pier | b1fe738 | 2018-04-17 17:25:22 +0200 | [diff] [blame] | 263 | * |
| 264 | * @deprecated in 1.12 ("Magpie") release. |
Pier Luigi | b29144d | 2018-01-15 18:06:43 +0100 | [diff] [blame] | 265 | */ |
Pier | b1fe738 | 2018-04-17 17:25:22 +0200 | [diff] [blame] | 266 | @Deprecated |
Pier Luigi | b29144d | 2018-01-15 18:06:43 +0100 | [diff] [blame] | 267 | Map<ConnectPoint, List<ConnectPoint>> getMcastPaths(IpAddress mcastIp); |
| 268 | |
Pier | b1fe738 | 2018-04-17 17:25:22 +0200 | [diff] [blame] | 269 | /** |
| 270 | * Returns the associated trees to the mcast group. |
| 271 | * |
| 272 | * @param mcastIp the group ip |
| 273 | * @param sourcecp the source connect point |
| 274 | * @return the mapping egress point to mcast path |
| 275 | */ |
| 276 | Multimap<ConnectPoint, List<ConnectPoint>> getMcastTrees(IpAddress mcastIp, |
| 277 | ConnectPoint sourcecp); |
| 278 | |
Pier | 96f63cb | 2018-04-17 16:29:56 +0200 | [diff] [blame] | 279 | /** |
| 280 | * Return the leaders of the mcast groups. |
| 281 | * |
| 282 | * @param mcastIp the group ip |
| 283 | * @return the mapping group-node |
| 284 | */ |
| 285 | Map<IpAddress, NodeId> getMcastLeaders(IpAddress mcastIp); |
Charles Chan | 8bc75ee | 2018-04-17 18:56:53 -0700 | [diff] [blame] | 286 | |
| 287 | /** |
| 288 | * Returns shouldProgram map. |
| 289 | * |
| 290 | * @return shouldProgram map |
| 291 | */ |
| 292 | Map<Set<DeviceId>, NodeId> getShouldProgram(); |
| 293 | |
| 294 | /** |
| 295 | * Returns shouldProgram local cache. |
| 296 | * |
| 297 | * @return shouldProgram local cache |
| 298 | */ |
| 299 | Map<DeviceId, Boolean> getShouldProgramCache(); |
sangho | 1e57565 | 2015-05-14 00:39:53 -0700 | [diff] [blame] | 300 | } |