ftmemsim-valgrind/coregrind/pub_core_demangle.h
Florian Krohm 665280aeaf Merge r14202 from the BUF_REMOVAL branch to trunk.
This patch changes the interface and behaviour of VG_(demangle) and
VG_(maybe_Z_demangle). Instead of copying the demangled name into a
fixed sized buffer that is passed in from the caller (HChar *buf, Int n_buf),
the demangling functions will now return a pointer to the full-length
demangled name (HChar **result). It is the caller's responsiblilty to
make a copy if needed. 

This change in function parameters ripples upward
- first: to get_sym_name
- then to the convenience wrappers
  - VG_(get_fnname)
  - VG_(get_fnname_w_offset)
  - VG_(get_fnname_if_entry)
  - VG_(get_fnname_raw)
  - VG_(get_fnname_no_cxx_demangle)
  - VG_(get_datasym_and_offset)

The changes in foComplete then forces the arguments of
  - VG_(get_objname) to be changed as well

There are some issues regarding the ownership and persistence of
character strings to consider.
In general, the returned character string is owned by "somebody else"
which means the caller must not free it. Also, the caller must not 
modify the returned string as it possibly points to read only memory.
Additionally, the returned string is not necessarily persistent. Here are
the scenarios:
- the returned string is a demangled function name in which case the
  memory holding the string will be freed when the demangler is called again.
- the returned string hangs off of a DebugInfo structure in which case
  it will be freed when the DebugInfo is discarded
- the returned string hangs off of a segment in the address space manager
  in which case it may be overwritten when the segment is merged with
  another segment
So the rule of thunb here is: if in doubt strdup the string.


git-svn-id: svn://svn.valgrind.org/valgrind/trunk@14664
2014-10-25 19:20:38 +00:00

73 lines
3.0 KiB
C

/*--------------------------------------------------------------------*/
/*--- The C++ name demangler. pub_core_demangle.h ---*/
/*--------------------------------------------------------------------*/
/*
This file is part of Valgrind, a dynamic binary instrumentation
framework.
Copyright (C) 2000-2013 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.
*/
#ifndef __PUB_CORE_DEMANGLE_H
#define __PUB_CORE_DEMANGLE_H
#include "pub_core_basics.h" // VG_ macro
//--------------------------------------------------------------------
// PURPOSE: This module exports functions for demangling C++ and
// Z-encoded names.
//--------------------------------------------------------------------
/* This is the main, standard demangler entry point. It does two things:
* (1) undoes Z-encoding, if "do_z_demangle" is True;
* (2) undoes C++ demangling, if 'do_cxx_demangle' is True. */
extern
void VG_(demangle) ( Bool do_cxx_demangling, Bool do_z_demangling,
const HChar* orig, const HChar** result );
/* Demangle a Z-encoded name as described in pub_tool_redir.h.
Z-encoded names are used by Valgrind for doing function
interception/wrapping.
Demangle 'sym' into its soname and fnname parts, putting them in
the specified buffers. Returns a Bool indicating whether the
demangled failed or not. A failure can occur because the prefix
isn't recognised, the internal Z-escaping is wrong, or because one
or the other (or both) of the output buffers becomes full. Passing
'so' as NULL is acceptable if the caller is only interested in the
function name part. */
extern
Bool VG_(maybe_Z_demangle) ( const HChar* sym,
/*OUT*/const HChar** so, // may be NULL
/*OUT*/const HChar** fn,
/*OUT*/Bool* isWrap, // may be NULL
/*OUT*/Int* eclassTag, // may be NULL
/*OUT*/Int* eclassPrio ); // may be NULL
#endif // __PUB_CORE_DEMANGLE_H
/*--------------------------------------------------------------------*/
/*--- end ---*/
/*--------------------------------------------------------------------*/