chiark / gitweb /
bootchart: rename --filter to --no-filter
[elogind.git] / src / bootchart / bootchart.c
index 3d77bab129f5565c7bdb0f38fdcd027a78b81b0f..af573da0f238469c90b823217678f546c81ab4e7 100644 (file)
@@ -1,21 +1,40 @@
-/*
- * bootchart.c
- *
- * Copyright (C) 2009-2012 Intel Coproration
- *
- * Authors:
- *   Auke Kok <auke-jan.h.kok@intel.com>
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; version 2
- * of the License.
- */
+/***
+  bootchart.c - This file is part of systemd-bootchart
 
+  Copyright (C) 2009-2013 Intel Coproration
+
+  Authors:
+    Auke Kok <auke-jan.h.kok@intel.com>
+
+  systemd is free software; you can redistribute it and/or modify it
+  under the terms of the GNU Lesser General Public License as published by
+  the Free Software Foundation; either version 2.1 of the License, or
+  (at your option) any later version.
+
+  systemd is distributed in the hope that it will be useful, but
+  WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public License
+  along with systemd; If not, see <http://www.gnu.org/licenses/>.
+ ***/
+
+/***
+
+  Many thanks to those who contributed ideas and code:
+  - Ziga Mahkovec - Original bootchart author
+  - Anders Norgaard - PyBootchartgui
+  - Michael Meeks - bootchart2
+  - Scott James Remnant - Ubuntu C-based logger
+  - Arjan van der Ven - for the idea to merge bootgraph.pl functionality
+
+ ***/
 
 #include <sys/time.h>
 #include <sys/types.h>
 #include <sys/resource.h>
+#include <sys/stat.h>
 #include <stdio.h>
 #include <signal.h>
 #include <stdlib.h>
 #include <getopt.h>
 #include <limits.h>
 #include <errno.h>
+#include <fcntl.h>
+#include <stdbool.h>
 
 
 #include "bootchart.h"
+#include "util.h"
+#include "fileio.h"
+#include "macro.h"
+#include "conf-parser.h"
+#include "strxcpyx.h"
+#include "path-util.h"
 
 double graph_start;
 double log_start;
@@ -39,16 +66,17 @@ struct cpu_stat_struct cpustat[MAXCPUS];
 int pscount;
 int cpus;
 double interval;
-FILE *of;
+FILE *of = NULL;
 int overrun = 0;
 static int exiting = 0;
+int sysfd=-1;
 
 /* graph defaults */
-int entropy = 0;
-int initcall = 1;
-int relative;
-int filter = 1;
-int pss = 0;
+bool entropy = false;
+bool initcall = true;
+bool relative = false;
+bool filter = true;
+bool pss = false;
 int samples;
 int len = 500; /* we record len+1 (1 start sample) */
 double hz = 25.0;   /* 20 seconds log time */
@@ -56,7 +84,7 @@ double scale_x = 100.0; /* 100px = 1sec */
 double scale_y = 20.0;  /* 16px = 1 process bar */
 
 char init_path[PATH_MAX] = "/sbin/init";
-char output_path[PATH_MAX] = "/var/log";
+char output_path[PATH_MAX] = "/run/log";
 
 static struct rlimit rlim;
 
@@ -70,82 +98,62 @@ static void signal_handler(int sig)
 
 int main(int argc, char *argv[])
 {
+        _cleanup_free_ char *build = NULL;
         struct sigaction sig;
         struct ps_struct *ps;
         char output_file[PATH_MAX];
         char datestr[200];
-        time_t t;
-        FILE *f;
+        time_t t = 0;
+        const char *fn;
+        _cleanup_fclose_ FILE *f;
         int gind;
-        int i;
-
-        memset(&t, 0, sizeof(time_t));
+        int i, r;
+        char *init = NULL, *output = NULL;
+
+        const ConfigTableItem items[] = {
+                { "Bootchart", "Samples",          config_parse_int,    0, &len      },
+                { "Bootchart", "Frequency",        config_parse_double, 0, &hz       },
+                { "Bootchart", "Relative",         config_parse_bool,   0, &relative },
+                { "Bootchart", "Filter",           config_parse_bool,   0, &filter   },
+                { "Bootchart", "Output",           config_parse_path,   0, &output   },
+                { "Bootchart", "Init",             config_parse_path,   0, &init     },
+                { "Bootchart", "PlotMemoryUsage",  config_parse_bool,   0, &pss      },
+                { "Bootchart", "PlotEntropyGraph", config_parse_bool,   0, &entropy  },
+                { "Bootchart", "ScaleX",           config_parse_double, 0, &scale_x  },
+                { "Bootchart", "ScaleY",           config_parse_double, 0, &scale_y  },
+                { NULL, NULL, NULL, 0, NULL }
+        };
 
         rlim.rlim_cur = 4096;
         rlim.rlim_max = 4096;
         (void) setrlimit(RLIMIT_NOFILE, &rlim);
 
-        f = fopen("/etc/systemd/bootchart.conf", "r");
+        fn = "/etc/systemd/bootchart.conf";
+        f = fopen(fn, "re");
         if (f) {
-                char buf[256];
-                char *key;
-                char *val;
-
-                while (fgets(buf, 80, f) != NULL) {
-                        char *c;
-
-                        c = strchr(buf, '\n');
-                        if (c) *c = 0; /* remove trailing \n */
-
-                        if (buf[0] == '#')
-                                continue; /* comment line */
-
-                        key = strtok(buf, "=");
-                        if (!key)
-                                continue;
-                        val = strtok(NULL, "=");
-                        if (!val)
-                                continue;
-
-                        // todo: filter leading/trailing whitespace
-
-                        if (!strcmp(key, "samples"))
-                                len = atoi(val);
-                        if (!strcmp(key, "freq"))
-                                hz = atof(val);
-                        if (!strcmp(key, "rel"))
-                                relative = atoi(val);
-                        if (!strcmp(key, "filter"))
-                                filter = atoi(val);
-                        if (!strcmp(key, "pss"))
-                                pss = atoi(val);
-                        if (!strcmp(key, "output"))
-                                strncpy(output_path, val, PATH_MAX - 1);
-                        if (!strcmp(key, "init"))
-                                strncpy(init_path, val, PATH_MAX - 1);
-                        if (!strcmp(key, "scale_x"))
-                                scale_x = atof(val);
-                        if (!strcmp(key, "scale_y"))
-                                scale_y = atof(val);
-                        if (!strcmp(key, "entropy"))
-                                entropy = atoi(val);
-                }
-                fclose(f);
+            r = config_parse(fn, f, NULL, config_item_table_lookup, (void*) items, true, NULL);
+            if (r < 0)
+                    log_warning("Failed to parse configuration file: %s", strerror(-r));
+
+            if (init != NULL)
+                    strscpy(init_path, sizeof(init_path), init);
+            if (output != NULL)
+                    strscpy(output_path, sizeof(output_path), output);
         }
 
         while (1) {
                 static struct option opts[] = {
-                        {"rel", 0, NULL, 'r'},
-                        {"freq", 1, NULL, 'f'},
-                        {"samples", 1, NULL, 'n'},
-                        {"pss", 0, NULL, 'p'},
-                        {"output", 1, NULL, 'o'},
-                        {"init", 1, NULL, 'i'},
-                        {"filter", 0, NULL, 'F'},
-                        {"help", 0, NULL, 'h'},
-                        {"scale-x", 1, NULL, 'x'},
-                        {"scale-y", 1, NULL, 'y'},
-                        {"entropy", 0, NULL, 'e'},
+                        {"rel",       no_argument,        NULL,  'r'},
+                        {"freq",      required_argument,  NULL,  'f'},
+                        {"samples",   required_argument,  NULL,  'n'},
+                        {"pss",       no_argument,        NULL,  'p'},
+                        {"output",    required_argument,  NULL,  'o'},
+                        {"init",      required_argument,  NULL,  'i'},
+                        {"no-filter", no_argument,        NULL,  'F'},
+                        {"help",      no_argument,        NULL,  'h'},
+                        {"scale-x",   required_argument,  NULL,  'x'},
+                        {"scale-y",   required_argument,  NULL,  'y'},
+                        {"entropy",   no_argument,        NULL,  'e'},
                         {NULL, 0, NULL, 0}
                 };
 
@@ -156,50 +164,64 @@ int main(int argc, char *argv[])
                         break;
                 switch (i) {
                 case 'r':
-                        relative = 1;
+                        relative = true;
                         break;
                 case 'f':
-                        hz = atof(optarg);
+                        r = safe_atod(optarg, &hz);
+                        if (r < 0)
+                                log_warning("failed to parse --freq/-f argument '%s': %s",
+                                            optarg, strerror(-r));
                         break;
                 case 'F':
-                        filter = 0;
+                        filter = false;
                         break;
                 case 'n':
-                        len = atoi(optarg);
+                        r = safe_atoi(optarg, &len);
+                        if (r < 0)
+                                log_warning("failed to parse --samples/-n argument '%s': %s",
+                                            optarg, strerror(-r));
                         break;
                 case 'o':
-                        strncpy(output_path, optarg, PATH_MAX - 1);
+                        path_kill_slashes(optarg);
+                        strscpy(output_path, sizeof(output_path), optarg);
                         break;
                 case 'i':
-                        strncpy(init_path, optarg, PATH_MAX - 1);
+                        path_kill_slashes(optarg);
+                        strscpy(init_path, sizeof(init_path), optarg);
                         break;
                 case 'p':
-                        pss = 1;
+                        pss = true;
                         break;
                 case 'x':
-                        scale_x = atof(optarg);
+                        r = safe_atod(optarg, &scale_x);
+                        if (r < 0)
+                                log_warning("failed to parse --scale-x/-x argument '%s': %s",
+                                            optarg, strerror(-r));
                         break;
                 case 'y':
-                        scale_y = atof(optarg);
+                        r = safe_atod(optarg, &scale_y);
+                        if (r < 0)
+                                log_warning("failed to parse --scale-y/-y argument '%s': %s",
+                                            optarg, strerror(-r));
                         break;
                 case 'e':
-                        entropy = 1;
+                        entropy = true;
                         break;
                 case 'h':
                         fprintf(stderr, "Usage: %s [OPTIONS]\n", argv[0]);
-                        fprintf(stderr, " --rel,     -r            Record time relative to recording\n");
-                        fprintf(stderr, " --freq,    -f N          Sample frequency [%f]\n", hz);
-                        fprintf(stderr, " --samples, -n N          Stop sampling at [%d] samples\n", len);
-                        fprintf(stderr, " --scale-x, -x N          Scale the graph horizontally [%f] \n", scale_x);
-                        fprintf(stderr, " --scale-y, -y N          Scale the graph vertically [%f] \n", scale_y);
-                        fprintf(stderr, " --pss,     -p            Enable PSS graph (CPU intensive)\n");
-                        fprintf(stderr, " --entropy, -e            Enable the entropy_avail graph\n");
-                        fprintf(stderr, " --output,  -o [PATH]     Path to output files [%s]\n", output_path);
-                        fprintf(stderr, " --init,    -i [PATH]     Path to init executable [%s]\n", init_path);
-                        fprintf(stderr, " --filter,  -F            Disable filtering of processes from the graph\n");
+                        fprintf(stderr, " --rel,       -r          Record time relative to recording\n");
+                        fprintf(stderr, " --freq,      -f f        Sample frequency [%f]\n", hz);
+                        fprintf(stderr, " --samples,   -n N        Stop sampling at [%d] samples\n", len);
+                        fprintf(stderr, " --scale-x,   -x N        Scale the graph horizontally [%f] \n", scale_x);
+                        fprintf(stderr, " --scale-y,   -y N        Scale the graph vertically [%f] \n", scale_y);
+                        fprintf(stderr, " --pss,       -p          Enable PSS graph (CPU intensive)\n");
+                        fprintf(stderr, " --entropy,   -e          Enable the entropy_avail graph\n");
+                        fprintf(stderr, " --output,    -o [PATH]   Path to output files [%s]\n", output_path);
+                        fprintf(stderr, " --init,      -i [PATH]   Path to init executable [%s]\n", init_path);
+                        fprintf(stderr, " --no-filter, -F          Disable filtering of processes from the graph\n");
                         fprintf(stderr, "                          that are of less importance or short-lived\n");
-                        fprintf(stderr, " --help,    -h            Display this message\n");
-                        fprintf(stderr, "See the installed README and bootchartd.conf.example for more information.\n");
+                        fprintf(stderr, " --help,      -h          Display this message\n");
+                        fprintf(stderr, "See bootchart.conf for more information.\n");
                         exit (EXIT_SUCCESS);
                         break;
                 default:
@@ -218,7 +240,7 @@ int main(int argc, char *argv[])
         }
 
         /*
-         * If the kernel executed us through init=/sbin/bootchartd, then
+         * If the kernel executed us through init=/usr/lib/systemd/systemd-bootchart, then
          * fork:
          * - parent execs executable specified via init_path[] (/sbin/init by default) as pid=1
          * - child logs data
@@ -229,14 +251,14 @@ int main(int argc, char *argv[])
                         execl(init_path, init_path, NULL);
                 }
         }
+        argv[0][0] = '@';
 
         /* start with empty ps LL */
-        ps_first = malloc(sizeof(struct ps_struct));
+        ps_first = calloc(1, sizeof(struct ps_struct));
         if (!ps_first) {
-                perror("malloc(ps_struct)");
+                perror("calloc(ps_struct)");
                 exit(EXIT_FAILURE);
         }
-        memset(ps_first, 0, sizeof(struct ps_struct));
 
         /* handle TERM/INT nicely */
         memset(&sig, 0, sizeof(struct sigaction));
@@ -259,6 +281,23 @@ int main(int argc, char *argv[])
 
                 sampletime[samples] = gettime_ns();
 
+                if (!of && (access(output_path, R_OK|W_OK|X_OK) == 0)) {
+                        t = time(NULL);
+                        strftime(datestr, sizeof(datestr), "%Y%m%d-%H%M", localtime(&t));
+                        snprintf(output_file, PATH_MAX, "%s/bootchart-%s.svg", output_path, datestr);
+                        of = fopen(output_file, "w");
+                }
+
+                if (sysfd < 0) {
+                        sysfd = open("/sys", O_RDONLY);
+                }
+
+                if (!build) {
+                        parse_env_file("/etc/os-release", NEWLINE,
+                                       "PRETTY_NAME", &build,
+                                       NULL);
+                }
+
                 /* wait for /proc to become available, discarding samples */
                 if (!(graph_start > 0.0))
                         log_uptime();
@@ -316,23 +355,27 @@ int main(int argc, char *argv[])
                 if (ps->smaps)
                         fclose(ps->smaps);
         }
-        closedir(proc);
 
-        t = time(NULL);
-        strftime(datestr, sizeof(datestr), "%Y%m%d-%H%M", localtime(&t));
-        snprintf(output_file, PATH_MAX, "%s/bootchart-%s.svg", output_path, datestr);
+        if (!of) {
+                t = time(NULL);
+                strftime(datestr, sizeof(datestr), "%Y%m%d-%H%M", localtime(&t));
+                snprintf(output_file, PATH_MAX, "%s/bootchart-%s.svg", output_path, datestr);
+                of = fopen(output_file, "w");
+        }
 
-        of = fopen(output_file, "w");
         if (!of) {
-                perror("open output_file");
+                fprintf(stderr, "opening output file '%s': %m\n", output_file);
                 exit (EXIT_FAILURE);
         }
 
-        svg_do();
+        svg_do(build);
 
-        fprintf(stderr, "bootchartd: Wrote %s\n", output_file);
+        fprintf(stderr, "systemd-bootchart wrote %s\n", output_file);
         fclose(of);
 
+        closedir(proc);
+        close(sysfd);
+
         /* nitpic cleanups */
         ps = ps_first;
         while (ps->next_ps) {
@@ -346,7 +389,7 @@ int main(int argc, char *argv[])
 
         /* don't complain when overrun once, happens most commonly on 1st sample */
         if (overrun > 1)
-                fprintf(stderr, "bootchartd: Warning: sample time overrun %i times\n", overrun);
+                fprintf(stderr, "systemd-boochart: Warning: sample time overrun %i times\n", overrun);
 
         return 0;
 }