Commit | Line | Data |
---|---|---|
3bd94003 | 1 | // SPDX-License-Identifier: GPL-2.0-only |
1da177e4 LT |
2 | /* |
3 | * Copyright (C) 2003 Sistina Software | |
b7fd54a7 | 4 | * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved. |
1da177e4 LT |
5 | * |
6 | * This file is released under the LGPL. | |
7 | */ | |
8 | ||
9 | #include <linux/init.h> | |
10 | #include <linux/slab.h> | |
11 | #include <linux/module.h> | |
12 | #include <linux/vmalloc.h> | |
a765e20e AK |
13 | #include <linux/dm-io.h> |
14 | #include <linux/dm-dirty-log.h> | |
1da177e4 | 15 | |
586e80e6 | 16 | #include <linux/device-mapper.h> |
1da177e4 | 17 | |
b7fd54a7 | 18 | #define DM_MSG_PREFIX "dirty region log" |
72d94861 | 19 | |
1da177e4 LT |
20 | static LIST_HEAD(_log_types); |
21 | static DEFINE_SPINLOCK(_lock); | |
22 | ||
ec44ab9d | 23 | static struct dm_dirty_log_type *__find_dirty_log_type(const char *name) |
1da177e4 | 24 | { |
ec44ab9d | 25 | struct dm_dirty_log_type *log_type; |
2a23aa1d JB |
26 | |
27 | list_for_each_entry(log_type, &_log_types, list) | |
ec44ab9d | 28 | if (!strcmp(name, log_type->name)) |
2a23aa1d JB |
29 | return log_type; |
30 | ||
31 | return NULL; | |
32 | } | |
33 | ||
ec44ab9d | 34 | static struct dm_dirty_log_type *_get_dirty_log_type(const char *name) |
2a23aa1d | 35 | { |
ec44ab9d | 36 | struct dm_dirty_log_type *log_type; |
1da177e4 LT |
37 | |
38 | spin_lock(&_lock); | |
2a23aa1d JB |
39 | |
40 | log_type = __find_dirty_log_type(name); | |
ec44ab9d | 41 | if (log_type && !try_module_get(log_type->module)) |
84e67c93 | 42 | log_type = NULL; |
1da177e4 LT |
43 | |
44 | spin_unlock(&_lock); | |
2a23aa1d JB |
45 | |
46 | return log_type; | |
1da177e4 LT |
47 | } |
48 | ||
fb8b2848 JB |
49 | /* |
50 | * get_type | |
51 | * @type_name | |
52 | * | |
2a23aa1d | 53 | * Attempt to retrieve the dm_dirty_log_type by name. If not already |
fb8b2848 JB |
54 | * available, attempt to load the appropriate module. |
55 | * | |
56 | * Log modules are named "dm-log-" followed by the 'type_name'. | |
57 | * Modules may contain multiple types. | |
58 | * This function will first try the module "dm-log-<type_name>", | |
59 | * then truncate 'type_name' on the last '-' and try again. | |
60 | * | |
61 | * For example, if type_name was "clustered-disk", it would search | |
62 | * 'dm-log-clustered-disk' then 'dm-log-clustered'. | |
63 | * | |
64 | * Returns: dirty_log_type* on success, NULL on failure | |
65 | */ | |
416cd17b | 66 | static struct dm_dirty_log_type *get_type(const char *type_name) |
fb8b2848 JB |
67 | { |
68 | char *p, *type_name_dup; | |
ec44ab9d | 69 | struct dm_dirty_log_type *log_type; |
fb8b2848 | 70 | |
2a23aa1d JB |
71 | if (!type_name) |
72 | return NULL; | |
73 | ||
74 | log_type = _get_dirty_log_type(type_name); | |
75 | if (log_type) | |
ec44ab9d | 76 | return log_type; |
fb8b2848 JB |
77 | |
78 | type_name_dup = kstrdup(type_name, GFP_KERNEL); | |
79 | if (!type_name_dup) { | |
80 | DMWARN("No memory left to attempt log module load for \"%s\"", | |
81 | type_name); | |
82 | return NULL; | |
83 | } | |
84 | ||
85 | while (request_module("dm-log-%s", type_name_dup) || | |
2a23aa1d | 86 | !(log_type = _get_dirty_log_type(type_name))) { |
fb8b2848 JB |
87 | p = strrchr(type_name_dup, '-'); |
88 | if (!p) | |
89 | break; | |
90 | p[0] = '\0'; | |
91 | } | |
92 | ||
2a23aa1d | 93 | if (!log_type) |
fb8b2848 JB |
94 | DMWARN("Module for logging type \"%s\" not found.", type_name); |
95 | ||
96 | kfree(type_name_dup); | |
97 | ||
ec44ab9d | 98 | return log_type; |
fb8b2848 JB |
99 | } |
100 | ||
416cd17b | 101 | static void put_type(struct dm_dirty_log_type *type) |
1da177e4 | 102 | { |
2a23aa1d JB |
103 | if (!type) |
104 | return; | |
105 | ||
1da177e4 | 106 | spin_lock(&_lock); |
ec44ab9d | 107 | if (!__find_dirty_log_type(type->name)) |
2a23aa1d JB |
108 | goto out; |
109 | ||
84e67c93 | 110 | module_put(type->module); |
2a23aa1d JB |
111 | |
112 | out: | |
1da177e4 LT |
113 | spin_unlock(&_lock); |
114 | } | |
115 | ||
b8206bc3 AK |
116 | int dm_dirty_log_type_register(struct dm_dirty_log_type *type) |
117 | { | |
2a23aa1d JB |
118 | int r = 0; |
119 | ||
b8206bc3 | 120 | spin_lock(&_lock); |
2a23aa1d | 121 | if (!__find_dirty_log_type(type->name)) |
ec44ab9d MS |
122 | list_add(&type->list, &_log_types); |
123 | else | |
2a23aa1d | 124 | r = -EEXIST; |
b8206bc3 AK |
125 | spin_unlock(&_lock); |
126 | ||
2a23aa1d | 127 | return r; |
b8206bc3 AK |
128 | } |
129 | EXPORT_SYMBOL(dm_dirty_log_type_register); | |
130 | ||
131 | int dm_dirty_log_type_unregister(struct dm_dirty_log_type *type) | |
132 | { | |
133 | spin_lock(&_lock); | |
134 | ||
ec44ab9d | 135 | if (!__find_dirty_log_type(type->name)) { |
2a23aa1d JB |
136 | spin_unlock(&_lock); |
137 | return -EINVAL; | |
138 | } | |
139 | ||
ec44ab9d | 140 | list_del(&type->list); |
b8206bc3 AK |
141 | |
142 | spin_unlock(&_lock); | |
143 | ||
144 | return 0; | |
145 | } | |
146 | EXPORT_SYMBOL(dm_dirty_log_type_unregister); | |
147 | ||
416cd17b | 148 | struct dm_dirty_log *dm_dirty_log_create(const char *type_name, |
87a8f240 MP |
149 | struct dm_target *ti, |
150 | int (*flush_callback_fn)(struct dm_target *ti), | |
151 | unsigned int argc, char **argv) | |
1da177e4 | 152 | { |
416cd17b HM |
153 | struct dm_dirty_log_type *type; |
154 | struct dm_dirty_log *log; | |
1da177e4 LT |
155 | |
156 | log = kmalloc(sizeof(*log), GFP_KERNEL); | |
157 | if (!log) | |
158 | return NULL; | |
159 | ||
160 | type = get_type(type_name); | |
161 | if (!type) { | |
162 | kfree(log); | |
163 | return NULL; | |
164 | } | |
165 | ||
87a8f240 | 166 | log->flush_callback_fn = flush_callback_fn; |
1da177e4 LT |
167 | log->type = type; |
168 | if (type->ctr(log, ti, argc, argv)) { | |
169 | kfree(log); | |
170 | put_type(type); | |
171 | return NULL; | |
172 | } | |
173 | ||
174 | return log; | |
175 | } | |
416cd17b | 176 | EXPORT_SYMBOL(dm_dirty_log_create); |
1da177e4 | 177 | |
416cd17b | 178 | void dm_dirty_log_destroy(struct dm_dirty_log *log) |
1da177e4 LT |
179 | { |
180 | log->type->dtr(log); | |
181 | put_type(log->type); | |
182 | kfree(log); | |
183 | } | |
416cd17b | 184 | EXPORT_SYMBOL(dm_dirty_log_destroy); |
1da177e4 | 185 | |
a4a82ce3 HM |
186 | /* |
187 | *--------------------------------------------------------------- | |
1da177e4 LT |
188 | * Persistent and core logs share a lot of their implementation. |
189 | * FIXME: need a reload method to be called from a resume | |
a4a82ce3 HM |
190 | *--------------------------------------------------------------- |
191 | */ | |
1da177e4 LT |
192 | /* |
193 | * Magic for persistent mirrors: "MiRr" | |
194 | */ | |
195 | #define MIRROR_MAGIC 0x4D695272 | |
196 | ||
197 | /* | |
198 | * The on-disk version of the metadata. | |
199 | */ | |
a4fc4717 | 200 | #define MIRROR_DISK_VERSION 2 |
1da177e4 LT |
201 | #define LOG_OFFSET 2 |
202 | ||
283a8328 AK |
203 | struct log_header_disk { |
204 | __le32 magic; | |
1da177e4 LT |
205 | |
206 | /* | |
207 | * Simple, incrementing version. no backward | |
208 | * compatibility. | |
209 | */ | |
283a8328 AK |
210 | __le32 version; |
211 | __le64 nr_regions; | |
212 | } __packed; | |
213 | ||
214 | struct log_header_core { | |
215 | uint32_t magic; | |
1da177e4 | 216 | uint32_t version; |
283a8328 | 217 | uint64_t nr_regions; |
1da177e4 LT |
218 | }; |
219 | ||
220 | struct log_c { | |
221 | struct dm_target *ti; | |
b09acf1a MP |
222 | int touched_dirtied; |
223 | int touched_cleaned; | |
5adc78d0 | 224 | int flush_failed; |
1da177e4 LT |
225 | uint32_t region_size; |
226 | unsigned int region_count; | |
227 | region_t sync_count; | |
228 | ||
86a3238c | 229 | unsigned int bitset_uint32_count; |
1da177e4 LT |
230 | uint32_t *clean_bits; |
231 | uint32_t *sync_bits; | |
232 | uint32_t *recovering_bits; /* FIXME: this seems excessive */ | |
233 | ||
234 | int sync_search; | |
235 | ||
236 | /* Resync flag */ | |
237 | enum sync { | |
238 | DEFAULTSYNC, /* Synchronize if necessary */ | |
239 | NOSYNC, /* Devices known to be already in sync */ | |
240 | FORCESYNC, /* Force a sync to happen */ | |
241 | } sync; | |
242 | ||
5d234d1e HM |
243 | struct dm_io_request io_req; |
244 | ||
1da177e4 LT |
245 | /* |
246 | * Disk log fields | |
247 | */ | |
01d03a66 | 248 | int log_dev_failed; |
64b30c46 | 249 | int log_dev_flush_failed; |
1da177e4 | 250 | struct dm_dev *log_dev; |
283a8328 | 251 | struct log_header_core header; |
1da177e4 | 252 | |
22a1ceb1 | 253 | struct dm_io_region header_location; |
283a8328 | 254 | struct log_header_disk *disk_header; |
1da177e4 LT |
255 | }; |
256 | ||
257 | /* | |
258 | * The touched member needs to be updated every time we access | |
259 | * one of the bitsets. | |
260 | */ | |
86a3238c | 261 | static inline int log_test_bit(uint32_t *bs, unsigned int bit) |
1da177e4 | 262 | { |
c8f543e0 | 263 | return test_bit_le(bit, bs) ? 1 : 0; |
1da177e4 LT |
264 | } |
265 | ||
266 | static inline void log_set_bit(struct log_c *l, | |
86a3238c | 267 | uint32_t *bs, unsigned int bit) |
1da177e4 | 268 | { |
c8f543e0 | 269 | __set_bit_le(bit, bs); |
b09acf1a | 270 | l->touched_cleaned = 1; |
1da177e4 LT |
271 | } |
272 | ||
273 | static inline void log_clear_bit(struct log_c *l, | |
86a3238c | 274 | uint32_t *bs, unsigned int bit) |
1da177e4 | 275 | { |
c8f543e0 | 276 | __clear_bit_le(bit, bs); |
b09acf1a | 277 | l->touched_dirtied = 1; |
1da177e4 LT |
278 | } |
279 | ||
a4a82ce3 HM |
280 | /* |
281 | *--------------------------------------------------------------- | |
1da177e4 | 282 | * Header IO |
a4a82ce3 HM |
283 | *-------------------------------------------------------------- |
284 | */ | |
283a8328 | 285 | static void header_to_disk(struct log_header_core *core, struct log_header_disk *disk) |
1da177e4 LT |
286 | { |
287 | disk->magic = cpu_to_le32(core->magic); | |
288 | disk->version = cpu_to_le32(core->version); | |
289 | disk->nr_regions = cpu_to_le64(core->nr_regions); | |
290 | } | |
291 | ||
283a8328 | 292 | static void header_from_disk(struct log_header_core *core, struct log_header_disk *disk) |
1da177e4 LT |
293 | { |
294 | core->magic = le32_to_cpu(disk->magic); | |
295 | core->version = le32_to_cpu(disk->version); | |
296 | core->nr_regions = le64_to_cpu(disk->nr_regions); | |
297 | } | |
298 | ||
c1389b33 | 299 | static int rw_header(struct log_c *lc, enum req_op op) |
5d234d1e | 300 | { |
581075e4 | 301 | lc->io_req.bi_opf = op; |
5d234d1e HM |
302 | |
303 | return dm_io(&lc->io_req, 1, &lc->header_location, NULL); | |
304 | } | |
305 | ||
20a34a8e MP |
306 | static int flush_header(struct log_c *lc) |
307 | { | |
308 | struct dm_io_region null_location = { | |
309 | .bdev = lc->header_location.bdev, | |
310 | .sector = 0, | |
311 | .count = 0, | |
312 | }; | |
313 | ||
581075e4 | 314 | lc->io_req.bi_opf = REQ_OP_WRITE | REQ_PREFLUSH; |
20a34a8e MP |
315 | |
316 | return dm_io(&lc->io_req, 1, &null_location, NULL); | |
317 | } | |
318 | ||
1da177e4 LT |
319 | static int read_header(struct log_c *log) |
320 | { | |
321 | int r; | |
1da177e4 | 322 | |
9c5a559d | 323 | r = rw_header(log, REQ_OP_READ); |
1da177e4 LT |
324 | if (r) |
325 | return r; | |
326 | ||
327 | header_from_disk(&log->header, log->disk_header); | |
328 | ||
329 | /* New log required? */ | |
330 | if (log->sync != DEFAULTSYNC || log->header.magic != MIRROR_MAGIC) { | |
331 | log->header.magic = MIRROR_MAGIC; | |
332 | log->header.version = MIRROR_DISK_VERSION; | |
333 | log->header.nr_regions = 0; | |
334 | } | |
335 | ||
a4fc4717 PC |
336 | #ifdef __LITTLE_ENDIAN |
337 | if (log->header.version == 1) | |
338 | log->header.version = 2; | |
339 | #endif | |
340 | ||
1da177e4 LT |
341 | if (log->header.version != MIRROR_DISK_VERSION) { |
342 | DMWARN("incompatible disk log version"); | |
343 | return -EINVAL; | |
344 | } | |
345 | ||
346 | return 0; | |
347 | } | |
348 | ||
2045e88e MB |
349 | static int _check_region_size(struct dm_target *ti, uint32_t region_size) |
350 | { | |
351 | if (region_size < 2 || region_size > ti->len) | |
352 | return 0; | |
353 | ||
354 | if (!is_power_of_2(region_size)) | |
355 | return 0; | |
356 | ||
357 | return 1; | |
358 | } | |
359 | ||
a4a82ce3 HM |
360 | /* |
361 | *-------------------------------------------------------------- | |
1da177e4 LT |
362 | * core log constructor/destructor |
363 | * | |
364 | * argv contains region_size followed optionally by [no]sync | |
a4a82ce3 HM |
365 | *-------------------------------------------------------------- |
366 | */ | |
1da177e4 | 367 | #define BYTE_SHIFT 3 |
416cd17b | 368 | static int create_log_context(struct dm_dirty_log *log, struct dm_target *ti, |
b7cca195 AK |
369 | unsigned int argc, char **argv, |
370 | struct dm_dev *dev) | |
1da177e4 LT |
371 | { |
372 | enum sync sync = DEFAULTSYNC; | |
373 | ||
374 | struct log_c *lc; | |
375 | uint32_t region_size; | |
376 | unsigned int region_count; | |
b7cca195 | 377 | size_t bitset_size, buf_size; |
5d234d1e | 378 | int r; |
31998ef1 | 379 | char dummy; |
1da177e4 LT |
380 | |
381 | if (argc < 1 || argc > 2) { | |
b7fd54a7 | 382 | DMWARN("wrong number of arguments to dirty region log"); |
1da177e4 LT |
383 | return -EINVAL; |
384 | } | |
385 | ||
386 | if (argc > 1) { | |
387 | if (!strcmp(argv[1], "sync")) | |
388 | sync = FORCESYNC; | |
389 | else if (!strcmp(argv[1], "nosync")) | |
390 | sync = NOSYNC; | |
391 | else { | |
2e84fecf | 392 | DMWARN("unrecognised sync argument to dirty region log: %s", argv[1]); |
1da177e4 LT |
393 | return -EINVAL; |
394 | } | |
395 | } | |
396 | ||
31998ef1 | 397 | if (sscanf(argv[0], "%u%c", ®ion_size, &dummy) != 1 || |
2045e88e MB |
398 | !_check_region_size(ti, region_size)) { |
399 | DMWARN("invalid region size %s", argv[0]); | |
1da177e4 LT |
400 | return -EINVAL; |
401 | } | |
402 | ||
403 | region_count = dm_sector_div_up(ti->len, region_size); | |
404 | ||
405 | lc = kmalloc(sizeof(*lc), GFP_KERNEL); | |
406 | if (!lc) { | |
407 | DMWARN("couldn't allocate core log"); | |
408 | return -ENOMEM; | |
409 | } | |
410 | ||
411 | lc->ti = ti; | |
b09acf1a MP |
412 | lc->touched_dirtied = 0; |
413 | lc->touched_cleaned = 0; | |
5adc78d0 | 414 | lc->flush_failed = 0; |
1da177e4 LT |
415 | lc->region_size = region_size; |
416 | lc->region_count = region_count; | |
417 | lc->sync = sync; | |
418 | ||
419 | /* | |
0e56822d | 420 | * Work out how many "unsigned long"s we need to hold the bitset. |
1da177e4 | 421 | */ |
85e123c2 | 422 | bitset_size = dm_round_up(region_count, BITS_PER_LONG); |
1da177e4 LT |
423 | bitset_size >>= BYTE_SHIFT; |
424 | ||
29121bd0 | 425 | lc->bitset_uint32_count = bitset_size / sizeof(*lc->clean_bits); |
b7cca195 AK |
426 | |
427 | /* | |
428 | * Disk log? | |
429 | */ | |
430 | if (!dev) { | |
431 | lc->clean_bits = vmalloc(bitset_size); | |
432 | if (!lc->clean_bits) { | |
433 | DMWARN("couldn't allocate clean bitset"); | |
434 | kfree(lc); | |
435 | return -ENOMEM; | |
436 | } | |
437 | lc->disk_header = NULL; | |
438 | } else { | |
439 | lc->log_dev = dev; | |
01d03a66 | 440 | lc->log_dev_failed = 0; |
64b30c46 | 441 | lc->log_dev_flush_failed = 0; |
b7cca195 AK |
442 | lc->header_location.bdev = lc->log_dev->bdev; |
443 | lc->header_location.sector = 0; | |
444 | ||
445 | /* | |
446 | * Buffer holds both header and bitset. | |
447 | */ | |
18d8594d MS |
448 | buf_size = |
449 | dm_round_up((LOG_OFFSET << SECTOR_SHIFT) + bitset_size, | |
dcdd4679 | 450 | bdev_logical_block_size(lc->header_location.bdev)); |
ac1f0ac2 | 451 | |
6dcbb52c | 452 | if (buf_size > bdev_nr_bytes(dev->bdev)) { |
ac1f0ac2 MB |
453 | DMWARN("log device %s too small: need %llu bytes", |
454 | dev->name, (unsigned long long)buf_size); | |
455 | kfree(lc); | |
456 | return -EINVAL; | |
457 | } | |
458 | ||
b7cca195 | 459 | lc->header_location.count = buf_size >> SECTOR_SHIFT; |
6f3af01c | 460 | |
5d234d1e | 461 | lc->io_req.mem.type = DM_IO_VMA; |
6f3af01c | 462 | lc->io_req.notify.fn = NULL; |
bda8efec | 463 | lc->io_req.client = dm_io_client_create(); |
5d234d1e HM |
464 | if (IS_ERR(lc->io_req.client)) { |
465 | r = PTR_ERR(lc->io_req.client); | |
466 | DMWARN("couldn't allocate disk io client"); | |
467 | kfree(lc); | |
dbc883f1 | 468 | return r; |
5d234d1e | 469 | } |
b7cca195 AK |
470 | |
471 | lc->disk_header = vmalloc(buf_size); | |
472 | if (!lc->disk_header) { | |
473 | DMWARN("couldn't allocate disk log buffer"); | |
c7a2bd19 | 474 | dm_io_client_destroy(lc->io_req.client); |
b7cca195 AK |
475 | kfree(lc); |
476 | return -ENOMEM; | |
477 | } | |
478 | ||
6f3af01c | 479 | lc->io_req.mem.ptr.vma = lc->disk_header; |
b7cca195 AK |
480 | lc->clean_bits = (void *)lc->disk_header + |
481 | (LOG_OFFSET << SECTOR_SHIFT); | |
1da177e4 | 482 | } |
b7cca195 | 483 | |
1da177e4 LT |
484 | memset(lc->clean_bits, -1, bitset_size); |
485 | ||
486 | lc->sync_bits = vmalloc(bitset_size); | |
487 | if (!lc->sync_bits) { | |
488 | DMWARN("couldn't allocate sync bitset"); | |
b7cca195 AK |
489 | if (!dev) |
490 | vfree(lc->clean_bits); | |
c7a2bd19 TY |
491 | else |
492 | dm_io_client_destroy(lc->io_req.client); | |
b7cca195 | 493 | vfree(lc->disk_header); |
1da177e4 LT |
494 | kfree(lc); |
495 | return -ENOMEM; | |
496 | } | |
497 | memset(lc->sync_bits, (sync == NOSYNC) ? -1 : 0, bitset_size); | |
498 | lc->sync_count = (sync == NOSYNC) ? region_count : 0; | |
499 | ||
e29e65aa | 500 | lc->recovering_bits = vzalloc(bitset_size); |
1da177e4 LT |
501 | if (!lc->recovering_bits) { |
502 | DMWARN("couldn't allocate sync bitset"); | |
503 | vfree(lc->sync_bits); | |
b7cca195 AK |
504 | if (!dev) |
505 | vfree(lc->clean_bits); | |
c7a2bd19 TY |
506 | else |
507 | dm_io_client_destroy(lc->io_req.client); | |
b7cca195 | 508 | vfree(lc->disk_header); |
1da177e4 LT |
509 | kfree(lc); |
510 | return -ENOMEM; | |
511 | } | |
1da177e4 LT |
512 | lc->sync_search = 0; |
513 | log->context = lc; | |
b7cca195 | 514 | |
1da177e4 LT |
515 | return 0; |
516 | } | |
517 | ||
416cd17b | 518 | static int core_ctr(struct dm_dirty_log *log, struct dm_target *ti, |
b7cca195 AK |
519 | unsigned int argc, char **argv) |
520 | { | |
521 | return create_log_context(log, ti, argc, argv, NULL); | |
522 | } | |
523 | ||
524 | static void destroy_log_context(struct log_c *lc) | |
1da177e4 | 525 | { |
1da177e4 LT |
526 | vfree(lc->sync_bits); |
527 | vfree(lc->recovering_bits); | |
528 | kfree(lc); | |
529 | } | |
530 | ||
416cd17b | 531 | static void core_dtr(struct dm_dirty_log *log) |
b7cca195 | 532 | { |
26cb62a2 | 533 | struct log_c *lc = log->context; |
b7cca195 AK |
534 | |
535 | vfree(lc->clean_bits); | |
536 | destroy_log_context(lc); | |
537 | } | |
538 | ||
a4a82ce3 HM |
539 | /* |
540 | *--------------------------------------------------------------------- | |
1da177e4 LT |
541 | * disk log constructor/destructor |
542 | * | |
543 | * argv contains log_device region_size followed optionally by [no]sync | |
a4a82ce3 HM |
544 | *--------------------------------------------------------------------- |
545 | */ | |
416cd17b | 546 | static int disk_ctr(struct dm_dirty_log *log, struct dm_target *ti, |
1da177e4 LT |
547 | unsigned int argc, char **argv) |
548 | { | |
549 | int r; | |
1da177e4 LT |
550 | struct dm_dev *dev; |
551 | ||
552 | if (argc < 2 || argc > 3) { | |
b7fd54a7 | 553 | DMWARN("wrong number of arguments to disk dirty region log"); |
1da177e4 LT |
554 | return -EINVAL; |
555 | } | |
556 | ||
024d37e9 | 557 | r = dm_get_device(ti, argv[0], dm_table_get_mode(ti->table), &dev); |
1da177e4 LT |
558 | if (r) |
559 | return r; | |
560 | ||
b7cca195 | 561 | r = create_log_context(log, ti, argc - 1, argv + 1, dev); |
1da177e4 LT |
562 | if (r) { |
563 | dm_put_device(ti, dev); | |
564 | return r; | |
565 | } | |
566 | ||
1da177e4 | 567 | return 0; |
1da177e4 LT |
568 | } |
569 | ||
416cd17b | 570 | static void disk_dtr(struct dm_dirty_log *log) |
1da177e4 | 571 | { |
26cb62a2 | 572 | struct log_c *lc = log->context; |
b7cca195 | 573 | |
1da177e4 LT |
574 | dm_put_device(lc->ti, lc->log_dev); |
575 | vfree(lc->disk_header); | |
5d234d1e | 576 | dm_io_client_destroy(lc->io_req.client); |
b7cca195 | 577 | destroy_log_context(lc); |
1da177e4 LT |
578 | } |
579 | ||
01d03a66 JB |
580 | static void fail_log_device(struct log_c *lc) |
581 | { | |
582 | if (lc->log_dev_failed) | |
583 | return; | |
584 | ||
585 | lc->log_dev_failed = 1; | |
586 | dm_table_event(lc->ti->table); | |
587 | } | |
588 | ||
416cd17b | 589 | static int disk_resume(struct dm_dirty_log *log) |
1da177e4 LT |
590 | { |
591 | int r; | |
86a3238c | 592 | unsigned int i; |
26cb62a2 | 593 | struct log_c *lc = log->context; |
1da177e4 LT |
594 | size_t size = lc->bitset_uint32_count * sizeof(uint32_t); |
595 | ||
596 | /* read the disk header */ | |
597 | r = read_header(lc); | |
01d03a66 | 598 | if (r) { |
b7fd54a7 | 599 | DMWARN("%s: Failed to read header on dirty region log device", |
01d03a66 JB |
600 | lc->log_dev->name); |
601 | fail_log_device(lc); | |
ba8b45ce JB |
602 | /* |
603 | * If the log device cannot be read, we must assume | |
604 | * all regions are out-of-sync. If we simply return | |
605 | * here, the state will be uninitialized and could | |
606 | * lead us to return 'in-sync' status for regions | |
607 | * that are actually 'out-of-sync'. | |
608 | */ | |
609 | lc->header.nr_regions = 0; | |
01d03a66 | 610 | } |
1da177e4 | 611 | |
8a835f11 | 612 | /* set or clear any new bits -- device has grown */ |
1da177e4 LT |
613 | if (lc->sync == NOSYNC) |
614 | for (i = lc->header.nr_regions; i < lc->region_count; i++) | |
615 | /* FIXME: amazingly inefficient */ | |
616 | log_set_bit(lc, lc->clean_bits, i); | |
617 | else | |
618 | for (i = lc->header.nr_regions; i < lc->region_count; i++) | |
619 | /* FIXME: amazingly inefficient */ | |
620 | log_clear_bit(lc, lc->clean_bits, i); | |
621 | ||
8a835f11 | 622 | /* clear any old bits -- device has shrunk */ |
90736eb3 | 623 | for (i = lc->region_count; i % BITS_PER_LONG; i++) |
8a835f11 AK |
624 | log_clear_bit(lc, lc->clean_bits, i); |
625 | ||
1da177e4 LT |
626 | /* copy clean across to sync */ |
627 | memcpy(lc->sync_bits, lc->clean_bits, size); | |
8fb980e3 AM |
628 | lc->sync_count = memweight(lc->clean_bits, |
629 | lc->bitset_uint32_count * sizeof(uint32_t)); | |
88b20a1a | 630 | lc->sync_search = 0; |
1da177e4 | 631 | |
1da177e4 LT |
632 | /* set the correct number of regions in the header */ |
633 | lc->header.nr_regions = lc->region_count; | |
634 | ||
6f3af01c TY |
635 | header_to_disk(&lc->header, lc->disk_header); |
636 | ||
1da177e4 | 637 | /* write the new header */ |
9c5a559d | 638 | r = rw_header(lc, REQ_OP_WRITE); |
64b30c46 | 639 | if (!r) { |
20a34a8e | 640 | r = flush_header(lc); |
64b30c46 MP |
641 | if (r) |
642 | lc->log_dev_flush_failed = 1; | |
643 | } | |
01d03a66 | 644 | if (r) { |
b7fd54a7 | 645 | DMWARN("%s: Failed to write header on dirty region log device", |
01d03a66 JB |
646 | lc->log_dev->name); |
647 | fail_log_device(lc); | |
648 | } | |
649 | ||
650 | return r; | |
1da177e4 LT |
651 | } |
652 | ||
416cd17b | 653 | static uint32_t core_get_region_size(struct dm_dirty_log *log) |
1da177e4 | 654 | { |
26cb62a2 | 655 | struct log_c *lc = log->context; |
0ef0b471 | 656 | |
1da177e4 LT |
657 | return lc->region_size; |
658 | } | |
659 | ||
416cd17b | 660 | static int core_resume(struct dm_dirty_log *log) |
88b20a1a | 661 | { |
26cb62a2 | 662 | struct log_c *lc = log->context; |
0ef0b471 | 663 | |
88b20a1a JB |
664 | lc->sync_search = 0; |
665 | return 0; | |
666 | } | |
667 | ||
416cd17b | 668 | static int core_is_clean(struct dm_dirty_log *log, region_t region) |
1da177e4 | 669 | { |
26cb62a2 | 670 | struct log_c *lc = log->context; |
0ef0b471 | 671 | |
1da177e4 LT |
672 | return log_test_bit(lc->clean_bits, region); |
673 | } | |
674 | ||
416cd17b | 675 | static int core_in_sync(struct dm_dirty_log *log, region_t region, int block) |
1da177e4 | 676 | { |
26cb62a2 | 677 | struct log_c *lc = log->context; |
0ef0b471 | 678 | |
1da177e4 LT |
679 | return log_test_bit(lc->sync_bits, region); |
680 | } | |
681 | ||
416cd17b | 682 | static int core_flush(struct dm_dirty_log *log) |
1da177e4 LT |
683 | { |
684 | /* no op */ | |
685 | return 0; | |
686 | } | |
687 | ||
416cd17b | 688 | static int disk_flush(struct dm_dirty_log *log) |
1da177e4 | 689 | { |
076010e2 MP |
690 | int r, i; |
691 | struct log_c *lc = log->context; | |
1da177e4 LT |
692 | |
693 | /* only write if the log has changed */ | |
b09acf1a | 694 | if (!lc->touched_cleaned && !lc->touched_dirtied) |
1da177e4 LT |
695 | return 0; |
696 | ||
076010e2 MP |
697 | if (lc->touched_cleaned && log->flush_callback_fn && |
698 | log->flush_callback_fn(lc->ti)) { | |
699 | /* | |
700 | * At this point it is impossible to determine which | |
701 | * regions are clean and which are dirty (without | |
702 | * re-reading the log off disk). So mark all of them | |
703 | * dirty. | |
704 | */ | |
705 | lc->flush_failed = 1; | |
706 | for (i = 0; i < lc->region_count; i++) | |
707 | log_clear_bit(lc, lc->clean_bits, i); | |
708 | } | |
709 | ||
9c5a559d | 710 | r = rw_header(lc, REQ_OP_WRITE); |
01d03a66 JB |
711 | if (r) |
712 | fail_log_device(lc); | |
b09acf1a | 713 | else { |
20a34a8e MP |
714 | if (lc->touched_dirtied) { |
715 | r = flush_header(lc); | |
64b30c46 MP |
716 | if (r) { |
717 | lc->log_dev_flush_failed = 1; | |
20a34a8e | 718 | fail_log_device(lc); |
64b30c46 | 719 | } else |
20a34a8e MP |
720 | lc->touched_dirtied = 0; |
721 | } | |
b09acf1a MP |
722 | lc->touched_cleaned = 0; |
723 | } | |
1da177e4 LT |
724 | |
725 | return r; | |
726 | } | |
727 | ||
416cd17b | 728 | static void core_mark_region(struct dm_dirty_log *log, region_t region) |
1da177e4 | 729 | { |
26cb62a2 | 730 | struct log_c *lc = log->context; |
0ef0b471 | 731 | |
1da177e4 LT |
732 | log_clear_bit(lc, lc->clean_bits, region); |
733 | } | |
734 | ||
416cd17b | 735 | static void core_clear_region(struct dm_dirty_log *log, region_t region) |
1da177e4 | 736 | { |
26cb62a2 | 737 | struct log_c *lc = log->context; |
0ef0b471 | 738 | |
5adc78d0 MP |
739 | if (likely(!lc->flush_failed)) |
740 | log_set_bit(lc, lc->clean_bits, region); | |
1da177e4 LT |
741 | } |
742 | ||
416cd17b | 743 | static int core_get_resync_work(struct dm_dirty_log *log, region_t *region) |
1da177e4 | 744 | { |
26cb62a2 | 745 | struct log_c *lc = log->context; |
1da177e4 LT |
746 | |
747 | if (lc->sync_search >= lc->region_count) | |
748 | return 0; | |
749 | ||
750 | do { | |
c8f543e0 | 751 | *region = find_next_zero_bit_le(lc->sync_bits, |
1da177e4 LT |
752 | lc->region_count, |
753 | lc->sync_search); | |
754 | lc->sync_search = *region + 1; | |
755 | ||
ac81b2ee | 756 | if (*region >= lc->region_count) |
1da177e4 LT |
757 | return 0; |
758 | ||
759 | } while (log_test_bit(lc->recovering_bits, *region)); | |
760 | ||
761 | log_set_bit(lc, lc->recovering_bits, *region); | |
762 | return 1; | |
763 | } | |
764 | ||
416cd17b | 765 | static void core_set_region_sync(struct dm_dirty_log *log, region_t region, |
f3ee6b2f | 766 | int in_sync) |
1da177e4 | 767 | { |
26cb62a2 | 768 | struct log_c *lc = log->context; |
1da177e4 LT |
769 | |
770 | log_clear_bit(lc, lc->recovering_bits, region); | |
f3ee6b2f | 771 | if (in_sync) { |
1da177e4 | 772 | log_set_bit(lc, lc->sync_bits, region); |
255e2646 HM |
773 | lc->sync_count++; |
774 | } else if (log_test_bit(lc->sync_bits, region)) { | |
f3ee6b2f JB |
775 | lc->sync_count--; |
776 | log_clear_bit(lc, lc->sync_bits, region); | |
777 | } | |
1da177e4 LT |
778 | } |
779 | ||
416cd17b | 780 | static region_t core_get_sync_count(struct dm_dirty_log *log) |
1da177e4 | 781 | { |
26cb62a2 | 782 | struct log_c *lc = log->context; |
1da177e4 | 783 | |
255e2646 | 784 | return lc->sync_count; |
1da177e4 LT |
785 | } |
786 | ||
787 | #define DMEMIT_SYNC \ | |
44bc08ed HM |
788 | do { \ |
789 | if (lc->sync != DEFAULTSYNC) \ | |
790 | DMEMIT("%ssync ", lc->sync == NOSYNC ? "no" : ""); \ | |
fb99e87b | 791 | } while (0) |
1da177e4 | 792 | |
416cd17b | 793 | static int core_status(struct dm_dirty_log *log, status_type_t status, |
1da177e4 LT |
794 | char *result, unsigned int maxlen) |
795 | { | |
796 | int sz = 0; | |
797 | struct log_c *lc = log->context; | |
798 | ||
96422281 | 799 | switch (status) { |
1da177e4 | 800 | case STATUSTYPE_INFO: |
315dcc22 | 801 | DMEMIT("1 %s", log->type->name); |
1da177e4 LT |
802 | break; |
803 | ||
804 | case STATUSTYPE_TABLE: | |
805 | DMEMIT("%s %u %u ", log->type->name, | |
806 | lc->sync == DEFAULTSYNC ? 1 : 2, lc->region_size); | |
807 | DMEMIT_SYNC; | |
8ec45662 TS |
808 | break; |
809 | ||
810 | case STATUSTYPE_IMA: | |
811 | *result = '\0'; | |
812 | break; | |
1da177e4 LT |
813 | } |
814 | ||
815 | return sz; | |
816 | } | |
817 | ||
416cd17b | 818 | static int disk_status(struct dm_dirty_log *log, status_type_t status, |
1da177e4 LT |
819 | char *result, unsigned int maxlen) |
820 | { | |
821 | int sz = 0; | |
1da177e4 LT |
822 | struct log_c *lc = log->context; |
823 | ||
96422281 | 824 | switch (status) { |
1da177e4 | 825 | case STATUSTYPE_INFO: |
315dcc22 | 826 | DMEMIT("3 %s %s %c", log->type->name, lc->log_dev->name, |
64b30c46 MP |
827 | lc->log_dev_flush_failed ? 'F' : |
828 | lc->log_dev_failed ? 'D' : | |
829 | 'A'); | |
1da177e4 LT |
830 | break; |
831 | ||
832 | case STATUSTYPE_TABLE: | |
1da177e4 | 833 | DMEMIT("%s %u %s %u ", log->type->name, |
315dcc22 | 834 | lc->sync == DEFAULTSYNC ? 2 : 3, lc->log_dev->name, |
1da177e4 LT |
835 | lc->region_size); |
836 | DMEMIT_SYNC; | |
8ec45662 TS |
837 | break; |
838 | ||
839 | case STATUSTYPE_IMA: | |
840 | *result = '\0'; | |
841 | break; | |
1da177e4 LT |
842 | } |
843 | ||
844 | return sz; | |
845 | } | |
846 | ||
416cd17b | 847 | static struct dm_dirty_log_type _core_type = { |
1da177e4 LT |
848 | .name = "core", |
849 | .module = THIS_MODULE, | |
850 | .ctr = core_ctr, | |
851 | .dtr = core_dtr, | |
88b20a1a | 852 | .resume = core_resume, |
1da177e4 LT |
853 | .get_region_size = core_get_region_size, |
854 | .is_clean = core_is_clean, | |
855 | .in_sync = core_in_sync, | |
856 | .flush = core_flush, | |
857 | .mark_region = core_mark_region, | |
858 | .clear_region = core_clear_region, | |
859 | .get_resync_work = core_get_resync_work, | |
f3ee6b2f | 860 | .set_region_sync = core_set_region_sync, |
1da177e4 LT |
861 | .get_sync_count = core_get_sync_count, |
862 | .status = core_status, | |
863 | }; | |
864 | ||
416cd17b | 865 | static struct dm_dirty_log_type _disk_type = { |
1da177e4 LT |
866 | .name = "disk", |
867 | .module = THIS_MODULE, | |
868 | .ctr = disk_ctr, | |
869 | .dtr = disk_dtr, | |
6b3df0d7 | 870 | .postsuspend = disk_flush, |
1da177e4 LT |
871 | .resume = disk_resume, |
872 | .get_region_size = core_get_region_size, | |
873 | .is_clean = core_is_clean, | |
874 | .in_sync = core_in_sync, | |
875 | .flush = disk_flush, | |
876 | .mark_region = core_mark_region, | |
877 | .clear_region = core_clear_region, | |
878 | .get_resync_work = core_get_resync_work, | |
f3ee6b2f | 879 | .set_region_sync = core_set_region_sync, |
1da177e4 LT |
880 | .get_sync_count = core_get_sync_count, |
881 | .status = disk_status, | |
882 | }; | |
883 | ||
c8da2f8d | 884 | static int __init dm_dirty_log_init(void) |
1da177e4 LT |
885 | { |
886 | int r; | |
887 | ||
416cd17b | 888 | r = dm_dirty_log_type_register(&_core_type); |
1da177e4 LT |
889 | if (r) |
890 | DMWARN("couldn't register core log"); | |
891 | ||
416cd17b | 892 | r = dm_dirty_log_type_register(&_disk_type); |
1da177e4 LT |
893 | if (r) { |
894 | DMWARN("couldn't register disk type"); | |
416cd17b | 895 | dm_dirty_log_type_unregister(&_core_type); |
1da177e4 LT |
896 | } |
897 | ||
898 | return r; | |
899 | } | |
900 | ||
c8da2f8d | 901 | static void __exit dm_dirty_log_exit(void) |
1da177e4 | 902 | { |
416cd17b HM |
903 | dm_dirty_log_type_unregister(&_disk_type); |
904 | dm_dirty_log_type_unregister(&_core_type); | |
1da177e4 LT |
905 | } |
906 | ||
769aef30 HM |
907 | module_init(dm_dirty_log_init); |
908 | module_exit(dm_dirty_log_exit); | |
909 | ||
910 | MODULE_DESCRIPTION(DM_NAME " dirty region log"); | |
911 | MODULE_AUTHOR("Joe Thornber, Heinz Mauelshagen <dm-devel@redhat.com>"); | |
912 | MODULE_LICENSE("GPL"); |