Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2001-2002 Sistina Software (UK) Limited. |
| 3 | * Copyright (C) 2008 Red Hat, Inc. All rights reserved. |
| 4 | * |
| 5 | * Device-mapper snapshot exception store. |
| 6 | * |
| 7 | * This file is released under the GPL. |
| 8 | */ |
| 9 | |
| 10 | #ifndef _LINUX_DM_EXCEPTION_STORE |
| 11 | #define _LINUX_DM_EXCEPTION_STORE |
| 12 | |
| 13 | #include <linux/blkdev.h> |
Jonathan Brassow | a159c1a | 2009-01-06 03:05:19 +0000 | [diff] [blame] | 14 | #include <linux/device-mapper.h> |
Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 15 | |
| 16 | /* |
| 17 | * The snapshot code deals with largish chunks of the disk at a |
| 18 | * time. Typically 32k - 512k. |
| 19 | */ |
| 20 | typedef sector_t chunk_t; |
| 21 | |
| 22 | /* |
| 23 | * An exception is used where an old chunk of data has been |
| 24 | * replaced by a new one. |
| 25 | * If chunk_t is 64 bits in size, the top 8 bits of new_chunk hold the number |
| 26 | * of chunks that follow contiguously. Remaining bits hold the number of the |
| 27 | * chunk within the device. |
| 28 | */ |
| 29 | struct dm_snap_exception { |
| 30 | struct list_head hash_list; |
| 31 | |
| 32 | chunk_t old_chunk; |
| 33 | chunk_t new_chunk; |
| 34 | }; |
| 35 | |
| 36 | /* |
| 37 | * Abstraction to handle the meta/layout of exception stores (the |
| 38 | * COW device). |
| 39 | */ |
Jonathan Brassow | b2a1146 | 2009-04-02 19:55:30 +0100 | [diff] [blame] | 40 | struct dm_exception_store; |
| 41 | struct dm_exception_store_type { |
| 42 | int (*ctr) (struct dm_exception_store *store, |
| 43 | unsigned argc, char **argv); |
| 44 | |
Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 45 | /* |
| 46 | * Destroys this object when you've finished with it. |
| 47 | */ |
Jonathan Brassow | b2a1146 | 2009-04-02 19:55:30 +0100 | [diff] [blame] | 48 | void (*dtr) (struct dm_exception_store *store); |
Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 49 | |
| 50 | /* |
| 51 | * The target shouldn't read the COW device until this is |
Jonathan Brassow | a159c1a | 2009-01-06 03:05:19 +0000 | [diff] [blame] | 52 | * called. As exceptions are read from the COW, they are |
| 53 | * reported back via the callback. |
Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 54 | */ |
Jonathan Brassow | a159c1a | 2009-01-06 03:05:19 +0000 | [diff] [blame] | 55 | int (*read_metadata) (struct dm_exception_store *store, |
| 56 | int (*callback)(void *callback_context, |
| 57 | chunk_t old, chunk_t new), |
| 58 | void *callback_context); |
Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 59 | |
| 60 | /* |
| 61 | * Find somewhere to store the next exception. |
| 62 | */ |
Jonathan Brassow | 1ae25f9 | 2009-01-06 03:05:16 +0000 | [diff] [blame] | 63 | int (*prepare_exception) (struct dm_exception_store *store, |
Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 64 | struct dm_snap_exception *e); |
| 65 | |
| 66 | /* |
| 67 | * Update the metadata with this exception. |
| 68 | */ |
Jonathan Brassow | 1ae25f9 | 2009-01-06 03:05:16 +0000 | [diff] [blame] | 69 | void (*commit_exception) (struct dm_exception_store *store, |
Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 70 | struct dm_snap_exception *e, |
| 71 | void (*callback) (void *, int success), |
| 72 | void *callback_context); |
| 73 | |
| 74 | /* |
| 75 | * The snapshot is invalid, note this in the metadata. |
| 76 | */ |
Jonathan Brassow | 1ae25f9 | 2009-01-06 03:05:16 +0000 | [diff] [blame] | 77 | void (*drop_snapshot) (struct dm_exception_store *store); |
Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 78 | |
Jonathan Brassow | a159c1a | 2009-01-06 03:05:19 +0000 | [diff] [blame] | 79 | int (*status) (struct dm_exception_store *store, status_type_t status, |
| 80 | char *result, unsigned int maxlen); |
| 81 | |
Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 82 | /* |
| 83 | * Return how full the snapshot is. |
| 84 | */ |
Jonathan Brassow | 1ae25f9 | 2009-01-06 03:05:16 +0000 | [diff] [blame] | 85 | void (*fraction_full) (struct dm_exception_store *store, |
Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 86 | sector_t *numerator, |
| 87 | sector_t *denominator); |
Jonathan Brassow | b2a1146 | 2009-04-02 19:55:30 +0100 | [diff] [blame] | 88 | }; |
| 89 | |
| 90 | struct dm_exception_store { |
| 91 | struct dm_exception_store_type type; |
Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 92 | |
| 93 | struct dm_snapshot *snap; |
Jonathan Brassow | b2a1146 | 2009-04-02 19:55:30 +0100 | [diff] [blame] | 94 | |
Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 95 | void *context; |
| 96 | }; |
| 97 | |
| 98 | /* |
| 99 | * Funtions to manipulate consecutive chunks |
| 100 | */ |
| 101 | # if defined(CONFIG_LBD) || (BITS_PER_LONG == 64) |
| 102 | # define DM_CHUNK_CONSECUTIVE_BITS 8 |
| 103 | # define DM_CHUNK_NUMBER_BITS 56 |
| 104 | |
| 105 | static inline chunk_t dm_chunk_number(chunk_t chunk) |
| 106 | { |
| 107 | return chunk & (chunk_t)((1ULL << DM_CHUNK_NUMBER_BITS) - 1ULL); |
| 108 | } |
| 109 | |
| 110 | static inline unsigned dm_consecutive_chunk_count(struct dm_snap_exception *e) |
| 111 | { |
| 112 | return e->new_chunk >> DM_CHUNK_NUMBER_BITS; |
| 113 | } |
| 114 | |
| 115 | static inline void dm_consecutive_chunk_count_inc(struct dm_snap_exception *e) |
| 116 | { |
| 117 | e->new_chunk += (1ULL << DM_CHUNK_NUMBER_BITS); |
| 118 | |
| 119 | BUG_ON(!dm_consecutive_chunk_count(e)); |
| 120 | } |
| 121 | |
| 122 | # else |
| 123 | # define DM_CHUNK_CONSECUTIVE_BITS 0 |
| 124 | |
| 125 | static inline chunk_t dm_chunk_number(chunk_t chunk) |
| 126 | { |
| 127 | return chunk; |
| 128 | } |
| 129 | |
| 130 | static inline unsigned dm_consecutive_chunk_count(struct dm_snap_exception *e) |
| 131 | { |
| 132 | return 0; |
| 133 | } |
| 134 | |
| 135 | static inline void dm_consecutive_chunk_count_inc(struct dm_snap_exception *e) |
| 136 | { |
| 137 | } |
| 138 | |
| 139 | # endif |
| 140 | |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 141 | int dm_exception_store_init(void); |
| 142 | void dm_exception_store_exit(void); |
| 143 | |
Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 144 | /* |
| 145 | * Two exception store implementations. |
| 146 | */ |
Alasdair G Kergon | 4db6bfe | 2009-01-06 03:05:17 +0000 | [diff] [blame] | 147 | int dm_persistent_snapshot_init(void); |
| 148 | void dm_persistent_snapshot_exit(void); |
| 149 | |
| 150 | int dm_transient_snapshot_init(void); |
| 151 | void dm_transient_snapshot_exit(void); |
| 152 | |
Jonathan Brassow | 1ae25f9 | 2009-01-06 03:05:16 +0000 | [diff] [blame] | 153 | int dm_create_persistent(struct dm_exception_store *store); |
Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 154 | |
Jonathan Brassow | 1ae25f9 | 2009-01-06 03:05:16 +0000 | [diff] [blame] | 155 | int dm_create_transient(struct dm_exception_store *store); |
Jonathan Brassow | aea53d9 | 2009-01-06 03:05:15 +0000 | [diff] [blame] | 156 | |
| 157 | #endif /* _LINUX_DM_EXCEPTION_STORE */ |