xref: /freebsd/lib/libc/string/strerror.c (revision b7f7cc25c01aeacaafb86ebcffdeb258b7933b08)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1988, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #if defined(LIBC_SCCS) && !defined(lint)
33 static char sccsid[] = "@(#)strerror.c	8.1 (Berkeley) 6/4/93";
34 #endif /* LIBC_SCCS and not lint */
35 #if defined(NLS)
36 #include <nl_types.h>
37 #endif
38 
39 #include <limits.h>
40 #include <errno.h>
41 #include <string.h>
42 #include <stdio.h>
43 
44 #include "errlst.h"
45 #include "../locale/xlocale_private.h"
46 #include "libc_private.h"
47 
48 /*
49  * Define buffer big enough to contain delimiter (": ", 2 bytes),
50  * 64-bit signed integer converted to ASCII decimal (19 bytes) with
51  * optional leading sign (1 byte), and a trailing NUL.
52  */
53 #define	EBUFSIZE	(2 + 19 + 1 + 1)
54 
55 /*
56  * Doing this by hand instead of linking with stdio(3) avoids bloat for
57  * statically linked binaries.
58  */
59 static void
60 errstr(int num, const char *uprefix, char *buf, size_t len)
61 {
62 	char *t;
63 	unsigned int uerr;
64 	char tmp[EBUFSIZE];
65 
66 	t = tmp + sizeof(tmp);
67 	*--t = '\0';
68 	uerr = (num >= 0) ? num : -num;
69 	do {
70 		*--t = "0123456789"[uerr % 10];
71 	} while (uerr /= 10);
72 	if (num < 0)
73 		*--t = '-';
74 	*--t = ' ';
75 	*--t = ':';
76 	strlcpy(buf, uprefix, len);
77 	strlcat(buf, t, len);
78 }
79 
80 static int
81 strerror_rl(int errnum, char *strerrbuf, size_t buflen, locale_t locale)
82 {
83 	int retval = 0;
84 #if defined(NLS)
85 	int saved_errno = errno;
86 	nl_catd catd;
87 
88 	catd = __catopen_l("libc", NL_CAT_LOCALE, locale);
89 #endif
90 
91 	if (errnum < 0 || errnum >= __hidden_sys_nerr) {
92 		errstr(errnum,
93 #if defined(NLS)
94 		    catgets(catd, 1, 0xffff, __uprefix),
95 #else
96 		    __uprefix,
97 #endif
98 		   strerrbuf, buflen);
99 		retval = EINVAL;
100 	} else {
101 		if (strlcpy(strerrbuf,
102 #if defined(NLS)
103 		    catgets(catd, 1, errnum, __hidden_sys_errlist[errnum]),
104 #else
105 		    __hidden_sys_errlist[errnum],
106 #endif
107 		    buflen) >= buflen)
108 			retval = ERANGE;
109 	}
110 
111 #if defined(NLS)
112 	catclose(catd);
113 	errno = saved_errno;
114 #endif
115 
116 	return (retval);
117 }
118 
119 int
120 strerror_r(int errnum, char *strerrbuf, size_t buflen)
121 {
122 	return (strerror_rl(errnum, strerrbuf, buflen, __get_locale()));
123 }
124 
125 char *
126 strerror_l(int num, locale_t locale)
127 {
128 	static _Thread_local char ebuf[NL_TEXTMAX];
129 
130 	if (strerror_rl(num, ebuf, sizeof(ebuf), locale) != 0)
131 		errno = EINVAL;
132 	return (ebuf);
133 }
134 
135 char *
136 strerror(int num)
137 {
138 	static char ebuf[NL_TEXTMAX];
139 
140 	if (strerror_rl(num, ebuf, sizeof(ebuf), __get_locale()) != 0)
141 		errno = EINVAL;
142 	return (ebuf);
143 }
144