util.c File Reference

#include <stdio.h>
#include <string.h>
#include "genC.h"
#include "linear.h"
#include "misc.h"
#include "ri.h"
#include "ri-util.h"

Include dependency graph for util.c:

Go to the source code of this file.

Functions
entity	find_label_entity (const char *module_name, const char *label_local_name)
	Pot-pourri of utilities for the internal representation. More...
string	module_codefilename (entity e)
	To find resources (this should be located in workspace-util as it depends both on pipsdbm and ri-util. More...
string	module_par_codefilename (entity e)
string	module_fortranfilename (entity e)
string	module_par_fortranfilename (entity e)
string	module_pp_fortranfilename (entity e)
string	module_predicat_fortranfilename (entity e)
string	module_entitiesfilename (entity e)
entity	find_ith_parameter (entity e, int i)
bool	ith_parameter_p (entity f, entity v, int i)
	returns true if v is the ith formal parameter of function f More...
expression	reference_ith_index (reference ref, int i)
	functions for references More...
bool	comment_string_p (const string comment)
	Test if a string can be a Fortran 77 comment: More...
string	string_remove_trailing_line_feed (string s)
	Remove trailing line feed if any. More...
string	string_remove_trailing_line_feeds (string s)
	Remove trailing line feeds. More...
string	string_strip_final_linefeeds (string s)
	Get rid of linefeed/newline at the end of a string. More...
string	string_fuse_final_linefeeds (string s)
	Get rid of extra linefeed/newline at the end of a string. More...

Function Documentation

comment_string_p()

bool comment_string_p

(

const string

comment

)

Test if a string can be a Fortran 77 comment:

If a line begins with a non-space character, claims it may be a Fortran comment. Assume empty line are comments.

Parameters

comment

omment

Definition at line 159 of file util.c.

{
  char c = *comment;
  /* If a line begins with a non-space character, claims it may be a
     Fortran comment. Assume empty line are comments. */
  return c != '\0' && c != ' ' && c != '\t';
}

References comment().

Referenced by get_declaration_comments(), and get_end_of_header_comments().

Here is the call graph for this function:

Here is the caller graph for this function:

find_ith_parameter()

entity find_ith_parameter	(	entity	e,
		int	i
	)

Definition at line 93 of file util.c.

{
  cons *pv = code_declarations(value_code(entity_initial(e)));
 
  if (! entity_module_p(e)) {
    pips_internal_error("entity %s is not a module",
                         entity_name(e));
  }
  while (pv != NIL) {
    entity v = ENTITY(CAR(pv));
    type tv = entity_type(v);
    storage sv = entity_storage(v);
    // FI: locations.c should be part of ri-util or a large entity library
    value val = entity_initial(v); // To check location entities
 
    // FI: the initial value of formal parameters may be value_undefined...
    // See Semantics-New/block01.c, formal parameter i of multiply
    if (type_variable_p(tv)
        && storage_formal_p(sv)
        && (value_undefined_p(val) || !value_reference_p(val))) {
      if (formal_offset(storage_formal(sv)) == i) {
        return(v);
      }
    }
 
    pv = CDR(pv);
  }
 
  return(entity_undefined);
}

References CAR, CDR, code_declarations, ENTITY, entity_initial, entity_module_p(), entity_name, entity_storage, entity_type, entity_undefined, formal_offset, NIL, pips_internal_error, storage_formal, storage_formal_p, type_variable_p, value_code, value_reference_p, and value_undefined_p.

Referenced by add_bound_arguments(), any_user_call_site_to_transformer(), compute_points_to_binded_set(), drop_distributed_arguments(), generic_substitute_formal_array_elements_in_transformer(), gpu_xml_dump(), hpfc_call_with_distributed_args_p(), hpfc_translate_call_with_distributed_args(), outliner_file(), RemoveDummyArguments(), update_overlaps_in_caller(), and words_parameters().

Here is the call graph for this function:

Here is the caller graph for this function:

find_label_entity()

entity find_label_entity	(	const char *	module_name,
		const char *	label_local_name
	)

Pot-pourri of utilities for the internal representation.

util.c

Some functions could be moved to non-generic files such as entity.c. To deal with labels

Parameters

module_name	odule_name
label_local_name	abel_local_name

Definition at line 43 of file util.c.

{
    string full = concatenate(module_name, MODULE_SEP_STRING,
                              LABEL_PREFIX, label_local_name, NULL);
 
    pips_debug(5, "searched entity: %s\n", full);
    void * found = gen_find_tabulated(full, entity_domain);
    return (entity) (gen_chunk_undefined_p(found) ? entity_undefined : found);
}

References concatenate(), entity_domain, entity_undefined, full, gen_chunk_undefined_p, gen_find_tabulated(), label_local_name(), LABEL_PREFIX, module_name(), MODULE_SEP_STRING, and pips_debug.

Referenced by find_statement_from_label_name(), full_unroll(), get_loop_execution_parallel(), inlining_regenerate_labels(), interactive_loop_transformation(), kernelize(), label_string_defined_in_current_module_p(), label_string_defined_in_statement_p(), loop_auto_unroll(), loop_expansion(), loop_expansion_init(), loop_pragma(), module_loops(), print_loopnest_dependence_cone(), set_loop_execution_parallel(), simdizer_auto_tile(), strip_mine(), symbolic_tiling(), unroll(), and words_regular_call().

Here is the call graph for this function:

Here is the caller graph for this function:

ith_parameter_p()

bool ith_parameter_p	(	entity	f,
		entity	v,
		int	i
	)

returns true if v is the ith formal parameter of function f

Definition at line 125 of file util.c.

{
  type tv = entity_type(v);
  storage sv = entity_storage(v);
 
  if (! entity_module_p(f)) {
    pips_internal_error("[ith_parameter_p] %s is not a module\n", entity_name(f));
  }
 
  if (type_variable_p(tv) && storage_formal_p(sv)) {
    formal fv = storage_formal(sv);
    return(formal_function(fv) == f && formal_offset(fv) == i);
  }
 
  return(false);
}

References entity_module_p(), entity_name, entity_storage, entity_type, f(), formal_function, formal_offset, pips_internal_error, storage_formal, storage_formal_p, and type_variable_p.

Referenced by add_parameter_aliases_for_this_call_site(), and formal_regions_backward_translation().

Here is the call graph for this function:

Here is the caller graph for this function:

module_codefilename()

string module_codefilename

(

entity

e

)

To find resources (this should be located in workspace-util as it depends both on pipsdbm and ri-util.

Definition at line 57 of file util.c.

{
    return(string_codefilename(entity_local_name(e)));
}

References entity_local_name(), and string_codefilename().

Here is the call graph for this function:

module_entitiesfilename()

string module_entitiesfilename

(

entity

e

)

Definition at line 87 of file util.c.

{
    return(string_entitiesfilename(entity_local_name(e)));
}

References entity_local_name(), and string_entitiesfilename().

Here is the call graph for this function:

module_fortranfilename()

string module_fortranfilename

(

entity

e

)

Definition at line 67 of file util.c.

{
    return(string_fortranfilename(entity_local_name(e)));
}

References entity_local_name(), and string_fortranfilename().

Here is the call graph for this function:

module_par_codefilename()

string module_par_codefilename

(

entity

e

)

Definition at line 62 of file util.c.

{
    return(string_par_codefilename(entity_local_name(e)));
}

References entity_local_name(), and string_par_codefilename().

Here is the call graph for this function:

module_par_fortranfilename()

string module_par_fortranfilename

(

entity

e

)

Definition at line 72 of file util.c.

{
    return(string_par_fortranfilename(entity_local_name(e)));
}

References entity_local_name(), and string_par_fortranfilename().

Here is the call graph for this function:

module_pp_fortranfilename()

string module_pp_fortranfilename

(

entity

e

)

Definition at line 77 of file util.c.

{
    return(string_pp_fortranfilename(entity_local_name(e)));
}

References entity_local_name(), and string_pp_fortranfilename().

Here is the call graph for this function:

module_predicat_fortranfilename()

string module_predicat_fortranfilename

(

entity

e

)

Definition at line 82 of file util.c.

{
    return(string_predicat_fortranfilename(entity_local_name(e)));
}

References entity_local_name(), and string_predicat_fortranfilename().

Here is the call graph for this function:

reference_ith_index()

expression reference_ith_index	(	reference	ref,
		int	i
	)

functions for references

returns the ith index of an array reference

Parameters

ref

ef

Definition at line 145 of file util.c.

{
  int count = i;
  cons *pi = reference_indices(ref);
 
  while (pi != NIL && --count > 0)
    pi = CDR(pi);
 
  pips_assert("reference_ith_index", pi != NIL);
 
  return(EXPRESSION(CAR(pi)));
}

References CAR, CDR, count, EXPRESSION, NIL, pips_assert, ref, and reference_indices.

string_fuse_final_linefeeds()

string string_fuse_final_linefeeds

(

string

s

)

Get rid of extra linefeed/newline at the end of a string.

This is sometimes useful to cleanup comments messed up by the lexical analyzer.

Warning: the argument s is updated if it ends up with LF

Definition at line 227 of file util.c.

{
  int l = strlen(s)-1;
 
  while(l>=1 && *(s+l)=='\n' && *(s+l-1)=='\n') {
    *(s+l) = '\000';
    l--;
  }
 
  return s;
}

string_remove_trailing_line_feed()

string string_remove_trailing_line_feed

(

string

s

)

Remove trailing line feed if any.

Definition at line 169 of file util.c.

{
  int sl = strlen(s);
  if(sl>0) {
    string ntl = s+sl-1;
    if(sl>0 && *ntl=='\n') {
      *ntl='\000';
    }
  }
  return s;
}

string_remove_trailing_line_feeds()

string string_remove_trailing_line_feeds

(

string

s

)

Remove trailing line feeds.

This function has been implemented three times. See below string_strip_final_linefeeds() and string_fuse_final_linefeeds().

Definition at line 186 of file util.c.

{
  int sl = strlen(s);
  if(sl>0) {
    string ntl = s+sl-1;
    while(sl>0 && *ntl=='\n') {
      *ntl='\000';
      ntl--;
      sl--;
    }
  }
  return s;
}

string_strip_final_linefeeds()

string string_strip_final_linefeeds

(

string

s

)

Get rid of linefeed/newline at the end of a string.

This is sometimes useful to cleanup comments messed up by the lexical analyzer.

Warning: the argument s is updated if it ends up with LF

Definition at line 208 of file util.c.

{
  int l = strlen(s)-1;
 
  while(l>=0 && *(s+l)=='\n') {
    *(s+l) = '\000';
    l--;
  }
 
  return s;
}