Collaboration diagram for Debugging:

Modules
	Assert
	assert functions and macros
	Fatal Error Handler
	Functions to help clean up when fatal error is encountered.
	Logging
	Logging functions and macros.

Macros
#define	NS_ABORT_IF(cond)
	Abnormal program termination if cond is true.
#define	NS_ABORT_MSG(msg)
	Abnormal program termination.
#define	NS_ABORT_MSG_IF(cond, msg)
	Abnormal program termination if cond is true.
#define	NS_ABORT_MSG_UNLESS(cond, msg) NS_ABORT_MSG_IF (!(cond),msg)
	Abnormal program termination if cond is false.
#define	NS_ABORT_UNLESS(cond) NS_ABORT_IF (!(cond))
	Abnormal program termination if cond is false.
#define	NS_BREAKPOINT() ns3::BreakpointFallback ()
#define	NS_FATAL_ERROR(msg)
	fatal error handling
#define	NS_FATAL_ERROR_NO_MSG()
	fatal error handling

Detailed Description

Macro Definition Documentation

#define NS_ABORT_IF ( cond )

Value:

do {                                                                  \
      if (cond)                                                           \
        {                                                                 \
          std::cerr << "aborted. cond=\"" << # cond << ", ";               \
          NS_FATAL_ERROR_NO_MSG ();                                       \
        }                                                                 \
    } while (false)

Abnormal program termination if cond is true.

Parameters

cond	condition to be evaluated.

This is similar to NS_ASSERT(!(cond)), except this check is enabled in all builds. If cond is evaluated to true, the espression evaluating to true is printed to stderr, followed by a call to the NS_FATAL_ERROR_NO_MSG() macro which prints the details of filename and line number to stderr. The program will be halted by calling std::terminate(), triggering any clean up code registered by std::set_terminate (NS3 default is a stream-flushing code, but may be overridden).

This macro is enable unconditionally in all builds, including debug and optimized builds.

Definition at line 69 of file abort.h.

Referenced by ns3::EpcTft::Add(), ns3::EpcSgwPgwApplication::DoCreateSessionRequest(), ns3::LteEpcE2eDataTestCase::DoRun(), ns3::UeManager::GetDataRadioBearerInfo(), ns3::PyViz::TraceNetDevPromiscRxCsma(), ns3::PyViz::TraceNetDevRxCsma(), ns3::PyViz::TraceNetDevRxWifi(), ns3::PyViz::TraceNetDevTxCsma(), and ns3::PyViz::TraceNetDevTxWifi().

#define NS_ABORT_MSG ( msg )

Value:

do {                                                          \
      std::cerr << "aborted. ";                                   \
      NS_FATAL_ERROR (msg);                                       \
    } while (false)

Abnormal program termination.

Parameters

msg	message to output when this macro is hit.

This macro is essentially equivalent to NS_FATAL_ERROR, excepts it prepends the error message with the string "aborted. ". When this macro is hit a runtime, the program will be halted using std::terminate, which triggers clean up code regestered by std::set_terminate.

This macro is enable unconditionally in all builds, including debug and optimized builds.

See Also: NS_FATAL_ERROR

Definition at line 43 of file abort.h.

Referenced by ns3::ConfigStore::ConfigStore(), ns3::RedQueue::GetQueueSize(), main(), ns3::operator<<(), ns3::PcapSniffRxEvent(), ns3::PcapSniffTxEvent(), PerfFile(), ns3::YansWifiPhyHelper::SetPcapDataLinkType(), and ns3::Time::Time().

#define NS_ABORT_MSG_IF	(	cond,
		msg
	)

Value:

do {                                                                  \
      if (cond)                                                           \
        {                                                                 \
          std::cerr << "aborted. cond=\"" << # cond << "\", ";             \
          NS_FATAL_ERROR (msg);                                           \
        }                                                                 \
    } while (false)

Abnormal program termination if cond is true.

Parameters

cond	condition to be evaluated.
msg	message to output when cond is true.

This is similar to NS_ASSERT_MSG(!(cond)), except this check is enabled in all builds. If cond is evaluated to true, the espression evaluating to true is printed to stderr, followed by a call to the NS_FATAL_ERROR() macro which prints the user-specified error message, and details of filename and line number to stderr. The program will be halted by calling std::terminate(), triggering any clean up code registered by std::set_terminate (NS3 default is a stream-flushing code, but may be overridden).

This macro is enable unconditionally in all builds, including debug and optimized builds.

Definition at line 98 of file abort.h.

Referenced by ns3::WaypointMobilityModel::AddWaypoint(), ns3::GlobalRouter::BuildNetworkLSAs(), ns3::PcapHelper::CreateFile(), ns3::PlanetLabFdNetDeviceHelper::CreateFileDescriptor(), ns3::TapFdNetDeviceHelper::CreateFileDescriptor(), ns3::TapBridge::CreateTap(), ns3::GlobalRouter::DiscoverLSAs(), ns3::TapBridgeFdReader::DoRead(), ns3::FdNetDeviceFdReader::DoRead(), ns3::AsciiTraceHelperForDevice::EnableAsciiImpl(), ns3::PcapHelperForDevice::EnablePcap(), ns3::YansWifiPhyHelper::EnablePcapInternal(), ns3::SystemWallClockMsPrivate::End(), ns3::RadioEnvironmentMapHelper::Install(), ns3::LteHelper::InstallSingleEnbDevice(), ns3::LteHelper::InstallSingleUeDevice(), main(), ns3::AthstatsWifiTraceSink::Open(), ns3::GlobalRouter::ProcessBridgedBroadcastLink(), ns3::GlobalRouter::ProcessPointToPointLink(), ns3::GlobalRouter::ProcessSingleBroadcastLink(), ns3::TapBridge::ReceiveFromBridgedDevice(), ns3::TcpSocketBase::Recv(), ns3::TcpSocketBase::Send(), ns3::Ipv4Header::SetFragmentOffset(), and ns3::TapBridge::StartTapDevice().

#define NS_ABORT_MSG_UNLESS	(	cond,
		msg
	)	NS_ABORT_MSG_IF (!(cond),msg)

Abnormal program termination if cond is false.

Parameters

cond	condition to be evaluated.
msg	message to output if cond is false.

This is an alias for NS_ABORT_MSG_IF(!(cond))

See Also: NS_ABORT_MSG_IF

Definition at line 131 of file abort.h.

Referenced by ns3::Names::Add(), ns3::Ipv4AddressGeneratorImpl::AddAllocated(), ns3::BufferSizeLevelBsr::BsrId2BufferSize(), ns3::GlobalRouter::BuildNetworkLSAs(), ns3::GlobalRouter::DiscoverLSAs(), Ns3TcpLossTestCase::DoSetup(), Ns3TcpStateTestCase::DoSetup(), Ns3TcpInteroperabilityTestCase::DoSetup(), ns3::TestVectors< T >::Get(), ns3::PcapHelper::GetFilenameFromDevice(), ns3::AsciiTraceHelper::GetFilenameFromDevice(), ns3::PcapHelper::GetFilenameFromInterfacePair(), ns3::AsciiTraceHelper::GetFilenameFromInterfacePair(), ns3::Ipv4AddressGeneratorImpl::Init(), ns3::Ipv4AddressGeneratorImpl::InitAddress(), main(), ns3::BuildingsHelper::MakeConsistent(), ns3::BuildingsHelper::MakeMobilityModelConsistent(), ns3::Ipv4AddressGeneratorImpl::MaskToIndex(), ns3::Ipv4NixVectorRouting::NetDeviceIsBridged(), ns3::GlobalRouter::NetDeviceIsBridged(), ns3::Ipv4AddressGeneratorImpl::NextAddress(), ns3::AthstatsWifiTraceSink::Open(), ns3::OutputStreamWrapper::OutputStreamWrapper(), ns3::Ipv6AddressGeneratorImpl::PrefixToIndex(), ns3::GlobalRouter::ProcessBridgedBroadcastLink(), ns3::GlobalRouter::ProcessPointToPointLink(), ns3::GlobalRouter::ProcessSingleBroadcastLink(), ns3::Names::Rename(), ns3::TcpNewReno::SetInitialCwnd(), ns3::TcpReno::SetInitialCwnd(), ns3::TcpTahoe::SetInitialCwnd(), ns3::TcpWestwood::SetInitialCwnd(), ns3::TcpNewReno::SetSegSize(), ns3::TcpReno::SetSegSize(), ns3::TcpTahoe::SetSegSize(), ns3::TcpSocketBase::SetSegSize(), ns3::TcpWestwood::SetSegSize(), and ns3::AthstatsWifiTraceSink::WriteStats().

#define NS_ABORT_UNLESS ( cond ) NS_ABORT_IF (!(cond))

Abnormal program termination if cond is false.

Parameters

cond	condition to be evaluated.

This is an alias for NS_ABORT_IF(!(cond))

See Also: NS_ABORT_IF

Definition at line 117 of file abort.h.

#define NS_BREAKPOINT ( ) ns3::BreakpointFallback ()

Inserts a breakpoint instruction (or equivalent system call) into the code for selected machines. When an NS_ASSERT cannot verify its condition, this macro is used. Falls back to calling AssertBreakpoint() for architectures where breakpoint assembly instructions are not supported.

Definition at line 56 of file breakpoint.h.

#define NS_FATAL_ERROR ( msg )

Value:

do                                                    \
    {                                                   \
      std::cerr << "msg=\"" << msg << "\", ";           \
      NS_FATAL_ERROR_NO_MSG ();                          \
    }                                                   \
  while (false)

fatal error handling

Parameters

msg	message to output when this macro is hit.

When this macro is hit at runtime, the user-specified error message is printed to stderr, followed by a call to the NS_FATAL_ERROR_NO_MSG() macro which prints the details of filename and line number to stderr. The program will be halted by calling std::terminate(), triggering any clean up code registered by std::set_terminate (NS3 default is a stream-flushing code, but may be overridden).

This macro is enabled unconditionally in all builds, including debug and optimized builds.

Definition at line 72 of file fatal-error.h.

#define NS_FATAL_ERROR_NO_MSG ( )

Value:

do                                                      \
    {                                                     \
      std::cerr << "file=" << __FILE__ << ", line=" <<    \
      __LINE__ << std::endl;                            \
      ::ns3::FatalImpl::FlushStreams ();                  \
      std::terminate ();                                  \
    }                                                     \
  while (false)

fatal error handling

When this macro is hit at runtime, details of filename and line number is printed to stderr, and the program is halted by calling std::terminate(). This will trigger any clean up code registered by std::set_terminate (NS3 default is a stream-flushing code), but may be overridden.

This macro is enabled unconditionally in all builds, including debug and optimized builds.

Definition at line 44 of file fatal-error.h.

Modules

Macros

Detailed Description

Macro Definition Documentation