package p4.config.v1

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: P4Info

• optional Preamble preamble = 1

• repeated Action.Param params = 2

Used in: Action

• uint32 id = 1

• string name = 2

• repeated string annotations = 3

• repeated SourceLocation annotation_locations = 8

  Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.

• int32 bitwidth = 4

• optional Documentation doc = 5

  Documentation of the Param.

• optional P4NamedType type_name = 6

  unset if not user-defined type.

• repeated StructuredAnnotation structured_annotations = 7

Used in: P4Info

• optional Preamble preamble = 1

• repeated uint32 table_ids = 2

  the ids of the tables sharing this action profile

• bool with_selector = 3

  true iff the action profile used dynamic selection

• int64 size = 4

  max number of member entries across all groups if the action profile does not have a selector. Otherwise, semantics as specified by `selector_size_semantics` below.

• int32 max_group_size = 5

  0 if the action profile does not have a selector. Otherwise, semantics as specified by `selector_size_semantics` below.

• oneof selector_size_semantics

  specifies the semantics of `size` and `max_group_size` above.

  • ActionProfile.SumOfWeights sum_of_weights = 6

    group size is the sum of the group's weights. Added in v1.4.0.

  • ActionProfile.SumOfMembers sum_of_members = 7

    group size is the sum of the group's members. Added in v1.4.0.

• bool weights_disallowed = 8

  Dictates whether the controller can specify weights for groups programmed in this ActionProfile. If `weights_disallowed` is true, then all weights must be absent. Unset (false) in action profiles without selectors. Added in v1.5.0.

indicates that `size` and `max_group_size` represent the maximum number of members that can be present across all selector groups and within a single selector group respectively. Added in v1.4.0.

Used in: ActionProfile

• int32 max_member_weight = 1

  the maximum weight of each individual member in a group.

indicates that `size` and `max_group_size` represent the maximum sum of weights that can be present across all selector groups and within a single selector group respectively. Added in v1.4.0.

Used in: ActionProfile

(message has no fields)

used to list all possible actions in a Table

Used in: Table

• uint32 id = 1

• ActionRef.Scope scope = 3

• repeated string annotations = 2

• repeated SourceLocation annotation_locations = 5

  Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.

• repeated StructuredAnnotation structured_annotations = 4

Used in: ActionRef

• TABLE_AND_DEFAULT = 0

• TABLE_ONLY = 1

• DEFAULT_ONLY = 2

• GROUP_ACTION = 3

  Added in v1.6.0.

Any metadata associated with controller Packet-IO (Packet-In or Packet-Out) is modeled as P4 headers carrying special annotations @controller_header("packet_out") and @controller_header("packet_in") respectively. There can be at most one header each with these annotations. This message captures the info contained within these special headers, and used in p4runtime.proto to supply the metadata.

Used in: P4Info

• optional Preamble preamble = 1

  preamble.name and preamble.id will specify header type ("packet_out" or "packet_in" for now).

• repeated ControllerPacketMetadata.Metadata metadata = 2

  Ordered based on header layout. This is a constraint on the generator of this P4Info.

Used in: ControllerPacketMetadata

• uint32 id = 1

• string name = 2

  This is the name of the header field (not fully-qualified), similar to e.g. Action.Param.name.

• repeated string annotations = 3

• repeated SourceLocation annotation_locations = 7

  Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.

• int32 bitwidth = 4

• optional P4NamedType type_name = 5

  unset if not user-defined type

• repeated StructuredAnnotation structured_annotations = 6

Used in: P4Info

• optional Preamble preamble = 1

• optional CounterSpec spec = 2

• int64 size = 3

  number of entries in the counter array

• optional P4NamedType index_type_name = 4

  unset if index is not user-defined type

Used in: Counter, DirectCounter

• CounterSpec.Unit unit = 1

Corresponds to 'type' constructor parameter for Counter / DirectCounter in PSA

Used in: CounterSpec

• UNSPECIFIED = 0

• BYTES = 1

• PACKETS = 2

• BOTH = 3

Used in: P4Info

• optional Preamble preamble = 1

• optional P4DataTypeSpec type_spec = 2

Used in: P4Info

• optional Preamble preamble = 1

• optional CounterSpec spec = 2

• uint32 direct_table_id = 3

  the id of the table to which the counter is attached

Used in: P4Info

• optional Preamble preamble = 1

• optional MeterSpec spec = 2

• uint32 direct_table_id = 3

  the id of the table to which the meter is attached

Used in: Action.Param, MatchField, PkgInfo, Preamble

• string brief = 1

  A brief description of something, e.g. one sentence

• string description = 2

  A more verbose description of something. Multiline is accepted. Markup format (if any) is TBD.

Used in: ExpressionList, KeyValuePair

• oneof value

  • string string_value = 1

  • int64 int64_value = 2

  • bool bool_value = 3

Used in: StructuredAnnotation

• repeated Expression expressions = 1

used to group all extern instances of the same type in one message

Used in: P4Info

• uint32 extern_type_id = 1

  the extern_type_id is unique for a given architecture and must be in the range [0x81, 0xfe].

• string extern_type_name = 2

• repeated ExternInstance instances = 3

Used in: Extern

• optional Preamble preamble = 1

• optional google.protobuf.Any info = 2

  specific to the extern type, declared in a separate vendor-specific proto file

Used in: KeyValuePairList

• string key = 1

• optional Expression value = 2

Used in: StructuredAnnotation

• repeated KeyValuePair kv_pairs = 1

Used in: Table, ValueSet

• uint32 id = 1

• string name = 2

• repeated string annotations = 3

• repeated SourceLocation annotation_locations = 10

  Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.

• int32 bitwidth = 4

• oneof match

  • MatchField.MatchType match_type = 5

  • string other_match_type = 7

    used for architecture-specific match types which are not part of the core P4 language or of the PSA architecture.

• optional Documentation doc = 6

  Documentation of the match field

• optional P4NamedType type_name = 8

  unset if not user-defined type

• repeated StructuredAnnotation structured_annotations = 9

Used in: MatchField

• UNSPECIFIED = 0

• EXACT = 2

• LPM = 3

• TERNARY = 4

• RANGE = 5

• OPTIONAL = 6

Used in: P4Info

• optional Preamble preamble = 1

• optional MeterSpec spec = 2

• int64 size = 3

  number of entries in the meter array

• optional P4NamedType index_type_name = 4

  unset if index is not user-defined type

Used in: DirectMeter, Meter

• MeterSpec.Unit unit = 1

• MeterSpec.Type type = 2

  Added in 1.4.0.

Used to restrict the MeterConfigs that can be used to instantiate the meter. Added in 1.4.0.

Used in: MeterSpec

• TWO_RATE_THREE_COLOR = 0

  As described in RFC 2698, allows meters to use two rates to split packets into three potential colors. MeterConfigs on table entries using this meter type MUST have `eburst == 0` (i.e. unset).

• SINGLE_RATE_THREE_COLOR = 1

  As described in RFC 2697, allows meters to use one rate with an Excess Burst Size (EBS) to split packets into three potential colors. MeterConfigs on table entries using this meter type MUST have `cir == pir && cburst == pburst`.

• SINGLE_RATE_TWO_COLOR = 2

  A simplified version of RFC 2697, restricting meters to using a single rate to split packets into only RED or GREEN, by not providing an Excess Burst Size (EBS). MeterConfigs on table entries using this meter type MUST have `cir == pir && cburst == pburst && eburst == 0` (i.e. unset).

Corresponds to 'type' constructor parameter for Meter / DirectMeter in PSA

Used in: MeterSpec

• UNSPECIFIED = 0

• BYTES = 1

• PACKETS = 2

Used in: P4BitstringLikeTypeSpec, P4SerializableEnumTypeSpec

• int32 bitwidth = 1

Used in: P4DataTypeSpec, P4HeaderTypeSpec.Member

• oneof type_spec

  • P4BitTypeSpec bit = 1

    bit<W>

  • P4IntTypeSpec int = 2

    int<W>

  • P4VarbitTypeSpec varbit = 3

    varbit<W>

• repeated string annotations = 4

  Useful to identify well-known types, such as IP address or Ethernet MAC address.

• repeated SourceLocation annotation_locations = 5

  Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.

• repeated StructuredAnnotation structured_annotations = 6

Empty message as no type information needed, just used as a placeholder in the oneof to identify boolean types.

Used in: P4DataTypeSpec

(message has no fields)

Describes a P4_16 type.

Used in: Digest, P4NewTypeSpec, P4StructTypeSpec.Member, P4TupleTypeSpec, Register

• oneof type_spec

  • P4BitstringLikeTypeSpec bitstring = 1

  • P4BoolType bool = 2

  • P4TupleTypeSpec tuple = 3

  • P4NamedType struct = 4

  • P4NamedType header = 5

  • P4NamedType header_union = 6

  • P4HeaderStackTypeSpec header_stack = 7

  • P4HeaderUnionStackTypeSpec header_union_stack = 8

  • P4NamedType enum = 9

  • P4ErrorType error = 10

  • P4NamedType serializable_enum = 11

  • P4NamedType new_type = 12

For "safe" enums with no underlying representation and no member integer values.

Used in: P4TypeInfo

• repeated P4EnumTypeSpec.Member members = 1

• repeated string annotations = 2

• repeated SourceLocation annotation_locations = 4

  Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.

• repeated StructuredAnnotation structured_annotations = 3

Used in: P4EnumTypeSpec

• string name = 1

• repeated string annotations = 2

• repeated SourceLocation annotation_locations = 4

  Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.

• repeated StructuredAnnotation structured_annotations = 3

Used in: P4DataTypeSpec

(message has no fields)

Similar to an enum, but there is always one and only one instance per P4 program.

Used in: P4TypeInfo

• repeated string members = 1

Used in: P4DataTypeSpec

• optional P4NamedType header = 1

• int32 size = 2

Used in: P4TypeInfo

• repeated P4HeaderTypeSpec.Member members = 1

• repeated string annotations = 2

• repeated SourceLocation annotation_locations = 3

  Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.

• repeated StructuredAnnotation structured_annotations = 4

Used in: P4HeaderTypeSpec

• string name = 1

• optional P4BitstringLikeTypeSpec type_spec = 2

Used in: P4DataTypeSpec

• optional P4NamedType header_union = 1

• int32 size = 2

Used in: P4TypeInfo

• repeated P4HeaderUnionTypeSpec.Member members = 1

• repeated string annotations = 2

• repeated SourceLocation annotation_locations = 3

  Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.

• repeated StructuredAnnotation structured_annotations = 4

Used in: P4HeaderUnionTypeSpec

• string name = 1

• optional P4NamedType header = 2

wrapping the enum in a message to avoid name collisions in C++, where "enum values are siblings of their type, not children of it"

(message has no fields)

ids are allocated in such a way that it is possible based on an id to deduce the resource type (e.g. table, action, counter, ...). The most-significant byte of the 32-bit id encodes the resource type. The purpose of this enum is to define which value is used as the most-significant byte for each resource type. The P4 compiler must use these values when allocating ids for P4 objects. Other users of P4Info can refer to this enum to identify a resource type based on its id.

• UNSPECIFIED = 0

• ACTION = 1

  P4 language built-ins

• TABLE = 2

• VALUE_SET = 3

• CONTROLLER_HEADER = 4

• PSA_EXTERNS_START = 16

  PSA externs

• ACTION_PROFILE = 17

• COUNTER = 18

• DIRECT_COUNTER = 19

• METER = 20

• DIRECT_METER = 21

• REGISTER = 22

• DIGEST = 23

• OTHER_EXTERNS_START = 128

  externs for other architectures (vendor extensions)

• MAX = 255

  max value for an unsigned 8-bit byte

  requires protoc >= 3.5.0 reserved 0x100 to max;

Used in: v1.ForwardingPipelineConfig

• optional PkgInfo pkg_info = 1

• repeated Table tables = 2

• repeated Action actions = 3

• repeated ActionProfile action_profiles = 4

• repeated Counter counters = 5

• repeated DirectCounter direct_counters = 6

• repeated Meter meters = 7

• repeated DirectMeter direct_meters = 8

• repeated ControllerPacketMetadata controller_packet_metadata = 9

• repeated ValueSet value_sets = 10

• repeated Register registers = 11

• repeated Digest digests = 12

• repeated Extern externs = 100

• optional P4TypeInfo type_info = 200

Used in: P4BitstringLikeTypeSpec

• int32 bitwidth = 1

Used in: Action.Param, ControllerPacketMetadata.Metadata, Counter, MatchField, Meter, P4DataTypeSpec, P4HeaderStackTypeSpec, P4HeaderUnionStackTypeSpec, P4HeaderUnionTypeSpec.Member, Register

• string name = 1

New types introduced with the "type" keyword

Used in: P4TypeInfo

• oneof representation

  • P4DataTypeSpec original_type = 1

    if no @p4runtime_translation annotation present

  • P4NewTypeTranslation translated_type = 2

    if @p4runtime_translation annotation present

• repeated string annotations = 3

  for other annotations (not @p4runtime_translation)

• repeated SourceLocation annotation_locations = 5

  Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.

• repeated StructuredAnnotation structured_annotations = 4

Used in: P4NewTypeSpec

• string uri = 1

  the URI uniquely identifies the translation in order to enable the P4Runtime agent to perform value-mapping appropriately when required. It is recommended that the URI includes at least the P4 architecture name and the type name.

• oneof sdn_type

  The object is either represented as an unsigned integer with a bitwidth of `sdn_bitwidth`, or as a string.

  • int32 sdn_bitwidth = 2

  • P4NewTypeTranslation.SdnString sdn_string = 3

Used in: P4NewTypeTranslation

(message has no fields)

For serializable (or "unsafe") enums, which have an underlying type. Note that as per the P4_16 specification, the underlying representation can only be a bit<W> type.

Used in: P4TypeInfo

• optional P4BitTypeSpec underlying_type = 1

• repeated P4SerializableEnumTypeSpec.Member members = 2

• repeated string annotations = 3

• repeated SourceLocation annotation_locations = 5

  Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.

• repeated StructuredAnnotation structured_annotations = 4

Used in: P4SerializableEnumTypeSpec

• string name = 1

• bytes value = 2

• repeated string annotations = 3

• repeated SourceLocation annotation_locations = 5

  Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.

• repeated StructuredAnnotation structured_annotations = 4

Used in: P4TypeInfo

• repeated P4StructTypeSpec.Member members = 1

• repeated string annotations = 2

• repeated SourceLocation annotation_locations = 3

  Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.

• repeated StructuredAnnotation structured_annotations = 4

Used in: P4StructTypeSpec

• string name = 1

• optional P4DataTypeSpec type_spec = 2

From the P4_16 spec: "A tuple is similar to a struct, in that it holds multiple values. Unlike a struct type, tuples have no named fields."

Used in: P4DataTypeSpec

• repeated P4DataTypeSpec members = 1

These P4 types (struct, header_type, header_union and enum) are guaranteed to have a fully-qualified name (e.g. you cannot use an anonymous struct to declare a variable like in C). Instead of duplicating the type spec for these every time the type is used, we include the type spec once in this P4TypeInfo message and refer to the types by name in the P4DataTypeSpec message. We also support annotations for these type specs which can be useful, e.g. to identify well-known headers (such as ipv4).

Used in: P4Info

• map<string, P4StructTypeSpec> structs = 1

• map<string, P4HeaderTypeSpec> headers = 2

• map<string, P4HeaderUnionTypeSpec> header_unions = 3

• map<string, P4EnumTypeSpec> enums = 4

• optional P4ErrorTypeSpec error = 5

• map<string, P4SerializableEnumTypeSpec> serializable_enums = 6

• map<string, P4NewTypeSpec> new_types = 7

Used in: P4BitstringLikeTypeSpec

• int32 max_bitwidth = 1

Top-level package documentation describing the forwarding pipeline config Can be used to manage multiple P4 packages.

Used in: P4Info

• string name = 1

  a definitive name for this configuration, e.g. switch.p4_v1.0

• string version = 2

  configuration version, free-format string

• optional Documentation doc = 3

  brief and detailed descriptions

• repeated string annotations = 4

  Miscellaneous metadata, free-form; a way to extend PkgInfo

• repeated SourceLocation annotation_locations = 10

  Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.

• string arch = 5

  the target architecture, e.g. "psa"

• string organization = 6

  organization which produced the configuration, e.g. "p4.org"

• string contact = 7

  contact info for support,e.g. "tech-support@acme.org"

• string url = 8

  url for more information, e.g. "http://support.p4.org/ref/p4/switch.p4_v1.0"

• repeated StructuredAnnotation structured_annotations = 9

  Miscellaneous metadata, structured; a way to extend PkgInfo

• optional PlatformProperties platform_properties = 11

  If set, specifies the properties that the underlying platform should have. If the platform does not conform to these properties, the server should reject the P4Info when used with a SetForwardingPipelineConfigRequest. Added in 1.4.0

Used to describe the required properties of the underlying platform. Added in v1.4.0

Used in: PkgInfo

• int32 multicast_group_table_size = 1

  The minimum number of multicast entries (i.e. multicast groups) that the platform is required to support. If 0, there are no requirements.

• int32 multicast_group_table_total_replicas = 2

  The minimum number of replicas that the platform is required to support across all groups. If 0, there are no requirements.

• int32 multicast_group_table_max_replicas_per_entry = 3

  The number of replicas that the platform is required to support per group/entry. If 0, `multicast_group_table_total_replicas` should be used. Must be no larger than `multicast_group_table_total_replicas`.

Used in: Action, ActionProfile, ControllerPacketMetadata, Counter, Digest, DirectCounter, DirectMeter, ExternInstance, Meter, Register, Table, ValueSet

• uint32 id = 1

  ids share the same number-space; e.g. table ids cannot overlap with counter ids. Even though this is irrelevant to this proto definition, the ids are allocated in such a way that it is possible based on an id to deduce the resource type (e.g. table, action, counter, ...). This means that code using these ids can detect if the wrong resource type is used somewhere. This also means that ids of different types can be mixed (e.g. direct resource list for a table) without ambiguity. Note that id 0 is reserved and means "invalid id".

• string name = 2

  fully qualified name of the P4 object, e.g. c1.c2.ipv4_lpm

• string alias = 3

  an alias (alternative name) for the P4 object, probably shorter than its fully qualified name. The only constraint is for it to be unique with respect to other P4 objects of the same type. By default, the compiler uses the shortest suffix of the name that uniquely identifies the object. For example if the P4 program contains two tables with names s.c1.t and s.c2.t, the default aliases will respectively be c1.t and c2.t. In the future, the P4 programmer may also be able to override the default alias for any P4 object (TBD).

• repeated string annotations = 4

• repeated SourceLocation annotation_locations = 7

  Optional. If present, the location of `annotations[i]` is given by `annotation_locations[i]`.

• optional Documentation doc = 5

  Documentation of the entity

• repeated StructuredAnnotation structured_annotations = 6

Used in: P4Info

• optional Preamble preamble = 1

• optional P4DataTypeSpec type_spec = 2

• int32 size = 3

• optional P4NamedType index_type_name = 4

  unset if index is not user-defined type

Location of code relative to a given source file.

Used in: Action.Param, ActionRef, ControllerPacketMetadata.Metadata, MatchField, P4BitstringLikeTypeSpec, P4EnumTypeSpec, P4EnumTypeSpec.Member, P4HeaderTypeSpec, P4HeaderUnionTypeSpec, P4NewTypeSpec, P4SerializableEnumTypeSpec, P4SerializableEnumTypeSpec.Member, P4StructTypeSpec, PkgInfo, Preamble, StructuredAnnotation

• string file = 1

  Path to the source file (absolute or relative to the working directory).

• int32 line = 2

  Line and column numbers within the source file, 1-based.

• int32 column = 3

Used in: Action.Param, ActionRef, ControllerPacketMetadata.Metadata, MatchField, P4BitstringLikeTypeSpec, P4EnumTypeSpec, P4EnumTypeSpec.Member, P4HeaderTypeSpec, P4HeaderUnionTypeSpec, P4NewTypeSpec, P4SerializableEnumTypeSpec, P4SerializableEnumTypeSpec.Member, P4StructTypeSpec, PkgInfo, Preamble

• string name = 1

• oneof body

  • ExpressionList expression_list = 2

  • KeyValuePairList kv_pair_list = 3

• optional SourceLocation source_location = 4

  Optional. Location of the '@' symbol of this annotation in the source code.

Used in: P4Info

• optional Preamble preamble = 1

• repeated MatchField match_fields = 2

• repeated ActionRef action_refs = 3

  even when the table is indirect (see implementation_id) below, this field includes all possible actions for the table; by using ActionRef instead of a repeated field of action ids, each action reference in a P4 table is able to have its own annotations

• uint32 const_default_action_id = 4

  0 (default value) means that the table does not have a const default action

• optional TableActionCall initial_default_action = 5

  The initial default action of the table. This can be overridden at runtime. Added in 1.4.0.

• uint32 implementation_id = 6

  P4 id of the "implementation" for this table (e.g. action profile id); 0 (default value) means that the table is a regular (direct) match table. As of today, only action profiles are supported but other table implementations may be added in the future

• repeated uint32 direct_resource_ids = 7

  ids of the direct resources (if any) attached to this table; for now this includes only direct counters and direct meters, but other resources may be added in the future

• int64 size = 8

  max number of entries in table

• Table.IdleTimeoutBehavior idle_timeout_behavior = 9

  is idle timeout supported for this table?

• bool is_const_table = 10

  True if and only if the table's entries are immutable, i.e. defined using the 'const entries' table property in the P4 source code, and thus entries cannot be deleted, modified, or inserted at run time.

• bool has_initial_entries = 11

  True if and only if the table has initial entries defined using the 'entries' table property in the P4 source code, either with or without the 'const' qualifier on 'entries', and there is at least one entry in that list. This field is false if the list of entries is empty in the P4 source code. Added in 1.4.0.

• optional google.protobuf.Any other_properties = 100

  architecture-specific table properties which are not part of the core P4 language or of the PSA architecture.

this enum can be extended in the future with other behaviors, such as "HARD_EVICTION"

Used in: Table

• NO_TIMEOUT = 0

• NOTIFY_CONTROL = 1

A TableActionCall references a particular action id and executes the action with the supplied list of arguments. Arguments are matched to the id of the respective action parameter. TableActionCalls may be used as the default action call of a table implementation. Added in 1.4.0.

Used in: Table

• uint32 action_id = 1

• repeated TableActionCall.Argument arguments = 4

Used in: TableActionCall

• uint32 param_id = 2

• bytes value = 3

Used in: P4Info

• optional Preamble preamble = 1

• repeated MatchField match = 2

• int32 size = 3

  number of entries in the value_set, as per the P4 constructor call.