src/journal/journald-server.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #pragma once
   3
   4 /***
   5   This file is part of systemd.
   6
   7   Copyright 2011 Lennart Poettering
   8
   9   systemd is free software; you can redistribute it and/or modify it
  10   under the terms of the GNU Lesser General Public License as published by
  11   the Free Software Foundation; either version 2.1 of the License, or
  12   (at your option) any later version.
  13
  14   systemd is distributed in the hope that it will be useful, but
  15   WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  17   Lesser General Public License for more details.
  18
  19   You should have received a copy of the GNU Lesser General Public License
  20   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  21 ***/
  22
  23 #include <stdbool.h>
  24 #include <sys/types.h>
  25
  26 #include "sd-event.h"
  27
  28 typedef struct Server Server;
  29
  30 #include "hashmap.h"
  31 #include "journal-file.h"
  32 #include "journald-context.h"
  33 #include "journald-rate-limit.h"
  34 #include "journald-stream.h"
  35 #include "list.h"
  36 #include "prioq.h"
  37
  38 typedef enum Storage {
  39         STORAGE_AUTO,
  40         STORAGE_VOLATILE,
  41         STORAGE_PERSISTENT,
  42         STORAGE_NONE,
  43         _STORAGE_MAX,
  44         _STORAGE_INVALID = -1
  45 } Storage;
  46
  47 typedef enum SplitMode {
  48         SPLIT_UID,
  49         SPLIT_LOGIN, /* deprecated */
  50         SPLIT_NONE,
  51         _SPLIT_MAX,
  52         _SPLIT_INVALID = -1
  53 } SplitMode;
  54
  55 typedef struct JournalStorageSpace {
  56         usec_t   timestamp;
  57
  58         uint64_t available;
  59         uint64_t limit;
  60
  61         uint64_t vfs_used; /* space used by journal files */
  62         uint64_t vfs_available;
  63 } JournalStorageSpace;
  64
  65 typedef struct JournalStorage {
  66         const char *name;
  67         char *path;
  68
  69         JournalMetrics metrics;
  70         JournalStorageSpace space;
  71 } JournalStorage;
  72
  73 struct Server {
  74         int syslog_fd;
  75         int native_fd;
  76         int stdout_fd;
  77         int dev_kmsg_fd;
  78         int audit_fd;
  79         int hostname_fd;
  80         int notify_fd;
  81
  82         sd_event *event;
  83
  84         sd_event_source *syslog_event_source;
  85         sd_event_source *native_event_source;
  86         sd_event_source *stdout_event_source;
  87         sd_event_source *dev_kmsg_event_source;
  88         sd_event_source *audit_event_source;
  89         sd_event_source *sync_event_source;
  90         sd_event_source *sigusr1_event_source;
  91         sd_event_source *sigusr2_event_source;
  92         sd_event_source *sigterm_event_source;
  93         sd_event_source *sigint_event_source;
  94         sd_event_source *sigrtmin1_event_source;
  95         sd_event_source *hostname_event_source;
  96         sd_event_source *notify_event_source;
  97         sd_event_source *watchdog_event_source;
  98
  99         JournalFile *runtime_journal;
 100         JournalFile *system_journal;
 101         OrderedHashmap *user_journals;
 102
 103         uint64_t seqnum;
 104
 105         char *buffer;
 106         size_t buffer_size;
 107
 108         JournalRateLimit *rate_limit;
 109         usec_t sync_interval_usec;
 110         usec_t rate_limit_interval;
 111         unsigned rate_limit_burst;
 112
 113         JournalStorage runtime_storage;
 114         JournalStorage system_storage;
 115
 116         bool compress;
 117         bool seal;
 118         bool read_kmsg;
 119
 120         bool forward_to_kmsg;
 121         bool forward_to_syslog;
 122         bool forward_to_console;
 123         bool forward_to_wall;
 124
 125         unsigned n_forward_syslog_missed;
 126         usec_t last_warn_forward_syslog_missed;
 127
 128         uint64_t var_available_timestamp;
 129
 130         usec_t max_retention_usec;
 131         usec_t max_file_usec;
 132         usec_t oldest_file_usec;
 133
 134         LIST_HEAD(StdoutStream, stdout_streams);
 135         LIST_HEAD(StdoutStream, stdout_streams_notify_queue);
 136         unsigned n_stdout_streams;
 137
 138         char *tty_path;
 139
 140         int max_level_store;
 141         int max_level_syslog;
 142         int max_level_kmsg;
 143         int max_level_console;
 144         int max_level_wall;
 145
 146         Storage storage;
 147         SplitMode split_mode;
 148
 149         MMapCache *mmap;
 150
 151         Set *deferred_closes;
 152
 153         struct udev *udev;
 154
 155         uint64_t *kernel_seqnum;
 156         bool dev_kmsg_readable:1;
 157
 158         bool send_watchdog:1;
 159         bool sent_notify_ready:1;
 160         bool sync_scheduled:1;
 161
 162         char machine_id_field[sizeof("_MACHINE_ID=") + 32];
 163         char boot_id_field[sizeof("_BOOT_ID=") + 32];
 164         char *hostname_field;
 165
 166         /* Cached cgroup root, so that we don't have to query that all the time */
 167         char *cgroup_root;
 168
 169         usec_t watchdog_usec;
 170
 171         usec_t last_realtime_clock;
 172
 173         size_t line_max;
 174
 175         /* Caching of client metadata */
 176         Hashmap *client_contexts;
 177         Prioq *client_contexts_lru;
 178
 179         ClientContext *my_context; /* the context of journald itself */
 180         ClientContext *pid1_context; /* the context of PID 1 */
 181 };
 182
 183 #define SERVER_MACHINE_ID(s) ((s)->machine_id_field + STRLEN("_MACHINE_ID="))
 184
 185 /* Extra fields for any log messages */
 186 #define N_IOVEC_META_FIELDS 22
 187
 188 /* Extra fields for log messages that contain OBJECT_PID= (i.e. log about another process) */
 189 #define N_IOVEC_OBJECT_FIELDS 18
 190
 191 /* Maximum number of fields we'll add in for driver (i.e. internal) messages */
 192 #define N_IOVEC_PAYLOAD_FIELDS 16
 193
 194 /* kmsg: Maximum number of extra fields we'll import from the kernel's /dev/kmsg */
 195 #define N_IOVEC_KERNEL_FIELDS 64
 196
 197 /* kmsg: Maximum number of extra fields we'll import from udev's devices */
 198 #define N_IOVEC_UDEV_FIELDS 32
 199
 200 void server_dispatch_message(Server *s, struct iovec *iovec, size_t n, size_t m, ClientContext *c, const struct timeval *tv, int priority, pid_t object_pid);
 201 void server_driver_message(Server *s, pid_t object_pid, const char *message_id, const char *format, ...) _sentinel_ _printf_(4,0);
 202
 203 /* gperf lookup function */
 204 const struct ConfigPerfItem* journald_gperf_lookup(const char *key, GPERF_LEN_TYPE length);
 205
 206 int config_parse_storage(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 207 int config_parse_line_max(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 208
 209 const char *storage_to_string(Storage s) _const_;
 210 Storage storage_from_string(const char *s) _pure_;
 211
 212 int config_parse_split_mode(const char *unit, const char *filename, unsigned line, const char *section, unsigned section_line, const char *lvalue, int ltype, const char *rvalue, void *data, void *userdata);
 213
 214 const char *split_mode_to_string(SplitMode s) _const_;
 215 SplitMode split_mode_from_string(const char *s) _pure_;
 216
 217 int server_init(Server *s);
 218 void server_done(Server *s);
 219 void server_sync(Server *s);
 220 int server_vacuum(Server *s, bool verbose);
 221 void server_rotate(Server *s);
 222 int server_schedule_sync(Server *s, int priority);
 223 int server_flush_to_var(Server *s, bool require_flag_file);
 224 void server_maybe_append_tags(Server *s);
 225 int server_process_datagram(sd_event_source *es, int fd, uint32_t revents, void *userdata);
 226 void server_space_usage_message(Server *s, JournalStorage *storage);