function_address_sequence.h

// Copyright 2011-2024 Google LLC
//
// 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
//
//     https://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.

#ifndef MATCH_FUNCTION_ADDRESS_SEQUENCE_H_
#define MATCH_FUNCTION_ADDRESS_SEQUENCE_H_

#include "third_party/zynamics/bindiff/match/call_graph.h"

namespace security::bindiff {

// Matches functions in order based on their entry point addresses. This is a
// special matching step that is especially useful during drill downs. Since it
// would indiscriminately match all functions if not further constrained there
// are two additional requirements: first the functions in question must already
// be equivalent according to the relaxed MD index and the flow graph MD index.
// Second, the two sets of equivalent functions in both binaries must be of
// equal size.
class MatchingStepSequence : public MatchingStep {
 public:
  MatchingStepSequence()
      : MatchingStep("function: address sequence",
                     "Function: Address Sequence") {
    strict_equivalence_ = true;
  }

  bool FindFixedPoints(const FlowGraph* primary_parent,
                       const FlowGraph* secondary_parent,
                       FlowGraphs& flow_graphs_1, FlowGraphs& flow_graphs_2,
                       MatchingContext& context, MatchingSteps& matching_steps,
                       const MatchingStepsFlowGraph& default_steps) override;

 private:
  void GetUnmatchedFlowGraphsByAddress(const FlowGraphs& flow_graphs,
                                       FlowGraphIntMap& flow_graphs_map);
};

}  // namespace security::bindiff

#endif  // MATCH_FUNCTION_ADDRESS_SEQUENCE_H_