michael@0: // Copyright (c) 2006, Google Inc.
michael@0: // All rights reserved.
michael@0: //
michael@0: // Redistribution and use in source and binary forms, with or without
michael@0: // modification, are permitted provided that the following conditions are
michael@0: // met:
michael@0: //
michael@0: //     * Redistributions of source code must retain the above copyright
michael@0: // notice, this list of conditions and the following disclaimer.
michael@0: //     * Redistributions in binary form must reproduce the above
michael@0: // copyright notice, this list of conditions and the following disclaimer
michael@0: // in the documentation and/or other materials provided with the
michael@0: // distribution.
michael@0: //     * Neither the name of Google Inc. nor the names of its
michael@0: // contributors may be used to endorse or promote products derived from
michael@0: // this software without specific prior written permission.
michael@0: //
michael@0: // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
michael@0: // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
michael@0: // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
michael@0: // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
michael@0: // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
michael@0: // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
michael@0: // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
michael@0: // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
michael@0: // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
michael@0: // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
michael@0: // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
michael@0: 
michael@0: // basic_code_modules.h: Contains all of the CodeModule objects that
michael@0: // were loaded into a single process.
michael@0: //
michael@0: // This is a basic concrete implementation of CodeModules.  It cannot be
michael@0: // instantiated directly, only based on other objects that implement
michael@0: // the CodeModules interface.  It exists to provide a CodeModules
michael@0: // implementation a place to store information when the life of the original
michael@0: // object (such as a MinidumpModuleList) cannot be guaranteed.
michael@0: //
michael@0: // Author: Mark Mentovai
michael@0: 
michael@0: #ifndef PROCESSOR_BASIC_CODE_MODULES_H__
michael@0: #define PROCESSOR_BASIC_CODE_MODULES_H__
michael@0: 
michael@0: #include "google_breakpad/processor/code_modules.h"
michael@0: 
michael@0: namespace google_breakpad {
michael@0: 
michael@0: template<typename T> class linked_ptr;
michael@0: template<typename AddressType, typename EntryType> class RangeMap;
michael@0: 
michael@0: class BasicCodeModules : public CodeModules {
michael@0:  public:
michael@0:   // Creates a new BasicCodeModules object given any existing CodeModules
michael@0:   // implementation.  This is useful to make a copy of the data relevant to
michael@0:   // the CodeModules and CodeModule interfaces without requiring all of the
michael@0:   // resources that other implementations may require.  A copy will be
michael@0:   // made of each contained CodeModule using CodeModule::Copy.
michael@0:   explicit BasicCodeModules(const CodeModules *that);
michael@0: 
michael@0:   virtual ~BasicCodeModules();
michael@0: 
michael@0:   // See code_modules.h for descriptions of these methods.
michael@0:   virtual unsigned int module_count() const;
michael@0:   virtual const CodeModule* GetModuleForAddress(uint64_t address) const;
michael@0:   virtual const CodeModule* GetMainModule() const;
michael@0:   virtual const CodeModule* GetModuleAtSequence(unsigned int sequence) const;
michael@0:   virtual const CodeModule* GetModuleAtIndex(unsigned int index) const;
michael@0:   virtual const CodeModules* Copy() const;
michael@0: 
michael@0:  private:
michael@0:   // The base address of the main module.
michael@0:   uint64_t main_address_;
michael@0: 
michael@0:   // The map used to contain each CodeModule, keyed by each CodeModule's
michael@0:   // address range.
michael@0:   RangeMap<uint64_t, linked_ptr<const CodeModule> > *map_;
michael@0: 
michael@0:   // Disallow copy constructor and assignment operator.
michael@0:   BasicCodeModules(const BasicCodeModules &that);
michael@0:   void operator=(const BasicCodeModules &that);
michael@0: };
michael@0: 
michael@0: }  // namespace google_breakpad
michael@0: 
michael@0: #endif  // PROCESSOR_BASIC_CODE_MODULES_H__