src/journal/journald-server.h

   1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
   2 #pragma once
   3
   4 #include <stdbool.h>
   5 #include <sys/types.h>
   6
   7 #include "sd-event.h"
   8
   9 typedef struct Server Server;
  10
  11 #include "conf-parser.h"
  12 #include "hashmap.h"
  13 #include "journald-context.h"
  14 #include "journald-rate-limit.h"
  15 #include "journald-stream.h"
  16 #include "list.h"
  17 #include "managed-journal-file.h"
  18 #include "prioq.h"
  19 #include "ratelimit.h"
  20 #include "time-util.h"
  21 #include "varlink.h"
  22
  23 typedef enum Storage {
  24         STORAGE_AUTO,
  25         STORAGE_VOLATILE,
  26         STORAGE_PERSISTENT,
  27         STORAGE_NONE,
  28         _STORAGE_MAX,
  29         _STORAGE_INVALID = -EINVAL,
  30 } Storage;
  31
  32 typedef enum SplitMode {
  33         SPLIT_UID,
  34         SPLIT_LOGIN, /* deprecated */
  35         SPLIT_NONE,
  36         _SPLIT_MAX,
  37         _SPLIT_INVALID = -EINVAL,
  38 } SplitMode;
  39
  40 typedef struct JournalCompressOptions {
  41         bool enabled;
  42         uint64_t threshold_bytes;
  43 } JournalCompressOptions;
  44
  45 typedef struct JournalStorageSpace {
  46         usec_t   timestamp;
  47
  48         uint64_t available;
  49         uint64_t limit;
  50
  51         uint64_t vfs_used; /* space used by journal files */
  52         uint64_t vfs_available;
  53 } JournalStorageSpace;
  54
  55 typedef struct JournalStorage {
  56         const char *name;
  57         char *path;
  58
  59         JournalMetrics metrics;
  60         JournalStorageSpace space;
  61 } JournalStorage;
  62
  63 /* This structure will be kept in $RUNTIME_DIRECTORY/seqnum and is mapped by journald, and is used to
  64  * maintain the sequence number counter with its seqnum ID */
  65 typedef struct SeqnumData {
  66         sd_id128_t id;
  67         uint64_t seqnum;
  68 } SeqnumData;
  69
  70 struct Server {
  71         char *namespace;
  72
  73         int syslog_fd;
  74         int native_fd;
  75         int stdout_fd;
  76         int dev_kmsg_fd;
  77         int audit_fd;
  78         int hostname_fd;
  79         int notify_fd;
  80
  81         sd_event *event;
  82
  83         sd_event_source *syslog_event_source;
  84         sd_event_source *native_event_source;
  85         sd_event_source *stdout_event_source;
  86         sd_event_source *dev_kmsg_event_source;
  87         sd_event_source *audit_event_source;
  88         sd_event_source *sync_event_source;
  89         sd_event_source *sigusr1_event_source;
  90         sd_event_source *sigusr2_event_source;
  91         sd_event_source *sigterm_event_source;
  92         sd_event_source *sigint_event_source;
  93         sd_event_source *sigrtmin1_event_source;
  94         sd_event_source *hostname_event_source;
  95         sd_event_source *notify_event_source;
  96         sd_event_source *watchdog_event_source;
  97         sd_event_source *idle_event_source;
  98
  99         ManagedJournalFile *runtime_journal;
 100         ManagedJournalFile *system_journal;
 101         OrderedHashmap *user_journals;
 102
 103         SeqnumData *seqnum;
 104
 105         char *buffer;
 106
 107         JournalRateLimit *ratelimit;
 108         usec_t sync_interval_usec;
 109         usec_t ratelimit_interval;
 110         unsigned ratelimit_burst;
 111
 112         JournalStorage runtime_storage;
 113         JournalStorage system_storage;
 114
 115         JournalCompressOptions compress;
 116         bool seal;
 117         bool read_kmsg;
 118         int set_audit;
 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         usec_t max_retention_usec;
 129         usec_t max_file_usec;
 130         usec_t oldest_file_usec;
 131
 132         LIST_HEAD(StdoutStream, stdout_streams);
 133         LIST_HEAD(StdoutStream, stdout_streams_notify_queue);
 134         unsigned n_stdout_streams;
 135
 136         char *tty_path;
 137
 138         int max_level_store;
 139         int max_level_syslog;
 140         int max_level_kmsg;
 141         int max_level_console;
 142         int max_level_wall;
 143
 144         Storage storage;
 145         SplitMode split_mode;
 146
 147         MMapCache *mmap;
 148
 149         Set *deferred_closes;
 150
 151         uint64_t *kernel_seqnum;
 152         bool dev_kmsg_readable:1;
 153         RateLimit kmsg_own_ratelimit;
 154
 155         bool send_watchdog:1;
 156         bool sent_notify_ready:1;
 157         bool sync_scheduled:1;
 158
 159         char machine_id_field[sizeof("_MACHINE_ID=") + 32];
 160         char boot_id_field[sizeof("_BOOT_ID=") + 32];
 161         char *hostname_field;
 162         char *namespace_field;
 163         char *runtime_directory;
 164
 165         /* Cached cgroup root, so that we don't have to query that all the time */
 166         char *cgroup_root;
 167
 168         usec_t watchdog_usec;
 169
 170         usec_t last_realtime_clock;
 171
 172         size_t line_max;
 173
 174         /* Caching of client metadata */
 175         Hashmap *client_contexts;
 176         Prioq *client_contexts_lru;
 177
 178         usec_t last_cache_pid_flush;
 179
 180         ClientContext *my_context; /* the context of journald itself */
 181         ClientContext *pid1_context; /* the context of PID 1 */
 182
 183         VarlinkServer *varlink_server;
 184 };
 185
 186 #define SERVER_MACHINE_ID(s) ((s)->machine_id_field + STRLEN("_MACHINE_ID="))
 187
 188 /* Extra fields for any log messages */
 189 #define N_IOVEC_META_FIELDS 24
 190
 191 /* Extra fields for log messages that contain OBJECT_PID= (i.e. log about another process) */
 192 #define N_IOVEC_OBJECT_FIELDS 18
 193
 194 /* Maximum number of fields we'll add in for driver (i.e. internal) messages */
 195 #define N_IOVEC_PAYLOAD_FIELDS 16
 196
 197 /* kmsg: Maximum number of extra fields we'll import from the kernel's /dev/kmsg */
 198 #define N_IOVEC_KERNEL_FIELDS 64
 199
 200 /* kmsg: Maximum number of extra fields we'll import from udev's devices */
 201 #define N_IOVEC_UDEV_FIELDS 32
 202
 203 /* audit: Maximum number of extra fields we'll import from audit messages */
 204 #define N_IOVEC_AUDIT_FIELDS 64
 205
 206 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);
 207 void server_driver_message(Server *s, pid_t object_pid, const char *message_id, const char *format, ...) _sentinel_ _printf_(4,0);
 208
 209 /* gperf lookup function */
 210 const struct ConfigPerfItem* journald_gperf_lookup(const char *key, GPERF_LEN_TYPE length);
 211
 212 CONFIG_PARSER_PROTOTYPE(config_parse_storage);
 213 CONFIG_PARSER_PROTOTYPE(config_parse_line_max);
 214 CONFIG_PARSER_PROTOTYPE(config_parse_compress);
 215
 216 const char *storage_to_string(Storage s) _const_;
 217 Storage storage_from_string(const char *s) _pure_;
 218
 219 CONFIG_PARSER_PROTOTYPE(config_parse_split_mode);
 220
 221 const char *split_mode_to_string(SplitMode s) _const_;
 222 SplitMode split_mode_from_string(const char *s) _pure_;
 223
 224 int server_init(Server *s, const char *namespace);
 225 void server_done(Server *s);
 226 void server_sync(Server *s);
 227 void server_vacuum(Server *s, bool verbose);
 228 void server_rotate(Server *s);
 229 int server_schedule_sync(Server *s, int priority);
 230 int server_flush_to_var(Server *s, bool require_flag_file);
 231 void server_maybe_append_tags(Server *s);
 232 int server_process_datagram(sd_event_source *es, int fd, uint32_t revents, void *userdata);
 233 void server_space_usage_message(Server *s, JournalStorage *storage);
 234
 235 int server_start_or_stop_idle_timer(Server *s);
 236 int server_refresh_idle_timer(Server *s);
 237
 238 int server_map_seqnum_file(Server *s, const char *fname, size_t size, void **ret);
 239 void server_unmap_seqnum_file(void *p, size_t size);