/*
   (c) Copyright 2001-2009  The world wide DirectFB Open Source Community (directfb.org)
   (c) Copyright 2000-2004  Convergence (integrated media) GmbH

   All rights reserved.

   Written by Denis Oliver Kropp <dok@directfb.org>,
              Andreas Hundt <andi@fischlustig.de>,
              Sven Neumann <neo@directfb.org>,
              Ville Syrjälä <syrjala@sci.fi> and
              Claudio Ciccani <klan@users.sf.net>.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library 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
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the
   Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.
*/

#ifndef __DIRECT__TRACE_H__
#define __DIRECT__TRACE_H__

#include <direct/types.h>

/***********************************************************************************************************************
** Symbols
*/

/*
 * Returns filename on success or NULL.
 *
 * Stores load address of object in 'ret_base' on success.
 */
const char *direct_trace_lookup_file  ( void        *address,
                                        void       **ret_base );

/*
 * Look up a symbol by filename and offset.
 *
 * Returns symbol name on success or NULL.
 */
const char *direct_trace_lookup_symbol( const char  *filename,
                                        long         offset );

/*
 * Convenience function combining direct_trace_lookup_file() and direct_trace_lookup_symbol().
 */
static inline const char *
direct_trace_lookup_symbol_at( void *address )
{
     void       *base;
     const char *filename;

     filename = direct_trace_lookup_file( address, &base );

     return direct_trace_lookup_symbol( filename, (unsigned long) address - (unsigned long) base );
}

/***********************************************************************************************************************
** Stacks
*/

/*
 * Print stack in 'buffer' or current if NULL.
 */
void direct_trace_print_stack( DirectTraceBuffer *buffer );

/*
 * Print stack of each known thread.
 */
void direct_trace_print_stacks( void );

/*
 * Returns indent level for debug output.
 */
int  direct_trace_debug_indent( void );

/*
 * Create a copy of a stack in 'buffer' or of current if NULL.
 */
DirectTraceBuffer *direct_trace_copy_buffer( DirectTraceBuffer *buffer );

/*
 * Free a (copied) stack buffer.
 */
void               direct_trace_free_buffer( DirectTraceBuffer *buffer );

#endif