xref: /external/google-breakpad/src/google_breakpad/processor/source_line_resolver_interface.h

// Copyright (C) 2006 Google Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// SourceLineResolver returns function/file/line info for a memory address.
// It uses address map files produced by a compatible writer, e.g.
// PDBSourceLineWriter.

#ifndef _SOURCE_LINE_RESOLVER_H__
#define _SOURCE_LINE_RESOLVER_H__

#include "config.h"
#include <string>
#include <ext/hash_map>

_START_GOOGLE_NAMESPACE_

using STL_NAMESPACE::string;
using __gnu_cxx::hash_map;

class SourceLineResolver {
 public:
  typedef unsigned long long MemAddr;

  // A struct that gives source file information for a memory address.
  struct SourceLineInfo {
    // Resets all fields to their default empty values
    void Reset();

    // The function name, for example Foo::Foo()
    string function_name;

    // The source file, for example C:\foo\bar.cc
    string source_file;

    // The line number within the source file (1-based)
    int source_line;
  };

  SourceLineResolver();
  ~SourceLineResolver();

  // Adds a module to this resolver, returning true on success.
  //
  // module_name may be an arbitrary string.  Typically, it will be the
  // filename of the module, optionally with version identifiers.
  //
  // map_file should contain line/address mappings for this module.
  bool LoadModule(const string &module_name, const string &map_file);

  // Determines the source line for the given address, and fills info
  // with the result.  module_name must match a module name that was
  // passed to LoadModule().  The address should be module-relative.
  void LookupAddress(MemAddr address, const string &module_name,
                     SourceLineInfo *info) const;

 private:
  template<class T> class MemAddrMap;
  struct Line;
  struct Function;
  struct File;
  struct HashString {
    size_t operator()(const string &s) const;
  };
  class Module;

  // All of the modules we've loaded
  typedef hash_map<string, Module*, HashString> ModuleMap;
  ModuleMap *modules_;

  // Disallow unwanted copy ctor and assignment operator
  SourceLineResolver(const SourceLineResolver&);
  void operator=(const SourceLineResolver&);
};

_END_GOOGLE_NAMESPACE_

#endif  // _SOLURCE_LINE_RESOLVER_H__