1    :  // Copyright 2013 Google Inc. All Rights Reserved.
   2    :  //
   3    :  // Licensed under the Apache License, Version 2.0 (the "License");
   4    :  // you may not use this file except in compliance with the License.
   5    :  // You may obtain a copy of the License at
   6    :  //
   7    :  //     http://www.apache.org/licenses/LICENSE-2.0
   8    :  //
   9    :  // Unless required by applicable law or agreed to in writing, software
  10    :  // distributed under the License is distributed on an "AS IS" BASIS,
  11    :  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12    :  // See the License for the specific language governing permissions and
  13    :  // limitations under the License.
  14    :  //
  15    :  // Declares the branch instrumenter.
  16    :  #ifndef SYZYGY_INSTRUMENT_INSTRUMENTERS_BRANCH_INSTRUMENTER_H_
  17    :  #define SYZYGY_INSTRUMENT_INSTRUMENTERS_BRANCH_INSTRUMENTER_H_
  18    :  
  19    :  #include <string>
  20    :  
  21    :  #include "base/command_line.h"
  22    :  #include "syzygy/instrument/instrumenters/instrumenter_with_agent.h"
  23    :  #include "syzygy/instrument/mutators/add_indexed_data_ranges_stream.h"
  24    :  #include "syzygy/instrument/transforms/branch_hook_transform.h"
  25    :  
  26    :  namespace instrument {
  27    :  namespace instrumenters {
  28    :  
  29    :  class BranchInstrumenter : public InstrumenterWithAgent {
  30    :   public:
  31    :    typedef InstrumenterWithAgent Super;
  32    :  
  33    :    BranchInstrumenter();
  34  E :    ~BranchInstrumenter() { }
  35    :  
  36    :   protected:
  37    :    // The name of the agent for this mode of instrumentation.
  38    :    static const char kAgentDllBasicBlockEntry[];
  39    :  
  40    :    // @name InstrumenterWithAgent overrides.
  41    :    // @{
  42    :    bool InstrumentPrepare() override;
  43    :    bool InstrumentImpl();
  44  i :    const char* InstrumentationMode() { return "branch"; }
  45    :    // @}
  46    :  
  47    :    // @name Super overrides.
  48    :    // @{
  49    :    bool DoCommandLineParse(const base::CommandLine* command_line) override;
  50    :    // @}
  51    :  
  52    :    // The transform for this agent.
  53    :    std::unique_ptr<instrument::transforms::BranchHookTransform>
  54    :        branch_transform_;
  55    :  
  56    :    // The PDB mutator for this agent.
  57    :    std::unique_ptr<instrument::mutators::AddIndexedDataRangesStreamPdbMutator>
  58    :        add_bb_addr_stream_mutator_;
  59    :  
  60    :    // @name Command-line parameters.
  61    :    // @{
  62    :    bool buffering_;
  63    :    uint32_t fs_slot_;
  64    :    // @}
  65    :  };
  66    :  
  67    :  }  // namespace instrumenters
  68    :  }  // namespace instrument
  69    :  
  70    :  #endif  // SYZYGY_INSTRUMENT_INSTRUMENTERS_BRANCH_INSTRUMENTER_H_