Centralise code for copying uuid
[thirdparty/mdadm.git] / bitmap.c
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
21 #include "mdadm.h"
22
23 #define min(a,b) (((a) < (b)) ? (a) : (b))
24
25 inline void sb_le_to_cpu(bitmap_super_t *sb)
26 {
27         sb->magic = __le32_to_cpu(sb->magic);
28         sb->version = __le32_to_cpu(sb->version);
29         /* uuid gets no translation */
30         sb->events = __le64_to_cpu(sb->events);
31         sb->events_cleared = __le64_to_cpu(sb->events_cleared);
32         sb->state = __le32_to_cpu(sb->state);
33         sb->chunksize = __le32_to_cpu(sb->chunksize);
34         sb->daemon_sleep = __le32_to_cpu(sb->daemon_sleep);
35         sb->sync_size = __le64_to_cpu(sb->sync_size);
36         sb->write_behind = __le32_to_cpu(sb->write_behind);
37 }
38
39 inline void sb_cpu_to_le(bitmap_super_t *sb)
40 {
41         sb_le_to_cpu(sb); /* these are really the same thing */
42 }
43
44 mapping_t bitmap_states[] = {
45         { "OK", 0 },
46         { "Out of date", 2 },
47         { NULL, -1 }
48 };
49
50 const char *bitmap_state(int state_num)
51 {
52         char *state = map_num(bitmap_states, state_num);
53         return state ? state : "Unknown";
54 }
55
56 const 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
67         snprintf(buf, sizeof(buf), "%lu %s", bytes, suffixes[i]);
68
69         return buf;
70 }
71
72 typedef 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 */
79 inline 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
98 int count_dirty_bits(char *buf, int num_bits)
99 {
100         int i, num = 0;
101
102         for (i=0; i < num_bits / 8; i++)
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 */
112 unsigned long long bitmap_bits(unsigned long long array_size,
113                                 unsigned long chunksize)
114 {
115         return (array_size * 512 + chunksize - 1) / chunksize;
116 }
117
118 bitmap_info_t *bitmap_fd_read(int fd, int brief)
119 {
120         /* Note: fd might be open O_DIRECT, so we must be
121          * careful to align reads properly
122          */
123         unsigned long long total_bits = 0, read_bits = 0, dirty_bits = 0;
124         bitmap_info_t *info;
125         char *buf, *unaligned;
126         int n, skip;
127
128         unaligned = malloc(8192*2);
129         buf = (char*) ((unsigned long)unaligned | 8191)+1;
130         n = read(fd, buf, 8192);
131
132         info = malloc(sizeof(*info));
133         if (info == NULL) {
134 #if __GNUC__ < 3
135                 fprintf(stderr, Name ": failed to allocate %d bytes\n",
136                                 (int)sizeof(*info));
137 #else
138                 fprintf(stderr, Name ": failed to allocate %zd bytes\n",
139                                 sizeof(*info));
140 #endif
141                 return NULL;
142         }
143
144         if (n < sizeof(info->sb)) {
145                 fprintf(stderr, Name ": failed to read superblock of bitmap "
146                         "file: %s\n", strerror(errno));
147                 free(info);
148                 free(unaligned);
149                 return NULL;
150         }
151         memcpy(&info->sb, buf, sizeof(info->sb));
152         skip = sizeof(info->sb);
153
154         sb_le_to_cpu(&info->sb); /* convert superblock to CPU byte ordering */
155         
156         if (brief || info->sb.sync_size == 0)
157                 goto out;
158
159         /* read the rest of the file counting total bits and dirty bits --
160          * we stop when either:
161          * 1) we hit EOF, in which case we assume the rest of the bits (if any)
162          *    are dirty
163          * 2) we've read the full bitmap, in which case we ignore any trailing
164          *    data in the file
165          */
166         total_bits = bitmap_bits(info->sb.sync_size, info->sb.chunksize);
167
168         while(read_bits < total_bits) {
169                 unsigned long long remaining = total_bits - read_bits;
170
171                 if (n == 0) {
172                         n = read(fd, buf, 8192);
173                         skip = 0;
174                         if (n <= 0)
175                                 break;
176                 }
177                 if (remaining > (n-skip) * 8) /* we want the full buffer */
178                         remaining = (n-skip) * 8;
179
180                 dirty_bits += count_dirty_bits(buf+skip, remaining);
181
182                 read_bits += remaining;
183                 n = 0;
184         }
185
186         if (read_bits < total_bits) { /* file truncated... */
187                 fprintf(stderr, Name ": WARNING: bitmap file is not large "
188                         "enough for array size %llu!\n\n",
189                         (unsigned long long)info->sb.sync_size);
190                 total_bits = read_bits;
191         }
192 out:
193         info->total_bits = total_bits;
194         info->dirty_bits = dirty_bits;
195         return info;
196 }
197
198 bitmap_info_t *bitmap_file_read(char *filename, int brief, struct supertype **stp)
199 {
200         int fd;
201         bitmap_info_t *info;
202         struct stat stb;
203         struct supertype *st = *stp;
204
205         if (stat(filename, &stb) < 0) {
206                 fprintf(stderr, Name ": failed to find file %s: %s\n",
207                         filename, strerror(errno));
208                 return NULL;
209         }
210         if ((S_IFMT & stb.st_mode) == S_IFBLK) {
211                 fd = open(filename, O_RDONLY);
212                 if (fd < 0) {
213                         fprintf(stderr, Name ": failed to open bitmap file %s: %s\n",
214                                 filename, strerror(errno));
215                         return NULL;
216                 }
217                 /* block device, so we are probably after an internal bitmap */
218                 if (!st) st = guess_super(fd);
219                 if (!st) {
220                         /* just look at device... */
221                         lseek(fd, 0, 0);
222                 } else {        
223                         st->ss->locate_bitmap(st, fd, NULL);
224                 }
225                 ioctl(fd, BLKFLSBUF, 0); /* make sure we read current data */
226                 *stp = st;
227         } else {
228                 fd = open(filename, O_RDONLY|O_DIRECT);
229                 if (fd < 0) {
230                         fprintf(stderr, Name ": failed to open bitmap file %s: %s\n",
231                                 filename, strerror(errno));
232                         return NULL;
233                 }
234         }
235
236         info = bitmap_fd_read(fd, brief);
237         close(fd);
238         return info;
239 }
240
241 __u32 swapl(__u32 l)
242 {
243         char *c = (char*)&l;
244         char t= c[0];
245         c[0] = c[3];
246         c[3] = t;
247
248         t = c[1];
249         c[1] = c[2];
250         c[2] = t;
251         return l;
252 }
253 int ExamineBitmap(char *filename, int brief, struct supertype *st)
254 {
255         /*
256          * Read the bitmap file and display its contents
257          */
258
259         bitmap_super_t *sb;
260         bitmap_info_t *info;
261         int rv = 1;
262         char buf[64];
263         int swap;
264
265         info = bitmap_file_read(filename, brief, &st);
266         if (!info)
267                 return rv;
268
269         sb = &info->sb;
270         printf("        Filename : %s\n", filename);
271         printf("           Magic : %08x\n", sb->magic);
272         if (sb->magic != BITMAP_MAGIC) {
273                 fprintf(stderr, Name ": invalid bitmap magic 0x%x, the bitmap file appears to be corrupted\n", sb->magic);
274         }
275         printf("         Version : %d\n", sb->version);
276         if (sb->version < BITMAP_MAJOR_LO ||
277             sb->version > BITMAP_MAJOR_HI) {
278                 fprintf(stderr, Name ": unknown bitmap version %d, either the bitmap file is corrupted or you need to upgrade your tools\n", sb->version);
279                 goto free_info;
280         }
281
282         rv = 0;
283         if (st)
284                 swap = st->ss->swapuuid;
285         else
286 #if __BYTE_ORDER == BIG_ENDIAN
287                 swap = 0;
288 #else
289                 swap = 1;
290 #endif
291         if (swap) {
292         printf("            UUID : %08x:%08x:%08x:%08x\n",
293                                         swapl(*(__u32 *)(sb->uuid+0)),
294                                         swapl(*(__u32 *)(sb->uuid+4)),
295                                         swapl(*(__u32 *)(sb->uuid+8)),
296                                         swapl(*(__u32 *)(sb->uuid+12)));
297         } else {
298         printf("            UUID : %08x:%08x:%08x:%08x\n",
299                                         *(__u32 *)(sb->uuid+0),
300                                         *(__u32 *)(sb->uuid+4),
301                                         *(__u32 *)(sb->uuid+8),
302                                         *(__u32 *)(sb->uuid+12));
303         }
304         printf("          Events : %llu\n", (unsigned long long)sb->events);
305         printf("  Events Cleared : %llu\n", (unsigned long long)sb->events_cleared);
306         printf("           State : %s\n", bitmap_state(sb->state));
307         printf("       Chunksize : %s\n", human_chunksize(sb->chunksize));
308         printf("          Daemon : %ds flush period\n", sb->daemon_sleep);
309         if (sb->write_behind)
310                 sprintf(buf, "Allow write behind, max %d", sb->write_behind);
311         else
312                 sprintf(buf, "Normal");
313         printf("      Write Mode : %s\n", buf);
314         printf("       Sync Size : %llu%s\n", (unsigned long long)sb->sync_size/2,
315                                         human_size(sb->sync_size * 512));
316         if (brief)
317                 goto free_info;
318         printf("          Bitmap : %llu bits (chunks), %llu dirty (%2.1f%%)\n",
319                         info->total_bits, info->dirty_bits,
320                         100.0 * info->dirty_bits / (info->total_bits + 1));
321 free_info:
322         free(info);
323         return rv;
324 }
325
326 int CreateBitmap(char *filename, int force, char uuid[16],
327                  unsigned long chunksize, unsigned long daemon_sleep,
328                  unsigned long write_behind,
329                  unsigned long long array_size /* sectors */,
330                  int major)
331 {
332         /*
333          * Create a bitmap file with a superblock and (optionally) a full bitmap
334          */
335
336         FILE *fp;
337         int rv = 1;
338         char block[512];
339         bitmap_super_t sb;
340         long long bytes, filesize;
341
342         if (!force && access(filename, F_OK) == 0) {
343                 fprintf(stderr, Name ": bitmap file %s already exists, use --force to overwrite\n", filename);
344                 return rv;
345         }
346
347         fp = fopen(filename, "w");
348         if (fp == NULL) {
349                 fprintf(stderr, Name ": failed to open bitmap file %s: %s\n",
350                         filename, strerror(errno));
351                 return rv;
352         }
353
354         if (chunksize == UnSet) {
355                 /* We don't want more than 2^21 chunks, as 2^11 fill up one
356                  * 4K page (2 bytes per chunk), and 2^10 address of those
357                  * fill up a 4K indexing page.  2^20 might be safer, especially
358                  * on 64bit hosts, so use that.
359                  */
360                 chunksize = DEFAULT_BITMAP_CHUNK;
361                 /* <<20 for 2^20 chunks, >>9 to convert bytes to sectors */
362                 while (array_size > (chunksize << (20-9)))
363                         chunksize <<= 1;
364         }
365
366         memset(&sb, 0, sizeof(sb));
367         sb.magic = BITMAP_MAGIC;
368         sb.version = major;
369         if (uuid != NULL)
370                 memcpy(sb.uuid, uuid, 16);
371         sb.chunksize = chunksize;
372         sb.daemon_sleep = daemon_sleep;
373         sb.write_behind = write_behind;
374         sb.sync_size = array_size;
375
376         sb_cpu_to_le(&sb); /* convert to on-disk byte ordering */
377
378         if (fwrite(&sb, sizeof(sb), 1, fp) != 1) {
379                 fprintf(stderr, Name ": failed to write superblock to bitmap file %s: %s\n", filename, strerror(errno));
380                 goto out;
381         }
382
383         /* calculate the size of the bitmap and write it to disk */
384         bytes = (bitmap_bits(array_size, chunksize) + 7) / 8;
385         if (!bytes) {
386                 rv = 0;
387                 goto out;
388         }
389
390         filesize = bytes + sizeof(sb);
391
392         memset(block, 0xff, sizeof(block));
393
394         while (bytes > 0) {
395                 if (fwrite(block, sizeof(block), 1, fp) != 1) {
396                         fprintf(stderr, Name ": failed to write bitmap file %s: %s\n", filename, strerror(errno));
397                         goto out;
398                 }
399                 bytes -= sizeof(block);
400         }
401         
402         rv = 0;
403         fflush(fp);
404         /* make the file be the right size (well, to the nearest byte) */
405         if (ftruncate(fileno(fp), filesize))
406                 perror("ftrunace");
407 out:
408         fclose(fp);
409         if (rv)
410                 unlink(filename); /* possibly corrupted, better get rid of it */
411         return rv;
412 }
413
414 int bitmap_update_uuid(int fd, int *uuid, int swap)
415 {
416         struct bitmap_super_s bm;
417         if (lseek(fd, 0, 0) != 0)
418                 return 1;
419         if (read(fd, &bm, sizeof(bm)) != sizeof(bm))
420                 return 1;
421         if (bm.magic != __cpu_to_le32(BITMAP_MAGIC))
422                 return 1;
423         copy_uuid(bm.uuid, uuid, swap);
424         if (lseek(fd, 0, 0) != 0)
425                 return 2;
426         if (write(fd, &bm, sizeof(bm)) != sizeof(bm)) {
427                 lseek(fd, 0, 0);
428                 return 2;
429         }
430         lseek(fd, 0, 0);
431         return 0;
432 }