]>
Commit | Line | Data |
---|---|---|
53e1b683 | 1 | /* SPDX-License-Identifier: LGPL-2.1+ */ |
ef63833d | 2 | |
ef63833d | 3 | #include <fcntl.h> |
4f5dd394 | 4 | #include <sys/epoll.h> |
ef63833d | 5 | #include <sys/mman.h> |
4871690d | 6 | #include <sys/socket.h> |
4f5dd394 | 7 | #include <unistd.h> |
ef63833d | 8 | |
8bebb09c | 9 | #include "sd-device.h" |
4f5dd394 | 10 | #include "sd-messages.h" |
ef63833d | 11 | |
e6a7ec4b | 12 | #include "alloc-util.h" |
8bebb09c | 13 | #include "device-util.h" |
4f5dd394 | 14 | #include "escape.h" |
3ffd4af2 | 15 | #include "fd-util.h" |
f97b34a6 | 16 | #include "format-util.h" |
afc5dbf3 | 17 | #include "io-util.h" |
3ffd4af2 | 18 | #include "journald-kmsg.h" |
d025f1e4 | 19 | #include "journald-server.h" |
35e2e347 | 20 | #include "journald-syslog.h" |
6bedfcbb | 21 | #include "parse-util.h" |
0b452006 | 22 | #include "process-util.h" |
15a5e950 | 23 | #include "stdio-util.h" |
07630cea | 24 | #include "string-util.h" |
ef63833d LP |
25 | |
26 | void server_forward_kmsg( | |
27 | Server *s, | |
28 | int priority, | |
29 | const char *identifier, | |
30 | const char *message, | |
3b3154df | 31 | const struct ucred *ucred) { |
ef63833d | 32 | |
e6a7ec4b | 33 | _cleanup_free_ char *ident_buf = NULL; |
ef63833d | 34 | struct iovec iovec[5]; |
3b97fcbd | 35 | char header_priority[DECIMAL_STR_MAX(priority) + 3], |
fbd0b64f | 36 | header_pid[STRLEN("[]: ") + DECIMAL_STR_MAX(pid_t) + 1]; |
ef63833d | 37 | int n = 0; |
ef63833d LP |
38 | |
39 | assert(s); | |
40 | assert(priority >= 0); | |
41 | assert(priority <= 999); | |
42 | assert(message); | |
43 | ||
44 | if (_unlikely_(LOG_PRI(priority) > s->max_level_kmsg)) | |
45 | return; | |
46 | ||
47 | if (_unlikely_(s->dev_kmsg_fd < 0)) | |
48 | return; | |
49 | ||
50 | /* Never allow messages with kernel facility to be written to | |
51 | * kmsg, regardless where the data comes from. */ | |
52 | priority = syslog_fixup_facility(priority); | |
53 | ||
54 | /* First: priority field */ | |
5ffa8c81 | 55 | xsprintf(header_priority, "<%i>", priority); |
e6a7ec4b | 56 | iovec[n++] = IOVEC_MAKE_STRING(header_priority); |
ef63833d LP |
57 | |
58 | /* Second: identifier and PID */ | |
59 | if (ucred) { | |
60 | if (!identifier) { | |
61 | get_process_comm(ucred->pid, &ident_buf); | |
62 | identifier = ident_buf; | |
63 | } | |
64 | ||
5ffa8c81 | 65 | xsprintf(header_pid, "["PID_FMT"]: ", ucred->pid); |
ef63833d LP |
66 | |
67 | if (identifier) | |
e6a7ec4b | 68 | iovec[n++] = IOVEC_MAKE_STRING(identifier); |
ef63833d | 69 | |
e6a7ec4b | 70 | iovec[n++] = IOVEC_MAKE_STRING(header_pid); |
ef63833d | 71 | } else if (identifier) { |
e6a7ec4b LP |
72 | iovec[n++] = IOVEC_MAKE_STRING(identifier); |
73 | iovec[n++] = IOVEC_MAKE_STRING(": "); | |
ef63833d LP |
74 | } |
75 | ||
76 | /* Fourth: message */ | |
e6a7ec4b LP |
77 | iovec[n++] = IOVEC_MAKE_STRING(message); |
78 | iovec[n++] = IOVEC_MAKE_STRING("\n"); | |
ef63833d LP |
79 | |
80 | if (writev(s->dev_kmsg_fd, iovec, n) < 0) | |
56f64d95 | 81 | log_debug_errno(errno, "Failed to write to /dev/kmsg for logging: %m"); |
ef63833d LP |
82 | } |
83 | ||
fe167298 AJ |
84 | static bool is_us(const char *identifier, const char *pid) { |
85 | pid_t pid_num; | |
ef63833d | 86 | |
fe167298 AJ |
87 | if (!identifier || !pid) |
88 | return false; | |
ef63833d | 89 | |
fe167298 | 90 | if (parse_pid(pid, &pid_num) < 0) |
ef63833d LP |
91 | return false; |
92 | ||
fe167298 AJ |
93 | return pid_num == getpid_cached() && |
94 | streq(identifier, program_invocation_short_name); | |
ef63833d LP |
95 | } |
96 | ||
8857fb9b | 97 | void dev_kmsg_record(Server *s, char *p, size_t l) { |
d3070fbd | 98 | |
e6a7ec4b | 99 | _cleanup_free_ char *message = NULL, *syslog_priority = NULL, *syslog_pid = NULL, *syslog_facility = NULL, *syslog_identifier = NULL, *source_time = NULL, *identifier = NULL, *pid = NULL; |
d3070fbd LP |
100 | struct iovec iovec[N_IOVEC_META_FIELDS + 7 + N_IOVEC_KERNEL_FIELDS + 2 + N_IOVEC_UDEV_FIELDS]; |
101 | char *kernel_device = NULL; | |
e9f600f2 | 102 | unsigned long long usec; |
d3070fbd LP |
103 | size_t n = 0, z = 0, j; |
104 | int priority, r; | |
e6a7ec4b | 105 | char *e, *f, *k; |
ef63833d LP |
106 | uint64_t serial; |
107 | size_t pl; | |
ef63833d LP |
108 | |
109 | assert(s); | |
110 | assert(p); | |
111 | ||
112 | if (l <= 0) | |
113 | return; | |
114 | ||
115 | e = memchr(p, ',', l); | |
116 | if (!e) | |
117 | return; | |
118 | *e = 0; | |
119 | ||
120 | r = safe_atoi(p, &priority); | |
121 | if (r < 0 || priority < 0 || priority > 999) | |
122 | return; | |
123 | ||
b3600346 | 124 | if (s->forward_to_kmsg && LOG_FAC(priority) != LOG_KERN) |
ef63833d LP |
125 | return; |
126 | ||
127 | l -= (e - p) + 1; | |
128 | p = e + 1; | |
129 | e = memchr(p, ',', l); | |
130 | if (!e) | |
131 | return; | |
132 | *e = 0; | |
133 | ||
134 | r = safe_atou64(p, &serial); | |
135 | if (r < 0) | |
136 | return; | |
137 | ||
138 | if (s->kernel_seqnum) { | |
139 | /* We already read this one? */ | |
140 | if (serial < *s->kernel_seqnum) | |
141 | return; | |
142 | ||
143 | /* Did we lose any? */ | |
144 | if (serial > *s->kernel_seqnum) | |
13181942 | 145 | server_driver_message(s, 0, |
2b044526 | 146 | "MESSAGE_ID=" SD_MESSAGE_JOURNAL_MISSED_STR, |
8a03c9ef ZJS |
147 | LOG_MESSAGE("Missed %"PRIu64" kernel messages", |
148 | serial - *s->kernel_seqnum), | |
149 | NULL); | |
ef63833d LP |
150 | |
151 | /* Make sure we never read this one again. Note that | |
152 | * we always store the next message serial we expect | |
153 | * here, simply because this makes handling the first | |
154 | * message with serial 0 easy. */ | |
155 | *s->kernel_seqnum = serial + 1; | |
156 | } | |
157 | ||
158 | l -= (e - p) + 1; | |
159 | p = e + 1; | |
160 | f = memchr(p, ';', l); | |
161 | if (!f) | |
162 | return; | |
163 | /* Kernel 3.6 has the flags field, kernel 3.5 lacks that */ | |
164 | e = memchr(p, ',', l); | |
165 | if (!e || f < e) | |
166 | e = f; | |
167 | *e = 0; | |
168 | ||
e9f600f2 | 169 | r = safe_atollu(p, &usec); |
ef63833d LP |
170 | if (r < 0) |
171 | return; | |
172 | ||
173 | l -= (f - p) + 1; | |
174 | p = f + 1; | |
175 | e = memchr(p, '\n', l); | |
176 | if (!e) | |
177 | return; | |
178 | *e = 0; | |
179 | ||
180 | pl = e - p; | |
181 | l -= (e - p) + 1; | |
182 | k = e + 1; | |
183 | ||
184 | for (j = 0; l > 0 && j < N_IOVEC_KERNEL_FIELDS; j++) { | |
185 | char *m; | |
dc61b7e4 | 186 | /* Metadata fields attached */ |
ef63833d LP |
187 | |
188 | if (*k != ' ') | |
189 | break; | |
190 | ||
313cefa1 | 191 | k++, l--; |
ef63833d LP |
192 | |
193 | e = memchr(k, '\n', l); | |
194 | if (!e) | |
30eddcd5 | 195 | goto finish; |
ef63833d LP |
196 | |
197 | *e = 0; | |
198 | ||
527b7a42 | 199 | if (cunescape_length_with_prefix(k, e - k, "_KERNEL_", UNESCAPE_RELAX, &m) < 0) |
ef63833d LP |
200 | break; |
201 | ||
202 | if (startswith(m, "_KERNEL_DEVICE=")) | |
203 | kernel_device = m + 15; | |
204 | ||
e6a7ec4b | 205 | iovec[n++] = IOVEC_MAKE_STRING(m); |
ef63833d LP |
206 | z++; |
207 | ||
208 | l -= (e - k) + 1; | |
209 | k = e + 1; | |
210 | } | |
211 | ||
212 | if (kernel_device) { | |
8bebb09c | 213 | _cleanup_(sd_device_unrefp) sd_device *d = NULL; |
ef63833d | 214 | |
8bebb09c | 215 | if (sd_device_new_from_device_id(&d, kernel_device) >= 0) { |
ef63833d | 216 | const char *g; |
ef63833d LP |
217 | char *b; |
218 | ||
8bebb09c | 219 | if (sd_device_get_devname(d, &g) >= 0) { |
ef63833d LP |
220 | b = strappend("_UDEV_DEVNODE=", g); |
221 | if (b) { | |
e6a7ec4b | 222 | iovec[n++] = IOVEC_MAKE_STRING(b); |
ef63833d LP |
223 | z++; |
224 | } | |
225 | } | |
226 | ||
8bebb09c | 227 | if (sd_device_get_sysname(d, &g) >= 0) { |
ef63833d LP |
228 | b = strappend("_UDEV_SYSNAME=", g); |
229 | if (b) { | |
e6a7ec4b | 230 | iovec[n++] = IOVEC_MAKE_STRING(b); |
ef63833d LP |
231 | z++; |
232 | } | |
233 | } | |
234 | ||
235 | j = 0; | |
8bebb09c | 236 | FOREACH_DEVICE_DEVLINK(d, g) { |
ef63833d LP |
237 | |
238 | if (j > N_IOVEC_UDEV_FIELDS) | |
239 | break; | |
240 | ||
8bebb09c YW |
241 | b = strappend("_UDEV_DEVLINK=", g); |
242 | if (b) { | |
243 | iovec[n++] = IOVEC_MAKE_STRING(b); | |
244 | z++; | |
ef63833d LP |
245 | } |
246 | ||
247 | j++; | |
248 | } | |
ef63833d LP |
249 | } |
250 | } | |
251 | ||
e9f600f2 | 252 | if (asprintf(&source_time, "_SOURCE_MONOTONIC_TIMESTAMP=%llu", usec) >= 0) |
e6a7ec4b | 253 | iovec[n++] = IOVEC_MAKE_STRING(source_time); |
ef63833d | 254 | |
e6a7ec4b | 255 | iovec[n++] = IOVEC_MAKE_STRING("_TRANSPORT=kernel"); |
ef63833d LP |
256 | |
257 | if (asprintf(&syslog_priority, "PRIORITY=%i", priority & LOG_PRIMASK) >= 0) | |
e6a7ec4b | 258 | iovec[n++] = IOVEC_MAKE_STRING(syslog_priority); |
ef63833d | 259 | |
36dd072c | 260 | if (asprintf(&syslog_facility, "SYSLOG_FACILITY=%i", LOG_FAC(priority)) >= 0) |
e6a7ec4b | 261 | iovec[n++] = IOVEC_MAKE_STRING(syslog_facility); |
36dd072c | 262 | |
b3600346 | 263 | if (LOG_FAC(priority) == LOG_KERN) |
e6a7ec4b | 264 | iovec[n++] = IOVEC_MAKE_STRING("SYSLOG_IDENTIFIER=kernel"); |
ef63833d | 265 | else { |
e88baee8 | 266 | pl -= syslog_parse_identifier((const char**) &p, &identifier, &pid); |
ef63833d LP |
267 | |
268 | /* Avoid any messages we generated ourselves via | |
269 | * log_info() and friends. */ | |
fe167298 | 270 | if (is_us(identifier, pid)) |
ef63833d LP |
271 | goto finish; |
272 | ||
273 | if (identifier) { | |
274 | syslog_identifier = strappend("SYSLOG_IDENTIFIER=", identifier); | |
275 | if (syslog_identifier) | |
e6a7ec4b | 276 | iovec[n++] = IOVEC_MAKE_STRING(syslog_identifier); |
ef63833d LP |
277 | } |
278 | ||
279 | if (pid) { | |
280 | syslog_pid = strappend("SYSLOG_PID=", pid); | |
281 | if (syslog_pid) | |
e6a7ec4b | 282 | iovec[n++] = IOVEC_MAKE_STRING(syslog_pid); |
ef63833d | 283 | } |
ef63833d LP |
284 | } |
285 | ||
527b7a42 | 286 | if (cunescape_length_with_prefix(p, pl, "MESSAGE=", UNESCAPE_RELAX, &message) >= 0) |
e6a7ec4b | 287 | iovec[n++] = IOVEC_MAKE_STRING(message); |
ef63833d | 288 | |
22e3a02b | 289 | server_dispatch_message(s, iovec, n, ELEMENTSOF(iovec), NULL, NULL, priority, 0); |
ef63833d LP |
290 | |
291 | finish: | |
292 | for (j = 0; j < z; j++) | |
293 | free(iovec[j].iov_base); | |
ef63833d LP |
294 | } |
295 | ||
f9a810be | 296 | static int server_read_dev_kmsg(Server *s) { |
ef63833d LP |
297 | char buffer[8192+1]; /* the kernel-side limit per record is 8K currently */ |
298 | ssize_t l; | |
299 | ||
300 | assert(s); | |
301 | assert(s->dev_kmsg_fd >= 0); | |
302 | ||
303 | l = read(s->dev_kmsg_fd, buffer, sizeof(buffer) - 1); | |
304 | if (l == 0) | |
305 | return 0; | |
306 | if (l < 0) { | |
307 | /* Old kernels who don't allow reading from /dev/kmsg | |
308 | * return EINVAL when we try. So handle this cleanly, | |
309 | * but don' try to ever read from it again. */ | |
310 | if (errno == EINVAL) { | |
f9a810be | 311 | s->dev_kmsg_event_source = sd_event_source_unref(s->dev_kmsg_event_source); |
ef63833d LP |
312 | return 0; |
313 | } | |
314 | ||
3742095b | 315 | if (IN_SET(errno, EAGAIN, EINTR, EPIPE)) |
ef63833d LP |
316 | return 0; |
317 | ||
e1427b13 | 318 | return log_error_errno(errno, "Failed to read from kernel: %m"); |
ef63833d LP |
319 | } |
320 | ||
321 | dev_kmsg_record(s, buffer, l); | |
322 | return 1; | |
323 | } | |
324 | ||
325 | int server_flush_dev_kmsg(Server *s) { | |
326 | int r; | |
327 | ||
328 | assert(s); | |
329 | ||
330 | if (s->dev_kmsg_fd < 0) | |
331 | return 0; | |
332 | ||
333 | if (!s->dev_kmsg_readable) | |
334 | return 0; | |
335 | ||
2b43f939 | 336 | log_debug("Flushing /dev/kmsg..."); |
ef63833d LP |
337 | |
338 | for (;;) { | |
339 | r = server_read_dev_kmsg(s); | |
340 | if (r < 0) | |
341 | return r; | |
342 | ||
343 | if (r == 0) | |
344 | break; | |
345 | } | |
346 | ||
347 | return 0; | |
348 | } | |
349 | ||
f9a810be LP |
350 | static int dispatch_dev_kmsg(sd_event_source *es, int fd, uint32_t revents, void *userdata) { |
351 | Server *s = userdata; | |
352 | ||
353 | assert(es); | |
354 | assert(fd == s->dev_kmsg_fd); | |
355 | assert(s); | |
356 | ||
357 | if (revents & EPOLLERR) | |
358 | log_warning("/dev/kmsg buffer overrun, some messages lost."); | |
359 | ||
360 | if (!(revents & EPOLLIN)) | |
361 | log_error("Got invalid event from epoll for /dev/kmsg: %"PRIx32, revents); | |
362 | ||
363 | return server_read_dev_kmsg(s); | |
364 | } | |
365 | ||
ef63833d | 366 | int server_open_dev_kmsg(Server *s) { |
b2392ff3 | 367 | mode_t mode; |
f9a810be | 368 | int r; |
ef63833d LP |
369 | |
370 | assert(s); | |
371 | ||
b2392ff3 SS |
372 | if (s->read_kmsg) |
373 | mode = O_RDWR|O_CLOEXEC|O_NONBLOCK|O_NOCTTY; | |
374 | else | |
375 | mode = O_WRONLY|O_CLOEXEC|O_NONBLOCK|O_NOCTTY; | |
376 | ||
377 | s->dev_kmsg_fd = open("/dev/kmsg", mode); | |
ef63833d | 378 | if (s->dev_kmsg_fd < 0) { |
445ea9be LP |
379 | log_full(errno == ENOENT ? LOG_DEBUG : LOG_WARNING, |
380 | "Failed to open /dev/kmsg, ignoring: %m"); | |
ef63833d LP |
381 | return 0; |
382 | } | |
383 | ||
b2392ff3 SS |
384 | if (!s->read_kmsg) |
385 | return 0; | |
386 | ||
151b9b96 | 387 | r = sd_event_add_io(s->event, &s->dev_kmsg_event_source, s->dev_kmsg_fd, EPOLLIN, dispatch_dev_kmsg, s); |
f9a810be | 388 | if (r < 0) { |
ef63833d LP |
389 | |
390 | /* This will fail with EPERM on older kernels where | |
391 | * /dev/kmsg is not readable. */ | |
c0f71f46 LP |
392 | if (r == -EPERM) { |
393 | r = 0; | |
394 | goto fail; | |
395 | } | |
ef63833d | 396 | |
da927ba9 | 397 | log_error_errno(r, "Failed to add /dev/kmsg fd to event loop: %m"); |
c0f71f46 | 398 | goto fail; |
f9a810be LP |
399 | } |
400 | ||
401 | r = sd_event_source_set_priority(s->dev_kmsg_event_source, SD_EVENT_PRIORITY_IMPORTANT+10); | |
402 | if (r < 0) { | |
da927ba9 | 403 | log_error_errno(r, "Failed to adjust priority of kmsg event source: %m"); |
c0f71f46 | 404 | goto fail; |
ef63833d LP |
405 | } |
406 | ||
407 | s->dev_kmsg_readable = true; | |
408 | ||
409 | return 0; | |
c0f71f46 LP |
410 | |
411 | fail: | |
03e334a1 LP |
412 | s->dev_kmsg_event_source = sd_event_source_unref(s->dev_kmsg_event_source); |
413 | s->dev_kmsg_fd = safe_close(s->dev_kmsg_fd); | |
c0f71f46 LP |
414 | |
415 | return r; | |
ef63833d LP |
416 | } |
417 | ||
418 | int server_open_kernel_seqnum(Server *s) { | |
03e334a1 | 419 | _cleanup_close_ int fd; |
ef63833d | 420 | uint64_t *p; |
7bb87460 | 421 | int r; |
ef63833d LP |
422 | |
423 | assert(s); | |
424 | ||
425 | /* We store the seqnum we last read in an mmaped file. That | |
426 | * way we can just use it like a variable, but it is | |
b2e6df73 | 427 | * persistent and automatically flushed at reboot. */ |
ef63833d LP |
428 | |
429 | fd = open("/run/systemd/journal/kernel-seqnum", O_RDWR|O_CREAT|O_CLOEXEC|O_NOCTTY|O_NOFOLLOW, 0644); | |
430 | if (fd < 0) { | |
56f64d95 | 431 | log_error_errno(errno, "Failed to open /run/systemd/journal/kernel-seqnum, ignoring: %m"); |
ef63833d LP |
432 | return 0; |
433 | } | |
434 | ||
7bb87460 MS |
435 | r = posix_fallocate(fd, 0, sizeof(uint64_t)); |
436 | if (r != 0) { | |
437 | log_error_errno(r, "Failed to allocate sequential number file, ignoring: %m"); | |
ef63833d LP |
438 | return 0; |
439 | } | |
440 | ||
441 | p = mmap(NULL, sizeof(uint64_t), PROT_READ|PROT_WRITE, MAP_SHARED, fd, 0); | |
442 | if (p == MAP_FAILED) { | |
56f64d95 | 443 | log_error_errno(errno, "Failed to map sequential number file, ignoring: %m"); |
ef63833d LP |
444 | return 0; |
445 | } | |
446 | ||
ef63833d LP |
447 | s->kernel_seqnum = p; |
448 | ||
449 | return 0; | |
450 | } |