/*

  $Id$

  Copyright 1989-2016 MINES ParisTech

  This file is part of PIPS.

  PIPS is free software: you can redistribute it and/or modify it
  under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  any later version.

  PIPS is distributed in the hope that it will be useful, but WITHOUT ANY
  WARRANTY; without even the implied warranty of MERCHANTABILITY or
  FITNESS FOR A PARTICULAR PURPOSE.

  See the GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with PIPS.  If not, see <http://www.gnu.org/licenses/>.

 */
#ifdef HAVE_CONFIG_H
#include "pips_config.h"
#endif
/* package generic effects :  Be'atrice Creusillet 5/97
 *
 * File: mappings.c
 * ~~~~~~~~~~~~~~~~~
 *
 * This File contains the mappings necessary for the computation of effects.
 *
 */
#include <stdlib.h>
#include "genC.h"
#include "linear.h"
#include "ri.h"
#include "misc.h"
#include "effects.h"
#include "effects-generic.h"

/* REFERENCES */
GENERIC_GLOBAL_FUNCTION(proper_references, statement_effects)
GENERIC_GLOBAL_FUNCTION(cumulated_references, statement_effects)

/* READ AND WRITE EFFECTS */
GENERIC_GLOBAL_FUNCTION(proper_rw_pointer_effects, statement_effects)
GENERIC_GLOBAL_FUNCTION(proper_rw_effects, statement_effects)
GENERIC_GLOBAL_FUNCTION(rw_pointer_effects, statement_effects)
GENERIC_GLOBAL_FUNCTION(invariant_rw_pointer_effects, statement_effects)
GENERIC_GLOBAL_FUNCTION(rw_effects, statement_effects)
GENERIC_GLOBAL_FUNCTION(invariant_rw_effects, statement_effects)
/* for external use - identical to rw_effects */
GENERIC_GLOBAL_FUNCTION(cumulated_rw_effects, statement_effects)

/* PROPER RW EFFECTS associated to expressions
 */
GENERIC_GLOBAL_FUNCTION(expr_prw_effects, persistant_expression_to_effects)


/* IN AND OUT EFFECTS */
GENERIC_GLOBAL_FUNCTION(in_effects, statement_effects)
GENERIC_GLOBAL_FUNCTION(cumulated_in_effects, statement_effects)
GENERIC_GLOBAL_FUNCTION(invariant_in_effects, statement_effects)

GENERIC_GLOBAL_FUNCTION(out_effects, statement_effects)

/* LIVE IN AND LIVE OUT PATHS */
GENERIC_GLOBAL_FUNCTION(live_in_paths, statement_effects)
GENERIC_GLOBAL_FUNCTION(live_out_paths, statement_effects)
GENERIC_GLOBAL_FUNCTION(live_out_regions, statement_effects)

/* USEFULL VARIABLES EFFECTS */
GENERIC_GLOBAL_FUNCTION(useful_variables_effects, entity_effects)


/* APIs to get lists of effects instead of RI's effects */

list
load_proper_rw_pointer_effects_list(statement s)
{
  effects e = load_proper_rw_pointer_effects(s);
  ifdebug(8) pips_assert("proper rw pointer effects loaded are consistent", effects_consistent_p(e));
  return(effects_effects(e));
}

void store_proper_rw_pointer_effects_list(statement s, list l_eff)
{
  effects e = make_effects(l_eff);
  ifdebug(8) pips_assert("proper rw pointer effects to store are consistent", effects_consistent_p(e));
  store_proper_rw_pointer_effects(s, e);
}

void update_proper_rw_pointer_effects_list(statement s, list l_eff)
{
  effects e = make_effects(l_eff);
  ifdebug(8) pips_assert("proper rw pointer effects to update are consistent", effects_consistent_p(e));
  update_proper_rw_pointer_effects(s, e);
}

list 
load_proper_rw_effects_list(statement s)
{
  effects e = load_proper_rw_effects(s);
  ifdebug(8) pips_assert("proper rw effects loaded are consistent", effects_consistent_p(e));
  return(effects_effects(e));
}

void store_proper_rw_effects_list(statement s, list l_eff)
{
  effects e = make_effects(l_eff);
  ifdebug(8) pips_assert("proper rw effects to store are consistent", effects_consistent_p(e));
  store_proper_rw_effects(s, e);
}

void update_proper_rw_effects_list(statement s, list l_eff)
{
  effects e = make_effects(l_eff);
  ifdebug(8) pips_assert("proper rw effects to update are consistent", effects_consistent_p(e));
  update_proper_rw_effects(s, e);
}


list 
load_rw_pointer_effects_list(statement s)
{
  effects e = load_rw_pointer_effects(s);
  ifdebug(8) pips_assert("rw pointer effects loaded are consistent", effects_consistent_p(e));
  return(effects_effects(e));
}

void
store_rw_pointer_effects_list(statement s, list l_eff)
{
  effects e = make_effects(l_eff);
  ifdebug(8) pips_assert("rw pointer effects to store are consistent", effects_consistent_p(e));
  store_rw_pointer_effects(s, e);
}

void
update_rw_pointer_effects_list(statement s, list l_eff)
{
  effects e = make_effects(l_eff);
  ifdebug(8) pips_assert("rw pointer effects to update are consistent", effects_consistent_p(e));
  update_rw_pointer_effects(s, e);
}

list 
load_rw_effects_list(statement s)
{
  effects e = load_rw_effects(s);
  ifdebug(8) pips_assert("rw effects loaded are consistent", effects_consistent_p(e));
  return(effects_effects(e));
}

void
store_rw_effects_list(statement s, list l_eff)
{
  effects e = make_effects(l_eff);
  ifdebug(8) pips_assert("rw effects to store are consistent", effects_consistent_p(e));
  store_rw_effects(s, e);
}

void
update_rw_effects_list(statement s, list l_eff)
{
  effects e = make_effects(l_eff);
  ifdebug(8) pips_assert("rw effects to update are consistent", effects_consistent_p(e));
  update_rw_effects(s, e);
}

list 
load_invariant_rw_pointer_effects_list(statement s)
{
  effects e = load_invariant_rw_pointer_effects(s);
  ifdebug(8) pips_assert("invariant rw pointer effects loaded are consistent", effects_consistent_p(e));
  return(effects_effects(e));
}

void
store_invariant_rw_pointer_effects_list(statement s, list l_eff)
{
  effects e = make_effects(l_eff);
  ifdebug(8) pips_assert("invariant rw pointer effects to store are consistent", effects_consistent_p(e));
  store_invariant_rw_pointer_effects(s, make_effects(l_eff));
}

void
update_invariant_rw_pointer_effects_list(statement s, list l_eff)
{
  effects e = make_effects(l_eff);
  ifdebug(8) pips_assert("invariant rw pointer effects to update are consistent", effects_consistent_p(e));
  update_invariant_rw_pointer_effects(s, e);
}

list 
load_invariant_rw_effects_list(statement s)
{
  effects e = load_invariant_rw_effects(s);
  ifdebug(8) pips_assert("invariant rw effects loaded are consistent", effects_consistent_p(e));
  return(effects_effects(e));
}

void
store_invariant_rw_effects_list(statement s, list l_eff)
{
  effects e = make_effects(l_eff);
  ifdebug(8) pips_assert("invariant rw effects to store are consistent", effects_consistent_p(e));
  store_invariant_rw_effects(s, make_effects(l_eff));
}

void
update_invariant_rw_effects_list(statement s, list l_eff)
{
  effects e = make_effects(l_eff);
  ifdebug(8) pips_assert("invariant rw effects to update are consistent", effects_consistent_p(e));
  update_invariant_rw_effects(s, e);
}

list 
load_cumulated_rw_effects_list(statement s)
{
  effects e = load_cumulated_rw_effects(s);
  ifdebug(8) pips_assert("cumulated rw effects loaded are consistent", effects_consistent_p(e));
  return(effects_effects(e));
}

void
store_cumulated_rw_effects_list(statement s, list l_eff)
{
  effects e = make_effects(l_eff);
  ifdebug(8) pips_assert("cumulated rw effects to store are consistent", effects_consistent_p(e));
  store_cumulated_rw_effects(s, e);
}

void
update_cumulated_rw_effects_list(statement s, list l_eff)
{
  effects e = make_effects(l_eff);
  ifdebug(8) pips_assert("cumulated rw effects to update are consistent", effects_consistent_p(e));
  update_cumulated_rw_effects(s, e);
}


/* IN AND OUT EFFECTS */

list 
load_in_effects_list(statement s)
{
  return(effects_effects(load_in_effects(s)));
}

void
store_in_effects_list(statement s, list l_eff)
{
  (*effects_descriptor_normalize_func)(l_eff);
  store_in_effects(s, make_effects(l_eff));
}

void
update_in_effects_list(statement s, list l_eff)
{
  update_in_effects(s, make_effects(l_eff));
}


list 
load_cumulated_in_effects_list(statement s)
{
  return(effects_effects(load_cumulated_in_effects(s)));
}

void
store_cumulated_in_effects_list(statement s, list l_eff)
{
  store_cumulated_in_effects(s, make_effects(l_eff));
}

void
update_cummulated_in_effects_list(statement s, list l_eff)
{
  update_cumulated_in_effects(s, make_effects(l_eff));
}

list 
load_invariant_in_effects_list(statement s)
{
  return(effects_effects(load_invariant_in_effects(s)));
}

void
store_invariant_in_effects_list(statement s, list l_eff)
{
  store_invariant_in_effects(s, make_effects(l_eff));
}

void
update_invariant_in_effects_list(statement s, list l_eff)
{
  update_invariant_in_effects(s, make_effects(l_eff));
}


list 
load_out_effects_list(statement s)
{
  return(effects_effects(load_out_effects(s)));
}

void
store_out_effects_list(statement s, list l_eff)
{
  (*effects_descriptor_normalize_func)(l_eff);
  store_out_effects(s, make_effects(l_eff));
}

void
update_out_effects_list(statement s, list l_eff)
{
  update_out_effects(s, make_effects(l_eff));
}

list
load_live_in_paths_list(statement s)
{
  return(effects_effects(load_live_in_paths(s)));
}

void
store_live_in_paths_list(statement s, list l_paths)
{
  store_live_in_paths(s, make_effects(l_paths));
}

void
update_live_in_paths_list(statement s, list l_paths)
{
  update_live_out_paths(s, make_effects(l_paths));
}

list
load_live_out_paths_list(statement s)
{
  return(effects_effects(load_live_out_paths(s)));
}

void
store_live_out_paths_list(statement s, list l_paths)
{
  store_live_out_paths(s, make_effects(l_paths));
}

void
update_live_out_paths_list(statement s, list l_paths)
{
  update_live_out_paths(s, make_effects(l_paths));
}

list
load_live_out_regions_list(statement s)
{
  return(effects_effects(load_live_out_regions(s)));
}

void
store_live_out_regions_list(statement s, list l)
{
  store_live_out_regions(s, make_effects(l));
}

void
update_live_out_regions_list(statement s, list l)
{
  update_live_out_regions(s, make_effects(l));
}




/* BACKWARD COMPATIBILITY */

list load_statement_local_regions(statement s)
{
  return(load_rw_effects_list(s));
}
void store_statement_local_regions(statement s, list t)
{
  store_rw_effects_list(s, t);
}
void update_statement_local_regions(statement s, list t)
{
  update_rw_effects_list(s, t);
}

list load_statement_inv_regions(statement s)
{
  return(load_invariant_rw_effects_list(s));
}
void store_statement_inv_regions(statement s, list t)
{
  store_invariant_rw_effects_list(s, t);
}
void update_statement_inv_regions(statement s, list t)
{
  update_invariant_rw_effects_list(s, t);
}

list load_statement_proper_regions(statement s)
{
  return(load_proper_rw_effects_list(s));
}
void store_statement_proper_regions(statement s, list t)
{
  store_proper_rw_effects_list(s, t);
}


list load_statement_in_regions(statement s)
{
  return(load_in_effects_list(s));
}
void store_statement_in_regions(statement s, list t)
{
  store_in_effects_list(s, t);
}

list load_statement_inv_in_regions(statement s)
{
  return(load_invariant_in_effects_list(s));
}
void store_statement_inv_in_regions(statement s, list t)
{
  store_invariant_in_effects_list(s, t);
}

void update_statement_inv_in_regions(statement s, list t)
{
  update_invariant_in_effects_list(s, t);
}

list load_statement_cumulated_in_regions(statement s)
{
  return(load_cumulated_in_effects_list(s));
}
void store_statement_cumulated_in_regions(statement s, list t)
{
  store_cumulated_in_effects_list(s, t);
}

list load_statement_out_regions(statement s)
{
  return(load_out_effects_list(s));
}
void store_statement_out_regions(statement s, list t)
{
  store_out_effects_list(s, t);
}