journal: link up documentation with the file structure header

[elogind.git] / src / journal / journal-def.h

diff --git a/src/journal/journal-def.h b/src/journal/journal-def.h
index e61e81ca84e1155f9616f992fb7c2a28d9fec111..351eec77c551fe35a1c2f86a4659dd5a677f89ad 100644 (file)
--- a/src/journal/journal-def.h
+++ b/src/journal/journal-def.h
@@ -27,6 +27,13 @@
 
 #include "macro.h"
 
+/*
+ * If you change this file you probably should also change its documentation:
+ *
+ * http://www.freedesktop.org/wiki/Software/systemd/journal-files
+ *
+ */
+
 typedef struct Header Header;
 
 typedef struct ObjectHeader ObjectHeader;
@@ -42,17 +49,17 @@ typedef struct TagObject TagObject;
 typedef struct EntryItem EntryItem;
 typedef struct HashItem HashItem;
 
-typedef struct FSPRGHeader FSPRGHeader;
+typedef struct FSSHeader FSSHeader;
 
 /* Object types */
 enum {
         OBJECT_UNUSED,
-        OBJECT_DATA,               /* !!! */
+        OBJECT_DATA,
         OBJECT_FIELD,
         OBJECT_ENTRY,
         OBJECT_DATA_HASH_TABLE,
         OBJECT_FIELD_HASH_TABLE,
-        OBJECT_ENTRY_ARRAY,        /* !!! */
+        OBJECT_ENTRY_ARRAY,
         OBJECT_TAG,
         _OBJECT_TYPE_MAX
 };
@@ -125,6 +132,7 @@ _packed_ struct EntryArrayObject {
 _packed_ struct TagObject {
         ObjectHeader object;
         uint64_t seqnum;
+        uint64_t epoch;
         uint8_t tag[TAG_LENGTH]; /* SHA-256 HMAC */
 };
 
@@ -139,9 +147,10 @@ union Object {
 };
 
 enum {
-        STATE_OFFLINE,
-        STATE_ONLINE,
-        STATE_ARCHIVED
+        STATE_OFFLINE = 0,
+        STATE_ONLINE = 1,
+        STATE_ARCHIVED = 2,
+        _STATE_MAX
 };
 
 /* Header flags */
@@ -150,7 +159,7 @@ enum {
 };
 
 enum {
-        HEADER_COMPATIBLE_AUTHENTICATED = 1
+        HEADER_COMPATIBLE_SEALED = 1
 };
 
 #define HEADER_SIGNATURE ((char[]) { 'L', 'P', 'K', 'S', 'H', 'H', 'R', 'H' })
@@ -167,9 +176,9 @@ _packed_ struct Header {
         sd_id128_t seqnum_id;
         le64_t header_size;
         le64_t arena_size;
-        le64_t data_hash_table_offset;     /* for looking up data objects */
+        le64_t data_hash_table_offset;
         le64_t data_hash_table_size;
-        le64_t field_hash_table_offset;     /* for looking up field objects */
+        le64_t field_hash_table_offset;
         le64_t field_hash_table_size;
         le64_t tail_object_offset;
         le64_t n_objects;
@@ -185,20 +194,23 @@ _packed_ struct Header {
         le64_t n_fields;
         /* Added in 189 */
         le64_t n_tags;
+        le64_t n_entry_arrays;
+
+        /* Size: 224 */
 };
 
-#define FSPRG_HEADER_SIGNATURE ((char[]) { 'K', 'S', 'H', 'H', 'R', 'H', 'L', 'P' })
+#define FSS_HEADER_SIGNATURE ((char[]) { 'K', 'S', 'H', 'H', 'R', 'H', 'L', 'P' })
 
-_packed_ struct FSPRGHeader {
+_packed_ struct FSSHeader {
         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;
-        le64_t fsprg_start_usec;
-        le64_t fsprg_interval_usec;
-        le16_t secpar;
+        le64_t start_usec;
+        le64_t interval_usec;
+        le16_t fsprg_secpar;
         le16_t reserved[3];
-        le64_t state_size;
+        le64_t fsprg_state_size;
 };