florian | 12d2eb5 | 2014-10-30 22:17:56 +0000 | [diff] [blame] | 1 | /* -*- mode: C; c-basic-offset: 3; -*- */ |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 2 | |
| 3 | /*--------------------------------------------------------------------*/ |
| 4 | /*--- Libc printing. m_libcprint.c ---*/ |
| 5 | /*--------------------------------------------------------------------*/ |
| 6 | |
| 7 | /* |
| 8 | This file is part of Valgrind, a dynamic binary instrumentation |
| 9 | framework. |
| 10 | |
sewardj | b3a1e4b | 2015-08-21 11:32:26 +0000 | [diff] [blame] | 11 | Copyright (C) 2000-2015 Julian Seward |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 12 | jseward@acm.org |
| 13 | |
| 14 | This program is free software; you can redistribute it and/or |
| 15 | modify it under the terms of the GNU General Public License as |
| 16 | published by the Free Software Foundation; either version 2 of the |
| 17 | License, or (at your option) any later version. |
| 18 | |
| 19 | This program is distributed in the hope that it will be useful, but |
| 20 | WITHOUT ANY WARRANTY; without even the implied warranty of |
| 21 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 22 | General Public License for more details. |
| 23 | |
| 24 | You should have received a copy of the GNU General Public License |
| 25 | along with this program; if not, write to the Free Software |
| 26 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA |
| 27 | 02111-1307, USA. |
| 28 | |
| 29 | The GNU General Public License is contained in the file COPYING. |
| 30 | */ |
| 31 | |
njn | c7561b9 | 2005-06-19 01:24:32 +0000 | [diff] [blame] | 32 | #include "pub_core_basics.h" |
sewardj | 4cfea4f | 2006-10-14 19:26:10 +0000 | [diff] [blame] | 33 | #include "pub_core_vki.h" |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 34 | #include "pub_core_debuglog.h" |
florian | c91f584 | 2013-09-15 10:42:26 +0000 | [diff] [blame] | 35 | #include "pub_core_gdbserver.h" // VG_(gdb_printf) |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 36 | #include "pub_core_libcbase.h" |
njn | 132bfcc | 2005-06-04 19:16:06 +0000 | [diff] [blame] | 37 | #include "pub_core_libcassert.h" |
sewardj | 592ae09 | 2005-11-08 19:01:44 +0000 | [diff] [blame] | 38 | #include "pub_core_libcfile.h" // VG_(write)(), VG_(write_socket)() |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 39 | #include "pub_core_libcprint.h" |
sewardj | 592ae09 | 2005-11-08 19:01:44 +0000 | [diff] [blame] | 40 | #include "pub_core_libcproc.h" // VG_(getpid)(), VG_(read_millisecond_timer() |
florian | 12d2eb5 | 2014-10-30 22:17:56 +0000 | [diff] [blame] | 41 | #include "pub_core_mallocfree.h" // VG_(malloc) |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 42 | #include "pub_core_options.h" |
florian | 1a046d5 | 2013-09-16 20:56:35 +0000 | [diff] [blame] | 43 | #include "pub_core_clreq.h" // For RUNNING_ON_VALGRIND |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 44 | |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 45 | |
| 46 | /* --------------------------------------------------------------------- |
| 47 | Writing to file or a socket |
| 48 | ------------------------------------------------------------------ */ |
| 49 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 50 | /* The destination sinks for normal and XML output. These have their |
| 51 | initial values here; they are set to final values by |
| 52 | m_main.main_process_cmd_line_options(). See comment at the top of |
sewardj | 3b29048 | 2011-05-06 21:02:55 +0000 | [diff] [blame] | 53 | that function for the associated logic. |
| 54 | After startup, the gdbserver monitor command might temporarily |
| 55 | set the fd of log_output_sink to -2 to indicate that output is |
| 56 | to be given to gdb rather than output to the startup fd */ |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 57 | OutputSink VG_(log_output_sink) = { 2, False }; /* 2 = stderr */ |
| 58 | OutputSink VG_(xml_output_sink) = { -1, False }; /* disabled */ |
| 59 | |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 60 | /* Do the low-level send of a message to the logging sink. */ |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 61 | static |
florian | dbb3584 | 2012-10-27 18:39:11 +0000 | [diff] [blame] | 62 | void send_bytes_to_logging_sink ( OutputSink* sink, const HChar* msg, Int nbytes ) |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 63 | { |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 64 | if (sink->is_socket) { |
| 65 | Int rc = VG_(write_socket)( sink->fd, msg, nbytes ); |
| 66 | if (rc == -1) { |
| 67 | // For example, the listener process died. Switch back to stderr. |
| 68 | sink->is_socket = False; |
| 69 | sink->fd = 2; |
| 70 | VG_(write)( sink->fd, msg, nbytes ); |
| 71 | } |
| 72 | } else { |
| 73 | /* sink->fd could have been set to -1 in the various |
sewardj | 6e31f80 | 2007-11-17 22:29:25 +0000 | [diff] [blame] | 74 | sys-wrappers for sys_fork, if --child-silent-after-fork=yes |
| 75 | is in effect. That is a signal that we should not produce |
| 76 | any more output. */ |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 77 | if (sink->fd >= 0) |
| 78 | VG_(write)( sink->fd, msg, nbytes ); |
philippe | 02ea413 | 2013-09-04 21:42:43 +0000 | [diff] [blame] | 79 | else if (sink->fd == -2 && nbytes > 0) |
| 80 | /* send to gdb the provided data, which must be |
| 81 | a null terminated string with len >= 1 */ |
sewardj | 3b29048 | 2011-05-06 21:02:55 +0000 | [diff] [blame] | 82 | VG_(gdb_printf)("%s", msg); |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 83 | } |
| 84 | } |
| 85 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 86 | |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 87 | /* --------------------------------------------------------------------- |
| 88 | printf() and friends |
| 89 | ------------------------------------------------------------------ */ |
| 90 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 91 | /* --------- printf --------- */ |
| 92 | |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 93 | typedef |
| 94 | struct { |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 95 | HChar buf[512]; |
| 96 | Int buf_used; |
| 97 | OutputSink* sink; |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 98 | } |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 99 | printf_buf_t; |
bart | 1a0cb6a | 2008-04-14 16:35:32 +0000 | [diff] [blame] | 100 | |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 101 | // Adds a single char to the buffer. When the buffer gets sufficiently |
| 102 | // full, we write its contents to the logging sink. |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 103 | static void add_to__printf_buf ( HChar c, void *p ) |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 104 | { |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 105 | printf_buf_t *b = (printf_buf_t *)p; |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 106 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 107 | if (b->buf_used > sizeof(b->buf) - 2 ) { |
| 108 | send_bytes_to_logging_sink( b->sink, b->buf, b->buf_used ); |
| 109 | b->buf_used = 0; |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 110 | } |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 111 | b->buf[b->buf_used++] = c; |
| 112 | b->buf[b->buf_used] = 0; |
florian | e2800c9 | 2014-09-15 20:57:45 +0000 | [diff] [blame] | 113 | vg_assert(b->buf_used < sizeof(b->buf)); |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 114 | } |
| 115 | |
| 116 | static UInt vprintf_to_buf ( printf_buf_t* b, |
| 117 | const HChar *format, va_list vargs ) |
| 118 | { |
| 119 | UInt ret = 0; |
sewardj | 3b29048 | 2011-05-06 21:02:55 +0000 | [diff] [blame] | 120 | if (b->sink->fd >= 0 || b->sink->fd == -2) { |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 121 | ret = VG_(debugLog_vprintf) |
| 122 | ( add_to__printf_buf, b, format, vargs ); |
| 123 | } |
| 124 | return ret; |
| 125 | } |
| 126 | |
| 127 | static UInt vprintf_WRK ( OutputSink* sink, |
| 128 | const HChar *format, va_list vargs ) |
| 129 | { |
| 130 | printf_buf_t myprintf_buf |
| 131 | = { "", 0, sink }; |
| 132 | UInt ret |
| 133 | = vprintf_to_buf(&myprintf_buf, format, vargs); |
| 134 | // Write out any chars left in the buffer. |
| 135 | if (myprintf_buf.buf_used > 0) { |
| 136 | send_bytes_to_logging_sink( myprintf_buf.sink, |
| 137 | myprintf_buf.buf, |
| 138 | myprintf_buf.buf_used ); |
| 139 | } |
| 140 | return ret; |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 141 | } |
| 142 | |
| 143 | UInt VG_(vprintf) ( const HChar *format, va_list vargs ) |
| 144 | { |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 145 | return vprintf_WRK( &VG_(log_output_sink), format, vargs ); |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 146 | } |
| 147 | |
| 148 | UInt VG_(printf) ( const HChar *format, ... ) |
| 149 | { |
| 150 | UInt ret; |
| 151 | va_list vargs; |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 152 | va_start(vargs, format); |
| 153 | ret = VG_(vprintf)(format, vargs); |
| 154 | va_end(vargs); |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 155 | return ret; |
| 156 | } |
| 157 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 158 | UInt VG_(vprintf_xml) ( const HChar *format, va_list vargs ) |
| 159 | { |
| 160 | return vprintf_WRK( &VG_(xml_output_sink), format, vargs ); |
| 161 | } |
| 162 | |
| 163 | UInt VG_(printf_xml) ( const HChar *format, ... ) |
bart | 1a0cb6a | 2008-04-14 16:35:32 +0000 | [diff] [blame] | 164 | { |
| 165 | UInt ret; |
| 166 | va_list vargs; |
bart | 1a0cb6a | 2008-04-14 16:35:32 +0000 | [diff] [blame] | 167 | va_start(vargs, format); |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 168 | ret = VG_(vprintf_xml)(format, vargs); |
bart | 1a0cb6a | 2008-04-14 16:35:32 +0000 | [diff] [blame] | 169 | va_end(vargs); |
bart | 1a0cb6a | 2008-04-14 16:35:32 +0000 | [diff] [blame] | 170 | return ret; |
| 171 | } |
| 172 | |
philippe | 07c0852 | 2014-05-14 20:39:27 +0000 | [diff] [blame] | 173 | static UInt emit_WRK ( const HChar* format, va_list vargs ) |
| 174 | { |
| 175 | if (VG_(clo_xml)) { |
| 176 | return VG_(vprintf_xml)(format, vargs); |
| 177 | } else if (VG_(log_output_sink).fd == -2) { |
| 178 | return VG_(vprintf) (format, vargs); |
| 179 | } else { |
| 180 | return VG_(vmessage)(Vg_UserMsg, format, vargs); |
| 181 | } |
| 182 | } |
| 183 | UInt VG_(emit) ( const HChar* format, ... ) |
| 184 | { |
| 185 | UInt ret; |
| 186 | va_list vargs; |
| 187 | va_start(vargs, format); |
| 188 | ret = emit_WRK(format, vargs); |
| 189 | va_end(vargs); |
| 190 | return ret; |
| 191 | } |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 192 | |
| 193 | /* --------- sprintf --------- */ |
| 194 | |
| 195 | /* If we had an explicit buf structure here, it would contain only one |
| 196 | field, indicating where the next char is to go. So use p directly |
| 197 | for that, rather than having it be a pointer to a structure. */ |
| 198 | |
| 199 | static void add_to__sprintf_buf ( HChar c, void *p ) |
| 200 | { |
| 201 | HChar** b = p; |
| 202 | *(*b)++ = c; |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 203 | } |
| 204 | |
florian | dbb3584 | 2012-10-27 18:39:11 +0000 | [diff] [blame] | 205 | UInt VG_(vsprintf) ( HChar* buf, const HChar *format, va_list vargs ) |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 206 | { |
| 207 | Int ret; |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 208 | HChar* sprintf_ptr = buf; |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 209 | |
| 210 | ret = VG_(debugLog_vprintf) |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 211 | ( add_to__sprintf_buf, &sprintf_ptr, format, vargs ); |
| 212 | add_to__sprintf_buf('\0', &sprintf_ptr); |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 213 | |
| 214 | vg_assert(VG_(strlen)(buf) == ret); |
| 215 | |
| 216 | return ret; |
| 217 | } |
| 218 | |
florian | dbb3584 | 2012-10-27 18:39:11 +0000 | [diff] [blame] | 219 | UInt VG_(sprintf) ( HChar* buf, const HChar *format, ... ) |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 220 | { |
| 221 | UInt ret; |
| 222 | va_list vargs; |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 223 | va_start(vargs,format); |
| 224 | ret = VG_(vsprintf)(buf, format, vargs); |
| 225 | va_end(vargs); |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 226 | return ret; |
| 227 | } |
| 228 | |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 229 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 230 | /* --------- snprintf --------- */ |
| 231 | |
florian | 3e81b8b | 2014-10-07 14:28:52 +0000 | [diff] [blame] | 232 | /* The return value of VG_(snprintf) and VG_(vsnprintf) differs from |
| 233 | what is defined in C99. Let S be the size of the buffer as given in |
| 234 | the 2nd argument. |
| 235 | Return value R: |
| 236 | R < S: The output string was successfully written to the buffer. |
| 237 | It is null-terminated and R == strlen( output string ) |
| 238 | R == S: The supplied buffer was too small to hold the output string. |
| 239 | The first S-1 characters of the output string were written |
| 240 | to the buffer followed by the terminating null character. |
| 241 | */ |
| 242 | |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 243 | typedef |
| 244 | struct { |
| 245 | HChar* buf; |
| 246 | Int buf_size; |
| 247 | Int buf_used; |
| 248 | } |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 249 | snprintf_buf_t; |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 250 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 251 | static void add_to__snprintf_buf ( HChar c, void* p ) |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 252 | { |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 253 | snprintf_buf_t* b = p; |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 254 | if (b->buf_size > 0 && b->buf_used < b->buf_size) { |
| 255 | b->buf[b->buf_used++] = c; |
| 256 | if (b->buf_used < b->buf_size) |
| 257 | b->buf[b->buf_used] = 0; |
sewardj | 03e2bb8 | 2006-12-24 03:02:18 +0000 | [diff] [blame] | 258 | else |
| 259 | b->buf[b->buf_size-1] = 0; /* pre: b->buf_size > 0 */ |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 260 | } |
| 261 | } |
| 262 | |
florian | dbb3584 | 2012-10-27 18:39:11 +0000 | [diff] [blame] | 263 | UInt VG_(vsnprintf) ( HChar* buf, Int size, const HChar *format, va_list vargs ) |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 264 | { |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 265 | snprintf_buf_t b; |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 266 | b.buf = buf; |
| 267 | b.buf_size = size < 0 ? 0 : size; |
| 268 | b.buf_used = 0; |
philippe | 3a00f52 | 2013-02-26 21:54:28 +0000 | [diff] [blame] | 269 | if (b.buf_size > 0) |
| 270 | b.buf[0] = 0; // ensure to null terminate buf if empty format |
sewardj | c7ffc94 | 2011-03-28 16:26:42 +0000 | [diff] [blame] | 271 | (void) VG_(debugLog_vprintf) |
| 272 | ( add_to__snprintf_buf, &b, format, vargs ); |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 273 | |
| 274 | return b.buf_used; |
| 275 | } |
| 276 | |
florian | dbb3584 | 2012-10-27 18:39:11 +0000 | [diff] [blame] | 277 | UInt VG_(snprintf) ( HChar* buf, Int size, const HChar *format, ... ) |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 278 | { |
| 279 | UInt ret; |
| 280 | va_list vargs; |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 281 | va_start(vargs,format); |
| 282 | ret = VG_(vsnprintf)(buf, size, format, vargs); |
| 283 | va_end(vargs); |
sewardj | 45f4e7c | 2005-09-27 19:20:21 +0000 | [diff] [blame] | 284 | return ret; |
| 285 | } |
| 286 | |
| 287 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 288 | /* --------- vcbprintf --------- */ |
| 289 | |
| 290 | void VG_(vcbprintf)( void(*char_sink)(HChar, void* opaque), |
| 291 | void* opaque, |
| 292 | const HChar* format, va_list vargs ) |
| 293 | { |
| 294 | (void) VG_(debugLog_vprintf) |
| 295 | ( char_sink, opaque, format, vargs ); |
| 296 | } |
| 297 | |
| 298 | |
florian | 12d2eb5 | 2014-10-30 22:17:56 +0000 | [diff] [blame] | 299 | /* --------- fprintf ---------- */ |
| 300 | |
| 301 | /* This is like [v]fprintf, except it writes to a file handle using |
| 302 | VG_(write). */ |
| 303 | |
| 304 | #define VGFILE_BUFSIZE 8192 |
| 305 | |
| 306 | struct _VgFile { |
| 307 | HChar buf[VGFILE_BUFSIZE]; |
| 308 | UInt num_chars; // number of characters in buf |
| 309 | Int fd; // file descriptor to write to |
| 310 | }; |
| 311 | |
| 312 | |
| 313 | static void add_to__vgfile ( HChar c, void *p ) |
| 314 | { |
| 315 | VgFile *fp = p; |
| 316 | |
| 317 | fp->buf[fp->num_chars++] = c; |
| 318 | |
| 319 | if (fp->num_chars == VGFILE_BUFSIZE) { |
| 320 | VG_(write)(fp->fd, fp->buf, fp->num_chars); |
| 321 | fp->num_chars = 0; |
| 322 | } |
| 323 | } |
| 324 | |
| 325 | VgFile *VG_(fopen)(const HChar *name, Int flags, Int mode) |
| 326 | { |
| 327 | SysRes res = VG_(open)(name, flags, mode); |
| 328 | |
| 329 | if (sr_isError(res)) |
| 330 | return NULL; |
| 331 | |
| 332 | VgFile *fp = VG_(malloc)("fopen", sizeof(VgFile)); |
| 333 | |
| 334 | fp->fd = sr_Res(res); |
| 335 | fp->num_chars = 0; |
| 336 | |
| 337 | return fp; |
| 338 | } |
| 339 | |
| 340 | |
| 341 | UInt VG_(vfprintf) ( VgFile *fp, const HChar *format, va_list vargs ) |
| 342 | { |
| 343 | return VG_(debugLog_vprintf)(add_to__vgfile, fp, format, vargs); |
| 344 | } |
| 345 | |
| 346 | UInt VG_(fprintf) ( VgFile *fp, const HChar *format, ... ) |
| 347 | { |
| 348 | UInt ret; |
| 349 | va_list vargs; |
| 350 | va_start(vargs,format); |
| 351 | ret = VG_(vfprintf)(fp, format, vargs); |
| 352 | va_end(vargs); |
| 353 | return ret; |
| 354 | } |
| 355 | |
| 356 | void VG_(fclose)( VgFile *fp ) |
| 357 | { |
| 358 | // Flush the buffer. |
| 359 | if (fp->num_chars) |
| 360 | VG_(write)(fp->fd, fp->buf, fp->num_chars); |
| 361 | |
Elliott Hughes | a0664b9 | 2017-04-18 17:46:52 -0700 | [diff] [blame^] | 362 | VG_(close)(fp->fd); |
florian | 12d2eb5 | 2014-10-30 22:17:56 +0000 | [diff] [blame] | 363 | VG_(free)(fp); |
| 364 | } |
| 365 | |
sewardj | a11553a | 2005-07-19 12:17:05 +0000 | [diff] [blame] | 366 | |
| 367 | /* --------------------------------------------------------------------- |
sewardj | 592ae09 | 2005-11-08 19:01:44 +0000 | [diff] [blame] | 368 | elapsed_wallclock_time() |
sewardj | a11553a | 2005-07-19 12:17:05 +0000 | [diff] [blame] | 369 | ------------------------------------------------------------------ */ |
| 370 | |
sewardj | 592ae09 | 2005-11-08 19:01:44 +0000 | [diff] [blame] | 371 | /* Get the elapsed wallclock time since startup into buf, which must |
| 372 | 16 chars long. This is unchecked. It also relies on the |
| 373 | millisecond timer having been set to zero by an initial read in |
| 374 | m_main during startup. */ |
sewardj | a11553a | 2005-07-19 12:17:05 +0000 | [diff] [blame] | 375 | |
florian | 77dec3a | 2014-11-14 22:34:40 +0000 | [diff] [blame] | 376 | void VG_(elapsed_wallclock_time) ( /*OUT*/HChar* buf, SizeT bufsize ) |
sewardj | a11553a | 2005-07-19 12:17:05 +0000 | [diff] [blame] | 377 | { |
sewardj | 592ae09 | 2005-11-08 19:01:44 +0000 | [diff] [blame] | 378 | UInt t, ms, s, mins, hours, days; |
| 379 | |
florian | 77dec3a | 2014-11-14 22:34:40 +0000 | [diff] [blame] | 380 | vg_assert(bufsize > 20); |
| 381 | |
sewardj | 592ae09 | 2005-11-08 19:01:44 +0000 | [diff] [blame] | 382 | t = VG_(read_millisecond_timer)(); /* milliseconds */ |
| 383 | |
| 384 | ms = t % 1000; |
| 385 | t /= 1000; /* now in seconds */ |
| 386 | |
| 387 | s = t % 60; |
| 388 | t /= 60; /* now in minutes */ |
| 389 | |
| 390 | mins = t % 60; |
| 391 | t /= 60; /* now in hours */ |
| 392 | |
| 393 | hours = t % 24; |
| 394 | t /= 24; /* now in days */ |
| 395 | |
| 396 | days = t; |
| 397 | |
njn | 82baca7 | 2009-07-24 05:35:49 +0000 | [diff] [blame] | 398 | VG_(sprintf)(buf, "%02u:%02u:%02u:%02u.%03u ", days, hours, mins, s, ms); |
sewardj | a11553a | 2005-07-19 12:17:05 +0000 | [diff] [blame] | 399 | } |
| 400 | |
| 401 | |
njn | 856c54e | 2005-06-26 18:43:40 +0000 | [diff] [blame] | 402 | /* --------------------------------------------------------------------- |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 403 | message() |
| 404 | ------------------------------------------------------------------ */ |
| 405 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 406 | /* A buffer for accumulating VG_(message) style output. This is |
| 407 | pretty much the same as VG_(printf)'s scheme, with two differences: |
| 408 | |
| 409 | * The message buffer persists between calls, so that multiple |
| 410 | calls to VG_(message) can build up output. |
| 411 | |
| 412 | * Whenever the first character on a line is emitted, the |
| 413 | ==PID== style preamble is stuffed in before it. |
| 414 | */ |
| 415 | typedef |
| 416 | struct { |
| 417 | HChar buf[512+128]; |
| 418 | Int buf_used; |
| 419 | Bool atLeft; /* notionally, is the next char position at the |
| 420 | leftmost column? */ |
| 421 | /* Current message kind - changes from call to call */ |
| 422 | VgMsgKind kind; |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 423 | /* destination */ |
| 424 | OutputSink* sink; |
| 425 | } |
| 426 | vmessage_buf_t; |
| 427 | |
| 428 | static vmessage_buf_t vmessage_buf |
sewardj | 8ddb93a | 2010-02-15 10:07:05 +0000 | [diff] [blame] | 429 | = { "", 0, True, Vg_UserMsg, &VG_(log_output_sink) }; |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 430 | |
| 431 | |
| 432 | // Adds a single char to the buffer. We aim to have at least 128 |
| 433 | // bytes free in the buffer, so that it's always possible to emit |
| 434 | // the preamble into the buffer if c happens to be the character |
| 435 | // following a \n. When the buffer gets too full, we write its |
| 436 | // contents to the logging sink. |
| 437 | static void add_to__vmessage_buf ( HChar c, void *p ) |
| 438 | { |
| 439 | HChar tmp[64]; |
| 440 | vmessage_buf_t* b = (vmessage_buf_t*)p; |
| 441 | |
| 442 | vg_assert(b->buf_used >= 0 && b->buf_used < sizeof(b->buf)-128); |
| 443 | |
| 444 | if (UNLIKELY(b->atLeft)) { |
| 445 | // insert preamble |
| 446 | HChar ch; |
| 447 | Int i, depth; |
| 448 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 449 | // Print one '>' in front of the messages for each level of |
| 450 | // self-hosting being performed. |
philippe | 72faf10 | 2012-03-11 22:24:03 +0000 | [diff] [blame] | 451 | // Do not print such '>' if sim hint "no-inner-prefix" given |
| 452 | // (useful to run regression tests in an outer/inner setup |
| 453 | // and avoid the diff failing due to these unexpected '>'). |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 454 | depth = RUNNING_ON_VALGRIND; |
philippe | ec905f7 | 2014-08-17 20:03:51 +0000 | [diff] [blame] | 455 | if (depth > 0 |
| 456 | && !SimHintiS(SimHint_no_inner_prefix, VG_(clo_sim_hints))) { |
philippe | 72faf10 | 2012-03-11 22:24:03 +0000 | [diff] [blame] | 457 | if (depth > 10) |
| 458 | depth = 10; // ?!?! |
| 459 | for (i = 0; i < depth; i++) { |
| 460 | b->buf[b->buf_used++] = '>'; |
| 461 | } |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 462 | } |
| 463 | |
njn | b1cc5d6 | 2010-07-06 04:05:23 +0000 | [diff] [blame] | 464 | if (Vg_FailMsg == b->kind) { |
| 465 | // "valgrind: " prefix. |
| 466 | b->buf[b->buf_used++] = 'v'; |
| 467 | b->buf[b->buf_used++] = 'a'; |
| 468 | b->buf[b->buf_used++] = 'l'; |
| 469 | b->buf[b->buf_used++] = 'g'; |
| 470 | b->buf[b->buf_used++] = 'r'; |
| 471 | b->buf[b->buf_used++] = 'i'; |
| 472 | b->buf[b->buf_used++] = 'n'; |
| 473 | b->buf[b->buf_used++] = 'd'; |
| 474 | b->buf[b->buf_used++] = ':'; |
| 475 | b->buf[b->buf_used++] = ' '; |
| 476 | } else { |
| 477 | switch (b->kind) { |
| 478 | case Vg_UserMsg: ch = '='; break; |
| 479 | case Vg_DebugMsg: ch = '-'; break; |
njn | b1cc5d6 | 2010-07-06 04:05:23 +0000 | [diff] [blame] | 480 | case Vg_ClientMsg: ch = '*'; break; |
| 481 | default: ch = '?'; break; |
| 482 | } |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 483 | |
njn | b1cc5d6 | 2010-07-06 04:05:23 +0000 | [diff] [blame] | 484 | b->buf[b->buf_used++] = ch; |
| 485 | b->buf[b->buf_used++] = ch; |
| 486 | |
| 487 | if (VG_(clo_time_stamp)) { |
florian | 77dec3a | 2014-11-14 22:34:40 +0000 | [diff] [blame] | 488 | VG_(elapsed_wallclock_time)(tmp, sizeof tmp); |
njn | b1cc5d6 | 2010-07-06 04:05:23 +0000 | [diff] [blame] | 489 | for (i = 0; tmp[i]; i++) |
| 490 | b->buf[b->buf_used++] = tmp[i]; |
| 491 | } |
| 492 | |
| 493 | VG_(sprintf)(tmp, "%d", VG_(getpid)()); |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 494 | tmp[sizeof(tmp)-1] = 0; |
| 495 | for (i = 0; tmp[i]; i++) |
| 496 | b->buf[b->buf_used++] = tmp[i]; |
njn | b1cc5d6 | 2010-07-06 04:05:23 +0000 | [diff] [blame] | 497 | |
| 498 | b->buf[b->buf_used++] = ch; |
| 499 | b->buf[b->buf_used++] = ch; |
| 500 | b->buf[b->buf_used++] = ' '; |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 501 | } |
| 502 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 503 | /* We can't possibly have stuffed 96 chars in merely as a result |
| 504 | of making the preamble (can we?) */ |
| 505 | vg_assert(b->buf_used < sizeof(b->buf)-32); |
| 506 | } |
| 507 | |
| 508 | b->buf[b->buf_used++] = c; |
| 509 | b->buf[b->buf_used] = 0; |
| 510 | |
| 511 | if (b->buf_used >= sizeof(b->buf) - 128) { |
| 512 | send_bytes_to_logging_sink( b->sink, b->buf, b->buf_used ); |
| 513 | b->buf_used = 0; |
| 514 | } |
| 515 | |
| 516 | b->atLeft = c == '\n'; |
| 517 | } |
| 518 | |
| 519 | |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 520 | UInt VG_(vmessage) ( VgMsgKind kind, const HChar* format, va_list vargs ) |
| 521 | { |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 522 | UInt ret; |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 523 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 524 | /* Note (carefully) that the buf persists from call to call, unlike |
| 525 | with the other printf variants in earlier parts of this file. */ |
| 526 | vmessage_buf_t* b = &vmessage_buf; /* shorthand for convenience */ |
| 527 | |
| 528 | /* We have to set this each call, so that the correct flavour |
| 529 | of preamble is emitted at each \n. */ |
| 530 | b->kind = kind; |
| 531 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 532 | ret = VG_(debugLog_vprintf) ( add_to__vmessage_buf, |
| 533 | b, format, vargs ); |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 534 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 535 | /* If the message finished exactly with a \n, then flush it at this |
| 536 | point. If not, assume more bits of the same line will turn up |
| 537 | in later messages, so don't bother to flush it right now. */ |
| 538 | |
| 539 | if (b->atLeft && b->buf_used > 0) { |
| 540 | send_bytes_to_logging_sink( b->sink, b->buf, b->buf_used ); |
| 541 | b->buf_used = 0; |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 542 | } |
| 543 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 544 | return ret; |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 545 | } |
| 546 | |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 547 | /* Send a simple single-part message. */ |
| 548 | UInt VG_(message) ( VgMsgKind kind, const HChar* format, ... ) |
| 549 | { |
| 550 | UInt count; |
| 551 | va_list vargs; |
| 552 | va_start(vargs,format); |
| 553 | count = VG_(vmessage) ( kind, format, vargs ); |
| 554 | va_end(vargs); |
| 555 | return count; |
| 556 | } |
| 557 | |
njn | b1cc5d6 | 2010-07-06 04:05:23 +0000 | [diff] [blame] | 558 | static void revert_to_stderr ( void ) |
| 559 | { |
| 560 | VG_(log_output_sink).fd = 2; /* stderr */ |
| 561 | VG_(log_output_sink).is_socket = False; |
| 562 | } |
| 563 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 564 | /* VG_(message) variants with hardwired first argument. */ |
njn | b1cc5d6 | 2010-07-06 04:05:23 +0000 | [diff] [blame] | 565 | |
| 566 | UInt VG_(fmsg) ( const HChar* format, ... ) |
| 567 | { |
| 568 | UInt count; |
| 569 | va_list vargs; |
| 570 | va_start(vargs,format); |
| 571 | count = VG_(vmessage) ( Vg_FailMsg, format, vargs ); |
| 572 | va_end(vargs); |
| 573 | return count; |
| 574 | } |
| 575 | |
florian | bbd9a21 | 2012-10-14 00:16:28 +0000 | [diff] [blame] | 576 | void VG_(fmsg_bad_option) ( const HChar* opt, const HChar* format, ... ) |
njn | b1cc5d6 | 2010-07-06 04:05:23 +0000 | [diff] [blame] | 577 | { |
| 578 | va_list vargs; |
| 579 | va_start(vargs,format); |
| 580 | revert_to_stderr(); |
| 581 | VG_(message) (Vg_FailMsg, "Bad option: %s\n", opt); |
| 582 | VG_(vmessage)(Vg_FailMsg, format, vargs ); |
| 583 | VG_(message) (Vg_FailMsg, "Use --help for more information or consult the user manual.\n"); |
njn | b1cc5d6 | 2010-07-06 04:05:23 +0000 | [diff] [blame] | 584 | va_end(vargs); |
florian | be1036e | 2014-10-17 19:44:55 +0000 | [diff] [blame] | 585 | VG_(exit)(1); |
njn | b1cc5d6 | 2010-07-06 04:05:23 +0000 | [diff] [blame] | 586 | } |
| 587 | |
florian | 5b99e66 | 2014-11-29 14:41:32 +0000 | [diff] [blame] | 588 | void VG_(fmsg_unknown_option) ( const HChar* opt) |
| 589 | { |
| 590 | revert_to_stderr(); |
| 591 | VG_(message) (Vg_FailMsg, "Unknown option: %s\n", opt); |
| 592 | VG_(message) (Vg_FailMsg, "Use --help for more information or consult the user manual.\n"); |
| 593 | VG_(exit)(1); |
| 594 | } |
| 595 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 596 | UInt VG_(umsg) ( const HChar* format, ... ) |
| 597 | { |
| 598 | UInt count; |
| 599 | va_list vargs; |
| 600 | va_start(vargs,format); |
| 601 | count = VG_(vmessage) ( Vg_UserMsg, format, vargs ); |
| 602 | va_end(vargs); |
| 603 | return count; |
| 604 | } |
| 605 | |
| 606 | UInt VG_(dmsg) ( const HChar* format, ... ) |
| 607 | { |
| 608 | UInt count; |
| 609 | va_list vargs; |
| 610 | va_start(vargs,format); |
| 611 | count = VG_(vmessage) ( Vg_DebugMsg, format, vargs ); |
| 612 | va_end(vargs); |
| 613 | return count; |
| 614 | } |
| 615 | |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 616 | /* Flush any output that has accumulated in vmessage_buf as a |
| 617 | result of previous calls to VG_(message) et al. */ |
| 618 | void VG_(message_flush) ( void ) |
| 619 | { |
| 620 | vmessage_buf_t* b = &vmessage_buf; |
| 621 | send_bytes_to_logging_sink( b->sink, b->buf, b->buf_used ); |
| 622 | b->buf_used = 0; |
| 623 | } |
| 624 | |
njn | b1cc5d6 | 2010-07-06 04:05:23 +0000 | [diff] [blame] | 625 | __attribute__((noreturn)) |
| 626 | void VG_(err_missing_prog) ( void ) |
| 627 | { |
| 628 | revert_to_stderr(); |
| 629 | VG_(fmsg)("no program specified\n"); |
| 630 | VG_(fmsg)("Use --help for more information.\n"); |
| 631 | VG_(exit)(1); |
| 632 | } |
| 633 | |
| 634 | __attribute__((noreturn)) |
florian | bbd9a21 | 2012-10-14 00:16:28 +0000 | [diff] [blame] | 635 | void VG_(err_config_error) ( const HChar* format, ... ) |
njn | b1cc5d6 | 2010-07-06 04:05:23 +0000 | [diff] [blame] | 636 | { |
florian | 1763e81 | 2011-07-12 19:07:05 +0000 | [diff] [blame] | 637 | va_list vargs; |
| 638 | va_start(vargs,format); |
njn | b1cc5d6 | 2010-07-06 04:05:23 +0000 | [diff] [blame] | 639 | revert_to_stderr(); |
florian | 1763e81 | 2011-07-12 19:07:05 +0000 | [diff] [blame] | 640 | VG_(message) (Vg_FailMsg, "Startup or configuration error:\n "); |
| 641 | VG_(vmessage)(Vg_FailMsg, format, vargs ); |
| 642 | VG_(message) (Vg_FailMsg, "Unable to start up properly. Giving up.\n"); |
florian | 1763e81 | 2011-07-12 19:07:05 +0000 | [diff] [blame] | 643 | va_end(vargs); |
florian | be1036e | 2014-10-17 19:44:55 +0000 | [diff] [blame] | 644 | VG_(exit)(1); |
njn | b1cc5d6 | 2010-07-06 04:05:23 +0000 | [diff] [blame] | 645 | } |
| 646 | |
florian | 596b3fe | 2015-04-20 20:42:42 +0000 | [diff] [blame] | 647 | /* --------------------------------------------------------------------- |
| 648 | VG_(sr_as_string)() |
| 649 | ------------------------------------------------------------------ */ |
| 650 | |
florian | 596b3fe | 2015-04-20 20:42:42 +0000 | [diff] [blame] | 651 | #if defined(VGO_linux) |
| 652 | // FIXME: Does this function need to be adjusted for MIPS's _valEx ? |
| 653 | const HChar *VG_(sr_as_string) ( SysRes sr ) |
| 654 | { |
| 655 | static HChar buf[7+1+2+16+1+1]; // large enough |
| 656 | |
| 657 | if (sr_isError(sr)) |
| 658 | VG_(sprintf)(buf, "Failure(0x%lx)", sr_Err(sr)); |
| 659 | else |
| 660 | VG_(sprintf)(buf, "Success(0x%lx)", sr_Res(sr)); |
| 661 | return buf; |
| 662 | } |
| 663 | |
sewardj | 8eb8bab | 2015-07-21 14:44:28 +0000 | [diff] [blame] | 664 | #elif defined(VGO_darwin) || (VGO_solaris) |
florian | 596b3fe | 2015-04-20 20:42:42 +0000 | [diff] [blame] | 665 | |
| 666 | const HChar *VG_(sr_as_string) ( SysRes sr ) |
| 667 | { |
| 668 | static HChar buf[7+1+2+16+1+2+16+1+1]; // large enough |
| 669 | |
| 670 | if (sr_isError(sr)) |
| 671 | VG_(sprintf)(buf, "Failure(0x%lx)", sr_Err(sr)); |
| 672 | else |
| 673 | VG_(sprintf)(buf, "Success(0x%lx:0x%lx)", sr_ResHI(sr), sr_Res(sr)); |
| 674 | return buf; |
| 675 | } |
| 676 | |
| 677 | #else |
| 678 | |
| 679 | #error unknown OS |
| 680 | |
| 681 | #endif |
sewardj | 738856f | 2009-07-15 14:48:32 +0000 | [diff] [blame] | 682 | |
njn | c44a6c2 | 2005-06-03 13:21:18 +0000 | [diff] [blame] | 683 | /*--------------------------------------------------------------------*/ |
| 684 | /*--- end ---*/ |
| 685 | /*--------------------------------------------------------------------*/ |