Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2014-2016 Open Networking Laboratory |
| 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.bmv2.ctl; |
| 18 | |
| 19 | import com.google.common.cache.CacheBuilder; |
| 20 | import com.google.common.cache.CacheLoader; |
| 21 | import com.google.common.cache.LoadingCache; |
| 22 | import com.google.common.cache.RemovalListener; |
| 23 | import com.google.common.cache.RemovalNotification; |
| 24 | import com.google.common.collect.Lists; |
| 25 | import org.apache.commons.lang3.tuple.ImmutablePair; |
| 26 | import org.apache.commons.lang3.tuple.Pair; |
| 27 | import org.apache.thrift.TException; |
| 28 | import org.apache.thrift.protocol.TBinaryProtocol; |
| 29 | import org.apache.thrift.protocol.TMultiplexedProtocol; |
| 30 | import org.apache.thrift.protocol.TProtocol; |
| 31 | import org.apache.thrift.transport.TSocket; |
| 32 | import org.apache.thrift.transport.TTransport; |
| 33 | import org.apache.thrift.transport.TTransportException; |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 34 | import org.onlab.util.ImmutableByteSequence; |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 35 | import org.onosproject.bmv2.api.runtime.Bmv2Action; |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 36 | import org.onosproject.bmv2.api.runtime.Bmv2Client; |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 37 | import org.onosproject.bmv2.api.runtime.Bmv2ExactMatchParam; |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 38 | import org.onosproject.bmv2.api.runtime.Bmv2LpmMatchParam; |
| 39 | import org.onosproject.bmv2.api.runtime.Bmv2MatchKey; |
| 40 | import org.onosproject.bmv2.api.runtime.Bmv2PortInfo; |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 41 | import org.onosproject.bmv2.api.runtime.Bmv2RuntimeException; |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 42 | import org.onosproject.bmv2.api.runtime.Bmv2TableEntry; |
| 43 | import org.onosproject.bmv2.api.runtime.Bmv2TernaryMatchParam; |
| 44 | import org.onosproject.bmv2.api.runtime.Bmv2ValidMatchParam; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 45 | import org.onosproject.net.DeviceId; |
| 46 | import org.p4.bmv2.thrift.BmAddEntryOptions; |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 47 | import org.p4.bmv2.thrift.BmMatchParam; |
| 48 | import org.p4.bmv2.thrift.BmMatchParamExact; |
| 49 | import org.p4.bmv2.thrift.BmMatchParamLPM; |
| 50 | import org.p4.bmv2.thrift.BmMatchParamTernary; |
| 51 | import org.p4.bmv2.thrift.BmMatchParamType; |
| 52 | import org.p4.bmv2.thrift.BmMatchParamValid; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 53 | import org.p4.bmv2.thrift.DevMgrPortInfo; |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 54 | import org.p4.bmv2.thrift.SimpleSwitch; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 55 | import org.p4.bmv2.thrift.Standard; |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 56 | import org.slf4j.Logger; |
| 57 | import org.slf4j.LoggerFactory; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 58 | |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 59 | import java.nio.ByteBuffer; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 60 | import java.util.Collection; |
| 61 | import java.util.List; |
| 62 | import java.util.concurrent.ExecutionException; |
| 63 | import java.util.concurrent.TimeUnit; |
| 64 | import java.util.stream.Collectors; |
| 65 | |
| 66 | import static com.google.common.base.Preconditions.checkNotNull; |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 67 | import static org.onosproject.bmv2.ctl.SafeThriftClient.Options; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 68 | |
| 69 | /** |
| 70 | * Implementation of a Thrift client to control the Bmv2 switch. |
| 71 | */ |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 72 | public final class Bmv2ThriftClient implements Bmv2Client { |
| 73 | |
| 74 | private static final Logger LOG = |
| 75 | LoggerFactory.getLogger(Bmv2ThriftClient.class); |
| 76 | |
| 77 | // FIXME: make context_id arbitrary for each call |
| 78 | // See: https://github.com/p4lang/behavioral-model/blob/master/modules/bm_sim/include/bm_sim/context.h |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 79 | private static final int CONTEXT_ID = 0; |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 80 | // Seconds after a client is expired (and connection closed) in the cache. |
| 81 | private static final int CLIENT_CACHE_TIMEOUT = 60; |
| 82 | // Number of connection retries after a network error. |
Carmelo Cascone | 5fa651e | 2016-04-27 17:35:57 -0700 | [diff] [blame^] | 83 | private static final int NUM_CONNECTION_RETRIES = 3; |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 84 | // Time between retries in milliseconds. |
Carmelo Cascone | 5fa651e | 2016-04-27 17:35:57 -0700 | [diff] [blame^] | 85 | private static final int TIME_BETWEEN_RETRIES = 300; |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 86 | |
| 87 | // Static client cache where clients are removed after a predefined timeout. |
| 88 | private static final LoadingCache<DeviceId, Bmv2ThriftClient> |
| 89 | CLIENT_CACHE = CacheBuilder.newBuilder() |
| 90 | .expireAfterAccess(CLIENT_CACHE_TIMEOUT, TimeUnit.SECONDS) |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 91 | .removalListener(new ClientRemovalListener()) |
| 92 | .build(new ClientLoader()); |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 93 | private final Standard.Iface standardClient; |
| 94 | private final SimpleSwitch.Iface simpleSwitchClient; |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 95 | private final TTransport transport; |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 96 | private final DeviceId deviceId; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 97 | |
| 98 | // ban constructor |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 99 | private Bmv2ThriftClient(DeviceId deviceId, TTransport transport, Standard.Iface standardClient, |
| 100 | SimpleSwitch.Iface simpleSwitchClient) { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 101 | this.deviceId = deviceId; |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 102 | this.transport = transport; |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 103 | this.standardClient = standardClient; |
| 104 | this.simpleSwitchClient = simpleSwitchClient; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 105 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 106 | LOG.debug("New client created! > deviceId={}", deviceId); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 107 | } |
| 108 | |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 109 | /** |
| 110 | * Returns a client object to control the passed device. |
| 111 | * |
| 112 | * @param deviceId device id |
| 113 | * @return bmv2 client object |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 114 | * @throws Bmv2RuntimeException if a connection to the device cannot be established |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 115 | */ |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 116 | public static Bmv2ThriftClient of(DeviceId deviceId) throws Bmv2RuntimeException { |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 117 | try { |
| 118 | checkNotNull(deviceId, "deviceId cannot be null"); |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 119 | LOG.debug("Getting a client from cache... > deviceId{}", deviceId); |
| 120 | return CLIENT_CACHE.get(deviceId); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 121 | } catch (ExecutionException e) { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 122 | LOG.debug("Exception while getting a client from cache: {} > ", e, deviceId); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 123 | throw new Bmv2RuntimeException(e.getMessage(), e.getCause()); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 124 | } |
| 125 | } |
| 126 | |
| 127 | /** |
Carmelo Cascone | 5fa651e | 2016-04-27 17:35:57 -0700 | [diff] [blame^] | 128 | * Force a close of the transport session (if one is open) with the given device. |
| 129 | * |
| 130 | * @param deviceId device id |
| 131 | */ |
| 132 | public static void forceDisconnectOf(DeviceId deviceId) { |
| 133 | CLIENT_CACHE.invalidate(deviceId); |
| 134 | } |
| 135 | |
| 136 | /** |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 137 | * Pings the device. Returns true if the device is reachable, |
| 138 | * false otherwise. |
| 139 | * |
| 140 | * @param deviceId device id |
| 141 | * @return true if reachable, false otherwise |
| 142 | */ |
| 143 | public static boolean ping(DeviceId deviceId) { |
| 144 | // poll ports status as workaround to assess device reachability |
| 145 | try { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 146 | LOG.debug("Pinging device... > deviceId={}", deviceId); |
| 147 | Bmv2ThriftClient client = of(deviceId); |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 148 | boolean result = client.simpleSwitchClient.ping(); |
| 149 | LOG.debug("Device pinged! > deviceId={}, state={}", deviceId, result); |
| 150 | return result; |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 151 | } catch (TException | Bmv2RuntimeException e) { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 152 | LOG.debug("Device NOT reachable! > deviceId={}", deviceId); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 153 | return false; |
| 154 | } |
| 155 | } |
| 156 | |
| 157 | /** |
| 158 | * Parse device ID into host and port. |
| 159 | * |
| 160 | * @param did device ID |
| 161 | * @return a pair of host and port |
| 162 | */ |
| 163 | private static Pair<String, Integer> parseDeviceId(DeviceId did) { |
| 164 | String[] info = did.toString().split(":"); |
| 165 | if (info.length == 3) { |
| 166 | String host = info[1]; |
| 167 | int port = Integer.parseInt(info[2]); |
| 168 | return ImmutablePair.of(host, port); |
| 169 | } else { |
| 170 | throw new IllegalArgumentException( |
| 171 | "Unable to parse BMv2 device ID " |
| 172 | + did.toString() |
| 173 | + ", expected format is scheme:host:port"); |
| 174 | } |
| 175 | } |
| 176 | |
| 177 | /** |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 178 | * Builds a list of Bmv2/Thrift compatible match parameters. |
| 179 | * |
| 180 | * @param matchKey a bmv2 matchKey |
| 181 | * @return list of thrift-compatible bm match parameters |
| 182 | */ |
| 183 | private static List<BmMatchParam> buildMatchParamsList(Bmv2MatchKey matchKey) { |
| 184 | List<BmMatchParam> paramsList = Lists.newArrayList(); |
| 185 | matchKey.matchParams().forEach(x -> { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 186 | ByteBuffer value; |
| 187 | ByteBuffer mask; |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 188 | switch (x.type()) { |
| 189 | case EXACT: |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 190 | value = ByteBuffer.wrap(((Bmv2ExactMatchParam) x).value().asArray()); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 191 | paramsList.add( |
| 192 | new BmMatchParam(BmMatchParamType.EXACT) |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 193 | .setExact(new BmMatchParamExact(value))); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 194 | break; |
| 195 | case TERNARY: |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 196 | value = ByteBuffer.wrap(((Bmv2TernaryMatchParam) x).value().asArray()); |
| 197 | mask = ByteBuffer.wrap(((Bmv2TernaryMatchParam) x).mask().asArray()); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 198 | paramsList.add( |
| 199 | new BmMatchParam(BmMatchParamType.TERNARY) |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 200 | .setTernary(new BmMatchParamTernary(value, mask))); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 201 | break; |
| 202 | case LPM: |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 203 | value = ByteBuffer.wrap(((Bmv2LpmMatchParam) x).value().asArray()); |
| 204 | int prefixLength = ((Bmv2LpmMatchParam) x).prefixLength(); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 205 | paramsList.add( |
| 206 | new BmMatchParam(BmMatchParamType.LPM) |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 207 | .setLpm(new BmMatchParamLPM(value, prefixLength))); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 208 | break; |
| 209 | case VALID: |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 210 | boolean flag = ((Bmv2ValidMatchParam) x).flag(); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 211 | paramsList.add( |
| 212 | new BmMatchParam(BmMatchParamType.VALID) |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 213 | .setValid(new BmMatchParamValid(flag))); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 214 | break; |
| 215 | default: |
| 216 | // should never be here |
| 217 | throw new RuntimeException("Unknown match param type " + x.type().name()); |
| 218 | } |
| 219 | }); |
| 220 | return paramsList; |
| 221 | } |
| 222 | |
| 223 | /** |
| 224 | * Build a list of Bmv2/Thrift compatible action parameters. |
| 225 | * |
| 226 | * @param action an action object |
| 227 | * @return list of ByteBuffers |
| 228 | */ |
| 229 | private static List<ByteBuffer> buildActionParamsList(Bmv2Action action) { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 230 | List<ByteBuffer> buffers = Lists.newArrayList(); |
| 231 | action.parameters().forEach(p -> buffers.add(ByteBuffer.wrap(p.asArray()))); |
| 232 | return buffers; |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 233 | } |
| 234 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 235 | private void closeTransport() { |
| 236 | LOG.debug("Closing transport session... > deviceId={}", deviceId); |
| 237 | if (this.transport.isOpen()) { |
| 238 | this.transport.close(); |
| 239 | LOG.debug("Transport session closed! > deviceId={}", deviceId); |
| 240 | } else { |
| 241 | LOG.debug("Transport session was already closed! deviceId={}", deviceId); |
| 242 | } |
| 243 | } |
| 244 | |
| 245 | @Override |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 246 | public final long addTableEntry(Bmv2TableEntry entry) throws Bmv2RuntimeException { |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 247 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 248 | LOG.debug("Adding table entry... > deviceId={}, entry={}", deviceId, entry); |
| 249 | |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 250 | long entryId = -1; |
| 251 | |
| 252 | try { |
| 253 | BmAddEntryOptions options = new BmAddEntryOptions(); |
| 254 | |
| 255 | if (entry.hasPriority()) { |
| 256 | options.setPriority(entry.priority()); |
| 257 | } |
| 258 | |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 259 | entryId = standardClient.bm_mt_add_entry( |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 260 | CONTEXT_ID, |
| 261 | entry.tableName(), |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 262 | buildMatchParamsList(entry.matchKey()), |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 263 | entry.action().name(), |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 264 | buildActionParamsList(entry.action()), |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 265 | options); |
| 266 | |
| 267 | if (entry.hasTimeout()) { |
| 268 | /* bmv2 accepts timeouts in milliseconds */ |
| 269 | int msTimeout = (int) Math.round(entry.timeout() * 1_000); |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 270 | standardClient.bm_mt_set_entry_ttl( |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 271 | CONTEXT_ID, entry.tableName(), entryId, msTimeout); |
| 272 | } |
| 273 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 274 | LOG.debug("Table entry added! > deviceId={}, entryId={}/{}", deviceId, entry.tableName(), entryId); |
| 275 | |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 276 | return entryId; |
| 277 | |
| 278 | } catch (TException e) { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 279 | LOG.debug("Exception while adding table entry: {} > deviceId={}, tableName={}", |
| 280 | e, deviceId, entry.tableName()); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 281 | if (entryId != -1) { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 282 | // entry is in inconsistent state (unable to add timeout), remove it |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 283 | try { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 284 | deleteTableEntry(entry.tableName(), entryId); |
| 285 | } catch (Bmv2RuntimeException e1) { |
| 286 | LOG.debug("Unable to remove failed table entry: {} > deviceId={}, tableName={}", |
| 287 | e1, deviceId, entry.tableName()); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 288 | } |
| 289 | } |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 290 | throw new Bmv2RuntimeException(e.getMessage(), e); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 291 | } |
| 292 | } |
| 293 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 294 | @Override |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 295 | public final void modifyTableEntry(String tableName, |
| 296 | long entryId, Bmv2Action action) |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 297 | throws Bmv2RuntimeException { |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 298 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 299 | LOG.debug("Modifying table entry... > deviceId={}, entryId={}/{}", deviceId, tableName, entryId); |
| 300 | |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 301 | try { |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 302 | standardClient.bm_mt_modify_entry( |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 303 | CONTEXT_ID, |
| 304 | tableName, |
| 305 | entryId, |
| 306 | action.name(), |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 307 | buildActionParamsList(action)); |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 308 | LOG.debug("Table entry modified! > deviceId={}, entryId={}/{}", deviceId, tableName, entryId); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 309 | } catch (TException e) { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 310 | LOG.debug("Exception while modifying table entry: {} > deviceId={}, entryId={}/{}", |
| 311 | e, deviceId, tableName, entryId); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 312 | throw new Bmv2RuntimeException(e.getMessage(), e); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 313 | } |
| 314 | } |
| 315 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 316 | @Override |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 317 | public final void deleteTableEntry(String tableName, |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 318 | long entryId) throws Bmv2RuntimeException { |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 319 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 320 | LOG.debug("Deleting table entry... > deviceId={}, entryId={}/{}", deviceId, tableName, entryId); |
| 321 | |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 322 | try { |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 323 | standardClient.bm_mt_delete_entry(CONTEXT_ID, tableName, entryId); |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 324 | LOG.debug("Table entry deleted! > deviceId={}, entryId={}/{}", deviceId, tableName, entryId); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 325 | } catch (TException e) { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 326 | LOG.debug("Exception while deleting table entry: {} > deviceId={}, entryId={}/{}", |
| 327 | e, deviceId, tableName, entryId); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 328 | throw new Bmv2RuntimeException(e.getMessage(), e); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 329 | } |
| 330 | } |
| 331 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 332 | @Override |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 333 | public final void setTableDefaultAction(String tableName, Bmv2Action action) |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 334 | throws Bmv2RuntimeException { |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 335 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 336 | LOG.debug("Setting table default... > deviceId={}, tableName={}, action={}", deviceId, tableName, action); |
| 337 | |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 338 | try { |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 339 | standardClient.bm_mt_set_default_action( |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 340 | CONTEXT_ID, |
| 341 | tableName, |
| 342 | action.name(), |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 343 | buildActionParamsList(action)); |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 344 | LOG.debug("Table default set! > deviceId={}, tableName={}, action={}", deviceId, tableName, action); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 345 | } catch (TException e) { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 346 | LOG.debug("Exception while setting table default : {} > deviceId={}, tableName={}, action={}", |
| 347 | e, deviceId, tableName, action); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 348 | throw new Bmv2RuntimeException(e.getMessage(), e); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 349 | } |
| 350 | } |
| 351 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 352 | @Override |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 353 | public Collection<Bmv2PortInfo> getPortsInfo() throws Bmv2RuntimeException { |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 354 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 355 | LOG.debug("Retrieving port info... > deviceId={}", deviceId); |
| 356 | |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 357 | try { |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 358 | List<DevMgrPortInfo> portInfos = standardClient.bm_dev_mgr_show_ports(); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 359 | |
| 360 | Collection<Bmv2PortInfo> bmv2PortInfos = Lists.newArrayList(); |
| 361 | |
| 362 | bmv2PortInfos.addAll( |
| 363 | portInfos.stream() |
| 364 | .map(Bmv2PortInfo::new) |
| 365 | .collect(Collectors.toList())); |
| 366 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 367 | LOG.debug("Port info retrieved! > deviceId={}, portInfos={}", deviceId, bmv2PortInfos); |
| 368 | |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 369 | return bmv2PortInfos; |
| 370 | |
| 371 | } catch (TException e) { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 372 | LOG.debug("Exception while retrieving port info: {} > deviceId={}", e, deviceId); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 373 | throw new Bmv2RuntimeException(e.getMessage(), e); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 374 | } |
| 375 | } |
| 376 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 377 | @Override |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 378 | public String dumpTable(String tableName) throws Bmv2RuntimeException { |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 379 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 380 | LOG.debug("Retrieving table dump... > deviceId={}, tableName={}", deviceId, tableName); |
| 381 | |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 382 | try { |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 383 | String dump = standardClient.bm_dump_table(CONTEXT_ID, tableName); |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 384 | LOG.debug("Table dump retrieved! > deviceId={}, tableName={}", deviceId, tableName); |
| 385 | return dump; |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 386 | } catch (TException e) { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 387 | LOG.debug("Exception while retrieving table dump: {} > deviceId={}, tableName={}", |
| 388 | e, deviceId, tableName); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 389 | throw new Bmv2RuntimeException(e.getMessage(), e); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 390 | } |
| 391 | } |
| 392 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 393 | @Override |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 394 | public void transmitPacket(int portNumber, ImmutableByteSequence packet) throws Bmv2RuntimeException { |
| 395 | |
| 396 | LOG.debug("Requesting packet transmission... > portNumber={}, packet={}", portNumber, packet); |
| 397 | |
| 398 | try { |
| 399 | |
| 400 | simpleSwitchClient.push_packet(portNumber, ByteBuffer.wrap(packet.asArray())); |
| 401 | LOG.debug("Packet transmission requested! > portNumber={}, packet={}", portNumber, packet); |
| 402 | } catch (TException e) { |
| 403 | LOG.debug("Exception while requesting packet transmission: {} > portNumber={}, packet={}", |
Carmelo Cascone | 5fa651e | 2016-04-27 17:35:57 -0700 | [diff] [blame^] | 404 | e, portNumber, packet); |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 405 | throw new Bmv2RuntimeException(e.getMessage(), e); |
| 406 | } |
| 407 | } |
| 408 | |
| 409 | @Override |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 410 | public void resetState() throws Bmv2RuntimeException { |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 411 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 412 | LOG.debug("Resetting device state... > deviceId={}", deviceId); |
| 413 | |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 414 | try { |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 415 | standardClient.bm_reset_state(); |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 416 | LOG.debug("Device state reset! > deviceId={}", deviceId); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 417 | } catch (TException e) { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 418 | LOG.debug("Exception while resetting device state: {} > deviceId={}", e, deviceId); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 419 | throw new Bmv2RuntimeException(e.getMessage(), e); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 420 | } |
| 421 | } |
| 422 | |
| 423 | /** |
| 424 | * Transport/client cache loader. |
| 425 | */ |
| 426 | private static class ClientLoader |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 427 | extends CacheLoader<DeviceId, Bmv2ThriftClient> { |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 428 | |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 429 | private static final Options RECONN_OPTIONS = new Options(NUM_CONNECTION_RETRIES, TIME_BETWEEN_RETRIES); |
| 430 | |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 431 | @Override |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 432 | public Bmv2ThriftClient load(DeviceId deviceId) |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 433 | throws TTransportException { |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 434 | LOG.debug("Creating new client in cache... > deviceId={}", deviceId); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 435 | Pair<String, Integer> info = parseDeviceId(deviceId); |
| 436 | //make the expensive call |
| 437 | TTransport transport = new TSocket( |
| 438 | info.getLeft(), info.getRight()); |
| 439 | TProtocol protocol = new TBinaryProtocol(transport); |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 440 | // Our BMv2 device implements multiple Thrift services, create a client for each one. |
| 441 | Standard.Client standardClient = new Standard.Client( |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 442 | new TMultiplexedProtocol(protocol, "standard")); |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 443 | SimpleSwitch.Client simpleSwitch = new SimpleSwitch.Client( |
| 444 | new TMultiplexedProtocol(protocol, "simple_switch")); |
| 445 | // Wrap clients so to automatically have synchronization and resiliency to connectivity errors |
| 446 | Standard.Iface safeStandardClient = SafeThriftClient.wrap(standardClient, |
| 447 | Standard.Iface.class, |
| 448 | RECONN_OPTIONS); |
| 449 | SimpleSwitch.Iface safeSimpleSwitchClient = SafeThriftClient.wrap(simpleSwitch, |
| 450 | SimpleSwitch.Iface.class, |
| 451 | RECONN_OPTIONS); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 452 | |
Carmelo Cascone | e4da909 | 2016-04-26 12:14:08 -0700 | [diff] [blame] | 453 | return new Bmv2ThriftClient(deviceId, transport, safeStandardClient, safeSimpleSwitchClient); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 454 | } |
| 455 | } |
| 456 | |
| 457 | /** |
| 458 | * Client cache removal listener. Close the connection on cache removal. |
| 459 | */ |
| 460 | private static class ClientRemovalListener implements |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 461 | RemovalListener<DeviceId, Bmv2ThriftClient> { |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 462 | |
| 463 | @Override |
| 464 | public void onRemoval( |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 465 | RemovalNotification<DeviceId, Bmv2ThriftClient> notification) { |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 466 | // close the transport connection |
Carmelo Cascone | 37d5dbf | 2016-04-18 15:15:48 -0700 | [diff] [blame] | 467 | LOG.debug("Removing client from cache... > deviceId={}", notification.getKey()); |
Carmelo Cascone | aa8b629 | 2016-04-13 14:27:06 -0700 | [diff] [blame] | 468 | notification.getValue().closeTransport(); |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 469 | } |
| 470 | } |
| 471 | } |