介绍
NS3提供了功能强大的日志系统，利用日志我们可以方便的使用、调试NS3代码。并且NS3的日志系统使用起来也非常方便。
日志使用
日志定义
日志定义之后才能使用，日志定义很简单，一行代码：
NS_LOG_COMPONENT_DEFINE ("DcaTxop");
NS_LOG_COMPONENT_DEFINE ("AdhocWifiMac");
...
这些代码用在源文件代码中，第一行代码存在dca-txop.cc文件开头部分，第二行代码存在adhoc-wifi-mac.cc文件开头部分。
仔细观察，在各个模块的model下的源文件下，都会有NS_LOG_COMPONENT_DEFINE 的代码使用。
这一行代码功能：
定义了日志的名字，并且这个名字不能重复，否则出错！
这一行代码位置：
/core/model/log.h
日志记录
日志记录有一批日志函数可以使用，如：
第一批：
NS_LOG_ERROR(msg);
NS_LOG_WARN(msg);
NS_LOG_DEBUG(msg);
NS_LOG_INFO(msg);
NS_LOG_LOGIC(msg);
第二批：
NS_LOG_FUNCTION_NOARGS();
NS_LOG_FUNCTION(parameters);
NS_LOG_UNCOND(msg);
功能：
记录运行信息，或调试信息输出到控制台
函数位置：
第一批位置在/core/model/log.cc
第二批位置在/core/model/log-macros-enabled.h
用法：
非常简单，例如：
void
AdhocWifiMac::Receive (Ptr packet, const WifiMacHeader *hdr)
{
NS_LOG_FUNCTION (this << packet << hdr);
NS_ASSERT (!hdr->IsCtl ());
if (hdr->IsData ())
{
if (hdr->IsQosData () && hdr->IsQosAmsdu ())
{
NS_LOG_DEBUG ("Received A-MSDU from" << from);
}
else
{
ForwardUp (packet, from, to);
}
return;
}
RegularWifiMac::Receive (packet, hdr);
}
去除了一些代码，使用上面的代码即可完成日志信息的输出，方便调试。
日志使用
这一步的使用是关键，上面的日志定义和日志记录，都只是调用了日志函数，只有再使用下面的代码，才能使日志真正起作用：
void LogComponentEnable (char const *name, enum LogLevel level);
void LogComponentEnableAll (enum LogLevel level);
void LogComponentDisable (char const *name, enum LogLevel level);
void LogComponentDisableAll (enum LogLevel level);
功能：
第一个函数使指定的name日志，在指定的日志级别level上输出，不指定的级别不输出。
第二个函数使全部使用到的日志，在指定的日志级别level上输出。
第三个和第四个是对应的日志禁止输出。
日志级别有：
enum LogLevel {
LOG_NONE = 0x00000000, //!< No logging.
LOG_ERROR = 0x00000001, //!< Serious error messages only.
LOG_LEVEL_ERROR = 0x00000001, //!< LOG_ERROR and above.
LOG_WARN = 0x00000002, //!< Warning messages.
LOG_LEVEL_WARN = 0x00000003, //!< LOG_WARN and above.
LOG_DEBUG = 0x00000004, //!< Rare ad-hoc debug messages.
LOG_LEVEL_DEBUG = 0x00000007, //!< LOG_DEBUG and above.
LOG_INFO = 0x00000008, //!< Informational messages (e.g., banners).
LOG_LEVEL_INFO = 0x0000000f, //!< LOG_INFO and above.
LOG_FUNCTION = 0x00000010, //!< Function tracing.
LOG_LEVEL_FUNCTION = 0x0000001f, //!< LOG_FUNCTION and above.
LOG_LOGIC = 0x00000020, //!< Control flow tracing within functions.
LOG_LEVEL_LOGIC = 0x0000003f, //!< LOG_LOGIC and above.
LOG_ALL = 0x0fffffff, //!< Print everything.
LOG_LEVEL_ALL = LOG_ALL, //!< Print everything.
LOG_PREFIX_FUNC = 0x80000000, //!< Prefix all trace prints with function.
LOG_PREFIX_TIME = 0x40000000, //!< Prefix all trace prints with simulation time.
LOG_PREFIX_NODE = 0x20000000, //!< Prefix all trace prints with simulation node.
LOG_PREFIX_LEVEL = 0x10000000, //!< Prefix all trace prints with log level (severity).
LOG_PREFIX_ALL = 0xf0000000 //!< All prefixes.
};
代码位置：
/core/model/log.h
用法：
//第一种用方法：
LogComponentEnable ("DcaTxop", LOG_LEVEL_ALL);
LogComponentEnable ("AdhocWifiMac", LOG_LEVEL_ALL);
//第二种用法，加前缀：
ns3::LogLevel level = (enum ns3::LogLevel)(LOG_LEVEL_ALL|LOG_PREFIX_NODE);
LogComponentEnable ("AdhocWifiMac",level);
这里可以加的前缀有：
LOG_PREFIX_FUNC = 0x80000000, //!< Prefix all trace prints with function.
LOG_PREFIX_TIME = 0x40000000, //!< Prefix all trace prints with simulation time.
LOG_PREFIX_NODE = 0x20000000, //!< Prefix all trace prints with simulation node.
LOG_PREFIX_LEVEL = 0x10000000, //!< Prefix all trace prints with log level (severity).
LOG_PREFIX_ALL = 0xf0000000 //!< All prefixes.
//代码位置：/core/model/log.h
LOG_PREFIX_ALL 可把时间、函数、节点ID、日志级别这些都加做前缀，在日志的输出字符串前面。
用法总结
第一步：
在源文件中使用如下代码定义唯一的日志名字：
NS_LOG_COMPONENT_DEFINE ("DcaTxop");
第二步：
在自己写的代码中（通常是在example目录下），使用如下代码使用上面定义的日志名字，启动日志：
LogComponentEnable ("DcaTxop", LOG_LEVEL_ALL);
第三步：
在源文件中，函数体内，使用合适的日志记录函数，输出一些必要的调试信息，掌握代码的流程：
NS_LOG_FUNCTION (this << packet << hdr);
NS_LOG_DEBUG(this << packet << hdr);
...
简单示例
#include "ns3/command-line.h"
#include "ns3/simulator.h"
#include "ns3/realtime-simulator-impl.h"
#include "ns3/nstime.h"
#include "ns3/log.h"
#include "ns3/system-thread.h"
#include "ns3/string.h"
#include "ns3/config.h"
#include "ns3/global-value.h"
#include "ns3/ptr.h"
#include
#include
using namespace ns3;
NS_LOG_COMPONENT_DEFINE ("TestSync");
void
inserted_function (void)
{
NS_LOG_UNCOND ("inserted_function() called at " <<
Simulator::Now ().GetSeconds () << " s");
}
void
background_function (void)
{
NS_LOG_UNCOND ("background_function() called at " <<
Simulator::Now ().GetSeconds () << " s");
}
void
first_function (void)
{
NS_LOG_UNCOND ("first_function() called at " <<
Simulator::Now ().GetSeconds () << " s");
}
class FakeNetDevice
{
public:
/** Constructor. */
FakeNetDevice ();
/** The thread entry point. */
void Doit3 (void);
};
FakeNetDevice::FakeNetDevice ()
{
NS_LOG_FUNCTION_NOARGS ();
}
void
FakeNetDevice::Doit3 (void)
{
NS_LOG_FUNCTION_NOARGS ();
sleep (1);
}
int
main (int argc, char *argv[])
{
CommandLine cmd;
cmd.Parse (argc, argv);
LogComponentEnable("TestSync", LOG_LEVEL_ALL);
// while (true)
{
test ();
}
}
这个代码仅仅示意用法。