/usr/include/yuma/ncx/log.h is in libyuma-dev 2.9-1+b2.
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 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 | /*
* Copyright (c) 2008 - 2012, Andy Bierman, All Rights Reserved.
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
#ifndef _H_log
#define _H_log
/* FILE: log.h
*********************************************************************
* *
* P U R P O S E *
* *
*********************************************************************
Logging manager
*********************************************************************
* *
* C H A N G E H I S T O R Y *
* *
*********************************************************************
date init comment
----------------------------------------------------------------------
08-jan-06 abb begun
*/
#include <stdio.h>
#include <xmlstring.h>
#include "procdefs.h"
#include "status.h"
#ifdef __cplusplus
extern "C" {
#endif
/********************************************************************
* *
* C O N S T A N T S *
* *
*********************************************************************/
/* macros to check the debug level */
#define LOGERROR (log_get_debug_level() >= LOG_DEBUG_ERROR)
#define LOGWARN (log_get_debug_level() >= LOG_DEBUG_WARN)
#define LOGINFO (log_get_debug_level() >= LOG_DEBUG_INFO)
#define LOGDEBUG (log_get_debug_level() >= LOG_DEBUG_DEBUG)
#define LOGDEBUG2 (log_get_debug_level() >= LOG_DEBUG_DEBUG2)
#define LOGDEBUG3 (log_get_debug_level() >= LOG_DEBUG_DEBUG3)
#define LOGDEBUG4 (log_get_debug_level() >= LOG_DEBUG_DEBUG4)
#define LOG_DEBUG_STR_OFF (const xmlChar *)"off"
#define LOG_DEBUG_STR_ERROR (const xmlChar *)"error"
#define LOG_DEBUG_STR_WARN (const xmlChar *)"warn"
#define LOG_DEBUG_STR_INFO (const xmlChar *)"info"
#define LOG_DEBUG_STR_DEBUG (const xmlChar *)"debug"
#define LOG_DEBUG_STR_DEBUG2 (const xmlChar *)"debug2"
#define LOG_DEBUG_STR_DEBUG3 (const xmlChar *)"debug3"
#define LOG_DEBUG_STR_DEBUG4 (const xmlChar *)"debug4"
/********************************************************************
* *
* T Y P E S *
* *
*********************************************************************/
/* The debug level enumerations used in util/log.c */
typedef enum log_debug_t_ {
LOG_DEBUG_NONE, /* value not set or error */
LOG_DEBUG_OFF, /* logging turned off */
LOG_DEBUG_ERROR, /* fatal + internal errors only */
LOG_DEBUG_WARN, /* all errors + warnings */
LOG_DEBUG_INFO, /* all previous + user info trace */
LOG_DEBUG_DEBUG, /* debug level 1 */
LOG_DEBUG_DEBUG2, /* debug level 2 */
LOG_DEBUG_DEBUG3, /* debug level 3 */
LOG_DEBUG_DEBUG4 /* debug level 3 */
} log_debug_t;
/* logging function template to switch between
* log_stdout and log_write
*/
typedef void (*logfn_t) (const char *fstr, ...);
/********************************************************************
* *
* F U N C T I O N S *
* *
*********************************************************************/
/********************************************************************
* FUNCTION log_open
*
* Open a logfile for writing
* DO NOT use this function to send log entries to STDOUT
* Leave the logfile NULL instead.
*
* INPUTS:
* fname == full filespec string for logfile
* append == TRUE if the log should be appended
* == FALSE if it should be rewriten
* tstamps == TRUE if the datetime stamp should be generated
* at log-open and log-close time
* == FALSE if no open and close timestamps should be generated
*
* RETURNS:
* status
*********************************************************************/
extern status_t
log_open (const char *fname,
boolean append,
boolean tstamps);
/********************************************************************
* FUNCTION log_close
*
* Close the logfile
*
* RETURNS:
* none
*********************************************************************/
extern void
log_close (void);
/********************************************************************
* FUNCTION log_audit_open
*
* Open the audit logfile for writing
* DO NOT use this function to send log entries to STDOUT
* Leave the audit_logfile NULL instead.
*
* INPUTS:
* fname == full filespec string for audit logfile
* append == TRUE if the log should be appended
* == FALSE if it should be rewriten
* tstamps == TRUE if the datetime stamp should be generated
* at log-open and log-close time
* == FALSE if no open and close timestamps should be generated
*
* RETURNS:
* status
*********************************************************************/
extern status_t
log_audit_open (const char *fname,
boolean append,
boolean tstamps);
/********************************************************************
* FUNCTION log_audit_close
*
* Close the audit_logfile
*
* RETURNS:
* none
*********************************************************************/
extern void
log_audit_close (void);
/********************************************************************
* FUNCTION log_audit_is_open
*
* Check if the audit log is open
*
* RETURNS:
* TRUE if audit log is open; FALSE if not
*********************************************************************/
extern boolean
log_audit_is_open (void);
/********************************************************************
* FUNCTION log_alt_open
*
* Open an alternate logfile for writing
* DO NOT use this function to send log entries to STDOUT
* Leave the logfile NULL instead.
*
* INPUTS:
* fname == full filespec string for logfile
*
* RETURNS:
* status
*********************************************************************/
extern status_t
log_alt_open (const char *fname);
/********************************************************************
* FUNCTION log_alt_close
*
* Close the alternate logfile
*
* RETURNS:
* none
*********************************************************************/
extern void
log_alt_close (void);
/********************************************************************
* FUNCTION log_stdout
*
* Write lines of text to STDOUT, even if the logfile
* is open, unless the debug mode is set to NONE
* to indicate silent batch mode
*
* INPUTS:
* fstr == format string in printf format
* ... == any additional arguments for printf
*
*********************************************************************/
extern void
log_stdout (const char *fstr, ...);
/********************************************************************
* FUNCTION log_write
*
* Generate a log entry, regardless of log level
*
* INPUTS:
* fstr == format string in printf format
* ... == any additional arguments for printf
*
*********************************************************************/
extern void
log_write (const char *fstr, ...);
/********************************************************************
* FUNCTION log_audit_write
*
* Generate an audit log entry, regardless of log level
*
* INPUTS:
* fstr == format string in printf format
* ... == any additional arguments for printf
*
*********************************************************************/
extern void
log_audit_write (const char *fstr, ...);
/********************************************************************
* FUNCTION log_alt_write
*
* Write to the alternate log file
*
* INPUTS:
* fstr == format string in printf format
* ... == any additional arguments for fprintf
*
*********************************************************************/
extern void
log_alt_write (const char *fstr, ...);
/********************************************************************
* FUNCTION log_alt_indent
*
* Printf a newline to the alternate logfile,
* then the specified number of space chars
*
* INPUTS:
* indentcnt == number of indent chars, -1 == skip everything
*
*********************************************************************/
extern void
log_alt_indent (int32 indentcnt);
/********************************************************************
* FUNCTION log_error
*
* Generate a LOG_DEBUG_ERROR log entry
*
* INPUTS:
* fstr == format string in printf format
* ... == any additional arguments for printf
*
*********************************************************************/
extern void log_error (const char *fstr, ...);
/********************************************************************
* FUNCTION log_error
*
* Generate a LOG_DEBUG_ERROR log entry
*
* INPUTS:
* fstr == format string in printf format
* args == any additional arguments for printf
*
*********************************************************************/
extern void vlog_error (const char *fstr, va_list args );
/********************************************************************
* FUNCTION log_warn
*
* Generate LOG_DEBUG_WARN log output
*
* INPUTS:
* fstr == format string in printf format
* ... == any additional arguments for printf
*
*********************************************************************/
extern void
log_warn (const char *fstr, ...);
/********************************************************************
* FUNCTION log_info
*
* Generate a LOG_DEBUG_INFO log entry
*
* INPUTS:
* fstr == format string in printf format
* ... == any additional arguments for printf
*
*********************************************************************/
extern void
log_info (const char *fstr, ...);
/********************************************************************
* FUNCTION log_debug
*
* Generate a LOG_DEBUG_DEBUG log entry
*
* INPUTS:
* fstr == format string in printf format
* ... == any additional arguments for printf
*
*********************************************************************/
extern void
log_debug (const char *fstr, ...);
/********************************************************************
* FUNCTION log_debug2
*
* Generate LOG_DEBUG_DEBUG2 log trace output
*
* INPUTS:
* fstr == format string in printf format
* ... == any additional arguments for printf
*
*********************************************************************/
extern void
log_debug2 (const char *fstr, ...);
/********************************************************************
* FUNCTION log_debug3
*
* Generate LOG_DEBUG_DEBUG3 log trace output
*
* INPUTS:
* fstr == format string in printf format
* ... == any additional arguments for printf
*
*********************************************************************/
extern void
log_debug3 (const char *fstr, ...);
/********************************************************************
* FUNCTION log_debug4
*
* Generate LOG_DEBUG_DEBUG4 log trace output
*
* INPUTS:
* fstr == format string in printf format
* ... == any additional arguments for printf
*
*********************************************************************/
extern void
log_debug4 (const char *fstr, ...);
/********************************************************************
* FUNCTION log_noop
*
* Do not generate any log message NO-OP
* Used to set logfn_t to no-loggging option
*
* INPUTS:
* fstr == format string in printf format
* ... == any additional arguments for printf
*
*********************************************************************/
extern void
log_noop (const char *fstr, ...);
/********************************************************************
* FUNCTION log_set_debug_level
*
* Set the global debug filter threshold level
*
* INPUTS:
* dlevel == desired debug level
*
*********************************************************************/
extern void
log_set_debug_level (log_debug_t dlevel);
/********************************************************************
* FUNCTION log_get_debug_level
*
* Get the global debug filter threshold level
*
* RETURNS:
* the global debug level
*********************************************************************/
extern log_debug_t
log_get_debug_level (void);
/********************************************************************
* FUNCTION log_get_debug_level_enum
*
* Get the corresponding debug enum for the specified string
*
* INPUTS:
* str == string value to convert
*
* RETURNS:
* the corresponding enum for the specified debug level
*********************************************************************/
extern log_debug_t
log_get_debug_level_enum (const char *str);
/********************************************************************
* FUNCTION log_get_debug_level_string
*
* Get the corresponding string for the debug enum
*
* INPUTS:
* level == the enum for the specified debug level
*
* RETURNS:
* the string value for this enum
*********************************************************************/
extern const xmlChar *
log_get_debug_level_string (log_debug_t level);
/********************************************************************
* FUNCTION log_is_open
*
* Check if the logfile is active
*
* RETURNS:
* TRUE if logfile open, FALSE otherwise
*********************************************************************/
extern boolean
log_is_open (void);
/********************************************************************
* FUNCTION log_indent
*
* Printf a newline, then the specified number of chars
*
* INPUTS:
* indentcnt == number of indent chars, -1 == skip everything
*
*********************************************************************/
extern void
log_indent (int32 indentcnt);
/********************************************************************
* FUNCTION log_stdout_indent
*
* Printf a newline to stdout, then the specified number of chars
*
* INPUTS:
* indentcnt == number of indent chars, -1 == skip everything
*
*********************************************************************/
extern void
log_stdout_indent (int32 indentcnt);
/********************************************************************
* FUNCTION log_get_logfile
*
* Get the open logfile for direct output
* Needed by libtecla to write command line history
*
* RETURNS:
* pointer to open FILE if any
* NULL if no open logfile
*********************************************************************/
extern FILE *
log_get_logfile (void);
#ifdef __cplusplus
} /* end extern 'C' */
#endif
#endif /* _H_log */
|