1ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 2ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 3ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- Debug (not-for-user) logging. pub_core_debuglog.h ---*/ 4ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 5ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 6ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* 7ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This file is part of Valgrind, a dynamic binary instrumentation 8ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown framework. 9ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 10b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov Copyright (C) 2000-2011 Julian Seward 11ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown jseward@acm.org 12ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 13ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is free software; you can redistribute it and/or 14ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown modify it under the terms of the GNU General Public License as 15ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown published by the Free Software Foundation; either version 2 of the 16ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown License, or (at your option) any later version. 17ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 18ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown This program is distributed in the hope that it will be useful, but 19ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown WITHOUT ANY WARRANTY; without even the implied warranty of 20ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 21ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown General Public License for more details. 22ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 23ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown You should have received a copy of the GNU General Public License 24ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown along with this program; if not, write to the Free Software 25ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 26ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 02111-1307, USA. 27ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 28ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown The GNU General Public License is contained in the file COPYING. 29ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown*/ 30ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 31ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#ifndef __PUB_CORE_DEBUGLOG_H 32ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#define __PUB_CORE_DEBUGLOG_H 33ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 34ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//-------------------------------------------------------------------- 35ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// PURPOSE: This module provides a low-level debug logging facility 36ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// that works through all the twists and turns of program startup. Is 37ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// is completely independent of everything, including all memory 38ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// facilities, and emits the debug log on file descriptor 2 (stderr). 39ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// This module is the first to be initialised at system startup. 40ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// 41ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// Because VG_(debugLog) does printf-style formatting, and because 42ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// this module depends on NO OTHERS, this module contains Valgrind's 43ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown// vfprintf implementation too. 44ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown//-------------------------------------------------------------------- 45ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 46ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Gaaah! We don't want glibc dependencies, but there is no easy, 47ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown portable way to avoid using stdarg.h. */ 48ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include <stdarg.h> 49ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 50ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#include "pub_tool_basics.h" /* For definition of VG_ macro */ 51ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 52ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* There are no tool-visible exports from m_debuglog, hence no header 53ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown file for it. */ 54ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* #include "pub_tool_debuglog.h" */ 55ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 56ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 57ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Module startup. */ 58ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern 59ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid VG_(debugLog_startup) ( Int level, HChar* who ); 60ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 61ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 62b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov/* Whether %ps should escape XML metacharacters. */ 63b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanovextern void VG_(debugLog_setXml)(Bool xml); 64b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov 65b32f58018498ea2225959b0ba11c18f0c433deefEvgeniy Stepanov 66ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Get the logging threshold level, as set by the most recent call to 67ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown VG_(debugLog_startup), or zero if there have been no such calls so 68ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown far. */ 69ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern 70ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownInt VG_(debugLog_getLevel) ( void ); 71ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 72ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 73ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* Send debugging output. Nothing happens unless 'level' 74ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown does not exceed the logging threshold level. */ 75ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern 76ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownvoid VG_(debugLog) ( Int level, const HChar* modulename, 77ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown const HChar* format, ... ) 78ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown __attribute__((format(__printf__, 3, 4))); 79ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 80ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 81ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/* A simple vprintf(). For each emitted byte, (*send_fn) is called with 82ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown that byte, and 'send_arg2' as its second param. */ 83ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brownextern 84ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff BrownUInt VG_(debugLog_vprintf) ( 85ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown void (*send_fn)(HChar,void*),/* byte sink */ 86ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown void* send_arg2, /* 2nd arg for byte sink */ 87ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown const HChar *format, 88ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown va_list vargs 89ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown ); 90ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 91ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 92ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown#endif // __PUB_CORE_DEBUGLOG_H 93ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown 94ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 95ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--- end pub_core_debuglog.h ---*/ 96ed07e00d438c74b7a23c01bfffde77e3968305e4Jeff Brown/*--------------------------------------------------------------------*/ 97