pypips.c File Reference

#include <unistd.h>
#include <stdlib.h>
#include <stdio.h>
#include <assert.h>
#include <string.h>
#include <stdarg.h>
#include "linear.h"
#include "genC.h"
#include "ri.h"
#include "database.h"
#include "misc.h"
#include "ri-util.h"
#include "pipsdbm.h"
#include "resources.h"
#include "phases.h"
#include "properties.h"
#include "pipsmake.h"
#include "text-util.h"
#include "top-level.h"
#include <Python.h>

Include dependency graph for pypips.c:

Go to the source code of this file.

Functions
statement	find_loop_from_label (statement, entity)
	hmmm... More...
static void	pyps_log_handler (const char *fmt, va_list *args)
static void	pyps_error_handler (const char *calling_function_name, const char *a_message_format, va_list *args)
void	close_log_buffer (void)
void	open_log_buffer (void)
char *	get_log_buffer (void)
void	verbose (bool on)
	DEFINE_LOCAL_STACK (properties, property)
	stack of properties, so that the previous value can be reinstated when going out of a phase. More...
void	set_property (const char *propname, const char *value)
void	push_property (const char *name, const char *value)
void	pop_property (const char *name)
void	atinit (void)
void	create (char *workspace_name, char **filenames)
	create a new workspace... More...
char *	info (char *about)
void	apply (char *phasename, char *target)
	apply a transformation on a module More...
void	capply (char *phasename, char **targets)
	apply a transformation on a set of modules, concurrently More...
void	display (char *rname, char *mname)
	display resource rname about module mname More...
char *	show (char *rname, char *mname)
	return the rname[mname] resource, which must be a string containing a file name More...
char *	get_callers_of (char *module_name)
	Returns the list of the modules that call that specific module, separated by ' '. More...
char *	get_callees_of (char *module_name)
	Returns the list of the modules called by that specific module, separated by ' '. More...
char *	pyps_get_stubs (void)
	Returns the list of the modules called by that specific module, separated by ' '. More...
void	setenviron (char *name, char *value)
	add an environment variable of a given value More...
char *	getenviron (char *name)
	get environment variable More...
bool	add_a_file (string file)
	Add a source file to the workspace We wrap process_user_file() here with a hack to define the workspace language so that some pipsmake activate specific to the language will be defined. More...
char *	get_module_language (string mod_name)
static string	get_stub_from_broker (string str)
void	set_python_missing_module_resolver_handler (PyObject *PyObj)
bool	get_loop_execution_parallel (const char *module_name, const char *loop_label)
	Read execution mode for a loop. More...
void	set_loop_execution_parallel (const char *module_name, const char *loop_label, bool exec_parallel_p)
	Change execution mode for a loop. More...

Variables
static FILE *	logstream = NULL
static list	log_list = list_undefined
char *	pyps_last_error = NULL
static PyObject *	stub_broker = NULL

Function Documentation

add_a_file()

bool add_a_file

(

string

file

)

Add a source file to the workspace We wrap process_user_file() here with a hack to define the workspace language so that some pipsmake activate specific to the language will be defined.

This function will be removed when pipsmake will be improved to handle multilanguage workspace !

Definition at line 466 of file pypips.c.

{
  gen_array_t filename_list = gen_array_make(0);
  gen_array_append(filename_list,file);
  language workspace_language(gen_array_t files);
  language l = workspace_language(filename_list);
  activate_language(l);
  free_language(l);
  gen_array_free(filename_list);
  bool process_user_file(string file);
  if(process_user_file(file)==false) {
    pips_user_error("Error adding new file.");
    return false;
  }
  return true;
}

References activate_language(), free_language(), gen_array_append(), gen_array_free(), gen_array_make(), pips_user_error, process_user_file(), and workspace_language().

Here is the call graph for this function:

apply()

void apply	(	char *	phasename,
		char *	target
	)

apply a transformation on a module

Definition at line 324 of file pypips.c.

{
  if (!safe_apply(phasename,target)) {
    if(!pyps_last_error)
      asprintf(&pyps_last_error, "phase %s on module %s failed" ,
               phasename, target);
    THROW(user_exception_error);
  }
}

References asprintf, pyps_last_error, safe_apply(), THROW, and user_exception_error.

Here is the call graph for this function:

atinit()

void atinit

(

void

)

init various composants

Definition at line 222 of file pypips.c.

{
  /* init various composants */
  // FIXME
  set_pips_meta_informations("<unknown>", "<unknown>", "<unknown>");
 
  initialize_newgen();
  initialize_sc((char*(*)(Variable))entity_local_name);
  pips_log_handler = pyps_log_handler;
  pips_error_handler = pyps_error_handler;
  set_exception_callbacks(push_pips_context, pop_pips_context);
  make_properties_stack();
}

References entity_local_name(), initialize_newgen(), initialize_sc(), pips_error_handler, pips_log_handler, pop_pips_context(), push_pips_context(), pyps_error_handler(), pyps_log_handler(), set_exception_callbacks(), and set_pips_meta_informations().

Here is the call graph for this function:

capply()

void capply	(	char *	phasename,
		char **	targets
	)

apply a transformation on a set of modules, concurrently

Definition at line 336 of file pypips.c.

{
  // create the array of arguments
  gen_array_t target_list = gen_array_make(0);
  while (*targets)
  {
    gen_array_append(target_list,*targets);
    targets++;
  }
  bool ok = safe_concurrent_apply(phasename, target_list);
  gen_array_free(target_list);
  if(!ok) {
    if(!pyps_last_error)
      asprintf(&pyps_last_error,
               "capply phase %s failed without setting error message",
               phasename);
    THROW(user_exception_error);
  }
}

References asprintf, gen_array_append(), gen_array_free(), gen_array_make(), ok, pyps_last_error, safe_concurrent_apply(), THROW, and user_exception_error.

Here is the call graph for this function:

close_log_buffer()

void close_log_buffer

(

void

)

Definition at line 137 of file pypips.c.

{
  if (!list_undefined_p(log_list))
  {
    gen_free_string_list(log_list);
    log_list = list_undefined;
  }
}

References gen_free_string_list(), list_undefined, list_undefined_p, and log_list.

Referenced by open_log_buffer().

Here is the call graph for this function:

Here is the caller graph for this function:

create()

void create	(	char *	workspace_name,
		char **	filenames
	)

create a new workspace...

FC: what about opening an existing one?

Definition at line 239 of file pypips.c.

{
  if (workspace_exists_p(workspace_name))
    pips_user_error("Workspace %s already exists. Delete it!\n",
                    workspace_name);
  else if (db_get_current_workspace_name()) {
    pips_user_error("Close current workspace %s before "
                    "creating another one!\n",
                    db_get_current_workspace_name());
  }
  else
  {
    if (db_create_workspace(workspace_name))
    {
      // create the array of arguments
      gen_array_t filename_list = gen_array_make(0);
      while(*filenames)
      {
        gen_array_append(filename_list,*filenames);
        filenames++;
      }
 
      bool success = create_workspace(filename_list);
 
      gen_array_free(filename_list);
 
      if (!success)
      {
        db_close_workspace(false);
        pips_user_error("Could not create workspace %s\n", workspace_name);
      }
    }
    else {
      pips_user_error("Cannot create directory for workspace, "
                      "check rights!\n");
    }
  }
}

References create_workspace(), db_close_workspace(), db_create_workspace(), db_get_current_workspace_name(), gen_array_append(), gen_array_free(), gen_array_make(), pips_user_error, and workspace_exists_p().

Here is the call graph for this function:

DEFINE_LOCAL_STACK()

DEFINE_LOCAL_STACK	(	properties	,
		property
	)

stack of properties, so that the previous value can be reinstated when going out of a phase.

display()

void display	(	char *	rname,
		char *	mname
	)

display resource rname about module mname

Definition at line 358 of file pypips.c.

{
  string old_current_module_name = db_get_current_module_name();
  if(old_current_module_name) {
    old_current_module_name = strdup(old_current_module_name);
    db_reset_current_module_name();
  }
 
  db_set_current_module_name(mname);
  string fname = build_view_file(rname);
  db_reset_current_module_name();
  if(old_current_module_name) {
    db_set_current_module_name(old_current_module_name);
    free(old_current_module_name);
  }
 
  if (!fname)
  {
    pips_user_error("Cannot build view file %s\n", rname);
    return;
  }
 
  safe_display(fname);
  free(fname);
  return;
}

References build_view_file(), db_get_current_module_name(), db_reset_current_module_name(), db_set_current_module_name(), free(), pips_user_error, safe_display(), and strdup().

Here is the call graph for this function:

find_loop_from_label()

statement find_loop_from_label	(	statement	s,
		entity	label
	)

hmmm...

when all header files are not yet generated cproto may silently fail to generate these headers. this few declarations allow to generate headers without anything else. ri needed for statement_mapping in pipsdbm...

Parameters

label

abel

Definition at line 218 of file util.c.

{
  struct flfl ctx = { label, statement_undefined };
  gen_context_recurse(s, &ctx,
                      loop_domain, find_loop_from_label_walker, gen_null2);
  return ctx.found;
}

Referenced by get_loop_execution_parallel(), and set_loop_execution_parallel().

Here is the caller graph for this function:

get_callees_of()

char* get_callees_of

(

char *

module_name

)

Returns the list of the modules called by that specific module, separated by ' '.

Definition at line 420 of file pypips.c.

{
  safe_make("CALLERS",module_name);
  gen_array_t callees = get_callees(module_name);
 
  char * callees_string = strdup(string_array_join(callees, " "));
 
  gen_array_free(callees);
 
  return callees_string;
}

References gen_array_free(), get_callees(), module_name(), safe_make(), strdup(), and string_array_join().

Here is the call graph for this function:

get_callers_of()

char* get_callers_of

(

char *

module_name

)

Returns the list of the modules that call that specific module, separated by ' '.

Definition at line 408 of file pypips.c.

{
  safe_make("CALLERS", module_name);
  gen_array_t callers = get_callers(module_name);
  char * callers_string = strdup(string_array_join(callers, " "));
  gen_array_free(callers);
  return callers_string;
}

References gen_array_free(), get_callers(), module_name(), safe_make(), strdup(), and string_array_join().

Here is the call graph for this function:

get_log_buffer()

char* get_log_buffer

(

void

)

Definition at line 153 of file pypips.c.

{
  assert(!list_undefined_p(log_list));
  list log_list_tmp=gen_copy_seq(log_list);
  log_list_tmp = gen_nreverse(log_list_tmp);
  char* ret = words_to_string(log_list_tmp);
  gen_free_list(log_list_tmp);
  return ret;
}

References assert, gen_copy_seq(), gen_free_list(), gen_nreverse(), list_undefined_p, log_list, ret, and words_to_string().

Here is the call graph for this function:

get_loop_execution_parallel()

bool get_loop_execution_parallel	(	const char *	module_name,
		const char *	loop_label
	)

Read execution mode for a loop.

Definition at line 561 of file pypips.c.

{
  // prelude
  set_current_module_entity(module_name_to_entity( module_name ));
  set_current_module_statement
    ((statement) db_get_memory_resource(DBR_CODE, module_name, true) );
 
  entity label = find_label_entity(module_name,loop_label);
  if(entity_undefined_p(label))
    pips_user_error("label '%s' does not exist\n",loop_label);
  statement stmt = find_loop_from_label(get_current_module_statement(),label);
  if(statement_undefined_p(stmt))
    pips_user_error("label '%s' is not on a loop\n",loop_label);
  bool is_exec_parallel_p =
    execution_parallel_p(loop_execution(statement_loop(stmt)));
 
  // reset current state
  reset_current_module_entity();
  reset_current_module_statement();
  return is_exec_parallel_p;
}

References db_get_memory_resource(), entity_undefined_p, execution_parallel_p, find_label_entity(), find_loop_from_label(), get_current_module_statement(), loop_execution, loop_label, module_name(), module_name_to_entity(), pips_user_error, reset_current_module_entity(), reset_current_module_statement(), set_current_module_entity(), set_current_module_statement(), statement_loop(), and statement_undefined_p.

Here is the call graph for this function:

get_module_language()

char* get_module_language

(

string

mod_name

)

Definition at line 487 of file pypips.c.

{
  language l = module_language(module_name_to_entity(mod_name));
 
  switch(language_tag(l)) {
    case is_language_fortran: return "fortran";
    case is_language_fortran95: return "fortran95";
    case is_language_c: return "c";
    default: return "unknown";
  }
}

References is_language_c, is_language_fortran, is_language_fortran95, language_tag, module_language, and module_name_to_entity().

Here is the call graph for this function:

get_stub_from_broker()

static string get_stub_from_broker ( string  str )

static

Definition at line 514 of file pypips.c.

{
  string result = NULL;
 
  // Assert that a broker is defined !
  if (stub_broker) {
 
    // Get the stub file (implemented in a python method...)
    PyObject *pyStubFile =
      PyEval_CallMethod(stub_broker, "stub_file_for_module", "(s)", str);
 
    // Sanity check
    if(pyStubFile) {
      // Convert to a regular C string
#if PY_MAJOR_VERSION >= 3
      result = strdup(PyUnicode_AsUTF8(pyStubFile));
#else // PYTHON 2
      result = strdup(PyString_AsString(pyStubFile));
#endif
      Py_XDECREF(pyStubFile);
    } else {
      // NULL is returned, error managed by the caller
      fprintf(stderr,"Callback failed !\n");
      PyErr_Print();
    }
  }
  // else NULL...
 
  return result;
}

References fprintf(), strdup(), and stub_broker.

Referenced by set_python_missing_module_resolver_handler().

Here is the call graph for this function:

Here is the caller graph for this function:

getenviron()

char* getenviron

(

char *

name

)

get environment variable

Definition at line 452 of file pypips.c.

{
  return getenv(name);
}

info()

char* info

(

char *

about

)

Definition at line 278 of file pypips.c.

{
  string sinfo = NULL;
  if (same_string_p(about, "workspace"))
  {
    sinfo = db_get_current_workspace_name();
    if (sinfo) sinfo = strdup(sinfo);
  }
  else if (same_string_p(about, "module"))
  {
        sinfo = db_get_current_module_name();
        if(sinfo) sinfo=strdup(sinfo);
  }
  else if (same_string_p(about, "modules") && db_get_current_workspace_name())
  {
    gen_array_t modules = db_get_module_list();
    int n = gen_array_nitems(modules), i;
 
    size_t sinfo_size=0;
    for(i=0; i<n; i++)
    {
      string m = gen_array_item(modules, i);
      sinfo_size+=strlen(m)+1;
    }
    sinfo = strdup(string_array_join(modules, " "));
    if(!sinfo)
      fprintf(stderr,"not enough memory to hold all module names\n");
    gen_array_full_free(modules);
  }
  else if (same_string_p(about, "directory"))
  {
    char pathname[MAXPATHLEN];
    sinfo = getcwd(pathname, MAXPATHLEN);
    if(sinfo)
      sinfo=strdup(sinfo);
    else
      fprintf(stderr,"failer to retreive current working directory\n");
  }
 
  if (!sinfo)
    sinfo = strdup("");
  return sinfo;
}

References db_get_current_module_name(), db_get_current_workspace_name(), db_get_module_list(), fprintf(), gen_array_full_free(), gen_array_item(), gen_array_nitems(), MAXPATHLEN, same_string_p, strdup(), and string_array_join().

Referenced by constraints_sort_info(), constraints_sort_with_compare(), sc_build_triang_elim_redund(), and sc_triang_elim_redund().

Here is the call graph for this function:

Here is the caller graph for this function:

open_log_buffer()

void open_log_buffer

(

void

)

Definition at line 146 of file pypips.c.

{
  if (!list_undefined_p(log_list))
    close_log_buffer();
  log_list = NIL;
}

References close_log_buffer(), list_undefined_p, log_list, and NIL.

Here is the call graph for this function:

pop_property()

void pop_property

(

const char *

name

)

Definition at line 209 of file pypips.c.

{
  property p = properties_pop();
  if(property_bool_p(p))
    set_bool_property(name,property_bool(p));
  else if(property_string_p(p))
    set_string_property(name,property_string(p));
  else
    set_int_property(name,property_int(p));
}

References property_bool, property_bool_p, property_int, property_string, property_string_p, set_bool_property(), set_int_property(), and set_string_property().

Here is the call graph for this function:

push_property()

void push_property	(	const char *	name,
		const char *	value
	)

Definition at line 202 of file pypips.c.

{
  property p = copy_property(get_property(name,false));
  set_property(strdup(name),value);
  properties_push(p);
}

References copy_property(), get_property(), set_property(), and strdup().

Here is the call graph for this function:

pyps_error_handler()

static void pyps_error_handler ( const char *  calling_function_name, const char *  a_message_format, va_list *  args  )

static

Definition at line 111 of file pypips.c.

{
  // Save pre-existing error message
  char *old_error = pyps_last_error;
 
  char * tmp;
  va_list acpy;
  va_copy(acpy, *args);
  vasprintf(&tmp, a_message_format, acpy);
  va_end(acpy);
 
  asprintf(&pyps_last_error,"in %s: %s",calling_function_name,tmp);
  free(tmp);
 
  // If we already had a message before, we stack it over the new one
  if(old_error) {
    char *tmp = pyps_last_error;
    asprintf(&pyps_last_error,"%s%s",old_error,tmp);
    free(old_error);
    free(tmp);
  }
}

References asprintf, free(), pyps_last_error, and vasprintf().

Referenced by atinit().

Here is the call graph for this function:

Here is the caller graph for this function:

pyps_get_stubs()

char* pyps_get_stubs

(

void

)

Returns the list of the modules called by that specific module, separated by ' '.

Definition at line 435 of file pypips.c.

{
  gen_array_t stubs = get_stubs();
  char * stubs_string = strdup(string_array_join(stubs, " "));
  gen_array_free(stubs);
  return stubs_string;
}

References gen_array_free(), get_stubs(), strdup(), and string_array_join().

Here is the call graph for this function:

pyps_log_handler()

static void pyps_log_handler ( const char *  fmt, va_list *  args  )

static

Definition at line 85 of file pypips.c.

{
  va_list args_copy;
 
  // avoid a repeat as pips_log_display called by pips_log_alist
  // already sent it to stderr
  if (logstream != stderr)
  {
    va_copy (args_copy, *args);
    vfprintf(logstream, fmt, args_copy);
    va_end(args_copy);
    fflush(logstream);
  }
 
  if (!list_undefined_p(log_list))
  {
    char* tmp;
    va_copy (args_copy, *args);
    vasprintf(&tmp, fmt, args_copy);
    va_end(args_copy);
    log_list = CONS(STRING,tmp,log_list);
  }
}

References CONS, list_undefined_p, log_list, logstream, STRING, and vasprintf().

Referenced by atinit().

Here is the call graph for this function:

Here is the caller graph for this function:

set_loop_execution_parallel()

void set_loop_execution_parallel	(	const char *	module_name,
		const char *	loop_label,
		bool	exec_parallel_p
	)

Change execution mode for a loop.

Definition at line 586 of file pypips.c.

{
  // prelude
  set_current_module_entity(module_name_to_entity( module_name ));
  set_current_module_statement
    ((statement) db_get_memory_resource(DBR_CODE, module_name, true) );
 
  entity label = find_label_entity(module_name,loop_label);
  if(entity_undefined_p(label))
    pips_user_error("label '%s' does not exist\n",loop_label);
  statement stmt = find_loop_from_label(get_current_module_statement(),label);
  if(statement_undefined_p(stmt))
    pips_user_error("label '%s' is not on a loop\n",loop_label);
  execution_tag(loop_execution(statement_loop(stmt)))
      = (exec_parallel_p ? is_execution_parallel : is_execution_sequential);
 
  // Store the new code
  DB_PUT_MEMORY_RESOURCE(DBR_CODE, module_name, get_current_module_statement());
 
  // reset current state
  reset_current_module_entity();
  reset_current_module_statement();
}

References db_get_memory_resource(), DB_PUT_MEMORY_RESOURCE, entity_undefined_p, execution_tag, find_label_entity(), find_loop_from_label(), get_current_module_statement(), is_execution_parallel, is_execution_sequential, loop_execution, loop_label, module_name(), module_name_to_entity(), pips_user_error, reset_current_module_entity(), reset_current_module_statement(), set_current_module_entity(), set_current_module_statement(), statement_loop(), and statement_undefined_p.

Here is the call graph for this function:

set_property()

void set_property	(	const char *	propname,
		const char *	value
	)

Definition at line 176 of file pypips.c.

{
  // thank's to rk, this hack is no longer needed
#if 0
  /* nice hack to temporarly redirect stderr */
  int saved_stderr = dup(STDERR_FILENO);
  char *buf;
  freopen("/dev/null","w",stderr);
  asprintf(&buf, "/dev/fd/%d", saved_stderr);
#endif
  if (!safe_set_property(propname, value)) {
#if 0
    freopen(buf,"w",stderr);
    free(buf);
#endif
    pips_user_error("error in setting property %s to %s\n",
                    propname, value);
  }
#if 0
  else {
    freopen(buf,"w",stderr);
    free(buf);
  }
#endif
}

References asprintf, buf, free(), pips_user_error, safe_set_property(), and STDERR_FILENO.

Referenced by push_property().

Here is the call graph for this function:

Here is the caller graph for this function:

set_python_missing_module_resolver_handler()

void set_python_missing_module_resolver_handler

(

PyObject *

PyObj

)

Dispose of previous callback

Remember new callback

Record of new callback

Definition at line 550 of file pypips.c.

{
  Py_XDECREF(stub_broker);          /* Dispose of previous callback */
  stub_broker = PyObj;         /* Remember new callback */
  Py_XINCREF(stub_broker);          /* Record of new callback */
 
  void set_internal_missing_module_resolver_handler(string (*)(string));
  set_internal_missing_module_resolver_handler(get_stub_from_broker);
}

References get_stub_from_broker(), set_internal_missing_module_resolver_handler(), and stub_broker.

Here is the call graph for this function:

setenviron()

void setenviron	(	char *	name,
		char *	value
	)

add an environment variable of a given value

Definition at line 445 of file pypips.c.

{
  setenv(name, value, 1);
}

show()

char* show	(	char *	rname,
		char *	mname
	)

return the rname[mname] resource, which must be a string containing a file name

Definition at line 388 of file pypips.c.

{
  if (!db_resource_p(rname, mname)) {
    pips_user_warning("no resource %s[%s].\n", rname, mname);
    return  strdup("");
  }
 
  // ensure that it is a filename, hence a string
  if (!displayable_file_p(rname)) {
    pips_user_warning("resource %s cannot be displayed.\n", rname);
    return strdup("");
  }
 
  // now returns the name of the file.
  return strdup(db_get_memory_resource(rname, mname, true));
}

References db_get_memory_resource(), db_resource_p(), displayable_file_p(), pips_user_warning, and strdup().

Here is the call graph for this function:

verbose()

void verbose

(

bool

on

)

Definition at line 163 of file pypips.c.

{
  if(on) logstream = stderr;
  else logstream = fopen("/dev/null","w");
}

References logstream.

Variable Documentation

log_list

list log_list = list_undefined

static

Definition at line 83 of file pypips.c.

Referenced by close_log_buffer(), get_log_buffer(), open_log_buffer(), and pyps_log_handler().

logstream

FILE* logstream = NULL

static

Definition at line 82 of file pypips.c.

Referenced by pyps_log_handler(), and verbose().

pyps_last_error

char* pyps_last_error = NULL

Definition at line 109 of file pypips.c.

Referenced by apply(), capply(), and pyps_error_handler().

stub_broker

PyObject* stub_broker = NULL

static

Definition at line 506 of file pypips.c.

Referenced by get_stub_from_broker(), and set_python_missing_module_resolver_handler().