Enhancements to 'trace' infrastructure
Subsystems (3)
cover Enhancements to 'trace' infrastructure
Hi All,
Please review the following patch which introduces two new
interfaces to output data using 'trace' infrastructure. These interfaces can be used to print directly onto a debugfs mount. Since it uses 'trace' interface underneath the directory and file structures are as created by 'trace'.
The proposed debugfs_* interfaces are meant to overcome the need to setup/tear-down 'trace' infrastructure by the user. In addition to this the patches help in:
a) Printing out data into a debugfs mounted file without bothering about creating/re-using debugfs files, sizes of intermediate buffers, etc. (This is achieved through the functions init_trace_interface() and trace_exists()).
b) Provide interfaces to do i)string output or ii)binary dump of data
c) Tear-down of the trace infrastructure through a single function call using its parent directory name, and unmindful of the internal data structures such as 'struct trace_info'.(using trace_cleanup_all)
d) The debugfs_printk_data may be further enhanced to provide features suh as the ability to invoke pre- and post- printing callback functions For e.g. A callback function to obtain a given lock before printing out a given data, etc.
A quick look at samples/trace/fork_trace.c would help understand what is required to get data out using the 'trace' infrastructure (vs the proposed interfaces which have been exemplified in samples/trace/fork_new_trace.c).
The patches are based against 2.6.25-rc8-mm1 and have been tested on an i386 machine.
Thanks,
K.Prasad
RFC PATCH 1/1 debugfs_printk and debugfs_dump interface
This patch introduces two new interfaces called debugfs_printk and debugfs_dump which can be used to print to the debugfs mount directly. It uses the 'trace' infrastructure underneath and is a patch over it. A sample file is also created to demonstrate its ease of use.
--- include/linux/trace.h | 54 ++++++++++++ lib/trace.c | 183 +++++++++++++++++++++++++++++++++++++++-- samples/trace/Makefile | 2 samples/trace/fork_new_trace.c | 98 +++++++++++++++++++++ 4 files changed, 331 insertions(+), 6 deletions(-)
include/linux/trace.h +54 -0
@@ -39,10 +39,30 @@ enum trace_state { TRACE_STOPPED, }; +enum trace_dir_state { +TRACE_PARENT_DIR_ABSENT , +TRACE_PARENT_DIR_EXISTS , +TRACE_DIR_EXISTS +}; +#define TRACE_ROOT_NAME_SIZE 64/* Max root dir identifier */ #define TRACE_NAME_SIZE 64/* Max trace identifier */ /* +* Buffers for use by debugfs_printk +*/ +#define DEFAULT_TRACE_BUF_SIZE 4096 +#define DEFAULT_TRACE_SUB_BUF_NR 40 + +struct debugfs_printk_data { +char *parent_dir; +char *dir; +int exists; +int buf_size; +int sub_buf_size; +}; + +/* * Global root user information */ struct trace_root {
@@ -73,6 +93,17 @@ struct trace_info {unsigned int buf_nr; }; +/* +* Information about every trace directory +*/ +struct trace_dir { +struct list_head trace_dir_list; +char trace_dir_name[TRACE_NAME_SIZE ]; +struct dentry *trace_root; +struct dentry *trace_dir; +struct trace_info *ti; +}; +#ifdef CONFIG_TRACE static inline int trace_running (struct trace_info *trace) {
@@ -83,6 +114,12 @@ struct trace_info *trace_setup(const chaint trace_start (struct trace_info *trace);int trace_stop (struct trace_info *trace);void trace_cleanup (struct trace_info *trace); +int trace_exists (const char *parent_dir,const char *dir, +struct trace_info **ti); +void trace_cleanup_all (const char *parent_dir); +int debugfs_printk (struct debugfs_printk_data *dpk,char *format, ...); +int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len);#else static inline struct trace_info *trace_setup(const char *root, const char *name, u32 buf_size,
@@ -94,6 +131,23 @@ static inline int trace_start(struct trastatic inline int trace_stop (struct trace_info *trace) {return -EINVAL ; }static inline int trace_running (struct trace_info *trace) {return 0 ; }static inline void trace_cleanup (struct trace_info *trace) {} +static inline int trace_exists (const char *parent_dir,const char *dir, +struct trace_info **ti) +{ +return -EINVAL ; +} +static inline void trace_cleanup_all (const char *parent_dir) {} +static inline int debugfs_printk (struct debugfs_printk_data *dpk,char *format, + ...) +{ +return -EINVAL ; +} +int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len) +{ +return -EINVAL ; +} +#endif #endif
lib/trace.c +178 -5
223 lines not on this page · raw message
samples/trace/fork_new_trace.c new file +98 -0
98 lines not on this page · raw message
samples/trace/Makefile +1 -1
@@ -1,4 +1,4 @@ # builds the trace example kernel modules; # then to use (as root): insmod <fork_trace.ko> -obj-$(CONFIG_SAMPLE_TRACE) := fork_trace.o +obj-$(CONFIG_SAMPLE_TRACE) := fork_trace.o fork_new_trace.o
Re: [RFC Patch 1/1] debugfs_printk and debugfs_dump interface
include/linux/trace.h enum trace_state { · line 63
Quoted 10 lines · K. Prasad
include/linux/trace.h +8
-0+ +struct debugfs_printk_data { +char *parent_dir; +char *dir; +int exists; +int buf_size; +int sub_buf_size; +};
How about adding a "flags" field here to hold the trace channel flags. Pass the flags through to trace_setup(). This way the caller can control the trace options.
Add a description of debugfs_printk() and debugfs_dump() to Documentation/trace.txt.
Re: [RFC Patch 1/1] debugfs_printk and debugfs_dump interface
Quoted 16 lines · David Wilder
Review
Quoted 10 lines · K. Prasad
(quoted diff) +8
-0+ +struct debugfs_printk_data { + char *parent_dir; + char *dir; + int exists; + int buf_size; + int sub_buf_size; +};How about adding a "flags" field here to hold the trace channel flags. Pass the flags through to
trace_setup(). This way the caller can control the trace options.
Quoted 2 lines
Add a description of
debugfs_printk()anddebugfs_dump()toDocumentation/trace.txt.
Hi David,
Thanks for your comments. I have added a flags field to structdebugfs_printk_data (defaulting to TRACE_FLIGHT_CHANNEL) and updated the documentation apart from a minor name change (trace_printf). Please review the changes.
Thanks,
K.Prasad
This patch introduces two new interfaces called debugfs_printk and debugfs_dump which can be used to print to the debugfs mount directly. It uses the 'trace' infrastructure underneath and is a patch over it. A sample file is also created to demonstrate its ease of use.
--- Documentation/trace.txt | 21 ++++ include/linux/trace.h | 55 +++++++++++ lib/trace.c | 196 +++++++++++++++++++++++++++++++++++++++-- samples/trace/Makefile | 2 samples/trace/fork_new_trace.c | 97 ++++++++++++++++++++ 5 files changed, 365 insertions(+), 6 deletions(-)
include/linux/trace.h +55 -0
@@ -39,10 +39,31 @@ enum trace_state { TRACE_STOPPED, }; +enum trace_dir_state { +TRACE_PARENT_DIR_ABSENT , +TRACE_PARENT_DIR_EXISTS , +TRACE_DIR_EXISTS +}; +#define TRACE_ROOT_NAME_SIZE 64/* Max root dir identifier */ #define TRACE_NAME_SIZE 64/* Max trace identifier */ /* +* Buffers for use by debugfs_printk +*/ +#define DEFAULT_TRACE_BUF_SIZE 4096 +#define DEFAULT_TRACE_SUB_BUF_NR 40 + +struct debugfs_printk_data { +char *parent_dir; +char *dir; +int exists; +int buf_size; +int sub_buf_size; +unsigned long flags; +}; + +/* * Global root user information */ struct trace_root {
@@ -73,6 +94,17 @@ struct trace_info {unsigned int buf_nr; }; +/* +* Information about every trace directory +*/ +struct trace_dir { +struct list_head trace_dir_list; +char trace_dir_name[TRACE_NAME_SIZE ]; +struct dentry *trace_root; +struct dentry *trace_dir; +struct trace_info *ti; +}; +#ifdef CONFIG_TRACE static inline int trace_running (struct trace_info *trace) {
@@ -83,6 +115,12 @@ struct trace_info *trace_setup(const chaint trace_start (struct trace_info *trace);int trace_stop (struct trace_info *trace);void trace_cleanup (struct trace_info *trace); +int trace_exists (const char *parent_dir,const char *dir, +struct trace_info **ti); +void trace_cleanup_all (const char *parent_dir); +int debugfs_printk (struct debugfs_printk_data *dpk,char *format, ...); +int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len);#else static inline struct trace_info *trace_setup(const char *root, const char *name, u32 buf_size,
@@ -94,6 +132,23 @@ static inline int trace_start(struct trastatic inline int trace_stop (struct trace_info *trace) {return -EINVAL ; }static inline int trace_running (struct trace_info *trace) {return 0 ; }static inline void trace_cleanup (struct trace_info *trace) {} +static inline int trace_exists (const char *parent_dir,const char *dir, +struct trace_info **ti) +{ +return -EINVAL ; +} +static inline void trace_cleanup_all (const char *parent_dir) {} +static inline int debugfs_printk (struct debugfs_printk_data *dpk,char *format, + ...) +{ +return -EINVAL ; +} +int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len) +{ +return -EINVAL ; +} +#endif #endif
lib/trace.c +191 -5
237 lines not on this page · raw message
samples/trace/fork_new_trace.c new file +97 -0
97 lines not on this page · raw message
samples/trace/Makefile +1 -1
@@ -1,4 +1,4 @@ # builds the trace example kernel modules; # then to use (as root): insmod <fork_trace.ko> -obj-$(CONFIG_SAMPLE_TRACE) := fork_trace.o +obj-$(CONFIG_SAMPLE_TRACE) := fork_trace.o fork_new_trace.o
Documentation/trace.txt +21 -0
@@ -150,6 +150,27 @@ The steps a kernel data provider takes t 5) Destroy the trace channel and underlying relay channel - trace_cleanup(). +Alternatively the user may choose to make use of two new interfaces +debugfs_printk() and debugfs_dump() to setup trace interface and +trace_cleanup_all() to tear-down the same. + +Steps to use: +1) Create and populate an instance of debugfs_printk_data structure. The fields + parent_dir and dir are mandatory. The fields buf_size, sub_buf_size and flags + are optional and will take default values if not populated. The field + 'exists' is for the trace infrastructure to use. +2) Default values for buf_size, sub_buf_size and flags are 4096, 40 and + TRACE_FLIGHT_CHANNEL respectively. +3) Use debugfs_dump() to output binary data which may be acted upon by a + high-level program (say dumping a structure). debugfs_printk() can be used + for string output. Pass a pointer to the instance of debugfs_printk_data + structure to these functions along with other parameters. The output from + these functions can be found at + <debugfs_mount>/<parent_dir>/<dir>/trace<0..n>. +4) trace_cleanup_all() for a given parent directory will cleanup and remove all + trace directories created under the specified directory. +5) Sample code for the same can be found in samples/trace/fork_new_trace.c + Kernel Configuration -------------------- To use trace, configure your kernel with CONFIG_TRACE=y. Trace depends on
Re: [RFC Patch 1/1] debugfs_printk and debugfs_dump interface
Quoted 19 lines · On Mon, 21 Apr 2008 18:13:29 +0530 K. Prasad wrote:
This patch introduces two new interfaces called
debugfs_printkanddebugfs_dumpwhich can be used to print to the debugfs mount directly. It uses the 'trace' infrastructure underneath and is a patch over it. A sample file is also created to demonstrate its ease of use.Signed-off-by K.Prasad <[email protected]>--- Documentation/trace.txt | 21 ++++ include/linux/trace.h | 55 +++++++++++ lib/trace.c | 196 +++++++++++++++++++++++++++++++++++++++-- samples/trace/Makefile | 2 samples/trace/fork_new_trace.c | 97 ++++++++++++++++++++ 5 files changed, 365 insertions(+), 6 deletions(-)Index:
linux-2.6.25-rc8-mm1/lib/trace.c
===================================================================
lib/trace.c void trace_cleanup(struct trace_info *tr · line 615
Quoted 7 lines
lib/trace.c +4
-0@@ -561,3 +609,141 @@ void trace_cleanup(struct trace_info *trkfree (trace); }EXPORT_SYMBOL_GPL (trace_cleanup); + +/** +* trace_cleanup_all - Removes all trace_info/directories created under a +* parent_dir
kernel-doc requires the "function name - description" to be on one line. You could change the *<tab> to be *<space(s)>.
Quoted 15 lines
lib/trace.c +15
-0+* @parent_dir: Name of the parent directory +*/ +void trace_cleanup_all (const char *parent_dir) +{ +struct list_head *pos, *pos_temp; +struct trace_dir *temp; + +list_for_each_safe (pos, pos_temp, &trace_dirs) { + temp = list_entry(pos, struct trace_dir, trace_dir_list); +if (!strcmp (parent_dir, temp->trace_root->d_iname)) +trace_cleanup (temp->ti); + } +} +EXPORT_SYMBOL_GPL (trace_cleanup_all); +
...
lib/trace.c void trace_cleanup(struct trace_info *tr · line 694
Quoted 7 lines
lib/trace.c +7
-0+ +/* +* debugfs_printk - A function to write into the debugfs mount 'directly' +* using 'trace' infrastructure +* @dpk - Structure containing info such as parent_dir and directory +* @format - String containing format string specifiers +* @ap - List of arguments
This one isn't quite kernel-doc notation, but it's very close to it, and it should be kernel-doc since it's an exported symbol. So it needs the following changes:
- begin with /**
- put function name + short description on one line
- use "@dpk: <description>" for function parameters (not "-")
Quoted 24 lines
+ */
lib/trace.c +23
-0+int debugfs_printk (struct debugfs_printk_data *dpk,char *format, ...) +{ +int ret; +struct trace_info *ti; +va_list (ap); +unsigned long flags; + +va_start (ap, format); + + ti =init_trace_interface (dpk); + +/* Now do the actual printing */ +/* Take an RCU Lock over the trace_info state */ +rcu_read_lock (); +/* Take a spinlock for the global buffer used by relay */ +if (dpk->flags &TRACE_GLOBAL_CHANNEL ) +spin_lock_irqsave (&trace_lock, flags); + ret =trace_printf (ti, format, ap); +if (dpk->flags &TRACE_GLOBAL_CHANNEL ) +spin_unlock_irqrestore (&trace_lock, flags); +rcu_read_unlock (); + +va_end (ap);
lib/trace.c void trace_cleanup(struct trace_info *tr · line 728
Quoted 10 lines
lib/trace.c +10
-0+return ret; +} +EXPORT_SYMBOL (debugfs_printk); + +/* +* debugfs_printk - A function to write into the debugfs mount 'directly' +* using 'trace' infrastructure +* @dpk - Structure containing info such as parent_dir and directory +* @output - Data that needs to be output +* @output_len - Length of the output data
Use kernel-doc notation. Same comments as above.
Quoted 27 lines
+ */
lib/trace.c +20
-0+int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len) +{ +struct trace_info *ti; +char *record; + + ti =init_trace_interface (dpk); + +/* Now do the actual printing */ +rcu_read_lock (); + record =relay_reserve (ti->rchan, output_len); +if (record) +memcpy (record, output, output_len); +else +return -ENOMEM ; +rcu_read_unlock (); + +return 0 ; +} +EXPORT_SYMBOL (debugfs_dump);Index:
linux-2.6.25-rc8-mm1/Documentation/trace.txt
===================================================================
Documentation/trace.txt The steps a kernel data provider takes t · line 153
Quoted 4 lines
Documentation/trace.txt +1
-0@@ -150,6 +150,27 @@ The steps a kernel data provider takes t 5) Destroy the trace channel and underlying relay channel - trace_cleanup(). +Alternatively the user may choose to make use of two new interfaces
two new interfaces --
Documentation/trace.txt The steps a kernel data provider takes t · line 154
Quoted 1 line
Documentation/trace.txt +1
-0+debugfs_printk() and debugfs_dump() to setup trace interface and
and debugfs_dump() -- to setup trace interfaces and
Documentation/trace.txt The steps a kernel data provider takes t · line 157
Quoted 3 lines
Documentation/trace.txt +3
-0+trace_cleanup_all() to tear-down the same. + +Steps to use:
---
~Randy
Re: [RFC Patch 1/1] debugfs_printk and debugfs_dump interface
Quoted 139 lines · Randy Dunlap
Quoted 19 lines · On Mon, 21 Apr 2008 18:13:29 +0530 K. Prasad wrote:
This patch introduces two new interfaces called
debugfs_printkanddebugfs_dumpwhich can be used to print to the debugfs mount directly. It uses the 'trace' infrastructure underneath and is a patch over it. A sample file is also created to demonstrate its ease of use.Signed-off-by K.Prasad <[email protected]>--- Documentation/trace.txt | 21 ++++ include/linux/trace.h | 55 +++++++++++ lib/trace.c | 196 +++++++++++++++++++++++++++++++++++++++-- samples/trace/Makefile | 2 samples/trace/fork_new_trace.c | 97 ++++++++++++++++++++ 5 files changed, 365 insertions(+), 6 deletions(-)Index:
linux-2.6.25-rc8-mm1/lib/trace.c
===================================================================lib/trace.c void trace_cleanup(struct trace_info *tr · line 615
Quoted 7 lines
lib/trace.c +4
-0@@ -561,3 +609,141 @@ void trace_cleanup(struct trace_info *trkfree (trace); }EXPORT_SYMBOL_GPL (trace_cleanup); + +/** +* trace_cleanup_all - Removes all trace_info/directories created under a +* parent_dir kernel-doc requires the "function name - description" to be on one line. You could change the *<tab> to be *<space(s)>.
Quoted 15 lines
lib/trace.c +15
-0+* @parent_dir: Name of the parent directory +*/ +void trace_cleanup_all (const char *parent_dir) +{ +struct list_head *pos, *pos_temp; +struct trace_dir *temp; + +list_for_each_safe (pos, pos_temp, &trace_dirs) { + temp = list_entry(pos, struct trace_dir, trace_dir_list); +if (!strcmp (parent_dir, temp->trace_root->d_iname)) +trace_cleanup (temp->ti); + } +} +EXPORT_SYMBOL_GPL (trace_cleanup_all); +...
lib/trace.c
Quoted 7 lines
lib/trace.c +7
-0+ +/* +* debugfs_printk - A function to write into the debugfs mount 'directly' +* using 'trace' infrastructure +* @dpk - Structure containing info such as parent_dir and directory +* @format - String containing format string specifiers +* @ap - List of arguments This one isn't quite kernel-doc notation, but it's very close to it, and it should be kernel-doc since it's an exported symbol. So it needs the following changes:
- begin with /**
- put function name + short description on one line
- use "@dpk: <description>" for function parameters (not "-")Quoted 24 lines
+ */
lib/trace.c +23
-0+int debugfs_printk (struct debugfs_printk_data *dpk,char *format, ...) +{ +int ret; +struct trace_info *ti; +va_list (ap); +unsigned long flags; + +va_start (ap, format); + + ti =init_trace_interface (dpk); + +/* Now do the actual printing */ +/* Take an RCU Lock over the trace_info state */ +rcu_read_lock (); +/* Take a spinlock for the global buffer used by relay */ +if (dpk->flags &TRACE_GLOBAL_CHANNEL ) +spin_lock_irqsave (&trace_lock, flags); + ret =trace_printf (ti, format, ap); +if (dpk->flags &TRACE_GLOBAL_CHANNEL ) +spin_unlock_irqrestore (&trace_lock, flags); +rcu_read_unlock (); + +va_end (ap);lib/trace.c
Quoted 10 lines
lib/trace.c +10
-0+return ret; +} +EXPORT_SYMBOL (debugfs_printk); + +/* +* debugfs_printk - A function to write into the debugfs mount 'directly' +* using 'trace' infrastructure +* @dpk - Structure containing info such as parent_dir and directory +* @output - Data that needs to be output +* @output_len - Length of the output data Use kernel-doc notation. Same comments as above.
Quoted 27 lines
+ */
lib/trace.c +20
-0+int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len) +{ +struct trace_info *ti; +char *record; + + ti =init_trace_interface (dpk); + +/* Now do the actual printing */ +rcu_read_lock (); + record =relay_reserve (ti->rchan, output_len); +if (record) +memcpy (record, output, output_len); +else +return -ENOMEM ; +rcu_read_unlock (); + +return 0 ; +} +EXPORT_SYMBOL (debugfs_dump);Index:
linux-2.6.25-rc8-mm1/Documentation/trace.txt
===================================================================Documentation/trace.txt The steps a kernel data provider takes t · line 153
Quoted 4 lines
Documentation/trace.txt +1
-0@@ -150,6 +150,27 @@ The steps a kernel data provider takes t 5) Destroy the trace channel and underlying relay channel - trace_cleanup(). +Alternatively the user may choose to make use of two new interfacestwo new interfaces --
Documentation/trace.txt The steps a kernel data provider takes t · line 154
Quoted 1 line
Documentation/trace.txt +1
-0+debugfs_printk() and debugfs_dump() to setup trace interface andand
debugfs_dump()-- to setup trace interfaces and
Quoted 7 lines
Documentation/trace.txt The steps a kernel data provider takes t · line 157
Quoted 3 lines
Documentation/trace.txt +3
-0+trace_cleanup_all() to tear-down the same. + +Steps to use:---
~Randy
Thanks for the review Randy, and teaching me a thing of two about kernel-doc notations!
Please find the revised patch below.
This patch introduces two new interfaces called debugfs_printk and debugfs_dump which can be used to print to the debugfs mount directly. It uses the 'trace' infrastructure underneath and is a patch over it. A sample file is also created to demonstrate its ease of use.
--- Documentation/trace.txt | 21 ++++ include/linux/trace.h | 55 +++++++++++ lib/trace.c | 193 +++++++++++++++++++++++++++++++++++++++-- samples/trace/Makefile | 2 samples/trace/fork_new_trace.c | 97 ++++++++++++++++++++ 5 files changed, 362 insertions(+), 6 deletions(-)
include/linux/trace.h +55 -0
@@ -39,10 +39,31 @@ enum trace_state { TRACE_STOPPED, }; +enum trace_dir_state { +TRACE_PARENT_DIR_ABSENT , +TRACE_PARENT_DIR_EXISTS , +TRACE_DIR_EXISTS +}; +#define TRACE_ROOT_NAME_SIZE 64/* Max root dir identifier */ #define TRACE_NAME_SIZE 64/* Max trace identifier */ /* +* Buffers for use by debugfs_printk +*/ +#define DEFAULT_TRACE_BUF_SIZE 4096 +#define DEFAULT_TRACE_SUB_BUF_NR 40 + +struct debugfs_printk_data { +char *parent_dir; +char *dir; +int exists; +int buf_size; +int sub_buf_size; +unsigned long flags; +}; + +/* * Global root user information */ struct trace_root {
@@ -73,6 +94,17 @@ struct trace_info {unsigned int buf_nr; }; +/* +* Information about every trace directory +*/ +struct trace_dir { +struct list_head trace_dir_list; +char trace_dir_name[TRACE_NAME_SIZE ]; +struct dentry *trace_root; +struct dentry *trace_dir; +struct trace_info *ti; +}; +#ifdef CONFIG_TRACE static inline int trace_running (struct trace_info *trace) {
@@ -83,6 +115,12 @@ struct trace_info *trace_setup(const chaint trace_start (struct trace_info *trace);int trace_stop (struct trace_info *trace);void trace_cleanup (struct trace_info *trace); +int trace_exists (const char *parent_dir,const char *dir, +struct trace_info **ti); +void trace_cleanup_all (const char *parent_dir); +int debugfs_printk (struct debugfs_printk_data *dpk,char *format, ...); +int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len);#else static inline struct trace_info *trace_setup(const char *root, const char *name, u32 buf_size,
@@ -94,6 +132,23 @@ static inline int trace_start(struct trastatic inline int trace_stop (struct trace_info *trace) {return -EINVAL ; }static inline int trace_running (struct trace_info *trace) {return 0 ; }static inline void trace_cleanup (struct trace_info *trace) {} +static inline int trace_exists (const char *parent_dir,const char *dir, +struct trace_info **ti) +{ +return -EINVAL ; +} +static inline void trace_cleanup_all (const char *parent_dir) {} +static inline int debugfs_printk (struct debugfs_printk_data *dpk,char *format, + ...) +{ +return -EINVAL ; +} +int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len) +{ +return -EINVAL ; +} +#endif #endif
lib/trace.c +188 -5
234 lines not on this page · raw message
samples/trace/fork_new_trace.c new file +97 -0
97 lines not on this page · raw message
samples/trace/Makefile +1 -1
@@ -1,4 +1,4 @@ # builds the trace example kernel modules; # then to use (as root): insmod <fork_trace.ko> -obj-$(CONFIG_SAMPLE_TRACE) := fork_trace.o +obj-$(CONFIG_SAMPLE_TRACE) := fork_trace.o fork_new_trace.o
Documentation/trace.txt +21 -0
@@ -150,6 +150,27 @@ The steps a kernel data provider takes t 5) Destroy the trace channel and underlying relay channel - trace_cleanup(). +Alternatively the user may choose to make use of two new interfaces -- +debugfs_printk() and debugfs_dump() -- to setup trace interface and +trace_cleanup_all() to tear-down the same. + +Steps to use: +1) Create and populate an instance of debugfs_printk_data structure. The fields + parent_dir and dir are mandatory. The fields buf_size, sub_buf_size and flags + are optional and will take default values if not populated. The field + 'exists' is for the trace infrastructure to use. +2) Default values for buf_size, sub_buf_size and flags are 4096, 40 and + TRACE_FLIGHT_CHANNEL respectively. +3) Use debugfs_dump() to output binary data which may be acted upon by a + high-level program (say dumping a structure). debugfs_printk() can be used + for string output. Pass a pointer to the instance of debugfs_printk_data + structure to these functions along with other parameters. The output from + these functions can be found at + <debugfs_mount>/<parent_dir>/<dir>/trace<0..n>. +4) trace_cleanup_all() for a given parent directory will cleanup and remove all + trace directories created under the specified directory. +5) Sample code for the same can be found in samples/trace/fork_new_trace.c + Kernel Configuration -------------------- To use trace, configure your kernel with CONFIG_TRACE=y. Trace depends on
Re: [RFC Patch 1/1] debugfs_printk and debugfs_dump interface
Quoted 13 lines · K. Prasad
This patch introduces two new interfaces called
debugfs_printkanddebugfs_dumpwhich can be used to print to the debugfs mount directly. It uses the 'trace' infrastructure underneath and is a patch over it.
A sample file is also created to demonstrate its ease of use.Signed-off-by K.Prasad <[email protected]>--- Documentation/trace.txt | 21 ++++ include/linux/trace.h | 55 +++++++++++ lib/trace.c | 193 +++++++++++++++++++++++++++++++++++++++-- samples/trace/Makefile | 2 samples/trace/fork_new_trace.c | 97 ++++++++++++++++++++ 5 files changed, 362 insertions(+), 6 deletions(-)
lib/trace.c void trace_cleanup(struct trace_info *tr · line 722
Quoted 3 lines
lib/trace.c +3
-0+ +/** +* debugfs_printk - Output binary into debugfs mount 'directly' using 'trace'
Oops. This is the debugfs_dump() function.
Otherwise it looks good. Thanks.
Quoted 7 lines
+ * @dpk: Structure containing info such as
parent_dirand directory
+ * @output: Data that needs to be output
+ * @output_len: Length of the output data
+ */include/linux/trace.h +3
-0+int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len) +{
Signature · 1 line
~Randy
Re: [RFC Patch 1/1] debugfs_printk and debugfs_dump interface
Quoted 17 lines · Randy Dunlap
Quoted 14 lines · K. Prasad
This patch introduces two new interfaces called
debugfs_printkanddebugfs_dumpwhich can be used to print to the debugfs mount directly. It uses the 'trace' infrastructure underneath and is a patch over it. A sample file is also created to demonstrate its ease of use.Signed-off-by K.Prasad <[email protected]>---
Documentation/trace.txt | 21 ++++ include/linux/trace.h | 55 +++++++++++ lib/trace.c | 193 +++++++++++++++++++++++++++++++++++++++-- samples/trace/Makefile | 2 samples/trace/fork_new_trace.c | 97 ++++++++++++++++++++ 5 files changed, 362 insertions(+), 6 deletions(-)
Quoted 6 lines
Quoted 4 lines
(quoted diff) +3
-0+ +/** + * debugfs_printk - Output binary into debugfs mount 'directly' using'trace'
Oops. This is the
debugfs_dump()function.
Missed again. Sending the patch again with that minor change.
Quoted 14 lines
Otherwise it looks good. Thanks.
Quoted 7 lines
+ * @dpk: Structure containing info such as
parent_dirand directory
+ * @output: Data that needs to be output
+ * @output_len: Length of the output data
+ */(quoted diff) +3
-0+int debugfs_dump(struct debugfs_printk_data *dpk, const void *output, + const int output_len) +{Signature · 1 line
~Randy
This patch introduces two new interfaces called debugfs_printk and debugfs_dump which can be used to print to the debugfs mount directly. It uses the 'trace' infrastructure underneath and is a patch over it. A sample file is also created to demonstrate its ease of use.
--- Documentation/trace.txt | 21 ++++ include/linux/trace.h | 55 +++++++++++ lib/trace.c | 193 +++++++++++++++++++++++++++++++++++++++-- samples/trace/Makefile | 2 samples/trace/fork_new_trace.c | 97 ++++++++++++++++++++ 5 files changed, 362 insertions(+), 6 deletions(-)
include/linux/trace.h +55 -0
@@ -39,10 +39,31 @@ enum trace_state { TRACE_STOPPED, }; +enum trace_dir_state { +TRACE_PARENT_DIR_ABSENT , +TRACE_PARENT_DIR_EXISTS , +TRACE_DIR_EXISTS +}; +#define TRACE_ROOT_NAME_SIZE 64/* Max root dir identifier */ #define TRACE_NAME_SIZE 64/* Max trace identifier */ /* +* Buffers for use by debugfs_printk +*/ +#define DEFAULT_TRACE_BUF_SIZE 4096 +#define DEFAULT_TRACE_SUB_BUF_NR 40 + +struct debugfs_printk_data { +char *parent_dir; +char *dir; +int exists; +int buf_size; +int sub_buf_size; +unsigned long flags; +}; + +/* * Global root user information */ struct trace_root {
@@ -73,6 +94,17 @@ struct trace_info {unsigned int buf_nr; }; +/* +* Information about every trace directory +*/ +struct trace_dir { +struct list_head trace_dir_list; +char trace_dir_name[TRACE_NAME_SIZE ]; +struct dentry *trace_root; +struct dentry *trace_dir; +struct trace_info *ti; +}; +#ifdef CONFIG_TRACE static inline int trace_running (struct trace_info *trace) {
@@ -83,6 +115,12 @@ struct trace_info *trace_setup(const chaint trace_start (struct trace_info *trace);int trace_stop (struct trace_info *trace);void trace_cleanup (struct trace_info *trace); +int trace_exists (const char *parent_dir,const char *dir, +struct trace_info **ti); +void trace_cleanup_all (const char *parent_dir); +int debugfs_printk (struct debugfs_printk_data *dpk,char *format, ...); +int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len);#else static inline struct trace_info *trace_setup(const char *root, const char *name, u32 buf_size,
@@ -94,6 +132,23 @@ static inline int trace_start(struct trastatic inline int trace_stop (struct trace_info *trace) {return -EINVAL ; }static inline int trace_running (struct trace_info *trace) {return 0 ; }static inline void trace_cleanup (struct trace_info *trace) {} +static inline int trace_exists (const char *parent_dir,const char *dir, +struct trace_info **ti) +{ +return -EINVAL ; +} +static inline void trace_cleanup_all (const char *parent_dir) {} +static inline int debugfs_printk (struct debugfs_printk_data *dpk,char *format, + ...) +{ +return -EINVAL ; +} +int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len) +{ +return -EINVAL ; +} +#endif #endif
lib/trace.c +188 -5
234 lines not on this page · raw message
samples/trace/fork_new_trace.c new file +97 -0
97 lines not on this page · raw message
samples/trace/Makefile +1 -1
@@ -1,4 +1,4 @@ # builds the trace example kernel modules; # then to use (as root): insmod <fork_trace.ko> -obj-$(CONFIG_SAMPLE_TRACE) := fork_trace.o +obj-$(CONFIG_SAMPLE_TRACE) := fork_trace.o fork_new_trace.o
Documentation/trace.txt +21 -0
@@ -150,6 +150,27 @@ The steps a kernel data provider takes t 5) Destroy the trace channel and underlying relay channel - trace_cleanup(). +Alternatively the user may choose to make use of two new interfaces -- +debugfs_printk() and debugfs_dump() -- to setup trace interface and +trace_cleanup_all() to tear-down the same. + +Steps to use: +1) Create and populate an instance of debugfs_printk_data structure. The fields + parent_dir and dir are mandatory. The fields buf_size, sub_buf_size and flags + are optional and will take default values if not populated. The field + 'exists' is for the trace infrastructure to use. +2) Default values for buf_size, sub_buf_size and flags are 4096, 40 and + TRACE_FLIGHT_CHANNEL respectively. +3) Use debugfs_dump() to output binary data which may be acted upon by a + high-level program (say dumping a structure). debugfs_printk() can be used + for string output. Pass a pointer to the instance of debugfs_printk_data + structure to these functions along with other parameters. The output from + these functions can be found at + <debugfs_mount>/<parent_dir>/<dir>/trace<0..n>. +4) trace_cleanup_all() for a given parent directory will cleanup and remove all + trace directories created under the specified directory. +5) Sample code for the same can be found in samples/trace/fork_new_trace.c + Kernel Configuration -------------------- To use trace, configure your kernel with CONFIG_TRACE=y. Trace depends on
Re: [RFC Patch 1/1] debugfs_printk and debugfs_dump interface
In reply to K. Prasaddebugfs_print makes a great improvement to the trace interface. I missing a couple of bugs the first time I reviewed it. Please see my comments in-line.
Dave..
Quoted 20 lines
lib/trace.c +20
-0+static inline struct trace_info *init_trace_interface (struct +debugfs_printk_data *dpk) +{ +struct trace_info *ti; + + dpk->exists =trace_exists (dpk->parent_dir, dpk->dir, &ti); + +switch (dpk->exists) { + +case TRACE_PARENT_DIR_EXISTS : +case TRACE_PARENT_DIR_ABSENT : +if (!dpk->buf_size) + dpk->buf_size =DEFAULT_TRACE_BUF_SIZE ; +if (!dpk->sub_buf_size) + dpk->sub_buf_size =DEFAULT_TRACE_SUB_BUF_NR ; +if (!dpk->flags) + dpk->flags =TRACE_FLIGHT_CHANNEL ; + ti =trace_setup (dpk->parent_dir, dpk->dir, + dpk->buf_size, dpk->sub_buf_size, dpk->flags); + printk(KERN_INFO "Trace interface %s setup through "
lib/trace.c void trace_cleanup(struct trace_info *tr · line 682
Quoted 10 lines
lib/trace.c +10
-0+"debugfs_printk\n" , + ti->dir->d_iname); +if (IS_ERR (ti)) { +printk (KERN_ERR "Trace interface could not be " +"initialised\n" ); +return PTR_ERR (ti); + } +/* Fall through */ +case TRACE_DIR_EXISTS : +if (ti->state !=TRACE_RUNNING ) {
You should start the trace only if the current state is TRACE_SETUP (I think). See my comment in debugfs_print()
if (ti->state == TRACE_SETUP)
Quoted 13 lines
lib/trace.c +13
-0+trace_start (ti); + } + } +return ti; +} + +/* +* debugfs_printk - A function to write into the debugfs mount 'directly' +* using 'trace' infrastructure +* @dpk - Structure containing info such as parent_dir and directory +* @format - String containing format string specifiers +* @ap - List of arguments +*/
lib/trace.c void trace_cleanup(struct trace_info *tr · line 705
Quoted 10 lines
lib/trace.c +10
-0+int debugfs_printk (struct debugfs_printk_data *dpk,char *format, ...) +{ +int ret; +struct trace_info *ti; +va_list (ap); +unsigned long flags; + +va_start (ap, format); + + ti =init_trace_interface (dpk);
init_trace_interface() alway sets trace->state to TRACE_RUNNING . The results is that the user is prevented from stopping the trace. You can see this in fork_new_trace.
$ cat debug/trace_new_example/do_fork/state running $ echo stop > debug/trace_new_example/do_fork/state $ cat debug/trace_new_example/do_fork/state running
Quoted 21 lines
lib/trace.c +21
-0+ +/* Now do the actual printing */ +/* Take an RCU Lock over the trace_info state */ +rcu_read_lock (); +/* Take a spinlock for the global buffer used by relay */ +if (dpk->flags &TRACE_GLOBAL_CHANNEL ) +spin_lock_irqsave (&trace_lock, flags); + ret =trace_printf (ti, format, ap); +if (dpk->flags &TRACE_GLOBAL_CHANNEL ) +spin_unlock_irqrestore (&trace_lock, flags); +rcu_read_unlock (); + +va_end (ap); +return ret; +} +EXPORT_SYMBOL (debugfs_printk); + +/* +* debugfs_printk - A function to write into the debugfs mount 'directly' +* using 'trace' infrastructure +* @dpk - Structure containing info such as parent_dir and directory
lib/trace.c void trace_cleanup(struct trace_info *tr · line 736
Quoted 10 lines
lib/trace.c +10
-0+* @output - Data that needs to be output +* @output_len - Length of the output data +*/ +int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len) +{ +struct trace_info *ti; +char *record; + + ti =init_trace_interface (dpk);
Same issue as debugfs_printf,
You should also check for trace_running as you did for trace_printf.
Quoted 13 lines
lib/trace.c +13
-0+ +/* Now do the actual printing */ +rcu_read_lock (); + record =relay_reserve (ti->rchan, output_len); +if (record) +memcpy (record, output, output_len); +else +return -ENOMEM ; +rcu_read_unlock (); + +return 0 ; +} +EXPORT_SYMBOL (debugfs_dump);
Re: [RFC Patch 1/1] debugfs_printk and debugfs_dump interface
Quoted 2 lines · David Wilder
debugfs_printmakes a great improvement to the trace interface. I
Thanks.
Quoted 62 lines
missing a couple of bugs the first time I reviewed it. Please see my comments in-line.
Dave..
Quoted 22 lines
(quoted diff) +21
-0+static inline struct trace_info *init_trace_interface(struct + debugfs_printk_data *dpk) +{ + struct trace_info *ti; + + dpk->exists = trace_exists(dpk->parent_dir, dpk->dir, &ti); + + switch(dpk->exists) { + + case TRACE_PARENT_DIR_EXISTS: + case TRACE_PARENT_DIR_ABSENT: + if(!dpk->buf_size) + dpk->buf_size = DEFAULT_TRACE_BUF_SIZE; + if(!dpk->sub_buf_size) + dpk->sub_buf_size = DEFAULT_TRACE_SUB_BUF_NR; + if(!dpk->flags) + dpk->flags = TRACE_FLIGHT_CHANNEL; + ti = trace_setup(dpk->parent_dir, dpk->dir, + dpk->buf_size, dpk->sub_buf_size, dpk->flags); + printk(KERN_INFO "Trace interface %s setup through " +"debugfs_printk\n",
Review
Quoted 9 lines
(quoted diff) +9
-0+ ti->dir->d_iname); + if (IS_ERR(ti)) { + printk(KERN_ERR "Trace interface could not be " + "initialised\n"); + return PTR_ERR(ti); + } + /* Fall through */ + case TRACE_DIR_EXISTS: + if (ti->state != TRACE_RUNNING) {You should start the trace only if the current state is
TRACE_SETUP(I think). See my comment indebugfs_print()if (ti->state == TRACE_SETUP)Quoted 19 lines
(quoted diff) +19
-0+ trace_start(ti); + } + } + return ti; +} + +/* + * debugfs_printk - A function to write into the debugfs mount 'directly' + * using 'trace' infrastructure + * @dpk - Structure containing info such as parent_dir and directory + * @format - String containing format string specifiers + * @ap - List of arguments + */ +int debugfs_printk(struct debugfs_printk_data *dpk, char *format, ...) +{ + int ret; + struct trace_info *ti; + va_list(ap); + unsigned long flags;
Quoted 8 lines
Review
Quoted 4 lines
(quoted diff) +4
-0+ + va_start(ap, format); + + ti = init_trace_interface(dpk);
init_trace_interface()alway setstrace->statetoTRACE_RUNNING. The results is that the user is prevented from stopping the trace. You can see this infork_new_trace.
This is actually an intentional design to guarantee that debugfs_* would output the data overriding the control (the state was retained to enable interoperability with other users of trace over the same parent_dir/dir combination).
On further thought, it does make sense to enable the user to control the output.
I will include your suggested changes.
Quoted 41 lines
$ cat debug/trace_new_example/do_fork/state running $ echo stop > debug/trace_new_example/do_fork/state $ cat debug/trace_new_example/do_fork/state runningQuoted 21 lines
(quoted diff) +21
-0+ + /* Now do the actual printing */ + /* Take an RCU Lock over the trace_info state */ + rcu_read_lock(); + /* Take a spinlock for the global buffer used by relay */ + if (dpk->flags & TRACE_GLOBAL_CHANNEL) + spin_lock_irqsave(&trace_lock, flags); + ret = trace_printf(ti, format, ap); + if (dpk->flags & TRACE_GLOBAL_CHANNEL) + spin_unlock_irqrestore(&trace_lock, flags); + rcu_read_unlock(); + + va_end(ap); + return ret; +} +EXPORT_SYMBOL(debugfs_printk); + +/* + * debugfs_printk - A function to write into the debugfs mount 'directly' + * using 'trace' infrastructure + * @dpk - Structure containing info such as parent_dir and directoryReview
Quoted 10 lines
(quoted diff) +10
-0+ * @output - Data that needs to be output + * @output_len - Length of the output data + */ +int debugfs_dump(struct debugfs_printk_data *dpk, const void *output, + const int output_len) +{ + struct trace_info *ti; + char *record; + + ti = init_trace_interface(dpk);Same issue as
debugfs_printf,
Quoted 1 line
You should also check for
trace_runningas you did fortrace_printf.
Thanks for pointing this out. I missed it. I'm also enclosing the memcpy with a spinlock if the TRACE_GLOBAL_CHANNEL flag is set. Please find the new patch below.
Quoted 15 lines
Quoted 5 lines
(quoted diff) +3
-0+ + /* Now do the actual printing */ + rcu_read_lock();Review
Quoted 10 lines
(quoted diff) +10
-0+ record = relay_reserve(ti->rchan, output_len); + if (record) + memcpy(record, output, output_len); + else + return -ENOMEM; + rcu_read_unlock(); + + return 0; +} +EXPORT_SYMBOL(debugfs_dump);
This patch introduces two new interfaces called debugfs_printk and debugfs_dump which can be used to print to the debugfs mount directly. It uses the 'trace' infrastructure underneath and is a patch over it. A sample file is also created to demonstrate its ease of use.
--- Documentation/trace.txt | 21 ++++ include/linux/trace.h | 55 +++++++++++ lib/trace.c | 202 +++++++++++++++++++++++++++++++++++++++-- samples/trace/Makefile | 2 samples/trace/fork_new_trace.c | 97 +++++++++++++++++++ 5 files changed, 371 insertions(+), 6 deletions(-)
include/linux/trace.h +55 -0
@@ -39,10 +39,31 @@ enum trace_state { TRACE_STOPPED, }; +enum trace_dir_state { +TRACE_PARENT_DIR_ABSENT , +TRACE_PARENT_DIR_EXISTS , +TRACE_DIR_EXISTS +}; +#define TRACE_ROOT_NAME_SIZE 64/* Max root dir identifier */ #define TRACE_NAME_SIZE 64/* Max trace identifier */ /* +* Buffers for use by debugfs_printk +*/ +#define DEFAULT_TRACE_BUF_SIZE 4096 +#define DEFAULT_TRACE_SUB_BUF_NR 40 + +struct debugfs_printk_data { +char *parent_dir; +char *dir; +int exists; +int buf_size; +int sub_buf_size; +unsigned long flags; +}; + +/* * Global root user information */ struct trace_root {
@@ -73,6 +94,17 @@ struct trace_info {unsigned int buf_nr; }; +/* +* Information about every trace directory +*/ +struct trace_dir { +struct list_head trace_dir_list; +char trace_dir_name[TRACE_NAME_SIZE ]; +struct dentry *trace_root; +struct dentry *trace_dir; +struct trace_info *ti; +}; +#ifdef CONFIG_TRACE static inline int trace_running (struct trace_info *trace) {
@@ -83,6 +115,12 @@ struct trace_info *trace_setup(const chaint trace_start (struct trace_info *trace);int trace_stop (struct trace_info *trace);void trace_cleanup (struct trace_info *trace); +int trace_exists (const char *parent_dir,const char *dir, +struct trace_info **ti); +void trace_cleanup_all (const char *parent_dir); +int debugfs_printk (struct debugfs_printk_data *dpk,char *format, ...); +int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len);#else static inline struct trace_info *trace_setup(const char *root, const char *name, u32 buf_size,
@@ -94,6 +132,23 @@ static inline int trace_start(struct trastatic inline int trace_stop (struct trace_info *trace) {return -EINVAL ; }static inline int trace_running (struct trace_info *trace) {return 0 ; }static inline void trace_cleanup (struct trace_info *trace) {} +static inline int trace_exists (const char *parent_dir,const char *dir, +struct trace_info **ti) +{ +return -EINVAL ; +} +static inline void trace_cleanup_all (const char *parent_dir) {} +static inline int debugfs_printk (struct debugfs_printk_data *dpk,char *format, + ...) +{ +return -EINVAL ; +} +int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len) +{ +return -EINVAL ; +} +#endif #endif
lib/trace.c +197 -5
243 lines not on this page · raw message
samples/trace/fork_new_trace.c new file +97 -0
97 lines not on this page · raw message
samples/trace/Makefile +1 -1
@@ -1,4 +1,4 @@ # builds the trace example kernel modules; # then to use (as root): insmod <fork_trace.ko> -obj-$(CONFIG_SAMPLE_TRACE) := fork_trace.o +obj-$(CONFIG_SAMPLE_TRACE) := fork_trace.o fork_new_trace.o
Documentation/trace.txt +21 -0
@@ -150,6 +150,27 @@ The steps a kernel data provider takes t 5) Destroy the trace channel and underlying relay channel - trace_cleanup(). +Alternatively the user may choose to make use of two new interfaces -- +debugfs_printk() and debugfs_dump() -- to setup trace interface and +trace_cleanup_all() to tear-down the same. + +Steps to use: +1) Create and populate an instance of debugfs_printk_data structure. The fields + parent_dir and dir are mandatory. The fields buf_size, sub_buf_size and flags + are optional and will take default values if not populated. The field + 'exists' is for the trace infrastructure to use. +2) Default values for buf_size, sub_buf_size and flags are 4096, 40 and + TRACE_FLIGHT_CHANNEL respectively. +3) Use debugfs_dump() to output binary data which may be acted upon by a + high-level program (say dumping a structure). debugfs_printk() can be used + for string output. Pass a pointer to the instance of debugfs_printk_data + structure to these functions along with other parameters. The output from + these functions can be found at + <debugfs_mount>/<parent_dir>/<dir>/trace<0..n>. +4) trace_cleanup_all() for a given parent directory will cleanup and remove all + trace directories created under the specified directory. +5) Sample code for the same can be found in samples/trace/fork_new_trace.c + Kernel Configuration -------------------- To use trace, configure your kernel with CONFIG_TRACE=y. Trace depends on
Re: [RFC Patch 1/1] debugfs_printk and debugfs_dump interface
Quoted 2 lines · K. Prasad
Please find the new patch below.
Quoted 1 line
Let the email slip through a little early. Please find the revised patch below.
Thanks,
K.Prasad
This patch introduces two new interfaces called debugfs_printk and debugfs_dump which can be used to print to the debugfs mount directly. It uses the 'trace' infrastructure underneath and is a patch over it. A sample file is also created to demonstrate its ease of use.
--- Documentation/trace.txt | 21 ++++ include/linux/trace.h | 55 +++++++++++ lib/trace.c | 202 +++++++++++++++++++++++++++++++++++++++-- samples/trace/Makefile | 2 samples/trace/fork_new_trace.c | 97 +++++++++++++++++++ 5 files changed, 371 insertions(+), 6 deletions(-)
include/linux/trace.h +55 -0
@@ -39,10 +39,31 @@ enum trace_state { TRACE_STOPPED, }; +enum trace_dir_state { +TRACE_PARENT_DIR_ABSENT , +TRACE_PARENT_DIR_EXISTS , +TRACE_DIR_EXISTS +}; +#define TRACE_ROOT_NAME_SIZE 64/* Max root dir identifier */ #define TRACE_NAME_SIZE 64/* Max trace identifier */ /* +* Buffers for use by debugfs_printk +*/ +#define DEFAULT_TRACE_BUF_SIZE 4096 +#define DEFAULT_TRACE_SUB_BUF_NR 40 + +struct debugfs_printk_data { +char *parent_dir; +char *dir; +int exists; +int buf_size; +int sub_buf_size; +unsigned long flags; +}; + +/* * Global root user information */ struct trace_root {
@@ -73,6 +94,17 @@ struct trace_info {unsigned int buf_nr; }; +/* +* Information about every trace directory +*/ +struct trace_dir { +struct list_head trace_dir_list; +char trace_dir_name[TRACE_NAME_SIZE ]; +struct dentry *trace_root; +struct dentry *trace_dir; +struct trace_info *ti; +}; +#ifdef CONFIG_TRACE static inline int trace_running (struct trace_info *trace) {
@@ -83,6 +115,12 @@ struct trace_info *trace_setup(const chaint trace_start (struct trace_info *trace);int trace_stop (struct trace_info *trace);void trace_cleanup (struct trace_info *trace); +int trace_exists (const char *parent_dir,const char *dir, +struct trace_info **ti); +void trace_cleanup_all (const char *parent_dir); +int debugfs_printk (struct debugfs_printk_data *dpk,char *format, ...); +int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len);#else static inline struct trace_info *trace_setup(const char *root, const char *name, u32 buf_size,
@@ -94,6 +132,23 @@ static inline int trace_start(struct trastatic inline int trace_stop (struct trace_info *trace) {return -EINVAL ; }static inline int trace_running (struct trace_info *trace) {return 0 ; }static inline void trace_cleanup (struct trace_info *trace) {} +static inline int trace_exists (const char *parent_dir,const char *dir, +struct trace_info **ti) +{ +return -EINVAL ; +} +static inline void trace_cleanup_all (const char *parent_dir) {} +static inline int debugfs_printk (struct debugfs_printk_data *dpk,char *format, + ...) +{ +return -EINVAL ; +} +int debugfs_dump (struct debugfs_printk_data *dpk,const void *output, +const int output_len) +{ +return -EINVAL ; +} +#endif #endif
lib/trace.c +197 -5
244 lines not on this page · raw message
samples/trace/fork_new_trace.c new file +97 -0
97 lines not on this page · raw message
samples/trace/Makefile +1 -1
@@ -1,4 +1,4 @@ # builds the trace example kernel modules; # then to use (as root): insmod <fork_trace.ko> -obj-$(CONFIG_SAMPLE_TRACE) := fork_trace.o +obj-$(CONFIG_SAMPLE_TRACE) := fork_trace.o fork_new_trace.o
Documentation/trace.txt +21 -0
@@ -150,6 +150,27 @@ The steps a kernel data provider takes t 5) Destroy the trace channel and underlying relay channel - trace_cleanup(). +Alternatively the user may choose to make use of two new interfaces -- +debugfs_printk() and debugfs_dump() -- to setup trace interface and +trace_cleanup_all() to tear-down the same. + +Steps to use: +1) Create and populate an instance of debugfs_printk_data structure. The fields + parent_dir and dir are mandatory. The fields buf_size, sub_buf_size and flags + are optional and will take default values if not populated. The field + 'exists' is for the trace infrastructure to use. +2) Default values for buf_size, sub_buf_size and flags are 4096, 40 and + TRACE_FLIGHT_CHANNEL respectively. +3) Use debugfs_dump() to output binary data which may be acted upon by a + high-level program (say dumping a structure). debugfs_printk() can be used + for string output. Pass a pointer to the instance of debugfs_printk_data + structure to these functions along with other parameters. The output from + these functions can be found at + <debugfs_mount>/<parent_dir>/<dir>/trace<0..n>. +4) trace_cleanup_all() for a given parent directory will cleanup and remove all + trace directories created under the specified directory. +5) Sample code for the same can be found in samples/trace/fork_new_trace.c + Kernel Configuration -------------------- To use trace, configure your kernel with CONFIG_TRACE=y. Trace depends on
Re: [RFC Patch 1/1] debugfs_printk and debugfs_dump interface
Quoted 6 lines · K. Prasad
Quoted 2 lines · K. Prasad
Please find the new patch below.
Quoted 1 line
Let the email slip through a little early. Please find the revised patch below.
Quoted 7 lines
Thanks,
K.PrasadThis patch introduces two new interfaces called
debugfs_printkanddebugfs_dumpwhich can be used to print to the debugfs mount directly. It uses the 'trace' infrastructure underneath and is a patch over it. A sample file is also created to demonstrate its ease of use.
I still think debugfs_printk() is not the right name, as it is not part of the existing family of debugfs_* routines.
Quoted 5 lines
Documentation/trace.txt | 21 ++++ include/linux/trace.h | 55 +++++++++++ lib/trace.c | 202 +++++++++++++++++++++++++++++++++++++++-- samples/trace/Makefile | 2 samples/trace/fork_new_trace.c | 97 +++++++++++++++++++
And it's not in debugfs.h
cheers
Signature · 8 lines
Michael Ellerman OzLabs, IBM Australia Development Lab wwweb: http://michael.ellerman.id.au phone: +61 2 6212 1183 (tie line 70 21183) We do not inherit the earth from our ancestors, we borrow it from our children. - S.M.A.R.T Person
Re: [RFC Patch 1/1] debugfs_printk and debugfs_dump interface
Quoted 10 lines · Michael Ellerman
Quoted 9 lines · K. Prasad
Quoted 2 lines · K. Prasad
Please find the new patch below.
Quoted 1 line
Let the email slip through a little early. Please find the revised patch below.
Thanks,
K.Prasad
Quoted 7 lines
Quoted 4 lines
This patch introduces two new interfaces called
debugfs_printkanddebugfs_dumpwhich can be used to print to the debugfs mount directly. It uses the 'trace' infrastructure underneath and is a patch over it. A sample file is also created to demonstrate its ease of use.I still think
debugfs_printk()is not the right name, as it is not part of the existing family of debugfs_* routines.
Whether to call it trace_printk() and trace_dump() is a suggestion I would like to ask David Wilder (and others). Let me know if you think there are better names.
Thanks,
K.Prasad
Re: [RFC Patch 1/1] debugfs_printk and debugfs_dump interface
Quoted 16 lines · K. Prasad
Quoted 15 lines · Michael Ellerman
Quoted 13 lines · K. Prasad
Quoted 2 lines · K. Prasad
Please find the new patch below.
Quoted 1 line
Let the email slip through a little early. Please find the revised patch below.
Thanks,
K.PrasadThis patch introduces two new interfaces called
debugfs_printkanddebugfs_dumpwhich can be used to print to the debugfs mount directly. It uses the 'trace' infrastructure underneath and is a patch over it. A sample file is also created to demonstrate its ease of use.
Quoted 6 lines
Quoted 2 lines
I still think
debugfs_printk()is not the right name, as it is not part of the existing family of debugfs_* routines.Whether to call it
trace_printk()andtrace_dump()is a suggestion I would like to ask David Wilder (and others). Let me know if you think there are better names.
That would be my pick, given that it's using the trace infrastructure and it's defined in trace.h, implemented in trace.c, and documented in trace.txt :)
cheers
Signature · 8 lines
Michael Ellerman OzLabs, IBM Australia Development Lab wwweb: http://michael.ellerman.id.au phone: +61 2 6212 1183 (tie line 70 21183) We do not inherit the earth from our ancestors, we borrow it from our children. - S.M.A.R.T Person