2 * Copyright (c) 2013 Pantheon Technologies s.r.o. and others. All rights reserved.
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
9 package org.opendaylight.openflowjava.protocol.impl.util;
11 import io.netty.buffer.ByteBuf;
13 import java.util.List;
15 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.EthertypeAction;
16 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ExperimenterAction;
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.GroupIdAction;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MaxLengthAction;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MplsTtlAction;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.NwTtlAction;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.OxmFieldsAction;
22 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.PortAction;
23 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.QueueIdAction;
24 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.CopyTtlIn;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.CopyTtlOut;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.DecMplsTtl;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.DecNwTtl;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.Experimenter;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.Group;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.Output;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.PopMpls;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.PopPbb;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.PopVlan;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.PushMpls;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.PushPbb;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.PushVlan;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.SetField;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.SetMplsTtl;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.SetNwTtl;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.SetQueue;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.actions.ActionsList;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.actions.actions.list.Action;
43 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev130731.oxm.fields.MatchEntries;
46 * Serializes ofp_actions (OpenFlow v1.3)
47 * @author michal.polkorab
48 * @author timotej.kubas
50 public abstract class ActionsSerializer {
52 private static final byte OUTPUT_CODE = 0;
53 private static final byte COPY_TTL_OUT_CODE = 11;
54 private static final byte COPY_TTL_IN_CODE = 12;
55 private static final byte SET_MPLS_TTL_CODE = 15;
56 private static final byte DEC_MPLS_TTL_CODE = 16;
57 private static final byte PUSH_VLAN_CODE = 17;
58 private static final byte POP_VLAN_CODE = 18;
59 private static final byte PUSH_MPLS_CODE = 19;
60 private static final byte POP_MPLS_CODE = 20;
61 private static final byte SET_QUEUE_CODE = 21;
62 private static final byte GROUP_CODE = 22;
63 private static final byte SET_NW_TTL_CODE = 23;
64 private static final byte DEC_NW_TTL_CODE = 24;
65 private static final int SET_FIELD_CODE = 25;
66 private static final byte PUSH_PBB_CODE = 26;
67 private static final byte POP_PBB_CODE = 27;
68 private static final int EXPERIMENTER_CODE = 65535; // 0xFFFF
69 private static final byte OUTPUT_LENGTH = 16;
70 private static final byte SET_MPLS_TTL_LENGTH = 8;
71 private static final byte SET_QUEUE_LENGTH = 8;
72 private static final byte GROUP_LENGTH = 8;
73 private static final byte SET_NW_TTL_LENGTH = 8;
74 private static final byte EXPERIMENTER_LENGTH = 8;
75 private static final byte ACTION_HEADER_LENGTH = 8;
76 private static final byte LENGTH_OF_ETHERTYPE_ACTION = 8;
77 private static final byte LENGTH_OF_OTHER_ACTIONS = 8;
78 private static final byte SET_FIELD_HEADER_LENGTH = 4; // only type and length
79 private static final byte OUTPUT_PADDING = 6;
80 private static final byte SET_MPLS_TTL_PADDING = 3;
81 private static final byte SET_NW_TTL_PADDING = 3;
82 private static final byte PADDING_IN_ACTION_HEADER = 4;
83 private static final byte ETHERTYPE_ACTION_PADDING = 2;
84 private static final byte ACTION_IDS_LENGTH = 4;
89 * Encodes actions to ByteBuf
90 * @param actionsList list of actions to be encoded
91 * @param outBuffer output ByteBuf
93 public static void encodeActions(List<ActionsList> actionsList, ByteBuf outBuffer) {
94 if (actionsList == null) {
97 for (ActionsList list : actionsList) {
98 Action action = list.getAction();
99 if (action.getType().isAssignableFrom(Output.class)) {
100 encodeOutputAction(action, outBuffer);
101 } else if (action.getType().isAssignableFrom(CopyTtlOut.class)) {
102 encodeCopyTtlOutAction(outBuffer);
103 } else if (action.getType().isAssignableFrom(CopyTtlIn.class)) {
104 encodeCopyTtlInAction(outBuffer);
105 } else if (action.getType().isAssignableFrom(SetMplsTtl.class)) {
106 encodeSetMplsTtltAction(action, outBuffer);
107 } else if (action.getType().isAssignableFrom(DecMplsTtl.class)) {
108 encodeDecMplsTtlAction(outBuffer);
109 } else if (action.getType().isAssignableFrom(PushVlan.class)) {
110 encodePushVlanAction(action, outBuffer);
111 } else if (action.getType().isAssignableFrom(PopVlan.class)) {
112 encodePopVlanAction(outBuffer);
113 } else if (action.getType().isAssignableFrom(PushMpls.class)) {
114 encodePushMplsAction(action, outBuffer);
115 } else if (action.getType().isAssignableFrom(PopMpls.class)) {
116 encodePopMplsAction(action, outBuffer);
117 } else if (action.getType().isAssignableFrom(SetQueue.class)) {
118 encodeSetQueueAction(action, outBuffer);
119 } else if (action.getType().isAssignableFrom(Group.class)) {
120 encodeGroupAction(action, outBuffer);
121 } else if (action.getType().isAssignableFrom(SetNwTtl.class)) {
122 encodeSetNwTtlAction(action, outBuffer);
123 } else if (action.getType().isAssignableFrom(DecNwTtl.class)) {
124 encodeDecNwTtlAction(outBuffer);
125 } else if (action.getType().isAssignableFrom(SetField.class)) {
126 encodeSetFieldAction(action, outBuffer);
127 } else if (action.getType().isAssignableFrom(PushPbb.class)) {
128 encodePushPbbAction(action, outBuffer);
129 } else if (action.getType().isAssignableFrom(PopPbb.class)) {
130 encodePopPbbAction(outBuffer);
131 } else if (action.getType().isAssignableFrom(Experimenter.class)) {
132 encodeExperimenterAction(action, outBuffer);
138 * Encodes action ids to ByteBuf (for Multipart - TableFeatures messages)
139 * @param actionsList list of actions to be encoded
140 * @param outBuffer output ByteBuf
142 public static void encodeActionIds(List<ActionsList> actionsList, ByteBuf outBuffer) {
143 if (actionsList == null) {
146 for (ActionsList list : actionsList) {
147 Action action = list.getAction();
148 if (action.getType().isAssignableFrom(Output.class)) {
149 writeTypeAndLength(outBuffer, OUTPUT_CODE, ACTION_IDS_LENGTH);
150 } else if (action.getType().isAssignableFrom(CopyTtlOut.class)) {
151 writeTypeAndLength(outBuffer, COPY_TTL_OUT_CODE, ACTION_IDS_LENGTH);
152 } else if (action.getType().isAssignableFrom(CopyTtlIn.class)) {
153 writeTypeAndLength(outBuffer, COPY_TTL_IN_CODE, ACTION_IDS_LENGTH);
154 } else if (action.getType().isAssignableFrom(SetMplsTtl.class)) {
155 writeTypeAndLength(outBuffer, SET_MPLS_TTL_CODE, ACTION_IDS_LENGTH);
156 } else if (action.getType().isAssignableFrom(DecMplsTtl.class)) {
157 writeTypeAndLength(outBuffer, DEC_MPLS_TTL_CODE, ACTION_IDS_LENGTH);
158 } else if (action.getType().isAssignableFrom(PushVlan.class)) {
159 writeTypeAndLength(outBuffer, PUSH_VLAN_CODE, ACTION_IDS_LENGTH);
160 } else if (action.getType().isAssignableFrom(PopVlan.class)) {
161 writeTypeAndLength(outBuffer, POP_VLAN_CODE, ACTION_IDS_LENGTH);
162 } else if (action.getType().isAssignableFrom(PushMpls.class)) {
163 writeTypeAndLength(outBuffer, PUSH_MPLS_CODE, ACTION_IDS_LENGTH);
164 } else if (action.getType().isAssignableFrom(PopMpls.class)) {
165 writeTypeAndLength(outBuffer, POP_MPLS_CODE, ACTION_IDS_LENGTH);
166 } else if (action.getType().isAssignableFrom(SetQueue.class)) {
167 writeTypeAndLength(outBuffer, SET_QUEUE_CODE, ACTION_IDS_LENGTH);
168 } else if (action.getType().isAssignableFrom(Group.class)) {
169 writeTypeAndLength(outBuffer, GROUP_CODE, ACTION_IDS_LENGTH);
170 } else if (action.getType().isAssignableFrom(SetNwTtl.class)) {
171 writeTypeAndLength(outBuffer, SET_NW_TTL_CODE, ACTION_IDS_LENGTH);
172 } else if (action.getType().isAssignableFrom(DecNwTtl.class)) {
173 writeTypeAndLength(outBuffer, DEC_NW_TTL_CODE, ACTION_IDS_LENGTH);
174 } else if (action.getType().isAssignableFrom(SetField.class)) {
175 writeTypeAndLength(outBuffer, SET_FIELD_CODE, ACTION_IDS_LENGTH);
176 } else if (action.getType().isAssignableFrom(PushPbb.class)) {
177 writeTypeAndLength(outBuffer, PUSH_PBB_CODE, ACTION_IDS_LENGTH);
178 } else if (action.getType().isAssignableFrom(PopPbb.class)) {
179 writeTypeAndLength(outBuffer, POP_PBB_CODE, ACTION_IDS_LENGTH);
180 } else if (action.getType().isAssignableFrom(Experimenter.class)) {
181 writeTypeAndLength(outBuffer, EXPERIMENTER_CODE, ACTION_IDS_LENGTH);
186 private static void writeTypeAndLength(ByteBuf out, int type, int length) {
187 out.writeShort(type);
188 out.writeShort(length);
191 private static void encodeOutputAction(Action action, ByteBuf outBuffer) {
192 outBuffer.writeShort(OUTPUT_CODE);
193 outBuffer.writeShort(OUTPUT_LENGTH);
194 PortAction port = action.getAugmentation(PortAction.class);
195 outBuffer.writeInt(port.getPort().getValue().intValue());
196 MaxLengthAction maxlength = action.getAugmentation(MaxLengthAction.class);
197 outBuffer.writeShort(maxlength.getMaxLength());
198 ByteBufUtils.padBuffer(OUTPUT_PADDING, outBuffer);
201 private static void encodeCopyTtlOutAction(ByteBuf outBuffer) {
202 outBuffer.writeShort(COPY_TTL_OUT_CODE);
203 encodeRestOfActionHeader(outBuffer);
206 private static void encodeCopyTtlInAction(ByteBuf outBuffer) {
207 outBuffer.writeShort(COPY_TTL_IN_CODE);
208 encodeRestOfActionHeader(outBuffer);
211 private static void encodeSetMplsTtltAction(Action action, ByteBuf outBuffer) {
212 outBuffer.writeShort(SET_MPLS_TTL_CODE);
213 outBuffer.writeShort(SET_MPLS_TTL_LENGTH);
214 MplsTtlAction mplsTtl = action.getAugmentation(MplsTtlAction.class);
215 outBuffer.writeByte(mplsTtl.getMplsTtl());
216 ByteBufUtils.padBuffer(SET_MPLS_TTL_PADDING, outBuffer);
219 private static void encodeDecMplsTtlAction(ByteBuf outBuffer) {
220 outBuffer.writeShort(DEC_MPLS_TTL_CODE);
221 encodeRestOfActionHeader(outBuffer);
224 private static void encodePushVlanAction(Action action, ByteBuf outBuffer) {
225 outBuffer.writeShort(PUSH_VLAN_CODE);
226 encodeCommonEthertype(action, outBuffer);
229 private static void encodePopVlanAction(ByteBuf outBuffer) {
230 outBuffer.writeShort(POP_VLAN_CODE);
231 encodeRestOfActionHeader(outBuffer);
234 private static void encodePushMplsAction(Action action, ByteBuf outBuffer) {
235 outBuffer.writeShort(PUSH_MPLS_CODE);
236 encodeCommonEthertype(action, outBuffer);
239 private static void encodePopMplsAction(Action action, ByteBuf outBuffer) {
240 outBuffer.writeShort(POP_MPLS_CODE);
241 encodeCommonEthertype(action, outBuffer);
244 private static void encodeSetQueueAction(Action action, ByteBuf outBuffer) {
245 outBuffer.writeShort(SET_QUEUE_CODE);
246 outBuffer.writeShort(SET_QUEUE_LENGTH);
247 QueueIdAction queueId = action.getAugmentation(QueueIdAction.class);
248 outBuffer.writeInt(queueId.getQueueId().intValue());
251 private static void encodeGroupAction(Action action, ByteBuf outBuffer) {
252 outBuffer.writeShort(GROUP_CODE);
253 outBuffer.writeShort(GROUP_LENGTH);
254 GroupIdAction groupId = action.getAugmentation(GroupIdAction.class);
255 outBuffer.writeInt(groupId.getGroupId().intValue());
258 private static void encodeSetNwTtlAction(Action action, ByteBuf outBuffer) {
259 outBuffer.writeShort(SET_NW_TTL_CODE);
260 outBuffer.writeShort(SET_NW_TTL_LENGTH);
261 NwTtlAction nwTtl = action.getAugmentation(NwTtlAction.class);
262 outBuffer.writeByte(nwTtl.getNwTtl());
263 ByteBufUtils.padBuffer(SET_NW_TTL_PADDING, outBuffer);
266 private static void encodeDecNwTtlAction(ByteBuf outBuffer) {
267 outBuffer.writeShort(DEC_NW_TTL_CODE);
268 encodeRestOfActionHeader(outBuffer);
271 private static void encodeSetFieldAction(Action action, ByteBuf outBuffer) {
272 OxmFieldsAction oxmField = action.getAugmentation(OxmFieldsAction.class);
273 int length = MatchSerializer.computeMatchEntriesLength(oxmField.getMatchEntries()) + SET_FIELD_HEADER_LENGTH;
274 outBuffer.writeShort(SET_FIELD_CODE);
275 int paddingRemainder = length % EncodeConstants.PADDING;
276 if (paddingRemainder != 0) {
277 length += EncodeConstants.PADDING - paddingRemainder;
279 outBuffer.writeShort(length);
280 MatchSerializer.encodeMatchEntries(oxmField.getMatchEntries(), outBuffer);
281 if (paddingRemainder != 0) {
282 ByteBufUtils.padBuffer(EncodeConstants.PADDING - paddingRemainder, outBuffer);
286 private static void encodePushPbbAction(Action action, ByteBuf outBuffer) {
287 outBuffer.writeShort(PUSH_PBB_CODE);
288 encodeCommonEthertype(action, outBuffer);
291 private static void encodePopPbbAction(ByteBuf outBuffer) {
292 outBuffer.writeShort(POP_PBB_CODE);
293 encodeRestOfActionHeader(outBuffer);
296 private static void encodeExperimenterAction(Action action, ByteBuf outBuffer) {
297 outBuffer.writeShort(EXPERIMENTER_CODE);
298 outBuffer.writeShort(EXPERIMENTER_LENGTH);
299 ExperimenterAction experimenter = action.getAugmentation(ExperimenterAction.class);
300 outBuffer.writeInt(experimenter.getExperimenter().intValue());
303 private static void encodeRestOfActionHeader(ByteBuf outBuffer) {
304 outBuffer.writeShort(ACTION_HEADER_LENGTH);
305 ByteBufUtils.padBuffer(PADDING_IN_ACTION_HEADER, outBuffer);
308 private static void encodeCommonEthertype(Action action, ByteBuf outBuffer) {
309 EthertypeAction ethertype = action.getAugmentation(EthertypeAction.class);
310 outBuffer.writeShort(LENGTH_OF_ETHERTYPE_ACTION);
311 outBuffer.writeShort(ethertype.getEthertype().getValue());
312 ByteBufUtils.padBuffer(ETHERTYPE_ACTION_PADDING, outBuffer);
316 * Computes length of actions
317 * @param actionsList list of actions
318 * @return actions length
320 public static int computeLengthOfActions(List<ActionsList> actionsList) {
321 int lengthOfActions = 0;
322 if (actionsList != null) {
323 for (ActionsList list : actionsList) {
324 Action action = list.getAction();
325 if (action.getType().isAssignableFrom(Output.class)) {
326 lengthOfActions += OUTPUT_LENGTH;
327 } else if (action.getType().isAssignableFrom(SetField.class)){
328 List<MatchEntries> entries = action.getAugmentation(OxmFieldsAction.class).getMatchEntries();
329 int actionLength = (2 * EncodeConstants.SIZE_OF_SHORT_IN_BYTES) + MatchSerializer.computeMatchEntriesLength(entries);
330 lengthOfActions += actionLength;
331 int paddingRemainder = actionLength % EncodeConstants.PADDING;
332 if ((paddingRemainder) != 0) {
333 lengthOfActions += EncodeConstants.PADDING - paddingRemainder;
336 lengthOfActions += LENGTH_OF_OTHER_ACTIONS;
340 return lengthOfActions;