2 * Copyright (c) 2016 Dell Inc. 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.netvirt.ipv6service;
11 import static java.util.Objects.requireNonNull;
13 import java.nio.ByteBuffer;
14 import java.util.ArrayList;
15 import java.util.Arrays;
16 import java.util.List;
17 import org.eclipse.jdt.annotation.Nullable;
18 import org.opendaylight.genius.ipv6util.api.Icmpv6Type;
19 import org.opendaylight.genius.ipv6util.api.Ipv6Constants;
20 import org.opendaylight.genius.ipv6util.api.Ipv6Constants.Ipv6RouterAdvertisementType;
21 import org.opendaylight.genius.ipv6util.api.Ipv6Util;
22 import org.opendaylight.genius.mdsalutil.ActionInfo;
23 import org.opendaylight.genius.mdsalutil.MDSALUtil;
24 import org.opendaylight.genius.mdsalutil.NwConstants;
25 import org.opendaylight.genius.mdsalutil.actions.ActionGroup;
26 import org.opendaylight.genius.mdsalutil.packet.IPProtocols;
27 import org.opendaylight.infrautils.utils.concurrent.JdkFutures;
28 import org.opendaylight.netvirt.ipv6service.utils.Ipv6ServiceConstants;
29 import org.opendaylight.netvirt.ipv6service.utils.Ipv6ServiceUtils;
30 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IetfInetUtil;
31 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress;
32 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.Ipv6Prefix;
33 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress;
34 import org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.Uuid;
35 import org.opendaylight.yang.gen.v1.urn.opendaylight.action.types.rev131112.action.list.Action;
36 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.packet.rev160620.RouterAdvertisementPacket;
37 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.packet.rev160620.RouterAdvertisementPacketBuilder;
38 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.packet.rev160620.RouterSolicitationPacket;
39 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.packet.rev160620.router.advertisement.packet.PrefixList;
40 import org.opendaylight.yang.gen.v1.urn.opendaylight.genius.ipv6.nd.packet.rev160620.router.advertisement.packet.PrefixListBuilder;
41 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.PacketProcessingService;
42 import org.opendaylight.yang.gen.v1.urn.opendaylight.packet.service.rev130709.TransmitPacketInput;
43 import org.opendaylight.yangtools.yang.common.Uint64;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
48 public class Ipv6RouterAdvt {
49 private static final Logger LOG = LoggerFactory.getLogger(Ipv6RouterAdvt.class);
50 private final PacketProcessingService packetService;
51 private final IfMgr ifMgr;
53 public Ipv6RouterAdvt(PacketProcessingService packetService, IfMgr ifMgr) {
54 this.packetService = packetService;
58 public boolean transmitRtrAdvertisement(Ipv6RouterAdvertisementType raType, VirtualPort routerPort,
59 long elanTag, @Nullable RouterSolicitationPacket rsPdu,
60 Uint64 dpnId, Uuid port) {
61 RouterAdvertisementPacketBuilder raPacket = new RouterAdvertisementPacketBuilder();
62 updateRAResponse(raType, rsPdu, raPacket, routerPort);
63 // Serialize the response packet
64 byte[] txPayload = fillRouterAdvertisementPacket(raPacket.build());
65 TransmitPacketInput input = null;
66 /* Send solicited router advertisement to requested VM port only.
67 * Send periodic unsolicited router advertisement to ELAN broadcast group.
69 if (raType == Ipv6RouterAdvertisementType.SOLICITED_ADVERTISEMENT) {
70 List<Action> actions = ifMgr.getEgressAction(port.getValue());
71 if (actions == null || actions.isEmpty()) {
72 LOG.error("Unable to send solicited router advertisement packet out. Since Egress "
73 + "action is empty for interface {}. ", port.getValue());
76 input = MDSALUtil.getPacketOut(actions, txPayload, dpnId);
77 LOG.debug("Transmitting the Router Advt packet out to port {}", port.getValue());
79 /* Here we handle UNSOLICITED_ADVERTISEMENT, CEASE_ADVERTISEMENT */
80 long elanGroupId = Ipv6ServiceUtils.getRemoteBCGroup(elanTag);
81 List<ActionInfo> lstActionInfo = new ArrayList<>();
82 lstActionInfo.add(new ActionGroup(elanGroupId));
83 input = MDSALUtil.getPacketOutDefault(lstActionInfo, txPayload, dpnId);
84 LOG.debug("Transmitting the Router Advt packet out to ELAN Group ID {}", elanGroupId);
86 JdkFutures.addErrorLogging(packetService.transmitPacket(input), LOG, "transmitPacket");
90 private static void updateRAResponse(Ipv6RouterAdvertisementType raType, @Nullable RouterSolicitationPacket pdu,
91 RouterAdvertisementPacketBuilder raPacket,
92 VirtualPort routerPort) {
93 short icmpv6RaFlags = 0;
94 String gatewayMac = null;
96 List<Ipv6Prefix> autoConfigPrefixList = new ArrayList<>();
97 List<Ipv6Prefix> statefulConfigPrefixList = new ArrayList<>();
99 for (VirtualSubnet subnet : routerPort.getSubnets()) {
100 gatewayIp = subnet.getGatewayIp();
101 // Skip if its a v4 subnet.
102 if (gatewayIp.getIpv4Address() != null) {
106 if (!subnet.getIpv6RAMode().isEmpty()) {
107 if (Ipv6ServiceConstants.IPV6_AUTO_ADDRESS_SUBNETS.contains(subnet.getIpv6RAMode())) {
108 autoConfigPrefixList.add(requireNonNull(subnet.getSubnetCidr().getIpv6Prefix()));
111 if (subnet.getIpv6RAMode().equalsIgnoreCase(Ipv6ServiceConstants.IPV6_DHCPV6_STATEFUL)) {
112 statefulConfigPrefixList.add(requireNonNull(subnet.getSubnetCidr().getIpv6Prefix()));
116 if (subnet.getIpv6RAMode().equalsIgnoreCase(Ipv6ServiceConstants.IPV6_DHCPV6_STATELESS)) {
117 icmpv6RaFlags = (short) (icmpv6RaFlags | 1 << 6); // Other Configuration.
118 } else if (subnet.getIpv6RAMode().equalsIgnoreCase(Ipv6ServiceConstants.IPV6_DHCPV6_STATEFUL)) {
119 icmpv6RaFlags = (short) (icmpv6RaFlags | 1 << 7); // Managed Address Conf.
123 gatewayMac = routerPort.getMacAddress();
125 MacAddress sourceMac = MacAddress.getDefaultInstance(gatewayMac);
126 raPacket.setSourceMac(sourceMac);
127 if (raType == Ipv6RouterAdvertisementType.SOLICITED_ADVERTISEMENT) {
129 throw new IllegalArgumentException("Null pdu for solicited advertisement");
131 raPacket.setDestinationMac(pdu.getSourceMac());
132 raPacket.setDestinationIpv6(pdu.getSourceIpv6());
133 raPacket.setFlowLabel(pdu.getFlowLabel());
135 raPacket.setDestinationMac(new MacAddress(Ipv6Constants.ALL_NODES_MCAST_MAC));
136 raPacket.setDestinationIpv6(Ipv6ServiceUtils.ALL_NODES_MCAST_ADDR);
137 raPacket.setFlowLabel(Ipv6ServiceConstants.DEF_FLOWLABEL);
140 raPacket.setEthertype(NwConstants.ETHTYPE_IPV6);
142 raPacket.setVersion(Ipv6Constants.IPV6_VERSION);
143 int prefixListLength = autoConfigPrefixList.size() + statefulConfigPrefixList.size();
144 int mtuOptionLength = routerPort.getMtu() == 0 ? 0 : Ipv6Constants.ICMPV6_OPTION_MTU_LENGTH;
145 raPacket.setIpv6Length(Ipv6Constants.ICMPV6_RA_LENGTH_WO_OPTIONS
146 + mtuOptionLength + Ipv6Constants.ICMPV6_OPTION_SOURCE_LLA_LENGTH
147 + prefixListLength * Ipv6Constants.ICMPV6_OPTION_PREFIX_LENGTH);
148 raPacket.setNextHeader(IPProtocols.IPV6ICMP.shortValue());
149 raPacket.setHopLimit(Ipv6Constants.ICMP_V6_MAX_HOP_LIMIT);
150 raPacket.setSourceIpv6(Ipv6Util.getIpv6LinkLocalAddressFromMac(sourceMac));
152 raPacket.setIcmp6Type(Icmpv6Type.ROUTER_ADVETISEMENT.getValue());
153 raPacket.setIcmp6Code((short)0);
154 raPacket.setIcmp6Chksum(0);
156 raPacket.setCurHopLimit((short) Ipv6Constants.IPV6_DEFAULT_HOP_LIMIT);
157 raPacket.setFlags(icmpv6RaFlags);
159 if (raType == Ipv6RouterAdvertisementType.CEASE_ADVERTISEMENT) {
160 raPacket.setRouterLifetime(0);
162 raPacket.setRouterLifetime(Ipv6Constants.IPV6_ROUTER_LIFETIME);
164 raPacket.setReachableTime((long) Ipv6Constants.IPV6_RA_REACHABLE_TIME);
165 raPacket.setRetransTime((long) 0);
167 raPacket.setOptionSourceAddr(Ipv6Constants.ICMP_V6_OPTION_SOURCE_LLA);
168 raPacket.setSourceAddrLength((short)1);
169 raPacket.setSourceLlAddress(MacAddress.getDefaultInstance(gatewayMac));
171 if (mtuOptionLength != 0) {
172 raPacket.setOptionMtu(Ipv6Constants.ICMP_V6_OPTION_MTU);
173 raPacket.setOptionMtuLength((short)1);
174 raPacket.setMtu((long) routerPort.getMtu());
177 List<PrefixList> prefixList = new ArrayList<>();
178 PrefixListBuilder prefix = new PrefixListBuilder();
179 prefix.setOptionType(Ipv6Constants.ICMP_V6_OPTION_PREFIX_INFO);
180 prefix.setOptionLength((short)4);
181 // Note: EUI-64 auto-configuration requires 64 bits.
182 prefix.setPrefixLength((short)64);
183 prefix.setValidLifetime((long) Ipv6Constants.IPV6_RA_VALID_LIFETIME);
184 prefix.setPreferredLifetime((long) Ipv6Constants.IPV6_RA_PREFERRED_LIFETIME);
185 prefix.setReserved((long) 0);
187 short autoConfPrefixFlags = 0;
188 autoConfPrefixFlags = (short) (autoConfPrefixFlags | 1 << 7); // On-link flag
189 autoConfPrefixFlags = (short) (autoConfPrefixFlags | 1 << 6); // Autonomous address-configuration flag.
190 for (Ipv6Prefix v6Prefix : autoConfigPrefixList) {
191 prefix.setFlags(autoConfPrefixFlags);
192 prefix.setPrefix(v6Prefix);
193 prefixList.add(prefix.build());
196 short statefulPrefixFlags = 0;
197 statefulPrefixFlags = (short) (statefulPrefixFlags | 1 << 7); // On-link flag
198 for (Ipv6Prefix v6Prefix : statefulConfigPrefixList) {
199 prefix.setFlags(statefulPrefixFlags);
200 prefix.setPrefix(v6Prefix);
201 prefixList.add(prefix.build());
204 raPacket.setPrefixList(prefixList);
207 private byte[] fillRouterAdvertisementPacket(RouterAdvertisementPacket pdu) {
208 ByteBuffer buf = ByteBuffer.allocate(Ipv6Constants.ICMPV6_OFFSET + pdu.getIpv6Length().toJava());
210 buf.put(Ipv6Util.convertEthernetHeaderToByte(pdu), 0, 14);
211 buf.put(Ipv6Util.convertIpv6HeaderToByte(pdu), 0, 40);
212 buf.put(icmp6RAPayloadtoByte(pdu), 0, pdu.getIpv6Length().toJava());
213 int checksum = Ipv6Util.calculateIcmpv6Checksum(buf.array(), pdu);
214 buf.putShort(Ipv6Constants.ICMPV6_OFFSET + 2, (short)checksum);
218 private static byte[] icmp6RAPayloadtoByte(RouterAdvertisementPacket pdu) {
219 byte[] data = new byte[pdu.getIpv6Length().toJava()];
220 Arrays.fill(data, (byte)0);
222 ByteBuffer buf = ByteBuffer.wrap(data);
223 buf.put((byte)pdu.getIcmp6Type().shortValue());
224 buf.put((byte)pdu.getIcmp6Code().shortValue());
225 buf.putShort((short)pdu.getIcmp6Chksum().intValue());
226 buf.put((byte)pdu.getCurHopLimit().shortValue());
227 buf.put((byte)pdu.getFlags().shortValue());
228 buf.putShort((short)pdu.getRouterLifetime().intValue());
229 buf.putInt((int)pdu.getReachableTime().longValue());
230 buf.putInt((int)pdu.getRetransTime().longValue());
231 buf.put((byte)pdu.getOptionSourceAddr().shortValue());
232 buf.put((byte)pdu.getSourceAddrLength().shortValue());
233 buf.put(Ipv6Util.bytesFromHexString(pdu.getSourceLlAddress().getValue()));
234 if (pdu.getOptionMtu() != null) {
235 buf.put((byte)pdu.getOptionMtu().shortValue());
236 buf.put((byte)pdu.getOptionMtuLength().shortValue());
237 buf.putShort((byte)0); // Reserved field
238 buf.putInt((int)pdu.getMtu().longValue());
241 for (PrefixList prefix : new ArrayList<PrefixList>(pdu.nonnullPrefixList().values())) {
242 buf.put((byte)prefix.getOptionType().shortValue());
243 buf.put((byte)prefix.getOptionLength().shortValue());
244 buf.put((byte)prefix.getPrefixLength().shortValue());
245 buf.put((byte)prefix.getFlags().shortValue());
246 buf.putInt((int)prefix.getValidLifetime().longValue());
247 buf.putInt((int)prefix.getPreferredLifetime().longValue());
248 buf.putInt((int)prefix.getReserved().longValue());
249 buf.put(IetfInetUtil.INSTANCE.ipv6PrefixToBytes(new Ipv6Prefix(prefix.getPrefix())),0,16);