| lists.openwall.net | lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC | |
|
Open Source and information security mailing list archives
| ||
|
Message-ID: <CAM_1_KzV_sYLiUY9QqXbM_NrkNU9Na-vwQeNcBFQ2V=rF6o6zA@mail.gmail.com>
Date: Thu, 21 Sep 2017 10:47:41 -0700
From: Julien Fortin <julien@...ulusnetworks.com>
To: Daniel Borkmann <daniel@...earbox.net>
Cc: Stephen Hemminger <stephen@...workplumber.org>, ast@...com,
netdev@...r.kernel.org
Subject: Re: [PATCH iproute2 master 1/2] json: move json printer to common library
On Thu, Sep 21, 2017 at 1:42 AM, Daniel Borkmann <daniel@...earbox.net> wrote:
> Move the json printer which is based on json writer into the
> iproute2 library, so it can be used by library code and tools
> other than ip. Should probably have been done from the beginning
> like that given json writer is in the library already anyway.
> No functional changes.
>
> Signed-off-by: Daniel Borkmann <daniel@...earbox.net>
Acked-by: Julien Fortin <julien@...ulusnetworks.com>
> ---
> include/json_print.h | 71 ++++++++++++++++
> ip/Makefile | 2 +-
> ip/ip_common.h | 65 ++------------
> ip/ip_print.c | 233 ---------------------------------------------------
> lib/Makefile | 2 +-
> lib/json_print.c | 231 ++++++++++++++++++++++++++++++++++++++++++++++++++
> 6 files changed, 312 insertions(+), 292 deletions(-)
> create mode 100644 include/json_print.h
> delete mode 100644 ip/ip_print.c
> create mode 100644 lib/json_print.c
>
> diff --git a/include/json_print.h b/include/json_print.h
> new file mode 100644
> index 0000000..44cf5ac
> --- /dev/null
> +++ b/include/json_print.h
> @@ -0,0 +1,71 @@
> +/*
> + * json_print.h "print regular or json output, based on json_writer".
> + *
> + * 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; either version
> + * 2 of the License, or (at your option) any later version.
> + *
> + * Authors: Julien Fortin, <julien@...ulusnetworks.com>
> + */
> +
> +#ifndef _JSON_PRINT_H_
> +#define _JSON_PRINT_H_
> +
> +#include "json_writer.h"
> +#include "color.h"
> +
> +json_writer_t *get_json_writer(void);
> +
> +/*
> + * use:
> + * - PRINT_ANY for context based output
> + * - PRINT_FP for non json specific output
> + * - PRINT_JSON for json specific output
> + */
> +enum output_type {
> + PRINT_FP = 1,
> + PRINT_JSON = 2,
> + PRINT_ANY = 4,
> +};
> +
> +void new_json_obj(int json, FILE *fp);
> +void delete_json_obj(void);
> +
> +bool is_json_context(void);
> +
> +void set_current_fp(FILE *fp);
> +
> +void fflush_fp(void);
> +
> +void open_json_object(const char *str);
> +void close_json_object(void);
> +void open_json_array(enum output_type type, const char *delim);
> +void close_json_array(enum output_type type, const char *delim);
> +
> +#define _PRINT_FUNC(type_name, type) \
> + void print_color_##type_name(enum output_type t, \
> + enum color_attr color, \
> + const char *key, \
> + const char *fmt, \
> + type value); \
> + \
> + static inline void print_##type_name(enum output_type t, \
> + const char *key, \
> + const char *fmt, \
> + type value) \
> + { \
> + print_color_##type_name(t, -1, key, fmt, value); \
> + }
> +_PRINT_FUNC(int, int);
> +_PRINT_FUNC(bool, bool);
> +_PRINT_FUNC(null, const char*);
> +_PRINT_FUNC(string, const char*);
> +_PRINT_FUNC(uint, uint64_t);
> +_PRINT_FUNC(hu, unsigned short);
> +_PRINT_FUNC(hex, unsigned int);
> +_PRINT_FUNC(0xhex, unsigned int);
> +_PRINT_FUNC(lluint, unsigned long long int);
> +#undef _PRINT_FUNC
> +
> +#endif /* _JSON_PRINT_H_ */
> diff --git a/ip/Makefile b/ip/Makefile
> index 52c9a2e..5a1c7ad 100644
> --- a/ip/Makefile
> +++ b/ip/Makefile
> @@ -9,7 +9,7 @@ IPOBJ=ip.o ipaddress.o ipaddrlabel.o iproute.o iprule.o ipnetns.o \
> link_iptnl.o link_gre6.o iplink_bond.o iplink_bond_slave.o iplink_hsr.o \
> iplink_bridge.o iplink_bridge_slave.o ipfou.o iplink_ipvlan.o \
> iplink_geneve.o iplink_vrf.o iproute_lwtunnel.o ipmacsec.o ipila.o \
> - ipvrf.o iplink_xstats.o ipseg6.o ip_print.o
> + ipvrf.o iplink_xstats.o ipseg6.o
>
> RTMONOBJ=rtmon.o
>
> diff --git a/ip/ip_common.h b/ip/ip_common.h
> index efc789c..4b8b0a7 100644
> --- a/ip/ip_common.h
> +++ b/ip/ip_common.h
> @@ -1,3 +1,10 @@
> +#ifndef _IP_COMMON_H_
> +#define _IP_COMMON_H_
> +
> +#include <stdbool.h>
> +
> +#include "json_print.h"
> +
> struct link_filter {
> int ifindex;
> int family;
> @@ -101,8 +108,6 @@ static inline int rtm_get_table(struct rtmsg *r, struct rtattr **tb)
>
> extern struct rtnl_handle rth;
>
> -#include <stdbool.h>
> -
> struct link_util {
> struct link_util *next;
> const char *id;
> @@ -141,58 +146,4 @@ int name_is_vrf(const char *name);
>
> void print_num(FILE *fp, unsigned int width, uint64_t count);
>
> -#include "json_writer.h"
> -
> -json_writer_t *get_json_writer(void);
> -/*
> - * use:
> - * - PRINT_ANY for context based output
> - * - PRINT_FP for non json specific output
> - * - PRINT_JSON for json specific output
> - */
> -enum output_type {
> - PRINT_FP = 1,
> - PRINT_JSON = 2,
> - PRINT_ANY = 4,
> -};
> -
> -void new_json_obj(int json, FILE *fp);
> -void delete_json_obj(void);
> -
> -bool is_json_context(void);
> -
> -void set_current_fp(FILE *fp);
> -
> -void fflush_fp(void);
> -
> -void open_json_object(const char *str);
> -void close_json_object(void);
> -void open_json_array(enum output_type type, const char *delim);
> -void close_json_array(enum output_type type, const char *delim);
> -
> -#include "color.h"
> -
> -#define _PRINT_FUNC(type_name, type) \
> - void print_color_##type_name(enum output_type t, \
> - enum color_attr color, \
> - const char *key, \
> - const char *fmt, \
> - type value); \
> - \
> - static inline void print_##type_name(enum output_type t, \
> - const char *key, \
> - const char *fmt, \
> - type value) \
> - { \
> - print_color_##type_name(t, -1, key, fmt, value); \
> - }
> -_PRINT_FUNC(int, int);
> -_PRINT_FUNC(bool, bool);
> -_PRINT_FUNC(null, const char*);
> -_PRINT_FUNC(string, const char*);
> -_PRINT_FUNC(uint, uint64_t);
> -_PRINT_FUNC(hu, unsigned short);
> -_PRINT_FUNC(hex, unsigned int);
> -_PRINT_FUNC(0xhex, unsigned int);
> -_PRINT_FUNC(lluint, unsigned long long int);
> -#undef _PRINT_FUNC
> +#endif /* _IP_COMMON_H_ */
> diff --git a/ip/ip_print.c b/ip/ip_print.c
> deleted file mode 100644
> index 4cd6a0b..0000000
> --- a/ip/ip_print.c
> +++ /dev/null
> @@ -1,233 +0,0 @@
> -/*
> - * ip_print.c "ip print regular or json output".
> - *
> - * 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; either version
> - * 2 of the License, or (at your option) any later version.
> - *
> - * Authors: Julien Fortin, <julien@...ulusnetworks.com>
> - *
> - */
> -
> -#include <stdarg.h>
> -#include <stdio.h>
> -
> -#include "utils.h"
> -#include "ip_common.h"
> -#include "json_writer.h"
> -
> -static json_writer_t *_jw;
> -static FILE *_fp;
> -
> -#define _IS_JSON_CONTEXT(type) ((type & PRINT_JSON || type & PRINT_ANY) && _jw)
> -#define _IS_FP_CONTEXT(type) (!_jw && (type & PRINT_FP || type & PRINT_ANY))
> -
> -void new_json_obj(int json, FILE *fp)
> -{
> - if (json) {
> - _jw = jsonw_new(fp);
> - if (!_jw) {
> - perror("json object");
> - exit(1);
> - }
> - jsonw_pretty(_jw, true);
> - jsonw_start_array(_jw);
> - }
> - set_current_fp(fp);
> -}
> -
> -void delete_json_obj(void)
> -{
> - if (_jw) {
> - jsonw_end_array(_jw);
> - jsonw_destroy(&_jw);
> - }
> -}
> -
> -bool is_json_context(void)
> -{
> - return _jw != NULL;
> -}
> -
> -void set_current_fp(FILE *fp)
> -{
> - if (!fp) {
> - fprintf(stderr, "Error: invalid file pointer.\n");
> - exit(1);
> - }
> - _fp = fp;
> -}
> -
> -json_writer_t *get_json_writer(void)
> -{
> - return _jw;
> -}
> -
> -void open_json_object(const char *str)
> -{
> - if (_IS_JSON_CONTEXT(PRINT_JSON)) {
> - if (str)
> - jsonw_name(_jw, str);
> - jsonw_start_object(_jw);
> - }
> -}
> -
> -void close_json_object(void)
> -{
> - if (_IS_JSON_CONTEXT(PRINT_JSON))
> - jsonw_end_object(_jw);
> -}
> -
> -/*
> - * Start json array or string array using
> - * the provided string as json key (if not null)
> - * or as array delimiter in non-json context.
> - */
> -void open_json_array(enum output_type type, const char *str)
> -{
> - if (_IS_JSON_CONTEXT(type)) {
> - if (str)
> - jsonw_name(_jw, str);
> - jsonw_start_array(_jw);
> - } else if (_IS_FP_CONTEXT(type)) {
> - fprintf(_fp, "%s", str);
> - }
> -}
> -
> -/*
> - * End json array or string array
> - */
> -void close_json_array(enum output_type type, const char *str)
> -{
> - if (_IS_JSON_CONTEXT(type)) {
> - jsonw_pretty(_jw, false);
> - jsonw_end_array(_jw);
> - jsonw_pretty(_jw, true);
> - } else if (_IS_FP_CONTEXT(type)) {
> - fprintf(_fp, "%s", str);
> - }
> -}
> -
> -/*
> - * pre-processor directive to generate similar
> - * functions handling different types
> - */
> -#define _PRINT_FUNC(type_name, type) \
> - void print_color_##type_name(enum output_type t, \
> - enum color_attr color, \
> - const char *key, \
> - const char *fmt, \
> - type value) \
> - { \
> - if (_IS_JSON_CONTEXT(t)) { \
> - if (!key) \
> - jsonw_##type_name(_jw, value); \
> - else \
> - jsonw_##type_name##_field(_jw, key, value); \
> - } else if (_IS_FP_CONTEXT(t)) { \
> - color_fprintf(_fp, color, fmt, value); \
> - } \
> - }
> -_PRINT_FUNC(int, int);
> -_PRINT_FUNC(hu, unsigned short);
> -_PRINT_FUNC(uint, uint64_t);
> -_PRINT_FUNC(lluint, unsigned long long int);
> -#undef _PRINT_FUNC
> -
> -void print_color_string(enum output_type type,
> - enum color_attr color,
> - const char *key,
> - const char *fmt,
> - const char *value)
> -{
> - if (_IS_JSON_CONTEXT(type)) {
> - if (key && !value)
> - jsonw_name(_jw, key);
> - else if (!key && value)
> - jsonw_string(_jw, value);
> - else
> - jsonw_string_field(_jw, key, value);
> - } else if (_IS_FP_CONTEXT(type)) {
> - color_fprintf(_fp, color, fmt, value);
> - }
> -}
> -
> -/*
> - * value's type is bool. When using this function in FP context you can't pass
> - * a value to it, you will need to use "is_json_context()" to have different
> - * branch for json and regular output. grep -r "print_bool" for example
> - */
> -void print_color_bool(enum output_type type,
> - enum color_attr color,
> - const char *key,
> - const char *fmt,
> - bool value)
> -{
> - if (_IS_JSON_CONTEXT(type)) {
> - if (key)
> - jsonw_bool_field(_jw, key, value);
> - else
> - jsonw_bool(_jw, value);
> - } else if (_IS_FP_CONTEXT(type)) {
> - color_fprintf(_fp, color, fmt, value ? "true" : "false");
> - }
> -}
> -
> -/*
> - * In JSON context uses hardcode %#x format: 42 -> 0x2a
> - */
> -void print_color_0xhex(enum output_type type,
> - enum color_attr color,
> - const char *key,
> - const char *fmt,
> - unsigned int hex)
> -{
> - if (_IS_JSON_CONTEXT(type)) {
> - SPRINT_BUF(b1);
> -
> - snprintf(b1, sizeof(b1), "%#x", hex);
> - print_string(PRINT_JSON, key, NULL, b1);
> - } else if (_IS_FP_CONTEXT(type)) {
> - color_fprintf(_fp, color, fmt, hex);
> - }
> -}
> -
> -void print_color_hex(enum output_type type,
> - enum color_attr color,
> - const char *key,
> - const char *fmt,
> - unsigned int hex)
> -{
> - if (_IS_JSON_CONTEXT(type)) {
> - SPRINT_BUF(b1);
> -
> - snprintf(b1, sizeof(b1), "%x", hex);
> - if (key)
> - jsonw_string_field(_jw, key, b1);
> - else
> - jsonw_string(_jw, b1);
> - } else if (_IS_FP_CONTEXT(type)) {
> - color_fprintf(_fp, color, fmt, hex);
> - }
> -}
> -
> -/*
> - * In JSON context we don't use the argument "value" we simply call jsonw_null
> - * whereas FP context can use "value" to output anything
> - */
> -void print_color_null(enum output_type type,
> - enum color_attr color,
> - const char *key,
> - const char *fmt,
> - const char *value)
> -{
> - if (_IS_JSON_CONTEXT(type)) {
> - if (key)
> - jsonw_null_field(_jw, key);
> - else
> - jsonw_null(_jw);
> - } else if (_IS_FP_CONTEXT(type)) {
> - color_fprintf(_fp, color, fmt, value);
> - }
> -}
> diff --git a/lib/Makefile b/lib/Makefile
> index 5e9f72f..0fbdf4c 100644
> --- a/lib/Makefile
> +++ b/lib/Makefile
> @@ -3,7 +3,7 @@ include ../config.mk
> CFLAGS += -fPIC
>
> UTILOBJ = utils.o rt_names.o ll_types.o ll_proto.o ll_addr.o \
> - inet_proto.o namespace.o json_writer.o \
> + inet_proto.o namespace.o json_writer.o json_print.o \
> names.o color.o bpf.o exec.o fs.o
>
> NLOBJ=libgenl.o ll_map.o libnetlink.o
> diff --git a/lib/json_print.c b/lib/json_print.c
> new file mode 100644
> index 0000000..93b4119
> --- /dev/null
> +++ b/lib/json_print.c
> @@ -0,0 +1,231 @@
> +/*
> + * json_print.c "print regular or json output, based on json_writer".
> + *
> + * 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; either version
> + * 2 of the License, or (at your option) any later version.
> + *
> + * Authors: Julien Fortin, <julien@...ulusnetworks.com>
> + */
> +
> +#include <stdarg.h>
> +#include <stdio.h>
> +
> +#include "utils.h"
> +#include "json_print.h"
> +
> +static json_writer_t *_jw;
> +static FILE *_fp;
> +
> +#define _IS_JSON_CONTEXT(type) ((type & PRINT_JSON || type & PRINT_ANY) && _jw)
> +#define _IS_FP_CONTEXT(type) (!_jw && (type & PRINT_FP || type & PRINT_ANY))
> +
> +void new_json_obj(int json, FILE *fp)
> +{
> + if (json) {
> + _jw = jsonw_new(fp);
> + if (!_jw) {
> + perror("json object");
> + exit(1);
> + }
> + jsonw_pretty(_jw, true);
> + jsonw_start_array(_jw);
> + }
> + set_current_fp(fp);
> +}
> +
> +void delete_json_obj(void)
> +{
> + if (_jw) {
> + jsonw_end_array(_jw);
> + jsonw_destroy(&_jw);
> + }
> +}
> +
> +bool is_json_context(void)
> +{
> + return _jw != NULL;
> +}
> +
> +void set_current_fp(FILE *fp)
> +{
> + if (!fp) {
> + fprintf(stderr, "Error: invalid file pointer.\n");
> + exit(1);
> + }
> + _fp = fp;
> +}
> +
> +json_writer_t *get_json_writer(void)
> +{
> + return _jw;
> +}
> +
> +void open_json_object(const char *str)
> +{
> + if (_IS_JSON_CONTEXT(PRINT_JSON)) {
> + if (str)
> + jsonw_name(_jw, str);
> + jsonw_start_object(_jw);
> + }
> +}
> +
> +void close_json_object(void)
> +{
> + if (_IS_JSON_CONTEXT(PRINT_JSON))
> + jsonw_end_object(_jw);
> +}
> +
> +/*
> + * Start json array or string array using
> + * the provided string as json key (if not null)
> + * or as array delimiter in non-json context.
> + */
> +void open_json_array(enum output_type type, const char *str)
> +{
> + if (_IS_JSON_CONTEXT(type)) {
> + if (str)
> + jsonw_name(_jw, str);
> + jsonw_start_array(_jw);
> + } else if (_IS_FP_CONTEXT(type)) {
> + fprintf(_fp, "%s", str);
> + }
> +}
> +
> +/*
> + * End json array or string array
> + */
> +void close_json_array(enum output_type type, const char *str)
> +{
> + if (_IS_JSON_CONTEXT(type)) {
> + jsonw_pretty(_jw, false);
> + jsonw_end_array(_jw);
> + jsonw_pretty(_jw, true);
> + } else if (_IS_FP_CONTEXT(type)) {
> + fprintf(_fp, "%s", str);
> + }
> +}
> +
> +/*
> + * pre-processor directive to generate similar
> + * functions handling different types
> + */
> +#define _PRINT_FUNC(type_name, type) \
> + void print_color_##type_name(enum output_type t, \
> + enum color_attr color, \
> + const char *key, \
> + const char *fmt, \
> + type value) \
> + { \
> + if (_IS_JSON_CONTEXT(t)) { \
> + if (!key) \
> + jsonw_##type_name(_jw, value); \
> + else \
> + jsonw_##type_name##_field(_jw, key, value); \
> + } else if (_IS_FP_CONTEXT(t)) { \
> + color_fprintf(_fp, color, fmt, value); \
> + } \
> + }
> +_PRINT_FUNC(int, int);
> +_PRINT_FUNC(hu, unsigned short);
> +_PRINT_FUNC(uint, uint64_t);
> +_PRINT_FUNC(lluint, unsigned long long int);
> +#undef _PRINT_FUNC
> +
> +void print_color_string(enum output_type type,
> + enum color_attr color,
> + const char *key,
> + const char *fmt,
> + const char *value)
> +{
> + if (_IS_JSON_CONTEXT(type)) {
> + if (key && !value)
> + jsonw_name(_jw, key);
> + else if (!key && value)
> + jsonw_string(_jw, value);
> + else
> + jsonw_string_field(_jw, key, value);
> + } else if (_IS_FP_CONTEXT(type)) {
> + color_fprintf(_fp, color, fmt, value);
> + }
> +}
> +
> +/*
> + * value's type is bool. When using this function in FP context you can't pass
> + * a value to it, you will need to use "is_json_context()" to have different
> + * branch for json and regular output. grep -r "print_bool" for example
> + */
> +void print_color_bool(enum output_type type,
> + enum color_attr color,
> + const char *key,
> + const char *fmt,
> + bool value)
> +{
> + if (_IS_JSON_CONTEXT(type)) {
> + if (key)
> + jsonw_bool_field(_jw, key, value);
> + else
> + jsonw_bool(_jw, value);
> + } else if (_IS_FP_CONTEXT(type)) {
> + color_fprintf(_fp, color, fmt, value ? "true" : "false");
> + }
> +}
> +
> +/*
> + * In JSON context uses hardcode %#x format: 42 -> 0x2a
> + */
> +void print_color_0xhex(enum output_type type,
> + enum color_attr color,
> + const char *key,
> + const char *fmt,
> + unsigned int hex)
> +{
> + if (_IS_JSON_CONTEXT(type)) {
> + SPRINT_BUF(b1);
> +
> + snprintf(b1, sizeof(b1), "%#x", hex);
> + print_string(PRINT_JSON, key, NULL, b1);
> + } else if (_IS_FP_CONTEXT(type)) {
> + color_fprintf(_fp, color, fmt, hex);
> + }
> +}
> +
> +void print_color_hex(enum output_type type,
> + enum color_attr color,
> + const char *key,
> + const char *fmt,
> + unsigned int hex)
> +{
> + if (_IS_JSON_CONTEXT(type)) {
> + SPRINT_BUF(b1);
> +
> + snprintf(b1, sizeof(b1), "%x", hex);
> + if (key)
> + jsonw_string_field(_jw, key, b1);
> + else
> + jsonw_string(_jw, b1);
> + } else if (_IS_FP_CONTEXT(type)) {
> + color_fprintf(_fp, color, fmt, hex);
> + }
> +}
> +
> +/*
> + * In JSON context we don't use the argument "value" we simply call jsonw_null
> + * whereas FP context can use "value" to output anything
> + */
> +void print_color_null(enum output_type type,
> + enum color_attr color,
> + const char *key,
> + const char *fmt,
> + const char *value)
> +{
> + if (_IS_JSON_CONTEXT(type)) {
> + if (key)
> + jsonw_null_field(_jw, key);
> + else
> + jsonw_null(_jw);
> + } else if (_IS_FP_CONTEXT(type)) {
> + color_fprintf(_fp, color, fmt, value);
> + }
> +}
> --
> 1.9.3
>
Powered by blists - more mailing lists