/* Copyright 2018 The OpenXLA Authors.

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.
==============================================================================*/

#ifndef XLA_HLO_ANALYSIS_WHILE_LOOP_ANALYSIS_H_
#define XLA_HLO_ANALYSIS_WHILE_LOOP_ANALYSIS_H_

#include <cstdint>
#include <optional>
#include <vector>

#include "absl/container/flat_hash_map.h"
#include "xla/hlo/ir/hlo_instruction.h"
#include "xla/literal.h"
#include "xla/service/value_range.h"

namespace xla {

// Returns the precise trip count of the loop if it's statically known,
// nullopt otherwise.
//
// max_brute_force_iters limits the number of steps that are evaluated while
// trying to brute force a loop trip count. trip counts larger than
// max_brute_force_iters may be returned if we can pattern-match the loop
// condition.
std::optional<int64_t> ComputeWhileLoopTripCount(
    const HloInstruction *while_op, int64_t max_brute_force_iters = 128);

// Returns an upper bound on the trip count of the loop if it's statically
// known, nullopt otherwise.
std::optional<int64_t> ComputeWhileLoopTripCountUpperBound(
    const HloInstruction *while_op);

// The below function identifies a subset of all possible auxiliary
// induction variables (AIV). Specifically, candidates are gtes, e.g.,
// gte(param0, N)
std::vector<const HloInstruction *> GetAuxiliaryLoopInductionVars(
    const HloInstruction *while_op);
// Returns the tuple index of the loop induction variable if there is such an
// induction variable detected. It is also checked that all ops that depend on
// the induction variable have scalar shape. Otherwise returns nullopt.
std::optional<int64_t> GetLoopInductionVarTupleIdx(
    const HloInstruction *while_op);

// Same as above, but also handles cases where the range of the induction
// variable depends on previously known values rather than constants. This is
// useful for unrolling nested loops.
std::optional<int64_t> GetLoopInductionVarTupleIdxWithKnownValues(
    const HloInstruction *while_op,
    const absl::flat_hash_map<const HloInstruction *, Range> &known_values);

// Checks the following conditions:
//  - `i`, the induction variable, is initialized to a scalar constant K
//    (namely, `indvar_init`),
//  - the while condition does `i < N` or `i <= N` (where N is a known constant)
//  - the while body does `i += C` (where C is a positive constant)
// If so, it's trivial to compute the loop bound as `(N - K) div C` or
// `(N - K + 1) div C`, respectively.
std::optional<int64_t> MatchTrivialLoopTripCount(const HloInstruction *while_op,
                                                 int64_t indvar_tuple_idx,
                                                 const Literal &indvar_init);

// Same as above, but returns the loop range, i.e., start (inclusive), end
// (inclusive) and step instead of the trip count.
std::optional<Range> MatchTrivialLoopRange(const HloInstruction *while_op);

// Same as above, but matches loops whose initial values or termination
// conditions depend on known values rather than constants.
std::optional<Range> MatchLoopRangeWithKnownValues(
    const HloInstruction *while_op, int64_t induction_var_idx,
    const absl::flat_hash_map<const HloInstruction *, Range> &known_values);
}  // namespace xla

#endif  // XLA_HLO_ANALYSIS_WHILE_LOOP_ANALYSIS_H_