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