14db6bfe0SAlasdair G Kergon /* 24db6bfe0SAlasdair G Kergon * Copyright (C) 2001-2002 Sistina Software (UK) Limited. 34db6bfe0SAlasdair G Kergon * Copyright (C) 2006-2008 Red Hat GmbH 44db6bfe0SAlasdair G Kergon * 54db6bfe0SAlasdair G Kergon * This file is released under the GPL. 64db6bfe0SAlasdair G Kergon */ 74db6bfe0SAlasdair G Kergon 84db6bfe0SAlasdair G Kergon #include "dm-exception-store.h" 94db6bfe0SAlasdair G Kergon 10b0d3cc01SMike Snitzer #include <linux/ctype.h> 114db6bfe0SAlasdair G Kergon #include <linux/mm.h> 124db6bfe0SAlasdair G Kergon #include <linux/pagemap.h> 134db6bfe0SAlasdair G Kergon #include <linux/vmalloc.h> 14daaa5f7cSPaul Gortmaker #include <linux/export.h> 154db6bfe0SAlasdair G Kergon #include <linux/slab.h> 164db6bfe0SAlasdair G Kergon #include <linux/dm-io.h> 17afa53df8SMikulas Patocka #include <linux/dm-bufio.h> 184db6bfe0SAlasdair G Kergon 194db6bfe0SAlasdair G Kergon #define DM_MSG_PREFIX "persistent snapshot" 20ad6bf88aSMikulas Patocka #define DM_CHUNK_SIZE_DEFAULT_SECTORS 32U /* 16KB */ 214db6bfe0SAlasdair G Kergon 2255b082e6SMikulas Patocka #define DM_PREFETCH_CHUNKS 12 2355b082e6SMikulas Patocka 244db6bfe0SAlasdair G Kergon /*----------------------------------------------------------------- 254db6bfe0SAlasdair G Kergon * Persistent snapshots, by persistent we mean that the snapshot 264db6bfe0SAlasdair G Kergon * will survive a reboot. 274db6bfe0SAlasdair G Kergon *---------------------------------------------------------------*/ 284db6bfe0SAlasdair G Kergon 294db6bfe0SAlasdair G Kergon /* 304db6bfe0SAlasdair G Kergon * We need to store a record of which parts of the origin have 314db6bfe0SAlasdair G Kergon * been copied to the snapshot device. The snapshot code 324db6bfe0SAlasdair G Kergon * requires that we copy exception chunks to chunk aligned areas 334db6bfe0SAlasdair G Kergon * of the COW store. It makes sense therefore, to store the 344db6bfe0SAlasdair G Kergon * metadata in chunk size blocks. 354db6bfe0SAlasdair G Kergon * 364db6bfe0SAlasdair G Kergon * There is no backward or forward compatibility implemented, 374db6bfe0SAlasdair G Kergon * snapshots with different disk versions than the kernel will 384db6bfe0SAlasdair G Kergon * not be usable. It is expected that "lvcreate" will blank out 394db6bfe0SAlasdair G Kergon * the start of a fresh COW device before calling the snapshot 404db6bfe0SAlasdair G Kergon * constructor. 414db6bfe0SAlasdair G Kergon * 424db6bfe0SAlasdair G Kergon * The first chunk of the COW device just contains the header. 434db6bfe0SAlasdair G Kergon * After this there is a chunk filled with exception metadata, 444db6bfe0SAlasdair G Kergon * followed by as many exception chunks as can fit in the 454db6bfe0SAlasdair G Kergon * metadata areas. 464db6bfe0SAlasdair G Kergon * 474db6bfe0SAlasdair G Kergon * All on disk structures are in little-endian format. The end 484db6bfe0SAlasdair G Kergon * of the exceptions info is indicated by an exception with a 494db6bfe0SAlasdair G Kergon * new_chunk of 0, which is invalid since it would point to the 504db6bfe0SAlasdair G Kergon * header chunk. 514db6bfe0SAlasdair G Kergon */ 524db6bfe0SAlasdair G Kergon 534db6bfe0SAlasdair G Kergon /* 544db6bfe0SAlasdair G Kergon * Magic for persistent snapshots: "SnAp" - Feeble isn't it. 554db6bfe0SAlasdair G Kergon */ 564db6bfe0SAlasdair G Kergon #define SNAP_MAGIC 0x70416e53 574db6bfe0SAlasdair G Kergon 584db6bfe0SAlasdair G Kergon /* 594db6bfe0SAlasdair G Kergon * The on-disk version of the metadata. 604db6bfe0SAlasdair G Kergon */ 614db6bfe0SAlasdair G Kergon #define SNAPSHOT_DISK_VERSION 1 624db6bfe0SAlasdair G Kergon 634454a621SMikulas Patocka #define NUM_SNAPSHOT_HDR_CHUNKS 1 644454a621SMikulas Patocka 654db6bfe0SAlasdair G Kergon struct disk_header { 66283a8328SAlasdair G Kergon __le32 magic; 674db6bfe0SAlasdair G Kergon 684db6bfe0SAlasdair G Kergon /* 694db6bfe0SAlasdair G Kergon * Is this snapshot valid. There is no way of recovering 704db6bfe0SAlasdair G Kergon * an invalid snapshot. 714db6bfe0SAlasdair G Kergon */ 72283a8328SAlasdair G Kergon __le32 valid; 734db6bfe0SAlasdair G Kergon 744db6bfe0SAlasdair G Kergon /* 754db6bfe0SAlasdair G Kergon * Simple, incrementing version. no backward 764db6bfe0SAlasdair G Kergon * compatibility. 774db6bfe0SAlasdair G Kergon */ 78283a8328SAlasdair G Kergon __le32 version; 794db6bfe0SAlasdair G Kergon 804db6bfe0SAlasdair G Kergon /* In sectors */ 81283a8328SAlasdair G Kergon __le32 chunk_size; 82283a8328SAlasdair G Kergon } __packed; 834db6bfe0SAlasdair G Kergon 844db6bfe0SAlasdair G Kergon struct disk_exception { 85283a8328SAlasdair G Kergon __le64 old_chunk; 86283a8328SAlasdair G Kergon __le64 new_chunk; 87283a8328SAlasdair G Kergon } __packed; 88283a8328SAlasdair G Kergon 89283a8328SAlasdair G Kergon struct core_exception { 904db6bfe0SAlasdair G Kergon uint64_t old_chunk; 914db6bfe0SAlasdair G Kergon uint64_t new_chunk; 924db6bfe0SAlasdair G Kergon }; 934db6bfe0SAlasdair G Kergon 944db6bfe0SAlasdair G Kergon struct commit_callback { 954db6bfe0SAlasdair G Kergon void (*callback)(void *, int success); 964db6bfe0SAlasdair G Kergon void *context; 974db6bfe0SAlasdair G Kergon }; 984db6bfe0SAlasdair G Kergon 994db6bfe0SAlasdair G Kergon /* 1004db6bfe0SAlasdair G Kergon * The top level structure for a persistent exception store. 1014db6bfe0SAlasdair G Kergon */ 1024db6bfe0SAlasdair G Kergon struct pstore { 10371fab00aSJonathan Brassow struct dm_exception_store *store; 1044db6bfe0SAlasdair G Kergon int version; 1054db6bfe0SAlasdair G Kergon int valid; 1064db6bfe0SAlasdair G Kergon uint32_t exceptions_per_area; 1074db6bfe0SAlasdair G Kergon 1084db6bfe0SAlasdair G Kergon /* 1094db6bfe0SAlasdair G Kergon * Now that we have an asynchronous kcopyd there is no 1104db6bfe0SAlasdair G Kergon * need for large chunk sizes, so it wont hurt to have a 1114db6bfe0SAlasdair G Kergon * whole chunks worth of metadata in memory at once. 1124db6bfe0SAlasdair G Kergon */ 1134db6bfe0SAlasdair G Kergon void *area; 1144db6bfe0SAlasdair G Kergon 1154db6bfe0SAlasdair G Kergon /* 1164db6bfe0SAlasdair G Kergon * An area of zeros used to clear the next area. 1174db6bfe0SAlasdair G Kergon */ 1184db6bfe0SAlasdair G Kergon void *zero_area; 1194db6bfe0SAlasdair G Kergon 1204db6bfe0SAlasdair G Kergon /* 12161578dcdSMikulas Patocka * An area used for header. The header can be written 12261578dcdSMikulas Patocka * concurrently with metadata (when invalidating the snapshot), 12361578dcdSMikulas Patocka * so it needs a separate buffer. 12461578dcdSMikulas Patocka */ 12561578dcdSMikulas Patocka void *header_area; 12661578dcdSMikulas Patocka 12761578dcdSMikulas Patocka /* 1284db6bfe0SAlasdair G Kergon * Used to keep track of which metadata area the data in 1294db6bfe0SAlasdair G Kergon * 'chunk' refers to. 1304db6bfe0SAlasdair G Kergon */ 1314db6bfe0SAlasdair G Kergon chunk_t current_area; 1324db6bfe0SAlasdair G Kergon 1334db6bfe0SAlasdair G Kergon /* 1344db6bfe0SAlasdair G Kergon * The next free chunk for an exception. 1354454a621SMikulas Patocka * 1364454a621SMikulas Patocka * When creating exceptions, all the chunks here and above are 1374454a621SMikulas Patocka * free. It holds the next chunk to be allocated. On rare 1384454a621SMikulas Patocka * occasions (e.g. after a system crash) holes can be left in 1394454a621SMikulas Patocka * the exception store because chunks can be committed out of 1404454a621SMikulas Patocka * order. 1414454a621SMikulas Patocka * 1424454a621SMikulas Patocka * When merging exceptions, it does not necessarily mean all the 1434454a621SMikulas Patocka * chunks here and above are free. It holds the value it would 1444454a621SMikulas Patocka * have held if all chunks had been committed in order of 1454454a621SMikulas Patocka * allocation. Consequently the value may occasionally be 1464454a621SMikulas Patocka * slightly too low, but since it's only used for 'status' and 1474454a621SMikulas Patocka * it can never reach its minimum value too early this doesn't 1484454a621SMikulas Patocka * matter. 1494db6bfe0SAlasdair G Kergon */ 1504454a621SMikulas Patocka 1514db6bfe0SAlasdair G Kergon chunk_t next_free; 1524db6bfe0SAlasdair G Kergon 1534db6bfe0SAlasdair G Kergon /* 1544db6bfe0SAlasdair G Kergon * The index of next free exception in the current 1554db6bfe0SAlasdair G Kergon * metadata area. 1564db6bfe0SAlasdair G Kergon */ 1574db6bfe0SAlasdair G Kergon uint32_t current_committed; 1584db6bfe0SAlasdair G Kergon 1594db6bfe0SAlasdair G Kergon atomic_t pending_count; 1604db6bfe0SAlasdair G Kergon uint32_t callback_count; 1614db6bfe0SAlasdair G Kergon struct commit_callback *callbacks; 1624db6bfe0SAlasdair G Kergon struct dm_io_client *io_client; 1634db6bfe0SAlasdair G Kergon 1644db6bfe0SAlasdair G Kergon struct workqueue_struct *metadata_wq; 1654db6bfe0SAlasdair G Kergon }; 1664db6bfe0SAlasdair G Kergon 1674db6bfe0SAlasdair G Kergon static int alloc_area(struct pstore *ps) 1684db6bfe0SAlasdair G Kergon { 1694db6bfe0SAlasdair G Kergon int r = -ENOMEM; 1704db6bfe0SAlasdair G Kergon size_t len; 1714db6bfe0SAlasdair G Kergon 17271fab00aSJonathan Brassow len = ps->store->chunk_size << SECTOR_SHIFT; 1734db6bfe0SAlasdair G Kergon 1744db6bfe0SAlasdair G Kergon /* 1754db6bfe0SAlasdair G Kergon * Allocate the chunk_size block of memory that will hold 1764db6bfe0SAlasdair G Kergon * a single metadata area. 1774db6bfe0SAlasdair G Kergon */ 1784db6bfe0SAlasdair G Kergon ps->area = vmalloc(len); 1794db6bfe0SAlasdair G Kergon if (!ps->area) 18061578dcdSMikulas Patocka goto err_area; 1814db6bfe0SAlasdair G Kergon 182e29e65aaSJoe Perches ps->zero_area = vzalloc(len); 18361578dcdSMikulas Patocka if (!ps->zero_area) 18461578dcdSMikulas Patocka goto err_zero_area; 1854db6bfe0SAlasdair G Kergon 18661578dcdSMikulas Patocka ps->header_area = vmalloc(len); 18761578dcdSMikulas Patocka if (!ps->header_area) 18861578dcdSMikulas Patocka goto err_header_area; 18961578dcdSMikulas Patocka 1904db6bfe0SAlasdair G Kergon return 0; 19161578dcdSMikulas Patocka 19261578dcdSMikulas Patocka err_header_area: 19361578dcdSMikulas Patocka vfree(ps->zero_area); 19461578dcdSMikulas Patocka 19561578dcdSMikulas Patocka err_zero_area: 19661578dcdSMikulas Patocka vfree(ps->area); 19761578dcdSMikulas Patocka 19861578dcdSMikulas Patocka err_area: 19961578dcdSMikulas Patocka return r; 2004db6bfe0SAlasdair G Kergon } 2014db6bfe0SAlasdair G Kergon 2024db6bfe0SAlasdair G Kergon static void free_area(struct pstore *ps) 2034db6bfe0SAlasdair G Kergon { 2044db6bfe0SAlasdair G Kergon vfree(ps->area); 2054db6bfe0SAlasdair G Kergon ps->area = NULL; 2064db6bfe0SAlasdair G Kergon vfree(ps->zero_area); 2074db6bfe0SAlasdair G Kergon ps->zero_area = NULL; 20861578dcdSMikulas Patocka vfree(ps->header_area); 20961578dcdSMikulas Patocka ps->header_area = NULL; 2104db6bfe0SAlasdair G Kergon } 2114db6bfe0SAlasdair G Kergon 2124db6bfe0SAlasdair G Kergon struct mdata_req { 2134db6bfe0SAlasdair G Kergon struct dm_io_region *where; 2144db6bfe0SAlasdair G Kergon struct dm_io_request *io_req; 2154db6bfe0SAlasdair G Kergon struct work_struct work; 2164db6bfe0SAlasdair G Kergon int result; 2174db6bfe0SAlasdair G Kergon }; 2184db6bfe0SAlasdair G Kergon 2194db6bfe0SAlasdair G Kergon static void do_metadata(struct work_struct *work) 2204db6bfe0SAlasdair G Kergon { 2214db6bfe0SAlasdair G Kergon struct mdata_req *req = container_of(work, struct mdata_req, work); 2224db6bfe0SAlasdair G Kergon 2234db6bfe0SAlasdair G Kergon req->result = dm_io(req->io_req, 1, req->where, NULL); 2244db6bfe0SAlasdair G Kergon } 2254db6bfe0SAlasdair G Kergon 2264db6bfe0SAlasdair G Kergon /* 2274db6bfe0SAlasdair G Kergon * Read or write a chunk aligned and sized block of data from a device. 2284db6bfe0SAlasdair G Kergon */ 229e6047149SMike Christie static int chunk_io(struct pstore *ps, void *area, chunk_t chunk, int op, 230e6047149SMike Christie int op_flags, int metadata) 2314db6bfe0SAlasdair G Kergon { 2324db6bfe0SAlasdair G Kergon struct dm_io_region where = { 233fc56f6fbSMike Snitzer .bdev = dm_snap_cow(ps->store->snap)->bdev, 23471fab00aSJonathan Brassow .sector = ps->store->chunk_size * chunk, 23571fab00aSJonathan Brassow .count = ps->store->chunk_size, 2364db6bfe0SAlasdair G Kergon }; 2374db6bfe0SAlasdair G Kergon struct dm_io_request io_req = { 238e6047149SMike Christie .bi_op = op, 239e6047149SMike Christie .bi_op_flags = op_flags, 2404db6bfe0SAlasdair G Kergon .mem.type = DM_IO_VMA, 24102d2fd31SMikulas Patocka .mem.ptr.vma = area, 2424db6bfe0SAlasdair G Kergon .client = ps->io_client, 2434db6bfe0SAlasdair G Kergon .notify.fn = NULL, 2444db6bfe0SAlasdair G Kergon }; 2454db6bfe0SAlasdair G Kergon struct mdata_req req; 2464db6bfe0SAlasdair G Kergon 2474db6bfe0SAlasdair G Kergon if (!metadata) 2484db6bfe0SAlasdair G Kergon return dm_io(&io_req, 1, &where, NULL); 2494db6bfe0SAlasdair G Kergon 2504db6bfe0SAlasdair G Kergon req.where = &where; 2514db6bfe0SAlasdair G Kergon req.io_req = &io_req; 2524db6bfe0SAlasdair G Kergon 2534db6bfe0SAlasdair G Kergon /* 2544db6bfe0SAlasdair G Kergon * Issue the synchronous I/O from a different thread 255*ed00aabdSChristoph Hellwig * to avoid submit_bio_noacct recursion. 2564db6bfe0SAlasdair G Kergon */ 257ca1cab37SAndrew Morton INIT_WORK_ONSTACK(&req.work, do_metadata); 2584db6bfe0SAlasdair G Kergon queue_work(ps->metadata_wq, &req.work); 2595ea330a7SMikulas Patocka flush_workqueue(ps->metadata_wq); 260c1a64160SChuansheng Liu destroy_work_on_stack(&req.work); 2614db6bfe0SAlasdair G Kergon 2624db6bfe0SAlasdair G Kergon return req.result; 2634db6bfe0SAlasdair G Kergon } 2644db6bfe0SAlasdair G Kergon 2654db6bfe0SAlasdair G Kergon /* 2664db6bfe0SAlasdair G Kergon * Convert a metadata area index to a chunk index. 2674db6bfe0SAlasdair G Kergon */ 2684db6bfe0SAlasdair G Kergon static chunk_t area_location(struct pstore *ps, chunk_t area) 2694db6bfe0SAlasdair G Kergon { 27087c961cbSTomohiro Kusumi return NUM_SNAPSHOT_HDR_CHUNKS + ((ps->exceptions_per_area + 1) * area); 2714db6bfe0SAlasdair G Kergon } 2724db6bfe0SAlasdair G Kergon 273e9c6a182SMikulas Patocka static void skip_metadata(struct pstore *ps) 274e9c6a182SMikulas Patocka { 275e9c6a182SMikulas Patocka uint32_t stride = ps->exceptions_per_area + 1; 276e9c6a182SMikulas Patocka chunk_t next_free = ps->next_free; 277e9c6a182SMikulas Patocka if (sector_div(next_free, stride) == NUM_SNAPSHOT_HDR_CHUNKS) 278e9c6a182SMikulas Patocka ps->next_free++; 279e9c6a182SMikulas Patocka } 280e9c6a182SMikulas Patocka 2814db6bfe0SAlasdair G Kergon /* 2824db6bfe0SAlasdair G Kergon * Read or write a metadata area. Remembering to skip the first 2834db6bfe0SAlasdair G Kergon * chunk which holds the header. 2844db6bfe0SAlasdair G Kergon */ 285e6047149SMike Christie static int area_io(struct pstore *ps, int op, int op_flags) 2864db6bfe0SAlasdair G Kergon { 2874db6bfe0SAlasdair G Kergon int r; 2884db6bfe0SAlasdair G Kergon chunk_t chunk; 2894db6bfe0SAlasdair G Kergon 2904db6bfe0SAlasdair G Kergon chunk = area_location(ps, ps->current_area); 2914db6bfe0SAlasdair G Kergon 292e6047149SMike Christie r = chunk_io(ps, ps->area, chunk, op, op_flags, 0); 2934db6bfe0SAlasdair G Kergon if (r) 2944db6bfe0SAlasdair G Kergon return r; 2954db6bfe0SAlasdair G Kergon 2964db6bfe0SAlasdair G Kergon return 0; 2974db6bfe0SAlasdair G Kergon } 2984db6bfe0SAlasdair G Kergon 2994db6bfe0SAlasdair G Kergon static void zero_memory_area(struct pstore *ps) 3004db6bfe0SAlasdair G Kergon { 30171fab00aSJonathan Brassow memset(ps->area, 0, ps->store->chunk_size << SECTOR_SHIFT); 3024db6bfe0SAlasdair G Kergon } 3034db6bfe0SAlasdair G Kergon 3044db6bfe0SAlasdair G Kergon static int zero_disk_area(struct pstore *ps, chunk_t area) 3054db6bfe0SAlasdair G Kergon { 306e6047149SMike Christie return chunk_io(ps, ps->zero_area, area_location(ps, area), 307e6047149SMike Christie REQ_OP_WRITE, 0, 0); 3084db6bfe0SAlasdair G Kergon } 3094db6bfe0SAlasdair G Kergon 3104db6bfe0SAlasdair G Kergon static int read_header(struct pstore *ps, int *new_snapshot) 3114db6bfe0SAlasdair G Kergon { 3124db6bfe0SAlasdair G Kergon int r; 3134db6bfe0SAlasdair G Kergon struct disk_header *dh; 314df96eee6SMikulas Patocka unsigned chunk_size; 3154db6bfe0SAlasdair G Kergon int chunk_size_supplied = 1; 316ae0b7448SMikulas Patocka char *chunk_err; 3174db6bfe0SAlasdair G Kergon 3184db6bfe0SAlasdair G Kergon /* 319df96eee6SMikulas Patocka * Use default chunk size (or logical_block_size, if larger) 320df96eee6SMikulas Patocka * if none supplied 3214db6bfe0SAlasdair G Kergon */ 32271fab00aSJonathan Brassow if (!ps->store->chunk_size) { 32371fab00aSJonathan Brassow ps->store->chunk_size = max(DM_CHUNK_SIZE_DEFAULT_SECTORS, 324fc56f6fbSMike Snitzer bdev_logical_block_size(dm_snap_cow(ps->store->snap)-> 325fc56f6fbSMike Snitzer bdev) >> 9); 32671fab00aSJonathan Brassow ps->store->chunk_mask = ps->store->chunk_size - 1; 327a3d939aeSMikulas Patocka ps->store->chunk_shift = __ffs(ps->store->chunk_size); 3284db6bfe0SAlasdair G Kergon chunk_size_supplied = 0; 3294db6bfe0SAlasdair G Kergon } 3304db6bfe0SAlasdair G Kergon 331bda8efecSMikulas Patocka ps->io_client = dm_io_client_create(); 3324db6bfe0SAlasdair G Kergon if (IS_ERR(ps->io_client)) 3334db6bfe0SAlasdair G Kergon return PTR_ERR(ps->io_client); 3344db6bfe0SAlasdair G Kergon 3354db6bfe0SAlasdair G Kergon r = alloc_area(ps); 3364db6bfe0SAlasdair G Kergon if (r) 3374db6bfe0SAlasdair G Kergon return r; 3384db6bfe0SAlasdair G Kergon 339e6047149SMike Christie r = chunk_io(ps, ps->header_area, 0, REQ_OP_READ, 0, 1); 3404db6bfe0SAlasdair G Kergon if (r) 3414db6bfe0SAlasdair G Kergon goto bad; 3424db6bfe0SAlasdair G Kergon 34361578dcdSMikulas Patocka dh = ps->header_area; 3444db6bfe0SAlasdair G Kergon 3454db6bfe0SAlasdair G Kergon if (le32_to_cpu(dh->magic) == 0) { 3464db6bfe0SAlasdair G Kergon *new_snapshot = 1; 3474db6bfe0SAlasdair G Kergon return 0; 3484db6bfe0SAlasdair G Kergon } 3494db6bfe0SAlasdair G Kergon 3504db6bfe0SAlasdair G Kergon if (le32_to_cpu(dh->magic) != SNAP_MAGIC) { 3514db6bfe0SAlasdair G Kergon DMWARN("Invalid or corrupt snapshot"); 3524db6bfe0SAlasdair G Kergon r = -ENXIO; 3534db6bfe0SAlasdair G Kergon goto bad; 3544db6bfe0SAlasdair G Kergon } 3554db6bfe0SAlasdair G Kergon 3564db6bfe0SAlasdair G Kergon *new_snapshot = 0; 3574db6bfe0SAlasdair G Kergon ps->valid = le32_to_cpu(dh->valid); 3584db6bfe0SAlasdair G Kergon ps->version = le32_to_cpu(dh->version); 3594db6bfe0SAlasdair G Kergon chunk_size = le32_to_cpu(dh->chunk_size); 3604db6bfe0SAlasdair G Kergon 361ae0b7448SMikulas Patocka if (ps->store->chunk_size == chunk_size) 3624db6bfe0SAlasdair G Kergon return 0; 3634db6bfe0SAlasdair G Kergon 364ae0b7448SMikulas Patocka if (chunk_size_supplied) 365df96eee6SMikulas Patocka DMWARN("chunk size %u in device metadata overrides " 366df96eee6SMikulas Patocka "table chunk size of %u.", 367df96eee6SMikulas Patocka chunk_size, ps->store->chunk_size); 3684db6bfe0SAlasdair G Kergon 3694db6bfe0SAlasdair G Kergon /* We had a bogus chunk_size. Fix stuff up. */ 3704db6bfe0SAlasdair G Kergon free_area(ps); 3714db6bfe0SAlasdair G Kergon 372ae0b7448SMikulas Patocka r = dm_exception_store_set_chunk_size(ps->store, chunk_size, 373ae0b7448SMikulas Patocka &chunk_err); 374ae0b7448SMikulas Patocka if (r) { 375df96eee6SMikulas Patocka DMERR("invalid on-disk chunk size %u: %s.", 376df96eee6SMikulas Patocka chunk_size, chunk_err); 377ae0b7448SMikulas Patocka return r; 378ae0b7448SMikulas Patocka } 3794db6bfe0SAlasdair G Kergon 3804db6bfe0SAlasdair G Kergon r = alloc_area(ps); 3814db6bfe0SAlasdair G Kergon return r; 3824db6bfe0SAlasdair G Kergon 3834db6bfe0SAlasdair G Kergon bad: 3844db6bfe0SAlasdair G Kergon free_area(ps); 3854db6bfe0SAlasdair G Kergon return r; 3864db6bfe0SAlasdair G Kergon } 3874db6bfe0SAlasdair G Kergon 3884db6bfe0SAlasdair G Kergon static int write_header(struct pstore *ps) 3894db6bfe0SAlasdair G Kergon { 3904db6bfe0SAlasdair G Kergon struct disk_header *dh; 3914db6bfe0SAlasdair G Kergon 39261578dcdSMikulas Patocka memset(ps->header_area, 0, ps->store->chunk_size << SECTOR_SHIFT); 3934db6bfe0SAlasdair G Kergon 39461578dcdSMikulas Patocka dh = ps->header_area; 3954db6bfe0SAlasdair G Kergon dh->magic = cpu_to_le32(SNAP_MAGIC); 3964db6bfe0SAlasdair G Kergon dh->valid = cpu_to_le32(ps->valid); 3974db6bfe0SAlasdair G Kergon dh->version = cpu_to_le32(ps->version); 39871fab00aSJonathan Brassow dh->chunk_size = cpu_to_le32(ps->store->chunk_size); 3994db6bfe0SAlasdair G Kergon 400e6047149SMike Christie return chunk_io(ps, ps->header_area, 0, REQ_OP_WRITE, 0, 1); 4014db6bfe0SAlasdair G Kergon } 4024db6bfe0SAlasdair G Kergon 4034db6bfe0SAlasdair G Kergon /* 4044db6bfe0SAlasdair G Kergon * Access functions for the disk exceptions, these do the endian conversions. 4054db6bfe0SAlasdair G Kergon */ 4062cadabd5SMikulas Patocka static struct disk_exception *get_exception(struct pstore *ps, void *ps_area, 4072cadabd5SMikulas Patocka uint32_t index) 4084db6bfe0SAlasdair G Kergon { 4094db6bfe0SAlasdair G Kergon BUG_ON(index >= ps->exceptions_per_area); 4104db6bfe0SAlasdair G Kergon 4112cadabd5SMikulas Patocka return ((struct disk_exception *) ps_area) + index; 4124db6bfe0SAlasdair G Kergon } 4134db6bfe0SAlasdair G Kergon 4142cadabd5SMikulas Patocka static void read_exception(struct pstore *ps, void *ps_area, 415283a8328SAlasdair G Kergon uint32_t index, struct core_exception *result) 4164db6bfe0SAlasdair G Kergon { 4172cadabd5SMikulas Patocka struct disk_exception *de = get_exception(ps, ps_area, index); 4184db6bfe0SAlasdair G Kergon 4194db6bfe0SAlasdair G Kergon /* copy it */ 420283a8328SAlasdair G Kergon result->old_chunk = le64_to_cpu(de->old_chunk); 421283a8328SAlasdair G Kergon result->new_chunk = le64_to_cpu(de->new_chunk); 4224db6bfe0SAlasdair G Kergon } 4234db6bfe0SAlasdair G Kergon 4244db6bfe0SAlasdair G Kergon static void write_exception(struct pstore *ps, 425283a8328SAlasdair G Kergon uint32_t index, struct core_exception *e) 4264db6bfe0SAlasdair G Kergon { 4272cadabd5SMikulas Patocka struct disk_exception *de = get_exception(ps, ps->area, index); 4284db6bfe0SAlasdair G Kergon 4294db6bfe0SAlasdair G Kergon /* copy it */ 430283a8328SAlasdair G Kergon de->old_chunk = cpu_to_le64(e->old_chunk); 431283a8328SAlasdair G Kergon de->new_chunk = cpu_to_le64(e->new_chunk); 4324db6bfe0SAlasdair G Kergon } 4334db6bfe0SAlasdair G Kergon 4344454a621SMikulas Patocka static void clear_exception(struct pstore *ps, uint32_t index) 4354454a621SMikulas Patocka { 4362cadabd5SMikulas Patocka struct disk_exception *de = get_exception(ps, ps->area, index); 4374454a621SMikulas Patocka 4384454a621SMikulas Patocka /* clear it */ 439283a8328SAlasdair G Kergon de->old_chunk = 0; 440283a8328SAlasdair G Kergon de->new_chunk = 0; 4414454a621SMikulas Patocka } 4424454a621SMikulas Patocka 4434db6bfe0SAlasdair G Kergon /* 4444db6bfe0SAlasdair G Kergon * Registers the exceptions that are present in the current area. 4454db6bfe0SAlasdair G Kergon * 'full' is filled in to indicate if the area has been 4464db6bfe0SAlasdair G Kergon * filled. 4474db6bfe0SAlasdair G Kergon */ 4482cadabd5SMikulas Patocka static int insert_exceptions(struct pstore *ps, void *ps_area, 449a159c1acSJonathan Brassow int (*callback)(void *callback_context, 450a159c1acSJonathan Brassow chunk_t old, chunk_t new), 451a159c1acSJonathan Brassow void *callback_context, 452a159c1acSJonathan Brassow int *full) 4534db6bfe0SAlasdair G Kergon { 4544db6bfe0SAlasdair G Kergon int r; 4554db6bfe0SAlasdair G Kergon unsigned int i; 456283a8328SAlasdair G Kergon struct core_exception e; 4574db6bfe0SAlasdair G Kergon 4584db6bfe0SAlasdair G Kergon /* presume the area is full */ 4594db6bfe0SAlasdair G Kergon *full = 1; 4604db6bfe0SAlasdair G Kergon 4614db6bfe0SAlasdair G Kergon for (i = 0; i < ps->exceptions_per_area; i++) { 4622cadabd5SMikulas Patocka read_exception(ps, ps_area, i, &e); 4634db6bfe0SAlasdair G Kergon 4644db6bfe0SAlasdair G Kergon /* 4654db6bfe0SAlasdair G Kergon * If the new_chunk is pointing at the start of 4664db6bfe0SAlasdair G Kergon * the COW device, where the first metadata area 4674db6bfe0SAlasdair G Kergon * is we know that we've hit the end of the 4684db6bfe0SAlasdair G Kergon * exceptions. Therefore the area is not full. 4694db6bfe0SAlasdair G Kergon */ 470283a8328SAlasdair G Kergon if (e.new_chunk == 0LL) { 4714db6bfe0SAlasdair G Kergon ps->current_committed = i; 4724db6bfe0SAlasdair G Kergon *full = 0; 4734db6bfe0SAlasdair G Kergon break; 4744db6bfe0SAlasdair G Kergon } 4754db6bfe0SAlasdair G Kergon 4764db6bfe0SAlasdair G Kergon /* 4774db6bfe0SAlasdair G Kergon * Keep track of the start of the free chunks. 4784db6bfe0SAlasdair G Kergon */ 479283a8328SAlasdair G Kergon if (ps->next_free <= e.new_chunk) 480283a8328SAlasdair G Kergon ps->next_free = e.new_chunk + 1; 4814db6bfe0SAlasdair G Kergon 4824db6bfe0SAlasdair G Kergon /* 4834db6bfe0SAlasdair G Kergon * Otherwise we add the exception to the snapshot. 4844db6bfe0SAlasdair G Kergon */ 485283a8328SAlasdair G Kergon r = callback(callback_context, e.old_chunk, e.new_chunk); 4864db6bfe0SAlasdair G Kergon if (r) 4874db6bfe0SAlasdair G Kergon return r; 4884db6bfe0SAlasdair G Kergon } 4894db6bfe0SAlasdair G Kergon 4904db6bfe0SAlasdair G Kergon return 0; 4914db6bfe0SAlasdair G Kergon } 4924db6bfe0SAlasdair G Kergon 493a159c1acSJonathan Brassow static int read_exceptions(struct pstore *ps, 494a159c1acSJonathan Brassow int (*callback)(void *callback_context, chunk_t old, 495a159c1acSJonathan Brassow chunk_t new), 496a159c1acSJonathan Brassow void *callback_context) 4974db6bfe0SAlasdair G Kergon { 4984db6bfe0SAlasdair G Kergon int r, full = 1; 49955494bf2SMikulas Patocka struct dm_bufio_client *client; 50055b082e6SMikulas Patocka chunk_t prefetch_area = 0; 50155494bf2SMikulas Patocka 50255494bf2SMikulas Patocka client = dm_bufio_client_create(dm_snap_cow(ps->store->snap)->bdev, 50355494bf2SMikulas Patocka ps->store->chunk_size << SECTOR_SHIFT, 50455494bf2SMikulas Patocka 1, 0, NULL, NULL); 50555494bf2SMikulas Patocka 50655494bf2SMikulas Patocka if (IS_ERR(client)) 50755494bf2SMikulas Patocka return PTR_ERR(client); 5084db6bfe0SAlasdair G Kergon 5094db6bfe0SAlasdair G Kergon /* 51055b082e6SMikulas Patocka * Setup for one current buffer + desired readahead buffers. 51155b082e6SMikulas Patocka */ 51255b082e6SMikulas Patocka dm_bufio_set_minimum_buffers(client, 1 + DM_PREFETCH_CHUNKS); 51355b082e6SMikulas Patocka 51455b082e6SMikulas Patocka /* 5154db6bfe0SAlasdair G Kergon * Keeping reading chunks and inserting exceptions until 5164db6bfe0SAlasdair G Kergon * we find a partially full area. 5174db6bfe0SAlasdair G Kergon */ 5184db6bfe0SAlasdair G Kergon for (ps->current_area = 0; full; ps->current_area++) { 51955494bf2SMikulas Patocka struct dm_buffer *bp; 52055494bf2SMikulas Patocka void *area; 52155b082e6SMikulas Patocka chunk_t chunk; 52255b082e6SMikulas Patocka 52355b082e6SMikulas Patocka if (unlikely(prefetch_area < ps->current_area)) 52455b082e6SMikulas Patocka prefetch_area = ps->current_area; 52555b082e6SMikulas Patocka 52655b082e6SMikulas Patocka if (DM_PREFETCH_CHUNKS) do { 52755b082e6SMikulas Patocka chunk_t pf_chunk = area_location(ps, prefetch_area); 52855b082e6SMikulas Patocka if (unlikely(pf_chunk >= dm_bufio_get_device_size(client))) 52955b082e6SMikulas Patocka break; 53055b082e6SMikulas Patocka dm_bufio_prefetch(client, pf_chunk, 1); 53155b082e6SMikulas Patocka prefetch_area++; 53255b082e6SMikulas Patocka if (unlikely(!prefetch_area)) 53355b082e6SMikulas Patocka break; 53455b082e6SMikulas Patocka } while (prefetch_area <= ps->current_area + DM_PREFETCH_CHUNKS); 53555b082e6SMikulas Patocka 53655b082e6SMikulas Patocka chunk = area_location(ps, ps->current_area); 5374db6bfe0SAlasdair G Kergon 53855494bf2SMikulas Patocka area = dm_bufio_read(client, chunk, &bp); 539fc0a4461Sviresh kumar if (IS_ERR(area)) { 54055494bf2SMikulas Patocka r = PTR_ERR(area); 54155494bf2SMikulas Patocka goto ret_destroy_bufio; 54255494bf2SMikulas Patocka } 54355494bf2SMikulas Patocka 54455494bf2SMikulas Patocka r = insert_exceptions(ps, area, callback, callback_context, 5452cadabd5SMikulas Patocka &full); 54655494bf2SMikulas Patocka 5472c945820SMikulas Patocka if (!full) 5482c945820SMikulas Patocka memcpy(ps->area, area, ps->store->chunk_size << SECTOR_SHIFT); 5492c945820SMikulas Patocka 55055494bf2SMikulas Patocka dm_bufio_release(bp); 55155494bf2SMikulas Patocka 55255494bf2SMikulas Patocka dm_bufio_forget(client, chunk); 55355494bf2SMikulas Patocka 55455494bf2SMikulas Patocka if (unlikely(r)) 55555494bf2SMikulas Patocka goto ret_destroy_bufio; 5564db6bfe0SAlasdair G Kergon } 5574db6bfe0SAlasdair G Kergon 5584db6bfe0SAlasdair G Kergon ps->current_area--; 5594db6bfe0SAlasdair G Kergon 560e9c6a182SMikulas Patocka skip_metadata(ps); 561e9c6a182SMikulas Patocka 56255494bf2SMikulas Patocka r = 0; 56355494bf2SMikulas Patocka 56455494bf2SMikulas Patocka ret_destroy_bufio: 56555494bf2SMikulas Patocka dm_bufio_client_destroy(client); 56655494bf2SMikulas Patocka 56755494bf2SMikulas Patocka return r; 5684db6bfe0SAlasdair G Kergon } 5694db6bfe0SAlasdair G Kergon 5704db6bfe0SAlasdair G Kergon static struct pstore *get_info(struct dm_exception_store *store) 5714db6bfe0SAlasdair G Kergon { 5724db6bfe0SAlasdair G Kergon return (struct pstore *) store->context; 5734db6bfe0SAlasdair G Kergon } 5744db6bfe0SAlasdair G Kergon 575985903bbSMike Snitzer static void persistent_usage(struct dm_exception_store *store, 576985903bbSMike Snitzer sector_t *total_sectors, 577985903bbSMike Snitzer sector_t *sectors_allocated, 578985903bbSMike Snitzer sector_t *metadata_sectors) 5794db6bfe0SAlasdair G Kergon { 580985903bbSMike Snitzer struct pstore *ps = get_info(store); 581985903bbSMike Snitzer 582985903bbSMike Snitzer *sectors_allocated = ps->next_free * store->chunk_size; 583fc56f6fbSMike Snitzer *total_sectors = get_dev_size(dm_snap_cow(store->snap)->bdev); 584985903bbSMike Snitzer 585985903bbSMike Snitzer /* 586985903bbSMike Snitzer * First chunk is the fixed header. 587985903bbSMike Snitzer * Then there are (ps->current_area + 1) metadata chunks, each one 588985903bbSMike Snitzer * separated from the next by ps->exceptions_per_area data chunks. 589985903bbSMike Snitzer */ 5904454a621SMikulas Patocka *metadata_sectors = (ps->current_area + 1 + NUM_SNAPSHOT_HDR_CHUNKS) * 5914454a621SMikulas Patocka store->chunk_size; 5924db6bfe0SAlasdair G Kergon } 5934db6bfe0SAlasdair G Kergon 594493df71cSJonathan Brassow static void persistent_dtr(struct dm_exception_store *store) 5954db6bfe0SAlasdair G Kergon { 5964db6bfe0SAlasdair G Kergon struct pstore *ps = get_info(store); 5974db6bfe0SAlasdair G Kergon 5984db6bfe0SAlasdair G Kergon destroy_workqueue(ps->metadata_wq); 599a32079ceSJonathan Brassow 600a32079ceSJonathan Brassow /* Created in read_header */ 601a32079ceSJonathan Brassow if (ps->io_client) 6024db6bfe0SAlasdair G Kergon dm_io_client_destroy(ps->io_client); 6034db6bfe0SAlasdair G Kergon free_area(ps); 604a32079ceSJonathan Brassow 605a32079ceSJonathan Brassow /* Allocated in persistent_read_metadata */ 606a32079ceSJonathan Brassow vfree(ps->callbacks); 607a32079ceSJonathan Brassow 6084db6bfe0SAlasdair G Kergon kfree(ps); 6094db6bfe0SAlasdair G Kergon } 6104db6bfe0SAlasdair G Kergon 611a159c1acSJonathan Brassow static int persistent_read_metadata(struct dm_exception_store *store, 612a159c1acSJonathan Brassow int (*callback)(void *callback_context, 613a159c1acSJonathan Brassow chunk_t old, chunk_t new), 614a159c1acSJonathan Brassow void *callback_context) 6154db6bfe0SAlasdair G Kergon { 6164db6bfe0SAlasdair G Kergon int r, uninitialized_var(new_snapshot); 6174db6bfe0SAlasdair G Kergon struct pstore *ps = get_info(store); 6184db6bfe0SAlasdair G Kergon 6194db6bfe0SAlasdair G Kergon /* 6204db6bfe0SAlasdair G Kergon * Read the snapshot header. 6214db6bfe0SAlasdair G Kergon */ 6224db6bfe0SAlasdair G Kergon r = read_header(ps, &new_snapshot); 6234db6bfe0SAlasdair G Kergon if (r) 6244db6bfe0SAlasdair G Kergon return r; 6254db6bfe0SAlasdair G Kergon 6264db6bfe0SAlasdair G Kergon /* 6274db6bfe0SAlasdair G Kergon * Now we know correct chunk_size, complete the initialisation. 6284db6bfe0SAlasdair G Kergon */ 62971fab00aSJonathan Brassow ps->exceptions_per_area = (ps->store->chunk_size << SECTOR_SHIFT) / 63071fab00aSJonathan Brassow sizeof(struct disk_exception); 6314db6bfe0SAlasdair G Kergon ps->callbacks = dm_vcalloc(ps->exceptions_per_area, 6324db6bfe0SAlasdair G Kergon sizeof(*ps->callbacks)); 6334db6bfe0SAlasdair G Kergon if (!ps->callbacks) 6344db6bfe0SAlasdair G Kergon return -ENOMEM; 6354db6bfe0SAlasdair G Kergon 6364db6bfe0SAlasdair G Kergon /* 6374db6bfe0SAlasdair G Kergon * Do we need to setup a new snapshot ? 6384db6bfe0SAlasdair G Kergon */ 6394db6bfe0SAlasdair G Kergon if (new_snapshot) { 6404db6bfe0SAlasdair G Kergon r = write_header(ps); 6414db6bfe0SAlasdair G Kergon if (r) { 6424db6bfe0SAlasdair G Kergon DMWARN("write_header failed"); 6434db6bfe0SAlasdair G Kergon return r; 6444db6bfe0SAlasdair G Kergon } 6454db6bfe0SAlasdair G Kergon 6464db6bfe0SAlasdair G Kergon ps->current_area = 0; 6474db6bfe0SAlasdair G Kergon zero_memory_area(ps); 6484db6bfe0SAlasdair G Kergon r = zero_disk_area(ps, 0); 649f5acc834SJon Brassow if (r) 6504db6bfe0SAlasdair G Kergon DMWARN("zero_disk_area(0) failed"); 6514db6bfe0SAlasdair G Kergon return r; 6524db6bfe0SAlasdair G Kergon } 6534db6bfe0SAlasdair G Kergon /* 6544db6bfe0SAlasdair G Kergon * Sanity checks. 6554db6bfe0SAlasdair G Kergon */ 6564db6bfe0SAlasdair G Kergon if (ps->version != SNAPSHOT_DISK_VERSION) { 6574db6bfe0SAlasdair G Kergon DMWARN("unable to handle snapshot disk version %d", 6584db6bfe0SAlasdair G Kergon ps->version); 6594db6bfe0SAlasdair G Kergon return -EINVAL; 6604db6bfe0SAlasdair G Kergon } 6614db6bfe0SAlasdair G Kergon 6624db6bfe0SAlasdair G Kergon /* 6634db6bfe0SAlasdair G Kergon * Metadata are valid, but snapshot is invalidated 6644db6bfe0SAlasdair G Kergon */ 6654db6bfe0SAlasdair G Kergon if (!ps->valid) 6664db6bfe0SAlasdair G Kergon return 1; 6674db6bfe0SAlasdair G Kergon 6684db6bfe0SAlasdair G Kergon /* 6694db6bfe0SAlasdair G Kergon * Read the metadata. 6704db6bfe0SAlasdair G Kergon */ 671a159c1acSJonathan Brassow r = read_exceptions(ps, callback, callback_context); 6724db6bfe0SAlasdair G Kergon 673f5acc834SJon Brassow return r; 6744db6bfe0SAlasdair G Kergon } 6754db6bfe0SAlasdair G Kergon 676a159c1acSJonathan Brassow static int persistent_prepare_exception(struct dm_exception_store *store, 6771d4989c8SJon Brassow struct dm_exception *e) 6784db6bfe0SAlasdair G Kergon { 6794db6bfe0SAlasdair G Kergon struct pstore *ps = get_info(store); 680fc56f6fbSMike Snitzer sector_t size = get_dev_size(dm_snap_cow(store->snap)->bdev); 6814db6bfe0SAlasdair G Kergon 6824db6bfe0SAlasdair G Kergon /* Is there enough room ? */ 683d0216849SJonathan Brassow if (size < ((ps->next_free + 1) * store->chunk_size)) 6844db6bfe0SAlasdair G Kergon return -ENOSPC; 6854db6bfe0SAlasdair G Kergon 6864db6bfe0SAlasdair G Kergon e->new_chunk = ps->next_free; 6874db6bfe0SAlasdair G Kergon 6884db6bfe0SAlasdair G Kergon /* 6894db6bfe0SAlasdair G Kergon * Move onto the next free pending, making sure to take 6904db6bfe0SAlasdair G Kergon * into account the location of the metadata chunks. 6914db6bfe0SAlasdair G Kergon */ 6924db6bfe0SAlasdair G Kergon ps->next_free++; 693e9c6a182SMikulas Patocka skip_metadata(ps); 6944db6bfe0SAlasdair G Kergon 6954db6bfe0SAlasdair G Kergon atomic_inc(&ps->pending_count); 6964db6bfe0SAlasdair G Kergon return 0; 6974db6bfe0SAlasdair G Kergon } 6984db6bfe0SAlasdair G Kergon 699a159c1acSJonathan Brassow static void persistent_commit_exception(struct dm_exception_store *store, 700385277bfSMikulas Patocka struct dm_exception *e, int valid, 7014db6bfe0SAlasdair G Kergon void (*callback) (void *, int success), 7024db6bfe0SAlasdair G Kergon void *callback_context) 7034db6bfe0SAlasdair G Kergon { 7044db6bfe0SAlasdair G Kergon unsigned int i; 7054db6bfe0SAlasdair G Kergon struct pstore *ps = get_info(store); 706283a8328SAlasdair G Kergon struct core_exception ce; 7074db6bfe0SAlasdair G Kergon struct commit_callback *cb; 7084db6bfe0SAlasdair G Kergon 709385277bfSMikulas Patocka if (!valid) 710385277bfSMikulas Patocka ps->valid = 0; 711385277bfSMikulas Patocka 712283a8328SAlasdair G Kergon ce.old_chunk = e->old_chunk; 713283a8328SAlasdair G Kergon ce.new_chunk = e->new_chunk; 714283a8328SAlasdair G Kergon write_exception(ps, ps->current_committed++, &ce); 7154db6bfe0SAlasdair G Kergon 7164db6bfe0SAlasdair G Kergon /* 7174db6bfe0SAlasdair G Kergon * Add the callback to the back of the array. This code 7184db6bfe0SAlasdair G Kergon * is the only place where the callback array is 7194db6bfe0SAlasdair G Kergon * manipulated, and we know that it will never be called 7204db6bfe0SAlasdair G Kergon * multiple times concurrently. 7214db6bfe0SAlasdair G Kergon */ 7224db6bfe0SAlasdair G Kergon cb = ps->callbacks + ps->callback_count++; 7234db6bfe0SAlasdair G Kergon cb->callback = callback; 7244db6bfe0SAlasdair G Kergon cb->context = callback_context; 7254db6bfe0SAlasdair G Kergon 7264db6bfe0SAlasdair G Kergon /* 7274db6bfe0SAlasdair G Kergon * If there are exceptions in flight and we have not yet 7284db6bfe0SAlasdair G Kergon * filled this metadata area there's nothing more to do. 7294db6bfe0SAlasdair G Kergon */ 7304db6bfe0SAlasdair G Kergon if (!atomic_dec_and_test(&ps->pending_count) && 7314db6bfe0SAlasdair G Kergon (ps->current_committed != ps->exceptions_per_area)) 7324db6bfe0SAlasdair G Kergon return; 7334db6bfe0SAlasdair G Kergon 7344db6bfe0SAlasdair G Kergon /* 7354db6bfe0SAlasdair G Kergon * If we completely filled the current area, then wipe the next one. 7364db6bfe0SAlasdair G Kergon */ 7374db6bfe0SAlasdair G Kergon if ((ps->current_committed == ps->exceptions_per_area) && 7384db6bfe0SAlasdair G Kergon zero_disk_area(ps, ps->current_area + 1)) 7394db6bfe0SAlasdair G Kergon ps->valid = 0; 7404db6bfe0SAlasdair G Kergon 7414db6bfe0SAlasdair G Kergon /* 7424db6bfe0SAlasdair G Kergon * Commit exceptions to disk. 7434db6bfe0SAlasdair G Kergon */ 744ff0361b3SJan Kara if (ps->valid && area_io(ps, REQ_OP_WRITE, 745ff0361b3SJan Kara REQ_PREFLUSH | REQ_FUA | REQ_SYNC)) 7464db6bfe0SAlasdair G Kergon ps->valid = 0; 7474db6bfe0SAlasdair G Kergon 7484db6bfe0SAlasdair G Kergon /* 7494db6bfe0SAlasdair G Kergon * Advance to the next area if this one is full. 7504db6bfe0SAlasdair G Kergon */ 7514db6bfe0SAlasdair G Kergon if (ps->current_committed == ps->exceptions_per_area) { 7524db6bfe0SAlasdair G Kergon ps->current_committed = 0; 7534db6bfe0SAlasdair G Kergon ps->current_area++; 7544db6bfe0SAlasdair G Kergon zero_memory_area(ps); 7554db6bfe0SAlasdair G Kergon } 7564db6bfe0SAlasdair G Kergon 7574db6bfe0SAlasdair G Kergon for (i = 0; i < ps->callback_count; i++) { 7584db6bfe0SAlasdair G Kergon cb = ps->callbacks + i; 7594db6bfe0SAlasdair G Kergon cb->callback(cb->context, ps->valid); 7604db6bfe0SAlasdair G Kergon } 7614db6bfe0SAlasdair G Kergon 7624db6bfe0SAlasdair G Kergon ps->callback_count = 0; 7634db6bfe0SAlasdair G Kergon } 7644db6bfe0SAlasdair G Kergon 7654454a621SMikulas Patocka static int persistent_prepare_merge(struct dm_exception_store *store, 7664454a621SMikulas Patocka chunk_t *last_old_chunk, 7674454a621SMikulas Patocka chunk_t *last_new_chunk) 7684454a621SMikulas Patocka { 7694454a621SMikulas Patocka struct pstore *ps = get_info(store); 770283a8328SAlasdair G Kergon struct core_exception ce; 7714454a621SMikulas Patocka int nr_consecutive; 7724454a621SMikulas Patocka int r; 7734454a621SMikulas Patocka 7744454a621SMikulas Patocka /* 7754454a621SMikulas Patocka * When current area is empty, move back to preceding area. 7764454a621SMikulas Patocka */ 7774454a621SMikulas Patocka if (!ps->current_committed) { 7784454a621SMikulas Patocka /* 7794454a621SMikulas Patocka * Have we finished? 7804454a621SMikulas Patocka */ 7814454a621SMikulas Patocka if (!ps->current_area) 7824454a621SMikulas Patocka return 0; 7834454a621SMikulas Patocka 7844454a621SMikulas Patocka ps->current_area--; 785e6047149SMike Christie r = area_io(ps, REQ_OP_READ, 0); 7864454a621SMikulas Patocka if (r < 0) 7874454a621SMikulas Patocka return r; 7884454a621SMikulas Patocka ps->current_committed = ps->exceptions_per_area; 7894454a621SMikulas Patocka } 7904454a621SMikulas Patocka 7912cadabd5SMikulas Patocka read_exception(ps, ps->area, ps->current_committed - 1, &ce); 792283a8328SAlasdair G Kergon *last_old_chunk = ce.old_chunk; 793283a8328SAlasdair G Kergon *last_new_chunk = ce.new_chunk; 7944454a621SMikulas Patocka 7954454a621SMikulas Patocka /* 7964454a621SMikulas Patocka * Find number of consecutive chunks within the current area, 7974454a621SMikulas Patocka * working backwards. 7984454a621SMikulas Patocka */ 7994454a621SMikulas Patocka for (nr_consecutive = 1; nr_consecutive < ps->current_committed; 8004454a621SMikulas Patocka nr_consecutive++) { 8012cadabd5SMikulas Patocka read_exception(ps, ps->area, 8022cadabd5SMikulas Patocka ps->current_committed - 1 - nr_consecutive, &ce); 803283a8328SAlasdair G Kergon if (ce.old_chunk != *last_old_chunk - nr_consecutive || 804283a8328SAlasdair G Kergon ce.new_chunk != *last_new_chunk - nr_consecutive) 8054454a621SMikulas Patocka break; 8064454a621SMikulas Patocka } 8074454a621SMikulas Patocka 8084454a621SMikulas Patocka return nr_consecutive; 8094454a621SMikulas Patocka } 8104454a621SMikulas Patocka 8114454a621SMikulas Patocka static int persistent_commit_merge(struct dm_exception_store *store, 8124454a621SMikulas Patocka int nr_merged) 8134454a621SMikulas Patocka { 8144454a621SMikulas Patocka int r, i; 8154454a621SMikulas Patocka struct pstore *ps = get_info(store); 8164454a621SMikulas Patocka 8174454a621SMikulas Patocka BUG_ON(nr_merged > ps->current_committed); 8184454a621SMikulas Patocka 8194454a621SMikulas Patocka for (i = 0; i < nr_merged; i++) 8204454a621SMikulas Patocka clear_exception(ps, ps->current_committed - 1 - i); 8214454a621SMikulas Patocka 82270fd7614SChristoph Hellwig r = area_io(ps, REQ_OP_WRITE, REQ_PREFLUSH | REQ_FUA); 8234454a621SMikulas Patocka if (r < 0) 8244454a621SMikulas Patocka return r; 8254454a621SMikulas Patocka 8264454a621SMikulas Patocka ps->current_committed -= nr_merged; 8274454a621SMikulas Patocka 8284454a621SMikulas Patocka /* 8294454a621SMikulas Patocka * At this stage, only persistent_usage() uses ps->next_free, so 8304454a621SMikulas Patocka * we make no attempt to keep ps->next_free strictly accurate 8314454a621SMikulas Patocka * as exceptions may have been committed out-of-order originally. 8324454a621SMikulas Patocka * Once a snapshot has become merging, we set it to the value it 8334454a621SMikulas Patocka * would have held had all the exceptions been committed in order. 8344454a621SMikulas Patocka * 8354454a621SMikulas Patocka * ps->current_area does not get reduced by prepare_merge() until 8364454a621SMikulas Patocka * after commit_merge() has removed the nr_merged previous exceptions. 8374454a621SMikulas Patocka */ 83887c961cbSTomohiro Kusumi ps->next_free = area_location(ps, ps->current_area) + 83987c961cbSTomohiro Kusumi ps->current_committed + 1; 8404454a621SMikulas Patocka 8414454a621SMikulas Patocka return 0; 8424454a621SMikulas Patocka } 8434454a621SMikulas Patocka 844a159c1acSJonathan Brassow static void persistent_drop_snapshot(struct dm_exception_store *store) 8454db6bfe0SAlasdair G Kergon { 8464db6bfe0SAlasdair G Kergon struct pstore *ps = get_info(store); 8474db6bfe0SAlasdair G Kergon 8484db6bfe0SAlasdair G Kergon ps->valid = 0; 8494db6bfe0SAlasdair G Kergon if (write_header(ps)) 8504db6bfe0SAlasdair G Kergon DMWARN("write header failed"); 8514db6bfe0SAlasdair G Kergon } 8524db6bfe0SAlasdair G Kergon 853b0d3cc01SMike Snitzer static int persistent_ctr(struct dm_exception_store *store, char *options) 8544db6bfe0SAlasdair G Kergon { 8554db6bfe0SAlasdair G Kergon struct pstore *ps; 856a2a678edSSudip Mukherjee int r; 8574db6bfe0SAlasdair G Kergon 8584db6bfe0SAlasdair G Kergon /* allocate the pstore */ 859a32079ceSJonathan Brassow ps = kzalloc(sizeof(*ps), GFP_KERNEL); 8604db6bfe0SAlasdair G Kergon if (!ps) 8614db6bfe0SAlasdair G Kergon return -ENOMEM; 8624db6bfe0SAlasdair G Kergon 86371fab00aSJonathan Brassow ps->store = store; 8644db6bfe0SAlasdair G Kergon ps->valid = 1; 8654db6bfe0SAlasdair G Kergon ps->version = SNAPSHOT_DISK_VERSION; 8664db6bfe0SAlasdair G Kergon ps->area = NULL; 86761578dcdSMikulas Patocka ps->zero_area = NULL; 86861578dcdSMikulas Patocka ps->header_area = NULL; 8694454a621SMikulas Patocka ps->next_free = NUM_SNAPSHOT_HDR_CHUNKS + 1; /* header and 1st area */ 8704db6bfe0SAlasdair G Kergon ps->current_committed = 0; 8714db6bfe0SAlasdair G Kergon 8724db6bfe0SAlasdair G Kergon ps->callback_count = 0; 8734db6bfe0SAlasdair G Kergon atomic_set(&ps->pending_count, 0); 8744db6bfe0SAlasdair G Kergon ps->callbacks = NULL; 8754db6bfe0SAlasdair G Kergon 876239c8dd5STejun Heo ps->metadata_wq = alloc_workqueue("ksnaphd", WQ_MEM_RECLAIM, 0); 8774db6bfe0SAlasdair G Kergon if (!ps->metadata_wq) { 8784db6bfe0SAlasdair G Kergon DMERR("couldn't start header metadata update thread"); 879a2a678edSSudip Mukherjee r = -ENOMEM; 880a2a678edSSudip Mukherjee goto err_workqueue; 8814db6bfe0SAlasdair G Kergon } 8824db6bfe0SAlasdair G Kergon 883b0d3cc01SMike Snitzer if (options) { 884b0d3cc01SMike Snitzer char overflow = toupper(options[0]); 885b0d3cc01SMike Snitzer if (overflow == 'O') 886b0d3cc01SMike Snitzer store->userspace_supports_overflow = true; 887b0d3cc01SMike Snitzer else { 888b0d3cc01SMike Snitzer DMERR("Unsupported persistent store option: %s", options); 889a2a678edSSudip Mukherjee r = -EINVAL; 890a2a678edSSudip Mukherjee goto err_options; 891b0d3cc01SMike Snitzer } 892b0d3cc01SMike Snitzer } 893b0d3cc01SMike Snitzer 8944db6bfe0SAlasdair G Kergon store->context = ps; 8954db6bfe0SAlasdair G Kergon 8964db6bfe0SAlasdair G Kergon return 0; 897a2a678edSSudip Mukherjee 898a2a678edSSudip Mukherjee err_options: 899a2a678edSSudip Mukherjee destroy_workqueue(ps->metadata_wq); 900a2a678edSSudip Mukherjee err_workqueue: 901a2a678edSSudip Mukherjee kfree(ps); 902a2a678edSSudip Mukherjee 903a2a678edSSudip Mukherjee return r; 9044db6bfe0SAlasdair G Kergon } 9054db6bfe0SAlasdair G Kergon 9061e302a92SJonathan Brassow static unsigned persistent_status(struct dm_exception_store *store, 907493df71cSJonathan Brassow status_type_t status, char *result, 9081e302a92SJonathan Brassow unsigned maxlen) 909493df71cSJonathan Brassow { 9101e302a92SJonathan Brassow unsigned sz = 0; 9111e302a92SJonathan Brassow 9121e302a92SJonathan Brassow switch (status) { 9131e302a92SJonathan Brassow case STATUSTYPE_INFO: 9141e302a92SJonathan Brassow break; 9151e302a92SJonathan Brassow case STATUSTYPE_TABLE: 916b0d3cc01SMike Snitzer DMEMIT(" %s %llu", store->userspace_supports_overflow ? "PO" : "P", 917b0d3cc01SMike Snitzer (unsigned long long)store->chunk_size); 9181e302a92SJonathan Brassow } 919493df71cSJonathan Brassow 920493df71cSJonathan Brassow return sz; 921493df71cSJonathan Brassow } 922493df71cSJonathan Brassow 923493df71cSJonathan Brassow static struct dm_exception_store_type _persistent_type = { 924493df71cSJonathan Brassow .name = "persistent", 925493df71cSJonathan Brassow .module = THIS_MODULE, 926493df71cSJonathan Brassow .ctr = persistent_ctr, 927493df71cSJonathan Brassow .dtr = persistent_dtr, 928493df71cSJonathan Brassow .read_metadata = persistent_read_metadata, 929493df71cSJonathan Brassow .prepare_exception = persistent_prepare_exception, 930493df71cSJonathan Brassow .commit_exception = persistent_commit_exception, 9314454a621SMikulas Patocka .prepare_merge = persistent_prepare_merge, 9324454a621SMikulas Patocka .commit_merge = persistent_commit_merge, 933493df71cSJonathan Brassow .drop_snapshot = persistent_drop_snapshot, 934985903bbSMike Snitzer .usage = persistent_usage, 935493df71cSJonathan Brassow .status = persistent_status, 936493df71cSJonathan Brassow }; 937493df71cSJonathan Brassow 938493df71cSJonathan Brassow static struct dm_exception_store_type _persistent_compat_type = { 939493df71cSJonathan Brassow .name = "P", 940493df71cSJonathan Brassow .module = THIS_MODULE, 941493df71cSJonathan Brassow .ctr = persistent_ctr, 942493df71cSJonathan Brassow .dtr = persistent_dtr, 943493df71cSJonathan Brassow .read_metadata = persistent_read_metadata, 944493df71cSJonathan Brassow .prepare_exception = persistent_prepare_exception, 945493df71cSJonathan Brassow .commit_exception = persistent_commit_exception, 9464454a621SMikulas Patocka .prepare_merge = persistent_prepare_merge, 9474454a621SMikulas Patocka .commit_merge = persistent_commit_merge, 948493df71cSJonathan Brassow .drop_snapshot = persistent_drop_snapshot, 949985903bbSMike Snitzer .usage = persistent_usage, 950493df71cSJonathan Brassow .status = persistent_status, 951493df71cSJonathan Brassow }; 952493df71cSJonathan Brassow 9534db6bfe0SAlasdair G Kergon int dm_persistent_snapshot_init(void) 9544db6bfe0SAlasdair G Kergon { 955493df71cSJonathan Brassow int r; 956493df71cSJonathan Brassow 957493df71cSJonathan Brassow r = dm_exception_store_type_register(&_persistent_type); 958493df71cSJonathan Brassow if (r) { 959493df71cSJonathan Brassow DMERR("Unable to register persistent exception store type"); 960493df71cSJonathan Brassow return r; 961493df71cSJonathan Brassow } 962493df71cSJonathan Brassow 963493df71cSJonathan Brassow r = dm_exception_store_type_register(&_persistent_compat_type); 964493df71cSJonathan Brassow if (r) { 965493df71cSJonathan Brassow DMERR("Unable to register old-style persistent exception " 966493df71cSJonathan Brassow "store type"); 967493df71cSJonathan Brassow dm_exception_store_type_unregister(&_persistent_type); 968493df71cSJonathan Brassow return r; 969493df71cSJonathan Brassow } 970493df71cSJonathan Brassow 971493df71cSJonathan Brassow return r; 9724db6bfe0SAlasdair G Kergon } 9734db6bfe0SAlasdair G Kergon 9744db6bfe0SAlasdair G Kergon void dm_persistent_snapshot_exit(void) 9754db6bfe0SAlasdair G Kergon { 976493df71cSJonathan Brassow dm_exception_store_type_unregister(&_persistent_type); 977493df71cSJonathan Brassow dm_exception_store_type_unregister(&_persistent_compat_type); 9784db6bfe0SAlasdair G Kergon } 979