init/bootchartd.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
   4  */
   5
   6 //applet:IF_BOOTCHARTD(APPLET(bootchartd, BB_DIR_SBIN, BB_SUID_DROP))
   7
   8 //kbuild:lib-$(CONFIG_BOOTCHARTD) += bootchartd.o
   9
  10 //config:config BOOTCHARTD
  11 //config:       bool "bootchartd"
  12 //config:       default y
  13 //config:       help
  14 //config:         bootchartd is commonly used to profile the boot process
  15 //config:         for the purpose of speeding it up. In this case, it is started
  16 //config:         by the kernel as the init process. This is configured by adding
  17 //config:         the init=/sbin/bootchartd option to the kernel command line.
  18 //config:
  19 //config:         It can also be used to monitor the resource usage of a specific
  20 //config:         application or the running system in general. In this case,
  21 //config:         bootchartd is started interactively by running bootchartd start
  22 //config:         and stopped using bootchartd stop.
  23 //config:
  24 //config:config FEATURE_BOOTCHARTD_BLOATED_HEADER
  25 //config:       bool "Compatible, bloated header"
  26 //config:       default y
  27 //config:       depends on BOOTCHARTD
  28 //config:       help
  29 //config:         Create extended header file compatible with "big" bootchartd.
  30 //config:         "Big" bootchartd is a shell script and it dumps some
  31 //config:         "convenient" info int the header, such as:
  32 //config:           title = Boot chart for `hostname` (`date`)
  33 //config:           system.uname = `uname -srvm`
  34 //config:           system.release = `cat /etc/DISTRO-release`
  35 //config:           system.cpu = `grep '^model name' /proc/cpuinfo | head -1` ($cpucount)
  36 //config:           system.kernel.options = `cat /proc/cmdline`
  37 //config:         This data is not mandatory for bootchart graph generation,
  38 //config:         and is considered bloat. Nevertheless, this option
  39 //config:         makes bootchartd applet to dump a subset of it.
  40 //config:
  41 //config:config FEATURE_BOOTCHARTD_CONFIG_FILE
  42 //config:       bool "Support bootchartd.conf"
  43 //config:       default y
  44 //config:       depends on BOOTCHARTD
  45 //config:       help
  46 //config:         Enable reading and parsing of $PWD/bootchartd.conf
  47 //config:         and /etc/bootchartd.conf files.
  48
  49 #include "libbb.h"
  50 /* After libbb.h, since it needs sys/types.h on some systems */
  51 #include <sys/utsname.h>
  52
  53 #ifdef __linux__
  54 # include <sys/mount.h>
  55 # ifndef MS_SILENT
  56 #  define MS_SILENT      (1 << 15)
  57 # endif
  58 # ifndef MNT_DETACH
  59 #  define MNT_DETACH 0x00000002
  60 # endif
  61 #endif
  62
  63 #define BC_VERSION_STR "0.8"
  64
  65 /* For debugging, set to 0:
  66  * strace won't work with DO_SIGNAL_SYNC set to 1.
  67  */
  68 #define DO_SIGNAL_SYNC 1
  69
  70
  71 //$PWD/bootchartd.conf and /etc/bootchartd.conf:
  72 //supported options:
  73 //# Sampling period (in seconds)
  74 //SAMPLE_PERIOD=0.2
  75 //
  76 //not yet supported:
  77 //# tmpfs size
  78 //# (32 MB should suffice for ~20 minutes worth of log data, but YMMV)
  79 //TMPFS_SIZE=32m
  80 //
  81 //# Whether to enable and store BSD process accounting information.  The
  82 //# kernel needs to be configured to enable v3 accounting
  83 //# (CONFIG_BSD_PROCESS_ACCT_V3). accton from the GNU accounting utilities
  84 //# is also required.
  85 //PROCESS_ACCOUNTING="no"
  86 //
  87 //# Tarball for the various boot log files
  88 //BOOTLOG_DEST=/var/log/bootchart.tgz
  89 //
  90 //# Whether to automatically stop logging as the boot process completes.
  91 //# The logger will look for known processes that indicate bootup completion
  92 //# at a specific runlevel (e.g. gdm-binary, mingetty, etc.).
  93 //AUTO_STOP_LOGGER="yes"
  94 //
  95 //# Whether to automatically generate the boot chart once the boot logger
  96 //# completes.  The boot chart will be generated in $AUTO_RENDER_DIR.
  97 //# Note that the bootchart package must be installed.
  98 //AUTO_RENDER="no"
  99 //
 100 //# Image format to use for the auto-generated boot chart
 101 //# (choose between png, svg and eps).
 102 //AUTO_RENDER_FORMAT="png"
 103 //
 104 //# Output directory for auto-generated boot charts
 105 //AUTO_RENDER_DIR="/var/log"
 106
 107
 108 /* Globals */
 109 struct globals {
 110         char jiffy_line[COMMON_BUFSIZE];
 111 } FIX_ALIASING;
 112 #define G (*(struct globals*)&bb_common_bufsiz1)
 113 #define INIT_G() do { } while (0)
 114
 115 static void dump_file(FILE *fp, const char *filename)
 116 {
 117         int fd = open(filename, O_RDONLY);
 118         if (fd >= 0) {
 119                 fputs(G.jiffy_line, fp);
 120                 fflush(fp);
 121                 bb_copyfd_eof(fd, fileno(fp));
 122                 close(fd);
 123                 fputc('\n', fp);
 124         }
 125 }
 126
 127 static int dump_procs(FILE *fp, int look_for_login_process)
 128 {
 129         struct dirent *entry;
 130         DIR *dir = opendir("/proc");
 131         int found_login_process = 0;
 132
 133         fputs(G.jiffy_line, fp);
 134         while ((entry = readdir(dir)) != NULL) {
 135                 char name[sizeof("/proc/%u/cmdline") + sizeof(int)*3];
 136                 int stat_fd;
 137                 unsigned pid = bb_strtou(entry->d_name, NULL, 10);
 138                 if (errno)
 139                         continue;
 140
 141                 /* Android's version reads /proc/PID/cmdline and extracts
 142                  * non-truncated process name. Do we want to do that? */
 143
 144                 sprintf(name, "/proc/%u/stat", pid);
 145                 stat_fd = open(name, O_RDONLY);
 146                 if (stat_fd >= 0) {
 147                         char *p;
 148                         char stat_line[4*1024];
 149                         int rd = safe_read(stat_fd, stat_line, sizeof(stat_line)-2);
 150
 151                         close(stat_fd);
 152                         if (rd < 0)
 153                                 continue;
 154                         stat_line[rd] = '\0';
 155                         p = strchrnul(stat_line, '\n');
 156                         *p++ = '\n';
 157                         *p = '\0';
 158                         fputs(stat_line, fp);
 159                         if (!look_for_login_process)
 160                                 continue;
 161                         p = strchr(stat_line, '(');
 162                         if (!p)
 163                                 continue;
 164                         p++;
 165                         strchrnul(p, ')')[0] = '\0';
 166                         /* Is it gdm, kdm or a getty? */
 167                         if (((p[0] == 'g' || p[0] == 'k' || p[0] == 'x') && p[1] == 'd' && p[2] == 'm')
 168                          || strstr(p, "getty")
 169                         ) {
 170                                 found_login_process = 1;
 171                         }
 172                 }
 173         }
 174         closedir(dir);
 175         fputc('\n', fp);
 176         return found_login_process;
 177 }
 178
 179 static char *make_tempdir(void)
 180 {
 181         char template[] = "/tmp/bootchart.XXXXXX";
 182         char *tempdir = xstrdup(mkdtemp(template));
 183         if (!tempdir) {
 184 #ifdef __linux__
 185                 /* /tmp is not writable (happens when we are used as init).
 186                  * Try to mount a tmpfs, them cd and lazily unmount it.
 187                  * Since we unmount it at once, we can mount it anywhere.
 188                  * Try a few locations which are likely ti exist.
 189                  */
 190                 static const char dirs[] = "/mnt\0""/tmp\0""/boot\0""/proc\0";
 191                 const char *try_dir = dirs;
 192                 while (mount("none", try_dir, "tmpfs", MS_SILENT, "size=16m") != 0) {
 193                         try_dir += strlen(try_dir) + 1;
 194                         if (!try_dir[0])
 195                                 bb_perror_msg_and_die("can't %smount tmpfs", "");
 196                 }
 197                 //bb_error_msg("mounted tmpfs on %s", try_dir);
 198                 xchdir(try_dir);
 199                 if (umount2(try_dir, MNT_DETACH) != 0) {
 200                         bb_perror_msg_and_die("can't %smount tmpfs", "un");
 201                 }
 202 #else
 203                 bb_perror_msg_and_die("can't create temporary directory");
 204 #endif
 205         } else {
 206                 xchdir(tempdir);
 207         }
 208         return tempdir;
 209 }
 210
 211 static void do_logging(unsigned sample_period_us)
 212 {
 213         //# Enable process accounting if configured
 214         //if [ "$PROCESS_ACCOUNTING" = "yes" ]; then
 215         //      [ -e kernel_pacct ] || : > kernel_pacct
 216         //      accton kernel_pacct
 217         //fi
 218
 219         FILE *proc_stat = xfopen("proc_stat.log", "w");
 220         FILE *proc_diskstats = xfopen("proc_diskstats.log", "w");
 221         //FILE *proc_netdev = xfopen("proc_netdev.log", "w");
 222         FILE *proc_ps = xfopen("proc_ps.log", "w");
 223         int look_for_login_process = (getppid() == 1);
 224         unsigned count = 60*1000*1000 / sample_period_us; /* ~1 minute */
 225
 226         while (--count && !bb_got_signal) {
 227                 char *p;
 228                 int len = open_read_close("/proc/uptime", G.jiffy_line, sizeof(G.jiffy_line)-2);
 229                 if (len < 0)
 230                         goto wait_more;
 231                 /* /proc/uptime has format "NNNNNN.MM NNNNNNN.MM" */
 232                 /* we convert it to "NNNNNNMM\n" (using first value) */
 233                 G.jiffy_line[len] = '\0';
 234                 p = strchr(G.jiffy_line, '.');
 235                 if (!p)
 236                         goto wait_more;
 237                 while (isdigit(*++p))
 238                         p[-1] = *p;
 239                 p[-1] = '\n';
 240                 p[0] = '\0';
 241
 242                 dump_file(proc_stat, "/proc/stat");
 243                 dump_file(proc_diskstats, "/proc/diskstats");
 244                 //dump_file(proc_netdev, "/proc/net/dev");
 245                 if (dump_procs(proc_ps, look_for_login_process)) {
 246                         /* dump_procs saw a getty or {g,k,x}dm
 247                          * stop logging in 2 seconds:
 248                          */
 249                         if (count > 2*1000*1000 / sample_period_us)
 250                                 count = 2*1000*1000 / sample_period_us;
 251                 }
 252                 fflush_all();
 253  wait_more:
 254                 usleep(sample_period_us);
 255         }
 256
 257         // [ -e kernel_pacct ] && accton off
 258 }
 259
 260 static void finalize(char *tempdir, const char *prog)
 261 {
 262         //# Stop process accounting if configured
 263         //local pacct=
 264         //[ -e kernel_pacct ] && pacct=kernel_pacct
 265
 266         FILE *header_fp = xfopen("header", "w");
 267
 268         if (prog)
 269                 fprintf(header_fp, "profile.process = %s\n", prog);
 270
 271         fputs("version = "BC_VERSION_STR"\n", header_fp);
 272         if (ENABLE_FEATURE_BOOTCHARTD_BLOATED_HEADER) {
 273                 char *hostname;
 274                 char *kcmdline;
 275                 time_t t;
 276                 struct tm tm_time;
 277                 /* x2 for possible localized weekday/month names */
 278                 char date_buf[sizeof("Mon Jun 21 05:29:03 CEST 2010") * 2];
 279                 struct utsname unamebuf;
 280
 281                 hostname = safe_gethostname();
 282                 time(&t);
 283                 localtime_r(&t, &tm_time);
 284                 strftime(date_buf, sizeof(date_buf), "%a %b %e %H:%M:%S %Z %Y", &tm_time);
 285                 fprintf(header_fp, "title = Boot chart for %s (%s)\n", hostname, date_buf);
 286                 if (ENABLE_FEATURE_CLEAN_UP)
 287                         free(hostname);
 288
 289                 uname(&unamebuf); /* never fails */
 290                 /* same as uname -srvm */
 291                 fprintf(header_fp, "system.uname = %s %s %s %s\n",
 292                                 unamebuf.sysname,
 293                                 unamebuf.release,
 294                                 unamebuf.version,
 295                                 unamebuf.machine
 296                 );
 297
 298                 //system.release = `cat /etc/DISTRO-release`
 299                 //system.cpu = `grep '^model name' /proc/cpuinfo | head -1` ($cpucount)
 300
 301                 kcmdline = xmalloc_open_read_close("/proc/cmdline", NULL);
 302                 /* kcmdline includes trailing "\n" */
 303                 fprintf(header_fp, "system.kernel.options = %s", kcmdline);
 304                 if (ENABLE_FEATURE_CLEAN_UP)
 305                         free(kcmdline);
 306         }
 307         fclose(header_fp);
 308
 309         /* Package log files */
 310         system("tar -zcf /var/log/bootchart.tgz header *.log"); // + $pacct
 311         /* Clean up (if we are not in detached tmpfs) */
 312         if (tempdir) {
 313                 unlink("header");
 314                 unlink("proc_stat.log");
 315                 unlink("proc_diskstats.log");
 316                 //unlink("proc_netdev.log");
 317                 unlink("proc_ps.log");
 318                 rmdir(tempdir);
 319         }
 320
 321         /* shell-based bootchartd tries to run /usr/bin/bootchart if $AUTO_RENDER=yes:
 322          * /usr/bin/bootchart -o "$AUTO_RENDER_DIR" -f $AUTO_RENDER_FORMAT "$BOOTLOG_DEST"
 323          */
 324 }
 325
 326 //usage:#define bootchartd_trivial_usage
 327 //usage:       "start [PROG ARGS]|stop|init"
 328 //usage:#define bootchartd_full_usage "\n\n"
 329 //usage:       "Create /var/log/bootchart.tgz with boot chart data\n"
 330 //usage:     "\nstart: start background logging; with PROG, run PROG, then kill logging with USR1"
 331 //usage:     "\nstop: send USR1 to all bootchartd processes"
 332 //usage:     "\ninit: start background logging; stop when getty/xdm is seen (for init scripts)"
 333 //usage:     "\nUnder PID 1: as init, then exec $bootchart_init, /init, /sbin/init"
 334
 335 int bootchartd_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 336 int bootchartd_main(int argc UNUSED_PARAM, char **argv)
 337 {
 338         unsigned sample_period_us;
 339         pid_t parent_pid, logger_pid;
 340         smallint cmd;
 341         enum {
 342                 CMD_STOP = 0,
 343                 CMD_START,
 344                 CMD_INIT,
 345                 CMD_PID1, /* used to mark pid 1 case */
 346         };
 347
 348         INIT_G();
 349
 350         parent_pid = getpid();
 351         if (argv[1]) {
 352                 cmd = index_in_strings("stop\0""start\0""init\0", argv[1]);
 353                 if (cmd < 0)
 354                         bb_show_usage();
 355                 if (cmd == CMD_STOP) {
 356                         pid_t *pidList = find_pid_by_name("bootchartd");
 357                         while (*pidList != 0) {
 358                                 if (*pidList != parent_pid)
 359                                         kill(*pidList, SIGUSR1);
 360                                 pidList++;
 361                         }
 362                         return EXIT_SUCCESS;
 363                 }
 364         } else {
 365                 if (parent_pid != 1)
 366                         bb_show_usage();
 367                 cmd = CMD_PID1;
 368         }
 369
 370         /* Here we are in START, INIT or CMD_PID1 state */
 371
 372         /* Read config file: */
 373         sample_period_us = 200 * 1000;
 374         if (ENABLE_FEATURE_BOOTCHARTD_CONFIG_FILE) {
 375                 char* token[2];
 376                 parser_t *parser = config_open2("/etc/bootchartd.conf" + 5, fopen_for_read);
 377                 if (!parser)
 378                         parser = config_open2("/etc/bootchartd.conf", fopen_for_read);
 379                 while (config_read(parser, token, 2, 0, "#=", PARSE_NORMAL & ~PARSE_COLLAPSE)) {
 380                         if (strcmp(token[0], "SAMPLE_PERIOD") == 0 && token[1])
 381                                 sample_period_us = atof(token[1]) * 1000000;
 382                 }
 383                 config_close(parser);
 384         }
 385         if ((int)sample_period_us <= 0)
 386                 sample_period_us = 1; /* prevent division by 0 */
 387
 388         /* Create logger child: */
 389         logger_pid = fork_or_rexec(argv);
 390
 391         if (logger_pid == 0) { /* child */
 392                 char *tempdir;
 393
 394                 bb_signals(0
 395                         + (1 << SIGUSR1)
 396                         + (1 << SIGUSR2)
 397                         + (1 << SIGTERM)
 398                         + (1 << SIGQUIT)
 399                         + (1 << SIGINT)
 400                         + (1 << SIGHUP)
 401                         , record_signo);
 402
 403                 if (DO_SIGNAL_SYNC)
 404                         /* Inform parent that we are ready */
 405                         raise(SIGSTOP);
 406
 407                 /* If we are started by kernel, PATH might be unset.
 408                  * In order to find "tar", let's set some sane PATH:
 409                  */
 410                 if (cmd == CMD_PID1 && !getenv("PATH"))
 411                         putenv((char*)bb_PATH_root_path);
 412
 413                 tempdir = make_tempdir();
 414                 do_logging(sample_period_us);
 415                 finalize(tempdir, cmd == CMD_START ? argv[2] : NULL);
 416                 return EXIT_SUCCESS;
 417         }
 418
 419         /* parent */
 420
 421         USE_FOR_NOMMU(argv[0][0] &= 0x7f); /* undo fork_or_rexec() damage */
 422
 423         if (DO_SIGNAL_SYNC) {
 424                 /* Wait for logger child to set handlers, then unpause it.
 425                  * Otherwise with short-lived PROG (e.g. "bootchartd start true")
 426                  * we might send SIGUSR1 before logger sets its handler.
 427                  */
 428                 waitpid(logger_pid, NULL, WUNTRACED);
 429                 kill(logger_pid, SIGCONT);
 430         }
 431
 432         if (cmd == CMD_PID1) {
 433                 char *bootchart_init = getenv("bootchart_init");
 434                 if (bootchart_init)
 435                         execl(bootchart_init, bootchart_init, NULL);
 436                 execl("/init", "init", NULL);
 437                 execl("/sbin/init", "init", NULL);
 438                 bb_perror_msg_and_die("can't execute '%s'", "/sbin/init");
 439         }
 440
 441         if (cmd == CMD_START && argv[2]) { /* "start PROG ARGS" */
 442                 pid_t pid = xvfork();
 443                 if (pid == 0) { /* child */
 444                         argv += 2;
 445                         BB_EXECVP_or_die(argv);
 446                 }
 447                 /* parent */
 448                 waitpid(pid, NULL, 0);
 449                 kill(logger_pid, SIGUSR1);
 450         }
 451
 452         return EXIT_SUCCESS;
 453 }