/*

  $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/>.

*/
/*
 * HPFC module by Fabien COELHO
 */

/* Most includes are centralized here.
 */

/*  standard C includes
 */
#include <stdio.h>
#include <stdlib.h>
#include <limits.h>
#include <float.h>
#include <ctype.h>
#include <string.h>

/*  C3/LINEAR
 */
#include "linear.h"

/*  NEWGEN
 */
#include "genC.h"
#include "text.h"
#include "ri.h"
#include "effects.h"
#include "database.h"
#include "hpf.h"
#include "hpf_private.h"
#include "reductions_private.h"
#include "message.h"
#include "properties.h"

/*  PIPS
 */
#include "misc.h"
#include "text-util.h"
#include "ri-util.h"
#include "effects-util.h"
#include "hpfc.h"

#include "prettyprint.h" // print_statement

/* in paf-util.h:
 */
list base_to_list(Pbase base);
void fprint_entity_list(FILE *fp, list l);

#define PVECTOR(v) CHUNK(v)
#define VECTOR gen_chunk*
#define PVECTOR_NEWGEN_DOMAIN (-1)
#define gen_PVECTOR_cons gen_cons

/* ??? very beurk!
 */
#define DELTAV        ((Variable) 12)
#define TEMPLATEV     ((Variable) 13)
#define TSHIFTV       ((Variable) 14)

/* Newgen short sentences
 */
#define function_mapping(f) (((f)+1)->h)

/* list of variables...
 */
#define add_to_list_of_vars(l, fun, n)\
  l = gen_nconc(make_list_of_dummy_variables((entity(*)())fun, n), l);

#define one_statement_unstructured(u) \
    ((control_predecessors(unstructured_control(u)) == NIL) && \
     (control_successors(unstructured_control(u)) == NIL))

#define entity_functional(e) (type_functional(entity_type(e)))

#define update_functional_as_model(e, model) \
    free_functional(entity_functional(e)), \
    entity_functional(e) = copy_functional(entity_functional(model));

#define min(a,b) (((a)<(b))?(a):(b))
#define max(a,b) (((a)>(b))?(a):(b))

/* integer ceiling function */
#define iceil(a,b) ((((a)-1)/(b))+1)

#ifndef bool_undefined
#define bool_undefined ((bool) (-15))
#define bool_undefined_p(b) ((b)==bool_undefined)
#endif

#ifndef int_undefined
#define int_undefined ((int) (-15))
#define int_undefined_p(i) ((i)==int_undefined)
#endif

/* file names to be generated
 */
#define GLOBAL_PARAMETERS_H "global_parameters.h"
#define GLOBAL_INIT_H       "global_init.h"

/* Constants
 */
#define HOST_NAME "HOST"
#define NODE_NAME "NODE"

/* Overlap
 */
#define UPPER "UP"
#define LOWER "LO"

#define SEND	1
#define RECEIVE 0

/* debug macro
 */
#define GEN_DEBUG(D, W, P) ifdebug(D) { pips_debug(D, "%s:\n", W); P;}

#define DEBUG_MTRX(D, W, M) GEN_DEBUG(D, W, matrix_fprint(stderr, M))
#define DEBUG_STAT(D, W, S) GEN_DEBUG(D, W, print_statement(S))
#define DEBUG_CODE(D, W, M, S) GEN_DEBUG(D, W, hpfc_print_code(stderr, M, S))
#define DEBUG_SYST(D, W, S) GEN_DEBUG(D, W, sc_syst_debug(S))
#define DEBUG_ELST(D, W, L)\
   GEN_DEBUG(D, W, fprint_entity_list(stderr, L); fprintf(stderr, "\n"))
#define DEBUG_BASE(D, W, B)\
   GEN_DEBUG(D, W, base_fprint(stderr, B, (string(*)(Variable))entity_local_name);\
	           fprintf(stderr, "\n"))

#define what_stat_debug(level, stat)\
 ifdebug(level) \
 { intptr_t so_ = statement_ordering(stat);\
   pips_debug(level, "statement %p (%"PRIdPTR",%"PRIdPTR":%"PRIdPTR")\n",\
   stat, ORDERING_NUMBER(so_), ORDERING_STATEMENT(so_), \
   statement_number(stat));}

/* Efficient I/O tags
 */
#define is_movement_collect 0
#define is_movement_update 1
#define movement_collect_p(t) ((t)==(is_movement_collect))
#define movement_update_p(t) ((t)==(is_movement_update))

/* Run-time support functions and subroutine names
 */
#define SND_TO_C        "HPFC SNDTO C"
#define SND_TO_H        "HPFC SNDTO H"
#define SND_TO_A        "HPFC SNDTO A"
#define SND_TO_A_BY_H   "HPFC HSNDTO A"
#define SND_TO_O        "HPFC SNDTO O"
#define SND_TO_OS       "HPFC SNDTO OS"
#define SND_TO_OOS      "HPFC SNDTO OOS"
/*#define SND_TO_HA       "HPFC SNDTO HA"*/
#define SND_TO_HA       "HPFC NSNDTO HA"
#define SND_TO_NO       "HPFC SNDTO NO"
#define SND_TO_HNO      "HPFC SNDTO HNO"

#define RCV_FR_S        "HPFC RCVFR S"
#define RCV_FR_H        "HPFC RCVFR H"
#define RCV_FR_C        "HPFC RCVFR C"
/*#define RCV_FR_mCS      "HPFC RCVFR mCS"*/
#define RCV_FR_mCS      "HPFC RCVFR HNBCAST S"
#define RCV_FR_mCH      "HPFC RCVFR mCH"

#define CMP_COMPUTER    "HPFC CMPCOMPUTER"
#define CMP_OWNERS      "HPFC CMPOWNERS"
#define CMP_NEIGHBOUR   "HPFC CMPNEIGHBOUR"
#define CMP_LID		"HPFC CMPLID"

#define TWIN_P		"HPFC TWIN P"

#define CND_SENDERP     "HPFC SENDERP"
#define CND_OWNERP      "HPFC OWNERP"
#define CND_COMPUTERP   "HPFC COMPUTERP"
#define CND_COMPINOWNP  "HPFC COMPUTERINOWNERSP"

#define LOCAL_IND       "HPFC LOCALIND"
#define LOCAL_IND_GAMMA "HPFC LOCALINDGAMMA"
#define LOCAL_IND_DELTA "HPFC LOCALINDDELTA"

#define INIT_NODE       "HPFC INIT NODE"
#define INIT_HOST       "HPFC INIT HOST"
#define NODE_END        "HPFC NODE END"
#define HOST_END        "HPFC HOST END"

#define HPFC_STOP	"HPFC STOP"

#define LOOP_BOUNDS     "HPFC LOOP BOUNDS"
#define SYNCHRO		"HPFC SYNCHRO"
#define IDIVIDE		"HPFC DIVIDE"

#define SND_TO_N        "HPFC SNDTO N"
#define RCV_FR_N        "HPFC RCVFR N"

/* hpfc packing and unpacking
 */
#define BUFPCK		" BUFPCK"
#define BUFUPK		" BUFUPK"

#define BROADCAST	"HPFC BROADCAST "
#define GUARDED_BRD	"HPFC REMAPBRD "

/* host/node communications
 */
#define HPFC_HCAST	"HPFC HCAST"
#define HPFC_NCAST	"HPFC NCAST"
#define HPFC_sN2H	"HPFC SND TO HOST"
#define HPFC_sH2N	"HPFC SND TO NODE"
#define HPFC_rH2N	"HPFC RCV FROM HOST"
#define HPFC_rN2H	"HPFC RCV FROM NODE"

/* special FCD calls.
 */
#define HOST_TIMEON	"HPFC HTIMEON"
#define NODE_TIMEON	"HPFC NTIMEON"
#define HOST_TIMEOFF	"HPFC HTIMEOFF"
#define NODE_TIMEOFF	"HPFC NTIMEOFF"
#define HPFC_HTELL	"HPFC HTELL"
#define HPFC_NTELL	"HPFC NTELL"

#define RENAME_SUFFIX	"_rename"

/********************************************************************** PVM */

/* PVM functions that may be called by the generated code
 */
#define PVM_INITSEND	"pvmfinitsend"
#define PVM_SEND	"pvmfsend"
#define PVM_CAST	"pvmfmcast"
#define PVM_RECV	"pvmfrecv"
#define PVM_PACK	"pvmfpack"
#define PVM_UNPACK	"pvmfunpack"

/* PVM types encoding for packing and unpacking
 */
#define PVM_BYTE1	"HPFC BYTE1"
#define PVM_INTEGER2	"HPFC INTEGER2"
#define PVM_INTEGER4	"HPFC INTEGER4"
#define PVM_REAL4	"HPFC REAL4"
#define PVM_REAL8	"HPFC REAL8"
#define PVM_COMPLEX8	"HPFC COMPLEX8"
#define PVM_COMPLEX16	"HPFC COMPLEX16"
#define PVM_STRING	"HPFC STRING"

/********************************************************* COMMON VARIABLES */

#define MYPOS		"MY POS"
#define MYLID		"MY LID"
#define MSTATUS		"MSTATUS"  		/* remapping status */
#define LIVEMAPPING	"LIVE MAPPING"
#define NODETIDS	"NODE TIDS"
#define HOST_TID	"HOST TID"
#define NBTASKS		"MAX SIZE OF PROCS"
#define MCASTHOST	"MCAST HOST"
#define SEND_CHANNELS	"SEND CHANNELS"
#define RECV_CHANNELS	"RECV CHANNELS"
#define HOST_SND_CHAN	"HOST SND CHANNEL"
#define HOST_RCV_CHAN	"HOST RCV CHANNEL"

/* common /hpfc_buffers/
 */
#define BUFFER		" BUFF"
#define BUFSZ		" BUFF SIZE"
#define BUFFER_INDEX	"BUF INDEX"
#define BUFFER_SIZE	"SIZE OF BUFFER"
#define BUFFER_RCV_SIZE	"SIZE OF RECEIVED BUFFER"
#define LAZY_SEND	"LAZY SEND"
#define LAZY_RECV	"LAZY RECV"
#define SND_NOT_INIT	"SEND NOT INITIALIZED"
#define RCV_NOT_PRF	"RECEIVED NOT PERFORMED"
#define BUFFER_ENCODING	"BUFFER ENCODING"

/* Variables
 */
#define T_LID		"T LID"
#define T_LIDp		"T LIDp"
#define INFO		"HPFC INFO"
#define BUFID		"HPFC BUFID"

/*************************************************************** PROPERTY */

#define LAZY_MESSAGES		"HPFC_LAZY_MESSAGES"
#define USE_BUFFERS		"HPFC_USE_BUFFERS"

/***************************************************************** MACROS */

/*  Very Short and very local functions
 *    moved to macros, FC 17/05/94
 */
#define set_integer(var, i) \
    make_assign_statement(entity_to_expression(var), int_to_expression(i))

#define set_logical(var, b) \
    make_assign_statement(entity_to_expression(var),\
	 make_call_expression(MakeConstant \
	      (b ? ".TRUE." : ".FALSE.", is_basic_logical), NIL))

#define set_expression(var, e) \
    make_assign_statement(entity_to_expression(var), e)

#define local_index_is_different_p(array, dim) \
  (new_declaration_tag(array, dim)!=is_hpf_newdecl_none)

#define FindArrayDimAlignmentOfArray(array, dim) \
  (FindAlignmentOfDim(align_alignment(load_hpf_alignment(array)), dim))

#define FindTemplateDimAlignmentOfArray(array, dim) \
  (FindAlignmentOfTemplateDim(align_alignment(load_hpf_alignment(array)), dim))

#define array_to_template(array) \
  (align_template(load_hpf_alignment(array)))

#define template_to_processors(template) \
  (distribute_processors(load_hpf_distribution(template)))

#define array_to_processors(array) \
  (template_to_processors(array_to_template(array)))

#define hpfc_name_to_expression(s) \
  (MakeNullaryCall(hpfc_name_to_entity(s)))

#define condition_computerp() \
  hpfc_name_to_expression(CND_COMPUTERP)

#define condition_senderp() \
  hpfc_name_to_expression(CND_SENDERP)

#define condition_ownerp() \
  hpfc_name_to_expression(CND_OWNERP)

#define condition_computer_in_owners() \
  hpfc_name_to_expression(CND_COMPINOWNP)

#define condition_not_computer_in_owners()\
  (MakeUnaryCall(entity_intrinsic(NOT_OPERATOR_NAME), \
		 condition_computer_in_owners()))

#define hpfc_name_to_stmt(s) \
  (hpfc_make_call_statement(hpfc_name_to_entity(s), NIL))

#define st_init_host() hpfc_name_to_stmt(INIT_HOST)
#define st_init_node() hpfc_name_to_stmt(INIT_NODE)
#define st_host_end() hpfc_name_to_stmt(HOST_END)
#define st_node_end() hpfc_name_to_stmt(NODE_END)

#define hpfc_name_and_ref_to_stmt(s, val) \
  st_call_send_or_receive(hpfc_name_to_entity(s), val)

/* SND */

#define st_send_to_computer(val) \
  hpfc_name_and_ref_to_stmt(SND_TO_C, val)

#define st_send_to_host(val) \
  hpfc_name_and_ref_to_stmt(SND_TO_H, val)

#define st_send_to_all_nodes(val) \
  hpfc_name_and_ref_to_stmt(SND_TO_A, val)

#define st_host_send_to_all_nodes(val) \
  hpfc_name_and_ref_to_stmt(SND_TO_A_BY_H, val)

#define st_send_to_neighbour() \
  hpfc_make_call_statement(hpfc_name_to_entity(SND_TO_N), NIL)

#define st_send_to_owner(val) \
  hpfc_name_and_ref_to_stmt(SND_TO_O, val)

#define st_send_to_owners(val) \
  hpfc_name_and_ref_to_stmt(SND_TO_OS, val)

#define st_send_to_other_owners(val) \
  hpfc_name_and_ref_to_stmt(SND_TO_OOS, val)

#define st_send_to_host_and_all_nodes(val) \
  hpfc_name_and_ref_to_stmt(SND_TO_HA, val)

#define st_send_to_not_owners(val) \
  hpfc_name_and_ref_to_stmt(SND_TO_NO, val)

#define st_send_to_host_and_not_owners(val) \
  hpfc_name_and_ref_to_stmt(SND_TO_HNO, val)


/* RCV */

#define st_receive_from_neighbour() \
  hpfc_make_call_statement(hpfc_name_to_entity(RCV_FR_N), NIL)

#define st_receive_from_sender(goal) \
  hpfc_name_and_ref_to_stmt(RCV_FR_S, goal)

#define st_receive_from_host(goal) \
  hpfc_name_and_ref_to_stmt(RCV_FR_H, goal)

#define st_receive_from_computer(goal) \
  hpfc_name_and_ref_to_stmt(RCV_FR_C, goal)

#define st_receive_mcast_from_sender(goal) \
  hpfc_name_and_ref_to_stmt(RCV_FR_mCS, goal)

#define st_receive_mcast_from_host(goal) \
  hpfc_name_and_ref_to_stmt(RCV_FR_mCH, goal)


#define primary_entity_p(a) (a==load_primary_entity(a))

/*   WARNING
 */
#define hpfc_warning \
    if (!get_bool_property("HPFC_NO_WARNING")) pips_user_warning

/* fake resources...
 */
#define NO_FILE (strdup(""))

/* File suffixes
 */

#define HOST_SUFFIX	"_host.f"
#define NODE_SUFFIX	"_node.f"
#define HINC_SUFFIX	"_host.h"
#define NINC_SUFFIX	"_node.h"
#define BOTH_SUFFIX	"_both.f"
#define PARM_SUFFIX	"_parameters.h"
#define INIT_SUFFIX	"_init.h"

/* that is all
 */