]> git.ipfire.org Git - thirdparty/mdadm.git/blame - bitmap.c
Show all bitmaps while examining bitmap
[thirdparty/mdadm.git] / bitmap.c
CommitLineData
c82f047c
NB
1/*
2 * mdadm - manage Linux "md" devices aka RAID arrays.
3 *
4 * Copyright (C) 2004 Paul Clements, SteelEye Technology, Inc.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20
c82f047c 21#include "mdadm.h"
c82f047c 22
c82f047c
NB
23inline void sb_le_to_cpu(bitmap_super_t *sb)
24{
25 sb->magic = __le32_to_cpu(sb->magic);
26 sb->version = __le32_to_cpu(sb->version);
27 /* uuid gets no translation */
28 sb->events = __le64_to_cpu(sb->events);
29 sb->events_cleared = __le64_to_cpu(sb->events_cleared);
30 sb->state = __le32_to_cpu(sb->state);
31 sb->chunksize = __le32_to_cpu(sb->chunksize);
32 sb->daemon_sleep = __le32_to_cpu(sb->daemon_sleep);
33 sb->sync_size = __le64_to_cpu(sb->sync_size);
10ae45c1 34 sb->write_behind = __le32_to_cpu(sb->write_behind);
95a05b37
GJ
35 sb->nodes = __le32_to_cpu(sb->nodes);
36 sb->sectors_reserved = __le32_to_cpu(sb->sectors_reserved);
c82f047c
NB
37}
38
39inline void sb_cpu_to_le(bitmap_super_t *sb)
40{
41 sb_le_to_cpu(sb); /* these are really the same thing */
42}
43
44mapping_t bitmap_states[] = {
45 { "OK", 0 },
46 { "Out of date", 2 },
47 { NULL, -1 }
48};
49
50const char *bitmap_state(int state_num)
51{
52 char *state = map_num(bitmap_states, state_num);
53 return state ? state : "Unknown";
54}
55
56const char *human_chunksize(unsigned long bytes)
57{
58 static char buf[16];
59 char *suffixes[] = { "B", "KB", "MB", "GB", "TB", NULL };
60 int i = 0;
61
62 while (bytes >> 10) {
63 bytes >>= 10;
64 i++;
65 }
66
8f23b0b3 67 snprintf(buf, sizeof(buf), "%lu %s", bytes, suffixes[i]);
c82f047c
NB
68
69 return buf;
70}
71
72typedef struct bitmap_info_s {
73 bitmap_super_t sb;
74 unsigned long long total_bits;
75 unsigned long long dirty_bits;
76} bitmap_info_t;
77
78/* count the dirty bits in the first num_bits of byte */
79inline int count_dirty_bits_byte(char byte, int num_bits)
80{
81 int num = 0;
82
83 switch (num_bits) { /* fall through... */
84 case 8: if (byte & 128) num++;
85 case 7: if (byte & 64) num++;
86 case 6: if (byte & 32) num++;
87 case 5: if (byte & 16) num++;
88 case 4: if (byte & 8) num++;
89 case 3: if (byte & 4) num++;
90 case 2: if (byte & 2) num++;
91 case 1: if (byte & 1) num++;
92 default: break;
93 }
94
95 return num;
96}
97
98int count_dirty_bits(char *buf, int num_bits)
99{
100 int i, num = 0;
101
ca3b6696 102 for (i = 0; i < num_bits / 8; i++)
c82f047c
NB
103 num += count_dirty_bits_byte(buf[i], 8);
104
105 if (num_bits % 8) /* not an even byte boundary */
106 num += count_dirty_bits_byte(buf[i], num_bits % 8);
107
108 return num;
109}
110
111/* calculate the size of the bitmap given the array size and bitmap chunksize */
112unsigned long long bitmap_bits(unsigned long long array_size,
113 unsigned long chunksize)
114{
115 return (array_size * 512 + chunksize - 1) / chunksize;
116}
117
2a528478
N
118unsigned long bitmap_sectors(struct bitmap_super_s *bsb)
119{
120 unsigned long long bits = bitmap_bits(__le64_to_cpu(bsb->sync_size),
121 __le32_to_cpu(bsb->chunksize));
122 int bits_per_sector = 8*512;
123 return (bits + bits_per_sector - 1) / bits_per_sector;
124}
125
c82f047c
NB
126bitmap_info_t *bitmap_fd_read(int fd, int brief)
127{
4ccdb956
NB
128 /* Note: fd might be open O_DIRECT, so we must be
129 * careful to align reads properly
130 */
c82f047c
NB
131 unsigned long long total_bits = 0, read_bits = 0, dirty_bits = 0;
132 bitmap_info_t *info;
6416d527 133 void *buf;
f21e18ca 134 unsigned int n, skip;
4ccdb956 135
a7322ae1 136 if (posix_memalign(&buf, 4096, 8192) != 0) {
e7b84f9d 137 pr_err("failed to allocate 8192 bytes\n");
3d2c4fc7
DW
138 return NULL;
139 }
4ccdb956 140 n = read(fd, buf, 8192);
c82f047c 141
503975b9 142 info = xmalloc(sizeof(*info));
c82f047c 143
4ccdb956 144 if (n < sizeof(info->sb)) {
7a862a02 145 pr_err("failed to read superblock of bitmap file: %s\n", strerror(errno));
c82f047c 146 free(info);
39c74d5e 147 free(buf);
c82f047c
NB
148 return NULL;
149 }
4ccdb956
NB
150 memcpy(&info->sb, buf, sizeof(info->sb));
151 skip = sizeof(info->sb);
c82f047c
NB
152
153 sb_le_to_cpu(&info->sb); /* convert superblock to CPU byte ordering */
aba69144 154
b47dff66 155 if (brief || info->sb.sync_size == 0 || info->sb.chunksize == 0)
c82f047c
NB
156 goto out;
157
158 /* read the rest of the file counting total bits and dirty bits --
159 * we stop when either:
160 * 1) we hit EOF, in which case we assume the rest of the bits (if any)
161 * are dirty
162 * 2) we've read the full bitmap, in which case we ignore any trailing
163 * data in the file
164 */
165 total_bits = bitmap_bits(info->sb.sync_size, info->sb.chunksize);
166
4ccdb956 167 while(read_bits < total_bits) {
c82f047c
NB
168 unsigned long long remaining = total_bits - read_bits;
169
4ccdb956
NB
170 if (n == 0) {
171 n = read(fd, buf, 8192);
172 skip = 0;
173 if (n <= 0)
174 break;
175 }
176 if (remaining > (n-skip) * 8) /* we want the full buffer */
177 remaining = (n-skip) * 8;
178
179 dirty_bits += count_dirty_bits(buf+skip, remaining);
c82f047c
NB
180
181 read_bits += remaining;
4ccdb956 182 n = 0;
c82f047c
NB
183 }
184
185 if (read_bits < total_bits) { /* file truncated... */
7a862a02 186 pr_err("WARNING: bitmap file is not large enough for array size %llu!\n\n",
f9c25f1d 187 (unsigned long long)info->sb.sync_size);
c82f047c
NB
188 total_bits = read_bits;
189 }
190out:
39c74d5e 191 free(buf);
c82f047c
NB
192 info->total_bits = total_bits;
193 info->dirty_bits = dirty_bits;
194 return info;
195}
196
1e781e07 197int bitmap_file_open(char *filename, struct supertype **stp)
c82f047c
NB
198{
199 int fd;
55935d51 200 struct stat stb;
34163fc7 201 struct supertype *st = *stp;
c82f047c 202
4ccdb956 203 if (stat(filename, &stb) < 0) {
e7b84f9d 204 pr_err("failed to find file %s: %s\n",
4ccdb956 205 filename, strerror(errno));
1e781e07 206 return -1;
c82f047c 207 }
55935d51 208 if ((S_IFMT & stb.st_mode) == S_IFBLK) {
9698df15 209 fd = open(filename, O_RDONLY|O_DIRECT);
4ccdb956 210 if (fd < 0) {
e7b84f9d 211 pr_err("failed to open bitmap file %s: %s\n",
4ccdb956 212 filename, strerror(errno));
1e781e07 213 return -1;
4ccdb956 214 }
55935d51
NB
215 /* block device, so we are probably after an internal bitmap */
216 if (!st) st = guess_super(fd);
217 if (!st) {
218 /* just look at device... */
219 lseek(fd, 0, 0);
ebeb3663 220 } else if (!st->ss->locate_bitmap) {
e7b84f9d 221 pr_err("No bitmap possible with %s metadata\n",
ebeb3663 222 st->ss->name);
1e781e07 223 return -1;
ebeb3663 224 } else
3da92f27 225 st->ss->locate_bitmap(st, fd);
ebeb3663 226
34163fc7 227 *stp = st;
4ccdb956
NB
228 } else {
229 fd = open(filename, O_RDONLY|O_DIRECT);
230 if (fd < 0) {
e7b84f9d 231 pr_err("failed to open bitmap file %s: %s\n",
4ccdb956 232 filename, strerror(errno));
1e781e07 233 return -1;
4ccdb956 234 }
55935d51 235 }
c82f047c 236
1e781e07 237 return fd;
c82f047c
NB
238}
239
34163fc7
NB
240__u32 swapl(__u32 l)
241{
242 char *c = (char*)&l;
243 char t= c[0];
244 c[0] = c[3];
245 c[3] = t;
246
247 t = c[1];
248 c[1] = c[2];
249 c[2] = t;
250 return l;
251}
55935d51 252int ExamineBitmap(char *filename, int brief, struct supertype *st)
c82f047c
NB
253{
254 /*
255 * Read the bitmap file and display its contents
256 */
257
258 bitmap_super_t *sb;
259 bitmap_info_t *info;
260 int rv = 1;
dfd4d8ee 261 char buf[64];
bf4fb153 262 int swap;
b98043a2 263 int fd, i;
caa0f6c6 264 __u32 uuid32[4];
c82f047c 265
1e781e07
N
266 fd = bitmap_file_open(filename, &st);
267 if (fd < 0)
c82f047c
NB
268 return rv;
269
1e781e07
N
270 info = bitmap_fd_read(fd, brief);
271 if (!info)
272 return rv;
c82f047c 273 sb = &info->sb;
1e781e07
N
274 if (sb->magic != BITMAP_MAGIC && md_get_version(fd) > 0) {
275 pr_err("This is an md array. To view a bitmap you need to examine\n");
276 pr_err("a member device, not the array.\n");
277 pr_err("Reporting bitmap that would be used if this array were used\n");
278 pr_err("as a member of some other array\n");
279 }
280 close(fd);
c82f047c
NB
281 printf(" Filename : %s\n", filename);
282 printf(" Magic : %08x\n", sb->magic);
283 if (sb->magic != BITMAP_MAGIC) {
1e781e07
N
284 pr_err("invalid bitmap magic 0x%x, the bitmap file appears\n",
285 sb->magic);
286 pr_err("to be corrupted or missing.\n");
c82f047c
NB
287 }
288 printf(" Version : %d\n", sb->version);
dcec9ee5
NB
289 if (sb->version < BITMAP_MAJOR_LO ||
290 sb->version > BITMAP_MAJOR_HI) {
1e781e07
N
291 pr_err("unknown bitmap version %d, either the bitmap file\n",
292 sb->version);
293 pr_err("is corrupted or you need to upgrade your tools\n");
c82f047c
NB
294 goto free_info;
295 }
296
297 rv = 0;
bf4fb153
NB
298 if (st)
299 swap = st->ss->swapuuid;
300 else
301#if __BYTE_ORDER == BIG_ENDIAN
302 swap = 0;
303#else
304 swap = 1;
305#endif
caa0f6c6
N
306 memcpy(uuid32, sb->uuid, 16);
307 if (swap)
308 printf(" UUID : %08x:%08x:%08x:%08x\n",
309 swapl(uuid32[0]),
310 swapl(uuid32[1]),
311 swapl(uuid32[2]),
312 swapl(uuid32[3]));
313 else
314 printf(" UUID : %08x:%08x:%08x:%08x\n",
315 uuid32[0],
316 uuid32[1],
317 uuid32[2],
318 uuid32[3]);
319
b98043a2
GJ
320 if (sb->nodes == 0) {
321 printf(" Events : %llu\n", (unsigned long long)sb->events);
322 printf(" Events Cleared : %llu\n", (unsigned long long)sb->events_cleared);
323 printf(" State : %s\n", bitmap_state(sb->state));
324
325 }
326
c82f047c
NB
327 printf(" Chunksize : %s\n", human_chunksize(sb->chunksize));
328 printf(" Daemon : %ds flush period\n", sb->daemon_sleep);
dfd4d8ee
NB
329 if (sb->write_behind)
330 sprintf(buf, "Allow write behind, max %d", sb->write_behind);
331 else
332 sprintf(buf, "Normal");
333 printf(" Write Mode : %s\n", buf);
f9c25f1d 334 printf(" Sync Size : %llu%s\n", (unsigned long long)sb->sync_size/2,
f277ce36 335 human_size(sb->sync_size * 512));
b98043a2
GJ
336
337 if (sb->nodes == 0) {
338 if (brief)
339 goto free_info;
340 printf(" Bitmap : %llu bits (chunks), %llu dirty (%2.1f%%)\n",
341 info->total_bits, info->dirty_bits,
342 100.0 * info->dirty_bits / (info->total_bits?:1));
343 } else {
344 printf(" Cluster nodes : %d\n", sb->nodes);
345 printf(" Cluster name : %64s\n", sb->cluster_name);
346 for (i = 0; i < (int)sb->nodes; i++) {
347 if (i) {
348 free(info);
349 info = bitmap_fd_read(fd, brief);
350 sb = &info->sb;
351 }
352 if (sb->magic != BITMAP_MAGIC)
353 pr_err("invalid bitmap magic 0x%x, the bitmap file appears to be corrupted\n", sb->magic);
354
355 printf(" Node Slot : %d\n", i);
356 printf(" Events : %llu\n",
357 (unsigned long long)sb->events);
358 printf(" Events Cleared : %llu\n",
359 (unsigned long long)sb->events_cleared);
360 printf(" State : %s\n", bitmap_state(sb->state));
361 if (brief)
362 continue;
363 printf(" Bitmap : %llu bits (chunks), %llu dirty (%2.1f%%)\n",
364 info->total_bits, info->dirty_bits,
365 100.0 * info->dirty_bits / (info->total_bits?:1));
366
367 }
368 }
369
c82f047c
NB
370free_info:
371 free(info);
372 return rv;
373}
374
375int CreateBitmap(char *filename, int force, char uuid[16],
1bf4e2d9
NB
376 unsigned long chunksize, unsigned long daemon_sleep,
377 unsigned long write_behind,
dcec9ee5
NB
378 unsigned long long array_size /* sectors */,
379 int major)
c82f047c
NB
380{
381 /*
382 * Create a bitmap file with a superblock and (optionally) a full bitmap
383 */
384
385 FILE *fp;
386 int rv = 1;
387 char block[512];
388 bitmap_super_t sb;
389 long long bytes, filesize;
390
391 if (!force && access(filename, F_OK) == 0) {
e7b84f9d 392 pr_err("bitmap file %s already exists, use --force to overwrite\n", filename);
c82f047c
NB
393 return rv;
394 }
395
396 fp = fopen(filename, "w");
397 if (fp == NULL) {
e7b84f9d 398 pr_err("failed to open bitmap file %s: %s\n",
c82f047c
NB
399 filename, strerror(errno));
400 return rv;
401 }
402
1bfdbe01
NB
403 if (chunksize == UnSet) {
404 /* We don't want more than 2^21 chunks, as 2^11 fill up one
405 * 4K page (2 bytes per chunk), and 2^10 address of those
b39827de
NB
406 * fill up a 4K indexing page. 2^20 might be safer, especially
407 * on 64bit hosts, so use that.
1bfdbe01
NB
408 */
409 chunksize = DEFAULT_BITMAP_CHUNK;
b39827de 410 /* <<20 for 2^20 chunks, >>9 to convert bytes to sectors */
3e416561 411 while (array_size > ((unsigned long long)chunksize << (20-9)))
1bfdbe01
NB
412 chunksize <<= 1;
413 }
414
c82f047c
NB
415 memset(&sb, 0, sizeof(sb));
416 sb.magic = BITMAP_MAGIC;
dcec9ee5 417 sb.version = major;
c82f047c
NB
418 if (uuid != NULL)
419 memcpy(sb.uuid, uuid, 16);
420 sb.chunksize = chunksize;
421 sb.daemon_sleep = daemon_sleep;
dfd4d8ee 422 sb.write_behind = write_behind;
c82f047c
NB
423 sb.sync_size = array_size;
424
425 sb_cpu_to_le(&sb); /* convert to on-disk byte ordering */
426
427 if (fwrite(&sb, sizeof(sb), 1, fp) != 1) {
e7b84f9d 428 pr_err("failed to write superblock to bitmap file %s: %s\n", filename, strerror(errno));
c82f047c
NB
429 goto out;
430 }
431
432 /* calculate the size of the bitmap and write it to disk */
433 bytes = (bitmap_bits(array_size, chunksize) + 7) / 8;
434 if (!bytes) {
435 rv = 0;
436 goto out;
437 }
438
439 filesize = bytes + sizeof(sb);
440
441 memset(block, 0xff, sizeof(block));
442
443 while (bytes > 0) {
444 if (fwrite(block, sizeof(block), 1, fp) != 1) {
e7b84f9d 445 pr_err("failed to write bitmap file %s: %s\n", filename, strerror(errno));
c82f047c
NB
446 goto out;
447 }
448 bytes -= sizeof(block);
449 }
aba69144 450
c82f047c 451 rv = 0;
97a6748c 452 fflush(fp);
c82f047c 453 /* make the file be the right size (well, to the nearest byte) */
1e0d770c
NB
454 if (ftruncate(fileno(fp), filesize))
455 perror("ftrunace");
c82f047c
NB
456out:
457 fclose(fp);
458 if (rv)
459 unlink(filename); /* possibly corrupted, better get rid of it */
460 return rv;
461}
8131b493 462
bf4fb153 463int bitmap_update_uuid(int fd, int *uuid, int swap)
8131b493
NB
464{
465 struct bitmap_super_s bm;
9fca7d62
NB
466 if (lseek(fd, 0, 0) != 0)
467 return 1;
8131b493 468 if (read(fd, &bm, sizeof(bm)) != sizeof(bm))
9fca7d62 469 return 1;
8131b493 470 if (bm.magic != __cpu_to_le32(BITMAP_MAGIC))
9fca7d62 471 return 1;
350f29f9 472 copy_uuid(bm.uuid, uuid, swap);
9fca7d62
NB
473 if (lseek(fd, 0, 0) != 0)
474 return 2;
475 if (write(fd, &bm, sizeof(bm)) != sizeof(bm)) {
476 lseek(fd, 0, 0);
477 return 2;
478 }
8131b493 479 lseek(fd, 0, 0);
9fca7d62 480 return 0;
8131b493 481}