Bump to version 1.22.1
[platform/upstream/busybox.git] / init / bootchartd.c
index 9faf14d..c7388c9 100644 (file)
@@ -1,14 +1,69 @@
 /* vi: set sw=4 ts=4: */
 /*
- * Licensed under GPLv2 or later, see file LICENSE in this tarball for details.
+ * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
+
+//applet:IF_BOOTCHARTD(APPLET(bootchartd, BB_DIR_SBIN, BB_SUID_DROP))
+
+//kbuild:lib-$(CONFIG_BOOTCHARTD) += bootchartd.o
+
+//config:config BOOTCHARTD
+//config:      bool "bootchartd"
+//config:      default y
+//config:      help
+//config:        bootchartd is commonly used to profile the boot process
+//config:        for the purpose of speeding it up. In this case, it is started
+//config:        by the kernel as the init process. This is configured by adding
+//config:        the init=/sbin/bootchartd option to the kernel command line.
+//config:
+//config:        It can also be used to monitor the resource usage of a specific
+//config:        application or the running system in general. In this case,
+//config:        bootchartd is started interactively by running bootchartd start
+//config:        and stopped using bootchartd stop.
+//config:
+//config:config FEATURE_BOOTCHARTD_BLOATED_HEADER
+//config:      bool "Compatible, bloated header"
+//config:      default y
+//config:      depends on BOOTCHARTD
+//config:      help
+//config:        Create extended header file compatible with "big" bootchartd.
+//config:        "Big" bootchartd is a shell script and it dumps some
+//config:        "convenient" info int the header, such as:
+//config:          title = Boot chart for `hostname` (`date`)
+//config:          system.uname = `uname -srvm`
+//config:          system.release = `cat /etc/DISTRO-release`
+//config:          system.cpu = `grep '^model name' /proc/cpuinfo | head -1` ($cpucount)
+//config:          system.kernel.options = `cat /proc/cmdline`
+//config:        This data is not mandatory for bootchart graph generation,
+//config:        and is considered bloat. Nevertheless, this option
+//config:        makes bootchartd applet to dump a subset of it.
+//config:
+//config:config FEATURE_BOOTCHARTD_CONFIG_FILE
+//config:      bool "Support bootchartd.conf"
+//config:      default y
+//config:      depends on BOOTCHARTD
+//config:      help
+//config:        Enable reading and parsing of $PWD/bootchartd.conf
+//config:        and /etc/bootchartd.conf files.
+
 #include "libbb.h"
-#include <sys/mount.h>
-#ifndef MS_SILENT
-# define MS_SILENT      (1 << 15)
+/* After libbb.h, since it needs sys/types.h on some systems */
+#include <sys/utsname.h>
+
+#ifdef __linux__
+# include <sys/mount.h>
+# ifndef MS_SILENT
+#  define MS_SILENT      (1 << 15)
+# endif
+# ifndef MNT_DETACH
+#  define MNT_DETACH 0x00000002
+# endif
 #endif
-#ifndef MNT_DETACH
-# define MNT_DETACH 0x00000002
+
+#if !ENABLE_TAR && !ENABLE_WERROR
+# warning Note: bootchartd requires tar command, but you did not select it.
+#elif !ENABLE_FEATURE_SEAMLESS_GZ && !ENABLE_WERROR
+# warning Note: bootchartd requires tar -z support, but you did not select it.
 #endif
 
 #define BC_VERSION_STR "0.8"
 #define DO_SIGNAL_SYNC 1
 
 
-//Not supported: $PWD/bootchartd.conf and /etc/bootchartd.conf
-
+//$PWD/bootchartd.conf and /etc/bootchartd.conf:
+//supported options:
+//# Sampling period (in seconds)
+//SAMPLE_PERIOD=0.2
+//
+//not yet supported:
 //# tmpfs size
 //# (32 MB should suffice for ~20 minutes worth of log data, but YMMV)
 //TMPFS_SIZE=32m
 //
-//# Sampling period (in seconds)
-//SAMPLE_PERIOD=0.2
-//
 //# Whether to enable and store BSD process accounting information.  The
 //# kernel needs to be configured to enable v3 accounting
 //# (CONFIG_BSD_PROCESS_ACCT_V3). accton from the GNU accounting utilities
 
 /* Globals */
 struct globals {
-       char jiffy_line[sizeof(bb_common_bufsiz1)];
+       char jiffy_line[COMMON_BUFSIZE];
 } FIX_ALIASING;
 #define G (*(struct globals*)&bb_common_bufsiz1)
 #define INIT_G() do { } while (0)
@@ -113,7 +169,7 @@ static int dump_procs(FILE *fp, int look_for_login_process)
                                continue;
                        p++;
                        strchrnul(p, ')')[0] = '\0';
-                       /* If is gdm, kdm or a getty? */
+                       /* Is it gdm, kdm or a getty? */
                        if (((p[0] == 'g' || p[0] == 'k' || p[0] == 'x') && p[1] == 'd' && p[2] == 'm')
                         || strstr(p, "getty")
                        ) {
@@ -126,11 +182,12 @@ static int dump_procs(FILE *fp, int look_for_login_process)
        return found_login_process;
 }
 
-static char *make_tempdir(const char *prog)
+static char *make_tempdir(void)
 {
        char template[] = "/tmp/bootchart.XXXXXX";
        char *tempdir = xstrdup(mkdtemp(template));
        if (!tempdir) {
+#ifdef __linux__
                /* /tmp is not writable (happens when we are used as init).
                 * Try to mount a tmpfs, them cd and lazily unmount it.
                 * Since we unmount it at once, we can mount it anywhere.
@@ -148,34 +205,28 @@ static char *make_tempdir(const char *prog)
                if (umount2(try_dir, MNT_DETACH) != 0) {
                        bb_perror_msg_and_die("can't %smount tmpfs", "un");
                }
+#else
+               bb_perror_msg_and_die("can't create temporary directory");
+#endif
        } else {
                xchdir(tempdir);
        }
-       {
-               FILE *header_fp = xfopen("header", "w");
-               if (prog)
-                       fprintf(header_fp, "profile.process = %s\n", prog);
-               fputs("version = "BC_VERSION_STR"\n", header_fp);
-               fclose(header_fp);
-       }
-
        return tempdir;
 }
 
-static void do_logging(void)
+static void do_logging(unsigned sample_period_us, int process_accounting)
 {
-       //# Enable process accounting if configured
-       //if [ "$PROCESS_ACCOUNTING" = "yes" ]; then
-       //      [ -e kernel_pacct ] || : > kernel_pacct
-       //      accton kernel_pacct
-       //fi
-
        FILE *proc_stat = xfopen("proc_stat.log", "w");
        FILE *proc_diskstats = xfopen("proc_diskstats.log", "w");
        //FILE *proc_netdev = xfopen("proc_netdev.log", "w");
        FILE *proc_ps = xfopen("proc_ps.log", "w");
        int look_for_login_process = (getppid() == 1);
-       unsigned count = 60*1000*1000 / (200*1000); /* ~1 minute */
+       unsigned count = 60*1000*1000 / sample_period_us; /* ~1 minute */
+
+       if (process_accounting) {
+               close(xopen("kernel_pacct", O_WRONLY | O_CREAT | O_TRUNC));
+               acct("kernel_pacct");
+       }
 
        while (--count && !bb_got_signal) {
                char *p;
@@ -200,34 +251,69 @@ static void do_logging(void)
                        /* dump_procs saw a getty or {g,k,x}dm
                         * stop logging in 2 seconds:
                         */
-                       if (count > 2*1000*1000 / (200*1000))
-                               count = 2*1000*1000 / (200*1000);
+                       if (count > 2*1000*1000 / sample_period_us)
+                               count = 2*1000*1000 / sample_period_us;
                }
                fflush_all();
  wait_more:
-               usleep(200*1000);
+               usleep(sample_period_us);
        }
-
-       // [ -e kernel_pacct ] && accton off
 }
 
-static void finalize(char *tempdir)
+static void finalize(char *tempdir, const char *prog, int process_accounting)
 {
        //# Stop process accounting if configured
        //local pacct=
        //[ -e kernel_pacct ] && pacct=kernel_pacct
 
-       //(
-       //      echo "version = $VERSION"
-       //      echo "title = Boot chart for $( hostname | sed q ) ($( date ))"
-       //      echo "system.uname = $( uname -srvm | sed q )"
-       //      echo "system.release = $( sed q /etc/SuSE-release )"
-       //      echo "system.cpu = $( grep '^model name' /proc/cpuinfo | sed q ) ($cpucount)"
-       //      echo "system.kernel.options = $( sed q /proc/cmdline )"
-       //) >> header
+       FILE *header_fp = xfopen("header", "w");
+
+       if (process_accounting)
+               acct(NULL);
+
+       if (prog)
+               fprintf(header_fp, "profile.process = %s\n", prog);
+
+       fputs("version = "BC_VERSION_STR"\n", header_fp);
+       if (ENABLE_FEATURE_BOOTCHARTD_BLOATED_HEADER) {
+               char *hostname;
+               char *kcmdline;
+               time_t t;
+               struct tm tm_time;
+               /* x2 for possible localized weekday/month names */
+               char date_buf[sizeof("Mon Jun 21 05:29:03 CEST 2010") * 2];
+               struct utsname unamebuf;
+
+               hostname = safe_gethostname();
+               time(&t);
+               localtime_r(&t, &tm_time);
+               strftime(date_buf, sizeof(date_buf), "%a %b %e %H:%M:%S %Z %Y", &tm_time);
+               fprintf(header_fp, "title = Boot chart for %s (%s)\n", hostname, date_buf);
+               if (ENABLE_FEATURE_CLEAN_UP)
+                       free(hostname);
+
+               uname(&unamebuf); /* never fails */
+               /* same as uname -srvm */
+               fprintf(header_fp, "system.uname = %s %s %s %s\n",
+                               unamebuf.sysname,
+                               unamebuf.release,
+                               unamebuf.version,
+                               unamebuf.machine
+               );
+
+               //system.release = `cat /etc/DISTRO-release`
+               //system.cpu = `grep '^model name' /proc/cpuinfo | head -1` ($cpucount)
+
+               kcmdline = xmalloc_open_read_close("/proc/cmdline", NULL);
+               /* kcmdline includes trailing "\n" */
+               fprintf(header_fp, "system.kernel.options = %s", kcmdline);
+               if (ENABLE_FEATURE_CLEAN_UP)
+                       free(kcmdline);
+       }
+       fclose(header_fp);
 
        /* Package log files */
-       system("tar -zcf /var/log/bootchart.tgz header *.log"); // + $pacct
+       system(xasprintf("tar -zcf /var/log/bootlog.tgz header %s *.log", process_accounting ? "kernel_pacct" : ""));
        /* Clean up (if we are not in detached tmpfs) */
        if (tempdir) {
                unlink("header");
@@ -235,6 +321,8 @@ static void finalize(char *tempdir)
                unlink("proc_diskstats.log");
                //unlink("proc_netdev.log");
                unlink("proc_ps.log");
+               if (process_accounting)
+                       unlink("kernel_pacct");
                rmdir(tempdir);
        }
 
@@ -243,21 +331,22 @@ static void finalize(char *tempdir)
         */
 }
 
-/* Usage:
- * bootchartd start [PROG ARGS]: start logging in background, USR1 stops it.
- *     With PROG, runs PROG, then kills background logging.
- * bootchartd stop: same as "killall -USR1 bootchartd"
- * bootchartd init: start logging in background
- *     Stop when getty/gdm is seen (if AUTO_STOP_LOGGER = yes).
- *     Meant to be used from init scripts.
- * bootchartd (pid==1): as init, but then execs $bootchart_init, /init, /sbin/init
- *     Meant to be used as kernel's init process.
- */
+//usage:#define bootchartd_trivial_usage
+//usage:       "start [PROG ARGS]|stop|init"
+//usage:#define bootchartd_full_usage "\n\n"
+//usage:       "Create /var/log/bootchart.tgz with boot chart data\n"
+//usage:     "\nstart: start background logging; with PROG, run PROG, then kill logging with USR1"
+//usage:     "\nstop: send USR1 to all bootchartd processes"
+//usage:     "\ninit: start background logging; stop when getty/xdm is seen (for init scripts)"
+//usage:     "\nUnder PID 1: as init, then exec $bootchart_init, /init, /sbin/init"
+
 int bootchartd_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 int bootchartd_main(int argc UNUSED_PARAM, char **argv)
 {
+       unsigned sample_period_us;
        pid_t parent_pid, logger_pid;
        smallint cmd;
+       int process_accounting;
        enum {
                CMD_STOP = 0,
                CMD_START,
@@ -287,7 +376,31 @@ int bootchartd_main(int argc UNUSED_PARAM, char **argv)
                cmd = CMD_PID1;
        }
 
-       /* Here we are in START or INIT state. Create logger child: */
+       /* Here we are in START, INIT or CMD_PID1 state */
+
+       /* Read config file: */
+       sample_period_us = 200 * 1000;
+       process_accounting = 0;
+       if (ENABLE_FEATURE_BOOTCHARTD_CONFIG_FILE) {
+               char* token[2];
+               parser_t *parser = config_open2("/etc/bootchartd.conf" + 5, fopen_for_read);
+               if (!parser)
+                       parser = config_open2("/etc/bootchartd.conf", fopen_for_read);
+               while (config_read(parser, token, 2, 0, "#=", PARSE_NORMAL & ~PARSE_COLLAPSE)) {
+                       if (strcmp(token[0], "SAMPLE_PERIOD") == 0 && token[1])
+                               sample_period_us = atof(token[1]) * 1000000;
+                       if (strcmp(token[0], "PROCESS_ACCOUNTING") == 0 && token[1]
+                        && (strcmp(token[1], "on") == 0 || strcmp(token[1], "yes") == 0)
+                       ) {
+                               process_accounting = 1;
+                       }
+               }
+               config_close(parser);
+               if ((int)sample_period_us <= 0)
+                       sample_period_us = 1; /* prevent division by 0 */
+       }
+
+       /* Create logger child: */
        logger_pid = fork_or_rexec(argv);
 
        if (logger_pid == 0) { /* child */
@@ -312,14 +425,16 @@ int bootchartd_main(int argc UNUSED_PARAM, char **argv)
                if (cmd == CMD_PID1 && !getenv("PATH"))
                        putenv((char*)bb_PATH_root_path);
 
-               tempdir = make_tempdir(cmd == CMD_START ? argv[2] : NULL);
-               do_logging();
-               finalize(tempdir);
+               tempdir = make_tempdir();
+               do_logging(sample_period_us, process_accounting);
+               finalize(tempdir, cmd == CMD_START ? argv[2] : NULL, process_accounting);
                return EXIT_SUCCESS;
        }
 
        /* parent */
 
+       USE_FOR_NOMMU(argv[0][0] &= 0x7f); /* undo fork_or_rexec() damage */
+
        if (DO_SIGNAL_SYNC) {
                /* Wait for logger child to set handlers, then unpause it.
                 * Otherwise with short-lived PROG (e.g. "bootchartd start true")
@@ -335,17 +450,14 @@ int bootchartd_main(int argc UNUSED_PARAM, char **argv)
                        execl(bootchart_init, bootchart_init, NULL);
                execl("/init", "init", NULL);
                execl("/sbin/init", "init", NULL);
-               bb_perror_msg_and_die("can't exec '%s'", "/sbin/init");
+               bb_perror_msg_and_die("can't execute '%s'", "/sbin/init");
        }
 
        if (cmd == CMD_START && argv[2]) { /* "start PROG ARGS" */
-               pid_t pid = vfork();
-               if (pid < 0)
-                       bb_perror_msg_and_die("vfork");
+               pid_t pid = xvfork();
                if (pid == 0) { /* child */
                        argv += 2;
-                       execvp(argv[0], argv);
-                       bb_perror_msg_and_die("can't exec '%s'", argv[0]);
+                       BB_EXECVP_or_die(argv);
                }
                /* parent */
                waitpid(pid, NULL, 0);