/* * Copyright (c) 2013 Pantheon Technologies s.r.o. and others. All rights reserved. * * This program and the accompanying materials are made available under the * terms of the Eclipse Public License v1.0 which accompanies this distribution, * and is available at http://www.eclipse.org/legal/epl-v10.html */ package org.opendaylight.openflowjava.protocol.impl.deserialization.factories; import static org.opendaylight.yangtools.yang.common.netty.ByteBufUtils.readUint16; import static org.opendaylight.yangtools.yang.common.netty.ByteBufUtils.readUint32; import static org.opendaylight.yangtools.yang.common.netty.ByteBufUtils.readUint64; import static org.opendaylight.yangtools.yang.common.netty.ByteBufUtils.readUint8; import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; import io.netty.buffer.ByteBuf; import java.nio.charset.StandardCharsets; import java.util.ArrayList; import java.util.List; import java.util.Objects; import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistry; import org.opendaylight.openflowjava.protocol.api.extensibility.DeserializerRegistryInjector; import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer; import org.opendaylight.openflowjava.protocol.api.keys.MessageCodeKey; import org.opendaylight.openflowjava.protocol.api.util.EncodeConstants; import org.opendaylight.openflowjava.protocol.impl.util.CodeKeyMaker; import org.opendaylight.openflowjava.protocol.impl.util.CodeKeyMakerFactory; import org.opendaylight.openflowjava.protocol.impl.util.ListDeserializer; import org.opendaylight.openflowjava.protocol.impl.util.OF10MatchDeserializer; import org.opendaylight.openflowjava.util.ByteBufUtils; import org.opendaylight.openflowjava.util.ExperimenterDeserializerKeyFactory; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.action.rev150203.actions.grouping.Action; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.ExperimenterId; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartRequestFlags; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.types.rev130731.MultipartType; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.v10.grouping.MatchV10; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessage; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.MultipartReplyMessageBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.experimenter.core.ExperimenterDataOfChoice; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyAggregateCase; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyAggregateCaseBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyDescCase; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyDescCaseBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyExperimenterCase; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyExperimenterCaseBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyFlowCase; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyFlowCaseBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyPortStatsCase; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyPortStatsCaseBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyQueueCase; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyQueueCaseBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyTableCase; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.MultipartReplyTableCaseBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.aggregate._case.MultipartReplyAggregateBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.desc._case.MultipartReplyDescBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.experimenter._case.MultipartReplyExperimenterBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.flow._case.MultipartReplyFlowBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.flow._case.multipart.reply.flow.FlowStats; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.flow._case.multipart.reply.flow.FlowStatsBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.stats._case.MultipartReplyPortStatsBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.stats._case.multipart.reply.port.stats.PortStats; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.port.stats._case.multipart.reply.port.stats.PortStatsBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.queue._case.MultipartReplyQueueBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.queue._case.multipart.reply.queue.QueueStats; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.queue._case.multipart.reply.queue.QueueStatsBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table._case.MultipartReplyTableBuilder; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table._case.multipart.reply.table.TableStats; import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.multipart.reply.multipart.reply.body.multipart.reply.table._case.multipart.reply.table.TableStatsBuilder; import org.opendaylight.yangtools.yang.common.Uint32; /** * Translates StatsReply messages (OpenFlow v1.0). * * @author michal.polkorab */ @SuppressFBWarnings("UWF_FIELD_NOT_INITIALIZED_IN_CONSTRUCTOR") // FB doesn't recognize Objects.requireNonNull public class OF10StatsReplyMessageFactory implements OFDeserializer, DeserializerRegistryInjector { private static final int DESC_STR_LEN = 256; private static final int SERIAL_NUM_LEN = 32; private static final byte PADDING_IN_FLOW_STATS_HEADER = 1; private static final byte PADDING_IN_FLOW_STATS_HEADER_02 = 6; private static final byte PADDING_IN_AGGREGATE_HEADER = 4; private static final byte PADDING_IN_TABLE_HEADER = 3; private static final byte MAX_TABLE_NAME_LENGTH = 32; private static final byte PADDING_IN_PORT_STATS_HEADER = 6; private static final byte PADDING_IN_QUEUE_HEADER = 2; private static final byte LENGTH_OF_FLOW_STATS = 88; private static final int TABLE_STATS_LENGTH = 64; private DeserializerRegistry registry; @Override public MultipartReplyMessage deserialize(final ByteBuf rawMessage) { Objects.requireNonNull(registry); MultipartReplyMessageBuilder builder = new MultipartReplyMessageBuilder() .setVersion(EncodeConstants.OF_VERSION_1_0) .setXid(readUint32(rawMessage)); int type = rawMessage.readUnsignedShort(); builder.setType(MultipartType.forValue(type)); builder.setFlags(new MultipartRequestFlags((rawMessage.readUnsignedShort() & 0x01) != 0)); switch (MultipartType.forValue(type)) { case OFPMPDESC: builder.setMultipartReplyBody(setDesc(rawMessage)); break; case OFPMPFLOW: builder.setMultipartReplyBody(setFlow(rawMessage)); break; case OFPMPAGGREGATE: builder.setMultipartReplyBody(setAggregate(rawMessage)); break; case OFPMPTABLE: builder.setMultipartReplyBody(setTable(rawMessage)); break; case OFPMPPORTSTATS: builder.setMultipartReplyBody(setPortStats(rawMessage)); break; case OFPMPQUEUE: builder.setMultipartReplyBody(setQueue(rawMessage)); break; case OFPMPEXPERIMENTER: builder.setMultipartReplyBody(setExperimenter(rawMessage)); break; default: break; } return builder.build(); } private static MultipartReplyDescCase setDesc(final ByteBuf input) { final MultipartReplyDescCaseBuilder caseBuilder = new MultipartReplyDescCaseBuilder(); MultipartReplyDescBuilder descBuilder = new MultipartReplyDescBuilder(); byte[] mfrDescBytes = new byte[DESC_STR_LEN]; input.readBytes(mfrDescBytes); String mfrDesc = new String(mfrDescBytes, StandardCharsets.UTF_8); descBuilder.setMfrDesc(mfrDesc.trim()); byte[] hwDescBytes = new byte[DESC_STR_LEN]; input.readBytes(hwDescBytes); String hwDesc = new String(hwDescBytes, StandardCharsets.UTF_8); descBuilder.setHwDesc(hwDesc.trim()); byte[] swDescBytes = new byte[DESC_STR_LEN]; input.readBytes(swDescBytes); String swDesc = new String(swDescBytes, StandardCharsets.UTF_8); descBuilder.setSwDesc(swDesc.trim()); byte[] serialNumBytes = new byte[SERIAL_NUM_LEN]; input.readBytes(serialNumBytes); String serialNum = new String(serialNumBytes, StandardCharsets.UTF_8); descBuilder.setSerialNum(serialNum.trim()); byte[] dpDescBytes = new byte[DESC_STR_LEN]; input.readBytes(dpDescBytes); String dpDesc = new String(dpDescBytes, StandardCharsets.UTF_8); descBuilder.setDpDesc(dpDesc.trim()); caseBuilder.setMultipartReplyDesc(descBuilder.build()); return caseBuilder.build(); } private MultipartReplyFlowCase setFlow(final ByteBuf input) { MultipartReplyFlowCaseBuilder caseBuilder = new MultipartReplyFlowCaseBuilder(); MultipartReplyFlowBuilder flowBuilder = new MultipartReplyFlowBuilder(); List flowStatsList = new ArrayList<>(); while (input.readableBytes() > 0) { FlowStatsBuilder flowStatsBuilder = new FlowStatsBuilder(); final int length = input.readUnsignedShort(); flowStatsBuilder.setTableId(readUint8(input)); input.skipBytes(PADDING_IN_FLOW_STATS_HEADER); OFDeserializer matchDeserializer = registry.getDeserializer( new MessageCodeKey(EncodeConstants.OF_VERSION_1_0, EncodeConstants.EMPTY_VALUE, MatchV10.class)); flowStatsBuilder.setMatchV10(matchDeserializer.deserialize(input)); flowStatsBuilder.setDurationSec(readUint32(input)); flowStatsBuilder.setDurationNsec(readUint32(input)); flowStatsBuilder.setPriority(readUint16(input)); flowStatsBuilder.setIdleTimeout(readUint16(input)); flowStatsBuilder.setHardTimeout(readUint16(input)); input.skipBytes(PADDING_IN_FLOW_STATS_HEADER_02); flowStatsBuilder.setCookie(readUint64(input)); flowStatsBuilder.setPacketCount(readUint64(input)); flowStatsBuilder.setByteCount(readUint64(input)); CodeKeyMaker keyMaker = CodeKeyMakerFactory.createActionsKeyMaker(EncodeConstants.OF_VERSION_1_0); List actions = ListDeserializer.deserializeList(EncodeConstants.OF10_VERSION_ID, length - LENGTH_OF_FLOW_STATS, input, keyMaker, registry); flowStatsBuilder.setAction(actions); flowStatsList.add(flowStatsBuilder.build()); } flowBuilder.setFlowStats(flowStatsList); caseBuilder.setMultipartReplyFlow(flowBuilder.build()); return caseBuilder.build(); } private static MultipartReplyAggregateCase setAggregate(final ByteBuf input) { final MultipartReplyAggregateCaseBuilder caseBuilder = new MultipartReplyAggregateCaseBuilder(); MultipartReplyAggregateBuilder builder = new MultipartReplyAggregateBuilder(); builder.setPacketCount(readUint64(input)); builder.setByteCount(readUint64(input)); builder.setFlowCount(readUint32(input)); input.skipBytes(PADDING_IN_AGGREGATE_HEADER); caseBuilder.setMultipartReplyAggregate(builder.build()); return caseBuilder.build(); } private static MultipartReplyTableCase setTable(final ByteBuf input) { final MultipartReplyTableCaseBuilder caseBuilder = new MultipartReplyTableCaseBuilder(); MultipartReplyTableBuilder builder = new MultipartReplyTableBuilder(); List tableStatsList = new ArrayList<>(); // TODO - replace ">= TABLE_STATS_LENGTH" with "> 0" after fix in OVS switch while (input.readableBytes() >= TABLE_STATS_LENGTH) { TableStatsBuilder tableStatsBuilder = new TableStatsBuilder(); tableStatsBuilder.setTableId(readUint8(input)); input.skipBytes(PADDING_IN_TABLE_HEADER); tableStatsBuilder.setName(ByteBufUtils.decodeNullTerminatedString(input, MAX_TABLE_NAME_LENGTH)); long wildcards = input.readUnsignedInt(); tableStatsBuilder.setWildcards(OF10MatchDeserializer.createWildcards(wildcards)); tableStatsBuilder.setNwSrcMask(OF10MatchDeserializer.decodeNwSrcMask(wildcards)); tableStatsBuilder.setNwDstMask(OF10MatchDeserializer.decodeNwDstMask(wildcards)); tableStatsBuilder.setMaxEntries(readUint32(input)); tableStatsBuilder.setActiveCount(readUint32(input)); tableStatsBuilder.setLookupCount(readUint64(input)); tableStatsBuilder.setMatchedCount(readUint64(input)); tableStatsList.add(tableStatsBuilder.build()); } input.skipBytes(input.readableBytes()); builder.setTableStats(tableStatsList); caseBuilder.setMultipartReplyTable(builder.build()); return caseBuilder.build(); } private static MultipartReplyPortStatsCase setPortStats(final ByteBuf input) { MultipartReplyPortStatsCaseBuilder caseBuilder = new MultipartReplyPortStatsCaseBuilder(); MultipartReplyPortStatsBuilder builder = new MultipartReplyPortStatsBuilder(); List portStatsList = new ArrayList<>(); while (input.readableBytes() > 0) { PortStatsBuilder portStatsBuilder = new PortStatsBuilder(); portStatsBuilder.setPortNo(readUint16(input).toUint32()); input.skipBytes(PADDING_IN_PORT_STATS_HEADER); portStatsBuilder.setRxPackets(readUint64(input)); portStatsBuilder.setTxPackets(readUint64(input)); portStatsBuilder.setRxBytes(readUint64(input)); portStatsBuilder.setTxBytes(readUint64(input)); portStatsBuilder.setRxDropped(readUint64(input)); portStatsBuilder.setTxDropped(readUint64(input)); portStatsBuilder.setRxErrors(readUint64(input)); portStatsBuilder.setTxErrors(readUint64(input)); portStatsBuilder.setRxFrameErr(readUint64(input)); portStatsBuilder.setRxOverErr(readUint64(input)); portStatsBuilder.setRxCrcErr(readUint64(input)); portStatsBuilder.setCollisions(readUint64(input)); portStatsList.add(portStatsBuilder.build()); } builder.setPortStats(portStatsList); caseBuilder.setMultipartReplyPortStats(builder.build()); return caseBuilder.build(); } private static MultipartReplyQueueCase setQueue(final ByteBuf input) { MultipartReplyQueueCaseBuilder caseBuilder = new MultipartReplyQueueCaseBuilder(); MultipartReplyQueueBuilder builder = new MultipartReplyQueueBuilder(); List queueStatsList = new ArrayList<>(); while (input.readableBytes() > 0) { QueueStatsBuilder queueStatsBuilder = new QueueStatsBuilder(); queueStatsBuilder.setPortNo(readUint16(input).toUint32()); input.skipBytes(PADDING_IN_QUEUE_HEADER); queueStatsBuilder.setQueueId(readUint32(input)); queueStatsBuilder.setTxBytes(readUint64(input)); queueStatsBuilder.setTxPackets(readUint64(input)); queueStatsBuilder.setTxErrors(readUint64(input)); queueStatsList.add(queueStatsBuilder.build()); } builder.setQueueStats(queueStatsList); caseBuilder.setMultipartReplyQueue(builder.build()); return caseBuilder.build(); } private MultipartReplyExperimenterCase setExperimenter(final ByteBuf input) { final Uint32 expId = readUint32(input); final OFDeserializer deserializer = registry.getDeserializer( ExperimenterDeserializerKeyFactory.createMultipartReplyVendorMessageDeserializerKey( EncodeConstants.OF_VERSION_1_0, expId)); final MultipartReplyExperimenterBuilder mpExperimenterBld = new MultipartReplyExperimenterBuilder() .setExperimenter(new ExperimenterId(expId)) .setExperimenterDataOfChoice(deserializer.deserialize(input)); final MultipartReplyExperimenterCaseBuilder mpReplyExperimenterCaseBld = new MultipartReplyExperimenterCaseBuilder().setMultipartReplyExperimenter(mpExperimenterBld.build()); return mpReplyExperimenterCaseBld.build(); } @Override public void injectDeserializerRegistry(final DeserializerRegistry deserializerRegistry) { registry = deserializerRegistry; } }