syntheses.h File Reference

#include "linear.h"
#include "genC.h"
#include "text.h"
#include "newgen.h"
#include "naming.h"
#include "ri.h"
#include "ri-util.h"
#include "pipsdbm.h"
#include "workspace-util.h"

Include dependency graph for syntheses.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
void	add_new_compilation_unit (const char *, bool, entity)
	Warning! Do not modify this file that is automatically generated! More...
bool	add_new_module_from_text (const char *, text, bool, const char *)
	Add the new resource files associated to a module with its more-or-less correct code. More...
bool	add_new_module (const char *, entity, statement, bool)
	Add the new resource files associated to a module with its more-or-less correct code. More...
void	set_internal_missing_module_resolver_handler (string(*)(const char *))
bool	fortran_initializer (const string)
	Create a module with its related file resources when there is no Fortran source for it. More...
bool	initializer (const string)
	A phase that creates a module with its related file resources when there is no Fortran source for it. More...
bool	c_initializer (const string)
	A phase that creates a module with its related file resources when there is no C source for it. More...
bool	clone_on_argument (const string)
	clone.c More...
bool	clone (const string)
bool	clone_substitute (const string)
bool	clone_only (const string)

Function Documentation

add_new_compilation_unit()

void add_new_compilation_unit	(	const char *	compilation_unit_name,
		bool	is_fortran,
		entity	module
	)

Warning! Do not modify this file that is automatically generated!

Modify src/Libs/syntheses/syntheses-local.h instead, to add your own modifications. header file built by cproto syntheses-local.h SYNTHESES Library: Passes and functions generating new modules, or removing modules, such as initializer, clone, inlining and outlining cproto-generated files initializer.c

Add the compilation unit files

Builds the compilation unit stub: it can be empty or include module_name declaration as an extern function.

Put it in the source file and link the initial file.

Parameters

compilation_unit_name	ompilation_unit_name
is_fortran	s_fortran
module	odule

Definition at line 367 of file initializer.c.

                                                                                            {
    /* Add the compilation unit files */
    pips_assert("The compilation unit name is defined", !string_undefined_p(compilation_unit_name));
    user_log("Registering synthesized compilation unit %s\n", compilation_unit_name);
    entity cu = FindEntity(TOP_LEVEL_MODULE_NAME,compilation_unit_name);
    const char* res = is_fortran? DBR_INITIAL_FILE : DBR_C_SOURCE_FILE;
    if(entity_undefined_p(cu))
        cu = MakeCompilationUnitEntity(compilation_unit_name);
 
    char *dir_name = db_get_current_workspace_directory();
 
    char *file_name;
    char* cu_real = strdup(compilation_unit_name);
    cu_real[strlen(cu_real)-1]=0;
    asprintf(&file_name,"%s" PP_C_ED ,cu_real);
    free(cu_real);
 
    char * src_name;
    asprintf(&src_name,WORKSPACE_TMP_SPACE "/%s",file_name);
    char *full_name;
    asprintf(&full_name,"%s/%s",dir_name,src_name);
    free(src_name);
 
    char *init_name = db_build_file_resource_name(res, compilation_unit_name, is_fortran? FORTRAN_INITIAL_FILE_SUFFIX : C_FILE_SUFFIX);
    char *finit_name;
    asprintf(&finit_name,"%s/%s", dir_name, init_name);
    free(dir_name);
 
    /* Builds the compilation unit stub: it can be empty or include
       module_name declaration as an extern function.
       */
    text stub = entity_undefined_p(module) ? make_text(NIL) : compilation_unit_text(cu, module) ;
 
    /* Put it in the source file and link the initial file.
    */
    db_make_subdirectory(WORKSPACE_TMP_SPACE);
    FILE *f = safe_fopen(finit_name, "w");
    print_text(f, stub);
    safe_fclose(f, finit_name);
    free_text(stub);
 
    if(!file_exists_p(full_name)) {
        FILE *fake = safe_fopen(full_name,"a");
        safe_fclose(fake, full_name);
    }
    DB_PUT_FILE_RESOURCE(res, compilation_unit_name, init_name);
    DB_PUT_FILE_RESOURCE(DBR_USER_FILE, compilation_unit_name, full_name);
    DB_PUT_FILE_RESOURCE(DBR_INPUT_FILE_NAME, compilation_unit_name, strdup(""));
}

References asprintf, compilation_unit_name, compilation_unit_text(), db_build_file_resource_name(), db_get_current_workspace_directory(), db_make_subdirectory, DB_PUT_FILE_RESOURCE, entity_undefined_p, f(), file_exists_p(), file_name, FindEntity(), free(), free_text(), full_name, make_text(), MakeCompilationUnitEntity(), module, NIL, pips_assert, print_text(), safe_fclose(), safe_fopen(), strdup(), string_undefined_p, TOP_LEVEL_MODULE_NAME, user_log(), and WORKSPACE_TMP_SPACE.

Referenced by add_new_module_from_text(), and outliner_compilation_unit().

Here is the call graph for this function:

Here is the caller graph for this function:

add_new_module()

bool add_new_module	(	const char *	module_name,
		entity	module,
		statement	stat,
		bool	is_fortran
	)

Add the new resource files associated to a module with its more-or-less correct code.

The idea is to prettyprint the module to some file resources and to parse it later in order to have a full-fledge module with all the PIPS structured up-to-date.

Useful for code generation, out-lining...

There is still some redundancy with module_name, module and stat

Get a text code for the new module

Parameters

module_name	odule_name
module	odule
stat	tat
is_fortran	text heading

Definition at line 553 of file initializer.c.

  {
  /* Get a text code for the new module */
  text code_text = text_module(module, stat);
  bool ret = add_new_module_from_text(module_name,
                                  code_text,
                                  is_fortran,
                  string_undefined);
  free_text(code_text);
 
  return ret;
}

References add_new_module_from_text(), free_text(), module, module_name(), ret, string_undefined, and text_module().

Referenced by create_module_with_statement().

Here is the call graph for this function:

Here is the caller graph for this function:

add_new_module_from_text()

bool add_new_module_from_text	(	const char *	module_name,
		text	code_text,
		bool	is_fortran,
		const char *	compilation_unit_name
	)

Add the new resource files associated to a module with its more-or-less correct code.

The idea is to prettyprint the module to some file resources and to parse it later in order to have a full-fledge module with all the PIPS data structures up-to-date.

Useful for code generation, out-lining, stub generation...

Should be checked with different module with the same name... Maybe a conflict in WORKSPACE_TMP_SPACE ?

relative to the current directory

For C only: compilation unit cu and compilation unit name cun

depending on output language, build compilation unit, select prettyprinter choose out file name

pips' current directory is just above the workspace

Put the code text in the temporary source file

A PIPS database may be partly incoherent after a core dump but still usable (Cathare 2, FI). So delete a previously finit_name file.

The initial file is linked to the newly generated temporary file:

Add the new generated file as a file resource with its local name... should only put a new user file, I guess?

The user file dwells in the WORKSPACE_TMP_SPACE

Parameters

module_name	odule_name
code_text	ode_text
is_fortran	s_fortran
compilation_unit_name	ompilation_unit_name

Definition at line 431 of file initializer.c.

                                                {
    bool success_p = true;
    entity m = local_name_to_top_level_entity(module_name);
    /* relative to the current directory */
    FILE * f;
    const char *res = is_fortran? DBR_INITIAL_FILE : DBR_C_SOURCE_FILE;
 
    /* For C only: compilation unit cu and compilation unit name cun */
    char* cun = string_undefined;
    entity cu = entity_undefined;
 
    if(entity_undefined_p(m))
    {
      pips_user_error(
        "No entity defined for module %s although it might"
        " have been encountered at a call site\n", module_name);
      return false;
    }
 
    /* depending on output language, build compilation unit,
     * select prettyprinter
     * choose out file name
     */
    char *file_name;
    if(is_fortran) {
      set_prettyprint_language_tag(is_language_fortran);
      asprintf(&file_name,"%s" FORTRAN_FILE_SUFFIX ,module_name );
    }
    else {
      set_prettyprint_language_tag(is_language_c);
      if(string_undefined_p(compilation_unit_name)) {
        cun = compilation_unit_of_module(module_name);
      }
      else {
        cun = strdup(compilation_unit_name);
        if(entity_undefined_p(FindEntity(TOP_LEVEL_MODULE_NAME,cun)))
          cu = MakeCompilationUnitEntity(cun);
      }
 
      // Build the corresponding compilation unit for C code
      if(string_undefined_p(cun)) {
        char * the_cu = NULL,*iter;
        if((iter=strchr(module_name,FILE_SEP))) {
          the_cu = strndup(module_name,iter-module_name);
        }
        else the_cu = strdup(module_name);
        asprintf(&cun, "%s" FILE_SEP_STRING, the_cu);
        cu = MakeCompilationUnitEntity(cun);
        free(the_cu);
      }
 
      /* pips' current directory is just above the workspace
       */
      string cu_real = strdup(cun);
      cu_real[strlen(cu_real)-1]=0;
      asprintf(&file_name,"%s" PP_C_ED ,cu_real);
      free(cu_real);
    }
    char *dir_name = db_get_current_workspace_directory(), *src_name;
    asprintf(&src_name,WORKSPACE_TMP_SPACE "/%s",file_name);
    char *full_name;
    asprintf(&full_name,"%s/%s",dir_name,src_name);
    char *init_name =
      db_build_file_resource_name(res, entity_local_name(m), is_fortran? FORTRAN_INITIAL_FILE_SUFFIX : C_FILE_SUFFIX);
    char *finit_name;
    asprintf(&finit_name,"%s/%s" ,dir_name,init_name);
    free(dir_name);
 
    /* Put the code text in the temporary source file */
    db_make_subdirectory(WORKSPACE_TMP_SPACE);
    f = safe_fopen(finit_name, "w");
    print_text(f, code_text);
    safe_fclose(f, finit_name);
    /* A PIPS database may be partly incoherent after a core dump but
       still usable (Cathare 2, FI). So delete a previously finit_name
       file. */
    if(file_exists_p(full_name))
      safe_unlink(full_name);
    /* The initial file is linked to the newly generated temporary file: */
    safe_link(full_name, finit_name);
    free(finit_name);
 
    /* Add the new generated file as a file resource with its local
     * name...  should only put a new user file, I guess?
     */
    user_log("Registering synthesized file %s\n", file_name );
    free(file_name);
    DB_PUT_FILE_RESOURCE(res, module_name, init_name);
    /* The user file dwells in the WORKSPACE_TMP_SPACE */
    DB_PUT_FILE_RESOURCE(DBR_USER_FILE, module_name, full_name);
    if(!is_fortran) {
      // No input file for synthesized C code
      DB_PUT_FILE_RESOURCE(DBR_INPUT_FILE_NAME, module_name, strdup(""));
    }
 
    if( !entity_undefined_p(cu) ) { // C is assumed
        add_new_compilation_unit(cun, is_fortran, m);
    }
    else if(!is_fortran) {
        if(entity_undefined_p(cu)) cu = module_name_to_entity(cun);
    }
 
    if(!string_undefined_p(cun)) free(cun);
    return success_p;
}

References add_new_compilation_unit(), asprintf, compilation_unit_name, compilation_unit_of_module(), db_build_file_resource_name(), db_get_current_workspace_directory(), db_make_subdirectory, DB_PUT_FILE_RESOURCE, entity_local_name(), entity_undefined, entity_undefined_p, f(), file_exists_p(), file_name, FILE_SEP, FILE_SEP_STRING, FindEntity(), free(), full_name, is_language_c, is_language_fortran, local_name_to_top_level_entity(), MakeCompilationUnitEntity(), module_name(), module_name_to_entity(), pips_user_error, print_text(), safe_fclose(), safe_fopen(), safe_link(), safe_unlink(), set_prettyprint_language_tag(), strdup(), string_undefined, string_undefined_p, strndup(), TOP_LEVEL_MODULE_NAME, user_log(), and WORKSPACE_TMP_SPACE.

Referenced by add_new_module(), create_module_with_statement(), missing_file_initializer(), outliner_file(), outliner_independent_recursively(), and simd_memory_packing().

Here is the call graph for this function:

Here is the caller graph for this function:

c_initializer()

bool c_initializer

(

const

string

)

A phase that creates a module with its related file resources when there is no C source for it.

Parameters

string

odule_name

Definition at line 853 of file initializer.c.

{
  bool res = false;
 
  debug_on("INITIALIZER_DEBUG_LEVEL");
  res = generic_initializer(module_name, false);
  debug_off();
 
  return res;
}

References debug_off, debug_on, generic_initializer(), and module_name().

Here is the call graph for this function:

clone()

bool clone

(

const

string

)

Parameters

string

ame

Referenced by get_private_entities(), and insert_rwt().

Here is the caller graph for this function:

clone_on_argument()

bool clone_on_argument

(

const

string

)

clone.c

Parameters

string

ame

clone_only()

bool clone_only

(

const

string

)

Parameters

string

od_name

clone_substitute()

bool clone_substitute

(

const

string

)

Parameters

string

ame

fortran_initializer()

bool fortran_initializer

(

const

string

)

Create a module with its related file resources when there is no Fortran source for it.

Parameters

string

odule_name

Definition at line 831 of file initializer.c.

{
  return generic_initializer(module_name, true);
}

References generic_initializer(), and module_name().

Here is the call graph for this function:

initializer()

bool initializer

(

const

string

)

A phase that creates a module with its related file resources when there is no Fortran source for it.

Parameters

string

odule_name

Definition at line 839 of file initializer.c.

{
  bool res = false;
 
  debug_on("INITIALIZER_DEBUG_LEVEL");
  res = generic_initializer(module_name, true);
  debug_off();
 
  return res;
}

References debug_off, debug_on, generic_initializer(), and module_name().

Here is the call graph for this function:

set_internal_missing_module_resolver_handler()

void set_internal_missing_module_resolver_handler

(

string(*)(const char *)

_internal_resolver

)

Definition at line 612 of file initializer.c.

                                                                                              {
  internal_resolver = _internal_resolver;
}

References internal_resolver.

Referenced by set_python_missing_module_resolver_handler().

Here is the caller graph for this function: