Add --print-stats command for machine-parsable statistics output

diff --git a/doc/MANUAL.adoc b/doc/MANUAL.adoc
index 43dd86fd5d95a5d0b09cd340a52c0e62ec9becfa..304b11cc60f35990098dfe4a290007be9e5a1a14 100644 (file)
--- a/doc/MANUAL.adoc
+++ b/doc/MANUAL.adoc
@@ -143,6 +143,11 @@ compiler options apply and you should refer to the compiler's documentation.
     stored in a configuration file in the cache directory and applies to all
     future compilations.
 
+*`--print-stats`*::
+
+    Print statistics counter IDs and corresponding values machine-parsable
+    (tab-separated) format.
+
 *`-o, --set-config`*=_KEY=VALUE_::
 
     Set configuration option _KEY_ to _VALUE_. See

diff --git a/src/ccache.c b/src/ccache.c
index 5a3f0cda74cd8a4fcd191df5ea0c3a7fe9157cc5..9f8165c4470b889143ea6476b97120b2631d1c86 100644 (file)
--- a/src/ccache.c
+++ b/src/ccache.c
@@ -82,6 +82,8 @@ static const char USAGE_TEXT[] =
        "Options for scripting or debugging:\n"
        "        --dump-manifest=PATH  dump manifest file at PATH in text format\n"
        "    -k, --get-config=K        get the value of configuration key K\n"
+       "        --print-stats         print statistics counter IDs and corresponding\n"
+       "                              values in machine-parsable format\n"
        "    -o, --set-config=K=V      set configuration item K to value V\n"
        "\n"
        "See also <https://ccache.samba.org>.\n";
@@ -3806,7 +3808,8 @@ ccache_main_options(int argc, char *argv[])
 {
        enum longopts {
                DUMP_MANIFEST,
-               HASH_FILE
+               HASH_FILE,
+               PRINT_STATS,
        };
        static const struct option options[] = {
                {"cleanup",       no_argument,       0, 'c'},
@@ -3817,6 +3820,7 @@ ccache_main_options(int argc, char *argv[])
                {"help",          no_argument,       0, 'h'},
                {"max-files",     required_argument, 0, 'F'},
                {"max-size",      required_argument, 0, 'M'},
+               {"print-stats",   no_argument,       0, PRINT_STATS},
                {"set-config",    required_argument, 0, 'o'},
                {"show-config",   no_argument,       0, 'p'},
                {"show-stats",    no_argument,       0, 's'},
@@ -3849,6 +3853,11 @@ ccache_main_options(int argc, char *argv[])
                        break;
                }
 
+               case PRINT_STATS:
+                       initialize();
+                       stats_print();
+                       break;
+
                case 'c': // --cleanup
                        initialize();
                        clean_up_all(conf);

diff --git a/src/ccache.h b/src/ccache.h
index 12d155ddcaf89cc766dda4ee57ff67cc75a6fb13..bdca4a514a0e357b04b6bb8ec9798c4c6706d1e8 100644 (file)
--- a/src/ccache.h
+++ b/src/ccache.h
@@ -218,6 +218,7 @@ void stats_flush(void);
 unsigned stats_get_pending(enum stats stat);
 void stats_zero(void);
 void stats_summary(void);
+void stats_print(void);
 void stats_update_size(int64_t size, int files);
 void stats_get_obsolete_limits(const char *dir, unsigned *maxfiles,
                                uint64_t *maxsize);

diff --git a/src/stats.c b/src/stats.c
index 5209a06034e07fa9ec3a20e80108cedeea78830c..28392f564a667528605e0296a47ef8e4cfc09cb8 100644 (file)
--- a/src/stats.c
+++ b/src/stats.c
@@ -51,180 +51,210 @@ static format_fn format_timestamp;
 // Statistics fields in display order.
 static struct {
        enum stats stat;
-       const char *message;
+       const char *id; // for --print-stats
+       const char *message; // for --show-stats
        format_fn *format_fn; // NULL -> use plain integer format
        unsigned flags;
 } stats_info[] = {
        {
                STATS_ZEROTIMESTAMP,
+               "stats_zeroed_timestamp",
                "stats zeroed",
                format_timestamp,
                FLAG_ALWAYS
        },
        {
                STATS_CACHEHIT_DIR,
+               "direct_cache_hit",
                "cache hit (direct)",
                NULL,
                FLAG_ALWAYS
        },
        {
                STATS_CACHEHIT_CPP,
+               "preprocessed_cache_hit",
                "cache hit (preprocessed)",
                NULL,
                FLAG_ALWAYS
        },
        {
                STATS_TOCACHE,
+               "cache_miss",
                "cache miss",
                NULL,
                FLAG_ALWAYS
        },
        {
                STATS_LINK,
+               "called_for_link",
                "called for link",
                NULL,
                0
        },
        {
                STATS_PREPROCESSING,
+               "called_for_preprocessing",
                "called for preprocessing",
                NULL,
                0
        },
        {
                STATS_MULTIPLE,
+               "multiple_source_files",
                "multiple source files",
                NULL,
                0
        },
        {
                STATS_STDOUT,
+               "compiler_produced_stdout",
                "compiler produced stdout",
                NULL,
                0
        },
        {
                STATS_NOOUTPUT,
+               "compiler_produced_no_output",
                "compiler produced no output",
                NULL,
                0
        },
        {
                STATS_EMPTYOUTPUT,
+               "compiler_produced_empty_output",
                "compiler produced empty output",
                NULL,
                0
        },
        {
                STATS_STATUS,
+               "compile_failed",
                "compile failed",
                NULL,
                0
        },
        {
                STATS_ERROR,
+               "internal_error",
                "ccache internal error",
                NULL,
                0
        },
        {
                STATS_PREPROCESSOR,
+               "preprocessor_error",
                "preprocessor error",
                NULL,
                0
        },
        {
                STATS_CANTUSEPCH,
+               "could_not_use_precompiled_header",
                "can't use precompiled header",
                NULL,
                0
        },
        {
                STATS_COMPILER,
+               "could_not_find_compiler",
                "couldn't find the compiler",
                NULL,
                0
        },
        {
                STATS_MISSING,
+               "missing_cache_file",
                "cache file missing",
                NULL,
                0
        },
        {
                STATS_ARGS,
+               "bad_compiler_arguments",
                "bad compiler arguments",
                NULL,
                0
        },
        {
                STATS_SOURCELANG,
+               "unsupported_source_language",
                "unsupported source language",
                NULL,
                0
        },
        {
                STATS_COMPCHECK,
+               "compiler_check_failed",
                "compiler check failed",
                NULL,
                0
        },
        {
                STATS_CONFTEST,
+               "autoconf_test",
                "autoconf compile/link",
                NULL,
                0
        },
        {
                STATS_UNSUPPORTED_OPTION,
+               "unsupported_compiler_option",
                "unsupported compiler option",
                NULL,
                0
        },
        {
                STATS_UNSUPPORTED_DIRECTIVE,
+               "unsupported_code_directive",
                "unsupported code directive",
                NULL,
                0
        },
        {
                STATS_OUTSTDOUT,
+               "output_to_stdout",
                "output to stdout",
                NULL,
                0
        },
        {
                STATS_DEVICE,
+               "output_to_a_non_file",
                "output to a non-regular file",
                NULL,
                0
        },
        {
                STATS_NOINPUT,
+               "no_input_file",
                "no input file",
                NULL,
                0
        },
        {
                STATS_BADEXTRAFILE,
+               "error_hashing_extra_file",
                "error hashing extra file",
                NULL,
                0
        },
        {
                STATS_NUMCLEANUPS,
+               "cleanups_performed",
                "cleanups performed",
                NULL,
                FLAG_ALWAYS
        },
        {
                STATS_NUMFILES,
+               "files_in_cache",
                "files in cache",
                NULL,
                FLAG_NOZERO|FLAG_ALWAYS
        },
        {
                STATS_TOTALSIZE,
+               "cache_size_kibibyte",
                "cache size",
                format_size_times_1024,
                FLAG_NOZERO|FLAG_ALWAYS
@@ -232,12 +262,14 @@ static struct {
        {
                STATS_OBSOLETE_MAXFILES,
                "OBSOLETE",
+               "OBSOLETE",
                NULL,
                FLAG_NOZERO|FLAG_NEVER
        },
        {
                STATS_OBSOLETE_MAXSIZE,
                "OBSOLETE",
+               "OBSOLETE",
                NULL,
                FLAG_NOZERO|FLAG_NEVER
        },
@@ -245,6 +277,7 @@ static struct {
                STATS_NONE,
                NULL,
                NULL,
+               NULL,
                0
        }
 };
@@ -546,6 +579,27 @@ stats_summary(void)
        counters_free(counters);
 }
 
+// Print machine-parsable (tab-separated) statistics counters.
+void
+stats_print(void)
+{
+       assert(conf);
+
+       struct counters *counters = counters_init(STATS_END);
+       time_t last_updated;
+       stats_collect(counters, &last_updated);
+
+       printf("stats_updated_timestamp\t%llu\n", (unsigned long long)last_updated);
+
+       for (int i = 0; stats_info[i].message; i++) {
+               if (!(stats_info[i].flags & FLAG_NEVER)) {
+                       printf("%s\t%u\n", stats_info[i].id, counters->data[stats_info[i].stat]);
+               }
+       }
+
+       counters_free(counters);
+}
+
 // Zero all the stats structures.
 void
 stats_zero(void)