You can subscribe to this list here.
| 2002 |
Jan
|
Feb
|
Mar
|
Apr
|
May
|
Jun
|
Jul
|
Aug
|
Sep
(1) |
Oct
(122) |
Nov
(152) |
Dec
(69) |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2003 |
Jan
(6) |
Feb
(25) |
Mar
(73) |
Apr
(82) |
May
(24) |
Jun
(25) |
Jul
(10) |
Aug
(11) |
Sep
(10) |
Oct
(54) |
Nov
(203) |
Dec
(182) |
| 2004 |
Jan
(307) |
Feb
(305) |
Mar
(430) |
Apr
(312) |
May
(187) |
Jun
(342) |
Jul
(487) |
Aug
(637) |
Sep
(336) |
Oct
(373) |
Nov
(441) |
Dec
(210) |
| 2005 |
Jan
(385) |
Feb
(480) |
Mar
(636) |
Apr
(544) |
May
(679) |
Jun
(625) |
Jul
(810) |
Aug
(838) |
Sep
(634) |
Oct
(521) |
Nov
(965) |
Dec
(543) |
| 2006 |
Jan
(494) |
Feb
(431) |
Mar
(546) |
Apr
(411) |
May
(406) |
Jun
(322) |
Jul
(256) |
Aug
(401) |
Sep
(345) |
Oct
(542) |
Nov
(308) |
Dec
(481) |
| 2007 |
Jan
(427) |
Feb
(326) |
Mar
(367) |
Apr
(255) |
May
(244) |
Jun
(204) |
Jul
(223) |
Aug
(231) |
Sep
(354) |
Oct
(374) |
Nov
(497) |
Dec
(362) |
| 2008 |
Jan
(322) |
Feb
(482) |
Mar
(658) |
Apr
(422) |
May
(476) |
Jun
(396) |
Jul
(455) |
Aug
(267) |
Sep
(280) |
Oct
(253) |
Nov
(232) |
Dec
(304) |
| 2009 |
Jan
(486) |
Feb
(470) |
Mar
(458) |
Apr
(423) |
May
(696) |
Jun
(461) |
Jul
(551) |
Aug
(575) |
Sep
(134) |
Oct
(110) |
Nov
(157) |
Dec
(102) |
| 2010 |
Jan
(226) |
Feb
(86) |
Mar
(147) |
Apr
(117) |
May
(107) |
Jun
(203) |
Jul
(193) |
Aug
(238) |
Sep
(300) |
Oct
(246) |
Nov
(23) |
Dec
(75) |
| 2011 |
Jan
(133) |
Feb
(195) |
Mar
(315) |
Apr
(200) |
May
(267) |
Jun
(293) |
Jul
(353) |
Aug
(237) |
Sep
(278) |
Oct
(611) |
Nov
(274) |
Dec
(260) |
| 2012 |
Jan
(303) |
Feb
(391) |
Mar
(417) |
Apr
(441) |
May
(488) |
Jun
(655) |
Jul
(590) |
Aug
(610) |
Sep
(526) |
Oct
(478) |
Nov
(359) |
Dec
(372) |
| 2013 |
Jan
(467) |
Feb
(226) |
Mar
(391) |
Apr
(281) |
May
(299) |
Jun
(252) |
Jul
(311) |
Aug
(352) |
Sep
(481) |
Oct
(571) |
Nov
(222) |
Dec
(231) |
| 2014 |
Jan
(185) |
Feb
(329) |
Mar
(245) |
Apr
(238) |
May
(281) |
Jun
(399) |
Jul
(382) |
Aug
(500) |
Sep
(579) |
Oct
(435) |
Nov
(487) |
Dec
(256) |
| 2015 |
Jan
(338) |
Feb
(357) |
Mar
(330) |
Apr
(294) |
May
(191) |
Jun
(108) |
Jul
(142) |
Aug
(261) |
Sep
(190) |
Oct
(54) |
Nov
(83) |
Dec
(22) |
| 2016 |
Jan
(49) |
Feb
(89) |
Mar
(33) |
Apr
(50) |
May
(27) |
Jun
(34) |
Jul
(53) |
Aug
(53) |
Sep
(98) |
Oct
(206) |
Nov
(93) |
Dec
(53) |
| 2017 |
Jan
(65) |
Feb
(82) |
Mar
(102) |
Apr
(86) |
May
(187) |
Jun
(67) |
Jul
(23) |
Aug
(93) |
Sep
(65) |
Oct
(45) |
Nov
(35) |
Dec
(17) |
| 2018 |
Jan
(26) |
Feb
(35) |
Mar
(38) |
Apr
(32) |
May
(8) |
Jun
(43) |
Jul
(27) |
Aug
(30) |
Sep
(43) |
Oct
(42) |
Nov
(38) |
Dec
(67) |
| 2019 |
Jan
(32) |
Feb
(37) |
Mar
(53) |
Apr
(64) |
May
(49) |
Jun
(18) |
Jul
(14) |
Aug
(53) |
Sep
(25) |
Oct
(30) |
Nov
(49) |
Dec
(31) |
| 2020 |
Jan
(87) |
Feb
(45) |
Mar
(37) |
Apr
(51) |
May
(99) |
Jun
(36) |
Jul
(11) |
Aug
(14) |
Sep
(20) |
Oct
(24) |
Nov
(40) |
Dec
(23) |
| 2021 |
Jan
(14) |
Feb
(53) |
Mar
(85) |
Apr
(15) |
May
(19) |
Jun
(3) |
Jul
(14) |
Aug
(1) |
Sep
(57) |
Oct
(73) |
Nov
(56) |
Dec
(22) |
| 2022 |
Jan
(3) |
Feb
(22) |
Mar
(6) |
Apr
(55) |
May
(46) |
Jun
(39) |
Jul
(15) |
Aug
(9) |
Sep
(11) |
Oct
(34) |
Nov
(20) |
Dec
(36) |
| 2023 |
Jan
(79) |
Feb
(41) |
Mar
(99) |
Apr
(169) |
May
(48) |
Jun
(16) |
Jul
(16) |
Aug
(57) |
Sep
(19) |
Oct
|
Nov
|
Dec
|
| S | M | T | W | T | F | S |
|---|---|---|---|---|---|---|
|
|
|
|
1
(3) |
2
|
3
|
4
|
|
5
(13) |
6
(2) |
7
(5) |
8
(4) |
9
(3) |
10
(4) |
11
(4) |
|
12
(7) |
13
|
14
(1) |
15
|
16
|
17
(2) |
18
|
|
19
|
20
|
21
(3) |
22
(8) |
23
(7) |
24
(5) |
25
(4) |
|
26
(6) |
27
|
28
(9) |
29
|
30
(4) |
31
(5) |
|
|
From: Paul F. <pa...@so...> - 2023-03-25 18:56:59
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=3eaac588274bbfecc3df4b73e3f86df8833c7f80 commit 3eaac588274bbfecc3df4b73e3f86df8833c7f80 Author: Paul Floyd <pj...@wa...> Date: Sat Mar 25 19:52:41 2023 +0100 Regtest: clean aligned alloc tests on FreeBSD x86 Add a filter for size_t (unsigned long on 64bit platforms and unsigned int on 32bit ones). Add another expected for x86. Diff: --- memcheck/tests/Makefile.am | 4 +++- memcheck/tests/filter_size_t | 5 ++++ memcheck/tests/memalign_args.stderr.exp-x86 | 28 ++++++++++++++++++++++ .../sized_aligned_new_delete_misaligned.vgtest | 1 + 4 files changed, 37 insertions(+), 1 deletion(-) diff --git a/memcheck/tests/Makefile.am b/memcheck/tests/Makefile.am index 0509d45869..ec16313ddf 100644 --- a/memcheck/tests/Makefile.am +++ b/memcheck/tests/Makefile.am @@ -80,7 +80,8 @@ dist_noinst_SCRIPTS = \ filter_varinfo3 \ filter_memcheck \ filter_overlaperror \ - filter_malloc_free + filter_malloc_free \ + filter_size_t noinst_HEADERS = leak.h @@ -228,6 +229,7 @@ EXTRA_DIST = \ memalign_args.stderr.exp-glibc \ memalign_args.stderr.exp-ppc64 \ memalign_args.stderr.exp-arm \ + memalign_args.stderr.exp-x86 \ memcmptest.stderr.exp memcmptest.stderr.exp2 \ memcmptest.stdout.exp memcmptest.vgtest \ memmem.stderr.exp memmem.vgtest \ diff --git a/memcheck/tests/filter_size_t b/memcheck/tests/filter_size_t new file mode 100755 index 0000000000..08386b219c --- /dev/null +++ b/memcheck/tests/filter_size_t @@ -0,0 +1,5 @@ +#! /bin/sh + + +./filter_stderr "$@" | +sed "s/unsigned int/unsigned long/" diff --git a/memcheck/tests/memalign_args.stderr.exp-x86 b/memcheck/tests/memalign_args.stderr.exp-x86 new file mode 100644 index 0000000000..1bb553ea6b --- /dev/null +++ b/memcheck/tests/memalign_args.stderr.exp-x86 @@ -0,0 +1,28 @@ +Conditional jump or move depends on uninitialised value(s) + at 0x........: memalign (vg_replace_malloc.c:...) + by 0x........: main (memalign_args.c:19) + +Conditional jump or move depends on uninitialised value(s) + at 0x........: memalign (vg_replace_malloc.c:...) + by 0x........: main (memalign_args.c:19) + +Conditional jump or move depends on uninitialised value(s) + at 0x........: posix_memalign (vg_replace_malloc.c:...) + by 0x........: main (memalign_args.c:23) + +Conditional jump or move depends on uninitialised value(s) + at 0x........: posix_memalign (vg_replace_malloc.c:...) + by 0x........: main (memalign_args.c:23) + +Conditional jump or move depends on uninitialised value(s) + at 0x........: aligned_alloc (vg_replace_malloc.c:...) + by 0x........: main (memalign_args.c:26) + +Conditional jump or move depends on uninitialised value(s) + at 0x........: aligned_alloc (vg_replace_malloc.c:...) + by 0x........: main (memalign_args.c:26) + +Conditional jump or move depends on uninitialised value(s) + at 0x........: valloc (vg_replace_malloc.c:...) + by 0x........: main (memalign_args.c:29) + diff --git a/memcheck/tests/sized_aligned_new_delete_misaligned.vgtest b/memcheck/tests/sized_aligned_new_delete_misaligned.vgtest index fc7b6f4712..13f61924b7 100644 --- a/memcheck/tests/sized_aligned_new_delete_misaligned.vgtest +++ b/memcheck/tests/sized_aligned_new_delete_misaligned.vgtest @@ -1,3 +1,4 @@ prog: sized_aligned_new_delete_misaligned prereq: test -e ./sized_aligned_new_delete_misaligned vgopts: -q +stderr_filter: filter_size_t |
|
From: Nicholas N. <n.n...@gm...> - 2023-03-25 00:25:33
|
On Fri, 24 Mar 2023 at 22:25, Mark Wielaard <ma...@kl...> wrote: > > We aren't (yet?) using all of them (and some of them would mean moving > over bugzilla and the mailinglist, which might be controversial). But > I'll at least add the buildbot CI testers to the website (and we should > at least make use of the try-branches) this weekend. > Great! I'd be happy to try this out. Though I guess I'd need to do a no-change try run before testing a real change, to give a baseline of expected test failures, right? Nick |
|
From: Nicholas N. <n.n...@gm...> - 2023-03-25 00:24:13
|
On Fri, 24 Mar 2023 at 22:52, Mark Wielaard <ma...@kl...> wrote: > > I completely agree with this sentiment. But how do you get there? Ruthless pragmatism and an incremental approach :) > And > how do you cross the psychological barrier. I mean that it feels like > cheating to just disable failing or flaky tests. > They might fail on some, but not all setups. Or they might even be just > flaky depending on CPU model (I think I saw some failures with an AMD > Ryzen processor, which succeeded on an Intel Xeon processor). > > What should our policy be to get to zero fail? > Does that mean a test should always pass on any arch/setup? > Or do we make exceptions for tests that fail on some setups? > Do we keep an "exception list" based on...? > What do we do with the "removed" (or excepted) tests? > Do those turn into high priority bugs instead? > What about new ports, they often start with a bunch of failing tests. > One way to do it is to divide the tests into "must pass on CI" and "the rest". I suspect there are plenty of tests that work on all platforms, which would give a lot of useful coverage from the start. Over time you can hopefully move tests from the first category to the second. The other way to do it is to divide the tests into "run on CI" and "don't run on CI", i.e. exceptions, which does require a mechanism for specifying those exceptions. In practice I think this works out much the same as the first approach, because a test that consistently fails on one platform isn't much use. (In fact, it can have negative value if its presence masks new failures in other tests.) One consequence of all this is that the CI platforms become gospel. E.g. if a test passes on CI but fails locally, that's good enough. This is fine in practice, assuming the CI platforms are reasonable choices. Flaky tests can be a problem. For rare failures you can always just trigger another CI run. For regular failures you should either fix the test or disable it. Nick |
|
From: Mark W. <ma...@kl...> - 2023-03-24 11:52:56
|
Hi Nick, On Thu, 2023-03-23 at 21:51 +1100, Nicholas Nethercote wrote: > I threw a lot of ideas out in my earlier email, but this is the most > important one. Graydon Hoare expressed this years ago as: > > > The Not Rocket Science Rule Of Software Engineering: > > automatically maintain a repository of code that always passes all > > the tests > > This requires that all the tests pass before merging a change. Having > worked on projects that follow this and projects that don't, I say > with confidence that it's a good idea. If we could get that happening > for Valgrind, that alone would be a huge improvement over the status > quo. I looked at the sites you linked, but couldn't work out much > about how they work. > > W.r.t. failing tests, this would give great incentive to fix > currently failing tests (or disable them if they cannot be made > reliable) and to keep them passing. I completely agree with this sentiment. But how do you get there? And how do you cross the psychological barrier. I mean that it feels like cheating to just disable failing or flaky tests. They might fail on some, but not all setups. Or they might even be just flaky depending on CPU model (I think I saw some failures with an AMD Ryzen processor, which succeeded on an Intel Xeon processor). What should our policy be to get to zero fail? Does that mean a test should always pass on any arch/setup? Or do we make exceptions for tests that fail on some setups? Do we keep an "exception list" based on...? What do we do with the "removed" (or excepted) tests? Do those turn into high priority bugs instead? What about new ports, they often start with a bunch of failing tests. e.g. for x86_64 we do have memcheck/tests/overlap which fails on newer glibc with certain processors where glibc might use an ifunc to point both memcpy and memmove to the same function, which confuses our intercept code. https://bugs.kde.org/show_bug.cgi?id=402833 It works fine on some (older or not x86_64) setups though. I would love to get to "zero fail" but what should we do to get there and what should our policy be to keep it given that we don't fully control our environment and some (new) failures simply come from upgrading glibc or the compiler or even the cpu. Cheers, Mark |
|
From: Mark W. <ma...@kl...> - 2023-03-24 11:26:00
|
On Thu, 2023-03-23 at 19:50 +1100, Nicholas Nethercote wrote: > Nice, I wasn't aware of any of those facilities. Are they documented > anywhere, both their existence and how to use them? I couldn't find > anything on valgrind.org about them, but maybe I overlooked > something. We aren't (yet?) using all of them (and some of them would mean moving over bugzilla and the mailinglist, which might be controversial). But I'll at least add the buildbot CI testers to the website (and we should at least make use of the try-branches) this weekend. Cheers, Mark |
|
From: Floyd, P. <pj...@wa...> - 2023-03-24 10:55:31
|
On 23/03/2023 00:08, Nicholas Nethercote wrote: > > I understand the concerns about GitHub and commercialization, but I > also worry about Valgrind's future viability if it doesn't attract > some level of new contributors. The Linux kernel will never have that > problem, but I suspect lots of GNU projects also face that risk. I also think that is a big problem. Both for contributing and reviewing code. 'Casual' contributors that have medium to large contributions either never get merged or take ages. We really could do with some experts to help with ARM and the latest Intel/AMD instructions as well. A+ Paul |
|
From: Floyd, P. <pj...@wa...> - 2023-03-24 10:39:14
|
On 23/03/2023 11:51, Nicholas Nethercote wrote: > > This requires that all the tests pass before merging a change. Having > worked on projects that follow this and projects that don't, I say > with confidence that it's a good idea. If we could get that happening > for Valgrind, that alone would be a huge improvement over the status > quo. I looked at the sites you linked, but couldn't work out much > about how they work. CI tests are good, as long as they aren't too slow or flaky - we do have the occasional test that fails intermittently, but no huge muti-day tests. The problem I see is for the 'other' platforms that CI probably won't cover: x86, FreeBSD, Solaris, macOS. Manually testing on all those is tedious which can result in a bit of git ping-pong to get things like expected filters to converge on working on all platforms. > Mozilla's been using clang-format for Firefox C and C++ code for > several years. I'd be happy to have anything like K&R or Allman formatting - not keen on GNU style. I really do appreciate being able to grep for patterns like "variable = " knowing that there will always be just one space to find all assignments without having to wrestle with RE whitespaces or wade through all uses of 'variable'. And I presume that this can be done with a git hook. A+ Paul |
|
From: Nicholas N. <nj...@so...> - 2023-03-24 05:26:09
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=179fc84ba7ea204b627373fd37fc1fb5cf1e1663 commit 179fc84ba7ea204b627373fd37fc1fb5cf1e1663 Author: Nicholas Nethercote <n.n...@gm...> Date: Tue Mar 21 13:58:40 2023 +1100 Add more annotated/unannotated lines at the end. This way, all CCs are categorised, which is useful for understanding why thing were/weren't annotated. Diff: --- cachegrind/cg_annotate.in | 131 +++++++++++++++++++++++++++++++---------- cachegrind/tests/ann1.post.exp | 8 ++- cachegrind/tests/ann2.post.exp | 8 ++- cachegrind/tests/ann3.post.exp | 20 ++++--- cachegrind/tests/cgout-test3 | 12 +++- cachegrind/tests/diff.post.exp | 10 +++- 6 files changed, 142 insertions(+), 47 deletions(-) diff --git a/cachegrind/cg_annotate.in b/cachegrind/cg_annotate.in index 48bf4f1aab..bf09c36513 100755 --- a/cachegrind/cg_annotate.in +++ b/cachegrind/cg_annotate.in @@ -436,7 +436,7 @@ def read_cgout_file() -> tuple[str, str, Events, DictFlfnCc, DictFlDictLineCc, C total_cc += flfn_cc if summary_cc != total_cc: msg = ( - "`summary:` line doesn't match compute total\n" + "`summary:` line doesn't match computed total\n" f"- summary: {summary_cc}\n" f"- total: {total_cc}" ) @@ -622,6 +622,38 @@ def print_flfn_ccs( return set(flfn_and_cc[0][0] for flfn_and_cc in sorted_flfns_and_ccs) +class AnnotatedCcs: + line_nums_known_cc: Cc + line_nums_unknown_cc: Cc + unreadable_cc: Cc + below_threshold_cc: Cc + files_unknown_cc: Cc + + labels = [ + " annotated: files known & above threshold & readable, line numbers known", + " annotated: files known & above threshold & readable, line numbers unknown", + "unannotated: files known & above threshold & unreadable ", + "unannotated: files known & below threshold", + "unannotated: files unknown", + ] + + def __init__(self, events: Events) -> None: + self.line_nums_known_cc = events.mk_empty_cc() + self.line_nums_unknown_cc = events.mk_empty_cc() + self.unreadable_cc = events.mk_empty_cc() + self.below_threshold_cc = events.mk_empty_cc() + self.files_unknown_cc = events.mk_empty_cc() + + def ccs(self) -> list[Cc]: + return [ + self.line_nums_known_cc, + self.line_nums_unknown_cc, + self.unreadable_cc, + self.below_threshold_cc, + self.files_unknown_cc, + ] + + def mk_warning(msg: str) -> str: return f"""\ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@ -649,10 +681,10 @@ def warn_bogus_lines(src_filename: str) -> None: def print_annotated_src_file( events: Events, - dict_line_cc: DictLineCc, + dict_line_cc: DictLineCc | None, ann_type: str, src_file: TextIO, - annotated_cc: Cc, + annotated_ccs: AnnotatedCcs, summary_cc: Cc, ) -> None: print(FANCY) @@ -674,9 +706,15 @@ def print_annotated_src_file( printer.print_events("") print() - # Remove the CC for line 0 if it's present. It gets special treatment - # later. + # The CC for line 0 is special, holding counts attributed to the source + # file but not to any particular line (due to incomplete debug info). + # Annotate the start of the file with this info, if present. line0_cc = dict_line_cc.pop(0, None) + if line0_cc: + suffix = "<unknown (line 0)>" + printer.print_cc(line0_cc, suffix) + annotated_ccs.line_nums_unknown_cc += line0_cc + print() # Find interesting line ranges: all lines with a CC, and all lines within # `args.context` lines of a line with a CC. @@ -716,7 +754,7 @@ def print_annotated_src_file( break if line_nums and line_num == line_nums[0]: printer.print_cc(dict_line_cc[line_num], src_line[:-1]) - annotated_cc += dict_line_cc[line_num] + annotated_ccs.line_nums_known_cc += dict_line_cc[line_num] del line_nums[0] else: printer.print_missing_cc(src_line[:-1]) @@ -731,36 +769,40 @@ def print_annotated_src_file( if line_nums: for line_num in line_nums: printer.print_cc(dict_line_cc[line_num], f"<bogus line {line_num}>") + annotated_ccs.line_nums_known_cc += dict_line_cc[line_num] print() warn_bogus_lines(src_file.name) print() - # Print summary of counts attributed to the source file but not to any - # particular line (due to incomplete debug info). - if line0_cc: - suffix = f"<counts for unidentified lines in {src_file.name}>" - printer.print_cc(line0_cc, suffix) - print() - +# This (partially) consumes `dict_fl_dict_line_cc`. def print_annotated_src_files( events: Events, threshold_src_filenames: set[str], dict_fl_dict_line_cc: DictFlDictLineCc, summary_cc: Cc, -) -> tuple[list[str], Cc]: - unfound_auto_filenames: list[str] = [] - annotated_cc = events.mk_empty_cc() +) -> tuple[list[str], AnnotatedCcs]: + unreadable_auto_filenames: list[str] = [] + annotated_ccs = AnnotatedCcs(events) def pair_with(label: str) -> Callable[[str], tuple[str, str]]: return lambda s: (s, label) + def add_dict_line_cc_to_cc(dict_line_cc: DictLineCc | None, accum_cc: Cc) -> None: + if dict_line_cc: + for line_cc in dict_line_cc.values(): + accum_cc += line_cc + # If auto-annotating, add interesting files (excluding "???"). all_src_filenames = set(map(pair_with("User"), args.src_filenames)) if args.auto: threshold_src_filenames.discard("???") + + dict_line_cc = dict_fl_dict_line_cc.pop("???", None) + add_dict_line_cc_to_cc(dict_line_cc, annotated_ccs.files_unknown_cc) + all_src_filenames.update(map(pair_with("Auto"), threshold_src_filenames)) # Prepend "" to the include dirnames so things work in the case where the @@ -778,12 +820,14 @@ def print_annotated_src_files( try: with open(full_src_filename, "r", encoding="utf-8") as src_file: + # The pop will fail if it's a user-specified filename that + # isn't mentioned in the cgout file. print_annotated_src_file( events, - dict_fl_dict_line_cc[src_filename], + dict_fl_dict_line_cc.pop(src_filename, None), ann_type, src_file, - annotated_cc, + annotated_ccs, summary_cc, ) annotated = True @@ -792,32 +836,57 @@ def print_annotated_src_files( pass if not annotated: - unfound_auto_filenames.append(src_filename) + unreadable_auto_filenames.append(src_filename) + dict_line_cc = dict_fl_dict_line_cc.pop(src_filename, None) + add_dict_line_cc_to_cc(dict_line_cc, annotated_ccs.unreadable_cc) + + # Sum the CCs remaining in `dict_fl_dict_line_cc`, which are all in files + # below the threshold. + for dict_line_cc in dict_fl_dict_line_cc.values(): + add_dict_line_cc_to_cc(dict_line_cc, annotated_ccs.below_threshold_cc) - return (unfound_auto_filenames, annotated_cc) + return (unreadable_auto_filenames, annotated_ccs) -def print_unfound_auto_filenames(unfound_auto_filenames: list[str]) -> None: - if unfound_auto_filenames: +def print_unreadable_auto_filenames(unreadable_auto_filenames: list[str]) -> None: + if unreadable_auto_filenames: print(FANCY) - print("The following files chosen for auto-annotation could not be found:") + print("The following files chosen for auto-annotation could not be read:") print(FANCY) - for filename in sorted(unfound_auto_filenames): + for filename in sorted(unreadable_auto_filenames): print(" ", filename) print() -def print_annotated_cc(events: Events, annotated_cc: Cc, summary_cc: Cc) -> None: +def print_annotated_ccs( + events: Events, + annotated_ccs: AnnotatedCcs, + summary_cc: Cc, +) -> None: # If we did any annotating, show how many events were covered by annotated # lines above. if args.auto or args.src_filenames: - printer = CcPrinter(events, [annotated_cc], summary_cc) + printer = CcPrinter(events, annotated_ccs.ccs(), summary_cc) print(FANCY) printer.print_events("") print(FANCY) - printer.print_cc(annotated_cc, "events annotated") + + total_cc = events.mk_empty_cc() + for (cc, label) in zip(annotated_ccs.ccs(), AnnotatedCcs.labels): + printer.print_cc(cc, label) + total_cc += cc + print() + # Internal sanity check. + if summary_cc != total_cc: + msg = ( + "`summary:` line doesn't match computed annotated counts\n" + f"- summary: {summary_cc}\n" + f"- annotated: {total_cc}" + ) + die(msg) + def main() -> None: ( @@ -829,7 +898,7 @@ def main() -> None: summary_cc, ) = read_cgout_file() - # Each of these calls prints a section of the output. + # Each of the following calls prints a section of the output. print_header(desc, cmd, events) @@ -837,13 +906,13 @@ def main() -> None: threshold_src_filenames = print_flfn_ccs(events, dict_flfn_cc, summary_cc) - (unfound_auto_filenames, annotated_cc) = print_annotated_src_files( + (unreadable_auto_filenames, annotated_ccs) = print_annotated_src_files( events, threshold_src_filenames, dict_fl_dict_line_cc, summary_cc ) - print_unfound_auto_filenames(unfound_auto_filenames) + print_unreadable_auto_filenames(unreadable_auto_filenames) - print_annotated_cc(events, annotated_cc, summary_cc) + print_annotated_ccs(events, annotated_ccs, summary_cc) if __name__ == "__main__": diff --git a/cachegrind/tests/ann1.post.exp b/cachegrind/tests/ann1.post.exp index e946b0a743..e4c1d7c8d9 100644 --- a/cachegrind/tests/ann1.post.exp +++ b/cachegrind/tests/ann1.post.exp @@ -44,7 +44,7 @@ Ir I1mr ILmr 2 0 0 } -------------------------------------------------------------------------------- -The following files chosen for auto-annotation could not be found: +The following files chosen for auto-annotation could not be read: -------------------------------------------------------------------------------- /build/glibc-OTsEL5/glibc-2.27/elf/../sysdeps/x86_64/dl-machine.h /build/glibc-OTsEL5/glibc-2.27/elf/dl-lookup.c @@ -57,5 +57,9 @@ The following files chosen for auto-annotation could not be found: -------------------------------------------------------------------------------- Ir I1mr ILmr -------------------------------------------------------------------------------- -5,000,015 1 1 events annotated +5,000,015 1 1 annotated: files known & above threshold & readable, line numbers known + 0 0 0 annotated: files known & above threshold & readable, line numbers unknown + 179,512 136 134 unannotated: files known & above threshold & unreadable + 49,754 770 758 unannotated: files known & below threshold + 472 45 38 unannotated: files unknown diff --git a/cachegrind/tests/ann2.post.exp b/cachegrind/tests/ann2.post.exp index a4884e6152..98f083e912 100644 --- a/cachegrind/tests/ann2.post.exp +++ b/cachegrind/tests/ann2.post.exp @@ -41,7 +41,11 @@ Dw Dr Ir 0 2 (0.0%) 2 (0.0%) } -------------------------------------------------------------------------------- -Dw Dr Ir +Dw Dr Ir -------------------------------------------------------------------------------- - 3 (0.0%) 4,000,004 (98.6%) 5,000,015 (95.6%) events annotated + 3 (0.0%) 4,000,004 (98.6%) 5,000,015 (95.6%) annotated: files known & above threshold & readable, line numbers known + 0 0 0 annotated: files known & above threshold & readable, line numbers unknown + 0 0 0 unannotated: files known & above threshold & unreadable +18,002 (100.0%) 57,951 (1.4%) 229,738 (4.4%) unannotated: files known & below threshold + 0 0 0 unannotated: files unknown diff --git a/cachegrind/tests/ann3.post.exp b/cachegrind/tests/ann3.post.exp index a5520b5af3..2b86957bc1 100644 --- a/cachegrind/tests/ann3.post.exp +++ b/cachegrind/tests/ann3.post.exp @@ -20,7 +20,7 @@ A SomeCount VeryLongEventName -------------------------------------------------------------------------------- A SomeCount VeryLongEventName file:function -------------------------------------------------------------------------------- -70,491 (70.5%) 90,491 (90.5%) 0 ann3-basic.rs:f0 +70,091 (70.1%) 90,291 (90.3%) 0 ann3-basic.rs:f0 15,000 (15.0%) 600 (0.6%) 0 ann3-basic.rs:f1 9,000 (9.0%) 6,000 (6.0%) 0 ann3-could-not-be-found.rs:f1 2,000 (2.0%) 100 (0.1%) 0 ann3-basic.rs:f2 @@ -38,13 +38,15 @@ A SomeCount VeryLongEventName file:function -------------------------------------------------------------------------------- A SomeCount VeryLongEventName + 7,100 (7.1%) 100 (0.1%) 0 <unknown (line 0)> + -- line 2 ---------------------------------------- . . . two . . . three 5,000 (5.0%) 500 (0.5%) 0 four 5,000 (5.0%) 100 (0.1%) 0 five . . . six -70,491 (70.5%) 90,491 (90.5%) 0 seven +70,091 (70.1%) 90,291 (90.3%) 0 seven . . . eight 110 (0.1%) 9 (0.0%) 0 nine . . . ten @@ -59,8 +61,6 @@ A SomeCount VeryLongEventName 499 (0.5%) 2,000 (2.0%) 0 nineteen 300 (0.3%) 0 0 twenty - 7,100 (7.1%) 100 (0.1%) 0 <counts for unidentified lines in ann3-basic.rs> - -------------------------------------------------------------------------------- -- Auto-annotated source: ann3-more-recent-than-cgout.rs -------------------------------------------------------------------------------- @@ -84,6 +84,8 @@ A SomeCount VeryLongEventName -------------------------------------------------------------------------------- A SomeCount VeryLongEventName + -2,000 (-2.0%) -1,000 (-1.0%) -990 (n/a) <unknown (line 0)> + 2,000 (2.0%) 2,000 (2.0%) 2,000 (n/a) one -1,000 (-1.0%) -1,000 (-1.0%) 0 two . . . three @@ -99,8 +101,6 @@ A SomeCount VeryLongEventName . . . thirteen -- line 13 ---------------------------------------- - -2,000 (-2.0%) -1,000 (-1.0%) -990 (n/a) <counts for unidentified lines in ann3-negatives.rs> - -------------------------------------------------------------------------------- -- Auto-annotated source: ann3-past-the-end.rs -------------------------------------------------------------------------------- @@ -134,7 +134,7 @@ A SomeCount VeryLongEventName 1,000 (1.0%) 500 (0.5%) 0 one -------------------------------------------------------------------------------- -The following files chosen for auto-annotation could not be found: +The following files chosen for auto-annotation could not be read: -------------------------------------------------------------------------------- ann3-could-not-be-found.rs ann3-no-such-file.rs @@ -142,5 +142,9 @@ The following files chosen for auto-annotation could not be found: -------------------------------------------------------------------------------- A SomeCount VeryLongEventName -------------------------------------------------------------------------------- -84,100 (84.1%) 94,700 (94.7%) 1,990 (n/a) events annotated +84,500 (84.5%) 94,700 (94.7%) 990 (n/a) annotated: files known & above threshold & readable, line numbers known + 5,100 (5.1%) -900 (-0.9%) -990 (n/a) annotated: files known & above threshold & readable, line numbers unknown + 9,000 (9.0%) 6,000 (6.0%) 0 unannotated: files known & above threshold & unreadable + 400 (0.4%) 200 (0.2%) 0 unannotated: files known & below threshold + 1,000 (1.0%) 0 0 unannotated: files unknown diff --git a/cachegrind/tests/cgout-test3 b/cachegrind/tests/cgout-test3 index d8023eef1d..600ae9b317 100644 --- a/cachegrind/tests/cgout-test3 +++ b/cachegrind/tests/cgout-test3 @@ -5,7 +5,7 @@ events: A SomeCount VeryLongEventName fl=ann3-basic.rs # This one has the counts to get the totals to 100,000/100,000/0. fn=f0 -7 70491 90491 0 +7 70091 90291 0 fn=f1 # Different whitespace. Mix of line 0 and other lines. 0 5000 0 0 @@ -85,6 +85,16 @@ fl=ann3-via-I.rs fn=f1 1 1000 500 0 +# File below the threshold. (It also doesn't exist, but that doesn't matter. We +# don't try to open it because it's below the threshold.) +fl=ann3-below-threshold.rs +fn=below1 +1 100 50 0 +2 100 50 0 +fn=below2 +5 100 50 0 +6 100 50 0 + # Unknown file fl=??? fn=unknown diff --git a/cachegrind/tests/diff.post.exp b/cachegrind/tests/diff.post.exp index 7d3b8aeeee..ed95860ddf 100644 --- a/cachegrind/tests/diff.post.exp +++ b/cachegrind/tests/diff.post.exp @@ -25,11 +25,15 @@ Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw file:fu -------------------------------------------------------------------------------- Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw +5,000,000 (100.0%) 0 0 -2,000,000 (100.0%) 0 0 0 0 0 <unknown (line 0)> -5,000,000 (100.0%) 0 0 -2,000,000 (100.0%) 0 0 0 0 0 <counts for unidentified lines in a.c> -------------------------------------------------------------------------------- -Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw +Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw -------------------------------------------------------------------------------- - 0 0 0 0 0 0 0 0 0 events annotated + 0 0 0 0 0 0 0 0 0 annotated: files known & above threshold & readable, line numbers known +5,000,000 (100.0%) 0 0 -2,000,000 (100.0%) 0 0 0 0 0 annotated: files known & above threshold & readable, line numbers unknown + 0 0 0 0 0 0 0 0 0 unannotated: files known & above threshold & unreadable + 0 0 0 0 0 0 0 0 0 unannotated: files known & below threshold + 0 0 0 0 0 0 0 0 0 unannotated: files unknown |
|
From: Nicholas N. <n.n...@gm...> - 2023-03-23 10:51:44
|
On Thu, 23 Mar 2023 at 20:15, Mark Wielaard <ma...@kl...> wrote: > > Modulo using github these sound like interesting ideas. Forcing this > workflow might be a bit heavy weight. But we could use sourceware > try-branches so all commits go through the CI builders. Requiring all > passing builds will be a bit of a puzzle since out testsuite(s) aren't > zero-fail. > I threw a lot of ideas out in my earlier email, but this is the most important one. Graydon Hoare expressed <https://graydon2.dreamwidth.org/1597.html> this years ago as: *The Not Rocket Science Rule Of Software Engineering:* > automatically maintain a repository of code that always passes all the > tests > This requires that all the tests pass before merging a change. Having worked on projects that follow this and projects that don't, I say with confidence that it's a good idea. If we could get that happening for Valgrind, that alone would be a huge improvement over the status quo. I looked at the sites you linked, but couldn't work out much about how they work. W.r.t. failing tests, this would give great incentive to fix currently failing tests (or disable them if they cannot be made reliable) and to keep them passing. Sourceware builder could help with that, we can setup a CI bot that > runs such a formatter over all commits to check formatting. I have > seen that work very nicely with the python black formatter. But for C > code/clang-format it seems the formatter seems not that good/stable. > Mozilla's been using clang-format for Firefox C and C++ code for several years. Nick |
|
From: Mark W. <ma...@kl...> - 2023-03-23 09:15:18
|
Hi Nick, On Thu, Mar 23, 2023 at 10:08:51AM +1100, Nicholas Nethercote wrote: > All the Rust projects I work on use GitHub, and in terms of usability and > productivity it's miles ahead of how Valgrind development works. I think github is unacceptable for Free Software projects, which I believe should use free software tools and not a corporate controlled proprietary platform: https://mako.cc/writing/hill-free_tools.html https://giveupgithub.com/ But that doesn't mean I don't agree with you. There are some really nice concepts in these "code forges". And there are free software implementations like https://codeberg.org/ https://docs.pagure.org/pagure/ https://sourcehut.org/ and (self managed) gitlab ce. valgrind already has an official mirror on sourcehut (like all other sourceware projects): https://sr.ht/~sourceware/valgrind/ > If I were king of the world here's how I would drag Valgrind's development > practices forward by 10-20 years. > > - Move the repository to GitHub. Require all changes to be done via pull > requests, with no direct pushing. > - Set up some CI testing via GitHub Actions. Require that all pull > requests pass these tests before merging. > - Lots of projects require a review approval before a pull request can > be merged. But that might be too hard for Valgrind to start with, given the > small number of active contributors. Modulo using github these sound like interesting ideas. Forcing this workflow might be a bit heavy weight. But we could use sourceware try-branches so all commits go through the CI builders. Requiring all passing builds will be a bit of a puzzle since out testsuite(s) aren't zero-fail. > - Switch from KDE bugzilla to GitHub issues for bug reporting. Not sure > what I'd do with existing open bug reports, whether it would be worth > importing them to GitHub issues somehow or not. I would consider moving to sourceware bugzilla, which would make it easier to connect commits/patches with issues. The downside is that all bugs get renumbered. What benefit do you see from GitHub issues over bugzilla? > - Use auto-formatting tools, such as clang-format. (Possibly even moving > from 3 space indents in C code to 2 or 4!) Sourceware builder could help with that, we can setup a CI bot that runs such a formatter over all commits to check formatting. I have seen that work very nicely with the python black formatter. But for C code/clang-format it seems the formatter seems not that good/stable. > - Change the docs from that XML-based thing we use (groan) to something > nicer, probably involving Markdown. Not against, but a lot of work. And with the make check xml linter checks writing new docs has become a lot nicer. We should however setup a buildbot to always create the docs on each commit. > - Website: not sure... a lot of it could be naturally hosted on the main > GitHub page. It might be nice to still have valgrind.org, though, but > perhaps greatly stripped back. What would you propose? The website is in git now, but uses php for a few things. https://sourceware.org/cgit/valgrind-htdocs we could drop the php and replace it with a more simpler markdown based site? Cheers, Mark |
|
From: Nicholas N. <n.n...@gm...> - 2023-03-23 08:51:15
|
Nice, I wasn't aware of any of those facilities. Are they documented anywhere, both their existence and how to use them? I couldn't find anything on valgrind.org about them, but maybe I overlooked something. Nick On Thu, 23 Mar 2023 at 19:45, Mark Wielaard <ma...@kl...> wrote: > Hi Nick, > > On Thu, Mar 23, 2023 at 07:31:47AM +1100, Nicholas Nethercote wrote: > > Thanks to Paul and Mark for a couple of small fixes to my commit. > > Thank you for the big fixes/rewrite! > > > Yesterday I was idly dreaming about the quality-of-life improvements that > > would be available if Valgrind was hosted on GitHub: > > - ability to upload commits ahead of time, in a fashion nicer than > "attach > > patch to bugzilla" > > - ability to do reviews > > - CI support for pre-merge testing runs > > - easier entry for newcomers > > > > Does sourceware.org have support for any of these things? > > Yes, sourceware offers patchwork.sourceware.org (in combination with > public-inbox support) which can be used for patch tracking and can be > configured to do pre-commit CI. And through builder.sourceware.org you > can do builds for "try branches". > > Note that valgrind already is using the sourceware CI for arm64, > armhf, i386, ppc64, ppc64le, power10, power9, x86_64 on some gnu/linux > distros: > https://builder.sourceware.org/buildbot/#/builders?tags=valgrind > > And there are of course the nightly builders which report to > valgrind-testresults: > https://sourceforge.net/p/valgrind/mailman/valgrind-testresults/ > > We have been pondering moving bugzilla and the mailinglists to > sourceware so we can have better integration (for example to > automatically link bugs, patches and commits). But weren't sure those > improvements were enough to "break" old links/habits. > > Cheers, > > Mark > |
|
From: Mark W. <ma...@kl...> - 2023-03-23 08:45:25
|
Hi Nick, On Thu, Mar 23, 2023 at 07:31:47AM +1100, Nicholas Nethercote wrote: > Thanks to Paul and Mark for a couple of small fixes to my commit. Thank you for the big fixes/rewrite! > Yesterday I was idly dreaming about the quality-of-life improvements that > would be available if Valgrind was hosted on GitHub: > - ability to upload commits ahead of time, in a fashion nicer than "attach > patch to bugzilla" > - ability to do reviews > - CI support for pre-merge testing runs > - easier entry for newcomers > > Does sourceware.org have support for any of these things? Yes, sourceware offers patchwork.sourceware.org (in combination with public-inbox support) which can be used for patch tracking and can be configured to do pre-commit CI. And through builder.sourceware.org you can do builds for "try branches". Note that valgrind already is using the sourceware CI for arm64, armhf, i386, ppc64, ppc64le, power10, power9, x86_64 on some gnu/linux distros: https://builder.sourceware.org/buildbot/#/builders?tags=valgrind And there are of course the nightly builders which report to valgrind-testresults: https://sourceforge.net/p/valgrind/mailman/valgrind-testresults/ We have been pondering moving bugzilla and the mailinglists to sourceware so we can have better integration (for example to automatically link bugs, patches and commits). But weren't sure those improvements were enough to "break" old links/habits. Cheers, Mark |
|
From: Nicholas N. <nj...@so...> - 2023-03-23 08:15:25
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=3f8494c8a4aaeb0176c38d22bb52ba221930454d commit 3f8494c8a4aaeb0176c38d22bb52ba221930454d Author: Nicholas Nethercote <n.n...@gm...> Date: Tue Mar 21 11:04:25 2023 +1100 Just use one decimal place for all percentages. Simpler, shorter, and good enough in practice. Diff: --- cachegrind/cg_annotate.in | 7 +-- cachegrind/tests/ann2.post.exp | 36 +++++------ cachegrind/tests/ann3.post.exp | 136 ++++++++++++++++++++--------------------- 3 files changed, 87 insertions(+), 92 deletions(-) diff --git a/cachegrind/cg_annotate.in b/cachegrind/cg_annotate.in index e7d094b50d..ac2f2b792a 100755 --- a/cachegrind/cg_annotate.in +++ b/cachegrind/cg_annotate.in @@ -528,12 +528,7 @@ class CcPrinter: perc = " (n/a)" else: p = cc.counts[i] * 100 / summary_count - # Use just one decimal place for large percentages. - if abs(p) < 100: - w = 2 - else: - w = 1 - perc = f" ({p:.{w}f}%)" + perc = f" ({p:.1f}%)" else: perc = "" diff --git a/cachegrind/tests/ann2.post.exp b/cachegrind/tests/ann2.post.exp index 8d33c9e79a..4428346813 100644 --- a/cachegrind/tests/ann2.post.exp +++ b/cachegrind/tests/ann2.post.exp @@ -18,30 +18,30 @@ Dw Dr Ir 18,005 (100.0%) 4,057,955 (100.0%) 5,229,753 (100.0%) PROGRAM TOTALS -------------------------------------------------------------------------------- -Dw Dr Ir file:function --------------------------------------------------------------------------------- - 3 (0.02%) 4,000,004 (98.57%) 5,000,015 (95.61%) a.c:main -4,543 (25.23%) 17,566 (0.43%) 47,993 (0.92%) /build/glibc-OTsEL5/glibc-2.27/elf/dl-lookup.c:do_lookup_x -3,083 (17.12%) 5,750 (0.14%) 28,534 (0.55%) /build/glibc-OTsEL5/glibc-2.27/elf/dl-lookup.c:_dl_lookup_symbol_x - 8 (0.04%) 5,521 (0.14%) 28,136 (0.54%) /build/glibc-OTsEL5/glibc-2.27/elf/dl-tunables.c:__GI___tunables_init -2,490 (13.83%) 5,219 (0.13%) 21,821 (0.42%) /build/glibc-OTsEL5/glibc-2.27/elf/../sysdeps/x86_64/dl-machine.h:_dl_relocate_object - 0 5,158 (0.13%) 25,408 (0.49%) /build/glibc-OTsEL5/glibc-2.27/string/../sysdeps/x86_64/strcmp.S:strcmp +Dw Dr Ir file:function +-------------------------------------------------------------------------------- + 3 (0.0%) 4,000,004 (98.6%) 5,000,015 (95.6%) a.c:main +4,543 (25.2%) 17,566 (0.4%) 47,993 (0.9%) /build/glibc-OTsEL5/glibc-2.27/elf/dl-lookup.c:do_lookup_x +3,083 (17.1%) 5,750 (0.1%) 28,534 (0.5%) /build/glibc-OTsEL5/glibc-2.27/elf/dl-lookup.c:_dl_lookup_symbol_x + 8 (0.0%) 5,521 (0.1%) 28,136 (0.5%) /build/glibc-OTsEL5/glibc-2.27/elf/dl-tunables.c:__GI___tunables_init +2,490 (13.8%) 5,219 (0.1%) 21,821 (0.4%) /build/glibc-OTsEL5/glibc-2.27/elf/../sysdeps/x86_64/dl-machine.h:_dl_relocate_object + 0 5,158 (0.1%) 25,408 (0.5%) /build/glibc-OTsEL5/glibc-2.27/string/../sysdeps/x86_64/strcmp.S:strcmp -------------------------------------------------------------------------------- -- User-annotated source: a.c -------------------------------------------------------------------------------- -Dw Dr Ir +Dw Dr Ir - 1 (0.01%) 0 2 (0.00%) int main(void) { - 1 (0.01%) 0 1 (0.00%) int z = 0; - 1 (0.01%) 2,000,001 (49.29%) 3,000,004 (57.36%) for (int i = 0; i < 1000000; i++) { - 0 2,000,000 (49.29%) 2,000,000 (38.24%) z += i; - . . . } - 0 1 (0.00%) 6 (0.00%) return z % 256; - 0 2 (0.00%) 2 (0.00%) } + 1 (0.0%) 0 2 (0.0%) int main(void) { + 1 (0.0%) 0 1 (0.0%) int z = 0; + 1 (0.0%) 2,000,001 (49.3%) 3,000,004 (57.4%) for (int i = 0; i < 1000000; i++) { + 0 2,000,000 (49.3%) 2,000,000 (38.2%) z += i; + . . . } + 0 1 (0.0%) 6 (0.0%) return z % 256; + 0 2 (0.0%) 2 (0.0%) } -------------------------------------------------------------------------------- -Dw Dr Ir +Dw Dr Ir -------------------------------------------------------------------------------- - 3 (0.02%) 4,000,004 (98.57%) 5,000,015 (95.61%) events annotated + 3 (0.0%) 4,000,004 (98.6%) 5,000,015 (95.6%) events annotated diff --git a/cachegrind/tests/ann3.post.exp b/cachegrind/tests/ann3.post.exp index 52c5b87503..063715aa6f 100644 --- a/cachegrind/tests/ann3.post.exp +++ b/cachegrind/tests/ann3.post.exp @@ -18,48 +18,48 @@ A SomeCount VeryLongEventName 100,000 (100.0%) 100,000 (100.0%) 0 PROGRAM TOTALS -------------------------------------------------------------------------------- -A SomeCount VeryLongEventName file:function --------------------------------------------------------------------------------- -70,491 (70.49%) 90,491 (90.49%) 0 ann3-basic.rs:f0 -15,000 (15.00%) 600 (0.60%) 0 ann3-basic.rs:f1 - 9,000 (9.00%) 6,000 (6.00%) 0 ann3-could-not-be-found.rs:f1 - 2,000 (2.00%) 100 (0.10%) 0 ann3-basic.rs:f2 - 1,000 (1.00%) 500 (0.50%) 0 ann3-via-I.rs:f1 - 1,000 (1.00%) 300 (0.30%) -1,000 (n/a) ann3-past-the-end.rs:f1 --1,000 (-1.00%) 0 0 ann3-negatives.rs:neg3 --1,000 (-1.00%) 0 0 ann3-negatives.rs:neg2 - 1,000 (1.00%) 0 0 ann3-more-recent-than-cgout.rs:new - 1,000 (1.00%) 0 0 ???:unknown - 500 (0.50%) 0 0 ann3-basic.rs:f6 - 500 (0.50%) 0 0 ann3-basic.rs:f4 +A SomeCount VeryLongEventName file:function +-------------------------------------------------------------------------------- +70,491 (70.5%) 90,491 (90.5%) 0 ann3-basic.rs:f0 +15,000 (15.0%) 600 (0.6%) 0 ann3-basic.rs:f1 + 9,000 (9.0%) 6,000 (6.0%) 0 ann3-could-not-be-found.rs:f1 + 2,000 (2.0%) 100 (0.1%) 0 ann3-basic.rs:f2 + 1,000 (1.0%) 500 (0.5%) 0 ann3-via-I.rs:f1 + 1,000 (1.0%) 300 (0.3%) -1,000 (n/a) ann3-past-the-end.rs:f1 +-1,000 (-1.0%) 0 0 ann3-negatives.rs:neg3 +-1,000 (-1.0%) 0 0 ann3-negatives.rs:neg2 + 1,000 (1.0%) 0 0 ann3-more-recent-than-cgout.rs:new + 1,000 (1.0%) 0 0 ???:unknown + 500 (0.5%) 0 0 ann3-basic.rs:f6 + 500 (0.5%) 0 0 ann3-basic.rs:f4 -------------------------------------------------------------------------------- -- Auto-annotated source: ann3-basic.rs -------------------------------------------------------------------------------- -A SomeCount VeryLongEventName +A SomeCount VeryLongEventName -- line 2 ---------------------------------------- - . . . two - . . . three - 5,000 (5.00%) 500 (0.50%) 0 four - 5,000 (5.00%) 100 (0.10%) 0 five - . . . six -70,491 (70.49%) 90,491 (90.49%) 0 seven - . . . eight - 110 (0.11%) 9 (0.01%) 0 nine - . . . ten - . . . eleven - 200 (0.20%) 0 0 twelve - 200 (0.20%) 0 0 thirteen - 100 (0.10%) 0 0 fourteen - 0 0 0 fifteen - 0 0 0 sixteen - 0 0 0 seventeen - 0 0 0 eighteen - 499 (0.50%) 2,000 (2.00%) 0 nineteen - 300 (0.30%) 0 0 twenty - - 7,100 (7.10%) 100 (0.10%) 0 <counts for unidentified lines in ann3-basic.rs> + . . . two + . . . three + 5,000 (5.0%) 500 (0.5%) 0 four + 5,000 (5.0%) 100 (0.1%) 0 five + . . . six +70,491 (70.5%) 90,491 (90.5%) 0 seven + . . . eight + 110 (0.1%) 9 (0.0%) 0 nine + . . . ten + . . . eleven + 200 (0.2%) 0 0 twelve + 200 (0.2%) 0 0 thirteen + 100 (0.1%) 0 0 fourteen + 0 0 0 fifteen + 0 0 0 sixteen + 0 0 0 seventeen + 0 0 0 eighteen + 499 (0.5%) 2,000 (2.0%) 0 nineteen + 300 (0.3%) 0 0 twenty + + 7,100 (7.1%) 100 (0.1%) 0 <counts for unidentified lines in ann3-basic.rs> -------------------------------------------------------------------------------- -- Auto-annotated source: ann3-more-recent-than-cgout.rs @@ -71,49 +71,49 @@ A SomeCount VeryLongEventName @ Annotations may not be correct. @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ -A SomeCount VeryLongEventName +A SomeCount VeryLongEventName - . . . one -1,000 (1.00%) 0 0 two - . . . three - . . . four + . . . one +1,000 (1.0%) 0 0 two + . . . three + . . . four -- line 4 ---------------------------------------- -------------------------------------------------------------------------------- -- Auto-annotated source: ann3-negatives.rs -------------------------------------------------------------------------------- -A SomeCount VeryLongEventName - - 2,000 (2.00%) 2,000 (2.00%) 2,000 (n/a) one - -1,000 (-1.00%) -1,000 (-1.00%) 0 two - . . . three - . . . four - 999,000 (999.0%) 0 -150,000 (n/a) five --1,000,000 (-1000.0%) 0 150,000 (n/a) six - . . . seven - . . . eight - . . . nine - -10,000 (-10.00%) 0 10 (n/a) ten - 10,000 (10.00%) 0 -20 (n/a) eleven - . . . twelve - . . . thirteen +A SomeCount VeryLongEventName + + 2,000 (2.0%) 2,000 (2.0%) 2,000 (n/a) one + -1,000 (-1.0%) -1,000 (-1.0%) 0 two + . . . three + . . . four + 999,000 (999.0%) 0 -150,000 (n/a) five +-1,000,000 (-1000.0%) 0 150,000 (n/a) six + . . . seven + . . . eight + . . . nine + -10,000 (-10.0%) 0 10 (n/a) ten + 10,000 (10.0%) 0 -20 (n/a) eleven + . . . twelve + . . . thirteen -- line 13 ---------------------------------------- - -2,000 (-2.00%) -1,000 (-1.00%) -990 (n/a) <counts for unidentified lines in ann3-negatives.rs> + -2,000 (-2.0%) -1,000 (-1.0%) -990 (n/a) <counts for unidentified lines in ann3-negatives.rs> -------------------------------------------------------------------------------- -- Auto-annotated source: ann3-past-the-end.rs -------------------------------------------------------------------------------- -A SomeCount VeryLongEventName +A SomeCount VeryLongEventName -200 (0.20%) 100 (0.10%) 0 one - . . . two - . . . three +200 (0.2%) 100 (0.1%) 0 one + . . . two + . . . three -- line 3 ---------------------------------------- -- line 18 ---------------------------------------- -300 (0.30%) 100 (0.10%) 0 <bogus line 20> -300 (0.30%) 100 (0.10%) 0 <bogus line 21> -200 (0.20%) 0 -1,000 (n/a) <bogus line 22> +300 (0.3%) 100 (0.1%) 0 <bogus line 20> +300 (0.3%) 100 (0.1%) 0 <bogus line 21> +200 (0.2%) 0 -1,000 (n/a) <bogus line 22> @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ @@ -129,9 +129,9 @@ A SomeCount VeryLongEventName -------------------------------------------------------------------------------- -- Auto-annotated source: ann3-aux/ann3-via-I.rs -------------------------------------------------------------------------------- -A SomeCount VeryLongEventName +A SomeCount VeryLongEventName -1,000 (1.00%) 500 (0.50%) 0 one +1,000 (1.0%) 500 (0.5%) 0 one -------------------------------------------------------------------------------- The following files chosen for auto-annotation could not be found: @@ -140,7 +140,7 @@ The following files chosen for auto-annotation could not be found: ann3-no-such-file.rs -------------------------------------------------------------------------------- -A SomeCount VeryLongEventName +A SomeCount VeryLongEventName -------------------------------------------------------------------------------- -84,100 (84.10%) 94,700 (94.70%) 1,990 (n/a) events annotated +84,100 (84.1%) 94,700 (94.7%) 1,990 (n/a) events annotated |
|
From: Nicholas N. <nj...@so...> - 2023-03-23 08:15:24
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=05d01cd6817613331b35955c84b23757e27db392 commit 05d01cd6817613331b35955c84b23757e27db392 Author: Nicholas Nethercote <n.n...@gm...> Date: Tue Mar 21 11:58:36 2023 +1100 Change `Threshold:` to `Thresholds:`. Because all the thresholds other than the first one were always 100, due to historical reasons. Diff: --- cachegrind/cg_annotate.in | 17 ++--------------- cachegrind/tests/ann1.post.exp | 2 +- cachegrind/tests/ann2.post.exp | 2 +- cachegrind/tests/ann3.post.exp | 2 +- cachegrind/tests/diff.post.exp | 2 +- 5 files changed, 6 insertions(+), 19 deletions(-) diff --git a/cachegrind/cg_annotate.in b/cachegrind/cg_annotate.in index ac2f2b792a..48bf4f1aab 100755 --- a/cachegrind/cg_annotate.in +++ b/cachegrind/cg_annotate.in @@ -233,12 +233,6 @@ class Events: # Like `sort_events`, but indices into `events`, rather than names. sort_indices: list[int] - # Threshold percentages, one per sort event. Dictates when we stop printing - # functions. Positions correspond to positions in `sort_events`. Only - # `thresholds[0]` is actually used for thresholding, for historical - # reasons. - threshold_percs: list[float] - def __init__(self, text: str) -> None: self.events = text.split() self.num_events = len(self.events) @@ -269,11 +263,6 @@ class Events: self.sort_indices = [event_indices[event] for event in self.sort_events] - # The primary sort event gets the --threshold value, and all other sort - # events get 100% (i.e. ignored). - self.threshold_percs = [100] * len(self.sort_events) - self.threshold_percs[0] = args.threshold - def mk_cc(self, text: str) -> Cc: # This is slightly faster than a list comprehension. counts = list(map(int, text.split())) @@ -561,7 +550,7 @@ def print_header(desc: str, cmd: str, events: Events) -> None: print("Events recorded: ", *events.events) print("Events shown: ", *events.show_events) print("Event sort order:", *events.sort_events) - print("Thresholds: ", *events.threshold_percs) + print("Threshold: ", args.threshold) if len(args.include) == 0: print("Include dirs: ") @@ -598,9 +587,7 @@ def print_flfn_ccs( threshold_index = events.sort_indices[0] # Convert the threshold from a percentage to an event count. - threshold = ( - events.threshold_percs[0] * abs(summary_cc.counts[threshold_index]) / 100 - ) + threshold = args.threshold * abs(summary_cc.counts[threshold_index]) / 100 def meets_threshold(flfn_and_cc: tuple[Flfn, Cc]) -> bool: cc = flfn_and_cc[1] diff --git a/cachegrind/tests/ann1.post.exp b/cachegrind/tests/ann1.post.exp index 10196377a7..e946b0a743 100644 --- a/cachegrind/tests/ann1.post.exp +++ b/cachegrind/tests/ann1.post.exp @@ -7,7 +7,7 @@ Data file: cgout-test Events recorded: Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw Events shown: Ir I1mr ILmr Event sort order: Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw -Thresholds: 0.1 100 100 100 100 100 100 100 100 +Threshold: 0.1 Include dirs: User annotated: Auto-annotation: on diff --git a/cachegrind/tests/ann2.post.exp b/cachegrind/tests/ann2.post.exp index 4428346813..a4884e6152 100644 --- a/cachegrind/tests/ann2.post.exp +++ b/cachegrind/tests/ann2.post.exp @@ -7,7 +7,7 @@ Data file: cgout-test Events recorded: Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw Events shown: Dw Dr Ir Event sort order: Dr -Thresholds: 0.1 +Threshold: 0.1 Include dirs: User annotated: a.c Auto-annotation: off diff --git a/cachegrind/tests/ann3.post.exp b/cachegrind/tests/ann3.post.exp index 063715aa6f..a5520b5af3 100644 --- a/cachegrind/tests/ann3.post.exp +++ b/cachegrind/tests/ann3.post.exp @@ -4,7 +4,7 @@ Data file: cgout-test3 Events recorded: A SomeCount VeryLongEventName Events shown: A SomeCount VeryLongEventName Event sort order: A SomeCount VeryLongEventName -Thresholds: 0.5 100 100 +Threshold: 0.5 Include dirs: ann3-no-such-dir ann3-no-such-dir-2 ann3-aux diff --git a/cachegrind/tests/diff.post.exp b/cachegrind/tests/diff.post.exp index 81fbe3e920..7d3b8aeeee 100644 --- a/cachegrind/tests/diff.post.exp +++ b/cachegrind/tests/diff.post.exp @@ -5,7 +5,7 @@ Data file: cgout-diff Events recorded: Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw Events shown: Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw Event sort order: Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw -Thresholds: 0.1 100 100 100 100 100 100 100 100 +Threshold: 0.1 Include dirs: User annotated: Auto-annotation: on |
|
From: Nicholas N. <nj...@so...> - 2023-03-23 08:15:21
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=b8a90ee9682b5dbed81d4dd8ee2d7bc3b77eb906 commit b8a90ee9682b5dbed81d4dd8ee2d7bc3b77eb906 Author: Nicholas Nethercote <n.n...@gm...> Date: Mon Mar 20 13:58:04 2023 +1100 Improve formatting of percentage columns. Currently their width is mostly hard-wired in a quick and dirty fashion. This commit does them properly, so: - all columns are always the right width, even ones with really large percentages - things like `( 1.00%)` are now `(1.00%)` - any percentages that would involve a division by zero now show as `(n/a)` rather than `( 0.00%)` Diff: --- cachegrind/cg_annotate.in | 99 +++++++++++++++------------- cachegrind/tests/ann2.post.exp | 28 ++++---- cachegrind/tests/ann3.post.exp | 144 ++++++++++++++++++++--------------------- cachegrind/tests/cgout-test3 | 2 +- cachegrind/tests/diff.post.exp | 16 ++--- 5 files changed, 148 insertions(+), 141 deletions(-) diff --git a/cachegrind/cg_annotate.in b/cachegrind/cg_annotate.in index 20969f0f92..e7d094b50d 100755 --- a/cachegrind/cg_annotate.in +++ b/cachegrind/cg_annotate.in @@ -456,10 +456,6 @@ def read_cgout_file() -> tuple[str, str, Events, DictFlfnCc, DictFlDictLineCc, C return (desc, cmd, events, dict_flfn_cc, dict_fl_dict_line_cc, summary_cc) -def safe_perc(m: int, n: int) -> float: - return 0 if n == 0 else m * 100 / n - - class CcPrinter: # Note: every `CcPrinter` gets the same `Events` object. events: Events @@ -467,9 +463,14 @@ class CcPrinter: # Note: every `CcPrinter` gets the same summary CC. summary_cc: Cc - # The width of each event column. For simplicity, its length matches - # `events.events`, even though not all events are necessarily shown. - widths: list[int] + # The width of each event count column. (This column is also used for event + # names.) For simplicity, its length matches `events.events`, even though + # not all events are necessarily shown. + count_widths: list[int] + + # The width of each percentage column. Zero if --show-percs is disabled. + # Its length matches `count_widths`. + perc_widths: list[int] def __init__(self, events: Events, ccs: list[Cc], summary_cc: Cc) -> None: self.events = events @@ -488,61 +489,67 @@ class CcPrinter: min_cc.counts[i] = count # Find maximum width for each column. - self.widths = [0] * len(events.events) + self.count_widths = [0] * len(events.events) + self.perc_widths = [0] * len(events.events) for i, event in enumerate(events.events): - # Get widest of the min and max, accounting for commas that will be - # added, and a possible percentage. - width = max(len(str(min_cc.counts[i])), len(str(max_cc.counts[i]))) - width += (width - 1) // 3 - if args.show_percs: - width += 9 # e.g. " (12.34%)" is 9 chars. + # Get count and perc widths of the min and max CCs. + (min_count, min_perc) = self.count_and_perc(min_cc, i) + (max_count, max_perc) = self.count_and_perc(max_cc, i) - # Account for the event name, too. - self.widths[i] = max(width, len(event)) + # The event name goes in the count column. + self.count_widths[i] = max(len(min_count), len(max_count), len(event)) + self.perc_widths[i] = max(len(min_perc), len(max_perc)) def print_events(self, suffix: str) -> None: for i in self.events.show_indices: - # +1 is for the single space between columns. - print(f"{self.events.events[i]:{self.widths[i] + 1}}", end="") + # The event name goes in the count column. + event = self.events.events[i] + nwidth = self.count_widths[i] + pwidth = self.perc_widths[i] + empty_perc = "" + print(f"{event:<{nwidth}}{empty_perc:>{pwidth}} ", end="") print(suffix) - def print_count(self, i: int, text: str) -> None: - print(f"{text:>{self.widths[i]}}", end=" ") + def print_count_and_perc(self, i: int, count: str, perc: str) -> None: + nwidth = self.count_widths[i] + pwidth = self.perc_widths[i] + print(f"{count:>{nwidth}}{perc:>{pwidth}} ", end="") - def print_cc(self, cc: Cc, suffix: str) -> None: - for i in self.events.show_indices: - nstr = f"{cc.counts[i]:,d}" # commify - if args.show_percs: - if cc.counts[i] != 0: - # Try our best to keep the number fitting into 5 chars. This - # requires dropping a digit after the decimal place if it's - # sufficiently negative (e.g. "-10.0") or positive (e.g. - # "100.0"). Thanks to diffs it's possible to have even more - # extreme values, like "-100.0" or "1000.0"; those rare case - # will end up with slightly wrong indenting, oh well. - p = safe_perc(cc.counts[i], self.summary_cc.counts[i]) - normal = -9.995 < p < 99.995 - perc = f" ({p:5.{2 if normal else 1}f}%)" - else: - # Don't show percentages for "0" entries, it's just clutter. - perc = " " - else: + def count_and_perc(self, cc: Cc, i: int) -> tuple[str, str]: + count = f"{cc.counts[i]:,d}" # commify + if args.show_percs: + if cc.counts[i] == 0: + # Don't show percentages for "0" entries, it's just clutter. perc = "" + else: + summary_count = self.summary_cc.counts[i] + if summary_count == 0: + perc = " (n/a)" + else: + p = cc.counts[i] * 100 / summary_count + # Use just one decimal place for large percentages. + if abs(p) < 100: + w = 2 + else: + w = 1 + perc = f" ({p:.{w}f}%)" + else: + perc = "" - self.print_count(i, nstr + perc) + return (count, perc) + + def print_cc(self, cc: Cc, suffix: str) -> None: + for i in self.events.show_indices: + (count, perc) = self.count_and_perc(cc, i) + self.print_count_and_perc(i, count, perc) print("", suffix) def print_missing_cc(self, suffix: str) -> None: - if args.show_percs: - # Don't show percentages for "." entries, it's just clutter. - text = ". " - else: - text = "." - + # Don't show percentages for "." entries, it's just clutter. for i in self.events.show_indices: - self.print_count(i, text) + self.print_count_and_perc(i, ".", "") print("", suffix) diff --git a/cachegrind/tests/ann2.post.exp b/cachegrind/tests/ann2.post.exp index ac12bf87a4..8d33c9e79a 100644 --- a/cachegrind/tests/ann2.post.exp +++ b/cachegrind/tests/ann2.post.exp @@ -20,28 +20,28 @@ Dw Dr Ir -------------------------------------------------------------------------------- Dw Dr Ir file:function -------------------------------------------------------------------------------- - 3 ( 0.02%) 4,000,004 (98.57%) 5,000,015 (95.61%) a.c:main -4,543 (25.23%) 17,566 ( 0.43%) 47,993 ( 0.92%) /build/glibc-OTsEL5/glibc-2.27/elf/dl-lookup.c:do_lookup_x -3,083 (17.12%) 5,750 ( 0.14%) 28,534 ( 0.55%) /build/glibc-OTsEL5/glibc-2.27/elf/dl-lookup.c:_dl_lookup_symbol_x - 8 ( 0.04%) 5,521 ( 0.14%) 28,136 ( 0.54%) /build/glibc-OTsEL5/glibc-2.27/elf/dl-tunables.c:__GI___tunables_init -2,490 (13.83%) 5,219 ( 0.13%) 21,821 ( 0.42%) /build/glibc-OTsEL5/glibc-2.27/elf/../sysdeps/x86_64/dl-machine.h:_dl_relocate_object - 0 5,158 ( 0.13%) 25,408 ( 0.49%) /build/glibc-OTsEL5/glibc-2.27/string/../sysdeps/x86_64/strcmp.S:strcmp + 3 (0.02%) 4,000,004 (98.57%) 5,000,015 (95.61%) a.c:main +4,543 (25.23%) 17,566 (0.43%) 47,993 (0.92%) /build/glibc-OTsEL5/glibc-2.27/elf/dl-lookup.c:do_lookup_x +3,083 (17.12%) 5,750 (0.14%) 28,534 (0.55%) /build/glibc-OTsEL5/glibc-2.27/elf/dl-lookup.c:_dl_lookup_symbol_x + 8 (0.04%) 5,521 (0.14%) 28,136 (0.54%) /build/glibc-OTsEL5/glibc-2.27/elf/dl-tunables.c:__GI___tunables_init +2,490 (13.83%) 5,219 (0.13%) 21,821 (0.42%) /build/glibc-OTsEL5/glibc-2.27/elf/../sysdeps/x86_64/dl-machine.h:_dl_relocate_object + 0 5,158 (0.13%) 25,408 (0.49%) /build/glibc-OTsEL5/glibc-2.27/string/../sysdeps/x86_64/strcmp.S:strcmp -------------------------------------------------------------------------------- -- User-annotated source: a.c -------------------------------------------------------------------------------- Dw Dr Ir -1 ( 0.01%) 0 2 ( 0.00%) int main(void) { -1 ( 0.01%) 0 1 ( 0.00%) int z = 0; -1 ( 0.01%) 2,000,001 (49.29%) 3,000,004 (57.36%) for (int i = 0; i < 1000000; i++) { -0 2,000,000 (49.29%) 2,000,000 (38.24%) z += i; -. . . } -0 1 ( 0.00%) 6 ( 0.00%) return z % 256; -0 2 ( 0.00%) 2 ( 0.00%) } + 1 (0.01%) 0 2 (0.00%) int main(void) { + 1 (0.01%) 0 1 (0.00%) int z = 0; + 1 (0.01%) 2,000,001 (49.29%) 3,000,004 (57.36%) for (int i = 0; i < 1000000; i++) { + 0 2,000,000 (49.29%) 2,000,000 (38.24%) z += i; + . . . } + 0 1 (0.00%) 6 (0.00%) return z % 256; + 0 2 (0.00%) 2 (0.00%) } -------------------------------------------------------------------------------- Dw Dr Ir -------------------------------------------------------------------------------- -3 ( 0.02%) 4,000,004 (98.57%) 5,000,015 (95.61%) events annotated + 3 (0.02%) 4,000,004 (98.57%) 5,000,015 (95.61%) events annotated diff --git a/cachegrind/tests/ann3.post.exp b/cachegrind/tests/ann3.post.exp index a648bb2e78..52c5b87503 100644 --- a/cachegrind/tests/ann3.post.exp +++ b/cachegrind/tests/ann3.post.exp @@ -1,9 +1,9 @@ -------------------------------------------------------------------------------- Command: ann3 Data file: cgout-test3 -Events recorded: A SomeCount ThisIsAVeryLongEventName -Events shown: A SomeCount ThisIsAVeryLongEventName -Event sort order: A SomeCount ThisIsAVeryLongEventName +Events recorded: A SomeCount VeryLongEventName +Events shown: A SomeCount VeryLongEventName +Event sort order: A SomeCount VeryLongEventName Thresholds: 0.5 100 100 Include dirs: ann3-no-such-dir ann3-no-such-dir-2 @@ -13,53 +13,53 @@ User annotated: ann3-unmentioned.rs Auto-annotation: on -------------------------------------------------------------------------------- -A SomeCount ThisIsAVeryLongEventName +A SomeCount VeryLongEventName -------------------------------------------------------------------------------- -100,000 (100.0%) 100,000 (100.0%) 0 PROGRAM TOTALS +100,000 (100.0%) 100,000 (100.0%) 0 PROGRAM TOTALS -------------------------------------------------------------------------------- -A SomeCount ThisIsAVeryLongEventName file:function +A SomeCount VeryLongEventName file:function -------------------------------------------------------------------------------- -70,491 (70.49%) 90,491 (90.49%) 0 ann3-basic.rs:f0 -15,000 (15.00%) 600 ( 0.60%) 0 ann3-basic.rs:f1 - 9,000 ( 9.00%) 6,000 ( 6.00%) 0 ann3-could-not-be-found.rs:f1 - 2,000 ( 2.00%) 100 ( 0.10%) 0 ann3-basic.rs:f2 - 1,000 ( 1.00%) 500 ( 0.50%) 0 ann3-via-I.rs:f1 - 1,000 ( 1.00%) 300 ( 0.30%) -1,000 ( 0.00%) ann3-past-the-end.rs:f1 --1,000 (-1.00%) 0 0 ann3-negatives.rs:neg3 --1,000 (-1.00%) 0 0 ann3-negatives.rs:neg2 - 1,000 ( 1.00%) 0 0 ann3-more-recent-than-cgout.rs:new - 1,000 ( 1.00%) 0 0 ???:unknown - 500 ( 0.50%) 0 0 ann3-basic.rs:f6 - 500 ( 0.50%) 0 0 ann3-basic.rs:f4 +70,491 (70.49%) 90,491 (90.49%) 0 ann3-basic.rs:f0 +15,000 (15.00%) 600 (0.60%) 0 ann3-basic.rs:f1 + 9,000 (9.00%) 6,000 (6.00%) 0 ann3-could-not-be-found.rs:f1 + 2,000 (2.00%) 100 (0.10%) 0 ann3-basic.rs:f2 + 1,000 (1.00%) 500 (0.50%) 0 ann3-via-I.rs:f1 + 1,000 (1.00%) 300 (0.30%) -1,000 (n/a) ann3-past-the-end.rs:f1 +-1,000 (-1.00%) 0 0 ann3-negatives.rs:neg3 +-1,000 (-1.00%) 0 0 ann3-negatives.rs:neg2 + 1,000 (1.00%) 0 0 ann3-more-recent-than-cgout.rs:new + 1,000 (1.00%) 0 0 ???:unknown + 500 (0.50%) 0 0 ann3-basic.rs:f6 + 500 (0.50%) 0 0 ann3-basic.rs:f4 -------------------------------------------------------------------------------- -- Auto-annotated source: ann3-basic.rs -------------------------------------------------------------------------------- -A SomeCount ThisIsAVeryLongEventName +A SomeCount VeryLongEventName -- line 2 ---------------------------------------- - . . . two - . . . three - 5,000 ( 5.00%) 500 ( 0.50%) 0 four - 5,000 ( 5.00%) 100 ( 0.10%) 0 five - . . . six -70,491 (70.49%) 90,491 (90.49%) 0 seven - . . . eight - 110 ( 0.11%) 9 ( 0.01%) 0 nine - . . . ten - . . . eleven - 200 ( 0.20%) 0 0 twelve - 200 ( 0.20%) 0 0 thirteen - 100 ( 0.10%) 0 0 fourteen - 0 0 0 fifteen - 0 0 0 sixteen - 0 0 0 seventeen - 0 0 0 eighteen - 499 ( 0.50%) 2,000 ( 2.00%) 0 nineteen - 300 ( 0.30%) 0 0 twenty - - 7,100 ( 7.10%) 100 ( 0.10%) 0 <counts for unidentified lines in ann3-basic.rs> + . . . two + . . . three + 5,000 (5.00%) 500 (0.50%) 0 four + 5,000 (5.00%) 100 (0.10%) 0 five + . . . six +70,491 (70.49%) 90,491 (90.49%) 0 seven + . . . eight + 110 (0.11%) 9 (0.01%) 0 nine + . . . ten + . . . eleven + 200 (0.20%) 0 0 twelve + 200 (0.20%) 0 0 thirteen + 100 (0.10%) 0 0 fourteen + 0 0 0 fifteen + 0 0 0 sixteen + 0 0 0 seventeen + 0 0 0 eighteen + 499 (0.50%) 2,000 (2.00%) 0 nineteen + 300 (0.30%) 0 0 twenty + + 7,100 (7.10%) 100 (0.10%) 0 <counts for unidentified lines in ann3-basic.rs> -------------------------------------------------------------------------------- -- Auto-annotated source: ann3-more-recent-than-cgout.rs @@ -71,49 +71,49 @@ A SomeCount ThisIsAVeryLongEventName @ Annotations may not be correct. @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ -A SomeCount ThisIsAVeryLongEventName +A SomeCount VeryLongEventName - . . . one -1,000 ( 1.00%) 0 0 two - . . . three - . . . four + . . . one +1,000 (1.00%) 0 0 two + . . . three + . . . four -- line 4 ---------------------------------------- -------------------------------------------------------------------------------- -- Auto-annotated source: ann3-negatives.rs -------------------------------------------------------------------------------- -A SomeCount ThisIsAVeryLongEventName - - 2,000 ( 2.00%) 2,000 ( 2.00%) 2,000 ( 0.00%) one - -1,000 (-1.00%) -1,000 (-1.00%) 0 two - . . . three - . . . four - 999,000 (999.0%) 0 -150,000 ( 0.00%) five --1,000,000 (-1000.0%) 0 150,000 ( 0.00%) six - . . . seven - . . . eight - . . . nine - -10,000 (-10.0%) 0 10 ( 0.00%) ten - 10,000 (10.00%) 0 -20 ( 0.00%) eleven - . . . twelve - . . . thirteen +A SomeCount VeryLongEventName + + 2,000 (2.00%) 2,000 (2.00%) 2,000 (n/a) one + -1,000 (-1.00%) -1,000 (-1.00%) 0 two + . . . three + . . . four + 999,000 (999.0%) 0 -150,000 (n/a) five +-1,000,000 (-1000.0%) 0 150,000 (n/a) six + . . . seven + . . . eight + . . . nine + -10,000 (-10.00%) 0 10 (n/a) ten + 10,000 (10.00%) 0 -20 (n/a) eleven + . . . twelve + . . . thirteen -- line 13 ---------------------------------------- - -2,000 (-2.00%) -1,000 (-1.00%) -990 ( 0.00%) <counts for unidentified lines in ann3-negatives.rs> + -2,000 (-2.00%) -1,000 (-1.00%) -990 (n/a) <counts for unidentified lines in ann3-negatives.rs> -------------------------------------------------------------------------------- -- Auto-annotated source: ann3-past-the-end.rs -------------------------------------------------------------------------------- -A SomeCount ThisIsAVeryLongEventName +A SomeCount VeryLongEventName -200 ( 0.20%) 100 ( 0.10%) 0 one - . . . two - . . . three +200 (0.20%) 100 (0.10%) 0 one + . . . two + . . . three -- line 3 ---------------------------------------- -- line 18 ---------------------------------------- -300 ( 0.30%) 100 ( 0.10%) 0 <bogus line 20> -300 ( 0.30%) 100 ( 0.10%) 0 <bogus line 21> -200 ( 0.20%) 0 -1,000 ( 0.00%) <bogus line 22> +300 (0.30%) 100 (0.10%) 0 <bogus line 20> +300 (0.30%) 100 (0.10%) 0 <bogus line 21> +200 (0.20%) 0 -1,000 (n/a) <bogus line 22> @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ @@ -129,9 +129,9 @@ A SomeCount ThisIsAVeryLongEventName -------------------------------------------------------------------------------- -- Auto-annotated source: ann3-aux/ann3-via-I.rs -------------------------------------------------------------------------------- -A SomeCount ThisIsAVeryLongEventName +A SomeCount VeryLongEventName -1,000 ( 1.00%) 500 ( 0.50%) 0 one +1,000 (1.00%) 500 (0.50%) 0 one -------------------------------------------------------------------------------- The following files chosen for auto-annotation could not be found: @@ -140,7 +140,7 @@ The following files chosen for auto-annotation could not be found: ann3-no-such-file.rs -------------------------------------------------------------------------------- -A SomeCount ThisIsAVeryLongEventName +A SomeCount VeryLongEventName -------------------------------------------------------------------------------- -84,100 (84.10%) 94,700 (94.70%) 1,990 ( 0.00%) events annotated +84,100 (84.10%) 94,700 (94.70%) 1,990 (n/a) events annotated diff --git a/cachegrind/tests/cgout-test3 b/cachegrind/tests/cgout-test3 index 7a3e188a8f..d8023eef1d 100644 --- a/cachegrind/tests/cgout-test3 +++ b/cachegrind/tests/cgout-test3 @@ -1,5 +1,5 @@ cmd: ann3 -events: A SomeCount ThisIsAVeryLongEventName +events: A SomeCount VeryLongEventName # A file testing various things. fl=ann3-basic.rs diff --git a/cachegrind/tests/diff.post.exp b/cachegrind/tests/diff.post.exp index aa88967e26..81fbe3e920 100644 --- a/cachegrind/tests/diff.post.exp +++ b/cachegrind/tests/diff.post.exp @@ -11,25 +11,25 @@ User annotated: Auto-annotation: on -------------------------------------------------------------------------------- -Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw +Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw -------------------------------------------------------------------------------- -5,000,000 (100.0%) 0 0 -2,000,000 (100.0%) 0 0 0 0 0 PROGRAM TOTALS +5,000,000 (100.0%) 0 0 -2,000,000 (100.0%) 0 0 0 0 0 PROGRAM TOTALS -------------------------------------------------------------------------------- -Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw file:function +Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw file:function -------------------------------------------------------------------------------- -5,000,000 (100.0%) 0 0 -2,000,000 (100.0%) 0 0 0 0 0 a.c:main +5,000,000 (100.0%) 0 0 -2,000,000 (100.0%) 0 0 0 0 0 a.c:main -------------------------------------------------------------------------------- -- Auto-annotated source: a.c -------------------------------------------------------------------------------- -Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw +Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw -5,000,000 (100.0%) 0 0 -2,000,000 (100.0%) 0 0 0 0 0 <counts for unidentified lines in a.c> +5,000,000 (100.0%) 0 0 -2,000,000 (100.0%) 0 0 0 0 0 <counts for unidentified lines in a.c> -------------------------------------------------------------------------------- -Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw +Ir I1mr ILmr Dr D1mr DLmr Dw D1mw DLmw -------------------------------------------------------------------------------- -0 0 0 0 0 0 0 0 0 events annotated + 0 0 0 0 0 0 0 0 0 events annotated |
|
From: Nicholas N. <n.n...@gm...> - 2023-03-22 23:09:11
|
All the Rust projects I work on use GitHub, and in terms of usability and productivity it's miles ahead of how Valgrind development works. If I were king of the world here's how I would drag Valgrind's development practices forward by 10-20 years. - Move the repository to GitHub. Require all changes to be done via pull requests, with no direct pushing. - Set up some CI testing via GitHub Actions. Require that all pull requests pass these tests before merging. - Lots of projects require a review approval before a pull request can be merged. But that might be too hard for Valgrind to start with, given the small number of active contributors. - Switch from KDE bugzilla to GitHub issues for bug reporting. Not sure what I'd do with existing open bug reports, whether it would be worth importing them to GitHub issues somehow or not. - Use auto-formatting tools, such as clang-format. (Possibly even moving from 3 space indents in C code to 2 or 4!) - Change the docs from that XML-based thing we use (groan) to something nicer, probably involving Markdown. - Website: not sure... a lot of it could be naturally hosted on the main GitHub page. It might be nice to still have valgrind.org, though, but perhaps greatly stripped back. I understand the concerns about GitHub and commercialization, but I also worry about Valgrind's future viability if it doesn't attract some level of new contributors. The Linux kernel will never have that problem, but I suspect lots of GNU projects also face that risk. Nick On Thu, 23 Mar 2023 at 08:19, Paul Floyd <pj...@wa...> wrote: > > > On 22-03-23 21:31, Nicholas Nethercote wrote: > > Thanks to Paul and Mark for a couple of small fixes to my commit. > > > > Yesterday I was idly dreaming about the quality-of-life improvements > > that would be available if Valgrind was hosted on GitHub: > > - ability to upload commits ahead of time, in a fashion nicer than > > "attach patch to bugzilla" > > - ability to do reviews > > - CI support for pre-merge testing runs > > - easier entry for newcomers > > > > Does sourceware.org <http://sourceware.org> have support for any of > > these things? > > Hi > > GH does have a lot going for it, and when they add code browsing it will > be even better. One concern though is their owner and creeping > commercialization. > > As far as I know, a lot of GNU projects and Linux still work mostly by > by patches sent to mailing lists. > > One other fairly common system is phabricator (used by LLVM and FreeBSD > amonst others). However, the company that developed phabricator closed > down so I don't know where that is going (there is a fork). FWIW FreeBSD > is increasingly using GH. > > A+ > Paul > > > > _______________________________________________ > Valgrind-developers mailing list > Val...@li... > https://lists.sourceforge.net/lists/listinfo/valgrind-developers > |
|
From: Nicholas N. <n.n...@gm...> - 2023-03-22 22:52:55
|
Thanks for the suggestion. I have removed the use of `TypeAlias` like you suggested, and documented version expectations. Nick On Thu, 23 Mar 2023 at 08:03, Paul Floyd <pj...@wa...> wrote: > > > On 22-03-23 00:22, Nicholas Nethercote wrote: > > I have merged the new version of `cg_annotate`: > > > https://sourceware.org/git/?p=valgrind.git;a=commit;h=4650b7949ae3a41326e52ae454a9202493c41444 > < > https://sourceware.org/git/?p=valgrind.git;a=commit;h=4650b7949ae3a41326e52ae454a9202493c41444 > > > > Hi Nick > > I've seen two problems. The first I've already fixed with "env". > > The other is with typing / TypeAlias. This was added in Python 3.10. On > my FreeBSD system "python3" defaults to Python 3.9, so I get > > ImportError: cannot import name 'TypeAlias' from 'typing' > (/usr/local/lib/python3.9/typing.py) > > That will probably also cause problems on old Linux systems as well. > > I don't know much Python, but would it be OK to use non-explicit > (implicit?) type aliases like in the diff below: > > The alternative would be to add python3.10 detection, something like > > AC_CHECK_PROGS([PYTHON3],[python3.10 python3] > > and then to use @PYTHON3@ in cg_annotate.in and the 3 ann[123]/vgtest > files. > > A+ > Paul > > > > diff --git a/cachegrind/cg_annotate.in b/cachegrind/cg_annotate.in > index 91d75aecd..c3d5f71d4 100755 > --- a/cachegrind/cg_annotate.in > +++ b/cachegrind/cg_annotate.in > @@ -73,7 +73,7 @@ import re > import sys > from argparse import ArgumentParser, BooleanOptionalAction, Namespace > from collections import defaultdict > -from typing import Callable, DefaultDict, NewType, NoReturn, TextIO, > TypeAlias > +from typing import Callable, DefaultDict, NewType, NoReturn, TextIO > > > class Args(Namespace): > @@ -323,11 +323,11 @@ class Cc: > Flfn = NewType("Flfn", tuple[str, str]) > > # Per-function CCs. > -DictFlfnCc: TypeAlias = DefaultDict[Flfn, Cc] > +DictFlfnCc = DefaultDict[Flfn, Cc] > > # Per-line CCs, organised by filename and line number. > -DictLineCc: TypeAlias = DefaultDict[int, Cc] > -DictFlDictLineCc: TypeAlias = DefaultDict[str, DictLineCc] > +DictLineCc = DefaultDict[int, Cc] > +DictFlDictLineCc = DefaultDict[str, DictLineCc] > > > def die(msg: str) -> NoReturn: > > > > A+ > Paul > > > _______________________________________________ > Valgrind-developers mailing list > Val...@li... > https://lists.sourceforge.net/lists/listinfo/valgrind-developers > |
|
From: Nicholas N. <nj...@so...> - 2023-03-22 22:51:47
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=e9e7b663fb69075a110963d85726389f469fcf5b commit e9e7b663fb69075a110963d85726389f469fcf5b Author: Nicholas Nethercote <n.n...@gm...> Date: Thu Mar 23 09:50:21 2023 +1100 Make `cg_annotate` work with Python 3.9, by avoiding `TypeAlias`. Diff: --- cachegrind/cg_annotate.in | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/cachegrind/cg_annotate.in b/cachegrind/cg_annotate.in index 91d75aecdf..20969f0f92 100755 --- a/cachegrind/cg_annotate.in +++ b/cachegrind/cg_annotate.in @@ -34,6 +34,10 @@ This script reads Cachegrind output files and produces human-readable reports. # formatters, type-checkers, and linters on `cg_annotate.in` and then generates # `cg_annotate`. # +# Python versions: Currently this script targets Python 3.9 and later versions. +# Consequences of this: +# - No use of `TypeAlias` for explicit type aliases, which requires 3.10. +# # The following Python tools are used. All can be installed with `pip3 install # $NAME`, except `cProfile` which is built into Python. # @@ -73,7 +77,7 @@ import re import sys from argparse import ArgumentParser, BooleanOptionalAction, Namespace from collections import defaultdict -from typing import Callable, DefaultDict, NewType, NoReturn, TextIO, TypeAlias +from typing import Callable, DefaultDict, NewType, NoReturn, TextIO class Args(Namespace): @@ -323,11 +327,13 @@ class Cc: Flfn = NewType("Flfn", tuple[str, str]) # Per-function CCs. -DictFlfnCc: TypeAlias = DefaultDict[Flfn, Cc] +# Note: not using `TypeAlias`. See "Python versions" comment above. +DictFlfnCc = DefaultDict[Flfn, Cc] # Per-line CCs, organised by filename and line number. -DictLineCc: TypeAlias = DefaultDict[int, Cc] -DictFlDictLineCc: TypeAlias = DefaultDict[str, DictLineCc] +# Note: not using `TypeAlias`. See "Python versions" comment above. +DictLineCc = DefaultDict[int, Cc] +DictFlDictLineCc = DefaultDict[str, DictLineCc] def die(msg: str) -> NoReturn: |
|
From: Paul F. <pj...@wa...> - 2023-03-22 21:18:25
|
On 22-03-23 21:31, Nicholas Nethercote wrote: > Thanks to Paul and Mark for a couple of small fixes to my commit. > > Yesterday I was idly dreaming about the quality-of-life improvements > that would be available if Valgrind was hosted on GitHub: > - ability to upload commits ahead of time, in a fashion nicer than > "attach patch to bugzilla" > - ability to do reviews > - CI support for pre-merge testing runs > - easier entry for newcomers > > Does sourceware.org <http://sourceware.org> have support for any of > these things? Hi GH does have a lot going for it, and when they add code browsing it will be even better. One concern though is their owner and creeping commercialization. As far as I know, a lot of GNU projects and Linux still work mostly by by patches sent to mailing lists. One other fairly common system is phabricator (used by LLVM and FreeBSD amonst others). However, the company that developed phabricator closed down so I don't know where that is going (there is a fork). FWIW FreeBSD is increasingly using GH. A+ Paul |
|
From: Paul F. <pj...@wa...> - 2023-03-22 21:02:53
|
On 22-03-23 00:22, Nicholas Nethercote wrote: > I have merged the new version of `cg_annotate`: > https://sourceware.org/git/?p=valgrind.git;a=commit;h=4650b7949ae3a41326e52ae454a9202493c41444 <https://sourceware.org/git/?p=valgrind.git;a=commit;h=4650b7949ae3a41326e52ae454a9202493c41444> Hi Nick I've seen two problems. The first I've already fixed with "env". The other is with typing / TypeAlias. This was added in Python 3.10. On my FreeBSD system "python3" defaults to Python 3.9, so I get ImportError: cannot import name 'TypeAlias' from 'typing' (/usr/local/lib/python3.9/typing.py) That will probably also cause problems on old Linux systems as well. I don't know much Python, but would it be OK to use non-explicit (implicit?) type aliases like in the diff below: The alternative would be to add python3.10 detection, something like AC_CHECK_PROGS([PYTHON3],[python3.10 python3] and then to use @PYTHON3@ in cg_annotate.in and the 3 ann[123]/vgtest files. A+ Paul diff --git a/cachegrind/cg_annotate.in b/cachegrind/cg_annotate.in index 91d75aecd..c3d5f71d4 100755 --- a/cachegrind/cg_annotate.in +++ b/cachegrind/cg_annotate.in @@ -73,7 +73,7 @@ import re import sys from argparse import ArgumentParser, BooleanOptionalAction, Namespace from collections import defaultdict -from typing import Callable, DefaultDict, NewType, NoReturn, TextIO, TypeAlias +from typing import Callable, DefaultDict, NewType, NoReturn, TextIO class Args(Namespace): @@ -323,11 +323,11 @@ class Cc: Flfn = NewType("Flfn", tuple[str, str]) # Per-function CCs. -DictFlfnCc: TypeAlias = DefaultDict[Flfn, Cc] +DictFlfnCc = DefaultDict[Flfn, Cc] # Per-line CCs, organised by filename and line number. -DictLineCc: TypeAlias = DefaultDict[int, Cc] -DictFlDictLineCc: TypeAlias = DefaultDict[str, DictLineCc] +DictLineCc = DefaultDict[int, Cc] +DictFlDictLineCc = DefaultDict[str, DictLineCc] def die(msg: str) -> NoReturn: A+ Paul |
|
From: Nicholas N. <n.n...@gm...> - 2023-03-22 20:32:11
|
Thanks to Paul and Mark for a couple of small fixes to my commit. Yesterday I was idly dreaming about the quality-of-life improvements that would be available if Valgrind was hosted on GitHub: - ability to upload commits ahead of time, in a fashion nicer than "attach patch to bugzilla" - ability to do reviews - CI support for pre-merge testing runs - easier entry for newcomers Does sourceware.org have support for any of these things? Nick On Wed, 22 Mar 2023 at 10:22, Nicholas Nethercote <n.n...@gm...> wrote: > I have merged the new version of `cg_annotate`: > > https://sourceware.org/git/?p=valgrind.git;a=commit;h=4650b7949ae3a41326e52ae454a9202493c41444 > > Nick > > On Fri, 17 Mar 2023 at 16:24, Nicholas Nethercote <n.n...@gm...> > wrote: > >> I have finished the rewrite. I am happy with the new code, it is much >> better than the old code. You can see it at >> https://bugs.kde.org/show_bug.cgi?id=467472. I plan to merge it by the >> end of next week, and I am happy to hear any suggestions. >> >> I also have some good news about the `cg_annotate.in`/`cg_annotate` >> split. I learned that you can generate the latter from the former very >> quickly with `config.status cachegrind/cg_annotate.in`. Also, this can >> be done automatically from some make targets. So I ended up creating a new >> make target `make ann` that can be run within the `cachegrind` directory. >> It runs the various Python formatters, type-checkers, and linters I am >> using on `cg_annotate.in` and then generates `cg_annotate`. It's a >> one-step "build" command that runs quickly, which is great. >> >> Nick >> >> On Wed, 15 Mar 2023 at 06:15, Nicholas Nethercote <n.n...@gm...> >> wrote: >> >>> On Sun, 12 Mar 2023 at 23:01, Paul Floyd <pj...@wa...> wrote: >>> >>>> >>>> The only think I can think of to get the version is to use something >>>> like >>>> >>>> pkg-config --modversion valgrind >>>> >>> >>> Thanks for the suggestion. Unfortunately this could cause misleading >>> results. E.g. if I have Valgrind installed on my system but I also have a >>> development version, when I run the development version of `cg_annotate >>> --version` it will claim to be the installed version. I think the `@VERSION@` >>> junk is unavoidable. >>> >>> Nick >>> >> |
|
From: Paul F. <pa...@so...> - 2023-03-22 19:44:49
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=bb35cd572f7f805eb55160ad13e5bf8f1c174499 commit bb35cd572f7f805eb55160ad13e5bf8f1c174499 Author: Paul Floyd <pj...@wa...> Date: Wed Mar 22 20:43:30 2023 +0100 Make cg_annotate independent of python3 install location Diff: --- cachegrind/cg_annotate.in | 2 +- cachegrind/tests/ann1.vgtest | 2 +- cachegrind/tests/ann2.vgtest | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/cachegrind/cg_annotate.in b/cachegrind/cg_annotate.in index 247026f1fa..91d75aecdf 100755 --- a/cachegrind/cg_annotate.in +++ b/cachegrind/cg_annotate.in @@ -1,4 +1,4 @@ -#! /usr/bin/python3 +#! /usr/bin/env python3 # pyright: strict # -------------------------------------------------------------------- diff --git a/cachegrind/tests/ann1.vgtest b/cachegrind/tests/ann1.vgtest index e3e574276a..660f524f09 100644 --- a/cachegrind/tests/ann1.vgtest +++ b/cachegrind/tests/ann1.vgtest @@ -2,5 +2,5 @@ # the post-processing of the cgout-test file. prog: ../../tests/true vgopts: --cachegrind-out-file=cachegrind.out -post: touch cgout-test && perl ../../cachegrind/cg_annotate --show=Ir,I1mr,ILmr --show-percs=no cgout-test +post: touch cgout-test && python3 ../../cachegrind/cg_annotate --show=Ir,I1mr,ILmr --show-percs=no cgout-test cleanup: rm cachegrind.out diff --git a/cachegrind/tests/ann2.vgtest b/cachegrind/tests/ann2.vgtest index 7cf1b7fcd3..9ef76e38e9 100644 --- a/cachegrind/tests/ann2.vgtest +++ b/cachegrind/tests/ann2.vgtest @@ -2,5 +2,5 @@ # the post-processing of the cgout-test file. prog: ../../tests/true vgopts: --cachegrind-out-file=cachegrind.out -post: touch cgout-test && perl ../../cachegrind/cg_annotate --sort=Dr --show=Dw,Dr,Ir --auto=no cgout-test a.c +post: touch cgout-test && python3 ../../cachegrind/cg_annotate --sort=Dr --show=Dw,Dr,Ir --auto=no cgout-test a.c cleanup: rm cachegrind.out |
|
From: Mark W. <ma...@so...> - 2023-03-22 10:42:36
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=3bb907290aa97ba6b5d776844444c04fcb3a71aa commit 3bb907290aa97ba6b5d776844444c04fcb3a71aa Author: Mark Wielaard <ma...@kl...> Date: Wed Mar 22 11:41:53 2023 +0100 cachegrind/tests/Makefile.am EXTRA_DIST add ann3.{{post,stderr}.exp,vgtest} Diff: --- cachegrind/tests/Makefile.am | 1 + 1 file changed, 1 insertion(+) diff --git a/cachegrind/tests/Makefile.am b/cachegrind/tests/Makefile.am index 2ce7426677..ded05c8fdb 100644 --- a/cachegrind/tests/Makefile.am +++ b/cachegrind/tests/Makefile.am @@ -16,6 +16,7 @@ EXTRA_DIST = \ cgout-test \ ann1.post.exp ann1.stderr.exp ann1.vgtest \ ann2.post.exp ann2.stderr.exp ann2.vgtest \ + ann3.post.exp ann3.stderr.exp ann3.vgtest \ chdir.vgtest chdir.stderr.exp \ clreq.vgtest clreq.stderr.exp \ diff.post.exp diff.stderr.exp diff.vgtest \ |
|
From: Nicholas N. <n.n...@gm...> - 2023-03-21 23:23:08
|
I have merged the new version of `cg_annotate`: https://sourceware.org/git/?p=valgrind.git;a=commit;h=4650b7949ae3a41326e52ae454a9202493c41444 Nick On Fri, 17 Mar 2023 at 16:24, Nicholas Nethercote <n.n...@gm...> wrote: > I have finished the rewrite. I am happy with the new code, it is much > better than the old code. You can see it at > https://bugs.kde.org/show_bug.cgi?id=467472. I plan to merge it by the > end of next week, and I am happy to hear any suggestions. > > I also have some good news about the `cg_annotate.in`/`cg_annotate` > split. I learned that you can generate the latter from the former very > quickly with `config.status cachegrind/cg_annotate.in`. Also, this can be > done automatically from some make targets. So I ended up creating a new > make target `make ann` that can be run within the `cachegrind` directory. > It runs the various Python formatters, type-checkers, and linters I am > using on `cg_annotate.in` and then generates `cg_annotate`. It's a > one-step "build" command that runs quickly, which is great. > > Nick > > On Wed, 15 Mar 2023 at 06:15, Nicholas Nethercote <n.n...@gm...> > wrote: > >> On Sun, 12 Mar 2023 at 23:01, Paul Floyd <pj...@wa...> wrote: >> >>> >>> The only think I can think of to get the version is to use something like >>> >>> pkg-config --modversion valgrind >>> >> >> Thanks for the suggestion. Unfortunately this could cause misleading >> results. E.g. if I have Valgrind installed on my system but I also have a >> development version, when I run the development version of `cg_annotate >> --version` it will claim to be the installed version. I think the `@VERSION@` >> junk is unavoidable. >> >> Nick >> > |
|
From: Nicholas N. <nj...@so...> - 2023-03-21 23:15:05
|
https://sourceware.org/git/gitweb.cgi?p=valgrind.git;h=4650b7949ae3a41326e52ae454a9202493c41444 commit 4650b7949ae3a41326e52ae454a9202493c41444 Author: Nicholas Nethercote <n.n...@gm...> Date: Thu Mar 9 15:41:31 2023 +1100 Rewrite `cg_annotate` in Python. Perl was a reasonable choice for `cg_annotate` in 2002, but not in 2023. Also, the existing structure of the code is not good. These two things make it hard to modify `cg_annotate` in any significant way. Benefits of the change: - Now written in a language that is (a) nice, and (b) not moribund. - Easier to maintain, due to (a) abovementioned better language, (b) better code structure, and (c) better language tooling, such as formatters, type checkers, and linters. - The new version is a little shorter. - It runs about 2x faster. - Argument handling is more standard. E.g. things like `--context 2`, `--auto`, `--no-auto` are supported. (The old forms that require `=` are still supported, though the `=yes`/`=no` forms are deprecated.) The behaviour and output of the new version is identical for typical uses, but there are some very minor changes for edge cases, which nobody is likely to notice. For example: - The file format is slightly changed: I removed support for '.' counts, which had the same meaning as '0'. This was a feature that Cachegrind never used, and the old script handled it inconsistently. - The new version will abort on a malformed data line. The old version would just print a warning and continue. The commit also adds a new test `ann3` that tests many parts of `cg_annotate` that weren't tested previously, and tweaks the existing `ann2` test. Diff: --- NEWS | 5 + cachegrind/Makefile.am | 30 + cachegrind/cg_annotate.in | 1759 +++++++++++------------ cachegrind/docs/cg-manual.xml | 33 +- cachegrind/pylintrc | 53 + cachegrind/tests/ann2.post.exp | 14 +- cachegrind/tests/ann2.vgtest | 2 +- cachegrind/tests/ann3-aux/ann3-via-I.rs | 1 + cachegrind/tests/ann3-basic.rs | 20 + cachegrind/tests/ann3-more-recent-than-cgout.rs | 5 + cachegrind/tests/ann3-negatives.rs | 15 + cachegrind/tests/ann3-past-the-end.rs | 3 + cachegrind/tests/ann3-unmentioned.rs | 1 + cachegrind/tests/ann3.post.exp | 146 ++ cachegrind/tests/ann3.stderr.exp | 17 + cachegrind/tests/ann3.vgtest | 13 + cachegrind/tests/cgout-test3 | 93 ++ cachegrind/tests/diff.post.exp | 4 +- 18 files changed, 1258 insertions(+), 956 deletions(-) diff --git a/NEWS b/NEWS index 8ede199d67..990043fe63 100644 --- a/NEWS +++ b/NEWS @@ -86,6 +86,11 @@ AMD64/macOS 10.13 and nanoMIPS/Linux. - Valgrind now contains python code that defines GDB helgrind front end monitor commands. See CORE CHANGES. +* Cachegrind: + - `cg_annotate` has been rewritten from Perl into Python. The new + version is twice as fast, has more flexible argument parsing, and + will make future improvements easier. + * Callgrind: - Valgrind now contains python code that defines GDB callgrind front end monitor commands. See CORE CHANGES. diff --git a/cachegrind/Makefile.am b/cachegrind/Makefile.am index f8447a17ce..8ea99ca529 100644 --- a/cachegrind/Makefile.am +++ b/cachegrind/Makefile.am @@ -88,3 +88,33 @@ cachegrind_@VGCONF_ARCH_SEC@_@VGCONF_OS@_LINK = \ $(cachegrind_@VGCONF_ARCH_SEC@_@VGCONF_OS@_CFLAGS) \ $(cachegrind_@VGCONF_ARCH_SEC@_@VGCONF_OS@_LDFLAGS) endif + +#---------------------------------------------------------------------------- +# Miscellaneous +#---------------------------------------------------------------------------- + +# Run the formatters, type checkers, and linters on `cg_annotate.in`, then +# generate `cg_annotate`. +# +# Note: `pyright` refuses to check any file without a `.py` extension, hence +# the copying to `/tmp/tmp.py`. +ann: + @echo "== black ==" + @black cg_annotate.in + @echo + @echo "== isort ==" + @isort cg_annotate.in + @echo + @echo "== mypy ==" + @mypy --strict cg_annotate.in + @echo + @echo "== pyright ==" + @cp cg_annotate.in /tmp/tmp.py && pyright /tmp/tmp.py && rm /tmp/tmp.py + @echo + @echo "== ruff ==" + @ruff cg_annotate.in + @echo + @echo "== pylint ==" + @pylint cg_annotate.in + @echo "== config.status ==" + $(MAKE) cg_annotate diff --git a/cachegrind/cg_annotate.in b/cachegrind/cg_annotate.in old mode 100644 new mode 100755 index 9111fbe7ef..247026f1fa --- a/cachegrind/cg_annotate.in +++ b/cachegrind/cg_annotate.in @@ -1,942 +1,855 @@ -#! @PERL@ +#! /usr/bin/python3 +# pyright: strict -##--------------------------------------------------------------------## -##--- Cachegrind's annotator. cg_annotate.in ---## -##--------------------------------------------------------------------## +# -------------------------------------------------------------------- +# --- Cachegrind's annotator. cg_annotate.in --- +# -------------------------------------------------------------------- -# This file is part of Cachegrind, a Valgrind tool for cache -# profiling programs. +# This file is part of Cachegrind, a Valgrind tool for cache +# profiling programs. # -# Copyright (C) 2002-2017 Nicholas Nethercote -# nj...@va... +# Copyright (C) 2002-2023 Nicholas Nethercote +# nj...@va... # -# This program is free software; you can redistribute it and/or -# modify it under the terms of the GNU General Public License as -# published by the Free Software Foundation; either version 2 of the -# License, or (at your option) any later version. +# This program is free software; you can redistribute it and/or +# modify it under the terms of the GNU General Public License as +# published by the Free Software Foundation; either version 2 of the +# License, or (at your option) any later version. # -# This program is distributed in the hope that it will be useful, but -# WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# General Public License for more details. +# This program is distributed in the hope that it will be useful, but +# WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +# General Public License for more details. # -# You should have received a copy of the GNU General Public License -# along with this program; if not, see <http://www.gnu.org/licenses/>. +# You should have received a copy of the GNU General Public License +# along with this program; if not, see <http://www.gnu.org/licenses/>. # -# The GNU General Public License is contained in the file COPYING. - -#---------------------------------------------------------------------------- -# The file format is simple, basically printing the cost centre for every -# source line, grouped by files and functions. The details are in -# Cachegrind's manual. - -#---------------------------------------------------------------------------- -# Performance improvements record, using cachegrind.out for cacheprof, doing no -# source annotation (irrelevant ones removed): -# user time -# 1. turned off warnings in add_hash_a_to_b() 3.81 --> 3.48s -# [now add_array_a_to_b()] -# 6. make line_to_CC() return a ref instead of a hash 3.01 --> 2.77s +# The GNU General Public License is contained in the file COPYING. + +""" +This script reads Cachegrind output files and produces human-readable reports. +""" + +# Use `make ann` to "build" this script every time it is changed. This runs the +# formatters, type-checkers, and linters on `cg_annotate.in` and then generates +# `cg_annotate`. # -#10. changed file format to avoid file/fn name repetition 2.40s -# (not sure why higher; maybe due to new '.' entries?) -#11. changed file format to drop unnecessary end-line "."s 2.36s -# (shrunk file by about 37%) -#12. switched from hash CCs to array CCs 1.61s -#13. only adding b[i] to a[i] if b[i] defined (was doing it if -# either a[i] or b[i] was defined, but if b[i] was undefined -# it just added 0) 1.48s -#14. Stopped converting "." entries to undef and then back 1.16s -#15. Using foreach $i (x..y) instead of for ($i = 0...) in -# add_array_a_to_b() 1.11s +# The following Python tools are used. All can be installed with `pip3 install +# $NAME`, except `cProfile` which is built into Python. # -# Auto-annotating primes: -#16. Finding count lengths by int((length-1)/3), not by -# commifying (halves the number of commify calls) 1.68s --> 1.47s - -use warnings; -use strict; - -#---------------------------------------------------------------------------- -# Overview: the running example in the comments is for: -# - events = A,B,C,D -# - --show=C,A,D -# - --sort=D,C -#---------------------------------------------------------------------------- - -#---------------------------------------------------------------------------- -# Global variables, main data structures -#---------------------------------------------------------------------------- -# CCs are arrays, the counts corresponding to @events, with 'undef' -# representing '.'. This makes things fast (faster than using hashes for CCs) -# but we have to use @sort_order and @show_order below to handle the --sort and -# --show options, which is a bit tricky. -#---------------------------------------------------------------------------- - -# Total counts for summary (an array reference). -my $summary_CC; - -# Totals for each function, for overall summary. -# hash(filename:fn_name => CC array) -my %fn_totals; - -# Individual CCs, organised by filename and line_num for easy annotation. -# hash(filename => hash(line_num => CC array)) -my %allCCs; - -# Files chosen for annotation on the command line. -# key = basename (trimmed of any directory), value = full filename -my %user_ann_files; - -# Generic description string. -my $desc = ""; - -# Command line of profiled program. -my $cmd; - -# Events in input file, eg. (A,B,C,D) -my @events; - -# Events to show, from command line, eg. (C,A,D) -my @show_events; - -# Map from @show_events indices to @events indices, eg. (2,0,3). Gives the -# order in which we must traverse @events in order to show the @show_events, -# eg. (@events[$show_order[1]], @events[$show_order[2]]...) = @show_events. -# (Might help to think of it like a hash (0 => 2, 1 => 0, 2 => 3).) -my @show_order; - -# Print out the function totals sorted by these events, eg. (D,C). -my @sort_events; - -# Map from @sort_events indices to @events indices, eg. (3,2). Same idea as -# for @show_order. -my @sort_order; - -# Thresholds, one for each sort event (or default to 1 if no sort events -# specified). We print out functions and do auto-annotations until we've -# handled this proportion of all the events thresholded. -my @thresholds; - -my $default_threshold = 0.1; - -my $single_threshold = $default_threshold; - -# If on, show a percentage for each non-zero count. -my $show_percs = 1; - -# If on, automatically annotates all files that are involved in getting over -# all the threshold counts. -my $auto_annotate = 1; - -# Number of lines to show around each annotated line. -my $context = 8; - -# Directories in which to look for annotation files. -my @include_dirs = (""); - -# Input file name -my $input_file = undef; - -# Version number -my $version = "@VERSION@"; - -# Usage message. -my $usage = <<END -usage: cg_annotate [options] cachegrind-out-file [source-files...] - - options for the user, with defaults in [ ], are: - -h --help show this message - --version show version - --show=A,B,C only show figures for events A,B,C [all] - --sort=A,B,C sort columns by events A,B,C [event column order] - --threshold=<0--20> a function is shown if it accounts for more than x% of - the counts of the primary sort event [$default_threshold] - --show-percs=yes|no show a percentage for each non-zero count [yes] - --auto=yes|no annotate all source files containing functions - that helped reach the event count threshold [yes] - --context=N print N lines of context before and after - annotated lines [8] - -I<d> --include=<d> add <d> to list of directories to search for - source files - - cg_annotate is Copyright (C) 2002-2017 Nicholas Nethercote. - and licensed under the GNU General Public License, version 2. - Bug reports, feedback, admiration, abuse, etc, to: njn\@valgrind.org. - -END -; - -# Used in various places of output. -my $fancy = '-' x 80 . "\n"; - -sub safe_div($$) -{ - my ($x, $y) = @_; - return ($y == 0 ? 0 : $x / $y); -} - -#----------------------------------------------------------------------------- -# Argument and option handling -#----------------------------------------------------------------------------- -sub process_cmd_line() -{ - for my $arg (@ARGV) { - - # Option handling - if ($arg =~ /^-/) { - - # --version - if ($arg =~ /^--version$/) { - die("cg_annotate-$version\n"); - - # --show=A,B,C - } elsif ($arg =~ /^--show=(.*)$/) { - @show_events = split(/,/, $1); - - # --sort=A,B,C - # Nb: You can specify thresholds individually, eg. - # --sort=A:99,B:95,C:90. These will override any --threshold - # argument. - } elsif ($arg =~ /^--sort=(.*)$/) { - @sort_events = split(/,/, $1); - my $th_specified = 0; - foreach my $i (0 .. scalar @sort_events - 1) { - if ($sort_events[$i] =~ /.*:([\d\.]+)%?$/) { - my $th = $1; - ($th >= 0 && $th <= 100) or die($usage); - $sort_events[$i] =~ s/:.*//; - $thresholds[$i] = $th; - $th_specified = 1; - } else { - $thresholds[$i] = 0; - } - } - if (not $th_specified) { - @thresholds = (); - } - - # --threshold=X (tolerates a trailing '%') - } elsif ($arg =~ /^--threshold=([\d\.]+)%?$/) { - $single_threshold = $1; - ($1 >= 0 && $1 <= 20) or die($usage); - - # --show-percs=yes|no - } elsif ($arg =~ /^--show-percs=yes$/) { - $show_percs = 1; - } elsif ($arg =~ /^--show-percs=no$/) { - $show_percs = 0; - - # --auto=yes|no - } elsif ($arg =~ /^--auto=yes$/) { - $auto_annotate = 1; - } elsif ($arg =~ /^--auto=no$/) { - $auto_annotate = 0; - - # --context=N - } elsif ($arg =~ /^--context=([\d\.]+)$/) { - $context = $1; - if ($context < 0) { - die($usage); - } - - # We don't handle "-I name" -- there can be no space. - } elsif ($arg =~ /^-I$/) { - die("Sorry, no space is allowed after a -I flag\n"); - - # --include=A,B,C. Allow -I=name for backwards compatibility. - } elsif ($arg =~ /^(-I=|-I|--include=)(.*)$/) { - my $inc = $2; - $inc =~ s|/$||; # trim trailing '/' - push(@include_dirs, "$inc/"); - - } else { # -h and --help fall under this case - die($usage); - } - - # Argument handling -- annotation file checking and selection. - # Stick filenames into a hash for quick 'n easy lookup throughout. - } else { - if (not defined $input_file) { - # First non-option argument is the output file. - $input_file = $arg; - } else { - # Subsequent non-option arguments are source files. - my $readable = 0; - foreach my $include_dir (@include_dirs) { - if (-r $include_dir . $arg) { - $readable = 1; - } - } - $readable or die("File $arg not found in any of: @include_dirs\n"); - $user_ann_files{$arg} = 1; - } - } - } - - # Must have chosen an input file - if (not defined $input_file) { - die($usage); - } -} - -#----------------------------------------------------------------------------- -# Reading of input file -#----------------------------------------------------------------------------- -sub max ($$) -{ - my ($x, $y) = @_; - return ($x > $y ? $x : $y); -} - -# Add the two arrays; any '.' entries are ignored. Two tricky things: -# 1. If $a2->[$i] is undefined, it defaults to 0 which is what we want; we turn -# off warnings to allow this. This makes things about 10% faster than -# checking for definedness ourselves. -# 2. We don't add an undefined count or a ".", even though it's value is 0, -# because we don't want to make an $a2->[$i] that is undef become 0 -# unnecessarily. -sub add_array_a_to_b ($$) -{ - my ($a1, $a2) = @_; - - my $n = max(scalar @$a1, scalar @$a2); - $^W = 0; - foreach my $i (0 .. $n-1) { - $a2->[$i] += $a1->[$i] if (defined $a1->[$i] && "." ne $a1->[$i]); - } - $^W = 1; -} - -# Add each event count to the CC array. '.' counts become undef, as do -# missing entries (implicitly). -sub line_to_CC ($) -{ - my @CC = (split /\s+/, $_[0]); - (@CC <= @events) or die("Line $.: too many event counts\n"); - return \@CC; -} - -sub read_input_file() -{ - open(INPUTFILE, "< $input_file") - || die "Cannot open $input_file for reading\n"; - - # Read "desc:" lines. - my $line; - while ($line = <INPUTFILE>) { - if ($line =~ s/desc:\s+//) { - $desc .= $line; - } else { - last; - } - } - - # Read "cmd:" line (Nb: will already be in $line from "desc:" loop above). - ($line =~ s/^cmd:\s+//) or die("Line $.: missing command line\n"); - $cmd = $line; - chomp($cmd); # Remove newline - - # Read "events:" line. We make a temporary hash in which the Nth event's - # value is N, which is useful for handling --show/--sort options below. - $line = <INPUTFILE>; - (defined $line && $line =~ s/^events:\s+//) - or die("Line $.: missing events line\n"); - @events = split(/\s+/, $line); - my %events; - my $n = 0; - foreach my $event (@events) { - $events{$event} = $n; - $n++ - } - - # If no --show arg give, default to showing all events in the file. - # If --show option is used, check all specified events appeared in the - # "events:" line. Then initialise @show_order. - if (@show_events) { - foreach my $show_event (@show_events) { - (defined $events{$show_event}) or - die("--show event `$show_event' did not appear in input\n"); - } - } else { - @show_events = @events; - } - foreach my $show_event (@show_events) { - push(@show_order, $events{$show_event}); - } - - # Do as for --show, but if no --sort arg given, default to sorting by - # column order (ie. first column event is primary sort key, 2nd column is - # 2ndary key, etc). - if (@sort_events) { - foreach my $sort_event (@sort_events) { - (defined $events{$sort_event}) or - die("--sort event `$sort_event' did not appear in input\n"); - } - } else { - @sort_events = @events; - } - foreach my $sort_event (@sort_events) { - push(@sort_order, $events{$sort_event}); - } - - # If multiple threshold args weren't given via --sort, stick in the single - # threshold (either from --threshold if used, or the default otherwise) for - # the primary sort event, and 0% for the rest. - if (not @thresholds) { - foreach my $e (@sort_order) { - push(@thresholds, 100); - } - $thresholds[0] = $single_threshold; - } - - my $currFileName; - my $currFileFuncName; - - my $currFuncCC; - my $currFileCCs = {}; # hash(line_num => CC) - - # Read body of input file. - while (<INPUTFILE>) { - # Skip comments and empty lines. - next if /^\s*$/ || /^\#/; - - if (s/^(-?\d+)\s+//) { - my $lineNum = $1; - my $CC = line_to_CC($_); - defined($currFuncCC) || die; - add_array_a_to_b($CC, $currFuncCC); - - # If currFileName is selected, add CC to currFileName list. We look for - # full filename matches; or, if auto-annotating, we have to - # remember everything -- we won't know until the end what's needed. - defined($currFileCCs) || die; - if ($auto_annotate || defined $user_ann_files{$currFileName}) { - my $currLineCC = $currFileCCs->{$lineNum}; - if (not defined $currLineCC) { - $currLineCC = []; - $currFileCCs->{$lineNum} = $currLineCC; - } - add_array_a_to_b($CC, $currLineCC); - } - - } elsif (s/^fn=(.*)$//) { - $currFileFuncName = "$currFileName:$1"; - $currFuncCC = $fn_totals{$currFileFuncName}; - if (not defined $currFuncCC) { - $currFuncCC = []; - $fn_totals{$currFileFuncName} = $currFuncCC; - } - - } elsif (s/^fl=(.*)$//) { - $currFileName = $1; - $currFileCCs = $allCCs{$currFileName}; - if (not defined $currFileCCs) { - $currFileCCs = {}; - $allCCs{$currFileName} = $currFileCCs; - } - # Assume that a "fn=" line is followed by a "fl=" line. - $currFileFuncName = undef; - - } elsif (s/^summary:\s+//) { - $summary_CC = line_to_CC($_); - (scalar(@$summary_CC) == @events) - or die("Line $.: summary event and total event mismatch\n"); - - } else { - warn("WARNING: line $. malformed, ignoring\n"); - } - } - - # Check if summary line was present - if (not defined $summary_CC) { - die("missing final summary line, aborting\n"); - } - - close(INPUTFILE); -} - -#----------------------------------------------------------------------------- -# Print options used -#----------------------------------------------------------------------------- -sub print_options () -{ - print($fancy); - print($desc); - print("Command: $cmd\n"); - print("Data file: $input_file\n"); - print("Events recorded: @events\n"); - print("Events shown: @show_events\n"); - print("Event sort order: @sort_events\n"); - print("Thresholds: @thresholds\n"); - - my @include_dirs2 = @include_dirs; # copy @include_dirs - shift(@include_dirs2); # remove "" entry, which is always the first - unshift(@include_dirs2, "") if (0 == @include_dirs2); - my $include_dir = shift(@include_dirs2); - print("Include dirs: $include_dir\n"); - foreach my $include_dir (@include_dirs2) { - print(" $include_dir\n"); - } - - my @user_ann_files = keys %user_ann_files; - unshift(@user_ann_files, "") if (0 == @user_ann_files); - my $user_ann_file = shift(@user_ann_files); - print("User annotated: $user_ann_file\n"); - foreach $user_ann_file (@user_ann_files) { - print(" $user_ann_file\n"); - } - - my $is_on = ($auto_annotate ? "on" : "off"); - print("Auto-annotation: $is_on\n"); - print("\n"); -} - -#----------------------------------------------------------------------------- -# Print summary and sorted function totals -#----------------------------------------------------------------------------- -sub mycmp ($$) -{ - my ($c, $d) = @_; - - # Iterate through sort events (eg. 3,2); return result if two are different - foreach my $i (@sort_order) { - my ($x, $y); - $x = $c->[$i]; - $y = $d->[$i]; - $x = -1 unless defined $x; - $y = -1 unless defined $y; - - my $cmp = abs($y) <=> abs($x); # reverse sort of absolute size - if (0 != $cmp) { - return $cmp; - } - } - # Exhausted events, equal - return 0; -} - -sub commify ($) { - my ($val) = @_; - 1 while ($val =~ s/^(-?\d+)(\d{3})/$1,$2/); - return $val; -} - -# Because the counts can get very big, and we don't want to waste screen space -# and make lines too long, we compute exactly how wide each column needs to be -# by finding the widest entry for each one. -sub compute_CC_col_widths (@) -{ - my @CCs = @_; - my $CC_col_widths = []; - - # Initialise with minimum widths (from event names) - foreach my $event (@events) { - push(@$CC_col_widths, length($event)); - } - - # Find maximum width count for each column. @CC_col_width positions - # correspond to @CC positions. - foreach my $CC (@CCs) { - foreach my $i (0 .. scalar(@$CC)-1) { - if (defined $CC->[$i]) { - # Find length, accounting for commas that will be added, and - # possibly a percentage. - my $length = length $CC->[$i]; - my $width = $length + int(($length - 1) / 3); - if ($show_percs) { - $width += 9; # e.g. " (12.34%)" is 9 chars - } - $CC_col_widths->[$i] = max($CC_col_widths->[$i], $width); - } - } - } - return $CC_col_widths; -} - -# Print the CC with each column's size dictated by $CC_col_widths. -sub print_CC ($$) -{ - my ($CC, $CC_col_widths) = @_; - - foreach my $i (@show_order) { - my $count = (defined $CC->[$i] ? commify($CC->[$i]) : "."); - - my $perc = ""; - if ($show_percs) { - if (defined $CC->[$i] && $CC->[$i] != 0) { - # Try our best to keep the number fitting into 5 chars. This - # requires dropping a digit after the decimal place if it's - # sufficiently negative (e.g. "-10.0") or positive (e.g. - # "100.0"). Thanks to diffs it's possible to have even more - # extreme values, like "-100.0" or "1000.0"; those rare case - # will end up with slightly wrong indenting, oh well. - $perc = safe_div($CC->[$i] * 100, $summary_CC->[$i]); - $perc = (-9.995 < $perc && $perc < 99.995) - ? sprintf(" (%5.2f%%)", $perc) - : sprintf(" (%5.1f%%)", $perc); - } else { - # Don't show percentages for "." and "0" entries. - $perc = " "; - } - } - - # $reps will be negative for the extreme values mentioned above. The - # use of max() avoids a possible warning about a negative repeat count. - my $text = $count . $perc; - my $len = length($text); - my $reps = $CC_col_widths->[$i] - length($text); - my $space = ' ' x max($reps, 0); - print("$space$text "); - } -} - -sub print_events ($) -{ - my ($CC_col_widths) = @_; - - foreach my $i (@show_order) { - my $event = $events[$i]; - my $event_width = length($event); - my $col_width = $CC_col_widths->[$i]; - my $space = ' ' x ($col_width - $event_width); - print("$event$space "); - } -} - -# Prints summary and function totals (with separate column widths, so that -# function names aren't pushed over unnecessarily by huge summary figures). -# Also returns a hash containing all the files that are involved in getting the -# events count above the thresholds (ie. all the interesting ones). -sub print_summary_and_fn_totals () -{ - my @fn_fullnames = keys %fn_totals; - - # Work out the size of each column for printing (summary and functions - # separately). - my $summary_CC_col_widths = compute_CC_col_widths($summary_CC); - my $fn_CC_col_widths = compute_CC_col_widths(values %fn_totals); - - # Header and counts for summary - print($fancy); - print_events($summary_CC_col_widths); - print("\n"); - print($fancy); - print_CC($summary_CC, $summary_CC_col_widths); - print(" PROGRAM TOTALS\n"); - print("\n"); - - # Header for functions - print($fancy); - print_events($fn_CC_col_widths); - print(" file:function\n"); - print($fancy); - - # Sort function names into order dictated by --sort option. - @fn_fullnames = sort { - mycmp($fn_totals{$a}, $fn_totals{$b}) - } @fn_fullnames; - - - # Assertion - (scalar @sort_order == scalar @thresholds) or - die("sort_order length != thresholds length:\n", - " @sort_order\n @thresholds\n"); - - my $threshold_files = {}; - # @curr_totals has the same shape as @sort_order and @thresholds - my @curr_totals = (); - foreach my $e (@thresholds) { - push(@curr_totals, 0); - } - - # Print functions, stopping when the threshold has been reached. - foreach my $fn_name (@fn_fullnames) { - - my $fn_CC = $fn_totals{$fn_name}; - - # Stop when we've reached all the thresholds - my $any_thresholds_exceeded = 0; - foreach my $i (0 .. scalar @thresholds - 1) { - my $prop = safe_div(abs($fn_CC->[$sort_order[$i]] * 100), - abs($summary_CC->[$sort_order[$i]])); - $any_thresholds_exceeded ||= ($prop >= $thresholds[$i]); - } - last if not $any_thresholds_exceeded; - - # Print function results - print_CC($fn_CC, $fn_CC_col_widths); - print(" $fn_name\n"); - - # Update the threshold counts - my $filename = $fn_name; - $filename =~ s/:.+$//; # remove function name - $threshold_files->{$filename} = 1; - foreach my $i (0 .. scalar @sort_order - 1) { - $curr_totals[$i] += $fn_CC->[$sort_order[$i]] - if (defined $fn_CC->[$sort_order[$i]]); - } - } - print("\n"); - - return $threshold_files; -} - -#----------------------------------------------------------------------------- -# Annotate selected files -#----------------------------------------------------------------------------- - -# Issue a warning that the source file is more recent than the input file. -sub warning_on_src_more_recent_than_inputfile ($) -{ - my $src_file = $_[0]; - - my $warning = <<END -@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ -@@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ -@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ -@ Source file '$src_file' is more recent than input file '$input_file'. -@ Annotations may not be correct. -@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ +# - Formatters: +# - `black`, for general formatting. This avoids the need for style checkers +# like `flake8`. Note that `black` allows a max line length of 88, which is +# a mild but common PEP-8 violation. +# - `isort`, for import sorting. +# +# - Type-checkers: +# - `mypy --strict`. This is the most commonly used Python type checker. +# - `pyright`. This is another good type checker. The `pyright: strict` +# comment above forces strict checking. +# - Sometimes one type-checker will complain about something the other does +# not. The goal is to keep both type checkers happy. +# +# - Linters: +# - `ruff`. Sometimes useful, and very fast to run. +# - `pylint`. Sometimes annoying, sometimes useful. The `pylintrc` +# modifies/disables the more annoying lints. +# +# - Profilers: +# - `cProfile` + `snakeviz`: Typically run with +# `python3 -m cProfile -o cg.prof cg_annotate $INPUT && snakeviz cg.prof`. +# - `scalene`. Typically run with `scalene ./cg_annotate $INPUT`. +# +# - Packager: +# - `cp` is used for distribution. This is possible because this program is a +# single file and only uses the Python Standard Library. This avoids the +# needs for any of the million different Python package management tools. + + +from __future__ import annotations + +import os +import re +import sys +from argparse import ArgumentParser, BooleanOptionalAction, Namespace +from collections import defaultdict +from typing import Callable, DefaultDict, NewType, NoReturn, TextIO, TypeAlias + + +class Args(Namespace): + """ + A typed wrapper for parsed args. + + None of these fields are modified after arg parsing finishes. + """ + + show: list[str] + sort: list[str] + threshold: float # a percentage + show_percs: bool + auto: bool + context: int + include: list[str] + cgout_filename: list[str] + src_filenames: list[str] + + @staticmethod + def parse() -> Args: + def comma_separated_list(values: str) -> list[str]: + return values.split(",") + + def threshold(n: str) -> float: + f = float(n) + if 0 <= f <= 20: + return f + raise ValueError + + def add_bool_argument(p: ArgumentParser, name: str, help: str) -> None: + """ + Add a bool argument that defaults to true. + + Supports these forms: `--foo`, `--no-foo`, `--foo=yes`, `--foo=no`. + The latter two were the forms supported by the old Perl version of + `cg_annotate`, and are now deprecated. + """ + flag = "--" + name + dest = name.replace("-", "_") + + # Note: the default value is always printed with `BooleanOptionalAction`, + # due to an argparse bug: https://github.com/python/cpython/issues/83137. + p.add_argument( + flag, + default=True, + action=BooleanOptionalAction, + help=help, + ) + p.add_argument( + f"{flag}=yes", + dest=dest, + action="store_true", + help=f"(deprecated) same as --{name}", + ) + p.add_argument( + f"{flag}=no", + dest=dest, + action="store_false", + help=f"(deprecated) same as --no-{name}", + ) + + p = ArgumentParser(description="Process Cachegrind output files.") + + p.add_argument("--version", action="version", version="%(prog)s-@VERSION@") + + p.add_argument( + "--show", + type=comma_separated_list, + metavar="A,B,C", + help="only show figures for events A,B,C (default: all events)", + ) + + p.add_argument( + "--sort", + type=comma_separated_list, + metavar="A,B,C", + help="sort functions by events A,B,C (default: event column order)", + ) + + p.add_argument( + "--threshold", + type=threshold, + default=0.1, + metavar="N:[0,20]", + help="only show functions with more than N%% of primary sort event " + "counts (default: %(default)s)", + ) + add_bool_argument( + p, + "show-percs", + "show a percentage for each non-zero count", + ) + add_bool_argument( + p, + "auto", + "annotate all source files containing functions that reached the " + "event count threshold", + ) + p.add_argument( + "--context", + type=int, + default=8, + metavar="N", + help="print N lines of context before and after annotated lines " + "(default: %(default)s)", + ) + p.add_argument( + "-I", + "--include", + action="append", + default=[], + metavar="D", + help="add D to the list of searched source file directories", + ) + p.add_argument( + "cgout_filename", + nargs=1, + metavar="cachegrind-out-file", + help="file produced by Cachegrind", + ) + p.add_argument( + "src_filenames", + nargs="*", + metavar="source-files", + help="source files to annotate (usually not needed due to --auto)", + ) + + return p.parse_args(namespace=Args()) + + +# Args are stored in a global for easy access. +args = Args.parse() + + +# A single instance of this class is constructed, from `args` and the `events:` +# line in the cgout file. +class Events: + # The event names. + events: list[str] + + # The order in which we must traverse events for --show. Can be shorter + # than `events`. + show_events: list[str] + + # Like `show_events`, but indices into `events`, rather than names. + show_indices: list[int] + + # The order in which we must traverse events for --sort. Can be shorter + # than `events`. + sort_events: list[str] + + # Like `sort_events`, but indices into `events`, rather than names. + sort_indices: list[int] + + # Threshold percentages, one per sort event. Dictates when we stop printing + # functions. Positions correspond to positions in `sort_events`. Only + # `thresholds[0]` is actually used for thresholding, for historical + # reasons. + threshold_percs: list[float] + + def __init__(self, text: str) -> None: + self.events = text.split() + self.num_events = len(self.events) + + # A temporary dict mapping events to indices, [0, n-1]. + event_indices = {event: n for n, event in enumerate(self.events)} + + # If --show is given, check it is valid. If --show is not given, + # default to all events in the standard order. + if args.show: + for event in args.show: + if event not in event_indices: + die(f"--show event `{event}` did not appear in `events:` line") + self.show_events = args.show + else: + self.show_events = self.events + + self.show_indices = [event_indices[event] for event in self.show_events] + + # Likewise for --sort. + if args.sort: + for event in args.sort: + if event not in event_indices: + die(f"--sort event `{event}` did not appear in `events:` line") + self.sort_events = args.sort + else: + self.sort_events = self.events + + self.sort_indices = [event_indices[event] for event in self.sort_events] + + # The primary sort event gets the --threshold value, and all other sort + # events get 100% (i.e. ignored). + self.threshold_percs = [100] * len(self.sort_events) + self.threshold_percs[0] = args.threshold + + def mk_cc(self, text: str) -> Cc: + # This is slightly faster than a list comprehension. + counts = list(map(int, text.split())) + + if len(counts) == self.num_events: + pass + elif len(counts) < self.num_events: + # Add zeroes at the end for any missing numbers. + counts.extend([0] * (self.num_events - len(counts))) + else: + raise ValueError + + return Cc(counts) + + def mk_empty_cc(self) -> Cc: + # This is much faster than a list comprehension. + return Cc([0] * self.num_events) + + +class Cc: + """ + This is a dumb container for counts. + + It doesn't know anything about events, i.e. what each count means. It can + do basic operations like `__iadd__` and `__eq__`, and anything more must be + done elsewhere. `Events.mk_cc` and `Events.mk_empty_cc` are used for + construction. + """ + + # Always the same length as `Events.events`. + counts: list[int] + + def __init__(self, counts: list[int]) -> None: + self.counts = counts + + def __repr__(self) -> str: + return str(self.counts) + + def __eq__(self, other: object) -> bool: + if not isinstance(other, Cc): + return NotImplemented + return self.counts == other.counts + + def __iadd__(self, other: Cc) -> Cc: + for i, other_count in enumerate(other.counts): + self.counts[i] += other_count + return self + + +# A paired filename and function name. +Flfn = NewType("Flfn", tuple[str, str]) + +# Per-function CCs. +DictFlfnCc: TypeAlias = DefaultDict[Flfn, Cc] + +# Per-line CCs, organised by filename and line number. +DictLineCc: TypeAlias = DefaultDict[int, Cc] +DictFlDictLineCc: TypeAlias = DefaultDict[str, DictLineCc] + + +def die(msg: str) -> NoReturn: + print("cg_annotate: error:", msg, file=sys.stderr) + sys.exit(1) + + +def read_cgout_file() -> tuple[str, str, Events, DictFlfnCc, DictFlDictLineCc, Cc]: + # The file format is described in Cachegrind's manual. + try: + cgout_file = open(args.cgout_filename[0], "r", encoding="utf-8") + except OSError as err: + die(f"{err}") + + with cgout_file: + cgout_line_num = 0 + + def parse_die(msg: str) -> NoReturn: + die(f"{cgout_file.name}:{cgout_line_num}: {msg}") + + def readline() -> str: + nonlocal cgout_line_num + cgout_line_num += 1 + return cgout_file.readline() + + # Read "desc:" lines. + desc = "" + while line := readline(): + if m := re.match(r"desc:\s+(.*)", line): + desc += m.group(1) + "\n" + else: + break + + # Read "cmd:" line. (`line` is already set from the "desc:" loop.) + if m := re.match(r"cmd:\s+(.*)", line): + cmd = m.group(1) + else: + parse_die("missing a `command:` line") + + # Read "events:" line. + line = readline() + if m := re.match(r"events:\s+(.*)", line): + events = Events(m.group(1)) + else: + parse_die("missing an `events:` line") + + def mk_empty_dict_line_cc() -> DictLineCc: + return defaultdict(events.mk_empty_cc) + + curr_fl = "" + curr_flfn = Flfn(("", "")) + + # Three different places where we accumulate CC data. + dict_flfn_cc: DictFlfnCc = defaultdict(events.mk_empty_cc) + dict_fl_dict_line_cc: DictFlDictLineCc = defaultdict(mk_empty_dict_line_cc) + summary_cc = None + + # Compile the one hot regex. + count_pat = re.compile(r"(\d+)\s+(.*)") + + # Line matching is done in order of pattern frequency, for speed. + while True: + line = readline() + + if m := count_pat.match(line): + line_num = int(m.group(1)) + try: + cc = events.mk_cc(m.group(2)) + except ValueError: + parse_die("malformed or too many event counts") + + # Record this CC at the function level. + flfn_cc = dict_flfn_cc[curr_flfn] + flfn_cc += cc + + # Record this CC at the file/line level. + line_cc = dict_fl_dict_line_cc[curr_fl][line_num] + line_cc += cc + + elif line.startswith("fn="): + curr_flfn = Flfn((curr_fl, line[3:-1])) + + elif line.startswith("fl="): + curr_fl = line[3:-1] + # A `fn=` line should follow, overwriting the "???". + curr_flfn = Flfn((curr_fl, "???")) + + elif m := re.match(r"summary:\s+(.*)", line): + try: + summary_cc = events.mk_cc(m.group(1)) + except ValueError: + parse_die("too many event counts") + + elif line == "": + break # EOF + + elif line == "\n" or line.startswith("#"): + # Skip empty lines and comment lines. + pass + + else: + parse_die(f"malformed line: {line[:-1]}") + + # Check if summary line was present. + if not summary_cc: + parse_die("missing `summary:` line, aborting") + + # Check summary is correct. + total_cc = events.mk_empty_cc() + for flfn_cc in dict_flfn_cc.values(): + total_cc += flfn_cc + if summary_cc != total_cc: + msg = ( + "`summary:` line doesn't match compute total\n" + f"- summary: {summary_cc}\n" + f"- total: {total_cc}" + ) + parse_die(msg) + + return (desc, cmd, events, dict_flfn_cc, dict_fl_dict_line_cc, summary_cc) + + +def safe_perc(m: int, n: int) -> float: + return 0 if n == 0 else m * 100 / n + + +class CcPrinter: + # Note: every `CcPrinter` gets the same `Events` object. + events: Events + + # Note: every `CcPrinter` gets the same summary CC. + summary_cc: Cc + + # The width of each event column. For simplicity, its length matches + # `events.events`, even though not all events are necessarily shown. + widths: list[int] + + def __init__(self, events: Events, ccs: list[Cc], summary_cc: Cc) -> None: + self.events = events + self.summary_cc = summary_cc + + # Find min and max value for each event. One of them will be the + # widest value. + min_cc = events.mk_empty_cc() + max_cc = events.mk_empty_cc() + for cc in ccs: + for i, _ in enumerate(events.events): + count = cc.counts[i] + if count > max_cc.counts[i]: + max_cc.counts[i] = count + elif count < min_cc.counts[i]: + min_cc.counts[i] = count + + # Find maximum width for each column. + self.widths = [0] * len(events.events) + for i, event in enumerate(events.events): + # Get widest of the min and max, accounting for commas that will be + # added, and a possible percentage. + width = max(len(str(min_cc.counts[i])), len(str(max_cc.counts[i]))) + width += (width - 1) // 3 + if args.show_percs: + width += 9 # e.g. " (12.34%)" is 9 chars. + + # Account for the event name, too. + self.widths[i] = max(width, len(event)) + + def print_events(self, suffix: str) -> None: + for i in self.events.show_indices: + # +1 is for the single space between columns. + print(f"{self.events.events[i]:{self.widths[i] + 1}}", end="") + + print(suffix) + + def print_count(self, i: int, text: str) -> None: + print(f"{text:>{self.widths[i]}}", end=" ") + + def print_cc(self, cc: Cc, suffix: str) -> None: + for i in self.events.show_indices: + nstr = f"{cc.counts[i]:,d}" # commify + if args.show_percs: + if cc.counts[i] != 0: + # Try our best to keep the number fitting into 5 chars. This + # requires dropping a digit after the decimal place if it's + # sufficiently negative (e.g. "-10.0") or positive (e.g. + # "100.0"). Thanks to diffs it's possible to have even more + # extreme values, like "-100.0" or "1000.0"; those rare case + # will end up with slightly wrong indenting, oh well. + p = safe_perc(cc.counts[i], self.summary_cc.counts[i]) + normal = -9.995 < p < 99.995 + perc = f" ({p:5.{2 if normal else 1}f}%)" + else: + # Don't show percentages for "0" entries, it's just clutter. + perc = " " + else: + perc = "" + + self.print_count(i, nstr + perc) + + print("", suffix) + + def print_missing_cc(self, suffix: str) -> None: + if args.show_percs: + # Don't show percentages for "." entries, it's just clutter. + text = ". " + else: + text = "." + + for i in self.events.show_indices: + self.print_count(i, text) + + print("", suffix) + + +# Used in various places in the output. +FANCY: str = "-" * 80 + + +def print_header(desc: str, cmd: str, events: Events) -> None: + print(FANCY) + print(desc, end="") + print("Command: ", cmd) + print("Data file: ", args.cgout_filename[0]) + print("Events recorded: ", *events.events) + print("Events shown: ", *events.show_events) + print("Event sort order:", *events.sort_events) + print("Thresholds: ", *events.threshold_percs) + + if len(args.include) == 0: + print("Include dirs: ") + else: + print(f"Include dirs: {args.include[0]}") + for include_dirname in args.include[1:]: + print(f" {include_dirname}") + + if len(args.src_filenames) == 0: + print("User annotated: ") + else: + print(f"User annotated: {args.src_filenames[0]}") + for src_filename in args.src_filenames[1:]: + print(f" {src_filename}") + + print("Auto-annotation: ", "on" if args.auto else "off") + print() + + +def print_summary_cc(events: Events, summary_cc: Cc) -> None: + printer = CcPrinter(events, [summary_cc], summary_cc) + + print(FANCY) + printer.print_events("") + print(FANCY) + printer.print_cc(summary_cc, "PROGRAM TOTALS") + print() + + +def print_flfn_ccs( + events: Events, dict_flfn_cc: DictFlfnCc, summary_cc: Cc +) -> set[str]: + # Only the first threshold percentage is actually used. + threshold_index = events.sort_indices[0] + + # Convert the threshold from a percentage to an event count. + threshold = ( + events.threshold_percs[0] * abs(summary_cc.counts[threshold_index]) / 100 + ) + + def meets_threshold(flfn_and_cc: tuple[Flfn, Cc]) -> bool: + cc = flfn_and_cc[1] + return abs(cc.counts[threshold_index]) >= threshold + + # Create a list with the counts in sort order, so that left-to-right list + # comparison does the right thing. Plus the `Flfn` at the end for + # deterministic output when all the event counts are identical in two CCs. + def key(flfn_and_cc: tuple[Flfn, Cc]) -> tuple[list[int], Flfn]: + cc = flfn_and_cc[1] + return ([abs(cc.counts[i]) for i in events.sort_indices], flfn_and_cc[0]) + + # Filter out functions for which the primary sort event count is below the + # threshold, and sort the remainder. + filtered_flfns_and_ccs = filter(meets_threshold, dict_flfn_cc.items()) + sorted_flfns_and_ccs = sorted(filtered_flfns_and_ccs, key=key, reverse=True) + sorted_ccs = list(map(lambda flfn_and_cc: flfn_and_cc[1], sorted_flfns_and_ccs)) + + printer = CcPrinter(events, sorted_ccs, summary_cc) + + print(FANCY) + printer.print_events(" file:function") + print(FANCY) -END -; - print($warning); -} - -# If there is information about lines not in the file, issue a warning -# explaining possible causes. -sub warning_on_nonexistent_lines ($$$) -{ - my ($src_more_recent_than_inputfile, $src_file, $excess_line_nums) = @_; - my $cause_and_solution; - - if ($src_more_recent_than_inputfile) { - $cause_and_solution = <<END -@@ cause: '$src_file' has changed since information was gathered. -@@ If so, a warning will have already been issued about this. -@@ solution: Recompile program and rerun under "valgrind --cachesim=yes" to -@@ gather new information. -END - # We suppress warnings about .h files - } elsif ($src_file =~ /\.h$/) { - $cause_and_solution = <<END -@@ cause: bug in the Valgrind's debug info reader that screws up with .h -@@ files sometimes -@@ solution: none, sorry -END - } else { - $cause_and_solution = <<END -@@ cause: not sure, sorry -END - } - - my $warning = <<END + # Print per-function counts. + for flfn, flfn_cc in sorted_flfns_and_ccs: + printer.print_cc(flfn_cc, f"{flfn[0]}:{flfn[1]}") + + print() + + # Files containing a function that met the threshold. + return set(flfn_and_cc[0][0] for flfn_and_cc in sorted_flfns_and_ccs) + + +def mk_warning(msg: str) -> str: + return f"""\ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ WARNING @@ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ -@@ -@@ Information recorded about lines past the end of '$src_file'. -@@ -@@ Probable cause and solution: -$cause_and_solution@@ +{msg}\ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ -END -; - print($warning); -} - -sub annotate_ann_files($) -{ - my ($threshold_files) = @_; - - my %all_ann_files; - my @unfound_auto_annotate_files; - my $printed_totals_CC = []; - - # If auto-annotating, add interesting files (but not "???") - if ($auto_annotate) { - delete $threshold_files->{"???"}; - %all_ann_files = (%user_ann_files, %$threshold_files) - } else { - %all_ann_files = %user_ann_files; - } - - # Track if we did any annotations. - my $did_annotations = 0; - - LOOP: - foreach my $src_file (keys %all_ann_files) { - - my $opened_file = ""; - my $full_file_name = ""; - # Nb: include_dirs already includes "", so it works in the case - # where the filename has the full path. - foreach my $include_dir (@include_dirs) { - my $try_name = $include_dir . $src_file; - if (open(INPUTFILE, "< $try_name")) { - $opened_file = $try_name; - $full_file_name = ($include_dir eq "" - ? $src_file - : "$include_dir + $src_file"); - last; - } - } - - if (not $opened_file) { - # Failed to open the file. If chosen on the command line, die. - # If arose from auto-annotation, print a little message. - if (defined $user_ann_files{$src_file}) { - die("File $src_file not opened in any of: @include_dirs\n"); - - } else { - push(@unfound_auto_annotate_files, $src_file); - } - - } else { - # File header (distinguish between user- and auto-selected files). - print("$fancy"); - my $ann_type = - (defined $user_ann_files{$src_file} ? "User" : "Auto"); - print("-- $ann_type-annotated source: $full_file_name\n"); - print("$fancy"); - - # Get file's CCs - my $src_file_CCs = $allCCs{$src_file}; - if (!defined $src_file_CCs) { - print(" No information has been collected for $src_file\n\n"); - next LOOP; - } - - $did_annotations = 1; - - # Numeric, not lexicographic sort! - my @line_nums = sort {$a <=> $b} keys %$src_file_CCs; - - # If $src_file more recent than cachegrind.out, issue warning - my $src_more_recent_than_inputfile = 0; - if ((stat $opened_file)[9] > (stat $input_file)[9]) { - $src_more_recent_than_inputfile = 1; - warning_on_src_more_recent_than_inputfile($src_file); - } - - # Work out the size of each column for printing - my $CC_col_widths = compute_CC_col_widths(values %$src_file_CCs); - - # Events header - print_events($CC_col_widths); - print("\n\n"); - - # Shift out 0 if it's in the line numbers (from unknown entries, - # likely due to bugs in Valgrind's stabs debug info reader) - shift(@line_nums) if (0 == $line_nums[0]); - - # Finds interesting line ranges -- all lines with a CC, and all - # lines within $context lines of a line with a CC. - my $n = @line_nums; - my @pairs; - for (my $i = 0; $i < $n; $i++) { - push(@pairs, $line_nums[$i] - $context); # lower marker - while ($i < $n-1 && - $line_nums[$i] + 2*$context >= $line_nums[$i+1]) { - $i++; - } - push(@pairs, $line_nums[$i] + $context); # upper marker - } - - # Annotate chosen lines, tracking total counts of lines printed - if (@pairs) { - $pairs[0] = 1 if ($pairs[0] < 1); - while (@pairs) { - my $low = shift @pairs; - my $high = shift @pairs; - while ($. < $low-1) { - my $tmp = <INPUTFILE>; - last unless (defined $tmp); # hack to detect EOF - } - my $src_line; - # Print line number, unless start of file - print("-- line $low " . '-' x 40 . "\n") if ($low != 1); - while (($. < $high) && ($src_line = <INPUTFILE>)) { - if (defined $line_nums[0] && $. == $line_nums[0]) { - print_CC($src_file_CCs->{$.}, $CC_col_widths); - add_array_a_to_b($src_file_CCs->{$.}, - $printed_totals_CC); - shift(@line_nums); - - } else { - print_CC([], $CC_col_widths); - } - - print(" $src_line"); - } - # Print line number, unless EOF - if ($src_line) { - print("-- line $high " . '-' x 40 . "\n"); - } else { - last; - } - } - } - - # If there was info on lines past the end of the file... - if (@line_nums) { - foreach my $line_num (@line_nums) { - print_CC($src_file_CCs->{$line_num}, $CC_col_widths); - print(" <bogus line $line_num>\n"); - } - print("\n"); - warning_on_nonexistent_lines($src_more_recent_than_inputfile, - $src_file, \@line_nums); - } - print("\n"); - - # Print summary of counts attributed to file but not to any - # particular line (due to incomplete debug info). - if ($src_file_CCs->{0}) { - print_CC($src_file_CCs->{0}, $CC_col_widths); - print(" <counts for unidentified lines in $src_file>\n\n"); - } - - close(INPUTFILE); - } - } - - # Print list of unfound auto-annotate selected files. - if (@unfound_auto_annotate_files) { - print("$fancy"); - print("The following files chosen for auto-annotation could not be found:\n"); - print($fancy); - foreach my $f (sort @unfound_auto_annotate_files) { - print(" $f\n"); - } - print("\n"); - } +""" + +def warn_src_file_is_newer(src_filename: str, cgout_filename: str) -> None: + msg = f"""\ +@ Source file '{src_filename}' is more recent than input file '{cgout_filename}'. +@ Annotations may not be correct. +""" + print(mk_warning(msg)) + + +def warn_bogus_lines(src_filename: str) -> None: +... [truncated message content] |