1 /* SPDX-License-Identifier: LGPL-2.1+ */
2 #ifndef foosdjournalhfoo
3 #define foosdjournalhfoo
6 systemd is free software; you can redistribute it and/or modify it
7 under the terms of the GNU Lesser General Public License as published by
8 the Free Software Foundation; either version 2.1 of the License, or
9 (at your option) any later version.
11 systemd is distributed in the hope that it will be useful, but
12 WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Lesser General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public License
17 along with systemd; If not, see <http://www.gnu.org/licenses/>.
22 #include <sys/types.h>
28 #include "_sd-common.h"
30 /* Journal APIs. See sd-journal(3) for more information. */
32 _SD_BEGIN_DECLARATIONS
;
35 int sd_journal_print(int priority
, const char *format
, ...) _sd_printf_(2, 3);
36 int sd_journal_printv(int priority
, const char *format
, va_list ap
) _sd_printf_(2, 0);
37 int sd_journal_send(const char *format
, ...) _sd_printf_(1, 0) _sd_sentinel_
;
38 int sd_journal_sendv(const struct iovec
*iov
, int n
);
39 int sd_journal_perror(const char *message
);
41 /* Used by the macros below. You probably don't want to call this directly. */
42 int sd_journal_print_with_location(int priority
, const char *file
, const char *line
, const char *func
, const char *format
, ...) _sd_printf_(5, 6);
43 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);
44 int sd_journal_send_with_location(const char *file
, const char *line
, const char *func
, const char *format
, ...) _sd_printf_(4, 0) _sd_sentinel_
;
45 int sd_journal_sendv_with_location(const char *file
, const char *line
, const char *func
, const struct iovec
*iov
, int n
);
46 int sd_journal_perror_with_location(const char *file
, const char *line
, const char *func
, const char *message
);
48 /* implicitly add code location to messages sent, if this is enabled */
49 #ifndef SD_JOURNAL_SUPPRESS_LOCATION
51 #define sd_journal_print(priority, ...) sd_journal_print_with_location(priority, "CODE_FILE=" __FILE__, "CODE_LINE=" _SD_STRINGIFY(__LINE__), __func__, __VA_ARGS__)
52 #define sd_journal_printv(priority, format, ap) sd_journal_printv_with_location(priority, "CODE_FILE=" __FILE__, "CODE_LINE=" _SD_STRINGIFY(__LINE__), __func__, format, ap)
53 #define sd_journal_send(...) sd_journal_send_with_location("CODE_FILE=" __FILE__, "CODE_LINE=" _SD_STRINGIFY(__LINE__), __func__, __VA_ARGS__)
54 #define sd_journal_sendv(iovec, n) sd_journal_sendv_with_location("CODE_FILE=" __FILE__, "CODE_LINE=" _SD_STRINGIFY(__LINE__), __func__, iovec, n)
55 #define sd_journal_perror(message) sd_journal_perror_with_location("CODE_FILE=" __FILE__, "CODE_LINE=" _SD_STRINGIFY(__LINE__), __func__, message)
59 int sd_journal_stream_fd(const char *identifier
, int priority
, int level_prefix
);
61 /* Browse journal stream */
63 typedef struct sd_journal sd_journal
;
67 SD_JOURNAL_LOCAL_ONLY
= 1 << 0,
68 SD_JOURNAL_RUNTIME_ONLY
= 1 << 1,
69 SD_JOURNAL_SYSTEM
= 1 << 2,
70 SD_JOURNAL_CURRENT_USER
= 1 << 3,
71 SD_JOURNAL_OS_ROOT
= 1 << 4,
72 SD_JOURNAL_ALL_NAMESPACES
= 1 << 5, /* Show all namespaces, not just the default or specified one */
73 SD_JOURNAL_INCLUDE_DEFAULT_NAMESPACE
= 1 << 6, /* Show default namespace in addition to specified one */
75 SD_JOURNAL_SYSTEM_ONLY _sd_deprecated_
= SD_JOURNAL_SYSTEM
/* old name */
78 /* Wakeup event types */
85 int sd_journal_open(sd_journal
**ret
, int flags
);
86 int sd_journal_open_namespace(sd_journal
**ret
, const char *name_space
, int flags
);
87 int sd_journal_open_directory(sd_journal
**ret
, const char *path
, int flags
);
88 int sd_journal_open_directory_fd(sd_journal
**ret
, int fd
, int flags
);
89 int sd_journal_open_files(sd_journal
**ret
, const char **paths
, int flags
);
90 int sd_journal_open_files_fd(sd_journal
**ret
, int fds
[], unsigned n_fds
, int flags
);
91 int sd_journal_open_container(sd_journal
**ret
, const char *machine
, int flags
) _sd_deprecated_
;
92 void sd_journal_close(sd_journal
*j
);
94 int sd_journal_previous(sd_journal
*j
);
95 int sd_journal_next(sd_journal
*j
);
97 int sd_journal_previous_skip(sd_journal
*j
, uint64_t skip
);
98 int sd_journal_next_skip(sd_journal
*j
, uint64_t skip
);
100 int sd_journal_get_realtime_usec(sd_journal
*j
, uint64_t *ret
);
101 int sd_journal_get_monotonic_usec(sd_journal
*j
, uint64_t *ret
, sd_id128_t
*ret_boot_id
);
103 int sd_journal_set_data_threshold(sd_journal
*j
, size_t sz
);
104 int sd_journal_get_data_threshold(sd_journal
*j
, size_t *sz
);
106 int sd_journal_get_data(sd_journal
*j
, const char *field
, const void **data
, size_t *l
);
107 int sd_journal_enumerate_data(sd_journal
*j
, const void **data
, size_t *l
);
108 int sd_journal_enumerate_available_data(sd_journal
*j
, const void **data
, size_t *l
);
109 void sd_journal_restart_data(sd_journal
*j
);
111 int sd_journal_add_match(sd_journal
*j
, const void *data
, size_t size
);
112 int sd_journal_add_disjunction(sd_journal
*j
);
113 int sd_journal_add_conjunction(sd_journal
*j
);
114 void sd_journal_flush_matches(sd_journal
*j
);
116 int sd_journal_seek_head(sd_journal
*j
);
117 int sd_journal_seek_tail(sd_journal
*j
);
118 int sd_journal_seek_monotonic_usec(sd_journal
*j
, sd_id128_t boot_id
, uint64_t usec
);
119 int sd_journal_seek_realtime_usec(sd_journal
*j
, uint64_t usec
);
120 int sd_journal_seek_cursor(sd_journal
*j
, const char *cursor
);
122 int sd_journal_get_cursor(sd_journal
*j
, char **cursor
);
123 int sd_journal_test_cursor(sd_journal
*j
, const char *cursor
);
125 int sd_journal_get_cutoff_realtime_usec(sd_journal
*j
, uint64_t *from
, uint64_t *to
);
126 int sd_journal_get_cutoff_monotonic_usec(sd_journal
*j
, const sd_id128_t boot_id
, uint64_t *from
, uint64_t *to
);
128 int sd_journal_get_usage(sd_journal
*j
, uint64_t *bytes
);
130 int sd_journal_query_unique(sd_journal
*j
, const char *field
);
131 int sd_journal_enumerate_unique(sd_journal
*j
, const void **data
, size_t *l
);
132 int sd_journal_enumerate_available_unique(sd_journal
*j
, const void **data
, size_t *l
);
133 void sd_journal_restart_unique(sd_journal
*j
);
135 int sd_journal_enumerate_fields(sd_journal
*j
, const char **field
);
136 void sd_journal_restart_fields(sd_journal
*j
);
138 int sd_journal_get_fd(sd_journal
*j
);
139 int sd_journal_get_events(sd_journal
*j
);
140 int sd_journal_get_timeout(sd_journal
*j
, uint64_t *timeout_usec
);
141 int sd_journal_process(sd_journal
*j
);
142 int sd_journal_wait(sd_journal
*j
, uint64_t timeout_usec
);
143 int sd_journal_reliable_fd(sd_journal
*j
);
145 int sd_journal_get_catalog(sd_journal
*j
, char **text
);
146 int sd_journal_get_catalog_for_message_id(sd_id128_t id
, char **text
);
148 int sd_journal_has_runtime_files(sd_journal
*j
);
149 int sd_journal_has_persistent_files(sd_journal
*j
);
151 /* The inverse condition avoids ambiguity of dangling 'else' after the macro */
152 #define SD_JOURNAL_FOREACH(j) \
153 if (sd_journal_seek_head(j) < 0) { } \
154 else while (sd_journal_next(j) > 0)
156 /* The inverse condition avoids ambiguity of dangling 'else' after the macro */
157 #define SD_JOURNAL_FOREACH_BACKWARDS(j) \
158 if (sd_journal_seek_tail(j) < 0) { } \
159 else while (sd_journal_previous(j) > 0)
161 /* Iterate through all available data fields of the current journal entry */
162 #define SD_JOURNAL_FOREACH_DATA(j, data, l) \
163 for (sd_journal_restart_data(j); sd_journal_enumerate_available_data((j), &(data), &(l)) > 0; )
165 /* Iterate through all available values of a specific field */
166 #define SD_JOURNAL_FOREACH_UNIQUE(j, data, l) \
167 for (sd_journal_restart_unique(j); sd_journal_enumerate_available_unique((j), &(data), &(l)) > 0; )
169 /* Iterate through all known field names */
170 #define SD_JOURNAL_FOREACH_FIELD(j, field) \
171 for (sd_journal_restart_fields(j); sd_journal_enumerate_fields((j), &(field)) > 0; )
173 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_journal
, sd_journal_close
);
175 _SD_END_DECLARATIONS
;