busybox/coreutils/split.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

180 lines
4.0 KiB
C

/* vi: set sw=4 ts=4: */
/*
* split - split a file into pieces
* Copyright (c) 2007 Bernhard Reutner-Fischer
*
* Licensed under GPLv2 or later, see file LICENSE in this source tree.
*/
//config:config SPLIT
//config: bool "split (5 kb)"
//config: default y
//config: help
//config: Split a file into pieces.
//config:
//config:config FEATURE_SPLIT_FANCY
//config: bool "Fancy extensions"
//config: default y
//config: depends on SPLIT
//config: help
//config: Add support for features not required by SUSv3.
//config: Supports additional suffixes 'b' for 512 bytes,
//config: 'g' for 1GiB for the -b option.
//applet:IF_SPLIT(APPLET(split, BB_DIR_USR_BIN, BB_SUID_DROP))
//kbuild:lib-$(CONFIG_SPLIT) += split.o
/* BB_AUDIT: SUSv3 compliant
* SUSv3 requirements:
* http://www.opengroup.org/onlinepubs/009695399/utilities/split.html
*/
//usage:#define split_trivial_usage
//usage: "[OPTIONS] [INPUT [PREFIX]]"
//usage:#define split_full_usage "\n\n"
//usage: " -b N[k|m] Split by N (kilo|mega)bytes"
//usage: "\n -l N Split by N lines"
//usage: "\n -a N Use N letters as suffix"
//usage:
//usage:#define split_example_usage
//usage: "$ split TODO foo\n"
//usage: "$ cat TODO | split -a 2 -l 2 TODO_\n"
#include "libbb.h"
#include "common_bufsiz.h"
#if ENABLE_FEATURE_SPLIT_FANCY
static const struct suffix_mult split_suffixes[] = {
{ "b", 512 },
{ "k", 1024 },
{ "m", 1024*1024 },
{ "g", 1024*1024*1024 },
{ "", 0 }
};
#endif
/* Increment the suffix part of the filename.
* Returns NULL if we are out of filenames.
*/
static char *next_file(char *old, unsigned suffix_len)
{
size_t end = strlen(old);
unsigned i = 1;
char *curr;
while (1) {
curr = old + end - i;
if (*curr < 'z') {
*curr += 1;
break;
}
i++;
if (i > suffix_len) {
return NULL;
}
*curr = 'a';
}
return old;
}
#define read_buffer bb_common_bufsiz1
enum { READ_BUFFER_SIZE = COMMON_BUFSIZE - 1 };
#define SPLIT_OPT_l (1<<0)
#define SPLIT_OPT_b (1<<1)
#define SPLIT_OPT_a (1<<2)
int split_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
int split_main(int argc UNUSED_PARAM, char **argv)
{
unsigned suffix_len = 2;
char *pfx;
char *count_p;
const char *sfx;
off_t cnt = 1000;
off_t remaining = 0;
unsigned opt;
ssize_t bytes_read, to_write;
char *src;
setup_common_bufsiz();
opt = getopt32(argv, "^"
"l:b:a:+" /* -a N */
"\0" "?2"/*max 2 args*/,
&count_p, &count_p, &suffix_len
);
if (opt & SPLIT_OPT_l)
cnt = XATOOFF(count_p);
if (opt & SPLIT_OPT_b) // FIXME: also needs XATOOFF
cnt = xatoull_sfx(count_p,
IF_FEATURE_SPLIT_FANCY(split_suffixes)
IF_NOT_FEATURE_SPLIT_FANCY(km_suffixes)
);
sfx = "x";
argv += optind;
if (argv[0]) {
int fd;
if (argv[1])
sfx = argv[1];
fd = xopen_stdin(argv[0]);
xmove_fd(fd, STDIN_FILENO);
} else {
argv[0] = (char *) bb_msg_standard_input;
}
if (NAME_MAX < strlen(sfx) + suffix_len)
bb_simple_error_msg_and_die("suffix too long");
{
char *char_p = xzalloc(suffix_len + 1);
memset(char_p, 'a', suffix_len);
pfx = xasprintf("%s%s", sfx, char_p);
if (ENABLE_FEATURE_CLEAN_UP)
free(char_p);
}
while (1) {
bytes_read = safe_read(STDIN_FILENO, read_buffer, READ_BUFFER_SIZE);
if (!bytes_read)
break;
if (bytes_read < 0)
bb_simple_perror_msg_and_die(argv[0]);
src = read_buffer;
do {
if (!remaining) {
if (!pfx)
bb_simple_error_msg_and_die("suffixes exhausted");
xmove_fd(xopen(pfx, O_WRONLY | O_CREAT | O_TRUNC), 1);
pfx = next_file(pfx, suffix_len);
remaining = cnt;
}
if (opt & SPLIT_OPT_b) {
/* split by bytes */
to_write = (bytes_read < remaining) ? bytes_read : remaining;
remaining -= to_write;
} else {
/* split by lines */
/* can be sped up by using _memrchr_
* and writing many lines at once... */
char *end = memchr(src, '\n', bytes_read);
if (end) {
--remaining;
to_write = end - src + 1;
} else {
to_write = bytes_read;
}
}
xwrite(STDOUT_FILENO, src, to_write);
bytes_read -= to_write;
src += to_write;
} while (bytes_read);
}
return EXIT_SUCCESS;
}