/* Header file for ssa-range generator.
   Copyright (C) 2017-2018 Free Software Foundation, Inc.
   Contributed by Andrew MacLeod <amacleod@redhat.com>.

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
version.

GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING3.  If not see
<http://www.gnu.org/licenses/>.  */

#ifndef GCC_SSA_RANGE_H
#define GCC_SSA_RANGE_H

#include "ssa-range-bb.h"

/* This class utilizes the basic block GORI map and is used to query the range
   of SSA_NAMEs across multiple basic blocks and edges.  */
class path_ranger : public block_ranger
{
private:
  class block_range_cache *block_cache;

  void range_for_bb (irange &r, tree name, basic_block bb, basic_block def_bb);
  void determine_block (tree name, basic_block bb, basic_block def_bb);
  bool path_range_reverse (irange &r, tree name, const vec<basic_block> &);
  bool path_fold_stmt (irange &r, range_stmt &rn, basic_block bb,
		       edge e = NULL);
  bool process_phi (irange &r, gphi *phi);
  bool path_get_operand (irange &r, tree name, basic_block bb);
protected:
  virtual bool get_operand_range (irange &r, tree op, gimple *s = NULL);
public:
  enum path_range_direction { FORWARD, REVERSE };
  path_ranger ();
  ~path_ranger ();

  /* What is the known range of name from its DEF point to edge E.  */
  bool path_range_edge (irange& r, tree name, edge e);
  bool path_range_entry (irange& r, tree name, basic_block bb);
  // Get ive the range of the LHS of the statement.
  bool path_range_stmt (irange& r, gimple *g);

  bool path_range (irange &r, tree name, const vec<basic_block> &bbs,
		   enum path_range_direction, edge start_edge = NULL);
  // Evaluate expression within a BB as much as possible.
  bool path_range_of_def (irange& r, gimple *g);
  bool path_range_of_def (irange& r, gimple *g, edge e);

  void dump (FILE *f);
  void exercise (FILE *f);   /* do a full mapping pass, dump if provided.  */
};

#endif /* GCC_SSA_RANGE_H */