Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -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.net.link.impl; |
| 17 | |
| 18 | import static org.slf4j.LoggerFactory.getLogger; |
Ayaka Koshibe | 2c59acf | 2015-09-08 15:37:47 -0700 | [diff] [blame] | 19 | import static com.google.common.base.Preconditions.checkNotNull; |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 20 | |
| 21 | import java.time.Duration; |
| 22 | |
| 23 | import org.onosproject.net.AnnotationKeys; |
Ray Milkey | a412236 | 2015-08-18 15:19:08 -0700 | [diff] [blame] | 24 | import org.onosproject.net.config.ConfigOperator; |
Thomas Vachuska | 4998caa | 2015-08-26 13:28:38 -0700 | [diff] [blame] | 25 | import org.onosproject.net.config.basics.BasicLinkConfig; |
Ayaka Koshibe | 2c59acf | 2015-09-08 15:37:47 -0700 | [diff] [blame] | 26 | import org.onosproject.net.ConnectPoint; |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 27 | import org.onosproject.net.DefaultAnnotations; |
| 28 | import org.onosproject.net.Link; |
| 29 | import org.onosproject.net.SparseAnnotations; |
| 30 | import org.onosproject.net.link.DefaultLinkDescription; |
| 31 | import org.onosproject.net.link.LinkDescription; |
| 32 | import org.slf4j.Logger; |
| 33 | |
| 34 | /** |
| 35 | * Implementations of merge policies for various sources of link configuration |
| 36 | * information. This includes applications, provides, and network configurations. |
| 37 | */ |
Ayaka Koshibe | 5373e76 | 2015-08-06 12:31:44 -0700 | [diff] [blame] | 38 | public final class BasicLinkOperator implements ConfigOperator { |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 39 | |
Ayaka Koshibe | 5373e76 | 2015-08-06 12:31:44 -0700 | [diff] [blame] | 40 | private static final long DEF_BANDWIDTH = -1L; |
Aaron Dunlap | 239ea5c | 2020-02-26 12:10:31 -0600 | [diff] [blame] | 41 | private static final double DEF_JITTER = -1.0; |
| 42 | private static final double DEF_DELAY = -1.0; |
| 43 | private static final double DEF_LOSS = -1.0; |
| 44 | private static final double DEF_AVAILABILITY = -1.0; |
| 45 | private static final double DEF_FLAPPING = -1.0; |
Thomas Vachuska | 41fe1ec | 2015-12-03 23:17:02 -0800 | [diff] [blame] | 46 | private static final double DEF_METRIC = -1; |
Ayaka Koshibe | 5373e76 | 2015-08-06 12:31:44 -0700 | [diff] [blame] | 47 | private static final Duration DEF_DURATION = Duration.ofNanos(-1L); |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 48 | private static final Logger log = getLogger(BasicLinkOperator.class); |
| 49 | |
| 50 | private BasicLinkOperator() { |
| 51 | } |
| 52 | |
| 53 | /** |
| 54 | * Generates a LinkDescription containing fields from a LinkDescription and |
| 55 | * a LinkConfig. |
| 56 | * |
| 57 | * @param cfg the link config entity from network config |
| 58 | * @param descr a LinkDescription |
| 59 | * @return LinkDescription based on both sources |
| 60 | */ |
| 61 | public static LinkDescription combine(BasicLinkConfig cfg, LinkDescription descr) { |
| 62 | if (cfg == null) { |
| 63 | return descr; |
| 64 | } |
| 65 | |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 66 | Link.Type type = descr.type(); |
Yuta HIGUCHI | 3142f64 | 2017-06-07 11:12:45 -0700 | [diff] [blame] | 67 | if (cfg.isTypeConfigured()) { |
| 68 | if (cfg.type() != type) { |
| 69 | type = cfg.type(); |
| 70 | } |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 71 | } |
| 72 | |
| 73 | SparseAnnotations sa = combine(cfg, descr.annotations()); |
| 74 | return new DefaultLinkDescription(descr.src(), descr.dst(), type, sa); |
| 75 | } |
| 76 | |
| 77 | /** |
| 78 | * Generates an annotation from an existing annotation and LinkConfig. |
| 79 | * |
| 80 | * @param cfg the link config entity from network config |
| 81 | * @param an the annotation |
| 82 | * @return annotation combining both sources |
| 83 | */ |
| 84 | public static SparseAnnotations combine(BasicLinkConfig cfg, SparseAnnotations an) { |
| 85 | DefaultAnnotations.Builder b = DefaultAnnotations.builder(); |
Yuta HIGUCHI | 9eed0b1 | 2017-06-07 11:59:18 -0700 | [diff] [blame] | 86 | b.putAll(an); |
Thomas Vachuska | 41fe1ec | 2015-12-03 23:17:02 -0800 | [diff] [blame] | 87 | if (cfg.metric() != DEF_METRIC) { |
| 88 | b.set(AnnotationKeys.METRIC, String.valueOf(cfg.metric())); |
| 89 | } |
Yuta HIGUCHI | f92598b | 2017-02-17 11:26:17 -0800 | [diff] [blame] | 90 | if (!cfg.latency().equals(DEF_DURATION)) { |
dingdamu | d3a0b21 | 2017-05-16 11:18:27 +0200 | [diff] [blame] | 91 | //Convert the latency from Duration to long, |
| 92 | //so that it's computable in the latencyConstraint. |
| 93 | b.set(AnnotationKeys.LATENCY, String.valueOf(cfg.latency().toNanos())); |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 94 | } |
Ayaka Koshibe | 5373e76 | 2015-08-06 12:31:44 -0700 | [diff] [blame] | 95 | if (cfg.bandwidth() != DEF_BANDWIDTH) { |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 96 | b.set(AnnotationKeys.BANDWIDTH, String.valueOf(cfg.bandwidth())); |
| 97 | } |
Ayaka Koshibe | 2c59acf | 2015-09-08 15:37:47 -0700 | [diff] [blame] | 98 | if (cfg.isDurable() != null) { |
| 99 | b.set(AnnotationKeys.DURABLE, String.valueOf(cfg.isDurable())); |
| 100 | } |
Aaron Dunlap | 239ea5c | 2020-02-26 12:10:31 -0600 | [diff] [blame] | 101 | if (cfg.jitter() != DEF_JITTER) { |
| 102 | b.set(AnnotationKeys.JITTER, String.valueOf(cfg.jitter())); |
| 103 | } |
| 104 | if (cfg.delay() != DEF_DELAY) { |
| 105 | b.set(AnnotationKeys.DELAY, String.valueOf(cfg.delay())); |
| 106 | } |
| 107 | if (cfg.loss() != DEF_LOSS) { |
| 108 | b.set(AnnotationKeys.LOSS, String.valueOf(cfg.loss())); |
| 109 | } |
| 110 | if (cfg.availability() != DEF_AVAILABILITY) { |
| 111 | b.set(AnnotationKeys.AVAILABILITY, String.valueOf(cfg.availability())); |
| 112 | } |
| 113 | if (cfg.flapping() != DEF_FLAPPING) { |
| 114 | b.set(AnnotationKeys.FLAPPING, String.valueOf(cfg.flapping())); |
| 115 | } |
David Glantz | 0843f5d | 2020-03-05 21:23:10 -0600 | [diff] [blame] | 116 | if (cfg.isMetered() != null) { |
| 117 | b.set(AnnotationKeys.METERED, String.valueOf(cfg.isMetered())); |
| 118 | } |
Yuta HIGUCHI | 9eed0b1 | 2017-06-07 11:59:18 -0700 | [diff] [blame] | 119 | return b.build(); |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 120 | } |
Ayaka Koshibe | 2c59acf | 2015-09-08 15:37:47 -0700 | [diff] [blame] | 121 | |
| 122 | /** |
| 123 | * Generates a link description from a link description entity. The endpoints |
| 124 | * must be specified to indicate directionality. |
| 125 | * |
| 126 | * @param src the source ConnectPoint |
| 127 | * @param dst the destination ConnectPoint |
| 128 | * @param link the link config entity |
| 129 | * @return a linkDescription based on the config |
| 130 | */ |
| 131 | public static LinkDescription descriptionOf( |
| 132 | ConnectPoint src, ConnectPoint dst, Link link) { |
| 133 | checkNotNull(src, "Must supply a source endpoint"); |
| 134 | checkNotNull(dst, "Must supply a destination endpoint"); |
| 135 | checkNotNull(link, "Must supply a link"); |
| 136 | return new DefaultLinkDescription( |
Yuta HIGUCHI | 0f4d63a | 2017-03-06 14:21:03 -0800 | [diff] [blame] | 137 | src, dst, link.type(), |
| 138 | link.isExpected(), |
| 139 | (SparseAnnotations) link.annotations()); |
Ayaka Koshibe | 2c59acf | 2015-09-08 15:37:47 -0700 | [diff] [blame] | 140 | } |
| 141 | |
| 142 | /** |
| 143 | * Generates a link description from a link config entity. This is for |
| 144 | * links that cannot be discovered and has to be injected. The endpoints |
| 145 | * must be specified to indicate directionality. |
| 146 | * |
| 147 | * @param src the source ConnectPoint |
| 148 | * @param dst the destination ConnectPoint |
| 149 | * @param link the link config entity |
| 150 | * @return a linkDescription based on the config |
| 151 | */ |
| 152 | public static LinkDescription descriptionOf( |
| 153 | ConnectPoint src, ConnectPoint dst, BasicLinkConfig link) { |
| 154 | checkNotNull(src, "Must supply a source endpoint"); |
| 155 | checkNotNull(dst, "Must supply a destination endpoint"); |
| 156 | checkNotNull(link, "Must supply a link config"); |
Yuta HIGUCHI | 0f4d63a | 2017-03-06 14:21:03 -0800 | [diff] [blame] | 157 | // Only allowed link is expected link |
| 158 | boolean expected = link.isAllowed(); |
Ayaka Koshibe | 2c59acf | 2015-09-08 15:37:47 -0700 | [diff] [blame] | 159 | return new DefaultLinkDescription( |
Yuta HIGUCHI | 0f4d63a | 2017-03-06 14:21:03 -0800 | [diff] [blame] | 160 | src, dst, link.type(), |
| 161 | expected, |
| 162 | combine(link, DefaultAnnotations.EMPTY)); |
Ayaka Koshibe | 2c59acf | 2015-09-08 15:37:47 -0700 | [diff] [blame] | 163 | } |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 164 | } |