source: branches/3.2/mindi-busybox/init/bootchartd.c @ 3232

Last change on this file since 3232 was 3232, checked in by bruno, 5 years ago
  • Update mindi-busybox to 1.21.1
  • Property svn:eol-style set to native
File size: 13.2 KB
Line 
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 */
109struct 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
115static 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
127static 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
179static 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
211static void do_logging(unsigned sample_period_us, int process_accounting)
212{
213    FILE *proc_stat = xfopen("proc_stat.log", "w");
214    FILE *proc_diskstats = xfopen("proc_diskstats.log", "w");
215    //FILE *proc_netdev = xfopen("proc_netdev.log", "w");
216    FILE *proc_ps = xfopen("proc_ps.log", "w");
217    int look_for_login_process = (getppid() == 1);
218    unsigned count = 60*1000*1000 / sample_period_us; /* ~1 minute */
219
220    if (process_accounting) {
221        close(xopen("kernel_pacct", O_WRONLY | O_CREAT | O_TRUNC));
222        acct("kernel_pacct");
223    }
224
225    while (--count && !bb_got_signal) {
226        char *p;
227        int len = open_read_close("/proc/uptime", G.jiffy_line, sizeof(G.jiffy_line)-2);
228        if (len < 0)
229            goto wait_more;
230        /* /proc/uptime has format "NNNNNN.MM NNNNNNN.MM" */
231        /* we convert it to "NNNNNNMM\n" (using first value) */
232        G.jiffy_line[len] = '\0';
233        p = strchr(G.jiffy_line, '.');
234        if (!p)
235            goto wait_more;
236        while (isdigit(*++p))
237            p[-1] = *p;
238        p[-1] = '\n';
239        p[0] = '\0';
240
241        dump_file(proc_stat, "/proc/stat");
242        dump_file(proc_diskstats, "/proc/diskstats");
243        //dump_file(proc_netdev, "/proc/net/dev");
244        if (dump_procs(proc_ps, look_for_login_process)) {
245            /* dump_procs saw a getty or {g,k,x}dm
246             * stop logging in 2 seconds:
247             */
248            if (count > 2*1000*1000 / sample_period_us)
249                count = 2*1000*1000 / sample_period_us;
250        }
251        fflush_all();
252 wait_more:
253        usleep(sample_period_us);
254    }
255}
256
257static void finalize(char *tempdir, const char *prog, int process_accounting)
258{
259    //# Stop process accounting if configured
260    //local pacct=
261    //[ -e kernel_pacct ] && pacct=kernel_pacct
262
263    FILE *header_fp = xfopen("header", "w");
264
265    if (process_accounting)
266        acct(NULL);
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(xasprintf("tar -zcf /var/log/bootlog.tgz header %s *.log", process_accounting ? "kernel_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        if (process_accounting)
319            unlink("kernel_pacct");
320        rmdir(tempdir);
321    }
322
323    /* shell-based bootchartd tries to run /usr/bin/bootchart if $AUTO_RENDER=yes:
324     * /usr/bin/bootchart -o "$AUTO_RENDER_DIR" -f $AUTO_RENDER_FORMAT "$BOOTLOG_DEST"
325     */
326}
327
328//usage:#define bootchartd_trivial_usage
329//usage:       "start [PROG ARGS]|stop|init"
330//usage:#define bootchartd_full_usage "\n\n"
331//usage:       "Create /var/log/bootchart.tgz with boot chart data\n"
332//usage:     "\nstart: start background logging; with PROG, run PROG, then kill logging with USR1"
333//usage:     "\nstop: send USR1 to all bootchartd processes"
334//usage:     "\ninit: start background logging; stop when getty/xdm is seen (for init scripts)"
335//usage:     "\nUnder PID 1: as init, then exec $bootchart_init, /init, /sbin/init"
336
337int bootchartd_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
338int bootchartd_main(int argc UNUSED_PARAM, char **argv)
339{
340    unsigned sample_period_us;
341    pid_t parent_pid, logger_pid;
342    smallint cmd;
343    int process_accounting;
344    enum {
345        CMD_STOP = 0,
346        CMD_START,
347        CMD_INIT,
348        CMD_PID1, /* used to mark pid 1 case */
349    };
350
351    INIT_G();
352
353    parent_pid = getpid();
354    if (argv[1]) {
355        cmd = index_in_strings("stop\0""start\0""init\0", argv[1]);
356        if (cmd < 0)
357            bb_show_usage();
358        if (cmd == CMD_STOP) {
359            pid_t *pidList = find_pid_by_name("bootchartd");
360            while (*pidList != 0) {
361                if (*pidList != parent_pid)
362                    kill(*pidList, SIGUSR1);
363                pidList++;
364            }
365            return EXIT_SUCCESS;
366        }
367    } else {
368        if (parent_pid != 1)
369            bb_show_usage();
370        cmd = CMD_PID1;
371    }
372
373    /* Here we are in START, INIT or CMD_PID1 state */
374
375    /* Read config file: */
376    sample_period_us = 200 * 1000;
377    process_accounting = 0;
378    if (ENABLE_FEATURE_BOOTCHARTD_CONFIG_FILE) {
379        char* token[2];
380        parser_t *parser = config_open2("/etc/bootchartd.conf" + 5, fopen_for_read);
381        if (!parser)
382            parser = config_open2("/etc/bootchartd.conf", fopen_for_read);
383        while (config_read(parser, token, 2, 0, "#=", PARSE_NORMAL & ~PARSE_COLLAPSE)) {
384            if (strcmp(token[0], "SAMPLE_PERIOD") == 0 && token[1])
385                sample_period_us = atof(token[1]) * 1000000;
386            if (strcmp(token[0], "PROCESS_ACCOUNTING") == 0 && token[1]
387             && (strcmp(token[1], "on") == 0 || strcmp(token[1], "yes") == 0)
388            ) {
389                process_accounting = 1;
390            }
391        }
392        config_close(parser);
393        if ((int)sample_period_us <= 0)
394            sample_period_us = 1; /* prevent division by 0 */
395    }
396
397    /* Create logger child: */
398    logger_pid = fork_or_rexec(argv);
399
400    if (logger_pid == 0) { /* child */
401        char *tempdir;
402
403        bb_signals(0
404            + (1 << SIGUSR1)
405            + (1 << SIGUSR2)
406            + (1 << SIGTERM)
407            + (1 << SIGQUIT)
408            + (1 << SIGINT)
409            + (1 << SIGHUP)
410            , record_signo);
411
412        if (DO_SIGNAL_SYNC)
413            /* Inform parent that we are ready */
414            raise(SIGSTOP);
415
416        /* If we are started by kernel, PATH might be unset.
417         * In order to find "tar", let's set some sane PATH:
418         */
419        if (cmd == CMD_PID1 && !getenv("PATH"))
420            putenv((char*)bb_PATH_root_path);
421
422        tempdir = make_tempdir();
423        do_logging(sample_period_us, process_accounting);
424        finalize(tempdir, cmd == CMD_START ? argv[2] : NULL, process_accounting);
425        return EXIT_SUCCESS;
426    }
427
428    /* parent */
429
430    USE_FOR_NOMMU(argv[0][0] &= 0x7f); /* undo fork_or_rexec() damage */
431
432    if (DO_SIGNAL_SYNC) {
433        /* Wait for logger child to set handlers, then unpause it.
434         * Otherwise with short-lived PROG (e.g. "bootchartd start true")
435         * we might send SIGUSR1 before logger sets its handler.
436         */
437        waitpid(logger_pid, NULL, WUNTRACED);
438        kill(logger_pid, SIGCONT);
439    }
440
441    if (cmd == CMD_PID1) {
442        char *bootchart_init = getenv("bootchart_init");
443        if (bootchart_init)
444            execl(bootchart_init, bootchart_init, NULL);
445        execl("/init", "init", NULL);
446        execl("/sbin/init", "init", NULL);
447        bb_perror_msg_and_die("can't execute '%s'", "/sbin/init");
448    }
449
450    if (cmd == CMD_START && argv[2]) { /* "start PROG ARGS" */
451        pid_t pid = xvfork();
452        if (pid == 0) { /* child */
453            argv += 2;
454            BB_EXECVP_or_die(argv);
455        }
456        /* parent */
457        waitpid(pid, NULL, 0);
458        kill(logger_pid, SIGUSR1);
459    }
460
461    return EXIT_SUCCESS;
462}
Note: See TracBrowser for help on using the repository browser.