summaryrefslogtreecommitdiffstats
path: root/v3po/v3po2vpp/src/main/java/io/fd/honeycomb/translate/v3po/vpp/ArpTerminationTableEntryCustomizer.java
blob: 4042dfac8c9c915b490219ae6d4b601a910212bd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/*
 * 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.translate.v3po.vpp;

import com.google.common.base.Preconditions;
import io.fd.honeycomb.translate.spi.write.ListWriterCustomizer;
import io.fd.honeycomb.translate.v3po.util.AddressTranslator;
import io.fd.honeycomb.translate.v3po.util.ByteDataTranslator;
import io.fd.honeycomb.translate.v3po.util.FutureJVppCustomizer;
import io.fd.honeycomb.translate.v3po.util.JvppReplyConsumer;
import io.fd.honeycomb.translate.v3po.util.NamingContext;
import io.fd.honeycomb.translate.v3po.util.WriteTimeoutException;
import io.fd.honeycomb.translate.write.WriteContext;
import io.fd.honeycomb.translate.write.WriteFailedException;
import java.util.concurrent.CompletionStage;
import javax.annotation.Nonnull;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv4AddressNoZone;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.bridge.domain.attributes.arp.termination.table.ArpTerminationTableEntry;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.bridge.domain.attributes.arp.termination.table.ArpTerminationTableEntryKey;
import org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.v3po.rev150105.vpp.bridge.domains.BridgeDomain;
import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
import org.openvpp.jvpp.VppBaseCallException;
import org.openvpp.jvpp.core.dto.BdIpMacAddDel;
import org.openvpp.jvpp.core.dto.BdIpMacAddDelReply;
import org.openvpp.jvpp.core.future.FutureJVppCore;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Writer Customizer responsible for ARP termination table management.<br> Sends {@code bd_ip_mac_add_del} message to
 * VPP.<br> Equivalent of invoking {@code vppctl set bridge-domain arp term} command.
 */
public class ArpTerminationTableEntryCustomizer extends FutureJVppCustomizer
        implements ListWriterCustomizer<ArpTerminationTableEntry, ArpTerminationTableEntryKey>, ByteDataTranslator,
        AddressTranslator, JvppReplyConsumer {

    private static final Logger LOG = LoggerFactory.getLogger(ArpTerminationTableEntryCustomizer.class);

    private final NamingContext bdContext;

    public ArpTerminationTableEntryCustomizer(@Nonnull final FutureJVppCore futureJvpp,
                                              @Nonnull final NamingContext bdContext) {
        super(futureJvpp);
        this.bdContext = Preconditions.checkNotNull(bdContext, "bdContext should not be null");
    }

    @Override
    public void writeCurrentAttributes(@Nonnull final InstanceIdentifier<ArpTerminationTableEntry> id,
                                       @Nonnull final ArpTerminationTableEntry dataAfter,
                                       @Nonnull final WriteContext writeContext)
            throws WriteFailedException {
        try {
            LOG.debug("Creating ARP termination table entry: {} {}", id, dataAfter);
            bdIpMacAddDel(id, dataAfter, writeContext, true);
            LOG.debug("L2 ARP termination table entry created successfully: {} {}", id, dataAfter);
        } catch (VppBaseCallException e) {
            LOG.warn("Failed to create ARP termination table entry: {} {}", id, dataAfter);
            throw new WriteFailedException.CreateFailedException(id, dataAfter, e);
        }
    }

    @Override
    public void updateCurrentAttributes(@Nonnull final InstanceIdentifier<ArpTerminationTableEntry> id,
                                        @Nonnull final ArpTerminationTableEntry dataBefore,
                                        @Nonnull final ArpTerminationTableEntry dataAfter,
                                        @Nonnull final WriteContext writeContext) throws WriteFailedException {
        throw new UnsupportedOperationException(
                "ARP termination table entry update is not supported. It has to be deleted and then created.");
    }

    @Override
    public void deleteCurrentAttributes(@Nonnull final InstanceIdentifier<ArpTerminationTableEntry> id,
                                        @Nonnull final ArpTerminationTableEntry dataBefore,
                                        @Nonnull final WriteContext writeContext)
            throws WriteFailedException {
        try {
            LOG.debug("Deleting ARP termination table entry entry: {} {}", id, dataBefore);
            bdIpMacAddDel(id, dataBefore, writeContext, false);
            LOG.debug("ARP termination table entry deleted successfully: {} {}", id, dataBefore);
        } catch (VppBaseCallException e) {
            LOG.warn("Failed to delete ARP termination table entry: {} {}", id, dataBefore);
            throw new WriteFailedException.DeleteFailedException(id, e);
        }
    }

    private void bdIpMacAddDel(@Nonnull final InstanceIdentifier<ArpTerminationTableEntry> id,
                               @Nonnull final ArpTerminationTableEntry entry,
                               final WriteContext writeContext, boolean isAdd)
            throws VppBaseCallException, WriteTimeoutException {
        final String bdName = id.firstKeyOf(BridgeDomain.class).getName();
        final int bdId = bdContext.getIndex(bdName, writeContext.getMappingContext());

        final BdIpMacAddDel request = createRequest(entry, bdId, isAdd);
        LOG.debug("Sending l2FibAddDel request: {}", request);
        final CompletionStage<BdIpMacAddDelReply> replyCompletionStage =
                getFutureJVpp().bdIpMacAddDel(request);

        getReplyForWrite(replyCompletionStage.toCompletableFuture(), id);
    }

    private BdIpMacAddDel createRequest(final ArpTerminationTableEntry entry, final int bdId, boolean isAdd) {
        final BdIpMacAddDel request = new BdIpMacAddDel();
        request.bdId = bdId;
        request.isAdd = booleanToByte(isAdd);
        request.macAddress = parseMac(entry.getPhysAddress().getValue());

        final IpAddress ipAddress = entry.getIpAddress();
        if (ipAddress.getIpv6Address() != null) {
            // FIXME: HONEYCOMB-187 vpp does not support ipv6 in arp-termination table (based on analysis of l2_bd.c)
            throw new UnsupportedOperationException("IPv6 address for ARP termination table is not supported yet");
        }

        request.ipAddress = ipv4AddressNoZoneToArray(new Ipv4AddressNoZone(ipAddress.getIpv4Address()));
        return request;
    }
}