syzygy/grinder/grinder_util.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.
//
// Utility code used by various pieces of the Grinder tool.

#ifndef SYZYGY_GRINDER_GRINDER_UTIL_H_
#define SYZYGY_GRINDER_GRINDER_UTIL_H_

#include "base/files/file_path.h"
#include "syzygy/core/address.h"

namespace grinder {

typedef std::vector<core::RelativeAddress> RelativeAddressVector;

// Gets the addresses of instrumented basic blocks from the PDB file associated
// with a coverage instrumented PE file. This function logs verbosely.
// @param pdb_path the path of the PDB file.
// @param bb_addresses will be populated with the basic block addresses (as
//     relative addresses in the original non-instrumented module) upon
//     success.
// @returns true on success, false otherwise.
bool GetBasicBlockAddresses(const base::FilePath& pdb_path,
                            RelativeAddressVector* bb_addresses);

}  // namespace grinder

#endif  // SYZYGY_GRINDER_GRINDER_UTIL_H_