coregrind/pub_core_libcprint.h

   1
   2 /*--------------------------------------------------------------------*/
   3 /*--- Printing libc stuff.                    pub_core_libcprint.h ---*/
   4 /*--------------------------------------------------------------------*/
   5
   6 /*
   7    This file is part of Valgrind, a dynamic binary instrumentation
   8    framework.
   9
  10    Copyright (C) 2000-2013 Julian Seward
  11       jseward@acm.org
  12
  13    This program is free software; you can redistribute it and/or
  14    modify it under the terms of the GNU General Public License as
  15    published by the Free Software Foundation; either version 2 of the
  16    License, or (at your option) any later version.
  17
  18    This program is distributed in the hope that it will be useful, but
  19    WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21    General Public License for more details.
  22
  23    You should have received a copy of the GNU General Public License
  24    along with this program; if not, write to the Free Software
  25    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  26    02111-1307, USA.
  27
  28    The GNU General Public License is contained in the file COPYING.
  29 */
  30
  31 #ifndef __PUB_CORE_LIBCPRINT_H
  32 #define __PUB_CORE_LIBCPRINT_H
  33
  34 //--------------------------------------------------------------------
  35 // PURPOSE: This module contains all the libc code that is related to
  36 // higher-level (ie. higher than DebugLog) printing, eg. VG_(printf)().
  37 //--------------------------------------------------------------------
  38
  39 #include "pub_tool_libcprint.h"
  40
  41 /* An output file descriptor wrapped up with a Bool indicating whether
  42    or not the fd is a socket. */
  43 typedef
  44    struct { Int fd; Bool is_socket; }
  45    OutputSink;
  46
  47 /* And the destinations for normal and XML output. */
  48 extern OutputSink VG_(log_output_sink);
  49 extern OutputSink VG_(xml_output_sink);
  50
  51 /* Get the elapsed wallclock time since startup into buf which has size
  52    bufsize. The function will assert if bufsize is not large enough.
  53    Upon return, buf will contain the zero-terminated wallclock time as
  54    a string. The function also relies on the
  55    millisecond timer having been set to zero by an initial read in
  56    m_main during startup. */
  57 void VG_(elapsed_wallclock_time) ( /*OUT*/HChar* buf, SizeT bufsize );
  58
  59 /* Call this if the executable is missing.  This function prints an
  60    error message, then shuts down the entire system. */
  61 __attribute__((noreturn))
  62 extern void VG_(err_missing_prog) ( void );
  63
  64 /* Similarly - complain and stop if there is some kind of config
  65    error. */
  66 __attribute__((noreturn))
  67 extern void VG_(err_config_error) ( const HChar* format, ... );
  68
  69 /* Called by main_process_cmd_line_options to indicate an unrecognised
  70    command line option. */
  71 __attribute__((noreturn))
  72 extern void VG_(fmsg_unknown_option) ( const HChar *opt );
  73
  74 #endif   // __PUB_CORE_LIBCPRINT_H
  75
  76 /*--------------------------------------------------------------------*/
  77 /*--- end                                                          ---*/
  78 /*--------------------------------------------------------------------*/