| |
| /*--------------------------------------------------------------------*/ |
| /*--- Libc printing. m_libcprint.c ---*/ |
| /*--------------------------------------------------------------------*/ |
| |
| /* |
| This file is part of Valgrind, a dynamic binary instrumentation |
| framework. |
| |
| Copyright (C) 2000-2009 Julian Seward |
| jseward@acm.org |
| |
| 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. |
| |
| You should have received a copy of the GNU General Public License |
| along with this program; if not, write to the Free Software |
| Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
| 02111-1307, USA. |
| |
| The GNU General Public License is contained in the file COPYING. |
| */ |
| |
| #include "pub_core_basics.h" |
| #include "pub_core_vki.h" |
| #include "pub_core_debuglog.h" |
| #include "pub_core_libcbase.h" |
| #include "pub_core_libcassert.h" |
| #include "pub_core_libcfile.h" // VG_(write)(), VG_(write_socket)() |
| #include "pub_core_libcprint.h" |
| #include "pub_core_libcproc.h" // VG_(getpid)(), VG_(read_millisecond_timer() |
| #include "pub_core_options.h" |
| #include "valgrind.h" // For RUNNING_ON_VALGRIND |
| |
| |
| |
| /* --------------------------------------------------------------------- |
| Writing to file or a socket |
| ------------------------------------------------------------------ */ |
| |
| /* Tell the logging mechanism whether we are logging to a file |
| descriptor or a socket descriptor. */ |
| Bool VG_(logging_to_socket) = False; |
| |
| /* Do the low-level send of a message to the logging sink. */ |
| static void send_bytes_to_logging_sink ( Char* msg, Int nbytes ) |
| { |
| if (!VG_(logging_to_socket)) { |
| /* VG_(clo_log_fd) could have been set to -1 in the various |
| sys-wrappers for sys_fork, if --child-silent-after-fork=yes |
| is in effect. That is a signal that we should not produce |
| any more output. */ |
| if (VG_(clo_log_fd) >= 0) |
| VG_(write)( VG_(clo_log_fd), msg, nbytes ); |
| } else { |
| Int rc = VG_(write_socket)( VG_(clo_log_fd), msg, nbytes ); |
| if (rc == -1) { |
| // For example, the listener process died. Switch back to stderr. |
| VG_(logging_to_socket) = False; |
| VG_(clo_log_fd) = 2; |
| VG_(write)( VG_(clo_log_fd), msg, nbytes ); |
| } |
| } |
| } |
| |
| /* --------------------------------------------------------------------- |
| printf() and friends |
| ------------------------------------------------------------------ */ |
| |
| typedef |
| struct { |
| HChar buf[128]; |
| Int n; |
| } |
| printf_buf; |
| |
| static UInt vprintf_to_buf ( printf_buf *prbuf, |
| const HChar *format, va_list vargs ); |
| static UInt printf_to_buf ( printf_buf* prbuf, const HChar *format, ... ); |
| |
| // Adds a single char to the buffer. When the buffer gets sufficiently |
| // full, we write its contents to the logging sink. |
| static void add_to_myprintf_buf ( HChar c, void *p ) |
| { |
| printf_buf *myprintf_buf = (printf_buf *)p; |
| |
| if (myprintf_buf->n > sizeof(myprintf_buf->buf) - 2 ) { |
| send_bytes_to_logging_sink( myprintf_buf->buf, myprintf_buf->n ); |
| myprintf_buf->n = 0; |
| } |
| myprintf_buf->buf[myprintf_buf->n++] = c; |
| myprintf_buf->buf[myprintf_buf->n] = 0; |
| tl_assert(myprintf_buf->n < sizeof(myprintf_buf->buf)); |
| } |
| |
| UInt VG_(vprintf) ( const HChar *format, va_list vargs ) |
| { |
| UInt ret = 0; |
| printf_buf myprintf_buf = {"",0}; |
| |
| ret = vprintf_to_buf(&myprintf_buf, format, vargs); |
| // Write out any chars left in the buffer. |
| if (myprintf_buf.n > 0) { |
| send_bytes_to_logging_sink( myprintf_buf.buf, myprintf_buf.n ); |
| } |
| return ret; |
| } |
| |
| static UInt vprintf_to_buf ( printf_buf *prbuf, |
| const HChar *format, va_list vargs ) |
| { |
| UInt ret = 0; |
| |
| if (VG_(clo_log_fd) >= 0) { |
| ret = VG_(debugLog_vprintf) |
| ( add_to_myprintf_buf, prbuf, format, vargs ); |
| } |
| return ret; |
| } |
| |
| UInt VG_(printf) ( const HChar *format, ... ) |
| { |
| UInt ret; |
| va_list vargs; |
| |
| va_start(vargs, format); |
| ret = VG_(vprintf)(format, vargs); |
| va_end(vargs); |
| |
| return ret; |
| } |
| |
| static UInt printf_to_buf ( printf_buf* prbuf, const HChar *format, ... ) |
| { |
| UInt ret; |
| va_list vargs; |
| |
| va_start(vargs, format); |
| ret = vprintf_to_buf(prbuf, format, vargs); |
| va_end(vargs); |
| |
| return ret; |
| } |
| |
| /* A general replacement for sprintf(). */ |
| static void add_to_vg_sprintf_buf ( HChar c, void *p ) |
| { |
| char **vg_sprintf_ptr = p; |
| *(*vg_sprintf_ptr)++ = c; |
| } |
| |
| UInt VG_(vsprintf) ( Char* buf, const HChar *format, va_list vargs ) |
| { |
| Int ret; |
| Char *vg_sprintf_ptr = buf; |
| |
| ret = VG_(debugLog_vprintf) |
| ( add_to_vg_sprintf_buf, &vg_sprintf_ptr, format, vargs ); |
| add_to_vg_sprintf_buf('\0', &vg_sprintf_ptr); |
| |
| vg_assert(VG_(strlen)(buf) == ret); |
| |
| return ret; |
| } |
| |
| UInt VG_(sprintf) ( Char* buf, const HChar *format, ... ) |
| { |
| UInt ret; |
| va_list vargs; |
| |
| va_start(vargs,format); |
| ret = VG_(vsprintf)(buf, format, vargs); |
| va_end(vargs); |
| |
| return ret; |
| } |
| |
| |
| /* A replacement for snprintf. */ |
| typedef |
| struct { |
| HChar* buf; |
| Int buf_size; |
| Int buf_used; |
| } |
| snprintf_buf; |
| |
| static void add_to_vg_snprintf_buf ( HChar c, void* p ) |
| { |
| snprintf_buf* b = p; |
| if (b->buf_size > 0 && b->buf_used < b->buf_size) { |
| b->buf[b->buf_used++] = c; |
| if (b->buf_used < b->buf_size) |
| b->buf[b->buf_used] = 0; |
| else |
| b->buf[b->buf_size-1] = 0; /* pre: b->buf_size > 0 */ |
| } |
| } |
| |
| UInt VG_(vsnprintf) ( Char* buf, Int size, const HChar *format, va_list vargs ) |
| { |
| Int ret; |
| snprintf_buf b; |
| b.buf = buf; |
| b.buf_size = size < 0 ? 0 : size; |
| b.buf_used = 0; |
| |
| ret = VG_(debugLog_vprintf) |
| ( add_to_vg_snprintf_buf, &b, format, vargs ); |
| |
| return b.buf_used; |
| } |
| |
| UInt VG_(snprintf) ( Char* buf, Int size, const HChar *format, ... ) |
| { |
| UInt ret; |
| va_list vargs; |
| |
| va_start(vargs,format); |
| ret = VG_(vsnprintf)(buf, size, format, vargs); |
| va_end(vargs); |
| |
| return ret; |
| } |
| |
| |
| /* --------------------------------------------------------------------- |
| percentify() |
| ------------------------------------------------------------------ */ |
| |
| // Percentify n/m with d decimal places. Includes the '%' symbol at the end. |
| // Right justifies in 'buf'. |
| void VG_(percentify)(ULong n, ULong m, UInt d, Int n_buf, char buf[]) |
| { |
| Int i, len, space; |
| ULong p1; |
| Char fmt[32]; |
| |
| if (m == 0) { |
| // Have to generate the format string in order to be flexible about |
| // the width of the field. |
| VG_(sprintf)(fmt, "%%-%ds", n_buf); |
| // fmt is now "%<n_buf>s" where <d> is 1,2,3... |
| VG_(sprintf)(buf, fmt, "--%"); |
| return; |
| } |
| |
| p1 = (100*n) / m; |
| |
| if (d == 0) { |
| VG_(sprintf)(buf, "%lld%%", p1); |
| } else { |
| ULong p2; |
| UInt ex; |
| switch (d) { |
| case 1: ex = 10; break; |
| case 2: ex = 100; break; |
| case 3: ex = 1000; break; |
| default: VG_(tool_panic)("Currently can only handle 3 decimal places"); |
| } |
| p2 = ((100*n*ex) / m) % ex; |
| // Have to generate the format string in order to be flexible about |
| // the width of the post-decimal-point part. |
| VG_(sprintf)(fmt, "%%lld.%%0%dlld%%%%", d); |
| // fmt is now "%lld.%0<d>lld%%" where <d> is 1,2,3... |
| VG_(sprintf)(buf, fmt, p1, p2); |
| } |
| |
| len = VG_(strlen)(buf); |
| space = n_buf - len; |
| if (space < 0) space = 0; /* Allow for v. small field_width */ |
| i = len; |
| |
| /* Right justify in field */ |
| for ( ; i >= 0; i--) buf[i + space] = buf[i]; |
| for (i = 0; i < space; i++) buf[i] = ' '; |
| } |
| |
| |
| /* --------------------------------------------------------------------- |
| elapsed_wallclock_time() |
| ------------------------------------------------------------------ */ |
| |
| /* Get the elapsed wallclock time since startup into buf, which must |
| 16 chars long. This is unchecked. It also relies on the |
| millisecond timer having been set to zero by an initial read in |
| m_main during startup. */ |
| |
| void VG_(elapsed_wallclock_time) ( /*OUT*/HChar* buf ) |
| { |
| UInt t, ms, s, mins, hours, days; |
| |
| t = VG_(read_millisecond_timer)(); /* milliseconds */ |
| |
| ms = t % 1000; |
| t /= 1000; /* now in seconds */ |
| |
| s = t % 60; |
| t /= 60; /* now in minutes */ |
| |
| mins = t % 60; |
| t /= 60; /* now in hours */ |
| |
| hours = t % 24; |
| t /= 24; /* now in days */ |
| |
| days = t; |
| |
| VG_(sprintf)(buf, "%02u:%02u:%02u:%02u.%03u", days, hours, mins, s, ms); |
| } |
| |
| |
| /* --------------------------------------------------------------------- |
| message() |
| ------------------------------------------------------------------ */ |
| |
| UInt VG_(vmessage) ( VgMsgKind kind, const HChar* format, va_list vargs ) |
| { |
| UInt count = 0; |
| Char c; |
| Int i, depth; |
| printf_buf myprintf_buf = {"",0}; |
| |
| switch (kind) { |
| case Vg_UserMsg: c = '='; break; |
| case Vg_DebugMsg: c = '-'; break; |
| case Vg_DebugExtraMsg: c = '+'; break; |
| case Vg_ClientMsg: c = '*'; break; |
| default: c = '?'; break; |
| } |
| |
| // Print one '>' in front of the messages for each level of self-hosting |
| // being performed. |
| depth = RUNNING_ON_VALGRIND; |
| for (i = 0; i < depth; i++) { |
| count += printf_to_buf (&myprintf_buf, ">"); |
| } |
| |
| if (!VG_(clo_xml)) |
| count += printf_to_buf (&myprintf_buf, "%c%c", c,c); |
| |
| if (VG_(clo_time_stamp)) { |
| HChar buf[50]; |
| VG_(elapsed_wallclock_time)(buf); |
| count += printf_to_buf(&myprintf_buf, "%s ", buf); |
| } |
| |
| if (!VG_(clo_xml)) |
| count += printf_to_buf (&myprintf_buf, "%d%c%c ", VG_(getpid)(), c,c); |
| |
| count += vprintf_to_buf (&myprintf_buf, format, vargs); |
| count += printf_to_buf (&myprintf_buf, "\n"); |
| |
| if (myprintf_buf.n > 0) { |
| send_bytes_to_logging_sink( myprintf_buf.buf, myprintf_buf.n ); |
| } |
| |
| return count; |
| } |
| |
| /* Send a simple single-part XML message. */ |
| UInt VG_(message_no_f_c) ( VgMsgKind kind, const HChar* format, ... ) |
| { |
| UInt count; |
| va_list vargs; |
| va_start(vargs,format); |
| count = VG_(vmessage) ( kind, format, vargs ); |
| va_end(vargs); |
| return count; |
| } |
| |
| /* Send a simple single-part message. */ |
| UInt VG_(message) ( VgMsgKind kind, const HChar* format, ... ) |
| { |
| UInt count; |
| va_list vargs; |
| va_start(vargs,format); |
| count = VG_(vmessage) ( kind, format, vargs ); |
| va_end(vargs); |
| return count; |
| } |
| |
| /*--------------------------------------------------------------------*/ |
| /*--- end ---*/ |
| /*--------------------------------------------------------------------*/ |
| |