1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
/*
* Copyright 2014-2015 Open Networking Laboratory
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onosproject.net.flow.instructions;
import static com.google.common.base.MoreObjects.toStringHelper;
import java.util.Objects;
import org.onlab.packet.IpAddress;
/**
* Abstraction of a single traffic treatment step.
*/
public abstract class L3ModificationInstruction implements Instruction {
/**
* Represents the type of traffic treatment.
*/
public enum L3SubType {
/**
* IPv4 src modification.
*/
IPV4_SRC,
/**
* IPv4 dst modification.
*/
IPV4_DST,
/**
* IPv6 src modification.
*/
IPV6_SRC,
/**
* IPv6 dst modification.
*/
IPV6_DST,
/**
* IPv6 flow label modification.
*/
IPV6_FLABEL,
/**
* Decrement TTL.
*/
DEC_TTL,
/**
* Copy TTL out.
*/
TTL_OUT,
/**
* Copy TTL in.
*/
TTL_IN
//TODO: remaining types
}
/**
* Returns the subtype of the modification instruction.
* @return type of instruction
*/
public abstract L3SubType subtype();
@Override
public final Type type() {
return Type.L3MODIFICATION;
}
/**
* Represents a L3 src/dst modification instruction.
*/
public static final class ModIPInstruction extends L3ModificationInstruction {
private final L3SubType subtype;
private final IpAddress ip;
ModIPInstruction(L3SubType subType, IpAddress addr) {
this.subtype = subType;
this.ip = addr;
}
@Override
public L3SubType subtype() {
return this.subtype;
}
public IpAddress ip() {
return this.ip;
}
@Override
public String toString() {
return toStringHelper(subtype().toString())
.add("ip", ip).toString();
}
@Override
public int hashCode() {
return Objects.hash(type(), subtype(), ip);
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj instanceof ModIPInstruction) {
ModIPInstruction that = (ModIPInstruction) obj;
return Objects.equals(ip, that.ip) &&
Objects.equals(this.subtype(), that.subtype());
}
return false;
}
}
/**
* Represents a L3 IPv6 Flow Label (RFC 6437) modification instruction
* (20 bits unsigned integer).
*/
public static final class ModIPv6FlowLabelInstruction
extends L3ModificationInstruction {
private static final int MASK = 0xfffff;
private final int flowLabel; // IPv6 flow label: 20 bits
/**
* Creates a new flow mod instruction.
*
* @param flowLabel the IPv6 flow label to set in the treatment (20 bits)
*/
ModIPv6FlowLabelInstruction(int flowLabel) {
this.flowLabel = flowLabel & MASK;
}
@Override
public L3SubType subtype() {
return L3SubType.IPV6_FLABEL;
}
/**
* Gets the IPv6 flow label to set in the treatment.
*
* @return the IPv6 flow label to set in the treatment (20 bits)
*/
public int flowLabel() {
return this.flowLabel;
}
@Override
public String toString() {
return toStringHelper(subtype().toString())
.add("flowLabel", Long.toHexString(flowLabel)).toString();
}
@Override
public int hashCode() {
return Objects.hash(type(), subtype(), flowLabel);
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj instanceof ModIPv6FlowLabelInstruction) {
ModIPv6FlowLabelInstruction that =
(ModIPv6FlowLabelInstruction) obj;
return Objects.equals(flowLabel, that.flowLabel);
}
return false;
}
}
/**
* Represents a L3 TTL modification instruction.
*/
public static final class ModTtlInstruction extends L3ModificationInstruction {
private final L3SubType subtype;
ModTtlInstruction(L3SubType subtype) {
this.subtype = subtype;
}
@Override
public L3SubType subtype() {
return this.subtype;
}
@Override
public String toString() {
return toStringHelper(subtype().toString())
.toString();
}
@Override
public int hashCode() {
return Objects.hash(type(), subtype());
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj instanceof ModTtlInstruction) {
ModTtlInstruction that = (ModTtlInstruction) obj;
return Objects.equals(this.subtype(), that.subtype());
}
return false;
}
}
}
|
