print.c File Reference

#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include "genC.h"
#include "linear.h"
#include "misc.h"
#include "pipsdbm.h"
#include "properties.h"
#include "ri-util.h"
#include "text-util.h"
#include "top-level.h"
#include "prettyprint.h"
#include "pips-libs.h"

Include dependency graph for print.c:

Go to the source code of this file.

Macros
#define	all_priv   "PRETTYPRINT_ALL_PRIVATE_VARIABLES"
#define	print_effects(e)    pips_internal_error("print_effects function not available")
#define	print_effect(e)    pips_internal_error("print_effect function not available")
#define	print_region(x)    pips_internal_error("print_region function not available")
#define	transformer_with_temporary_values_p(t)   ((t) != NULL)
#define	dump_transformer(t)    pips_internal_error("dump_transformer function not available")
#define	print_transformer(t)    pips_internal_error("print_transformer function not available")
#define	points_to_domain   (-1)
#define	points_to_list_domain   (-1)
#define	points_to_graph_domain   (-1)
#define	print_points_to(x)    pips_internal_error("print_points_to function not available")
#define	print_points_to_cell(x)    pips_internal_error("print_points_to_cell function not available")
#define	print_points_to_cells(x)    pips_internal_error("print_points_to_cells function not available")
#define	print_points_to_list(x)    pips_internal_error("print_points_to_list function not available")
#define	print_points_to_graph(x)    pips_internal_error("print_points_to_graph function not available")
#define	print_points_to_relations(x)    pips_internal_error("print_points_to_relations function not available")

Functions
bool	make_text_resource (const char *mod_name, const char *res_name, const char *file_ext, text texte)
	Main C functions to print code, sequential or parallel. More...
bool	make_text_resource_and_free (const char *mod_name, const char *res_name, const char *file_ext, text t)
bool	user_view_p ()
	print_code or print_source More...
bool	print_code_or_source (string mod_name)
	Generic function to prettyprint some sequential or parallel code, or even user view for the given module. More...
static bool	print_parallelized_code_common (const char *mod_name, const char *style)
	Build a textual resource for a parallel code using a string optional parallel style (dialect such as "f90", "doall", "hpf", "omp". More...
bool	print_code (const string mod_name)
bool	print_source (const string mod_name)
bool	print_parallelized_code (const string mod_name)
bool	print_parallelized90_code (const string mod_name)
bool	print_parallelized77_code (const string mod_name)
bool	print_parallelizedHPF_code (const string module_name)
bool	print_parallelizedOMP_code (const string mod_name)
bool	print_parallelizedMPI_code (const string mod_name)
void	dprint (expression x)
	For debugging: prettyprint many different kinds of newgen objects FC: type should be gen_chunk... More...

Variables
static bool	is_user_view

Macro Definition Documentation

all_priv

#define all_priv   "PRETTYPRINT_ALL_PRIVATE_VARIABLES"

Definition at line 304 of file print.c.

dump_transformer

#define dump_transformer

(

t

)

pips_internal_error("dump_transformer function not available")

Definition at line 355 of file print.c.

points_to_domain

#define points_to_domain   (-1)

Definition at line 367 of file print.c.

points_to_graph_domain

#define points_to_graph_domain   (-1)

Definition at line 373 of file print.c.

points_to_list_domain

#define points_to_list_domain   (-1)

Definition at line 370 of file print.c.

print_effect

#define print_effect

(

e

)

pips_internal_error("print_effect function not available")

Definition at line 336 of file print.c.

print_effects

#define print_effects

(

e

)

pips_internal_error("print_effects function not available")

Definition at line 334 of file print.c.

print_points_to

#define print_points_to

(

x

)

pips_internal_error("print_points_to function not available")

Definition at line 375 of file print.c.

print_points_to_cell

#define print_points_to_cell

(

x

)

pips_internal_error("print_points_to_cell function not available")

Definition at line 377 of file print.c.

print_points_to_cells

#define print_points_to_cells

(

x

)

pips_internal_error("print_points_to_cells function not available")

Definition at line 379 of file print.c.

print_points_to_graph

#define print_points_to_graph

(

x

)

pips_internal_error("print_points_to_graph function not available")

Definition at line 383 of file print.c.

print_points_to_list

#define print_points_to_list

(

x

)

pips_internal_error("print_points_to_list function not available")

Definition at line 381 of file print.c.

print_points_to_relations

#define print_points_to_relations

(

x

)

pips_internal_error("print_points_to_relations function not available")

Definition at line 385 of file print.c.

print_region

#define print_region

(

x

)

pips_internal_error("print_region function not available")

Definition at line 343 of file print.c.

print_transformer

#define print_transformer

(

t

)

pips_internal_error("print_transformer function not available")

Definition at line 357 of file print.c.

transformer_with_temporary_values_p

#define transformer_with_temporary_values_p

(

t

)

((t) != NULL)

Definition at line 354 of file print.c.

Function Documentation

dprint()

void dprint

(

expression

x

)

For debugging: prettyprint many different kinds of newgen objects FC: type should be gen_chunk...

Definition at line 392 of file print.c.

{
  debug_on("PRETTYPRINT_DEBUG_LEVEL");
  if(expression_undefined_p(x))
    (void) fprintf(stderr, "UNDEFINED NEWGEN OBJECT\n");
  else if(x==0)
    (void) fprintf(stderr, "EMPTY LIST\n");
  else {
    int ot = expression_domain_number(x);
    if(ot==0)
      (void) fprintf(stderr,"PROBABLY AN EMPTY LIST\n");
    else if(expression_undefined_p(x))
      (void) fprintf(stderr,"UNDEFINED NEWGEN OBJECT\n");
    else if(ot==expression_domain)
      print_expression( x);
    else if(ot==reference_domain)
      print_reference((reference) x);
    else if(ot==points_to_domain)
      print_points_to((points_to) x); // See also print_points_to_relation
    else if(ot==cell_domain) {
      print_points_to_cell((cell) x);
      fprintf(stderr, "\n");
    }
    else if(ot==type_domain)
      print_type((type) x);
    else if(ot==statement_domain)
      print_statement((statement) x);
    else if(ot==effect_domain) {
      descriptor d = effect_descriptor((effect) x);
      if(descriptor_none_p(d))
        print_effect((effect) x);
      else
        print_region((effect) x);
    }
    else if(ot==points_to_list_domain)
      print_points_to_list((points_to_list) x);
    else if(ot==points_to_graph_domain)
      print_points_to_graph((points_to_graph) x);
    else if(ot==text_domain)
      print_text(stderr, (text) x);
    else if(ot==entity_domain) {
      entity m = get_current_module_entity();
      entity mx = module_name_to_entity(entity_module_name((entity)x));
      if(entity_undefined_p(mx))
        fprintf(stderr, "%s\n", entity_name((entity) x));
      else {
        if(m!=mx)
          fprintf(stderr,"%s" MODULE_SEP_STRING, entity_local_name(mx));
        fprintf(stderr, "%s\n", entity_local_name((entity) x));
      }
    }
    else if(ot==basic_domain) {
      string s = basic_to_string((basic) x);
      fprintf(stderr, "%s\n", s);
      free(s);
    }
    else if(ot==transformer_domain) {
      transformer t = (transformer)x;
      if(transformer_with_temporary_values_p(t))
        dump_transformer(t);
      else {
        // FI: print_transformer() core dumps in interprocedural
        // settings and dump_transformer() is as good for debugging ig
        // not better
        dump_transformer(t);
      }
    }
    else if(ot==effects_domain) {
      list el = effects_effects((effects) x);
      dprint((expression) el);
    }
    else if(ot==dimension_domain) {
      dimension d = (dimension) x;
      expression l = dimension_lower(d);
      expression u = dimension_upper(d);
      // list ql = dimension_qualifiers(d);
      // FI: lets forget abut qualifiers
      print_expression(l);
      print_expression(u);
    }
    else if(ot==qualifier_domain) {
      qualifier q = (qualifier) x;
      print_qualifier(q);
    }
    else if(0<=ot && ot<1000)
      (void) fprintf(stderr, "Unprocessed Newgen Object with tag %d\n", ot);
    else if(ot>1000 || ot<=0) {
      // FI: I do not know how to get the largest Newgen type
      // We could assume that the object is a list and look for the type
      // of the first object...
      (void) fprintf(stderr,"NOT A NEWGEN OBJECT. MAYBE A LIST\n");
      expression cx = EXPRESSION(CAR((list) x));
      int cot = expression_domain_number(cx);
      if(cot==expression_domain)
        print_expressions((list) x);
      else if(cot==reference_domain)
        print_references((list) x);
      else if(cot==cell_domain)
        print_points_to_cells((list) x);
      else if(cot==type_domain)
        print_types((list) x);
      else if(cot==statement_domain)
        print_statements((list) x);
      else if(cot==effect_domain)
        print_effects((list) x);
      else if(cot==points_to_domain)
        print_points_to_relations((list) x);
      else if(cot==transformer_domain) {
        list tl = (list) x;
        FOREACH(TRANSFORMER, t, tl) {
          if(transformer_with_temporary_values_p(t))
            dump_transformer(t);
          else
            dump_transformer(t);
        }
      }
      else if(cot==entity_domain) {
        // print_entities((list) x);
        list el = (list) x;
      entity m = get_current_module_entity();
        FOREACH(ENTITY, e, el) {
          entity me = module_name_to_entity(entity_module_name(e));
          if(m!=me)
            fprintf(stderr,"%s" MODULE_SEP_STRING, entity_local_name(me));
          fprintf(stderr, "%s\n", entity_local_name(e));
        }
      }
      else if(cot==dimension_domain) {
        list dl = (list) x;
        FOREACH(DIMENSION, d, dl) {
          expression l = dimension_lower(d);
          expression u = dimension_upper(d);
          // list ql = dimension_qualifiers(d);
          // FI: lets forget abut qualifiers
          print_expression(l);
          print_expression(u);
        }
      }
      else if(cot==qualifier_domain) {
        list ql = (list) x;
        print_qualifiers(ql);
      }
      else
        (void) fprintf(stderr, "If a list, a list of unknown objects: tag=%d\n", (int) cot);
    }
  }
  debug_off();
}

References basic_domain, basic_to_string(), CAR, cell_domain, debug_off, debug_on, descriptor_none_p, DIMENSION, dimension_domain, dimension_lower, dimension_upper, dprint(), dump_transformer, effect_descriptor, effect_domain, effects_domain, effects_effects, ENTITY, entity_domain, entity_local_name(), entity_module_name(), entity_name, entity_undefined_p, EXPRESSION, expression_domain, expression_domain_number, expression_undefined_p, FOREACH, fprintf(), free(), get_current_module_entity(), module_name_to_entity(), MODULE_SEP_STRING, points_to_domain, points_to_graph_domain, points_to_list_domain, print_effect, print_effects, print_expression(), print_expressions(), print_points_to, print_points_to_cell, print_points_to_cells, print_points_to_graph, print_points_to_list, print_points_to_relations, print_qualifier(), print_qualifiers(), print_reference(), print_references(), print_region, print_statement(), print_statements(), print_text(), print_type(), print_types(), qualifier_domain, reference_domain, statement_domain, text_domain, TRANSFORMER, transformer_domain, transformer_with_temporary_values_p, type_domain, and x.

Referenced by dprint().

Here is the call graph for this function:

Here is the caller graph for this function:

make_text_resource()

bool make_text_resource	(	const char *	mod_name,
		const char *	res_name,
		const char *	file_ext,
		text	texte
	)

Main C functions to print code, sequential or parallel.

print.c

generate resource res_name for module mod_name with prefix file_ext as the text provided. it should be made clear who is to free the texte structure. currently it looks like a massive memory leak.

Parameters

mod_name	od_name
res_name	module name
file_ext	resource name [DBR_...]
texte	file extension text to be printed as this resource

Definition at line 55 of file print.c.

{
    string filename, localfilename, dir;
    FILE *fd;
 
    localfilename = db_build_file_resource_name(res_name, mod_name, file_ext);
    dir = db_get_current_workspace_directory();
    filename = strdup(concatenate(dir, "/", localfilename, NULL));
    free(dir);
 
    fd = safe_fopen(filename, "w");
    debug_on("PRETTYPRINT_DEBUG_LEVEL");
    print_text(fd, texte);
    debug_off();
    safe_fclose(fd, filename);
 
    DB_PUT_FILE_RESOURCE(res_name, mod_name, localfilename);
    write_an_attachment_file(filename);
    free(filename);
 
    return true;
}

References concatenate(), db_build_file_resource_name(), db_get_current_workspace_directory(), DB_PUT_FILE_RESOURCE, debug_off, debug_on, free(), print_text(), safe_fclose(), safe_fopen(), strdup(), and write_an_attachment_file().

Referenced by make_text_resource_and_free(), print_aliases(), print_code_or_source(), print_code_semantics(), print_code_static_control(), print_code_with_comp_regions(), print_parallelized_code_common(), print_parallelizedCMF_code(), print_parallelizedCRAFT_code(), store_new_module(), and wp65().

Here is the call graph for this function:

Here is the caller graph for this function:

make_text_resource_and_free()

bool make_text_resource_and_free	(	const char *	mod_name,
		const char *	res_name,
		const char *	file_ext,
		text	t
	)

Parameters

mod_name	od_name
res_name	es_name
file_ext	ile_ext

Definition at line 82 of file print.c.

{
    bool ok = make_text_resource(mod_name, res_name, file_ext, t);
    free_text(t);
    return ok;
}

References free_text(), make_text_resource(), and ok.

Referenced by create_HRE_module(), generic_print_code_pv(), print_any_reductions(), print_code_or_source_comp(), print_code_points_to(), print_continuation_conditions(), print_initial_precondition(), print_program_precondition(), ProcessEntries(), and ProcessEntry().

Here is the call graph for this function:

Here is the caller graph for this function:

print_code()

bool print_code

(

const string

mod_name

)

Parameters

mod_name

od_name

Definition at line 272 of file print.c.

{
  is_user_view = false;
  return print_code_or_source(mod_name);
}

References is_user_view, and print_code_or_source().

Referenced by print_code_as_a_graph().

Here is the call graph for this function:

Here is the caller graph for this function:

print_code_or_source()

bool print_code_or_source

(

string

mod_name

)

Generic function to prettyprint some sequential or parallel code, or even user view for the given module.

FI: This test could be moved up in pipsmake?

FI: Should be a pips_internal_error() as pipsmake is here to avoid this very problem...

Since we want to prettyprint with a sequential syntax, save the PRETTYPRINT_PARALLEL property that may select the parallel output style before overriding it:

Select the default prettyprint style for sequential prettyprint:

Restore the previous PRETTYPRINT_PARALLEL property for the next parallel code prettyprint:

Parameters

mod_name

od_name

Definition at line 103 of file print.c.

                                           {
  bool success = false;
  text r = make_text(NIL);
  entity module;
  statement mod_stat;
  string pp;
  bool print_graph_p = get_bool_property("PRETTYPRINT_UNSTRUCTURED_AS_A_GRAPH");
  string resource_name =
      strdup(print_graph_p ? DBR_GRAPH_PRINTED_FILE
                           : (is_user_view ? DBR_PARSED_PRINTED_FILE
                                           : DBR_PRINTED_FILE));
  string file_ext = string_undefined;
 
  /* FI: This test could be moved up in pipsmake? */
  if(entity_undefined_p(module = module_name_to_entity(mod_name))) {
    /* FI: Should be a pips_internal_error() as pipsmake is here to
     avoid this very problem... */
    pips_user_error("Module \"\%s\"\n not found", mod_name);
    return false;
  }
 
  /*
   * Set the current language
   */
  value mv = entity_initial(module);
  if(value_code_p(mv)) {
    code c = value_code(mv);
    set_prettyprint_language_from_property(language_tag(code_language(c)));
  }
 
  switch(get_prettyprint_language_tag()) {
    case is_language_fortran:
      file_ext = strdup(concatenate(is_user_view ? PRETTYPRINT_FORTRAN_EXT
                                                 : PREDICAT_FORTRAN_EXT,
                                    print_graph_p ? GRAPH_FILE_EXT : "",
                                    NULL));
      break;
    case is_language_c:
      file_ext = strdup(concatenate(is_user_view ? PRETTYPRINT_C_EXT
                                                 : PREDICAT_C_EXT,
                                    print_graph_p ? GRAPH_FILE_EXT : "",
                                    NULL));
      break;
    case is_language_fortran95:
      file_ext = strdup(concatenate(is_user_view ? PRETTYPRINT_F95_EXT
                                                 : PREDICAT_F95_EXT,
                                    print_graph_p ? GRAPH_FILE_EXT : "",
                                    NULL));
      break;
    default:
      pips_internal_error("Language unknown !");
      break;
  }
 
  set_current_module_entity(module);
 
  /* Since we want to prettyprint with a sequential syntax, save the
   PRETTYPRINT_PARALLEL property that may select the parallel output
   style before overriding it: */
  pp = strdup(get_string_property("PRETTYPRINT_PARALLEL"));
  /* Select the default prettyprint style for sequential prettyprint: */
  set_string_property("PRETTYPRINT_PARALLEL",
                      get_string_property("PRETTYPRINT_SEQUENTIAL_STYLE"));
 
  mod_stat = (statement)db_get_memory_resource(is_user_view ? DBR_PARSED_CODE
                                                            : DBR_CODE,
                                               mod_name,
                                               true);
 
  set_current_module_statement(mod_stat);
 
  debug_on("PRETTYPRINT_DEBUG_LEVEL");
 
  begin_attachment_prettyprint();
  init_prettyprint(empty_text);
  MERGE_TEXTS(r, text_module(module,mod_stat));
  success = make_text_resource(mod_name, resource_name, file_ext, r);
  end_attachment_prettyprint();
 
  debug_off();
 
  /* Restore the previous PRETTYPRINT_PARALLEL property for the next
   parallel code prettyprint: */
  set_string_property("PRETTYPRINT_PARALLEL", pp);
  free(pp);
 
  reset_current_module_entity();
  reset_current_module_statement();
 
  free_text(r);
  free(resource_name);
  free(file_ext);
 
  return success;
}

References begin_attachment_prettyprint(), code_language, concatenate(), db_get_memory_resource(), debug_off, debug_on, empty_text(), end_attachment_prettyprint(), entity_initial, entity_undefined_p, free(), free_text(), get_bool_property(), get_prettyprint_language_tag(), get_string_property(), init_prettyprint(), is_language_c, is_language_fortran, is_language_fortran95, is_user_view, language_tag, make_text(), make_text_resource(), MERGE_TEXTS, mod_stat, module, module_name_to_entity(), NIL, pips_internal_error, pips_user_error, reset_current_module_entity(), reset_current_module_statement(), resource_name, set_current_module_entity(), set_current_module_statement(), set_prettyprint_language_from_property(), set_string_property(), strdup(), string_undefined, text_module(), value_code, and value_code_p.

Referenced by print_code(), and print_source().

Here is the call graph for this function:

Here is the caller graph for this function:

print_parallelized77_code()

bool print_parallelized77_code

(

const string

mod_name

)

Parameters

mod_name

od_name

Definition at line 294 of file print.c.

{
    return print_parallelized_code_common(mod_name, "doall");
}

References print_parallelized_code_common().

Here is the call graph for this function:

print_parallelized90_code()

bool print_parallelized90_code

(

const string

mod_name

)

Parameters

mod_name

od_name

Definition at line 289 of file print.c.

{
    return print_parallelized_code_common(mod_name, "f90");
}

References print_parallelized_code_common().

Here is the call graph for this function:

print_parallelized_code()

bool print_parallelized_code

(

const string

mod_name

)

Parameters

mod_name

od_name

Definition at line 284 of file print.c.

{
    return print_parallelized_code_common(mod_name, NULL);
}

References print_parallelized_code_common().

Here is the call graph for this function:

print_parallelized_code_common()

static bool print_parallelized_code_common ( const char *  mod_name, const char *  style  )

static

Build a textual resource for a parallel code using a string optional parallel style (dialect such as "f90", "doall", "hpf", "omp".

Definition at line 202 of file print.c.

{
    bool success = false;
    text r = make_text(NIL);
    entity module = module_name_to_entity(mod_name);
    statement mod_stat;
    string pp = string_undefined;
 
    set_current_module_entity(module);
 
    if (style) {
        pp = strdup(get_string_property("PRETTYPRINT_PARALLEL"));
        set_string_property("PRETTYPRINT_PARALLEL", style);
    }
 
    begin_attachment_prettyprint();
 
    init_prettyprint(empty_text);
 
    mod_stat = (statement)
        db_get_memory_resource(DBR_PARALLELIZED_CODE, mod_name, true);
 
    debug_on("PRETTYPRINT_DEBUG_LEVEL");
    MERGE_TEXTS(r, text_module(module, mod_stat));
    debug_off();
 
    close_prettyprint();
 
    switch(get_prettyprint_language_tag()) {
    case is_language_fortran:
      success = make_text_resource(mod_name,
                                   DBR_PARALLELPRINTED_FILE,
                                   PARALLEL_FORTRAN_EXT,
                                   r);
      break;
    case is_language_c:
      success = make_text_resource(mod_name,
                                   DBR_PARALLELPRINTED_FILE,
                                   PARALLEL_C_EXT,
                                   r);
      break;
    case is_language_fortran95:
      success = make_text_resource(mod_name,
                                   DBR_PARALLELPRINTED_FILE,
                                   PARALLEL_FORTRAN95_EXT,
                                   r);
      break;
    default:
      pips_internal_error("Language unknown !");
      break;
    }
 
    end_attachment_prettyprint();
 
    if (style) {
        set_string_property("PRETTYPRINT_PARALLEL", pp);
        free(pp);
    }
 
    reset_current_module_entity();
 
    free_text(r);
    return success;
}

References begin_attachment_prettyprint(), close_prettyprint(), db_get_memory_resource(), debug_off, debug_on, empty_text(), end_attachment_prettyprint(), free(), free_text(), get_prettyprint_language_tag(), get_string_property(), init_prettyprint(), is_language_c, is_language_fortran, is_language_fortran95, make_text(), make_text_resource(), MERGE_TEXTS, mod_stat, module, module_name_to_entity(), NIL, pips_internal_error, reset_current_module_entity(), set_current_module_entity(), set_string_property(), strdup(), string_undefined, and text_module().

Referenced by print_parallelized77_code(), print_parallelized90_code(), print_parallelized_code(), print_parallelizedHPF_code(), print_parallelizedMPI_code(), and print_parallelizedOMP_code().

Here is the call graph for this function:

Here is the caller graph for this function:

print_parallelizedHPF_code()

bool print_parallelizedHPF_code

(

const string

module_name

)

Parameters

module_name

odule_name

Definition at line 299 of file print.c.

{
    return print_parallelized_code_common(module_name, "hpf");
}

References module_name(), and print_parallelized_code_common().

Here is the call graph for this function:

print_parallelizedMPI_code()

bool print_parallelizedMPI_code

(

const string

mod_name

)

Parameters

mod_name

od_name

Definition at line 314 of file print.c.

{
  return print_parallelized_code_common(mod_name, "mpi");
}

References print_parallelized_code_common().

Here is the call graph for this function:

print_parallelizedOMP_code()

bool print_parallelizedOMP_code

(

const string

mod_name

)

Parameters

mod_name

od_name

Definition at line 306 of file print.c.

{
    if (get_bool_property(all_priv))
        pips_user_warning("avoid property " all_priv "=TRUE with OMP\n");
 
    return print_parallelized_code_common(mod_name, "omp");
}

References all_priv, get_bool_property(), pips_user_warning, and print_parallelized_code_common().

Here is the call graph for this function:

print_source()

bool print_source

(

const string

mod_name

)

Parameters

mod_name

od_name

Definition at line 278 of file print.c.

{
  is_user_view = true;
  return print_code_or_source(mod_name);
}

References is_user_view, and print_code_or_source().

Here is the call graph for this function:

user_view_p()

bool user_view_p

(

void

)

print_code or print_source

Definition at line 95 of file print.c.

{
    return is_user_view;
}

References is_user_view.

Variable Documentation

is_user_view

bool is_user_view

static

Definition at line 93 of file print.c.

Referenced by print_code(), print_code_or_source(), print_source(), and user_view_p().