A Discrete-Event Network Simulator
API
mpi-test-fixtures.h
Go to the documentation of this file.
1 /*
2  * Copyright 2018. Lawrence Livermore National Security, LLC.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation;
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16  *
17  * Author: Steven Smith <smith84@llnl.gov>
18  */
19 
20 #ifndef MPI_TEST_FIXTURES_H
21 #define MPI_TEST_FIXTURES_H
22 
23 #include <iomanip>
24 #include <ios>
25 #include <sstream>
26 
44 namespace ns3
45 {
46 
47 template <typename T>
48 class Ptr;
49 class Address;
50 class Packet;
51 
60 #define RANK0COUT(x) \
61  do \
62  if (SinkTracer::GetWorldRank() == 0) \
63  { \
64  std::cout << "TEST : "; \
65  std::ios_base::fmtflags f(std::cout.flags()); \
66  std::cout << std::setfill('0') << std::setw(5) << SinkTracer::GetLineCount(); \
67  std::cout.flags(f); \
68  std::cout << " : " << x; \
69  } \
70  while (false)
71 
80 #define RANK0COUTAPPEND(x) \
81  do \
82  if (SinkTracer::GetWorldRank() == 0) \
83  { \
84  std::cout << x; \
85  } \
86  while (false)
87 
94 {
95  public:
99  static void Init();
100 
105  static void SinkTrace(const ns3::Ptr<const ns3::Packet> packet,
106  const ns3::Address& srcAddress,
107  const ns3::Address& destAddress);
108 
115  static void Verify(unsigned long expectedCount);
116 
123  static std::string FormatAddress(const ns3::Address address);
124 
130  static int GetWorldRank()
131  {
132  return m_worldRank;
133  }
134 
140  static int GetWorldSize()
141  {
142  return m_worldSize;
143  }
144 
149  static int GetLineCount()
150  {
151  return m_line++;
152  }
153 
154  private:
155  static unsigned long m_sinkCount;
156  static unsigned long m_line;
157  static int m_worldRank;
158  static int m_worldSize;
159 };
160 
161 } // namespace ns3
162 
163 #endif // MPI_TEST_FIXTURES_H
a polymophic address class
Definition: address.h:101
Collects data about incoming packets.
static void SinkTrace(const ns3::Ptr< const ns3::Packet > packet, const ns3::Address &srcAddress, const ns3::Address &destAddress)
PacketSink receive trace callback.
static int m_worldRank
MPI CommWorld rank.
static void Verify(unsigned long expectedCount)
Verify the sink trace count observed matches the expected count.
static int m_worldSize
MPI CommWorld size.
static unsigned long m_line
Current output line number for ordering output.
static void Init()
PacketSink Init.
static int GetWorldSize()
Get the MPI size of the world communicator.
static int GetLineCount()
Get current line count and increment it.
static int GetWorldRank()
Get the MPI rank in the world communicator.
static unsigned long m_sinkCount
Running sum of number of SinkTrace calls observed.
static std::string FormatAddress(const ns3::Address address)
Get the source address and port, as a formatted string.
address
Definition: first.py:47
Every class exported by the ns3 library is enclosed in the ns3 namespace.