syzygy/instrument/mutators/add_indexed_data_ranges_stream.h

// Copyright 2012 Google Inc. All Rights Reserved.
//
// 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.
//
// Declares a PDB mutator for adding indexed data addresses and sizes to a
// named PDB stream.

#ifndef SYZYGY_INSTRUMENT_MUTATORS_ADD_INDEXED_DATA_RANGES_STREAM_H_
#define SYZYGY_INSTRUMENT_MUTATORS_ADD_INDEXED_DATA_RANGES_STREAM_H_

#include "syzygy/core/address.h"
#include "syzygy/core/address_space.h"
#include "syzygy/pdb/mutators/add_named_stream_mutator.h"

namespace instrument {
namespace mutators {

class AddIndexedDataRangesStreamPdbMutator
    : public pdb::mutators::AddNamedStreamMutatorImpl<
          AddIndexedDataRangesStreamPdbMutator> {
 public:
  typedef core::AddressRange<core::RelativeAddress, size_t>
      RelativeAddressRange;
  typedef std::vector<RelativeAddressRange> RelativeAddressRangeVector;

  // Constructor.
  // @param indexed_data_ranges A reference to the vector that contains the
  //     relative addresses associated with the indexed data in an image. This
  //     need not be populated at the time of construction, so long as it exists
  //     before MutatePdb is called.
  // @param stream_name The name to give to the stream we're adding.
  AddIndexedDataRangesStreamPdbMutator(
      const RelativeAddressRangeVector& indexed_data_ranges,
      std::string stream_name)
          : indexed_data_ranges_(indexed_data_ranges),
            stream_name_(stream_name) {
  }

 protected:
  friend pdb::mutators::AddNamedStreamMutatorImpl<
      AddIndexedDataRangesStreamPdbMutator>;
  friend pdb::mutators::NamedPdbMutatorImpl<
      AddIndexedDataRangesStreamPdbMutator>;

  // Implementation of AddNamedStreamMutatorImpl.
  bool AddNamedStreams(const pdb::PdbFile& pdb_file);

  // Implementation of NamedPdbMutatorImpl.
  static const char kMutatorName[];

  std::string stream_name_;

  const RelativeAddressRangeVector& indexed_data_ranges_;
};

}  // namespace mutators
}  // namespace instrument

#endif  // SYZYGY_INSTRUMENT_MUTATORS_ADD_INDEXED_DATA_RANGES_STREAM_H_