SAFE public projects git trees. - safe/jmp/linux-2.6/blob - crypto/async_tx/async_xor.c

   1 /*
   2  * xor offload engine api
   3  *
   4  * Copyright © 2006, Intel Corporation.
   5  *
   6  *      Dan Williams <dan.j.williams@intel.com>
   7  *
   8  *      with architecture considerations by:
   9  *      Neil Brown <neilb@suse.de>
  10  *      Jeff Garzik <jeff@garzik.org>
  11  *
  12  * This program is free software; you can redistribute it and/or modify it
  13  * under the terms and conditions of the GNU General Public License,
  14  * version 2, as published by the Free Software Foundation.
  15  *
  16  * This program is distributed in the hope it will be useful, but WITHOUT
  17  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  19  * more details.
  20  *
  21  * You should have received a copy of the GNU General Public License along with
  22  * this program; if not, write to the Free Software Foundation, Inc.,
  23  * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  24  *
  25  */
  26 #include <linux/kernel.h>
  27 #include <linux/interrupt.h>
  28 #include <linux/mm.h>
  29 #include <linux/dma-mapping.h>
  30 #include <linux/raid/xor.h>
  31 #include <linux/async_tx.h>
  32
  33 /* do_async_xor - dma map the pages and perform the xor with an engine */
  34 static __async_inline struct dma_async_tx_descriptor *
  35 do_async_xor(struct dma_chan *chan, struct page *dest, struct page **src_list,
  36              unsigned int offset, int src_cnt, size_t len, dma_addr_t *dma_src,
  37              struct async_submit_ctl *submit)
  38 {
  39         struct dma_device *dma = chan->device;
  40         struct dma_async_tx_descriptor *tx = NULL;
  41         int src_off = 0;
  42         int i;
  43         dma_async_tx_callback cb_fn_orig = submit->cb_fn;
  44         void *cb_param_orig = submit->cb_param;
  45         enum async_tx_flags flags_orig = submit->flags;
  46         enum dma_ctrl_flags dma_flags;
  47         int xor_src_cnt;
  48         dma_addr_t dma_dest;
  49
  50         /* map the dest bidrectional in case it is re-used as a source */
  51         dma_dest = dma_map_page(dma->dev, dest, offset, len, DMA_BIDIRECTIONAL);
  52         for (i = 0; i < src_cnt; i++) {
  53                 /* only map the dest once */
  54                 if (unlikely(src_list[i] == dest)) {
  55                         dma_src[i] = dma_dest;
  56                         continue;
  57                 }
  58                 dma_src[i] = dma_map_page(dma->dev, src_list[i], offset,
  59                                           len, DMA_TO_DEVICE);
  60         }
  61
  62         while (src_cnt) {
  63                 submit->flags = flags_orig;
  64                 dma_flags = 0;
  65                 xor_src_cnt = min(src_cnt, (int)dma->max_xor);
  66                 /* if we are submitting additional xors, leave the chain open,
  67                  * clear the callback parameters, and leave the destination
  68                  * buffer mapped
  69                  */
  70                 if (src_cnt > xor_src_cnt) {
  71                         submit->flags &= ~ASYNC_TX_ACK;
  72                         dma_flags = DMA_COMPL_SKIP_DEST_UNMAP;
  73                         submit->cb_fn = NULL;
  74                         submit->cb_param = NULL;
  75                 } else {
  76                         submit->cb_fn = cb_fn_orig;
  77                         submit->cb_param = cb_param_orig;
  78                 }
  79                 if (submit->cb_fn)
  80                         dma_flags |= DMA_PREP_INTERRUPT;
  81
  82                 /* Since we have clobbered the src_list we are committed
  83                  * to doing this asynchronously.  Drivers force forward progress
  84                  * in case they can not provide a descriptor
  85                  */
  86                 tx = dma->device_prep_dma_xor(chan, dma_dest, &dma_src[src_off],
  87                                               xor_src_cnt, len, dma_flags);
  88
  89                 if (unlikely(!tx))
  90                         async_tx_quiesce(&submit->depend_tx);
  91
  92                 /* spin wait for the preceeding transactions to complete */
  93                 while (unlikely(!tx)) {
  94                         dma_async_issue_pending(chan);
  95                         tx = dma->device_prep_dma_xor(chan, dma_dest,
  96                                                       &dma_src[src_off],
  97                                                       xor_src_cnt, len,
  98                                                       dma_flags);
  99                 }
 100
 101                 async_tx_submit(chan, tx, submit);
 102                 submit->depend_tx = tx;
 103
 104                 if (src_cnt > xor_src_cnt) {
 105                         /* drop completed sources */
 106                         src_cnt -= xor_src_cnt;
 107                         src_off += xor_src_cnt;
 108
 109                         /* use the intermediate result a source */
 110                         dma_src[--src_off] = dma_dest;
 111                         src_cnt++;
 112                 } else
 113                         break;
 114         }
 115
 116         return tx;
 117 }
 118
 119 static void
 120 do_sync_xor(struct page *dest, struct page **src_list, unsigned int offset,
 121             int src_cnt, size_t len, struct async_submit_ctl *submit)
 122 {
 123         int i;
 124         int xor_src_cnt;
 125         int src_off = 0;
 126         void *dest_buf;
 127         void **srcs;
 128
 129         if (submit->scribble)
 130                 srcs = submit->scribble;
 131         else
 132                 srcs = (void **) src_list;
 133
 134         /* convert to buffer pointers */
 135         for (i = 0; i < src_cnt; i++)
 136                 srcs[i] = page_address(src_list[i]) + offset;
 137
 138         /* set destination address */
 139         dest_buf = page_address(dest) + offset;
 140
 141         if (submit->flags & ASYNC_TX_XOR_ZERO_DST)
 142                 memset(dest_buf, 0, len);
 143
 144         while (src_cnt > 0) {
 145                 /* process up to 'MAX_XOR_BLOCKS' sources */
 146                 xor_src_cnt = min(src_cnt, MAX_XOR_BLOCKS);
 147                 xor_blocks(xor_src_cnt, len, dest_buf, &srcs[src_off]);
 148
 149                 /* drop completed sources */
 150                 src_cnt -= xor_src_cnt;
 151                 src_off += xor_src_cnt;
 152         }
 153
 154         async_tx_sync_epilog(submit);
 155 }
 156
 157 /**
 158  * async_xor - attempt to xor a set of blocks with a dma engine.
 159  * @dest: destination page
 160  * @src_list: array of source pages
 161  * @offset: common src/dst offset to start transaction
 162  * @src_cnt: number of source pages
 163  * @len: length in bytes
 164  * @submit: submission / completion modifiers
 165  *
 166  * honored flags: ASYNC_TX_ACK, ASYNC_TX_XOR_ZERO_DST, ASYNC_TX_XOR_DROP_DST
 167  *
 168  * xor_blocks always uses the dest as a source so the
 169  * ASYNC_TX_XOR_ZERO_DST flag must be set to not include dest data in
 170  * the calculation.  The assumption with dma eninges is that they only
 171  * use the destination buffer as a source when it is explicity specified
 172  * in the source list.
 173  *
 174  * src_list note: if the dest is also a source it must be at index zero.
 175  * The contents of this array will be overwritten if a scribble region
 176  * is not specified.
 177  */
 178 struct dma_async_tx_descriptor *
 179 async_xor(struct page *dest, struct page **src_list, unsigned int offset,
 180           int src_cnt, size_t len, struct async_submit_ctl *submit)
 181 {
 182         struct dma_chan *chan = async_tx_find_channel(submit, DMA_XOR,
 183                                                       &dest, 1, src_list,
 184                                                       src_cnt, len);
 185         dma_addr_t *dma_src = NULL;
 186
 187         BUG_ON(src_cnt <= 1);
 188
 189         if (submit->scribble)
 190                 dma_src = submit->scribble;
 191         else if (sizeof(dma_addr_t) <= sizeof(struct page *))
 192                 dma_src = (dma_addr_t *) src_list;
 193
 194         if (dma_src && chan) {
 195                 /* run the xor asynchronously */
 196                 pr_debug("%s (async): len: %zu\n", __func__, len);
 197
 198                 return do_async_xor(chan, dest, src_list, offset, src_cnt, len,
 199                                     dma_src, submit);
 200         } else {
 201                 /* run the xor synchronously */
 202                 pr_debug("%s (sync): len: %zu\n", __func__, len);
 203                 WARN_ONCE(chan, "%s: no space for dma address conversion\n",
 204                           __func__);
 205
 206                 /* in the sync case the dest is an implied source
 207                  * (assumes the dest is the first source)
 208                  */
 209                 if (submit->flags & ASYNC_TX_XOR_DROP_DST) {
 210                         src_cnt--;
 211                         src_list++;
 212                 }
 213
 214                 /* wait for any prerequisite operations */
 215                 async_tx_quiesce(&submit->depend_tx);
 216
 217                 do_sync_xor(dest, src_list, offset, src_cnt, len, submit);
 218
 219                 return NULL;
 220         }
 221 }
 222 EXPORT_SYMBOL_GPL(async_xor);
 223
 224 static int page_is_zero(struct page *p, unsigned int offset, size_t len)
 225 {
 226         char *a = page_address(p) + offset;
 227         return ((*(u32 *) a) == 0 &&
 228                 memcmp(a, a + 4, len - 4) == 0);
 229 }
 230
 231 /**
 232  * async_xor_val - attempt a xor parity check with a dma engine.
 233  * @dest: destination page used if the xor is performed synchronously
 234  * @src_list: array of source pages
 235  * @offset: offset in pages to start transaction
 236  * @src_cnt: number of source pages
 237  * @len: length in bytes
 238  * @result: 0 if sum == 0 else non-zero
 239  * @submit: submission / completion modifiers
 240  *
 241  * honored flags: ASYNC_TX_ACK
 242  *
 243  * src_list note: if the dest is also a source it must be at index zero.
 244  * The contents of this array will be overwritten if a scribble region
 245  * is not specified.
 246  */
 247 struct dma_async_tx_descriptor *
 248 async_xor_val(struct page *dest, struct page **src_list, unsigned int offset,
 249               int src_cnt, size_t len, enum sum_check_flags *result,
 250               struct async_submit_ctl *submit)
 251 {
 252         struct dma_chan *chan = async_tx_find_channel(submit, DMA_XOR_VAL,
 253                                                       &dest, 1, src_list,
 254                                                       src_cnt, len);
 255         struct dma_device *device = chan ? chan->device : NULL;
 256         struct dma_async_tx_descriptor *tx = NULL;
 257         dma_addr_t *dma_src = NULL;
 258
 259         BUG_ON(src_cnt <= 1);
 260
 261         if (submit->scribble)
 262                 dma_src = submit->scribble;
 263         else if (sizeof(dma_addr_t) <= sizeof(struct page *))
 264                 dma_src = (dma_addr_t *) src_list;
 265
 266         if (dma_src && device && src_cnt <= device->max_xor) {
 267                 unsigned long dma_prep_flags;
 268                 int i;
 269
 270                 pr_debug("%s: (async) len: %zu\n", __func__, len);
 271
 272                 dma_prep_flags = submit->cb_fn ? DMA_PREP_INTERRUPT : 0;
 273                 for (i = 0; i < src_cnt; i++)
 274                         dma_src[i] = dma_map_page(device->dev, src_list[i],
 275                                                   offset, len, DMA_TO_DEVICE);
 276
 277                 tx = device->device_prep_dma_xor_val(chan, dma_src, src_cnt,
 278                                                      len, result,
 279                                                      dma_prep_flags);
 280                 if (unlikely(!tx)) {
 281                         async_tx_quiesce(&submit->depend_tx);
 282
 283                         while (!tx) {
 284                                 dma_async_issue_pending(chan);
 285                                 tx = device->device_prep_dma_xor_val(chan,
 286                                         dma_src, src_cnt, len, result,
 287                                         dma_prep_flags);
 288                         }
 289                 }
 290
 291                 async_tx_submit(chan, tx, submit);
 292         } else {
 293                 enum async_tx_flags flags_orig = submit->flags;
 294
 295                 pr_debug("%s: (sync) len: %zu\n", __func__, len);
 296                 WARN_ONCE(device && src_cnt <= device->max_xor,
 297                           "%s: no space for dma address conversion\n",
 298                           __func__);
 299
 300                 submit->flags |= ASYNC_TX_XOR_DROP_DST;
 301                 submit->flags &= ~ASYNC_TX_ACK;
 302
 303                 tx = async_xor(dest, src_list, offset, src_cnt, len, submit);
 304
 305                 async_tx_quiesce(&tx);
 306
 307                 *result = !page_is_zero(dest, offset, len) << SUM_CHECK_P;
 308
 309                 async_tx_sync_epilog(submit);
 310                 submit->flags = flags_orig;
 311         }
 312
 313         return tx;
 314 }
 315 EXPORT_SYMBOL_GPL(async_xor_val);
 316
 317 MODULE_AUTHOR("Intel Corporation");
 318 MODULE_DESCRIPTION("asynchronous xor/xor-zero-sum api");
 319 MODULE_LICENSE("GPL");