* [PATCH 0/4] gcov kernel support
@ 2009-05-07 12:45 Peter Oberparleiter
2009-05-07 12:45 ` [PATCH 1/4] kernel: constructor support Peter Oberparleiter
` (3 more replies)
0 siblings, 4 replies; 23+ messages in thread
From: Peter Oberparleiter @ 2009-05-07 12:45 UTC (permalink / raw)
To: linux-kernel
Cc: Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman
This patchset implements support for performing kernel code coverage
measurements based on gcc's gcov mechanism. It can be used to improve
kernel code quality by identifying code parts which are not exercised
during test cases. Patch base is 2.6.30-rc4.
Changes since last version:
* fix return code of gcov_seq_show
Patch overview:
[PATCH 1/4] kernel: constructor support
[PATCH 2/4] seq_file: add function to write binary data
[PATCH 3/4] gcov: add gcov profiling infrastructure
[PATCH 4/4] gcov: enable GCOV_PROFILE_ALL for x86_64
For more information see Documentation/gcov.txt and the previous post:
http://marc.info/?l=linux-kernel&m=123565658224661
^ permalink raw reply [flat|nested] 23+ messages in thread* [PATCH 1/4] kernel: constructor support 2009-05-07 12:45 [PATCH 0/4] gcov kernel support Peter Oberparleiter @ 2009-05-07 12:45 ` Peter Oberparleiter 2009-05-07 12:51 ` Ingo Molnar 2009-05-07 12:53 ` Ingo Molnar 2009-05-07 12:45 ` [PATCH 2/4] seq_file: add function to write binary data Peter Oberparleiter ` (2 subsequent siblings) 3 siblings, 2 replies; 23+ messages in thread From: Peter Oberparleiter @ 2009-05-07 12:45 UTC (permalink / raw) To: linux-kernel Cc: Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Rusty Russell, Sam Ravnborg, Jeff Dike [-- Attachment #1: kernel-constructor-support.patch --] [-- Type: text/plain, Size: 5117 bytes --] From: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> Call constructors (gcc-generated initcall-like functions) during kernel start and module load. Constructors are e.g. used for gcov data initialization. Disable constructor support for usermode Linux to prevent conflicts with host glibc. Signed-off-by: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> Acked-by: Rusty Russell <rusty@rustcorp.com.au> Cc: Sam Ravnborg <sam@ravnborg.org> Cc: Jeff Dike <jdike@addtoit.com> --- include/asm-generic/vmlinux.lds.h | 11 ++++++++++- include/linux/init.h | 2 ++ include/linux/module.h | 6 ++++++ init/Kconfig | 5 +++++ init/main.c | 13 +++++++++++++ kernel/module.c | 16 ++++++++++++++++ 6 files changed, 52 insertions(+), 1 deletion(-) Index: linux-2.6.30-rc4/include/asm-generic/vmlinux.lds.h =================================================================== --- linux-2.6.30-rc4.orig/include/asm-generic/vmlinux.lds.h +++ linux-2.6.30-rc4/include/asm-generic/vmlinux.lds.h @@ -332,6 +332,14 @@ /* Section used for early init (in .S files) */ #define HEAD_TEXT *(HEAD_TEXT_SECTION) +#ifdef CONFIG_CONSTRUCTORS +#define KERNEL_CTORS() VMLINUX_SYMBOL(__ctors_start) = .; \ + *(.ctors) \ + VMLINUX_SYMBOL(__ctors_end) = .; +#else +#define KERNEL_CTORS() +#endif + /* init and exit section handling */ #define INIT_DATA \ *(.init.data) \ @@ -340,7 +348,8 @@ CPU_DISCARD(init.data) \ CPU_DISCARD(init.rodata) \ MEM_DISCARD(init.data) \ - MEM_DISCARD(init.rodata) + MEM_DISCARD(init.rodata) \ + KERNEL_CTORS() #define INIT_TEXT \ *(.init.text) \ Index: linux-2.6.30-rc4/include/linux/init.h =================================================================== --- linux-2.6.30-rc4.orig/include/linux/init.h +++ linux-2.6.30-rc4/include/linux/init.h @@ -136,6 +136,8 @@ typedef void (*exitcall_t)(void); extern initcall_t __con_initcall_start[], __con_initcall_end[]; extern initcall_t __security_initcall_start[], __security_initcall_end[]; +typedef void (*ctorcall_t)(void); + /* Defined in init/main.c */ extern int do_one_initcall(initcall_t fn); extern char __initdata boot_command_line[]; Index: linux-2.6.30-rc4/include/linux/module.h =================================================================== --- linux-2.6.30-rc4.orig/include/linux/module.h +++ linux-2.6.30-rc4/include/linux/module.h @@ -354,6 +354,12 @@ struct module local_t ref; #endif #endif + +#ifdef CONFIG_CONSTRUCTORS + /* Constructor functions. */ + ctorcall_t *ctors; + unsigned int num_ctors; +#endif }; #ifndef MODULE_ARCH_INIT #define MODULE_ARCH_INIT {} Index: linux-2.6.30-rc4/init/main.c =================================================================== --- linux-2.6.30-rc4.orig/init/main.c +++ linux-2.6.30-rc4/init/main.c @@ -700,6 +700,18 @@ asmlinkage void __init start_kernel(void rest_init(); } +/* Call all constructor functions linked into the kernel. */ +static void __init do_ctors(void) +{ +#ifdef CONFIG_CONSTRUCTORS + extern ctorcall_t __ctors_start[], __ctors_end[]; + ctorcall_t *call; + + for (call = __ctors_start; call < __ctors_end; call++) + (*call)(); +#endif +} + int initcall_debug; core_param(initcall_debug, initcall_debug, bool, 0644); @@ -780,6 +792,7 @@ static void __init do_basic_setup(void) usermodehelper_init(); driver_init(); init_irq_proc(); + do_ctors(); do_initcalls(); } Index: linux-2.6.30-rc4/kernel/module.c =================================================================== --- linux-2.6.30-rc4.orig/kernel/module.c +++ linux-2.6.30-rc4/kernel/module.c @@ -2172,6 +2172,10 @@ static noinline struct module *load_modu sizeof(*mod->tracepoints), &mod->num_tracepoints); #endif +#ifdef CONFIG_CONSTRUCTORS + mod->ctors = section_objs(hdr, sechdrs, secstrings, ".ctors", + sizeof(*mod->ctors), &mod->num_ctors); +#endif #ifdef CONFIG_MODVERSIONS if ((mod->num_syms && !mod->crcs) @@ -2328,6 +2332,17 @@ static noinline struct module *load_modu goto free_hdr; } +/* Call module constructors. */ +static void do_mod_ctors(struct module *mod) +{ +#ifdef CONFIG_CONSTRUCTORS + unsigned long i; + + for (i = 0; i < mod->num_ctors; i++) + mod->ctors[i](); +#endif +} + /* This is where the real work happens */ SYSCALL_DEFINE3(init_module, void __user *, umod, unsigned long, len, const char __user *, uargs) @@ -2356,6 +2371,7 @@ SYSCALL_DEFINE3(init_module, void __user blocking_notifier_call_chain(&module_notify_list, MODULE_STATE_COMING, mod); + do_mod_ctors(mod); /* Start the module */ if (mod->init != NULL) ret = do_one_initcall(mod->init); Index: linux-2.6.30-rc4/init/Kconfig =================================================================== --- linux-2.6.30-rc4.orig/init/Kconfig +++ linux-2.6.30-rc4/init/Kconfig @@ -16,6 +16,11 @@ config DEFCONFIG_LIST default "$ARCH_DEFCONFIG" default "arch/$ARCH/defconfig" +config CONSTRUCTORS + bool + depends on !UML + default y + menu "General setup" config EXPERIMENTAL ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 1/4] kernel: constructor support 2009-05-07 12:45 ` [PATCH 1/4] kernel: constructor support Peter Oberparleiter @ 2009-05-07 12:51 ` Ingo Molnar 2009-05-07 13:33 ` Peter Oberparleiter 2009-05-07 12:53 ` Ingo Molnar 1 sibling, 1 reply; 23+ messages in thread From: Ingo Molnar @ 2009-05-07 12:51 UTC (permalink / raw) To: Peter Oberparleiter Cc: linux-kernel, Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Rusty Russell, Sam Ravnborg, Jeff Dike * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> wrote: > +typedef void (*ctorcall_t)(void); that name is pretty ugly. Please change it to the usual kernel convention for function pointers: typedef void (*ctor_fn_t)(void); Thanks, Ingo ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 1/4] kernel: constructor support 2009-05-07 12:51 ` Ingo Molnar @ 2009-05-07 13:33 ` Peter Oberparleiter 0 siblings, 0 replies; 23+ messages in thread From: Peter Oberparleiter @ 2009-05-07 13:33 UTC (permalink / raw) To: Ingo Molnar Cc: linux-kernel, Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Rusty Russell, Sam Ravnborg, Jeff Dike Ingo Molnar wrote: > * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> wrote: > >> +typedef void (*ctorcall_t)(void); > > that name is pretty ugly. Please change it to the usual kernel > convention for function pointers: > > typedef void (*ctor_fn_t)(void); Ok, will do. Thanks. ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 1/4] kernel: constructor support 2009-05-07 12:45 ` [PATCH 1/4] kernel: constructor support Peter Oberparleiter 2009-05-07 12:51 ` Ingo Molnar @ 2009-05-07 12:53 ` Ingo Molnar 2009-05-07 13:38 ` Peter Oberparleiter 1 sibling, 1 reply; 23+ messages in thread From: Ingo Molnar @ 2009-05-07 12:53 UTC (permalink / raw) To: Peter Oberparleiter Cc: linux-kernel, Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Rusty Russell, Sam Ravnborg, Jeff Dike * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> wrote: > Disable constructor support for usermode Linux to prevent conflicts > with host glibc. > +++ linux-2.6.30-rc4/init/Kconfig > @@ -16,6 +16,11 @@ config DEFCONFIG_LIST > default "$ARCH_DEFCONFIG" > default "arch/$ARCH/defconfig" > > +config CONSTRUCTORS > + bool > + depends on !UML > + default y > + > menu "General setup" Hm, excluding UML like that is sad. Is there no better solution? Ingo ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 1/4] kernel: constructor support 2009-05-07 12:53 ` Ingo Molnar @ 2009-05-07 13:38 ` Peter Oberparleiter 2009-05-07 13:48 ` Ingo Molnar 0 siblings, 1 reply; 23+ messages in thread From: Peter Oberparleiter @ 2009-05-07 13:38 UTC (permalink / raw) To: Ingo Molnar Cc: linux-kernel, Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Rusty Russell, Sam Ravnborg, Jeff Dike Ingo Molnar wrote: > * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> wrote: > >> Disable constructor support for usermode Linux to prevent conflicts >> with host glibc. > >> +++ linux-2.6.30-rc4/init/Kconfig >> @@ -16,6 +16,11 @@ config DEFCONFIG_LIST >> default "$ARCH_DEFCONFIG" >> default "arch/$ARCH/defconfig" >> >> +config CONSTRUCTORS >> + bool >> + depends on !UML >> + default y >> + >> menu "General setup" > > Hm, excluding UML like that is sad. Is there no better solution? UML is excluded because in that environment constructors are called by the host glibc, so there is no need for kernel support on UML (in fact it would break things). Or were you referring to the actual way the exclusion is implemented? ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 1/4] kernel: constructor support 2009-05-07 13:38 ` Peter Oberparleiter @ 2009-05-07 13:48 ` Ingo Molnar 2009-05-08 11:23 ` Peter Oberparleiter 0 siblings, 1 reply; 23+ messages in thread From: Ingo Molnar @ 2009-05-07 13:48 UTC (permalink / raw) To: Peter Oberparleiter Cc: linux-kernel, Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Rusty Russell, Sam Ravnborg, Jeff Dike * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> wrote: > Ingo Molnar wrote: >> * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> wrote: >> >>> Disable constructor support for usermode Linux to prevent conflicts >>> with host glibc. >> >>> +++ linux-2.6.30-rc4/init/Kconfig >>> @@ -16,6 +16,11 @@ config DEFCONFIG_LIST >>> default "$ARCH_DEFCONFIG" >>> default "arch/$ARCH/defconfig" >>> +config CONSTRUCTORS >>> + bool >>> + depends on !UML >>> + default y >>> + >>> menu "General setup" >> >> Hm, excluding UML like that is sad. Is there no better solution? > > UML is excluded because in that environment constructors are > called by the host glibc, so there is no need for kernel support > on UML (in fact it would break things). > > Or were you referring to the actual way the exclusion is > implemented? the way it's done is OK (there's really just UML in this situation), but the question is really, shouldnt it be possible to coverage-test UML instances 'from the inside'? Plus, if any other kernel facility grows out of this or makes use of it, UML will be left out in the cold. Ingo ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 1/4] kernel: constructor support 2009-05-07 13:48 ` Ingo Molnar @ 2009-05-08 11:23 ` Peter Oberparleiter 0 siblings, 0 replies; 23+ messages in thread From: Peter Oberparleiter @ 2009-05-08 11:23 UTC (permalink / raw) To: Ingo Molnar Cc: linux-kernel, Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Rusty Russell, Sam Ravnborg, Jeff Dike Ingo Molnar wrote: > * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> wrote: >> Ingo Molnar wrote: >>> * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> wrote: >>> >>>> Disable constructor support for usermode Linux to prevent conflicts >>>> with host glibc. >>>> +++ linux-2.6.30-rc4/init/Kconfig >>>> @@ -16,6 +16,11 @@ config DEFCONFIG_LIST >>>> default "$ARCH_DEFCONFIG" >>>> default "arch/$ARCH/defconfig" >>>> +config CONSTRUCTORS >>>> + bool >>>> + depends on !UML >>>> + default y >>>> + >>>> menu "General setup" >>> Hm, excluding UML like that is sad. Is there no better solution? >> UML is excluded because in that environment constructors are >> called by the host glibc, so there is no need for kernel support >> on UML (in fact it would break things). >> >> Or were you referring to the actual way the exclusion is >> implemented? > > the way it's done is OK (there's really just UML in this situation), > but the question is really, shouldnt it be possible to coverage-test > UML instances 'from the inside'? From a mere gcov perspective, coverage-testing from the outside is superior because that is the way it was meant to be run in the first place. > > Plus, if any other kernel facility grows out of this or makes use of > it, UML will be left out in the cold. I'm afraid that trying to over-engineer the gcov-kernel mechanism at this time might serve neither the gcov-kernel users, nor potential new users. Once the base is established, it will be far easier to decide which other purposes the infrastructure can serve (without completely bending it). ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 2/4] seq_file: add function to write binary data 2009-05-07 12:45 [PATCH 0/4] gcov kernel support Peter Oberparleiter 2009-05-07 12:45 ` [PATCH 1/4] kernel: constructor support Peter Oberparleiter @ 2009-05-07 12:45 ` Peter Oberparleiter 2009-05-07 12:45 ` [PATCH 3/4] gcov: add gcov profiling infrastructure Peter Oberparleiter 2009-05-07 12:46 ` [PATCH 4/4] gcov: enable GCOV_PROFILE_ALL for x86_64 Peter Oberparleiter 3 siblings, 0 replies; 23+ messages in thread From: Peter Oberparleiter @ 2009-05-07 12:45 UTC (permalink / raw) To: linux-kernel Cc: Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Al Viro [-- Attachment #1: seq_file-add-function-to-write-binary-data.patch --] [-- Type: text/plain, Size: 1908 bytes --] From: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> seq_write() can be used to construct seq_files containing arbitrary data. Required by the gcov-profiling interface to synthesize binary profiling data files. Signed-off-by: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> Cc: Al Viro <viro@zeniv.linux.org.uk> --- fs/seq_file.c | 20 ++++++++++++++++++++ include/linux/seq_file.h | 1 + 2 files changed, 21 insertions(+) Index: linux-2.6.30-rc4/fs/seq_file.c =================================================================== --- linux-2.6.30-rc4.orig/fs/seq_file.c +++ linux-2.6.30-rc4/fs/seq_file.c @@ -640,6 +640,26 @@ int seq_puts(struct seq_file *m, const c } EXPORT_SYMBOL(seq_puts); +/** + * seq_write - write arbitrary data to buffer + * @seq: seq_file identifying the buffer to which data should be written + * @data: data address + * @len: number of bytes + * + * Return 0 on success, non-zero otherwise. + */ +int seq_write(struct seq_file *seq, const void *data, size_t len) +{ + if (seq->count + len < seq->size) { + memcpy(seq->buf + seq->count, data, len); + seq->count += len; + return 0; + } + seq->count = seq->size; + return -1; +} +EXPORT_SYMBOL(seq_write); + struct list_head *seq_list_start(struct list_head *head, loff_t pos) { struct list_head *lh; Index: linux-2.6.30-rc4/include/linux/seq_file.h =================================================================== --- linux-2.6.30-rc4.orig/include/linux/seq_file.h +++ linux-2.6.30-rc4/include/linux/seq_file.h @@ -43,6 +43,7 @@ int seq_release(struct inode *, struct f int seq_escape(struct seq_file *, const char *, const char *); int seq_putc(struct seq_file *m, char c); int seq_puts(struct seq_file *m, const char *s); +int seq_write(struct seq_file *seq, const void *data, size_t len); int seq_printf(struct seq_file *, const char *, ...) __attribute__ ((format (printf,2,3))); ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 3/4] gcov: add gcov profiling infrastructure 2009-05-07 12:45 [PATCH 0/4] gcov kernel support Peter Oberparleiter 2009-05-07 12:45 ` [PATCH 1/4] kernel: constructor support Peter Oberparleiter 2009-05-07 12:45 ` [PATCH 2/4] seq_file: add function to write binary data Peter Oberparleiter @ 2009-05-07 12:45 ` Peter Oberparleiter 2009-05-07 13:46 ` Ingo Molnar 2009-05-07 12:46 ` [PATCH 4/4] gcov: enable GCOV_PROFILE_ALL for x86_64 Peter Oberparleiter 3 siblings, 1 reply; 23+ messages in thread From: Peter Oberparleiter @ 2009-05-07 12:45 UTC (permalink / raw) To: linux-kernel Cc: Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman [-- Attachment #1: gcov-add-gcov-profiling-infrastructure.patch --] [-- Type: text/plain, Size: 52868 bytes --] From: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> Enable the use of GCC's coverage testing tool gcov [1] with the Linux kernel. gcov may be useful for: * debugging (has this code been reached at all?) * test improvement (how do I change my test to cover these lines?) * minimizing kernel configurations (do I need this option if the associated code is never run?) The profiling patch incorporates the following changes: * change kbuild to include profiling flags * provide functions needed by profiling code * present profiling data as files in debugfs Note that on some architectures, enabling gcc's profiling option "-fprofile-arcs" for the entire kernel may trigger compile/link/ run-time problems, some of which are caused by toolchain bugs and others which require adjustment of architecture code. For this reason profiling the entire kernel is initially restricted to those architectures for which it is known to work without changes. This restriction can be lifted once an architecture has been tested and found compatible with gcc's profiling. Profiling of single files or directories is still available on all platforms (see config help text). [1] http://gcc.gnu.org/onlinedocs/gcc/Gcov.html Signed-off-by: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> --- Documentation/gcov.txt | 246 +++++++++++++ Documentation/kernel-parameters.txt | 7 Makefile | 11 arch/Kconfig | 2 init/main.c | 8 kernel/Makefile | 1 kernel/gcov/Kconfig | 48 ++ kernel/gcov/Makefile | 3 kernel/gcov/base.c | 145 ++++++++ kernel/gcov/fs.c | 634 ++++++++++++++++++++++++++++++++++++ kernel/gcov/gcc_3_4.c | 419 +++++++++++++++++++++++ kernel/gcov/gcov.h | 128 +++++++ scripts/Makefile.lib | 9 13 files changed, 1656 insertions(+), 5 deletions(-) Index: linux-2.6.30-rc4/Documentation/gcov.txt =================================================================== --- /dev/null +++ linux-2.6.30-rc4/Documentation/gcov.txt @@ -0,0 +1,246 @@ +Using gcov with the Linux kernel +================================ + +1. Introduction +2. Preparation +3. Customization +4. Files +5. Modules +6. Separated build and test machines +7. Troubleshooting +Appendix A: sample script: gather_on_build.sh +Appendix B: sample script: gather_on_test.sh + + +1. Introduction +=============== + +gcov profiling kernel support enables the use of GCC's coverage testing +tool gcov [1] with the Linux kernel. Coverage data of a running kernel +is exported in gcov-compatible format via the "gcov" debugfs directory. +To get coverage data for a specific file, change to the kernel build +directory and use gcov with the -o option as follows (requires root): + +# cd /tmp/linux-out +# gcov -o /sys/kernel/debug/gcov/tmp/linux-out/kernel spinlock.c + +This will create source code files annotated with execution counts +in the current directory. In addition, graphical gcov front-ends such +as lcov [2] can be used to automate the process of collecting data +for the entire kernel and provide coverage overviews in HTML format. + +Possible uses: + +* debugging (has this line been reached at all?) +* test improvement (how do I change my test to cover these lines?) +* minimizing kernel configurations (do I need this option if the + associated code is never run?) + +-- + +[1] http://gcc.gnu.org/onlinedocs/gcc/Gcov.html +[2] http://ltp.sourceforge.net/coverage/lcov.php + + +2. Preparation +============== + +Configure the kernel with: + + CONFIG_DEBUGFS=y + CONFIG_GCOV_KERNEL=y + +and to get coverage data for the entire kernel: + + CONFIG_GCOV_PROFILE_ALL=y + +Note that kernels compiled with profiling flags will be significantly +larger and run slower. Also CONFIG_GCOV_PROFILE_ALL may not be supported +on all architectures. + +Profiling data will only become accessible once debugfs has been +mounted: + + mount -t debugfs none /sys/kernel/debug + + +3. Customization +================ + +To enable profiling for specific files or directories, add a line +similar to the following to the respective kernel Makefile: + + For a single file (e.g. main.o): + GCOV_PROFILE_main.o := y + + For all files in one directory: + GCOV_PROFILE := y + +To exclude files from being profiled even when CONFIG_GCOV_PROFILE_ALL +is specified, use: + + GCOV_PROFILE_main.o := n + and: + GCOV_PROFILE := n + +Only files which are linked to the main kernel image or are compiled as +kernel modules are supported by this mechanism. + + +4. Files +======== + +The gcov kernel support creates the following files in debugfs: + + /sys/kernel/debug/gcov + Parent directory for all gcov-related files. + + /sys/kernel/debug/gcov/reset + Global reset file: resets all coverage data to zero when + written to. + + /sys/kernel/debug/gcov/path/to/compile/dir/file.gcda + The actual gcov data file as understood by the gcov + tool. Resets file coverage data to zero when written to. + + /sys/kernel/debug/gcov/path/to/compile/dir/file.gcno + Symbolic link to a static data file required by the gcov + tool. This file is generated by gcc when compiling with + option -ftest-coverage. + + +5. Modules +========== + +Kernel modules may contain cleanup code which is only run during +module unload time. The gcov mechanism provides a means to collect +coverage data for such code by keeping a copy of the data associated +with the unloaded module. This data remains available through debugfs. +Once the module is loaded again, the associated coverage counters are +initialized with the data from its previous instantiation. + +This behavior can be deactivated by specifying the gcov_persist kernel +parameter: + + gcov_persist=0 + +At run-time, a user can also choose to discard data for an unloaded +module by writing to its data file or the global reset file. + + +6. Separated build and test machines +==================================== + +The gcov kernel profiling infrastructure is designed to work out-of-the +box for setups where kernels are built and run on the same machine. In +cases where the kernel runs on a separate machine, special preparations +must be made, depending on where the gcov tool is used: + +a) gcov is run on the TEST machine + +The gcov tool version on the test machine must be compatible with the +gcc version used for kernel build. Also the following files need to be +copied from build to test machine: + +from the source tree: + - all C source files + headers + +from the build tree: + - all C source files + headers + - all .gcda and .gcno files + - all links to directories + +It is important to note that these files need to be placed into the +exact same file system location on the test machine as on the build +machine. If any of the path components is symbolic link, the actual +directory needs to be used instead (due to make's CURDIR handling). + +b) gcov is run on the BUILD machine + +The following files need to be copied after each test case from test +to build machine: + +from the gcov directory in sysfs: + - all .gcda files + - all links to .gcno files + +These files can be copied to any location on the build machine. gcov +must then be called with the -o option pointing to that directory. + +Example directory setup on the build machine: + + /tmp/linux: kernel source tree + /tmp/out: kernel build directory as specified by make O= + /tmp/coverage: location of the files copied from the test machine + + [user@build] cd /tmp/out + [user@build] gcov -o /tmp/coverage/tmp/out/init main.c + + +7. Troubleshooting +================== + +Problem: Compilation aborts during linker step. +Cause: Profiling flags are specified for source files which are not + linked to the main kernel or which are linked by a custom + linker procedure. +Solution: Exclude affected source files from profiling by specifying + GCOV_PROFILE := n or GCOV_PROFILE_basename.o := n in the + corresponding Makefile. + + +Appendix A: gather_on_build.sh +============================== + +Sample script to gather coverage meta files on the build machine +(see 6a): + +#!/bin/bash + +KSRC=$1 +KOBJ=$2 +DEST=$3 + +if [ -z "$KSRC" ] || [ -z "$KOBJ" ] || [ -z "$DEST" ]; then + echo "Usage: $0 <ksrc directory> <kobj directory> <output.tar.gz>" >&2 + exit 1 +fi + +KSRC=$(cd $KSRC; printf "all:\n\t@echo \${CURDIR}\n" | make -f -) +KOBJ=$(cd $KOBJ; printf "all:\n\t@echo \${CURDIR}\n" | make -f -) + +find $KSRC $KOBJ \( -name '*.gcno' -o -name '*.[ch]' -o -type l \) -a \ + -perm /u+r,g+r | tar cfz $DEST -P -T - + +if [ $? -eq 0 ] ; then + echo "$DEST successfully created, copy to test system and unpack with:" + echo " tar xfz $DEST -P" +else + echo "Could not create file $DEST" +fi + + +Appendix B: gather_on_test.sh +============================= + +Sample script to gather coverage data files on the test machine +(see 6b): + +#!/bin/bash + +DEST=$1 +GCDA=/sys/kernel/debug/gcov + +if [ -z "$DEST" ] ; then + echo "Usage: $0 <output.tar.gz>" >&2 + exit 1 +fi + +find $GCDA -name '*.gcno' -o -name '*.gcda' | tar cfz $DEST -T - + +if [ $? -eq 0 ] ; then + echo "$DEST successfully created, copy to build system and unpack with:" + echo " tar xfz $DEST" +else + echo "Could not create file $DEST" +fi Index: linux-2.6.30-rc4/Documentation/kernel-parameters.txt =================================================================== --- linux-2.6.30-rc4.orig/Documentation/kernel-parameters.txt +++ linux-2.6.30-rc4/Documentation/kernel-parameters.txt @@ -42,6 +42,7 @@ parameter is applicable: EFI EFI Partitioning (GPT) is enabled EIDE EIDE/ATAPI support is enabled. FB The frame buffer device is enabled. + GCOV GCOV profiling is enabled. HW Appropriate hardware is enabled. IA-64 IA-64 architecture is enabled. IMA Integrity measurement architecture is enabled. @@ -765,6 +766,12 @@ and is between 256 and 4096 characters. Format: off | on default: on + gcov_persist= [GCOV] When non-zero (default), profiling data for + kernel modules is saved and remains accessible via + debugfs, even when the module is unloaded/reloaded. + When zero, profiling data is discarded and associated + debugfs files are removed at module unload time. + gdth= [HW,SCSI] See header of drivers/scsi/gdth.c. Index: linux-2.6.30-rc4/Makefile =================================================================== --- linux-2.6.30-rc4.orig/Makefile +++ linux-2.6.30-rc4/Makefile @@ -338,6 +338,7 @@ AFLAGS_MODULE = $(MODFLAGS) LDFLAGS_MODULE = CFLAGS_KERNEL = AFLAGS_KERNEL = +CFLAGS_GCOV = -fprofile-arcs -ftest-coverage # Use LINUXINCLUDE when you must reference the include/ directory. @@ -364,7 +365,7 @@ export CPP AR NM STRIP OBJCOPY OBJDUMP M export HOSTCXX HOSTCXXFLAGS LDFLAGS_MODULE CHECK CHECKFLAGS export KBUILD_CPPFLAGS NOSTDINC_FLAGS LINUXINCLUDE OBJCOPYFLAGS LDFLAGS -export KBUILD_CFLAGS CFLAGS_KERNEL CFLAGS_MODULE +export KBUILD_CFLAGS CFLAGS_KERNEL CFLAGS_MODULE CFLAGS_GCOV export KBUILD_AFLAGS AFLAGS_KERNEL AFLAGS_MODULE # When compiling out-of-tree modules, put MODVERDIR in the module @@ -1224,8 +1225,8 @@ clean: archclean $(clean-dirs) \( -name '*.[oas]' -o -name '*.ko' -o -name '.*.cmd' \ -o -name '.*.d' -o -name '.*.tmp' -o -name '*.mod.c' \ -o -name '*.symtypes' -o -name 'modules.order' \ - -o -name 'Module.markers' -o -name '.tmp_*.o.*' \) \ - -type f -print | xargs rm -f + -o -name 'Module.markers' -o -name '.tmp_*.o.*' \ + -o -name '*.gcno' \) -type f -print | xargs rm -f # mrproper - Delete all generated files, including .config # @@ -1427,8 +1428,8 @@ clean: $(clean-dirs) $(call cmd,rmfiles) @find $(KBUILD_EXTMOD) $(RCS_FIND_IGNORE) \ \( -name '*.[oas]' -o -name '*.ko' -o -name '.*.cmd' \ - -o -name '.*.d' -o -name '.*.tmp' -o -name '*.mod.c' \) \ - -type f -print | xargs rm -f + -o -name '.*.d' -o -name '.*.tmp' -o -name '*.mod.c' \ + -o -name '*.gcno' \) -type f -print | xargs rm -f help: @echo ' Building external modules.' Index: linux-2.6.30-rc4/arch/Kconfig =================================================================== --- linux-2.6.30-rc4.orig/arch/Kconfig +++ linux-2.6.30-rc4/arch/Kconfig @@ -112,3 +112,5 @@ config HAVE_DMA_API_DEBUG config HAVE_DEFAULT_NO_SPIN_MUTEXES bool + +source "kernel/gcov/Kconfig" Index: linux-2.6.30-rc4/init/main.c =================================================================== --- linux-2.6.30-rc4.orig/init/main.c +++ linux-2.6.30-rc4/init/main.c @@ -77,6 +77,14 @@ #include <asm/smp.h> #endif +#ifdef CONFIG_GCOV_KERNEL + +#if (__GNUC__ < 3) || (__GNUC__ == 3) && (__GNUC_MINOR__ < 4) +#error "GCOV profiling support for gcc versions below 3.4 not included" +#endif /* __GNUC__ */ + +#endif /* CONFIG_GCOV_KERNEL */ + static int kernel_init(void *); extern void init_IRQ(void); Index: linux-2.6.30-rc4/kernel/Makefile =================================================================== --- linux-2.6.30-rc4.orig/kernel/Makefile +++ linux-2.6.30-rc4/kernel/Makefile @@ -70,6 +70,7 @@ obj-$(CONFIG_STOP_MACHINE) += stop_machi obj-$(CONFIG_KPROBES_SANITY_TEST) += test_kprobes.o obj-$(CONFIG_AUDIT) += audit.o auditfilter.o obj-$(CONFIG_AUDITSYSCALL) += auditsc.o +obj-$(CONFIG_GCOV_KERNEL) += gcov/ obj-$(CONFIG_AUDIT_TREE) += audit_tree.o obj-$(CONFIG_KPROBES) += kprobes.o obj-$(CONFIG_KGDB) += kgdb.o Index: linux-2.6.30-rc4/kernel/gcov/Kconfig =================================================================== --- /dev/null +++ linux-2.6.30-rc4/kernel/gcov/Kconfig @@ -0,0 +1,48 @@ +menu "GCOV-based kernel profiling" + +config GCOV_KERNEL + bool "Enable gcov-based kernel profiling" + depends on DEBUG_FS && CONSTRUCTORS + default n + ---help--- + This option enables gcov-based code profiling (e.g. for code coverage + measurements). + + If unsure, say N. + + Additionally specify CONFIG_GCOV_PROFILE_ALL=y to get profiling data + for the entire kernel. To enable profiling for specific files or + directories, add a line similar to the following to the respective + Makefile: + + For a single file (e.g. main.o): + GCOV_PROFILE_main.o := y + + For all files in one directory: + GCOV_PROFILE := y + + To exclude files from being profiled even when CONFIG_GCOV_PROFILE_ALL + is specified, use: + + GCOV_PROFILE_main.o := n + and: + GCOV_PROFILE := n + + Note that the debugfs filesystem has to be mounted to access + profiling data. + +config GCOV_PROFILE_ALL + bool "Profile entire Kernel" + depends on GCOV_KERNEL + depends on S390 || X86_32 + default n + ---help--- + This options activates profiling for the entire kernel. + + If unsure, say N. + + Note that a kernel compiled with profiling flags will be significantly + larger and run slower. Also be sure to exclude files from profiling + which are not linked to the kernel image to prevent linker errors. + +endmenu Index: linux-2.6.30-rc4/kernel/gcov/Makefile =================================================================== --- /dev/null +++ linux-2.6.30-rc4/kernel/gcov/Makefile @@ -0,0 +1,3 @@ +EXTRA_CFLAGS := -DSRCTREE='"$(srctree)"' -DOBJTREE='"$(objtree)"' + +obj-$(CONFIG_GCOV_KERNEL) := base.o fs.o gcc_3_4.o Index: linux-2.6.30-rc4/kernel/gcov/base.c =================================================================== --- /dev/null +++ linux-2.6.30-rc4/kernel/gcov/base.c @@ -0,0 +1,145 @@ +/* + * This code maintains a list of active profiling data structures. + * + * Copyright IBM Corp. 2009 + * Author(s): Peter Oberparleiter <oberpar@linux.vnet.ibm.com> + * + * Uses gcc-internal data definitions. + * Based on the gcov-kernel patch by: + * Hubertus Franke <frankeh@us.ibm.com> + * Nigel Hinds <nhinds@us.ibm.com> + * Rajan Ravindran <rajancr@us.ibm.com> + * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> + * Paul Larson + */ + +#include <linux/init.h> +#include <linux/module.h> +#include <linux/mutex.h> +#include <linux/syscalls.h> +#include "gcov.h" + +static struct gcov_info *gcov_info_head; +static int gcov_events_enabled; +static DEFINE_MUTEX(gcov_lock); + +/* __gcov_init is called by gcc-generated constructor code for each object + * file compiled with -fprofile-arcs. */ +void __gcov_init(struct gcov_info *info) +{ + static unsigned int gcov_version; + + mutex_lock(&gcov_lock); + if (gcov_version == 0) { + gcov_version = info->version; + /* Printing gcc's version magic may prove useful for debugging + * incompatibility reports. */ + printk(KERN_INFO TAG "version magic: 0x%x\n", gcov_version); + } + /* Add new profiling data structure to list and inform event + * listener. */ + info->next = gcov_info_head; + gcov_info_head = info; + if (gcov_events_enabled) + gcov_event(gcov_add, info); + mutex_unlock(&gcov_lock); +} +EXPORT_SYMBOL(__gcov_init); + +/* These functions may be referenced by gcc-generated profiling code but serve + * no function for kernel profiling. */ +void __gcov_flush(void) +{ + /* Unused. */ +} +EXPORT_SYMBOL(__gcov_flush); + +void __gcov_merge_add(gcov_type *counters, unsigned int n_counters) +{ + /* Unused. */ +} +EXPORT_SYMBOL(__gcov_merge_add); + +void __gcov_merge_single(gcov_type *counters, unsigned int n_counters) +{ + /* Unused. */ +} +EXPORT_SYMBOL(__gcov_merge_single); + +void __gcov_merge_delta(gcov_type *counters, unsigned int n_counters) +{ + /* Unused. */ +} +EXPORT_SYMBOL(__gcov_merge_delta); + +int __gcov_execve(const char *path, char *const argv[], char *const envp[]) +{ + return kernel_execve(path, argv, envp); +} +EXPORT_SYMBOL(__gcov_execve); + +/** + * gcov_enable_events - enable event reporting through gcov_event() + * + * Turn on reporting of profiling data load/unload-events through the + * gcov_event() callback. Also replay all previous events once. This function + * is needed because some events are potentially generated too early for the + * callback implementation to handle them initially. + */ +void gcov_enable_events(void) +{ + struct gcov_info *info; + + mutex_lock(&gcov_lock); + gcov_events_enabled = 1; + /* Perform event callback for previously registered entries. */ + for (info = gcov_info_head; info; info = info->next) + gcov_event(gcov_add, info); + mutex_unlock(&gcov_lock); +} + +static inline int within(void *addr, void *start, unsigned long size) +{ + return ((addr >= start) && (addr < start + size)); +} + +/* Update list and generate events when modules are unloaded. */ +static int gcov_module_notifier(struct notifier_block *nb, unsigned long event, + void *data) +{ +#ifdef CONFIG_MODULES + struct module *mod = data; + struct gcov_info *info; + struct gcov_info *prev; + + if (event != MODULE_STATE_GOING) + return NOTIFY_OK; + mutex_lock(&gcov_lock); + prev = NULL; + /* Remove entries located in module from linked list. */ + for (info = gcov_info_head; info; info = info->next) { + if (within(info, mod->module_core, mod->core_size)) { + if (prev) + prev->next = info->next; + else + gcov_info_head = info->next; + if (gcov_events_enabled) + gcov_event(gcov_remove, info); + } else + prev = info; + } + mutex_unlock(&gcov_lock); +#endif /* CONFIG_MODULES */ + + return NOTIFY_OK; +} + +static struct notifier_block gcov_nb = { + .notifier_call = gcov_module_notifier, +}; + +static int __init gcov_init(void) +{ + return register_module_notifier(&gcov_nb); +} +device_initcall(gcov_init); Index: linux-2.6.30-rc4/kernel/gcov/fs.c =================================================================== --- /dev/null +++ linux-2.6.30-rc4/kernel/gcov/fs.c @@ -0,0 +1,634 @@ +/* + * This code exports profiling data as debugfs files to userspace. + * + * Copyright IBM Corp. 2009 + * Author(s): Peter Oberparleiter <oberpar@linux.vnet.ibm.com> + * + * Uses gcc-internal data definitions. + * Based on the gcov-kernel patch by: + * Hubertus Franke <frankeh@us.ibm.com> + * Nigel Hinds <nhinds@us.ibm.com> + * Rajan Ravindran <rajancr@us.ibm.com> + * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> + * Paul Larson + * Yi CDL Yang + */ + +#include <linux/init.h> +#include <linux/module.h> +#include <linux/debugfs.h> +#include <linux/fs.h> +#include <linux/list.h> +#include <linux/string.h> +#include <linux/slab.h> +#include <linux/mutex.h> +#include <linux/seq_file.h> +#include "gcov.h" + +/** + * struct gcov_node - represents a debugfs entry + * @list: list head for child node list + * @children: child nodes + * @all: list head for list of all nodes + * @parent: parent node + * @info: associated profiling data structure if not a directory + * @ghost: when an object file containing profiling data is unloaded we keep a + * copy of the profiling data here to allow collecting coverage data + * for cleanup code. Such a node is called a "ghost". + * @dentry: main debugfs entry, either a directory or data file + * @links: associated symbolic links + * @name: data file basename + * + * struct gcov_node represents an entity within the gcov/ subdirectory + * of debugfs. There are directory and data file nodes. The latter represent + * the actual synthesized data file plus any associated symbolic links which + * are needed by the gcov tool to work correctly. + */ +struct gcov_node { + struct list_head list; + struct list_head children; + struct list_head all; + struct gcov_node *parent; + struct gcov_info *info; + struct gcov_info *ghost; + struct dentry *dentry; + struct dentry **links; + char name[0]; +}; + +static const char objtree[] = OBJTREE; +static const char srctree[] = SRCTREE; +static struct gcov_node root_node; +static struct dentry *reset_dentry; +static LIST_HEAD(all_head); +static DEFINE_MUTEX(node_lock); + +/* If non-zero, keep copies of profiling data for unloaded modules. */ +static int gcov_persist = 1; + +static int __init gcov_persist_setup(char *str) +{ + int val; + char delim; + + if (sscanf(str, "%d %c", &val, &delim) != 1) { + printk(KERN_WARNING TAG "invalid gcov_persist parameter '%s'\n", + str); + return 0; + } + printk(KERN_INFO TAG "setting gcov_persist to %d\n", val); + gcov_persist = val; + + return 1; +} +__setup("gcov_persist=", gcov_persist_setup); + +/* seq_file.start() implementation for gcov data files. Note that the + * gcov_iterator interface is designed to be more restrictive than seq_file + * (no start from arbitrary position, etc.), to simplify the iterator + * implementation. */ +static void *gcov_seq_start(struct seq_file *seq, loff_t *pos) +{ + loff_t i; + + gcov_iter_start(seq->private); + for (i = 0; i < *pos; i++) + if (gcov_iter_next(seq->private)) + return NULL; + + return seq->private; +} + +/* seq_file.next() implementation for gcov data files. */ +static void *gcov_seq_next(struct seq_file *seq, void *data, loff_t *pos) +{ + struct gcov_iterator *iter = data; + + if (gcov_iter_next(iter)) + return NULL; + (*pos)++; + + return iter; +} + +/* seq_file.show() implementation for gcov data files. */ +static int gcov_seq_show(struct seq_file *seq, void *data) +{ + struct gcov_iterator *iter = data; + + if (gcov_iter_write(iter, seq)) + return -EINVAL; + return 0; +} + +static void gcov_seq_stop(struct seq_file *seq, void *data) +{ + /* Unused. */ +} + +static const struct seq_operations gcov_seq_ops = { + .start = gcov_seq_start, + .next = gcov_seq_next, + .show = gcov_seq_show, + .stop = gcov_seq_stop, +}; + +/* Return the profiling data set for a given node. This can either be the + * original profiling data structure or a duplicate (also called "ghost") + * in case the associated object file has been unloaded. */ +static struct gcov_info *get_node_info(struct gcov_node *node) +{ + if (node->info) + return node->info; + + return node->ghost; +} + +/* open() implementation for gcov data files. Create a copy of the profiling + * data set and initialize the iterator and seq_file interface. */ +static int gcov_seq_open(struct inode *inode, struct file *file) +{ + struct gcov_node *node = inode->i_private; + struct gcov_iterator *iter; + struct seq_file *seq; + struct gcov_info *info; + int rc; + + mutex_lock(&node_lock); + /* Read from a profiling data copy to minimize reference tracking + * complexity and concurrent access. */ + info = gcov_info_dup(get_node_info(node)); + if (!info) { + rc = -ENOMEM; + goto out_unlock; + } + iter = gcov_iter_new(info); + if (!iter) { + rc = -ENOMEM; + goto out_free; + } + rc = seq_open(file, &gcov_seq_ops); + if (rc) + goto out_free2; + seq = file->private_data; + seq->private = iter; + goto out_unlock; + +out_free2: + gcov_iter_free(iter); +out_free: + gcov_info_free(info); +out_unlock: + mutex_unlock(&node_lock); + + return rc; +} + +/* release() implementation for gcov data files. Release resources allocated + * by open(). */ +static int gcov_seq_release(struct inode *inode, struct file *file) +{ + struct gcov_iterator *iter; + struct gcov_info *info; + struct seq_file *seq = file->private_data; + + iter = seq->private; + info = gcov_iter_get_info(iter); + gcov_iter_free(iter); + gcov_info_free(info); + seq_release(inode, file); + + return 0; +} + +/* Find a node by the associated data file name. Needs to be called with + * node_lock held. */ +static struct gcov_node *get_node_by_name(const char *name) +{ + struct gcov_node *node; + struct gcov_info *info; + + list_for_each_entry(node, &all_head, all) { + info = get_node_info(node); + if (info && (strcmp(info->filename, name) == 0)) + return node; + } + + return NULL; +} + +static void remove_node(struct gcov_node *node); + +/* write() implementation for gcov data files. Reset profiling data for the + * associated file. If the object file has been unloaded (i.e. this is + * a "ghost" node), remove the debug fs node as well. */ +static ssize_t gcov_seq_write(struct file *file, const char __user *addr, + size_t len, loff_t *pos) +{ + struct seq_file *seq = file->private_data; + struct gcov_info *info = gcov_iter_get_info(seq->private); + struct gcov_node *node; + + mutex_lock(&node_lock); + node = get_node_by_name(info->filename); + if (node) { + /* Reset counts or remove node for unloaded modules. */ + if (node->ghost) + remove_node(node); + else + gcov_info_reset(node->info); + } + /* Reset counts for open file. */ + gcov_info_reset(info); + mutex_unlock(&node_lock); + + return len; +} + +/* Given a string <path> representing a file path of format: + * path/to/file.gcda + * construct and return a new string: + * <dir/>path/to/file.<ext> */ +static char *link_target(const char *dir, const char *path, const char *ext) +{ + char *target; + char *old_ext; + char *copy; + + copy = kstrdup(path, GFP_KERNEL); + if (!copy) + return NULL; + old_ext = strrchr(copy, '.'); + if (old_ext) + *old_ext = '\0'; + if (dir) + target = kasprintf(GFP_KERNEL, "%s/%s.%s", dir, copy, ext); + else + target = kasprintf(GFP_KERNEL, "%s.%s", copy, ext); + kfree(copy); + + return target; +} + +/* Construct a string representing the symbolic link target for the given + * gcov data file name and link type. Depending on the link type and the + * location of the data file, the link target can either point to a + * subdirectory of srctree, objtree or in an external location. */ +static char *get_link_target(const char *filename, const struct gcov_link *ext) +{ + const char *rel; + char *result; + + if (strncmp(filename, objtree, strlen(objtree)) == 0) { + rel = filename + strlen(objtree) + 1; + if (ext->dir == src_tree) + result = link_target(srctree, rel, ext->ext); + else + result = link_target(objtree, rel, ext->ext); + } else { + /* External compilation. */ + result = link_target(NULL, filename, ext->ext); + } + + return result; +} + +#define SKEW_PREFIX ".tmp_" + +/* For a filename .tmp_filename.ext return filename.ext. Needed to compensate + * for filename skewing caused by the mod-versioning mechanism. */ +static const char *deskew(const char *basename) +{ + if (strncmp(basename, SKEW_PREFIX, sizeof(SKEW_PREFIX) - 1) == 0) + return basename + sizeof(SKEW_PREFIX) - 1; + return basename; +} + +/* Create links to additional files (usually .c and .gcno files) which the + * gcov tool expects to find in the same directory as the gcov data file. */ +static void add_links(struct gcov_node *node, struct dentry *parent) +{ + char *basename; + char *target; + int num; + int i; + + for (num = 0; gcov_link[num].ext; num++) + /* Nothing. */; + node->links = kcalloc(num, sizeof(struct dentry *), GFP_KERNEL); + if (!node->links) + return; + for (i = 0; i < num; i++) { + target = get_link_target(get_node_info(node)->filename, + &gcov_link[i]); + if (!target) + goto out_err; + basename = strrchr(target, '/'); + if (!basename) + goto out_err; + basename++; + node->links[i] = debugfs_create_symlink(deskew(basename), + parent, target); + if (!node->links[i]) + goto out_err; + kfree(target); + } + + return; +out_err: + kfree(target); + while (i-- > 0) + debugfs_remove(node->links[i]); + kfree(node->links); + node->links = NULL; +} + +static const struct file_operations gcov_data_fops = { + .open = gcov_seq_open, + .release = gcov_seq_release, + .read = seq_read, + .llseek = seq_lseek, + .write = gcov_seq_write, +}; + +/* Basic initialization of a new node. */ +static void init_node(struct gcov_node *node, struct gcov_info *info, + const char *name, struct gcov_node *parent) +{ + INIT_LIST_HEAD(&node->list); + INIT_LIST_HEAD(&node->children); + INIT_LIST_HEAD(&node->all); + node->info = info; + node->parent = parent; + if (name) + strcpy(node->name, name); +} + +/* Create a new node and associated debugfs entry. Needs to be called with + * node_lock held. */ +static struct gcov_node *new_node(struct gcov_node *parent, + struct gcov_info *info, const char *name) +{ + struct gcov_node *node; + + node = kzalloc(sizeof(struct gcov_node) + strlen(name) + 1, GFP_KERNEL); + if (!node) { + printk(KERN_WARNING TAG "out of memory\n"); + return NULL; + } + init_node(node, info, name, parent); + /* Differentiate between gcov data file nodes and directory nodes. */ + if (info) { + node->dentry = debugfs_create_file(deskew(node->name), 0600, + parent->dentry, node, &gcov_data_fops); + } else + node->dentry = debugfs_create_dir(node->name, parent->dentry); + if (!node->dentry) { + printk(KERN_WARNING TAG "could not create file\n"); + kfree(node); + return NULL; + } + if (info) + add_links(node, parent->dentry); + list_add(&node->list, &parent->children); + list_add(&node->all, &all_head); + + return node; +} + +/* Remove symbolic links associated with node. */ +static void remove_links(struct gcov_node *node) +{ + int i; + + if (!node->links) + return; + for (i = 0; gcov_link[i].ext; i++) + debugfs_remove(node->links[i]); + kfree(node->links); + node->links = NULL; +} + +/* Remove node from all lists and debugfs and release associated resources. + * Needs to be called with node_lock held. */ +static void release_node(struct gcov_node *node) +{ + list_del(&node->list); + list_del(&node->all); + debugfs_remove(node->dentry); + remove_links(node); + if (node->ghost) + gcov_info_free(node->ghost); + kfree(node); +} + +/* Release node and empty parents. Needs to be called with node_lock held. */ +static void remove_node(struct gcov_node *node) +{ + struct gcov_node *parent; + + while ((node != &root_node) && list_empty(&node->children)) { + parent = node->parent; + release_node(node); + node = parent; + } +} + +/* Find child node with given basename. Needs to be called with node_lock + * held. */ +static struct gcov_node *get_child_by_name(struct gcov_node *parent, + const char *name) +{ + struct gcov_node *node; + + list_for_each_entry(node, &parent->children, list) { + if (strcmp(node->name, name) == 0) + return node; + } + + return NULL; +} + +/* write() implementation for reset file. Reset all profiling data to zero + * and remove ghost nodes. */ +static ssize_t reset_write(struct file *file, const char __user *addr, + size_t len, loff_t *pos) +{ + struct gcov_node *node; + + mutex_lock(&node_lock); +restart: + list_for_each_entry(node, &all_head, all) { + if (node->info) + gcov_info_reset(node->info); + else if (list_empty(&node->children)) { + remove_node(node); + /* Several nodes may have gone - restart loop. */ + goto restart; + } + } + mutex_unlock(&node_lock); + + return len; +} + +/* read() implementation for reset file. Unused. */ +static ssize_t reset_read(struct file *file, char __user *addr, size_t len, + loff_t *pos) +{ + /* Allow read operation so that a recursive copy won't fail. */ + return 0; +} + +static const struct file_operations gcov_reset_fops = { + .write = reset_write, + .read = reset_read, +}; + +/* Create a node for a given profiling data set and add it to all lists and + * debugfs. Needs to be called with node_lock held. */ +static void add_node(struct gcov_info *info) +{ + char *filename; + char *curr; + char *next; + struct gcov_node *parent; + struct gcov_node *node; + + filename = kstrdup(info->filename, GFP_KERNEL); + if (!filename) + return; + parent = &root_node; + /* Create directory nodes along the path. */ + for (curr = filename; (next = strchr(curr, '/')); curr = next + 1) { + if (curr == next) + continue; + *next = 0; + if (strcmp(curr, ".") == 0) + continue; + if (strcmp(curr, "..") == 0) { + if (!parent->parent) + goto out_err; + parent = parent->parent; + continue; + } + node = get_child_by_name(parent, curr); + if (!node) { + node = new_node(parent, NULL, curr); + if (!node) + goto out_err; + } + parent = node; + } + /* Create file node. */ + node = new_node(parent, info, curr); + if (node) + goto out; +out_err: + remove_node(parent); +out: + kfree(filename); +} + +/* The profiling data set associated with this node is being unloaded. Store a + * copy of the profiling data and turn this node into a "ghost". */ +static int ghost_node(struct gcov_node *node) +{ + node->ghost = gcov_info_dup(node->info); + if (!node->ghost) { + printk(KERN_WARNING TAG "could not save data for '%s' (out of " + "memory)\n", node->info->filename); + return -ENOMEM; + } + node->info = NULL; + + return 0; +} + +/* Profiling data for this node has been loaded again. Add profiling data + * from previous instantiation and turn this node into a regular node. */ +static void revive_node(struct gcov_node *node, struct gcov_info *info) +{ + if (gcov_info_is_compatible(node->ghost, info)) + gcov_info_add(info, node->ghost); + else { + printk(KERN_WARNING TAG "discarding saved data for '%s' " + "(version changed)\n", info->filename); + } + gcov_info_free(node->ghost); + node->ghost = NULL; + node->info = info; +} + +/* Callback to create/remove profiling files when code compiled with + * -fprofile-arcs is loaded/unloaded. */ +void gcov_event(enum gcov_action action, struct gcov_info *info) +{ + struct gcov_node *node; + + mutex_lock(&node_lock); + node = get_node_by_name(info->filename); + switch (action) { + case gcov_add: + /* Add new node or revive ghost. */ + if (!node) { + add_node(info); + break; + } + if (gcov_persist) + revive_node(node, info); + else + printk(KERN_WARNING TAG "could not add '%s' " + "(already exists)\n", info->filename); + break; + case gcov_remove: + /* Remove node or turn into ghost. */ + if (!node) { + printk(KERN_WARNING TAG "could not remove '%s' (not " + "found)\n", info->filename); + break; + } + if (gcov_persist) { + if (!ghost_node(node)) + break; + } + remove_node(node); + break; + } + mutex_unlock(&node_lock); +} + +/* Create debugfs entries. */ +static __init int gcov_fs_init(void) +{ + int rc; + + init_node(&root_node, NULL, NULL, NULL); + /* /sys/kernel/debug/gcov will be parent for the reset control file + * and all profiling files. */ + root_node.dentry = debugfs_create_dir("gcov", NULL); + if (!root_node.dentry) { + printk(KERN_ERR TAG "could not create root dir\n"); + rc = -EIO; + goto out_remove; + } + /* Create reset file which resets all profiling counts when written + * to. */ + reset_dentry = debugfs_create_file("reset", 0600, root_node.dentry, + NULL, &gcov_reset_fops); + if (!reset_dentry) { + printk(KERN_ERR TAG "could not create reset file\n"); + rc = -EIO; + goto out_remove; + } + /* Replay previous events to get our fs hierarchy up-to-date. */ + gcov_enable_events(); + + return 0; +out_remove: + if (root_node.dentry) + debugfs_remove(root_node.dentry); + + return rc; +} +device_initcall(gcov_fs_init); Index: linux-2.6.30-rc4/kernel/gcov/gcc_3_4.c =================================================================== --- /dev/null +++ linux-2.6.30-rc4/kernel/gcov/gcc_3_4.c @@ -0,0 +1,419 @@ +/* + * This code provides functions to handle gcc's profiling data format + * introduced with gcc 3.4. Future versions of gcc may change the gcov + * format (as happened before), so all format-specific information needs + * to be kept modular and easily exchangeable. + * + * This file is based on gcc-internal definitions. Functions and data + * structures are defined to be compatible with gcc counterparts. + * For a better understanding, refer to gcc source: gcc/gcov-io.h. + * + * Copyright IBM Corp. 2009 + * Author(s): Peter Oberparleiter <oberpar@linux.vnet.ibm.com> + * + * Uses gcc-internal data definitions. + */ + +#include <linux/errno.h> +#include <linux/slab.h> +#include <linux/string.h> +#include <linux/seq_file.h> +#include "gcov.h" + +/* Symbolic links to be created for each profiling data file. */ +const struct gcov_link gcov_link[] = { + { obj_tree, "gcno" }, /* Link to .gcno file in $(objtree). */ + { 0, NULL}, +}; + +/* Determine whether a counter is active. Based on gcc magic. Doesn't change + * at run-time. */ +static int counter_active(struct gcov_info *info, unsigned int type) +{ + return (1 << type) & info->ctr_mask; +} + +/* Determine number of active counters. Based on gcc magic. */ +static unsigned int num_counter_active(struct gcov_info *info) +{ + unsigned int i; + unsigned int result = 0; + + for (i = 0; i < GCOV_COUNTERS; i++) + if (counter_active(info, i)) + result++; + return result; +} + +/** + * gcov_info_reset - reset profiling data to zero + * @info: profiling data set + */ +void gcov_info_reset(struct gcov_info *info) +{ + unsigned int active = num_counter_active(info); + unsigned int i; + + for (i = 0; i < active; i++) + memset(info->counts[i].values, 0, + info->counts[i].num * sizeof(gcov_type)); +} + +/** + * gcov_info_is_compatible - check if profiling data can be added + * @info1: first profiling data set + * @info2: second profiling data set + * + * Returns non-zero if profiling data can be added, zero otherwise. + */ +int gcov_info_is_compatible(struct gcov_info *info1, struct gcov_info *info2) +{ + return (info1->stamp == info2->stamp); +} + +/** + * gcov_info_add - add up profiling data + * @dest: profiling data set to which data is added + * @source: profiling data set which is added + * + * Adds profiling counts of @source to @dest. + */ +void gcov_info_add(struct gcov_info *dest, struct gcov_info *source) +{ + unsigned int i; + unsigned int j; + + for (i = 0; i < num_counter_active(dest); i++) + for (j = 0; j < dest->counts[i].num; j++) + dest->counts[i].values[j] += + source->counts[i].values[j]; +} + +/* Get size of function info entry. Based on gcc magic. */ +static size_t get_fn_size(struct gcov_info *info) +{ + size_t size; + + size = sizeof(struct gcov_fn_info) + num_counter_active(info) * + sizeof(unsigned int); + if (__alignof__(struct gcov_fn_info) > sizeof(unsigned int)) + size = ALIGN(size, __alignof__(struct gcov_fn_info)); + return size; +} + +/* Get address of function info entry. Based on gcc magic. */ +static struct gcov_fn_info *get_fn_info(struct gcov_info *info, unsigned int fn) +{ + return (struct gcov_fn_info *) + ((char *) info->functions + fn * get_fn_size(info)); +} + +/** + * gcov_info_dup - duplicate profiling data set + * @info: profiling data set to duplicate + * + * Return newly allocated duplicate on success, %NULL on error. + */ +struct gcov_info *gcov_info_dup(struct gcov_info *info) +{ + struct gcov_info *dup; + unsigned int i; + unsigned int active = num_counter_active(info); + + /* Duplicate gcov_info. */ + dup = kzalloc(sizeof(struct gcov_info) + + sizeof(struct gcov_ctr_info) * active, GFP_KERNEL); + if (!dup) + return NULL; + dup->version = info->version; + dup->stamp = info->stamp; + dup->n_functions = info->n_functions; + dup->ctr_mask = info->ctr_mask; + /* Duplicate filename. */ + dup->filename = kstrdup(info->filename, GFP_KERNEL); + if (!dup->filename) + goto out_free; + /* Duplicate table of functions. */ + dup->functions = kmemdup(info->functions, info->n_functions * + get_fn_size(info), GFP_KERNEL); + if (!dup->functions) + goto out_free; + /* Duplicate counter arrays. */ + for (i = 0; i < active ; i++) { + dup->counts[i].num = info->counts[i].num; + dup->counts[i].merge = info->counts[i].merge; + dup->counts[i].values = kmemdup(info->counts[i].values, + sizeof(gcov_type) * info->counts[i].num, + GFP_KERNEL); + if (!dup->counts[i].values) + goto out_free; + } + return dup; + +out_free: + gcov_info_free(dup); + + return NULL; +} + +/** + * gcov_info_free - release memory for profiling data set duplicate + * @info: profiling data set duplicate to free + */ +void gcov_info_free(struct gcov_info *info) +{ + unsigned int active = num_counter_active(info); + unsigned int i; + + for (i = 0; i < active ; i++) + kfree(info->counts[i].values); + kfree(info->functions); + kfree(info->filename); + kfree(info); +} + +/** + * struct type_info - iterator helper array + * @ctr_type: counter type + * @offset: index of the first value of the current function for this type + * + * This array is needed to convert the in-memory data format into the in-file + * data format: + * + * In-memory: + * for each counter type + * for each function + * values + * + * In-file: + * for each function + * for each counter type + * values + * + * See gcc source gcc/gcov-io.h for more information on data organization. + */ +struct type_info { + int ctr_type; + unsigned int offset; +}; + +/** + * struct gcov_iterator - specifies current file position in logical records + * @info: associated profiling data + * @record: record type + * @function: function number + * @type: counter type + * @count: index into values array + * @num_types: number of counter types + * @type_info: helper array to get values-array offset for current function + */ +struct gcov_iterator { + struct gcov_info *info; + + int record; + unsigned int function; + unsigned int type; + unsigned int count; + + int num_types; + struct type_info type_info[0]; +}; + +static struct gcov_fn_info *get_func(struct gcov_iterator *iter) +{ + return get_fn_info(iter->info, iter->function); +} + +static struct type_info *get_type(struct gcov_iterator *iter) +{ + return &iter->type_info[iter->type]; +} + +/** + * gcov_iter_new - allocate and initialize profiling data iterator + * @info: profiling data set to be iterated + * + * Return file iterator on success, %NULL otherwise. + */ +struct gcov_iterator *gcov_iter_new(struct gcov_info *info) +{ + struct gcov_iterator *iter; + + iter = kzalloc(sizeof(struct gcov_iterator) + + num_counter_active(info) * sizeof(struct type_info), + GFP_KERNEL); + if (iter) + iter->info = info; + + return iter; +} + +/** + * gcov_iter_free - release memory for iterator + * @iter: file iterator to free + */ +void gcov_iter_free(struct gcov_iterator *iter) +{ + kfree(iter); +} + +/** + * gcov_iter_get_info - return profiling data set for given file iterator + * @iter: file iterator + */ +struct gcov_info *gcov_iter_get_info(struct gcov_iterator *iter) +{ + return iter->info; +} + +/** + * gcov_iter_start - reset file iterator to starting position + * @iter: file iterator + */ +void gcov_iter_start(struct gcov_iterator *iter) +{ + int i; + + iter->record = 0; + iter->function = 0; + iter->type = 0; + iter->count = 0; + iter->num_types = 0; + for (i = 0; i < GCOV_COUNTERS; i++) { + if (counter_active(iter->info, i)) { + iter->type_info[iter->num_types].ctr_type = i; + iter->type_info[iter->num_types++].offset = 0; + } + } +} + +/** + * gcov_iter_next - advance file iterator to next logical record + * @iter: file iterator + * + * Return zero if new position is valid, non-zero if iterator has reached end. + */ +int gcov_iter_next(struct gcov_iterator *iter) +{ + switch (iter->record) { + case 0: + case 1: + case 3: + case 4: + case 5: + case 7: + /* Advance to next record */ + iter->record++; + break; + case 9: + /* Advance to next count */ + iter->count++; + /* fall through */ + case 8: + if (iter->count < get_func(iter)->n_ctrs[iter->type]) { + iter->record = 9; + break; + } + /* Advance to next counter type */ + get_type(iter)->offset += iter->count; + iter->count = 0; + iter->type++; + /* fall through */ + case 6: + if (iter->type < iter->num_types) { + iter->record = 7; + break; + } + /* Advance to next function */ + iter->type = 0; + iter->function++; + /* fall through */ + case 2: + if (iter->function < iter->info->n_functions) + iter->record = 3; + else + iter->record = -1; + break; + } + /* Check for EOF. */ + if (iter->record == -1) + return -EINVAL; + else + return 0; +} + +/** + * seq_write_gcov_int - write number in gcov format to seq_file + * @seq: seq_file handle + * @size: size of number in bytes (either 4 or 8) + * @v: value to be stored + * + * Number format defined by gcc: numbers are recorded in the 32 bit + * unsigned binary form of the endianness of the machine generating the + * file. 64 bit numbers are stored as two 32 bit numbers, the low part + * first. + */ +static int seq_write_gcov_int(struct seq_file *seq, size_t size, u64 v) +{ + u32 data[2]; + + switch (size) { + case 8: + data[1] = (v >> 32); + /* fall through */ + case 4: + data[0] = (v & 0xffffffffUL); + return seq_write(seq, data, size); + } + return -EINVAL; +} + +/** + * gcov_iter_write - write data for current pos to seq_file + * @iter: file iterator + * @seq: seq_file handle + * + * Return zero on success, non-zero otherwise. + */ +int gcov_iter_write(struct gcov_iterator *iter, struct seq_file *seq) +{ + int rc = -EINVAL; + + switch (iter->record) { + case 0: /* file magic */ + rc = seq_write_gcov_int(seq, 4, GCOV_DATA_MAGIC); + break; + case 1: /* gcov_version */ + rc = seq_write_gcov_int(seq, 4, iter->info->version); + break; + case 2: /* time stamp */ + rc = seq_write_gcov_int(seq, 4, iter->info->stamp); + break; + case 3: /* function tag */ + rc = seq_write_gcov_int(seq, 4, GCOV_TAG_FUNCTION); + break; + case 4: /* function tag length */ + rc = seq_write_gcov_int(seq, 4, 2); + break; + case 5: /* function ident*/ + rc = seq_write_gcov_int(seq, 4, get_func(iter)->ident); + break; + case 6: /* function checksum */ + rc = seq_write_gcov_int(seq, 4, get_func(iter)->checksum); + break; + case 7: /* count tag */ + rc = seq_write_gcov_int(seq, 4, + GCOV_TAG_FOR_COUNTER(get_type(iter)->ctr_type)); + break; + case 8: /* count length */ + rc = seq_write_gcov_int(seq, 4, + get_func(iter)->n_ctrs[iter->type] * 2); + break; + case 9: /* count */ + rc = seq_write_gcov_int(seq, 8, + iter->info->counts[iter->type]. + values[iter->count + get_type(iter)->offset]); + break; + } + return rc; +} Index: linux-2.6.30-rc4/kernel/gcov/gcov.h =================================================================== --- /dev/null +++ linux-2.6.30-rc4/kernel/gcov/gcov.h @@ -0,0 +1,128 @@ +/* + * Profiling infrastructure declarations. + * + * This file is based on gcc-internal definitions. Data structures are + * defined to be compatible with gcc counterparts. For a better + * understanding, refer to gcc source: gcc/gcov-io.h. + * + * Copyright IBM Corp. 2009 + * Author(s): Peter Oberparleiter <oberpar@linux.vnet.ibm.com> + * + * Uses gcc-internal data definitions. + */ + +#ifndef GCOV_H +#define GCOV_H GCOV_H + +#include <linux/types.h> + +#define TAG "gcov: " + +/* Profiling data types used for gcc 3.4 and above - these are defined by + * gcc and need to be kept as close to the original definition as possible to + * remain compatible. */ +#define GCOV_COUNTERS 5 +#define GCOV_DATA_MAGIC ((unsigned int) 0x67636461) +#define GCOV_TAG_FUNCTION ((unsigned int) 0x01000000) +#define GCOV_TAG_COUNTER_BASE ((unsigned int) 0x01a10000) +#define GCOV_TAG_FOR_COUNTER(count) \ + (GCOV_TAG_COUNTER_BASE + ((unsigned int) (count) << 17)) + +#if BITS_PER_LONG >= 64 +typedef long gcov_type; +#else +typedef long long gcov_type; +#endif + +/** + * struct gcov_fn_info - profiling meta data per function + * @ident: object file-unique function identifier + * @checksum: function checksum + * @n_ctrs: number of values per counter type belonging to this function + * + * This data is generated by gcc during compilation and doesn't change + * at run-time. + */ +struct gcov_fn_info { + unsigned int ident; + unsigned int checksum; + unsigned int n_ctrs[0]; +}; + +/** + * struct gcov_ctr_info - profiling data per counter type + * @num: number of counter values for this type + * @values: array of counter values for this type + * @merge: merge function for counter values of this type (unused) + * + * This data is generated by gcc during compilation and doesn't change + * at run-time with the exception of the values array. + */ +struct gcov_ctr_info { + unsigned int num; + gcov_type *values; + void (*merge)(gcov_type *, unsigned int); +}; + +/** + * struct gcov_info - profiling data per object file + * @version: gcov version magic indicating the gcc version used for compilation + * @next: list head for a singly-linked list + * @stamp: time stamp + * @filename: name of the associated gcov data file + * @n_functions: number of instrumented functions + * @functions: function data + * @ctr_mask: mask specifying which counter types are active + * @counts: counter data per counter type + * + * This data is generated by gcc during compilation and doesn't change + * at run-time with the exception of the next pointer. + */ +struct gcov_info { + unsigned int version; + struct gcov_info *next; + unsigned int stamp; + const char *filename; + unsigned int n_functions; + const struct gcov_fn_info *functions; + unsigned int ctr_mask; + struct gcov_ctr_info counts[0]; +}; + +/* Base interface. */ +enum gcov_action { + gcov_add, + gcov_remove, +}; + +void gcov_event(enum gcov_action action, struct gcov_info *info); +void gcov_enable_events(void); + +/* Iterator control. */ +struct seq_file; +struct gcov_iterator; + +struct gcov_iterator *gcov_iter_new(struct gcov_info *info); +void gcov_iter_free(struct gcov_iterator *iter); +void gcov_iter_start(struct gcov_iterator *iter); +int gcov_iter_next(struct gcov_iterator *iter); +int gcov_iter_write(struct gcov_iterator *iter, struct seq_file *seq); +struct gcov_info *gcov_iter_get_info(struct gcov_iterator *iter); + +/* gcov_info control. */ +void gcov_info_reset(struct gcov_info *info); +int gcov_info_is_compatible(struct gcov_info *info1, struct gcov_info *info2); +void gcov_info_add(struct gcov_info *dest, struct gcov_info *source); +struct gcov_info *gcov_info_dup(struct gcov_info *info); +void gcov_info_free(struct gcov_info *info); + +struct gcov_link { + enum { + obj_tree, + src_tree, + } dir; + const char *ext; +}; +extern const struct gcov_link gcov_link[]; + +#endif /* GCOV_H */ Index: linux-2.6.30-rc4/scripts/Makefile.lib =================================================================== --- linux-2.6.30-rc4.orig/scripts/Makefile.lib +++ linux-2.6.30-rc4/scripts/Makefile.lib @@ -116,6 +116,15 @@ _a_flags = $(KBUILD_CPPFLAGS) $(KB $(asflags-y) $(AFLAGS_$(basetarget).o) _cpp_flags = $(KBUILD_CPPFLAGS) $(cppflags-y) $(CPPFLAGS_$(@F)) +# Enable gcov profiling flags for a file, directory or for all files depending +# on variables GCOV_PROFILE_obj.o, GCOV_PROFILE and CONFIG_GCOV_PROFILE_ALL +# (in this order) +ifeq ($(CONFIG_GCOV_KERNEL),y) +_c_flags += $(if $(patsubst n%,, \ + $(GCOV_PROFILE_$(basetarget).o)$(GCOV_PROFILE)$(CONFIG_GCOV_PROFILE_ALL)), \ + $(CFLAGS_GCOV)) +endif + # If building the kernel in a separate objtree expand all occurrences # of -Idir to -I$(srctree)/dir except for absolute paths (starting with '/'). ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 3/4] gcov: add gcov profiling infrastructure 2009-05-07 12:45 ` [PATCH 3/4] gcov: add gcov profiling infrastructure Peter Oberparleiter @ 2009-05-07 13:46 ` Ingo Molnar 2009-05-07 13:49 ` Ingo Molnar 2009-05-08 11:10 ` Peter Oberparleiter 0 siblings, 2 replies; 23+ messages in thread From: Ingo Molnar @ 2009-05-07 13:46 UTC (permalink / raw) To: Peter Oberparleiter Cc: linux-kernel, Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> wrote: [...] > Index: linux-2.6.30-rc4/init/main.c > =================================================================== > --- linux-2.6.30-rc4.orig/init/main.c > +++ linux-2.6.30-rc4/init/main.c > @@ -77,6 +77,14 @@ > #include <asm/smp.h> > #endif > > +#ifdef CONFIG_GCOV_KERNEL > + > +#if (__GNUC__ < 3) || (__GNUC__ == 3) && (__GNUC_MINOR__ < 4) > +#error "GCOV profiling support for gcc versions below 3.4 not included" > +#endif /* __GNUC__ */ > + > +#endif /* CONFIG_GCOV_KERNEL */ Compiler support assertions are typically done in include/linux/compiler*.h. They used to be in init/main.c up until recently but we moved them out of there. > + > static int kernel_init(void *); > > extern void init_IRQ(void); > Index: linux-2.6.30-rc4/kernel/Makefile > =================================================================== > --- linux-2.6.30-rc4.orig/kernel/Makefile > +++ linux-2.6.30-rc4/kernel/Makefile > @@ -70,6 +70,7 @@ obj-$(CONFIG_STOP_MACHINE) += stop_machi > obj-$(CONFIG_KPROBES_SANITY_TEST) += test_kprobes.o > obj-$(CONFIG_AUDIT) += audit.o auditfilter.o > obj-$(CONFIG_AUDITSYSCALL) += auditsc.o > +obj-$(CONFIG_GCOV_KERNEL) += gcov/ > obj-$(CONFIG_AUDIT_TREE) += audit_tree.o > obj-$(CONFIG_KPROBES) += kprobes.o > obj-$(CONFIG_KGDB) += kgdb.o > Index: linux-2.6.30-rc4/kernel/gcov/Kconfig > =================================================================== > --- /dev/null > +++ linux-2.6.30-rc4/kernel/gcov/Kconfig > @@ -0,0 +1,48 @@ > +menu "GCOV-based kernel profiling" > + > +config GCOV_KERNEL > + bool "Enable gcov-based kernel profiling" > + depends on DEBUG_FS && CONSTRUCTORS > + default n > + ---help--- > + This option enables gcov-based code profiling (e.g. for code coverage > + measurements). > + > + If unsure, say N. > + > + Additionally specify CONFIG_GCOV_PROFILE_ALL=y to get profiling data > + for the entire kernel. To enable profiling for specific files or > + directories, add a line similar to the following to the respective > + Makefile: > + > + For a single file (e.g. main.o): > + GCOV_PROFILE_main.o := y > + > + For all files in one directory: > + GCOV_PROFILE := y > + > + To exclude files from being profiled even when CONFIG_GCOV_PROFILE_ALL > + is specified, use: > + > + GCOV_PROFILE_main.o := n > + and: > + GCOV_PROFILE := n > + > + Note that the debugfs filesystem has to be mounted to access > + profiling data. > + > +config GCOV_PROFILE_ALL > + bool "Profile entire Kernel" > + depends on GCOV_KERNEL > + depends on S390 || X86_32 > + default n > + ---help--- > + This options activates profiling for the entire kernel. > + > + If unsure, say N. > + > + Note that a kernel compiled with profiling flags will be significantly > + larger and run slower. Also be sure to exclude files from profiling > + which are not linked to the kernel image to prevent linker errors. > + > +endmenu > Index: linux-2.6.30-rc4/kernel/gcov/Makefile > =================================================================== > --- /dev/null > +++ linux-2.6.30-rc4/kernel/gcov/Makefile > @@ -0,0 +1,3 @@ > +EXTRA_CFLAGS := -DSRCTREE='"$(srctree)"' -DOBJTREE='"$(objtree)"' > + > +obj-$(CONFIG_GCOV_KERNEL) := base.o fs.o gcc_3_4.o > Index: linux-2.6.30-rc4/kernel/gcov/base.c > =================================================================== > --- /dev/null > +++ linux-2.6.30-rc4/kernel/gcov/base.c > @@ -0,0 +1,145 @@ > +/* > + * This code maintains a list of active profiling data structures. > + * > + * Copyright IBM Corp. 2009 > + * Author(s): Peter Oberparleiter <oberpar@linux.vnet.ibm.com> > + * > + * Uses gcc-internal data definitions. > + * Based on the gcov-kernel patch by: > + * Hubertus Franke <frankeh@us.ibm.com> > + * Nigel Hinds <nhinds@us.ibm.com> > + * Rajan Ravindran <rajancr@us.ibm.com> > + * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> > + * Paul Larson > + */ > + > +#include <linux/init.h> > +#include <linux/module.h> > +#include <linux/mutex.h> > +#include <linux/syscalls.h> > +#include "gcov.h" > + > +static struct gcov_info *gcov_info_head; > +static int gcov_events_enabled; > +static DEFINE_MUTEX(gcov_lock); > + > +/* __gcov_init is called by gcc-generated constructor code for each object > + * file compiled with -fprofile-arcs. */ Please use standard multi-line comments like specified in Documentation/CodingStyle. This observation holds for basically all the comment blocks in this file - dozens of them. > +void __gcov_init(struct gcov_info *info) > +{ > + static unsigned int gcov_version; > + > + mutex_lock(&gcov_lock); > + if (gcov_version == 0) { > + gcov_version = info->version; > + /* Printing gcc's version magic may prove useful for debugging > + * incompatibility reports. */ > + printk(KERN_INFO TAG "version magic: 0x%x\n", gcov_version); > + } > + /* Add new profiling data structure to list and inform event > + * listener. */ > + info->next = gcov_info_head; > + gcov_info_head = info; > + if (gcov_events_enabled) > + gcov_event(gcov_add, info); > + mutex_unlock(&gcov_lock); > +} > +EXPORT_SYMBOL(__gcov_init); > + > +/* These functions may be referenced by gcc-generated profiling code but serve > + * no function for kernel profiling. */ > +void __gcov_flush(void) > +{ > + /* Unused. */ > +} > +EXPORT_SYMBOL(__gcov_flush); Please turn these into GPL exports. We dont want binary-only crap to learn to depend on one more kernel-internal detail in an ABI fashion. > +void __gcov_merge_add(gcov_type *counters, unsigned int n_counters) > +{ > + /* Unused. */ > +} > +EXPORT_SYMBOL(__gcov_merge_add); > + > +void __gcov_merge_single(gcov_type *counters, unsigned int n_counters) > +{ > + /* Unused. */ > +} > +EXPORT_SYMBOL(__gcov_merge_single); > + > +void __gcov_merge_delta(gcov_type *counters, unsigned int n_counters) > +{ > + /* Unused. */ > +} > +EXPORT_SYMBOL(__gcov_merge_delta); > + > +int __gcov_execve(const char *path, char *const argv[], char *const envp[]) > +{ > + return kernel_execve(path, argv, envp); > +} > +EXPORT_SYMBOL(__gcov_execve); > + > +/** > + * gcov_enable_events - enable event reporting through gcov_event() > + * > + * Turn on reporting of profiling data load/unload-events through the > + * gcov_event() callback. Also replay all previous events once. This function > + * is needed because some events are potentially generated too early for the > + * callback implementation to handle them initially. > + */ > +void gcov_enable_events(void) > +{ > + struct gcov_info *info; > + > + mutex_lock(&gcov_lock); > + gcov_events_enabled = 1; > + /* Perform event callback for previously registered entries. */ > + for (info = gcov_info_head; info; info = info->next) > + gcov_event(gcov_add, info); > + mutex_unlock(&gcov_lock); > +} > + > +static inline int within(void *addr, void *start, unsigned long size) > +{ > + return ((addr >= start) && (addr < start + size)); > +} this should be factored out into a generic helper in include/linux/kernel.h. > + > +/* Update list and generate events when modules are unloaded. */ > +static int gcov_module_notifier(struct notifier_block *nb, unsigned long event, > + void *data) > +{ > +#ifdef CONFIG_MODULES > + struct module *mod = data; > + struct gcov_info *info; > + struct gcov_info *prev; > + > + if (event != MODULE_STATE_GOING) > + return NOTIFY_OK; > + mutex_lock(&gcov_lock); > + prev = NULL; > + /* Remove entries located in module from linked list. */ > + for (info = gcov_info_head; info; info = info->next) { > + if (within(info, mod->module_core, mod->core_size)) { > + if (prev) > + prev->next = info->next; > + else > + gcov_info_head = info->next; > + if (gcov_events_enabled) > + gcov_event(gcov_remove, info); > + } else > + prev = info; > + } > + mutex_unlock(&gcov_lock); > +#endif /* CONFIG_MODULES */ > + > + return NOTIFY_OK; > +} > + > +static struct notifier_block gcov_nb = { > + .notifier_call = gcov_module_notifier, > +}; > + > +static int __init gcov_init(void) > +{ > + return register_module_notifier(&gcov_nb); > +} > +device_initcall(gcov_init); this whole block could move under CONFIG_MODULES. > Index: linux-2.6.30-rc4/kernel/gcov/fs.c > =================================================================== > --- /dev/null > +++ linux-2.6.30-rc4/kernel/gcov/fs.c > @@ -0,0 +1,634 @@ > +/* > + * This code exports profiling data as debugfs files to userspace. > + * > + * Copyright IBM Corp. 2009 > + * Author(s): Peter Oberparleiter <oberpar@linux.vnet.ibm.com> > + * > + * Uses gcc-internal data definitions. > + * Based on the gcov-kernel patch by: > + * Hubertus Franke <frankeh@us.ibm.com> > + * Nigel Hinds <nhinds@us.ibm.com> > + * Rajan Ravindran <rajancr@us.ibm.com> > + * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> > + * Paul Larson > + * Yi CDL Yang > + */ > + > +#include <linux/init.h> > +#include <linux/module.h> > +#include <linux/debugfs.h> > +#include <linux/fs.h> > +#include <linux/list.h> > +#include <linux/string.h> > +#include <linux/slab.h> > +#include <linux/mutex.h> > +#include <linux/seq_file.h> > +#include "gcov.h" > + > +/** > + * struct gcov_node - represents a debugfs entry > + * @list: list head for child node list > + * @children: child nodes > + * @all: list head for list of all nodes > + * @parent: parent node > + * @info: associated profiling data structure if not a directory > + * @ghost: when an object file containing profiling data is unloaded we keep a > + * copy of the profiling data here to allow collecting coverage data > + * for cleanup code. Such a node is called a "ghost". > + * @dentry: main debugfs entry, either a directory or data file > + * @links: associated symbolic links > + * @name: data file basename > + * > + * struct gcov_node represents an entity within the gcov/ subdirectory > + * of debugfs. There are directory and data file nodes. The latter represent > + * the actual synthesized data file plus any associated symbolic links which > + * are needed by the gcov tool to work correctly. > + */ > +struct gcov_node { > + struct list_head list; > + struct list_head children; > + struct list_head all; > + struct gcov_node *parent; > + struct gcov_info *info; > + struct gcov_info *ghost; > + struct dentry *dentry; > + struct dentry **links; > + char name[0]; > +}; > + > +static const char objtree[] = OBJTREE; > +static const char srctree[] = SRCTREE; > +static struct gcov_node root_node; > +static struct dentry *reset_dentry; > +static LIST_HEAD(all_head); > +static DEFINE_MUTEX(node_lock); > + > +/* If non-zero, keep copies of profiling data for unloaded modules. */ > +static int gcov_persist = 1; > + > +static int __init gcov_persist_setup(char *str) > +{ > + int val; > + char delim; > + > + if (sscanf(str, "%d %c", &val, &delim) != 1) { > + printk(KERN_WARNING TAG "invalid gcov_persist parameter '%s'\n", > + str); > + return 0; > + } > + printk(KERN_INFO TAG "setting gcov_persist to %d\n", val); > + gcov_persist = val; > + > + return 1; > +} > +__setup("gcov_persist=", gcov_persist_setup); > + > +/* seq_file.start() implementation for gcov data files. Note that the > + * gcov_iterator interface is designed to be more restrictive than seq_file > + * (no start from arbitrary position, etc.), to simplify the iterator > + * implementation. */ > +static void *gcov_seq_start(struct seq_file *seq, loff_t *pos) > +{ > + loff_t i; > + > + gcov_iter_start(seq->private); > + for (i = 0; i < *pos; i++) > + if (gcov_iter_next(seq->private)) > + return NULL; Please use curly braces for multi-line loop bodies. > + > + return seq->private; > +} > + > +/* seq_file.next() implementation for gcov data files. */ > +static void *gcov_seq_next(struct seq_file *seq, void *data, loff_t *pos) > +{ > + struct gcov_iterator *iter = data; > + > + if (gcov_iter_next(iter)) > + return NULL; > + (*pos)++; > + > + return iter; > +} > + > +/* seq_file.show() implementation for gcov data files. */ > +static int gcov_seq_show(struct seq_file *seq, void *data) > +{ > + struct gcov_iterator *iter = data; > + > + if (gcov_iter_write(iter, seq)) > + return -EINVAL; > + return 0; > +} > + > +static void gcov_seq_stop(struct seq_file *seq, void *data) > +{ > + /* Unused. */ > +} > + > +static const struct seq_operations gcov_seq_ops = { > + .start = gcov_seq_start, > + .next = gcov_seq_next, > + .show = gcov_seq_show, > + .stop = gcov_seq_stop, turning _stop into NULL and removing gcov_seq_stop() will have the same effect as the code above, right? > +}; > + > +/* Return the profiling data set for a given node. This can either be the > + * original profiling data structure or a duplicate (also called "ghost") > + * in case the associated object file has been unloaded. */ (continuing objection to comment style) > +static struct gcov_info *get_node_info(struct gcov_node *node) > +{ > + if (node->info) > + return node->info; > + > + return node->ghost; > +} > + > +/* open() implementation for gcov data files. Create a copy of the profiling > + * data set and initialize the iterator and seq_file interface. */ > +static int gcov_seq_open(struct inode *inode, struct file *file) > +{ > + struct gcov_node *node = inode->i_private; > + struct gcov_iterator *iter; > + struct seq_file *seq; > + struct gcov_info *info; > + int rc; > + > + mutex_lock(&node_lock); > + /* Read from a profiling data copy to minimize reference tracking > + * complexity and concurrent access. */ > + info = gcov_info_dup(get_node_info(node)); > + if (!info) { > + rc = -ENOMEM; > + goto out_unlock; > + } The standard pattern is: rc = -ENOMEM; info = gcov_info_dup(get_node_info(node)); if (!info) goto out_unlock; One liner shorter, no curly braces, but look how the same rc code will be used for the code below as well: > + iter = gcov_iter_new(info); > + if (!iter) { > + rc = -ENOMEM; > + goto out_free; > + } making it ~3 lines shorter and much easier on the eyes. > + rc = seq_open(file, &gcov_seq_ops); > + if (rc) > + goto out_free2; > + seq = file->private_data; > + seq->private = iter; > + goto out_unlock; > + > +out_free2: > + gcov_iter_free(iter); > +out_free: > + gcov_info_free(info); > +out_unlock: > + mutex_unlock(&node_lock); > + > + return rc; No. The standard pattern to do this is: seq = file->private_data; seq->private = iter; out_unlock: mutex_unlock(&node_lock); return rc; out_free2: gcov_iter_free(iter); out_free: gcov_info_free(info); goto out_unlock; Note how the common path is fall-through now. (fall-through both to the compiler and to the human eye.) Furthermore, istead of out_free2, please use a more descriptive labels like: out_free_iter_info: out_free_info: that contains the nesting nature. > +} > + > +/* release() implementation for gcov data files. Release resources allocated > + * by open(). */ > +static int gcov_seq_release(struct inode *inode, struct file *file) > +{ > + struct gcov_iterator *iter; > + struct gcov_info *info; > + struct seq_file *seq = file->private_data; > + > + iter = seq->private; > + info = gcov_iter_get_info(iter); please either initialize all variables in the local variables definition block, or (preferably) assign them later on (even if this means one more line of code). Mixing the twomakes no sense. > + gcov_iter_free(iter); > + gcov_info_free(info); this is a repeating pattern - shouldnt gcov_iter_free() auto-free the (embedded) info structure as well? > + seq_release(inode, file); > + > + return 0; > +} > + > +/* Find a node by the associated data file name. Needs to be called with > + * node_lock held. */ > +static struct gcov_node *get_node_by_name(const char *name) > +{ > + struct gcov_node *node; > + struct gcov_info *info; > + > + list_for_each_entry(node, &all_head, all) { > + info = get_node_info(node); > + if (info && (strcmp(info->filename, name) == 0)) > + return node; > + } > + > + return NULL; > +} > + > +static void remove_node(struct gcov_node *node); > + > +/* write() implementation for gcov data files. Reset profiling data for the > + * associated file. If the object file has been unloaded (i.e. this is > + * a "ghost" node), remove the debug fs node as well. */ > +static ssize_t gcov_seq_write(struct file *file, const char __user *addr, > + size_t len, loff_t *pos) > +{ > + struct seq_file *seq = file->private_data; > + struct gcov_info *info = gcov_iter_get_info(seq->private); > + struct gcov_node *node; > + > + mutex_lock(&node_lock); > + node = get_node_by_name(info->filename); > + if (node) { > + /* Reset counts or remove node for unloaded modules. */ > + if (node->ghost) > + remove_node(node); > + else > + gcov_info_reset(node->info); > + } > + /* Reset counts for open file. */ > + gcov_info_reset(info); > + mutex_unlock(&node_lock); > + > + return len; > +} > + > +/* Given a string <path> representing a file path of format: > + * path/to/file.gcda > + * construct and return a new string: > + * <dir/>path/to/file.<ext> */ > +static char *link_target(const char *dir, const char *path, const char *ext) > +{ > + char *target; > + char *old_ext; > + char *copy; > + > + copy = kstrdup(path, GFP_KERNEL); > + if (!copy) > + return NULL; > + old_ext = strrchr(copy, '.'); > + if (old_ext) > + *old_ext = '\0'; > + if (dir) > + target = kasprintf(GFP_KERNEL, "%s/%s.%s", dir, copy, ext); > + else > + target = kasprintf(GFP_KERNEL, "%s.%s", copy, ext); > + kfree(copy); > + > + return target; > +} > + > +/* Construct a string representing the symbolic link target for the given > + * gcov data file name and link type. Depending on the link type and the > + * location of the data file, the link target can either point to a > + * subdirectory of srctree, objtree or in an external location. */ > +static char *get_link_target(const char *filename, const struct gcov_link *ext) > +{ > + const char *rel; > + char *result; > + > + if (strncmp(filename, objtree, strlen(objtree)) == 0) { > + rel = filename + strlen(objtree) + 1; > + if (ext->dir == src_tree) > + result = link_target(srctree, rel, ext->ext); > + else > + result = link_target(objtree, rel, ext->ext); > + } else { > + /* External compilation. */ > + result = link_target(NULL, filename, ext->ext); > + } > + > + return result; > +} > + > +#define SKEW_PREFIX ".tmp_" > + > +/* For a filename .tmp_filename.ext return filename.ext. Needed to compensate > + * for filename skewing caused by the mod-versioning mechanism. */ > +static const char *deskew(const char *basename) > +{ > + if (strncmp(basename, SKEW_PREFIX, sizeof(SKEW_PREFIX) - 1) == 0) > + return basename + sizeof(SKEW_PREFIX) - 1; > + return basename; > +} > + > +/* Create links to additional files (usually .c and .gcno files) which the > + * gcov tool expects to find in the same directory as the gcov data file. */ > +static void add_links(struct gcov_node *node, struct dentry *parent) > +{ > + char *basename; > + char *target; > + int num; > + int i; > + > + for (num = 0; gcov_link[num].ext; num++) > + /* Nothing. */; > + node->links = kcalloc(num, sizeof(struct dentry *), GFP_KERNEL); > + if (!node->links) > + return; > + for (i = 0; i < num; i++) { > + target = get_link_target(get_node_info(node)->filename, > + &gcov_link[i]); > + if (!target) > + goto out_err; > + basename = strrchr(target, '/'); > + if (!basename) > + goto out_err; > + basename++; > + node->links[i] = debugfs_create_symlink(deskew(basename), > + parent, target); > + if (!node->links[i]) > + goto out_err; > + kfree(target); > + } > + > + return; > +out_err: > + kfree(target); > + while (i-- > 0) > + debugfs_remove(node->links[i]); > + kfree(node->links); > + node->links = NULL; > +} > + > +static const struct file_operations gcov_data_fops = { > + .open = gcov_seq_open, > + .release = gcov_seq_release, > + .read = seq_read, > + .llseek = seq_lseek, > + .write = gcov_seq_write, > +}; please write all such multi-line structure initializations as: .open = gcov_seq_open, .release = gcov_seq_release, .read = seq_read, .llseek = seq_lseek, .write = gcov_seq_write, When written in that form a detail immediately stands out: the seq_read and seq_lseek initialization is superfluous, having NULL there will cause the seqfile code to default to those methods. > + > +/* Basic initialization of a new node. */ > +static void init_node(struct gcov_node *node, struct gcov_info *info, > + const char *name, struct gcov_node *parent) > +{ > + INIT_LIST_HEAD(&node->list); > + INIT_LIST_HEAD(&node->children); > + INIT_LIST_HEAD(&node->all); > + node->info = info; > + node->parent = parent; > + if (name) > + strcpy(node->name, name); > +} > + > +/* Create a new node and associated debugfs entry. Needs to be called with > + * node_lock held. */ > +static struct gcov_node *new_node(struct gcov_node *parent, > + struct gcov_info *info, const char *name) > +{ > + struct gcov_node *node; > + > + node = kzalloc(sizeof(struct gcov_node) + strlen(name) + 1, GFP_KERNEL); > + if (!node) { > + printk(KERN_WARNING TAG "out of memory\n"); > + return NULL; > + } > + init_node(node, info, name, parent); > + /* Differentiate between gcov data file nodes and directory nodes. */ > + if (info) { > + node->dentry = debugfs_create_file(deskew(node->name), 0600, > + parent->dentry, node, &gcov_data_fops); > + } else > + node->dentry = debugfs_create_dir(node->name, parent->dentry); > + if (!node->dentry) { > + printk(KERN_WARNING TAG "could not create file\n"); > + kfree(node); > + return NULL; > + } > + if (info) > + add_links(node, parent->dentry); > + list_add(&node->list, &parent->children); > + list_add(&node->all, &all_head); > + > + return node; > +} > + > +/* Remove symbolic links associated with node. */ > +static void remove_links(struct gcov_node *node) > +{ > + int i; > + > + if (!node->links) > + return; > + for (i = 0; gcov_link[i].ext; i++) > + debugfs_remove(node->links[i]); > + kfree(node->links); > + node->links = NULL; > +} > + > +/* Remove node from all lists and debugfs and release associated resources. > + * Needs to be called with node_lock held. */ > +static void release_node(struct gcov_node *node) > +{ > + list_del(&node->list); > + list_del(&node->all); > + debugfs_remove(node->dentry); > + remove_links(node); > + if (node->ghost) > + gcov_info_free(node->ghost); > + kfree(node); > +} > + > +/* Release node and empty parents. Needs to be called with node_lock held. */ > +static void remove_node(struct gcov_node *node) > +{ > + struct gcov_node *parent; > + > + while ((node != &root_node) && list_empty(&node->children)) { > + parent = node->parent; > + release_node(node); > + node = parent; > + } > +} > + > +/* Find child node with given basename. Needs to be called with node_lock > + * held. */ > +static struct gcov_node *get_child_by_name(struct gcov_node *parent, > + const char *name) > +{ > + struct gcov_node *node; > + > + list_for_each_entry(node, &parent->children, list) { > + if (strcmp(node->name, name) == 0) > + return node; > + } > + > + return NULL; > +} > + > +/* write() implementation for reset file. Reset all profiling data to zero > + * and remove ghost nodes. */ > +static ssize_t reset_write(struct file *file, const char __user *addr, > + size_t len, loff_t *pos) > +{ > + struct gcov_node *node; > + > + mutex_lock(&node_lock); > +restart: > + list_for_each_entry(node, &all_head, all) { > + if (node->info) > + gcov_info_reset(node->info); > + else if (list_empty(&node->children)) { > + remove_node(node); > + /* Several nodes may have gone - restart loop. */ > + goto restart; > + } > + } > + mutex_unlock(&node_lock); > + > + return len; > +} > + > +/* read() implementation for reset file. Unused. */ > +static ssize_t reset_read(struct file *file, char __user *addr, size_t len, > + loff_t *pos) > +{ > + /* Allow read operation so that a recursive copy won't fail. */ > + return 0; > +} > + > +static const struct file_operations gcov_reset_fops = { > + .write = reset_write, > + .read = reset_read, > +}; > + > +/* Create a node for a given profiling data set and add it to all lists and > + * debugfs. Needs to be called with node_lock held. */ > +static void add_node(struct gcov_info *info) > +{ > + char *filename; > + char *curr; > + char *next; > + struct gcov_node *parent; > + struct gcov_node *node; > + > + filename = kstrdup(info->filename, GFP_KERNEL); > + if (!filename) > + return; > + parent = &root_node; > + /* Create directory nodes along the path. */ > + for (curr = filename; (next = strchr(curr, '/')); curr = next + 1) { > + if (curr == next) > + continue; > + *next = 0; > + if (strcmp(curr, ".") == 0) > + continue; > + if (strcmp(curr, "..") == 0) { > + if (!parent->parent) > + goto out_err; > + parent = parent->parent; > + continue; > + } > + node = get_child_by_name(parent, curr); > + if (!node) { > + node = new_node(parent, NULL, curr); > + if (!node) > + goto out_err; > + } > + parent = node; > + } > + /* Create file node. */ > + node = new_node(parent, info, curr); > + if (node) > + goto out; > +out_err: > + remove_node(parent); > +out: > + kfree(filename); this too is an ugly teardown sequence mixing success and failure paths. Please clean it up like suggested above. > +} > + > +/* The profiling data set associated with this node is being unloaded. Store a > + * copy of the profiling data and turn this node into a "ghost". */ > +static int ghost_node(struct gcov_node *node) > +{ > + node->ghost = gcov_info_dup(node->info); > + if (!node->ghost) { > + printk(KERN_WARNING TAG "could not save data for '%s' (out of " > + "memory)\n", node->info->filename); > + return -ENOMEM; > + } > + node->info = NULL; > + > + return 0; > +} > + > +/* Profiling data for this node has been loaded again. Add profiling data > + * from previous instantiation and turn this node into a regular node. */ > +static void revive_node(struct gcov_node *node, struct gcov_info *info) > +{ > + if (gcov_info_is_compatible(node->ghost, info)) > + gcov_info_add(info, node->ghost); > + else { > + printk(KERN_WARNING TAG "discarding saved data for '%s' " > + "(version changed)\n", info->filename); > + } > + gcov_info_free(node->ghost); > + node->ghost = NULL; > + node->info = info; > +} > + > +/* Callback to create/remove profiling files when code compiled with > + * -fprofile-arcs is loaded/unloaded. */ > +void gcov_event(enum gcov_action action, struct gcov_info *info) > +{ > + struct gcov_node *node; > + > + mutex_lock(&node_lock); > + node = get_node_by_name(info->filename); > + switch (action) { > + case gcov_add: > + /* Add new node or revive ghost. */ > + if (!node) { > + add_node(info); > + break; > + } > + if (gcov_persist) > + revive_node(node, info); > + else > + printk(KERN_WARNING TAG "could not add '%s' " > + "(already exists)\n", info->filename); Please use pr_warning, pr_info, etc. for all such KERN_* printks in the whole patch. > + break; > + case gcov_remove: > + /* Remove node or turn into ghost. */ > + if (!node) { > + printk(KERN_WARNING TAG "could not remove '%s' (not " > + "found)\n", info->filename); > + break; > + } > + if (gcov_persist) { > + if (!ghost_node(node)) > + break; > + } > + remove_node(node); > + break; > + } > + mutex_unlock(&node_lock); > +} > + > +/* Create debugfs entries. */ > +static __init int gcov_fs_init(void) > +{ > + int rc; > + > + init_node(&root_node, NULL, NULL, NULL); > + /* /sys/kernel/debug/gcov will be parent for the reset control file > + * and all profiling files. */ > + root_node.dentry = debugfs_create_dir("gcov", NULL); > + if (!root_node.dentry) { > + printk(KERN_ERR TAG "could not create root dir\n"); > + rc = -EIO; > + goto out_remove; > + } > + /* Create reset file which resets all profiling counts when written > + * to. */ > + reset_dentry = debugfs_create_file("reset", 0600, root_node.dentry, > + NULL, &gcov_reset_fops); > + if (!reset_dentry) { > + printk(KERN_ERR TAG "could not create reset file\n"); > + rc = -EIO; > + goto out_remove; > + } rc setting could move to the local variable definition line. This would save two lines of code. > + /* Replay previous events to get our fs hierarchy up-to-date. */ > + gcov_enable_events(); > + > + return 0; > +out_remove: > + if (root_node.dentry) > + debugfs_remove(root_node.dentry); the printks could move to this place, cleaning up the normal code flow. > + > + return rc; > +} > +device_initcall(gcov_fs_init); > Index: linux-2.6.30-rc4/kernel/gcov/gcc_3_4.c > =================================================================== > --- /dev/null > +++ linux-2.6.30-rc4/kernel/gcov/gcc_3_4.c > @@ -0,0 +1,419 @@ > +/* > + * This code provides functions to handle gcc's profiling data format > + * introduced with gcc 3.4. Future versions of gcc may change the gcov > + * format (as happened before), so all format-specific information needs > + * to be kept modular and easily exchangeable. > + * > + * This file is based on gcc-internal definitions. Functions and data > + * structures are defined to be compatible with gcc counterparts. > + * For a better understanding, refer to gcc source: gcc/gcov-io.h. > + * > + * Copyright IBM Corp. 2009 > + * Author(s): Peter Oberparleiter <oberpar@linux.vnet.ibm.com> > + * > + * Uses gcc-internal data definitions. > + */ > + > +#include <linux/errno.h> > +#include <linux/slab.h> > +#include <linux/string.h> > +#include <linux/seq_file.h> > +#include "gcov.h" > + > +/* Symbolic links to be created for each profiling data file. */ > +const struct gcov_link gcov_link[] = { > + { obj_tree, "gcno" }, /* Link to .gcno file in $(objtree). */ > + { 0, NULL}, > +}; > + > +/* Determine whether a counter is active. Based on gcc magic. Doesn't change > + * at run-time. */ > +static int counter_active(struct gcov_info *info, unsigned int type) > +{ > + return (1 << type) & info->ctr_mask; > +} > + > +/* Determine number of active counters. Based on gcc magic. */ > +static unsigned int num_counter_active(struct gcov_info *info) > +{ > + unsigned int i; > + unsigned int result = 0; > + > + for (i = 0; i < GCOV_COUNTERS; i++) > + if (counter_active(info, i)) > + result++; > + return result; > +} > + > +/** > + * gcov_info_reset - reset profiling data to zero > + * @info: profiling data set > + */ > +void gcov_info_reset(struct gcov_info *info) > +{ > + unsigned int active = num_counter_active(info); > + unsigned int i; > + > + for (i = 0; i < active; i++) > + memset(info->counts[i].values, 0, > + info->counts[i].num * sizeof(gcov_type)); > +} > + > +/** > + * gcov_info_is_compatible - check if profiling data can be added > + * @info1: first profiling data set > + * @info2: second profiling data set > + * > + * Returns non-zero if profiling data can be added, zero otherwise. > + */ > +int gcov_info_is_compatible(struct gcov_info *info1, struct gcov_info *info2) > +{ > + return (info1->stamp == info2->stamp); > +} > + > +/** > + * gcov_info_add - add up profiling data > + * @dest: profiling data set to which data is added > + * @source: profiling data set which is added > + * > + * Adds profiling counts of @source to @dest. > + */ > +void gcov_info_add(struct gcov_info *dest, struct gcov_info *source) > +{ > + unsigned int i; > + unsigned int j; > + > + for (i = 0; i < num_counter_active(dest); i++) > + for (j = 0; j < dest->counts[i].num; j++) > + dest->counts[i].values[j] += > + source->counts[i].values[j]; > +} > + > +/* Get size of function info entry. Based on gcc magic. */ > +static size_t get_fn_size(struct gcov_info *info) > +{ > + size_t size; > + > + size = sizeof(struct gcov_fn_info) + num_counter_active(info) * > + sizeof(unsigned int); > + if (__alignof__(struct gcov_fn_info) > sizeof(unsigned int)) > + size = ALIGN(size, __alignof__(struct gcov_fn_info)); > + return size; > +} > + > +/* Get address of function info entry. Based on gcc magic. */ > +static struct gcov_fn_info *get_fn_info(struct gcov_info *info, unsigned int fn) > +{ > + return (struct gcov_fn_info *) > + ((char *) info->functions + fn * get_fn_size(info)); > +} > + > +/** > + * gcov_info_dup - duplicate profiling data set > + * @info: profiling data set to duplicate > + * > + * Return newly allocated duplicate on success, %NULL on error. > + */ > +struct gcov_info *gcov_info_dup(struct gcov_info *info) > +{ > + struct gcov_info *dup; > + unsigned int i; > + unsigned int active = num_counter_active(info); > + > + /* Duplicate gcov_info. */ > + dup = kzalloc(sizeof(struct gcov_info) + > + sizeof(struct gcov_ctr_info) * active, GFP_KERNEL); > + if (!dup) > + return NULL; > + dup->version = info->version; > + dup->stamp = info->stamp; > + dup->n_functions = info->n_functions; > + dup->ctr_mask = info->ctr_mask; > + /* Duplicate filename. */ > + dup->filename = kstrdup(info->filename, GFP_KERNEL); Please write such 6-line initializations as: dup->version = info->version; dup->stamp = info->stamp; dup->n_functions = info->n_functions; dup->ctr_mask = info->ctr_mask; /* Duplicate filename. */ dup->filename = kstrdup(info->filename, GFP_KERNEL); Makes it far easier to check at a glance that it's 1) correct 2) where the complexity lies. > + if (!dup->filename) > + goto out_free; > + /* Duplicate table of functions. */ > + dup->functions = kmemdup(info->functions, info->n_functions * > + get_fn_size(info), GFP_KERNEL); > + if (!dup->functions) > + goto out_free; > + /* Duplicate counter arrays. */ > + for (i = 0; i < active ; i++) { > + dup->counts[i].num = info->counts[i].num; > + dup->counts[i].merge = info->counts[i].merge; > + dup->counts[i].values = kmemdup(info->counts[i].values, > + sizeof(gcov_type) * info->counts[i].num, > + GFP_KERNEL); Please get rid of these ugly linebreaks by introducing a local 'struct gcov_ctr_info *count = dup->counts + i' and 'size' variables. You'll get a nice: gcov_ctr_info *count = dup->counts + i; size_t size = count->num * sizeof(gcov_type); count->num = info->counts[i].num; count->merge = info->counts[i].merge; count->values = kmemdup(count->values, size, GFP_KERNEL); if (!count->values) goto out_free; > + } > + return dup; > + > +out_free: > + gcov_info_free(dup); The convention for error case labels is "err_free". 'out' labels are generally used for normal outgoing paths. Here, when the entry's size is doubled, an allocation failure is an error. > + > + return NULL; > +} > + > +/** > + * gcov_info_free - release memory for profiling data set duplicate > + * @info: profiling data set duplicate to free > + */ > +void gcov_info_free(struct gcov_info *info) > +{ > + unsigned int active = num_counter_active(info); > + unsigned int i; > + > + for (i = 0; i < active ; i++) > + kfree(info->counts[i].values); > + kfree(info->functions); > + kfree(info->filename); > + kfree(info); > +} > + > +/** > + * struct type_info - iterator helper array > + * @ctr_type: counter type > + * @offset: index of the first value of the current function for this type > + * > + * This array is needed to convert the in-memory data format into the in-file > + * data format: > + * > + * In-memory: > + * for each counter type > + * for each function > + * values > + * > + * In-file: > + * for each function > + * for each counter type > + * values > + * > + * See gcc source gcc/gcov-io.h for more information on data organization. > + */ > +struct type_info { > + int ctr_type; > + unsigned int offset; > +}; > + > +/** > + * struct gcov_iterator - specifies current file position in logical records > + * @info: associated profiling data > + * @record: record type > + * @function: function number > + * @type: counter type > + * @count: index into values array > + * @num_types: number of counter types > + * @type_info: helper array to get values-array offset for current function > + */ > +struct gcov_iterator { > + struct gcov_info *info; > + > + int record; > + unsigned int function; > + unsigned int type; > + unsigned int count; > + > + int num_types; > + struct type_info type_info[0]; > +}; > + > +static struct gcov_fn_info *get_func(struct gcov_iterator *iter) > +{ > + return get_fn_info(iter->info, iter->function); > +} > + > +static struct type_info *get_type(struct gcov_iterator *iter) > +{ > + return &iter->type_info[iter->type]; > +} > + > +/** > + * gcov_iter_new - allocate and initialize profiling data iterator > + * @info: profiling data set to be iterated > + * > + * Return file iterator on success, %NULL otherwise. > + */ > +struct gcov_iterator *gcov_iter_new(struct gcov_info *info) > +{ > + struct gcov_iterator *iter; > + > + iter = kzalloc(sizeof(struct gcov_iterator) + > + num_counter_active(info) * sizeof(struct type_info), > + GFP_KERNEL); > + if (iter) > + iter->info = info; > + > + return iter; > +} > + > +/** > + * gcov_iter_free - release memory for iterator > + * @iter: file iterator to free > + */ > +void gcov_iter_free(struct gcov_iterator *iter) > +{ > + kfree(iter); > +} > + > +/** > + * gcov_iter_get_info - return profiling data set for given file iterator > + * @iter: file iterator > + */ > +struct gcov_info *gcov_iter_get_info(struct gcov_iterator *iter) > +{ > + return iter->info; > +} Such wrappers are completely pointless. Here it obfuscates the usage sites and makes them _larger_. Before it was: iter->info Now it is: gcov_iter_get_info(iter) Which is not very helpful ... > + > +/** > + * gcov_iter_start - reset file iterator to starting position > + * @iter: file iterator > + */ > +void gcov_iter_start(struct gcov_iterator *iter) > +{ > + int i; > + > + iter->record = 0; > + iter->function = 0; > + iter->type = 0; > + iter->count = 0; > + iter->num_types = 0; > + for (i = 0; i < GCOV_COUNTERS; i++) { > + if (counter_active(iter->info, i)) { > + iter->type_info[iter->num_types].ctr_type = i; > + iter->type_info[iter->num_types++].offset = 0; > + } > + } > +} > + > +/** > + * gcov_iter_next - advance file iterator to next logical record > + * @iter: file iterator > + * > + * Return zero if new position is valid, non-zero if iterator has reached end. > + */ > +int gcov_iter_next(struct gcov_iterator *iter) > +{ > + switch (iter->record) { > + case 0: > + case 1: > + case 3: > + case 4: > + case 5: > + case 7: > + /* Advance to next record */ > + iter->record++; > + break; > + case 9: > + /* Advance to next count */ > + iter->count++; > + /* fall through */ > + case 8: > + if (iter->count < get_func(iter)->n_ctrs[iter->type]) { > + iter->record = 9; > + break; > + } > + /* Advance to next counter type */ > + get_type(iter)->offset += iter->count; > + iter->count = 0; > + iter->type++; > + /* fall through */ > + case 6: > + if (iter->type < iter->num_types) { > + iter->record = 7; > + break; > + } > + /* Advance to next function */ > + iter->type = 0; > + iter->function++; > + /* fall through */ > + case 2: > + if (iter->function < iter->info->n_functions) > + iter->record = 3; > + else > + iter->record = -1; > + break; what are all these magic numbers? Is there a symbolic form of them? > + } > + /* Check for EOF. */ > + if (iter->record == -1) > + return -EINVAL; > + else > + return 0; > +} > + > +/** > + * seq_write_gcov_int - write number in gcov format to seq_file > + * @seq: seq_file handle > + * @size: size of number in bytes (either 4 or 8) > + * @v: value to be stored > + * > + * Number format defined by gcc: numbers are recorded in the 32 bit > + * unsigned binary form of the endianness of the machine generating the > + * file. 64 bit numbers are stored as two 32 bit numbers, the low part > + * first. > + */ > +static int seq_write_gcov_int(struct seq_file *seq, size_t size, u64 v) > +{ > + u32 data[2]; > + > + switch (size) { > + case 8: > + data[1] = (v >> 32); > + /* fall through */ > + case 4: > + data[0] = (v & 0xffffffffUL); > + return seq_write(seq, data, size); > + } > + return -EINVAL; > +} > + > +/** > + * gcov_iter_write - write data for current pos to seq_file > + * @iter: file iterator > + * @seq: seq_file handle > + * > + * Return zero on success, non-zero otherwise. > + */ > +int gcov_iter_write(struct gcov_iterator *iter, struct seq_file *seq) > +{ > + int rc = -EINVAL; > + > + switch (iter->record) { > + case 0: /* file magic */ > + rc = seq_write_gcov_int(seq, 4, GCOV_DATA_MAGIC); > + break; > + case 1: /* gcov_version */ > + rc = seq_write_gcov_int(seq, 4, iter->info->version); please use sizeof, or push the 'input type is int' assumption into seq_write_gcov_int(). The latter is more intelligent i guess, but for 8-byte writes: > + break; > + case 2: /* time stamp */ > + rc = seq_write_gcov_int(seq, 4, iter->info->stamp); > + break; > + case 3: /* function tag */ > + rc = seq_write_gcov_int(seq, 4, GCOV_TAG_FUNCTION); > + break; > + case 4: /* function tag length */ > + rc = seq_write_gcov_int(seq, 4, 2); > + break; > + case 5: /* function ident*/ > + rc = seq_write_gcov_int(seq, 4, get_func(iter)->ident); > + break; > + case 6: /* function checksum */ > + rc = seq_write_gcov_int(seq, 4, get_func(iter)->checksum); > + break; > + case 7: /* count tag */ > + rc = seq_write_gcov_int(seq, 4, > + GCOV_TAG_FOR_COUNTER(get_type(iter)->ctr_type)); > + break; > + case 8: /* count length */ > + rc = seq_write_gcov_int(seq, 4, > + get_func(iter)->n_ctrs[iter->type] * 2); > + break; > + case 9: /* count */ > + rc = seq_write_gcov_int(seq, 8, > + iter->info->counts[iter->type]. > + values[iter->count + get_type(iter)->offset]); ... introduce a seq_write_gcov_long variant for this. > + break; > + } > + return rc; > +} > Index: linux-2.6.30-rc4/kernel/gcov/gcov.h > =================================================================== > --- /dev/null > +++ linux-2.6.30-rc4/kernel/gcov/gcov.h > @@ -0,0 +1,128 @@ > +/* > + * Profiling infrastructure declarations. > + * > + * This file is based on gcc-internal definitions. Data structures are > + * defined to be compatible with gcc counterparts. For a better > + * understanding, refer to gcc source: gcc/gcov-io.h. > + * > + * Copyright IBM Corp. 2009 > + * Author(s): Peter Oberparleiter <oberpar@linux.vnet.ibm.com> > + * > + * Uses gcc-internal data definitions. > + */ > + > +#ifndef GCOV_H > +#define GCOV_H GCOV_H > + > +#include <linux/types.h> > + > +#define TAG "gcov: " > + > +/* Profiling data types used for gcc 3.4 and above - these are defined by > + * gcc and need to be kept as close to the original definition as possible to > + * remain compatible. */ > +#define GCOV_COUNTERS 5 > +#define GCOV_DATA_MAGIC ((unsigned int) 0x67636461) The 0x67636461U literal is the same. > +#define GCOV_TAG_FUNCTION ((unsigned int) 0x01000000) ditto. > +#define GCOV_TAG_COUNTER_BASE ((unsigned int) 0x01a10000) ditto. > +#define GCOV_TAG_FOR_COUNTER(count) \ > + (GCOV_TAG_COUNTER_BASE + ((unsigned int) (count) << 17)) generates code: should be an inline function. > + > +#if BITS_PER_LONG >= 64 > +typedef long gcov_type; > +#else > +typedef long long gcov_type; > +#endif please use u64 instead of gcov_type. This is ABI so it wont change. > + > +/** > + * struct gcov_fn_info - profiling meta data per function > + * @ident: object file-unique function identifier > + * @checksum: function checksum > + * @n_ctrs: number of values per counter type belonging to this function > + * > + * This data is generated by gcc during compilation and doesn't change > + * at run-time. > + */ > +struct gcov_fn_info { > + unsigned int ident; > + unsigned int checksum; > + unsigned int n_ctrs[0]; > +}; > + > +/** > + * struct gcov_ctr_info - profiling data per counter type > + * @num: number of counter values for this type > + * @values: array of counter values for this type > + * @merge: merge function for counter values of this type (unused) > + * > + * This data is generated by gcc during compilation and doesn't change > + * at run-time with the exception of the values array. > + */ > +struct gcov_ctr_info { > + unsigned int num; > + gcov_type *values; > + void (*merge)(gcov_type *, unsigned int); > +}; > + > +/** > + * struct gcov_info - profiling data per object file > + * @version: gcov version magic indicating the gcc version used for compilation > + * @next: list head for a singly-linked list > + * @stamp: time stamp > + * @filename: name of the associated gcov data file > + * @n_functions: number of instrumented functions > + * @functions: function data > + * @ctr_mask: mask specifying which counter types are active > + * @counts: counter data per counter type > + * > + * This data is generated by gcc during compilation and doesn't change > + * at run-time with the exception of the next pointer. > + */ > +struct gcov_info { > + unsigned int version; > + struct gcov_info *next; > + unsigned int stamp; > + const char *filename; > + unsigned int n_functions; > + const struct gcov_fn_info *functions; > + unsigned int ctr_mask; > + struct gcov_ctr_info counts[0]; please write such structure definitions as: struct gcov_info { unsigned int version; struct gcov_info *next; unsigned int stamp; const char *filename; unsigned int n_functions; const struct gcov_fn_info *functions; unsigned int ctr_mask; struct gcov_ctr_info counts[0]; for better readability That form immediately shows a packing inefficiency - the following ordering of the fields: unsigned int version; unsigned int stamp; unsigned int n_functions; unsigned int ctr_mask; struct gcov_info *next; const char *filename; const struct gcov_fn_info *functions; struct gcov_ctr_info counts[0]; ... will save 8 bytes off the structure size on 64-bit platforms. > +}; > + > +/* Base interface. */ > +enum gcov_action { > + gcov_add, > + gcov_remove, > +}; please use capital letters for constants. The 'gcov _add' here: gcov_event(gcov_add, info); Can be easily mistaken for a function pointer or a local variable. > + > +void gcov_event(enum gcov_action action, struct gcov_info *info); > +void gcov_enable_events(void); > + > +/* Iterator control. */ > +struct seq_file; > +struct gcov_iterator; > + > +struct gcov_iterator *gcov_iter_new(struct gcov_info *info); > +void gcov_iter_free(struct gcov_iterator *iter); > +void gcov_iter_start(struct gcov_iterator *iter); > +int gcov_iter_next(struct gcov_iterator *iter); > +int gcov_iter_write(struct gcov_iterator *iter, struct seq_file *seq); > +struct gcov_info *gcov_iter_get_info(struct gcov_iterator *iter); > + > +/* gcov_info control. */ > +void gcov_info_reset(struct gcov_info *info); > +int gcov_info_is_compatible(struct gcov_info *info1, struct gcov_info *info2); > +void gcov_info_add(struct gcov_info *dest, struct gcov_info *source); > +struct gcov_info *gcov_info_dup(struct gcov_info *info); > +void gcov_info_free(struct gcov_info *info); > + > +struct gcov_link { > + enum { > + obj_tree, > + src_tree, ditto. > + } dir; > + const char *ext; > +}; > +extern const struct gcov_link gcov_link[]; > + > +#endif /* GCOV_H */ > Index: linux-2.6.30-rc4/scripts/Makefile.lib > =================================================================== > --- linux-2.6.30-rc4.orig/scripts/Makefile.lib > +++ linux-2.6.30-rc4/scripts/Makefile.lib > @@ -116,6 +116,15 @@ _a_flags = $(KBUILD_CPPFLAGS) $(KB > $(asflags-y) $(AFLAGS_$(basetarget).o) > _cpp_flags = $(KBUILD_CPPFLAGS) $(cppflags-y) $(CPPFLAGS_$(@F)) > > +# Enable gcov profiling flags for a file, directory or for all files depending > +# on variables GCOV_PROFILE_obj.o, GCOV_PROFILE and CONFIG_GCOV_PROFILE_ALL > +# (in this order) > +ifeq ($(CONFIG_GCOV_KERNEL),y) Please try to use winged comments in makefiles too. > +_c_flags += $(if $(patsubst n%,, \ > + $(GCOV_PROFILE_$(basetarget).o)$(GCOV_PROFILE)$(CONFIG_GCOV_PROFILE_ALL)), \ > + $(CFLAGS_GCOV)) > +endif > + > # If building the kernel in a separate objtree expand all occurrences > # of -Idir to -I$(srctree)/dir except for absolute paths (starting with '/'). Furthermore: > +config GCOV_PROFILE_ALL > + bool "Profile entire Kernel" > + depends on GCOV_KERNEL > + depends on S390 || X86_32 64-bit x86 support is a must-have before we can think about upstreaming any of this. also: > +config GCOV_PROFILE_ALL > + bool "Profile entire Kernel" > + depends on GCOV_KERNEL > + depends on S390 || X86_32 > + default n > + ---help--- > + This options activates profiling for the entire kernel. > + > + If unsure, say N. > + > + Note that a kernel compiled with profiling flags will be significantly > + larger and run slower. Also be sure to exclude files from profiling > + which are not linked to the kernel image to prevent linker errors. ... the gcov code should consider using runtime code patching techniques like ftrace does - if possible - to bring this overhead down. So ... there's still a lot of work to be done with this code, and this review only sratched the surface. Please Cc: me to future submissions of this patch-set. Thanks, Ingo ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 3/4] gcov: add gcov profiling infrastructure 2009-05-07 13:46 ` Ingo Molnar @ 2009-05-07 13:49 ` Ingo Molnar 2009-05-08 11:10 ` Peter Oberparleiter 1 sibling, 0 replies; 23+ messages in thread From: Ingo Molnar @ 2009-05-07 13:49 UTC (permalink / raw) To: Peter Oberparleiter Cc: linux-kernel, Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman * Ingo Molnar <mingo@elte.hu> wrote: > > +config GCOV_PROFILE_ALL > > + bool "Profile entire Kernel" > > + depends on GCOV_KERNEL > > + depends on S390 || X86_32 > > 64-bit x86 support is a must-have before we can think about > upstreaming any of this. ok, the next patch does this so this hurdle is met :-) Ingo ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 3/4] gcov: add gcov profiling infrastructure 2009-05-07 13:46 ` Ingo Molnar 2009-05-07 13:49 ` Ingo Molnar @ 2009-05-08 11:10 ` Peter Oberparleiter 2009-05-11 13:17 ` Ingo Molnar 1 sibling, 1 reply; 23+ messages in thread From: Peter Oberparleiter @ 2009-05-08 11:10 UTC (permalink / raw) To: Ingo Molnar Cc: linux-kernel, Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman Ingo Molnar wrote: > * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> wrote: > > [...] >> Index: linux-2.6.30-rc4/init/main.c >> =================================================================== >> --- linux-2.6.30-rc4.orig/init/main.c >> +++ linux-2.6.30-rc4/init/main.c >> @@ -77,6 +77,14 @@ >> #include <asm/smp.h> >> #endif >> >> +#ifdef CONFIG_GCOV_KERNEL >> + >> +#if (__GNUC__ < 3) || (__GNUC__ == 3) && (__GNUC_MINOR__ < 4) >> +#error "GCOV profiling support for gcc versions below 3.4 not included" >> +#endif /* __GNUC__ */ >> + >> +#endif /* CONFIG_GCOV_KERNEL */ > > Compiler support assertions are typically done in > include/linux/compiler*.h. They used to be in init/main.c up until > recently but we moved them out of there. Ok, I'll move it to compiler-gcc3.h. [...] >> Index: linux-2.6.30-rc4/kernel/gcov/base.c >> =================================================================== >> --- /dev/null >> +++ linux-2.6.30-rc4/kernel/gcov/base.c >> @@ -0,0 +1,145 @@ >> +/* >> + * This code maintains a list of active profiling data structures. >> + * >> + * Copyright IBM Corp. 2009 >> + * Author(s): Peter Oberparleiter <oberpar@linux.vnet.ibm.com> >> + * >> + * Uses gcc-internal data definitions. >> + * Based on the gcov-kernel patch by: >> + * Hubertus Franke <frankeh@us.ibm.com> >> + * Nigel Hinds <nhinds@us.ibm.com> >> + * Rajan Ravindran <rajancr@us.ibm.com> >> + * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> >> + * Paul Larson >> + */ >> + >> +#include <linux/init.h> >> +#include <linux/module.h> >> +#include <linux/mutex.h> >> +#include <linux/syscalls.h> >> +#include "gcov.h" >> + >> +static struct gcov_info *gcov_info_head; >> +static int gcov_events_enabled; >> +static DEFINE_MUTEX(gcov_lock); >> + >> +/* __gcov_init is called by gcc-generated constructor code for each object >> + * file compiled with -fprofile-arcs. */ > > Please use standard multi-line comments like specified in > Documentation/CodingStyle. This observation holds for basically all > the comment blocks in this file - dozens of them. None of the __gcov functions are ever called by the kernel directly - only by gcc generated code. I can add comments for __gcov_init as that one is actually implemented. The other functions are required to prevent linking errors but are never actually called in kernel context, therefore in my opinion it wouldn't make much sense to provide full-blown comments for them. >> +void __gcov_init(struct gcov_info *info) >> +{ >> + static unsigned int gcov_version; >> + >> + mutex_lock(&gcov_lock); >> + if (gcov_version == 0) { >> + gcov_version = info->version; >> + /* Printing gcc's version magic may prove useful for debugging >> + * incompatibility reports. */ >> + printk(KERN_INFO TAG "version magic: 0x%x\n", gcov_version); >> + } >> + /* Add new profiling data structure to list and inform event >> + * listener. */ >> + info->next = gcov_info_head; >> + gcov_info_head = info; >> + if (gcov_events_enabled) >> + gcov_event(gcov_add, info); >> + mutex_unlock(&gcov_lock); >> +} >> +EXPORT_SYMBOL(__gcov_init); >> + >> +/* These functions may be referenced by gcc-generated profiling code but serve >> + * no function for kernel profiling. */ >> +void __gcov_flush(void) >> +{ >> + /* Unused. */ >> +} >> +EXPORT_SYMBOL(__gcov_flush); > > Please turn these into GPL exports. We dont want binary-only crap to > learn to depend on one more kernel-internal detail in an ABI > fashion. I disagree on this one. As mentioned before, these functions are only called indirectly by gcc-generated code when compiled with -fprofile-arcs. Declaring them GPL would not prevent people from writing non-GPL modules, it would only deny them a new method of finding bugs in their code. >> +void __gcov_merge_add(gcov_type *counters, unsigned int n_counters) >> +{ >> + /* Unused. */ >> +} >> +EXPORT_SYMBOL(__gcov_merge_add); >> + >> +void __gcov_merge_single(gcov_type *counters, unsigned int n_counters) >> +{ >> + /* Unused. */ >> +} >> +EXPORT_SYMBOL(__gcov_merge_single); >> + >> +void __gcov_merge_delta(gcov_type *counters, unsigned int n_counters) >> +{ >> + /* Unused. */ >> +} >> +EXPORT_SYMBOL(__gcov_merge_delta); >> + >> +int __gcov_execve(const char *path, char *const argv[], char *const envp[]) >> +{ >> + return kernel_execve(path, argv, envp); >> +} >> +EXPORT_SYMBOL(__gcov_execve); >> + >> +/** >> + * gcov_enable_events - enable event reporting through gcov_event() >> + * >> + * Turn on reporting of profiling data load/unload-events through the >> + * gcov_event() callback. Also replay all previous events once. This function >> + * is needed because some events are potentially generated too early for the >> + * callback implementation to handle them initially. >> + */ >> +void gcov_enable_events(void) >> +{ >> + struct gcov_info *info; >> + >> + mutex_lock(&gcov_lock); >> + gcov_events_enabled = 1; >> + /* Perform event callback for previously registered entries. */ >> + for (info = gcov_info_head; info; info = info->next) >> + gcov_event(gcov_add, info); >> + mutex_unlock(&gcov_lock); >> +} >> + >> +static inline int within(void *addr, void *start, unsigned long size) >> +{ >> + return ((addr >= start) && (addr < start + size)); >> +} > > this should be factored out into a generic helper in > include/linux/kernel.h. I tried that last year but didn't get far. See: http://marc.info/?t=121118719800004 http://marc.info/?t=121242388600010 I'd rather put this on a todo list and focus on the improvement of the core gcov patches first. >> + >> +/* Update list and generate events when modules are unloaded. */ >> +static int gcov_module_notifier(struct notifier_block *nb, unsigned long event, >> + void *data) >> +{ >> +#ifdef CONFIG_MODULES >> + struct module *mod = data; >> + struct gcov_info *info; >> + struct gcov_info *prev; >> + >> + if (event != MODULE_STATE_GOING) >> + return NOTIFY_OK; >> + mutex_lock(&gcov_lock); >> + prev = NULL; >> + /* Remove entries located in module from linked list. */ >> + for (info = gcov_info_head; info; info = info->next) { >> + if (within(info, mod->module_core, mod->core_size)) { >> + if (prev) >> + prev->next = info->next; >> + else >> + gcov_info_head = info->next; >> + if (gcov_events_enabled) >> + gcov_event(gcov_remove, info); >> + } else >> + prev = info; >> + } >> + mutex_unlock(&gcov_lock); >> +#endif /* CONFIG_MODULES */ >> + >> + return NOTIFY_OK; >> +} >> + >> +static struct notifier_block gcov_nb = { >> + .notifier_call = gcov_module_notifier, >> +}; >> + >> +static int __init gcov_init(void) >> +{ >> + return register_module_notifier(&gcov_nb); >> +} >> +device_initcall(gcov_init); > > this whole block could move under CONFIG_MODULES. Ok. >> Index: linux-2.6.30-rc4/kernel/gcov/fs.c >> =================================================================== >> --- /dev/null >> +++ linux-2.6.30-rc4/kernel/gcov/fs.c >> @@ -0,0 +1,634 @@ >> +/* >> + * This code exports profiling data as debugfs files to userspace. >> + * >> + * Copyright IBM Corp. 2009 >> + * Author(s): Peter Oberparleiter <oberpar@linux.vnet.ibm.com> >> + * >> + * Uses gcc-internal data definitions. >> + * Based on the gcov-kernel patch by: >> + * Hubertus Franke <frankeh@us.ibm.com> >> + * Nigel Hinds <nhinds@us.ibm.com> >> + * Rajan Ravindran <rajancr@us.ibm.com> >> + * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> >> + * Paul Larson >> + * Yi CDL Yang >> + */ >> + >> +#include <linux/init.h> >> +#include <linux/module.h> >> +#include <linux/debugfs.h> >> +#include <linux/fs.h> >> +#include <linux/list.h> >> +#include <linux/string.h> >> +#include <linux/slab.h> >> +#include <linux/mutex.h> >> +#include <linux/seq_file.h> >> +#include "gcov.h" >> + >> +/** >> + * struct gcov_node - represents a debugfs entry >> + * @list: list head for child node list >> + * @children: child nodes >> + * @all: list head for list of all nodes >> + * @parent: parent node >> + * @info: associated profiling data structure if not a directory >> + * @ghost: when an object file containing profiling data is unloaded we keep a >> + * copy of the profiling data here to allow collecting coverage data >> + * for cleanup code. Such a node is called a "ghost". >> + * @dentry: main debugfs entry, either a directory or data file >> + * @links: associated symbolic links >> + * @name: data file basename >> + * >> + * struct gcov_node represents an entity within the gcov/ subdirectory >> + * of debugfs. There are directory and data file nodes. The latter represent >> + * the actual synthesized data file plus any associated symbolic links which >> + * are needed by the gcov tool to work correctly. >> + */ >> +struct gcov_node { >> + struct list_head list; >> + struct list_head children; >> + struct list_head all; >> + struct gcov_node *parent; >> + struct gcov_info *info; >> + struct gcov_info *ghost; >> + struct dentry *dentry; >> + struct dentry **links; >> + char name[0]; >> +}; >> + >> +static const char objtree[] = OBJTREE; >> +static const char srctree[] = SRCTREE; >> +static struct gcov_node root_node; >> +static struct dentry *reset_dentry; >> +static LIST_HEAD(all_head); >> +static DEFINE_MUTEX(node_lock); >> + >> +/* If non-zero, keep copies of profiling data for unloaded modules. */ >> +static int gcov_persist = 1; >> + >> +static int __init gcov_persist_setup(char *str) >> +{ >> + int val; >> + char delim; >> + >> + if (sscanf(str, "%d %c", &val, &delim) != 1) { >> + printk(KERN_WARNING TAG "invalid gcov_persist parameter '%s'\n", >> + str); >> + return 0; >> + } >> + printk(KERN_INFO TAG "setting gcov_persist to %d\n", val); >> + gcov_persist = val; >> + >> + return 1; >> +} >> +__setup("gcov_persist=", gcov_persist_setup); >> + >> +/* seq_file.start() implementation for gcov data files. Note that the >> + * gcov_iterator interface is designed to be more restrictive than seq_file >> + * (no start from arbitrary position, etc.), to simplify the iterator >> + * implementation. */ >> +static void *gcov_seq_start(struct seq_file *seq, loff_t *pos) >> +{ >> + loff_t i; >> + >> + gcov_iter_start(seq->private); >> + for (i = 0; i < *pos; i++) >> + if (gcov_iter_next(seq->private)) > >> + return NULL; > > Please use curly braces for multi-line loop bodies. Ok. >> + >> + return seq->private; >> +} >> + >> +/* seq_file.next() implementation for gcov data files. */ >> +static void *gcov_seq_next(struct seq_file *seq, void *data, loff_t *pos) >> +{ >> + struct gcov_iterator *iter = data; >> + >> + if (gcov_iter_next(iter)) >> + return NULL; >> + (*pos)++; >> + >> + return iter; >> +} >> + >> +/* seq_file.show() implementation for gcov data files. */ >> +static int gcov_seq_show(struct seq_file *seq, void *data) >> +{ >> + struct gcov_iterator *iter = data; >> + >> + if (gcov_iter_write(iter, seq)) >> + return -EINVAL; >> + return 0; >> +} >> + >> +static void gcov_seq_stop(struct seq_file *seq, void *data) >> +{ >> + /* Unused. */ >> +} >> + >> +static const struct seq_operations gcov_seq_ops = { >> + .start = gcov_seq_start, >> + .next = gcov_seq_next, >> + .show = gcov_seq_show, >> + .stop = gcov_seq_stop, > > turning _stop into NULL and removing gcov_seq_stop() will have the > same effect as the code above, right? I don't think that would work. The seq_file implementation calls ops->stop() without checking for NULL. >> +}; >> + >> +/* Return the profiling data set for a given node. This can either be the >> + * original profiling data structure or a duplicate (also called "ghost") >> + * in case the associated object file has been unloaded. */ > > (continuing objection to comment style) Ok, I'll add respective comments. >> +static struct gcov_info *get_node_info(struct gcov_node *node) >> +{ >> + if (node->info) >> + return node->info; >> + >> + return node->ghost; >> +} >> + >> +/* open() implementation for gcov data files. Create a copy of the profiling >> + * data set and initialize the iterator and seq_file interface. */ >> +static int gcov_seq_open(struct inode *inode, struct file *file) >> +{ >> + struct gcov_node *node = inode->i_private; >> + struct gcov_iterator *iter; >> + struct seq_file *seq; >> + struct gcov_info *info; >> + int rc; >> + >> + mutex_lock(&node_lock); >> + /* Read from a profiling data copy to minimize reference tracking >> + * complexity and concurrent access. */ >> + info = gcov_info_dup(get_node_info(node)); >> + if (!info) { >> + rc = -ENOMEM; >> + goto out_unlock; >> + } > > The standard pattern is: > > rc = -ENOMEM; > > info = gcov_info_dup(get_node_info(node)); > if (!info) > goto out_unlock; > > One liner shorter, no curly braces, but look how the same rc code > will be used for the code below as well: > >> + iter = gcov_iter_new(info); >> + if (!iter) { >> + rc = -ENOMEM; >> + goto out_free; >> + } > > making it ~3 lines shorter and much easier on the eyes. Ok. >> + rc = seq_open(file, &gcov_seq_ops); >> + if (rc) >> + goto out_free2; >> + seq = file->private_data; >> + seq->private = iter; >> + goto out_unlock; >> + >> +out_free2: >> + gcov_iter_free(iter); >> +out_free: >> + gcov_info_free(info); >> +out_unlock: >> + mutex_unlock(&node_lock); >> + >> + return rc; > > No. The standard pattern to do this is: > > seq = file->private_data; > seq->private = iter; > out_unlock: > mutex_unlock(&node_lock); > return rc; > > out_free2: > gcov_iter_free(iter); > out_free: > gcov_info_free(info); > goto out_unlock; > > Note how the common path is fall-through now. (fall-through both to > the compiler and to the human eye.) > > Furthermore, istead of out_free2, please use a more descriptive > labels like: > > out_free_iter_info: > out_free_info: > > that contains the nesting nature. I usually try to stay away from gotos jumping backwards but will give this a try. >> +} >> + >> +/* release() implementation for gcov data files. Release resources allocated >> + * by open(). */ >> +static int gcov_seq_release(struct inode *inode, struct file *file) >> +{ >> + struct gcov_iterator *iter; >> + struct gcov_info *info; >> + struct seq_file *seq = file->private_data; >> + >> + iter = seq->private; >> + info = gcov_iter_get_info(iter); > > please either initialize all variables in the local variables > definition block, or (preferably) assign them later on (even if this > means one more line of code). Mixing the twomakes no sense. Ok. > >> + gcov_iter_free(iter); >> + gcov_info_free(info); > > this is a repeating pattern - shouldnt gcov_iter_free() auto-free > the (embedded) info structure as well? This would violate the layering that I tried to set up between fs.c and gcc_*.c: the handling of info structures is done generically in fs.c, while iterator structures need to be handled per gcc-version in gcc_*.c. For that reason, gcov_iter_free should not affect memory allocations of the "base layer" in fs.c. > >> + seq_release(inode, file); >> + >> + return 0; >> +} >> + >> +/* Find a node by the associated data file name. Needs to be called with >> + * node_lock held. */ >> +static struct gcov_node *get_node_by_name(const char *name) >> +{ >> + struct gcov_node *node; >> + struct gcov_info *info; >> + >> + list_for_each_entry(node, &all_head, all) { >> + info = get_node_info(node); >> + if (info && (strcmp(info->filename, name) == 0)) >> + return node; >> + } >> + >> + return NULL; >> +} >> + >> +static void remove_node(struct gcov_node *node); >> + >> +/* write() implementation for gcov data files. Reset profiling data for the >> + * associated file. If the object file has been unloaded (i.e. this is >> + * a "ghost" node), remove the debug fs node as well. */ >> +static ssize_t gcov_seq_write(struct file *file, const char __user *addr, >> + size_t len, loff_t *pos) >> +{ >> + struct seq_file *seq = file->private_data; >> + struct gcov_info *info = gcov_iter_get_info(seq->private); >> + struct gcov_node *node; >> + >> + mutex_lock(&node_lock); >> + node = get_node_by_name(info->filename); >> + if (node) { >> + /* Reset counts or remove node for unloaded modules. */ >> + if (node->ghost) >> + remove_node(node); >> + else >> + gcov_info_reset(node->info); >> + } >> + /* Reset counts for open file. */ >> + gcov_info_reset(info); >> + mutex_unlock(&node_lock); >> + >> + return len; >> +} >> + >> +/* Given a string <path> representing a file path of format: >> + * path/to/file.gcda >> + * construct and return a new string: >> + * <dir/>path/to/file.<ext> */ >> +static char *link_target(const char *dir, const char *path, const char *ext) >> +{ >> + char *target; >> + char *old_ext; >> + char *copy; >> + >> + copy = kstrdup(path, GFP_KERNEL); >> + if (!copy) >> + return NULL; >> + old_ext = strrchr(copy, '.'); >> + if (old_ext) >> + *old_ext = '\0'; >> + if (dir) >> + target = kasprintf(GFP_KERNEL, "%s/%s.%s", dir, copy, ext); >> + else >> + target = kasprintf(GFP_KERNEL, "%s.%s", copy, ext); >> + kfree(copy); >> + >> + return target; >> +} >> + >> +/* Construct a string representing the symbolic link target for the given >> + * gcov data file name and link type. Depending on the link type and the >> + * location of the data file, the link target can either point to a >> + * subdirectory of srctree, objtree or in an external location. */ >> +static char *get_link_target(const char *filename, const struct gcov_link *ext) >> +{ >> + const char *rel; >> + char *result; >> + >> + if (strncmp(filename, objtree, strlen(objtree)) == 0) { >> + rel = filename + strlen(objtree) + 1; >> + if (ext->dir == src_tree) >> + result = link_target(srctree, rel, ext->ext); >> + else >> + result = link_target(objtree, rel, ext->ext); >> + } else { >> + /* External compilation. */ >> + result = link_target(NULL, filename, ext->ext); >> + } >> + >> + return result; >> +} >> + >> +#define SKEW_PREFIX ".tmp_" >> + >> +/* For a filename .tmp_filename.ext return filename.ext. Needed to compensate >> + * for filename skewing caused by the mod-versioning mechanism. */ >> +static const char *deskew(const char *basename) >> +{ >> + if (strncmp(basename, SKEW_PREFIX, sizeof(SKEW_PREFIX) - 1) == 0) >> + return basename + sizeof(SKEW_PREFIX) - 1; >> + return basename; >> +} >> + >> +/* Create links to additional files (usually .c and .gcno files) which the >> + * gcov tool expects to find in the same directory as the gcov data file. */ >> +static void add_links(struct gcov_node *node, struct dentry *parent) >> +{ >> + char *basename; >> + char *target; >> + int num; >> + int i; >> + >> + for (num = 0; gcov_link[num].ext; num++) >> + /* Nothing. */; >> + node->links = kcalloc(num, sizeof(struct dentry *), GFP_KERNEL); >> + if (!node->links) >> + return; >> + for (i = 0; i < num; i++) { >> + target = get_link_target(get_node_info(node)->filename, >> + &gcov_link[i]); >> + if (!target) >> + goto out_err; >> + basename = strrchr(target, '/'); >> + if (!basename) >> + goto out_err; >> + basename++; >> + node->links[i] = debugfs_create_symlink(deskew(basename), >> + parent, target); >> + if (!node->links[i]) >> + goto out_err; >> + kfree(target); >> + } >> + >> + return; >> +out_err: >> + kfree(target); >> + while (i-- > 0) >> + debugfs_remove(node->links[i]); >> + kfree(node->links); >> + node->links = NULL; >> +} >> + >> +static const struct file_operations gcov_data_fops = { >> + .open = gcov_seq_open, >> + .release = gcov_seq_release, >> + .read = seq_read, >> + .llseek = seq_lseek, >> + .write = gcov_seq_write, >> +}; > > please write all such multi-line structure initializations as: > > .open = gcov_seq_open, > .release = gcov_seq_release, > .read = seq_read, > .llseek = seq_lseek, > .write = gcov_seq_write, > > When written in that form a detail immediately stands out: the > seq_read and seq_lseek initialization is superfluous, having NULL > there will cause the seqfile code to default to those methods. Agreed on the formatting. Looking at the seq_file code though, I don't think that leaving out seq_read and seq_lseek assignments would work. > >> + >> +/* Basic initialization of a new node. */ >> +static void init_node(struct gcov_node *node, struct gcov_info *info, >> + const char *name, struct gcov_node *parent) >> +{ >> + INIT_LIST_HEAD(&node->list); >> + INIT_LIST_HEAD(&node->children); >> + INIT_LIST_HEAD(&node->all); >> + node->info = info; >> + node->parent = parent; >> + if (name) >> + strcpy(node->name, name); >> +} >> + >> +/* Create a new node and associated debugfs entry. Needs to be called with >> + * node_lock held. */ >> +static struct gcov_node *new_node(struct gcov_node *parent, >> + struct gcov_info *info, const char *name) >> +{ >> + struct gcov_node *node; >> + >> + node = kzalloc(sizeof(struct gcov_node) + strlen(name) + 1, GFP_KERNEL); >> + if (!node) { >> + printk(KERN_WARNING TAG "out of memory\n"); >> + return NULL; >> + } >> + init_node(node, info, name, parent); >> + /* Differentiate between gcov data file nodes and directory nodes. */ >> + if (info) { >> + node->dentry = debugfs_create_file(deskew(node->name), 0600, >> + parent->dentry, node, &gcov_data_fops); >> + } else >> + node->dentry = debugfs_create_dir(node->name, parent->dentry); >> + if (!node->dentry) { >> + printk(KERN_WARNING TAG "could not create file\n"); >> + kfree(node); >> + return NULL; >> + } >> + if (info) >> + add_links(node, parent->dentry); >> + list_add(&node->list, &parent->children); >> + list_add(&node->all, &all_head); >> + >> + return node; >> +} >> + >> +/* Remove symbolic links associated with node. */ >> +static void remove_links(struct gcov_node *node) >> +{ >> + int i; >> + >> + if (!node->links) >> + return; >> + for (i = 0; gcov_link[i].ext; i++) >> + debugfs_remove(node->links[i]); >> + kfree(node->links); >> + node->links = NULL; >> +} >> + >> +/* Remove node from all lists and debugfs and release associated resources. >> + * Needs to be called with node_lock held. */ >> +static void release_node(struct gcov_node *node) >> +{ >> + list_del(&node->list); >> + list_del(&node->all); >> + debugfs_remove(node->dentry); >> + remove_links(node); >> + if (node->ghost) >> + gcov_info_free(node->ghost); >> + kfree(node); >> +} >> + >> +/* Release node and empty parents. Needs to be called with node_lock held. */ >> +static void remove_node(struct gcov_node *node) >> +{ >> + struct gcov_node *parent; >> + >> + while ((node != &root_node) && list_empty(&node->children)) { >> + parent = node->parent; >> + release_node(node); >> + node = parent; >> + } >> +} >> + >> +/* Find child node with given basename. Needs to be called with node_lock >> + * held. */ >> +static struct gcov_node *get_child_by_name(struct gcov_node *parent, >> + const char *name) >> +{ >> + struct gcov_node *node; >> + >> + list_for_each_entry(node, &parent->children, list) { >> + if (strcmp(node->name, name) == 0) >> + return node; >> + } >> + >> + return NULL; >> +} >> + >> +/* write() implementation for reset file. Reset all profiling data to zero >> + * and remove ghost nodes. */ >> +static ssize_t reset_write(struct file *file, const char __user *addr, >> + size_t len, loff_t *pos) >> +{ >> + struct gcov_node *node; >> + >> + mutex_lock(&node_lock); >> +restart: >> + list_for_each_entry(node, &all_head, all) { >> + if (node->info) >> + gcov_info_reset(node->info); >> + else if (list_empty(&node->children)) { >> + remove_node(node); >> + /* Several nodes may have gone - restart loop. */ >> + goto restart; >> + } >> + } >> + mutex_unlock(&node_lock); >> + >> + return len; >> +} >> + >> +/* read() implementation for reset file. Unused. */ >> +static ssize_t reset_read(struct file *file, char __user *addr, size_t len, >> + loff_t *pos) >> +{ >> + /* Allow read operation so that a recursive copy won't fail. */ >> + return 0; >> +} >> + >> +static const struct file_operations gcov_reset_fops = { >> + .write = reset_write, >> + .read = reset_read, >> +}; >> + >> +/* Create a node for a given profiling data set and add it to all lists and >> + * debugfs. Needs to be called with node_lock held. */ >> +static void add_node(struct gcov_info *info) >> +{ >> + char *filename; >> + char *curr; >> + char *next; >> + struct gcov_node *parent; >> + struct gcov_node *node; >> + >> + filename = kstrdup(info->filename, GFP_KERNEL); >> + if (!filename) >> + return; >> + parent = &root_node; >> + /* Create directory nodes along the path. */ >> + for (curr = filename; (next = strchr(curr, '/')); curr = next + 1) { >> + if (curr == next) >> + continue; >> + *next = 0; >> + if (strcmp(curr, ".") == 0) >> + continue; >> + if (strcmp(curr, "..") == 0) { >> + if (!parent->parent) >> + goto out_err; >> + parent = parent->parent; >> + continue; >> + } >> + node = get_child_by_name(parent, curr); >> + if (!node) { >> + node = new_node(parent, NULL, curr); >> + if (!node) >> + goto out_err; >> + } >> + parent = node; >> + } >> + /* Create file node. */ >> + node = new_node(parent, info, curr); >> + if (node) >> + goto out; >> +out_err: >> + remove_node(parent); >> +out: >> + kfree(filename); > > this too is an ugly teardown sequence mixing success and failure > paths. Please clean it up like suggested above. Ok. > >> +} >> + >> +/* The profiling data set associated with this node is being unloaded. Store a >> + * copy of the profiling data and turn this node into a "ghost". */ >> +static int ghost_node(struct gcov_node *node) >> +{ >> + node->ghost = gcov_info_dup(node->info); >> + if (!node->ghost) { >> + printk(KERN_WARNING TAG "could not save data for '%s' (out of " >> + "memory)\n", node->info->filename); >> + return -ENOMEM; >> + } >> + node->info = NULL; >> + >> + return 0; >> +} >> + >> +/* Profiling data for this node has been loaded again. Add profiling data >> + * from previous instantiation and turn this node into a regular node. */ >> +static void revive_node(struct gcov_node *node, struct gcov_info *info) >> +{ >> + if (gcov_info_is_compatible(node->ghost, info)) >> + gcov_info_add(info, node->ghost); >> + else { >> + printk(KERN_WARNING TAG "discarding saved data for '%s' " >> + "(version changed)\n", info->filename); >> + } >> + gcov_info_free(node->ghost); >> + node->ghost = NULL; >> + node->info = info; >> +} >> + >> +/* Callback to create/remove profiling files when code compiled with >> + * -fprofile-arcs is loaded/unloaded. */ >> +void gcov_event(enum gcov_action action, struct gcov_info *info) >> +{ >> + struct gcov_node *node; >> + >> + mutex_lock(&node_lock); >> + node = get_node_by_name(info->filename); >> + switch (action) { >> + case gcov_add: >> + /* Add new node or revive ghost. */ >> + if (!node) { >> + add_node(info); >> + break; >> + } >> + if (gcov_persist) >> + revive_node(node, info); >> + else >> + printk(KERN_WARNING TAG "could not add '%s' " >> + "(already exists)\n", info->filename); > > Please use pr_warning, pr_info, etc. for all such KERN_* printks in > the whole patch. Ok. > >> + break; >> + case gcov_remove: >> + /* Remove node or turn into ghost. */ >> + if (!node) { >> + printk(KERN_WARNING TAG "could not remove '%s' (not " >> + "found)\n", info->filename); >> + break; >> + } >> + if (gcov_persist) { >> + if (!ghost_node(node)) >> + break; > >> + } >> + remove_node(node); >> + break; >> + } >> + mutex_unlock(&node_lock); >> +} >> + >> +/* Create debugfs entries. */ >> +static __init int gcov_fs_init(void) >> +{ >> + int rc; >> + >> + init_node(&root_node, NULL, NULL, NULL); >> + /* /sys/kernel/debug/gcov will be parent for the reset control file >> + * and all profiling files. */ >> + root_node.dentry = debugfs_create_dir("gcov", NULL); >> + if (!root_node.dentry) { >> + printk(KERN_ERR TAG "could not create root dir\n"); >> + rc = -EIO; >> + goto out_remove; >> + } >> + /* Create reset file which resets all profiling counts when written >> + * to. */ >> + reset_dentry = debugfs_create_file("reset", 0600, root_node.dentry, >> + NULL, &gcov_reset_fops); >> + if (!reset_dentry) { >> + printk(KERN_ERR TAG "could not create reset file\n"); >> + rc = -EIO; >> + goto out_remove; >> + } > > rc setting could move to the local variable definition line. This > would save two lines of code. Ok. > >> + /* Replay previous events to get our fs hierarchy up-to-date. */ >> + gcov_enable_events(); >> + >> + return 0; >> +out_remove: >> + if (root_node.dentry) >> + debugfs_remove(root_node.dentry); > > the printks could move to this place, cleaning up the normal code > flow. This will make the error message less specific about the actual cause of the problem, but I guess I can live with that. > >> + >> + return rc; >> +} >> +device_initcall(gcov_fs_init); >> Index: linux-2.6.30-rc4/kernel/gcov/gcc_3_4.c >> =================================================================== >> --- /dev/null >> +++ linux-2.6.30-rc4/kernel/gcov/gcc_3_4.c >> @@ -0,0 +1,419 @@ >> +/* >> + * This code provides functions to handle gcc's profiling data format >> + * introduced with gcc 3.4. Future versions of gcc may change the gcov >> + * format (as happened before), so all format-specific information needs >> + * to be kept modular and easily exchangeable. >> + * >> + * This file is based on gcc-internal definitions. Functions and data >> + * structures are defined to be compatible with gcc counterparts. >> + * For a better understanding, refer to gcc source: gcc/gcov-io.h. >> + * >> + * Copyright IBM Corp. 2009 >> + * Author(s): Peter Oberparleiter <oberpar@linux.vnet.ibm.com> >> + * >> + * Uses gcc-internal data definitions. >> + */ >> + >> +#include <linux/errno.h> >> +#include <linux/slab.h> >> +#include <linux/string.h> >> +#include <linux/seq_file.h> >> +#include "gcov.h" >> + >> +/* Symbolic links to be created for each profiling data file. */ >> +const struct gcov_link gcov_link[] = { >> + { obj_tree, "gcno" }, /* Link to .gcno file in $(objtree). */ >> + { 0, NULL}, >> +}; >> + >> +/* Determine whether a counter is active. Based on gcc magic. Doesn't change >> + * at run-time. */ >> +static int counter_active(struct gcov_info *info, unsigned int type) >> +{ >> + return (1 << type) & info->ctr_mask; >> +} >> + >> +/* Determine number of active counters. Based on gcc magic. */ >> +static unsigned int num_counter_active(struct gcov_info *info) >> +{ >> + unsigned int i; >> + unsigned int result = 0; >> + >> + for (i = 0; i < GCOV_COUNTERS; i++) >> + if (counter_active(info, i)) >> + result++; >> + return result; >> +} >> + >> +/** >> + * gcov_info_reset - reset profiling data to zero >> + * @info: profiling data set >> + */ >> +void gcov_info_reset(struct gcov_info *info) >> +{ >> + unsigned int active = num_counter_active(info); >> + unsigned int i; >> + >> + for (i = 0; i < active; i++) >> + memset(info->counts[i].values, 0, >> + info->counts[i].num * sizeof(gcov_type)); >> +} >> + >> +/** >> + * gcov_info_is_compatible - check if profiling data can be added >> + * @info1: first profiling data set >> + * @info2: second profiling data set >> + * >> + * Returns non-zero if profiling data can be added, zero otherwise. >> + */ >> +int gcov_info_is_compatible(struct gcov_info *info1, struct gcov_info *info2) >> +{ >> + return (info1->stamp == info2->stamp); >> +} >> + >> +/** >> + * gcov_info_add - add up profiling data >> + * @dest: profiling data set to which data is added >> + * @source: profiling data set which is added >> + * >> + * Adds profiling counts of @source to @dest. >> + */ >> +void gcov_info_add(struct gcov_info *dest, struct gcov_info *source) >> +{ >> + unsigned int i; >> + unsigned int j; >> + >> + for (i = 0; i < num_counter_active(dest); i++) >> + for (j = 0; j < dest->counts[i].num; j++) >> + dest->counts[i].values[j] += >> + source->counts[i].values[j]; >> +} >> + >> +/* Get size of function info entry. Based on gcc magic. */ >> +static size_t get_fn_size(struct gcov_info *info) >> +{ >> + size_t size; >> + >> + size = sizeof(struct gcov_fn_info) + num_counter_active(info) * >> + sizeof(unsigned int); >> + if (__alignof__(struct gcov_fn_info) > sizeof(unsigned int)) >> + size = ALIGN(size, __alignof__(struct gcov_fn_info)); >> + return size; >> +} >> + >> +/* Get address of function info entry. Based on gcc magic. */ >> +static struct gcov_fn_info *get_fn_info(struct gcov_info *info, unsigned int fn) >> +{ >> + return (struct gcov_fn_info *) >> + ((char *) info->functions + fn * get_fn_size(info)); >> +} >> + >> +/** >> + * gcov_info_dup - duplicate profiling data set >> + * @info: profiling data set to duplicate >> + * >> + * Return newly allocated duplicate on success, %NULL on error. >> + */ >> +struct gcov_info *gcov_info_dup(struct gcov_info *info) >> +{ >> + struct gcov_info *dup; >> + unsigned int i; >> + unsigned int active = num_counter_active(info); >> + >> + /* Duplicate gcov_info. */ >> + dup = kzalloc(sizeof(struct gcov_info) + >> + sizeof(struct gcov_ctr_info) * active, GFP_KERNEL); >> + if (!dup) >> + return NULL; >> + dup->version = info->version; >> + dup->stamp = info->stamp; >> + dup->n_functions = info->n_functions; >> + dup->ctr_mask = info->ctr_mask; >> + /* Duplicate filename. */ >> + dup->filename = kstrdup(info->filename, GFP_KERNEL); > > Please write such 6-line initializations as: > > dup->version = info->version; > dup->stamp = info->stamp; > dup->n_functions = info->n_functions; > dup->ctr_mask = info->ctr_mask; > /* Duplicate filename. */ > dup->filename = kstrdup(info->filename, GFP_KERNEL); > > Makes it far easier to check at a glance that it's 1) correct 2) > where the complexity lies. Ok. > >> + if (!dup->filename) >> + goto out_free; >> + /* Duplicate table of functions. */ >> + dup->functions = kmemdup(info->functions, info->n_functions * >> + get_fn_size(info), GFP_KERNEL); >> + if (!dup->functions) >> + goto out_free; >> + /* Duplicate counter arrays. */ >> + for (i = 0; i < active ; i++) { >> + dup->counts[i].num = info->counts[i].num; >> + dup->counts[i].merge = info->counts[i].merge; >> + dup->counts[i].values = kmemdup(info->counts[i].values, >> + sizeof(gcov_type) * info->counts[i].num, >> + GFP_KERNEL); > > Please get rid of these ugly linebreaks by introducing a local > 'struct gcov_ctr_info *count = dup->counts + i' and 'size' > variables. You'll get a nice: > > gcov_ctr_info *count = dup->counts + i; > size_t size = count->num * sizeof(gcov_type); > > count->num = info->counts[i].num; > count->merge = info->counts[i].merge; > count->values = kmemdup(count->values, size, GFP_KERNEL); > > if (!count->values) > goto out_free; Looks good (minus the pointer arithmetics - I prefer count = &dup->counts[i]). > >> + } >> + return dup; >> + >> +out_free: >> + gcov_info_free(dup); > > The convention for error case labels is "err_free". 'out' labels are > generally used for normal outgoing paths. Here, when the entry's > size is doubled, an allocation failure is an error. Ok. > >> + >> + return NULL; >> +} >> + >> +/** >> + * gcov_info_free - release memory for profiling data set duplicate >> + * @info: profiling data set duplicate to free >> + */ >> +void gcov_info_free(struct gcov_info *info) >> +{ >> + unsigned int active = num_counter_active(info); >> + unsigned int i; >> + >> + for (i = 0; i < active ; i++) >> + kfree(info->counts[i].values); >> + kfree(info->functions); >> + kfree(info->filename); >> + kfree(info); >> +} >> + >> +/** >> + * struct type_info - iterator helper array >> + * @ctr_type: counter type >> + * @offset: index of the first value of the current function for this type >> + * >> + * This array is needed to convert the in-memory data format into the in-file >> + * data format: >> + * >> + * In-memory: >> + * for each counter type >> + * for each function >> + * values >> + * >> + * In-file: >> + * for each function >> + * for each counter type >> + * values >> + * >> + * See gcc source gcc/gcov-io.h for more information on data organization. >> + */ >> +struct type_info { >> + int ctr_type; >> + unsigned int offset; >> +}; >> + >> +/** >> + * struct gcov_iterator - specifies current file position in logical records >> + * @info: associated profiling data >> + * @record: record type >> + * @function: function number >> + * @type: counter type >> + * @count: index into values array >> + * @num_types: number of counter types >> + * @type_info: helper array to get values-array offset for current function >> + */ >> +struct gcov_iterator { >> + struct gcov_info *info; >> + >> + int record; >> + unsigned int function; >> + unsigned int type; >> + unsigned int count; >> + >> + int num_types; >> + struct type_info type_info[0]; >> +}; >> + >> +static struct gcov_fn_info *get_func(struct gcov_iterator *iter) >> +{ >> + return get_fn_info(iter->info, iter->function); >> +} >> + >> +static struct type_info *get_type(struct gcov_iterator *iter) >> +{ >> + return &iter->type_info[iter->type]; >> +} >> + >> +/** >> + * gcov_iter_new - allocate and initialize profiling data iterator >> + * @info: profiling data set to be iterated >> + * >> + * Return file iterator on success, %NULL otherwise. >> + */ >> +struct gcov_iterator *gcov_iter_new(struct gcov_info *info) >> +{ >> + struct gcov_iterator *iter; >> + >> + iter = kzalloc(sizeof(struct gcov_iterator) + >> + num_counter_active(info) * sizeof(struct type_info), >> + GFP_KERNEL); >> + if (iter) >> + iter->info = info; >> + >> + return iter; >> +} >> + >> +/** >> + * gcov_iter_free - release memory for iterator >> + * @iter: file iterator to free >> + */ >> +void gcov_iter_free(struct gcov_iterator *iter) >> +{ >> + kfree(iter); >> +} >> + >> +/** >> + * gcov_iter_get_info - return profiling data set for given file iterator >> + * @iter: file iterator >> + */ >> +struct gcov_info *gcov_iter_get_info(struct gcov_iterator *iter) >> +{ >> + return iter->info; >> +} > > Such wrappers are completely pointless. Here it obfuscates the usage > sites and makes them _larger_. Before it was: > > iter->info > > Now it is: > > gcov_iter_get_info(iter) > > Which is not very helpful ... This is due to the layering issue detailed above: fs.c doesn't know about where in struct gcov_iterator the info structure is stored. > >> + >> +/** >> + * gcov_iter_start - reset file iterator to starting position >> + * @iter: file iterator >> + */ >> +void gcov_iter_start(struct gcov_iterator *iter) >> +{ >> + int i; >> + >> + iter->record = 0; >> + iter->function = 0; >> + iter->type = 0; >> + iter->count = 0; >> + iter->num_types = 0; >> + for (i = 0; i < GCOV_COUNTERS; i++) { >> + if (counter_active(iter->info, i)) { >> + iter->type_info[iter->num_types].ctr_type = i; >> + iter->type_info[iter->num_types++].offset = 0; >> + } >> + } >> +} >> + >> +/** >> + * gcov_iter_next - advance file iterator to next logical record >> + * @iter: file iterator >> + * >> + * Return zero if new position is valid, non-zero if iterator has reached end. >> + */ >> +int gcov_iter_next(struct gcov_iterator *iter) >> +{ >> + switch (iter->record) { >> + case 0: >> + case 1: >> + case 3: >> + case 4: >> + case 5: >> + case 7: >> + /* Advance to next record */ >> + iter->record++; >> + break; >> + case 9: >> + /* Advance to next count */ >> + iter->count++; >> + /* fall through */ >> + case 8: >> + if (iter->count < get_func(iter)->n_ctrs[iter->type]) { >> + iter->record = 9; >> + break; >> + } >> + /* Advance to next counter type */ >> + get_type(iter)->offset += iter->count; >> + iter->count = 0; >> + iter->type++; >> + /* fall through */ >> + case 6: >> + if (iter->type < iter->num_types) { >> + iter->record = 7; >> + break; >> + } >> + /* Advance to next function */ >> + iter->type = 0; >> + iter->function++; >> + /* fall through */ >> + case 2: >> + if (iter->function < iter->info->n_functions) >> + iter->record = 3; >> + else >> + iter->record = -1; >> + break; > > what are all these magic numbers? Is there a symbolic form of them? These are record numbers. I can try to give them symbolic names though if that helps in understanding. > >> + } >> + /* Check for EOF. */ >> + if (iter->record == -1) >> + return -EINVAL; >> + else >> + return 0; >> +} >> + >> +/** >> + * seq_write_gcov_int - write number in gcov format to seq_file >> + * @seq: seq_file handle >> + * @size: size of number in bytes (either 4 or 8) >> + * @v: value to be stored >> + * >> + * Number format defined by gcc: numbers are recorded in the 32 bit >> + * unsigned binary form of the endianness of the machine generating the >> + * file. 64 bit numbers are stored as two 32 bit numbers, the low part >> + * first. >> + */ >> +static int seq_write_gcov_int(struct seq_file *seq, size_t size, u64 v) >> +{ >> + u32 data[2]; >> + >> + switch (size) { >> + case 8: >> + data[1] = (v >> 32); >> + /* fall through */ >> + case 4: >> + data[0] = (v & 0xffffffffUL); >> + return seq_write(seq, data, size); >> + } >> + return -EINVAL; >> +} >> + >> +/** >> + * gcov_iter_write - write data for current pos to seq_file >> + * @iter: file iterator >> + * @seq: seq_file handle >> + * >> + * Return zero on success, non-zero otherwise. >> + */ >> +int gcov_iter_write(struct gcov_iterator *iter, struct seq_file *seq) >> +{ >> + int rc = -EINVAL; >> + >> + switch (iter->record) { >> + case 0: /* file magic */ >> + rc = seq_write_gcov_int(seq, 4, GCOV_DATA_MAGIC); >> + break; >> + case 1: /* gcov_version */ >> + rc = seq_write_gcov_int(seq, 4, iter->info->version); > > please use sizeof, or push the 'input type is int' assumption into > seq_write_gcov_int(). The latter is more intelligent i guess, but > for 8-byte writes: Ok. > >> + break; >> + case 2: /* time stamp */ >> + rc = seq_write_gcov_int(seq, 4, iter->info->stamp); >> + break; >> + case 3: /* function tag */ >> + rc = seq_write_gcov_int(seq, 4, GCOV_TAG_FUNCTION); >> + break; >> + case 4: /* function tag length */ >> + rc = seq_write_gcov_int(seq, 4, 2); >> + break; >> + case 5: /* function ident*/ >> + rc = seq_write_gcov_int(seq, 4, get_func(iter)->ident); >> + break; >> + case 6: /* function checksum */ >> + rc = seq_write_gcov_int(seq, 4, get_func(iter)->checksum); >> + break; >> + case 7: /* count tag */ >> + rc = seq_write_gcov_int(seq, 4, >> + GCOV_TAG_FOR_COUNTER(get_type(iter)->ctr_type)); >> + break; >> + case 8: /* count length */ >> + rc = seq_write_gcov_int(seq, 4, >> + get_func(iter)->n_ctrs[iter->type] * 2); >> + break; >> + case 9: /* count */ >> + rc = seq_write_gcov_int(seq, 8, >> + iter->info->counts[iter->type]. >> + values[iter->count + get_type(iter)->offset]); > > ... introduce a seq_write_gcov_long variant for this. Ok, though it will be named more like: seq_write_gcov_counter > >> + break; >> + } >> + return rc; >> +} >> Index: linux-2.6.30-rc4/kernel/gcov/gcov.h >> =================================================================== >> --- /dev/null >> +++ linux-2.6.30-rc4/kernel/gcov/gcov.h >> @@ -0,0 +1,128 @@ >> +/* >> + * Profiling infrastructure declarations. >> + * >> + * This file is based on gcc-internal definitions. Data structures are >> + * defined to be compatible with gcc counterparts. For a better >> + * understanding, refer to gcc source: gcc/gcov-io.h. >> + * >> + * Copyright IBM Corp. 2009 >> + * Author(s): Peter Oberparleiter <oberpar@linux.vnet.ibm.com> >> + * >> + * Uses gcc-internal data definitions. >> + */ >> + >> +#ifndef GCOV_H >> +#define GCOV_H GCOV_H >> + >> +#include <linux/types.h> >> + >> +#define TAG "gcov: " >> + >> +/* Profiling data types used for gcc 3.4 and above - these are defined by >> + * gcc and need to be kept as close to the original definition as possible to >> + * remain compatible. */ >> +#define GCOV_COUNTERS 5 >> +#define GCOV_DATA_MAGIC ((unsigned int) 0x67636461) > > The 0x67636461U literal is the same. > >> +#define GCOV_TAG_FUNCTION ((unsigned int) 0x01000000) > > ditto. > >> +#define GCOV_TAG_COUNTER_BASE ((unsigned int) 0x01a10000) > > ditto. > >> +#define GCOV_TAG_FOR_COUNTER(count) \ >> + (GCOV_TAG_COUNTER_BASE + ((unsigned int) (count) << 17)) > > generates code: should be an inline function. > >> + >> +#if BITS_PER_LONG >= 64 >> +typedef long gcov_type; >> +#else >> +typedef long long gcov_type; >> +#endif > > please use u64 instead of gcov_type. This is ABI so it wont change. How crucial are these proposed changes? In my opinion this particular part of code should stay as close to the original gcc code as possible to make it easier to relate between the two code bases. > >> + >> +/** >> + * struct gcov_fn_info - profiling meta data per function >> + * @ident: object file-unique function identifier >> + * @checksum: function checksum >> + * @n_ctrs: number of values per counter type belonging to this function >> + * >> + * This data is generated by gcc during compilation and doesn't change >> + * at run-time. >> + */ >> +struct gcov_fn_info { >> + unsigned int ident; >> + unsigned int checksum; >> + unsigned int n_ctrs[0]; >> +}; >> + >> +/** >> + * struct gcov_ctr_info - profiling data per counter type >> + * @num: number of counter values for this type >> + * @values: array of counter values for this type >> + * @merge: merge function for counter values of this type (unused) >> + * >> + * This data is generated by gcc during compilation and doesn't change >> + * at run-time with the exception of the values array. >> + */ >> +struct gcov_ctr_info { >> + unsigned int num; >> + gcov_type *values; >> + void (*merge)(gcov_type *, unsigned int); >> +}; >> + >> +/** >> + * struct gcov_info - profiling data per object file >> + * @version: gcov version magic indicating the gcc version used for compilation >> + * @next: list head for a singly-linked list >> + * @stamp: time stamp >> + * @filename: name of the associated gcov data file >> + * @n_functions: number of instrumented functions >> + * @functions: function data >> + * @ctr_mask: mask specifying which counter types are active >> + * @counts: counter data per counter type >> + * >> + * This data is generated by gcc during compilation and doesn't change >> + * at run-time with the exception of the next pointer. >> + */ >> +struct gcov_info { >> + unsigned int version; >> + struct gcov_info *next; >> + unsigned int stamp; >> + const char *filename; >> + unsigned int n_functions; >> + const struct gcov_fn_info *functions; >> + unsigned int ctr_mask; >> + struct gcov_ctr_info counts[0]; > > > please write such structure definitions as: > > struct gcov_info { > unsigned int version; > struct gcov_info *next; > unsigned int stamp; > const char *filename; > unsigned int n_functions; > const struct gcov_fn_info *functions; > unsigned int ctr_mask; > struct gcov_ctr_info counts[0]; > > for better readability Ok. > > That form immediately shows a packing inefficiency - the following > ordering of the fields: > > unsigned int version; > unsigned int stamp; > unsigned int n_functions; > unsigned int ctr_mask; > struct gcov_info *next; > const char *filename; > const struct gcov_fn_info *functions; > struct gcov_ctr_info counts[0]; > > ... will save 8 bytes off the structure size on 64-bit platforms. The layout of this data structure is defined by gcc so it can't be changed in this place. > >> +}; >> + >> +/* Base interface. */ >> +enum gcov_action { >> + gcov_add, >> + gcov_remove, >> +}; > > please use capital letters for constants. The 'gcov _add' here: > > gcov_event(gcov_add, info); > > Can be easily mistaken for a function pointer or a local variable. Ok. > >> + >> +void gcov_event(enum gcov_action action, struct gcov_info *info); >> +void gcov_enable_events(void); >> + >> +/* Iterator control. */ >> +struct seq_file; >> +struct gcov_iterator; >> + >> +struct gcov_iterator *gcov_iter_new(struct gcov_info *info); >> +void gcov_iter_free(struct gcov_iterator *iter); >> +void gcov_iter_start(struct gcov_iterator *iter); >> +int gcov_iter_next(struct gcov_iterator *iter); >> +int gcov_iter_write(struct gcov_iterator *iter, struct seq_file *seq); >> +struct gcov_info *gcov_iter_get_info(struct gcov_iterator *iter); >> + >> +/* gcov_info control. */ >> +void gcov_info_reset(struct gcov_info *info); >> +int gcov_info_is_compatible(struct gcov_info *info1, struct gcov_info *info2); >> +void gcov_info_add(struct gcov_info *dest, struct gcov_info *source); >> +struct gcov_info *gcov_info_dup(struct gcov_info *info); >> +void gcov_info_free(struct gcov_info *info); >> + >> +struct gcov_link { >> + enum { >> + obj_tree, >> + src_tree, > > ditto. Ok. > >> + } dir; >> + const char *ext; >> +}; >> +extern const struct gcov_link gcov_link[]; >> + >> +#endif /* GCOV_H */ >> Index: linux-2.6.30-rc4/scripts/Makefile.lib >> =================================================================== >> --- linux-2.6.30-rc4.orig/scripts/Makefile.lib >> +++ linux-2.6.30-rc4/scripts/Makefile.lib >> @@ -116,6 +116,15 @@ _a_flags = $(KBUILD_CPPFLAGS) $(KB >> $(asflags-y) $(AFLAGS_$(basetarget).o) >> _cpp_flags = $(KBUILD_CPPFLAGS) $(cppflags-y) $(CPPFLAGS_$(@F)) >> >> +# Enable gcov profiling flags for a file, directory or for all files depending >> +# on variables GCOV_PROFILE_obj.o, GCOV_PROFILE and CONFIG_GCOV_PROFILE_ALL >> +# (in this order) >> +ifeq ($(CONFIG_GCOV_KERNEL),y) > > Please try to use winged comments in makefiles too. What do you mean by winged comments? > >> +_c_flags += $(if $(patsubst n%,, \ >> + $(GCOV_PROFILE_$(basetarget).o)$(GCOV_PROFILE)$(CONFIG_GCOV_PROFILE_ALL)), \ >> + $(CFLAGS_GCOV)) >> +endif >> + >> # If building the kernel in a separate objtree expand all occurrences >> # of -Idir to -I$(srctree)/dir except for absolute paths (starting with '/'). > > Furthermore: > >> +config GCOV_PROFILE_ALL >> + bool "Profile entire Kernel" >> + depends on GCOV_KERNEL >> + depends on S390 || X86_32 > > 64-bit x86 support is a must-have before we can think about > upstreaming any of this. See next patch. > also: > >> +config GCOV_PROFILE_ALL >> + bool "Profile entire Kernel" >> + depends on GCOV_KERNEL >> + depends on S390 || X86_32 >> + default n >> + ---help--- >> + This options activates profiling for the entire kernel. >> + >> + If unsure, say N. >> + >> + Note that a kernel compiled with profiling flags will be significantly >> + larger and run slower. Also be sure to exclude files from profiling >> + which are not linked to the kernel image to prevent linker errors. > > ... the gcov code should consider using runtime code patching > techniques like ftrace does - if possible - to bring this overhead > down. Runtime code patching sounds like a possible (though potentially rather complex) optimization. Before venturing into that area though, I would prefer to establish a stable and generally accepted (read integrated) base. > > So ... there's still a lot of work to be done with this code, and > this review only sratched the surface. Comments that improve patch quality are always welcome. I'll integrate your suggestions and resend the set soon. > Please Cc: me to future > submissions of this patch-set. Will do. Thanks, Peter ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 3/4] gcov: add gcov profiling infrastructure 2009-05-08 11:10 ` Peter Oberparleiter @ 2009-05-11 13:17 ` Ingo Molnar 2009-05-12 13:09 ` Peter Oberparleiter 0 siblings, 1 reply; 23+ messages in thread From: Ingo Molnar @ 2009-05-11 13:17 UTC (permalink / raw) To: Peter Oberparleiter Cc: linux-kernel, Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> wrote: >>> +/* __gcov_init is called by gcc-generated constructor code for each object >>> + * file compiled with -fprofile-arcs. */ >> >> Please use standard multi-line comments like specified in >> Documentation/CodingStyle. This observation holds for basically all >> the comment blocks in this file - dozens of them. > > None of the __gcov functions are ever called by the kernel > directly - only by gcc generated code. I can add comments for > __gcov_init as that one is actually implemented. The other > functions are required to prevent linking errors but are never > actually called in kernel context, therefore in my opinion it > wouldn't make much sense to provide full-blown comments for them. It isnt about the amount of comments, it is about the plain (and simple to rectify) fact that the above two-lines comment is inconsistent with other kernel code. >>> $(asflags-y) $(AFLAGS_$(basetarget).o) >>> _cpp_flags = $(KBUILD_CPPFLAGS) $(cppflags-y) $(CPPFLAGS_$(@F)) >>> +# Enable gcov profiling flags for a file, directory or for all >>> files depending >>> +# on variables GCOV_PROFILE_obj.o, GCOV_PROFILE and CONFIG_GCOV_PROFILE_ALL >>> +# (in this order) >>> +ifeq ($(CONFIG_GCOV_KERNEL),y) >> >> Please try to use winged comments in makefiles too. > > What do you mean by winged comments? This: /* * Comment ..... * ...... goes here: */ Is called a winged comment. Its makefile equivalent is: # # Comment ......... # ....... goes here # Ingo ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 3/4] gcov: add gcov profiling infrastructure 2009-05-11 13:17 ` Ingo Molnar @ 2009-05-12 13:09 ` Peter Oberparleiter 2009-05-12 13:35 ` Ingo Molnar 0 siblings, 1 reply; 23+ messages in thread From: Peter Oberparleiter @ 2009-05-12 13:09 UTC (permalink / raw) To: Ingo Molnar Cc: linux-kernel, Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman Ingo Molnar wrote: > * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> wrote: > >>>> +/* __gcov_init is called by gcc-generated constructor code for each object >>>> + * file compiled with -fprofile-arcs. */ [...] > It isnt about the amount of comments, it is about the plain (and > simple to rectify) fact that the above two-lines comment is > inconsistent with other kernel code. Ok, I misunderstood when I replied. The updated patch set should contain the correct changes though. >>>> $(asflags-y) $(AFLAGS_$(basetarget).o) >>>> _cpp_flags = $(KBUILD_CPPFLAGS) $(cppflags-y) $(CPPFLAGS_$(@F)) >>>> +# Enable gcov profiling flags for a file, directory or for all >>>> files depending >>>> +# on variables GCOV_PROFILE_obj.o, GCOV_PROFILE and CONFIG_GCOV_PROFILE_ALL >>>> +# (in this order) >>>> +ifeq ($(CONFIG_GCOV_KERNEL),y) >>> Please try to use winged comments in makefiles too. >> What do you mean by winged comments? > > This: > > /* > * Comment ..... > * ...... goes here: > */ > > Is called a winged comment. Its makefile equivalent is: Ok. Though google disagrees on that definition (see http://www.catb.org/~esr/jargon/html/W/winged-comments.html). ^ permalink raw reply [flat|nested] 23+ messages in thread
* Re: [PATCH 3/4] gcov: add gcov profiling infrastructure 2009-05-12 13:09 ` Peter Oberparleiter @ 2009-05-12 13:35 ` Ingo Molnar 0 siblings, 0 replies; 23+ messages in thread From: Ingo Molnar @ 2009-05-12 13:35 UTC (permalink / raw) To: Peter Oberparleiter Cc: linux-kernel, Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> wrote: > Ingo Molnar wrote: >> * Peter Oberparleiter <oberpar@linux.vnet.ibm.com> wrote: >> >>>>> +/* __gcov_init is called by gcc-generated constructor code for each object >>>>> + * file compiled with -fprofile-arcs. */ > [...] >> It isnt about the amount of comments, it is about the plain (and >> simple to rectify) fact that the above two-lines comment is >> inconsistent with other kernel code. > > Ok, I misunderstood when I replied. The updated patch set should contain > the correct changes though. > >>>>> $(asflags-y) $(AFLAGS_$(basetarget).o) >>>>> _cpp_flags = $(KBUILD_CPPFLAGS) $(cppflags-y) $(CPPFLAGS_$(@F)) >>>>> +# Enable gcov profiling flags for a file, directory or for all >>>>> files depending >>>>> +# on variables GCOV_PROFILE_obj.o, GCOV_PROFILE and CONFIG_GCOV_PROFILE_ALL >>>>> +# (in this order) >>>>> +ifeq ($(CONFIG_GCOV_KERNEL),y) >>>> Please try to use winged comments in makefiles too. >>> What do you mean by winged comments? >> >> This: >> >> /* >> * Comment ..... >> * ...... goes here: >> */ >> >> Is called a winged comment. Its makefile equivalent is: > > Ok. Though google disagrees on that definition (see > http://www.catb.org/~esr/jargon/html/W/winged-comments.html). yeah, i guess you are right, the correct term would be something like 'multi-line winged comments'. Ingo ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 4/4] gcov: enable GCOV_PROFILE_ALL for x86_64 2009-05-07 12:45 [PATCH 0/4] gcov kernel support Peter Oberparleiter ` (2 preceding siblings ...) 2009-05-07 12:45 ` [PATCH 3/4] gcov: add gcov profiling infrastructure Peter Oberparleiter @ 2009-05-07 12:46 ` Peter Oberparleiter 3 siblings, 0 replies; 23+ messages in thread From: Peter Oberparleiter @ 2009-05-07 12:46 UTC (permalink / raw) To: linux-kernel Cc: Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman [-- Attachment #1: gcov-profile-all-x86_64.patch --] [-- Type: text/plain, Size: 3773 bytes --] From: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> Enable gcov profiling of the entire kernel on x86_64. Required changes include disabling profiling for: * arch/kernel/acpi/realmode and arch/kernel/boot/compressed: not linked to main kernel * arch/vdso, arch/kernel/vsyscall_64 and arch/kernel/hpet: profiling causes segfaults during boot (incompatible context) Signed-off-by: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> --- arch/x86/boot/Makefile | 1 + arch/x86/boot/compressed/Makefile | 1 + arch/x86/kernel/Makefile | 2 ++ arch/x86/kernel/acpi/realmode/Makefile | 1 + arch/x86/vdso/Makefile | 1 + kernel/gcov/Kconfig | 2 +- 6 files changed, 7 insertions(+), 1 deletion(-) Index: linux-2.6.30-rc4/kernel/gcov/Kconfig =================================================================== --- linux-2.6.30-rc4.orig/kernel/gcov/Kconfig +++ linux-2.6.30-rc4/kernel/gcov/Kconfig @@ -34,7 +34,7 @@ config GCOV_KERNEL config GCOV_PROFILE_ALL bool "Profile entire Kernel" depends on GCOV_KERNEL - depends on S390 || X86_32 + depends on S390 || X86 default n ---help--- This options activates profiling for the entire kernel. Index: linux-2.6.30-rc4/arch/x86/kernel/acpi/realmode/Makefile =================================================================== --- linux-2.6.30-rc4.orig/arch/x86/kernel/acpi/realmode/Makefile +++ linux-2.6.30-rc4/arch/x86/kernel/acpi/realmode/Makefile @@ -42,6 +42,7 @@ KBUILD_CFLAGS := $(LINUXINCLUDE) -g -Os $(call cc-option, -mpreferred-stack-boundary=2) KBUILD_CFLAGS += $(call cc-option, -m32) KBUILD_AFLAGS := $(KBUILD_CFLAGS) -D__ASSEMBLY__ +GCOV_PROFILE := n WAKEUP_OBJS = $(addprefix $(obj)/,$(wakeup-y)) Index: linux-2.6.30-rc4/arch/x86/boot/Makefile =================================================================== --- linux-2.6.30-rc4.orig/arch/x86/boot/Makefile +++ linux-2.6.30-rc4/arch/x86/boot/Makefile @@ -69,6 +69,7 @@ KBUILD_CFLAGS := $(LINUXINCLUDE) -g -Os $(call cc-option, -mpreferred-stack-boundary=2) KBUILD_CFLAGS += $(call cc-option, -m32) KBUILD_AFLAGS := $(KBUILD_CFLAGS) -D__ASSEMBLY__ +GCOV_PROFILE := n $(obj)/bzImage: asflags-y := $(SVGA_MODE) Index: linux-2.6.30-rc4/arch/x86/boot/compressed/Makefile =================================================================== --- linux-2.6.30-rc4.orig/arch/x86/boot/compressed/Makefile +++ linux-2.6.30-rc4/arch/x86/boot/compressed/Makefile @@ -15,6 +15,7 @@ KBUILD_CFLAGS += $(call cc-option,-ffree KBUILD_CFLAGS += $(call cc-option,-fno-stack-protector) KBUILD_AFLAGS := $(KBUILD_CFLAGS) -D__ASSEMBLY__ +GCOV_PROFILE := n LDFLAGS := -m elf_$(UTS_MACHINE) LDFLAGS_vmlinux := -T Index: linux-2.6.30-rc4/arch/x86/vdso/Makefile =================================================================== --- linux-2.6.30-rc4.orig/arch/x86/vdso/Makefile +++ linux-2.6.30-rc4/arch/x86/vdso/Makefile @@ -123,6 +123,7 @@ quiet_cmd_vdso = VDSO $@ -Wl,-T,$(filter %.lds,$^) $(filter %.o,$^) VDSO_LDFLAGS = -fPIC -shared $(call ld-option, -Wl$(comma)--hash-style=sysv) +GCOV_PROFILE := n # # Install the unstripped copy of vdso*.so listed in $(vdso-install-y). Index: linux-2.6.30-rc4/arch/x86/kernel/Makefile =================================================================== --- linux-2.6.30-rc4.orig/arch/x86/kernel/Makefile +++ linux-2.6.30-rc4/arch/x86/kernel/Makefile @@ -24,6 +24,8 @@ CFLAGS_vsyscall_64.o := $(PROFILING) -g0 CFLAGS_hpet.o := $(nostackp) CFLAGS_tsc.o := $(nostackp) CFLAGS_paravirt.o := $(nostackp) +GCOV_PROFILE_vsyscall_64.o := n +GCOV_PROFILE_hpet.o := n obj-y := process_$(BITS).o signal.o entry_$(BITS).o obj-y += traps.o irq.o irq_$(BITS).o dumpstack_$(BITS).o ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 0/4] gcov kernel support @ 2009-06-02 11:43 Peter Oberparleiter 2009-06-02 11:44 ` [PATCH 2/4] seq_file: add function to write binary data Peter Oberparleiter 0 siblings, 1 reply; 23+ messages in thread From: Peter Oberparleiter @ 2009-06-02 11:43 UTC (permalink / raw) To: Andrew Morton Cc: linux-kernel, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Ingo Molnar, Heiko Carstens, Martin Schwidefsky This patchset implements support for performing kernel code coverage measurements based on gcc's gcov mechanism. It can be used to improve kernel code quality by identifying code parts which are not exercised during test cases. Patch base is 2.6.30-rc7. Changes since last version: * removed __gcov_execve (assuming no kernel function will be called execve) Patch overview: [PATCH 1/4] kernel: constructor support [PATCH 2/4] seq_file: add function to write binary data [PATCH 3/4] gcov: add gcov profiling infrastructure [PATCH 4/4] gcov: enable GCOV_PROFILE_ALL for x86_64 For more information see Documentation/gcov.txt and the previous post: http://marc.info/?l=linux-kernel&m=123565658224661 ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 2/4] seq_file: add function to write binary data 2009-06-02 11:43 [PATCH 0/4] gcov kernel support Peter Oberparleiter @ 2009-06-02 11:44 ` Peter Oberparleiter 0 siblings, 0 replies; 23+ messages in thread From: Peter Oberparleiter @ 2009-06-02 11:44 UTC (permalink / raw) To: Andrew Morton Cc: linux-kernel, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Ingo Molnar, Heiko Carstens, Martin Schwidefsky, Al Viro [-- Attachment #1: seq_file-add-function-to-write-binary-data.patch --] [-- Type: text/plain, Size: 1970 bytes --] From: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> seq_write() can be used to construct seq_files containing arbitrary data. Required by the gcov-profiling interface to synthesize binary profiling data files. Signed-off-by: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> Cc: Al Viro <viro@zeniv.linux.org.uk> --- fs/seq_file.c | 20 ++++++++++++++++++++ include/linux/seq_file.h | 1 + 2 files changed, 21 insertions(+) Index: linux-2.6.30-rc7/fs/seq_file.c =================================================================== --- linux-2.6.30-rc7.orig/fs/seq_file.c 2009-06-02 10:34:35.000000000 +0200 +++ linux-2.6.30-rc7/fs/seq_file.c 2009-06-02 10:35:24.000000000 +0200 @@ -640,6 +640,26 @@ } EXPORT_SYMBOL(seq_puts); +/** + * seq_write - write arbitrary data to buffer + * @seq: seq_file identifying the buffer to which data should be written + * @data: data address + * @len: number of bytes + * + * Return 0 on success, non-zero otherwise. + */ +int seq_write(struct seq_file *seq, const void *data, size_t len) +{ + if (seq->count + len < seq->size) { + memcpy(seq->buf + seq->count, data, len); + seq->count += len; + return 0; + } + seq->count = seq->size; + return -1; +} +EXPORT_SYMBOL(seq_write); + struct list_head *seq_list_start(struct list_head *head, loff_t pos) { struct list_head *lh; Index: linux-2.6.30-rc7/include/linux/seq_file.h =================================================================== --- linux-2.6.30-rc7.orig/include/linux/seq_file.h 2009-06-02 10:34:43.000000000 +0200 +++ linux-2.6.30-rc7/include/linux/seq_file.h 2009-06-02 10:35:24.000000000 +0200 @@ -43,6 +43,7 @@ int seq_escape(struct seq_file *, const char *, const char *); int seq_putc(struct seq_file *m, char c); int seq_puts(struct seq_file *m, const char *s); +int seq_write(struct seq_file *seq, const void *data, size_t len); int seq_printf(struct seq_file *, const char *, ...) __attribute__ ((format (printf,2,3))); ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 0/4] gcov kernel support @ 2009-05-19 14:24 Peter Oberparleiter 2009-05-19 14:24 ` [PATCH 2/4] seq_file: add function to write binary data Peter Oberparleiter 0 siblings, 1 reply; 23+ messages in thread From: Peter Oberparleiter @ 2009-05-19 14:24 UTC (permalink / raw) To: Andrew Morton Cc: linux-kernel, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Ingo Molnar, Heiko Carstens, Martin Schwidefsky This patchset implements support for performing kernel code coverage measurements based on gcc's gcov mechanism. It can be used to improve kernel code quality by identifying code parts which are not exercised during test cases. Patch base is 2.6.30-rc6. Patch feedback has been integrated. There were no further comments since the last version. In my opinion this patchset is ready for inclusion into the -mm tree. Patch overview: [PATCH 1/4] kernel: constructor support [PATCH 2/4] seq_file: add function to write binary data [PATCH 3/4] gcov: add gcov profiling infrastructure [PATCH 4/4] gcov: enable GCOV_PROFILE_ALL for x86_64 For more information see Documentation/gcov.txt and the previous post: http://marc.info/?l=linux-kernel&m=123565658224661 ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 2/4] seq_file: add function to write binary data 2009-05-19 14:24 [PATCH 0/4] gcov kernel support Peter Oberparleiter @ 2009-05-19 14:24 ` Peter Oberparleiter 0 siblings, 0 replies; 23+ messages in thread From: Peter Oberparleiter @ 2009-05-19 14:24 UTC (permalink / raw) To: Andrew Morton Cc: linux-kernel, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Ingo Molnar, Heiko Carstens, Martin Schwidefsky, Al Viro [-- Attachment #1: seq_file-add-function-to-write-binary-data.patch --] [-- Type: text/plain, Size: 1970 bytes --] From: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> seq_write() can be used to construct seq_files containing arbitrary data. Required by the gcov-profiling interface to synthesize binary profiling data files. Signed-off-by: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> Cc: Al Viro <viro@zeniv.linux.org.uk> --- fs/seq_file.c | 20 ++++++++++++++++++++ include/linux/seq_file.h | 1 + 2 files changed, 21 insertions(+) Index: linux-2.6.30-rc6/fs/seq_file.c =================================================================== --- linux-2.6.30-rc6.orig/fs/seq_file.c 2009-05-19 12:27:37.000000000 +0200 +++ linux-2.6.30-rc6/fs/seq_file.c 2009-05-19 12:41:26.000000000 +0200 @@ -640,6 +640,26 @@ } EXPORT_SYMBOL(seq_puts); +/** + * seq_write - write arbitrary data to buffer + * @seq: seq_file identifying the buffer to which data should be written + * @data: data address + * @len: number of bytes + * + * Return 0 on success, non-zero otherwise. + */ +int seq_write(struct seq_file *seq, const void *data, size_t len) +{ + if (seq->count + len < seq->size) { + memcpy(seq->buf + seq->count, data, len); + seq->count += len; + return 0; + } + seq->count = seq->size; + return -1; +} +EXPORT_SYMBOL(seq_write); + struct list_head *seq_list_start(struct list_head *head, loff_t pos) { struct list_head *lh; Index: linux-2.6.30-rc6/include/linux/seq_file.h =================================================================== --- linux-2.6.30-rc6.orig/include/linux/seq_file.h 2009-05-19 12:27:37.000000000 +0200 +++ linux-2.6.30-rc6/include/linux/seq_file.h 2009-05-19 12:41:26.000000000 +0200 @@ -43,6 +43,7 @@ int seq_escape(struct seq_file *, const char *, const char *); int seq_putc(struct seq_file *m, char c); int seq_puts(struct seq_file *m, const char *s); +int seq_write(struct seq_file *seq, const void *data, size_t len); int seq_printf(struct seq_file *, const char *, ...) __attribute__ ((format (printf,2,3))); ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 0/4] gcov kernel support @ 2009-05-12 15:38 Peter Oberparleiter 2009-05-12 15:38 ` [PATCH 2/4] seq_file: add function to write binary data Peter Oberparleiter 0 siblings, 1 reply; 23+ messages in thread From: Peter Oberparleiter @ 2009-05-12 15:38 UTC (permalink / raw) To: linux-kernel Cc: Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Ingo Molnar, Heiko Carstens, Martin Schwidefsky This patchset implements support for performing kernel code coverage measurements based on gcc's gcov mechanism. It can be used to improve kernel code quality by identifying code parts which are not exercised during test cases. Patch base is 2.6.30-rc5. Changes since last version: * updated to 2.6.30-rc5 * moved __ctors_start and __ctors_end declaration to include/asm-generic/sections.h Patch overview: [PATCH 1/4] kernel: constructor support [PATCH 2/4] seq_file: add function to write binary data [PATCH 3/4] gcov: add gcov profiling infrastructure [PATCH 4/4] gcov: enable GCOV_PROFILE_ALL for x86_64 For more information see Documentation/gcov.txt and the previous post: http://marc.info/?l=linux-kernel&m=123565658224661 ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 2/4] seq_file: add function to write binary data 2009-05-12 15:38 [PATCH 0/4] gcov kernel support Peter Oberparleiter @ 2009-05-12 15:38 ` Peter Oberparleiter 0 siblings, 0 replies; 23+ messages in thread From: Peter Oberparleiter @ 2009-05-12 15:38 UTC (permalink / raw) To: linux-kernel Cc: Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Ingo Molnar, Heiko Carstens, Martin Schwidefsky, Al Viro [-- Attachment #1: seq_file-add-function-to-write-binary-data.patch --] [-- Type: text/plain, Size: 1908 bytes --] From: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> seq_write() can be used to construct seq_files containing arbitrary data. Required by the gcov-profiling interface to synthesize binary profiling data files. Signed-off-by: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> Cc: Al Viro <viro@zeniv.linux.org.uk> --- fs/seq_file.c | 20 ++++++++++++++++++++ include/linux/seq_file.h | 1 + 2 files changed, 21 insertions(+) Index: linux-2.6.30-rc5/fs/seq_file.c =================================================================== --- linux-2.6.30-rc5.orig/fs/seq_file.c +++ linux-2.6.30-rc5/fs/seq_file.c @@ -640,6 +640,26 @@ int seq_puts(struct seq_file *m, const c } EXPORT_SYMBOL(seq_puts); +/** + * seq_write - write arbitrary data to buffer + * @seq: seq_file identifying the buffer to which data should be written + * @data: data address + * @len: number of bytes + * + * Return 0 on success, non-zero otherwise. + */ +int seq_write(struct seq_file *seq, const void *data, size_t len) +{ + if (seq->count + len < seq->size) { + memcpy(seq->buf + seq->count, data, len); + seq->count += len; + return 0; + } + seq->count = seq->size; + return -1; +} +EXPORT_SYMBOL(seq_write); + struct list_head *seq_list_start(struct list_head *head, loff_t pos) { struct list_head *lh; Index: linux-2.6.30-rc5/include/linux/seq_file.h =================================================================== --- linux-2.6.30-rc5.orig/include/linux/seq_file.h +++ linux-2.6.30-rc5/include/linux/seq_file.h @@ -43,6 +43,7 @@ int seq_release(struct inode *, struct f int seq_escape(struct seq_file *, const char *, const char *); int seq_putc(struct seq_file *m, char c); int seq_puts(struct seq_file *m, const char *s); +int seq_write(struct seq_file *seq, const void *data, size_t len); int seq_printf(struct seq_file *, const char *, ...) __attribute__ ((format (printf,2,3))); ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 0/4] gcov kernel support @ 2009-05-08 15:44 Peter Oberparleiter 2009-05-08 15:44 ` [PATCH 2/4] seq_file: add function to write binary data Peter Oberparleiter 0 siblings, 1 reply; 23+ messages in thread From: Peter Oberparleiter @ 2009-05-08 15:44 UTC (permalink / raw) To: linux-kernel Cc: Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Ingo Molnar, Heiko Carstens, Martin Schwidefsky This patchset implements support for performing kernel code coverage measurements based on gcc's gcov mechanism. It can be used to improve kernel code quality by identifying code parts which are not exercised during test cases. Patch base is 2.6.30-rc4. Changes since last version: * moved compiler version assertion to include/linux/compiler-gcc3.h * moved all module-specific code under CONFIG_MODULES * added symbolic names for gcda file record numbers * split seq_write_gcov_int() into two functions * coding style changes: * fixed multi-line comments * added braces for multi-line blocks * improved rc and error label usage * made local variable initialization consistent * added initialization indentation * improved readability by using local variables Patch overview: [PATCH 1/4] kernel: constructor support [PATCH 2/4] seq_file: add function to write binary data [PATCH 3/4] gcov: add gcov profiling infrastructure [PATCH 4/4] gcov: enable GCOV_PROFILE_ALL for x86_64 For more information see Documentation/gcov.txt and the previous post: http://marc.info/?l=linux-kernel&m=123565658224661 ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 2/4] seq_file: add function to write binary data 2009-05-08 15:44 [PATCH 0/4] gcov kernel support Peter Oberparleiter @ 2009-05-08 15:44 ` Peter Oberparleiter 0 siblings, 0 replies; 23+ messages in thread From: Peter Oberparleiter @ 2009-05-08 15:44 UTC (permalink / raw) To: linux-kernel Cc: Andrew Morton, Andi Kleen, Huang Ying, Li Wei, Michael Ellerman, Ingo Molnar, Heiko Carstens, Martin Schwidefsky, Al Viro [-- Attachment #1: seq_file-add-function-to-write-binary-data.patch --] [-- Type: text/plain, Size: 1908 bytes --] From: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> seq_write() can be used to construct seq_files containing arbitrary data. Required by the gcov-profiling interface to synthesize binary profiling data files. Signed-off-by: Peter Oberparleiter <oberpar@linux.vnet.ibm.com> Cc: Al Viro <viro@zeniv.linux.org.uk> --- fs/seq_file.c | 20 ++++++++++++++++++++ include/linux/seq_file.h | 1 + 2 files changed, 21 insertions(+) Index: linux-2.6.30-rc4/fs/seq_file.c =================================================================== --- linux-2.6.30-rc4.orig/fs/seq_file.c +++ linux-2.6.30-rc4/fs/seq_file.c @@ -640,6 +640,26 @@ int seq_puts(struct seq_file *m, const c } EXPORT_SYMBOL(seq_puts); +/** + * seq_write - write arbitrary data to buffer + * @seq: seq_file identifying the buffer to which data should be written + * @data: data address + * @len: number of bytes + * + * Return 0 on success, non-zero otherwise. + */ +int seq_write(struct seq_file *seq, const void *data, size_t len) +{ + if (seq->count + len < seq->size) { + memcpy(seq->buf + seq->count, data, len); + seq->count += len; + return 0; + } + seq->count = seq->size; + return -1; +} +EXPORT_SYMBOL(seq_write); + struct list_head *seq_list_start(struct list_head *head, loff_t pos) { struct list_head *lh; Index: linux-2.6.30-rc4/include/linux/seq_file.h =================================================================== --- linux-2.6.30-rc4.orig/include/linux/seq_file.h +++ linux-2.6.30-rc4/include/linux/seq_file.h @@ -43,6 +43,7 @@ int seq_release(struct inode *, struct f int seq_escape(struct seq_file *, const char *, const char *); int seq_putc(struct seq_file *m, char c); int seq_puts(struct seq_file *m, const char *s); +int seq_write(struct seq_file *seq, const void *data, size_t len); int seq_printf(struct seq_file *, const char *, ...) __attribute__ ((format (printf,2,3))); ^ permalink raw reply [flat|nested] 23+ messages in thread
* [PATCH 2/4] seq_file: add function to write binary data
@ 2009-02-26 13:51 Peter Oberparleiter
0 siblings, 0 replies; 23+ messages in thread
From: Peter Oberparleiter @ 2009-02-26 13:51 UTC (permalink / raw)
To: linux-kernel
Cc: Andrew Morton, Andi Kleen, Huang Ying, Al Viro, Sam Ravnborg,
Rusty Russell
From: Peter Oberparleiter <oberpar@linux.vnet.ibm.com>
seq_write() can be used to construct seq_files containing arbitrary
data. Required by the gcov-profiling interface to synthesize binary
profiling data files.
Signed-off-by: Peter Oberparleiter <oberpar@linux.vnet.ibm.com>
---
fs/seq_file.c | 20 ++++++++++++++++++++
include/linux/seq_file.h | 1 +
2 files changed, 21 insertions(+)
Index: linux-2.6.29-rc6/fs/seq_file.c
===================================================================
--- linux-2.6.29-rc6.orig/fs/seq_file.c
+++ linux-2.6.29-rc6/fs/seq_file.c
@@ -640,6 +640,26 @@ int seq_puts(struct seq_file *m, const c
}
EXPORT_SYMBOL(seq_puts);
+/**
+ * seq_write - write arbitrary data to buffer
+ * @seq: seq_file identifying the buffer to which data should be written
+ * @data: data address
+ * @len: number of bytes
+ *
+ * Return 0 on success, non-zero otherwise.
+ */
+int seq_write(struct seq_file *seq, const void *data, size_t len)
+{
+ if (seq->count + len < seq->size) {
+ memcpy(seq->buf + seq->count, data, len);
+ seq->count += len;
+ return 0;
+ }
+ seq->count = seq->size;
+ return -1;
+}
+EXPORT_SYMBOL(seq_write);
+
struct list_head *seq_list_start(struct list_head *head, loff_t pos)
{
struct list_head *lh;
Index: linux-2.6.29-rc6/include/linux/seq_file.h
===================================================================
--- linux-2.6.29-rc6.orig/include/linux/seq_file.h
+++ linux-2.6.29-rc6/include/linux/seq_file.h
@@ -43,6 +43,7 @@ int seq_release(struct inode *, struct f
int seq_escape(struct seq_file *, const char *, const char *);
int seq_putc(struct seq_file *m, char c);
int seq_puts(struct seq_file *m, const char *s);
+int seq_write(struct seq_file *seq, const void *data, size_t len);
int seq_printf(struct seq_file *, const char *, ...)
__attribute__ ((format (printf,2,3)));
^ permalink raw reply [flat|nested] 23+ messages in thread* [PATCH 2/4] seq_file: add function to write binary data
@ 2009-02-03 12:46 Peter Oberparleiter
0 siblings, 0 replies; 23+ messages in thread
From: Peter Oberparleiter @ 2009-02-03 12:46 UTC (permalink / raw)
To: linux-kernel
Cc: Andrew Morton, Andi Kleen, Huang Ying, Al Viro, Sam Ravnborg,
Rusty Russell
From: Peter Oberparleiter <oberpar@linux.vnet.ibm.com>
seq_write() can be used to construct seq_files containing arbitrary
data. Required by the gcov-profiling interface to synthesize binary
profiling data files.
Signed-off-by: Peter Oberparleiter <oberpar@linux.vnet.ibm.com>
---
fs/seq_file.c | 20 ++++++++++++++++++++
include/linux/seq_file.h | 1 +
2 files changed, 21 insertions(+)
Index: linux-2.6.29-rc3/fs/seq_file.c
===================================================================
--- linux-2.6.29-rc3.orig/fs/seq_file.c
+++ linux-2.6.29-rc3/fs/seq_file.c
@@ -611,6 +611,26 @@ int seq_puts(struct seq_file *m, const c
}
EXPORT_SYMBOL(seq_puts);
+/**
+ * seq_write - write arbitrary data to buffer
+ * @seq: seq_file identifying the buffer to which data should be written
+ * @data: data address
+ * @len: number of bytes
+ *
+ * Return 0 on success, non-zero otherwise.
+ */
+int seq_write(struct seq_file *seq, const void *data, size_t len)
+{
+ if (seq->count + len < seq->size) {
+ memcpy(seq->buf + seq->count, data, len);
+ seq->count += len;
+ return 0;
+ }
+ seq->count = seq->size;
+ return -1;
+}
+EXPORT_SYMBOL(seq_write);
+
struct list_head *seq_list_start(struct list_head *head, loff_t pos)
{
struct list_head *lh;
Index: linux-2.6.29-rc3/include/linux/seq_file.h
===================================================================
--- linux-2.6.29-rc3.orig/include/linux/seq_file.h
+++ linux-2.6.29-rc3/include/linux/seq_file.h
@@ -42,6 +42,7 @@ int seq_release(struct inode *, struct f
int seq_escape(struct seq_file *, const char *, const char *);
int seq_putc(struct seq_file *m, char c);
int seq_puts(struct seq_file *m, const char *s);
+int seq_write(struct seq_file *seq, const void *data, size_t len);
int seq_printf(struct seq_file *, const char *, ...)
__attribute__ ((format (printf,2,3)));
^ permalink raw reply [flat|nested] 23+ messages in threadend of thread, other threads:[~2009-06-02 11:44 UTC | newest] Thread overview: 23+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2009-05-07 12:45 [PATCH 0/4] gcov kernel support Peter Oberparleiter 2009-05-07 12:45 ` [PATCH 1/4] kernel: constructor support Peter Oberparleiter 2009-05-07 12:51 ` Ingo Molnar 2009-05-07 13:33 ` Peter Oberparleiter 2009-05-07 12:53 ` Ingo Molnar 2009-05-07 13:38 ` Peter Oberparleiter 2009-05-07 13:48 ` Ingo Molnar 2009-05-08 11:23 ` Peter Oberparleiter 2009-05-07 12:45 ` [PATCH 2/4] seq_file: add function to write binary data Peter Oberparleiter 2009-05-07 12:45 ` [PATCH 3/4] gcov: add gcov profiling infrastructure Peter Oberparleiter 2009-05-07 13:46 ` Ingo Molnar 2009-05-07 13:49 ` Ingo Molnar 2009-05-08 11:10 ` Peter Oberparleiter 2009-05-11 13:17 ` Ingo Molnar 2009-05-12 13:09 ` Peter Oberparleiter 2009-05-12 13:35 ` Ingo Molnar 2009-05-07 12:46 ` [PATCH 4/4] gcov: enable GCOV_PROFILE_ALL for x86_64 Peter Oberparleiter -- strict thread matches above, loose matches on Subject: below -- 2009-06-02 11:43 [PATCH 0/4] gcov kernel support Peter Oberparleiter 2009-06-02 11:44 ` [PATCH 2/4] seq_file: add function to write binary data Peter Oberparleiter 2009-05-19 14:24 [PATCH 0/4] gcov kernel support Peter Oberparleiter 2009-05-19 14:24 ` [PATCH 2/4] seq_file: add function to write binary data Peter Oberparleiter 2009-05-12 15:38 [PATCH 0/4] gcov kernel support Peter Oberparleiter 2009-05-12 15:38 ` [PATCH 2/4] seq_file: add function to write binary data Peter Oberparleiter 2009-05-08 15:44 [PATCH 0/4] gcov kernel support Peter Oberparleiter 2009-05-08 15:44 ` [PATCH 2/4] seq_file: add function to write binary data Peter Oberparleiter 2009-02-26 13:51 Peter Oberparleiter 2009-02-03 12:46 Peter Oberparleiter
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).