2020-11-09 05:23:58 +01:00
|
|
|
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
2012-07-18 19:07:51 +02:00
|
|
|
#pragma once
|
2011-10-07 21:06:39 +02:00
|
|
|
|
2015-10-25 13:14:12 +01:00
|
|
|
#include "sd-id128.h"
|
2012-01-05 16:01:58 +01:00
|
|
|
|
2011-10-07 21:06:39 +02:00
|
|
|
#include "macro.h"
|
2015-10-25 13:14:12 +01:00
|
|
|
#include "sparse-endian.h"
|
2011-10-07 21:06:39 +02:00
|
|
|
|
2012-10-20 17:00:57 +02:00
|
|
|
/*
|
|
|
|
* If you change this file you probably should also change its documentation:
|
|
|
|
*
|
2020-06-01 22:56:02 +02:00
|
|
|
* https://systemd.io/JOURNAL_FILE_FORMAT
|
2012-10-20 17:00:57 +02:00
|
|
|
*/
|
|
|
|
|
2011-10-07 21:06:39 +02:00
|
|
|
typedef struct Header Header;
|
2012-06-05 20:45:54 +02:00
|
|
|
|
2011-10-07 21:06:39 +02:00
|
|
|
typedef struct ObjectHeader ObjectHeader;
|
|
|
|
typedef union Object Object;
|
2012-06-05 20:45:54 +02:00
|
|
|
|
2011-10-07 21:06:39 +02:00
|
|
|
typedef struct DataObject DataObject;
|
2011-11-08 18:20:03 +01:00
|
|
|
typedef struct FieldObject FieldObject;
|
2011-10-07 21:06:39 +02:00
|
|
|
typedef struct EntryObject EntryObject;
|
|
|
|
typedef struct HashTableObject HashTableObject;
|
2011-11-08 18:20:03 +01:00
|
|
|
typedef struct EntryArrayObject EntryArrayObject;
|
2012-08-13 20:31:10 +02:00
|
|
|
typedef struct TagObject TagObject;
|
2012-06-05 20:45:54 +02:00
|
|
|
|
2011-10-07 21:06:39 +02:00
|
|
|
typedef struct EntryItem EntryItem;
|
|
|
|
typedef struct HashItem HashItem;
|
|
|
|
|
2012-08-17 00:45:18 +02:00
|
|
|
typedef struct FSSHeader FSSHeader;
|
2012-08-13 20:31:10 +02:00
|
|
|
|
2011-10-07 21:06:39 +02:00
|
|
|
/* Object types */
|
2014-12-10 15:18:49 +01:00
|
|
|
typedef enum ObjectType {
|
2014-12-12 22:51:24 +01:00
|
|
|
OBJECT_UNUSED, /* also serves as "any type" or "additional context" */
|
2012-10-20 17:00:57 +02:00
|
|
|
OBJECT_DATA,
|
2011-11-08 18:20:03 +01:00
|
|
|
OBJECT_FIELD,
|
2011-10-07 21:06:39 +02:00
|
|
|
OBJECT_ENTRY,
|
2011-11-08 18:20:03 +01:00
|
|
|
OBJECT_DATA_HASH_TABLE,
|
|
|
|
OBJECT_FIELD_HASH_TABLE,
|
2012-10-20 17:00:57 +02:00
|
|
|
OBJECT_ENTRY_ARRAY,
|
2012-08-13 20:31:10 +02:00
|
|
|
OBJECT_TAG,
|
2011-11-08 18:20:03 +01:00
|
|
|
_OBJECT_TYPE_MAX
|
2014-12-10 15:18:49 +01:00
|
|
|
} ObjectType;
|
2011-10-07 21:06:39 +02:00
|
|
|
|
2011-12-21 02:40:59 +01:00
|
|
|
/* Object flags */
|
|
|
|
enum {
|
2020-06-02 00:26:34 +02:00
|
|
|
OBJECT_COMPRESSED_XZ = 1 << 0,
|
|
|
|
OBJECT_COMPRESSED_LZ4 = 1 << 1,
|
2020-06-01 23:26:55 +02:00
|
|
|
OBJECT_COMPRESSED_ZSTD = 1 << 2,
|
|
|
|
OBJECT_COMPRESSION_MASK = (OBJECT_COMPRESSED_XZ | OBJECT_COMPRESSED_LZ4 | OBJECT_COMPRESSED_ZSTD),
|
2020-06-02 00:26:34 +02:00
|
|
|
_OBJECT_COMPRESSED_MAX = OBJECT_COMPRESSION_MASK,
|
2011-12-21 02:40:59 +01:00
|
|
|
};
|
|
|
|
|
2012-12-17 11:38:47 +01:00
|
|
|
struct ObjectHeader {
|
2011-10-07 21:06:39 +02:00
|
|
|
uint8_t type;
|
2011-12-21 02:40:59 +01:00
|
|
|
uint8_t flags;
|
|
|
|
uint8_t reserved[6];
|
2012-03-16 11:59:04 +01:00
|
|
|
le64_t size;
|
2011-10-07 21:06:39 +02:00
|
|
|
uint8_t payload[];
|
2012-12-17 11:38:47 +01:00
|
|
|
} _packed_;
|
2011-10-07 21:06:39 +02:00
|
|
|
|
2019-01-27 18:04:22 +01:00
|
|
|
#define DataObject__contents { \
|
|
|
|
ObjectHeader object; \
|
|
|
|
le64_t hash; \
|
|
|
|
le64_t next_hash_offset; \
|
|
|
|
le64_t next_field_offset; \
|
|
|
|
le64_t entry_offset; /* the first array entry we store inline */ \
|
|
|
|
le64_t entry_array_offset; \
|
|
|
|
le64_t n_entries; \
|
|
|
|
uint8_t payload[]; \
|
|
|
|
}
|
|
|
|
|
|
|
|
struct DataObject DataObject__contents;
|
|
|
|
struct DataObject__packed DataObject__contents _packed_;
|
|
|
|
assert_cc(sizeof(struct DataObject) == sizeof(struct DataObject__packed));
|
2011-11-08 18:20:03 +01:00
|
|
|
|
2020-06-01 19:40:30 +02:00
|
|
|
#define FieldObject__contents { \
|
|
|
|
ObjectHeader object; \
|
|
|
|
le64_t hash; \
|
|
|
|
le64_t next_hash_offset; \
|
|
|
|
le64_t head_data_offset; \
|
|
|
|
uint8_t payload[]; \
|
|
|
|
}
|
|
|
|
|
|
|
|
struct FieldObject FieldObject__contents;
|
|
|
|
struct FieldObject__packed FieldObject__contents _packed_;
|
|
|
|
assert_cc(sizeof(struct FieldObject) == sizeof(struct FieldObject__packed));
|
2011-10-07 21:06:39 +02:00
|
|
|
|
2012-12-17 11:38:47 +01:00
|
|
|
struct EntryItem {
|
2012-03-16 11:59:04 +01:00
|
|
|
le64_t object_offset;
|
|
|
|
le64_t hash;
|
2012-12-17 11:38:47 +01:00
|
|
|
} _packed_;
|
2011-10-07 21:06:39 +02:00
|
|
|
|
2019-01-27 18:04:22 +01:00
|
|
|
#define EntryObject__contents { \
|
|
|
|
ObjectHeader object; \
|
|
|
|
le64_t seqnum; \
|
|
|
|
le64_t realtime; \
|
|
|
|
le64_t monotonic; \
|
|
|
|
sd_id128_t boot_id; \
|
|
|
|
le64_t xor_hash; \
|
|
|
|
EntryItem items[]; \
|
|
|
|
}
|
|
|
|
|
|
|
|
struct EntryObject EntryObject__contents;
|
|
|
|
struct EntryObject__packed EntryObject__contents _packed_;
|
|
|
|
assert_cc(sizeof(struct EntryObject) == sizeof(struct EntryObject__packed));
|
|
|
|
|
2012-12-17 11:38:47 +01:00
|
|
|
struct HashItem {
|
2012-03-16 11:59:04 +01:00
|
|
|
le64_t head_hash_offset;
|
|
|
|
le64_t tail_hash_offset;
|
2012-12-17 11:38:47 +01:00
|
|
|
} _packed_;
|
2011-10-07 21:06:39 +02:00
|
|
|
|
2012-12-17 11:38:47 +01:00
|
|
|
struct HashTableObject {
|
2011-10-07 21:06:39 +02:00
|
|
|
ObjectHeader object;
|
2011-11-08 18:20:03 +01:00
|
|
|
HashItem items[];
|
2012-12-17 11:38:47 +01:00
|
|
|
} _packed_;
|
2011-10-07 21:06:39 +02:00
|
|
|
|
2012-12-17 11:38:47 +01:00
|
|
|
struct EntryArrayObject {
|
2011-10-07 21:06:39 +02:00
|
|
|
ObjectHeader object;
|
2012-03-16 11:59:04 +01:00
|
|
|
le64_t next_entry_array_offset;
|
|
|
|
le64_t items[];
|
2012-12-17 11:38:47 +01:00
|
|
|
} _packed_;
|
2011-10-07 21:06:39 +02:00
|
|
|
|
2012-08-13 20:31:10 +02:00
|
|
|
#define TAG_LENGTH (256/8)
|
2012-06-05 20:45:54 +02:00
|
|
|
|
2012-12-17 11:38:47 +01:00
|
|
|
struct TagObject {
|
2012-06-05 20:45:54 +02:00
|
|
|
ObjectHeader object;
|
2012-10-20 17:10:32 +02:00
|
|
|
le64_t seqnum;
|
|
|
|
le64_t epoch;
|
2012-08-13 20:31:10 +02:00
|
|
|
uint8_t tag[TAG_LENGTH]; /* SHA-256 HMAC */
|
2012-12-17 11:38:47 +01:00
|
|
|
} _packed_;
|
2012-06-05 20:45:54 +02:00
|
|
|
|
2011-10-07 21:06:39 +02:00
|
|
|
union Object {
|
|
|
|
ObjectHeader object;
|
|
|
|
DataObject data;
|
2011-11-08 18:20:03 +01:00
|
|
|
FieldObject field;
|
2011-10-07 21:06:39 +02:00
|
|
|
EntryObject entry;
|
|
|
|
HashTableObject hash_table;
|
2011-11-08 18:20:03 +01:00
|
|
|
EntryArrayObject entry_array;
|
2012-08-13 20:31:10 +02:00
|
|
|
TagObject tag;
|
2011-10-07 21:06:39 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
enum {
|
2012-08-18 00:37:21 +02:00
|
|
|
STATE_OFFLINE = 0,
|
|
|
|
STATE_ONLINE = 1,
|
|
|
|
STATE_ARCHIVED = 2,
|
|
|
|
_STATE_MAX
|
2011-10-07 21:06:39 +02:00
|
|
|
};
|
|
|
|
|
2011-12-21 02:40:59 +01:00
|
|
|
/* Header flags */
|
|
|
|
enum {
|
2020-06-02 00:26:34 +02:00
|
|
|
HEADER_INCOMPATIBLE_COMPRESSED_XZ = 1 << 0,
|
|
|
|
HEADER_INCOMPATIBLE_COMPRESSED_LZ4 = 1 << 1,
|
2020-05-30 00:00:50 +02:00
|
|
|
HEADER_INCOMPATIBLE_KEYED_HASH = 1 << 2,
|
2020-06-01 23:26:55 +02:00
|
|
|
HEADER_INCOMPATIBLE_COMPRESSED_ZSTD = 1 << 3,
|
2011-12-21 02:40:59 +01:00
|
|
|
};
|
|
|
|
|
2020-06-01 23:26:55 +02:00
|
|
|
#define HEADER_INCOMPATIBLE_ANY \
|
|
|
|
(HEADER_INCOMPATIBLE_COMPRESSED_XZ | \
|
|
|
|
HEADER_INCOMPATIBLE_COMPRESSED_LZ4 | \
|
|
|
|
HEADER_INCOMPATIBLE_KEYED_HASH | \
|
|
|
|
HEADER_INCOMPATIBLE_COMPRESSED_ZSTD)
|
2014-07-04 04:42:22 +02:00
|
|
|
|
2020-06-01 23:26:55 +02:00
|
|
|
#if HAVE_XZ && HAVE_LZ4 && HAVE_ZSTD
|
2014-07-04 04:42:22 +02:00
|
|
|
# define HEADER_INCOMPATIBLE_SUPPORTED HEADER_INCOMPATIBLE_ANY
|
2020-06-01 23:26:55 +02:00
|
|
|
#elif HAVE_XZ && HAVE_LZ4
|
|
|
|
# define HEADER_INCOMPATIBLE_SUPPORTED (HEADER_INCOMPATIBLE_COMPRESSED_XZ|HEADER_INCOMPATIBLE_COMPRESSED_LZ4|HEADER_INCOMPATIBLE_KEYED_HASH)
|
|
|
|
#elif HAVE_XZ && HAVE_ZSTD
|
|
|
|
# define HEADER_INCOMPATIBLE_SUPPORTED (HEADER_INCOMPATIBLE_COMPRESSED_XZ|HEADER_INCOMPATIBLE_COMPRESSED_ZSTD|HEADER_INCOMPATIBLE_KEYED_HASH)
|
|
|
|
#elif HAVE_LZ4 && HAVE_ZSTD
|
|
|
|
# define HEADER_INCOMPATIBLE_SUPPORTED (HEADER_INCOMPATIBLE_COMPRESSED_LZ4|HEADER_INCOMPATIBLE_COMPRESSED_ZSTD|HEADER_INCOMPATIBLE_KEYED_HASH)
|
2017-10-03 10:41:51 +02:00
|
|
|
#elif HAVE_XZ
|
2020-05-30 00:00:50 +02:00
|
|
|
# define HEADER_INCOMPATIBLE_SUPPORTED (HEADER_INCOMPATIBLE_COMPRESSED_XZ|HEADER_INCOMPATIBLE_KEYED_HASH)
|
2017-10-03 10:41:51 +02:00
|
|
|
#elif HAVE_LZ4
|
2020-05-30 00:00:50 +02:00
|
|
|
# define HEADER_INCOMPATIBLE_SUPPORTED (HEADER_INCOMPATIBLE_COMPRESSED_LZ4|HEADER_INCOMPATIBLE_KEYED_HASH)
|
2020-06-01 23:26:55 +02:00
|
|
|
#elif HAVE_ZSTD
|
|
|
|
# define HEADER_INCOMPATIBLE_SUPPORTED (HEADER_INCOMPATIBLE_COMPRESSED_ZSTD|HEADER_INCOMPATIBLE_KEYED_HASH)
|
2014-07-04 04:42:22 +02:00
|
|
|
#else
|
2020-05-30 00:00:50 +02:00
|
|
|
# define HEADER_INCOMPATIBLE_SUPPORTED HEADER_INCOMPATIBLE_KEYED_HASH
|
2014-07-04 04:42:22 +02:00
|
|
|
#endif
|
|
|
|
|
2012-06-05 20:45:54 +02:00
|
|
|
enum {
|
2020-06-02 00:26:34 +02:00
|
|
|
HEADER_COMPATIBLE_SEALED = 1 << 0,
|
2012-06-05 20:45:54 +02:00
|
|
|
};
|
|
|
|
|
2014-07-04 04:42:22 +02:00
|
|
|
#define HEADER_COMPATIBLE_ANY HEADER_COMPATIBLE_SEALED
|
2017-10-03 10:41:51 +02:00
|
|
|
#if HAVE_GCRYPT
|
2014-07-04 04:42:22 +02:00
|
|
|
# define HEADER_COMPATIBLE_SUPPORTED HEADER_COMPATIBLE_SEALED
|
|
|
|
#else
|
|
|
|
# define HEADER_COMPATIBLE_SUPPORTED 0
|
|
|
|
#endif
|
|
|
|
|
2020-06-01 18:50:33 +02:00
|
|
|
#define HEADER_SIGNATURE \
|
|
|
|
((const char[]) { 'L', 'P', 'K', 'S', 'H', 'H', 'R', 'H' })
|
2012-08-13 20:31:10 +02:00
|
|
|
|
2019-01-27 18:04:22 +01:00
|
|
|
#define struct_Header__contents { \
|
|
|
|
uint8_t signature[8]; /* "LPKSHHRH" */ \
|
|
|
|
le32_t compatible_flags; \
|
|
|
|
le32_t incompatible_flags; \
|
|
|
|
uint8_t state; \
|
|
|
|
uint8_t reserved[7]; \
|
|
|
|
sd_id128_t file_id; \
|
|
|
|
sd_id128_t machine_id; \
|
|
|
|
sd_id128_t boot_id; /* last writer */ \
|
|
|
|
sd_id128_t seqnum_id; \
|
|
|
|
le64_t header_size; \
|
|
|
|
le64_t arena_size; \
|
|
|
|
le64_t data_hash_table_offset; \
|
|
|
|
le64_t data_hash_table_size; \
|
|
|
|
le64_t field_hash_table_offset; \
|
|
|
|
le64_t field_hash_table_size; \
|
|
|
|
le64_t tail_object_offset; \
|
|
|
|
le64_t n_objects; \
|
|
|
|
le64_t n_entries; \
|
|
|
|
le64_t tail_entry_seqnum; \
|
|
|
|
le64_t head_entry_seqnum; \
|
|
|
|
le64_t entry_array_offset; \
|
|
|
|
le64_t head_entry_realtime; \
|
|
|
|
le64_t tail_entry_realtime; \
|
|
|
|
le64_t tail_entry_monotonic; \
|
|
|
|
/* Added in 187 */ \
|
|
|
|
le64_t n_data; \
|
|
|
|
le64_t n_fields; \
|
|
|
|
/* Added in 189 */ \
|
|
|
|
le64_t n_tags; \
|
|
|
|
le64_t n_entry_arrays; \
|
2020-06-01 19:40:30 +02:00
|
|
|
/* Added in 246 */ \
|
|
|
|
le64_t data_hash_chain_depth; \
|
|
|
|
le64_t field_hash_chain_depth; \
|
2019-01-27 18:04:22 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
struct Header struct_Header__contents;
|
|
|
|
struct Header__packed struct_Header__contents _packed_;
|
|
|
|
assert_cc(sizeof(struct Header) == sizeof(struct Header__packed));
|
2020-06-01 19:40:30 +02:00
|
|
|
assert_cc(sizeof(struct Header) == 256);
|
2012-08-13 20:31:10 +02:00
|
|
|
|
2020-06-01 18:50:33 +02:00
|
|
|
#define FSS_HEADER_SIGNATURE \
|
|
|
|
((const char[]) { 'K', 'S', 'H', 'H', 'R', 'H', 'L', 'P' })
|
2012-08-13 20:31:10 +02:00
|
|
|
|
2012-12-17 11:38:47 +01:00
|
|
|
struct FSSHeader {
|
2012-08-13 20:31:10 +02:00
|
|
|
uint8_t signature[8]; /* "KSHHRHLP" */
|
|
|
|
le32_t compatible_flags;
|
|
|
|
le32_t incompatible_flags;
|
|
|
|
sd_id128_t machine_id;
|
|
|
|
sd_id128_t boot_id; /* last writer */
|
|
|
|
le64_t header_size;
|
2012-08-17 00:45:18 +02:00
|
|
|
le64_t start_usec;
|
|
|
|
le64_t interval_usec;
|
|
|
|
le16_t fsprg_secpar;
|
2012-08-13 20:31:10 +02:00
|
|
|
le16_t reserved[3];
|
2012-08-17 00:45:18 +02:00
|
|
|
le64_t fsprg_state_size;
|
2012-12-17 11:38:47 +01:00
|
|
|
} _packed_;
|