logs-show.c 20 KB
Newer Older
1
2
3
4
5
6
7
8
/*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/

/***
  This file is part of systemd.

  Copyright 2012 Lennart Poettering

  systemd is free software; you can redistribute it and/or modify it
9
10
  under the terms of the GNU Lesser General Public License as published by
  the Free Software Foundation; either version 2.1 of the License, or
11
12
13
14
15
  (at your option) any later version.

  systemd is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16
  Lesser General Public License for more details.
17

18
  You should have received a copy of the GNU Lesser General Public License
19
20
21
22
23
24
  along with systemd; If not, see <http://www.gnu.org/licenses/>.
***/

#include <time.h>
#include <assert.h>
#include <errno.h>
25
#include <sys/poll.h>
26
#include <string.h>
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

#include "logs-show.h"
#include "log.h"
#include "util.h"

#define PRINT_THRESHOLD 128

static bool contains_unprintable(const void *p, size_t l) {
        const char *j;

        for (j = p; j < (const char *) p + l; j++)
                if (*j < ' ' || *j >= 127)
                        return true;

        return false;
}

44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
static int parse_field(const void *data, size_t length, const char *field, char **target, size_t *target_size) {
        size_t fl, nl;
        void *buf;

        assert(data);
        assert(field);
        assert(target);
        assert(target_size);

        fl = strlen(field);
        if (length < fl)
                return 0;

        if (memcmp(data, field, fl))
                return 0;

        nl = length - fl;
61
62
63
        buf = malloc(nl+1);
        memcpy(buf, (const char*) data + fl, nl);
        ((char*)buf)[nl] = 0;
64
65
66
67
68
        if (!buf) {
                log_error("Out of memory");
                return -ENOMEM;
        }

Lennart Poettering's avatar
Lennart Poettering committed
69
        free(*target);
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
        *target = buf;
        *target_size = nl;

        return 1;
}

static bool shall_print(bool show_all, char *p, size_t l) {
        if (show_all)
                return true;

        if (l > PRINT_THRESHOLD)
                return false;

        if (contains_unprintable(p, l))
                return false;

        return true;
}

89
static int output_short(sd_journal *j, unsigned line, unsigned n_columns, bool show_all, bool monotonic_mode) {
90
91
92
93
        int r;
        const void *data;
        size_t length;
        size_t n = 0;
94
95
        char *hostname = NULL, *identifier = NULL, *comm = NULL, *pid = NULL, *fake_pid = NULL, *message = NULL, *realtime = NULL, *monotonic = NULL;
        size_t hostname_len = 0, identifier_len = 0, comm_len = 0, pid_len = 0, fake_pid_len = 0, message_len = 0, realtime_len = 0, monotonic_len = 0;
96
97
98

        assert(j);

99
100
101
102
103
104
105
106
        SD_JOURNAL_FOREACH_DATA(j, data, length) {

                r = parse_field(data, length, "_HOSTNAME=", &hostname, &hostname_len);
                if (r < 0)
                        goto finish;
                else if (r > 0)
                        continue;

107
                r = parse_field(data, length, "SYSLOG_IDENTIFIER=", &identifier, &identifier_len);
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
                if (r < 0)
                        goto finish;
                else if (r > 0)
                        continue;

                r = parse_field(data, length, "_COMM=", &comm, &comm_len);
                if (r < 0)
                        goto finish;
                else if (r > 0)
                        continue;

                r = parse_field(data, length, "_PID=", &pid, &pid_len);
                if (r < 0)
                        goto finish;
                else if (r > 0)
                        continue;

Lennart Poettering's avatar
Lennart Poettering committed
125
126
127
128
129
130
                r = parse_field(data, length, "SYSLOG_PID=", &fake_pid, &fake_pid_len);
                if (r < 0)
                        goto finish;
                else if (r > 0)
                        continue;

131
132
133
134
135
136
137
138
139
140
141
142
                r = parse_field(data, length, "_SOURCE_REALTIME_TIMESTAMP=", &realtime, &realtime_len);
                if (r < 0)
                        goto finish;
                else if (r > 0)
                        continue;

                r = parse_field(data, length, "_SOURCE_MONOTONIC_TIMESTAMP=", &monotonic, &monotonic_len);
                if (r < 0)
                        goto finish;
                else if (r > 0)
                        continue;

143
144
145
146
147
148
149
150
151
152
                r = parse_field(data, length, "MESSAGE=", &message, &message_len);
                if (r < 0)
                        goto finish;
        }

        if (!message) {
                r = 0;
                goto finish;
        }

153
        if (monotonic_mode) {
154
                uint64_t t;
155
156
                sd_id128_t boot_id;

157
158
159
160
161
162
                r = -ENOENT;

                if (monotonic)
                        r = safe_atou64(monotonic, &t);

                if (r < 0)
163
                        r = sd_journal_get_monotonic_usec(j, &t, &boot_id);
164

165
166
167
                if (r < 0) {
                        log_error("Failed to get monotonic: %s", strerror(-r));
                        goto finish;
168
169
                }

170
171
172
173
174
175
                printf("[%5llu.%06llu]",
                       (unsigned long long) (t / USEC_PER_SEC),
                       (unsigned long long) (t % USEC_PER_SEC));

                n += 1 + 5 + 1 + 6 + 1;

176
177
        } else {
                char buf[64];
178
                uint64_t x;
179
180
                time_t t;
                struct tm tm;
181

182
183
184
185
186
187
188
                r = -ENOENT;

                if (realtime)
                        r = safe_atou64(realtime, &x);

                if (r < 0)
                        r = sd_journal_get_realtime_usec(j, &x);
189
190
191
192
193
194

                if (r < 0) {
                        log_error("Failed to get realtime: %s", strerror(-r));
                        goto finish;
                }

195
                t = (time_t) (x / USEC_PER_SEC);
196
197
198
199
200
201
202
203
                if (strftime(buf, sizeof(buf), "%b %d %H:%M:%S", localtime_r(&t, &tm)) <= 0) {
                        log_error("Failed to format time.");
                        goto finish;
                }

                fputs(buf, stdout);
                n += strlen(buf);
        }
204

205
206
207
208
209
        if (hostname && shall_print(show_all, hostname, hostname_len)) {
                printf(" %.*s", (int) hostname_len, hostname);
                n += hostname_len + 1;
        }

210
211
212
        if (identifier && shall_print(show_all, identifier, identifier_len)) {
                printf(" %.*s", (int) identifier_len, identifier);
                n += identifier_len + 1;
213
214
215
        } else if (comm && shall_print(show_all, comm, comm_len)) {
                printf(" %.*s", (int) comm_len, comm);
                n += comm_len + 1;
216
217
        } else
                putchar(' ');
218

219
220
221
        if (pid && shall_print(show_all, pid, pid_len)) {
                printf("[%.*s]", (int) pid_len, pid);
                n += pid_len + 2;
Lennart Poettering's avatar
Lennart Poettering committed
222
223
224
        } else if (fake_pid && shall_print(show_all, fake_pid, fake_pid_len)) {
                printf("[%.*s]", (int) fake_pid_len, fake_pid);
                n += fake_pid_len + 2;
225
226
        }

227
228
        if (show_all)
                printf(": %.*s\n", (int) message_len, message);
229
230
231
        else if (contains_unprintable(message, message_len)) {
                char bytes[FORMAT_BYTES_MAX];
                printf(": [%s blob data]\n", format_bytes(bytes, sizeof(bytes), message_len));
232
        } else if (message_len + n < n_columns)
233
                printf(": %.*s\n", (int) message_len, message);
234
        else if (n < n_columns) {
235
236
                char *e;

237
                e = ellipsize_mem(message, message_len, n_columns - n - 2, 90);
238
239
240
241

                if (!e)
                        printf(": %.*s\n", (int) message_len, message);
                else
242
                        printf(": %s\n", e);
243
244
245
246
247
248
249
250
251

                free(e);
        } else
                fputs("\n", stdout);

        r = 0;

finish:
        free(hostname);
252
        free(identifier);
253
254
        free(comm);
        free(pid);
Lennart Poettering's avatar
Lennart Poettering committed
255
        free(fake_pid);
256
        free(message);
257
258
        free(monotonic);
        free(realtime);
259

260
        return r;
261
262
}

263
264
static int output_short_realtime(sd_journal *j, unsigned line, unsigned n_columns, bool show_all) {
        return output_short(j, line, n_columns, show_all, false);
265
266
}

267
268
static int output_short_monotonic(sd_journal *j, unsigned line, unsigned n_columns, bool show_all) {
        return output_short(j, line, n_columns, show_all, true);
269
270
}

271
static int output_verbose(sd_journal *j, unsigned line, unsigned n_columns, bool show_all) {
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
        const void *data;
        size_t length;
        char *cursor;
        uint64_t realtime;
        char ts[FORMAT_TIMESTAMP_MAX];
        int r;

        assert(j);

        r = sd_journal_get_realtime_usec(j, &realtime);
        if (r < 0) {
                log_error("Failed to get realtime timestamp: %s", strerror(-r));
                return r;
        }

        r = sd_journal_get_cursor(j, &cursor);
        if (r < 0) {
                log_error("Failed to get cursor: %s", strerror(-r));
                return r;
        }

        printf("%s [%s]\n",
               format_timestamp(ts, sizeof(ts), realtime),
               cursor);

        free(cursor);

        SD_JOURNAL_FOREACH_DATA(j, data, length) {
                if (!show_all && (length > PRINT_THRESHOLD ||
                                  contains_unprintable(data, length))) {
                        const char *c;
303
                        char bytes[FORMAT_BYTES_MAX];
304
305
306
307
308
309
310

                        c = memchr(data, '=', length);
                        if (!c) {
                                log_error("Invalid field.");
                                return -EINVAL;
                        }

311
                        printf("\t%.*s=[%s blob data]\n",
312
                               (int) (c - (const char*) data),
313
314
                               (const char*) data,
                               format_bytes(bytes, sizeof(bytes), length - (c - (const char *) data) - 1));
315
316
317
318
319
320
321
                } else
                        printf("\t%.*s\n", (int) length, (const char*) data);
        }

        return 0;
}

322
static int output_export(sd_journal *j, unsigned line, unsigned n_columns, bool show_all) {
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
        sd_id128_t boot_id;
        char sid[33];
        int r;
        usec_t realtime, monotonic;
        char *cursor;
        const void *data;
        size_t length;

        assert(j);

        r = sd_journal_get_realtime_usec(j, &realtime);
        if (r < 0) {
                log_error("Failed to get realtime timestamp: %s", strerror(-r));
                return r;
        }

        r = sd_journal_get_monotonic_usec(j, &monotonic, &boot_id);
        if (r < 0) {
                log_error("Failed to get monotonic timestamp: %s", strerror(-r));
                return r;
        }

        r = sd_journal_get_cursor(j, &cursor);
        if (r < 0) {
                log_error("Failed to get cursor: %s", strerror(-r));
                return r;
        }

351
        printf("__CURSOR=%s\n"
352
353
               "__REALTIME_TIMESTAMP=%llu\n"
               "__MONOTONIC_TIMESTAMP=%llu\n"
354
               "_BOOT_ID=%s\n",
355
356
357
358
359
360
361
362
363
               cursor,
               (unsigned long long) realtime,
               (unsigned long long) monotonic,
               sd_id128_to_string(boot_id, sid));

        free(cursor);

        SD_JOURNAL_FOREACH_DATA(j, data, length) {

364
365
366
367
368
369
                /* We already printed the boot id, from the data in
                 * the header, hence let's suppress it here */
                if (length >= 9 &&
                    memcmp(data, "_BOOT_ID=", 9) == 0)
                        continue;

370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
                if (contains_unprintable(data, length)) {
                        const char *c;
                        uint64_t le64;

                        c = memchr(data, '=', length);
                        if (!c) {
                                log_error("Invalid field.");
                                return -EINVAL;
                        }

                        fwrite(data, c - (const char*) data, 1, stdout);
                        fputc('\n', stdout);
                        le64 = htole64(length - (c - (const char*) data) - 1);
                        fwrite(&le64, sizeof(le64), 1, stdout);
                        fwrite(c + 1, length - (c - (const char*) data) - 1, 1, stdout);
                } else
                        fwrite(data, length, 1, stdout);

                fputc('\n', stdout);
        }

        fputc('\n', stdout);

        return 0;
}

static void json_escape(const char* p, size_t l) {

        if (contains_unprintable(p, l)) {
                bool not_first = false;

                fputs("[ ", stdout);

                while (l > 0) {
                        if (not_first)
                                printf(", %u", (uint8_t) *p);
                        else {
                                not_first = true;
                                printf("%u", (uint8_t) *p);
                        }

                        p++;
                        l--;
                }

                fputs(" ]", stdout);
        } else {
                fputc('\"', stdout);

                while (l > 0) {
                        if (*p == '"' || *p == '\\') {
                                fputc('\\', stdout);
                                fputc(*p, stdout);
                        } else
                                fputc(*p, stdout);

                        p++;
                        l--;
                }

                fputc('\"', stdout);
        }
}

434
static int output_json(sd_journal *j, unsigned line, unsigned n_columns, bool show_all) {
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
        uint64_t realtime, monotonic;
        char *cursor;
        const void *data;
        size_t length;
        sd_id128_t boot_id;
        char sid[33];
        int r;

        assert(j);

        r = sd_journal_get_realtime_usec(j, &realtime);
        if (r < 0) {
                log_error("Failed to get realtime timestamp: %s", strerror(-r));
                return r;
        }

        r = sd_journal_get_monotonic_usec(j, &monotonic, &boot_id);
        if (r < 0) {
                log_error("Failed to get monotonic timestamp: %s", strerror(-r));
                return r;
        }

        r = sd_journal_get_cursor(j, &cursor);
        if (r < 0) {
                log_error("Failed to get cursor: %s", strerror(-r));
                return r;
        }

        if (line == 1)
                fputc('\n', stdout);
        else
                fputs(",\n", stdout);

        printf("{\n"
469
               "\t\"__CURSOR\" : \"%s\",\n"
470
471
               "\t\"__REALTIME_TIMESTAMP\" : \"%llu\",\n"
               "\t\"__MONOTONIC_TIMESTAMP\" : \"%llu\",\n"
472
               "\t\"_BOOT_ID\" : \"%s\"",
473
474
475
476
477
478
479
480
481
482
               cursor,
               (unsigned long long) realtime,
               (unsigned long long) monotonic,
               sd_id128_to_string(boot_id, sid));

        free(cursor);

        SD_JOURNAL_FOREACH_DATA(j, data, length) {
                const char *c;

483
484
485
486
487
488
                /* We already printed the boot id, from the data in
                 * the header, hence let's suppress it here */
                if (length >= 9 &&
                    memcmp(data, "_BOOT_ID=", 9) == 0)
                        continue;

489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
                c = memchr(data, '=', length);
                if (!c) {
                        log_error("Invalid field.");
                        return -EINVAL;
                }

                fputs(",\n\t", stdout);
                json_escape(data, c - (const char*) data);
                fputs(" : ", stdout);
                json_escape(c + 1, length - (c - (const char*) data) - 1);
        }

        fputs("\n}", stdout);
        fflush(stdout);

        return 0;
}

507
static int output_cat(sd_journal *j, unsigned line, unsigned n_columns, bool show_all) {
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
        const void *data;
        size_t l;
        int r;

        assert(j);

        r = sd_journal_get_data(j, "MESSAGE", &data, &l);
        if (r < 0) {
                log_error("Failed to get data: %s", strerror(-r));
                return r;
        }

        assert(l >= 8);

        fwrite((const char*) data + 8, 1, l - 8, stdout);
        putchar('\n');

        return 0;
}

528
static int (*output_funcs[_OUTPUT_MODE_MAX])(sd_journal*j, unsigned line, unsigned n_columns, bool show_all) = {
529
530
        [OUTPUT_SHORT] = output_short_realtime,
        [OUTPUT_SHORT_MONOTONIC] = output_short_monotonic,
531
532
        [OUTPUT_VERBOSE] = output_verbose,
        [OUTPUT_EXPORT] = output_export,
533
534
        [OUTPUT_JSON] = output_json,
        [OUTPUT_CAT] = output_cat
535
536
};

537
int output_journal(sd_journal *j, OutputMode mode, unsigned line, unsigned n_columns, bool show_all) {
538
        assert(mode >= 0);
539
540
        assert(mode < _OUTPUT_MODE_MAX);

541
542
543
544
        if (n_columns <= 0)
                n_columns = columns();

        return output_funcs[mode](j, line, n_columns, show_all);
545
546
}

547
548
549
int show_journal_by_unit(
                const char *unit,
                OutputMode mode,
550
551
552
                unsigned n_columns,
                usec_t not_before,
                unsigned how_many,
553
554
                bool show_all,
                bool follow) {
555
556
557
558

        char *m = NULL;
        sd_journal *j;
        int r;
559
560
561
        int fd;
        unsigned line = 0;
        bool need_seek = false;
562

563
564
565
566
567
568
569
570
571
        assert(mode >= 0);
        assert(mode < _OUTPUT_MODE_MAX);
        assert(unit);

        if (!endswith(unit, ".service") &&
            !endswith(unit, ".socket") &&
            !endswith(unit, ".mount") &&
            !endswith(unit, ".swap"))
                return 0;
572

573
        if (how_many <= 0)
574
575
                return 0;

576
        if (asprintf(&m, "_SYSTEMD_UNIT=%s", unit) < 0) {
577
578
579
580
581
582
583
584
                r = -ENOMEM;
                goto finish;
        }

        r = sd_journal_open(&j, SD_JOURNAL_LOCAL_ONLY|SD_JOURNAL_SYSTEM_ONLY);
        if (r < 0)
                goto finish;

585
586
587
588
        fd = sd_journal_get_fd(j);
        if (fd < 0)
                goto finish;

589
590
591
592
593
594
595
596
        r = sd_journal_add_match(j, m, strlen(m));
        if (r < 0)
                goto finish;

        r = sd_journal_seek_tail(j);
        if (r < 0)
                goto finish;

597
598
599
        r = sd_journal_previous_skip(j, how_many);
        if (r < 0)
                goto finish;
600

601
602
603
604
        if (mode == OUTPUT_JSON) {
                fputc('[', stdout);
                fflush(stdout);
        }
605

606
607
608
609
610
611
612
613
614
615
616
617
        for (;;) {
                for (;;) {
                        usec_t usec;

                        if (need_seek) {
                                r = sd_journal_next(j);
                                if (r < 0)
                                        goto finish;
                        }

                        if (r == 0)
                                break;
618

619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
                        need_seek = true;

                        if (not_before > 0) {
                                r = sd_journal_get_monotonic_usec(j, &usec, NULL);

                                /* -ESTALE is returned if the
                                   timestamp is not from this boot */
                                if (r == -ESTALE)
                                        continue;
                                else if (r < 0)
                                        goto finish;

                                if (usec < not_before)
                                        continue;
                        }

                        line ++;

637
                        r = output_journal(j, mode, line, n_columns, show_all);
638
639
640
641
642
                        if (r < 0)
                                goto finish;
                }

                if (!follow)
643
644
                        break;

Lennart Poettering's avatar
Lennart Poettering committed
645
                r = fd_wait_for_event(fd, POLLIN, (usec_t) -1);
646
647
                if (r < 0)
                        goto finish;
648
649
650
651
652

                r = sd_journal_process(j);
                if (r < 0)
                        goto finish;

653
654
        }

655
656
657
        if (mode == OUTPUT_JSON)
                fputs("\n]\n", stdout);

658
659
660
661
662
663
664
665
666
finish:
        if (m)
                free(m);

        if (j)
                sd_journal_close(j);

        return r;
}
667
668
669

static const char *const output_mode_table[_OUTPUT_MODE_MAX] = {
        [OUTPUT_SHORT] = "short",
670
        [OUTPUT_SHORT_MONOTONIC] = "short-monotonic",
671
672
        [OUTPUT_VERBOSE] = "verbose",
        [OUTPUT_EXPORT] = "export",
673
674
        [OUTPUT_JSON] = "json",
        [OUTPUT_CAT] = "cat"
675
676
677
};

DEFINE_STRING_TABLE_LOOKUP(output_mode, OutputMode);