src/systemd/sd-journal.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foosdjournalhfoo
   4 #define foosdjournalhfoo
   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 "sd-id128.h"
  32 #include "_sd-common.h"
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 /* Journal APIs. See sd-journal(3) for more information. */
  39
  40 /* Write to daemon */
  41 int sd_journal_print(int priority, const char *format, ...) _sd_printf_(2, 3);
  42 int sd_journal_printv(int priority, const char *format, va_list ap) _sd_printf_(2, 0);
  43 int sd_journal_send(const char *format, ...) _sd_printf_(1, 0) _sd_sentinel_;
  44 int sd_journal_sendv(const struct iovec *iov, int n);
  45 int sd_journal_perror(const char *message);
  46
  47 /* Used by the macros below. Don't call this directly. */
  48 int sd_journal_print_with_location(int priority, const char *file, const char *line, const char *func, const char *format, ...) _sd_printf_(5, 6);
  49 int sd_journal_printv_with_location(int priority, const char *file, const char *line, const char *func, const char *format, va_list ap) _sd_printf_(5, 0);
  50 int sd_journal_send_with_location(const char *file, const char *line, const char *func, const char *format, ...) _sd_printf_(4, 0) _sd_sentinel_;
  51 int sd_journal_sendv_with_location(const char *file, const char *line, const char *func, const struct iovec *iov, int n);
  52 int sd_journal_perror_with_location(const char *file, const char *line, const char *func, const char *message);
  53
  54 /* implicitly add code location to messages sent, if this is enabled */
  55 #ifndef SD_JOURNAL_SUPPRESS_LOCATION
  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 #define sd_journal_perror(message) sd_journal_perror_with_location("CODE_FILE=" __FILE__, "CODE_LINE=" _sd_stringify(__LINE__), __func__, message)
  62
  63 #endif
  64
  65 int sd_journal_stream_fd(const char *identifier, int priority, int level_prefix);
  66
  67 /* Browse journal stream */
  68
  69 typedef struct sd_journal sd_journal;
  70
  71 /* Open flags */
  72 enum {
  73         SD_JOURNAL_LOCAL_ONLY = 1,
  74         SD_JOURNAL_RUNTIME_ONLY = 2,
  75         SD_JOURNAL_SYSTEM = 4,
  76         SD_JOURNAL_CURRENT_USER = 8,
  77
  78         SD_JOURNAL_SYSTEM_ONLY = SD_JOURNAL_SYSTEM, /* deprecated name */
  79 };
  80
  81 /* Wakeup event types */
  82 enum {
  83         SD_JOURNAL_NOP,
  84         SD_JOURNAL_APPEND,
  85         SD_JOURNAL_INVALIDATE
  86 };
  87
  88 int sd_journal_open(sd_journal **ret, int flags);
  89 int sd_journal_open_directory(sd_journal **ret, const char *path, int flags);
  90 int sd_journal_open_files(sd_journal **ret, const char **paths, int flags);
  91 void sd_journal_close(sd_journal *j);
  92
  93 int sd_journal_previous(sd_journal *j);
  94 int sd_journal_next(sd_journal *j);
  95
  96 int sd_journal_previous_skip(sd_journal *j, uint64_t skip);
  97 int sd_journal_next_skip(sd_journal *j, uint64_t skip);
  98
  99 int sd_journal_get_realtime_usec(sd_journal *j, uint64_t *ret);
 100 int sd_journal_get_monotonic_usec(sd_journal *j, uint64_t *ret, sd_id128_t *ret_boot_id);
 101
 102 int sd_journal_set_data_threshold(sd_journal *j, size_t sz);
 103 int sd_journal_get_data_threshold(sd_journal *j, size_t *sz);
 104
 105 int sd_journal_get_data(sd_journal *j, const char *field, const void **data, size_t *l);
 106 int sd_journal_enumerate_data(sd_journal *j, const void **data, size_t *l);
 107 void sd_journal_restart_data(sd_journal *j);
 108
 109 int sd_journal_add_match(sd_journal *j, const void *data, size_t size);
 110 int sd_journal_add_disjunction(sd_journal *j);
 111 int sd_journal_add_conjunction(sd_journal *j);
 112 void sd_journal_flush_matches(sd_journal *j);
 113
 114 int sd_journal_seek_head(sd_journal *j);
 115 int sd_journal_seek_tail(sd_journal *j);
 116 int sd_journal_seek_monotonic_usec(sd_journal *j, sd_id128_t boot_id, uint64_t usec);
 117 int sd_journal_seek_realtime_usec(sd_journal *j, uint64_t usec);
 118 int sd_journal_seek_cursor(sd_journal *j, const char *cursor);
 119
 120 int sd_journal_get_cursor(sd_journal *j, char **cursor);
 121 int sd_journal_test_cursor(sd_journal *j, const char *cursor);
 122
 123 int sd_journal_get_cutoff_realtime_usec(sd_journal *j, uint64_t *from, uint64_t *to);
 124 int sd_journal_get_cutoff_monotonic_usec(sd_journal *j, const sd_id128_t boot_id, uint64_t *from, uint64_t *to);
 125
 126 int sd_journal_get_usage(sd_journal *j, uint64_t *bytes);
 127
 128 int sd_journal_query_unique(sd_journal *j, const char *field);
 129 int sd_journal_enumerate_unique(sd_journal *j, const void **data, size_t *l);
 130 void sd_journal_restart_unique(sd_journal *j);
 131
 132 int sd_journal_get_fd(sd_journal *j);
 133 int sd_journal_get_events(sd_journal *j);
 134 int sd_journal_get_timeout(sd_journal *j, uint64_t *timeout_usec);
 135 int sd_journal_process(sd_journal *j);
 136 int sd_journal_wait(sd_journal *j, uint64_t timeout_usec);
 137 int sd_journal_reliable_fd(sd_journal *j);
 138
 139 int sd_journal_get_catalog(sd_journal *j, char **text);
 140 int sd_journal_get_catalog_for_message_id(sd_id128_t id, char **ret);
 141
 142 #define SD_JOURNAL_FOREACH(j)                                           \
 143         if (sd_journal_seek_head(j) >= 0)                               \
 144                 while (sd_journal_next(j) > 0)
 145
 146 #define SD_JOURNAL_FOREACH_BACKWARDS(j)                                 \
 147         if (sd_journal_seek_tail(j) >= 0)                               \
 148                 while (sd_journal_previous(j) > 0)
 149
 150 #define SD_JOURNAL_FOREACH_DATA(j, data, l)                             \
 151         for (sd_journal_restart_data(j); sd_journal_enumerate_data((j), &(data), &(l)) > 0; )
 152
 153 #define SD_JOURNAL_FOREACH_UNIQUE(j, data, l)                           \
 154         for (sd_journal_restart_unique(j); sd_journal_enumerate_unique((j), &(data), &(l)) > 0; )
 155
 156 #ifdef __cplusplus
 157 }
 158 #endif
 159
 160 #endif