/usr/include/ns3.27/ns3/log-macros-enabled.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2006,2007 INRIA
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
*/
#ifndef NS3_LOG_MACROS_ENABLED_H
#define NS3_LOG_MACROS_ENABLED_H
/**
* \file
* \ingroup logging
* NS_LOG and related logging macro definitions.
*/
#ifdef NS3_LOG_ENABLE
/**
* \ingroup logging
* Append the simulation time to a log message.
* \internal
* Logging implementation macro; should not be called directly.
*/
#define NS_LOG_APPEND_TIME_PREFIX \
if (g_log.IsEnabled (ns3::LOG_PREFIX_TIME)) \
{ \
ns3::LogTimePrinter printer = ns3::LogGetTimePrinter (); \
if (printer != 0) \
{ \
(*printer)(std::clog); \
std::clog << " "; \
} \
}
/**
* \ingroup logging
* Append the simulation node id to a log message.
* \internal
* Logging implementation macro; should not be called directly.
*/
#define NS_LOG_APPEND_NODE_PREFIX \
if (g_log.IsEnabled (ns3::LOG_PREFIX_NODE)) \
{ \
ns3::LogNodePrinter printer = ns3::LogGetNodePrinter (); \
if (printer != 0) \
{ \
(*printer)(std::clog); \
std::clog << " "; \
} \
}
/**
* \ingroup logging
* Append the function name to a log message.
* \internal
* Logging implementation macro; should not be called directly.
*/
#define NS_LOG_APPEND_FUNC_PREFIX \
if (g_log.IsEnabled (ns3::LOG_PREFIX_FUNC)) \
{ \
std::clog << g_log.Name () << ":" << \
__FUNCTION__ << "(): "; \
} \
/**
* \ingroup logging
* Append the log severity level to a log message.
* \internal
* Logging implementation macro; should not be called directly.
*/
#define NS_LOG_APPEND_LEVEL_PREFIX(level) \
if (g_log.IsEnabled (ns3::LOG_PREFIX_LEVEL)) \
{ \
std::clog << "[" << g_log.GetLevelLabel (level) << "] "; \
} \
#ifndef NS_LOG_APPEND_CONTEXT
/**
* \ingroup logging
* Append the node id (or other file-local programmatic context, such as
* MPI rank) to a log message.
*
* This is implemented locally in `.cc` files because
* the relevant variable is only known there.
*
* Preferred format is something like (assuming the node id is
* accessible from `var`:
* \code
* if (var)
* {
* std::clog << "[node " << var->GetObject<Node> ()->GetId () << "] ";
* }
* \endcode
*/
#define NS_LOG_APPEND_CONTEXT
#endif /* NS_LOG_APPEND_CONTEXT */
#ifndef NS_LOG_CONDITION
/**
* \ingroup logging
* Limit logging output based on some file-local condition,
* such as MPI rank.
*
* This is implemented locally in `.cc` files because
* the relevant condition variable is only known there.
*
* Since this appears immediately before the `do { ... } while false`
* construct of \c NS_LOG(level, msg), it must have the form
* \code
* #define NS_LOG_CONDITION if (condition)
* \endcode
*/
#define NS_LOG_CONDITION
#endif
/**
* \ingroup logging
*
* 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:
* \code
* NS_LOG (LOG_DEBUG, "a number="<<aNumber<<", anotherNumber="<<anotherNumber);
* \endcode
*
* \param [in] level The log level
* \param [in] msg The message to log
* \internal
* Logging implementation macro; should not be called directly.
*/
#define NS_LOG(level, msg) \
NS_LOG_CONDITION \
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; \
NS_LOG_APPEND_LEVEL_PREFIX (level); \
std::clog << msg << std::endl; \
} \
} \
while (false)
/**
* \ingroup logging
*
* Output the name of the function.
*
* This should be used only in static functions; most member functions
* should instead use NS_LOG_FUNCTION().
*/
#define NS_LOG_FUNCTION_NOARGS() \
NS_LOG_CONDITION \
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)
/**
* \ingroup logging
*
* If log level LOG_FUNCTION is enabled, this macro will output
* all input parameters separated by ", ".
*
* Typical usage looks like:
* \code
* NS_LOG_FUNCTION (aNumber<<anotherNumber);
* \endcode
* And the output will look like:
* \code
* Component:Function (aNumber, anotherNumber)
* \endcode
*
* To facilitate function tracing, most functions should begin with
* (at least) NS_LOG_FUNCTION(this). Static functions should use
* NS_LOG_FUNCTION_NOARGS() instead.
*
* \param [in] parameters The parameters to output.
*/
#define NS_LOG_FUNCTION(parameters) \
NS_LOG_CONDITION \
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)
/**
* \ingroup logging
*
* Output the requested message unconditionaly.
*
* \param [in] msg The message to log
*/
#define NS_LOG_UNCOND(msg) \
NS_LOG_CONDITION \
do \
{ \
std::clog << msg << std::endl; \
} \
while (false)
#endif /* NS3_LOG_ENABLE */
#endif /* NS3_LOG_MACROS_ENABLED_H */
|