2 * Copyright(c) 2007 Yuri Tikhonov <yur@emcraft.com>
3 * Copyright(c) 2009 Intel Corporation
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License as published by the Free
7 * Software Foundation; either version 2 of the License, or (at your option)
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 59
17 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 * The full GNU General Public License is included in this distribution in the
20 * file called COPYING.
22 #include <linux/kernel.h>
23 #include <linux/interrupt.h>
24 #include <linux/module.h>
25 #include <linux/dma-mapping.h>
26 #include <linux/raid/pq.h>
27 #include <linux/async_tx.h>
28 #include <linux/gfp.h>
31 * pq_scribble_page - space to hold throwaway P or Q buffer for
32 * synchronous gen_syndrome
34 static struct page
*pq_scribble_page
;
36 /* the struct page *blocks[] parameter passed to async_gen_syndrome()
37 * and async_syndrome_val() contains the 'P' destination address at
38 * blocks[disks-2] and the 'Q' destination address at blocks[disks-1]
40 * note: these are macros as they are used as lvalues
42 #define P(b, d) (b[d-2])
43 #define Q(b, d) (b[d-1])
46 * do_async_gen_syndrome - asynchronously calculate P and/or Q
48 static __async_inline
struct dma_async_tx_descriptor
*
49 do_async_gen_syndrome(struct dma_chan
*chan
,
50 const unsigned char *scfs
, int disks
,
51 struct dmaengine_unmap_data
*unmap
,
52 enum dma_ctrl_flags dma_flags
,
53 struct async_submit_ctl
*submit
)
55 struct dma_async_tx_descriptor
*tx
= NULL
;
56 struct dma_device
*dma
= chan
->device
;
57 enum async_tx_flags flags_orig
= submit
->flags
;
58 dma_async_tx_callback cb_fn_orig
= submit
->cb_fn
;
59 dma_async_tx_callback cb_param_orig
= submit
->cb_param
;
60 int src_cnt
= disks
- 2;
61 unsigned short pq_src_cnt
;
62 dma_addr_t dma_dest
[2];
65 if (submit
->flags
& ASYNC_TX_FENCE
)
66 dma_flags
|= DMA_PREP_FENCE
;
69 submit
->flags
= flags_orig
;
70 pq_src_cnt
= min(src_cnt
, dma_maxpq(dma
, dma_flags
));
71 /* if we are submitting additional pqs, leave the chain open,
72 * clear the callback parameters, and leave the destination
75 if (src_cnt
> pq_src_cnt
) {
76 submit
->flags
&= ~ASYNC_TX_ACK
;
77 submit
->flags
|= ASYNC_TX_FENCE
;
79 submit
->cb_param
= NULL
;
81 submit
->cb_fn
= cb_fn_orig
;
82 submit
->cb_param
= cb_param_orig
;
84 dma_flags
|= DMA_PREP_INTERRUPT
;
87 /* Drivers force forward progress in case they can not provide
91 dma_dest
[0] = unmap
->addr
[disks
- 2];
92 dma_dest
[1] = unmap
->addr
[disks
- 1];
93 tx
= dma
->device_prep_dma_pq(chan
, dma_dest
,
94 &unmap
->addr
[src_off
],
96 &scfs
[src_off
], unmap
->len
,
100 async_tx_quiesce(&submit
->depend_tx
);
101 dma_async_issue_pending(chan
);
104 dma_set_unmap(tx
, unmap
);
105 async_tx_submit(chan
, tx
, submit
);
106 submit
->depend_tx
= tx
;
108 /* drop completed sources */
109 src_cnt
-= pq_src_cnt
;
110 src_off
+= pq_src_cnt
;
112 dma_flags
|= DMA_PREP_CONTINUE
;
119 * do_sync_gen_syndrome - synchronously calculate a raid6 syndrome
122 do_sync_gen_syndrome(struct page
**blocks
, unsigned int offset
, int disks
,
123 size_t len
, struct async_submit_ctl
*submit
)
127 int start
= -1, stop
= disks
- 3;
129 if (submit
->scribble
)
130 srcs
= submit
->scribble
;
132 srcs
= (void **) blocks
;
134 for (i
= 0; i
< disks
; i
++) {
135 if (blocks
[i
] == NULL
) {
136 BUG_ON(i
> disks
- 3); /* P or Q can't be zero */
137 srcs
[i
] = (void*)raid6_empty_zero_page
;
139 srcs
[i
] = page_address(blocks
[i
]) + offset
;
147 if (submit
->flags
& ASYNC_TX_PQ_XOR_DST
) {
148 BUG_ON(!raid6_call
.xor_syndrome
);
150 raid6_call
.xor_syndrome(disks
, start
, stop
, len
, srcs
);
152 raid6_call
.gen_syndrome(disks
, len
, srcs
);
153 async_tx_sync_epilog(submit
);
157 * async_gen_syndrome - asynchronously calculate a raid6 syndrome
158 * @blocks: source blocks from idx 0..disks-3, P @ disks-2 and Q @ disks-1
159 * @offset: common offset into each block (src and dest) to start transaction
160 * @disks: number of blocks (including missing P or Q, see below)
161 * @len: length of operation in bytes
162 * @submit: submission/completion modifiers
164 * General note: This routine assumes a field of GF(2^8) with a
165 * primitive polynomial of 0x11d and a generator of {02}.
167 * 'disks' note: callers can optionally omit either P or Q (but not
168 * both) from the calculation by setting blocks[disks-2] or
169 * blocks[disks-1] to NULL. When P or Q is omitted 'len' must be <=
170 * PAGE_SIZE as a temporary buffer of this size is used in the
171 * synchronous path. 'disks' always accounts for both destination
172 * buffers. If any source buffers (blocks[i] where i < disks - 2) are
173 * set to NULL those buffers will be replaced with the raid6_zero_page
174 * in the synchronous path and omitted in the hardware-asynchronous
177 struct dma_async_tx_descriptor
*
178 async_gen_syndrome(struct page
**blocks
, unsigned int offset
, int disks
,
179 size_t len
, struct async_submit_ctl
*submit
)
181 int src_cnt
= disks
- 2;
182 struct dma_chan
*chan
= async_tx_find_channel(submit
, DMA_PQ
,
183 &P(blocks
, disks
), 2,
184 blocks
, src_cnt
, len
);
185 struct dma_device
*device
= chan
? chan
->device
: NULL
;
186 struct dmaengine_unmap_data
*unmap
= NULL
;
188 BUG_ON(disks
> 255 || !(P(blocks
, disks
) || Q(blocks
, disks
)));
191 unmap
= dmaengine_get_unmap_data(device
->dev
, disks
, GFP_NOWAIT
);
193 /* XORing P/Q is only implemented in software */
194 if (unmap
&& !(submit
->flags
& ASYNC_TX_PQ_XOR_DST
) &&
195 (src_cnt
<= dma_maxpq(device
, 0) ||
196 dma_maxpq(device
, DMA_PREP_CONTINUE
) > 0) &&
197 is_dma_pq_aligned(device
, offset
, 0, len
)) {
198 struct dma_async_tx_descriptor
*tx
;
199 enum dma_ctrl_flags dma_flags
= 0;
200 unsigned char coefs
[src_cnt
];
203 /* run the p+q asynchronously */
204 pr_debug("%s: (async) disks: %d len: %zu\n",
205 __func__
, disks
, len
);
207 /* convert source addresses being careful to collapse 'empty'
208 * sources and update the coefficients accordingly
211 for (i
= 0, j
= 0; i
< src_cnt
; i
++) {
212 if (blocks
[i
] == NULL
)
214 unmap
->addr
[j
] = dma_map_page(device
->dev
, blocks
[i
], offset
,
216 coefs
[j
] = raid6_gfexp
[i
];
222 * DMAs use destinations as sources,
223 * so use BIDIRECTIONAL mapping
226 if (P(blocks
, disks
))
227 unmap
->addr
[j
++] = dma_map_page(device
->dev
, P(blocks
, disks
),
228 offset
, len
, DMA_BIDIRECTIONAL
);
230 unmap
->addr
[j
++] = 0;
231 dma_flags
|= DMA_PREP_PQ_DISABLE_P
;
235 if (Q(blocks
, disks
))
236 unmap
->addr
[j
++] = dma_map_page(device
->dev
, Q(blocks
, disks
),
237 offset
, len
, DMA_BIDIRECTIONAL
);
239 unmap
->addr
[j
++] = 0;
240 dma_flags
|= DMA_PREP_PQ_DISABLE_Q
;
243 tx
= do_async_gen_syndrome(chan
, coefs
, j
, unmap
, dma_flags
, submit
);
244 dmaengine_unmap_put(unmap
);
248 dmaengine_unmap_put(unmap
);
250 /* run the pq synchronously */
251 pr_debug("%s: (sync) disks: %d len: %zu\n", __func__
, disks
, len
);
253 /* wait for any prerequisite operations */
254 async_tx_quiesce(&submit
->depend_tx
);
256 if (!P(blocks
, disks
)) {
257 P(blocks
, disks
) = pq_scribble_page
;
258 BUG_ON(len
+ offset
> PAGE_SIZE
);
260 if (!Q(blocks
, disks
)) {
261 Q(blocks
, disks
) = pq_scribble_page
;
262 BUG_ON(len
+ offset
> PAGE_SIZE
);
264 do_sync_gen_syndrome(blocks
, offset
, disks
, len
, submit
);
268 EXPORT_SYMBOL_GPL(async_gen_syndrome
);
270 static inline struct dma_chan
*
271 pq_val_chan(struct async_submit_ctl
*submit
, struct page
**blocks
, int disks
, size_t len
)
273 #ifdef CONFIG_ASYNC_TX_DISABLE_PQ_VAL_DMA
276 return async_tx_find_channel(submit
, DMA_PQ_VAL
, NULL
, 0, blocks
,
281 * async_syndrome_val - asynchronously validate a raid6 syndrome
282 * @blocks: source blocks from idx 0..disks-3, P @ disks-2 and Q @ disks-1
283 * @offset: common offset into each block (src and dest) to start transaction
284 * @disks: number of blocks (including missing P or Q, see below)
285 * @len: length of operation in bytes
286 * @pqres: on val failure SUM_CHECK_P_RESULT and/or SUM_CHECK_Q_RESULT are set
287 * @spare: temporary result buffer for the synchronous case
288 * @submit: submission / completion modifiers
290 * The same notes from async_gen_syndrome apply to the 'blocks',
291 * and 'disks' parameters of this routine. The synchronous path
292 * requires a temporary result buffer and submit->scribble to be
295 struct dma_async_tx_descriptor
*
296 async_syndrome_val(struct page
**blocks
, unsigned int offset
, int disks
,
297 size_t len
, enum sum_check_flags
*pqres
, struct page
*spare
,
298 struct async_submit_ctl
*submit
)
300 struct dma_chan
*chan
= pq_val_chan(submit
, blocks
, disks
, len
);
301 struct dma_device
*device
= chan
? chan
->device
: NULL
;
302 struct dma_async_tx_descriptor
*tx
;
303 unsigned char coefs
[disks
-2];
304 enum dma_ctrl_flags dma_flags
= submit
->cb_fn
? DMA_PREP_INTERRUPT
: 0;
305 struct dmaengine_unmap_data
*unmap
= NULL
;
310 unmap
= dmaengine_get_unmap_data(device
->dev
, disks
, GFP_NOWAIT
);
312 if (unmap
&& disks
<= dma_maxpq(device
, 0) &&
313 is_dma_pq_aligned(device
, offset
, 0, len
)) {
314 struct device
*dev
= device
->dev
;
316 int i
, j
= 0, src_cnt
= 0;
318 pr_debug("%s: (async) disks: %d len: %zu\n",
319 __func__
, disks
, len
);
322 for (i
= 0; i
< disks
-2; i
++)
323 if (likely(blocks
[i
])) {
324 unmap
->addr
[j
] = dma_map_page(dev
, blocks
[i
],
327 coefs
[j
] = raid6_gfexp
[i
];
333 if (!P(blocks
, disks
)) {
335 dma_flags
|= DMA_PREP_PQ_DISABLE_P
;
337 pq
[0] = dma_map_page(dev
, P(blocks
, disks
),
340 unmap
->addr
[j
++] = pq
[0];
343 if (!Q(blocks
, disks
)) {
345 dma_flags
|= DMA_PREP_PQ_DISABLE_Q
;
347 pq
[1] = dma_map_page(dev
, Q(blocks
, disks
),
350 unmap
->addr
[j
++] = pq
[1];
354 if (submit
->flags
& ASYNC_TX_FENCE
)
355 dma_flags
|= DMA_PREP_FENCE
;
357 tx
= device
->device_prep_dma_pq_val(chan
, pq
,
365 async_tx_quiesce(&submit
->depend_tx
);
366 dma_async_issue_pending(chan
);
369 dma_set_unmap(tx
, unmap
);
370 async_tx_submit(chan
, tx
, submit
);
372 struct page
*p_src
= P(blocks
, disks
);
373 struct page
*q_src
= Q(blocks
, disks
);
374 enum async_tx_flags flags_orig
= submit
->flags
;
375 dma_async_tx_callback cb_fn_orig
= submit
->cb_fn
;
376 void *scribble
= submit
->scribble
;
377 void *cb_param_orig
= submit
->cb_param
;
380 pr_debug("%s: (sync) disks: %d len: %zu\n",
381 __func__
, disks
, len
);
383 /* caller must provide a temporary result buffer and
384 * allow the input parameters to be preserved
386 BUG_ON(!spare
|| !scribble
);
388 /* wait for any prerequisite operations */
389 async_tx_quiesce(&submit
->depend_tx
);
391 /* recompute p and/or q into the temporary buffer and then
392 * check to see the result matches the current value
397 init_async_submit(submit
, ASYNC_TX_XOR_ZERO_DST
, NULL
,
398 NULL
, NULL
, scribble
);
399 tx
= async_xor(spare
, blocks
, offset
, disks
-2, len
, submit
);
400 async_tx_quiesce(&tx
);
401 p
= page_address(p_src
) + offset
;
402 s
= page_address(spare
) + offset
;
403 *pqres
|= !!memcmp(p
, s
, len
) << SUM_CHECK_P
;
407 P(blocks
, disks
) = NULL
;
408 Q(blocks
, disks
) = spare
;
409 init_async_submit(submit
, 0, NULL
, NULL
, NULL
, scribble
);
410 tx
= async_gen_syndrome(blocks
, offset
, disks
, len
, submit
);
411 async_tx_quiesce(&tx
);
412 q
= page_address(q_src
) + offset
;
413 s
= page_address(spare
) + offset
;
414 *pqres
|= !!memcmp(q
, s
, len
) << SUM_CHECK_Q
;
417 /* restore P, Q and submit */
418 P(blocks
, disks
) = p_src
;
419 Q(blocks
, disks
) = q_src
;
421 submit
->cb_fn
= cb_fn_orig
;
422 submit
->cb_param
= cb_param_orig
;
423 submit
->flags
= flags_orig
;
424 async_tx_sync_epilog(submit
);
427 dmaengine_unmap_put(unmap
);
431 EXPORT_SYMBOL_GPL(async_syndrome_val
);
433 static int __init
async_pq_init(void)
435 pq_scribble_page
= alloc_page(GFP_KERNEL
);
437 if (pq_scribble_page
)
440 pr_err("%s: failed to allocate required spare page\n", __func__
);
445 static void __exit
async_pq_exit(void)
447 __free_page(pq_scribble_page
);
450 module_init(async_pq_init
);
451 module_exit(async_pq_exit
);
453 MODULE_DESCRIPTION("asynchronous raid6 syndrome generation/validation");
454 MODULE_LICENSE("GPL");