lscpu: add --hierarchic

Fixes: https://github.com/util-linux/util-linux/issues/1735
Signed-off-by: Karel Zak <kzak@redhat.com>

diff --git a/sys-utils/lscpu.1.adoc b/sys-utils/lscpu.1.adoc
index 88a999e92439f986324c85544f905367d73fb50e..4b55bcfe751b3029a02c77c2deceec4d9912b2dd 100644 (file)
--- a/sys-utils/lscpu.1.adoc
+++ b/sys-utils/lscpu.1.adoc
@@ -51,6 +51,9 @@ The default list of columns may be extended if list is specified in the format +
 *-c*, *--offline*::
 Limit the output to offline CPUs. This option may only be specified together with option *-e* or *-p*.
 
+*--hierarchic*[=_when_]::
+Use subsections in summary output. For backward compatibility, the default is to use subsections only when output on a terminal and flattened output on a non-terminal. The optional argument _when_ can be *never*, *always* or *auto*. If the _when_ argument is omitted, it defaults to "always".
+
 *-e*, *--extended*[=_list_]::
 Display the CPU information in human-readable format.
 +
@@ -61,7 +64,10 @@ When specifying the _list_ argument, the string of option, equal sign (=), and _
 The default list of columns may be extended if list is specified in the format +list (e.g., lscpu -e=+MHZ).
 
 *-J*, *--json*::
-Use JSON output format for the default summary or extended output (see *--extended*).
+Use JSON output format for the default summary or extended output (see
+*--extended*).  For backward compatibility, JSON output follows the default
+summary behavior for non-terminals (e.g., pipes) where subsections are missing. See
+also *--hierarchic*.
 
 *-p*, *--parse*[=_list_]::
 Optimize the command output for easy parsing.

diff --git a/sys-utils/lscpu.c b/sys-utils/lscpu.c
index 018ab601498e9200bc8526105d4ceda0b879cad0..0b9b59cc98ffd88a009dd023d7bb76e2389cf592 100644 (file)
--- a/sys-utils/lscpu.c
+++ b/sys-utils/lscpu.c
@@ -172,7 +172,7 @@ static struct lscpu_coldesc coldescs_cache[] =
        [COL_CACHE_COHERENCYSIZE] = { "COHERENCY-SIZE", N_("minimum amount of data in bytes transferred from memory to cache"), SCOLS_FL_RIGHT, 0, SCOLS_JSON_NUMBER }
 };
 
-static int is_term = 0;
+static int hierarchic = -1;
 
 UL_DEBUG_DEFINE_MASK(lscpu);
 UL_DEBUG_DEFINE_MASKNAMES(lscpu) = UL_DEBUG_EMPTY_MASKNAMES;
@@ -799,8 +799,8 @@ static struct libscols_line *
        struct libscols_line *ln;
        va_list args;
 
-       /* Don't print section lines without data on non-terminal output */
-       if (!is_term && fmt == NULL)
+       /* Don't print section lines without data */
+       if (!hierarchic && fmt == NULL)
                return NULL;
 
        ln = scols_table_new_line(tb, sec);
@@ -955,7 +955,7 @@ static void print_summary(struct lscpu_cxt *cxt)
        if (cxt->json) {
                scols_table_enable_json(tb, 1);
                scols_table_set_name(tb, "lscpu");
-       } else if (is_term) {
+       } else if (hierarchic) {
                struct libscols_symbols *sy = scols_new_symbols();
 
                if (!sy)
@@ -967,7 +967,7 @@ static void print_summary(struct lscpu_cxt *cxt)
                scols_unref_symbols(sy);
        }
 
-       if (scols_table_new_column(tb, "field", 0, is_term ? SCOLS_FL_TREE : 0) == NULL ||
+       if (scols_table_new_column(tb, "field", 0, hierarchic ? SCOLS_FL_TREE : 0) == NULL ||
            scols_table_new_column(tb, "data", 0, SCOLS_FL_NOEXTREMES | SCOLS_FL_WRAP) == NULL)
                err(EXIT_FAILURE, _("failed to initialize output column"));
 
@@ -1080,7 +1080,7 @@ static void print_summary(struct lscpu_cxt *cxt)
                                hdr_caches = 1;
                        }
 
-                       snprintf(field, sizeof(field), is_term ? _("%s:") : _("%s cache:"), name);
+                       snprintf(field, sizeof(field), hierarchic ? _("%s:") : _("%s cache:"), name);
                        if (cxt->bytes)
                                add_summary_sprint(tb, sec, field,
                                                P_("%" PRIu64 " (%d instance)",
@@ -1110,7 +1110,7 @@ static void print_summary(struct lscpu_cxt *cxt)
                        sec = add_summary_e(tb, NULL, _("Caches:"));
                        hdr_caches = 1;
                }
-               snprintf(field, sizeof(field), is_term ? _("%s:") : _("%s cache:"), ca->name);
+               snprintf(field, sizeof(field), hierarchic ? _("%s:") : _("%s cache:"), ca->name);
                if (cxt->bytes)
                        add_summary_x(tb, sec, field, "%" PRIu64, ca->size);
                else {
@@ -1141,7 +1141,7 @@ static void print_summary(struct lscpu_cxt *cxt)
                sec = add_summary_e(tb, NULL, _("Vulnerabilities:"));
 
                for (i = 0; i < cxt->nvuls; i++) {
-                       snprintf(field, sizeof(field), is_term ?
+                       snprintf(field, sizeof(field), hierarchic ?
                                        _("%s:") : _("Vulnerability %s:"), cxt->vuls[i].name);
                        add_summary_s(tb, sec, field, cxt->vuls[i].text);
                }
@@ -1174,6 +1174,7 @@ static void __attribute__((__noreturn__)) usage(void)
        fputs(_(" -s, --sysroot <dir>     use specified directory as system root\n"), out);
        fputs(_(" -x, --hex               print hexadecimal masks rather than lists of CPUs\n"), out);
        fputs(_(" -y, --physical          print physical instead of logical IDs\n"), out);
+       fputs(_("     --hierarchic[=when] use subsections in summary (auto, never, always)\n"), out);
        fputs(_("     --output-all        print all available columns for -e, -p or -C\n"), out);
        fputs(USAGE_SEPARATOR, out);
        printf(USAGE_HELP_OPTIONS(25));
@@ -1201,6 +1202,7 @@ int main(int argc, char *argv[])
        size_t i, ncolumns = 0;
        enum {
                OPT_OUTPUT_ALL = CHAR_MAX + 1,
+               OPT_HIERARCHIC,
        };
        static const struct option longopts[] = {
                { "all",        no_argument,       NULL, 'a' },
@@ -1217,6 +1219,7 @@ int main(int argc, char *argv[])
                { "hex",        no_argument,       NULL, 'x' },
                { "version",    no_argument,       NULL, 'V' },
                { "output-all", no_argument,       NULL, OPT_OUTPUT_ALL },
+               { "hierarchic", optional_argument, NULL, OPT_HIERARCHIC },
                { NULL,         0, NULL, 0 }
        };
 
@@ -1287,7 +1290,19 @@ int main(int argc, char *argv[])
                case OPT_OUTPUT_ALL:
                        all = 1;
                        break;
-
+               case OPT_HIERARCHIC:
+                       if (optarg) {
+                               if (strcmp(optarg, "auto") == 0)
+                                       hierarchic = -1;
+                               else if (strcmp(optarg, "never") == 0)
+                                       hierarchic = 0;
+                               else if (strcmp(optarg, "always") == 0)
+                                       hierarchic = 1;
+                               else
+                                       errx(EXIT_FAILURE, _("unsupported --flat argument"));
+                       } else
+                               hierarchic = 1;
+                       break;
                case 'h':
                        usage();
                case 'V':
@@ -1325,7 +1340,6 @@ int main(int argc, char *argv[])
                cxt->show_offline = cxt->mode == LSCPU_OUTPUT_READABLE ? 1 : 0;
        }
 
-       is_term = isatty(STDOUT_FILENO);        /* global variable */
 
        lscpu_init_debug();
 
@@ -1344,6 +1358,9 @@ int main(int argc, char *argv[])
 
        cxt->virt = lscpu_read_virtualization(cxt);
 
+       if (hierarchic == -1)
+               hierarchic = isatty(STDOUT_FILENO);     /* default */
+
        switch(cxt->mode) {
        case LSCPU_OUTPUT_SUMMARY:
                print_summary(cxt);