summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHoria Geantă <horia.geanta@nxp.com>2018-03-20 08:56:12 +0100
committerHerbert Xu <herbert@gondor.apana.org.au>2018-03-30 19:33:02 +0200
commit0550f5a5f0c5bac10e982c1e968db9f3f297dda3 (patch)
tree20acb9b0e96728b7c717049f543638e7b8bbaeb3
parentcrypto: api - Keep failed instances alive (diff)
downloadlinux-0550f5a5f0c5bac10e982c1e968db9f3f297dda3.tar.xz
linux-0550f5a5f0c5bac10e982c1e968db9f3f297dda3.zip
crypto: doc - clarify hash callbacks state machine
Add a note that it is perfectly legal to "abandon" a request object: - call .init() and then (as many times) .update() - _not_ call any of .final(), .finup() or .export() at any point in future Link: https://lkml.kernel.org/r/20180222114741.GA27631@gondor.apana.org.au Signed-off-by: Horia Geantă <horia.geanta@nxp.com> Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
-rw-r--r--Documentation/crypto/devel-algos.rst8
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/crypto/devel-algos.rst b/Documentation/crypto/devel-algos.rst
index 66f50d32dcec..c45c6f400dbd 100644
--- a/Documentation/crypto/devel-algos.rst
+++ b/Documentation/crypto/devel-algos.rst
@@ -236,6 +236,14 @@ when used from another part of the kernel.
|
'---------------> HASH2
+Note that it is perfectly legal to "abandon" a request object:
+- call .init() and then (as many times) .update()
+- _not_ call any of .final(), .finup() or .export() at any point in future
+
+In other words implementations should mind the resource allocation and clean-up.
+No resources related to request objects should remain allocated after a call
+to .init() or .update(), since there might be no chance to free them.
+
Specifics Of Asynchronous HASH Transformation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~