Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | 5ab426f | 2016-04-09 01:19:45 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Laboratory |
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; |
Thomas Vachuska | 41fe1ec | 2015-12-03 23:17:02 -0800 | [diff] [blame] | 41 | private static final double DEF_METRIC = -1; |
Ayaka Koshibe | 5373e76 | 2015-08-06 12:31:44 -0700 | [diff] [blame] | 42 | private static final Duration DEF_DURATION = Duration.ofNanos(-1L); |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 43 | private static final Logger log = getLogger(BasicLinkOperator.class); |
| 44 | |
| 45 | private BasicLinkOperator() { |
| 46 | } |
| 47 | |
| 48 | /** |
| 49 | * Generates a LinkDescription containing fields from a LinkDescription and |
| 50 | * a LinkConfig. |
| 51 | * |
| 52 | * @param cfg the link config entity from network config |
| 53 | * @param descr a LinkDescription |
| 54 | * @return LinkDescription based on both sources |
| 55 | */ |
| 56 | public static LinkDescription combine(BasicLinkConfig cfg, LinkDescription descr) { |
| 57 | if (cfg == null) { |
| 58 | return descr; |
| 59 | } |
| 60 | |
| 61 | // cfg.type() defaults to DIRECT, so there is a risk of unwanted override. |
| 62 | // do we want this behavior? |
| 63 | Link.Type type = descr.type(); |
| 64 | if (cfg.type() != type) { |
| 65 | type = cfg.type(); |
| 66 | } |
| 67 | |
| 68 | SparseAnnotations sa = combine(cfg, descr.annotations()); |
| 69 | return new DefaultLinkDescription(descr.src(), descr.dst(), type, sa); |
| 70 | } |
| 71 | |
| 72 | /** |
| 73 | * Generates an annotation from an existing annotation and LinkConfig. |
| 74 | * |
| 75 | * @param cfg the link config entity from network config |
| 76 | * @param an the annotation |
| 77 | * @return annotation combining both sources |
| 78 | */ |
| 79 | public static SparseAnnotations combine(BasicLinkConfig cfg, SparseAnnotations an) { |
| 80 | DefaultAnnotations.Builder b = DefaultAnnotations.builder(); |
Thomas Vachuska | 41fe1ec | 2015-12-03 23:17:02 -0800 | [diff] [blame] | 81 | if (cfg.metric() != DEF_METRIC) { |
| 82 | b.set(AnnotationKeys.METRIC, String.valueOf(cfg.metric())); |
| 83 | } |
Yuta HIGUCHI | f92598b | 2017-02-17 11:26:17 -0800 | [diff] [blame] | 84 | if (!cfg.latency().equals(DEF_DURATION)) { |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 85 | b.set(AnnotationKeys.LATENCY, cfg.latency().toString()); |
| 86 | } |
Ayaka Koshibe | 5373e76 | 2015-08-06 12:31:44 -0700 | [diff] [blame] | 87 | if (cfg.bandwidth() != DEF_BANDWIDTH) { |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 88 | b.set(AnnotationKeys.BANDWIDTH, String.valueOf(cfg.bandwidth())); |
| 89 | } |
Ayaka Koshibe | 2c59acf | 2015-09-08 15:37:47 -0700 | [diff] [blame] | 90 | if (cfg.isDurable() != null) { |
| 91 | b.set(AnnotationKeys.DURABLE, String.valueOf(cfg.isDurable())); |
| 92 | } |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 93 | return DefaultAnnotations.union(an, b.build()); |
| 94 | } |
Ayaka Koshibe | 2c59acf | 2015-09-08 15:37:47 -0700 | [diff] [blame] | 95 | |
| 96 | /** |
| 97 | * Generates a link description from a link description entity. The endpoints |
| 98 | * must be specified to indicate directionality. |
| 99 | * |
| 100 | * @param src the source ConnectPoint |
| 101 | * @param dst the destination ConnectPoint |
| 102 | * @param link the link config entity |
| 103 | * @return a linkDescription based on the config |
| 104 | */ |
| 105 | public static LinkDescription descriptionOf( |
| 106 | ConnectPoint src, ConnectPoint dst, Link link) { |
| 107 | checkNotNull(src, "Must supply a source endpoint"); |
| 108 | checkNotNull(dst, "Must supply a destination endpoint"); |
| 109 | checkNotNull(link, "Must supply a link"); |
| 110 | return new DefaultLinkDescription( |
Yuta HIGUCHI | 0f4d63a | 2017-03-06 14:21:03 -0800 | [diff] [blame] | 111 | src, dst, link.type(), |
| 112 | link.isExpected(), |
| 113 | (SparseAnnotations) link.annotations()); |
Ayaka Koshibe | 2c59acf | 2015-09-08 15:37:47 -0700 | [diff] [blame] | 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Generates a link description from a link config entity. This is for |
| 118 | * links that cannot be discovered and has to be injected. The endpoints |
| 119 | * must be specified to indicate directionality. |
| 120 | * |
| 121 | * @param src the source ConnectPoint |
| 122 | * @param dst the destination ConnectPoint |
| 123 | * @param link the link config entity |
| 124 | * @return a linkDescription based on the config |
| 125 | */ |
| 126 | public static LinkDescription descriptionOf( |
| 127 | ConnectPoint src, ConnectPoint dst, BasicLinkConfig link) { |
| 128 | checkNotNull(src, "Must supply a source endpoint"); |
| 129 | checkNotNull(dst, "Must supply a destination endpoint"); |
| 130 | checkNotNull(link, "Must supply a link config"); |
Yuta HIGUCHI | 0f4d63a | 2017-03-06 14:21:03 -0800 | [diff] [blame] | 131 | // Only allowed link is expected link |
| 132 | boolean expected = link.isAllowed(); |
Ayaka Koshibe | 2c59acf | 2015-09-08 15:37:47 -0700 | [diff] [blame] | 133 | return new DefaultLinkDescription( |
Yuta HIGUCHI | 0f4d63a | 2017-03-06 14:21:03 -0800 | [diff] [blame] | 134 | src, dst, link.type(), |
| 135 | expected, |
| 136 | combine(link, DefaultAnnotations.EMPTY)); |
Ayaka Koshibe | 2c59acf | 2015-09-08 15:37:47 -0700 | [diff] [blame] | 137 | } |
Ayaka Koshibe | cc260d2 | 2015-08-04 17:13:38 -0700 | [diff] [blame] | 138 | } |