mars/kernel/brick_say.h

// (c) 2010 Thomas Schoebel-Theuer / 1&1 Internet AG
#ifndef BRICK_SAY_H
#define BRICK_SAY_H

#ifndef CONFIG_MARS_MODULE
// when unsure, include faked config file
#include "mars_config.h"
#endif

/////////////////////////////////////////////////////////////////////////

extern int brick_say_logging;
extern int brick_say_debug;
extern int brick_say_syslog_min;
extern int brick_say_syslog_max;
extern int brick_say_syslog_flood_class;
extern int brick_say_syslog_flood_limit;
extern int brick_say_syslog_flood_recovery;
extern int delay_say_on_overflow;

// printk() replacements

enum {
	SAY_DEBUG,
	SAY_INFO,
	SAY_WARN,
	SAY_ERROR,
	SAY_FATAL,
	SAY_TOTAL,
	MAX_SAY_CLASS
};

extern const char *say_class[MAX_SAY_CLASS];

struct say_channel;

extern struct say_channel *default_channel;

extern struct say_channel *make_channel(const char *name, bool must_exit);

extern void del_channel(struct say_channel *ch);

extern void bind_to_channel(struct say_channel *ch, struct task_struct *whom);

#define bind_me(_name)					\
	bind_to_channel(make_channel(_name), current)

extern struct say_channel *get_binding(struct task_struct *whom);

extern void remove_binding_from(struct say_channel *ch, struct task_struct *whom);
extern void remove_binding(struct task_struct *whom);

extern void rollover_channel(struct say_channel *ch);
extern void rollover_all(void);

extern void say_to(struct say_channel *ch, int class, const char *fmt, ...) __attribute__ ((format (printf, 3, 4)));

#define say(_class, _fmt, _args...)			\
	say_to(NULL, _class, _fmt, ##_args)

extern void brick_say_to(struct say_channel *ch, int class, bool dump, const char *prefix, const char *file, int line, const char *func, const char *fmt, ...) __attribute__ ((format (printf, 8, 9)));

#define brick_say(_class, _dump, _prefix, _file, _line, _func, _fmt, _args...) \
	brick_say_to(NULL, _class, _dump, _prefix, _file, _line, _func, _fmt, ##_args)

extern void init_say(void);
extern void exit_say(void);

#ifdef CONFIG_MARS_DEBUG
#define INLINE static inline
//#define INLINE __attribute__((__noinline__))
extern void brick_dump_stack(void);

#else // CONFIG_MARS_DEBUG

#define INLINE static inline
#define brick_dump_stack() /*empty*/

#endif // CONFIG_MARS_DEBUG

#endif
improved memory handling (big change but necessary for long-time stability of mem allocs) 2011-11-14 17:52:05 +00:00			`// (c) 2010 Thomas Schoebel-Theuer / 1&1 Internet AG`
			`#ifndef BRICK_SAY_H`
			`#define BRICK_SAY_H`

infra: check Kconfig prerequirements 2013-07-10 06:30:35 +00:00			`#ifndef CONFIG_MARS_MODULE`
			`// when unsure, include faked config file`
all: preparations for out-of-tree build - Makefile: Prepare for out-of-tree build - Define CONFIG_MARS_BIGMODULE if build out-of-tree - Adjusted target for buildtag.h generation - Added target for mars_config.h generation (depends on Kconfig) - Commits 949c64e 3e1d566 167dd73 rebased on eaba743 - Added script gen_config.pl to generate mars_config.h from Kconfig (Commits f373687 dc92c2f bf863f2 rebased on eaba743) - Include mars_config.h in mars.h/brick.h/brick_say.h (Commits 6f14e02 8f1b7d6 rebased on eaba743) Signed-off-by: Thomas Schoebel-Theuer <tst@1und1.de> 2013-04-09 13:35:00 +00:00			`#include "mars_config.h"`
infra: check Kconfig prerequirements 2013-07-10 06:30:35 +00:00			`#endif`
all: preparations for out-of-tree build - Makefile: Prepare for out-of-tree build - Define CONFIG_MARS_BIGMODULE if build out-of-tree - Adjusted target for buildtag.h generation - Added target for mars_config.h generation (depends on Kconfig) - Commits 949c64e 3e1d566 167dd73 rebased on eaba743 - Added script gen_config.pl to generate mars_config.h from Kconfig (Commits f373687 dc92c2f bf863f2 rebased on eaba743) - Include mars_config.h in mars.h/brick.h/brick_say.h (Commits 6f14e02 8f1b7d6 rebased on eaba743) Signed-off-by: Thomas Schoebel-Theuer <tst@1und1.de> 2013-04-09 13:35:00 +00:00
improved memory handling (big change but necessary for long-time stability of mem allocs) 2011-11-14 17:52:05 +00:00			`/////////////////////////////////////////////////////////////////////////`

infra: allow stopping of log messages 2013-04-08 08:45:20 +00:00			`extern int brick_say_logging;`
brick_say: make debug messages runtime-selectable 2013-01-20 22:09:09 +00:00			`extern int brick_say_debug;`
brick_say: implement status files via intermediate .tmp files 2012-11-13 11:50:48 +00:00			`extern int brick_say_syslog_min;`
			`extern int brick_say_syslog_max;`
infra: add flood protected syslogging 2014-01-28 09:51:17 +00:00			`extern int brick_say_syslog_flood_class;`
			`extern int brick_say_syslog_flood_limit;`
			`extern int brick_say_syslog_flood_recovery;`
brick_say: allow delaying callers upon overflow 2012-11-20 08:09:33 +00:00			`extern int delay_say_on_overflow;`
brick_say: implement status files via intermediate .tmp files 2012-11-13 11:50:48 +00:00
improved memory handling (big change but necessary for long-time stability of mem allocs) 2011-11-14 17:52:05 +00:00			`// printk() replacements`

infra: rewrite brick_say to work with threads It was cumbersome to write to files in / after in_interrupt() & co. A master write thread will also reduce the peak IO parallelism on log data in /mars . Further work has to be done to utilize non-default write channels. 2012-10-11 06:25:41 +00:00			`enum {`
			`SAY_DEBUG,`
			`SAY_INFO,`
			`SAY_WARN,`
			`SAY_ERROR,`
			`SAY_FATAL,`
			`SAY_TOTAL,`
			`MAX_SAY_CLASS`
			`};`
usability: added /proc/sys/mars/{errors,warnings} 2012-02-02 10:16:06 +00:00
infra: control creation of log messages 2013-04-08 09:44:09 +00:00			`extern const char *say_class[MAX_SAY_CLASS];`

infra: rewrite brick_say to work with threads It was cumbersome to write to files in / after in_interrupt() & co. A master write thread will also reduce the peak IO parallelism on log data in /mars . Further work has to be done to utilize non-default write channels. 2012-10-11 06:25:41 +00:00			`struct say_channel;`

			`extern struct say_channel *default_channel;`

infra: control creation of log messages 2013-04-08 09:44:09 +00:00			`extern struct say_channel make_channel(const char name, bool must_exit);`
infra: rewrite brick_say to work with threads It was cumbersome to write to files in / after in_interrupt() & co. A master write thread will also reduce the peak IO parallelism on log data in /mars . Further work has to be done to utilize non-default write channels. 2012-10-11 06:25:41 +00:00
infra: export del_channel() for general use 2013-04-08 07:14:23 +00:00			`extern void del_channel(struct say_channel *ch);`

infra: rewrite brick_say to work with threads It was cumbersome to write to files in / after in_interrupt() & co. A master write thread will also reduce the peak IO parallelism on log data in /mars . Further work has to be done to utilize non-default write channels. 2012-10-11 06:25:41 +00:00			`extern void bind_to_channel(struct say_channel ch, struct task_struct whom);`

			`#define bind_me(_name) \`
			`bind_to_channel(make_channel(_name), current)`

brick_say: implement status files via intermediate .tmp files 2012-11-13 11:50:48 +00:00			`extern struct say_channel get_binding(struct task_struct whom);`

			`extern void remove_binding_from(struct say_channel ch, struct task_struct whom);`
infra: rewrite brick_say to work with threads It was cumbersome to write to files in / after in_interrupt() & co. A master write thread will also reduce the peak IO parallelism on log data in /mars . Further work has to be done to utilize non-default write channels. 2012-10-11 06:25:41 +00:00			`extern void remove_binding(struct task_struct *whom);`
usability: added /proc/sys/mars/{errors,warnings} 2012-02-02 10:16:06 +00:00
brick_say: implement status files via intermediate .tmp files 2012-11-13 11:50:48 +00:00			`extern void rollover_channel(struct say_channel *ch);`
			`extern void rollover_all(void);`

infra: rewrite brick_say to work with threads It was cumbersome to write to files in / after in_interrupt() & co. A master write thread will also reduce the peak IO parallelism on log data in /mars . Further work has to be done to utilize non-default write channels. 2012-10-11 06:25:41 +00:00			`extern void say_to(struct say_channel ch, int class, const char fmt, ...) __attribute__ ((format (printf, 3, 4)));`
fixed logging to file, allow logrotate 2012-01-11 15:16:39 +00:00
infra: rewrite brick_say to work with threads It was cumbersome to write to files in / after in_interrupt() & co. A master write thread will also reduce the peak IO parallelism on log data in /mars . Further work has to be done to utilize non-default write channels. 2012-10-11 06:25:41 +00:00			`#define say(_class, _fmt, _args...) \`
			`say_to(NULL, _class, _fmt, ##_args)`
improved printk flooding (long filename paths) 2012-01-09 16:12:06 +00:00
infra: rewrite brick_say to work with threads It was cumbersome to write to files in / after in_interrupt() & co. A master write thread will also reduce the peak IO parallelism on log data in /mars . Further work has to be done to utilize non-default write channels. 2012-10-11 06:25:41 +00:00			`extern void brick_say_to(struct say_channel ch, int class, bool dump, const char prefix, const char file, int line, const char func, const char *fmt, ...) __attribute__ ((format (printf, 8, 9)));`

			`#define brick_say(_class, _dump, _prefix, _file, _line, _func, _fmt, _args...) \`
			`brick_say_to(NULL, _class, _dump, _prefix, _file, _line, _func, _fmt, ##_args)`
improved printk flooding (long filename paths) 2012-01-09 16:12:06 +00:00
allow logging to /mars/log.txt instead of syslog 2012-01-10 12:55:50 +00:00			`extern void init_say(void);`
improved printk flooding (long filename paths) 2012-01-09 16:12:06 +00:00			`extern void exit_say(void);`

treat CONFIG_MARS_DEBUG independent from CONFIG_DEBUG_KERNEL 2012-02-08 11:44:42 +00:00			`#ifdef CONFIG_MARS_DEBUG`
improved memory handling (big change but necessary for long-time stability of mem allocs) 2011-11-14 17:52:05 +00:00			`#define INLINE static inline`
			`//#define INLINE __attribute__((__noinline__))`
			`extern void brick_dump_stack(void);`

treat CONFIG_MARS_DEBUG independent from CONFIG_DEBUG_KERNEL 2012-02-08 11:44:42 +00:00			`#else // CONFIG_MARS_DEBUG`
improved memory handling (big change but necessary for long-time stability of mem allocs) 2011-11-14 17:52:05 +00:00
			`#define INLINE static inline`
			`#define brick_dump_stack() /empty/`

treat CONFIG_MARS_DEBUG independent from CONFIG_DEBUG_KERNEL 2012-02-08 11:44:42 +00:00			`#endif // CONFIG_MARS_DEBUG`
improved memory handling (big change but necessary for long-time stability of mem allocs) 2011-11-14 17:52:05 +00:00
			`#endif`