Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2017-present Open Networking Foundation |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [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.p4runtime.ctl; |
| 18 | |
| 19 | import com.google.protobuf.ByteString; |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 20 | import org.onlab.util.ImmutableByteSequence; |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 21 | import org.onosproject.net.DeviceId; |
| 22 | import org.onosproject.net.pi.model.PiControlMetadataId; |
| 23 | import org.onosproject.net.pi.model.PiPacketOperationType; |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 24 | import org.onosproject.net.pi.model.PiPipeconf; |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 25 | import org.onosproject.net.pi.runtime.PiControlMetadata; |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 26 | import org.onosproject.net.pi.runtime.PiPacketOperation; |
| 27 | import org.slf4j.Logger; |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 28 | import p4.config.P4InfoOuterClass; |
| 29 | |
Carmelo Cascone | 2cad9ef | 2017-08-01 21:52:07 +0200 | [diff] [blame] | 30 | import java.util.Collections; |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 31 | import java.util.List; |
| 32 | import java.util.Objects; |
| 33 | import java.util.stream.Collectors; |
| 34 | |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 35 | import static org.onlab.util.ImmutableByteSequence.copyFrom; |
| 36 | import static org.onosproject.p4runtime.ctl.P4InfoBrowser.NotFoundException; |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 37 | import static org.slf4j.LoggerFactory.getLogger; |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 38 | import static p4.P4RuntimeOuterClass.PacketIn; |
| 39 | import static p4.P4RuntimeOuterClass.PacketMetadata; |
| 40 | import static p4.P4RuntimeOuterClass.PacketOut; |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 41 | |
| 42 | /** |
| 43 | * Encoder of packet metadata, from ONOS Pi* format, to P4Runtime protobuf messages, and vice versa. |
| 44 | */ |
| 45 | final class PacketIOCodec { |
| 46 | |
| 47 | private static final Logger log = getLogger(PacketIOCodec.class); |
| 48 | |
| 49 | private static final String PACKET_OUT = "packet_out"; |
| 50 | |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 51 | private static final String PACKET_IN = "packet_in"; |
| 52 | |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 53 | // TODO: implement cache of encoded entities. |
| 54 | |
| 55 | private PacketIOCodec() { |
| 56 | // hide. |
| 57 | } |
| 58 | |
| 59 | /** |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 60 | * Returns a P4Runtime packet out protobuf message, encoded from the given PiPacketOperation for the given pipeconf. |
| 61 | * If a PI packet metadata inside the PacketOperation cannot be encoded, it is skipped, hence the returned PacketOut |
| 62 | * collection of metadatas might have different size than the input one. |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 63 | * <p> |
| 64 | * Please check the log for an explanation of any error that might have occurred. |
| 65 | * |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 66 | * @param packet PI packet operation |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 67 | * @param pipeconf the pipeconf for the program on the switch |
| 68 | * @return a P4Runtime packet out protobuf message |
| 69 | * @throws NotFoundException if the browser can't find the packet_out in the given p4Info |
| 70 | */ |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 71 | static PacketOut encodePacketOut(PiPacketOperation packet, PiPipeconf pipeconf) |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 72 | throws NotFoundException { |
| 73 | |
| 74 | //Get the P4browser |
| 75 | P4InfoBrowser browser = PipeconfHelper.getP4InfoBrowser(pipeconf); |
| 76 | |
Carmelo Cascone | 2cad9ef | 2017-08-01 21:52:07 +0200 | [diff] [blame] | 77 | //Get the packet out controller packet metadata |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 78 | P4InfoOuterClass.ControllerPacketMetadata controllerControlMetadata = |
Carmelo Cascone | cb0a49c | 2017-10-03 14:32:23 +0200 | [diff] [blame] | 79 | browser.controllerPacketMetadatas().getByName(PACKET_OUT); |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 80 | PacketOut.Builder packetOutBuilder = PacketOut.newBuilder(); |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 81 | |
| 82 | //outer controller packet metadata id |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 83 | int controllerControlMetadataId = controllerControlMetadata.getPreamble().getId(); |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 84 | |
| 85 | //Add all its metadata to the packet out |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 86 | packetOutBuilder.addAllMetadata(encodeControlMetadata(packet, browser, controllerControlMetadataId)); |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 87 | |
| 88 | //Set the packet out payload |
| 89 | packetOutBuilder.setPayload(ByteString.copyFrom(packet.data().asReadOnlyBuffer())); |
| 90 | return packetOutBuilder.build(); |
| 91 | |
| 92 | } |
| 93 | |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 94 | private static List<PacketMetadata> encodeControlMetadata(PiPacketOperation packet, |
| 95 | P4InfoBrowser browser, int controllerControlMetadataId) { |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 96 | return packet.metadatas().stream().map(metadata -> { |
| 97 | try { |
| 98 | //get each metadata id |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 99 | int metadataId = browser.packetMetadatas(controllerControlMetadataId) |
| 100 | .getByName(metadata.id().toString()).getId(); |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 101 | |
| 102 | //Add the metadata id and it's data the packet out |
| 103 | return PacketMetadata.newBuilder() |
| 104 | .setMetadataId(metadataId) |
| 105 | .setValue(ByteString.copyFrom(metadata.value().asReadOnlyBuffer())) |
| 106 | .build(); |
| 107 | } catch (NotFoundException e) { |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 108 | log.error("Cant find metadata with name {} in p4Info file.", metadata.id()); |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 109 | return null; |
| 110 | } |
| 111 | }).filter(Objects::nonNull).collect(Collectors.toList()); |
| 112 | } |
| 113 | |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 114 | /** |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 115 | * Returns a PiPacketOperation, decoded from the given P4Runtime PacketIn protobuf message for the given pipeconf |
| 116 | * and device ID. If a PI packet metadata inside the protobuf message cannot be decoded, it is skipped, hence the |
| 117 | * returned PiPacketOperation collection of metadatas might have different size than the input one. |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 118 | * <p> |
| 119 | * Please check the log for an explanation of any error that might have occurred. |
| 120 | * |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 121 | * @param packetIn the P4Runtime PacketIn message |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 122 | * @param pipeconf the pipeconf for the program on the switch |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 123 | * @param deviceId the deviceId that originated the PacketIn message |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 124 | * @return a PiPacketOperation |
| 125 | */ |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 126 | static PiPacketOperation decodePacketIn(PacketIn packetIn, PiPipeconf pipeconf, DeviceId deviceId) { |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 127 | |
| 128 | //Get the P4browser |
| 129 | P4InfoBrowser browser = PipeconfHelper.getP4InfoBrowser(pipeconf); |
| 130 | |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 131 | List<PiControlMetadata> packetMetadatas; |
Carmelo Cascone | 2cad9ef | 2017-08-01 21:52:07 +0200 | [diff] [blame] | 132 | try { |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 133 | int controllerControlMetadataId = browser.controllerPacketMetadatas().getByName(PACKET_IN) |
| 134 | .getPreamble().getId(); |
| 135 | packetMetadatas = decodeControlMetadataIn(packetIn.getMetadataList(), browser, |
| 136 | controllerControlMetadataId); |
Carmelo Cascone | 2cad9ef | 2017-08-01 21:52:07 +0200 | [diff] [blame] | 137 | } catch (NotFoundException e) { |
| 138 | log.error("Unable to decode packet metadatas: {}", e.getMessage()); |
| 139 | packetMetadatas = Collections.emptyList(); |
| 140 | } |
| 141 | |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 142 | //Transform the packetIn data |
| 143 | ImmutableByteSequence data = copyFrom(packetIn.getPayload().asReadOnlyByteBuffer()); |
| 144 | |
| 145 | //Build the PiPacketOperation with all the metadatas. |
| 146 | return PiPacketOperation.builder() |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 147 | .forDevice(deviceId) |
| 148 | .withType(PiPacketOperationType.PACKET_IN) |
Carmelo Cascone | 2cad9ef | 2017-08-01 21:52:07 +0200 | [diff] [blame] | 149 | .withMetadatas(packetMetadatas) |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 150 | .withData(data) |
| 151 | .build(); |
| 152 | } |
| 153 | |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 154 | private static List<PiControlMetadata> decodeControlMetadataIn(List<PacketMetadata> packetMetadatas, |
| 155 | P4InfoBrowser browser, |
| 156 | int controllerControlMetadataId) { |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 157 | return packetMetadatas.stream().map(packetMetadata -> { |
| 158 | try { |
| 159 | |
Carmelo Cascone | 2cad9ef | 2017-08-01 21:52:07 +0200 | [diff] [blame] | 160 | int packetMetadataId = packetMetadata.getMetadataId(); |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 161 | String packetMetadataName = browser.packetMetadatas(controllerControlMetadataId) |
Carmelo Cascone | 2cad9ef | 2017-08-01 21:52:07 +0200 | [diff] [blame] | 162 | .getById(packetMetadataId).getName(); |
| 163 | |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 164 | PiControlMetadataId metadataId = PiControlMetadataId.of(packetMetadataName); |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 165 | |
| 166 | //Build each metadata. |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 167 | return PiControlMetadata.builder() |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 168 | .withId(metadataId) |
| 169 | .withValue(ImmutableByteSequence.copyFrom(packetMetadata.getValue().asReadOnlyByteBuffer())) |
| 170 | .build(); |
| 171 | } catch (NotFoundException e) { |
| 172 | log.error("Cant find metadata with id {} in p4Info file.", packetMetadata.getMetadataId()); |
| 173 | return null; |
| 174 | } |
| 175 | }).filter(Objects::nonNull).collect(Collectors.toList()); |
| 176 | } |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 177 | |
| 178 | } |