src/journal/sd-journal.h

	sd-journal.h revision 94fb446e55babb713fb24850455627acf30d999b
c6d33447e28403a90ad817dba4df75fae785be28pquerna/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna#ifndef foojournalhfoo
c6d33447e28403a90ad817dba4df75fae785be28pquerna#define foojournalhfoo
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna/***
c6d33447e28403a90ad817dba4df75fae785be28pquerna  This file is part of systemd.
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna  Copyright 2011 Lennart Poettering
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna  systemd is free software; you can redistribute it and/or modify it
c6d33447e28403a90ad817dba4df75fae785be28pquerna  under the terms of the GNU General Public License as published by
c6d33447e28403a90ad817dba4df75fae785be28pquerna  the Free Software Foundation; either version 2 of the License, or
c6d33447e28403a90ad817dba4df75fae785be28pquerna  (at your option) any later version.
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna  systemd is distributed in the hope that it will be useful, but
c6d33447e28403a90ad817dba4df75fae785be28pquerna  WITHOUT ANY WARRANTY; without even the implied warranty of
c6d33447e28403a90ad817dba4df75fae785be28pquerna  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c6d33447e28403a90ad817dba4df75fae785be28pquerna  General Public License for more details.
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna  You should have received a copy of the GNU General Public License
c6d33447e28403a90ad817dba4df75fae785be28pquerna  along with systemd; If not, see <http://www.gnu.org/licenses/>.
c6d33447e28403a90ad817dba4df75fae785be28pquerna***/
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna#include <inttypes.h>
c6d33447e28403a90ad817dba4df75fae785be28pquerna#include <sys/types.h>
c6d33447e28403a90ad817dba4df75fae785be28pquerna#include <stdarg.h>
c6d33447e28403a90ad817dba4df75fae785be28pquerna#include <sys/uio.h>
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna#include "sd-id128.h"
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna/* TODO:
c6d33447e28403a90ad817dba4df75fae785be28pquerna *
c6d33447e28403a90ad817dba4df75fae785be28pquerna *   - add options for copy-to-console, copy-to-kmsg
c6d33447e28403a90ad817dba4df75fae785be28pquerna *   - OR of matches is borked...
c6d33447e28403a90ad817dba4df75fae785be28pquerna *   - extend hash tables table as we go
c6d33447e28403a90ad817dba4df75fae785be28pquerna *   - accelerate looking for "all hostnames" and suchlike.
c6d33447e28403a90ad817dba4df75fae785be28pquerna *   - handle incomplete header
c6d33447e28403a90ad817dba4df75fae785be28pquerna *
c6d33447e28403a90ad817dba4df75fae785be28pquerna *   - local deserializer
c6d33447e28403a90ad817dba4df75fae785be28pquerna *   - http server
c6d33447e28403a90ad817dba4df75fae785be28pquerna *   - message catalog
c6d33447e28403a90ad817dba4df75fae785be28pquerna *
c6d33447e28403a90ad817dba4df75fae785be28pquerna *   - check LE/BE conversion for 8bit, 16bit, 32bit values
c6d33447e28403a90ad817dba4df75fae785be28pquerna *   - cryptographic hash
c6d33447e28403a90ad817dba4df75fae785be28pquerna *   - think about manipulations of header
c6d33447e28403a90ad817dba4df75fae785be28pquerna *   - implement audit gateway
c6d33447e28403a90ad817dba4df75fae785be28pquerna */
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna/* Write to daemon */
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_print(int piority, const char *format, ...) __attribute__ ((format (printf, 2, 3)));
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_printv(int priority, const char *format, va_list ap);
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_send(const char *format, ...) __attribute__((sentinel));
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_sendv(const struct iovec *iov, int n);
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_stream_fd(const char *tag, int priority, int priority_prefix);
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna/* Browse journal stream */
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquernatypedef struct sd_journal sd_journal;
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquernaenum {
c6d33447e28403a90ad817dba4df75fae785be28pquerna        SD_JOURNAL_LOCAL_ONLY = 1,
c6d33447e28403a90ad817dba4df75fae785be28pquerna        SD_JOURNAL_RUNTIME_ONLY = 2,
c6d33447e28403a90ad817dba4df75fae785be28pquerna        SD_JOURNAL_SYSTEM_ONLY = 4
c6d33447e28403a90ad817dba4df75fae785be28pquerna};
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_open(sd_journal **ret, int flags);
c6d33447e28403a90ad817dba4df75fae785be28pquernavoid sd_journal_close(sd_journal *j);
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_previous(sd_journal *j);
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_next(sd_journal *j);
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_previous_skip(sd_journal *j, uint64_t skip);
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_next_skip(sd_journal *j, uint64_t skip);
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_get_realtime_usec(sd_journal *j, uint64_t *ret);
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_get_monotonic_usec(sd_journal *j, uint64_t *ret, sd_id128_t *ret_boot_id);
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_get_data(sd_journal *j, const char *field, const void **data, size_t *l);
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_enumerate_data(sd_journal *j, const void **data, size_t *l);
c6d33447e28403a90ad817dba4df75fae785be28pquernavoid sd_journal_restart_data(sd_journal *j);
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_add_match(sd_journal *j, const void *data, size_t size);
c6d33447e28403a90ad817dba4df75fae785be28pquernavoid sd_journal_flush_matches(sd_journal *j);
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_seek_head(sd_journal *j);
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_seek_tail(sd_journal *j);
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_seek_monotonic_usec(sd_journal *j, sd_id128_t boot_id, uint64_t usec);
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_seek_realtime_usec(sd_journal *j, uint64_t usec);
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_seek_cursor(sd_journal *j, const char *cursor);
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_get_cursor(sd_journal *j, char **cursor);
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_query_unique(sd_journal *j, const char *field);      /* missing */
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_enumerate_unique(sd_journal *j, const void **data, size_t *l); /* missing */
c6d33447e28403a90ad817dba4df75fae785be28pquernavoid sd_journal_restart_unique(sd_journal *j);                      /* missing */
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquernaenum {
c6d33447e28403a90ad817dba4df75fae785be28pquerna        SD_JOURNAL_NOP,
c6d33447e28403a90ad817dba4df75fae785be28pquerna        SD_JOURNAL_APPEND,
c6d33447e28403a90ad817dba4df75fae785be28pquerna        SD_JOURNAL_INVALIDATE_ADD,
c6d33447e28403a90ad817dba4df75fae785be28pquerna        SD_JOURNAL_INVALIDATE_REMOVE
c6d33447e28403a90ad817dba4df75fae785be28pquerna};
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_get_fd(sd_journal *j);
c6d33447e28403a90ad817dba4df75fae785be28pquernaint sd_journal_process(sd_journal *j);
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna#define SD_JOURNAL_FOREACH(j)                                           \
c6d33447e28403a90ad817dba4df75fae785be28pquerna        if (sd_journal_seek_head(j) >= 0)                               \
c6d33447e28403a90ad817dba4df75fae785be28pquerna                while (sd_journal_next(j) > 0)
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna#define SD_JOURNAL_FOREACH_BACKWARDS(j)                                 \
c6d33447e28403a90ad817dba4df75fae785be28pquerna        if (sd_journal_seek_tail(j) >= 0)                               \
c6d33447e28403a90ad817dba4df75fae785be28pquerna                while (sd_journal_previous(j) > 0)
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna#define SD_JOURNAL_FOREACH_DATA(j, data, l)                             \
c6d33447e28403a90ad817dba4df75fae785be28pquerna        for (sd_journal_restart_data(j); sd_journal_enumerate_data((j), &(data), &(l)) > 0; )
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna#define SD_JOURNAL_FOREACH_UNIQUE(j, data, l)                           \
c6d33447e28403a90ad817dba4df75fae785be28pquerna        for (sd_journal_restart_unique(j); sd_journal_enumerate_data((j), &(data), &(l)) > 0; )
c6d33447e28403a90ad817dba4df75fae785be28pquerna
c6d33447e28403a90ad817dba4df75fae785be28pquerna#endif
c6d33447e28403a90ad817dba4df75fae785be28pquerna