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 org.opendaylight.openflowjava.protocol.api.extensibility.MessageTypeKey;
14 import org.opendaylight.openflowjava.protocol.api.extensibility.OFSerializer;
15 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistryInjector;
16 import org.opendaylight.openflowjava.protocol.api.extensibility.SerializerRegistry;
17 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.DlAddressAction;
18 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.ExperimenterAction;
19 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.IpAddressAction;
20 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.MaxLengthAction;
21 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.NwTosAction;
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.augments.rev131002.VlanPcpAction;
25 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.augments.rev131002.VlanVidAction;
26 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.Enqueue;
27 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.Experimenter;
28 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.Output;
29 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.SetDlDst;
30 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.SetDlSrc;
31 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.SetNwDst;
32 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.SetNwSrc;
33 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.SetNwTos;
34 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.SetTpDst;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.SetTpSrc;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.SetVlanPcp;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.SetVlanVid;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.StripVlan;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev130731.actions.grouping.Action;
42 * Serializes ofp_action (OpenFlow v1.0) structures
43 * @author michal.polkorab
45 public class OF10ActionsSerializer implements OFSerializer<Action>, SerializerRegistryInjector {
47 private static final byte OUTPUT_CODE = 0;
48 private static final byte SET_VLAN_VID_CODE = 1;
49 private static final byte SET_VLAN_PCP_CODE = 2;
50 private static final byte STRIP_VLAN_CODE = 3;
51 private static final byte SET_DL_SRC_CODE = 4;
52 private static final byte SET_DL_DST_CODE = 5;
53 private static final byte SET_NW_SRC_CODE = 6;
54 private static final byte SET_NW_DST_CODE = 7;
55 private static final byte SET_NW_TOS_CODE = 8;
56 private static final byte SET_TP_SRC_CODE = 9;
57 private static final byte SET_TP_DST_CODE = 10;
58 private static final byte ENQUEUE_CODE = 11;
59 private static final byte GENERIC_ACTION_LENGTH = 8;
60 private static final byte PADDING_IN_GENERIC_ACTION = 4;
61 private static final byte OUTPUT_LENGTH = 8;
62 private static final byte SET_VLAN_VID_LENGTH = 8;
63 private static final byte PADDING_IN_SET_VLAN_VID_ACTION = 2;
64 private static final byte SET_VLAN_PCP_LENGTH = 8;
65 private static final byte PADDING_IN_SET_VLAN_PCP_ACTION = 3;
66 private static final byte DL_ADDRESS_ACTION_LENGTH = 16;
67 private static final byte PADDING_IN_DL_ADDRESS_ACTION = 6;
68 private static final byte SET_NW_TOS_LENGTH = 8;
69 private static final byte PADDING_IN_SET_NW_TOS_ACTION = 3;
70 private static final byte IP_ADDRESS_ACTION_LENGTH = 8;
71 private static final byte TP_PORT_ACTION_LENGTH = 8;
72 private static final byte PADDING_IN_TP_PORT_ACTION = 2;
73 private static final byte ENQUEUE_LENGTH = 16;
74 private static final byte PADDING_IN_ENQUEUE_ACTION = 6;
75 private SerializerRegistry registry;
78 public void serialize(Action action, ByteBuf outBuffer) {
79 if (action.getType().equals(Output.class)) {
80 encodeOutputAction(action, outBuffer);
81 } else if (action.getType().equals(SetVlanVid.class)) {
82 encodeSetVlanVidAction(action, outBuffer);
83 } else if (action.getType().equals(SetVlanPcp.class)) {
84 encodeSetVlanPcpAction(action, outBuffer);
85 } else if (action.getType().equals(StripVlan.class)) {
86 encodeGenericAction(STRIP_VLAN_CODE, outBuffer);
87 } else if (action.getType().equals(SetDlSrc.class)) {
88 encodeDlAddressAction(action, outBuffer, SET_DL_SRC_CODE);
89 } else if (action.getType().equals(SetDlDst.class)) {
90 encodeDlAddressAction(action, outBuffer, SET_DL_DST_CODE);
91 } else if (action.getType().equals(SetNwSrc.class)) {
92 encodeIpAddressAction(action, outBuffer, SET_NW_SRC_CODE);
93 } else if (action.getType().equals(SetNwDst.class)) {
94 encodeIpAddressAction(action, outBuffer, SET_NW_DST_CODE);
95 } else if (action.getType().equals(SetNwTos.class)) {
96 encodeNwTosAction(action, outBuffer);
97 } else if (action.getType().equals(SetTpSrc.class)) {
98 encodeTpPortAction(action, outBuffer, SET_TP_SRC_CODE);
99 } else if (action.getType().equals(SetTpDst.class)) {
100 encodeTpPortAction(action, outBuffer, SET_TP_DST_CODE);
101 } else if (action.getType().equals(Enqueue.class)) {
102 encodeEnqueueAction(action, outBuffer);
103 } else if (action.getType().equals(Experimenter.class)) {
104 encodeExperimenterAction(action, outBuffer);
109 public void injectSerializerRegistry(SerializerRegistry serializerRegistry) {
110 this.registry = serializerRegistry;
113 private static void encodeGenericAction(byte code, ByteBuf out) {
114 out.writeShort(code);
115 out.writeShort(GENERIC_ACTION_LENGTH);
116 ByteBufUtils.padBuffer(PADDING_IN_GENERIC_ACTION, out);
119 private static void encodeOutputAction(Action action, ByteBuf out) {
120 out.writeShort(OUTPUT_CODE);
121 out.writeShort(OUTPUT_LENGTH);
122 PortAction port = action.getAugmentation(PortAction.class);
123 out.writeShort(port.getPort().getValue().intValue());
124 MaxLengthAction maxlength = action.getAugmentation(MaxLengthAction.class);
125 out.writeShort(maxlength.getMaxLength());
128 private static void encodeSetVlanVidAction(Action action, ByteBuf out) {
129 out.writeShort(SET_VLAN_VID_CODE);
130 out.writeShort(SET_VLAN_VID_LENGTH);
131 out.writeShort(action.getAugmentation(VlanVidAction.class).getVlanVid());
132 ByteBufUtils.padBuffer(PADDING_IN_SET_VLAN_VID_ACTION, out);
135 private static void encodeSetVlanPcpAction(Action action, ByteBuf out) {
136 out.writeShort(SET_VLAN_PCP_CODE);
137 out.writeShort(SET_VLAN_PCP_LENGTH);
138 out.writeByte(action.getAugmentation(VlanPcpAction.class).getVlanPcp());
139 ByteBufUtils.padBuffer(PADDING_IN_SET_VLAN_PCP_ACTION, out);
142 private static void encodeDlAddressAction(Action action, ByteBuf out, byte code) {
143 out.writeShort(code);
144 out.writeShort(DL_ADDRESS_ACTION_LENGTH);
145 out.writeBytes(ByteBufUtils.macAddressToBytes(action.getAugmentation(DlAddressAction.class)
146 .getDlAddress().getValue()));
147 ByteBufUtils.padBuffer(PADDING_IN_DL_ADDRESS_ACTION, out);
150 private static void encodeNwTosAction(Action action, ByteBuf out) {
151 out.writeShort(SET_NW_TOS_CODE);
152 out.writeShort(SET_NW_TOS_LENGTH);
153 out.writeByte(action.getAugmentation(NwTosAction.class).getNwTos());
154 ByteBufUtils.padBuffer(PADDING_IN_SET_NW_TOS_ACTION, out);
157 private static void encodeIpAddressAction(Action action, ByteBuf out, byte code) {
158 out.writeShort(code);
159 out.writeShort(IP_ADDRESS_ACTION_LENGTH);
160 String[] addressGroups = action.
161 getAugmentation(IpAddressAction.class).getIpAddress().getValue().split("\\.");
162 for (int i = 0; i < addressGroups.length; i++) {
163 out.writeByte(Integer.parseInt(addressGroups[i]));
167 private static void encodeTpPortAction(Action action, ByteBuf out, byte code) {
168 out.writeShort(code);
169 out.writeShort(TP_PORT_ACTION_LENGTH);
170 PortAction port = action.getAugmentation(PortAction.class);
171 out.writeShort(port.getPort().getValue().intValue());
172 ByteBufUtils.padBuffer(PADDING_IN_TP_PORT_ACTION, out);
175 private static void encodeEnqueueAction(Action action, ByteBuf out) {
176 out.writeShort(ENQUEUE_CODE);
177 out.writeShort(ENQUEUE_LENGTH);
178 PortAction port = action.getAugmentation(PortAction.class);
179 out.writeShort(port.getPort().getValue().intValue());
180 ByteBufUtils.padBuffer(PADDING_IN_ENQUEUE_ACTION, out);
181 QueueIdAction queueId = action.getAugmentation(QueueIdAction.class);
182 out.writeInt(queueId.getQueueId().intValue());
185 private void encodeExperimenterAction(Action action, ByteBuf outBuffer) {
186 OFSerializer<ExperimenterAction> serializer = registry.getSerializer(
187 new MessageTypeKey<>(EncodeConstants.OF13_VERSION_ID, Experimenter.class));
188 serializer.serialize((ExperimenterAction) action, outBuffer);