Linux cryptographic layer development
 help / color / mirror / Atom feed
From: Gilad Ben-Yossef <gilad@benyossef.com>
To: Herbert Xu <herbert@gondor.apana.org.au>,
	"David S. Miller" <davem@davemloft.net>,
	Jonathan Corbet <corbet@lwn.net>,
	David Howells <dhowells@redhat.com>,
	Tom Lendacky <thomas.lendacky@amd.com>,
	Gary Hook <gary.hook@amd.com>,
	Boris Brezillon <boris.brezillon@free-electrons.com>,
	Arnaud Ebalard <arno@natisbad.org>,
	Matthias Brugger <matthias.bgg@gmail.com>,
	Alasdair Kergon <agk@redhat.com>,
	Mike Snitzer <snitzer@redhat.com>,
	dm-devel@redhat.com, Shaohua Li <shli@kernel.org>,
	Steve French <sfrench@samba.org>,
	"Theodore Y. Ts'o" <tytso@mit.edu>,
	Jaegeuk Kim <jaegeuk@kernel.org>,
	Mimi Zohar <zohar@linux.vnet.ibm.com>,
	Dmitry Kasatkin <dmitry.kasatkin@gmail.com>,
	James Morris <james.l.morris@oracle.com>,
	"Serge E. Hallyn" <serge@hallyn.com>,
	linux-crypto@v
Cc: Ofir Drang <ofir.drang@arm.com>
Subject: [PATCH v5 19/19] crypto: adapt api sample to use async. op wait
Date: Mon, 14 Aug 2017 18:21:29 +0300	[thread overview]
Message-ID: <1502724094-23305-20-git-send-email-gilad@benyossef.com> (raw)
In-Reply-To: <1502724094-23305-1-git-send-email-gilad@benyossef.com>

The code sample is waiting for an async. crypto op completion.
Adapt sample to use the new generic infrastructure to do the same.

This also fixes a possible data coruption bug created by the
use of wait_for_completion_interruptible() without dealing
correctly with an interrupt aborting the wait prior to the
async op finishing.

Signed-off-by: Gilad Ben-Yossef <gilad@benyossef.com>
---
 Documentation/crypto/api-samples.rst | 52 +++++++-----------------------------
 1 file changed, 10 insertions(+), 42 deletions(-)

diff --git a/Documentation/crypto/api-samples.rst b/Documentation/crypto/api-samples.rst
index 2531948..006827e 100644
--- a/Documentation/crypto/api-samples.rst
+++ b/Documentation/crypto/api-samples.rst
@@ -7,59 +7,27 @@ Code Example For Symmetric Key Cipher Operation
 ::
 
 
-    struct tcrypt_result {
-        struct completion completion;
-        int err;
-    };
-
     /* tie all data structures together */
     struct skcipher_def {
         struct scatterlist sg;
         struct crypto_skcipher *tfm;
         struct skcipher_request *req;
-        struct tcrypt_result result;
+        struct crypto_wait wait;
     };
 
-    /* Callback function */
-    static void test_skcipher_cb(struct crypto_async_request *req, int error)
-    {
-        struct tcrypt_result *result = req->data;
-
-        if (error == -EINPROGRESS)
-            return;
-        result->err = error;
-        complete(&result->completion);
-        pr_info("Encryption finished successfully\n");
-    }
-
     /* Perform cipher operation */
     static unsigned int test_skcipher_encdec(struct skcipher_def *sk,
                          int enc)
     {
-        int rc = 0;
+        int rc;
 
         if (enc)
-            rc = crypto_skcipher_encrypt(sk->req);
+            rc = crypto_wait_req(crypto_skcipher_encrypt(sk->req), &sk->wait);
         else
-            rc = crypto_skcipher_decrypt(sk->req);
-
-        switch (rc) {
-        case 0:
-            break;
-        case -EINPROGRESS:
-        case -EBUSY:
-            rc = wait_for_completion_interruptible(
-                &sk->result.completion);
-            if (!rc && !sk->result.err) {
-                reinit_completion(&sk->result.completion);
-                break;
-            }
-        default:
-            pr_info("skcipher encrypt returned with %d result %d\n",
-                rc, sk->result.err);
-            break;
-        }
-        init_completion(&sk->result.completion);
+            rc = crypto_wait_req(crypto_skcipher_decrypt(sk->req), &sk->wait);
+
+	if (rc)
+		pr_info("skcipher encrypt returned with result %d\n", rc);
 
         return rc;
     }
@@ -89,8 +57,8 @@ Code Example For Symmetric Key Cipher Operation
         }
 
         skcipher_request_set_callback(req, CRYPTO_TFM_REQ_MAY_BACKLOG,
-                          test_skcipher_cb,
-                          &sk.result);
+                          crypto_req_done,
+                          &sk.wait);
 
         /* AES 256 with random key */
         get_random_bytes(&key, 32);
@@ -122,7 +90,7 @@ Code Example For Symmetric Key Cipher Operation
         /* We encrypt one block */
         sg_init_one(&sk.sg, scratchpad, 16);
         skcipher_request_set_crypt(req, &sk.sg, &sk.sg, 16, ivdata);
-        init_completion(&sk.result.completion);
+        crypto_init_wait(&sk.wait);
 
         /* encrypt data */
         ret = test_skcipher_encdec(&sk, 1);
-- 
2.1.4

      parent reply	other threads:[~2017-08-14 15:21 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-08-14 15:21 [PATCH v5 00/19] simplify crypto wait for async op Gilad Ben-Yossef
     [not found] ` <1502724094-23305-1-git-send-email-gilad-6S/DczAoZh3WXxRugSxzZg@public.gmane.org>
2017-08-14 15:21   ` [PATCH v5 01/19] crypto: change transient busy return code to -EAGAIN Gilad Ben-Yossef
2017-08-14 15:21   ` [PATCH v5 08/19] crypto: move drbg to generic async completion Gilad Ben-Yossef
2017-08-14 15:21 ` [PATCH v5 02/19] crypto: ccp: use -EAGAIN for transient busy indication Gilad Ben-Yossef
     [not found]   ` <1502724094-23305-3-git-send-email-gilad-6S/DczAoZh3WXxRugSxzZg@public.gmane.org>
2017-08-14 16:55     ` Gary R Hook
2017-08-14 16:55   ` Gary R Hook
2017-08-14 16:55   ` Gary R Hook
2017-08-14 15:21 ` [PATCH v5 03/19] crypto: remove redundant backlog checks on EBUSY Gilad Ben-Yossef
2017-08-14 15:21 ` [PATCH v5 04/19] crypto: marvell/cesa: " Gilad Ben-Yossef
2017-08-15  8:16   ` Boris Brezillon
2017-08-14 15:21 ` [PATCH v5 05/19] crypto: introduce crypto wait for async op Gilad Ben-Yossef
2017-08-15  2:23   ` Jonathan Cameron
2017-08-21 12:49     ` Gilad Ben-Yossef
2017-08-14 15:21 ` [PATCH v5 06/19] crypto: move algif to generic async completion Gilad Ben-Yossef
2017-08-14 15:21 ` [PATCH v5 07/19] crypto: move pub key " Gilad Ben-Yossef
2017-08-14 15:21 ` [PATCH v5 09/19] crypto: move gcm " Gilad Ben-Yossef
2017-08-14 15:21 ` [PATCH v5 10/19] crypto: move testmgr " Gilad Ben-Yossef
2017-08-14 15:21 ` [PATCH v5 11/19] fscrypt: move " Gilad Ben-Yossef
2017-08-14 15:21 ` [PATCH v5 12/19] dm: move dm-verity " Gilad Ben-Yossef
2017-08-19 20:08   ` [dm-devel] " Mikulas Patocka
     [not found]     ` <alpine.LRH.2.02.1708191605370.2380-Hpncn10jQN4oNljnaZt3ZvA+iT7yCHsGwRM8/txMwJMAicBL8TP8PQ@public.gmane.org>
2017-08-21 12:48       ` Gilad Ben-Yossef
2017-08-14 15:21 ` [PATCH v5 13/19] cifs: move " Gilad Ben-Yossef
2017-08-14 15:21 ` [PATCH v5 14/19] ima: " Gilad Ben-Yossef
2017-08-14 15:21 ` [PATCH v5 15/19] crypto: tcrypt: " Gilad Ben-Yossef
2017-08-14 15:21 ` [PATCH v5 16/19] crypto: talitos: " Gilad Ben-Yossef
2017-08-14 15:21 ` [PATCH v5 17/19] crypto: qce: " Gilad Ben-Yossef
2017-08-14 15:21 ` [PATCH v5 18/19] crypto: mediatek: " Gilad Ben-Yossef
     [not found]   ` <1502724094-23305-19-git-send-email-gilad-6S/DczAoZh3WXxRugSxzZg@public.gmane.org>
2017-08-15  5:13     ` Ryder Lee
2017-08-14 15:21 ` Gilad Ben-Yossef [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1502724094-23305-20-git-send-email-gilad@benyossef.com \
    --to=gilad@benyossef.com \
    --cc=agk@redhat.com \
    --cc=arno@natisbad.org \
    --cc=boris.brezillon@free-electrons.com \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=dhowells@redhat.com \
    --cc=dm-devel@redhat.com \
    --cc=dmitry.kasatkin@gmail.com \
    --cc=gary.hook@amd.com \
    --cc=herbert@gondor.apana.org.au \
    --cc=jaegeuk@kernel.org \
    --cc=james.l.morris@oracle.com \
    --cc=linux-crypto@v \
    --cc=matthias.bgg@gmail.com \
    --cc=ofir.drang@arm.com \
    --cc=serge@hallyn.com \
    --cc=sfrench@samba.org \
    --cc=shli@kernel.org \
    --cc=snitzer@redhat.com \
    --cc=thomas.lendacky@amd.com \
    --cc=tytso@mit.edu \
    --cc=zohar@linux.vnet.ibm.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox