@@ -13,15 +13,17 @@
* kernel. The ABI is built upon the Kexec HandOver framework and registers
* the central `struct luo_ser` via the KHO raw subtree API.
*
- * This interface is a contract. Any modification to the structure fields,
- * compatible strings, or the layout of the `__packed` serialization
- * structures defined here constitutes a breaking change. Such changes require
- * incrementing the version number in the relevant `_COMPATIBLE` string to
- * prevent a new kernel from misinterpreting data from an old kernel.
+ * This interface is a contract. To ensure the stability of moving between
+ * kernel versions, any changes to the structures should only be additive
+ * and should utilize the feature flags to denote the supported, active, and
+ * required status of the feature.
+ *
+ * Features that are entirely optional can be added with the supported and
+ * active flags both asserted, and the required flag cleared. Features that
+ * require that the next kernel supports the feature should only be added as
+ * supported to allow compatible transition kernels. At a later time, the
+ * active and required flag should be asserted.
*
- * Changes are allowed provided the compatibility version is incremented;
- * however, backward/forward compatibility is only guaranteed for kernels
- * supporting the same ABI version.
*
* KHO Structure Overview:
* The entire LUO state is encapsulated within a single KHO entry named "LUO".
@@ -30,7 +32,7 @@
* Serialization Structures:
* - struct luo_ser:
* The central ABI structure that contains the overall state of the LUO.
- * It includes the compatibility string, the liveupdate-number, and pointers
+ * It includes the feature flags, the liveupdate-number, and pointers
* to sessions and FLBs.
*
* - struct luo_session_ser:
@@ -58,19 +60,65 @@
#define _LINUX_KHO_ABI_LUO_H
#include <linux/align.h>
+#include <linux/bits.h>
#include <linux/kho/abi/block.h>
#include <uapi/linux/liveupdate.h>
+/**
+ * struct luo_feature_hdr - Feature negotiation and versioning header.
+ * @supp: Bitmask of features supported by the producing subsystem.
+ * @req: Bitmask of features required for safe deserialization by the
+ * receiving subsystem.
+ * @active: Bitmask of features actually active/used in the serialized payload.
+ * @reserved: Reserved for future use.
+ *
+ * This header can be embedded at the beginning of any serialized structure to
+ * provide forward and backward compatibility via feature negotiation across
+ * live update.
+ */
+struct luo_feature_hdr {
+ u64 supp;
+ u64 req;
+ u64 active;
+ u64 reserved[13];
+} __packed;
+
+#define LUO_FEATURE_ACTIVE(s, f) \
+ do { \
+ (s)->features.supp |= (u64)(f); \
+ (s)->features.active |= (u64)(f); \
+ } while (0)
+#define LUO_FEATURE_SUPPORTED(s, f) ((s)->features.supp |= (u64)(f))
+#define LUO_FEATURE_REQUIRED(s, f) ((s)->features.req |= (u64)(f))
+#define LUO_FEATURE_IS_ACTIVE(s, f) (!!((s)->features.active & (u64)(f)))
+#define LUO_FEATURE_IS_SUPPORTED(s, f) (!!((s)->features.supp & (u64)(f)))
+#define LUO_FEATURE_IS_REQUIRED(s, f) (!!((s)->features.req & (u64)(f)))
+
/*
* The LUO state is registered under this KHO entry name.
*/
#define LUO_KHO_ENTRY_NAME "LUO"
-#define LUO_ABI_COMPATIBLE "luo-v5"
-#define LUO_ABI_COMPAT_LEN ALIGN(sizeof(LUO_ABI_COMPATIBLE), 8)
+
+/*
+ * Bits associated with the luo_feature_hdr values.
+ */
+#define LUO_FEATURE_NUMBER BIT_ULL(0)
+#define LUO_FEATURE_SESSIONS BIT_ULL(1)
+#define LUO_FEATURE_FLBS BIT_ULL(2)
+
+#define LUO_CORE_FEATURES_SUPP (LUO_FEATURE_NUMBER | \
+ LUO_FEATURE_SESSIONS | \
+ LUO_FEATURE_FLBS)
+#define LUO_CORE_FEATURES_REQ (LUO_FEATURE_NUMBER | \
+ LUO_FEATURE_SESSIONS | \
+ LUO_FEATURE_FLBS)
+#define LUO_CORE_FEATURES_ACTIVE (LUO_FEATURE_NUMBER | \
+ LUO_FEATURE_SESSIONS | \
+ LUO_FEATURE_FLBS)
/**
* struct luo_ser - Centralized LUO ABI header.
- * @compatible: Compatibility string identifying the LUO ABI version.
+ * @features: Bit mask of supported and active features.
* @liveupdate_num: A counter tracking the number of successful live updates.
* @sessions_pa: Physical address of the first session block header.
* @flbs_pa: Physical address of the FLB header.
@@ -78,7 +126,7 @@
* This structure is the root of all preserved LUO state.
*/
struct luo_ser {
- char compatible[LUO_ABI_COMPAT_LEN];
+ struct luo_feature_hdr features;
u64 liveupdate_num;
u64 sessions_pa;
u64 flbs_pa;
@@ -107,26 +107,37 @@ static int __init luo_early_startup(void)
return 0;
}
- if (len < sizeof(*luo_ser)) {
- pr_err("LUO state is too small (%zu < %zu)\n", len, sizeof(*luo_ser));
- return -EINVAL;
+ luo_ser = phys_to_virt(luo_ser_phys);
+
+ if (len < sizeof(struct luo_feature_hdr)) {
+ pr_err("LUO state is too small (%zu < %zu)\n",
+ len, sizeof(struct luo_feature_hdr));
+ err = -EINVAL;
+ goto out_free_ser;
}
- luo_ser = phys_to_virt(luo_ser_phys);
- if (strncmp(luo_ser->compatible, LUO_ABI_COMPATIBLE, LUO_ABI_COMPAT_LEN)) {
- pr_err("LUO state is incompatible with '%s'\n", LUO_ABI_COMPATIBLE);
- return -EINVAL;
+ if (luo_ser->features.req & ~LUO_CORE_FEATURES_SUPP) {
+ pr_err("Unsupported required LUO feature (req: 0x%llx, supp: 0x%llx)\n",
+ luo_ser->features.req, (u64)LUO_CORE_FEATURES_SUPP);
+ err = -EOPNOTSUPP;
+ goto out_free_ser;
}
- luo_global.liveupdate_num = luo_ser->liveupdate_num;
- pr_info("Retrieved live update data, liveupdate number: %lld\n",
- luo_global.liveupdate_num);
+ if (LUO_FEATURE_IS_ACTIVE(luo_ser, LUO_FEATURE_NUMBER)) {
+ luo_global.liveupdate_num = luo_ser->liveupdate_num;
+ pr_info("Retrieved live update data, liveupdate number: %lld\n",
+ luo_global.liveupdate_num);
+ }
- err = luo_session_setup_incoming(luo_ser->sessions_pa);
- if (err)
- goto out_free_ser;
- luo_flb_setup_incoming(luo_ser->flbs_pa);
+ if (LUO_FEATURE_IS_ACTIVE(luo_ser, LUO_FEATURE_SESSIONS)) {
+ err = luo_session_setup_incoming(luo_ser->sessions_pa);
+ if (err)
+ goto out_free_ser;
+ }
+
+ if (LUO_FEATURE_IS_ACTIVE(luo_ser, LUO_FEATURE_FLBS))
+ luo_flb_setup_incoming(luo_ser->flbs_pa);
err = 0;
@@ -162,7 +173,10 @@ static int __init luo_state_setup(void)
return PTR_ERR(luo_ser);
}
- strscpy(luo_ser->compatible, LUO_ABI_COMPATIBLE, sizeof(luo_ser->compatible));
+ luo_ser->features.supp = LUO_CORE_FEATURES_SUPP;
+ luo_ser->features.req = LUO_CORE_FEATURES_REQ;
+ luo_ser->features.active = LUO_CORE_FEATURES_ACTIVE;
+
luo_ser->liveupdate_num = luo_global.liveupdate_num + 1;
luo_session_setup_outgoing(&luo_ser->sessions_pa);
Define a 128 byte header that can be used by all live update serialized structures. In this header, we reserve room for 64 features with supported, active, and required bits. Update the top level luo struct to use this instead of compatibility strings. Previous versions of the struct had smaller sizes, so add a minimum size check to avoid collisions with older kernels. Signed-off-by: Logan Odell <loganodell@google.com> --- include/linux/kho/abi/luo.h | 74 +++++++++++++++++++++++++++++------- kernel/liveupdate/luo_core.c | 44 +++++++++++++-------- 2 files changed, 90 insertions(+), 28 deletions(-)