osprey/common/com/wn_map.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_map_INCLUDED
#define wn_map_INCLUDED
#ifdef __cplusplus
extern "C" {
#endif

#ifdef _KEEP_RCS_ID
static char *wn_map_rcs_id = "$Source$ $Revision$";
#endif /* _KEEP_RCS_ID */


struct mem_pool;


typedef INT32     WN_MAP;

/* predefined (reserved) mappings */
#define WN_MAP_UNDEFINED (-1)
#define WN_MAP_DEPGRAPH 0
#define WN_MAP_PREFETCH 1
#define WN_MAP_FEEDBACK 2
#define WN_MAP_AC_INTERNAL 3
#define WN_MAP_ALIAS_CLASS 4

/* number of reserved mappings and total number */
#define WN_MAP_RESERVED 5
#define WN_MAP_MAX 32

typedef enum {
  WN_MAP_KIND_VOIDP = 1,
  WN_MAP_KIND_INT32 = 2,
  WN_MAP_KIND_INT64 = 3
} WN_MAP_KIND;

typedef struct wn_map_tab {
  struct mem_pool *_free_list_pool;
  struct mem_pool *_pool[WN_MAP_MAX];
  WN_MAP_KIND _kind[WN_MAP_MAX];
  void **_mapping[WN_MAP_CATEGORIES][WN_MAP_MAX];
  BOOL _is_used[WN_MAP_MAX];  /* is this WN_MAP being used */
  BOOL _dont_copy[WN_MAP_MAX]; /* does this WN_MAP need to be copied to the nested function ? */
  INT32 _last_map_id[WN_MAP_CATEGORIES]; /* last map_id for each category */
  INT32 _map_size[WN_MAP_CATEGORIES][WN_MAP_MAX]; /* size of each mapping */

  /* free list of map_ids */
  WN_MAP_ID *_free_list[WN_MAP_CATEGORIES];
  INT32 _free_list_count[WN_MAP_CATEGORIES];
  INT32 _free_list_size[WN_MAP_CATEGORIES];
} WN_MAP_TAB; 

/* map table for the current PU (set automatically) */
extern WN_MAP_TAB *Current_Map_Tab;


extern WN_MAP_TAB *WN_MAP_TAB_Create(
    struct mem_pool *pool
);

extern void WN_MAP_TAB_Delete(
    WN_MAP_TAB  *maptab
);

#define WN_MAP_TAB_Last_ID(maptab,category) \
  (maptab)->_last_map_id[(category)]


extern WN_MAP WN_MAP_Do_Create(
    WN_MAP_TAB  *maptab,
    struct mem_pool *pool,
    WN_MAP_KIND kind
);

#define WN_MAP_Create(pool) \
  WN_MAP_Do_Create(Current_Map_Tab, (pool), WN_MAP_KIND_VOIDP)
#define WN_MAP32_Create(pool) \
  WN_MAP_Do_Create(Current_Map_Tab, (pool), WN_MAP_KIND_INT32)
#define WN_MAP64_Create(pool) \
  WN_MAP_Do_Create(Current_Map_Tab, (pool), WN_MAP_KIND_INT64)

#define IPA_WN_MAP_Create(maptab, pool) \
  WN_MAP_Do_Create((maptab), (pool), WN_MAP_KIND_VOIDP)
#define IPA_WN_MAP32_Create(maptab, pool) \
  WN_MAP_Do_Create((maptab), (pool), WN_MAP_KIND_INT32)
#define IPA_WN_MAP64_Create(maptab, pool) \
  WN_MAP_Do_Create((maptab), (pool), WN_MAP_KIND_INT64)

extern WN_MAP_ID IPA_WN_MAP_Status(
    WN_MAP_TAB *maptab
);

#define WN_MAP_Status() \
  IPA_WN_MAP_Status(Current_Map_Tab)

extern void IPA_WN_MAP_Delete(
    WN_MAP_TAB  *maptab,
    WN_MAP      wn_map
);

#define WN_MAP_Delete(wn_map) \
  IPA_WN_MAP_Delete(Current_Map_Tab, (wn_map))


extern void IPA_WN_MAP_Set(
    WN_MAP_TAB  *maptab,
    WN_MAP      wn_map,
    WN          *wn,
    void        *thing
);
extern void IPA_WN_MAP32_Set(
    WN_MAP_TAB  *maptab,
    WN_MAP      wn_map,
    WN          *wn,
    INT32       thing
);
extern void IPA_WN_MAP64_Set(
    WN_MAP_TAB  *maptab,
    WN_MAP      wn_map,
    WN          *wn,
    INT64       thing
);

#define WN_MAP_Set(wn_map,wn,thing) \
  IPA_WN_MAP_Set(Current_Map_Tab, (wn_map), (wn), (thing))
#define WN_MAP32_Set(wn_map,wn,thing) \
  IPA_WN_MAP32_Set(Current_Map_Tab, (wn_map), (wn), (thing))
#define WN_MAP64_Set(wn_map,wn,thing) \
  IPA_WN_MAP64_Set(Current_Map_Tab, (wn_map), (wn), (thing))


extern void *IPA_WN_MAP_Get(
    WN_MAP_TAB  *maptab,
    WN_MAP      wn_map,
    const WN    *wn
);
extern INT32 IPA_WN_MAP32_Get(
    WN_MAP_TAB  *maptab,
    WN_MAP      wn_map,
    const WN    *wn
);
extern INT64 IPA_WN_MAP64_Get(
    WN_MAP_TAB  *maptab,
    WN_MAP      wn_map,
    const WN    *wn
);

#define WN_MAP_Get(wn_map,wn) \
  IPA_WN_MAP_Get(Current_Map_Tab, (wn_map), (wn))
#define WN_MAP32_Get(wn_map,wn) \
  IPA_WN_MAP32_Get(Current_Map_Tab, (wn_map), (wn))
#define WN_MAP64_Get(wn_map,wn) \
  IPA_WN_MAP64_Get(Current_Map_Tab, (wn_map), (wn))


#define WN_MAP_Size(wn_map,category) \
  IPA_WN_MAP_Size(Current_Map_Tab, (wn_map), (category))
#define IPA_WN_MAP_Size(maptab,wn_map,category) \
  (maptab)->_map_size[(category)][(wn_map)]


extern void WN_MAP_Add_Free_List(
    WN_MAP_TAB  *maptab,
    WN          *wn
);

extern void WN_MAP_Set_ID(
    WN_MAP_TAB  *maptab,
    WN    *wn
);

#define WN_MAP_Get_Kind(wn_map) (Current_Map_Tab->_kind[(wn_map)])

#define WN_MAP_Get_dont_copy(wn_map) (Current_Map_Tab->_dont_copy[(wn_map)])

#define WN_MAP_Set_dont_copy(wn_map, dont_copy) \
    (Current_Map_Tab->_dont_copy[(wn_map)] = (dont_copy))

#ifdef __cplusplus
}
#endif
#endif /* wn_map_INCLUDED */

---