src/mpi/model/remote-channel-bundle-manager.h
author Tom Henderson <tomh@tomh.org>
Sat, 16 Jan 2016 08:14:40 -0800
changeset 11683 9142266fbb25
parent 10476 8abf67214c5d
permissions -rw-r--r--
add figures to main documentation build
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
10476
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
     1
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
     2
/*
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
     3
 *  Copyright 2013. Lawrence Livermore National Security, LLC.
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
     4
 *
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
     8
 *
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    12
 * GNU General Public License for more details.
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    13
 *
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    17
 *
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    18
 * Author: Steven Smith <smith84@llnl.gov>
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    19
 *
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    20
 */
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    21
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    22
#ifndef NS3_REMOTE_CHANNEL_BUNDLE_MANAGER
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    23
#define NS3_REMOTE_CHANNEL_BUNDLE_MANAGER
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    24
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    25
#include <ns3/nstime.h>
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    26
#include <ns3/ptr.h>
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    27
#include <map>
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    28
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    29
namespace ns3 {
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    30
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    31
class RemoteChannelBundle;
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    32
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    33
/*
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    34
 * \ingroup mpi
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    35
 * 
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    36
 * \brief Singleton for managing the RemoteChannelBundles for each process.
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    37
 *
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    38
 * Manages collective tasks associated with the bundle collection.
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    39
 */
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    40
class RemoteChannelBundleManager
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    41
{
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    42
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    43
public:
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    44
  /**
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    45
   * \return remote channel bundle for specified SystemId.
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    46
   */
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    47
  static Ptr<RemoteChannelBundle> Find (uint32_t systemId);
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    48
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    49
  /**
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    50
   * Add RemoteChannelBundle from this task to MPI task on other side of the link.
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    51
   * Can not be invoked after InitializeNullMessageEvents has been invoked.
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    52
   */
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    53
  static Ptr<RemoteChannelBundle> Add (uint32_t systemId);
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    54
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    55
  /**
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    56
   * \return number of remote channel bundles
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    57
   * 
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    58
   */
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    59
  static uint32_t Size (void);
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    60
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    61
  /**
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    62
   * Setup initial Null Message events for every RemoteChannelBundle.
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    63
   * All RemoteChannelBundles should be added before this method is invoked.
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    64
   */
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    65
  static void InitializeNullMessageEvents (void);
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    66
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    67
  /**
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    68
   * \return safe time across all remote channels.
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    69
   */
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    70
  static Time GetSafeTime (void);
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    71
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    72
  /**
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    73
   * Destroy the singleton.
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    74
   */
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    75
  static void Destroy (void);
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    76
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    77
private:
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    78
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    79
  /**
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    80
   * Private ctor to prevent creation outside of singleton pattern.
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    81
   */
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    82
  RemoteChannelBundleManager ()
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    83
  {
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    84
  }
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    85
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    86
  ~RemoteChannelBundleManager ()
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    87
  {
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    88
  }
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    89
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    90
  /*
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    91
   * Container for all remote channel bundles for this task.
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    92
   *
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    93
   * Would be more efficient to use unordered_map when C++11 is adopted for NS3.
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    94
   */
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    95
  typedef std::map<uint32_t, Ptr<RemoteChannelBundle> > RemoteChannelMap;
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    96
  static RemoteChannelMap g_remoteChannelBundles;
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    97
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    98
  /*
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
    99
   * Protect manager class from being initialized twice or incorrect
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
   100
   * ordering of method calls.
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
   101
   */
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
   102
  static bool g_initialized;
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
   103
};
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
   104
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
   105
} // namespace ns3
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
   106
8abf67214c5d Null message scheduler
Steven Smith <smith84@llnl.gov>
parents:
diff changeset
   107
#endif