//-*-c++-*-
// ====================================================================
// ====================================================================
//
// Module: opt_util.h
// $Revision: 1.3 $
// $Date: 2003/03/07 07:18:23 $
//
// Revision history:
//  15-SEP-94 shin - Original Version
//
// ====================================================================
//
// Copyright (C) 2000, 2001 Silicon Graphics, Inc.  All Rights Reserved.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of version 2 of the GNU General Public License as
// published by the Free Software Foundation.
//
// This program is distributed in the hope that it would be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//
// Further, this software is distributed without any warranty that it
// is free of the rightful claim of any third person regarding
// infringement  or the like.  Any license provided herein, whether
// implied or otherwise, applies only to this software file.  Patent
// licenses, if any, provided herein do not apply to combinations of
// this program with other software, or any other product whatsoever.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write the Free Software Foundation,
// Inc., 59 Temple Place - Suite 330, Boston MA 02111-1307, USA.
//
// Contact information:  Silicon Graphics, Inc., 1600 Amphitheatre Pky,
// Mountain View, CA 94043, or:
//
// http://www.sgi.com
//
// For further information regarding this notice, see:
//
// http://oss.sgi.com/projects/GenInfo/NoticeExplan
//
// ====================================================================
//
// Description:  Utilities for Optimizer
//
// ====================================================================
// ====================================================================


#ifndef opt_util_INCLUDED
#define opt_util_INCLUDED	"opt_util.h"

#ifndef srcpos_INCLUDED
#include "srcpos.h"
#endif /* srcpos_INCLUDED */
#ifndef opcode_gen_core_INCLUDED
#include "opcode_gen_core.h"
#endif

class BB_NODE;
class CODEREP;
class CODEMAP;

// warning for things to do
/*PRINTFLIKE1*/
extern void Warn_todo(const char*, ...)
#ifdef __GNUC__
        __attribute__((format(printf,1,2)))
#endif
	;

#ifndef opt_util_CXX
// TLOG interface for reporting optimizations
extern "C" void Opt_tlog( const char *keyword, SRCPOS srcpos, const char *fmt, ... );

extern "C" void Set_tlog_phase(const INT32 phase);
#endif


enum NUMBER_DESC {
  NUMBER_INVALID,   // not used (for error detection)
  NUMBER_OVERFLOW,   // value is overflowed
  NUMBER_UNKNOWN,   // value is unknown
  NUMBER_KNOWN      // value is determined
};

// 
class NUMBER {
  INT64       _value;
  NUMBER_DESC _desc;

public:

  NUMBER_DESC Desc(void) const    { return _desc; }
  INT64 Value(void) const         { return _value; }
  void  Set_desc(NUMBER_DESC n)   { _desc = n; }
  void  Set_value(INT64 value)    { _value = value; }

  void Init(void) 
    { Set_desc(NUMBER_INVALID);
      Set_value(0); }

  void Set_const(INT64 value) 
    { Set_desc(NUMBER_KNOWN); Set_value(value); }

  void Copy(NUMBER *n)
    { Set_desc(n->Desc()); Set_value(n->Value()); }

  void Eval1(OPERATOR opr, NUMBER *);
  void Eval2(OPERATOR opr, NUMBER *, NUMBER *);

  // The value can be represented using nbits
  BOOL Representable_in_nbits(INT32 nbits);
};

// the number of variants in an expression.
enum NUM_VARIANTS {
  NO_VARIANT    = 0,   // all are invariants
  ONE_VARIANT   = 1,   // contains 1 variant that is the same as vr
  NOT_ONE_VARIANT = 2
     // contains more than 1 variant
     // contains some variant that is different from vr or more than 1 variant
     // contains opcodes other than  add/sub/neg/mul.
};

// Check if the expr is an induction expression of iv.
extern NUM_VARIANTS Find_one_variant(BB_NODE *bb,
                                     CODEREP *iv,
                                     CODEREP *expr,
                                     NUMBER *,
                                     CODEMAP *htable = NULL);

#if 1
#define SET_OPT_PHASE(str)  (void) Set_opt_phase(NULL, str)
#define SET_OPT_REPEAT_PHASE(phase_id, str) (void) Set_opt_phase(&phase_id, str)
INT Set_opt_phase(INT32 *, char*);  // Set the current subphases of the optimizer
#define REPORT_STATISTICS() Report_statistics()
INT Report_statistics();   // Report statistics of subphases of the optimizer
#else
#define SET_OPT_PHASE(str)
#define REPORT_STATISTICS()
#endif

// Bitvector definitions
//
#include <vector>
#include "segmented_array.h" // For mempool_allocator


/* WEI:
   we don't want to use stl_use_namespaces, since it's defined in gcc2.96 but not in gcc3.x
*/
#if defined(__GNUC__)
using std::vector;
#endif

/*
  #ifdef __STL_USE_NAMESPACES
  using std::vector;
  #endif
*/

typedef mempool_allocator<bool>         BVECTOR_ALLOCATOR;
typedef vector<bool, BVECTOR_ALLOCATOR> BVECTOR; // TODO add range checks

// For each coderep (i), determines whether it contains a reference
// to a volatile memory location or a volatile OPC, and if this is 
// the case sets vol[i]=TRUE.  
//
// PRECONDITION: For all i
//                 where: 0 <= i <= cfg->Htable()->Coderep_id_cnt()+1
//                 vol[i] == FALSE
//
class CFG;
void Set_volatile_map(CFG *cfg, BVECTOR &vol);

#endif  // opt_util_INCLUDED