Functions to help clean up when a fatal error is encountered. More...

Collaboration diagram for Fatal Error Handlers:

Modules
	Fatal Implementation.

Files
file	abort.h
	`NS_ABORT_x` macro definitions.

file	fatal-error.h
	`NS_FATAL_x` macro definitions.

Macros
#define	NS_ABORT_IF(cond)
	Abnormal program termination if a condition is `true`. More...

#define	NS_ABORT_MSG(msg)
	Unconditional abnormal program termination with a message. More...

#define	NS_ABORT_MSG_IF(cond, msg)
	Abnormal program termination if a condition is `true`, with a message. More...

#define	NS_ABORT_MSG_UNLESS(cond, msg) NS_ABORT_MSG_IF (!(cond),msg)
	Abnormal program termination if a condition is `false`, with a message. More...

#define	NS_ABORT_UNLESS(cond) NS_ABORT_IF (!(cond))
	Abnormal program termination if a condition is `false`. More...

#define	NS_FATAL_ERROR(msg)
	Fatal error handling. More...

#define	NS_FATAL_ERROR_NO_MSG()
	Fatal error handling. More...

Detailed Description

Functions to help clean up when a fatal error is encountered.

The functions in this group are used to perform limited clean up, like flushing active streams, when fatal errors are encountered (through assertion fail, calls to NS_ABORT_* or calls to NS_FATAL_ERROR).

Currently, other than flushing active ostreams, these functions does not interfere with outside memory. There is still a residual risk that invalid ostream pointers may be present, and may corrupt the memory on the attempt to execute the flush() function.

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 a condition is true.

Parameters

cond	The 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 expression for cond 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. The ns-3 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 77 of file abort.h.

Referenced by ns3::EpcTft::Add(), ns3::EmuEpcHelper::AddEnb(), ns3::EpcSgwPgwApplication::DoCreateSessionRequest(), LteEpcE2eDataTestCase::DoRun(), ns3::LrWpanPhy::EndSetTRXState(), ns3::LrWpanPhy::EndTx(), ns3::UeManager::GetDataRadioBearerInfo(), ns3::LrWpanPhy::PlmeSetTRXStateRequest(), 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)

Unconditional abnormal program termination with a message.

Parameters

msg	The 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 registered by std::set_terminate.

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

See also: NS_FATAL_ERROR

Definition at line 50 of file abort.h.

Referenced by ns3::GnuplotAggregator::Add2dDataset(), ns3::FileHelper::AddAggregator(), ns3::GnuplotHelper::AddProbe(), ns3::FileHelper::AddProbe(), ns3::FileHelper::AddTimeSeriesAdaptor(), ns3::GnuplotHelper::AddTimeSeriesAdaptor(), ns3::SixLowPanNetDevice::CompressLowPanNhc(), ns3::ConfigStore::ConfigStore(), ns3::SixLowPanNetDevice::DecompressLowPanIphc(), ns3::SixLowPanNetDevice::DecompressLowPanNhc(), ns3::RipNg::DeleteRoute(), ns3::LrWpanNetDevice::GetMulticast(), ns3::SixLowPanNetDevice::Fragments::GetPacket(), ns3::FileHelper::GetProbe(), ns3::GnuplotHelper::GetProbe(), ns3::CoDelQueue::GetQueueSize(), ns3::RedQueue::GetQueueSize(), ns3::Radvd::HandleRead(), ns3::RipNg::InvalidateRoute(), ns3::SixLowPanNetDevice::MakeGlobalAddressFromMac(), ns3::SixLowPanNetDevice::MakeLinkLocalAddressFromMac(), ns3::operator<<(), ns3::PcapSniffRxEvent(), ns3::PcapSniffTxEvent(), PerfFile(), ns3::SixLowPanIphc::PostProcessDac(), ns3::SixLowPanIphc::PostProcessSac(), ns3::RipNg::Receive(), ns3::LrWpanNetDevice::SendFrom(), ns3::GnuplotAggregator::Set2dDatasetErrorBars(), ns3::GnuplotAggregator::Set2dDatasetExtra(), ns3::GnuplotAggregator::Set2dDatasetStyle(), ns3::LrWpanNetDevice::SetMtu(), ns3::YansWifiPhyHelper::SetPcapDataLinkType(), ns3::Time::Time(), ns3::GnuplotAggregator::Write2d(), ns3::GnuplotAggregator::Write2dDatasetEmptyLine(), ns3::GnuplotAggregator::Write2dWithXErrorDelta(), ns3::GnuplotAggregator::Write2dWithXYErrorDelta(), and ns3::GnuplotAggregator::Write2dWithYErrorDelta().

#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 a condition is true, with a message.

Parameters

cond	The ondition to be evaluated.
msg	The 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 expression for cond 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. The ns-3 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 108 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::YansWavePhyHelper::EnablePcapInternal(), ns3::YansWifiPhyHelper::EnablePcapInternal(), ns3::SystemWallClockMsPrivate::End(), ns3::RadioEnvironmentMapHelper::Install(), ns3::LteHelper::InstallSingleEnbDevice(), ns3::LteHelper::InstallSingleUeDevice(), ns3::AthstatsWifiTraceSink::Open(), ns3::GlobalRouter::ProcessBridgedBroadcastLink(), ns3::GlobalRouter::ProcessPointToPointLink(), ns3::GlobalRouter::ProcessSingleBroadcastLink(), ns3::TapBridge::ReceiveFromBridgedDevice(), ns3::TcpSocketBase::Recv(), ns3::TcpSocketBase::Send(), ns3::Ipv4Header::SetFragmentOffset(), ns3::TapBridge::StartTapDevice(), and ns3::int64x64_t::Umul().

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

Abnormal program termination if a condition is false, with a message.

Parameters

cond	Thecondition to be evaluated.
msg	The 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 144 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(), ns3::BuildingsHelper::Install(), 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::SetInitialSSThresh(), ns3::TcpReno::SetInitialSSThresh(), ns3::TcpTahoe::SetInitialSSThresh(), ns3::TcpWestwood::SetInitialSSThresh(), ns3::TcpNewReno::SetSegSize(), ns3::TcpReno::SetSegSize(), ns3::TcpTahoe::SetSegSize(), ns3::TcpWestwood::SetSegSize(), ns3::TcpSocketBase::SetSegSize(), and ns3::AthstatsWifiTraceSink::WriteStats().

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

Abnormal program termination if a condition is false.

Parameters

cond	The condition to be evaluated.

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

See also: NS_ABORT_IF

Definition at line 128 of file abort.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 100 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 71 of file fatal-error.h.

Referenced by ns3::OrganizationIdentifier::GetSerializedSize().

Modules

Files

Macros

Detailed Description

Macro Definition Documentation