DPDK: Data Plane Development Kit

18.02.0-rc0
rte_log.h File Reference
#include <stdint.h>
#include <stdio.h>
#include <stdarg.h>
#include <rte_common.h>

Go to the source code of this file.

Data Structures

struct  rte_logs

Macros

#define RTE_LOGTYPE_EAL   0
#define RTE_LOGTYPE_MALLOC   1
#define RTE_LOGTYPE_RING   2
#define RTE_LOGTYPE_MEMPOOL   3
#define RTE_LOGTYPE_TIMER   4
#define RTE_LOGTYPE_PMD   5
#define RTE_LOGTYPE_HASH   6
#define RTE_LOGTYPE_LPM   7
#define RTE_LOGTYPE_KNI   8
#define RTE_LOGTYPE_ACL   9
#define RTE_LOGTYPE_POWER   10
#define RTE_LOGTYPE_METER   11
#define RTE_LOGTYPE_SCHED   12
#define RTE_LOGTYPE_PORT   13
#define RTE_LOGTYPE_TABLE   14
#define RTE_LOGTYPE_PIPELINE   15
#define RTE_LOGTYPE_MBUF   16
#define RTE_LOGTYPE_CRYPTODEV   17
#define RTE_LOGTYPE_EFD   18
#define RTE_LOGTYPE_EVENTDEV   19
#define RTE_LOGTYPE_GSO   20
#define RTE_LOGTYPE_USER1   24
#define RTE_LOGTYPE_USER2   25
#define RTE_LOGTYPE_USER3   26
#define RTE_LOGTYPE_USER4   27
#define RTE_LOGTYPE_USER5   28
#define RTE_LOGTYPE_USER6   29
#define RTE_LOGTYPE_USER7   30
#define RTE_LOGTYPE_USER8   31
#define RTE_LOGTYPE_FIRST_EXT_ID   32
#define RTE_LOG_EMERG   1U
#define RTE_LOG_ALERT   2U
#define RTE_LOG_CRIT   3U
#define RTE_LOG_ERR   4U
#define RTE_LOG_WARNING   5U
#define RTE_LOG_NOTICE   6U
#define RTE_LOG_INFO   7U
#define RTE_LOG_DEBUG   8U
#define RTE_LOG(l, t,...)
#define RTE_LOG_DP(l, t,...)

Functions

int rte_openlog_stream (FILE *f)
void rte_log_set_global_level (uint32_t level)
uint32_t rte_log_get_global_level (void)
int rte_log_get_level (uint32_t logtype)
int rte_log_set_level_regexp (const char *pattern, uint32_t level)
int rte_log_set_level (uint32_t logtype, uint32_t level)
int rte_log_cur_msg_loglevel (void)
int rte_log_cur_msg_logtype (void)
int rte_log_register (const char *name)
void rte_log_dump (FILE *f)
int rte_log (uint32_t level, uint32_t logtype, const char *format,...)
int rte_vlog (uint32_t level, uint32_t logtype, const char *format, va_list ap)

Variables

struct rte_logs rte_logs

Detailed Description

RTE Logs API

This file provides a log API to RTE applications.

Definition in file rte_log.h.

Macro Definition Documentation

#define RTE_LOGTYPE_EAL   0

Log related to eal.

Definition at line 70 of file rte_log.h.

#define RTE_LOGTYPE_MALLOC   1

Log related to malloc.

Definition at line 71 of file rte_log.h.

#define RTE_LOGTYPE_RING   2

Log related to ring.

Definition at line 72 of file rte_log.h.

#define RTE_LOGTYPE_MEMPOOL   3

Log related to mempool.

Definition at line 73 of file rte_log.h.

#define RTE_LOGTYPE_TIMER   4

Log related to timers.

Definition at line 74 of file rte_log.h.

#define RTE_LOGTYPE_PMD   5

Log related to poll mode driver.

Definition at line 75 of file rte_log.h.

#define RTE_LOGTYPE_HASH   6

Log related to hash table.

Definition at line 76 of file rte_log.h.

#define RTE_LOGTYPE_LPM   7

Log related to LPM.

Definition at line 77 of file rte_log.h.

#define RTE_LOGTYPE_KNI   8

Log related to KNI.

Definition at line 78 of file rte_log.h.

#define RTE_LOGTYPE_ACL   9

Log related to ACL.

Definition at line 79 of file rte_log.h.

#define RTE_LOGTYPE_POWER   10

Log related to power.

Definition at line 80 of file rte_log.h.

#define RTE_LOGTYPE_METER   11

Log related to QoS meter.

Definition at line 81 of file rte_log.h.

#define RTE_LOGTYPE_SCHED   12

Log related to QoS port scheduler.

Definition at line 82 of file rte_log.h.

#define RTE_LOGTYPE_PORT   13

Log related to port.

Definition at line 83 of file rte_log.h.

#define RTE_LOGTYPE_TABLE   14

Log related to table.

Definition at line 84 of file rte_log.h.

#define RTE_LOGTYPE_PIPELINE   15

Log related to pipeline.

Definition at line 85 of file rte_log.h.

#define RTE_LOGTYPE_MBUF   16

Log related to mbuf.

Definition at line 86 of file rte_log.h.

#define RTE_LOGTYPE_CRYPTODEV   17

Log related to cryptodev.

Definition at line 87 of file rte_log.h.

#define RTE_LOGTYPE_EFD   18

Log related to EFD.

Definition at line 88 of file rte_log.h.

#define RTE_LOGTYPE_EVENTDEV   19

Log related to eventdev.

Definition at line 89 of file rte_log.h.

#define RTE_LOGTYPE_GSO   20

Log related to GSO.

Definition at line 90 of file rte_log.h.

#define RTE_LOGTYPE_USER1   24

User-defined log type 1.

Definition at line 93 of file rte_log.h.

#define RTE_LOGTYPE_USER2   25

User-defined log type 2.

Definition at line 94 of file rte_log.h.

#define RTE_LOGTYPE_USER3   26

User-defined log type 3.

Definition at line 95 of file rte_log.h.

#define RTE_LOGTYPE_USER4   27

User-defined log type 4.

Definition at line 96 of file rte_log.h.

#define RTE_LOGTYPE_USER5   28

User-defined log type 5.

Definition at line 97 of file rte_log.h.

#define RTE_LOGTYPE_USER6   29

User-defined log type 6.

Definition at line 98 of file rte_log.h.

#define RTE_LOGTYPE_USER7   30

User-defined log type 7.

Definition at line 99 of file rte_log.h.

#define RTE_LOGTYPE_USER8   31

User-defined log type 8.

Definition at line 100 of file rte_log.h.

#define RTE_LOGTYPE_FIRST_EXT_ID   32

First identifier for extended logs

Definition at line 103 of file rte_log.h.

#define RTE_LOG_EMERG   1U

System is unusable.

Definition at line 106 of file rte_log.h.

#define RTE_LOG_ALERT   2U

Action must be taken immediately.

Definition at line 107 of file rte_log.h.

#define RTE_LOG_CRIT   3U

Critical conditions.

Definition at line 108 of file rte_log.h.

#define RTE_LOG_ERR   4U

Error conditions.

Definition at line 109 of file rte_log.h.

#define RTE_LOG_WARNING   5U

Warning conditions.

Definition at line 110 of file rte_log.h.

#define RTE_LOG_NOTICE   6U

Normal but significant condition.

Definition at line 111 of file rte_log.h.

#define RTE_LOG_INFO   7U

Informational.

Examples:
examples/quota_watermark/qw/main.c, and examples/quota_watermark/qwctl/qwctl.c.

Definition at line 112 of file rte_log.h.

#define RTE_LOG_DEBUG   8U

Debug-level messages.

Definition at line 113 of file rte_log.h.

#define RTE_LOG (   l,
  t,
  ... 
)
Value:
rte_log(RTE_LOG_ ## l, \
RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__)

Generates a log message.

The RTE_LOG() is a helper that prefixes the string with the log level and type, and call rte_log().

Parameters
lLog level. A value between EMERG (1) and DEBUG (8). The short name is expanded by the macro, so it cannot be an integer value.
tThe log type, for example, EAL. The short name is expanded by the macro, so it cannot be an integer value.
...The fmt string, as in printf(3), followed by the variable arguments required by the format.
Returns
  • 0: Success.
  • Negative on error.
Examples:
examples/distributor/main.c, examples/ip_fragmentation/main.c, examples/ip_reassembly/main.c, examples/ipsec-secgw/esp.c, examples/ipsec-secgw/ipsec-secgw.c, examples/ipsec-secgw/ipsec.c, examples/ipsec-secgw/rt.c, examples/ipsec-secgw/sa.c, examples/ipsec-secgw/sp4.c, examples/ipsec-secgw/sp6.c, examples/ipv4_multicast/main.c, examples/kni/main.c, examples/l2fwd-crypto/main.c, examples/l2fwd-jobstats/main.c, examples/l2fwd-keepalive/main.c, examples/l2fwd-keepalive/shm.c, examples/l2fwd/main.c, examples/l3fwd-acl/main.c, examples/l3fwd-power/main.c, examples/l3fwd-vf/main.c, examples/l3fwd/l3fwd_em.c, examples/l3fwd/l3fwd_lpm.c, examples/link_status_interrupt/main.c, examples/multi_process/client_server_mp/mp_client/client.c, examples/multi_process/client_server_mp/mp_server/main.c, examples/multi_process/l2fwd_fork/main.c, examples/multi_process/simple_mp/main.c, examples/multi_process/symmetric_mp/main.c, examples/netmap_compat/lib/compat_netmap.c, examples/packet_ordering/main.c, examples/performance-thread/common/lthread_diag.c, examples/performance-thread/common/lthread_sched.c, examples/performance-thread/l3fwd-thread/main.c, examples/qos_sched/args.c, examples/qos_sched/init.c, examples/qos_sched/main.c, examples/quota_watermark/qw/main.c, examples/server_node_efd/node/node.c, examples/server_node_efd/server/main.c, examples/tep_termination/main.c, examples/tep_termination/vxlan_setup.c, examples/vhost/main.c, examples/vhost/virtio_net.c, examples/vm_power_manager/channel_manager.c, examples/vm_power_manager/channel_monitor.c, examples/vm_power_manager/guest_cli/vm_power_cli_guest.c, examples/vm_power_manager/main.c, and examples/vm_power_manager/power_manager.c.

Definition at line 314 of file rte_log.h.

#define RTE_LOG_DP (   l,
  t,
  ... 
)
Value:
(void)((RTE_LOG_ ## l <= RTE_LOG_DP_LEVEL) ? \
rte_log(RTE_LOG_ ## l, \
RTE_LOGTYPE_ ## t, # t ": " __VA_ARGS__) : \
0)

Generates a log message for data path.

Similar to RTE_LOG(), except that it is removed at compilation time if the RTE_LOG_DP_LEVEL configuration option is lower than the log level argument.

Parameters
lLog level. A value between EMERG (1) and DEBUG (8). The short name is expanded by the macro, so it cannot be an integer value.
tThe log type, for example, EAL. The short name is expanded by the macro, so it cannot be an integer value.
...The fmt string, as in printf(3), followed by the variable arguments required by the format.
Returns
  • 0: Success.
  • Negative on error.
Examples:
examples/distributor/main.c, examples/ipsec-secgw/esp.c, examples/ipsec-secgw/ipsec.c, examples/packet_ordering/main.c, examples/quota_watermark/qw/main.c, examples/tep_termination/main.c, and examples/vhost/main.c.

Definition at line 338 of file rte_log.h.

Function Documentation

int rte_openlog_stream ( FILE *  f)

Change the stream that will be used by the logging system.

This can be done at any time. The f argument represents the stream to be used to send the logs. If f is NULL, the default output is used (stderr).

Parameters
fPointer to the stream.
Returns
  • 0 on success.
  • Negative on error.
Examples:
examples/ip_pipeline/main.c.
void rte_log_set_global_level ( uint32_t  level)

Set the global log level.

After this call, logs with a level lower or equal than the level passed as argument will be displayed.

Parameters
levelLog level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
Examples:
examples/quota_watermark/qw/main.c, and examples/quota_watermark/qwctl/qwctl.c.
uint32_t rte_log_get_global_level ( void  )

Get the global log level.

Returns
The current global log level.
int rte_log_get_level ( uint32_t  logtype)

Get the log level for a given type.

Parameters
logtypeThe log type identifier.
Returns
0 on success, a negative value if logtype is invalid.
int rte_log_set_level_regexp ( const char *  pattern,
uint32_t  level 
)

Set the log level for a given type.

Parameters
patternThe regexp identifying the log type.
levelThe level to be set.
Returns
0 on success, a negative value if level is invalid.
int rte_log_set_level ( uint32_t  logtype,
uint32_t  level 
)

Set the log level for a given type.

Parameters
logtypeThe log type identifier.
levelThe level to be set.
Returns
0 on success, a negative value if logtype or level is invalid.
int rte_log_cur_msg_loglevel ( void  )

Get the current loglevel for the message being processed.

Before calling the user-defined stream for logging, the log subsystem sets a per-lcore variable containing the loglevel and the logtype of the message being processed. This information can be accessed by the user-defined log output function through this function.

Returns
The loglevel of the message being processed.
int rte_log_cur_msg_logtype ( void  )

Get the current logtype for the message being processed.

Before calling the user-defined stream for logging, the log subsystem sets a per-lcore variable containing the loglevel and the logtype of the message being processed. This information can be accessed by the user-defined log output function through this function.

Returns
The logtype of the message being processed.
int rte_log_register ( const char *  name)

Register a dynamic log type

If a log is already registered with the same type, the returned value is the same than the previous one.

Parameters
nameThe string identifying the log type.
Returns
  • >0: success, the returned value is the log type identifier.
  • (-ENOMEM): cannot allocate memory.
void rte_log_dump ( FILE *  f)

Dump log information.

Dump the global level and the registered log types.

Parameters
fThe output stream where the dump should be sent.
int rte_log ( uint32_t  level,
uint32_t  logtype,
const char *  format,
  ... 
)

Generates a log message.

The message will be sent in the stream defined by the previous call to rte_openlog_stream().

The level argument determines if the log should be displayed or not, depending on the global rte_logs variable.

The preferred alternative is the RTE_LOG() because it adds the level and type in the logged string.

Parameters
levelLog level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
logtypeThe log type, for example, RTE_LOGTYPE_EAL.
formatThe format string, as in printf(3), followed by the variable arguments required by the format.
Returns
  • 0: Success.
  • Negative on error.
int rte_vlog ( uint32_t  level,
uint32_t  logtype,
const char *  format,
va_list  ap 
)

Generates a log message.

The message will be sent in the stream defined by the previous call to rte_openlog_stream().

The level argument determines if the log should be displayed or not, depending on the global rte_logs variable. A trailing newline may be added if needed.

The preferred alternative is the RTE_LOG() because it adds the level and type in the logged string.

Parameters
levelLog level. A value between RTE_LOG_EMERG (1) and RTE_LOG_DEBUG (8).
logtypeThe log type, for example, RTE_LOGTYPE_EAL.
formatThe format string, as in printf(3), followed by the variable arguments required by the format.
apThe va_list of the variable arguments required by the format.
Returns
  • 0: Success.
  • Negative on error.

Variable Documentation

Global log informations