wn_lower.h

Go to the documentation of this file.

/*

  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

*/




#ifndef wn_lower_INCLUDED
#define wn_lower_INCLUDED

#include "opt_alias_interface.h"

#ifdef __cplusplus
extern "C" {
#endif

/* Note: LOWER_ACTIONS isn't an enum since we want to combine actions
 *       with |, which isn't allowed for enums under C++.
 */
typedef INT64 LOWER_ACTIONS;

#define LOWER_NULL                0x000000000000ll
#define LOWER_DO_LOOP             0x000000000001ll
#define LOWER_DO_WHILE            0x000000000002ll
#define LOWER_WHILE_DO            0x000000000004ll
#define LOWER_IF                  0x000000000008ll
#define LOWER_COMPLEX             0x000000000010ll
#define LOWER_ARRAY               0x000000000020ll
#define LOWER_SPLIT_CONST_OFFSETS 0x000000000040ll
#define LOWER_ENTRY_EXIT          0x000000000080ll
#define LOWER_CALL                0x000000000100ll
#define LOWER_SPLIT_SYM_ADDRS     0x000000000200ll
#define LOWER_IO_STATEMENT        0x000000000400ll
#define LOWER_MSTORE              0x000000000800ll
#define LOWER_CVT                 0x000000001000ll
#define LOWER_MP                  0x000000002000ll
#define LOWER_8X_ARRAY            0x000000004000ll
#define LOWER_REGION              0x000000008000ll
#define LOWER_QUAD                0x000000010000ll
#define LOWER_COMPGOTO            0x000000020000ll
#define LOWER_MADD                0x000000040000ll
#define LOWER_INTRINSIC           0x000000080000ll
#define LOWER_INLINE_INTRINSIC    0x000000100000ll
#define LOWER_TOP_LEVEL_ONLY      0x000000200000ll
#define LOWER_REGION_EXITS        0x000000400000ll
#define LOWER_INL_STACK_INTRINSIC 0x000000800000ll
#define LOWER_PREFETCH_MAPS       0x000001000000ll
#define LOWER_ALIAS_MAPS          0x000002000000ll
#define LOWER_DEPGRAPH_MAPS       0x000004000000ll
#define LOWER_PARITY_MAPS         0x000008000000ll
#define LOWER_PICCALL             0x000010000000ll
#define LOWER_BASE_INDEX          0x000020000000ll
#define LOWER_ASSERT              0x000040000000ll
#define LOWER_FREQUENCY_MAPS      0x000080000000ll
#define LOWER_FORMAL_REF          0x000100000000ll
#define LOWER_UPLEVEL             0x000200000000ll
#define LOWER_ENTRY_FORMAL_REF    0x000400000000ll
#define LOWER_SHORTCIRCUIT        0x000800000000ll
#define LOWER_TREEHEIGHT          0x001000000000ll
#define LOWER_RETURN_VAL          0x002000000000ll
#define LOWER_MLDID_MSTID         0x004000000000ll
#define LOWER_BIT_FIELD_ID        0x008000000000ll
#define LOWER_BITS_OP             0x010000000000ll 
#define LOWER_UPC_TO_INTR         0x020000000000ll
#define LOWER_UPC_INTRINSIC       0x040000000000ll
#define LOWER_UPC_CONSISTENCY     0x080000000000ll
#define LOWER_UPC_FORALL          0x100000000000ll
#define LOWER_UPC_MFIELD          0x200000000000ll


#define LOWER_TO_CG               0x800000000000ll


/* 
 * LOWER_TOP_LEVEL_ONLY applies to scf nodes.  If it's set, we don't
 * call the lowerer recursively 
 */

/*
 * LOWER_REGION removes the hierarchy from the tree but
 * preserves information by keeping the region id (RID) for
 * the nearest enclosing REGION in the RID_map of each statement.
 * We may change the interface to CG so that this lowering is
 * not required.  We use any call to WN_Lower
 * to compute the REGION_tree which is kept in the parent, first_kid,
 * next, last_kid fields of the RID.  This tree could also be computed
 * on the fly when the optimizer is emitting REGION nodes.
 */

#define LOWER_SCF       (LOWER_DO_LOOP | LOWER_DO_WHILE | LOWER_WHILE_DO | LOWER_IF)

#define LOWER_ALL_MAPS  (LOWER_PREFETCH_MAPS | LOWER_ALIAS_MAPS | LOWER_DEPGRAPH_MAPS | LOWER_PARITY_MAPS | LOWER_FREQUENCY_MAPS)

/*
 * During map lowering (if enabled) complex  [real, imag] and quad [hi, lo]
 * are marked using these qualities
 *
 * This allows the CG dep graph builder (or LNO, wopt alias analysis) to
 * disambiguate using these qualities.
 *
 */
typedef enum
{
  PARITY_UNKNOWN=       ~0x0,
  PARITY_COMPLEX_REAL=  0x01,
  PARITY_COMPLEX_IMAG=  0x02,
  PARITY_QUAD_HI=       0x04,
  PARITY_QUAD_LO=       0x08
} PARITY;


/* return the parity associated with a WN */
extern PARITY WN_parity(WN *tree);

/* return true if parity shows independence */
extern BOOL WN_parity_independent(WN *wn1, WN *wn2);

/*
 * lowering specific initialization
 */
extern void Lower_Init(void);
extern void Lowering_Finalize(void);

extern FLD_HANDLE FLD_And_Offset_From_Field_Id (TY_IDX  struct_ty_idx, 
                                                UINT    field_id, 
                                                UINT&   cur_field_id,
                                                UINT64& offset);

extern WN *WN_Lower(WN *tree, LOWER_ACTIONS actions, struct ALIAS_MANAGER *alias, char *msg);

/*
 * lower an scf node but not things underneath it 
 */
extern WN *lower_scf_non_recursive(WN *block, WN *tree, LOWER_ACTIONS actions);

/* 
 * lower a block node and everything underneath it  
 */
extern WN *lower_block(WN *tree, LOWER_ACTIONS actions);

/*
 * character string for action
 */
extern const char *LOWER_ACTIONS_name(LOWER_ACTIONS action);

#ifdef __cplusplus
}
#endif

/*
 * return alignment consistant with offset and alignment
 */
extern UINT32 compute_offset_alignment(INT32 offset, UINT32 align);

/*
 * return alignment consistant with TY, ST and offset
 */
extern TY *compute_alignment_type(WN *tree, TY *type, INT64 offset);

/*
 * check trace flags and generate appropriate dumps
 */
extern void WN_Lower_Checkdump(char *msg, WN *tree, LOWER_ACTIONS actions);

/*
 * lower M or lower WHIRL to conform to unsigned 64-bit instruction only ISA
 */
extern void U64_lower_wn(WN *, BOOL);

#endif /* wn_lower_INCLUDED */