always output array without --human
v2 cover always output array without --human
If "ndctl list" is only printing a single object it currently does not print it in an array. When printing multiple objects, though, an array is used. This simplifies the output for single objects when a human is looking at it but it creates complications for parsers like jq. jq wants to know whether it is trying to parse an object or an array of objects.
The first patch in this series is cleanup I noticed while fixing the above issue with the second patch.
---
Changes since v1:
* Dropped patch 2 that dealt with cleaning up the way flags are handled in ndctl/list.c. (Dan)
* Added Dan's Ack to patch 1.
Ross Zwisler (2):
ndctl: simplify JSON print flag handling
ndctl list: always output array without --human
daxctl/list.c | 12 +++++++----- ndctl/bus.c | 3 +-- ndctl/dimm.c | 3 +-- ndctl/inject-smart.c | 3 +-- ndctl/list.c | 11 +++++------ util/json.c | 6 ++++-- util/json.h | 3 ++- 7 files changed, 21 insertions(+), 20 deletions(-)
Signature · 6 lines
2.14.4 _______________________________________________ Linux-nvdimm mailing list [email protected] https://lists.01.org/mailman/listinfo/linux-nvdimm
PATCH v2 1/2 ndctl: simplify JSON print flag handling
json_object_to_json_string_ext()'s second argument is a flags field which we always want to be JSON_C_TO_STRING_PRETTY. We were going to a lot of trouble for this, though. We had multiple variables set to be this one flag and util_display_json_array() took it as an argument, even though it never varied.
Instead, just pass in the necessary flag when calling json_object_to_json_string_ext(), removing the local variables and the extra argument to util_display_json_array().
--- daxctl/list.c | 5 ++--- ndctl/bus.c | 3 +-- ndctl/dimm.c | 3 +-- ndctl/inject-smart.c | 3 +-- ndctl/list.c | 11 +++++------ util/json.c | 3 ++- util/json.h | 2 +- 7 files changed, 13 insertions(+), 17 deletions(-)
daxctl/list.c +2 -3
@@ -50,7 +50,6 @@ static struct { };static int did_fail; -static int jflag =JSON_C_TO_STRING_PRETTY ;#define fail (fmt, ...) \ do { \
@@ -130,9 +129,9 @@ int cmd_list(int argc, const char **argv, void *ctx) }if (jregions) -util_display_json_array (stdout, jregions, jflag); +util_display_json_array (stdout, jregions);else if (jdevs) -util_display_json_array (stdout, jdevs, jflag); +util_display_json_array (stdout, jdevs);if (did_fail)return -ENOMEM ;
ndctl/bus.c +1 -2
@@ -88,8 +88,7 @@ static int bus_action(int argc, const char **argv, const char *usage, }if (success) -util_display_json_array (stdout, jbuses, -JSON_C_TO_STRING_PRETTY ); +util_display_json_array (stdout, jbuses);else json_object_put (jbuses);
ndctl/dimm.c +1 -2
@@ -1081,8 +1081,7 @@ static int dimm_action(int argc, const char **argv, void *ctx, }if (actx.jdimms) -util_display_json_array (actx.f_out, actx.jdimms, -JSON_C_TO_STRING_PRETTY ); +util_display_json_array (actx.f_out, actx.jdimms);if (actx.f_out != stdout)fclose (actx.f_out);
ndctl/inject-smart.c +1 -2
@@ -375,8 +375,7 @@ static int dimm_inject_smart(struct ndctl_dimm *dimm) jhealth =util_dimm_health_to_json (dimm);if (jhealth) {json_object_object_add (jdimm,"health" , jhealth); -util_display_json_array (stdout, jdimms, -JSON_C_TO_STRING_PRETTY ); +util_display_json_array (stdout, jdimms); } } out:
ndctl/list.c +5 -6
@@ -56,7 +56,6 @@ static unsigned long listopts_to_flags(void)struct util_filter_params param;static int did_fail; -static int jflag =JSON_C_TO_STRING_PRETTY ;#define fail (fmt, ...) \ do { \
@@ -380,7 +379,7 @@ static int list_display(struct list_filter_arg *lfa)struct json_object *jbuses = lfa->jbuses;if (jbuses) -util_display_json_array (stdout, jbuses, jflag); +util_display_json_array (stdout, jbuses);else if ((!!jdimms + !!jregions + !!jnamespaces) >1 ) {struct json_object *jplatform =json_object_new_object ();
@@ -397,14 +396,14 @@ static int list_display(struct list_filter_arg *lfa)json_object_object_add (jplatform,"namespaces" , jnamespaces);printf ("%s\n" ,json_object_to_json_string_ext (jplatform, - jflag)); +JSON_C_TO_STRING_PRETTY ));json_object_put (jplatform); }else if (jdimms) -util_display_json_array (stdout, jdimms, jflag); +util_display_json_array (stdout, jdimms);else if (jregions) -util_display_json_array (stdout, jregions, jflag); +util_display_json_array (stdout, jregions);else if (jnamespaces) -util_display_json_array (stdout, jnamespaces, jflag); +util_display_json_array (stdout, jnamespaces);return 0 ; }
util/json.c +2 -1
@@ -105,9 +105,10 @@ struct json_object *util_json_object_hex(unsigned long long val,return jobj; } -void util_display_json_array (FILE *f_out,struct json_object *jarray,int jflag) +void util_display_json_array (FILE *f_out,struct json_object *jarray) {int len =json_object_array_length (jarray); +int jflag =JSON_C_TO_STRING_PRETTY ;if (json_object_array_length (jarray) >1 )fprintf (f_out,"%s\n" ,json_object_to_json_string_ext (jarray, jflag));
util/json.h +1 -1
@@ -26,7 +26,7 @@ enum util_json_flags { };struct json_object ; -void util_display_json_array (FILE *f_out,struct json_object *jarray,int jflag); +void util_display_json_array (FILE *f_out,struct json_object *jarray);struct json_object *util_bus_to_json (struct ndctl_bus *bus);struct json_object *util_dimm_to_json (struct ndctl_dimm *dimm,unsigned long flags);
Signature · 6 lines
2.14.4 _______________________________________________ Linux-nvdimm mailing list [email protected] https://lists.01.org/mailman/listinfo/linux-nvdimm
PATCH v2 2/2 ndctl list: always output array without --human
In reply to Ross ZwislerIf "ndctl list" is only printing a single object it currently does not print it in an array. When printing multiple objects, though, an array is used. This simplifies the output for single objects when a human is looking at it but it creates complications for parsers like jq. jq wants to know whether it is trying to parse an object or an array of objects.
For example, here's how you print just the mode of a single namespace:
# ndctl list -n namespace1.0 | jq ".mode" "raw"
This works on a single object. If you have multiple objects in a JSON array you do this:
# ndctl list | jq -r '(.[]) | .mode' raw raw
If you want to write a generic script that works in both cases you have to do something quite complicated like:
# ndctl list | jq -r '((. | arrays | .[]), . | objects | .mode)' raw raw
Instead of pushing the burden on the user, have ndctl output consistently be an array even if there is only one element. This allows the parsing code to be simpler and only worry about one case.
If the user specifies the --human or -u flags we will assume that a person is looking at the output and not a script and will continue to output a single element which is not part of an array.
--- daxctl/list.c | 11 +++++++---- ndctl/bus.c | 2 +- ndctl/dimm.c | 2 +- ndctl/inject-smart.c | 2 +- ndctl/list.c | 8 ++++---- util/json.c | 5 +++-- util/json.h | 3 ++- 7 files changed, 19 insertions(+), 14 deletions(-)
daxctl/list.c +7 -4
@@ -83,6 +83,7 @@ int cmd_list(int argc, const char **argv, void *ctx)struct json_object *jregions =NULL ;struct json_object *jdevs =NULL ;struct daxctl_region *region; +unsigned long list_flags;int i; argc =parse_options (argc, argv, options, u,0 );
@@ -100,6 +101,8 @@ int cmd_list(int argc, const char **argv, void *ctx)if (num_list_flags () ==0 ) list.devs = true; + list_flags =listopts_to_flags (); + daxctl_region_foreach(ctx, region) {struct json_object *jregion =NULL ;
@@ -117,7 +120,7 @@ int cmd_list(int argc, const char **argv, void *ctx) } jregion =util_daxctl_region_to_json (region, - param.dev,listopts_to_flags ()); + param.dev, list_flags);if (!jregion) {fail ("\n" );continue ;
@@ -125,13 +128,13 @@ int cmd_list(int argc, const char **argv, void *ctx)json_object_array_add (jregions, jregion); }else if (list.devs) jdevs =util_daxctl_devs_to_list (region, jdevs, - param.dev,listopts_to_flags ()); + param.dev, list_flags); }if (jregions) -util_display_json_array (stdout, jregions); +util_display_json_array (stdout, jregions, list_flags);else if (jdevs) -util_display_json_array (stdout, jdevs); +util_display_json_array (stdout, jdevs, list_flags);if (did_fail)return -ENOMEM ;
ndctl/bus.c +1 -1
@@ -88,7 +88,7 @@ static int bus_action(int argc, const char **argv, const char *usage, }if (success) -util_display_json_array (stdout, jbuses); +util_display_json_array (stdout, jbuses,0 );else json_object_put (jbuses);
ndctl/dimm.c +1 -1
@@ -1081,7 +1081,7 @@ static int dimm_action(int argc, const char **argv, void *ctx, }if (actx.jdimms) -util_display_json_array (actx.f_out, actx.jdimms); +util_display_json_array (actx.f_out, actx.jdimms,0 );if (actx.f_out != stdout)fclose (actx.f_out);
ndctl/inject-smart.c +1 -1
@@ -375,7 +375,7 @@ static int dimm_inject_smart(struct ndctl_dimm *dimm) jhealth =util_dimm_health_to_json (dimm);if (jhealth) {json_object_object_add (jdimm,"health" , jhealth); -util_display_json_array (stdout, jdimms); +util_display_json_array (stdout, jdimms, sctx.flags); } } out:
ndctl/list.c +4 -4
@@ -379,7 +379,7 @@ static int list_display(struct list_filter_arg *lfa)struct json_object *jbuses = lfa->jbuses;if (jbuses) -util_display_json_array (stdout, jbuses); +util_display_json_array (stdout, jbuses, lfa->flags);else if ((!!jdimms + !!jregions + !!jnamespaces) >1 ) {struct json_object *jplatform =json_object_new_object ();
@@ -399,11 +399,11 @@ static int list_display(struct list_filter_arg *lfa) JSON_C_TO_STRING_PRETTY));json_object_put (jplatform); }else if (jdimms) -util_display_json_array (stdout, jdimms); +util_display_json_array (stdout, jdimms, lfa->flags);else if (jregions) -util_display_json_array (stdout, jregions); +util_display_json_array (stdout, jregions, lfa->flags);else if (jnamespaces) -util_display_json_array (stdout, jnamespaces); +util_display_json_array (stdout, jnamespaces, lfa->flags);return 0 ; }
util/json.c +3 -2
@@ -105,12 +105,13 @@ struct json_object *util_json_object_hex(unsigned long long val,return jobj; } -void util_display_json_array (FILE *f_out,struct json_object *jarray) +void util_display_json_array (FILE *f_out,struct json_object *jarray, +unsigned long flags) {int len =json_object_array_length (jarray);int jflag =JSON_C_TO_STRING_PRETTY ; -if (json_object_array_length (jarray) >1 ) +if (json_object_array_length (jarray) >1 || !(flags &UTIL_JSON_HUMAN ))fprintf (f_out,"%s\n" ,json_object_to_json_string_ext (jarray, jflag));else if (len) {struct json_object *jobj;
util/json.h +2 -1
@@ -26,7 +26,8 @@ enum util_json_flags { };struct json_object ; -void util_display_json_array (FILE *f_out,struct json_object *jarray); +void util_display_json_array (FILE *f_out,struct json_object *jarray, +unsigned long flags);struct json_object *util_bus_to_json (struct ndctl_bus *bus);struct json_object *util_dimm_to_json (struct ndctl_dimm *dimm,unsigned long flags);
Signature · 6 lines
2.14.4 _______________________________________________ Linux-nvdimm mailing list [email protected] https://lists.01.org/mailman/listinfo/linux-nvdimm