2 * Copyright 2014 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.
17 #ifndef __STDC_FORMAT_MACROS
18 #define __STDC_FORMAT_MACROS
21 #include <folly/SocketAddress.h>
23 #include <folly/Hash.h>
25 #include <boost/functional/hash.hpp>
26 #include <boost/static_assert.hpp>
36 * A structure to free a struct addrinfo when it goes out of scope.
38 struct ScopedAddrInfo {
39 explicit ScopedAddrInfo(struct addrinfo* info) : info(info) {}
44 struct addrinfo* info;
48 * A simple data structure for parsing a host-and-port string.
50 * Accepts a string of the form "<host>:<port>" or just "<port>",
51 * and contains two string pointers to the host and the port portion of the
54 * The HostAndPort may contain pointers into the original string. It is
55 * responsible for the user to ensure that the input string is valid for the
56 * lifetime of the HostAndPort structure.
59 HostAndPort(const char* str, bool hostRequired)
64 // Look for the last colon
65 const char* colon = strrchr(str, ':');
66 if (colon == nullptr) {
67 // No colon, just a port number.
69 throw std::invalid_argument(
70 "expected a host and port string of the "
71 "form \"<host>:<port>\"");
77 // We have to make a copy of the string so we can modify it
78 // and change the colon to a NUL terminator.
79 allocated = strdup(str);
81 throw std::bad_alloc();
84 char *allocatedColon = allocated + (colon - str);
85 *allocatedColon = '\0';
87 port = allocatedColon + 1;
88 // bracketed IPv6 address, remove the brackets
89 // allocatedColon[-1] is fine, as allocatedColon >= host and
90 // *allocatedColon != *host therefore allocatedColon > host
91 if (*host == '[' && allocatedColon[-1] == ']') {
92 allocatedColon[-1] = '\0';
106 } // unnamed namespace
110 bool SocketAddress::isPrivateAddress() const {
111 auto family = getFamily();
112 if (family == AF_INET || family == AF_INET6) {
113 return storage_.addr.isPrivate() ||
114 (storage_.addr.isV6() && storage_.addr.asV6().isLinkLocal());
115 } else if (family == AF_UNIX) {
116 // Unix addresses are always local to a host. Return true,
117 // since this conforms to the semantics of returning true for IP loopback
124 bool SocketAddress::isLoopbackAddress() const {
125 auto family = getFamily();
126 if (family == AF_INET || family == AF_INET6) {
127 return storage_.addr.isLoopback();
128 } else if (family == AF_UNIX) {
129 // Return true for UNIX addresses, since they are always local to a host.
135 void SocketAddress::setFromHostPort(const char* host, uint16_t port) {
136 ScopedAddrInfo results(getAddrInfo(host, port, 0));
137 setFromAddrInfo(results.info);
140 void SocketAddress::setFromIpPort(const char* ip, uint16_t port) {
141 ScopedAddrInfo results(getAddrInfo(ip, port, AI_NUMERICHOST));
142 setFromAddrInfo(results.info);
145 void SocketAddress::setFromLocalPort(uint16_t port) {
146 ScopedAddrInfo results(getAddrInfo(nullptr, port, AI_ADDRCONFIG));
147 setFromLocalAddr(results.info);
150 void SocketAddress::setFromLocalPort(const char* port) {
151 ScopedAddrInfo results(getAddrInfo(nullptr, port, AI_ADDRCONFIG));
152 setFromLocalAddr(results.info);
155 void SocketAddress::setFromLocalIpPort(const char* addressAndPort) {
156 HostAndPort hp(addressAndPort, false);
157 ScopedAddrInfo results(getAddrInfo(hp.host, hp.port,
158 AI_NUMERICHOST | AI_ADDRCONFIG));
159 setFromLocalAddr(results.info);
162 void SocketAddress::setFromIpPort(const char* addressAndPort) {
163 HostAndPort hp(addressAndPort, true);
164 ScopedAddrInfo results(getAddrInfo(hp.host, hp.port, AI_NUMERICHOST));
165 setFromAddrInfo(results.info);
168 void SocketAddress::setFromHostPort(const char* hostAndPort) {
169 HostAndPort hp(hostAndPort, true);
170 ScopedAddrInfo results(getAddrInfo(hp.host, hp.port, 0));
171 setFromAddrInfo(results.info);
174 void SocketAddress::setFromPath(const char* path, size_t len) {
175 if (getFamily() != AF_UNIX) {
180 storage_.un.len = offsetof(struct sockaddr_un, sun_path) + len;
181 if (len > sizeof(storage_.un.addr->sun_path)) {
182 throw std::invalid_argument(
183 "socket path too large to fit into sockaddr_un");
184 } else if (len == sizeof(storage_.un.addr->sun_path)) {
185 // Note that there will be no terminating NUL in this case.
186 // We allow this since getsockname() and getpeername() may return
187 // Unix socket addresses with paths that fit exactly in sun_path with no
189 memcpy(storage_.un.addr->sun_path, path, len);
191 memcpy(storage_.un.addr->sun_path, path, len + 1);
195 void SocketAddress::setFromPeerAddress(int socket) {
196 setFromSocket(socket, getpeername);
199 void SocketAddress::setFromLocalAddress(int socket) {
200 setFromSocket(socket, getsockname);
203 void SocketAddress::setFromSockaddr(const struct sockaddr* address) {
204 if (address->sa_family == AF_INET) {
205 storage_.addr = folly::IPAddress(address);
206 port_ = ntohs(((sockaddr_in*)address)->sin_port);
207 } else if (address->sa_family == AF_INET6) {
208 storage_.addr = folly::IPAddress(address);
209 port_ = ntohs(((sockaddr_in6*)address)->sin6_port);
210 } else if (address->sa_family == AF_UNIX) {
211 // We need an explicitly specified length for AF_UNIX addresses,
212 // to be able to distinguish anonymous addresses from addresses
213 // in Linux's abstract namespace.
214 throw std::invalid_argument(
215 "SocketAddress::setFromSockaddr(): the address "
216 "length must be explicitly specified when "
217 "setting AF_UNIX addresses");
219 throw std::invalid_argument(
220 "SocketAddress::setFromSockaddr() called "
221 "with unsupported address type");
226 void SocketAddress::setFromSockaddr(const struct sockaddr* address,
228 // Check the length to make sure we can access address->sa_family
229 if (addrlen < (offsetof(struct sockaddr, sa_family) +
230 sizeof(address->sa_family))) {
231 throw std::invalid_argument(
232 "SocketAddress::setFromSockaddr() called "
233 "with length too short for a sockaddr");
236 if (address->sa_family == AF_INET) {
237 if (addrlen < sizeof(struct sockaddr_in)) {
238 throw std::invalid_argument(
239 "SocketAddress::setFromSockaddr() called "
240 "with length too short for a sockaddr_in");
242 setFromSockaddr(reinterpret_cast<const struct sockaddr_in*>(address));
243 } else if (address->sa_family == AF_INET6) {
244 if (addrlen < sizeof(struct sockaddr_in6)) {
245 throw std::invalid_argument(
246 "SocketAddress::setFromSockaddr() called "
247 "with length too short for a sockaddr_in6");
249 setFromSockaddr(reinterpret_cast<const struct sockaddr_in6*>(address));
250 } else if (address->sa_family == AF_UNIX) {
251 setFromSockaddr(reinterpret_cast<const struct sockaddr_un*>(address),
254 throw std::invalid_argument(
255 "SocketAddress::setFromSockaddr() called "
256 "with unsupported address type");
260 void SocketAddress::setFromSockaddr(const struct sockaddr_in* address) {
261 assert(address->sin_family == AF_INET);
262 setFromSockaddr((sockaddr*)address);
265 void SocketAddress::setFromSockaddr(const struct sockaddr_in6* address) {
266 assert(address->sin6_family == AF_INET6);
267 setFromSockaddr((sockaddr*)address);
270 void SocketAddress::setFromSockaddr(const struct sockaddr_un* address,
272 assert(address->sun_family == AF_UNIX);
273 if (addrlen > sizeof(struct sockaddr_un)) {
274 throw std::invalid_argument(
275 "SocketAddress::setFromSockaddr() called "
276 "with length too long for a sockaddr_un");
279 prepFamilyChange(AF_UNIX);
280 memcpy(storage_.un.addr, address, addrlen);
281 updateUnixAddressLength(addrlen);
283 // Fill the rest with 0s, just for safety
284 if (addrlen < sizeof(struct sockaddr_un)) {
285 char *p = reinterpret_cast<char*>(storage_.un.addr);
286 memset(p + addrlen, 0, sizeof(struct sockaddr_un) - addrlen);
290 const folly::IPAddress& SocketAddress::getIPAddress() const {
291 auto family = getFamily();
292 if (family != AF_INET && family != AF_INET6) {
293 throw InvalidAddressFamilyException(family);
295 return storage_.addr;
298 socklen_t SocketAddress::getActualSize() const {
299 switch (getFamily()) {
302 return sizeof(struct sockaddr_in);
304 return sizeof(struct sockaddr_in6);
306 return storage_.un.len;
308 throw std::invalid_argument(
309 "SocketAddress::getActualSize() called "
310 "with unrecognized address family");
314 std::string SocketAddress::getFullyQualified() const {
315 auto family = getFamily();
316 if (family != AF_INET && family != AF_INET6) {
317 throw std::invalid_argument("Can't get address str for non ip address");
319 return storage_.addr.toFullyQualified();
322 std::string SocketAddress::getAddressStr() const {
323 char buf[INET6_ADDRSTRLEN];
324 getAddressStr(buf, sizeof(buf));
328 void SocketAddress::getAddressStr(char* buf, size_t buflen) const {
329 auto family = getFamily();
330 if (family != AF_INET && family != AF_INET6) {
331 throw std::invalid_argument("Can't get address str for non ip address");
333 std::string ret = storage_.addr.str();
334 size_t len = std::min(buflen, ret.size());
335 memcpy(buf, ret.data(), len);
339 uint16_t SocketAddress::getPort() const {
340 switch (getFamily()) {
345 throw std::invalid_argument(
346 "SocketAddress::getPort() called on non-IP "
351 void SocketAddress::setPort(uint16_t port) {
352 switch (getFamily()) {
358 throw std::invalid_argument(
359 "SocketAddress::setPort() called on non-IP "
364 void SocketAddress::convertToIPv4() {
365 if (!tryConvertToIPv4()) {
366 throw std::invalid_argument(
367 "convertToIPv4() called on an addresse that is "
368 "not an IPv4-mapped address");
372 bool SocketAddress::tryConvertToIPv4() {
373 if (!isIPv4Mapped()) {
377 storage_.addr = folly::IPAddress::createIPv4(storage_.addr);
381 bool SocketAddress::mapToIPv6() {
382 if (getFamily() != AF_INET) {
386 storage_.addr = folly::IPAddress::createIPv6(storage_.addr);
390 std::string SocketAddress::getHostStr() const {
391 return getIpString(0);
394 std::string SocketAddress::getPath() const {
395 if (getFamily() != AF_UNIX) {
396 throw std::invalid_argument(
397 "SocketAddress: attempting to get path "
398 "for a non-Unix address");
401 if (storage_.un.pathLength() == 0) {
403 return std::string();
405 if (storage_.un.addr->sun_path[0] == '\0') {
406 // abstract namespace
407 return std::string(storage_.un.addr->sun_path, storage_.un.pathLength());
410 return std::string(storage_.un.addr->sun_path,
411 strnlen(storage_.un.addr->sun_path,
412 storage_.un.pathLength()));
415 std::string SocketAddress::describe() const {
416 switch (getFamily()) {
418 return "<uninitialized address>";
421 char buf[NI_MAXHOST + 16];
422 getAddressStr(buf, sizeof(buf));
423 size_t iplen = strlen(buf);
424 snprintf(buf + iplen, sizeof(buf) - iplen, ":%" PRIu16, getPort());
429 char buf[NI_MAXHOST + 18];
431 getAddressStr(buf + 1, sizeof(buf) - 1);
432 size_t iplen = strlen(buf);
433 snprintf(buf + iplen, sizeof(buf) - iplen, "]:%" PRIu16, getPort());
438 if (storage_.un.pathLength() == 0) {
439 return "<anonymous unix address>";
442 if (storage_.un.addr->sun_path[0] == '\0') {
443 // Linux supports an abstract namespace for unix socket addresses
444 return "<abstract unix address>";
447 return std::string(storage_.un.addr->sun_path,
448 strnlen(storage_.un.addr->sun_path,
449 storage_.un.pathLength()));
454 snprintf(buf, sizeof(buf), "<unknown address family %d>",
461 bool SocketAddress::operator==(const SocketAddress& other) const {
462 if (other.getFamily() != getFamily()) {
466 switch (getFamily()) {
469 return (other.storage_.addr == storage_.addr) &&
470 (other.port_ == port_);
473 // anonymous addresses are never equal to any other addresses
474 if (storage_.un.pathLength() == 0 ||
475 other.storage_.un.pathLength() == 0) {
479 if (storage_.un.len != other.storage_.un.len) {
482 int cmp = memcmp(storage_.un.addr->sun_path,
483 other.storage_.un.addr->sun_path,
484 storage_.un.pathLength());
488 throw std::invalid_argument(
489 "SocketAddress: unsupported address family "
494 bool SocketAddress::prefixMatch(const SocketAddress& other,
495 unsigned prefixLength) const {
496 if (other.getFamily() != getFamily()) {
499 int mask_length = 128;
500 switch (getFamily()) {
506 auto prefix = folly::IPAddress::longestCommonPrefix(
507 {storage_.addr, mask_length},
508 {other.storage_.addr, mask_length});
509 return prefix.second >= prefixLength;
517 size_t SocketAddress::hash() const {
518 size_t seed = folly::hash::twang_mix64(getFamily());
520 switch (getFamily()) {
523 boost::hash_combine(seed, port_);
524 boost::hash_combine(seed, storage_.addr.hash());
529 enum { kUnixPathMax = sizeof(storage_.un.addr->sun_path) };
530 const char *path = storage_.un.addr->sun_path;
531 size_t pathLength = storage_.un.pathLength();
532 // TODO: this probably could be made more efficient
533 for (unsigned int n = 0; n < pathLength; ++n) {
534 boost::hash_combine(seed, folly::hash::twang_mix64(path[n]));
540 throw std::invalid_argument(
541 "SocketAddress: unsupported address family "
548 struct addrinfo* SocketAddress::getAddrInfo(const char* host,
551 // getaddrinfo() requires the port number as a string
552 char portString[sizeof("65535")];
553 snprintf(portString, sizeof(portString), "%" PRIu16, port);
555 return getAddrInfo(host, portString, flags);
558 struct addrinfo* SocketAddress::getAddrInfo(const char* host,
561 struct addrinfo hints;
562 memset(&hints, 0, sizeof(hints));
563 hints.ai_family = AF_UNSPEC;
564 hints.ai_socktype = SOCK_STREAM;
565 hints.ai_flags = AI_PASSIVE | AI_NUMERICSERV | flags;
567 struct addrinfo *results;
568 int error = getaddrinfo(host, port, &hints, &results);
570 auto os = folly::to<std::string>(
571 "Failed to resolve address for \"", host, "\": ",
572 gai_strerror(error), " (error=", error, ")");
573 throw std::system_error(error, std::generic_category(), os);
579 void SocketAddress::setFromAddrInfo(const struct addrinfo* info) {
580 setFromSockaddr(info->ai_addr, info->ai_addrlen);
583 void SocketAddress::setFromLocalAddr(const struct addrinfo* info) {
584 // If an IPv6 address is present, prefer to use it, since IPv4 addresses
585 // can be mapped into IPv6 space.
586 for (const struct addrinfo* ai = info; ai != nullptr; ai = ai->ai_next) {
587 if (ai->ai_family == AF_INET6) {
588 setFromSockaddr(ai->ai_addr, ai->ai_addrlen);
593 // Otherwise, just use the first address in the list.
594 setFromSockaddr(info->ai_addr, info->ai_addrlen);
597 void SocketAddress::setFromSocket(int socket,
598 int (*fn)(int, sockaddr*, socklen_t*)) {
599 // If this was previously an AF_UNIX socket, free the external buffer.
600 // TODO: It would be smarter to just remember the external buffer, and then
601 // re-use it or free it depending on if the new address is also a unix
603 if (getFamily() == AF_UNIX) {
608 // Try to put the address into a local storage buffer.
609 sockaddr_storage tmp_sock;
610 socklen_t addrLen = sizeof(tmp_sock);
611 if (fn(socket, (sockaddr*)&tmp_sock, &addrLen) != 0) {
612 folly::throwSystemError("setFromSocket() failed");
615 setFromSockaddr((sockaddr*)&tmp_sock, addrLen);
618 std::string SocketAddress::getIpString(int flags) const {
619 char addrString[NI_MAXHOST];
620 getIpString(addrString, sizeof(addrString), flags);
621 return std::string(addrString);
624 void SocketAddress::getIpString(char *buf, size_t buflen, int flags) const {
625 auto family = getFamily();
626 if (family != AF_INET &&
627 family != AF_INET6) {
628 throw std::invalid_argument(
629 "SocketAddress: attempting to get IP address "
630 "for a non-IP address");
633 sockaddr_storage tmp_sock;
634 storage_.addr.toSockaddrStorage(&tmp_sock, port_);
635 int rc = getnameinfo((sockaddr*)&tmp_sock, sizeof(sockaddr_storage),
636 buf, buflen, nullptr, 0, flags);
638 auto os = folly::to<std::string>(
639 "getnameinfo() failed in getIpString() error = ",
641 throw std::system_error(rc, std::generic_category(), os);
645 void SocketAddress::updateUnixAddressLength(socklen_t addrlen) {
646 if (addrlen < offsetof(struct sockaddr_un, sun_path)) {
647 throw std::invalid_argument(
648 "SocketAddress: attempted to set a Unix socket "
649 "with a length too short for a sockaddr_un");
652 storage_.un.len = addrlen;
653 if (storage_.un.pathLength() == 0) {
658 if (storage_.un.addr->sun_path[0] == '\0') {
659 // abstract namespace. honor the specified length
661 // Call strnlen(), just in case the length was overspecified.
662 socklen_t maxLength = addrlen - offsetof(struct sockaddr_un, sun_path);
663 size_t pathLength = strnlen(storage_.un.addr->sun_path, maxLength);
664 storage_.un.len = offsetof(struct sockaddr_un, sun_path) + pathLength;
668 bool SocketAddress::operator<(const SocketAddress& other) const {
669 if (getFamily() != other.getFamily()) {
670 return getFamily() < other.getFamily();
673 switch (getFamily()) {
676 if (port_ != other.port_) {
677 return port_ < other.port_;
681 storage_.addr < other.storage_.addr;
684 // Anonymous addresses can't be compared to anything else.
685 // Return that they are never less than anything.
687 // Note that this still meets the requirements for a strict weak
688 // ordering, so we can use this operator<() with standard C++ containers.
689 size_t thisPathLength = storage_.un.pathLength();
690 if (thisPathLength == 0) {
693 size_t otherPathLength = other.storage_.un.pathLength();
694 if (otherPathLength == 0) {
698 // Compare based on path length first, for efficiency
699 if (thisPathLength != otherPathLength) {
700 return thisPathLength < otherPathLength;
702 int cmp = memcmp(storage_.un.addr->sun_path,
703 other.storage_.un.addr->sun_path,
709 throw std::invalid_argument(
710 "SocketAddress: unsupported address family for comparing");
714 size_t hash_value(const SocketAddress& address) {
715 return address.hash();
718 std::ostream& operator<<(std::ostream& os, const SocketAddress& addr) {
719 os << addr.describe();