NS3 日志使用

介绍

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> 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 <unistd.h>
#include <sys/time.h>

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 ();
    }
}

这个代码仅仅示意用法。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,736评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,167评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,442评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,902评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,302评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,573评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,847评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,562评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,260评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,531评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,021评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,367评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,016评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,068评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,827评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,610评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,514评论 2 269

推荐阅读更多精彩内容