Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2017-present Open Networking Foundation |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [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.net.pi.model; |
| 18 | |
| 19 | import com.google.common.collect.ImmutableMap; |
Carmelo Cascone | 3b4baa0 | 2019-04-17 16:39:12 -0700 | [diff] [blame] | 20 | import com.google.common.hash.Hashing; |
| 21 | import com.google.common.hash.HashingInputStream; |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 22 | import org.onosproject.net.driver.Behaviour; |
| 23 | |
Carmelo Cascone | 31d3e44 | 2017-07-18 16:58:51 -0400 | [diff] [blame] | 24 | import java.io.IOException; |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 25 | import java.io.InputStream; |
Carmelo Cascone | 31d3e44 | 2017-07-18 16:58:51 -0400 | [diff] [blame] | 26 | import java.net.URL; |
ghj0504520 | ec1a420 | 2018-10-22 10:50:41 -0700 | [diff] [blame] | 27 | import java.nio.ByteBuffer; |
| 28 | import java.util.ArrayList; |
| 29 | import java.util.Arrays; |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 30 | import java.util.Collection; |
| 31 | import java.util.Map; |
| 32 | import java.util.Optional; |
| 33 | |
Carmelo Cascone | 31d3e44 | 2017-07-18 16:58:51 -0400 | [diff] [blame] | 34 | import static com.google.common.base.Preconditions.checkArgument; |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 35 | import static com.google.common.base.Preconditions.checkNotNull; |
Carmelo Cascone | 31d3e44 | 2017-07-18 16:58:51 -0400 | [diff] [blame] | 36 | import static java.lang.String.format; |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 37 | |
| 38 | /** |
| 39 | * Default pipeconf implementation. |
| 40 | */ |
| 41 | public final class DefaultPiPipeconf implements PiPipeconf { |
| 42 | |
| 43 | private final PiPipeconfId id; |
| 44 | private final PiPipelineModel pipelineModel; |
ghj0504520 | ec1a420 | 2018-10-22 10:50:41 -0700 | [diff] [blame] | 45 | private final long fingerprint; |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 46 | private final Map<Class<? extends Behaviour>, Class<? extends Behaviour>> behaviours; |
Carmelo Cascone | 31d3e44 | 2017-07-18 16:58:51 -0400 | [diff] [blame] | 47 | private final Map<ExtensionType, URL> extensions; |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 48 | |
ghj0504520 | ec1a420 | 2018-10-22 10:50:41 -0700 | [diff] [blame] | 49 | private DefaultPiPipeconf(PiPipeconfId id, PiPipelineModel pipelineModel, long fingerprint, |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 50 | Map<Class<? extends Behaviour>, Class<? extends Behaviour>> behaviours, |
Carmelo Cascone | 31d3e44 | 2017-07-18 16:58:51 -0400 | [diff] [blame] | 51 | Map<ExtensionType, URL> extensions) { |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 52 | this.id = id; |
| 53 | this.pipelineModel = pipelineModel; |
ghj0504520 | ec1a420 | 2018-10-22 10:50:41 -0700 | [diff] [blame] | 54 | this.fingerprint = fingerprint; |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 55 | this.behaviours = behaviours; |
| 56 | this.extensions = extensions; |
| 57 | } |
| 58 | |
| 59 | @Override |
| 60 | public PiPipeconfId id() { |
| 61 | return id; |
| 62 | } |
| 63 | |
| 64 | @Override |
| 65 | public PiPipelineModel pipelineModel() { |
| 66 | return pipelineModel; |
| 67 | } |
| 68 | |
| 69 | @Override |
ghj0504520 | ec1a420 | 2018-10-22 10:50:41 -0700 | [diff] [blame] | 70 | public long fingerprint() { |
| 71 | return fingerprint; |
| 72 | } |
| 73 | |
| 74 | @Override |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 75 | public Collection<Class<? extends Behaviour>> behaviours() { |
| 76 | return behaviours.keySet(); |
| 77 | } |
| 78 | |
| 79 | @Override |
| 80 | public Optional<Class<? extends Behaviour>> implementation(Class<? extends Behaviour> behaviour) { |
| 81 | return Optional.ofNullable(behaviours.get(behaviour)); |
| 82 | } |
| 83 | |
| 84 | @Override |
| 85 | public boolean hasBehaviour(Class<? extends Behaviour> behaviourClass) { |
| 86 | return behaviours.containsKey(behaviourClass); |
| 87 | } |
| 88 | |
| 89 | @Override |
| 90 | public Optional<InputStream> extension(ExtensionType type) { |
Carmelo Cascone | 31d3e44 | 2017-07-18 16:58:51 -0400 | [diff] [blame] | 91 | if (extensions.containsKey(type)) { |
| 92 | try { |
| 93 | return Optional.of(extensions.get(type).openStream()); |
| 94 | } catch (IOException e) { |
Ray Milkey | 986a47a | 2018-01-25 11:38:51 -0800 | [diff] [blame] | 95 | throw new IllegalStateException(e); |
Carmelo Cascone | 31d3e44 | 2017-07-18 16:58:51 -0400 | [diff] [blame] | 96 | } |
| 97 | } else { |
| 98 | return Optional.empty(); |
| 99 | } |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 100 | } |
| 101 | |
| 102 | /** |
| 103 | * Returns a new pipeconf builder. |
| 104 | * |
| 105 | * @return pipeconf builder |
| 106 | */ |
| 107 | public static Builder builder() { |
| 108 | return new Builder(); |
| 109 | } |
| 110 | |
| 111 | /** |
| 112 | * Builder of pipeconf implementations. |
| 113 | */ |
| 114 | public static class Builder { |
| 115 | |
| 116 | private PiPipeconfId id; |
| 117 | private PiPipelineModel pipelineModel; |
| 118 | private ImmutableMap.Builder<Class<? extends Behaviour>, Class<? extends Behaviour>> behaviourMapBuilder |
| 119 | = ImmutableMap.builder(); |
Carmelo Cascone | 31d3e44 | 2017-07-18 16:58:51 -0400 | [diff] [blame] | 120 | private ImmutableMap.Builder<ExtensionType, URL> extensionMapBuilder = ImmutableMap.builder(); |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 121 | |
| 122 | /** |
| 123 | * Sets the identifier of this pipeconf. |
| 124 | * |
| 125 | * @param id pipeconf identifier |
| 126 | * @return this |
| 127 | */ |
| 128 | public Builder withId(PiPipeconfId id) { |
| 129 | this.id = id; |
| 130 | return this; |
| 131 | } |
| 132 | |
| 133 | /** |
| 134 | * Sets the pipeline model of this pipeconf. |
| 135 | * |
| 136 | * @param model pipeline model |
| 137 | * @return this |
| 138 | */ |
| 139 | public Builder withPipelineModel(PiPipelineModel model) { |
| 140 | this.pipelineModel = model; |
| 141 | return this; |
| 142 | } |
| 143 | |
| 144 | /** |
| 145 | * Adds a behaviour to this pipeconf. |
| 146 | * |
| 147 | * @param clazz behavior interface class |
| 148 | * @param implementation behavior implementation class |
| 149 | * @return this |
| 150 | */ |
| 151 | public Builder addBehaviour(Class<? extends Behaviour> clazz, Class<? extends Behaviour> implementation) { |
| 152 | checkNotNull(clazz); |
| 153 | checkNotNull(implementation); |
| 154 | behaviourMapBuilder.put(clazz, implementation); |
| 155 | return this; |
| 156 | } |
| 157 | |
| 158 | /** |
| 159 | * Adds an extension to this pipeconf. |
| 160 | * |
Carmelo Cascone | 31d3e44 | 2017-07-18 16:58:51 -0400 | [diff] [blame] | 161 | * @param type extension type |
| 162 | * @param url url pointing at the extension file |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 163 | * @return this |
| 164 | */ |
Carmelo Cascone | 31d3e44 | 2017-07-18 16:58:51 -0400 | [diff] [blame] | 165 | public Builder addExtension(ExtensionType type, URL url) { |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 166 | checkNotNull(type); |
Carmelo Cascone | 31d3e44 | 2017-07-18 16:58:51 -0400 | [diff] [blame] | 167 | checkNotNull(url); |
| 168 | checkArgument(checkUrl(url), format("Extension url %s seems to be empty/non existent", url.toString())); |
| 169 | extensionMapBuilder.put(type, url); |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 170 | return this; |
| 171 | } |
| 172 | |
Carmelo Cascone | 31d3e44 | 2017-07-18 16:58:51 -0400 | [diff] [blame] | 173 | private boolean checkUrl(URL url) { |
| 174 | try { |
| 175 | int byteCount = url.openStream().available(); |
| 176 | return byteCount > 0; |
| 177 | } catch (IOException e) { |
| 178 | return false; |
| 179 | } |
| 180 | } |
| 181 | |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 182 | /** |
| 183 | * Creates a new pipeconf. |
| 184 | * |
| 185 | * @return pipeconf instance |
| 186 | */ |
| 187 | public PiPipeconf build() { |
| 188 | checkNotNull(id); |
| 189 | checkNotNull(pipelineModel); |
ghj0504520 | ec1a420 | 2018-10-22 10:50:41 -0700 | [diff] [blame] | 190 | |
| 191 | Map<ExtensionType, URL> extensions = extensionMapBuilder.build(); |
Carmelo Cascone | 3b4baa0 | 2019-04-17 16:39:12 -0700 | [diff] [blame] | 192 | Map<Class<? extends Behaviour>, Class<? extends Behaviour>> behaviours = |
| 193 | behaviourMapBuilder.build(); |
| 194 | return new DefaultPiPipeconf( |
| 195 | id, pipelineModel, generateFingerprint(extensions.values()), |
| 196 | behaviours, extensions); |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 197 | } |
| 198 | |
Carmelo Cascone | 3b4baa0 | 2019-04-17 16:39:12 -0700 | [diff] [blame] | 199 | private long generateFingerprint(Collection<URL> extensions) { |
| 200 | Collection<Integer> hashes = new ArrayList<>(); |
| 201 | for (URL extUrl : extensions) { |
ghj0504520 | ec1a420 | 2018-10-22 10:50:41 -0700 | [diff] [blame] | 202 | try { |
Carmelo Cascone | 3b4baa0 | 2019-04-17 16:39:12 -0700 | [diff] [blame] | 203 | HashingInputStream hin = new HashingInputStream( |
| 204 | Hashing.crc32(), extUrl.openStream()); |
| 205 | //noinspection StatementWithEmptyBody |
| 206 | while (hin.read() != -1) { |
| 207 | // Do nothing. Reading all input stream to update hash. |
| 208 | } |
| 209 | hashes.add(hin.hash().asInt()); |
ghj0504520 | ec1a420 | 2018-10-22 10:50:41 -0700 | [diff] [blame] | 210 | } catch (IOException e) { |
| 211 | throw new IllegalArgumentException(e); |
| 212 | } |
| 213 | } |
Carmelo Cascone | 3b4baa0 | 2019-04-17 16:39:12 -0700 | [diff] [blame] | 214 | // FIXME: how to include behaviours in the hash? |
| 215 | int low = Arrays.hashCode(hashes.toArray()); |
| 216 | int high = pipelineModel.hashCode(); |
| 217 | return ByteBuffer.allocate(8).putInt(high).putInt(low).getLong(0); |
ghj0504520 | ec1a420 | 2018-10-22 10:50:41 -0700 | [diff] [blame] | 218 | } |
Carmelo Cascone | 07d7271 | 2017-07-14 15:57:47 -0400 | [diff] [blame] | 219 | } |
| 220 | } |