Files
@ d6b9b2ac5869
Branch filter:
Location: vmkdrivers/BLD/build/HEADERS/vmkapi-current-all-public-bincomp/vmkernel64/release/base/vmkapi_logging.h
d6b9b2ac5869
19.7 KiB
text/x-chdr
ESXi-5.5-U2
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 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 | /* **********************************************************
* Copyright 2007 - 2009 VMware, Inc. All rights reserved.
* **********************************************************/
/*
* @VMKAPIMOD_LICENSE@
*/
/*
***********************************************************************
* Logging */ /**
* \addtogroup Core
* @{
* \defgroup Logging Kernel Logging
*
* The logging interfaces provide a means of writing informational
* and error messages to the kernel's logs.
*
* @{
***********************************************************************
*/
#ifndef _VMKAPI_LOGGING_H_
#define _VMKAPI_LOGGING_H_
/** \cond never */
#ifndef VMK_HEADER_INCLUDED_FROM_VMKAPI_H
#error This vmkapi file should never be included directly but only via vmkapi.h
#endif
/** \endcond never */
#include <stdarg.h>
/** \brief Opaque log component handle. */
typedef struct vmk_LogComponentInt *vmk_LogComponent;
/** \brief Log handle guaranteed to be invalid. */
#define VMK_INVALID_LOG_HANDLE NULL
/** \brief Log urgency level. */
typedef enum {
VMK_LOG_URGENCY_DEBUG,
VMK_LOG_URGENCY_NORMAL,
VMK_LOG_URGENCY_WARNING,
VMK_LOG_URGENCY_ALERT
} vmk_LogUrgency ;
/** \brief Types of log throttling */
typedef enum {
/** Log is not throttled. All messages will be logged. */
VMK_LOG_THROTTLE_NONE=0,
/**
* An internal message count will be kept and messages will
* only be logged as the count reaches certain wider-spaced values.
*/
VMK_LOG_THROTTLE_COUNT=1,
/**
* Messages will be logged depending on the return value
* of a custom log throttling function.
*/
VMK_LOG_THROTTLE_CUSTOM=2,
} vmk_LogThrottleType;
/*
***********************************************************************
* vmk_LogThrottleFunc -- */ /**
*
* \brief Custom throttling function for a log component.
*
* \note This callback is not allowed to block.
*
* A log throttling function will be called each time an attempt to
* log a message to a log component is made. If this function returns
* VMK_TRUE, the message will be logged. Otherwise, the message will
* not be logged.
*
* \param[in] arg Private data argument
*
* \return Whether or not the logger should log the current log message.
* \retval VMK_TRUE Log the current message.
* \retval VMK_FALSE Do not log the current message.
*
***********************************************************************
*/
typedef vmk_Bool (*vmk_LogThrottleFunc)(void *arg);
/**
* \brief Properties that define the type of throttling for
* a particular log component.
*/
typedef struct vmk_LogThrottleProperties {
/** Type of log throttling to use. */
vmk_LogThrottleType type;
/** Properties for the specified log throttling type. */
union {
/** Properties for a custom log throttler. */
struct {
/**
* Throttling function to call on each message submitted to the
* log component.
*/
vmk_LogThrottleFunc throttler;
/**
* Private data argument to pass to the log throttling function
* on each call.
*/
void *arg;
} custom;
} info;
} vmk_LogThrottleProperties;
/**
* \brief Properties that define a logging component.
*/
typedef struct vmk_LogProperties {
/** Name of the log component. */
vmk_Name name;
/** Module that owns the logging component. */
vmk_ModuleID module;
/** Heap to allocate the component and any other tracking information. */
vmk_HeapID heap;
/** Default log level. */
vmk_int32 defaultLevel;
/**
* Throttling properties for the new component or NULL if no throttling
* is required.
*/
const vmk_LogThrottleProperties *throttle;
} vmk_LogProperties;
/*
***********************************************************************
* vmk_StatusToString -- */ /**
*
* \brief Convert a status into a human readable text string
*
* \note This function will not block.
*
* \note The strings returned from this function for a particular
* status can change across releases regardless of binary
* compatibility. Do not rely on specific string contents.
* These are only intended to be used for display in logging.
*
* \param[in] status Return status code to convert to a
* human-readable string.
*
* \return Human-readable string that describes the supplied status.
*
***********************************************************************
*/
const char *vmk_StatusToString(
VMK_ReturnStatus status);
/*
***********************************************************************
* vmk_LogRegister -- */ /**
*
* \brief Register a log component
*
* \note This function will not block.
*
* \param[in] props Properties for the new logging component.
* \param[out] handle Handle to the newly created log component.
*
* \retval VMK_BAD_PARAM Bad LogThrottleType specified in
* the throttle properties.
* \retval VMK_NO_MEMORY Not enough memory on the heap or
* to create the new logging component.
* \retval VMK_INVALID_MODULE Supplied module ID is invalid.
* \retval VMK_EXISTS A log component with the same name has
* already been registered.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_LogRegister(
const vmk_LogProperties *props,
vmk_LogComponent *handle);
/*
***********************************************************************
* vmk_LogUnregister -- */ /**
*
* \brief Unregister a log component
*
* \note This function will not block.
*
* Should be used to unregister an existing logging component
*
* \note Should be called before the module heap is destroyed.
*
* \param[in] handle Pointer to handle for log component to be
* unregistered.
*
* \retval VMK_NOT_FOUND Supplied log component is invalid/unregisterd.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_LogUnregister(
vmk_LogComponent handle);
/*
***********************************************************************
* vmk_LogHeapAllocSize -- */ /**
*
* \brief Amount of heap space needed per registered log component
*
* \note This function will not block.
*
* \retval Number of bytes to set aside in a heap per log component
*
***********************************************************************
*/
vmk_ByteCount vmk_LogHeapAllocSize(void);
/*
***********************************************************************
* vmk_LogGetName -- */ /**
*
* \brief Get log component name as a printable string.
*
* \note This function will not block.
*
* \param[in] handle Log component handle.
*
* \return The name associated with the supplied log component handle
* as a printable string.
*
***********************************************************************
*/
const char * vmk_LogGetName(
vmk_LogComponent handle);
/*
***********************************************************************
* vmk_LogGetCurrentLogLevel -- */ /**
*
* \brief Get current log level of the given component
*
* \note This function will not block.
*
* \param[in] handle Log component handle.
*
* \return Current log level of the given component returned.
*
***********************************************************************
*/
vmk_int32 vmk_LogGetCurrentLogLevel(
vmk_LogComponent handle);
/*
***********************************************************************
* vmk_LogDebug -- */ /**
*
* \brief Log a message to a logging component on debug builds only.
*
* Should be used to log information messages and non-error conditions.
*
* Messages are logged only if the component's log level is greater
* than or equal to the minimum log level specified.
*
* \printformatstringdoc
* \note This function will not block.
*
* \param[in] handle Log component handle,
* \param[in] min Minimum log level required to print the message,
* \param[in] fmt Format string,
* \param[in] args List of message arguments,
*
***********************************************************************
*/
#ifndef VMX86_LOG
#define vmk_LogDebug(handle, min, fmt, args...)
#else
#define vmk_LogDebug(handle, min, fmt, args...) \
vmk_LogLevel(VMK_LOG_URGENCY_DEBUG, handle, min, \
"%s: %s:%d: " fmt "\n", vmk_LogGetName(handle), \
__FUNCTION__, __LINE__, ##args)
#endif
/*
***********************************************************************
* vmk_Log -- */ /**
*
* \brief Log message to a logging component at its current log level.
*
* Should be used to log information messages and non-error conditions.
*
* \printformatstringdoc
* \note This function will not block.
*
* \param[in] handle Log component handle.
* \param[in] fmt Format string.
* \param[in] args List of message arguments.
*
***********************************************************************
*/
#define vmk_Log(handle, fmt, args...) \
vmk_LogLevel(VMK_LOG_URGENCY_NORMAL, \
handle, vmk_LogGetCurrentLogLevel(handle), \
"%s: %s:%d: " fmt "\n", vmk_LogGetName(handle), \
__FUNCTION__, __LINE__, ##args)
/*
***********************************************************************
* vmk_Warning -- */ /**
*
* \brief Log a warning message to a logging component at its current
* log level.
*
* Should be used to log abnormal conditions.
*
* \printformatstringdoc
* \note This function will not block.
*
* \param[in] handle Log component handle.
* \param[in] fmt Format string.
* \param[in] args List of message arguments.
*
***********************************************************************
*/
#define vmk_Warning(handle, fmt, args...) \
vmk_LogLevel(VMK_LOG_URGENCY_WARNING, \
handle, vmk_LogGetCurrentLogLevel(handle), \
"%s: %s:%d: " fmt "\n", vmk_LogGetName(handle), \
__FUNCTION__, __LINE__, ##args)
/*
***********************************************************************
* vmk_Alert -- */ /**
*
* \brief Log an alert message to a logging component at its current
* log level.
*
* Should be used to notify users of system alerts.
*
* \printformatstringdoc
* \note This function will not block.
*
* \param[in] handle Log component handle.
* \param[in] fmt Format string.
* \param[in] args List of message arguments.
*
***********************************************************************
*/
#define vmk_Alert(handle, fmt, args...) \
vmk_LogLevel(VMK_LOG_URGENCY_ALERT, \
handle, vmk_LogGetCurrentLogLevel(handle), \
"%s: %s:%d: " fmt "\n", vmk_LogGetName(handle), \
__FUNCTION__, __LINE__, ##args)
/*
***********************************************************************
* vmk_LogDebugMessage -- */ /**
*
* \brief Log an information message to the vmkernel log unconditionally
* on debug builds only.
*
* Should be used to log information messages and non-error conditions
* when no log component is available.
*
* \printformatstringdoc
* \note This function will not block.
*
* \param[in] fmt Format string.
* \param[in] args List of message arguments.
*
***********************************************************************
*/
#ifndef VMX86_LOG
#define vmk_LogDebugMessage(fmt, args...)
#else
#define vmk_LogDebugMessage(fmt, args...) \
vmk_LogNoLevel(VMK_LOG_URGENCY_NORMAL, fmt "\n", ##args)
#endif
/*
***********************************************************************
* vmk_LogMessage -- */ /**
*
* \brief Log an information message to the vmkernel log unconditionally.
*
* Should be used to log information messages and non-error conditions
* when no log component is available.
*
* \printformatstringdoc
* \note This function will not block.
*
* \param[in] fmt Format string.
* \param[in] args List of message arguments.
*
***********************************************************************
*/
#define vmk_LogMessage(fmt, args...) \
vmk_LogNoLevel(VMK_LOG_URGENCY_NORMAL, fmt "\n", ##args)
/*
***********************************************************************
* vmk_WarningMessage -- */ /**
*
* \brief Log a warning or error message to the vmkernel log
* unconditionally.
*
* Should be used to log abnormal conditions when no log component is
* available.
*
* \printformatstringdoc
* \note This function will not block.
*
* \param[in] fmt Format string.
* \param[in] args List of message arguments.
*
***********************************************************************
*/
#define vmk_WarningMessage(fmt, args...) \
vmk_LogNoLevel(VMK_LOG_URGENCY_WARNING, fmt "\n", ##args)
/*
***********************************************************************
* vmk_AlertMessage -- */ /**
*
* \brief Log a system alert to the vmkernel log and the console
* unconditionally.
*
* Should be used to log severe problems when no log component is
* available.
*
* \printformatstringdoc
* \note This function will not block.
*
* \param[in] fmt Format string.
* \param[in] args List of message arguments.
*
***********************************************************************
*/
#define vmk_AlertMessage(fmt, args...) \
vmk_LogNoLevel(VMK_LOG_URGENCY_ALERT, fmt "\n", ##args)
/*
***********************************************************************
* vmk_LogSetCurrentLogLevel -- */ /**
*
* \brief Set current log level of a given log component
*
* \note This function will not block.
*
* \param[in] handle Log component handle to modify.
* \param[in] level Log level to set component to.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_LogSetCurrentLogLevel(
vmk_LogComponent handle,
vmk_int32 level);
/*
***********************************************************************
* vmk_vLogLevel -- */ /**
*
* \brief Log a message using a log component
*
* \printformatstringdoc
* \note This function will not block.
*
* Output a log message to the vmkernel log if the current log level
* on the given log component is equal to or greater than the given
* log level.
*
* \param[in] urgency How urgent the message is.
* \param[in] handle Log component handle.
* \param[in] level Minimum log level the component must be set to
* in order to print the message.
* \param[in] fmt Format string.
* \param[in] ap List of message arguments.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_vLogLevel(
vmk_LogUrgency urgency,
vmk_LogComponent handle,
vmk_int32 level,
const char *fmt,
va_list ap);
/*
***********************************************************************
* vmk_LogLevel -- */ /**
*
* \brief Log a message using a log component
*
* \printformatstringdoc
* \note This function will not block.
*
* Output a log message to the vmkernel log if the current log level
* on the given log component is equal to or greater than the given
* log level.
*
*
* \param[in] urgency How urgent the message is.
* \param[in] handle Log component handle.
* \param[in] level Minimum log level the component must be set to
* in order to print the message.
* \param[in] fmt Format string.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_LogLevel(
vmk_LogUrgency urgency,
vmk_LogComponent handle,
vmk_int32 level,
const char *fmt,
...)
VMK_ATTRIBUTE_PRINTF(4,5);
/*
***********************************************************************
* vmk_vLogNoLevel -- */ /**
*
* \brief Log an information message to the vmkernel log
* unconditionally with a va_list.
*
* \printformatstringdoc
* \note This function will not block.
*
* Should be used to log information messages and non-error conditions
* when no log component is available.
*
* \param[in] urgency How urgent the message is.
* \param[in] fmt Format string.
* \param[in] ap List of message arguments.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_vLogNoLevel(
vmk_LogUrgency urgency,
const char *fmt,
va_list ap);
/*
***********************************************************************
* vmk_LogNoLevel -- */ /**
*
* \brief Log an information message to the vmkernel log
* unconditionally with variable arguments.
*
* \printformatstringdoc
* \note This function will not block.
*
* Should be used to log information messages and non-error conditions
* when no log component is available.
*
*
* \param[in] urgency How urgent the message is.
* \param[in] fmt Format string.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_LogNoLevel(
vmk_LogUrgency urgency,
const char *fmt,
...)
VMK_ATTRIBUTE_PRINTF(2,3);
/*
***********************************************************************
* vmk_LogFindLogComponentByName -- */ /**
*
* \brief Get a log component by the given log component name and
* the module ID.
*
* \note This function will not block.
*
* \param[in] id Module ID that registered the log component
* \param[in] name Log component name
* \param[out] handle Returns log component handle of the specified
* name and the module ID.
*
* \retval VMK_NOT_FOUND The given log component name does not exist.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_LogFindLogComponentByName(
vmk_ModuleID id,
const vmk_Name *name,
vmk_LogComponent *handle);
/*
***********************************************************************
* vmk_LogBacktrace -- */ /**
*
* \brief Write the current stack backtrace to a log component.
*
* \note This function will not block.
*
* This routine logs at the component's current logging level and
* at NORMAL urgency.
*
* \param[in] handle Log component to write the backtrace to.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_LogBacktrace(
vmk_LogComponent handle);
/*
***********************************************************************
* vmk_LogBacktraceMessage -- */ /**
*
* \brief Write the current stack backtrace to the vmkernel log.
*
* \note This function will not block.
*
* Should be used to log the backtrace when no logging component
* is available.
*
***********************************************************************
*/
VMK_ReturnStatus vmk_LogBacktraceMessage(void);
#endif /* _VMKAPI_LOGGING_H_ */
/** @} */
/** @} */
|