mirror of
https://git.proxmox.com/git/mirror_iproute2
synced 2025-10-04 16:16:39 +00:00
adbe5de966
When displaying sizes of various sorts, tc commonly uses the function sprint_size() to format the size into a buffer as a human-readable string. This string is then displayed either using print_string(), or in some code even fprintf(). As a result, a typical sequence of code when formatting a size is something like the following: SPRINT_BUF(b); print_uint(PRINT_JSON, "foo", NULL, foo); print_string(PRINT_FP, NULL, "foo %s ", sprint_size(foo, b)); For a concept as broadly useful as size, it would be better to have a dedicated function in json_print. To that end, move sprint_size() from tc_util to json_print. Add helpers print_size() and print_color_size() that wrap arount sprint_size() and provide the JSON dispatch as appropriate. Since print_size() should be the preferred interface, convert vast majority of uses of sprint_size() to print_size(). Two notable exceptions are: - q_tbf, which does not show the size as such, but uses the string "$human_readable_size/$cell_size" even in JSON. There is simply no way to have print_size() emit the same text, because print_size() in JSON mode should of course just use the raw number, without human-readable frills. - q_cake, which relies on the existence of sprint_size() in its macro-based formatting helpers. There might be ways to convert this particular case, but given q_tbf simply cannot be converted, leave it as is. Signed-off-by: Petr Machata <me@pmachata.org> Signed-off-by: David Ahern <dsahern@gmail.com>
104 lines
3.0 KiB
C
104 lines
3.0 KiB
C
/*
|
|
* 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@cumulusnetworks.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);
|
|
void delete_json_obj(void);
|
|
void new_json_obj_plain(int json);
|
|
void delete_json_obj_plain(void);
|
|
|
|
bool is_json_context(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);
|
|
|
|
void print_nl(void);
|
|
|
|
#define _PRINT_FUNC(type_name, type) \
|
|
int print_color_##type_name(enum output_type t, \
|
|
enum color_attr color, \
|
|
const char *key, \
|
|
const char *fmt, \
|
|
type value); \
|
|
\
|
|
static inline int print_##type_name(enum output_type t, \
|
|
const char *key, \
|
|
const char *fmt, \
|
|
type value) \
|
|
{ \
|
|
return print_color_##type_name(t, COLOR_NONE, key, fmt, \
|
|
value); \
|
|
}
|
|
|
|
/* These functions return 0 if printing to a JSON context, number of
|
|
* characters printed otherwise (as calculated by printf(3)).
|
|
*/
|
|
_PRINT_FUNC(int, int)
|
|
_PRINT_FUNC(s64, int64_t)
|
|
_PRINT_FUNC(bool, bool)
|
|
_PRINT_FUNC(on_off, bool)
|
|
_PRINT_FUNC(null, const char*)
|
|
_PRINT_FUNC(string, const char*)
|
|
_PRINT_FUNC(uint, unsigned int)
|
|
_PRINT_FUNC(size, __u32)
|
|
_PRINT_FUNC(u64, uint64_t)
|
|
_PRINT_FUNC(hhu, unsigned char)
|
|
_PRINT_FUNC(hu, unsigned short)
|
|
_PRINT_FUNC(hex, unsigned int)
|
|
_PRINT_FUNC(0xhex, unsigned long long)
|
|
_PRINT_FUNC(luint, unsigned long)
|
|
_PRINT_FUNC(lluint, unsigned long long)
|
|
_PRINT_FUNC(float, double)
|
|
#undef _PRINT_FUNC
|
|
|
|
#define _PRINT_NAME_VALUE_FUNC(type_name, type, format_char) \
|
|
void print_##type_name##_name_value(const char *name, type value) \
|
|
|
|
_PRINT_NAME_VALUE_FUNC(uint, unsigned int, u);
|
|
_PRINT_NAME_VALUE_FUNC(string, const char*, s);
|
|
#undef _PRINT_NAME_VALUE_FUNC
|
|
|
|
int print_color_rate(bool use_iec, enum output_type t, enum color_attr color,
|
|
const char *key, const char *fmt, unsigned long long rate);
|
|
|
|
static inline int print_rate(bool use_iec, enum output_type t,
|
|
const char *key, const char *fmt,
|
|
unsigned long long rate)
|
|
{
|
|
return print_color_rate(use_iec, t, COLOR_NONE, key, fmt, rate);
|
|
}
|
|
|
|
/* A backdoor to the size formatter. Please use print_size() instead. */
|
|
char *sprint_size(__u32 sz, char *buf);
|
|
|
|
#endif /* _JSON_PRINT_H_ */
|