OmpAttribute.h

#ifndef Omp_Attribute_h_INCLUDED
#define Omp_Attribute_h_INCLUDED

//
// Liao 9/17, 2008
//

#include <iostream>
#include <string>
#include <map>
#include <cassert>
#include <vector>
class SgNode;
namespace OmpSupport
{
  // OpenMP construct name list
  //-------------------------------------------------------------------
  // We put all directive and clause types into one enumerate type
  // since some internal data structure(map) have to access 
  // both directives and clauses uniformly
  enum  omp_construct_enum 
  {
    e_unknown = 0, 

    // 16 directives as OpenMP 3.0
    e_parallel,
    e_for,
    e_for_simd,
    e_do,
    e_workshare,
    e_sections,
    e_section,
    e_single,

    e_master, 
    e_critical,
    e_barrier,
    e_atomic,
    e_flush,

    // Liao, 1/15/2013, experimental implementation for the draft OpenMP Accelerator Model technical report 
    e_target, 
    e_target_declare,
    e_target_data,
    e_target_update, 
    e_map, // map clauses
    e_device,
    e_begin, // 10/29/2015, experimental begin/end directives for SPMD code blocks, without changing variable scopes
    e_end,

    e_threadprivate,
    e_parallel_for,
    e_parallel_for_simd,
    e_parallel_do,
    e_parallel_sections,
    e_parallel_workshare,
    e_task,
    e_taskwait, 
    // we have both ordered directive and ordered clause, 
    //so make the name explicit
    e_ordered_directive,

    // Fortran only end directives
    e_end_critical,
    e_end_do,
    e_end_master,
    e_end_ordered,
    e_end_parallel_do,
    e_end_parallel_sections,
    e_end_parallel_workshare,
    e_end_parallel,
    e_end_sections,
    e_end_single,
    e_end_task,
    e_end_workshare,

    // 15 clauses for OpenMP 3.0
    // 7 data-sharing attributes clauses
    e_default, // the clause
    e_shared,
    e_private,
    e_firstprivate,
    e_lastprivate,
    e_copyin,
    e_copyprivate,
    e_proc_bind, 

    //8 misc clauses
    e_if, // used with omp parallel or omp task
    e_num_threads, // for omp parallel only
    e_nowait,
    e_ordered_clause,
    e_reduction,
    e_schedule,
    e_collapse,
    e_untied, 
    e_mergeable, 
    e_final, 
    e_priority, 
    e_atomic_clause, 
    e_inbranch,
    e_notinbranch,

    e_depend, // OpenMP 4.0 task clauses

    // Simple values for some clauses

    //4 values for default clause 
    //C/C++ default values
    e_default_none,
    e_default_shared,
    //Fortran default values
    e_default_private,
    e_default_firstprivate,

    // proc_bind(master|close|spread)
    e_proc_bind_master, 
    e_proc_bind_close, 
    e_proc_bind_spread, 

    e_atomic_read, 
    e_atomic_write, 
    e_atomic_update, 
    e_atomic_capture, 

    // reduction operations
    //8 operand for C/C++
     //  shared 3 common operators for both C and Fortran
    e_reduction_plus, //+
    e_reduction_mul,  //* 
    e_reduction_minus, // -

      // C/C++ only
    e_reduction_bitand, // &  
    e_reduction_bitor,  // | 
    e_reduction_bitxor,  // ^  
    e_reduction_logand,  // &&  
    e_reduction_logor,   // || 

    // Fortran operator
    e_reduction_and, // .and.
    e_reduction_or, // .or.
    e_reduction_eqv,   // fortran .eqv. 
    e_reduction_neqv,   // fortran .neqv.

    // reduction intrinsic procedure name for Fortran  
    // min, max also for C
    e_reduction_max,
    e_reduction_min, 

    e_reduction_iand,
    e_reduction_ior,
    e_reduction_ieor,

    //5 schedule policies for
    //---------------------
    e_schedule_none,
    e_schedule_static,
    e_schedule_dynamic,
    e_schedule_guided,
    e_schedule_auto,
    e_schedule_runtime,

    // 4 device map variants
    //----------------------
    e_map_alloc,
    e_map_to,
    e_map_from,
    e_map_tofrom,

    // experimental dist_data clause dist_data(dim1_policy, dim2_policy, dim3_policy)
    // A policy can be block(n), cyclic(n), or duplicate
    e_dist_data, 
    e_duplicate, 
    e_block,
    e_cyclic,

    // experimental SIMD directive, phlin 8/5/2013
    e_simd,
    e_declare_simd,
    e_safelen,
    e_simdlen,
    e_uniform,
    e_aligned,
    e_linear,

    // task dependence type
    e_depend_in, 
    e_depend_out, 
    e_depend_inout, 

    // not an OpenMP construct
    e_not_omp

  }; //end omp_construct_enum

  // A new variable to communicate the context of OpenMP parser
  // what directive is being parsed right now. 
  // This is useful for rare case of parsing "declare simd"
  extern omp_construct_enum cur_omp_directive; 
   
  //-------------------------------------------------------------------
  // some utility functions

  // Better using OmpSupport::toString() to avoid ambiguous 
  std::string toString(omp_construct_enum omp_type);

  bool isFortranEndDirective(omp_construct_enum omp_type);

  bool isFortranBeginDirective(omp_construct_enum omp_type);

  bool isDirective(omp_construct_enum omp_type);

  bool isDirectiveWithBody(omp_construct_enum omp_type);

  bool isClause(omp_construct_enum omp_type);

  bool isReductionOperator(omp_construct_enum omp_type);

  bool isDependenceType(omp_construct_enum omp_type);

  class OmpAttribute;
  //
  ROSE_DLL_API OmpAttribute* buildOmpAttribute(enum omp_construct_enum directive_type, SgNode* context_node, bool useDefined);

  ROSE_DLL_API void addOmpAttribute(OmpAttribute* ompattribute, SgNode* node);

  ROSE_DLL_API void removeOmpAttribute(OmpAttribute* ompattribute, SgNode* node);

  ROSE_DLL_API bool isEquivalentOmpAttribute (OmpAttribute* a1, OmpAttribute* a2);
  
  class OmpAttributeList;
  ROSE_DLL_API OmpAttributeList* getOmpAttributeList(SgNode* node);

  OmpAttribute* getOmpAttribute(SgNode* node);

  omp_construct_enum getOmpConstructEnum(SgPragmaDeclaration* decl);

  omp_construct_enum getBeginOmpConstructEnum (omp_construct_enum end_enum);

  omp_construct_enum getEndOmpConstructEnum (omp_construct_enum begin_enum);

  ROSE_DLL_API void generatePragmaFromOmpAttribute(SgNode* sg_node); 
  //TODO this is duplicated from autoParallization project's generatedOpenMPPragmas() 
  // We should remove this duplicate once autopar is moved into rose/src 
  
  ROSE_DLL_API std::string generateDiffTextFromOmpAttribute(SgNode* sg_node);

  //------------------------------------------------------------------
  // By default, the persistent attribute attached to an OpenMP pragma node in SAGE III AST
  // Attaching to pragma is easier since a few directives have no obvious 
  // associated code blocks, like threadprivate.
  //
  // The attribute can also be attached by a scope affected by OpenMP. This is used during
  // automatic parallelization when the corresponding pragma is not yet generated.
  //
  // A cure-all approach is used to simplify the handling. 
  // OmpAttribute is implemented using a 'flat' data structure encompass all 
  // possible directives, clauses
  // and their various contents, if any.
  //
  // different types of pragmas need different information in some cases
  // e.g.
  //    'omp for' needs scheduling type 
  //------------------------------------------------------------------

  class ROSE_DLL_API OmpAttributeList :public AstAttribute
  {
    public:
      std::vector<OmpAttribute*> ompAttriList;
      // Restore to legal OpenMP directive strings
      std::string toOpenMPString();
      // Pretty print for debugging purpose
      void print();
      ~OmpAttributeList();

      // This attribute attempts to manage its own memory by calling "delete" whenever the attribute is removed from an AST
      // node.  It avoids memory leaks by not allowing OmpAttributeList attributes to be copied (no virtual "copy"
      // constructor), and it never tries to replace one OmpAttributeList object with another with AstAttributeMechanism's
      // "set" or "replace" methods or the corresponding methods in SgNode. However, it leaks memory if an AST node is deleted.
      virtual OwnershipPolicy getOwnershipPolicy() const ROSE_OVERRIDE {
          return CUSTOM_OWNERSHIP;
      }
      // MS2018: added to fix warning
      virtual std::string attribute_class_name() const ROSE_OVERRIDE;
      virtual OmpAttributeList* copy() ROSE_OVERRIDE;
  };                      

  class ROSE_DLL_API OmpAttribute
  {
    public:
      SgPragmaDeclaration* getPragmaDeclaration();

      PreprocessingInfo* getPreprocessingInfo() {return pinfo;};
      void setPreprocessingInfo(PreprocessingInfo* info) { pinfo=info;};

      SgNode* getNode(){return mNode;};
      void setNode(SgNode* n) { mNode= n;};
      void setOmpDirectiveType(omp_construct_enum omptype){ assert (isDirective(omptype)); omp_type = omptype;}
      omp_construct_enum getOmpDirectiveType() {return omp_type;}

      void addClause(omp_construct_enum clause_type);
      bool hasClause(omp_construct_enum clause_type);

      std::vector<omp_construct_enum> getClauses();

      SgVariableSymbol* addVariable(omp_construct_enum targetConstruct, const std::string& varString, SgInitializedName* sgvar=NULL);

      SgVariableSymbol* addVariable(omp_construct_enum targetConstruct, SgExpression* varExp);

      bool hasVariableList(omp_construct_enum);
      std::vector<std::pair<std::string,SgNode* > > 
        getVariableList(omp_construct_enum);

      // We store a list (vector) of dimension bounds for each array variable
      std::map<SgSymbol*,  std::vector < std::pair <SgExpression*, SgExpression*> > >  array_dimensions;  
      
      // dist_data (dim1_policy, dim2_policy, dim3_policy) for mapped arrays
      // we use std::map <variable, policy_vector> to represent this.
      // the policy vector contains up to three pair of (policy, optional size)
      // e.g.  map(x[0:n][0:m] dist_data(duplicate, block(2)))
      // -----------------------------------
      std::map <SgSymbol* ,  std::vector < std::pair<omp_construct_enum, SgExpression*> >   >  dist_data_policies; 
 
      std::vector<enum omp_construct_enum> get_clauses(const std::string& variable);

      bool appendDistDataPolicy(SgVariableSymbol* array_symbol, omp_construct_enum dist_data_policy, SgExpression* size_exp = NULL);

     std::vector < std::pair < omp_construct_enum, SgExpression*> > getDistDataPolicy (SgVariableSymbol* array_symbol); 
       
      void addExpression(omp_construct_enum targetConstruct, const std::string& expString, SgExpression*    sgexp=NULL); 

      std::pair<std::string, SgExpression*>  
        getExpression(omp_construct_enum targetConstruct);

      //
      // Reduction needs special handling 
      // since multiple ones with different operator types can co-exist within one pragma
      // We categories reduction clauses by their operator type and store variable lists for each of the reduction operator type, not with the reduction clause

      // Add a new reduction clause with the specified operator
      void setReductionOperator(omp_construct_enum operatorx);

      std::vector<omp_construct_enum> getReductionOperators();

      bool hasReductionOperator(omp_construct_enum operatorx);
      
      //------------------------------------------
      // Add a new clause with the specified operator
      void setDependenceType(omp_construct_enum operatorx);

      std::vector<omp_construct_enum> getDependenceTypes();

      bool hasDependenceType(omp_construct_enum operatorx);


      // map clause is similar to reduction clause, 
      //
      // Add a new map clauses with the specified variant type
      void setMapVariant(omp_construct_enum operatorx);
      std::vector<omp_construct_enum> getMapVariants();
      bool hasMapVariant(omp_construct_enum operatorx);

      bool isMapVariant(omp_construct_enum omp_type);

      // default () value
      void setDefaultValue(omp_construct_enum valuex);
      omp_construct_enum getDefaultValue();

      // proc_bind() policy 
      void setProcBindPolicy(omp_construct_enum valuex);
      omp_construct_enum getProcBindPolicy();

      //Atomicity of Atomic Clause 
      void setAtomicAtomicity(omp_construct_enum valuex);
      omp_construct_enum getAtomicAtomicity();

      // Schedule kind
      omp_construct_enum getScheduleKind(); 
      void setScheduleKind(omp_construct_enum kindx);

      bool isInConstruct(const std::string & variable, enum omp_construct_enum);

      void setCriticalName(const std::string & name);
      std::string  getCriticalName() {return name;};
      bool isNamedCritical(){return hasName;};

      void print(); 
      
      bool get_isUserDefined() {return isUserDefined; }

      //not named toString() to void ambiguous with OmpAttribute::toString()
      std::string toOpenMPString();
    friend  OmpAttribute* buildOmpAttribute(omp_construct_enum directive_type, SgNode* node, bool userDefined);
      //------------------hide the implementation details, could be changed anytime!!
      //----------------------------------------------------------------------------
    private:  
      //It is recommended to use OmpSupport::buildOmpAttribute() instead of 
      //using the constructors here
      OmpAttribute()
      {
        mNode = NULL;
        omp_type = e_unknown;
        init();
        isUserDefined = true;
      }
      OmpAttribute(omp_construct_enum omptype, SgNode* mynode):
        mNode(mynode),omp_type(omptype){ 
          /*The initialization order has to match the declaration order, 
           * otherwise get a compilation warning*/
          init();
          isUserDefined = true;
          if (mNode != NULL )
          {
#if 0 // [Robb Matzke 2021-03-28]: causes unused variable warning every time this header is included
            SgLocatedNode * lnode = isSgLocatedNode (mNode);
            ROSE_ASSERT (lnode != NULL);
            //ROSE_ASSERT (lnode->get_file_info()->get_filename()!=std::string("transformation"));
#else // fixed version
            ROSE_ASSERT(isSgLocatedNode(mNode));
#endif
          }
          // Liao 2/12/2010, we allow build empty attribute as a replacement of a default constructor.
          // This is used by autoParallization to tentatively create an instance and later fill data fields.
          // assert(isDirective(omptype));
        }

      SgNode*  mNode; 
      PreprocessingInfo* pinfo;

      bool isUserDefined; 

      enum omp_construct_enum  omp_type; 

      // vector is used to preserve the order of clauses in the directive
      // map is used to fast query if a clause exists or not
      // Some clauses are allowed to appear more than once, merge the content into the first occurrence in our implementation.
      std::vector<omp_construct_enum> clauses;
      std::map<omp_construct_enum,bool> clause_map;

      // Multiple reduction clauses, each has a different operator
      //value for reduction operation: + -, * & | etc
      std::vector<omp_construct_enum> reduction_operators;

      std::vector<omp_construct_enum> dependence_types;

      // Liao, 1/15/2013, map variant:
      // there could be multiple map clause with the same variant type: alloc, to, from , and tofrom.
      std::vector<omp_construct_enum> map_variants; 
      //enum omp_construct_enum map_variant; 
      
      //variable lists------------------- 
      //appeared within some directives and clauses
      //The clauses/directive are: flush, threadprivate, private, firstprivate, 
      //  shared, copyin, reduction, lastprivate, copyprivate
      // We use a pair of (name, SgNode) for each variable 
      // It is highly possible that a variable having more than one OpenMP properties.
      // For example, a variable can be both firstprivate and lastprivate.
      std::map<omp_construct_enum, std::vector<std::pair<std::string,SgNode* > > > variable_lists; 
      // A reverse map from a variable to the clauses the variable appears
      std::map<std::string, std::vector<omp_construct_enum> > var_clauses;

     
      // expressions ----------------------
      // e.g.: if (exp), num_threads(exp), schedule(,exp), collapse(exp)
      std::map<omp_construct_enum, std::pair<std::string, SgExpression*> > expressions;

      // values for some clauses -------------------------
      // values for default() clause: data scoping information
      // choices are: none,shared, private, firstprivate
      omp_construct_enum default_scope; 

     // values for proc_bind() clause
      omp_construct_enum proc_bind_policy; 

      // Atomic clause's atomicity
      omp_construct_enum atomicity; 

      // value for omp for's schedule policies
      omp_construct_enum schedule_kind;

      // Only used for omp critical to indicate if it is named or not
      // name for the directive, only used for omp critical
      bool hasName; 
      std::string name; 

      // Misc fields  --------------------------------
      // help translation and analysis   
      bool isOrphaned; //true if parent omp parallel is not in the static lexical scope

      // Additional information to help translation
      int wrapperCount; // the shared variables from the same scope which needs wrapper

      //optional information
      OmpAttribute * parent; //upper-level OMP pragma's attribute

      void init() ;

      // invoke OmpSupport::toString() to stringify the enumerate type internally
      // some variables have the optional dist_data policy
      std::string toOpenMPString(omp_construct_enum omp_type);

      std::string toOpenMPString(std::vector<std::pair<std::string,SgNode* > > varList, bool checkDistPolicy = false);

      std::string toOpenMPString (std::vector < std::pair <omp_construct_enum, SgExpression*> > dim_policies);
  }; // end class OmpAttribute


 // save encountered Fortran OpenMP directives here.
 // We reuse the list later on to build OpenMP AST for Fortran
  extern std::list<OmpAttribute* > omp_comment_list;


} //end namespace OmpSupport

#endif //Omp_Attribute_h_INCLUDED