libbb: reduce the overhead of single parameter bb_error_msg() calls

Back in 2007, commit 0c97c9d437 ("'simple' error message functions by
Loic Grenie") introduced bb_simple_perror_msg() to allow for a lower
overhead call to bb_perror_msg() when only a string was being printed
with no parameters. This saves space for some CPU architectures because
it avoids the overhead of a call to a variadic function. However there
has never been a simple version of bb_error_msg(), and since 2007 many
new calls to bb_perror_msg() have been added that only take a single
parameter and so could have been using bb_simple_perror_message().

This changeset introduces 'simple' versions of bb_info_msg(),
bb_error_msg(), bb_error_msg_and_die(), bb_herror_msg() and
bb_herror_msg_and_die(), and replaces all calls that only take a
single parameter, or use something like ("%s", arg), with calls to the
corresponding 'simple' version.

Since it is likely that single parameter calls to the variadic functions
may be accidentally reintroduced in the future a new debugging config
option WARN_SIMPLE_MSG has been introduced. This uses some macro magic
which will cause any such calls to generate a warning, but this is
turned off by default to avoid use of the unpleasant macros in normal
circumstances.

This is a large changeset due to the number of calls that have been
replaced. The only files that contain changes other than simple
substitution of function calls are libbb.h, libbb/herror_msg.c,
libbb/verror_msg.c and libbb/xfuncs_printf.c. In miscutils/devfsd.c,
networking/udhcp/common.h and util-linux/mdev.c additonal macros have
been added for logging so that single parameter and multiple parameter
logging variants exist.

The amount of space saved varies considerably by architecture, and was
found to be as follows (for 'defconfig' using GCC 7.4):

Arm:     -92 bytes
MIPS:    -52 bytes
PPC:   -1836 bytes
x86_64: -938 bytes

Note that for the MIPS architecture only an exception had to be made
disabling the 'simple' calls for 'udhcp' (in networking/udhcp/common.h)
because it made these files larger on MIPS.

Signed-off-by: James Byrne <james.byrne@origamienergy.com>
Signed-off-by: Denys Vlasenko <vda.linux@googlemail.com>
This commit is contained in:
James Byrne
2019-07-02 11:35:03 +02:00
committed by Denys Vlasenko
parent caecfdc20d
commit 6937487be7
225 changed files with 845 additions and 736 deletions

View File

@@ -631,7 +631,7 @@ static void check_suid(int applet_no)
/* same group / in group */
m >>= 3;
if (!(m & S_IXOTH)) /* is x bit not set? */
bb_error_msg_and_die("you have no permission to run this applet");
bb_simple_error_msg_and_die("you have no permission to run this applet");
/* We set effective AND saved ids. If saved-id is not set
* like we do below, seteuid(0) can still later succeed! */
@@ -643,7 +643,7 @@ static void check_suid(int applet_no)
rgid = sct->m_ugid.gid;
/* else: we will set egid = rgid, thus dropping sgid effect */
if (setresgid(-1, rgid, rgid))
bb_perror_msg_and_die("setresgid");
bb_simple_perror_msg_and_die("setresgid");
/* Are we directed to change uid
* (APPLET = s** USER.GROUP or APPLET = S** USER.GROUP)?
@@ -653,7 +653,7 @@ static void check_suid(int applet_no)
uid = sct->m_ugid.uid;
/* else: we will set euid = ruid, thus dropping suid effect */
if (setresuid(-1, uid, uid))
bb_perror_msg_and_die("setresuid");
bb_simple_perror_msg_and_die("setresuid");
goto ret;
}
@@ -663,7 +663,7 @@ static void check_suid(int applet_no)
if (!onetime) {
onetime = 1;
bb_error_msg("using fallback suid method");
bb_simple_error_msg("using fallback suid method");
}
}
# endif
@@ -673,7 +673,7 @@ static void check_suid(int applet_no)
/* Real uid is not 0. If euid isn't 0 too, suid bit
* is most probably not set on our executable */
if (geteuid())
bb_error_msg_and_die("must be suid to work properly");
bb_simple_error_msg_and_die("must be suid to work properly");
} else if (APPLET_SUID(applet_no) == BB_SUID_DROP) {
/*
* Drop all privileges.

View File

@@ -38,7 +38,7 @@ gid_t* FAST_FUNC bb_getgroups(int *ngroups, gid_t *group_array)
continue;
}
/* Some other error (should never happen on Linux) */
bb_perror_msg_and_die("getgroups");
bb_simple_perror_msg_and_die("getgroups");
}
if (ngroups)

View File

@@ -60,6 +60,6 @@ int unit_main(int argc UNUSED_PARAM, char **argv UNUSED_PARAM)
return EXIT_FAILURE;
}
bb_error_msg("All tests passed");
bb_simple_error_msg("All tests passed");
return EXIT_SUCCESS;
}

View File

@@ -119,7 +119,7 @@ void FAST_FUNC getcaps(void *arg)
caps->u32s = _LINUX_CAPABILITY_U32S_3;
break;
default:
bb_error_msg_and_die("unsupported capability version");
bb_simple_error_msg_and_die("unsupported capability version");
}
if (capget(&caps->header, caps->data) != 0)

View File

@@ -51,7 +51,7 @@ void FAST_FUNC change_identity(const struct passwd *pw)
return;
}
bb_perror_msg_and_die("can't set groups");
bb_simple_perror_msg_and_die("can't set groups");
}
xsetgid(pw->pw_gid);

View File

@@ -327,7 +327,7 @@ int FAST_FUNC copy_file(const char *source, const char *dest, int flags)
) {
security_context_t con;
if (getfscreatecon(&con) == -1) {
bb_perror_msg("getfscreatecon");
bb_simple_perror_msg("getfscreatecon");
return -1;
}
if (con) {

View File

@@ -87,7 +87,7 @@ static off_t bb_full_fd_action(int src_fd, int dst_fd, off_t size)
rd = safe_read(src_fd, buffer,
size > buffer_size ? buffer_size : size);
if (rd < 0) {
bb_perror_msg(bb_msg_read_error);
bb_simple_perror_msg(bb_msg_read_error);
break;
}
read_ok:
@@ -100,7 +100,7 @@ static off_t bb_full_fd_action(int src_fd, int dst_fd, off_t size)
ssize_t wr = full_write(dst_fd, buffer, rd);
if (wr < rd) {
if (!continue_on_write_error) {
bb_perror_msg(bb_msg_write_error);
bb_simple_perror_msg(bb_msg_write_error);
break;
}
dst_fd = -1;
@@ -151,7 +151,7 @@ void FAST_FUNC bb_copyfd_exact_size(int fd1, int fd2, off_t size)
if (sz == (size >= 0 ? size : -size))
return;
if (sz != -1)
bb_error_msg_and_die("short read");
bb_simple_error_msg_and_die("short read");
/* if sz == -1, bb_copyfd_XX already complained */
xfunc_die();
}

View File

@@ -57,5 +57,5 @@ void FAST_FUNC die_if_bad_username(const char *name)
* including the terminating null byte.
*/
if (name - start >= LOGIN_NAME_MAX)
bb_error_msg_and_die("name is too long");
bb_simple_error_msg_and_die("name is too long");
}

View File

@@ -199,7 +199,7 @@ static NOINLINE void rewrite(priv_dumper_t *dumper, FS *fs)
pr->bcnt = fu->bcnt;
if (fu->bcnt == 0) {
if (!prec)
bb_error_msg_and_die("%%s needs precision or byte count");
bb_simple_error_msg_and_die("%%s needs precision or byte count");
pr->bcnt = atoi(prec);
}
} else
@@ -266,7 +266,7 @@ static NOINLINE void rewrite(priv_dumper_t *dumper, FS *fs)
/* only one conversion character if byte count */
if (!(pr->flags & F_ADDRESS) && fu->bcnt && nconv++) {
bb_error_msg_and_die("byte count with multiple conversion characters");
bb_simple_error_msg_and_die("byte count with multiple conversion characters");
}
}
/*

View File

@@ -15,7 +15,7 @@ void FAST_FUNC fflush_stdout_and_exit(int retval)
{
xfunc_error_retval = retval;
if (fflush(stdout))
bb_perror_msg_and_die(bb_msg_standard_output);
bb_simple_perror_msg_and_die(bb_msg_standard_output);
/* In case we are in NOFORK applet. Do not exit() directly,
* but use xfunc_die() */
xfunc_die();

View File

@@ -62,7 +62,7 @@ int FAST_FUNC get_console_fd_or_die(void)
}
}
bb_error_msg_and_die("can't open console");
bb_simple_error_msg_and_die("can't open console");
}
/* From <linux/vt.h> */

View File

@@ -18,7 +18,7 @@ uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
if (override) {
result = XATOOFF(override);
if (result >= (uoff_t)(MAXINT(off_t)) / override_units)
bb_error_msg_and_die("image size is too big");
bb_simple_error_msg_and_die("image size is too big");
result *= override_units;
/* seek past end fails on block devices but works on files */
if (lseek(fd, result - 1, SEEK_SET) != (off_t)-1) {
@@ -42,7 +42,7 @@ uoff_t FAST_FUNC get_volume_size_in_bytes(int fd,
*
* Picked 16k arbitrarily: */
if (result < 16*1024)
bb_error_msg_and_die("image is too small");
bb_simple_error_msg_and_die("image is too small");
return result;
}

View File

@@ -23,14 +23,14 @@ int FAST_FUNC xgetpty(char *line)
const char *name;
name = ptsname(p); /* find out the name of slave pty */
if (!name) {
bb_perror_msg_and_die("ptsname error (is /dev/pts mounted?)");
bb_simple_perror_msg_and_die("ptsname error (is /dev/pts mounted?)");
}
safe_strncpy(line, name, GETPTY_BUFSIZE);
}
# else
/* find out the name of slave pty */
if (ptsname_r(p, line, GETPTY_BUFSIZE-1) != 0) {
bb_perror_msg_and_die("ptsname error (is /dev/pts mounted?)");
bb_simple_perror_msg_and_die("ptsname error (is /dev/pts mounted?)");
}
line[GETPTY_BUFSIZE-1] = '\0';
# endif
@@ -61,5 +61,5 @@ int FAST_FUNC xgetpty(char *line)
}
}
#endif /* FEATURE_DEVPTS */
bb_error_msg_and_die("can't find free pty");
bb_simple_error_msg_and_die("can't find free pty");
}

View File

@@ -26,3 +26,13 @@ void FAST_FUNC bb_herror_msg_and_die(const char *s, ...)
va_end(p);
xfunc_die();
}
void FAST_FUNC bb_simple_herror_msg(const char *s)
{
bb_herror_msg("%s", s);
}
void FAST_FUNC bb_simple_herror_msg_and_die(const char *s)
{
bb_herror_msg_and_die("%s", s);
}

View File

@@ -21,7 +21,7 @@ void FAST_FUNC erase_mtab(const char *name)
/* Bummer. Fall back on trying the /proc filesystem */
if (!mountTable) mountTable = setmntent("/proc/mounts", "r");
if (!mountTable) {
bb_perror_msg(bb_path_mtab_file);
bb_simple_perror_msg(bb_path_mtab_file);
return;
}
@@ -49,6 +49,6 @@ void FAST_FUNC erase_mtab(const char *name)
}
endmntent(mountTable);
} else if (errno != EROFS)
bb_perror_msg(bb_path_mtab_file);
bb_simple_perror_msg(bb_path_mtab_file);
}
#endif

View File

@@ -12,11 +12,11 @@
* instead of including libbb.h */
//#include "libbb.h"
#include "platform.h"
extern void bb_perror_msg(const char *s, ...) FAST_FUNC;
extern void bb_simple_perror_msg(const char *s) FAST_FUNC;
/* suppress gcc "no previous prototype" warning */
void FAST_FUNC bb_perror_nomsg(void);
void FAST_FUNC bb_perror_nomsg(void)
{
bb_perror_msg(0);
bb_simple_perror_msg(0);
}

View File

@@ -12,11 +12,11 @@
* instead of including libbb.h */
//#include "libbb.h"
#include "platform.h"
extern void bb_perror_msg_and_die(const char *s, ...) FAST_FUNC;
extern void bb_simple_perror_msg_and_die(const char *s) FAST_FUNC;
/* suppress gcc "no previous prototype" warning */
void FAST_FUNC bb_perror_nomsg_and_die(void);
void FAST_FUNC bb_perror_nomsg_and_die(void)
{
bb_perror_msg_and_die(0);
bb_simple_perror_msg_and_die(0);
}

View File

@@ -217,7 +217,7 @@ void FAST_FUNC xread(int fd, void *buf, size_t count)
if (count) {
ssize_t size = full_read(fd, buf, count);
if ((size_t)size != count)
bb_error_msg_and_die("short read");
bb_simple_error_msg_and_die("short read");
}
}

View File

@@ -27,7 +27,7 @@ int FAST_FUNC safe_poll(struct pollfd *ufds, nfds_t nfds, int timeout)
/* I doubt many callers would handle this correctly! */
if (errno == ENOMEM)
continue;
bb_perror_msg("poll");
bb_simple_perror_msg("poll");
return n;
}
}

View File

@@ -48,7 +48,7 @@ void FAST_FUNC selinux_preserve_fcontext(int fdesc)
if (fgetfilecon(fdesc, &context) < 0) {
if (errno == ENODATA || errno == ENOTSUP)
return;
bb_perror_msg_and_die("fgetfilecon failed");
bb_simple_perror_msg_and_die("fgetfilecon failed");
}
setfscreatecon_or_die(context);
freecon(context);

View File

@@ -258,7 +258,7 @@ char* FAST_FUNC strftime_YYYYMMDDHHMMSS(char *buf, unsigned len, time_t *tp)
static void get_mono(struct timespec *ts)
{
if (syscall(__NR_clock_gettime, CLOCK_MONOTONIC, ts))
bb_error_msg_and_die("clock_gettime(MONOTONIC) failed");
bb_simple_error_msg_and_die("clock_gettime(MONOTONIC) failed");
}
unsigned long long FAST_FUNC monotonic_ns(void)
{

View File

@@ -25,7 +25,7 @@ static void check_selinux_update_passwd(const char *username)
return; /* No need to check */
if (getprevcon_raw(&context) < 0)
bb_perror_msg_and_die("getprevcon failed");
bb_simple_perror_msg_and_die("getprevcon failed");
seuser = strtok(context, ":");
if (!seuser)
bb_error_msg_and_die("invalid context '%s'", context);
@@ -42,7 +42,7 @@ static void check_selinux_update_passwd(const char *username)
if (selinux_check_passwd_access(av) != 0)
die:
bb_error_msg_and_die("SELinux: access denied");
bb_simple_error_msg_and_die("SELinux: access denied");
}
if (ENABLE_FEATURE_CLEAN_UP)
freecon(context);

View File

@@ -213,7 +213,7 @@ void FAST_FUNC read_base64(FILE *src_stream, FILE *dst_stream, int flags)
if (*in_tail == '\0')
return;
/* No */
bb_error_msg_and_die("truncated base64 input");
bb_simple_error_msg_and_die("truncated base64 input");
}
/* It was partial decode */

View File

@@ -197,4 +197,19 @@ void FAST_FUNC bb_info_msg(const char *s, ...)
bb_vinfo_msg(s, p);
va_end(p);
}
void FAST_FUNC bb_simple_info_msg(const char *s)
{
bb_info_msg("%s", s);
}
#endif
void FAST_FUNC bb_simple_error_msg(const char *s)
{
bb_error_msg("%s", s);
}
void FAST_FUNC bb_simple_error_msg_and_die(const char *s)
{
bb_error_msg_and_die("%s", s);
}

View File

@@ -12,7 +12,7 @@
void FAST_FUNC bb_warn_ignoring_args(char *arg)
{
if (arg) {
bb_error_msg("ignoring all arguments");
bb_simple_error_msg("ignoring all arguments");
}
}
#endif

View File

@@ -66,7 +66,7 @@ int FAST_FUNC setsockopt_bindtodevice(int fd, const char *iface)
int FAST_FUNC setsockopt_bindtodevice(int fd UNUSED_PARAM,
const char *iface UNUSED_PARAM)
{
bb_error_msg("SO_BINDTODEVICE is not supported on this system");
bb_simple_error_msg("SO_BINDTODEVICE is not supported on this system");
return -1;
}
#endif
@@ -109,7 +109,7 @@ void FAST_FUNC xconnect(int s, const struct sockaddr *s_addr, socklen_t addrlen)
bb_perror_msg_and_die("%s (%s)",
"can't connect to remote host",
inet_ntoa(((struct sockaddr_in *)s_addr)->sin_addr));
bb_perror_msg_and_die("can't connect to remote host");
bb_simple_perror_msg_and_die("can't connect to remote host");
}
}

View File

@@ -426,6 +426,6 @@ int FAST_FUNC wait_for_exitstatus(pid_t pid)
n = safe_waitpid(pid, &exit_status, 0);
if (n < 0)
bb_perror_msg_and_die("waitpid");
bb_simple_perror_msg_and_die("waitpid");
return exit_status;
}

View File

@@ -27,7 +27,7 @@
void FAST_FUNC bb_die_memory_exhausted(void)
{
bb_error_msg_and_die(bb_msg_memory_exhausted);
bb_simple_error_msg_and_die(bb_msg_memory_exhausted);
}
#ifndef DMALLOC
@@ -40,7 +40,7 @@ void* FAST_FUNC malloc_or_warn(size_t size)
{
void *ptr = malloc(size);
if (ptr == NULL && size != 0)
bb_error_msg(bb_msg_memory_exhausted);
bb_simple_error_msg(bb_msg_memory_exhausted);
return ptr;
}
@@ -97,7 +97,7 @@ char* FAST_FUNC xstrndup(const char *s, int n)
char *t;
if (ENABLE_DEBUG && s == NULL)
bb_error_msg_and_die("xstrndup bug");
bb_simple_error_msg_and_die("xstrndup bug");
/* We can just xmalloc(n+1) and strncpy into it, */
/* but think about xstrndup("abc", 10000) wastage! */
@@ -215,13 +215,13 @@ int FAST_FUNC rename_or_warn(const char *oldpath, const char *newpath)
void FAST_FUNC xpipe(int filedes[2])
{
if (pipe(filedes))
bb_perror_msg_and_die("can't create pipe");
bb_simple_perror_msg_and_die("can't create pipe");
}
void FAST_FUNC xdup2(int from, int to)
{
if (dup2(from, to) != to)
bb_perror_msg_and_die("can't duplicate file descriptor");
bb_simple_perror_msg_and_die("can't duplicate file descriptor");
// " %d to %d", from, to);
}
@@ -245,7 +245,7 @@ void FAST_FUNC xwrite(int fd, const void *buf, size_t count)
* or some writes succeeded, then we hit an error.
* In either case, errno is set.
*/
bb_perror_msg_and_die(
bb_simple_perror_msg_and_die(
size >= 0 ? "short write" : "write error"
);
}
@@ -259,7 +259,7 @@ void FAST_FUNC xwrite_str(int fd, const char *str)
void FAST_FUNC xclose(int fd)
{
if (close(fd))
bb_perror_msg_and_die("close failed");
bb_simple_perror_msg_and_die("close failed");
}
// Die with an error message if we can't lseek to the right spot.
@@ -267,9 +267,7 @@ off_t FAST_FUNC xlseek(int fd, off_t offset, int whence)
{
off_t off = lseek(fd, offset, whence);
if (off == (off_t)-1) {
if (whence == SEEK_SET)
bb_perror_msg_and_die("lseek(%"OFF_FMT"u)", offset);
bb_perror_msg_and_die("lseek");
bb_perror_msg_and_die("lseek(%"OFF_FMT"u, %d)", offset, whence);
}
return off;
}
@@ -384,23 +382,23 @@ void FAST_FUNC bb_unsetenv_and_free(char *var)
// setgid() will fail and we'll _still_be_root_, which is bad.)
void FAST_FUNC xsetgid(gid_t gid)
{
if (setgid(gid)) bb_perror_msg_and_die("setgid");
if (setgid(gid)) bb_simple_perror_msg_and_die("setgid");
}
// Die with an error message if we can't set uid. (See xsetgid() for why.)
void FAST_FUNC xsetuid(uid_t uid)
{
if (setuid(uid)) bb_perror_msg_and_die("setuid");
if (setuid(uid)) bb_simple_perror_msg_and_die("setuid");
}
void FAST_FUNC xsetegid(gid_t egid)
{
if (setegid(egid)) bb_perror_msg_and_die("setegid");
if (setegid(egid)) bb_simple_perror_msg_and_die("setegid");
}
void FAST_FUNC xseteuid(uid_t euid)
{
if (seteuid(euid)) bb_perror_msg_and_die("seteuid");
if (seteuid(euid)) bb_simple_perror_msg_and_die("seteuid");
}
// Die if we can't chdir to a new path.
@@ -413,7 +411,7 @@ void FAST_FUNC xchdir(const char *path)
void FAST_FUNC xfchdir(int fd)
{
if (fchdir(fd))
bb_perror_msg_and_die("fchdir");
bb_simple_perror_msg_and_die("fchdir");
}
void FAST_FUNC xchroot(const char *path)
@@ -463,7 +461,7 @@ int FAST_FUNC xsocket(int domain, int type, int protocol)
IF_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
bb_perror_msg_and_die("socket(AF_%s,%d,%d)", s, type, protocol);
#else
bb_perror_msg_and_die("socket");
bb_simple_perror_msg_and_die("socket");
#endif
}
@@ -473,13 +471,13 @@ IF_FEATURE_IPV6(if (domain == AF_INET6) s = "INET6";)
// Die with an error message if we can't bind a socket to an address.
void FAST_FUNC xbind(int sockfd, struct sockaddr *my_addr, socklen_t addrlen)
{
if (bind(sockfd, my_addr, addrlen)) bb_perror_msg_and_die("bind");
if (bind(sockfd, my_addr, addrlen)) bb_simple_perror_msg_and_die("bind");
}
// Die with an error message if we can't listen for connections on a socket.
void FAST_FUNC xlisten(int s, int backlog)
{
if (listen(s, backlog)) bb_perror_msg_and_die("listen");
if (listen(s, backlog)) bb_simple_perror_msg_and_die("listen");
}
/* Die with an error message if sendto failed.
@@ -491,7 +489,7 @@ ssize_t FAST_FUNC xsendto(int s, const void *buf, size_t len, const struct socka
if (ret < 0) {
if (ENABLE_FEATURE_CLEAN_UP)
close(s);
bb_perror_msg_and_die("sendto");
bb_simple_perror_msg_and_die("sendto");
}
return ret;
}
@@ -519,12 +517,12 @@ void FAST_FUNC selinux_or_die(void)
#if ENABLE_SELINUX
int rc = is_selinux_enabled();
if (rc == 0) {
bb_error_msg_and_die("SELinux is disabled");
bb_simple_error_msg_and_die("SELinux is disabled");
} else if (rc < 0) {
bb_error_msg_and_die("is_selinux_enabled() failed");
bb_simple_error_msg_and_die("is_selinux_enabled() failed");
}
#else
bb_error_msg_and_die("SELinux support is disabled");
bb_simple_error_msg_and_die("SELinux support is disabled");
#endif
}
@@ -675,7 +673,7 @@ pid_t FAST_FUNC xfork(void)
pid_t pid;
pid = fork();
if (pid < 0) /* wtf? */
bb_perror_msg_and_die("vfork"+1);
bb_simple_perror_msg_and_die("vfork"+1);
return pid;
}
#endif

View File

@@ -33,7 +33,7 @@ xrealloc_getcwd_or_warn(char *cwd)
if (errno == ERANGE)
continue;
free(cwd);
bb_perror_msg("getcwd");
bb_simple_perror_msg("getcwd");
return NULL;
}
cwd = xrealloc(cwd, strlen(cwd) + 1);

View File

@@ -12,6 +12,6 @@ struct hostent* FAST_FUNC xgethostbyname(const char *name)
{
struct hostent *retval = gethostbyname(name);
if (!retval)
bb_herror_msg_and_die("%s", name);
bb_simple_herror_msg_and_die(name);
return retval;
}