/*
- * Copyright 2014 Facebook, Inc.
+ * Copyright 2017 Facebook, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* limitations under the License.
*/
-#include "IPAddressV4.h"
+#include <folly/IPAddressV4.h>
#include <ostream>
#include <string>
#include <folly/Format.h>
#include <folly/IPAddress.h>
#include <folly/IPAddressV6.h>
+#include <folly/detail/IPAddressSource.h>
using std::ostream;
using std::string;
result->append(addr.str());
}
+bool IPAddressV4::validate(StringPiece ip) noexcept {
+ return tryFromString(ip).hasValue();
+}
// public static
IPAddressV4 IPAddressV4::fromLong(uint32_t src) {
auto str = ip.str();
in_addr addr;
if (inet_pton(AF_INET, str.c_str(), &addr) != 1) {
- throw IPAddressFormatException("Can't convert invalid IP '", ip, "' ",
- "to long");
+ throw IPAddressFormatException(
+ sformat("Can't convert invalid IP '{}' to long", ip));
}
return addr.s_addr;
}
}
// public default constructor
-IPAddressV4::IPAddressV4() {
-}
+IPAddressV4::IPAddressV4() {}
// ByteArray4 constructor
-IPAddressV4::IPAddressV4(const ByteArray4& src)
- : addr_(src)
-{
-}
+IPAddressV4::IPAddressV4(const ByteArray4& src) noexcept : addr_(src) {}
// public string constructor
-IPAddressV4::IPAddressV4(StringPiece addr)
- : addr_()
-{
- auto ip = addr.str();
- if (inet_pton(AF_INET, ip.c_str(), &addr_.inAddr_) != 1) {
- throw IPAddressFormatException("Invalid IPv4 address '", addr, "'");
+IPAddressV4::IPAddressV4(StringPiece addr) : addr_() {
+ auto maybeIp = tryFromString(addr);
+ if (maybeIp.hasError()) {
+ throw IPAddressFormatException(
+ to<std::string>("Invalid IPv4 address '", addr, "'"));
}
+ *this = std::move(maybeIp.value());
+}
+
+Expected<IPAddressV4, IPAddressFormatError> IPAddressV4::tryFromString(
+ StringPiece str) noexcept {
+ struct in_addr inAddr;
+ if (inet_pton(AF_INET, str.str().c_str(), &inAddr) != 1) {
+ return makeUnexpected(IPAddressFormatError::INVALID_IP);
+ }
+ return IPAddressV4(inAddr);
}
// in_addr constructor
-IPAddressV4::IPAddressV4(const in_addr src)
- : addr_(src)
-{
+IPAddressV4::IPAddressV4(const in_addr src) noexcept : addr_(src) {}
+
+IPAddressV4 IPAddressV4::fromBinary(ByteRange bytes) {
+ auto maybeIp = tryFromBinary(bytes);
+ if (maybeIp.hasError()) {
+ throw IPAddressFormatException(to<std::string>(
+ "Invalid IPv4 binary data: length must be 4 bytes, got ",
+ bytes.size()));
+ }
+ return maybeIp.value();
}
-// public
-void IPAddressV4::setFromBinary(ByteRange bytes) {
+Expected<IPAddressV4, IPAddressFormatError> IPAddressV4::tryFromBinary(
+ ByteRange bytes) noexcept {
+ IPAddressV4 addr;
+ auto setResult = addr.trySetFromBinary(bytes);
+ if (setResult.hasError()) {
+ return makeUnexpected(std::move(setResult.error()));
+ }
+ return addr;
+}
+
+Expected<Unit, IPAddressFormatError> IPAddressV4::trySetFromBinary(
+ ByteRange bytes) noexcept {
if (bytes.size() != 4) {
- throw IPAddressFormatException("Invalid IPv4 binary data: length must "
- "be 4 bytes, got ", bytes.size());
+ return makeUnexpected(IPAddressFormatError::INVALID_IP);
}
memcpy(&addr_.inAddr_.s_addr, bytes.data(), sizeof(in_addr));
+ return folly::unit;
}
-// public
+// static
+IPAddressV4 IPAddressV4::fromInverseArpaName(const std::string& arpaname) {
+ auto piece = StringPiece(arpaname);
+ // input must be something like 1.0.168.192.in-addr.arpa
+ if (!piece.removeSuffix(".in-addr.arpa")) {
+ throw IPAddressFormatException(
+ sformat("input does not end with '.in-addr.arpa': '{}'", arpaname));
+ }
+ std::vector<StringPiece> pieces;
+ split(".", piece, pieces);
+ if (pieces.size() != 4) {
+ throw IPAddressFormatException(sformat("Invalid input. Got {}", piece));
+ }
+ // reverse 1.0.168.192 -> 192.168.0.1
+ return IPAddressV4(join(".", pieces.rbegin(), pieces.rend()));
+}
IPAddressV6 IPAddressV4::createIPv6() const {
- ByteArray16 ba{{0}};
+ ByteArray16 ba{};
ba[10] = 0xff;
ba[11] = 0xff;
std::memcpy(&ba[12], bytes(), 4);
return IPAddressV6(ba);
}
+// public
+IPAddressV6 IPAddressV4::getIPv6For6To4() const {
+ ByteArray16 ba{};
+ ba[0] = (uint8_t)((IPAddressV6::PREFIX_6TO4 & 0xFF00) >> 8);
+ ba[1] = (uint8_t)(IPAddressV6::PREFIX_6TO4 & 0x00FF);
+ std::memcpy(&ba[2], bytes(), 4);
+ return IPAddressV6(ba);
+}
+
// public
string IPAddressV4::toJson() const {
- return format(
- "{{family:'AF_INET', addr:'{}', hash:{}}}", str(), hash()).str();
+ return sformat("{{family:'AF_INET', addr:'{}', hash:{}}}", str(), hash());
}
// public
auto subnetInfo = IPAddress::createNetwork(cidrNetwork);
auto addr = subnetInfo.first;
if (!addr.isV4()) {
- throw IPAddressFormatException("Address '", addr.toJson(), "' ",
- "is not a V4 address");
+ throw IPAddressFormatException(
+ sformat("Address '{}' is not a V4 address", addr.toJson()));
}
return inSubnetWithMask(addr.asV4(), fetchMask(subnetInfo.second));
}
// public
-bool IPAddressV4::inSubnetWithMask(const IPAddressV4& subnet,
- const ByteArray4 cidrMask) const {
- const ByteArray4 mask = detail::Bytes::mask(toByteArray(), cidrMask);
- const ByteArray4 subMask = detail::Bytes::mask(subnet.toByteArray(),
- cidrMask);
+bool IPAddressV4::inSubnetWithMask(
+ const IPAddressV4& subnet,
+ const ByteArray4 cidrMask) const {
+ const auto mask = detail::Bytes::mask(toByteArray(), cidrMask);
+ const auto subMask = detail::Bytes::mask(subnet.toByteArray(), cidrMask);
return (mask == subMask);
}
+// public
+bool IPAddressV4::isLoopback() const {
+ static IPAddressV4 loopback_addr("127.0.0.0");
+ return inSubnetWithMask(loopback_addr, fetchMask(8));
+}
+
+// public
+bool IPAddressV4::isLinkLocal() const {
+ static IPAddressV4 linklocal_addr("169.254.0.0");
+ return inSubnetWithMask(linklocal_addr, fetchMask(16));
+}
+
// public
bool IPAddressV4::isNonroutable() const {
auto ip = toLongHBO();
return isPrivate() ||
- (ip <= 0x00FFFFFF) || // 0.0.0.0-0.255.255.255
+ (/* align */ true && ip <= 0x00FFFFFF) || // 0.0.0.0-0.255.255.255
(ip >= 0xC0000000 && ip <= 0xC00000FF) || // 192.0.0.0-192.0.0.255
(ip >= 0xC0000200 && ip <= 0xC00002FF) || // 192.0.2.0-192.0.2.255
(ip >= 0xC6120000 && ip <= 0xC613FFFF) || // 198.18.0.0-198.19.255.255
(ip >= 0xC6336400 && ip <= 0xC63364FF) || // 198.51.100.0-198.51.100.255
(ip >= 0xCB007100 && ip <= 0xCB0071FF) || // 203.0.113.0-203.0.113.255
- (ip >= 0xE0000000 && ip <= 0xFFFFFFFF); // 224.0.0.0-255.255.255.255
+ (ip >= 0xE0000000 && ip <= 0xFFFFFFFF) || // 224.0.0.0-255.255.255.255
+ false;
}
// public
bool IPAddressV4::isPrivate() const {
auto ip = toLongHBO();
- return
+ return // some ranges below
(ip >= 0x0A000000 && ip <= 0x0AFFFFFF) || // 10.0.0.0-10.255.255.255
(ip >= 0x7F000000 && ip <= 0x7FFFFFFF) || // 127.0.0.0-127.255.255.255
(ip >= 0xA9FE0000 && ip <= 0xA9FEFFFF) || // 169.254.0.0-169.254.255.255
(ip >= 0xAC100000 && ip <= 0xAC1FFFFF) || // 172.16.0.0-172.31.255.255
- (ip >= 0xC0A80000 && ip <= 0xC0A8FFFF); // 192.168.0.0-192.168.255.255
+ (ip >= 0xC0A80000 && ip <= 0xC0A8FFFF) || // 192.168.0.0-192.168.255.255
+ false;
}
// public
IPAddressV4 IPAddressV4::mask(size_t numBits) const {
static const auto bits = bitCount();
if (numBits > bits) {
- throw IPAddressFormatException("numBits(", numBits,
- ") > bitsCount(", bits, ")");
+ throw IPAddressFormatException(
+ sformat("numBits({}) > bitsCount({})", numBits, bits));
}
ByteArray4 ba = detail::Bytes::mask(fetchMask(numBits), addr_.bytes_);
}
// public
-// Taken from TSocketAddress::getAddressStrIPv4Fast
string IPAddressV4::str() const {
- char buf[INET_ADDRSTRLEN] = {0};
- const uint8_t* ip = addr_.bytes_.data();
- int pos = 0;
- for (int k = 0; k < 4; ++k) {
- uint8_t num = ip[k];
-
- if (num >= 200) {
- buf[pos++] = '2';
- num -= 200;
- } else if (num >= 100) {
- buf[pos++] = '1';
- num -= 100;
- }
-
- // num < 100
- if (ip[k] >= 10) {
- buf[pos++] = '0' + num / 10;
- buf[pos++] = '0' + num % 10;
- } else {
- buf[pos++] = '0' + num;
- }
-
- buf[pos++] = '.';
- }
- buf[pos-1] = '\0';
- string ipAddr(buf);
- return std::move(ipAddr);
+ return detail::fastIpv4ToString(addr_.inAddr_);
+}
+
+// public
+void IPAddressV4::toFullyQualifiedAppend(std::string& out) const {
+ detail::fastIpv4AppendToString(addr_.inAddr_, out);
+}
+
+// public
+string IPAddressV4::toInverseArpaName() const {
+ return sformat(
+ "{}.{}.{}.{}.in-addr.arpa",
+ addr_.bytes_[3],
+ addr_.bytes_[2],
+ addr_.bytes_[1],
+ addr_.bytes_[0]);
}
// public
uint8_t IPAddressV4::getNthMSByte(size_t byteIndex) const {
const auto highestIndex = byteCount() - 1;
if (byteIndex > highestIndex) {
- throw std::invalid_argument(to<string>("Byte index must be <= ",
- to<string>(highestIndex), " for addresses of type :",
+ throw std::invalid_argument(sformat(
+ "Byte index must be <= {} for addresses of type: {}",
+ highestIndex,
detail::familyNameStr(AF_INET)));
}
return bytes()[byteIndex];
}
// protected
const ByteArray4 IPAddressV4::fetchMask(size_t numBits) {
- static const uint8_t bits = bitCount();
+ static const size_t bits = bitCount();
if (numBits > bits) {
throw IPAddressFormatException("IPv4 addresses are 32 bits");
}
- // masks_ is backed by an array so is zero indexed
- return masks_[numBits];
-}
-
-// static private
-const std::array<ByteArray4, 33> IPAddressV4::masks_ = {{
- {{0x00, 0x00, 0x00, 0x00}},
- {{0x80, 0x00, 0x00, 0x00}},
- {{0xc0, 0x00, 0x00, 0x00}},
- {{0xe0, 0x00, 0x00, 0x00}},
- {{0xf0, 0x00, 0x00, 0x00}},
- {{0xf8, 0x00, 0x00, 0x00}},
- {{0xfc, 0x00, 0x00, 0x00}},
- {{0xfe, 0x00, 0x00, 0x00}},
- {{0xff, 0x00, 0x00, 0x00}},
- {{0xff, 0x80, 0x00, 0x00}},
- {{0xff, 0xc0, 0x00, 0x00}},
- {{0xff, 0xe0, 0x00, 0x00}},
- {{0xff, 0xf0, 0x00, 0x00}},
- {{0xff, 0xf8, 0x00, 0x00}},
- {{0xff, 0xfc, 0x00, 0x00}},
- {{0xff, 0xfe, 0x00, 0x00}},
- {{0xff, 0xff, 0x00, 0x00}},
- {{0xff, 0xff, 0x80, 0x00}},
- {{0xff, 0xff, 0xc0, 0x00}},
- {{0xff, 0xff, 0xe0, 0x00}},
- {{0xff, 0xff, 0xf0, 0x00}},
- {{0xff, 0xff, 0xf8, 0x00}},
- {{0xff, 0xff, 0xfc, 0x00}},
- {{0xff, 0xff, 0xfe, 0x00}},
- {{0xff, 0xff, 0xff, 0x00}},
- {{0xff, 0xff, 0xff, 0x80}},
- {{0xff, 0xff, 0xff, 0xc0}},
- {{0xff, 0xff, 0xff, 0xe0}},
- {{0xff, 0xff, 0xff, 0xf0}},
- {{0xff, 0xff, 0xff, 0xf8}},
- {{0xff, 0xff, 0xff, 0xfc}},
- {{0xff, 0xff, 0xff, 0xfe}},
- {{0xff, 0xff, 0xff, 0xff}}
-}};
-
-} // folly
+ auto const val = Endian::big(uint32_t(~uint64_t(0) << (32 - numBits)));
+ ByteArray4 arr;
+ std::memcpy(arr.data(), &val, sizeof(val));
+ return arr;
+}
+// public static
+CIDRNetworkV4 IPAddressV4::longestCommonPrefix(
+ const CIDRNetworkV4& one,
+ const CIDRNetworkV4& two) {
+ auto prefix = detail::Bytes::longestCommonPrefix(
+ one.first.addr_.bytes_, one.second, two.first.addr_.bytes_, two.second);
+ return {IPAddressV4(prefix.first), prefix.second};
+}
+
+} // namespace folly