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