scale.backend
Class Stabs

java.lang.Object
  scale.backend.Stabs

All Implemented Interfaces:

TypePredicate

public class Stabs
extends java.lang.Object
implements TypePredicate

This class represents "stabs" debugging information.

$Id: Stabs.java,v 1.42 2007-10-04 19:57:49 burrill Exp $

Copyright 2008 by the Scale Compiler Group,
Department of Computer Science
University of Massachusetts,
Amherst MA. 01003, USA
All Rights Reserved.

Notes

• Do not call the visit...Type methods from other classes.
• This class has not been enhanced yet to handle Fortran programs correctly.
• This version is based upon Solaris stabs which differ from GCC stabs and AIX stabs in important details.

  Field Summary

  static int	FMT_GCC Output stabs in GCC format.
  static int	FMT_SOLARIS Output stabs in Solaris format.
  static short	N_BCOMM Begin named common block.
  static short	N_BINCL Beginning of an include file (Sun only).
  static short	N_BROWS Sun source code browser, path to `.cb' file.
  static short	N_BSLINE Line number in bss segment.
  static short	N_CATCH GNU C++ catch clause.
  static short	N_DEFD GNU Modula2 definition module dependency.
  static short	N_DSLINE Line number in data segment.
  static short	N_ECOML Member of a common block.
  static short	N_ECOMM End named common block.
  static short	N_EHDECL GNU C++ exception variable.
  static short	N_EINCL End of an include file.
  static short	N_ENDM Last stab for module (Solaris2).
  static short	N_ENTRY Alternate entry point.
  static short	N_EXCL Place holder for a deleted include file.
  static short	N_FLINE Function start/body/end line numbers (Solaris2).
  static short	N_FNAME Function name (for BSD Fortran).
  static short	N_FUN Function name or text segment variable.
  static short	N_GSYM Global symbol.
  static short	N_LBRAC Beginning of a lexical block.
  static short	N_LCSYM BSS segment file-scope variable.
  static short	N_LSYM Stack variable.
  static short	N_M2C Modula-2 compilation unit.
  static short	N_MAIN Name of main routine.
  static short	N_MOD2 Modula2 info "for imc" (according to Ultrix V4.0).
  static short	N_NBBSS Gould non-base registers.
  static short	N_NBDATA Gould non-base registers.
  static short	N_NBLCS Gould non-base registers.
  static short	N_NBSTS Gould non-base registers.
  static short	N_NBTEXT Gould non-base registers.
  static short	N_NOMAP No DST map.
  static short	N_NSYMS Number of symbols (according to Ultrix V4.0).
  static short	N_OBJ Displacement file (Solaris2).
  static short	N_OPT Debugger options (Solaris2).
  static short	N_PC Global symbol (for Pascal).
  static short	N_PSYM Parameter variable.
  static short	N_RBRAC End of a lexical block.
  static short	N_ROSYM Variable in .rodata section.
  static short	N_RSYM Register variable.
  static short	N_SCOPE Modula2 scope information (Sun linker).
  static short	N_SLINE Line number in text segment.
  static short	N_SO Path and name of source file.
  static byte	N_SO_ANSI_C The source program is written in ANSI C.
  static byte	N_SO_AS The source program is written in assembly.
  static byte	N_SO_C The source program is written in C.
  static byte	N_SO_CC The source program is written in C++.
  static byte	N_SO_FORTRAN The source program is written in Fortran 77.
  static byte	N_SO_FORTRAN90 The source program is written in Fortran 90.
  static byte	N_SO_PASCAL The source program is written in Pascal.
  static short	N_SOL Name of include file.
  static short	N_SSYM Structure of union element.
  static short	N_STSYM Data segment file-scope variable.
  static short	N_WITH Pascal with statement: type,,0,0,offset (Solaris2).

  Constructor Summary

  Stabs(Machine machine, int fmt, int lang)
  

  Method Summary

  int	addStabd(short type, int other, int desc) Add a new "stabd".
  int	addStabn(short type, int other, int desc, Displacement value) Add a new "stabn".
  int	addStabn(short type, int other, int desc, int value) Add a new "stabn".
  int	addStabs(java.lang.String string, short type, int other, int desc, Displacement value) Add a new "stabs".
  int	addStabs(java.lang.String string, short type, int other, int desc, int value) Add a new "stabs".
  int	addStabx(java.lang.String string, Displacement value, short type, short std_type) Add a new "stabx".
  int	addStabx(java.lang.String string, int value, short type, short std_type) Add a new "stabx".
  int	addXStabs(java.lang.String string, short type, int other, int desc, Displacement value) Add a new "xstabs".
  int	addXStabs(java.lang.String string, short type, int other, int desc, int value) Add a new "xstabs".
  void	assemble(Assembler asm, Emit emit) Generate the assembly statement for all of the stabs.
  void	defineDeclInCommon(Declaration decl, Displacement disp) Associate information with a Declaration in COMMON.
  void	defineDeclInMemory(Declaration decl, Displacement disp) Associate information with a Declaration kept in memory.
  void	defineDeclInRegister(Declaration decl, int register) Associate information with a variable Declaration kept in a register.
  void	defineDeclOnStack(Declaration decl, Displacement disp) Associate information with a Declaration kept on the stack.
  void	defineParameterInRegister(Declaration decl, int register) Associate information with a variable Declaration kept in a register.
  void	defineParameterOnStack(Declaration decl, Displacement disp) Associate information with a Declaration kept on the stack.
  void	defineRoutineInfo(RoutineDecl rd, Displacement disp) Associate information with a routine.
  void	endCommon() Finish processing COMMON variables.
  int	genFtnDescriptor(RoutineDecl rd) Generate the stab for a {$link scale.clef.decl.RoutineDecl RoutineDecl}.
  void	genTypeDecl(TypeDecl decl) Generate the stabs for this {$link scale.clef.type.Type Type} and all the other types it depends upon.
  void	genTypeName(TypeName tn) Generate the stabs for this {$link scale.clef.type.Type Type} and all the other types it depends upon.
  int	genVarDescriptor(VariableDecl decl) Generate the stab for a {$link scale.clef.decl.VariableDecl VariableDecl}.
  int	numberStabs() Return the number of stab entries.
  void	renumberRegisters(int first, int end, int[] map, int nrr) Renumber the registers in N_RSYM entries after register allocation.
  void	startCommon() Prepare for processing COMMON variables.
  void	visitAggregateType(AggregateType type)
  void	visitAllocArrayType(AllocArrayType at)
  void	visitArrayType(ArrayType type)
  void	visitAtomicType(AtomicType type)
  void	visitBooleanType(BooleanType type)
  void	visitBound(Bound bd)
  void	visitCharacterType(CharacterType type)
  void	visitComplexType(ComplexType ct)
  void	visitCompositeType(CompositeType type)
  void	visitEnumerationType(EnumerationType et)
  void	visitFixedArrayType(FixedArrayType at)
  void	visitFloatType(FloatType ft)
  void	visitFortranCharType(FortranCharType it)
  void	visitIncompleteType(IncompleteType type)
  void	visitIntegerType(IntegerType it)
  void	visitNumericType(NumericType type)
  void	visitPointerType(PointerType pt)
  void	visitProcedureType(ProcedureType pt)
  void	visitRaise(Raise type)
  void	visitRaiseWithObject(RaiseWithObject type)
  void	visitRaiseWithType(RaiseWithType type)
  void	visitRealType(RealType type)
  void	visitRecordType(RecordType rt)
  void	visitRefType(RefType rt)
  void	visitSignedIntegerType(SignedIntegerType it)
  void	visitType(Type type)
  void	visitUnionType(UnionType ut)
  void	visitUnsignedIntegerType(UnsignedIntegerType it)
  void	visitVoidType(VoidType vt)

  Methods inherited from class java.lang.Object

  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  Field Detail

  FMT_SOLARIS

  public static final int FMT_SOLARIS

  Output stabs in Solaris format.

  See Also:

  Constant Field Values

  FMT_GCC

  public static final int FMT_GCC

  Output stabs in GCC format.

  See Also:

  Constant Field Values

  N_GSYM

  public static final short N_GSYM

  Global symbol.

  See Also:

  Constant Field Values

  N_FNAME

  public static final short N_FNAME

  Function name (for BSD Fortran).

  See Also:

  Constant Field Values

  N_FUN

  public static final short N_FUN

  Function name or text segment variable.

  See Also:

  Constant Field Values

  N_STSYM

  public static final short N_STSYM

  Data segment file-scope variable.

  See Also:

  Constant Field Values

  N_LCSYM

  public static final short N_LCSYM

  BSS segment file-scope variable.

  See Also:

  Constant Field Values

  N_MAIN

  public static final short N_MAIN

  Name of main routine.

  See Also:

  Constant Field Values

  N_ROSYM

  public static final short N_ROSYM

  Variable in .rodata section.

  See Also:

  Constant Field Values

  N_PC

  public static final short N_PC

  Global symbol (for Pascal).

  See Also:

  Constant Field Values

  N_NSYMS

  public static final short N_NSYMS

  Number of symbols (according to Ultrix V4.0).

  See Also:

  Constant Field Values

  N_NOMAP

  public static final short N_NOMAP

  No DST map.

  See Also:

  Constant Field Values

  N_OBJ

  public static final short N_OBJ

  Displacement file (Solaris2).

  See Also:

  Constant Field Values

  N_OPT

  public static final short N_OPT

  Debugger options (Solaris2).

  See Also:

  Constant Field Values

  N_RSYM

  public static final short N_RSYM

  Register variable.

  See Also:

  Constant Field Values

  N_M2C

  public static final short N_M2C

  Modula-2 compilation unit.

  See Also:

  Constant Field Values

  N_SLINE

  public static final short N_SLINE

  Line number in text segment.

  See Also:

  Constant Field Values

  N_DSLINE

  public static final short N_DSLINE

  Line number in data segment.

  See Also:

  Constant Field Values

  N_BSLINE

  public static final short N_BSLINE

  Line number in bss segment.

  See Also:

  Constant Field Values

  N_BROWS

  public static final short N_BROWS

  Sun source code browser, path to `.cb' file.

  See Also:

  Constant Field Values

  N_DEFD

  public static final short N_DEFD

  GNU Modula2 definition module dependency.

  See Also:

  Constant Field Values

  N_FLINE

  public static final short N_FLINE

  Function start/body/end line numbers (Solaris2).

  See Also:

  Constant Field Values

  N_EHDECL

  public static final short N_EHDECL

  GNU C++ exception variable.

  See Also:

  Constant Field Values

  N_MOD2

  public static final short N_MOD2

  Modula2 info "for imc" (according to Ultrix V4.0).

  See Also:

  Constant Field Values

  N_CATCH

  public static final short N_CATCH

  GNU C++ catch clause.

  See Also:

  Constant Field Values

  N_SSYM

  public static final short N_SSYM

  Structure of union element.

  See Also:

  Constant Field Values

  N_ENDM

  public static final short N_ENDM

  Last stab for module (Solaris2).

  See Also:

  Constant Field Values

  N_SO

  public static final short N_SO

  Path and name of source file.

  See Also:

  Constant Field Values

  N_LSYM

  public static final short N_LSYM

  Stack variable.

  See Also:

  Constant Field Values

  N_BINCL

  public static final short N_BINCL

  Beginning of an include file (Sun only).

  See Also:

  Constant Field Values

  N_SOL

  public static final short N_SOL

  Name of include file.

  See Also:

  Constant Field Values

  N_PSYM

  public static final short N_PSYM

  Parameter variable.

  See Also:

  Constant Field Values

  N_EINCL

  public static final short N_EINCL

  End of an include file.

  See Also:

  Constant Field Values

  N_ENTRY

  public static final short N_ENTRY

  Alternate entry point.

  See Also:

  Constant Field Values

  N_LBRAC

  public static final short N_LBRAC

  Beginning of a lexical block.

  See Also:

  Constant Field Values

  N_EXCL

  public static final short N_EXCL

  Place holder for a deleted include file.

  See Also:

  Constant Field Values

  N_SCOPE

  public static final short N_SCOPE

  Modula2 scope information (Sun linker).

  See Also:

  Constant Field Values

  N_RBRAC

  public static final short N_RBRAC

  End of a lexical block.

  See Also:

  Constant Field Values

  N_BCOMM

  public static final short N_BCOMM

  Begin named common block.

  See Also:

  Constant Field Values

  N_ECOMM

  public static final short N_ECOMM

  End named common block.

  See Also:

  Constant Field Values

  N_ECOML

  public static final short N_ECOML

  Member of a common block.

  See Also:

  Constant Field Values

  N_WITH

  public static final short N_WITH

  Pascal with statement: type,,0,0,offset (Solaris2).

  See Also:

  Constant Field Values

  N_NBTEXT

  public static final short N_NBTEXT

  Gould non-base registers.

  See Also:

  Constant Field Values

  N_NBDATA

  public static final short N_NBDATA

  Gould non-base registers.

  See Also:

  Constant Field Values

  N_NBBSS

  public static final short N_NBBSS

  Gould non-base registers.

  See Also:

  Constant Field Values

  N_NBSTS

  public static final short N_NBSTS

  Gould non-base registers.

  See Also:

  Constant Field Values

  N_NBLCS

  public static final short N_NBLCS

  Gould non-base registers.

  See Also:

  Constant Field Values

  N_SO_AS

  public static final byte N_SO_AS

  The source program is written in assembly.

  See Also:

  Constant Field Values

  N_SO_C

  public static final byte N_SO_C

  The source program is written in C.

  See Also:

  Constant Field Values

  N_SO_ANSI_C

  public static final byte N_SO_ANSI_C

  The source program is written in ANSI C.

  See Also:

  Constant Field Values

  N_SO_CC

  public static final byte N_SO_CC

  The source program is written in C++.

  See Also:

  Constant Field Values

  N_SO_FORTRAN

  public static final byte N_SO_FORTRAN

  The source program is written in Fortran 77.

  See Also:

  Constant Field Values

  N_SO_PASCAL

  public static final byte N_SO_PASCAL

  The source program is written in Pascal.

  See Also:

  Constant Field Values

  N_SO_FORTRAN90

  public static final byte N_SO_FORTRAN90

  The source program is written in Fortran 90.

  See Also:

  Constant Field Values

  Constructor Detail

  Stabs

  public Stabs(Machine machine,
               int fmt,
               int lang)

  Parameters:

  machine - specifies the target architecture

  fmt - specifies the stabs format: FMT_SOLARIS, FMT_GCC, etc.

  lang - specifies the source language: N_SO_C, N_SO_FORTRAN, etc

  Method Detail

  addStabs

  public int addStabs(java.lang.String string,
                      short type,
                      int other,
                      int desc,
                      Displacement value)

  Add a new "stabs".

  Returns:

  the handle for this new stabs

  addStabs

  public int addStabs(java.lang.String string,
                      short type,
                      int other,
                      int desc,
                      int value)

  Add a new "stabs".

  Returns:

  the handle for this new stabs

  addXStabs

  public int addXStabs(java.lang.String string,
                       short type,
                       int other,
                       int desc,
                       Displacement value)

  Add a new "xstabs".

  Returns:

  the handle for this new stabs

  addXStabs

  public int addXStabs(java.lang.String string,
                       short type,
                       int other,
                       int desc,
                       int value)

  Add a new "xstabs".

  Returns:

  the handle for this new stabs

  addStabn

  public int addStabn(short type,
                      int other,
                      int desc,
                      Displacement value)

  Add a new "stabn".

  Returns:

  the handle for this new stabn

  addStabn

  public int addStabn(short type,
                      int other,
                      int desc,
                      int value)

  Add a new "stabn".

  Returns:

  the handle for this new stabn

  addStabd

  public int addStabd(short type,
                      int other,
                      int desc)

  Add a new "stabd".

  Returns:

  the handle for this new stabd

  addStabx

  public int addStabx(java.lang.String string,
                      Displacement value,
                      short type,
                      short std_type)

  Add a new "stabx".

  Returns:

  the handle for this new stabx

  addStabx

  public int addStabx(java.lang.String string,
                      int value,
                      short type,
                      short std_type)

  Add a new "stabx".

  Returns:

  the handle for this new stabx

  numberStabs

  public int numberStabs()

  Return the number of stab entries.

  renumberRegisters

  public void renumberRegisters(int first,
                                int end,
                                int[] map,
                                int nrr)

  Renumber the registers in N_RSYM entries after register allocation. If the map entry for a register is greater than or equal to nrr, the corresponding stabs entry is eliminated.

  Parameters:

  first - is the handle of the first stab entry to process

  end - is the handle of the stab entry after the last entry to process

  map - specifies the register mapping: virtual->real

  nrr - is the number of real registers

  assemble

  public void assemble(Assembler asm,
                       Emit emit)

  Generate the assembly statement for all of the stabs.

  genTypeDecl

  public void genTypeDecl(TypeDecl decl)

  Generate the stabs for this {$link scale.clef.type.Type Type} and all the other types it depends upon.

  genTypeName

  public void genTypeName(TypeName tn)

  Generate the stabs for this {$link scale.clef.type.Type Type} and all the other types it depends upon.

  genFtnDescriptor

  public int genFtnDescriptor(RoutineDecl rd)

  Generate the stab for a {$link scale.clef.decl.RoutineDecl RoutineDecl}. Return the stab handle.

  genVarDescriptor

  public int genVarDescriptor(VariableDecl decl)

  Generate the stab for a {$link scale.clef.decl.VariableDecl VariableDecl}. Return the stab handle.

  defineDeclInRegister

  public void defineDeclInRegister(Declaration decl,
                                   int register)

  Associate information with a variable Declaration kept in a register.

  Parameters:

  decl - is the variable

  register - is the register allocated for the variable

  defineParameterInRegister

  public void defineParameterInRegister(Declaration decl,
                                        int register)

  Associate information with a variable Declaration kept in a register.

  Parameters:

  decl - is the variable

  register - is the register allocated for the variable

  defineDeclOnStack

  public void defineDeclOnStack(Declaration decl,
                                Displacement disp)

  Associate information with a Declaration kept on the stack.

  Parameters:

  decl - is the variable

  disp - - displacement associated with declaration

  defineParameterOnStack

  public void defineParameterOnStack(Declaration decl,
                                     Displacement disp)

  Associate information with a Declaration kept on the stack.

  Parameters:

  decl - is the variable

  disp - - displacement associated with declaration

  defineDeclInMemory

  public void defineDeclInMemory(Declaration decl,
                                 Displacement disp)

  Associate information with a Declaration kept in memory.

  Parameters:

  decl - is the variable

  disp - - displacement associated with declaration

  defineDeclInCommon

  public void defineDeclInCommon(Declaration decl,
                                 Displacement disp)

  Associate information with a Declaration in COMMON.

  Parameters:

  decl - is the variable

  disp - - displacement associated with declaration

  defineRoutineInfo

  public void defineRoutineInfo(RoutineDecl rd,
                                Displacement disp)

  Associate information with a routine.

  Parameters:

  rd - is the routine

  disp - - displacement associated with declaration

  startCommon

  public void startCommon()

  Prepare for processing COMMON variables.

  endCommon

  public void endCommon()

  Finish processing COMMON variables.

  visitAggregateType

  public void visitAggregateType(AggregateType type)

  Specified by:

  visitAggregateType in interface TypePredicate

  visitArrayType

  public void visitArrayType(ArrayType type)

  Specified by:

  visitArrayType in interface TypePredicate

  visitAtomicType

  public void visitAtomicType(AtomicType type)

  Specified by:

  visitAtomicType in interface TypePredicate

  visitBooleanType

  public void visitBooleanType(BooleanType type)

  Specified by:

  visitBooleanType in interface TypePredicate

  visitCharacterType

  public void visitCharacterType(CharacterType type)

  Specified by:

  visitCharacterType in interface TypePredicate

  visitComplexType

  public void visitComplexType(ComplexType ct)

  Specified by:

  visitComplexType in interface TypePredicate

  visitCompositeType

  public void visitCompositeType(CompositeType type)

  Specified by:

  visitCompositeType in interface TypePredicate

  visitEnumerationType

  public void visitEnumerationType(EnumerationType et)

  Specified by:

  visitEnumerationType in interface TypePredicate

  visitAllocArrayType

  public void visitAllocArrayType(AllocArrayType at)

  Specified by:

  visitAllocArrayType in interface TypePredicate

  visitFixedArrayType

  public void visitFixedArrayType(FixedArrayType at)

  Specified by:

  visitFixedArrayType in interface TypePredicate

  visitFloatType

  public void visitFloatType(FloatType ft)

  Specified by:

  visitFloatType in interface TypePredicate

  visitIncompleteType

  public void visitIncompleteType(IncompleteType type)

  Specified by:

  visitIncompleteType in interface TypePredicate

  visitIntegerType

  public void visitIntegerType(IntegerType it)

  Specified by:

  visitIntegerType in interface TypePredicate

  visitSignedIntegerType

  public void visitSignedIntegerType(SignedIntegerType it)

  Specified by:

  visitSignedIntegerType in interface TypePredicate

  visitUnsignedIntegerType

  public void visitUnsignedIntegerType(UnsignedIntegerType it)

  Specified by:

  visitUnsignedIntegerType in interface TypePredicate

  visitFortranCharType

  public void visitFortranCharType(FortranCharType it)

  Specified by:

  visitFortranCharType in interface TypePredicate

  visitNumericType

  public void visitNumericType(NumericType type)

  Specified by:

  visitNumericType in interface TypePredicate

  visitPointerType

  public void visitPointerType(PointerType pt)

  Specified by:

  visitPointerType in interface TypePredicate

  visitProcedureType

  public void visitProcedureType(ProcedureType pt)

  Specified by:

  visitProcedureType in interface TypePredicate

  visitRaise

  public void visitRaise(Raise type)

  Specified by:

  visitRaise in interface TypePredicate

  visitRaiseWithObject

  public void visitRaiseWithObject(RaiseWithObject type)

  Specified by:

  visitRaiseWithObject in interface TypePredicate

  visitRaiseWithType

  public void visitRaiseWithType(RaiseWithType type)

  Specified by:

  visitRaiseWithType in interface TypePredicate

  visitBound

  public void visitBound(Bound bd)

  Specified by:

  visitBound in interface TypePredicate

  visitRealType

  public void visitRealType(RealType type)

  Specified by:

  visitRealType in interface TypePredicate

  visitRecordType

  public void visitRecordType(RecordType rt)

  Specified by:

  visitRecordType in interface TypePredicate

  visitRefType

  public void visitRefType(RefType rt)

  Specified by:

  visitRefType in interface TypePredicate

  visitType

  public void visitType(Type type)

  Specified by:

  visitType in interface TypePredicate

  visitUnionType

  public void visitUnionType(UnionType ut)

  Specified by:

  visitUnionType in interface TypePredicate

  visitVoidType

  public void visitVoidType(VoidType vt)

  Specified by:

  visitVoidType in interface TypePredicate