1// Copyright (c) 2009, Google Inc.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
8//     * Redistributions of source code must retain the above copyright
9// notice, this list of conditions and the following disclaimer.
10//     * Redistributions in binary form must reproduce the above
11// copyright notice, this list of conditions and the following disclaimer
12// in the documentation and/or other materials provided with the
13// distribution.
14//     * Neither the name of Google Inc. nor the names of its
15// contributors may be used to endorse or promote products derived from
16// this software without specific prior written permission.
17//
18// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29
30// ---
31// Author: Craig Silverstein
32
33#ifndef TCMALLOC_SYMBOLIZE_H_
34#define TCMALLOC_SYMBOLIZE_H_
35
36#include "config.h"
37#ifdef HAVE_STDINT_H
38#include <stdint.h>  // for uintptr_t
39#endif
40#include <stddef.h>  // for NULL
41#include <map>
42
43using std::map;
44
45// SymbolTable encapsulates the address operations necessary for stack trace
46// symbolization. A common use-case is to Add() the addresses from one or
47// several stack traces to a table, call Symbolize() once and use GetSymbol()
48// to get the symbol names for pretty-printing the stack traces.
49class SymbolTable {
50 public:
51  SymbolTable()
52    : symbol_buffer_(NULL) {}
53  ~SymbolTable() {
54    delete[] symbol_buffer_;
55  }
56
57  // Adds an address to the table. This may overwrite a currently known symbol
58  // name, so Add() should not generally be called after Symbolize().
59  void Add(const void* addr);
60
61  // Returns the symbol name for addr, if the given address was added before
62  // the last successful call to Symbolize(). Otherwise may return an empty
63  // c-string.
64  const char* GetSymbol(const void* addr);
65
66  // Obtains the symbol names for the addresses stored in the table and returns
67  // the number of addresses actually symbolized.
68  int Symbolize();
69
70 private:
71  typedef map<const void*, const char*> SymbolMap;
72
73  // An average size of memory allocated for a stack trace symbol.
74  static const int kSymbolSize = 1024;
75
76  // Map from addresses to symbol names.
77  SymbolMap symbolization_table_;
78
79  // Pointer to the buffer that stores the symbol names.
80  char *symbol_buffer_;
81};
82
83#endif  // TCMALLOC_SYMBOLIZE_H_
84