busybox/mailutils/mail.c
James Byrne 6937487be7 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>
2019-07-02 11:35:03 +02:00

184 lines
4.0 KiB
C

/* vi: set sw=4 ts=4: */
/*
* helper routines
*
* Copyright (C) 2008 by Vladimir Dronnikov <dronnikov@gmail.com>
*
* Licensed under GPLv2, see file LICENSE in this source tree.
*/
#include <sys/prctl.h>
#include "libbb.h"
#include "mail.h"
// generic signal handler
static void signal_handler(int signo)
{
#define err signo
if (SIGALRM == signo) {
bb_simple_error_msg_and_die("timed out");
}
// SIGCHLD. reap zombies
if (safe_waitpid(G.helper_pid, &err, WNOHANG) > 0) {
if (WIFSIGNALED(err))
bb_error_msg_and_die("helper killed by signal %u", WTERMSIG(err));
if (WIFEXITED(err)) {
G.helper_pid = 0;
if (WEXITSTATUS(err))
bb_error_msg_and_die("helper exited (%u)", WEXITSTATUS(err));
}
}
#undef err
}
void FAST_FUNC launch_helper(const char **argv)
{
// setup vanilla unidirectional pipes interchange
int i;
int pipes[4];
xpipe(pipes);
xpipe(pipes + 2);
// NB: handler must be installed before vfork
bb_signals(0
+ (1 << SIGCHLD)
+ (1 << SIGALRM)
, signal_handler);
G.helper_pid = xvfork();
i = (!G.helper_pid) * 2; // for parent:0, for child:2
close(pipes[i + 1]); // 1 or 3 - closing one write end
close(pipes[2 - i]); // 2 or 0 - closing one read end
xmove_fd(pipes[i], STDIN_FILENO); // 0 or 2 - using other read end
xmove_fd(pipes[3 - i], STDOUT_FILENO); // 3 or 1 - using other write end
// End result:
// parent stdout [3] -> child stdin [2]
// child stdout [1] -> parent stdin [0]
if (!G.helper_pid) {
// child
// if parent dies, get SIGTERM
prctl(PR_SET_PDEATHSIG, SIGTERM, 0, 0, 0);
// try to execute connection helper
// NB: SIGCHLD & SIGALRM revert to SIG_DFL on exec
BB_EXECVP_or_die((char**)argv);
}
// parent goes on
}
char* FAST_FUNC send_mail_command(const char *fmt, const char *param)
{
char *msg;
if (timeout)
alarm(timeout);
msg = (char*)fmt;
if (fmt) {
msg = xasprintf(fmt, param);
if (verbose)
bb_error_msg("send:'%s'", msg);
printf("%s\r\n", msg);
}
fflush_all();
return msg;
}
// NB: parse_url can modify url[] (despite const), but only if '@' is there
/*
static char* FAST_FUNC parse_url(char *url, char **user, char **pass)
{
// parse [user[:pass]@]host
// return host
char *s = strchr(url, '@');
*user = *pass = NULL;
if (s) {
*s++ = '\0';
*user = url;
url = s;
s = strchr(*user, ':');
if (s) {
*s++ = '\0';
*pass = s;
}
}
return url;
}
*/
static void encode_n_base64(const char *fname, const char *text, size_t len)
{
enum {
SRC_BUF_SIZE = 57, /* This *MUST* be a multiple of 3 */
DST_BUF_SIZE = 4 * ((SRC_BUF_SIZE + 2) / 3),
};
#define src_buf text
char src[SRC_BUF_SIZE];
FILE *fp = fp;
char dst_buf[DST_BUF_SIZE + 1];
if (fname) {
fp = (NOT_LONE_DASH(fname)) ? xfopen_for_read(fname) : stdin;
src_buf = src;
}
while (1) {
size_t size;
if (fname) {
size = fread((char *)src_buf, 1, SRC_BUF_SIZE, fp);
if ((ssize_t)size < 0)
bb_simple_perror_msg_and_die(bb_msg_read_error);
} else {
size = len;
if (len > SRC_BUF_SIZE)
size = SRC_BUF_SIZE;
}
if (!size)
break;
// encode the buffer we just read in
bb_uuencode(dst_buf, src_buf, size, bb_uuenc_tbl_base64);
if (fname) {
puts("");
} else {
src_buf += size;
len -= size;
}
fwrite(dst_buf, 1, 4 * ((size + 2) / 3), stdout);
}
if (fname && NOT_LONE_DASH(fname))
fclose(fp);
#undef src_buf
}
void FAST_FUNC printstr_base64(const char *text)
{
encode_n_base64(NULL, text, strlen(text));
}
void FAST_FUNC printbuf_base64(const char *text, unsigned len)
{
encode_n_base64(NULL, text, len);
}
void FAST_FUNC printfile_base64(const char *fname)
{
encode_n_base64(fname, NULL, 0);
}
/*
* get username and password from a file descriptor
*/
void FAST_FUNC get_cred_or_die(int fd)
{
if (isatty(fd)) {
G.user = bb_ask_noecho(fd, /* timeout: */ 0, "User: ");
G.pass = bb_ask_noecho(fd, /* timeout: */ 0, "Password: ");
} else {
G.user = xmalloc_reads(fd, /* maxsize: */ NULL);
G.pass = xmalloc_reads(fd, /* maxsize: */ NULL);
}
if (!G.user || !*G.user || !G.pass)
bb_simple_error_msg_and_die("no username or password");
}