Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [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.flow.instructions; |
| 18 | |
| 19 | import com.google.common.annotations.Beta; |
| 20 | import com.google.common.base.MoreObjects; |
| 21 | |
| 22 | import java.util.Objects; |
| 23 | |
| 24 | /** |
Jonathan Hart | 26a8d95 | 2015-12-02 15:16:35 -0800 | [diff] [blame] | 25 | * Type of treatment extensions. |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 26 | */ |
| 27 | @Beta |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 28 | public final class ExtensionTreatmentType { |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 29 | |
| 30 | /** |
| 31 | * A list of well-known named extension instruction type codes. |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 32 | * These numbers have no impact on the actual OF type id. |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 33 | */ |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 34 | public enum ExtensionTreatmentTypes { |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 35 | NICIRA_SET_TUNNEL_DST(0), |
Phaneendra Manda | ce66cbc | 2015-11-26 18:07:48 +0530 | [diff] [blame] | 36 | NICIRA_RESUBMIT(1), |
Charles Chan | 14967c2 | 2015-12-07 11:11:50 -0800 | [diff] [blame] | 37 | NICIRA_MOV_ARP_SHA_TO_THA(2), |
| 38 | NICIRA_MOV_ARP_SPA_TO_TPA(3), |
| 39 | NICIRA_MOV_ETH_SRC_TO_DST(4), |
| 40 | NICIRA_MOV_IP_SRC_TO_DST(5), |
Phaneendra Manda | 8db7d09 | 2016-06-04 00:17:24 +0530 | [diff] [blame] | 41 | NICIRA_MOV_NSH_C1_TO_C1(6), |
| 42 | NICIRA_MOV_NSH_C2_TO_C2(7), |
| 43 | NICIRA_MOV_NSH_C3_TO_C3(8), |
| 44 | NICIRA_MOV_NSH_C4_TO_C4(9), |
| 45 | NICIRA_MOV_TUN_IPV4_DST_TO_TUN_IPV4_DST(10), |
| 46 | NICIRA_MOV_TUN_ID_TO_TUN_ID(11), |
| 47 | NICIRA_MOV_NSH_C2_TO_TUN_ID(12), |
Phaneendra Manda | ab5a736 | 2015-12-02 01:10:01 +0530 | [diff] [blame] | 48 | NICIRA_RESUBMIT_TABLE(14), |
Phaneendra Manda | 8db7d09 | 2016-06-04 00:17:24 +0530 | [diff] [blame] | 49 | NICIRA_PUSH_NSH(38), |
| 50 | NICIRA_POP_NSH(39), |
Frank Wang | 5733c38 | 2017-03-28 10:15:18 +0800 | [diff] [blame] | 51 | NICIRA_CT(40), |
| 52 | NICIRA_NAT(41), |
| 53 | NICIRA_CT_CLEAR(42), |
Carmelo Cascone | 2ea177b | 2016-02-25 18:38:42 -0800 | [diff] [blame] | 54 | OFDPA_SET_VLAN_ID(64), |
Charles Chan | cad338a | 2016-09-16 18:03:11 -0700 | [diff] [blame] | 55 | OFDPA_SET_MPLS_TYPE(65), |
Pier Ventre | 6f63005 | 2016-10-18 09:58:41 -0700 | [diff] [blame] | 56 | OFDPA_SET_OVID(66), |
Pier Ventre | 9cf536b | 2016-10-21 13:30:18 -0700 | [diff] [blame] | 57 | OFDPA_SET_MPLS_L2_PORT(67), |
Pier Ventre | db252cc | 2016-10-21 21:54:26 -0700 | [diff] [blame] | 58 | OFDPA_SET_QOS_INDEX(68), |
Pier Ventre | ee4a8f2 | 2016-10-22 15:45:36 -0700 | [diff] [blame] | 59 | OFDPA_PUSH_L2_HEADER(69), |
| 60 | OFDPA_PUSH_CW(70), |
| 61 | OFDPA_POP_L2_HEADER(71), |
| 62 | OFDPA_POP_CW(72), |
Phaneendra Manda | 8db7d09 | 2016-06-04 00:17:24 +0530 | [diff] [blame] | 63 | NICIRA_TUN_GPE_NP(111), |
| 64 | NICIRA_SET_NSH_SPI(113), |
| 65 | NICIRA_SET_NSH_SI(114), |
| 66 | NICIRA_SET_NSH_CH1(115), |
| 67 | NICIRA_SET_NSH_CH2(116), |
| 68 | NICIRA_SET_NSH_CH3(117), |
| 69 | NICIRA_SET_NSH_CH4(118), |
| 70 | NICIRA_NSH_MDTYPE(119), |
| 71 | NICIRA_NSH_NP(120), |
| 72 | NICIRA_ENCAP_ETH_SRC(121), |
| 73 | NICIRA_ENCAP_ETH_DST(122), |
| 74 | NICIRA_ENCAP_ETH_TYPE(123), |
Frank Wang | 72c5e43 | 2016-09-23 17:20:49 +0800 | [diff] [blame] | 75 | OPLINK_ATTENUATION(130), |
Andreas Pantelopoulos | fdcfe53 | 2018-04-02 10:59:23 -0700 | [diff] [blame] | 76 | OFDPA_ALLOW_VLAN_TRANSLATION(131), |
| 77 | ONF_COPY_FIELD(132), |
Frank Wang | 72c5e43 | 2016-09-23 17:20:49 +0800 | [diff] [blame] | 78 | UNRESOLVED_TYPE(200); |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 79 | |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 80 | private ExtensionTreatmentType type; |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 81 | |
| 82 | /** |
Jonathan Hart | 010527b | 2015-12-02 16:11:53 -0800 | [diff] [blame] | 83 | * Creates a new named extension treatment type. |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 84 | * |
| 85 | * @param type type code |
| 86 | */ |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 87 | ExtensionTreatmentTypes(int type) { |
| 88 | this.type = new ExtensionTreatmentType(type); |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 89 | } |
| 90 | |
| 91 | /** |
| 92 | * Gets the extension type object for this named type code. |
| 93 | * |
| 94 | * @return extension type object |
| 95 | */ |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 96 | public ExtensionTreatmentType type() { |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 97 | return type; |
| 98 | } |
| 99 | } |
| 100 | |
| 101 | private final int type; |
| 102 | |
| 103 | /** |
| 104 | * Creates an extension type with the given int type code. |
| 105 | * |
| 106 | * @param type type code |
| 107 | */ |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 108 | public ExtensionTreatmentType(int type) { |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 109 | this.type = type; |
| 110 | } |
| 111 | |
Jian Li | dab7256 | 2016-04-12 14:10:32 -0700 | [diff] [blame] | 112 | /** |
| 113 | * Returns extension treatment type. |
| 114 | * |
| 115 | * @return extension treatment type |
| 116 | */ |
| 117 | public int type() { |
| 118 | return type; |
| 119 | } |
| 120 | |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 121 | @Override |
| 122 | public int hashCode() { |
| 123 | return Objects.hash(type); |
| 124 | } |
| 125 | |
| 126 | @Override |
| 127 | public boolean equals(Object obj) { |
| 128 | if (this == obj) { |
| 129 | return true; |
| 130 | } |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 131 | if (obj instanceof ExtensionTreatmentType) { |
| 132 | final ExtensionTreatmentType that = (ExtensionTreatmentType) obj; |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 133 | return this.type == that.type; |
| 134 | } |
| 135 | return false; |
| 136 | } |
| 137 | |
| 138 | @Override |
| 139 | public String toString() { |
alshabib | 880b644 | 2015-11-23 22:13:04 -0800 | [diff] [blame] | 140 | return MoreObjects.toStringHelper(ExtensionTreatmentType.class) |
Jonathan Hart | 3c25916 | 2015-10-21 21:31:19 -0700 | [diff] [blame] | 141 | .add("type", type) |
| 142 | .toString(); |
| 143 | } |
| 144 | } |