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 #include <stdarg.h>
  28 #include <sys/uio.h>
  29
  30 #include "sd-id128.h"
  31
  32 /* TODO:
  33  *
  34  *   - check LE/BE conversion for 8bit, 16bit, 32bit values
  35  *   - implement inotify usage on client
  36  *   - implement audit gateway
  37  *   - implement native gateway
  38  *   - implement stdout gateway
  39  *   - extend hash tables table as we go
  40  *   - accelerate looking for "all hostnames" and suchlike.
  41  *   - throttling
  42  *   - enforce limit on open journal files in journald and journalctl
  43  *   - cryptographic hash
  44  *   - fix space reservation logic
  45  *   - comm, argv can be manipulated, should it be _COMM=, _CMDLINE= or COMM=, CMDLINE=?
  46  */
  47
  48 /* Write to daemon */
  49
  50 int sd_journal_print(const char *format, ...) __attribute__ ((format (printf, 1, 2)));
  51 int sd_journal_printv(const char *format, va_list ap);
  52
  53 int sd_journal_send(const char *format, ...) __attribute__((sentinel));
  54 int sd_journal_sendv(const struct iovec *iov, int n);
  55
  56 /* Browse journal stream */
  57
  58 typedef struct sd_journal sd_journal;
  59
  60 int sd_journal_open(sd_journal **ret);
  61 void sd_journal_close(sd_journal *j);
  62
  63 int sd_journal_previous(sd_journal *j);
  64 int sd_journal_next(sd_journal *j);
  65
  66 int sd_journal_previous_skip(sd_journal *j, uint64_t skip);
  67 int sd_journal_next_skip(sd_journal *j, uint64_t skip);
  68
  69 int sd_journal_get_realtime_usec(sd_journal *j, uint64_t *ret);
  70 int sd_journal_get_monotonic_usec(sd_journal *j, uint64_t *ret, sd_id128_t *ret_boot_id);
  71 int sd_journal_get_data(sd_journal *j, const char *field, const void **data, size_t *l);
  72 int sd_journal_enumerate_data(sd_journal *j, const void **data, size_t *l);
  73 void sd_journal_restart_data(sd_journal *j);
  74
  75 int sd_journal_add_match(sd_journal *j, const void *data, size_t size);
  76 void sd_journal_flush_matches(sd_journal *j);
  77
  78 int sd_journal_seek_head(sd_journal *j);
  79 int sd_journal_seek_tail(sd_journal *j);
  80 int sd_journal_seek_monotonic_usec(sd_journal *j, sd_id128_t boot_id, uint64_t usec);
  81 int sd_journal_seek_realtime_usec(sd_journal *j, uint64_t usec);
  82 int sd_journal_seek_cursor(sd_journal *j, const char *cursor);
  83
  84 int sd_journal_get_cursor(sd_journal *j, char **cursor);
  85
  86 int sd_journal_query_unique(sd_journal *j, const char *field);      /* missing */
  87 int sd_journal_enumerate_unique(sd_journal *j, const void **data, size_t *l); /* missing */
  88 void sd_journal_restart_unique(sd_journal *j);                      /* missing */
  89
  90 enum {
  91         SD_JOURNAL_NOP,
  92         SD_JOURNAL_APPEND,
  93         SD_JOURNAL_INVALIDATE_ADD,
  94         SD_JOURNAL_INVALIDATE_REMOVE
  95 };
  96
  97 int sd_journal_get_fd(sd_journal *j);                              /* missing */
  98 int sd_journal_process(sd_journal *j);                             /* missing */
  99
 100 #define SD_JOURNAL_FOREACH(j)                                           \
 101         if (sd_journal_seek_head(j) >= 0)                               \
 102                 while (sd_journal_next(j) > 0)                          \
 103
 104 #define SD_JOURNAL_FOREACH_BACKWARDS(j)                                 \
 105         if (sd_journal_seek_tail(j) >= 0)                               \
 106                 while (sd_journal_previous(j) > 0)                      \
 107
 108 #define SD_JOURNAL_FOREACH_DATA(j, data, l)                             \
 109         for (sd_journal_restart_data(j); sd_journal_enumerate_data((j), &(data), &(l)) > 0; )
 110
 111 #define SD_JOURNAL_FOREACH_UNIQUE(j, data, l)                           \
 112         for (sd_journal_restart_unique(j); sd_journal_enumerate_data((j), &(data), &(l)) > 0; )
 113
 114 #endif