Tempo Specializer - Installation Manual

• The Tempo Specializer system
• Requirement
• Available platforms
• Content
• Installation procedure
• Emacs installation issues

Tempo is an partial evaluator for C programs. The system consists of:

• A kernel (written in New Jersey SML v1.10), that implements all the analyses and basic transformations (except specialization itself) and that sequences all phases. SML can be downloaded from http://www.smlnj.org/install/index.html. It may work better to download the software using the ftp links rather than the http links.

  Note that using Tempo with the most recent versions of SML will result in
  a "bad magic number" error.  To correct the problem, please use Version
  110, Patch 7 (110.0.7).  To compile this version of SML it is necessary to
  use an older version of gcc, such as gcc 2.95.
  

• A library (written in C++) for compile-time specialization which performs source-to-source specialization actions.

• A template compiler (written in C) that prepares the assembly of object code templates for run-time specialization.

• A "front-end" (part of the Suif compiler) that handles the parsing of C and some additional source-to-source transformations.

The following tools must be installed on the machine for doing runtime specialization:

• gcc (or a slightly modified version of lcc)
• gmake
• objdump

• Sun OS 4.1
• Sun OS 5.5, i.e. Solaris 2.5
• Linux on PC

It must be noted though that the system performs poorly on PC/Linux as we are using a very old and inefficient version of New Jersey SML. However, only analysis and post-processing are affected, not compile-time nor run-time specialization themselves.

The distribution for, e.g., SunOS 4 contains the following directories.

• tempo :   Root directory
• tempo/bin/tempo : Script that runs the Tempo top level
• tempo/bin/ARCH/tempo :   Tempo top-level binary
• tempo/ctcg/... :   Compile-time specializer header files
• tempo/ctcg/ARCH/libctcg.a : Compile-time specialization library
• tempo/rtcg/tcc/ARCH/tcc :   Template compiler
• tempo/rtcg/rts/ARCH/... :   Run-time specializer files
• tempo/demos/... :   Demos directory
• tempo/doc :   Documentation directory
• tempo/suif/MACHINE/bin/... :   Suif binaries
• tempo/suif/MACHINE/solib/... :   Dynamic libraries (Linux only)
• tempo/emacs/... : Emacs files for visualizing color-annotated files

where ARCH and MACHINE are among one of the following couples.

There is no special reason why there are two different names for the same thing, just history of existing systems...

The distribution files are named tempoN.NNN_ARCH.tar.gz. There is one such file for each ARCH platform:

• SunOS 4.1: SunOS-4
• SunOS 5.1: SunOS-5
• Linux on PC: Linux-2

Each distribution contains all the required files. In order to install Tempo for different platforms at the same time, follow the installation procedure starting from the same root directory; appropriate sub-directories will be created.

The installation process is as follows:

1. Choose the location of your installation:

   mv tempoN.NNN_ARCH.tar.gz INSTALL_DIR
   cd INSTALL_DIR
   

2. Extract the distribution:

   gunzip tempoN.NNN_ARCH.tar.gz
   tar xf tempoN.NNN_ARCH.tar
   

3. Add INSTALL_DIR/tempo/bin to your path.


4. Modify the tempo script in the directory INSTALL_DIR/tempo/bin so that SML_PATH specifies the path used to invoke SML. This should include both the directory containing SML and the SML command itself, not just the directory.

You can now start Tempo by running the command tempo.

To view the color annotated files produced by Tempo under certain versions of Emacs (19.34 and potentially other versions including XEmacs, see the detailed section for more details), it is necessary to load the format-patch elisp file from the .emacs file:

• insert the line (load "/myDir/tempo/work/format-patch") in your .emacs This and other Emacs-related installation issues (potential problems) is thoroughly described the detailed section on Emacs installation.

  ---

  Emacs Installation Issues

  Two problems are known to occur when using Emacs to view ".color" files (MIME Enriched format) generated by Tempo:

  1. Color file loading failing with a "Wrong type argument" error (or in some cases loading but displaying without certain color annotations).

  2. Color file filling messing up the program.

  This section describes the proper installation procedures for circumventing these problems.

  ---

  Loading / Coloring Failure

  Loading of color files may fail with a "Wrong type argument" error; in some cases loading may succeed but without displaying certain color annotations.

  There exist a temporary patch to fix this for certain versions of Emacs:

  • With Emacs 19.30 and lower, we have observed no problems. Thus, the patch should not be needed for such installations.

  • With Emacs 19.34, the color files cannot be loaded. When loading a color file, Emacs generates a "Wrong type argument" error, and does not display the colored file. In some cases, the file will load, but not all the annotations will display correctly. Thus, the patch is needed for such installations.

  • We have not thoroughly tested higher version of Emacs. (Emacs 20.2.4 seems to be OK though.) If Emacs cannot load the color files produced by Tempo, the patch is needed, and will probably work.

  • Certain versions of X-Emacs display similar problems, and should thus use the patch.

  To use the patch, in the following line in your .emacs file.

  • under Emacs:

    (load "INSTALL_DIR/tempo/emacs/format-patch")
    

  • under X-Emacs

    (load "INSTALL_DIR/tempo/emacs/format-patch-xemacs")
    

  The patch is necessary because the enriched mode (used for displaying enriched MIME color files under Emacs) was updated between versions 19.30 and 19.34 of Emacs. The updated version no longer supports multiple color overlays for the same text. The support of multiple overlays (and the selection of "innermost" as the visible overlay for a piece of text) worked well with a recursive-descent way of generating colored files. For this reason, Tempo generates color files that have overlapping color overlays. This causes some versions of Emacs to generate an error when the color file is loaded, or simply to not display the appropriate colors.

  The patch consists of a single elisp file that contains the appropriate functions from the standard encriched mode from version 19.30 of Emacs. When the file is loaded, the appropriate functions are replaced with the compatible, older (and more tolerant) versions. The patch is needed only as long as the the color files generated by Tempo have overlapping overlay annotations. Most color files don't and the remaining color files will be generated correctly Real Soon Now.

  ---

  Automatic Filling

  The color files generated by Tempo are sometimes inadvertently filled: all spaces and indentation is reduced to single spaces and lines are wrapped as if they were ordinary text (rather than part of a program), making the program unreadable.

  The (temporary) solution is to disable automatic filling. For this, add the following line in your .emacs file.

  (setq enriched-fill-after-visiting nil)
  

  To restore automatic filling, do:

  (setq enriched-fill-after-visiting 'ask)
  

  ---

  MAIN  TUTOR  USER  REF  INSTALL  FAQ  LIMIT  BUGS  SUPPORT  SML  SUIF  DEMO  CONTRIB

  ---

  • Users' mailing list: tempo-talk@irisa.fr
  • Developers and maintainers: tempo@irisa.fr
  • Compose project home page: http://compose.labri.fr
  • Tempo Specializer home page: tempo

  ---

  Last modified: Wed Apr 29 09:35:10 MET DST 1998