This is the mail archive of the gcc-patches@gcc.gnu.org mailing list for the GCC project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

[PATCH][alias-improvements] Expand documentation


This documents the main entry points of the oracle.

Installed to the branch.

Richard.

2009-02-07  Richard Guenther  <rguenther@suse.de>

	* tree-ssa-alias.c: Expand documentation.

Index: alias-improvements/gcc/tree-ssa-alias.c
===================================================================
*** alias-improvements.orig/gcc/tree-ssa-alias.c	2009-02-06 21:44:08.000000000 +0100
--- alias-improvements/gcc/tree-ssa-alias.c	2009-02-06 21:53:21.000000000 +0100
*************** along with GCC; see the file COPYING3.  
*** 66,73 ****
     precise tracking of call-clobbered and call-used variables and
     related disambiguations.
  
!    This file contains functions for disambiguating memory references
!    and tools for walking of the gimple IL.  */
  
  
  /* Query statistics for the different low-level disambiguators.
--- 66,102 ----
     precise tracking of call-clobbered and call-used variables and
     related disambiguations.
  
!    This file contains functions for disambiguating memory references,
!    the so called alias-oracle and tools for walking of the gimple IL.
! 
!    The main alias-oracle entry-points are
! 
!    bool stmt_may_clobber_ref_p (gimple, tree)
! 
!      This function queries if a statement may invalidate (parts of)
!      the memory designated by the reference tree argument.
! 
!    bool ref_maybe_used_by_stmt_p (gimple, tree)
! 
!      This function queries if a statement may need (parts of) the
!      memory designated by the reference tree argument.
! 
!    There are variants of these functions that only handle the call
!    part of a statement, call_may_clobber_ref_p and ref_maybe_used_by_call_p.
!    Note that these do not disambiguate against a possible call lhs.
! 
!    bool refs_may_alias_p (tree, tree)
! 
!      This function tries to disambiguate two reference trees.
! 
!    bool may_point_to_global_var (tree)
! 
!      This function queries if a pointer variable may point to global
!      memory.
! 
!    More low-level disambiguators are available and documented in
!    this file.  Low-level disambiguators dealing with points-to
!    information are in tree-ssa-structalias.c.  */
  
  
  /* Query statistics for the different low-level disambiguators.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]