src/journal/sd-journal.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foojournalhfoo
   4 #define foojournalhfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2011 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU General Public License as published by
  13   the Free Software Foundation; either version 2 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   General Public License for more details.
  20
  21   You should have received a copy of the GNU General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <inttypes.h>
  26 #include <sys/types.h>
  27
  28 /* TODO:
  29  *
  30  *   - check LE/BE conversion for 8bit, 16bit, 32bit values
  31  *   - implement parallel traversal
  32  *   - implement inotify usage on client
  33  *   - implement audit gateway
  34  *   - implement native gateway
  35  *   - implement stdout gateway
  36  *   - extend hash table/bisect table as we go
  37  *   - accelerate looking for "all hostnames" and suchlike.
  38  *   - throttling
  39  *   - enforce limit on open journal files in journald and journalctl
  40  */
  41
  42 typedef struct sd_journal sd_journal;
  43
  44 int sd_journal_open(sd_journal **ret);
  45 void sd_journal_close(sd_journal *j);
  46
  47 int sd_journal_previous(sd_journal *j);
  48 int sd_journal_next(sd_journal *j);
  49
  50 int sd_journal_get_realtime_usec(sd_journal *j, uint64_t *ret);
  51 int sd_journal_get_monotonic_usec(sd_journal *j, uint64_t *ret);
  52 int sd_journal_get_field(sd_journal *j, const char *field, const void **data, size_t *l);
  53 int sd_journal_iterate_fields(sd_journal *j, const void **data, size_t *l);
  54
  55 int sd_journal_add_match(sd_journal *j, const void *data, size_t size);
  56 void sd_journal_flush_matches(sd_journal *j);
  57
  58 int sd_journal_seek_head(sd_journal *j);
  59 int sd_journal_seek_tail(sd_journal *j);
  60
  61 int sd_journal_seek_monotonic_usec(sd_journal *j, uint64_t usec);
  62 int sd_journal_seek_realtime_usec(sd_journal *j, uint64_t usec);
  63
  64 int sd_journal_get_cursor(sd_journal *j, char **cursor);
  65 int sd_journal_set_cursor(sd_journal *j, const char *cursor);
  66
  67 int sd_journal_get_fd(sd_journal *j);
  68
  69 enum {
  70         SD_JOURNAL_NOP,
  71         SD_JOURNAL_APPEND,
  72         SD_JOURNAL_DROP
  73 };
  74
  75 int sd_journal_process(sd_journal *j);
  76
  77 #define SD_JOURNAL_FOREACH(j)                   \
  78         while (sd_journal_next(j) > 0)
  79
  80 #define SD_JOURNAL_FOREACH_BACKWARDS(j)         \
  81         while (sd_journal_previous(j) > 0)
  82
  83 #define SD_JOURNAL_FOREACH_FIELD(j, data, l)                            \
  84         while (sd_journal_iterate_fields((j), &(data), &(l)) > 0)
  85
  86 #endif