blob: 2730c38a6abd663776ba2bcceb3afc153cfe8d23 [file] [log] [blame]
Ray Milkeyd43fe452015-05-29 09:35:12 -07001/*
Brian O'Connora09fe5b2017-08-03 21:12:30 -07002 * Copyright 2015-present Open Networking Foundation
Ray Milkeyd43fe452015-05-29 09:35:12 -07003 *
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 */
16package org.onosproject.codec.impl;
17
Jian Lidab72562016-04-12 14:10:32 -070018import com.fasterxml.jackson.databind.JsonNode;
Jian Li1ef82db2016-03-03 14:43:21 -080019import com.fasterxml.jackson.databind.node.ObjectNode;
Cem Türker3baff672017-10-12 15:09:01 +030020import com.google.common.collect.Maps;
Jian Lidab72562016-04-12 14:10:32 -070021import org.onlab.osgi.DefaultServiceDirectory;
22import org.onlab.osgi.ServiceDirectory;
Konstantinos Kanonakis9215ff22016-11-04 13:28:11 -050023import org.onlab.packet.EthType;
Ray Milkeyd43fe452015-05-29 09:35:12 -070024import org.onlab.packet.IpAddress;
25import org.onlab.packet.MacAddress;
26import org.onlab.packet.MplsLabel;
Hyunsun Moonfab29502015-08-25 13:39:16 -070027import org.onlab.packet.TpPort;
Ray Milkeyd43fe452015-05-29 09:35:12 -070028import org.onlab.packet.VlanId;
Yafit Hadar5796d972015-10-15 13:16:11 +030029import org.onlab.util.HexString;
Frank Wang74ce2c12018-04-11 20:26:45 +080030import org.onlab.util.ImmutableByteSequence;
Jonathan Harte3bcfc32016-08-16 17:12:49 -070031import org.onosproject.codec.CodecContext;
Jian Lice8c5602016-03-03 21:43:24 -080032import org.onosproject.core.GroupId;
Ray Milkeyd43fe452015-05-29 09:35:12 -070033import org.onosproject.net.ChannelSpacing;
Jian Lidab72562016-04-12 14:10:32 -070034import org.onosproject.net.Device;
35import org.onosproject.net.DeviceId;
Ray Milkeyd43fe452015-05-29 09:35:12 -070036import org.onosproject.net.GridType;
Ray Milkeyd43fe452015-05-29 09:35:12 -070037import org.onosproject.net.OchSignal;
Yafit Hadar5796d972015-10-15 13:16:11 +030038import org.onosproject.net.OduSignalId;
Ray Milkeyd43fe452015-05-29 09:35:12 -070039import org.onosproject.net.PortNumber;
Jian Lidab72562016-04-12 14:10:32 -070040import org.onosproject.net.device.DeviceService;
Carmelo Casconecb4327a2018-09-11 15:17:23 -070041import org.onosproject.net.flow.ExtensionTreatmentCodec;
Cem Türker3baff672017-10-12 15:09:01 +030042import org.onosproject.net.flow.StatTriggerField;
43import org.onosproject.net.flow.StatTriggerFlag;
Jian Lidab72562016-04-12 14:10:32 -070044import org.onosproject.net.flow.instructions.ExtensionTreatment;
Ray Milkeyd43fe452015-05-29 09:35:12 -070045import org.onosproject.net.flow.instructions.Instruction;
46import org.onosproject.net.flow.instructions.Instructions;
47import org.onosproject.net.flow.instructions.L0ModificationInstruction;
Yafit Hadar5796d972015-10-15 13:16:11 +030048import org.onosproject.net.flow.instructions.L1ModificationInstruction;
Ray Milkeyd43fe452015-05-29 09:35:12 -070049import org.onosproject.net.flow.instructions.L2ModificationInstruction;
50import org.onosproject.net.flow.instructions.L3ModificationInstruction;
Hyunsun Moonfab29502015-08-25 13:39:16 -070051import org.onosproject.net.flow.instructions.L4ModificationInstruction;
Jian Li47b26232016-03-07 09:59:59 -080052import org.onosproject.net.meter.MeterId;
Frank Wang74ce2c12018-04-11 20:26:45 +080053import org.onosproject.net.pi.model.PiActionId;
54import org.onosproject.net.pi.model.PiActionParamId;
55import org.onosproject.net.pi.runtime.PiAction;
Frank Wang74ce2c12018-04-11 20:26:45 +080056import org.onosproject.net.pi.runtime.PiActionParam;
Carmelo Casconecb4327a2018-09-11 15:17:23 -070057import org.onosproject.net.pi.runtime.PiActionProfileGroupId;
58import org.onosproject.net.pi.runtime.PiActionProfileMemberId;
Frank Wang74ce2c12018-04-11 20:26:45 +080059import org.onosproject.net.pi.runtime.PiTableAction;
Jian Lidab72562016-04-12 14:10:32 -070060import org.slf4j.Logger;
Ray Milkeyd43fe452015-05-29 09:35:12 -070061
Cem Türker3baff672017-10-12 15:09:01 +030062import java.util.Map;
Konstantinos Kanonakis9215ff22016-11-04 13:28:11 -050063import java.util.regex.Matcher;
64import java.util.regex.Pattern;
65
Jian Li1ef82db2016-03-03 14:43:21 -080066import static org.onlab.util.Tools.nullIsIllegal;
Cem Türker3baff672017-10-12 15:09:01 +030067import static org.onosproject.codec.impl.InstructionCodec.STAT_PACKET_COUNT;
Jian Lidab72562016-04-12 14:10:32 -070068import static org.slf4j.LoggerFactory.getLogger;
Ray Milkeyd43fe452015-05-29 09:35:12 -070069
70/**
71 * Decoding portion of the instruction codec.
72 */
Ray Milkey6d7968e2015-07-06 14:30:02 -070073public final class DecodeInstructionCodecHelper {
Ray Milkey9c9cde42018-01-12 14:22:06 -080074 private static final Logger log = getLogger(DecodeInstructionCodecHelper.class);
Ray Milkeyd43fe452015-05-29 09:35:12 -070075 private final ObjectNode json;
Jonathan Harte3bcfc32016-08-16 17:12:49 -070076 private final CodecContext context;
Konstantinos Kanonakis9215ff22016-11-04 13:28:11 -050077 private static final Pattern ETHTYPE_PATTERN = Pattern.compile("0x([0-9a-fA-F]{4})");
Ray Milkeyd43fe452015-05-29 09:35:12 -070078
79 /**
80 * Creates a decode instruction codec object.
81 *
82 * @param json JSON object to decode
Ray Milkeyef794342016-11-09 16:20:29 -080083 * @param context codec context
Ray Milkeyd43fe452015-05-29 09:35:12 -070084 */
Jonathan Harte3bcfc32016-08-16 17:12:49 -070085 public DecodeInstructionCodecHelper(ObjectNode json, CodecContext context) {
Ray Milkeyd43fe452015-05-29 09:35:12 -070086 this.json = json;
Jonathan Harte3bcfc32016-08-16 17:12:49 -070087 this.context = context;
Ray Milkeyd43fe452015-05-29 09:35:12 -070088 }
89
90 /**
91 * Decodes a Layer 2 instruction.
92 *
93 * @return instruction object decoded from the JSON
94 * @throws IllegalArgumentException if the JSON is invalid
95 */
96 private Instruction decodeL2() {
Jayasree Ghosh8aca6772016-10-04 03:32:11 +053097 String subType = nullIsIllegal(json.get(InstructionCodec.SUBTYPE),
98 InstructionCodec.SUBTYPE + InstructionCodec.ERROR_MESSAGE).asText();
Ray Milkeyd43fe452015-05-29 09:35:12 -070099
100 if (subType.equals(L2ModificationInstruction.L2SubType.ETH_SRC.name())) {
101 String mac = nullIsIllegal(json.get(InstructionCodec.MAC),
102 InstructionCodec.MAC + InstructionCodec.MISSING_MEMBER_MESSAGE).asText();
103 return Instructions.modL2Src(MacAddress.valueOf(mac));
104 } else if (subType.equals(L2ModificationInstruction.L2SubType.ETH_DST.name())) {
105 String mac = nullIsIllegal(json.get(InstructionCodec.MAC),
106 InstructionCodec.MAC + InstructionCodec.MISSING_MEMBER_MESSAGE).asText();
107 return Instructions.modL2Dst(MacAddress.valueOf(mac));
108 } else if (subType.equals(L2ModificationInstruction.L2SubType.VLAN_ID.name())) {
109 short vlanId = (short) nullIsIllegal(json.get(InstructionCodec.VLAN_ID),
110 InstructionCodec.VLAN_ID + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt();
111 return Instructions.modVlanId(VlanId.vlanId(vlanId));
112 } else if (subType.equals(L2ModificationInstruction.L2SubType.VLAN_PCP.name())) {
113 byte vlanPcp = (byte) nullIsIllegal(json.get(InstructionCodec.VLAN_PCP),
114 InstructionCodec.VLAN_PCP + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt();
115 return Instructions.modVlanPcp(vlanPcp);
116 } else if (subType.equals(L2ModificationInstruction.L2SubType.MPLS_LABEL.name())) {
117 int label = nullIsIllegal(json.get(InstructionCodec.MPLS_LABEL),
118 InstructionCodec.MPLS_LABEL + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt();
119 return Instructions.modMplsLabel(MplsLabel.mplsLabel(label));
120 } else if (subType.equals(L2ModificationInstruction.L2SubType.MPLS_PUSH.name())) {
121 return Instructions.pushMpls();
122 } else if (subType.equals(L2ModificationInstruction.L2SubType.MPLS_POP.name())) {
Sivachidambaram Subramaniandab7f4b2017-05-15 12:28:12 +0530123 if (json.has(InstructionCodec.ETHERNET_TYPE)) {
124 return Instructions.popMpls(getEthType());
125 }
Ray Milkeyd43fe452015-05-29 09:35:12 -0700126 return Instructions.popMpls();
127 } else if (subType.equals(L2ModificationInstruction.L2SubType.DEC_MPLS_TTL.name())) {
128 return Instructions.decMplsTtl();
129 } else if (subType.equals(L2ModificationInstruction.L2SubType.VLAN_POP.name())) {
130 return Instructions.popVlan();
131 } else if (subType.equals(L2ModificationInstruction.L2SubType.VLAN_PUSH.name())) {
Konstantinos Kanonakis9215ff22016-11-04 13:28:11 -0500132 if (json.has(InstructionCodec.ETHERNET_TYPE)) {
133 return Instructions.pushVlan(getEthType());
134 }
Ray Milkeyd43fe452015-05-29 09:35:12 -0700135 return Instructions.pushVlan();
Hyunsun Moon7080a0d2015-08-14 19:18:48 -0700136 } else if (subType.equals(L2ModificationInstruction.L2SubType.TUNNEL_ID.name())) {
137 long tunnelId = nullIsIllegal(json.get(InstructionCodec.TUNNEL_ID),
138 InstructionCodec.TUNNEL_ID + InstructionCodec.MISSING_MEMBER_MESSAGE).asLong();
139 return Instructions.modTunnelId(tunnelId);
Ray Milkeyd43fe452015-05-29 09:35:12 -0700140 }
141 throw new IllegalArgumentException("L2 Instruction subtype "
142 + subType + " is not supported");
143 }
144
145 /**
146 * Decodes a Layer 3 instruction.
147 *
148 * @return instruction object decoded from the JSON
149 * @throws IllegalArgumentException if the JSON is invalid
150 */
151 private Instruction decodeL3() {
Jayasree Ghosh8aca6772016-10-04 03:32:11 +0530152 String subType = nullIsIllegal(json.get(InstructionCodec.SUBTYPE),
153 InstructionCodec.SUBTYPE + InstructionCodec.ERROR_MESSAGE).asText();
Ray Milkeyd43fe452015-05-29 09:35:12 -0700154
155 if (subType.equals(L3ModificationInstruction.L3SubType.IPV4_SRC.name())) {
156 IpAddress ip = IpAddress.valueOf(nullIsIllegal(json.get(InstructionCodec.IP),
157 InstructionCodec.IP + InstructionCodec.MISSING_MEMBER_MESSAGE).asText());
158 return Instructions.modL3Src(ip);
159 } else if (subType.equals(L3ModificationInstruction.L3SubType.IPV4_DST.name())) {
160 IpAddress ip = IpAddress.valueOf(nullIsIllegal(json.get(InstructionCodec.IP),
161 InstructionCodec.IP + InstructionCodec.MISSING_MEMBER_MESSAGE).asText());
162 return Instructions.modL3Dst(ip);
163 } else if (subType.equals(L3ModificationInstruction.L3SubType.IPV6_SRC.name())) {
164 IpAddress ip = IpAddress.valueOf(nullIsIllegal(json.get(InstructionCodec.IP),
165 InstructionCodec.IP + InstructionCodec.MISSING_MEMBER_MESSAGE).asText());
166 return Instructions.modL3IPv6Src(ip);
167 } else if (subType.equals(L3ModificationInstruction.L3SubType.IPV6_DST.name())) {
168 IpAddress ip = IpAddress.valueOf(nullIsIllegal(json.get(InstructionCodec.IP),
169 InstructionCodec.IP + InstructionCodec.MISSING_MEMBER_MESSAGE).asText());
170 return Instructions.modL3IPv6Dst(ip);
171 } else if (subType.equals(L3ModificationInstruction.L3SubType.IPV6_FLABEL.name())) {
172 int flowLabel = nullIsIllegal(json.get(InstructionCodec.FLOW_LABEL),
173 InstructionCodec.FLOW_LABEL + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt();
174 return Instructions.modL3IPv6FlowLabel(flowLabel);
Jonathan Hartcc962d82016-08-09 16:52:22 -0700175 } else if (subType.equals(L3ModificationInstruction.L3SubType.TTL_IN.name())) {
176 return Instructions.copyTtlIn();
177 } else if (subType.equals(L3ModificationInstruction.L3SubType.TTL_OUT.name())) {
178 return Instructions.copyTtlOut();
179 } else if (subType.equals(L3ModificationInstruction.L3SubType.DEC_TTL.name())) {
180 return Instructions.decNwTtl();
Ray Milkeyd43fe452015-05-29 09:35:12 -0700181 }
182 throw new IllegalArgumentException("L3 Instruction subtype "
183 + subType + " is not supported");
184 }
185
186 /**
187 * Decodes a Layer 0 instruction.
188 *
189 * @return instruction object decoded from the JSON
190 * @throws IllegalArgumentException if the JSON is invalid
191 */
192 private Instruction decodeL0() {
Jayasree Ghosh8aca6772016-10-04 03:32:11 +0530193 String subType = nullIsIllegal(json.get(InstructionCodec.SUBTYPE),
194 InstructionCodec.SUBTYPE + InstructionCodec.ERROR_MESSAGE).asText();
Ray Milkeyd43fe452015-05-29 09:35:12 -0700195
Sho SHIMIZUcc137a92016-03-11 15:10:54 -0800196 if (subType.equals(L0ModificationInstruction.L0SubType.OCH.name())) {
Ray Milkeyd43fe452015-05-29 09:35:12 -0700197 String gridTypeString = nullIsIllegal(json.get(InstructionCodec.GRID_TYPE),
198 InstructionCodec.GRID_TYPE + InstructionCodec.MISSING_MEMBER_MESSAGE).asText();
199 GridType gridType = GridType.valueOf(gridTypeString);
200 if (gridType == null) {
201 throw new IllegalArgumentException("Unknown grid type "
202 + gridTypeString);
203 }
204 String channelSpacingString = nullIsIllegal(json.get(InstructionCodec.CHANNEL_SPACING),
205 InstructionCodec.CHANNEL_SPACING + InstructionCodec.MISSING_MEMBER_MESSAGE).asText();
206 ChannelSpacing channelSpacing = ChannelSpacing.valueOf(channelSpacingString);
207 if (channelSpacing == null) {
208 throw new IllegalArgumentException("Unknown channel spacing "
209 + channelSpacingString);
210 }
211 int spacingMultiplier = nullIsIllegal(json.get(InstructionCodec.SPACING_MULTIPLIER),
212 InstructionCodec.SPACING_MULTIPLIER + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt();
213 int slotGranularity = nullIsIllegal(json.get(InstructionCodec.SLOT_GRANULARITY),
214 InstructionCodec.SLOT_GRANULARITY + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt();
215 return Instructions.modL0Lambda(new OchSignal(gridType, channelSpacing,
216 spacingMultiplier, slotGranularity));
217 }
218 throw new IllegalArgumentException("L0 Instruction subtype "
219 + subType + " is not supported");
220 }
221
222 /**
Yafit Hadar5796d972015-10-15 13:16:11 +0300223 * Decodes a Layer 1 instruction.
224 *
225 * @return instruction object decoded from the JSON
226 * @throws IllegalArgumentException if the JSON is invalid
227 */
228 private Instruction decodeL1() {
Jayasree Ghosh8aca6772016-10-04 03:32:11 +0530229 String subType = nullIsIllegal(json.get(InstructionCodec.SUBTYPE),
230 InstructionCodec.SUBTYPE + InstructionCodec.ERROR_MESSAGE).asText();
Yafit Hadar5796d972015-10-15 13:16:11 +0300231 if (subType.equals(L1ModificationInstruction.L1SubType.ODU_SIGID.name())) {
232 int tributaryPortNumber = nullIsIllegal(json.get(InstructionCodec.TRIBUTARY_PORT_NUMBER),
233 InstructionCodec.TRIBUTARY_PORT_NUMBER + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt();
234 int tributarySlotLen = nullIsIllegal(json.get(InstructionCodec.TRIBUTARY_SLOT_LEN),
235 InstructionCodec.TRIBUTARY_SLOT_LEN + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt();
236 byte[] tributarySlotBitmap = null;
237 tributarySlotBitmap = HexString.fromHexString(
238 nullIsIllegal(json.get(InstructionCodec.TRIBUTARY_SLOT_BITMAP),
239 InstructionCodec.TRIBUTARY_SLOT_BITMAP + InstructionCodec.MISSING_MEMBER_MESSAGE).asText());
240 return Instructions.modL1OduSignalId(OduSignalId.oduSignalId(tributaryPortNumber, tributarySlotLen,
241 tributarySlotBitmap));
242 }
243 throw new IllegalArgumentException("L1 Instruction subtype "
244 + subType + " is not supported");
245 }
246
247 /**
Hyunsun Moonfab29502015-08-25 13:39:16 -0700248 * Decodes a Layer 4 instruction.
249 *
250 * @return instruction object decoded from the JSON
251 * @throws IllegalArgumentException if the JSON is invalid
252 */
253 private Instruction decodeL4() {
Jayasree Ghosh8aca6772016-10-04 03:32:11 +0530254 String subType = nullIsIllegal(json.get(InstructionCodec.SUBTYPE),
255 InstructionCodec.SUBTYPE + InstructionCodec.ERROR_MESSAGE).asText();
Hyunsun Moonfab29502015-08-25 13:39:16 -0700256
257 if (subType.equals(L4ModificationInstruction.L4SubType.TCP_DST.name())) {
258 TpPort tcpPort = TpPort.tpPort(nullIsIllegal(json.get(InstructionCodec.TCP_PORT),
259 InstructionCodec.TCP_PORT + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt());
260 return Instructions.modTcpDst(tcpPort);
261 } else if (subType.equals(L4ModificationInstruction.L4SubType.TCP_SRC.name())) {
262 TpPort tcpPort = TpPort.tpPort(nullIsIllegal(json.get(InstructionCodec.TCP_PORT),
263 InstructionCodec.TCP_PORT + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt());
264 return Instructions.modTcpSrc(tcpPort);
265 } else if (subType.equals(L4ModificationInstruction.L4SubType.UDP_DST.name())) {
266 TpPort udpPort = TpPort.tpPort(nullIsIllegal(json.get(InstructionCodec.UDP_PORT),
267 InstructionCodec.UDP_PORT + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt());
268 return Instructions.modUdpDst(udpPort);
269 } else if (subType.equals(L4ModificationInstruction.L4SubType.UDP_SRC.name())) {
270 TpPort udpPort = TpPort.tpPort(nullIsIllegal(json.get(InstructionCodec.UDP_PORT),
271 InstructionCodec.UDP_PORT + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt());
272 return Instructions.modUdpSrc(udpPort);
273 }
274 throw new IllegalArgumentException("L4 Instruction subtype "
275 + subType + " is not supported");
276 }
277
Frank Wang74ce2c12018-04-11 20:26:45 +0800278 /**
279 * Decodes a protocol-independent instruction.
280 *
281 * @return instruction object decoded from the JSON
282 * @throws IllegalArgumentException if the JSON is invalid
283 */
284 private Instruction decodePi() {
285 String subType = nullIsIllegal(json.get(InstructionCodec.SUBTYPE),
286 InstructionCodec.SUBTYPE + InstructionCodec.ERROR_MESSAGE).asText();
287
288 if (subType.equals(PiTableAction.Type.ACTION.name())) {
289 PiActionId piActionId = PiActionId.of(nullIsIllegal(
290 json.get(InstructionCodec.PI_ACTION_ID),
291 InstructionCodec.PI_ACTION_ID + InstructionCodec.MISSING_MEMBER_MESSAGE).asText());
292 JsonNode params = json.get(InstructionCodec.PI_ACTION_PARAMS);
293
294 PiAction.Builder builder = PiAction.builder();
295 PiActionParam piActionParam;
296 PiActionParamId piActionParamId;
297 if (params != null) {
298 for (Map.Entry<String, String> param : ((Map<String, String>)
299 (context.mapper().convertValue(params, Map.class))).entrySet()) {
300 piActionParamId = PiActionParamId.of(param.getKey());
301 piActionParam = new PiActionParam(piActionParamId,
302 ImmutableByteSequence.copyFrom(
303 HexString.fromHexString(param.getValue(), null)));
304 builder.withParameter(piActionParam);
305 }
306 }
307
308 return Instructions.piTableAction(builder.withId(piActionId).build());
Carmelo Casconecb4327a2018-09-11 15:17:23 -0700309 } else if (subType.equals(PiTableAction.Type.ACTION_PROFILE_GROUP_ID.name())) {
310 PiActionProfileGroupId piActionGroupId = PiActionProfileGroupId.of(nullIsIllegal(
311 json.get(InstructionCodec.PI_ACTION_PROFILE_GROUP_ID),
312 InstructionCodec.PI_ACTION_PROFILE_GROUP_ID + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt());
Frank Wang74ce2c12018-04-11 20:26:45 +0800313
314 return Instructions.piTableAction(piActionGroupId);
Carmelo Casconecb4327a2018-09-11 15:17:23 -0700315 } else if (subType.equals(PiTableAction.Type.ACTION_PROFILE_MEMBER_ID.name())) {
316 PiActionProfileMemberId piActionProfileMemberId = PiActionProfileMemberId.of(nullIsIllegal(
317 json.get(InstructionCodec.PI_ACTION_PROFILE_MEMBER_ID),
318 InstructionCodec.PI_ACTION_PROFILE_MEMBER_ID + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt());
Frank Wang74ce2c12018-04-11 20:26:45 +0800319
Carmelo Casconecb4327a2018-09-11 15:17:23 -0700320 return Instructions.piTableAction(piActionProfileMemberId);
Frank Wang74ce2c12018-04-11 20:26:45 +0800321 }
322 throw new IllegalArgumentException("Protocol-independent Instruction subtype "
323 + subType + " is not supported");
324 }
325
Cem Türker3baff672017-10-12 15:09:01 +0300326 private Instruction decodeStatTrigger() {
327 String statTriggerFlag = nullIsIllegal(json.get(InstructionCodec.STAT_TRIGGER_FLAG),
328 InstructionCodec.STAT_TRIGGER_FLAG + InstructionCodec.ERROR_MESSAGE).asText();
329
330 StatTriggerFlag flag = null;
331
332 if (statTriggerFlag.equals(StatTriggerFlag.ONLY_FIRST.name())) {
333 flag = StatTriggerFlag.ONLY_FIRST;
334 } else if (statTriggerFlag.equals(StatTriggerFlag.PERIODIC.name())) {
335 flag = StatTriggerFlag.PERIODIC;
336 } else {
337 throw new IllegalArgumentException("statTriggerFlag "
338 + statTriggerFlag + " is not supported");
339 }
340 if (!json.has(InstructionCodec.STAT_THRESHOLDS)) {
341 throw new IllegalArgumentException("statThreshold is not added");
342 }
343 JsonNode statThresholdsNode = nullIsIllegal(json.get(InstructionCodec.STAT_THRESHOLDS),
344 InstructionCodec.STAT_THRESHOLDS + InstructionCodec.ERROR_MESSAGE);
345 Map<StatTriggerField, Long> statThresholdMap = getStatThreshold(statThresholdsNode);
346 if (statThresholdMap.isEmpty()) {
347 throw new IllegalArgumentException("statThreshold must have at least one property");
348 }
349 return Instructions.statTrigger(statThresholdMap, flag);
350 }
351
352 private Map<StatTriggerField, Long> getStatThreshold(JsonNode statThresholdNode) {
353 Map<StatTriggerField, Long> statThresholdMap = Maps.newEnumMap(StatTriggerField.class);
354 for (JsonNode jsonNode : statThresholdNode) {
355 if (jsonNode.hasNonNull(InstructionCodec.STAT_BYTE_COUNT)) {
356 JsonNode byteCountNode = jsonNode.get(InstructionCodec.STAT_BYTE_COUNT);
357 if (!byteCountNode.isNull() && byteCountNode.isNumber()) {
358 statThresholdMap.put(StatTriggerField.BYTE_COUNT, byteCountNode.asLong());
359 }
360 } else if (jsonNode.hasNonNull(STAT_PACKET_COUNT)) {
361 JsonNode packetCount = jsonNode.get(STAT_PACKET_COUNT);
362 if (!packetCount.isNull() && packetCount.isNumber()) {
363 statThresholdMap.put(StatTriggerField.PACKET_COUNT, packetCount.asLong());
364 }
365 } else if (jsonNode.hasNonNull(InstructionCodec.STAT_DURATION)) {
366 JsonNode duration = jsonNode.get(InstructionCodec.STAT_DURATION);
367 if (!duration.isNull() && duration.isNumber()) {
368 statThresholdMap.put(StatTriggerField.DURATION, duration.asLong());
369 }
370 } else {
371 log.error("Unsupported stat {}", jsonNode.toString());
372 }
373 }
374
375 return statThresholdMap;
376 }
377
Hyunsun Moonfab29502015-08-25 13:39:16 -0700378 /**
Jian Lidab72562016-04-12 14:10:32 -0700379 * Decodes a extension instruction.
380 *
381 * @return extension treatment
382 */
383 private Instruction decodeExtension() {
384 ObjectNode node = (ObjectNode) json.get(InstructionCodec.EXTENSION);
385 if (node != null) {
386 DeviceId deviceId = getDeviceId();
387
388 ServiceDirectory serviceDirectory = new DefaultServiceDirectory();
389 DeviceService deviceService = serviceDirectory.get(DeviceService.class);
390 Device device = deviceService.getDevice(deviceId);
391
Jonathan Harte3bcfc32016-08-16 17:12:49 -0700392 if (device == null) {
393 throw new IllegalArgumentException("Device not found");
394 }
395
Jian Lidab72562016-04-12 14:10:32 -0700396 if (device.is(ExtensionTreatmentCodec.class)) {
397 ExtensionTreatmentCodec treatmentCodec = device.as(ExtensionTreatmentCodec.class);
Jonathan Harte3bcfc32016-08-16 17:12:49 -0700398 ExtensionTreatment treatment = treatmentCodec.decode(node, context);
Jian Lidab72562016-04-12 14:10:32 -0700399 return Instructions.extension(treatment, deviceId);
400 } else {
Jonathan Harte3bcfc32016-08-16 17:12:49 -0700401 throw new IllegalArgumentException(
402 "There is no codec to decode extension for device " + deviceId.toString());
Jian Lidab72562016-04-12 14:10:32 -0700403 }
404 }
405 return null;
406 }
407
408 /**
409 * Returns device identifier.
410 *
411 * @return device identifier
412 * @throws IllegalArgumentException if the JSON is invalid
413 */
414 private DeviceId getDeviceId() {
415 JsonNode deviceIdNode = json.get(InstructionCodec.DEVICE_ID);
416 if (deviceIdNode != null) {
417 return DeviceId.deviceId(deviceIdNode.asText());
418 }
419 throw new IllegalArgumentException("Empty device identifier");
420 }
421
422 /**
Jian Li70dffe42016-03-08 22:23:02 -0800423 * Extracts port number of the given json node.
424 *
425 * @param jsonNode json node
426 * @return port number
427 */
428 private PortNumber getPortNumber(ObjectNode jsonNode) {
429 PortNumber portNumber;
Jayasree Ghosh8aca6772016-10-04 03:32:11 +0530430 JsonNode portNode = nullIsIllegal(jsonNode.get(InstructionCodec.PORT),
431 InstructionCodec.PORT + InstructionCodec.ERROR_MESSAGE);
432 if (portNode.isLong() || portNode.isInt()) {
433 portNumber = PortNumber.portNumber(portNode.asLong());
434 } else if (portNode.isTextual()) {
435 portNumber = PortNumber.fromString(portNode.textValue());
Jian Li70dffe42016-03-08 22:23:02 -0800436 } else {
437 throw new IllegalArgumentException("Port value "
Jayasree Ghosh8aca6772016-10-04 03:32:11 +0530438 + portNode.toString()
Jian Li70dffe42016-03-08 22:23:02 -0800439 + " is not supported");
440 }
441 return portNumber;
442 }
443
444 /**
Konstantinos Kanonakis9215ff22016-11-04 13:28:11 -0500445 * Returns Ethernet type.
446 *
447 * @return ethernet type
448 * @throws IllegalArgumentException if the JSON is invalid
449 */
450 private EthType getEthType() {
451 String ethTypeStr = nullIsIllegal(json.get(InstructionCodec.ETHERNET_TYPE),
452 InstructionCodec.ETHERNET_TYPE + InstructionCodec.MISSING_MEMBER_MESSAGE).asText();
453 Matcher matcher = ETHTYPE_PATTERN.matcher(ethTypeStr);
454 if (!matcher.matches()) {
455 throw new IllegalArgumentException("ETHERNET_TYPE must be a four digit hex string starting with 0x");
456 }
457 short ethernetType = (short) Integer.parseInt(matcher.group(1), 16);
458 return new EthType(ethernetType);
459 }
460
461 /**
Ray Milkeyd43fe452015-05-29 09:35:12 -0700462 * Decodes the JSON into an instruction object.
463 *
464 * @return Criterion object
465 * @throws IllegalArgumentException if the JSON is invalid
466 */
467 public Instruction decode() {
Jayasree Ghosh8aca6772016-10-04 03:32:11 +0530468 String type = nullIsIllegal(json.get(InstructionCodec.TYPE),
469 InstructionCodec.TYPE + InstructionCodec.ERROR_MESSAGE).asText();
Ray Milkeyd43fe452015-05-29 09:35:12 -0700470
471 if (type.equals(Instruction.Type.OUTPUT.name())) {
Jian Li70dffe42016-03-08 22:23:02 -0800472 return Instructions.createOutput(getPortNumber(json));
Ray Milkey2be39ed2016-02-22 15:54:19 -0800473 } else if (type.equals(Instruction.Type.NOACTION.name())) {
474 return Instructions.createNoAction();
Jian Li1ef82db2016-03-03 14:43:21 -0800475 } else if (type.equals(Instruction.Type.TABLE.name())) {
Jayasree Ghosh8aca6772016-10-04 03:32:11 +0530476 return Instructions.transition(nullIsIllegal(json.get(InstructionCodec.TABLE_ID),
477 InstructionCodec.TABLE_ID + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt());
Jian Lice8c5602016-03-03 21:43:24 -0800478 } else if (type.equals(Instruction.Type.GROUP.name())) {
Yi Tsengfa394de2017-02-01 11:26:40 -0800479 GroupId groupId = new GroupId(nullIsIllegal(json.get(InstructionCodec.GROUP_ID),
Jayasree Ghosh8aca6772016-10-04 03:32:11 +0530480 InstructionCodec.GROUP_ID + InstructionCodec.MISSING_MEMBER_MESSAGE).asInt());
Jian Lice8c5602016-03-03 21:43:24 -0800481 return Instructions.createGroup(groupId);
Jian Li47b26232016-03-07 09:59:59 -0800482 } else if (type.equals(Instruction.Type.METER.name())) {
Jayasree Ghosh8aca6772016-10-04 03:32:11 +0530483 MeterId meterId = MeterId.meterId(nullIsIllegal(json.get(InstructionCodec.METER_ID),
484 InstructionCodec.METER_ID + InstructionCodec.MISSING_MEMBER_MESSAGE).asLong());
Jian Li47b26232016-03-07 09:59:59 -0800485 return Instructions.meterTraffic(meterId);
Jian Li70dffe42016-03-08 22:23:02 -0800486 } else if (type.equals(Instruction.Type.QUEUE.name())) {
Jayasree Ghosh8aca6772016-10-04 03:32:11 +0530487 long queueId = nullIsIllegal(json.get(InstructionCodec.QUEUE_ID),
488 InstructionCodec.QUEUE_ID + InstructionCodec.MISSING_MEMBER_MESSAGE).asLong();
ke han74702102016-11-29 14:57:29 +0800489 if (json.get(InstructionCodec.PORT) == null ||
490 json.get(InstructionCodec.PORT).isNull()) {
491 return Instructions.setQueue(queueId, null);
492 } else {
493 return Instructions.setQueue(queueId, getPortNumber(json));
494 }
Ray Milkeyd43fe452015-05-29 09:35:12 -0700495 } else if (type.equals(Instruction.Type.L0MODIFICATION.name())) {
496 return decodeL0();
Yafit Hadar5796d972015-10-15 13:16:11 +0300497 } else if (type.equals(Instruction.Type.L1MODIFICATION.name())) {
498 return decodeL1();
Ray Milkeyd43fe452015-05-29 09:35:12 -0700499 } else if (type.equals(Instruction.Type.L2MODIFICATION.name())) {
500 return decodeL2();
501 } else if (type.equals(Instruction.Type.L3MODIFICATION.name())) {
502 return decodeL3();
Hyunsun Moonfab29502015-08-25 13:39:16 -0700503 } else if (type.equals(Instruction.Type.L4MODIFICATION.name())) {
504 return decodeL4();
Jian Lidab72562016-04-12 14:10:32 -0700505 } else if (type.equals(Instruction.Type.EXTENSION.name())) {
506 return decodeExtension();
Cem Türker3baff672017-10-12 15:09:01 +0300507 } else if (type.equals(Instruction.Type.STAT_TRIGGER.name())) {
508 return decodeStatTrigger();
Frank Wang74ce2c12018-04-11 20:26:45 +0800509 } else if (type.equals(Instruction.Type.PROTOCOL_INDEPENDENT.name())) {
510 return decodePi();
Ray Milkeyd43fe452015-05-29 09:35:12 -0700511 }
Frank Wang74ce2c12018-04-11 20:26:45 +0800512
Ray Milkeyd43fe452015-05-29 09:35:12 -0700513 throw new IllegalArgumentException("Instruction type "
Frank Wang74ce2c12018-04-11 20:26:45 +0800514 + type + " is not supported");
Ray Milkeyd43fe452015-05-29 09:35:12 -0700515 }
Ray Milkeyd43fe452015-05-29 09:35:12 -0700516}