[apple/libc.git] / string / FreeBSD / strerror.c

/*-
 * Copyright (c) 1988, 1993
 *	The Regents of the University of California.  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.
 * 4. Neither the name of the University 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 REGENTS 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 REGENTS 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.
 */

#if defined(LIBC_SCCS) && !defined(lint)
static char sccsid[] = "@(#)strerror.c	8.1 (Berkeley) 6/4/93";
#endif /* LIBC_SCCS and not lint */
#include <sys/cdefs.h>
__FBSDID("$FreeBSD: src/lib/libc/string/strerror.c,v 1.16 2007/01/09 00:28:12 imp Exp $");

#if defined(NLS)
#include <nl_types.h>
#endif

#include <limits.h>
#include <errno.h>
#include <string.h>
#include <stdio.h>
#include <stdlib.h>

#define	UPREFIX		"Unknown error"

/*
 * Define a buffer size big enough to describe a 64-bit signed integer
 * converted to ASCII decimal (19 bytes), with an optional leading sign
 * (1 byte); finally, we get the prefix, delimiter (": ") and a trailing
 * NUL from UPREFIX.
 */
#define	EBUFSIZE	(20 + 2 + sizeof(UPREFIX))

#ifndef BUILDING_VARIANT
/*
 * Doing this by hand instead of linking with stdio(3) avoids bloat for
 * statically linked binaries.
 */
__private_extern__ void
__errstr(int num, char *uprefix, char *buf, size_t len)
{
	char *t;
	unsigned int uerr;
	char tmp[EBUFSIZE];

	t = tmp + sizeof(tmp);
	*--t = '\0';
	uerr = (num >= 0) ? num : -num;
	do {
		*--t = "0123456789"[uerr % 10];
	} while (uerr /= 10);
	if (num < 0)
		*--t = '-';
	*--t = ' ';
	*--t = ':';
	strlcpy(buf, uprefix, len);
	strlcat(buf, t, len);
}

int
strerror_r(int errnum, char *strerrbuf, size_t buflen)
{
	int retval = 0;
#if defined(NLS)
	int saved_errno = errno;
	nl_catd catd;
	catd = catopen("libc", NL_CAT_LOCALE);
#endif

	if (errnum < 0 || errnum >= sys_nerr) {
		__errstr(errnum,
#if defined(NLS)
			catgets(catd, 1, 0xffff, UPREFIX),
#else
			UPREFIX,
#endif
			strerrbuf, buflen);
		retval = EINVAL;
	} else {
		if (strlcpy(strerrbuf,
#if defined(NLS)
			catgets(catd, 1, errnum, sys_errlist[errnum]),
#else
			sys_errlist[errnum],
#endif
			buflen) >= buflen)
		retval = ERANGE;
	}

#if defined(NLS)
	catclose(catd);
	errno = saved_errno;
#endif

	return (retval);
}

__private_extern__ char *__strerror_ebuf = NULL;
#else /* BUILDING_VARIANT */
__private_extern__ void __errstr(int, char *, size_t);

extern char *__strerror_ebuf;
#endif /* !BUILDING_VARIANT */

char *
strerror(int num)
{
	// Dynamically allocate a big buffer to receive the text then shrink it
	// down to the actual size needed.
	size_t ebufsiz = NL_TEXTMAX;

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