Blame src/plugins/abrt-journal.h

Packit 8ea169
/*
Packit 8ea169
 * Copyright (C) 2014  ABRT team
Packit 8ea169
 * Copyright (C) 2014  RedHat Inc
Packit 8ea169
 *
Packit 8ea169
 * This program is free software; you can redistribute it and/or modify
Packit 8ea169
 * it under the terms of the GNU General Public License as published by
Packit 8ea169
 * the Free Software Foundation; either version 2 of the License, or
Packit 8ea169
 * (at your option) any later version.
Packit 8ea169
 *
Packit 8ea169
 * This program is distributed in the hope that it will be useful,
Packit 8ea169
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 8ea169
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit 8ea169
 * GNU General Public License for more details.
Packit 8ea169
 */
Packit 8ea169
#ifndef _ABRT_JOURNAL_H_
Packit 8ea169
#define _ABRT_JOURNAL_H_
Packit 8ea169
Packit 8ea169
#include <glib.h>
Packit 8ea169
Packit 8ea169
#ifdef __cplusplus
Packit 8ea169
extern "C" {
Packit 8ea169
#endif
Packit 8ea169
Packit 8ea169
/*
Packit 8ea169
 * A systemd-journal wrapper
Packit 8ea169
 * (isolates systemd API in a single compile unit)
Packit 8ea169
 */
Packit 8ea169
struct abrt_journal;
Packit 8ea169
typedef struct abrt_journal abrt_journal_t;
Packit 8ea169
Packit 8ea169
/* Only journal files generated on the local machine and all journal file types
Packit 8ea169
 * will be opened.
Packit 8ea169
 */
Packit 8ea169
int abrt_journal_new(abrt_journal_t **journal);
Packit 8ea169
Packit 8ea169
/* Journal files generated on ALL machines and all journal file types will be
Packit 8ea169
 * opened.
Packit 8ea169
 */
Packit 8ea169
int abrt_journal_new_merged(abrt_journal_t **journal);
Packit 8ea169
Packit 8ea169
/* Open a directory and merge all journal files placed there.
Packit 8ea169
 */
Packit 8ea169
int abrt_journal_open_directory(abrt_journal_t **journal, const char *directory);
Packit 8ea169
Packit 8ea169
void abrt_journal_free(abrt_journal_t *journal);
Packit 8ea169
Packit 8ea169
int abrt_journal_set_journal_filter(abrt_journal_t *journal,
Packit 8ea169
                                    GList *journal_filter_list);
Packit 8ea169
Packit 8ea169
int abrt_journal_get_field(abrt_journal_t *journal,
Packit 8ea169
                           const char *field,
Packit 8ea169
                           const void **value,
Packit 8ea169
                           size_t *value_len);
Packit 8ea169
Packit 8ea169
int abrt_journal_get_int_field(abrt_journal_t *journal,
Packit 8ea169
                               const char *field,
Packit 8ea169
                               int *value);
Packit 8ea169
Packit 8ea169
int abrt_journal_get_unsigned_field(abrt_journal_t *journal,
Packit 8ea169
                                    const char *field,
Packit 8ea169
                                    unsigned *value);
Packit 8ea169
Packit 8ea169
/* Returns allocated memory if value is NULL; otherwise makes copy of journald
Packit 8ea169
 * field to memory pointed by value arg. */
Packit 8ea169
char *abrt_journal_get_string_field(abrt_journal_t *journal,
Packit 8ea169
                                  const char *field,
Packit 8ea169
                                  char *value);
Packit 8ea169
Packit 8ea169
char *abrt_journal_get_log_line(abrt_journal_t *journal);
Packit 8ea169
Packit 8ea169
char *abrt_journal_get_next_log_line(void *data);
Packit 8ea169
Packit 8ea169
int abrt_journal_get_cursor(abrt_journal_t *journal, char **cursor);
Packit 8ea169
Packit 8ea169
int abrt_journal_set_cursor(abrt_journal_t *journal, const char *cursor);
Packit 8ea169
Packit 8ea169
int abrt_journal_seek_tail(abrt_journal_t *journal);
Packit 8ea169
Packit 8ea169
int abrt_journal_next(abrt_journal_t *journal);
Packit 8ea169
Packit 8ea169
int abrt_journal_save_current_position(abrt_journal_t *journal,
Packit 8ea169
                                       const char *file_name);
Packit 8ea169
Packit 8ea169
int abrt_journal_restore_position(abrt_journal_t *journal,
Packit 8ea169
                                  const char *file_name);
Packit 8ea169
Packit 8ea169
/*
Packit 8ea169
 * A systemd-journal listener which waits for new messages a loop and notifies
Packit 8ea169
 * them via a call back
Packit 8ea169
 */
Packit 8ea169
struct abrt_journal_watch;
Packit 8ea169
typedef struct abrt_journal_watch abrt_journal_watch_t;
Packit 8ea169
Packit 8ea169
typedef void (* abrt_journal_watch_callback)(struct abrt_journal_watch *watch,
Packit 8ea169
                                             void *data);
Packit 8ea169
Packit 8ea169
int abrt_journal_watch_new(abrt_journal_watch_t **watch,
Packit 8ea169
                           abrt_journal_t *journal,
Packit 8ea169
                           abrt_journal_watch_callback callback,
Packit 8ea169
                           void *callback_data);
Packit 8ea169
Packit 8ea169
void abrt_journal_watch_free(abrt_journal_watch_t *watch);
Packit 8ea169
Packit 8ea169
/*
Packit 8ea169
 * Returns the watched journal.
Packit 8ea169
 */
Packit 8ea169
abrt_journal_t *abrt_journal_watch_get_journal(abrt_journal_watch_t *watch);
Packit 8ea169
Packit 8ea169
/*
Packit 8ea169
 * Starts reading journal messages and waiting for new messages in a loop.
Packit 8ea169
 *
Packit 8ea169
 * SIGTERM and SIGINT terminates the loop gracefully.
Packit 8ea169
 */
Packit 8ea169
int abrt_journal_watch_run_sync(abrt_journal_watch_t *watch);
Packit 8ea169
Packit 8ea169
/*
Packit 8ea169
 * Can be used to terminate the loop in abrt_journal_watch_run_sync()
Packit 8ea169
 */
Packit 8ea169
void abrt_journal_watch_stop(abrt_journal_watch_t *watch);
Packit 8ea169
Packit 8ea169
Packit 8ea169
/*
Packit 8ea169
 * A decorator for abrt_journal_watch call backs which calls the decorated call
Packit 8ea169
 * back in case where journal message contains a string from the interested
Packit 8ea169
 * list.
Packit 8ea169
 */
Packit 8ea169
struct abrt_journal_watch_notify_strings
Packit 8ea169
{
Packit 8ea169
    abrt_journal_watch_callback decorated_cb;
Packit 8ea169
    void *decorated_cb_data;
Packit 8ea169
    GList *strings;
Packit 8ea169
    GList *blacklisted_strings;
Packit 8ea169
};
Packit 8ea169
Packit 8ea169
void abrt_journal_watch_notify_strings(abrt_journal_watch_t *watch, void *data);
Packit 8ea169
Packit 8ea169
#ifdef __cplusplus
Packit 8ea169
}
Packit 8ea169
#endif
Packit 8ea169
Packit 8ea169
#endif /*_ABRT_JOURNAL_H_*/