diff --git a/lib/libc/net/gai_strerror.3 b/lib/libc/net/gai_strerror.3 index d948083447db..2653fc6d371a 100644 --- a/lib/libc/net/gai_strerror.3 +++ b/lib/libc/net/gai_strerror.3 @@ -1,89 +1,100 @@ .\" $KAME: gai_strerror.3,v 1.1 2005/01/05 03:04:47 itojun Exp $ .\" $OpenBSD: gai_strerror.3,v 1.4 2004/12/20 23:04:53 millert Exp $ .\" .\" Copyright (C) 2004 Internet Systems Consortium, Inc. ("ISC") .\" Copyright (C) 2000, 2001 Internet Software Consortium. .\" .\" Permission to use, copy, modify, and distribute this software for any .\" purpose with or without fee is hereby granted, provided that the above .\" copyright notice and this permission notice appear in all copies. .\" .\" THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH .\" REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY .\" AND FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, .\" INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM .\" LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE .\" OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR .\" PERFORMANCE OF THIS SOFTWARE. .\" .\" $FreeBSD$ .\" -.Dd December 23, 2018 +.Dd November 2, 2022 .Dt GAI_STRERROR 3 .Os .Sh NAME .Nm gai_strerror .Nd get error message string from EAI_xxx error code .Sh SYNOPSIS .In sys/types.h .In sys/socket.h .In netdb.h .Ft "const char *" .Fn gai_strerror "int ecode" .Sh DESCRIPTION The .Fn gai_strerror function returns an error message string corresponding to the error code returned by .Xr getaddrinfo 3 or .Xr getnameinfo 3 . .Pp The following error codes and their meaning are defined in .In netdb.h : .Pp -.Bl -tag -width ".Dv EAI_BADFLAGS" -offset indent -compact +.Bl -tag -width ".Dv EAI_ADDRFAMILY" -offset indent -compact +.It Dv EAI_ADDRFAMILY +Address family for hostname not supported .It Dv EAI_AGAIN Name could not be resolved at this time .It Dv EAI_BADFLAGS flags parameter had an invalid value .It Dv EAI_BADHINTS invalid value for .Fa hints .It Dv EAI_FAIL Non-recoverable failure in name resolution .It Dv EAI_FAMILY Address family was not recognized .It Dv EAI_MEMORY Memory allocation failure +.It Dv EAI_NODATA +No address associated with hostname .It Dv EAI_NONAME Name does not resolve .It Dv EAI_OVERFLOW argument buffer overflow .It Dv EAI_PROTOCOL Resolved protocol is unknown .It Dv EAI_SERVICE Service was not recognized for socket type .It Dv EAI_SOCKTYPE Intended socket type was not recognized .It Dv EAI_SYSTEM System error returned in .Va errno .El .Sh RETURN VALUES The .Fn gai_strerror function returns a pointer to the error message string corresponding to .Fa ecode . If .Fa ecode is out of range, an implementation-specific error message string is returned. .Sh SEE ALSO .Xr getaddrinfo 3 , .Xr getnameinfo 3 .Sh STANDARDS -.Bl -tag -width ".It RFC 2743" +.Bl -tag -width ".It RFC 3493" .It RFC 3493 Basic Socket Interface Extensions for IPv6 .El +.Pp +EAI_ADDRFAMILY and EAI_NODATA were in previous RFCs, but not in RFC 3493. +They are not in POSIX (IEEE Std 1003.1-2017). +They were in +.Fx +before 5.2, and were re-added for 14.0. +EAI_BADHINTS, EAI_OVERFLOW, and EAI_PROTOCOL are not in RFC 3493 or POSIX. diff --git a/lib/libc/net/gai_strerror.c b/lib/libc/net/gai_strerror.c index f168c3093735..276ba91b95fd 100644 --- a/lib/libc/net/gai_strerror.c +++ b/lib/libc/net/gai_strerror.c @@ -1,121 +1,123 @@ /*- * SPDX-License-Identifier: BSD-3-Clause * * Copyright (C) 1995, 1996, 1997, and 1998 WIDE Project. * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of the project nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE PROJECT AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE PROJECT OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. */ #include __FBSDID("$FreeBSD$"); #include "namespace.h" #include #if defined(NLS) #include #include #include #include #include #include "reentrant.h" #endif #include "un-namespace.h" -/* Entries EAI_ADDRFAMILY (1) and EAI_NODATA (7) are obsoleted, but left */ -/* for backwards compatibility with userland code prior to RFC2553bis-02 */ +/* + * Entries EAI_ADDRFAMILY (1) and EAI_NODATA (7) were omitted from RFC 3493, + * but are or may be used as extensions or in old code. + */ static const char *ai_errlist[] = { "Success", /* 0 */ - "Address family for hostname not supported", /* 1: Obsolete */ + "Address family for hostname not supported", /* EAI_ADDRFAMILY */ "Name could not be resolved at this time", /* EAI_AGAIN */ "Flags parameter had an invalid value", /* EAI_BADFLAGS */ "Non-recoverable failure in name resolution", /* EAI_FAIL */ "Address family not recognized", /* EAI_FAMILY */ "Memory allocation failure", /* EAI_MEMORY */ - "No address associated with hostname", /* 7: Obsolete*/ + "No address associated with hostname", /* EAI_NODATA*/ "Name does not resolve", /* EAI_NONAME */ "Service was not recognized for socket type", /* EAI_SERVICE */ "Intended socket type was not recognized", /* EAI_SOCKTYPE */ "System error returned in errno", /* EAI_SYSTEM */ "Invalid value for hints", /* EAI_BADHINTS */ "Resolved protocol is unknown", /* EAI_PROTOCOL */ "Argument buffer overflow" /* EAI_OVERFLOW */ }; #if defined(NLS) static char gai_buf[NL_TEXTMAX]; static once_t gai_init_once = ONCE_INITIALIZER; static thread_key_t gai_key; static int gai_keycreated = 0; static void gai_keycreate(void) { gai_keycreated = (thr_keycreate(&gai_key, free) == 0); } #endif const char * gai_strerror(int ecode) { #if defined(NLS) nl_catd catd; char *buf; if (thr_main() != 0) buf = gai_buf; else { if (thr_once(&gai_init_once, gai_keycreate) != 0 || !gai_keycreated) goto thr_err; if ((buf = thr_getspecific(gai_key)) == NULL) { if ((buf = malloc(sizeof(gai_buf))) == NULL) goto thr_err; if (thr_setspecific(gai_key, buf) != 0) { free(buf); goto thr_err; } } } catd = catopen("libc", NL_CAT_LOCALE); if (ecode > 0 && ecode < EAI_MAX) strlcpy(buf, catgets(catd, 3, ecode, ai_errlist[ecode]), sizeof(gai_buf)); else if (ecode == 0) strlcpy(buf, catgets(catd, 3, NL_MSGMAX - 1, "Success"), sizeof(gai_buf)); else strlcpy(buf, catgets(catd, 3, NL_MSGMAX, "Unknown error"), sizeof(gai_buf)); catclose(catd); return buf; thr_err: #endif if (ecode >= 0 && ecode < EAI_MAX) return ai_errlist[ecode]; return "Unknown error"; }