src/systemd/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 Lesser General Public License as published by
  13   the Free Software Foundation; either version 2.1 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   Lesser General Public License for more details.
  20
  21   You should have received a copy of the GNU Lesser 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 #include <syslog.h>
  30
  31 #include <systemd/sd-id128.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 /* Journal APIs. See sd-journal(3) for more information. */
  38
  39 /* Write to daemon */
  40 int sd_journal_print(int priority, const char *format, ...) __attribute__ ((format (printf, 2, 3)));
  41 int sd_journal_printv(int priority, const char *format, va_list ap);
  42 int sd_journal_send(const char *format, ...) __attribute__((sentinel));
  43 int sd_journal_sendv(const struct iovec *iov, int n);
  44
  45 /* Used by the macros below. Don't call this directly. */
  46 int sd_journal_print_with_location(int priority, const char *file, const char *line, const char *func, const char *format, ...) __attribute__ ((format (printf, 5, 6)));
  47 int sd_journal_printv_with_location(int priority, const char *file, const char *line, const char *func, const char *format, va_list ap);
  48 int sd_journal_send_with_location(const char *file, const char *line, const char *func, const char *format, ...) __attribute__((sentinel));
  49 int sd_journal_sendv_with_location(const char *file, const char *line, const char *func, const struct iovec *iov, int n);
  50
  51 /* implicitly add code location to messages sent, if this is enabled */
  52 #ifndef SD_JOURNAL_SUPPRESS_LOCATION
  53
  54 #define _sd_XSTRINGIFY(x) #x
  55 #define _sd_STRINGIFY(x) _sd_XSTRINGIFY(x)
  56
  57 #define sd_journal_print(priority, ...) sd_journal_print_with_location(priority, "CODE_FILE=" __FILE__, "CODE_LINE=" _sd_STRINGIFY(__LINE__), __func__, __VA_ARGS__)
  58 #define sd_journal_printv(priority, format, ap) sd_journal_printv_with_location(priority, "CODE_FILE=" __FILE__, "CODE_LINE=" _sd_STRINGIFY(__LINE__), __func__, format, ap)
  59 #define sd_journal_send(...) sd_journal_send_with_location("CODE_FILE=" __FILE__, "CODE_LINE=" _sd_STRINGIFY(__LINE__), __func__, __VA_ARGS__)
  60 #define sd_journal_sendv(iovec, n) sd_journal_sendv_with_location("CODE_FILE=" __FILE__, "CODE_LINE=" _sd_STRINGIFY(__LINE__), __func__, iovec, n)
  61
  62 #endif
  63
  64 int sd_journal_stream_fd(const char *identifier, int priority, int level_prefix);
  65
  66 /* Browse journal stream */
  67
  68 typedef struct sd_journal sd_journal;
  69
  70 enum {
  71         SD_JOURNAL_LOCAL_ONLY = 1,
  72         SD_JOURNAL_RUNTIME_ONLY = 2,
  73         SD_JOURNAL_SYSTEM_ONLY = 4
  74 };
  75
  76 int sd_journal_open(sd_journal **ret, int flags);
  77 int sd_journal_open_directory(sd_journal **ret, const char *path, int flags);
  78 void sd_journal_close(sd_journal *j);
  79
  80 int sd_journal_previous(sd_journal *j);
  81 int sd_journal_next(sd_journal *j);
  82
  83 int sd_journal_previous_skip(sd_journal *j, uint64_t skip);
  84 int sd_journal_next_skip(sd_journal *j, uint64_t skip);
  85
  86 int sd_journal_get_realtime_usec(sd_journal *j, uint64_t *ret);
  87 int sd_journal_get_monotonic_usec(sd_journal *j, uint64_t *ret, sd_id128_t *ret_boot_id);
  88
  89 int sd_journal_get_data(sd_journal *j, const char *field, const void **data, size_t *l);
  90 int sd_journal_enumerate_data(sd_journal *j, const void **data, size_t *l);
  91 void sd_journal_restart_data(sd_journal *j);
  92
  93 int sd_journal_add_match(sd_journal *j, const void *data, size_t size);
  94 int sd_journal_add_disjunction(sd_journal *j);
  95 void sd_journal_flush_matches(sd_journal *j);
  96
  97 int sd_journal_seek_head(sd_journal *j);
  98 int sd_journal_seek_tail(sd_journal *j);
  99 int sd_journal_seek_monotonic_usec(sd_journal *j, sd_id128_t boot_id, uint64_t usec);
 100 int sd_journal_seek_realtime_usec(sd_journal *j, uint64_t usec);
 101 int sd_journal_seek_cursor(sd_journal *j, const char *cursor);
 102
 103 int sd_journal_get_cursor(sd_journal *j, char **cursor);
 104
 105 int sd_journal_get_cutoff_realtime_usec(sd_journal *j, uint64_t *from, uint64_t *to);
 106 int sd_journal_get_cutoff_monotonic_usec(sd_journal *j, const sd_id128_t boot_id, uint64_t *from, uint64_t *to);
 107
 108 /* int sd_journal_query_unique(sd_journal *j, const char *field);      /\* missing *\/ */
 109 /* int sd_journal_enumerate_unique(sd_journal *j, const void **data, size_t *l); /\* missing *\/ */
 110 /* void sd_journal_restart_unique(sd_journal *j);                      /\* missing *\/ */
 111
 112 enum {
 113         SD_JOURNAL_NOP,
 114         SD_JOURNAL_APPEND,
 115         SD_JOURNAL_INVALIDATE
 116 };
 117
 118 int sd_journal_get_fd(sd_journal *j);
 119 int sd_journal_process(sd_journal *j);
 120 int sd_journal_wait(sd_journal *j, uint64_t timeout_usec);
 121
 122 #define SD_JOURNAL_FOREACH(j)                                           \
 123         if (sd_journal_seek_head(j) >= 0)                               \
 124                 while (sd_journal_next(j) > 0)
 125
 126 #define SD_JOURNAL_FOREACH_BACKWARDS(j)                                 \
 127         if (sd_journal_seek_tail(j) >= 0)                               \
 128                 while (sd_journal_previous(j) > 0)
 129
 130 #define SD_JOURNAL_FOREACH_DATA(j, data, l)                             \
 131         for (sd_journal_restart_data(j); sd_journal_enumerate_data((j), &(data), &(l)) > 0; )
 132
 133 /* #define SD_JOURNAL_FOREACH_UNIQUE(j, data, l)                           \ */
 134 /*         for (sd_journal_restart_unique(j); sd_journal_enumerate_data((j), &(data), &(l)) > 0; ) */
 135
 136 #ifdef __cplusplus
 137 }
 138 #endif
 139
 140 #endif