:orphan: .. index:: pair: group; Log format string processing .. _doxid-group__te__tools__te__log__fmt: Log format string processing ============================ .. toctree:: :hidden: enum_te_log_msg_arg_type.rst struct_te_log_arg_descr.rst struct_te_log_msg_out.rst struct_te_log_msg_raw_data.rst struct_te_log_msg_truncated.rst Overview ~~~~~~~~ Some TE-specific features, such as memory dump, file content logging, and additional length modifiers are supported. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef enum :ref:`te_log_msg_arg_type` :ref:`te_log_msg_arg_type`; typedef struct :ref:`te_log_msg_out` :target:`te_log_msg_out`; typedef :ref:`te_errno` (*:ref:`te_log_msg_fmt_args_f`)( te_log_msg_out *out, const char *fmt, va_list ap ); typedef :ref:`te_errno` (*:ref:`te_log_msg_raw_arg_f`)( te_log_msg_out *out, const char *fmt, size_t fmt_len, te_log_msg_arg_type arg_type, const void *arg_addr, size_t arg_len ); typedef struct :ref:`te_log_arg_descr` :ref:`te_log_arg_descr`; typedef struct :ref:`te_log_msg_raw_data` :ref:`te_log_msg_raw_data`; typedef struct :ref:`te_log_msg_truncated` :ref:`te_log_msg_truncated`; // enums enum :ref:`te_log_msg_arg_type`; // structs struct :ref:`te_log_arg_descr`; struct :ref:`te_log_msg_out`; struct :ref:`te_log_msg_raw_data`; struct :ref:`te_log_msg_truncated`; // global variables const struct :ref:`te_log_msg_out` :target:`te_log_msg_out_raw`; // global functions :ref:`te_errno` :ref:`te_log_vprintf`(:ref:`te_log_msg_out`* out, const char* fmt, va_list ap); :ref:`te_errno` :ref:`te_log_message_raw_va`(:ref:`te_log_msg_raw_data`* data, :ref:`te_log_ts_sec` ts_sec, :ref:`te_log_ts_usec` ts_usec, :ref:`te_log_level` level, :ref:`te_log_id` log_id, const char* entity, const char* user, const char* fmt, va_list ap); :ref:`te_errno` :ref:`te_log_message_split`(const char* file, unsigned int line, unsigned int level, const char* entity, const char* user, const char* fmt, ...); .. _details-group__te__tools__te__log__fmt: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Some TE-specific features, such as memory dump, file content logging, and additional length modifiers are supported. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; te_log_msg_arg_type .. _doxid-group__te__tools__te__log__fmt_1gae0152ef783d1f443e9205ed2ec25393c: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef enum :ref:`te_log_msg_arg_type` te_log_msg_arg_type Types of TE log message arguments .. index:: pair: typedef; te_log_msg_fmt_args_f .. _doxid-group__te__tools__te__log__fmt_1ga1eaeb43db0feafb83011c657c07b5906: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` (*te_log_msg_fmt_args_f)( te_log_msg_out *out, const char *fmt, va_list ap ) Callback to process possibly few format string arguments in vprintf()-like mode. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - out - Backend parameters * - fmt - Part of format string, terminated by NUL, which corresponds to arguments pointed by *ap* * - ap - Arguments for format string .. rubric:: Returns: FIXME .. index:: pair: typedef; te_log_msg_raw_arg_f .. _doxid-group__te__tools__te__log__fmt_1ga864b357d467bb33910bb302e408572a4: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef :ref:`te_errno` (*te_log_msg_raw_arg_f)( te_log_msg_out *out, const char *fmt, size_t fmt_len, te_log_msg_arg_type arg_type, const void *arg_addr, size_t arg_len ) Callback to process one format string argument in raw mode. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - out - Backend parameters * - fmt - Part of format string which corresponds to the argument (possibly not terminated by NUL) or ``NULL`` * - fmt_len - Length of the *fmt* (zero, if *fmt* is ``NULL``) * - arg_type - Type of the argument * - arg_addr - Address of the argument * - arg_len - Argument length .. rubric:: Returns: FIXME .. index:: pair: typedef; te_log_arg_descr .. _doxid-group__te__tools__te__log__fmt_1ga8f0fed29c3f0397ffb404ff7b3eedbf0: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`te_log_arg_descr` te_log_arg_descr Log argument descriptor .. index:: pair: typedef; te_log_msg_raw_data .. _doxid-group__te__tools__te__log__fmt_1ga12a02fd7e22005b098ade2a3fca58767: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`te_log_msg_raw_data` te_log_msg_raw_data Raw logging backend parameters .. index:: pair: typedef; te_log_msg_truncated .. _doxid-group__te__tools__te__log__fmt_1ga7c491d4233dafcd3073573be7271453d: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`te_log_msg_truncated` te_log_msg_truncated Information about truncated part of raw log argument. Global Functions ---------------- .. index:: pair: function; te_log_vprintf .. _doxid-group__te__tools__te__log__fmt_1ga3eaf731c62e24f105727a9b84562bbc7: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_log_vprintf(:ref:`te_log_msg_out`* out, const char* fmt, va_list ap) Preprocess and output message to log with special features parsing. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - out - Output parameters * - fmt - Format string * - ap - Arguments for the format string .. rubric:: Returns: Error code (see ``te_errno.h``) .. index:: pair: function; te_log_message_raw_va .. _doxid-group__te__tools__te__log__fmt_1ga4efbe9e5cbe0882e1e759274ca8e41f8: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_log_message_raw_va(:ref:`te_log_msg_raw_data`* data, :ref:`te_log_ts_sec` ts_sec, :ref:`te_log_ts_usec` ts_usec, :ref:`te_log_level` level, :ref:`te_log_id` log_id, const char* entity, const char* user, const char* fmt, va_list ap) .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - data - Output parameters * - ts_sec - Timestamp seconds * - ts_usec - Timestamp microseconds * - level - Log levelt * - log_id - Test ID or TE_LOG_ID_UNDEFINED * - entity - Entity name * - user - User name * - fmt - Format string * - ap - Arguments for the format string .. rubric:: Returns: Error code (see ``te_errno.h``) .. index:: pair: function; te_log_message_split .. _doxid-group__te__tools__te__log__fmt_1ga061b87896c0d99e8f0901fb0a90b599f: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` te_log_message_split(const char* file, unsigned int line, unsigned int level, const char* entity, const char* user, const char* fmt, ...) Print a given string in log, splitting it in multiple messages if it is too long to fit in a single one. This function does not parse TE format specifiers like 'r', and involves some processing overhead. So use it only when it is necessary. This function will try to split the string at ' ' symbols (removing them from the beginning and the end of each message). If it is not possible, it will cut the string at arbitrary positions. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - file - Name of file where this function is called (use **FILE**) * - line - Number of line where this function is called (use **LINE**) * - level - Log level * - entity - Logger entity * - user - Logger user * - fmt - Format string * - ... - Format string arguments .. rubric:: Returns: Status code