Menu
▾
▴
[Valgrind-developers] valgrind: r13516: When XML mode is selected messages from VALGRIND_PRINTF and friends
|
From: <sv...@va...> - 2013-08-27 15:18:13
|
florian 2013-08-27 15:17:53 +0000 (Tue, 27 Aug 2013)
New Revision: 13516
Log:
When XML mode is selected messages from VALGRIND_PRINTF and friends
should go to the XML stream not stderr. Fixes BZ 322807.
Added files:
trunk/memcheck/tests/client-msg-as-xml.stderr.exp
trunk/memcheck/tests/client-msg-as-xml.vgtest
trunk/memcheck/tests/client-msg.c
trunk/memcheck/tests/client-msg.stderr.exp
trunk/memcheck/tests/client-msg.vgtest
Modified directories:
trunk/memcheck/tests/
Modified files:
trunk/NEWS
trunk/coregrind/m_scheduler/scheduler.c
trunk/docs/internals/xml-output-protocol4.txt
trunk/memcheck/tests/Makefile.am
Modified: trunk/memcheck/tests/
Modified: trunk/NEWS (+3 -0)
===================================================================
--- trunk/NEWS 2013-08-27 10:23:23 +00:00 (rev 13515)
+++ trunk/NEWS 2013-08-27 15:17:53 +00:00 (rev 13516)
@@ -443,6 +443,9 @@
321960 pthread_create() then alloca() causing invalid stack write errors
FIXED 13467
+322807 VALGRIND_PRINTF_BACKTRACE writes callstack to xml and text to stderr
+ FIXED 13516
+
322851 0bXXX binary literal syntax is not standard
FIXED 2736
Modified: trunk/coregrind/m_scheduler/scheduler.c (+84 -11)
===================================================================
--- trunk/coregrind/m_scheduler/scheduler.c 2013-08-27 10:23:23 +00:00 (rev 13515)
+++ trunk/coregrind/m_scheduler/scheduler.c 2013-08-27 15:17:53 +00:00 (rev 13516)
@@ -1654,6 +1654,76 @@
}
+/* Write out a client message, possibly including a back trace. Return
+ the number of characters written. In case of XML output, the format
+ string as well as any arguments it requires will be XML'ified.
+ I.e. special characters such as the angle brackets will be translated
+ into proper escape sequences. */
+static
+Int print_client_message( ThreadId tid, const HChar *format,
+ va_list *vargsp, Bool include_backtrace)
+{
+ Int count;
+
+ if (VG_(clo_xml)) {
+ /* Translate the format string as follows:
+ < --> <
+ > --> >
+ & --> &
+ %s --> %pS
+ Yes, yes, it's simplified but in synch with
+ myvprintf_str_XML_simplistic and VG_(debugLog_vprintf).
+ */
+
+ /* Allocate a buffer that is for sure large enough. */
+ HChar xml_format[VG_(strlen)(format) * 5 + 1];
+
+ const HChar *p;
+ HChar *q = xml_format;
+
+ for (p = format; *p; ++p) {
+ switch (*p) {
+ case '<': VG_(strcpy)(q, "<"); q += 4; break;
+ case '>': VG_(strcpy)(q, ">"); q += 4; break;
+ case '&': VG_(strcpy)(q, "&"); q += 5; break;
+ case '%':
+ /* Careful: make sure %%s stays %%s */
+ *q++ = *p++;
+ if (*p == 's') {
+ *q++ = 'p';
+ *q++ = 'S';
+ } else {
+ *q++ = *p;
+ }
+ break;
+
+ default:
+ *q++ = *p;
+ break;
+ }
+ }
+ *q = '\0';
+
+ VG_(printf_xml)( "<clientmsg>\n" );
+ VG_(printf_xml)( " <tid>%d</tid>\n", tid );
+ VG_(printf_xml)( " <text>" );
+ count = VG_(vprintf_xml)( xml_format, *vargsp );
+ VG_(printf_xml)( " </text>\n" );
+ } else {
+ count = VG_(vmessage)( Vg_ClientMsg, format, *vargsp );
+ VG_(message_flush)();
+ }
+
+ if (include_backtrace)
+ VG_(get_and_pp_StackTrace)( tid, VG_(clo_backtrace_size) );
+
+ if (VG_(clo_xml))
+ VG_(printf_xml)( "</clientmsg>\n" );
+
+ return count;
+}
+
+
/* Do a client request for the thread tid. After the request, tid may
or may not still be runnable; if not, the scheduler will have to
choose a new thread to run.
@@ -1708,6 +1778,7 @@
break;
case VG_USERREQ__PRINTF: {
+ const HChar* format = (HChar *)arg[1];
/* JRS 2010-Jan-28: this is DEPRECATED; use the
_VALIST_BY_REF version instead */
if (sizeof(va_list) != sizeof(UWord))
@@ -1718,13 +1789,14 @@
} u;
u.uw = (unsigned long)arg[2];
Int count =
- VG_(vmessage)( Vg_ClientMsg, (HChar *)arg[1], u.vargs );
- VG_(message_flush)();
+ print_client_message( tid, format, &u.vargs,
+ /* include_backtrace */ False );
SET_CLREQ_RETVAL( tid, count );
break;
}
case VG_USERREQ__PRINTF_BACKTRACE: {
+ const HChar* format = (HChar *)arg[1];
/* JRS 2010-Jan-28: this is DEPRECATED; use the
_VALIST_BY_REF version instead */
if (sizeof(va_list) != sizeof(UWord))
@@ -1735,28 +1807,29 @@
} u;
u.uw = (unsigned long)arg[2];
Int count =
- VG_(vmessage)( Vg_ClientMsg, (HChar *)arg[1], u.vargs );
- VG_(message_flush)();
- VG_(get_and_pp_StackTrace)( tid, VG_(clo_backtrace_size) );
+ print_client_message( tid, format, &u.vargs,
+ /* include_backtrace */ True );
SET_CLREQ_RETVAL( tid, count );
break;
}
case VG_USERREQ__PRINTF_VALIST_BY_REF: {
+ const HChar* format = (HChar *)arg[1];
va_list* vargsp = (va_list*)arg[2];
- Int count =
- VG_(vmessage)( Vg_ClientMsg, (HChar *)arg[1], *vargsp );
- VG_(message_flush)();
+ Int count =
+ print_client_message( tid, format, vargsp,
+ /* include_backtrace */ False );
+
SET_CLREQ_RETVAL( tid, count );
break;
}
case VG_USERREQ__PRINTF_BACKTRACE_VALIST_BY_REF: {
+ const HChar* format = (HChar *)arg[1];
va_list* vargsp = (va_list*)arg[2];
Int count =
- VG_(vmessage)( Vg_ClientMsg, (HChar *)arg[1], *vargsp );
- VG_(message_flush)();
- VG_(get_and_pp_StackTrace)( tid, VG_(clo_backtrace_size) );
+ print_client_message( tid, format, vargsp,
+ /* include_backtrace */ True );
SET_CLREQ_RETVAL( tid, count );
break;
}
Modified: trunk/docs/internals/xml-output-protocol4.txt (+34 -1)
===================================================================
--- trunk/docs/internals/xml-output-protocol4.txt 2013-08-27 10:23:23 +00:00 (rev 13515)
+++ trunk/docs/internals/xml-output-protocol4.txt 2013-08-27 15:17:53 +00:00 (rev 13516)
@@ -190,7 +190,7 @@
human-understandable. In current Valgrind versions it is the
elapsed wallclock time since process start.
-* Zero or more of (either ERRORCOUNTS or TOOLSPECIFIC).
+* Zero or more of (either ERRORCOUNTS, TOOLSPECIFIC, or CLIENTMSG).
* The following, indicating that the program has now finished, and
that the any final wrapup (eg, for Memcheck, leak checking) is happening.
@@ -699,3 +699,36 @@
One of various miscellaneous noteworthy conditions was observed
(eg, thread exited whilst holding locks, "impossible" behaviour
from the underlying threading library, etc)
+
+====================================================================
+
+CLIENTMSG
+
+CLIENTMSG defines a message that was caused by one of the following
+client requests:
+
+- VALGRIND_PRINTF
+- VALGRIND_PRINTF_BACKTRACE
+
+Definition:
+
+<clientmsg>
+ <tid>INT</tid>
+ <text>...</text>
+</clientmsg>
+
+OR
+
+<clientmsg>
+ <tid>INT</tid>
+ <text>...</text>
+ STACK
+</clientmsg>
+
+* The <tid> tag indicates the Valgrind thread number.
+
+* The <text> tag indicates the message as specified in the client request
+ (properly translated to XML).
+
+* STACK is only present in case of VALGRIND_PRINTF_BACKTRACE. See above
+ for a definition of STACK.
Property changed: trunk/memcheck/tests (+0 -0)
___________________________________________________________________
Name: svn:ignore
- *.dSYM
*.stderr.diff*
*.stderr.out
*.stdout.diff*
*.stdout.out
.deps
accounting
addressable
atomic_incs
badaddrvalue
badfree
badjump
badjump2
badloop
badpoll
badrw
big_blocks_freed_list
brk
brk2
buflen_check
bug287260
calloc-overflow
clientperm
clientstackperm
clireq_nofill
clo_redzone
cond_ld_st
custom-overlap
custom_alloc
deep-backtrace
deep_templates
describe-block
dir
doublefree
dw4
erringfds
error_counts
errs1
err_disable1
err_disable2
err_disable3
err_disable4
execve1
execve2
exitprog
file_locking
filter_leak_check_size
filter_stderr
fprw
fwrite
hello
holey_buffer_too_small
inits
inline
leak-0
leak-cases
leak-cycle
leak-delta
leak-pool
leak-regroot
leak-segv-jmp
leak-tree
leakotron
linux-capget
linux-syscalls-2007
linux-syslog-syscall
linux-timerfd-syscall
long-supps
long_namespace_xml
lsframe1
lsframe2
Makefile
Makefile.in
mallinfo
malloc1
malloc2
malloc3
malloc_free_fill
malloc_usable
manuel1
manuel2
manuel3
match-overrun
memalign2
memalign_test
memcmptest
mempool
mempool2
metadata
mismatches
mmaptest
nanoleak
nanoleak2
nanoleak_supp
new_nothrow
new_override
noisy_child
null_socket
origin1-yes
origin2-not-quite
origin3-no
origin4-many
origin5-bz2
origin6-fp
oset_test
overlap
partiallydefinedeq
partial_load
pdb-realloc
pdb-realloc2
pipe
pointer-trace
post-syscall
realloc1
realloc2
realloc3
recursive-merge
sbfragment
scalar
scalar_exit_group
scalar_fork
scalar_supp
scalar_vfork
sendmsg
sh-mem
sh-mem-random
sigaltstack
sigkill
signal2
sigprocmask
stack_changes
stack_switch
static_malloc
strchr
str_tester
supp1
supp2
suppfree
supp_unknown
test-plo
threadederrno
trivialleak
undef_malloc_args
unit_libcbase
unit_oset
varinfo1
varinfo2
varinfo3
varinfo4
varinfo5
varinfo5so.so
varinfo6
vcpu_bz2
vcpu_fbench
vcpu_fnfns
vgtest_ume
weirdioctl
with space
wrap1
wrap2
wrap3
wrap4
wrap5
wrap6
wrap7
wrap7so.so
wrap8
writev1
xml1
zeropage
stpncpy
wcs
thread_alloca
+ *.dSYM
*.stderr.diff*
*.stderr.out
*.stdout.diff*
*.stdout.out
.deps
accounting
addressable
atomic_incs
badaddrvalue
badfree
badjump
badjump2
badloop
badpoll
badrw
big_blocks_freed_list
brk
brk2
buflen_check
bug287260
calloc-overflow
client-msg
clientperm
clientstackperm
clireq_nofill
clo_redzone
cond_ld_st
custom-overlap
custom_alloc
deep-backtrace
deep_templates
describe-block
dir
doublefree
dw4
erringfds
error_counts
errs1
err_disable1
err_disable2
err_disable3
err_disable4
execve1
execve2
exitprog
file_locking
filter_leak_check_size
filter_stderr
fprw
fwrite
hello
holey_buffer_too_small
inits
inline
leak-0
leak-cases
leak-cycle
leak-delta
leak-pool
leak-regroot
leak-segv-jmp
leak-tree
leakotron
linux-capget
linux-syscalls-2007
linux-syslog-syscall
linux-timerfd-syscall
long-supps
long_namespace_xml
lsframe1
lsframe2
Makefile
Makefile.in
mallinfo
malloc1
malloc2
malloc3
malloc_free_fill
malloc_usable
manuel1
manuel2
manuel3
match-overrun
memalign2
memalign_test
memcmptest
mempool
mempool2
metadata
mismatches
mmaptest
nanoleak
nanoleak2
nanoleak_supp
new_nothrow
new_override
noisy_child
null_socket
origin1-yes
origin2-not-quite
origin3-no
origin4-many
origin5-bz2
origin6-fp
oset_test
overlap
partiallydefinedeq
partial_load
pdb-realloc
pdb-realloc2
pipe
pointer-trace
post-syscall
realloc1
realloc2
realloc3
recursive-merge
sbfragment
scalar
scalar_exit_group
scalar_fork
scalar_supp
scalar_vfork
sendmsg
sh-mem
sh-mem-random
sigaltstack
sigkill
signal2
sigprocmask
stack_changes
stack_switch
static_malloc
strchr
str_tester
supp1
supp2
suppfree
supp_unknown
test-plo
threadederrno
trivialleak
undef_malloc_args
unit_libcbase
unit_oset
varinfo1
varinfo2
varinfo3
varinfo4
varinfo5
varinfo5so.so
varinfo6
vcpu_bz2
vcpu_fbench
vcpu_fnfns
vgtest_ume
weirdioctl
with space
wrap1
wrap2
wrap3
wrap4
wrap5
wrap6
wrap7
wrap7so.so
wrap8
writev1
xml1
zeropage
stpncpy
wcs
thread_alloca
Modified: trunk/memcheck/tests/Makefile.am (+3 -0)
===================================================================
--- trunk/memcheck/tests/Makefile.am 2013-08-27 10:23:23 +00:00 (rev 13515)
+++ trunk/memcheck/tests/Makefile.am 2013-08-27 15:17:53 +00:00 (rev 13516)
@@ -74,6 +74,8 @@
buflen_check.stderr.exp-kfail \
bug287260.stderr.exp bug287260.vgtest \
calloc-overflow.stderr.exp calloc-overflow.vgtest\
+ client-msg.stderr.exp client-msg.vgtest \
+ client-msg-as-xml.stderr.exp client-msg-as-xml.vgtest \
clientperm.stderr.exp \
clientperm.stdout.exp clientperm.vgtest \
clireq_nofill.stderr.exp \
@@ -273,6 +275,7 @@
buflen_check \
bug287260 \
calloc-overflow \
+ client-msg \
clientperm \
clireq_nofill \
clo_redzone \
Added: trunk/memcheck/tests/client-msg-as-xml.stderr.exp (+90 -0)
===================================================================
--- trunk/memcheck/tests/client-msg-as-xml.stderr.exp 2013-08-27 10:23:23 +00:00 (rev 13515)
+++ trunk/memcheck/tests/client-msg-as-xml.stderr.exp 2013-08-27 15:17:53 +00:00 (rev 13516)
@@ -0,0 +1,90 @@
+<?xml version="1.0"?>
+
+<valgrindoutput>
+
+<protocolversion>4</protocolversion>
+<protocoltool>memcheck</protocoltool>
+
+<preamble>
+ <line>...</line>
+ <line>...</line>
+ <line>...</line>
+ <line>...</line>
+</preamble>
+
+<pid>...</pid>
+<ppid>...</ppid>
+<tool>memcheck</tool>
+
+<args>
+ <vargv>...</vargv>
+ <argv>
+ <exe>./client-msg</exe>
+ </argv>
+</args>
+
+<status>
+ <state>RUNNING</state>
+ <time>...</time>
+</status>
+
+<clientmsg>
+ <tid>...</tid>
+ <text>hello <> <&>%s world
+ </text>
+ <stack>
+ <frame>
+ <ip>0x........</ip>
+ <obj>...</obj>
+ <fn>VALGRIND_PRINTF_BACKTRACE</fn>
+ <dir>...</dir>
+ <file>valgrind.h</file>
+ <line>...</line>
+ </frame>
+ <frame>
+ <ip>0x........</ip>
+ <obj>...</obj>
+ <fn>baz</fn>
+ <dir>...</dir>
+ <file>client-msg.c</file>
+ <line>...</line>
+ </frame>
+ <frame>
+ <ip>0x........</ip>
+ <obj>...</obj>
+ <fn>bar</fn>
+ <dir>...</dir>
+ <file>client-msg.c</file>
+ <line>...</line>
+ </frame>
+ <frame>
+ <ip>0x........</ip>
+ <obj>...</obj>
+ <fn>foo</fn>
+ <dir>...</dir>
+ <file>client-msg.c</file>
+ <line>...</line>
+ </frame>
+ <frame>
+ <ip>0x........</ip>
+ <obj>...</obj>
+ <fn>main</fn>
+ <dir>...</dir>
+ <file>client-msg.c</file>
+ <line>...</line>
+ </frame>
+ </stack>
+</clientmsg>
+
+<status>
+ <state>FINISHED</state>
+ <time>...</time>
+</status>
+
+<errorcounts>
+</errorcounts>
+
+<suppcounts>...</suppcounts>
+
+</valgrindoutput>
+
Added: trunk/memcheck/tests/client-msg-as-xml.vgtest (+3 -0)
===================================================================
--- trunk/memcheck/tests/client-msg-as-xml.vgtest 2013-08-27 10:23:23 +00:00 (rev 13515)
+++ trunk/memcheck/tests/client-msg-as-xml.vgtest 2013-08-27 15:17:53 +00:00 (rev 13516)
@@ -0,0 +1,3 @@
+prog: client-msg
+vgopts: --xml=yes --xml-fd=2 --log-file=/dev/null
+stderr_filter: filter_xml
Added: trunk/memcheck/tests/client-msg.c (+24 -0)
===================================================================
--- trunk/memcheck/tests/client-msg.c 2013-08-27 10:23:23 +00:00 (rev 13515)
+++ trunk/memcheck/tests/client-msg.c 2013-08-27 15:17:53 +00:00 (rev 13516)
@@ -0,0 +1,24 @@
+#include "valgrind.h"
+
+void baz()
+{
+ VALGRIND_PRINTF_BACKTRACE("hello <> %s%%s world\n","<&>");
+}
+
+void bar()
+{
+ baz();
+}
+
+void foo()
+{
+ bar();
+}
+
+int main()
+{
+ foo();
+
+ return 0;
+}
+
Added: trunk/memcheck/tests/client-msg.stderr.exp (+6 -0)
===================================================================
--- trunk/memcheck/tests/client-msg.stderr.exp 2013-08-27 10:23:23 +00:00 (rev 13515)
+++ trunk/memcheck/tests/client-msg.stderr.exp 2013-08-27 15:17:53 +00:00 (rev 13516)
@@ -0,0 +1,6 @@
+hello <> <&>%s world
+ ...
+ by 0x........: baz (client-msg.c:5)
+ by 0x........: bar (client-msg.c:10)
+ by 0x........: foo (client-msg.c:15)
+ by 0x........: main (client-msg.c:20)
Added: trunk/memcheck/tests/client-msg.vgtest (+2 -0)
===================================================================
--- trunk/memcheck/tests/client-msg.vgtest 2013-08-27 10:23:23 +00:00 (rev 13515)
+++ trunk/memcheck/tests/client-msg.vgtest 2013-08-27 15:17:53 +00:00 (rev 13516)
@@ -0,0 +1,2 @@
+prog: client-msg
+vgopts: -q
|
