busybox/util-linux/eject.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

154 lines
4.0 KiB
C

/* vi: set sw=4 ts=4: */
/*
* eject implementation for busybox
*
* Copyright (C) 2004 Peter Willis <psyphreak@phreaker.net>
* Copyright (C) 2005 Tito Ragusa <farmatito@tiscali.it>
*
* Licensed under GPLv2 or later, see file LICENSE in this source tree.
*/
/*
* This is a simple hack of eject based on something Erik posted in #uclibc.
* Most of the dirty work blatantly ripped off from cat.c =)
*/
//config:config EJECT
//config: bool "eject (4 kb)"
//config: default y
//config: select PLATFORM_LINUX
//config: help
//config: Used to eject cdroms. (defaults to /dev/cdrom)
//config:
//config:config FEATURE_EJECT_SCSI
//config: bool "SCSI support"
//config: default y
//config: depends on EJECT
//config: help
//config: Add the -s option to eject, this allows to eject SCSI-Devices and
//config: usb-storage devices.
//applet:IF_EJECT(APPLET(eject, BB_DIR_USR_BIN, BB_SUID_DROP))
//kbuild:lib-$(CONFIG_EJECT) += eject.o
//usage:#define eject_trivial_usage
//usage: "[-t] [-T] [DEVICE]"
//usage:#define eject_full_usage "\n\n"
//usage: "Eject DEVICE or default /dev/cdrom\n"
//usage: IF_FEATURE_EJECT_SCSI(
//usage: "\n -s SCSI device"
//usage: )
//usage: "\n -t Close tray"
//usage: "\n -T Open/close tray (toggle)"
#include <sys/mount.h>
#include "libbb.h"
#if ENABLE_FEATURE_EJECT_SCSI
/* Must be after libbb.h: they need size_t */
# include "fix_u32.h"
# include <scsi/sg.h>
# include <scsi/scsi.h>
#endif
#define dev_fd 3
/* Code taken from the original eject (http://eject.sourceforge.net/),
* refactored it a bit for busybox (ne-bb@nicoerfurth.de) */
#if ENABLE_FEATURE_EJECT_SCSI
static void eject_scsi(const char *dev)
{
static const char sg_commands[3][6] ALIGN1 = {
{ ALLOW_MEDIUM_REMOVAL, 0, 0, 0, 0, 0 },
{ START_STOP, 0, 0, 0, 1, 0 },
{ START_STOP, 0, 0, 0, 2, 0 }
};
unsigned i;
unsigned char sense_buffer[32];
unsigned char inqBuff[2];
sg_io_hdr_t io_hdr;
if ((ioctl(dev_fd, SG_GET_VERSION_NUM, &i) < 0) || (i < 30000))
bb_simple_error_msg_and_die("not a sg device or old sg driver");
memset(&io_hdr, 0, sizeof(sg_io_hdr_t));
io_hdr.interface_id = 'S';
io_hdr.cmd_len = 6;
io_hdr.mx_sb_len = sizeof(sense_buffer);
io_hdr.dxfer_direction = SG_DXFER_NONE;
/* io_hdr.dxfer_len = 0; */
io_hdr.dxferp = inqBuff;
io_hdr.sbp = sense_buffer;
io_hdr.timeout = 2000;
for (i = 0; i < 3; i++) {
io_hdr.cmdp = (void *)sg_commands[i];
ioctl_or_perror_and_die(dev_fd, SG_IO, (void *)&io_hdr, "%s", dev);
}
/* force kernel to reread partition table when new disc is inserted */
ioctl(dev_fd, BLKRRPART);
}
#else
# define eject_scsi(dev) ((void)0)
#endif
/* various defines swiped from linux/cdrom.h */
#define CDROMCLOSETRAY 0x5319 /* pendant of CDROMEJECT */
#define CDROMEJECT 0x5309 /* Ejects the cdrom media */
#define CDROM_DRIVE_STATUS 0x5326 /* Get tray position, etc. */
/* drive status possibilities returned by CDROM_DRIVE_STATUS ioctl */
#define CDS_TRAY_OPEN 2
#define FLAG_CLOSE 1
#define FLAG_SMART 2
#define FLAG_SCSI 4
static void eject_cdrom(unsigned flags, const char *dev)
{
int cmd = CDROMEJECT;
if (flags & FLAG_CLOSE
|| ((flags & FLAG_SMART) && ioctl(dev_fd, CDROM_DRIVE_STATUS) == CDS_TRAY_OPEN)
) {
cmd = CDROMCLOSETRAY;
}
ioctl_or_perror_and_die(dev_fd, cmd, NULL, "%s", dev);
}
int eject_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
int eject_main(int argc UNUSED_PARAM, char **argv)
{
unsigned flags;
const char *device;
flags = getopt32(argv, "^" "tT"IF_FEATURE_EJECT_SCSI("s")
"\0" "?1:t--T:T--t"
);
device = argv[optind] ? argv[optind] : "/dev/cdrom";
/* We used to do "umount <device>" here, but it was buggy
if something was mounted OVER cdrom and
if cdrom is mounted many times.
This works equally well (or better):
#!/bin/sh
umount /dev/cdrom
eject /dev/cdrom
*/
xmove_fd(xopen_nonblocking(device), dev_fd);
if (ENABLE_FEATURE_EJECT_SCSI && (flags & FLAG_SCSI))
eject_scsi(device);
else
eject_cdrom(flags, device);
if (ENABLE_FEATURE_CLEAN_UP)
close(dev_fd);
return EXIT_SUCCESS;
}