diff options
Diffstat (limited to 'Documentation/device-mapper')
-rw-r--r-- | Documentation/device-mapper/dm-raid.txt | 26 | ||||
-rw-r--r-- | Documentation/device-mapper/striped.txt | 7 | ||||
-rw-r--r-- | Documentation/device-mapper/thin-provisioning.txt | 24 |
3 files changed, 52 insertions, 5 deletions
diff --git a/Documentation/device-mapper/dm-raid.txt b/Documentation/device-mapper/dm-raid.txt index 946c73342cde..1c1844957166 100644 --- a/Documentation/device-mapper/dm-raid.txt +++ b/Documentation/device-mapper/dm-raid.txt | |||
@@ -27,6 +27,10 @@ The target is named "raid" and it accepts the following parameters: | |||
27 | - rotating parity N (right-to-left) with data restart | 27 | - rotating parity N (right-to-left) with data restart |
28 | raid6_nc RAID6 N continue | 28 | raid6_nc RAID6 N continue |
29 | - rotating parity N (right-to-left) with data continuation | 29 | - rotating parity N (right-to-left) with data continuation |
30 | raid10 Various RAID10 inspired algorithms chosen by additional params | ||
31 | - RAID10: Striped Mirrors (aka 'Striping on top of mirrors') | ||
32 | - RAID1E: Integrated Adjacent Stripe Mirroring | ||
33 | - and other similar RAID10 variants | ||
30 | 34 | ||
31 | Reference: Chapter 4 of | 35 | Reference: Chapter 4 of |
32 | http://www.snia.org/sites/default/files/SNIA_DDF_Technical_Position_v2.0.pdf | 36 | http://www.snia.org/sites/default/files/SNIA_DDF_Technical_Position_v2.0.pdf |
@@ -59,6 +63,28 @@ The target is named "raid" and it accepts the following parameters: | |||
59 | logical size of the array. The bitmap records the device | 63 | logical size of the array. The bitmap records the device |
60 | synchronisation state for each region. | 64 | synchronisation state for each region. |
61 | 65 | ||
66 | [raid10_copies <# copies>] | ||
67 | [raid10_format near] | ||
68 | These two options are used to alter the default layout of | ||
69 | a RAID10 configuration. The number of copies is can be | ||
70 | specified, but the default is 2. There are other variations | ||
71 | to how the copies are laid down - the default and only current | ||
72 | option is "near". Near copies are what most people think of | ||
73 | with respect to mirroring. If these options are left | ||
74 | unspecified, or 'raid10_copies 2' and/or 'raid10_format near' | ||
75 | are given, then the layouts for 2, 3 and 4 devices are: | ||
76 | 2 drives 3 drives 4 drives | ||
77 | -------- ---------- -------------- | ||
78 | A1 A1 A1 A1 A2 A1 A1 A2 A2 | ||
79 | A2 A2 A2 A3 A3 A3 A3 A4 A4 | ||
80 | A3 A3 A4 A4 A5 A5 A5 A6 A6 | ||
81 | A4 A4 A5 A6 A6 A7 A7 A8 A8 | ||
82 | .. .. .. .. .. .. .. .. .. | ||
83 | The 2-device layout is equivalent 2-way RAID1. The 4-device | ||
84 | layout is what a traditional RAID10 would look like. The | ||
85 | 3-device layout is what might be called a 'RAID1E - Integrated | ||
86 | Adjacent Stripe Mirroring'. | ||
87 | |||
62 | <#raid_devs>: The number of devices composing the array. | 88 | <#raid_devs>: The number of devices composing the array. |
63 | Each device consists of two entries. The first is the device | 89 | Each device consists of two entries. The first is the device |
64 | containing the metadata (if any); the second is the one containing the | 90 | containing the metadata (if any); the second is the one containing the |
diff --git a/Documentation/device-mapper/striped.txt b/Documentation/device-mapper/striped.txt index f34d3236b9da..45f3b91ea4c3 100644 --- a/Documentation/device-mapper/striped.txt +++ b/Documentation/device-mapper/striped.txt | |||
@@ -9,15 +9,14 @@ devices in parallel. | |||
9 | 9 | ||
10 | Parameters: <num devs> <chunk size> [<dev path> <offset>]+ | 10 | Parameters: <num devs> <chunk size> [<dev path> <offset>]+ |
11 | <num devs>: Number of underlying devices. | 11 | <num devs>: Number of underlying devices. |
12 | <chunk size>: Size of each chunk of data. Must be a power-of-2 and at | 12 | <chunk size>: Size of each chunk of data. Must be at least as |
13 | least as large as the system's PAGE_SIZE. | 13 | large as the system's PAGE_SIZE. |
14 | <dev path>: Full pathname to the underlying block-device, or a | 14 | <dev path>: Full pathname to the underlying block-device, or a |
15 | "major:minor" device-number. | 15 | "major:minor" device-number. |
16 | <offset>: Starting sector within the device. | 16 | <offset>: Starting sector within the device. |
17 | 17 | ||
18 | One or more underlying devices can be specified. The striped device size must | 18 | One or more underlying devices can be specified. The striped device size must |
19 | be a multiple of the chunk size and a multiple of the number of underlying | 19 | be a multiple of the chunk size multiplied by the number of underlying devices. |
20 | devices. | ||
21 | 20 | ||
22 | 21 | ||
23 | Example scripts | 22 | Example scripts |
diff --git a/Documentation/device-mapper/thin-provisioning.txt b/Documentation/device-mapper/thin-provisioning.txt index f5cfc62b7ad3..30b8b83bd333 100644 --- a/Documentation/device-mapper/thin-provisioning.txt +++ b/Documentation/device-mapper/thin-provisioning.txt | |||
@@ -231,6 +231,9 @@ i) Constructor | |||
231 | no_discard_passdown: Don't pass discards down to the underlying | 231 | no_discard_passdown: Don't pass discards down to the underlying |
232 | data device, but just remove the mapping. | 232 | data device, but just remove the mapping. |
233 | 233 | ||
234 | read_only: Don't allow any changes to be made to the pool | ||
235 | metadata. | ||
236 | |||
234 | Data block size must be between 64KB (128 sectors) and 1GB | 237 | Data block size must be between 64KB (128 sectors) and 1GB |
235 | (2097152 sectors) inclusive. | 238 | (2097152 sectors) inclusive. |
236 | 239 | ||
@@ -239,7 +242,7 @@ ii) Status | |||
239 | 242 | ||
240 | <transaction id> <used metadata blocks>/<total metadata blocks> | 243 | <transaction id> <used metadata blocks>/<total metadata blocks> |
241 | <used data blocks>/<total data blocks> <held metadata root> | 244 | <used data blocks>/<total data blocks> <held metadata root> |
242 | 245 | [no_]discard_passdown ro|rw | |
243 | 246 | ||
244 | transaction id: | 247 | transaction id: |
245 | A 64-bit number used by userspace to help synchronise with metadata | 248 | A 64-bit number used by userspace to help synchronise with metadata |
@@ -257,6 +260,21 @@ ii) Status | |||
257 | held root. This feature is not yet implemented so '-' is | 260 | held root. This feature is not yet implemented so '-' is |
258 | always returned. | 261 | always returned. |
259 | 262 | ||
263 | discard_passdown|no_discard_passdown | ||
264 | Whether or not discards are actually being passed down to the | ||
265 | underlying device. When this is enabled when loading the table, | ||
266 | it can get disabled if the underlying device doesn't support it. | ||
267 | |||
268 | ro|rw | ||
269 | If the pool encounters certain types of device failures it will | ||
270 | drop into a read-only metadata mode in which no changes to | ||
271 | the pool metadata (like allocating new blocks) are permitted. | ||
272 | |||
273 | In serious cases where even a read-only mode is deemed unsafe | ||
274 | no further I/O will be permitted and the status will just | ||
275 | contain the string 'Fail'. The userspace recovery tools | ||
276 | should then be used. | ||
277 | |||
260 | iii) Messages | 278 | iii) Messages |
261 | 279 | ||
262 | create_thin <dev id> | 280 | create_thin <dev id> |
@@ -329,3 +347,7 @@ regain some space then send the 'trim' message to the pool. | |||
329 | ii) Status | 347 | ii) Status |
330 | 348 | ||
331 | <nr mapped sectors> <highest mapped sector> | 349 | <nr mapped sectors> <highest mapped sector> |
350 | |||
351 | If the pool has encountered device errors and failed, the status | ||
352 | will just contain the string 'Fail'. The userspace recovery | ||
353 | tools should then be used. | ||