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_data(sd_journal *j, const char *field, const void **data, size_t *l);
  53 int sd_journal_enumerate_data(sd_journal *j, const void **data, size_t *l);
  54 void sd_journal_start_data(sd_journal *j);
  55
  56 int sd_journal_add_match(sd_journal *j, const void *data, size_t size);
  57 void sd_journal_flush_matches(sd_journal *j);
  58
  59 int sd_journal_seek_head(sd_journal *j);
  60 int sd_journal_seek_tail(sd_journal *j);
  61
  62 int sd_journal_seek_monotonic_usec(sd_journal *j, uint64_t usec);  /* missing */
  63 int sd_journal_seek_realtime_usec(sd_journal *j, uint64_t usec);   /* missing */
  64
  65 int sd_journal_get_cursor(sd_journal *j, char **cursor);
  66 int sd_journal_set_cursor(sd_journal *j, const char *cursor);      /* missing */
  67
  68 int sd_journal_unique_seek(sd_journal *j, const char *field);      /* missing */
  69 int sd_journal_unique_enumerate(sd_journal *j, const void **data, size_t *l); /* missing */
  70
  71 int sd_journal_get_fd(sd_journal *j);                              /* missing */
  72
  73 enum {
  74         SD_JOURNAL_NOP,
  75         SD_JOURNAL_APPEND,
  76         SD_JOURNAL_DROP
  77 };
  78
  79 int sd_journal_process(sd_journal *j);
  80
  81 #define SD_JOURNAL_FOREACH_BEGIN(j)             \
  82         if (sd_journal_seek_head(j) > 0) do {
  83
  84 #define SD_JOURNAL_FOREACH_END(j)               \
  85         } while (sd_journal_next(j) > 0)
  86
  87 #define SD_JOURNAL_FOREACH_CONTINUE(j)          \
  88         do {
  89
  90 #define SD_JOURNAL_FOREACH_BACKWARDS_BEGIN(j)   \
  91         if (sd_journal_seek_tail(j) > 0) do {
  92
  93 #define SD_JOURNAL_FOREACH_BACKWARDS_END(j)     \
  94         } while (sd_journal_previous(j) > 0)
  95
  96 #define SD_JOURNAL_FOREACH_BACKWARDS_CONTINUE(j) \
  97         do {
  98
  99 #define SD_JOURNAL_FOREACH_DATA(j, data, l)                             \
 100         for (sd_journal_start_data(j); sd_journal_enumerate_data((j), &(data), &(l)) > 0; )
 101
 102 #define SD_JOURNAL_FOREACH_UNIQUE(j, data, l)                      \
 103         while (sd_journal_enumerate_unique_data((j), &(data), &(l)) > 0)
 104
 105 #endif