/*
* Copyright (c) 2016 Cisco and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.fd.honeycomb.v3po.translate.v3po.vppclassifier;
import static com.google.common.base.Preconditions.checkArgument;
import static com.google.common.base.Preconditions.checkNotNull;
import static com.google.common.base.Preconditions.checkState;
import static io.fd.honeycomb.v3po.translate.v3po.interfacesstate.InterfaceUtils.printHexBinary;
import com.google.common.base.Optional;
import com.google.common.primitives.UnsignedInts;
import io.fd.honeycomb.v3po.translate.read.ReadContext;
import io.fd.honeycomb.v3po.translate.read.ReadFailedException;
import io.fd.honeycomb.v3po.translate.spi.read.ListReaderCustomizer;
import io.fd.honeycomb.v3po.translate.v3po.util.FutureJVppCustomizer;
import io.fd.honeycomb.v3po.translate.v3po.util.NamingContext;
import io.fd.honeycomb.v3po.translate.v3po.util.TranslateUtils;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.xml.bind.DatatypeConverter;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.HexString;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev150603.OpaqueIndex;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev150603.VppNode;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev150603.classify.table.attributes.ClassifySession;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev150603.classify.table.attributes.ClassifySessionBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev150603.classify.table.attributes.ClassifySessionKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev150603.vpp.classifier.ClassifyTable;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev150603.vpp.classifier.ClassifyTableBuilder;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.vpp.classifier.rev150603.vpp.classifier.ClassifyTableKey;
import org.opendaylight.yangtools.concepts.Builder;
import org.opendaylight.yangtools.yang.binding.DataObject;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.openvpp.jvpp.VppBaseCallException;
import org.openvpp.jvpp.dto.ClassifySessionDetails;
import org.openvpp.jvpp.dto.ClassifySessionDetailsReplyDump;
import org.openvpp.jvpp.dto.ClassifySessionDump;
import org.openvpp.jvpp.future.FutureJVpp;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* Reader customizer responsible for classify session read.
to VPP.
Equivalent to invoking {@code vppctl show
* class table verbose} command.
*/
public class ClassifySessionReader extends FutureJVppCustomizer
implements ListReaderCustomizer, VppNodeReader {
private static final Logger LOG = LoggerFactory.getLogger(ClassifySessionReader.class);
static final String CACHE_KEY = ClassifySessionReader.class.getName();
private final NamingContext classifyTableContext;
public ClassifySessionReader(@Nonnull final FutureJVpp futureJvpp,
@Nonnull final NamingContext classifyTableContext) {
super(futureJvpp);
this.classifyTableContext = checkNotNull(classifyTableContext, "classifyTableContext should not be null");
}
@Override
public void merge(@Nonnull final Builder extends DataObject> builder,
@Nonnull final List readData) {
((ClassifyTableBuilder) builder).setClassifySession(readData);
}
@Nonnull
@Override
public ClassifySessionBuilder getBuilder(@Nonnull final InstanceIdentifier id) {
return new ClassifySessionBuilder();
}
@Override
public void readCurrentAttributes(@Nonnull final InstanceIdentifier id,
@Nonnull final ClassifySessionBuilder builder, @Nonnull final ReadContext ctx)
throws ReadFailedException {
LOG.debug("Reading attributes for classify session: {}", id);
final ClassifySessionKey key = id.firstKeyOf(ClassifySession.class);
checkArgument(key != null, "could not find ClassifySession key in {}", id);
final ClassifySessionDetailsReplyDump classifySessionDump = dumpClassifySessions(id, ctx);
final byte[] match = DatatypeConverter.parseHexBinary(key.getMatch().getValue().replace(":", ""));
final Optional classifySession =
findClassifySessionDetailsByMatch(classifySessionDump, match);
if (classifySession.isPresent()) {
final ClassifySessionDetails detail = classifySession.get();
builder.setHitNext(readVppNode(detail.hitNextIndex, LOG));
if (detail.opaqueIndex != ~0) {
// value is specified:
builder.setOpaqueIndex(readOpaqueIndex(detail.opaqueIndex));
}
builder.setAdvance(detail.advance);
builder.setMatch(key.getMatch());
if (LOG.isTraceEnabled()) {
LOG.trace("Attributes for classify session {} successfully read: {}", id, builder.build());
}
}
}
private OpaqueIndex readOpaqueIndex(final int opaqueIndex) {
// We first try to map the value to a vpp node, if that fails, simply wrap the u32 value
// FIXME: the approach might fail if the opaqueIndex contains small value that collides
// with some of the adjacent nodes
final VppNode node = readVppNode(opaqueIndex, LOG);
if (node != null) {
return new OpaqueIndex(node);
} else {
return new OpaqueIndex(UnsignedInts.toLong(opaqueIndex));
}
}
@Nullable
private ClassifySessionDetailsReplyDump dumpClassifySessions(@Nonnull final InstanceIdentifier> id,
@Nonnull final ReadContext ctx)
throws ReadFailedException {
final ClassifyTableKey tableKey = id.firstKeyOf(ClassifyTable.class);
checkArgument(tableKey != null, "could not find ClassifyTable key in {}", id);
final String cacheKey = CACHE_KEY + tableKey;
ClassifySessionDetailsReplyDump classifySessionDump =
(ClassifySessionDetailsReplyDump) ctx.getModificationCache().get(cacheKey);
if (classifySessionDump != null) {
LOG.debug("Classify sessions is present in cache: {}", cacheKey);
return classifySessionDump;
}
final String tableName = tableKey.getName();
checkState(classifyTableContext.containsIndex(tableName, ctx.getMappingContext()),
"Reading classify sessions for table {}, but table index could not be found in the classify table context",
tableName);
final int tableId = classifyTableContext.getIndex(tableName, ctx.getMappingContext());
LOG.debug("Dumping classify sessions for classify table id={}", tableId);
try {
final ClassifySessionDump dumpRequest = new ClassifySessionDump();
dumpRequest.tableId = tableId;
classifySessionDump = TranslateUtils
.getReplyForRead(getFutureJVpp().classifySessionDump(dumpRequest).toCompletableFuture(), id);
// update the cache:
ctx.getModificationCache().put(cacheKey, classifySessionDump);
return classifySessionDump;
} catch (VppBaseCallException e) {
throw new ReadFailedException(id, e);
}
}
private static Optional findClassifySessionDetailsByMatch(
@Nullable final ClassifySessionDetailsReplyDump classifySessionDump, @Nonnull final byte[] match) {
if (classifySessionDump != null && classifySessionDump.classifySessionDetails != null) {
final List details = classifySessionDump.classifySessionDetails;
final List filteredSessions = details.stream()
.filter(singleDetail -> Arrays.equals(singleDetail.match, match)).collect(Collectors.toList());
if (filteredSessions.isEmpty()) {
return Optional.absent();
} else if (filteredSessions.size() == 1) {
return Optional.of(filteredSessions.get(0));
} else {
throw new IllegalStateException(String.format(
"Found %d classify sessions witch given match. Single session expected.",
filteredSessions.size()));
}
}
return Optional.absent();
}
@Nonnull
@Override
public List getAllIds(@Nonnull final InstanceIdentifier id,
@Nonnull final ReadContext ctx) throws ReadFailedException {
LOG.debug("Reading list of keys for classify sessions: {}", id);
final ClassifySessionDetailsReplyDump classifySessionDump = dumpClassifySessions(id, ctx);
if (classifySessionDump != null && classifySessionDump.classifySessionDetails != null) {
return classifySessionDump.classifySessionDetails.stream()
.map(detail -> new ClassifySessionKey(new HexString(printHexBinary(detail.match))))
.collect(Collectors.toList());
} else {
return Collections.emptyList();
}
}
}