sudo/lib/util/strsignal.c

/*
 * SPDX-License-Identifier: ISC
 *
 * Copyright (c) 2009-2014 Todd C. Miller <Todd.Miller@sudo.ws>
 *
 * 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 THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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.
 */

/*
 * This is an open source non-commercial project. Dear PVS-Studio, please check it.
 * PVS-Studio Static Code Analyzer for C, C++ and C#: http://www.viva64.com
 */

#include <config.h>

#ifndef HAVE_STRSIGNAL

#include <signal.h>

#include <sudo_compat.h>
#include <sudo_gettext.h>

#if defined(HAVE_DECL_SYS_SIGLIST) && HAVE_DECL_SYS_SIGLIST == 1
# define sudo_sys_siglist	sys_siglist
#elif defined(HAVE_DECL__SYS_SIGLIST) && HAVE_DECL__SYS_SIGLIST == 1
# define sudo_sys_siglist	_sys_siglist
#else
extern const char *const sudo_sys_siglist[NSIG];
#endif

/*
 * Get signal description string
 */
char *
sudo_strsignal(int signo)
{
    if (signo > 0 && signo < NSIG && sudo_sys_siglist[signo] != NULL)
	return (char *)sudo_sys_siglist[signo];
    /* XXX - should be "Unknown signal: %d" */
    return (char *)_("Unknown signal");
}
#endif /* HAVE_STRSIGNAL */
Add check for strsignal() and a simple implementation if it is not there but sys_siglist is 2009-10-14 20:04:04 +00:00			`/*`
Add SPDX-License-Identifier to files. 2019-04-29 07:21:51 -06:00			`* SPDX-License-Identifier: ISC`
			`*`
update my email to Todd.Miller@sudo.ws 2017-12-03 17:53:40 -07:00			`* Copyright (c) 2009-2014 Todd C. Miller <Todd.Miller@sudo.ws>`
Add check for strsignal() and a simple implementation if it is not there but sys_siglist is 2009-10-14 20:04:04 +00:00			`*`
			`* 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 THE AUTHOR DISCLAIMS ALL WARRANTIES`
			`* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF`
			`* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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.`
			`*/`

Convert PVS-Studio comment to ANSI C. 2018-10-26 08:39:09 -06:00			`/*`
			`* This is an open source non-commercial project. Dear PVS-Studio, please check it.`
			`* PVS-Studio Static Code Analyzer for C, C++ and C#: http://www.viva64.com`
			`*/`
Add comments in .c files so PVS-Studio will check them. 2018-10-21 08:46:05 -06:00
Add #include of sys/types.h for .c files that include missing.h to be sure that size_t and ssize_t are defined. 2010-08-30 09:14:41 -04:00			`#include <config.h>`

Add guards in compat source files. Not really needed since we only include them in the Makefile if they are needed but should not hurt either. 2013-04-01 10:19:26 -04:00			`#ifndef HAVE_STRSIGNAL`

Add check for strsignal() and a simple implementation if it is not there but sys_siglist is 2009-10-14 20:04:04 +00:00			`#include <signal.h>`

Use #include <foo.h> instead of #include "foo.h" in most cases. We rely on the include path to find many of these headers. It especially doesn't make sense to use #include "foo.h" for headers in the top-level include directory. 2023-09-25 10:13:28 -06:00			`#include <sudo_compat.h>`
			`#include <sudo_gettext.h>`
Add gettext.h convenience header. This is similar to but distinct from the one included with the gettext package. 2011-05-20 11:48:17 -04:00
Create our own sys_siglist for systems without it for use by strsignal() 2010-04-02 07:47:19 -04:00			`#if defined(HAVE_DECL_SYS_SIGLIST) && HAVE_DECL_SYS_SIGLIST == 1`
Use strsigname() to print signal names in the debug output. If the system has no strsigname(), use our own. 2012-08-26 20:12:51 -04:00			`# define sudo_sys_siglist sys_siglist`
Create our own sys_siglist for systems without it for use by strsignal() 2010-04-02 07:47:19 -04:00			`#elif defined(HAVE_DECL__SYS_SIGLIST) && HAVE_DECL__SYS_SIGLIST == 1`
Use strsigname() to print signal names in the debug output. If the system has no strsigname(), use our own. 2012-08-26 20:12:51 -04:00			`# define sudo_sys_siglist _sys_siglist`
Create our own sys_siglist for systems without it for use by strsignal() 2010-04-02 07:47:19 -04:00			`#else`
Use strsigname() to print signal names in the debug output. If the system has no strsigname(), use our own. 2012-08-26 20:12:51 -04:00			`extern const char *const sudo_sys_siglist[NSIG];`
Create our own sys_siglist for systems without it for use by strsignal() 2010-04-02 07:47:19 -04:00			`#endif`

Add check for strsignal() and a simple implementation if it is not there but sys_siglist is 2009-10-14 20:04:04 +00:00			`/*`
			`* Get signal description string`
			`*/`
			`char *`
Prefix all libc replacements with sudo_ and #define the real name to the sudo_ version. That way we don't pollute the libc namespace. 2014-06-26 15:51:08 -06:00			`sudo_strsignal(int signo)`
Add check for strsignal() and a simple implementation if it is not there but sys_siglist is 2009-10-14 20:04:04 +00:00			`{`
Handle NULL entries in sys_siglist and sys_signame. 2012-08-28 09:40:56 -04:00			`if (signo > 0 && signo < NSIG && sudo_sys_siglist[signo] != NULL)`
Use strsigname() to print signal names in the debug output. If the system has no strsigname(), use our own. 2012-08-26 20:12:51 -04:00			`return (char *)sudo_sys_siglist[signo];`
Convert my_sys_sig{list,name} -> sudo_sys_sig{list,name} 2012-08-28 09:28:25 -04:00			`/* XXX - should be "Unknown signal: %d" */`
Quiet another -Wwrite-strings warning. 2022-06-29 16:41:11 -06:00			`return (char *)_("Unknown signal");`
Add check for strsignal() and a simple implementation if it is not there but sys_siglist is 2009-10-14 20:04:04 +00:00			`}`
Add guards in compat source files. Not really needed since we only include them in the Makefile if they are needed but should not hurt either. 2013-04-01 10:19:26 -04:00			`#endif /* HAVE_STRSIGNAL */`