Skip to content

P
PPSi
Commit bdf18817 authored by Alessandro Rubini's avatar Alessandro Rubini
Browse files
Options

diag new mechanism in header files 

This only introduces the header files, the actual code is still
missing, and is added by later commits. I still want this to be by
itself because it explains the thing (please read the comments in
diag-macros.h, that I won't copy in this commit message).
Signed-off-by: Alessandro Rubini's avatarAlessandro Rubini <rubini@gnudd.com>
parent 88835733
Hide whitespace changes
Inline Side-by-side
Showing with 105 additions and 23 deletions
include/ppsi/diag-macros.h
View file @ bdf18817
/*
* Macros for diagnostic prints. The thing is not trivial because
* we need to remove all strings and parameter passing when running
* wrpc-sw with all its options enabled, for space reasons.
* Macros for diagnostic prints.
*/
/*
* Then we have a verbosity argument, that can be changed at run time
* We still have support for compile-time settings, in order to remove
* quite a few kilobytes of stuff from the compiled binary. This first
* part of the file is the previous way, which is still used in
* several files. I plan to phase it out slowly, but let's avoid
* massive changes at this point.
*
* This verbosity argument, that can be changed at run time
* or not. If it can be changed, stuff works like this, depending on
* an integer value somewhere (it is incremented by each -V on a host run)
* an integer value somewhere (it is incremented by each -V on a host run).
*
* BTW, Host build always have CONFIG_PPSI_RUNTIME_VERBOSITY set, because we
* have no size problems there (bare build don't have it, in order to
* easily test how stuff work on real freestanding environments.
*/
#ifdef CONFIG_PPSI_RUNTIME_VERBOSITY
#define CONST_VERBOSITY /* nothing: use "int pp_diag_verbosity" */
extern int pp_diag_verbosity;
#define CONST_VERBOSITY /* nothing: use "int pp_diag_verbosity" */
#define PP_PRINTF(...) if (pp_diag_verbosity) pp_printf(__VA_ARGS__)
#define PP_VPRINTF(...) if (pp_diag_verbosity > 1) pp_printf(__VA_ARGS__)
#define PP_PRINTF(...) if (pp_diag_verbosity) pp_printf(__VA_ARGS__)
#define PP_VPRINTF(...) if (pp_diag_verbosity > 1) pp_printf(__VA_ARGS__)
#else
#else /* no runtime verbosity */
/*
* If verbosity cannot be changed at run time, we have CONFIG_PPSI_VERBOSITY
* set at build time (or at Kconfig time when we add it)
*/
/*
* If verbosity cannot be changed at run time, we have CONFIG_PPSI_VERBOSITY
* set at build time (or at Kconfig time when we add it)
*/
#define CONST_VERBOSITY const /* use "const int pp_diag_verbosity */
#define CONST_VERBOSITY const /* use "const int pp_diag_verbosity */
#if CONFIG_PPSI_VERBOSITY > 0
#define PP_PRINTF(...) if (pp_diag_verbosity) pp_printf(__VA_ARGS__)
#define PP_VPRINTF(...) if (pp_diag_verbosity > 1) pp_printf(__VA_ARGS__)
#define PP_PRINTF(...) if (pp_diag_verbosity) pp_printf(__VA_ARGS__)
#define PP_VPRINTF(...) if (pp_diag_verbosity > 1) pp_printf(__VA_ARGS__)
#else
#define PP_PRINTF(...)
#define PP_VPRINTF(...)
#define PP_PRINTF(...)
#define PP_VPRINTF(...)
#endif /* CONFIG_PPSI_VERBOSITY > 0 */
#endif /* CONFIG_PPSI_RUNTIME_VERBOSITY */
......@@ -50,6 +57,85 @@ extern CONST_VERBOSITY int pp_diag_verbosity;
#define pp_Vprintf(...) \
if (pp_diag_verbosity > 1) pp_printf(__VA_ARGS__)
/*
* The "new" diagnostics is based on flags: there are per-instance flags
* and global flags.
*
* Basically, we may have just bits about what to print, but we might
* want to add extra-verbose stuff for specific cases, like looking at
* how WR synchronizes, or all details of delay calculations. So
* let's use 4 bits for each "kind" of thing.
*
* By using 4 bits, we can make a simple parser (that can be used in
* freestanding environments, without strtok or such) and have a
* format like "00105", which is not really hex, because position 0 is
* position 0, and you can omit trailing zeroes, not leading ones. The
* parser is exported, so every arch uses the same convention. By
* doing like this we can have up to 7 "things", separate for each pp
* instance (the low 4 bits are general diagnostic flags).
*
* So, let's name the things, numberinf from 7 downwards because we
* think of the final hex number:
*/
enum pp_diag_things {
pp_dt_fsm = 7,
pp_dt_time = 6, /* level 1: set and timeouts, 2: get_time too */
pp_dt_frames = 5, /* level 1: send/recv, 2: dump contents */
pp_dt_servo = 4,
pp_dt_bmc = 3,
pp_dt_ext = 2,
};
/*
* Note: we may use less bits and have more things, without changing
* anything. Set's say levels are ony 0..3 -- still,I prefer to be
* able to print the active flags as %x while debugging this very
* mechanism).
*/
extern unsigned long pp_global_flags; /* Supplement ppi-specific ones */
#define PP_FLAG_NOTIMELOG 1 /* This is for a special case, I'm sorry */
/* So, extract the level */
#define __PP_FLAGS(ppi) (ppi->flags | pp_global_flags)
#define __PP_DIAG_ALLOW(ppi, th, level) \
((__PP_FLAGS(ppi) >> (4 * (th)) & 0xf) >= level)
/* The function it is better external, since it is variadic */
extern void __pp_diag(struct pp_instance *ppi, enum pp_diag_things th,
int level, char *fmt, ...)
__attribute__((format(printf, 4, 5)));
/* Now, *still* use PPSI_NO_DIAG as an escape route to kill all diag code */
#ifdef PPSI_NO_DIAG
# define PP_HAS_DIAG 0
#else
# define PP_HAS_DIAG 1
#endif
/* So, this is the function that is to be used by real ppsi code */
#define pp_diag(ppi_, th_, level_, ...) \
({ \
if (PP_HAS_DIAG) \
__pp_diag(ppi_, pp_dt_ ## th_, level_, __VA_ARGS__); \
PP_HAS_DIAG; /* return 1 if done, 0 if not done */ \
})
/*
* And this is the parser of the string. Internally it obeys VERB_LOG_MESGS
* to set the value to 0xfffffff0 to be compatible with previous usage.
*/
extern unsigned long pp_diag_parse(char *diaglevel);
/*
* The following stuff is being removed in a few commits. It's stuff that
* I did but don't like any more (because we really need per-instance bits
*/
/*
* Then, we have this VERB_LOG_MSGS that used to be an ifdef. Provide
* constants instead, to avoid the hairyness of ifdef.
......
include/ppsi/pp-instance.h
View file @ bdf18817
......@@ -190,8 +190,4 @@ struct pp_instance {
waiting_for_follow:1;
};
extern unsigned long pp_global_flags; /* Supplement ppi-specific ones */
#define PP_FLAG_NOTIMELOG 1 /* This is for a special case, I'm sorry */
#endif /* __PPSI_PP_INSTANCE_H__ */
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment