The SUIF 2 Compiler System

This page contains a guide to the documentation of the SUIF2 system, which is built as part of the National Compiler Infrastructure project. The SUIF2 representation is completely different from the SUIF1 representation. The released system includes conversion tools between the SUIF 1 and SUIF 2 representations to allow passes written in both systems to work together.

Table of Contents

• Overview of the System. Describes the basic concepts in the design of the system.
• Getting Started. A quick step-by-step guide to download and run the SUIF compiler.
• Directory Structure. An overview of the directory structure in the system.
• Base System. The Stanford release includes the base system and a set of advanced analysis.
• Available Programs and Passes. The SUIF infrastructure includes a set of programs and passes that can be combined to create different systems.
• Writing your own SUIF Pass The SUIF infrastructure includes a set of tools to allow users to define their own passes.

• An Overview of the SUIF Compiler Infrastructure
  This document introduces the major concepts in the system, namely
  • A module subsystem that allows passes to be composed easily.
  • An extensible SUIF representation that allows programmers to extend the representation without requiring updating the infrastructure.
  It also provides an overview of the SUIF system architecture and describes the SUIF extensible intermediate representation.
• Tutorial presentation at the ACM SIGPLAN 2000 Conference on Programming Language Design and Implementation, June 2000, Vancouver B.C.
  • Overview of the SUIF System, Monica Lam. (powerpoint, postscript)
  • Introduction to the Basic Infrastructure, David Heine. (powerpoint, postscript)
  • Introduction to the MachSUIF Infrastructure, Michael D. Smith. (powerpoint, postscript)
  • Introduction to the OSUIF Infrastructure, Urs Hoelzle and Holger Kienle. (powerpoint, postscript)
  • OSUIF: a Closer Look, Holger Kienle. (powerpoint, postscript)
  • Work in progress
    • Affine Program Transforms, Amy Lim (powerpoint, postscript)
    • Interprocedural Program Analysis, David Heine, Vladimir Livshits, Brian Murphy, Chris Unkel, Hansel Wan (powerpoint, postscript)

• Introduction to SUIF2. (powerpoint, postscript) Revised version of the tutorial at the ACM SIGPLAN '99 Conference on Programming Language Design and Implementation, May 4, 1999, Atlanta GA.

• Download the compiler.At the site, you can download:
  • Binary of the C front end. This is a front end based on the EDG front end. It is freely available to users for research purposes, but registration is required.
  • Sources of the basic SUIF system. The system is copyrighted, but it is freely available for research or commercial purposes.
• Follow the instructions in the README file to build the system
• Run the compiler.
• Build guide for Windows: "How To Build & Work With SUIF 2 Under NT Using Microsoft Visual C++".

• combining different standalone programs that communicate using files, and
• invoking different passes using the suifdriver program that operate on program representations in memory.

• The SUIF Program Representation Guide: Detailed documentation of the representation. (postscript version).
  Quick references
  • Class hierarchy diagram
  • Definition of the SUIF representation:
    • basic nodes (basicnodes.hoof)
    • suif nodes (suifnodes.hoof)
    • cfe nodes (cfenodes.hoof)
• The SUIF Programming Guide. This document describes some of the details in writing SUIF passes. (postscript version).
• The SUIF Interfaces Guide. This provides a reference to all the header files that are useful for writing new compiler passes
• Simple examples.
  • A pass module. Illustrates how to write a simple SUIF pass that counts the number of direct and indirect calls using an iterator and a walker.
  • An IR module using hoof. Illustrates how to define and generate a simple SUIF IR module from a Hoof specification.
• The SUIF System Programmmer's Reference Manual A reference manual by the SUIF classes and header files generated by Doxygen. A great programmer's reference, but it is large.

Internal SUIF Implementation Documentation

• Generation of SUIF objects from a hoof file