The SUIF Interfaces Guide

Program Representation
Please consult The SUIF Program Representation Guide for a detailed description of the basic and SUIF nodes.

• basesuif/basicnodes/basic.h - definition of the basic nodes in the IR
• basesuif/basicnodes/basic_factory.h - factory for basic nodes
• basesuif/suifnodes/suif.h - definition of SUIF nodes in the IR
• basesuif/suifnodes/suif_factory.h - factory for SUIF nodes

Writing SUIF Code

• basesuif/iokernel
• cast.h - Helper functions to determine types of objects and to cast the objects to certain types.
• walker.h - Base class of all walkers.
• basesuif/suifkernel
• suif_env.h - Environment of the SUIF system
• module.h - A module contains either definitions of IR nodes or a pass
• suif_object.h - Interface of a SUIF object
• suif_walker.h - A walker of SUIF objects in the ownership tree.
• group_walker.h - Walkers of objects.
• iter.h - Iterators of objects
• utilities.h - Templates for iterating over subsets of SuifObjects.
• visitor_map.h - Visitors of objects
• command_line_parsing.h - For parsing command lines when modules are invoked.
• suifkernel_messages.h - Error message subsystem
• basesuif/suifpasses
  • passes.h - Definition of a pass
• basesuif/typebuilder
• type_builder.h - SUIF type factory

Data Structures and Utilities for Writing Code in SUIF

• common - basic data structures used by basesuif. (Classes that conflict with STL are preceded with suif_).
• MString.h - a general string class
• formatted.h - Simple formatted text
• i_integer.h - Integers with infinite precision
• lstring.h - lexicon string: a string class that compares in near-constant time.
• sparse_vector.h - Sparse vectors
• suif_hash_map.h - A subset interface to STL hash_map
• suif_indexed_list.h - A subset interface to STL indexed_list
• suif_list.h - A subset interface to STL list.h
• suif_map.h - A subset interface to STL map.h
• suif_vector.h - A subset interface to STL vector.h

• utils - Common functions in manipulating SUIF representations.
• expression_utils.h - A repository for utilities involving expressions
• value_block_utils.h - A repository for utilities involving value_blocks.
• symbol_utils.h - A repository for utilities involving symbols
• type_utils.h - A repository for utilities involving types
• semantic_helper.h - Classes to extract source variables and destination variables in IR.
• cloning_utils.h - A prepackaged statement cloner.
• print_utils.h - A function to print short id string of objects.
• trash_utils.h - Nodes whose references are removed are placed in the trash so a later routine can eliminate nodes with no references.