dlog
Logging framework
Loading...
Searching...
No Matches
dlogutil.h File Reference
#include <time.h>
#include <tizen_type.h>
#include <dlog.h>
#include <limits.h>

Go to the source code of this file.

Macros

#define DLOGUTIL_MAX_DUMP_SIZE   UINT_MAX
 Enables the full dump mode which prints every stored log.

Typedefs

typedef struct dlogutil_entry dlogutil_entry_s
 A struct containing the metadata and contents for a single dlog entry.
typedef struct dlogutil_config dlogutil_config_s
 A struct containing libdlogutil initialisation configuration.
typedef struct dlogutil_state dlogutil_state_s
 A struct containing the state of a log handling request.

Enumerations

enum  dlogutil_sorting_order_e {
  DLOGUTIL_SORT_SENT_MONO = 0 ,
  DLOGUTIL_SORT_SENT_REAL ,
  DLOGUTIL_SORT_RECV_MONO ,
  DLOGUTIL_SORT_RECV_REAL ,
  DLOGUTIL_SORT_DEFAULT
}
 Enumeration for timestamp-based log sorting orderings. More...

Functions

void dlogutil_entry_destroy (dlogutil_entry_s *entry)
 Destroys the dlogutil_entry_s struct and cleans up its memory. @since_tizen 9.0.
int dlogutil_entry_get_tid (const dlogutil_entry_s *entry, pid_t *tid)
 Retrieves the TID (thread identificator) of the log sender.
int dlogutil_entry_get_pid (const dlogutil_entry_s *entry, pid_t *pid)
 Retrieves the PID (process identificator) of the log sender.
int dlogutil_entry_get_tag (const dlogutil_entry_s *entry, const char **tag)
 Retrieves the tag (arbitrary label) of the log entry.
int dlogutil_entry_get_message (const dlogutil_entry_s *entry, const char **msg)
 Retrieves the message (without any metadata) of the log entry.
int dlogutil_entry_get_timestamp (const dlogutil_entry_s *entry, dlogutil_sorting_order_e order, struct timespec *ts)
 Retrieves the timestamp of given type from the log entry.
int dlogutil_entry_get_priority (const dlogutil_entry_s *entry, log_priority *prio)
 Retrieves the priority level metadata of the log entry.
dlogutil_config_sdlogutil_config_create (void)
 Creates a new dlogutil_config_s struct to be filled with configuration.
void dlogutil_config_destroy (dlogutil_config_s *config)
 Destroys the dlogutil_config_s struct and cleans up its memory.
int dlogutil_config_filter_tid (dlogutil_config_s *config, pid_t tid)
 Enables retrieving only those logs that are logged by the thread with the given TID.
int dlogutil_config_filter_pid (dlogutil_config_s *config, pid_t pid)
 Enables retrieving only those logs that are logged by the process with the given PID.
int dlogutil_config_filter_filterspec (dlogutil_config_s *config, const char *query)
 Enables retrieving only those logs that match a given filter.
int dlogutil_config_sorting_disable (dlogutil_config_s *config)
 Disables log sorting for given log retrieval request.
int dlogutil_config_sorting_enable (dlogutil_config_s *config)
 Enables log sorting for given log retrieval request. @since_tizen 6.0.
int dlogutil_config_sorting_enable_with_size (dlogutil_config_s *config, unsigned int entry_count)
 Enables sorting, choosing the sort buffer size manually. @since_tizen 6.0.
int dlogutil_config_order_set (dlogutil_config_s *config, dlogutil_sorting_order_e sort_by)
 Chooses a timestamp type by which returned logs are sorted by @since_tizen 6.0.
int dlogutil_config_buffer_add (dlogutil_config_s *config, log_id_t buf)
 Adds a buffer whence logs will be taken to a request.
void dlogutil_state_destroy (dlogutil_state_s *state)
 Destroys the dlogutil_state_s struct and frees its memory.
int dlogutil_config_mode_set_continuous (dlogutil_config_s *config)
 Set log retrieval mode to retrieving all the logs since the start of the system without an end.
int dlogutil_config_mode_set_monitor (dlogutil_config_s *config)
 Set log retrieval mode to retrieving all the logs since the call without an end.
int dlogutil_config_mode_set_dump (dlogutil_config_s *config, unsigned int entry_count)
 Set log retrieval mode to dumping all the logs since the start of the system until the call (possibly a specified amount of the most recent of them instead).
int dlogutil_config_mode_set_compressed_memory_dump (dlogutil_config_s *config, const char *compression_buffer)
 Set log retrieval mode to dumping compressed historical logs.
int dlogutil_config_connect (dlogutil_config_s *config, dlogutil_state_s **state_out)
 Finalizes the config into a state struct by connecting to buffers.
int dlogutil_get_log (dlogutil_state_s *state, int timeout, dlogutil_entry_s **entry_out)
 Retrieves a single log according to a dump request.
int dlogutil_buffer_clear (dlogutil_state_s *state, log_id_t buffer)
 Irreversibly clears a log buffer from any logs inside.
int dlogutil_buffer_get_name (log_id_t buffer, const char **name)
 Gets the human-readable, constant name of a buffer.
int dlogutil_buffer_get_capacity (dlogutil_state_s *state, log_id_t buffer, unsigned int *capacity)
 Gets the data storage capacity of a log buffer in bytes.
int dlogutil_buffer_get_usage (dlogutil_state_s *state, log_id_t buffer, unsigned int *usage)
 Gets the storage data usage of a log buffer, in bytes.
int dlogutil_buffer_get_default_ts_type (log_id_t buffer, dlogutil_sorting_order_e *type)
 Gets the default sorting timestamp type of a buffer. @since_tizen 6.0.
int dlogutil_buffer_check_ts_type_available (log_id_t buffer, dlogutil_sorting_order_e type, bool *available)
 Checks if a buffer contains timestamps of a given type. @since_tizen 6.0.
int dlogutil_buffer_get_alias (dlogutil_state_s *state, log_id_t buffer, log_id_t *real_buffer)
 Gets the buffer aliasing (same storage) information @since_tizen 6.0.