org.opendaylight.openflowjava.nx.codec.match.AbstractMatchCodec Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openflowjava-extension-nicira Show documentation
There is a newer version: 0.19.0
Show newest version
/*
 * Copyright (c) 2014, 2015 Cisco Systems, Inc. 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.nx.codec.match;

import io.netty.buffer.ByteBuf;
import org.opendaylight.openflowjava.protocol.api.extensibility.HeaderDeserializer;
import org.opendaylight.openflowjava.protocol.api.extensibility.HeaderSerializer;
import org.opendaylight.openflowjava.protocol.api.extensibility.OFDeserializer;
import org.opendaylight.openflowjava.protocol.api.extensibility.OFSerializer;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.MatchField;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.OxmClassBase;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntry;
import org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entries.grouping.MatchEntryBuilder;

public abstract class AbstractMatchCodec implements
        OFSerializer,
        OFDeserializer,
        HeaderSerializer,
        HeaderDeserializer {

    protected NxmHeader headerWithMask;
    protected NxmHeader headerWithoutMask;

    protected MatchEntryBuilder deserializeHeaderToBuilder(final ByteBuf message) {
        MatchEntryBuilder builder = new MatchEntryBuilder();
        builder.setOxmClass(getOxmClass());
        // skip oxm_class - provided
        message.skipBytes(Short.BYTES);
        builder.setOxmMatchField(getNxmField());
        boolean hasMask = (message.readUnsignedByte() & 1) != 0;
        builder.setHasMask(hasMask);
        // skip match entry length - not needed
        message.skipBytes(Byte.BYTES);
        return builder;
    }

    @Override
    public MatchEntry deserializeHeader(final ByteBuf message) {
        return deserializeHeaderToBuilder(message).build();
    }

    @Override
    public void serializeHeader(final MatchEntry input, final ByteBuf outBuffer) {
        serializeHeader(getHeader(input.getHasMask()), outBuffer);
    }

    public void serializeHeader(final NxmHeader input, final ByteBuf outBuffer) {
        outBuffer.writeInt((int) input.toLong());
    }

    protected NxmHeader getHeader(final boolean hasMask) {
        if (hasMask) {
            if (headerWithMask == null) {
                headerWithMask = buildHeader(hasMask);
            }
            return headerWithMask;
        } else {
            if (headerWithoutMask == null) {
                headerWithoutMask = buildHeader(hasMask);
            }
            return headerWithoutMask;
        }
    }

    protected NxmHeader buildHeader(final boolean hasMask) {
        return new NxmHeader(
                getOxmClassCode(),
                getNxmFieldCode(),
                hasMask,
                hasMask ? getValueLength() * 2 : getValueLength()
        );
    }

    public NxmHeader getHeaderWithoutHasMask() {
        return getHeader(false);
    }

    public NxmHeader getHeaderWithHasMask() {
        return getHeader(true);
    }

    /**
     * Returns the numeric representation of nxm_field.
     */
    public abstract int getNxmFieldCode();

    /**
     * Returns the numeric representation of oxm_class.
     */
    public abstract int getOxmClassCode();

    /**
     * Returns the match entry value length.
     */
    public abstract int getValueLength();

    /**
     * Returns the nxm_field class.
     */
    public abstract MatchField getNxmField();

    /**
     * Returns the oxm_class class.
     */
    public abstract OxmClassBase getOxmClass();
}