Carmelo Cascone | 1022a4e | 2017-05-25 00:16:18 -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 | 1022a4e | 2017-05-25 00:16:18 -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.annotations.Beta; |
Carmelo Cascone | 1e8843f | 2018-07-19 19:01:12 +0200 | [diff] [blame] | 20 | import org.onosproject.net.PortNumber; |
Carmelo Cascone | 1022a4e | 2017-05-25 00:16:18 -0400 | [diff] [blame] | 21 | import org.onosproject.net.driver.HandlerBehaviour; |
| 22 | import org.onosproject.net.flow.TrafficTreatment; |
| 23 | import org.onosproject.net.flow.criteria.Criterion; |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 24 | import org.onosproject.net.packet.InboundPacket; |
Andrea Campanella | 432f718 | 2017-07-14 18:43:27 +0200 | [diff] [blame] | 25 | import org.onosproject.net.packet.OutboundPacket; |
Carmelo Cascone | f3a1a38 | 2017-07-27 12:04:39 -0400 | [diff] [blame] | 26 | import org.onosproject.net.pi.runtime.PiAction; |
Andrea Campanella | fc1d34c | 2017-07-18 17:01:41 +0200 | [diff] [blame] | 27 | import org.onosproject.net.pi.runtime.PiPacketOperation; |
Carmelo Cascone | 1022a4e | 2017-05-25 00:16:18 -0400 | [diff] [blame] | 28 | |
Andrea Campanella | 432f718 | 2017-07-14 18:43:27 +0200 | [diff] [blame] | 29 | import java.util.Collection; |
Carmelo Cascone | 1022a4e | 2017-05-25 00:16:18 -0400 | [diff] [blame] | 30 | import java.util.Optional; |
| 31 | |
| 32 | /** |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 33 | * An interpreter of a PI pipeline model. |
Carmelo Cascone | 1022a4e | 2017-05-25 00:16:18 -0400 | [diff] [blame] | 34 | */ |
| 35 | @Beta |
| 36 | public interface PiPipelineInterpreter extends HandlerBehaviour { |
| 37 | |
| 38 | /** |
Carmelo Cascone | 1e8843f | 2018-07-19 19:01:12 +0200 | [diff] [blame] | 39 | * Returns a PI match field ID that is equivalent to the given criterion |
| 40 | * type, if present. If not present, it means that the given criterion type |
| 41 | * is not supported by this interpreter. |
Carmelo Cascone | 1022a4e | 2017-05-25 00:16:18 -0400 | [diff] [blame] | 42 | * |
| 43 | * @param type criterion type |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 44 | * @return optional match field ID |
Carmelo Cascone | 1022a4e | 2017-05-25 00:16:18 -0400 | [diff] [blame] | 45 | */ |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 46 | Optional<PiMatchFieldId> mapCriterionType(Criterion.Type type); |
Carmelo Cascone | 1022a4e | 2017-05-25 00:16:18 -0400 | [diff] [blame] | 47 | |
| 48 | /** |
Carmelo Cascone | 1e8843f | 2018-07-19 19:01:12 +0200 | [diff] [blame] | 49 | * Returns the criterion type that is equivalent to the given PI match field |
| 50 | * ID, if present. If not present, it means that the given match field is |
| 51 | * not supported by this interpreter. |
Carmelo Cascone | 1022a4e | 2017-05-25 00:16:18 -0400 | [diff] [blame] | 52 | * |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 53 | * @param fieldId match field ID |
Carmelo Cascone | 1022a4e | 2017-05-25 00:16:18 -0400 | [diff] [blame] | 54 | * @return optional criterion type |
| 55 | */ |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 56 | Optional<Criterion.Type> mapPiMatchFieldId(PiMatchFieldId fieldId); |
Carmelo Cascone | 1022a4e | 2017-05-25 00:16:18 -0400 | [diff] [blame] | 57 | |
| 58 | /** |
Carmelo Cascone | 1e8843f | 2018-07-19 19:01:12 +0200 | [diff] [blame] | 59 | * Returns a PI table ID equivalent to the given numeric table ID (as in |
| 60 | * {@link org.onosproject.net.flow.FlowRule#tableId()}). If not present, it |
| 61 | * means that the given integer table ID cannot be mapped to any table of |
| 62 | * the pipeline model. |
Carmelo Cascone | 00a5996 | 2017-06-16 17:51:49 +0900 | [diff] [blame] | 63 | * |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 64 | * @param flowRuleTableId a numeric table ID |
| 65 | * @return PI table ID |
Carmelo Cascone | 00a5996 | 2017-06-16 17:51:49 +0900 | [diff] [blame] | 66 | */ |
| 67 | Optional<PiTableId> mapFlowRuleTableId(int flowRuleTableId); |
| 68 | |
| 69 | /** |
Carmelo Cascone | 1e8843f | 2018-07-19 19:01:12 +0200 | [diff] [blame] | 70 | * Returns an integer table ID equivalent to the given PI table ID. If not |
| 71 | * present, it means that the given PI table ID cannot be mapped to any |
| 72 | * integer table ID, because such mapping would be meaningless or because |
| 73 | * such PI table ID is not defined by the pipeline model. |
Carmelo Cascone | 0b22d8f | 2017-07-31 07:22:27 +0200 | [diff] [blame] | 74 | * |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 75 | * @param piTableId PI table ID |
| 76 | * @return numeric table ID |
Carmelo Cascone | 0b22d8f | 2017-07-31 07:22:27 +0200 | [diff] [blame] | 77 | */ |
| 78 | Optional<Integer> mapPiTableId(PiTableId piTableId); |
| 79 | |
| 80 | /** |
Carmelo Cascone | 1e8843f | 2018-07-19 19:01:12 +0200 | [diff] [blame] | 81 | * Returns an action of a PI pipeline that is functionally equivalent to the |
| 82 | * given traffic treatment for the given table. |
Carmelo Cascone | 1022a4e | 2017-05-25 00:16:18 -0400 | [diff] [blame] | 83 | * |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 84 | * @param treatment traffic treatment |
| 85 | * @param piTableId PI table ID |
| 86 | * @return action object |
Carmelo Cascone | 1e8843f | 2018-07-19 19:01:12 +0200 | [diff] [blame] | 87 | * @throws PiInterpreterException if the treatment cannot be mapped to any |
| 88 | * PI action |
Carmelo Cascone | 1022a4e | 2017-05-25 00:16:18 -0400 | [diff] [blame] | 89 | */ |
Carmelo Cascone | f3a1a38 | 2017-07-27 12:04:39 -0400 | [diff] [blame] | 90 | PiAction mapTreatment(TrafficTreatment treatment, PiTableId piTableId) |
Carmelo Cascone | 1022a4e | 2017-05-25 00:16:18 -0400 | [diff] [blame] | 91 | throws PiInterpreterException; |
| 92 | |
| 93 | /** |
Carmelo Cascone | 1e8843f | 2018-07-19 19:01:12 +0200 | [diff] [blame] | 94 | * Returns a collection of PI packet operations equivalent to the given |
| 95 | * outbound packet instance. |
Andrea Campanella | 432f718 | 2017-07-14 18:43:27 +0200 | [diff] [blame] | 96 | * |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 97 | * @param packet outbound packet |
| 98 | * @return collection of PI packet operations |
Carmelo Cascone | 1e8843f | 2018-07-19 19:01:12 +0200 | [diff] [blame] | 99 | * @throws PiInterpreterException if the packet treatments cannot be |
| 100 | * executed by this pipeline |
Andrea Campanella | 432f718 | 2017-07-14 18:43:27 +0200 | [diff] [blame] | 101 | */ |
Carmelo Cascone | f3a1a38 | 2017-07-27 12:04:39 -0400 | [diff] [blame] | 102 | Collection<PiPacketOperation> mapOutboundPacket(OutboundPacket packet) |
Andrea Campanella | 432f718 | 2017-07-14 18:43:27 +0200 | [diff] [blame] | 103 | throws PiInterpreterException; |
| 104 | |
| 105 | /** |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 106 | * Returns an inbound packet equivalent to the given PI packet operation. |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 107 | * |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 108 | * @param packetOperation packet operation |
| 109 | * @return inbound packet |
Carmelo Cascone | 1e8843f | 2018-07-19 19:01:12 +0200 | [diff] [blame] | 110 | * @throws PiInterpreterException if the packet operation cannot be mapped |
| 111 | * to an inbound packet |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 112 | */ |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 113 | InboundPacket mapInboundPacket(PiPacketOperation packetOperation) |
Andrea Campanella | 288b273 | 2017-07-28 14:16:16 +0200 | [diff] [blame] | 114 | throws PiInterpreterException; |
| 115 | |
| 116 | /** |
Carmelo Cascone | 1e8843f | 2018-07-19 19:01:12 +0200 | [diff] [blame] | 117 | * Maps the given logical port number to the data plane port ID (integer) |
| 118 | * identifying the same port for this pipeconf, if such mapping is |
| 119 | * possible. |
| 120 | * |
| 121 | * @param port port number |
| 122 | * @return optional integer |
| 123 | */ |
| 124 | default Optional<Integer> mapLogicalPortNumber(PortNumber port) { |
| 125 | return Optional.empty(); |
| 126 | } |
| 127 | |
| 128 | /** |
Carmelo Cascone | 1022a4e | 2017-05-25 00:16:18 -0400 | [diff] [blame] | 129 | * Signals that an error was encountered while executing the interpreter. |
| 130 | */ |
| 131 | @Beta |
| 132 | class PiInterpreterException extends Exception { |
| 133 | public PiInterpreterException(String message) { |
| 134 | super(message); |
| 135 | } |
| 136 | } |
Carmelo Cascone | 87892e2 | 2017-11-13 16:01:29 -0800 | [diff] [blame] | 137 | } |