Changes for New Netvirt SFC Classifier
[genius.git] / mdsalutil / mdsalutil-api / src / main / java / org / opendaylight / genius / mdsalutil / NwConstants.java
1 /*
2  * Copyright (c) 2016 Ericsson India Global Services Pvt Ltd. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 package org.opendaylight.genius.mdsalutil;
9
10 import java.math.BigInteger;
11
12 public final class NwConstants {
13
14     // EthType Values
15     public static final int ETHTYPE_802_1Q            = 0X8100;
16     public static final int ETHTYPE_IPV4              = 0X0800;
17     public static final int ETHTYPE_IPV6              = 0x86dd;
18     public static final int ETHTYPE_ARP               = 0X0806;
19
20     public static final int ETHTYPE_MPLS_UC           = 0X8847;
21     public static final int ETHTYPE_PBB               = 0X88E7;
22
23     public static final String MACADDR_SEP = ":";
24
25     public static final String IPV4PREFIX = "/32";
26     public static final String IPV6PREFIX = "/128";
27     public static final String IPV4_SEP = ".";
28     public static final String IPV6_SEP = ":";
29
30     //Protocol Type
31     public static final int IP_PROT_ICMP = 1;
32     public static final int IP_PROT_TCP = 6;
33     public static final int IP_PROT_UDP = 17;
34     public static final int IP_PROT_GRE = 47;
35
36     //ARP TYPE
37     public static final int ARP_REQUEST = 1;
38     public static final int ARP_REPLY = 2;
39
40     //Default Port
41     public static final int UDP_DEFAULT_PORT = 4789;
42
43
44     // Flow Actions
45     public static final int ADD_FLOW = 0;
46     public static final int DEL_FLOW = 1;
47     public static final int MOD_FLOW = 2;
48
49     // Flow Constants
50     public static final String FLOWID_SEPARATOR = ".";
51     public static final int TABLE_MISS_FLOW = 0;
52     public static final int TABLE_MISS_PRIORITY = 0;
53
54     public static final int DEFAULT_ARP_FLOW_PRIORITY = 100;
55
56     // Ingress (w.r.t switch) service indexes
57     public static final short DEFAULT_SERVICE_INDEX = 0;
58     public static final short SFC_SERVICE_INDEX = 1;
59     public static final short SCF_SERVICE_INDEX = 1;
60     public static final short ACL_SERVICE_INDEX = 2;
61     public static final short SFC_CLASSIFIER_INDEX = 3;
62     public static final short DHCP_SERVICE_INDEX = 4;
63     public static final short QOS_SERVICE_INDEX = 5;
64     public static final short IPV6_SERVICE_INDEX = 6;
65     public static final short L3VPN_SERVICE_INDEX = 7;
66     public static final short ELAN_SERVICE_INDEX = 8;
67     public static final short DEFAULT_EGRESS_SERVICE_INDEX = 7;
68
69     public static final String DHCP_SERVICE_NAME = "DHCP_SERVICE";
70     public static final String ACL_SERVICE_NAME = "ACL_SERVICE";
71     public static final String QOS_SERVICE_NAME = "QOS_SERVICE";
72     public static final String IPV6_SERVICE_NAME = "IPV6_SERVICE";
73     public static final String SCF_SERVICE_NAME = "SCF_SERVICE";
74     public static final String SFC_SERVICE_NAME = "SFC_SERVICE";
75     public static final String L3VPN_SERVICE_NAME = "L3VPN_SERVICE";
76     public static final String ELAN_SERVICE_NAME = "ELAN_SERVICE";
77     public static final String SFC_CLASSIFIER_SERVICE_NAME = "SFC_CLASSIFIER_SERVICE";
78     public static final String DEFAULT_EGRESS_SERVICE_NAME = "DEFAULT_EGRESS_SERVICE";
79
80     // Egress (w.r.t switch) service indexes
81     public static final short EGRESS_ACL_SERVICE_INDEX = 6;
82     public static final short EGRESS_SFC_CLASSIFIER_SERVICE_INDEX = 7;
83
84     public static final String EGRESS_ACL_SERVICE_NAME = "EGRESS_ACL_SERVICE";
85     public static final String EGRESS_SFC_CLASSIFIER_SERVICE_NAME = "EGRESS_SFC_CLASSIFIER_SERVICE";
86
87     public static final BigInteger COOKIE_IPV6_TABLE = new BigInteger("4000000", 16);
88     public static final BigInteger COOKIE_QOS_TABLE = new BigInteger("4000001", 16);
89     public static final BigInteger VLAN_TABLE_COOKIE = new BigInteger("8000000", 16);
90     public static final BigInteger COOKIE_VM_INGRESS_TABLE = new BigInteger("8000001", 16);
91     public static final BigInteger COOKIE_VM_LFIB_TABLE = new BigInteger("8000002", 16);
92     public static final BigInteger COOKIE_VM_FIB_TABLE =  new BigInteger("8000003", 16);
93     public static final BigInteger COOKIE_DNAT_TABLE = new BigInteger("8000004", 16);
94     public static final BigInteger COOKIE_TS_TABLE = new BigInteger("8000005", 16);
95     public static final BigInteger COOKIE_SNAT_TABLE = new BigInteger("8000006", 16);
96     public static final BigInteger EGRESS_DISPATCHER_TABLE_COOKIE = new BigInteger("8000007", 16);
97     public static final BigInteger COOKIE_OUTBOUND_NAPT_TABLE = new BigInteger("8000008", 16);
98     public static final BigInteger COOKIE_L3_GW_MAC_TABLE = new BigInteger("8000009", 16);
99     public static final BigInteger COOKIE_VXLAN_TRUNK_L2_TABLE = new BigInteger("1200000", 16);
100     public static final BigInteger COOKIE_GRE_TRUNK_L2_TABLE = new BigInteger("1400000", 16);
101     public static final BigInteger COOKIE_ELAN_INGRESS_TABLE = new BigInteger("8040000", 16);
102     public static final BigInteger TUNNEL_TABLE_COOKIE = new BigInteger("9000000", 16);
103     public static final BigInteger COOKIE_ARP_RESPONDER = new BigInteger("8220000", 16);
104
105     //Table IDs
106     public static final short VLAN_INTERFACE_INGRESS_TABLE = 0;
107     public static final short VXLAN_TRUNK_INTERFACE_TABLE = 10;
108     public static final short TRUNK_L2_TABLE = 11;
109     public static final short GRE_TRUNK_INTERFACE_TABLE = 12;
110     public static final short LPORT_DISPATCHER_TABLE = 17;
111     public static final short DHCP_TABLE_EXTERNAL_TUNNEL = 18;
112     public static final short L3_GW_MAC_TABLE = 19;
113     public static final short L3_LFIB_TABLE = 20;
114     public static final short L3_FIB_TABLE = 21;
115     public static final short L3_SUBNET_ROUTE_TABLE = 22;
116     public static final short L3VNI_EXTERNAL_TUNNEL_DEMUX_TABLE = 23;
117     public static final short PDNAT_TABLE = 25;
118     public static final short PSNAT_TABLE = 26;
119     public static final short DNAT_TABLE = 27;
120     public static final short SNAT_TABLE = 28;
121     public static final short INTERNAL_TUNNEL_TABLE = 36;
122     public static final short EXTERNAL_TUNNEL_TABLE = 38;
123     public static final short INBOUND_NAPT_TABLE = 44;
124     public static final short IPV6_TABLE = 45;
125     public static final short OUTBOUND_NAPT_TABLE = 46;
126     public static final short NAPT_PFIB_TABLE = 47;
127     public static final short ELAN_BASE_TABLE = 48;
128     public static final short ELAN_SMAC_LEARNED_TABLE = 49;
129     public static final short ELAN_SMAC_TABLE = 50;
130     public static final short ELAN_DMAC_TABLE = 51;
131     public static final short ELAN_UNKNOWN_DMAC_TABLE = 52;
132     public static final short ELAN_FILTER_EQUALS_TABLE = 55;
133     public static final short DHCP_TABLE = 60;
134     public static final short SCF_UP_SUB_FILTER_TCP_BASED_TABLE = 70;
135     public static final short SCF_DOWN_SUB_FILTER_TCP_BASED_TABLE = 72;
136     public static final short SCF_CHAIN_FWD_TABLE = 75;
137     public static final short L3_INTERFACE_TABLE = 80;
138     public static final short ARP_RESPONDER_TABLE = 81;
139     public static final short SFC_TRANSPORT_CLASSIFIER_TABLE = 82;
140     public static final short SFC_TRANSPORT_INGRESS_TABLE = 83;
141     public static final short SFC_TRANSPORT_PATH_MAPPER_TABLE = 84;
142     public static final short SFC_TRANSPORT_PATH_MAPPER_ACL_TABLE = 85;
143     public static final short SFC_TRANSPORT_NEXT_HOP_TABLE = 86;
144     public static final short SFC_TRANSPORT_EGRESS_TABLE = 87;
145     public static final short QOS_DSCP_TABLE = 90;
146     public static final short INGRESS_SFC_CLASSIFIER_FILTER_TABLE = 100;
147     public static final short INGRESS_SFC_CLASSIFIER_ACL_TABLE = 101;
148     public static final short EGRESS_SFC_CLASSIFIER_FILTER_TABLE = 110;
149     public static final short EGRESS_SFC_CLASSIFIER_ACL_TABLE = 111;
150     public static final short INGRESS_ACL_TABLE = 211;
151     public static final short INGRESS_ACL_REMOTE_ACL_TABLE = 212;
152     public static final short INGRESS_ACL_FILTER_TABLE = 213;
153     public static final short INGRESS_LEARN_TABLE = 212;
154     public static final short INGRESS_LEARN_ACL_REMOTE_ACL_TABLE = 213;
155     public static final short INGRESS_LEARN_ACL_FILTER_TABLE = 214;
156     public static final short EGRESS_LPORT_DISPATCHER_TABLE = 220;
157     public static final short EGRESS_ACL_TABLE = 241;
158     public static final short EGRESS_ACL_REMOTE_ACL_TABLE = 242;
159     public static final short EGRESS_ACL_FILTER_TABLE = 243;
160     public static final short EGRESS_LEARN_TABLE = 242;
161     public static final short EGRESS_LEARN_ACL_REMOTE_ACL_TABLE = 243;
162     public static final short EGRESS_LEARN_ACL_FILTER_TABLE = 244;
163
164     public enum NxmOfFieldType {
165         NXM_OF_IN_PORT(0x0000, 0, 2, 16),
166         NXM_OF_ETH_DST(0x0000, 1, 6, 48),
167         NXM_OF_ETH_SRC(0x0000, 2, 6, 48),
168         NXM_OF_ETH_TYPE(0x0000, 3, 2, 16),
169         NXM_OF_VLAN_TCI(0x0000, 4, 2, 12),
170         NXM_OF_IP_TOS(0x0000, 5, 1, 8),
171         NXM_OF_IP_PROTO(0x0000, 6, 1, 8),
172         NXM_OF_IP_SRC(0x0000, 7, 4, 32),
173         NXM_OF_IP_DST(0x0000, 8, 4, 32),
174         NXM_OF_TCP_SRC(0x0000, 9, 2, 16),
175         NXM_OF_TCP_DST(0x0000, 10, 2, 16),
176         NXM_OF_UDP_SRC(0x0000, 11, 2, 16),
177         NXM_OF_UDP_DST(0x0000, 12, 2, 16),
178         NXM_OF_ICMP_TYPE(0x0000, 13, 1, 8),
179         NXM_OF_ICMP_CODE(0x0000, 14, 1, 8),
180         NXM_OF_ARP_OP(0x0000, 15, 2, 16),
181         NXM_OF_ARP_SPA(0x0000, 16, 4, 16),
182         NXM_OF_ARP_TPA(0x0000, 17, 4, 16),
183         NXM_NX_REG0(0x0001, 0, 4, -1),
184         NXM_NX_REG1(0x0001, 1, 4, -1),
185         NXM_NX_REG2(0x0001, 2, 4, -1),
186         NXM_NX_REG3(0x0001, 3, 4, -1),
187         NXM_NX_REG4(0x0001, 4, 4, -1),
188         NXM_NX_REG5(0x0001, 5, 4, -1),
189         NXM_NX_REG6(0x0001, 6, 4, -1),
190         NXM_NX_REG7(0x0001, 7, 4, -1);
191
192         long type;
193         int flowModHeaderLen;
194
195         NxmOfFieldType(long vendor, long field, long length, int flowModHeaderLen) {
196             type = nxmHeader(vendor, field, length);
197             this.flowModHeaderLen = flowModHeaderLen;
198         }
199
200         private static long nxmHeader(long vendor, long field, long length) {
201             return vendor << 16 | field << 9 | length;
202         }
203
204         @Deprecated
205         public String getHexType() {
206             return String.valueOf(type);
207         }
208
209         public long getType() {
210             return type;
211         }
212
213         @Deprecated
214         public String getFlowModHeaderLen() {
215             return String.valueOf(flowModHeaderLen);
216         }
217
218         public int getFlowModHeaderLenInt() {
219             return flowModHeaderLen;
220         }
221     }
222 }