Open64: osprey/common/targ_info/access/ti

00001 /*
00002 
00003   Copyright (C) 2000, 2001 Silicon Graphics, Inc.  All Rights Reserved.
00004 
00005   This program is free software; you can redistribute it and/or modify it
00006   under the terms of version 2 of the GNU General Public License as
00007   published by the Free Software Foundation.
00008 
00009   This program is distributed in the hope that it would be useful, but
00010   WITHOUT ANY WARRANTY; without even the implied warranty of
00011   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  
00012 
00013   Further, this software is distributed without any warranty that it is
00014   free of the rightful claim of any third person regarding infringement 
00015   or the like.  Any license provided herein, whether implied or 
00016   otherwise, applies only to this software file.  Patent licenses, if 
00017   any, provided herein do not apply to combinations of this program with 
00018   other software, or any other product whatsoever.  
00019 
00020   You should have received a copy of the GNU General Public License along
00021   with this program; if not, write the Free Software Foundation, Inc., 59
00022   Temple Place - Suite 330, Boston MA 02111-1307, USA.
00023 
00024   Contact information:  Silicon Graphics, Inc., 1600 Amphitheatre Pky,
00025   Mountain View, CA 94043, or:
00026 
00027   http://www.sgi.com
00028 
00029   For further information regarding this notice, see:
00030 
00031   http://oss.sgi.com/projects/GenInfo/NoticeExplan
00032 
00033 */
00034 
00035 
00036 /* ====================================================================
00037  * ====================================================================
00038  *
00039  *  Module: ti_bundle.h
00040  *  $Revision: 1.1.1.1 $
00041  *  $Date: 2005/10/21 19:00:00 $
00042  *  $Author: marcel $
00043  *  $Source: /proj/osprey/CVS/open64/osprey1.0/common/targ_info/access/ti_bundle.h,v $
00044  *
00045  *  Synopsis:
00046  *
00047  *      Bundle (or template) accounting package for various clients including
00048  *  the software pipeliner, local (BB) scheduler, disassembler and 
00049  *      linker. 
00050  *
00051  *  Interface Description:
00052  *
00053  *  Exported types:
00054  *
00055  *      Exported functions:
00056  *
00057  *      BOOL TI_BUNDLE_Has_Property(
00058  *    TI_BUNDLE *bundle
00059  *    ISA_EXEC_UNIT_PROPERTY property
00060  *              INT *error
00061  *      )
00062  *
00063  *    Returns TRUE if <bundle> contains an instance of <property>.
00064  *              If an error occurs, <error> is set to TI_RC_ERROR.
00065  *
00066  *      BOOL TI_BUNDLE_Is_Full(
00067  *    TI_BUNDLE *bundle
00068  *              INT *error
00069  *      )
00070  *
00071  *    Returns TRUE if <bundle> is fully packed with insts. If 
00072  *              an error occurs, <error> is set to TI_RC_ERROR.
00073  *
00074  *      BOOL TI_BUNDLE_Is_Empty(
00075  *    TI_BUNDLE *bundle
00076  *              INT *error
00077  *      )
00078  *
00079  *    Returns TRUE if <bundle> is empty. If an error occurs, 
00080  *    <error> is set to TI_RC_ERROR.
00081  *
00082  *          INT TI_BUNDLE_Return_Template(
00083  *              TI_BUNDLE *bundle
00084  *          )
00085  *              
00086  *              Returns the template encoding bit for the slot pattern in
00087  *              <bundle>.
00088  *              
00089  *          void TI_BUNDLE_Clear(
00090  *              TI_BUNDLE *bundle
00091  *          )
00092  *              
00093  *              Reset the contents of the bundle.
00094  *
00095  *      BOOL TI_BUNDLE_Slot_Available(
00096  *    TI_BUNDLE  *bundle
00097  *    ISA_EXEC_UNIT_PROPERTY  property
00098  *    INT slot
00099  *      )
00100  *
00101  *              Check to see if 'slot' for 'property' is available for
00102  *    the given 'bundle'. Returns TRUE if available; FALSE 
00103  *    otherwise.
00104  *
00105  *      BOOL TI_BUNDLE_Stop_Bit_Available(
00106  *    TI_BUNDLE  *bundle
00107  *    INT slot
00108  *      )
00109  *
00110  *              Check to see if a stop bit can be set for 'slot'
00111  *    in the given 'bundle'. Returns TRUE if available; FALSE 
00112  *    otherwise.  
00113  *
00114  *      void TI_BUNDLE_Reserve_Slot(
00115  *    TI_BUNDLE  *bundle
00116  *    INT        slot
00117  *              ISA_EXEC_UNIT_PROPERTY property
00118  *      )
00119  *
00120  *              Reserve 'slot' for 'property' at the given 'bundle'.
00121  *
00122  *      void TI_BUNDLE_Reserve_Stop_Bit(
00123  *    TI_BUNDLE  *bundle
00124  *    INT        slot
00125  *      )
00126  *
00127  *              Reserve 'slot' position for STOP bit at the given 'bundle'.
00128  *
00129  *      void TI_BUNDLE_Unreserve_Stop_Bit(
00130  *    TI_BUNDLE  *bundle
00131  *    INT        slot
00132  *      )
00133  *
00134  *              Unreserve 'slot' position for STOP bit at the given 'bundle'.
00135  *
00136  *
00137  * ====================================================================
00138  * ====================================================================
00139  */
00140 
00141 #ifndef ti_bundle_INCLUDED
00142 #define ti_bundle_INCLUDED
00143 
00144 #include "topcode.h"
00145 
00146 #ifdef __cplusplus
00147 extern "C" {
00148 #endif
00149 
00150 #ifdef _KEEP_RCS_ID
00151 static const char ti_bundle_rcs_id[] = "$Source: /proj/osprey/CVS/open64/osprey1.0/common/targ_info/access/ti_bundle.h,v $ $Revision: 1.1.1.1 $";
00152 #endif /* _KEEP_RCS_ID */
00153 
00154 #ifndef defs_INCLUDED
00155 #define defs_INCLUDED
00156 typedef signed int INT;
00157 typedef signed int INT32;
00158 typedef signed long long INT64;
00159 typedef signed char mINT8;
00160 typedef signed short mINT16;
00161 typedef signed int mINT32;
00162 typedef signed long long mINT64;
00163 typedef unsigned int UINT;
00164 typedef unsigned int UINT32;
00165 typedef unsigned long long UINT64;
00166 typedef unsigned char mUINT8;
00167 typedef unsigned short mUINT16;
00168 typedef unsigned int mUINT32;
00169 typedef unsigned long long mUINT64;
00170 typedef int BOOL;
00171 typedef unsigned char mBOOL;
00172 #ifndef TRUE
00173 #define TRUE    ((BOOL) 1)
00174 #endif
00175 #ifndef FALSE
00176 #define FALSE   ((BOOL) 0)
00177 #endif
00178 #if defined(_LANGUAGE_C) && !defined(inline)
00179 #define inline static __inline
00180 #endif
00181 #endif
00182 
00183 typedef struct ti_bundle {
00184   ISA_BUNDLE_INFO *bundle_info; /* exported interface from targ_info */
00185   BOOL slot_filled[ISA_MAX_SLOTS];  
00186 } TI_BUNDLE;
00187 
00188 /* TI_BUNDLE accessors:
00189  */
00190 
00191 #define TI_BUNDLE_bundle_info(t)            ((t)->bundle_info)
00192 #define TI_BUNDLE_slot_count(t)             ((t)->bundle_info->slot_count)
00193 #define TI_BUNDLE_exec_property(t,i)        ((t)->bundle_info->slot[i])
00194 #define TI_BUNDLE_stop_bit(t,i)             ((t)->bundle_info->stop[i])
00195 #define TI_BUNDLE_slot_filled(t,i)          ((t)->slot_filled[i])
00196 #define TI_BUNDLE_slot_mask(t)              ((t)->bundle_info->slot_mask)
00197 #define TI_BUNDLE_stop_mask(t)              ((t)->bundle_info->stop_mask)
00198 #define TI_BUNDLE_pack_code(t)            ((t)->bundle_info->pack_code)
00199 
00200 #define Set_TI_BUNDLE_exec_property(t, i, value) ((t)->bundle_info->slot[i] = \
00201               (value))
00202 #define Set_TI_BUNDLE_slot_mask(t, i)       ((t)->bundle_info->slot_mask = i)
00203 #define Set_TI_BUNDLE_stop_mask(t, i)       ((t)->bundle_info->stop_mask = i)
00204 #define Set_TI_BUNDLE_slot_count(t, i)      ((t)->bundle_info->slot_count = i)
00205 #define Set_TI_BUNDLE_stop_bit(t, i, value) ((t)->bundle_info->stop[i] = \
00206               (value))
00207 #define Set_TI_BUNDLE_pack_code(t, value)   ((t)->bundle_info->pack_code = \
00208                                       (value))
00209 
00210 /* Iterator Macros */
00211 
00212 #define FOR_ALL_SLOT_MEMBERS(bundle, i) \
00213      for (i = 0; i < TI_BUNDLE_slot_count(bundle); ++i)
00214 
00215 inline BOOL
00216 TI_BUNDLE_Stop_Bit_Present(TI_BUNDLE *bundle) {
00217   INT i;
00218   for (i = 0; i < TI_BUNDLE_slot_count(bundle) - 1; ++i) {
00219     if (TI_BUNDLE_stop_bit(bundle, i)) return TRUE;
00220   }
00221   return FALSE;
00222 }
00223 
00224 extern BOOL TI_BUNDLE_Has_Property(
00225   TI_BUNDLE *bundle,
00226   ISA_EXEC_UNIT_PROPERTY property,
00227   INT *error
00228 );
00229 
00230 extern BOOL TI_BUNDLE_Is_Full(
00231   TI_BUNDLE *bundle,
00232   INT *error
00233 );
00234 
00235 extern BOOL TI_BUNDLE_Is_Empty(
00236   TI_BUNDLE *bundle,
00237   INT *error
00238 );
00239 
00240 extern INT TI_BUNDLE_Return_Template(
00241   TI_BUNDLE *bundle
00242 );
00243 
00244 extern void TI_BUNDLE_Clear(
00245   TI_BUNDLE *bundle
00246 );
00247 
00248 extern BOOL TI_BUNDLE_Slot_Available(
00249   TI_BUNDLE  *bundle,
00250   ISA_EXEC_UNIT_PROPERTY  property,
00251   INT        slot
00252 );
00253 
00254 extern BOOL TI_BUNDLE_Stop_Bit_Available(
00255   TI_BUNDLE  *bundle,
00256   INT        slot
00257 );
00258 
00259 extern void TI_BUNDLE_Reserve_Slot(
00260   TI_BUNDLE  *bundle,
00261   INT slot,
00262   ISA_EXEC_UNIT_PROPERTY property
00263 );
00264 
00265 extern void TI_BUNDLE_Reserve_Stop_Bit(
00266   TI_BUNDLE  *bundle,
00267   INT slot
00268 );
00269 
00270 extern void TI_BUNDLE_Unreserve_Stop_Bit(
00271   TI_BUNDLE  *bundle,
00272   INT slot
00273 );
00274 
00275 #ifdef __cplusplus
00276 }
00277 #endif
00278 #endif /* ti_res_res_INCLUDED */
00279
osprey/common/targ_info/access/ti_bundle.h
