org.onosproject.net.pi.model

Interface PiPipelineInterpreter

All Superinterfaces:

Behaviour, HandlerBehaviour

@Beta
public interface PiPipelineInterpreter
extends HandlerBehaviour

An interpreter of a PI pipeline model.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PiPipelineInterpreter.PiInterpreterException Signals that an error was encountered while executing the interpreter.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<PiMatchFieldId>	mapCriterionType(Criterion.Type type) Returns a PI match field ID that is equivalent to the given criterion type, if present.
java.util.Optional<PiTableId>	mapFlowRuleTableId(int flowRuleTableId) Returns a PI table ID equivalent to the given numeric table ID (as in FlowRule.tableId()).
InboundPacket	mapInboundPacket(PiPacketOperation packetOperation) Returns an inbound packet equivalent to the given PI packet operation.
java.util.Collection<PiPacketOperation>	mapOutboundPacket(OutboundPacket packet) Returns a collection of PI packet operations equivalent to the given outbound packet instance.
java.util.Optional<Criterion.Type>	mapPiMatchFieldId(PiMatchFieldId fieldId) Returns the criterion type that is equivalent to the given PI match field ID, if present.
java.util.Optional<java.lang.Integer>	mapPiTableId(PiTableId piTableId) Returns an integer table ID equivalent to the given PI table ID.
java.util.Optional<PiCounterId>	mapTableCounter(PiTableId piTableId) Returns a PI direct counter ID for the given table to be used to to compute flow entry statistics, if present.
PiAction	mapTreatment(TrafficTreatment treatment, PiTableId piTableId) Returns an action of a PI pipeline that is functionally equivalent to the given traffic treatment for the given table.

Methods inherited from interface org.onosproject.net.driver.HandlerBehaviour

handler, setHandler

Methods inherited from interface org.onosproject.net.driver.Behaviour

data, setData

Method Detail

mapCriterionType

java.util.Optional<PiMatchFieldId> mapCriterionType(Criterion.Type type)

Returns a PI match field ID that is equivalent to the given criterion type, if present. If not present, it means that the given criterion type is not supported by this interpreter.

Parameters:

type - criterion type

Returns:

optional match field ID

mapPiMatchFieldId

java.util.Optional<Criterion.Type> mapPiMatchFieldId(PiMatchFieldId fieldId)

Returns the criterion type that is equivalent to the given PI match field ID, if present. If not present, it means that the given match field is not supported by this interpreter.

Parameters:

fieldId - match field ID

Returns:

optional criterion type

mapFlowRuleTableId

java.util.Optional<PiTableId> mapFlowRuleTableId(int flowRuleTableId)

Returns a PI table ID equivalent to the given numeric table ID (as in FlowRule.tableId()). If not present, it means that the given integer table ID cannot be mapped to any table of the pipeline model.

Parameters:

flowRuleTableId - a numeric table ID

Returns:

PI table ID

mapPiTableId

java.util.Optional<java.lang.Integer> mapPiTableId(PiTableId piTableId)

Returns an integer table ID equivalent to the given PI table ID. If not present, it means that the given PI table ID cannot be mapped to any integer table ID, because such mapping would be meaningless or because such PI table ID is not defined by the pipeline model.

Parameters:

piTableId - PI table ID

Returns:

numeric table ID

mapTreatment

PiAction mapTreatment(TrafficTreatment treatment,
                      PiTableId piTableId)
               throws PiPipelineInterpreter.PiInterpreterException

Returns an action of a PI pipeline that is functionally equivalent to the given traffic treatment for the given table.

Parameters:

treatment - traffic treatment

piTableId - PI table ID

Returns:

action object

Throws:

PiPipelineInterpreter.PiInterpreterException - if the treatment cannot be mapped to any PI action

mapTableCounter

java.util.Optional<PiCounterId> mapTableCounter(PiTableId piTableId)

Returns a PI direct counter ID for the given table to be used to to compute flow entry statistics, if present. If not present, it means that the given table does not offer any counter suitable for the purpose of computing flow rule statistics. Other direct counters might be defined for the given table (check pipeline model), however none of them should be used for flow entry statistics except for this one.

Parameters:

piTableId - table ID

Returns:

optional direct counter ID

mapOutboundPacket

java.util.Collection<PiPacketOperation> mapOutboundPacket(OutboundPacket packet)
                                                   throws PiPipelineInterpreter.PiInterpreterException

Returns a collection of PI packet operations equivalent to the given outbound packet instance.

Parameters:

packet - outbound packet

Returns:

collection of PI packet operations

Throws:

PiPipelineInterpreter.PiInterpreterException - if the packet treatments cannot be executed by this pipeline

mapInboundPacket

InboundPacket mapInboundPacket(PiPacketOperation packetOperation)
                        throws PiPipelineInterpreter.PiInterpreterException

Returns an inbound packet equivalent to the given PI packet operation.

Parameters:

packetOperation - packet operation

Returns:

inbound packet

Throws:

PiPipelineInterpreter.PiInterpreterException - if the packet operation cannot be mapped to an inbound packet