2 * Copyright 2015 Facebook, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
24 #include <boost/operators.hpp>
26 #include <folly/Hash.h>
27 #include <folly/Range.h>
28 #include <folly/detail/IPAddress.h>
38 * Pair of IPAddressV6, netmask
40 typedef std::pair<IPAddressV6, uint8_t> CIDRNetworkV6;
43 * Specialization for IPv6 addresses
45 typedef std::array<uint8_t, 16> ByteArray16;
48 * IPv6 variation of IPAddress.
50 * Added methods: createIPv4, getIPv4For6To4, is6To4,
51 * isTeredo, isIPv4Mapped, tryCreateIPv4, type
55 * Notes on scope ID parsing:
57 * getaddrinfo() uses if_nametoindex() to convert interface names
58 * into a numerical index. For instance,
59 * "fe80::202:c9ff:fec1:ee08%eth0" may return scope ID 2 on some
60 * hosts, but other numbers on other hosts. It will fail entirely on
61 * hosts without an eth0 interface.
63 * Serializing / Deserializing IPAddressB6's on different hosts
64 * that use link-local scoping probably won't work.
66 class IPAddressV6 : boost::totally_ordered<IPAddressV6> {
70 TEREDO, T6TO4, NORMAL,
72 // A constructor parameter to indicate that we should create a link-local
77 // Thrown when a type assertion fails
78 typedef std::runtime_error TypeError;
80 // Binary prefix for teredo networks
81 static const uint32_t PREFIX_TEREDO;
82 // Binary prefix for 6to4 networks
83 static const uint32_t PREFIX_6TO4;
85 // Size of std::string returned by toFullyQualified.
86 static constexpr size_t kToFullyQualifiedSize =
87 8 /*words*/ * 4 /*hex chars per word*/ + 7 /*separators*/;
90 * Create a new IPAddress instance from the provided binary data.
91 * @throws IPAddressFormatException if the input length is not 16 bytes.
93 static IPAddressV6 fromBinary(ByteRange bytes) {
95 addr.setFromBinary(bytes);
100 * Returns the address as a Range.
102 ByteRange toBinary() const {
103 return ByteRange((const unsigned char *) &addr_.in6Addr_.s6_addr, 16);
107 * Default constructor for IPAddressV6.
109 * The address value will be ::0
113 // Create an IPAddressV6 from a string
114 // @throws IPAddressFormatException
116 explicit IPAddressV6(StringPiece ip);
118 // ByteArray16 constructor
119 explicit IPAddressV6(const ByteArray16& src);
121 // in6_addr constructor
122 explicit IPAddressV6(const in6_addr& src);
124 // sockaddr_in6 constructor
125 explicit IPAddressV6(const sockaddr_in6& src);
128 * Create a link-local IPAddressV6 from the specified ethernet MAC address.
130 IPAddressV6(LinkLocalTag tag, MacAddress mac);
132 // return the mapped V4 address
133 // @throws IPAddressFormatException if !isIPv4Mapped
134 IPAddressV4 createIPv4() const;
137 * Return a V4 address if this is a 6To4 address.
138 * @throws TypeError if not a 6To4 address
140 IPAddressV4 getIPv4For6To4() const;
142 // Return true if a 6TO4 address
143 bool is6To4() const {
144 return type() == IPAddressV6::Type::T6TO4;
147 // Return true if a TEREDO address
148 bool isTeredo() const {
149 return type() == IPAddressV6::Type::TEREDO;
152 // return true if this is v4-to-v6-mapped
153 bool isIPv4Mapped() const;
155 // Return the V6 address type
159 * @see IPAddress#bitCount
162 static size_t bitCount() { return 128; }
165 * @see IPAddress#toJson
167 std::string toJson() const;
171 // @see IPAddress#inSubnet
172 // @throws IPAddressFormatException if string doesn't contain a V6 address
173 bool inSubnet(StringPiece cidrNetwork) const;
175 // return true if address is in subnet
176 bool inSubnet(const IPAddressV6& subnet, uint8_t cidr) const {
177 return inSubnetWithMask(subnet, fetchMask(cidr));
179 bool inSubnetWithMask(const IPAddressV6& subnet,
180 const ByteArray16& mask) const;
182 // @see IPAddress#isLoopback
183 bool isLoopback() const;
185 // @see IPAddress#isNonroutable
186 bool isNonroutable() const {
187 return !isRoutable();
191 * Return true if this address is routable.
193 bool isRoutable() const;
195 // @see IPAddress#isPrivate
196 bool isPrivate() const;
199 * Return true if this is a link-local IPv6 address.
201 * Note that this only returns true for addresses in the fe80::/10 range.
202 * It returns false for the loopback address (::1), even though this address
203 * is also effectively has link-local scope. It also returns false for
204 * link-scope and interface-scope multicast addresses.
206 bool isLinkLocal() const;
209 * Return true if this is a multicast address.
211 bool isMulticast() const;
214 * Return the flags for a multicast address.
215 * This method may only be called on multicast addresses.
217 uint8_t getMulticastFlags() const;
220 * Return the scope for a multicast address.
221 * This method may only be called on multicast addresses.
223 uint8_t getMulticastScope() const;
225 // @see IPAddress#isZero
226 bool isZero() const {
227 return detail::Bytes::isZero(bytes(), 16);
230 bool isLinkLocalBroadcast() const;
232 // @see IPAddress#mask
233 IPAddressV6 mask(size_t numBits) const;
235 // return underlying in6_addr structure
236 in6_addr toAddr() const { return addr_.in6Addr_; }
238 uint16_t getScopeId() const { return scope_; }
239 void setScopeId(uint16_t scope) {
243 sockaddr_in6 toSockAddr() const {
245 memset(&addr, 0, sizeof(sockaddr_in6));
246 addr.sin6_family = AF_INET6;
247 addr.sin6_scope_id = scope_;
248 memcpy(&addr.sin6_addr, &addr_.in6Addr_, sizeof(in6_addr));
252 ByteArray16 toByteArray() const {
254 std::memcpy(ba.data(), bytes(), 16);
258 // @see IPAddress#toFullyQualified
259 std::string toFullyQualified() const;
261 // @see IPAddress#str
262 std::string str() const;
264 // @see IPAddress#version
265 size_t version() const { return 6; }
268 * Return the solicited-node multicast address for this address.
270 IPAddressV6 getSolicitedNodeAddress() const;
273 * Return the mask associated with the given number of bits.
274 * If for instance numBits was 24 (e.g. /24) then the V4 mask returned should
275 * be {0xff, 0xff, 0xff, 0x00}.
276 * @param [in] numBits bitmask to retrieve
277 * @throws abort if numBits == 0 or numBits > bitCount()
278 * @return mask associated with numBits
280 static const ByteArray16 fetchMask(size_t numBits);
281 // Given 2 IPAddressV6,mask pairs extract the longest common IPAddress,
283 static CIDRNetworkV6 longestCommonPrefix(const CIDRNetworkV6& one,
284 const CIDRNetworkV6& two) {
285 auto prefix = detail::Bytes::longestCommonPrefix(
286 one.first.addr_.bytes_, one.second,
287 two.first.addr_.bytes_, two.second);
288 return {IPAddressV6(prefix.first), prefix.second};
290 // Number of bytes in the address representation.
291 static constexpr size_t byteCount() { return 16; }
293 //get nth most significant bit - 0 indexed
294 bool getNthMSBit(size_t bitIndex) const {
295 return detail::getNthMSBitImpl(*this, bitIndex, AF_INET6);
297 //get nth most significant byte - 0 indexed
298 uint8_t getNthMSByte(size_t byteIndex) const;
299 //get nth bit - 0 indexed
300 bool getNthLSBit(size_t bitIndex) const {
301 return getNthMSBit(bitCount() - bitIndex - 1);
303 //get nth byte - 0 indexed
304 uint8_t getNthLSByte(size_t byteIndex) const {
305 return getNthMSByte(byteCount() - byteIndex - 1);
308 const unsigned char* bytes() const { return addr_.in6Addr_.s6_addr; }
311 * Helper that returns true if the address is in the binary subnet specified
314 bool inBinarySubnet(const std::array<uint8_t, 2> addr,
315 size_t numBits) const;
318 union AddressStorage {
322 std::memset(this, 0, sizeof(AddressStorage));
324 explicit AddressStorage(const ByteArray16& bytes): bytes_(bytes) {}
325 explicit AddressStorage(const in6_addr& addr): in6Addr_(addr) {}
326 explicit AddressStorage(MacAddress mac);
329 // Link-local scope id. This should always be 0 for IPAddresses that
330 // are *not* link-local.
333 static const std::array<ByteArray16, 129> masks_;
336 * Set the current IPAddressV6 object to have the address specified by bytes.
337 * @throws IPAddressFormatException if bytes.size() is not 16.
339 void setFromBinary(ByteRange bytes);
342 // boost::hash uses hash_value() so this allows boost::hash to work
343 // automatically for IPAddressV6
344 std::size_t hash_value(const IPAddressV6& addr);
345 std::ostream& operator<<(std::ostream& os, const IPAddressV6& addr);
346 // Define toAppend() to allow IPAddressV6 to be used with to<string>
347 void toAppend(IPAddressV6 addr, std::string* result);
348 void toAppend(IPAddressV6 addr, fbstring* result);
351 * Return true if two addresses are equal.
353 inline bool operator==(const IPAddressV6& addr1, const IPAddressV6& addr2) {
354 return (std::memcmp(addr1.toAddr().s6_addr, addr2.toAddr().s6_addr, 16) == 0)
355 && addr1.getScopeId() == addr2.getScopeId();
357 // Return true if addr1 < addr2
358 inline bool operator<(const IPAddressV6& addr1, const IPAddressV6& addr2) {
359 auto cmp = std::memcmp(addr1.toAddr().s6_addr,
360 addr2.toAddr().s6_addr, 16) < 0;
362 return addr1.getScopeId() < addr2.getScopeId();
372 struct hash<folly::IPAddressV6> {
373 size_t operator()(const folly::IPAddressV6& addr) const {