src/smpi/include/smpi_comm.hpp

   1 /* Copyright (c) 2010-2022. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SMPI_COMM_HPP_INCLUDED
   7 #define SMPI_COMM_HPP_INCLUDED
   8
   9 #include <list>
  10 #include <string>
  11 #include <memory>
  12 #include "smpi_errhandler.hpp"
  13 #include "smpi_keyvals.hpp"
  14 #include "smpi_group.hpp"
  15 #include "smpi_topo.hpp"
  16 #include "smpi_config.hpp"
  17
  18 namespace simgrid{
  19 namespace smpi{
  20
  21 class Comm : public F2C, public Keyval{
  22   friend Topo;
  23   MPI_Group group_;
  24   SMPI_Topo_type topoType_ = MPI_INVALID_TOPO;
  25   std::shared_ptr<Topo> topo_; // to be replaced by an union
  26   int refcount_          = 1;
  27   MPI_Comm leaders_comm_ = MPI_COMM_NULL; // inter-node communicator
  28   MPI_Comm intra_comm_   = MPI_COMM_NULL; // intra-node communicator. For MPI_COMM_WORLD this can't be used, as var is
  29                                           // global. Use an intracomm stored in the process data instead
  30   int* leaders_map_     = nullptr;        // who is the leader of each process
  31   bool is_uniform_      = true;
  32   int* non_uniform_map_ = nullptr; // set if smp nodes have a different number of processes allocated
  33   bool is_blocked_      = false;   // are ranks allocated on the same smp node contiguous?
  34   bool is_smp_comm_     = false;   // set to false in case this is already an intra-comm or a leader-comm to avoid
  35                                    // recursion
  36   std::list<MPI_Win> rma_wins_; // attached windows for synchronization.
  37   std::string name_;
  38   MPI_Info info_ = MPI_INFO_NULL;
  39   int id_;
  40   MPI_Errhandler errhandler_ =  _smpi_cfg_default_errhandler_is_error ? MPI_ERRORS_ARE_FATAL : MPI_ERRORS_RETURN;;
  41   MPI_Errhandler* errhandlers_ = nullptr; //for MPI_COMM_WORLD only
  42
  43   std::unordered_map<std::string, unsigned int> sent_messages_;
  44   std::unordered_map<std::string, unsigned int> recv_messages_;
  45   unsigned int collectives_count_ = 0;
  46   unsigned int* collectives_counts_ = nullptr; //for MPI_COMM_WORLD only
  47
  48
  49 public:
  50   static std::unordered_map<int, smpi_key_elem> keyvals_;
  51   static int keyval_id_;
  52
  53   Comm() = default;
  54   Comm(MPI_Group group, MPI_Topology topo, bool smp = false, int id = MPI_UNDEFINED);
  55   int dup(MPI_Comm* newcomm);
  56   int dup_with_info(MPI_Info info, MPI_Comm* newcomm);
  57   MPI_Group group();
  58   MPI_Topology topo() const { return topo_; }
  59   void set_topo(MPI_Topology topo){topo_=topo;}
  60   int size() const;
  61   int rank() const;
  62   int id() const;
  63   void get_name(char* name, int* len) const;
  64   std::string name() const override;
  65   void set_name(const char* name);
  66   MPI_Info info();
  67   void set_info( MPI_Info info);
  68   MPI_Errhandler errhandler();
  69   void set_errhandler( MPI_Errhandler errhandler);
  70   void set_leaders_comm(MPI_Comm leaders);
  71   void set_intra_comm(MPI_Comm leaders) { intra_comm_ = leaders; };
  72   int* get_non_uniform_map() const;
  73   int* get_leaders_map() const;
  74   MPI_Comm get_leaders_comm() const;
  75   MPI_Comm get_intra_comm() const;
  76   MPI_Comm find_intra_comm(int* leader);
  77   bool is_uniform() const;
  78   bool is_blocked() const;
  79   bool is_smp_comm() const;
  80   MPI_Comm split(int color, int key);
  81   void cleanup_smp();
  82   void ref();
  83   static void unref(MPI_Comm comm);
  84   static void destroy(MPI_Comm comm);
  85   void init_smp();
  86
  87   static void free_f(int id);
  88   static Comm* f2c(int);
  89
  90   static int keyval_create(MPI_Comm_copy_attr_function* copy_fn, MPI_Comm_delete_attr_function* delete_fn, int* keyval,
  91                            void* extra_state);
  92   static int keyval_free(int* keyval);
  93   static void keyval_cleanup();
  94
  95   void add_rma_win(MPI_Win win);
  96   void remove_rma_win(MPI_Win win);
  97   void finish_rma_calls() const;
  98   MPI_Comm split_type(int type, int key, const Info* info);
  99   unsigned int get_sent_messages_count(int src, int dst, int tag);
 100   void increment_sent_messages_count(int src, int dst, int tag);
 101   unsigned int get_received_messages_count(int src, int dst, int tag);
 102   void increment_received_messages_count(int src, int dst, int tag);
 103   unsigned int get_collectives_count();
 104   void increment_collectives_count();
 105 };
 106
 107 } // namespace smpi
 108 } // namespace simgrid
 109
 110 #endif