Logging functions and macros. More...

Collaboration diagram for Logging:

Macros
#define	NS_LOG(level, msg)
#define	NS_LOG_COMPONENT_DEFINE(name) static ns3::LogComponent g_log = ns3::LogComponent (name)
#define	NS_LOG_DEBUG(msg) NS_LOG (ns3::LOG_DEBUG, msg)
#define	NS_LOG_ERROR(msg) NS_LOG (ns3::LOG_ERROR, msg)
#define	NS_LOG_FUNCTION(parameters)
#define	NS_LOG_FUNCTION_NOARGS()
#define	NS_LOG_INFO(msg) NS_LOG (ns3::LOG_INFO, msg)
#define	NS_LOG_LOGIC(msg) NS_LOG (ns3::LOG_LOGIC, msg)
#define	NS_LOG_UNCOND(msg)
#define	NS_LOG_WARN(msg) NS_LOG (ns3::LOG_WARN, msg)

Functions
void	ns3::LogComponentDisable (char const *name, enum LogLevel level)
void	ns3::LogComponentDisableAll (enum LogLevel level)
void	ns3::LogComponentEnable (char const *name, enum LogLevel level)
void	ns3::LogComponentEnableAll (enum LogLevel level)
void	ns3::LogComponentPrintList (void)

Detailed Description

Logging functions and macros.

LOG functionality: macros which allow developers to send information out on screen. All logging messages are disabled by default. To enable selected logging messages, use the ns3::LogComponentEnable function or use the NS_LOG environment variable

Use the environment variable NS_LOG to define a ':'-separated list of logging components to enable. For example (using bash syntax), NS_LOG="OlsrAgent" would enable one component at all log levels. NS_LOG="OlsrAgent:Ipv4L3Protocol" would enable two components, at all log levels, etc. NS_LOG="*" will enable all available log components at all levels.

To control more selectively the log levels for each component, use this syntax: NS_LOG='Component1=func|warn:Component2=error|debug' This example would enable the 'func', and 'warn' log levels for 'Component1' and the 'error' and 'debug' log levels for 'Component2'. The wildcard can be used here as well. For example NS_LOG='*=level_all|prefix' would enable all log levels and prefix all prints with the component and function names.

A note on NS_LOG_FUNCTION() and NS_LOG_FUNCTION_NOARGS(): generally, use of (at least) NS_LOG_FUNCTION(this) is preferred. Use NS_LOG_FUNCTION_NOARGS() only in static functions.

Macro Definition Documentation

#define NS_LOG	(	level,
		msg
	)

Value:

do                                                            \
    {                                                           \
      if (g_log.IsEnabled (level))                              \
        {                                                       \
          NS_LOG_APPEND_TIME_PREFIX;                            \
          NS_LOG_APPEND_NODE_PREFIX;                            \
          NS_LOG_APPEND_CONTEXT;                                \
          NS_LOG_APPEND_FUNC_PREFIX;                            \
          std::clog << msg << std::endl;                        \
        }                                                       \
    }                                                           \
  while (false)

Parameters

level	the log level
msg	the message to log

This macro allows you to log an arbitrary message at a specific log level. The log message is expected to be a C++ ostream message such as "my string" << aNumber << "my oth stream".

Typical usage looks like:

NS_LOG (LOG_DEBUG, "a number="<<aNumber<<", anotherNumber="<<anotherNumber);

Definition at line 206 of file log.h.

Referenced by ns3::UplinkSchedulerMBQoS::UplinkSchedWindowTimer().

#define NS_LOG_COMPONENT_DEFINE ( name ) static ns3::LogComponent g_log = ns3::LogComponent (name)

Parameters

name a string

Define a Log component with a specific name. This macro should be used at the top of every file in which you want to use the NS_LOG macro. This macro defines a new "log component" which can be later selectively enabled or disabled with the ns3::LogComponentEnable and ns3::LogComponentDisable functions or with the NS_LOG environment variable.

Definition at line 119 of file log.h.

#define NS_LOG_DEBUG ( msg ) NS_LOG (ns3::LOG_DEBUG, msg)

Parameters

msg	the message to log

Use NS_LOG to output a message of level LOG_DEBUG.

Definition at line 244 of file log.h.

#define NS_LOG_ERROR ( msg ) NS_LOG (ns3::LOG_ERROR, msg)

Parameters

msg	the message to log

Use NS_LOG to output a message of level LOG_ERROR.

Definition at line 226 of file log.h.

Referenced by ns3::LteEnbPhy::AddUePhy(), ns3::UdpSocketImpl::Bind(), ns3::Ns2MobilityHelper::ConfigNodesMovements(), ns3::LteEnbPhy::DeleteUePhy(), ns3::MacStatsCalculator::DlScheduling(), ns3::LteEnbMac::DoAddLc(), ns3::PfFfMacScheduler::DoCschedLcConfigReq(), ns3::SubscriberStationNetDevice::DoReceive(), ns3::LteUeMac::DoReceiveIdealControlMessage(), ns3::Resolver::DoResolve(), ns3::RrFfMacScheduler::DoSchedDlCqiInfoReq(), ns3::PfFfMacScheduler::DoSchedDlCqiInfoReq(), ns3::RrFfMacScheduler::DoSchedDlTriggerReq(), ns3::RrFfMacScheduler::DoSchedUlTriggerReq(), ns3::PfFfMacScheduler::DoSchedUlTriggerReq(), ns3::UdpSocketImpl::DoSendTo(), ns3::SqliteDataOutput::Exec(), ns3::RadioBearerStatsCalculator::GetDlDelay(), ns3::LteSpectrumValueHelper::GetDownlinkCarrierFrequency(), ns3::ItuR1238PropagationLossModel::GetLoss(), ns3::Ipv4NixVectorRouting::GetNixVector(), ns3::Ipv4NixVectorRouting::GetNodeByIp(), ns3::RadioBearerStatsCalculator::GetUlDelay(), ns3::LteSpectrumValueHelper::GetUplinkCarrierFrequency(), main(), ns3::SqliteDataOutput::Output(), PrintGnuplottableBuildingListToFile(), PrintGnuplottableEnbListToFile(), PrintGnuplottableUeListToFile(), ns3::aodv::RoutingProtocol::RouteInput(), ns3::dsdv::RoutingProtocol::RouteInput(), ns3::Ipv4NixVectorRouting::RouteOutput(), ns3::TcpL4Protocol::Send(), ns3::Ipv4L3Protocol::Send(), ns3::TcpL4Protocol::SendPacket(), ns3::TcpSocketBase::SetupEndpoint(), ns3::TcpSocketBase::SetupEndpoint6(), ns3::RadioBearerStatsCalculator::ShowResults(), ns3::LteEnbPhy::StartSubFrame(), ns3::CsmaChannel::TransmitEnd(), ns3::CsmaChannel::TransmitStart(), ns3::MacStatsCalculator::UlScheduling(), ns3::PfFfMacScheduler::UpdateDlRlcBufferInfo(), ns3::RrFfMacScheduler::UpdateUlRlcBufferInfo(), and ns3::PfFfMacScheduler::UpdateUlRlcBufferInfo().

#define NS_LOG_FUNCTION ( parameters )

Value:

do                                                            \
    {                                                           \
      if (g_log.IsEnabled (ns3::LOG_FUNCTION))                  \
        {                                                       \
          NS_LOG_APPEND_TIME_PREFIX;                            \
          NS_LOG_APPEND_NODE_PREFIX;                            \
          NS_LOG_APPEND_CONTEXT;                                \
          std::clog << g_log.Name () << ":"                     \
                    << __FUNCTION__ << "(";                     \
          ns3::ParameterLogger (std::clog) << parameters;      \
          std::clog << ")" << std::endl;                        \
        }                                                       \
    }                                                           \
  while (false)

Parameters

parameters the parameters to output.

If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ", ".

Typical usage looks like:

NS_LOG_FUNCTION (aNumber<<anotherNumber);

And the output will look like:

Component:Function (aNumber, anotherNumber)

To facilitate function tracing, most functions should begin with (at least) NS_LOG_FUNCTION(this). Static functions should use NS_LOG_FUNCTION_NOARGS() instead.

Definition at line 300 of file log.h.

#define NS_LOG_FUNCTION_NOARGS ( )

Value:

do                                                            \
    {                                                           \
      if (g_log.IsEnabled (ns3::LOG_FUNCTION))                  \
        {                                                       \
          NS_LOG_APPEND_TIME_PREFIX;                            \
          NS_LOG_APPEND_NODE_PREFIX;                            \
          NS_LOG_APPEND_CONTEXT;                                \
          std::clog << g_log.Name () << ":"                     \
                    << __FUNCTION__ << "()" << std::endl;       \
        }                                                       \
    }                                                           \
  while (false)

Output the name of the function.

This should be used only in static functions; most member functions should instead use NS_LOG_FUNCTION().

Definition at line 264 of file log.h.

#define NS_LOG_INFO ( msg ) NS_LOG (ns3::LOG_INFO, msg)

Parameters

msg	the message to log

Use NS_LOG to output a message of level LOG_INFO.

Definition at line 253 of file log.h.

#define NS_LOG_LOGIC ( msg ) NS_LOG (ns3::LOG_LOGIC, msg)

Parameters

msg	the message to log

Use NS_LOG to output a message of level LOG_LOGIC

Definition at line 323 of file log.h.

#define NS_LOG_UNCOND ( msg )

Value:

do                                    \
    {                                   \
      std::clog << msg << std::endl;    \
    }                                   \
  while (false)

Parameters

msg	the message to log

Output the requested message unconditionaly.

Definition at line 332 of file log.h.

Referenced by background_function(), first_function(), inserted_function(), main(), PingRtt(), WifiInterferenceTestCase::PrintEndSync(), ReceivePacket(), WifiInterferenceTestCase::ReceivePacket(), DsdvManetExample::ReceivePacket(), ns3::WifiModeFactory::Search(), and ns3::AnimationInterface::UpdatePosition().

#define NS_LOG_WARN ( msg ) NS_LOG (ns3::LOG_WARN, msg)

Parameters

msg	the message to log

Use NS_LOG to output a message of level LOG_WARN.

Definition at line 235 of file log.h.

Function Documentation

void ns3::LogComponentDisable	(	char const *	name,
		enum LogLevel	level
	)

Parameters

name	a log component name
level	a logging level

Disable the logging output associated with that log component. The logging output can be later re-enabled with a call to ns3::LogComponentEnable.

Definition at line 297 of file log.cc.

References ns3::GetComponentList().

Here is the call graph for this function:

void ns3::LogComponentDisableAll ( enum LogLevel level )

Parameters

level a logging level

Disable all logging for all components.

Definition at line 313 of file log.cc.

References ns3::GetComponentList().

Referenced by ns3::LenaMimoTestCase::DoRun(), ns3::LenaPhyErrorModelTestCase::DoRun(), ns3::LenaRrFfMacSchedulerTestCase::DoRun(), and ns3::LenaPfFfMacSchedulerTestCase1::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::LogComponentEnable	(	char const *	name,
		enum LogLevel	level
	)

Parameters

name	a log component name
level	a logging level

Enable the logging output associated with that log component. The logging output can be later disabled with a call to ns3::LogComponentDisable.

Same as running your program with the NS_LOG environment variable set as NS_LOG='name=level'

Definition at line 261 of file log.cc.

References ns3::GetComponentList(), ns3::LogComponentPrintList(), and NS_FATAL_ERROR.

Referenced by ns3::BuildingsPathlossTestSuite::BuildingsPathlossTestSuite(), ns3::BuildingsShadowingTestSuite::BuildingsShadowingTestSuite(), ns3::LenaMimoTestCase::DoRun(), ns3::LenaPhyErrorModelTestCase::DoRun(), ns3::LenaRrFfMacSchedulerTestCase::DoRun(), ns3::EpsGtpuHeaderTestCase::DoRun(), ns3::LenaPfFfMacSchedulerTestCase1::DoRun(), ns3::LteFadingTestCase::DoRun(), ns3::LtePathlossModelSystemTestCase::DoRun(), Ns3TcpLossTestCase::DoRun(), Ns3TcpStateTestCase::DoRun(), ns3::LenaPfFfMacSchedulerTestCase2::DoRun(), ns3::LteSimpleHelper::EnableLogComponents(), ns3::WifiHelper::EnableLogComponents(), ns3::LteHelper::EnableLogComponents(), ns3::WimaxHelper::EnableLogComponents(), ns3::ItuR1411LosPropagationLossModelTestSuite::ItuR1411LosPropagationLossModelTestSuite(), ns3::ItuR1411NlosOverRooftopPropagationLossModelTestSuite::ItuR1411NlosOverRooftopPropagationLossModelTestSuite(), ns3::Kun2600MhzPropagationLossModelTestSuite::Kun2600MhzPropagationLossModelTestSuite(), ns3::LteFadingTestSuite::LteFadingTestSuite(), main(), and ns3::OkumuraHataPropagationLossModelTestSuite::OkumuraHataPropagationLossModelTestSuite().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::LogComponentEnableAll ( enum LogLevel level )

Parameters

level a logging level

Enable the logging output for all registered log components.

Same as running your program with the NS_LOG environment variable set as NS_LOG='*=level'

Definition at line 285 of file log.cc.

References ns3::GetComponentList().

Referenced by Ns3TcpLossTestCase::DoRun(), and Ns3TcpStateTestCase::DoRun().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::LogComponentPrintList ( void )

Print the list of logging messages available. Same as running your program with the NS_LOG environment variable set as NS_LOG=print-list

Definition at line 325 of file log.cc.

References ns3::GetComponentList(), ns3::LOG_ALL, ns3::LOG_DEBUG, ns3::LOG_ERROR, ns3::LOG_FUNCTION, ns3::LOG_INFO, ns3::LOG_LOGIC, and ns3::LOG_WARN.

Referenced by ns3::CheckEnvironmentVariables(), ns3::LogComponentEnable(), and ns3::PrintList::PrintList().

Here is the call graph for this function:

Here is the caller graph for this function:

Macros

Functions

Detailed Description

Macro Definition Documentation

Function Documentation