Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2016-present Open Networking Foundation |
Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -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 | |
| 17 | package org.onosproject.segmentrouting.config; |
| 18 | |
| 19 | import com.fasterxml.jackson.databind.JsonNode; |
| 20 | import com.fasterxml.jackson.databind.node.ArrayNode; |
| 21 | import com.google.common.collect.ImmutableSet; |
Andrea Campanella | d980c6d | 2018-04-30 11:48:55 +0200 | [diff] [blame^] | 22 | import org.onlab.packet.IpPrefix; |
Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 23 | import org.onlab.packet.MacAddress; |
| 24 | import org.onosproject.core.ApplicationId; |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 25 | import org.onosproject.net.ConnectPoint; |
Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 26 | import org.onosproject.net.config.Config; |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 27 | |
Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 28 | import java.util.Set; |
| 29 | |
| 30 | import static com.google.common.base.MoreObjects.toStringHelper; |
| 31 | |
| 32 | /** |
| 33 | * App configuration object for Segment Routing. |
| 34 | */ |
| 35 | public class SegmentRoutingAppConfig extends Config<ApplicationId> { |
| 36 | private static final String VROUTER_MACS = "vRouterMacs"; |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 37 | private static final String SUPPRESS_SUBNET = "suppressSubnet"; |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 38 | private static final String SUPPRESS_HOST_BY_PORT = "suppressHostByPort"; |
| 39 | // TODO We might want to move SUPPRESS_HOST_BY_PROVIDER to Component Config |
| 40 | private static final String SUPPRESS_HOST_BY_PROVIDER = "suppressHostByProvider"; |
Pier Ventre | 9816178 | 2016-10-31 15:00:01 -0700 | [diff] [blame] | 41 | private static final String MPLS_ECMP = "MPLS-ECMP"; |
Andrea Campanella | d980c6d | 2018-04-30 11:48:55 +0200 | [diff] [blame^] | 42 | private static final String BLACKHOLE_IPS = "blackholeIps"; |
Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 43 | |
| 44 | @Override |
| 45 | public boolean isValid() { |
Charles Chan | 03a73e0 | 2016-10-24 14:52:01 -0700 | [diff] [blame] | 46 | return hasOnlyFields(VROUTER_MACS, SUPPRESS_SUBNET, |
Andrea Campanella | d980c6d | 2018-04-30 11:48:55 +0200 | [diff] [blame^] | 47 | SUPPRESS_HOST_BY_PORT, SUPPRESS_HOST_BY_PROVIDER, MPLS_ECMP, BLACKHOLE_IPS) && |
Charles Chan | 03a73e0 | 2016-10-24 14:52:01 -0700 | [diff] [blame] | 48 | vRouterMacs() != null && |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 49 | suppressSubnet() != null && suppressHostByPort() != null && |
Andrea Campanella | d980c6d | 2018-04-30 11:48:55 +0200 | [diff] [blame^] | 50 | suppressHostByProvider() != null && |
| 51 | blackholeIPs() != null; |
| 52 | } |
| 53 | |
| 54 | /** |
| 55 | * Gets ips to blackhole from the config. |
| 56 | * |
| 57 | * @return Set of ips to blackhole, empty is not specified, |
| 58 | * or null if not valid |
| 59 | */ |
| 60 | public Set<IpPrefix> blackholeIPs() { |
| 61 | if (!object.has(BLACKHOLE_IPS)) { |
| 62 | return ImmutableSet.of(); |
| 63 | } |
| 64 | |
| 65 | ImmutableSet.Builder<IpPrefix> builder = ImmutableSet.builder(); |
| 66 | ArrayNode arrayNode = (ArrayNode) object.path(BLACKHOLE_IPS); |
| 67 | for (JsonNode jsonNode : arrayNode) { |
| 68 | IpPrefix address; |
| 69 | |
| 70 | String addrStr = jsonNode.asText(null); |
| 71 | if (addrStr == null) { |
| 72 | return null; |
| 73 | } |
| 74 | try { |
| 75 | address = IpPrefix.valueOf(addrStr); |
| 76 | } catch (IllegalArgumentException e) { |
| 77 | return null; |
| 78 | } |
| 79 | |
| 80 | builder.add(address); |
| 81 | } |
| 82 | return builder.build(); |
| 83 | } |
| 84 | |
| 85 | /** |
| 86 | * Sets ips to blackhole to the config. |
| 87 | * |
| 88 | * @param blackholeIps a set of ips to blackhole |
| 89 | * @return this {@link SegmentRoutingAppConfig} |
| 90 | */ |
| 91 | public SegmentRoutingAppConfig setBalckholeIps(Set<IpPrefix> blackholeIps) { |
| 92 | if (blackholeIps == null) { |
| 93 | object.remove(BLACKHOLE_IPS); |
| 94 | } else { |
| 95 | ArrayNode arrayNode = mapper.createArrayNode(); |
| 96 | |
| 97 | blackholeIps.forEach(ip -> { |
| 98 | arrayNode.add(ip.toString()); |
| 99 | }); |
| 100 | |
| 101 | object.set(BLACKHOLE_IPS, arrayNode); |
| 102 | } |
| 103 | return this; |
Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 104 | } |
| 105 | |
| 106 | /** |
Pier Ventre | 9816178 | 2016-10-31 15:00:01 -0700 | [diff] [blame] | 107 | * Gets MPLS-ECMP configuration from the config. |
| 108 | * |
| 109 | * @return the configuration of MPLS-ECMP. If it is not |
| 110 | * specified, the default behavior is false. |
| 111 | */ |
| 112 | public boolean mplsEcmp() { |
| 113 | return get(MPLS_ECMP, false); |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Sets MPLS-ECMP to the config. |
| 118 | * |
| 119 | * @param mplsEcmp the MPLS-ECMP configuration |
| 120 | * @return this {@link SegmentRoutingAppConfig} |
| 121 | */ |
| 122 | public SegmentRoutingAppConfig setMplsEcmp(boolean mplsEcmp) { |
| 123 | object.put(MPLS_ECMP, mplsEcmp); |
| 124 | return this; |
| 125 | } |
| 126 | |
| 127 | /** |
Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 128 | * Gets vRouters from the config. |
| 129 | * |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 130 | * @return Set of vRouter MAC addresses, empty is not specified, |
| 131 | * or null if not valid |
Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 132 | */ |
| 133 | public Set<MacAddress> vRouterMacs() { |
| 134 | if (!object.has(VROUTER_MACS)) { |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 135 | return ImmutableSet.of(); |
Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 136 | } |
| 137 | |
| 138 | ImmutableSet.Builder<MacAddress> builder = ImmutableSet.builder(); |
| 139 | ArrayNode arrayNode = (ArrayNode) object.path(VROUTER_MACS); |
| 140 | for (JsonNode jsonNode : arrayNode) { |
| 141 | MacAddress mac; |
| 142 | |
| 143 | String macStr = jsonNode.asText(null); |
| 144 | if (macStr == null) { |
| 145 | return null; |
| 146 | } |
| 147 | try { |
| 148 | mac = MacAddress.valueOf(macStr); |
| 149 | } catch (IllegalArgumentException e) { |
| 150 | return null; |
| 151 | } |
| 152 | |
| 153 | builder.add(mac); |
| 154 | } |
| 155 | return builder.build(); |
| 156 | } |
| 157 | |
| 158 | /** |
| 159 | * Sets vRouters to the config. |
| 160 | * |
| 161 | * @param vRouterMacs a set of vRouter MAC addresses |
| 162 | * @return this {@link SegmentRoutingAppConfig} |
| 163 | */ |
| 164 | public SegmentRoutingAppConfig setVRouterMacs(Set<MacAddress> vRouterMacs) { |
| 165 | if (vRouterMacs == null) { |
| 166 | object.remove(VROUTER_MACS); |
| 167 | } else { |
| 168 | ArrayNode arrayNode = mapper.createArrayNode(); |
| 169 | |
| 170 | vRouterMacs.forEach(mac -> { |
| 171 | arrayNode.add(mac.toString()); |
| 172 | }); |
| 173 | |
| 174 | object.set(VROUTER_MACS, arrayNode); |
| 175 | } |
| 176 | return this; |
| 177 | } |
| 178 | |
Charles Chan | f2565a9 | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 179 | /** |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 180 | * Gets names of ports to which SegmentRouting does not push subnet rules. |
Charles Chan | f2565a9 | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 181 | * |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 182 | * @return Set of port names, empty if not specified, or null |
| 183 | * if not valid |
Charles Chan | f2565a9 | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 184 | */ |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 185 | public Set<ConnectPoint> suppressSubnet() { |
| 186 | if (!object.has(SUPPRESS_SUBNET)) { |
| 187 | return ImmutableSet.of(); |
Charles Chan | f2565a9 | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 188 | } |
| 189 | |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 190 | ImmutableSet.Builder<ConnectPoint> builder = ImmutableSet.builder(); |
| 191 | ArrayNode arrayNode = (ArrayNode) object.path(SUPPRESS_SUBNET); |
Charles Chan | f2565a9 | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 192 | for (JsonNode jsonNode : arrayNode) { |
| 193 | String portName = jsonNode.asText(null); |
| 194 | if (portName == null) { |
| 195 | return null; |
| 196 | } |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 197 | try { |
| 198 | builder.add(ConnectPoint.deviceConnectPoint(portName)); |
| 199 | } catch (IllegalArgumentException e) { |
| 200 | return null; |
| 201 | } |
Charles Chan | f2565a9 | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 202 | } |
| 203 | return builder.build(); |
| 204 | } |
| 205 | |
| 206 | /** |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 207 | * Sets names of ports to which SegmentRouting does not push subnet rules. |
Charles Chan | f2565a9 | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 208 | * |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 209 | * @param suppressSubnet names of ports to which SegmentRouting does not push |
| 210 | * subnet rules |
Charles Chan | f2565a9 | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 211 | * @return this {@link SegmentRoutingAppConfig} |
| 212 | */ |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 213 | public SegmentRoutingAppConfig setSuppressSubnet(Set<ConnectPoint> suppressSubnet) { |
| 214 | if (suppressSubnet == null) { |
| 215 | object.remove(SUPPRESS_SUBNET); |
Charles Chan | f2565a9 | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 216 | } else { |
| 217 | ArrayNode arrayNode = mapper.createArrayNode(); |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 218 | suppressSubnet.forEach(connectPoint -> { |
| 219 | arrayNode.add(connectPoint.deviceId() + "/" + connectPoint.port()); |
Charles Chan | f2565a9 | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 220 | }); |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 221 | object.set(SUPPRESS_SUBNET, arrayNode); |
| 222 | } |
| 223 | return this; |
| 224 | } |
| 225 | |
| 226 | /** |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 227 | * Gets connect points to which SegmentRouting does not push host rules. |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 228 | * |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 229 | * @return Set of connect points, empty if not specified, or null |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 230 | * if not valid |
| 231 | */ |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 232 | public Set<ConnectPoint> suppressHostByPort() { |
| 233 | if (!object.has(SUPPRESS_HOST_BY_PORT)) { |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 234 | return ImmutableSet.of(); |
| 235 | } |
| 236 | |
| 237 | ImmutableSet.Builder<ConnectPoint> builder = ImmutableSet.builder(); |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 238 | ArrayNode arrayNode = (ArrayNode) object.path(SUPPRESS_HOST_BY_PORT); |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 239 | for (JsonNode jsonNode : arrayNode) { |
| 240 | String portName = jsonNode.asText(null); |
| 241 | if (portName == null) { |
| 242 | return null; |
| 243 | } |
| 244 | try { |
| 245 | builder.add(ConnectPoint.deviceConnectPoint(portName)); |
| 246 | } catch (IllegalArgumentException e) { |
| 247 | return null; |
| 248 | } |
| 249 | } |
| 250 | return builder.build(); |
| 251 | } |
| 252 | |
| 253 | /** |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 254 | * Sets connect points to which SegmentRouting does not push host rules. |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 255 | * |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 256 | * @param connectPoints connect points to which SegmentRouting does not push |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 257 | * host rules |
| 258 | * @return this {@link SegmentRoutingAppConfig} |
| 259 | */ |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 260 | public SegmentRoutingAppConfig setSuppressHostByPort(Set<ConnectPoint> connectPoints) { |
| 261 | if (connectPoints == null) { |
| 262 | object.remove(SUPPRESS_HOST_BY_PORT); |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 263 | } else { |
| 264 | ArrayNode arrayNode = mapper.createArrayNode(); |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 265 | connectPoints.forEach(connectPoint -> { |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 266 | arrayNode.add(connectPoint.deviceId() + "/" + connectPoint.port()); |
| 267 | }); |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 268 | object.set(SUPPRESS_HOST_BY_PORT, arrayNode); |
Charles Chan | f2565a9 | 2016-02-10 20:46:58 -0800 | [diff] [blame] | 269 | } |
| 270 | return this; |
| 271 | } |
| 272 | |
Charles Chan | 6ea94fc | 2016-05-10 17:29:47 -0700 | [diff] [blame] | 273 | /** |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 274 | * Gets provider names from which SegmentRouting does not learn host info. |
Charles Chan | 6ea94fc | 2016-05-10 17:29:47 -0700 | [diff] [blame] | 275 | * |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 276 | * @return array of provider names that need to be ignored |
Charles Chan | 6ea94fc | 2016-05-10 17:29:47 -0700 | [diff] [blame] | 277 | */ |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 278 | public Set<String> suppressHostByProvider() { |
| 279 | if (!object.has(SUPPRESS_HOST_BY_PROVIDER)) { |
| 280 | return ImmutableSet.of(); |
| 281 | } |
| 282 | |
| 283 | ImmutableSet.Builder<String> builder = ImmutableSet.builder(); |
| 284 | ArrayNode arrayNode = (ArrayNode) object.path(SUPPRESS_HOST_BY_PROVIDER); |
| 285 | for (JsonNode jsonNode : arrayNode) { |
| 286 | String providerName = jsonNode.asText(null); |
| 287 | if (providerName == null) { |
| 288 | return null; |
| 289 | } |
| 290 | builder.add(providerName); |
| 291 | } |
| 292 | return builder.build(); |
Charles Chan | 6ea94fc | 2016-05-10 17:29:47 -0700 | [diff] [blame] | 293 | } |
| 294 | |
| 295 | /** |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 296 | * Sets provider names from which SegmentRouting does not learn host info. |
Charles Chan | 6ea94fc | 2016-05-10 17:29:47 -0700 | [diff] [blame] | 297 | * |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 298 | * @param providers set of provider names |
Charles Chan | 6ea94fc | 2016-05-10 17:29:47 -0700 | [diff] [blame] | 299 | * @return this {@link SegmentRoutingAppConfig} |
| 300 | */ |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 301 | public SegmentRoutingAppConfig setSuppressHostByProvider(Set<String> providers) { |
| 302 | if (providers == null) { |
| 303 | object.remove(SUPPRESS_HOST_BY_PROVIDER); |
| 304 | } else { |
| 305 | ArrayNode arrayNode = mapper.createArrayNode(); |
| 306 | providers.forEach(arrayNode::add); |
| 307 | object.set(SUPPRESS_HOST_BY_PROVIDER, arrayNode); |
| 308 | } |
Charles Chan | 6ea94fc | 2016-05-10 17:29:47 -0700 | [diff] [blame] | 309 | return this; |
| 310 | } |
| 311 | |
Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 312 | @Override |
| 313 | public String toString() { |
| 314 | return toStringHelper(this) |
| 315 | .add("vRouterMacs", vRouterMacs()) |
Charles Chan | d9681e7 | 2016-02-22 19:27:29 -0800 | [diff] [blame] | 316 | .add("suppressSubnet", suppressSubnet()) |
Charles Chan | b3007e1 | 2016-05-20 10:55:40 -0700 | [diff] [blame] | 317 | .add("suppressHostByPort", suppressHostByPort()) |
| 318 | .add("suppressHostByProvider", suppressHostByProvider()) |
Pier Ventre | 9816178 | 2016-10-31 15:00:01 -0700 | [diff] [blame] | 319 | .add("mplsEcmp", mplsEcmp()) |
Andrea Campanella | d980c6d | 2018-04-30 11:48:55 +0200 | [diff] [blame^] | 320 | .add("blackholeIps", blackholeIPs()) |
Charles Chan | 5270ed0 | 2016-01-30 23:22:37 -0800 | [diff] [blame] | 321 | .toString(); |
| 322 | } |
| 323 | } |