[PATCH RFC v2] mdadm: add support for new lockless bitmap

From: Yu Kuai
Date: Thu Mar 27 2025 - 09:55:03 EST


From: Yu Kuai <yukuai3@xxxxxxxxxx>

A new major number 6 is used for the new bitmap.

Noted that for the kernel that doesn't support lockless bitmap, create
such array will fail:

md0: invalid bitmap file superblock: unrecognized superblock version.

Signed-off-by: Yu Kuai <yukuai3@xxxxxxxxxx>
---
Changes in v2:
- add support for Incremental mode;
- use sysfs API bitmap_version to notify kernel to use llbitmap;

Assemble.c | 5 +++++
Create.c | 8 +++++++-
Grow.c | 3 ++-
Incremental.c | 34 ++++++++++++++++++++++++++++++++++
bitmap.h | 8 ++++++--
mdadm.c | 9 ++++++++-
mdadm.h | 2 ++
super1.c | 14 ++++++++++++++
8 files changed, 78 insertions(+), 5 deletions(-)

diff --git a/Assemble.c b/Assemble.c
index f8099cd3..5d46379d 100644
--- a/Assemble.c
+++ b/Assemble.c
@@ -1029,6 +1029,11 @@ static int start_array(int mdfd,
int i;
unsigned int req_cnt;

+ if (st->ss->get_bitmap_version &&
+ st->ss->get_bitmap_version(st) == BITMAP_MAJOR_LOCKLESS &&
+ sysfs_set_str(content, NULL, "bitmap_version", "llbitmap"))
+ return 1;
+
if (content->journal_device_required && (content->journal_clean == 0)) {
if (!c->force) {
pr_err("Not safe to assemble with missing or stale journal device, consider --force.\n");
diff --git a/Create.c b/Create.c
index fd6c9215..a85c0419 100644
--- a/Create.c
+++ b/Create.c
@@ -541,6 +541,8 @@ int Create(struct supertype *st, struct mddev_ident *ident, int subdevs,
pr_err("At least 2 nodes are needed for cluster-md\n");
return 1;
}
+ } else if (s->btype == BitmapLockless) {
+ major_num = BITMAP_MAJOR_LOCKLESS;
}

memset(&info, 0, sizeof(info));
@@ -1182,7 +1184,8 @@ int Create(struct supertype *st, struct mddev_ident *ident, int subdevs,
* to stop another mdadm from finding and using those devices.
*/

- if (s->btype == BitmapInternal || s->btype == BitmapCluster) {
+ if (s->btype == BitmapInternal || s->btype == BitmapCluster ||
+ s->btype == BitmapLockless) {
if (!st->ss->add_internal_bitmap) {
pr_err("internal bitmaps not supported with %s metadata\n",
st->ss->name);
@@ -1194,6 +1197,9 @@ int Create(struct supertype *st, struct mddev_ident *ident, int subdevs,
pr_err("Given bitmap chunk size not supported.\n");
goto abort_locked;
}
+ if (s->btype == BitmapLockless &&
+ sysfs_set_str(&info, NULL, "bitmap_version", "llbitmap") < 0)
+ goto abort_locked;
}

if (sysfs_init(&info, mdfd, NULL)) {
diff --git a/Grow.c b/Grow.c
index cc1be6cc..3905f64c 100644
--- a/Grow.c
+++ b/Grow.c
@@ -383,7 +383,8 @@ int Grow_addbitmap(char *devname, int fd, struct context *c, struct shape *s)
free(mdi);
}

- if (s->btype == BitmapInternal || s->btype == BitmapCluster) {
+ if (s->btype == BitmapInternal || s->btype == BitmapCluster ||
+ s->btype == BitmapLockless) {
int rv;
int d;
int offset_setable = 0;
diff --git a/Incremental.c b/Incremental.c
index 228d2bdd..de2edecb 100644
--- a/Incremental.c
+++ b/Incremental.c
@@ -552,6 +552,40 @@ int Incremental(struct mddev_dev *devlist, struct context *c,
if (d->disk.state & (1<<MD_DISK_REMOVED))
remove_disk(mdfd, st, sra, d);

+ if (st->ss->get_bitmap_version) {
+ if (st->sb == NULL) {
+ dfd = dev_open(devname, O_RDONLY);
+ if (dfd < 0) {
+ rv = 1;
+ goto out;
+ }
+
+ rv = st->ss->load_super(st, dfd, NULL);
+ close(dfd);
+ dfd = -1;
+ if (rv) {
+ pr_err("load super failed %d\n", rv);
+ goto out;
+ }
+ }
+
+ if (st->ss->get_bitmap_version(st) == BITMAP_MAJOR_LOCKLESS) {
+ if (sra == NULL) {
+ sra = sysfs_read(mdfd, NULL, (GET_DEVS | GET_STATE |
+ GET_OFFSET | GET_SIZE));
+ if (!sra) {
+ pr_err("can't read mdinfo\n");
+ rv = 1;
+ goto out;
+ }
+ }
+
+ rv = sysfs_set_str(sra, NULL, "bitmap_version", "llbitmap");
+ if (rv)
+ goto out;
+ }
+ }
+
if ((sra == NULL || active_disks >= info.array.working_disks) &&
trustworthy != FOREIGN)
rv = ioctl(mdfd, RUN_ARRAY, NULL);
diff --git a/bitmap.h b/bitmap.h
index 7b1f80f2..3a08cf60 100644
--- a/bitmap.h
+++ b/bitmap.h
@@ -13,6 +13,7 @@
#define BITMAP_MAJOR_HI 4
#define BITMAP_MAJOR_HOSTENDIAN 3
#define BITMAP_MAJOR_CLUSTERED 5
+#define BITMAP_MAJOR_LOCKLESS 6

#define BITMAP_MINOR 39

@@ -139,8 +140,11 @@ typedef __u16 bitmap_counter_t;

/* use these for bitmap->flags and bitmap->sb->state bit-fields */
enum bitmap_state {
- BITMAP_ACTIVE = 0x001, /* the bitmap is in use */
- BITMAP_STALE = 0x002 /* the bitmap file is out of date or had -EIO */
+ BITMAP_STALE = 1, /* the bitmap file is out of date or had -EIO */
+ BITMAP_WRITE_ERROR = 2, /* A write error has occurred */
+ BITMAP_FIRST_USE = 3,
+ BITMAP_DAEMON_BUSY = 4,
+ BITMAP_HOSTENDIAN =15,
};

/* the superblock at the front of the bitmap file -- little endian */
diff --git a/mdadm.c b/mdadm.c
index 1fd4dcba..7a64fba2 100644
--- a/mdadm.c
+++ b/mdadm.c
@@ -56,6 +56,12 @@ static mdadm_status_t set_bitmap_value(struct shape *s, struct context *c, char
return MDADM_STATUS_SUCCESS;
}

+ if (strcmp(val, "lockless") == 0) {
+ s->btype = BitmapLockless;
+ pr_info("Experimental lockless bitmap, use at your own disk!\n");
+ return MDADM_STATUS_SUCCESS;
+ }
+
if (strcmp(val, "clustered") == 0) {
s->btype = BitmapCluster;
/* Set the default number of cluster nodes
@@ -1251,7 +1257,8 @@ int main(int argc, char *argv[])
pr_err("--bitmap is required for consistency policy: %s\n",
map_num_s(consistency_policies, s.consistency_policy));
exit(2);
- } else if ((s.btype == BitmapInternal || s.btype == BitmapCluster) &&
+ } else if ((s.btype == BitmapInternal || s.btype == BitmapCluster ||
+ s.btype == BitmapLockless) &&
s.consistency_policy != CONSISTENCY_POLICY_BITMAP &&
s.consistency_policy != CONSISTENCY_POLICY_JOURNAL) {
pr_err("--bitmap is not compatible with consistency policy: %s\n",
diff --git a/mdadm.h b/mdadm.h
index 77705b11..cc21e0d3 100644
--- a/mdadm.h
+++ b/mdadm.h
@@ -607,6 +607,7 @@ enum bitmap_type {
BitmapNone,
BitmapInternal,
BitmapCluster,
+ BitmapLockless,
BitmapUnknown,
};

@@ -1202,6 +1203,7 @@ extern struct superswitch {
int (*add_internal_bitmap)(struct supertype *st, int *chunkp,
int delay, int write_behind,
unsigned long long size, int may_change, int major);
+ int (*get_bitmap_version)(struct supertype *st);
/* Perform additional setup required to activate a bitmap.
*/
int (*set_bitmap)(struct supertype *st, struct mdinfo *info);
diff --git a/super1.c b/super1.c
index fe3c4c64..caa2569d 100644
--- a/super1.c
+++ b/super1.c
@@ -2487,6 +2487,14 @@ static __u64 avail_size1(struct supertype *st, __u64 devsize,
return 0;
}

+static int get_bitmap_version1(struct supertype *st)
+{
+ struct mdp_superblock_1 *sb = st->sb;
+ bitmap_super_t *bms = (bitmap_super_t *)(((char *)sb) + MAX_SB_SIZE);
+
+ return __le32_to_cpu(bms->version);
+}
+
static int
add_internal_bitmap1(struct supertype *st,
int *chunkp, int delay, int write_behind,
@@ -2650,6 +2658,11 @@ add_internal_bitmap1(struct supertype *st,
bms->cluster_name[len - 1] = '\0';
}

+ /* kernel will initialize bitmap */
+ if (major == BITMAP_MAJOR_LOCKLESS) {
+ bms->state = __cpu_to_le32(1 << BITMAP_FIRST_USE);
+ bms->sectors_reserved = __le32_to_cpu(room);
+ }
*chunkp = chunk;
return 0;
}
@@ -3025,6 +3038,7 @@ struct superswitch super1 = {
.avail_size = avail_size1,
.add_internal_bitmap = add_internal_bitmap1,
.locate_bitmap = locate_bitmap1,
+ .get_bitmap_version = get_bitmap_version1,
.write_bitmap = write_bitmap1,
.free_super = free_super1,
#if __BYTE_ORDER == BIG_ENDIAN
--
2.39.2