1 /* vi: set sw=4 ts=4: */
3 * Licensed under GPLv2 or later, see file LICENSE in this source tree.
6 //applet:IF_BOOTCHARTD(APPLET(bootchartd, BB_DIR_SBIN, BB_SUID_DROP))
8 //kbuild:lib-$(CONFIG_BOOTCHARTD) += bootchartd.o
10 //config:config BOOTCHARTD
11 //config: bool "bootchartd"
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.
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.
24 //config:config FEATURE_BOOTCHARTD_BLOATED_HEADER
25 //config: bool "Compatible, bloated header"
27 //config: depends on BOOTCHARTD
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.
41 //config:config FEATURE_BOOTCHARTD_CONFIG_FILE
42 //config: bool "Support bootchartd.conf"
44 //config: depends on BOOTCHARTD
46 //config: Enable reading and parsing of $PWD/bootchartd.conf
47 //config: and /etc/bootchartd.conf files.
50 /* After libbb.h, since it needs sys/types.h on some systems */
51 #include <sys/utsname.h>
54 # include <sys/mount.h>
56 # define MS_SILENT (1 << 15)
59 # define MNT_DETACH 0x00000002
63 #define BC_VERSION_STR "0.8"
65 /* For debugging, set to 0:
66 * strace won't work with DO_SIGNAL_SYNC set to 1.
68 #define DO_SIGNAL_SYNC 1
71 //$PWD/bootchartd.conf and /etc/bootchartd.conf:
73 //# Sampling period (in seconds)
78 //# (32 MB should suffice for ~20 minutes worth of log data, but YMMV)
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
85 //PROCESS_ACCOUNTING="no"
87 //# Tarball for the various boot log files
88 //BOOTLOG_DEST=/var/log/bootchart.tgz
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"
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.
100 //# Image format to use for the auto-generated boot chart
101 //# (choose between png, svg and eps).
102 //AUTO_RENDER_FORMAT="png"
104 //# Output directory for auto-generated boot charts
105 //AUTO_RENDER_DIR="/var/log"
110 char jiffy_line
[COMMON_BUFSIZE
];
112 #define G (*(struct globals*)&bb_common_bufsiz1)
113 #define INIT_G() do { } while (0)
115 static void dump_file(FILE *fp
, const char *filename
)
117 int fd
= open(filename
, O_RDONLY
);
119 fputs(G
.jiffy_line
, fp
);
121 bb_copyfd_eof(fd
, fileno(fp
));
127 static int dump_procs(FILE *fp
, int look_for_login_process
)
129 struct dirent
*entry
;
130 DIR *dir
= opendir("/proc");
131 int found_login_process
= 0;
133 fputs(G
.jiffy_line
, fp
);
134 while ((entry
= readdir(dir
)) != NULL
) {
135 char name
[sizeof("/proc/%u/cmdline") + sizeof(int)*3];
137 unsigned pid
= bb_strtou(entry
->d_name
, NULL
, 10);
141 /* Android's version reads /proc/PID/cmdline and extracts
142 * non-truncated process name. Do we want to do that? */
144 sprintf(name
, "/proc/%u/stat", pid
);
145 stat_fd
= open(name
, O_RDONLY
);
148 char stat_line
[4*1024];
149 int rd
= safe_read(stat_fd
, stat_line
, sizeof(stat_line
)-2);
154 stat_line
[rd
] = '\0';
155 p
= strchrnul(stat_line
, '\n');
158 fputs(stat_line
, fp
);
159 if (!look_for_login_process
)
161 p
= strchr(stat_line
, '(');
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")
170 found_login_process
= 1;
176 return found_login_process
;
179 static char *make_tempdir(void)
181 char template[] = "/tmp/bootchart.XXXXXX";
182 char *tempdir
= xstrdup(mkdtemp(template));
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.
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;
195 bb_perror_msg_and_die("can't %smount tmpfs", "");
197 //bb_error_msg("mounted tmpfs on %s", try_dir);
199 if (umount2(try_dir
, MNT_DETACH
) != 0) {
200 bb_perror_msg_and_die("can't %smount tmpfs", "un");
203 bb_perror_msg_and_die("can't create temporary directory");
211 static void do_logging(unsigned sample_period_us
, int process_accounting
)
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 */
220 if (process_accounting
) {
221 close(xopen("kernel_pacct", O_WRONLY
| O_CREAT
| O_TRUNC
));
222 acct("kernel_pacct");
225 while (--count
&& !bb_got_signal
) {
227 int len
= open_read_close("/proc/uptime", G
.jiffy_line
, sizeof(G
.jiffy_line
)-2);
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
, '.');
236 while (isdigit(*++p
))
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:
248 if (count
> 2*1000*1000 / sample_period_us
)
249 count
= 2*1000*1000 / sample_period_us
;
253 usleep(sample_period_us
);
257 static void finalize(char *tempdir
, const char *prog
, int process_accounting
)
259 //# Stop process accounting if configured
261 //[ -e kernel_pacct ] && pacct=kernel_pacct
263 FILE *header_fp
= xfopen("header", "w");
265 if (process_accounting
)
269 fprintf(header_fp
, "profile.process = %s\n", prog
);
271 fputs("version = "BC_VERSION_STR
"\n", header_fp
);
272 if (ENABLE_FEATURE_BOOTCHARTD_BLOATED_HEADER
) {
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
;
281 hostname
= safe_gethostname();
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
)
289 uname(&unamebuf
); /* never fails */
290 /* same as uname -srvm */
291 fprintf(header_fp
, "system.uname = %s %s %s %s\n",
298 //system.release = `cat /etc/DISTRO-release`
299 //system.cpu = `grep '^model name' /proc/cpuinfo | head -1` ($cpucount)
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
)
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) */
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");
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"
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"
337 int bootchartd_main(int argc
, char **argv
) MAIN_EXTERNALLY_VISIBLE
;
338 int bootchartd_main(int argc UNUSED_PARAM
, char **argv
)
340 unsigned sample_period_us
;
341 pid_t parent_pid
, logger_pid
;
343 int process_accounting
;
348 CMD_PID1
, /* used to mark pid 1 case */
353 parent_pid
= getpid();
355 cmd
= index_in_strings("stop\0""start\0""init\0", argv
[1]);
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
);
373 /* Here we are in START, INIT or CMD_PID1 state */
375 /* Read config file: */
376 sample_period_us
= 200 * 1000;
377 process_accounting
= 0;
378 if (ENABLE_FEATURE_BOOTCHARTD_CONFIG_FILE
) {
380 parser_t
*parser
= config_open2("/etc/bootchartd.conf" + 5, fopen_for_read
);
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)
389 process_accounting
= 1;
392 config_close(parser
);
393 if ((int)sample_period_us
<= 0)
394 sample_period_us
= 1; /* prevent division by 0 */
397 /* Create logger child: */
398 logger_pid
= fork_or_rexec(argv
);
400 if (logger_pid
== 0) { /* child */
413 /* Inform parent that we are ready */
416 /* If we are started by kernel, PATH might be unset.
417 * In order to find "tar", let's set some sane PATH:
419 if (cmd
== CMD_PID1
&& !getenv("PATH"))
420 putenv((char*)bb_PATH_root_path
);
422 tempdir
= make_tempdir();
423 do_logging(sample_period_us
, process_accounting
);
424 finalize(tempdir
, cmd
== CMD_START
? argv
[2] : NULL
, process_accounting
);
430 USE_FOR_NOMMU(argv
[0][0] &= 0x7f); /* undo fork_or_rexec() damage */
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.
437 waitpid(logger_pid
, NULL
, WUNTRACED
);
438 kill(logger_pid
, SIGCONT
);
441 if (cmd
== CMD_PID1
) {
442 char *bootchart_init
= getenv("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");
450 if (cmd
== CMD_START
&& argv
[2]) { /* "start PROG ARGS" */
451 pid_t pid
= xvfork();
452 if (pid
== 0) { /* child */
454 BB_EXECVP_or_die(argv
);
457 waitpid(pid
, NULL
, 0);
458 kill(logger_pid
, SIGUSR1
);