dlogutil.h

Go to the documentation of this file.

/*
 * DLOG
 * Copyright (c) 2005-2008, The Android Open Source Project
 * Copyright (c) 2012-2020 Samsung Electronics Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the License);
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * 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 __TIZEN_SYSTEM_DLOGUTIL_H__
#define __TIZEN_SYSTEM_DLOGUTIL_H__

#include <time.h>
#include <tizen_type.h>
#include <dlog.h>
#include <limits.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    DLOGUTIL_SORT_SENT_MONO = 0, 
    DLOGUTIL_SORT_SENT_REAL,     
    DLOGUTIL_SORT_RECV_MONO,     
    DLOGUTIL_SORT_RECV_REAL,     
    DLOGUTIL_SORT_DEFAULT,       
} dlogutil_sorting_order_e;

typedef enum {
    DLOGUTIL_BUF_MAIN   = 1 << LOG_ID_MAIN,   
    DLOGUTIL_BUF_RADIO  = 1 << LOG_ID_RADIO,  
    DLOGUTIL_BUF_SYSTEM = 1 << LOG_ID_SYSTEM, 
    DLOGUTIL_BUF_APPS   = 1 << LOG_ID_APPS,   
    DLOGUTIL_BUF_KMSG   = 1 << LOG_ID_KMSG,   
    DLOGUTIL_BUF_SYSLOG = 1 << LOG_ID_SYSLOG, 
} dlogutil_buffer_e;

typedef struct dlogutil_entry dlogutil_entry_s;

int dlogutil_entry_get_tid(const dlogutil_entry_s *entry, pid_t *tid);

int dlogutil_entry_get_pid(const dlogutil_entry_s *entry, pid_t *pid);

int dlogutil_entry_get_tag(const dlogutil_entry_s *entry, const char **tag);

int dlogutil_entry_get_message(const dlogutil_entry_s *entry, const char **msg);

int dlogutil_entry_get_timestamp(const dlogutil_entry_s *entry, dlogutil_sorting_order_e order, struct timespec *ts);

int dlogutil_entry_get_priority(const dlogutil_entry_s *entry, log_priority *prio);

typedef struct dlogutil_filter_options dlogutil_filter_options_s;

dlogutil_filter_options_s *dlogutil_filter_options_create(void);

void dlogutil_filter_options_destroy(dlogutil_filter_options_s *filter);

int dlogutil_filter_options_set_tid(dlogutil_filter_options_s *filter, pid_t tid);

int dlogutil_filter_options_set_pid(dlogutil_filter_options_s *filter, pid_t pid);

int dlogutil_filter_options_set_filterspec(dlogutil_filter_options_s *filter, const char *query);

typedef struct dlogutil_sorting_options dlogutil_sorting_options_s;

dlogutil_sorting_options_s *dlogutil_sorting_options_create(void);

void dlogutil_sorting_options_destroy(dlogutil_sorting_options_s *sorting);

int dlogutil_sorting_options_disable_sorting(dlogutil_sorting_options_s *sorting);

int dlogutil_sorting_options_enable_sorting(dlogutil_sorting_options_s *sorting);

int dlogutil_sorting_options_enable_sorting_with_size(dlogutil_sorting_options_s *sorting, unsigned int entry_count);

int dlogutil_sorting_options_set_sort_by(dlogutil_sorting_options_s *sorting, dlogutil_sorting_order_e sort_by);

typedef int dlogutil_entry_cb(const dlogutil_entry_s *entry, void *data);

#define DLOGUTIL_MAX_DUMP_SIZE UINT_MAX

int dlogutil_get_logs_continuous(int buffers, dlogutil_entry_cb callback, void *data, dlogutil_sorting_options_s *sorting, dlogutil_filter_options_s *filter);

int dlogutil_get_logs_monitor(int buffers, dlogutil_entry_cb callback, void *data, dlogutil_sorting_options_s *sorting, dlogutil_filter_options_s *filter);

int dlogutil_get_logs_dump(int buffers, unsigned int entry_count, dlogutil_entry_cb callback, void *data, dlogutil_sorting_options_s *sorting, dlogutil_filter_options_s *filter);

int dlogutil_buffer_clear(dlogutil_buffer_e buffer);

int dlogutil_buffer_get_name(dlogutil_buffer_e buffer, const char **name);

int dlogutil_buffer_get_size(dlogutil_buffer_e buffer, unsigned int *size);

int dlogutil_buffer_get_default_ts_type(dlogutil_buffer_e buffer, dlogutil_sorting_order_e *type);

int dlogutil_buffer_check_ts_type_available(dlogutil_buffer_e buffer, dlogutil_sorting_order_e type, bool *available);

#ifdef __cplusplus
}
#endif

#endif /* __TIZEN_SYSTEM_DLOGUTIL_H__ */