chiark / gitweb /
journal: add ability to list values a specified field can take in all entries of...
[elogind.git] / 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 int sd_journal_perror(const char *message);
45
46 /* Used by the macros below. Don't call this directly. */
47 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)));
48 int sd_journal_printv_with_location(int priority, const char *file, const char *line, const char *func, const char *format, va_list ap);
49 int sd_journal_send_with_location(const char *file, const char *line, const char *func, const char *format, ...) __attribute__((sentinel));
50 int sd_journal_sendv_with_location(const char *file, const char *line, const char *func, const struct iovec *iov, int n);
51 int sd_journal_perror_with_location(const char *file, const char *line, const char *func, const char *message);
52
53 /* implicitly add code location to messages sent, if this is enabled */
54 #ifndef SD_JOURNAL_SUPPRESS_LOCATION
55
56 #define _sd_XSTRINGIFY(x) #x
57 #define _sd_STRINGIFY(x) _sd_XSTRINGIFY(x)
58
59 #define sd_journal_print(priority, ...) sd_journal_print_with_location(priority, "CODE_FILE=" __FILE__, "CODE_LINE=" _sd_STRINGIFY(__LINE__), __func__, __VA_ARGS__)
60 #define sd_journal_printv(priority, format, ap) sd_journal_printv_with_location(priority, "CODE_FILE=" __FILE__, "CODE_LINE=" _sd_STRINGIFY(__LINE__), __func__, format, ap)
61 #define sd_journal_send(...) sd_journal_send_with_location("CODE_FILE=" __FILE__, "CODE_LINE=" _sd_STRINGIFY(__LINE__), __func__, __VA_ARGS__)
62 #define sd_journal_sendv(iovec, n) sd_journal_sendv_with_location("CODE_FILE=" __FILE__, "CODE_LINE=" _sd_STRINGIFY(__LINE__), __func__, iovec, n)
63 #define sd_journal_perror(message) sd_journal_perror_with_location("CODE_FILE=" __FILE__, "CODE_LINE=" _sd_STRINGIFY(__LINE__), __func__, message)
64
65 #endif
66
67 int sd_journal_stream_fd(const char *identifier, int priority, int level_prefix);
68
69 /* Browse journal stream */
70
71 typedef struct sd_journal sd_journal;
72
73 /* Open flags */
74 enum {
75         SD_JOURNAL_LOCAL_ONLY = 1,
76         SD_JOURNAL_RUNTIME_ONLY = 2,
77         SD_JOURNAL_SYSTEM_ONLY = 4
78 };
79
80 /* Wakeup event types */
81 enum {
82         SD_JOURNAL_NOP,
83         SD_JOURNAL_APPEND,
84         SD_JOURNAL_INVALIDATE
85 };
86
87 int sd_journal_open(sd_journal **ret, int flags);
88 int sd_journal_open_directory(sd_journal **ret, const char *path, int flags);
89 void sd_journal_close(sd_journal *j);
90
91 int sd_journal_previous(sd_journal *j);
92 int sd_journal_next(sd_journal *j);
93
94 int sd_journal_previous_skip(sd_journal *j, uint64_t skip);
95 int sd_journal_next_skip(sd_journal *j, uint64_t skip);
96
97 int sd_journal_get_realtime_usec(sd_journal *j, uint64_t *ret);
98 int sd_journal_get_monotonic_usec(sd_journal *j, uint64_t *ret, sd_id128_t *ret_boot_id);
99
100 int sd_journal_get_data(sd_journal *j, const char *field, const void **data, size_t *l);
101 int sd_journal_enumerate_data(sd_journal *j, const void **data, size_t *l);
102 void sd_journal_restart_data(sd_journal *j);
103
104 int sd_journal_add_match(sd_journal *j, const void *data, size_t size);
105 int sd_journal_add_disjunction(sd_journal *j);
106 void sd_journal_flush_matches(sd_journal *j);
107
108 int sd_journal_seek_head(sd_journal *j);
109 int sd_journal_seek_tail(sd_journal *j);
110 int sd_journal_seek_monotonic_usec(sd_journal *j, sd_id128_t boot_id, uint64_t usec);
111 int sd_journal_seek_realtime_usec(sd_journal *j, uint64_t usec);
112 int sd_journal_seek_cursor(sd_journal *j, const char *cursor);
113
114 int sd_journal_get_cursor(sd_journal *j, char **cursor);
115 int sd_journal_test_cursor(sd_journal *j, const char *cursor);
116
117 int sd_journal_get_cutoff_realtime_usec(sd_journal *j, uint64_t *from, uint64_t *to);
118 int sd_journal_get_cutoff_monotonic_usec(sd_journal *j, const sd_id128_t boot_id, uint64_t *from, uint64_t *to);
119
120 int sd_journal_get_usage(sd_journal *j, uint64_t *bytes);
121
122 int sd_journal_query_unique(sd_journal *j, const char *field);
123 int sd_journal_enumerate_unique(sd_journal *j, const void **data, size_t *l);
124 void sd_journal_restart_unique(sd_journal *j);
125
126 int sd_journal_get_fd(sd_journal *j);
127 int sd_journal_process(sd_journal *j);
128 int sd_journal_wait(sd_journal *j, uint64_t timeout_usec);
129
130 #define SD_JOURNAL_FOREACH(j)                                           \
131         if (sd_journal_seek_head(j) >= 0)                               \
132                 while (sd_journal_next(j) > 0)
133
134 #define SD_JOURNAL_FOREACH_BACKWARDS(j)                                 \
135         if (sd_journal_seek_tail(j) >= 0)                               \
136                 while (sd_journal_previous(j) > 0)
137
138 #define SD_JOURNAL_FOREACH_DATA(j, data, l)                             \
139         for (sd_journal_restart_data(j); sd_journal_enumerate_data((j), &(data), &(l)) > 0; )
140
141 #define SD_JOURNAL_FOREACH_UNIQUE(j, data, l)                           \
142         for (sd_journal_restart_unique(j); sd_journal_enumerate_unique((j), &(data), &(l)) > 0; )
143
144 #ifdef __cplusplus
145 }
146 #endif
147
148 #endif