1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
'\" t
.TH "SD_JOURNAL_NEXT" "3" "" "systemd 254" "sd_journal_next"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
sd_journal_next, sd_journal_previous, sd_journal_step_one, sd_journal_next_skip, sd_journal_previous_skip, SD_JOURNAL_FOREACH, SD_JOURNAL_FOREACH_BACKWARDS \- Advance or set back the read pointer in the journal
.SH "SYNOPSIS"
.sp
.ft B
.nf
#include <systemd/sd\-journal\&.h>
.fi
.ft
.HP \w'int\ sd_journal_next('u
.BI "int sd_journal_next(sd_journal\ *" "j" ");"
.HP \w'int\ sd_journal_previous('u
.BI "int sd_journal_previous(sd_journal\ *" "j" ");"
.HP \w'int\ sd_journal_step_one('u
.BI "int sd_journal_step_one(sd_journal\ *" "j" ", int\ " "advanced" ");"
.HP \w'int\ sd_journal_next_skip('u
.BI "int sd_journal_next_skip(sd_journal\ *" "j" ", uint64_t\ " "skip" ");"
.HP \w'int\ sd_journal_previous_skip('u
.BI "int sd_journal_previous_skip(sd_journal\ *" "j" ", uint64_t\ " "skip" ");"
.HP \w'SD_JOURNAL_FOREACH('u
.BI "SD_JOURNAL_FOREACH(sd_journal\ *" "j" ");"
.HP \w'SD_JOURNAL_FOREACH_BACKWARDS('u
.BI "SD_JOURNAL_FOREACH_BACKWARDS(sd_journal\ *" "j" ");"
.SH "DESCRIPTION"
.PP
\fBsd_journal_next()\fR
advances the read pointer into the journal by one entry\&. The only argument taken is a journal context object as allocated via
\fBsd_journal_open\fR(3)\&. After successful invocation the entry may be read with functions such as
\fBsd_journal_get_data\fR(3)\&.
.PP
Similarly,
\fBsd_journal_previous()\fR
sets the read pointer back one entry\&.
.PP
\fBsd_journal_step_one()\fR
also moves the read pointer\&. If the current location is the head of the journal, e\&.g\&. when this is called following
\fBsd_journal_seek_head()\fR, then this is equivalent to
\fBsd_journal_next()\fR, and the argument
\fIadvanced\fR
will be ignored\&. Similarly, if the current location is the tail of the journal, e\&.g\&. when this is called following
\fBsd_journal_seek_tail()\fR, then this is equivalent to
\fBsd_journal_previous()\fR, and
\fIadvanced\fR
will be ignored\&. Otherwise, this is equivalent to
\fBsd_journal_next()\fR
when
\fIadvanced\fR
is non\-zero, and
\fBsd_journal_previous()\fR
when
\fIadvanced\fR
is zero\&.
.PP
\fBsd_journal_next_skip()\fR
and
\fBsd_journal_previous_skip()\fR
advance/set back the read pointer by multiple entries at once, as specified in the
\fIskip\fR
parameter\&. The
\fIskip\fR
parameter must be less than or equal to 2147483647 (2\(S3\(S1\-1)\&.
.PP
The journal is strictly ordered by reception time, and hence advancing to the next entry guarantees that the entry then pointing to is later in time than then previous one, or has the same timestamp\&.
.PP
Note that
\fBsd_journal_get_data\fR(3)
and related calls will fail unless
\fBsd_journal_next()\fR
has been invoked at least once in order to position the read pointer on a journal entry\&.
.PP
Note that the
\fBSD_JOURNAL_FOREACH()\fR
macro may be used as a wrapper around
\fBsd_journal_seek_head\fR(3)
and
\fBsd_journal_next()\fR
in order to make iterating through the journal easier\&. See below for an example\&. Similarly,
\fBSD_JOURNAL_FOREACH_BACKWARDS()\fR
may be used for iterating the journal in reverse order\&.
.SH "RETURN VALUE"
.PP
The four calls return the number of entries advanced/set back on success or a negative errno\-style error code\&. When the end or beginning of the journal is reached, a number smaller than requested is returned\&. More specifically, if
\fBsd_journal_next()\fR
or
\fBsd_journal_previous()\fR
reach the end/beginning of the journal they will return 0, instead of 1 when they are successful\&. This should be considered an EOF marker\&.
.SH "NOTES"
.PP
All functions listed here are thread\-agnostic and only a single specific thread may operate on a given object during its entire lifetime\&. It\*(Aqs safe to allocate multiple independent objects and use each from a specific thread in parallel\&. However, it\*(Aqs not safe to allocate such an object in one thread, and operate or free it from any other, even if locking is used to ensure these threads don\*(Aqt operate on it at the very same time\&.
.PP
Functions described here are available as a shared library, which can be compiled against and linked to with the
\fBlibsystemd\fR\ \&\fBpkg-config\fR(1)
file\&.
.SH "EXAMPLES"
.PP
Iterating through the journal:
.sp
.if n \{\
.RS 4
.\}
.nf
/* SPDX\-License\-Identifier: MIT\-0 */
#include <errno\&.h>
#include <stdio\&.h>
#include <systemd/sd\-journal\&.h>
int main(int argc, char *argv[]) {
int r;
sd_journal *j;
r = sd_journal_open(&j, SD_JOURNAL_LOCAL_ONLY);
if (r < 0) {
errno = \-r;
fprintf(stderr, "Failed to open journal: %m\en");
return 1;
}
SD_JOURNAL_FOREACH(j) {
const char *d;
size_t l;
r = sd_journal_get_data(j, "MESSAGE", (const void **)&d, &l);
if (r < 0) {
errno = \-r;
fprintf(stderr, "Failed to read message field: %m\en");
continue;
}
printf("%\&.*s\en", (int) l, d);
}
sd_journal_close(j);
return 0;
}
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.PP
\fBsystemd\fR(1),
\fBsd-journal\fR(3),
\fBsd_journal_open\fR(3),
\fBsd_journal_get_data\fR(3),
\fBsd_journal_get_realtime_usec\fR(3),
\fBsd_journal_get_cursor\fR(3)
|
