[PATCH 1/1] crypto: api.c: doc on crypto_alg_lookup, crypto_larval_lookup, and crypto_alg_mod_lookup

[PATCH 1/1] crypto: api.c: doc on crypto_alg_lookup, crypto_larval_lookup, and crypto_alg_mod_lookup

[Mark Allyn]

Resubmit due to errors on patch submitted 11/4/2010

Signed-off-by: Mark A. Allyn <mark.a.allyn@intel.com>
---
 crypto/api.c |   25 +++++++++++++++++++++++++
 1 files changed, 25 insertions(+), 0 deletions(-)

diff --git a/crypto/api.c b/crypto/api.c
index 033a714..d8a7c35 100644
--- a/crypto/api.c
+++ b/crypto/api.c
@@ -193,6 +193,14 @@ static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg)
 	return alg;
 }
 
+/**
+ * crypto_alg_lookup() - get the crypto_alg structure for an algorithm
+ * @name:	text string containing name of algorithm
+ * @type:	crypto type defined in include/linux/crypto.h
+ * @mask:	mask of allowable crypto types (use or'd list
+ *		of types as defined in include/linux/crypto.h)
+ * @returns:	pointer to crypto_alg structure
+ */
 struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask)
 {
 	struct crypto_alg *alg;
@@ -205,6 +213,15 @@ struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask)
 }
 EXPORT_SYMBOL_GPL(crypto_alg_lookup);
 
+/**
+ * crypto_larval_lookup() - gets large value (larval) crypto_alg
+ *	structure for an algorithm
+ * @name:	text string containing name of algorithm
+ * @type:	crypto type defined in include/linux/crypto.h
+ * @mask:	mask of allowable crypto types (use or'd list
+ *		of types as defined in include/linux/crypto.h)
+ * @returns:	pointer to crypto_alg structure
+ */
 struct crypto_alg *crypto_larval_lookup(const char *name, u32 type, u32 mask)
 {
 	struct crypto_alg *alg;
@@ -247,6 +264,14 @@ int crypto_probing_notify(unsigned long val, void *v)
 }
 EXPORT_SYMBOL_GPL(crypto_probing_notify);
 
+/**
+ * crypto_alg_mod_lookup() - gets the algorithm module
+ * @name:	text string containing name of algorithm
+ * @type:	crypto type defined in include/linux/crypto.h
+ * @mask:	mask of allowable crypto types (use or'd list
+ *		of types as defined in include/linux/crypto.h)
+ * @returns:	pointer to crypto_alg structure
+ */
 struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask)
 {
 	struct crypto_alg *alg;
-- 
1.6.3.3

Re: [PATCH 1/1] crypto: api.c: doc on crypto_alg_lookup, crypto_larval_lookup, and crypto_alg_mod_lookup

[Lee Nipper]

On Fri, Nov 5, 2010 at 13:05, Mark Allyn <mark.a.allyn@intel.com> wrote:
> Resubmit due to errors on patch submitted 11/4/2010
>
> Signed-off-by: Mark A. Allyn <mark.a.allyn@intel.com>
> ---
>  crypto/api.c |   25 +++++++++++++++++++++++++
>  1 files changed, 25 insertions(+), 0 deletions(-)
>
> diff --git a/crypto/api.c b/crypto/api.c
> index 033a714..d8a7c35 100644
> --- a/crypto/api.c
> +++ b/crypto/api.c
> @@ -193,6 +193,14 @@ static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg)
>        return alg;
>  }
>
> +/**
> + * crypto_alg_lookup() - get the crypto_alg structure for an algorithm
> + * @name:      text string containing name of algorithm
> + * @type:      crypto type defined in include/linux/crypto.h
> + * @mask:      mask of allowable crypto types (use or'd list
> + *             of types as defined in include/linux/crypto.h)
> + * @returns:   pointer to crypto_alg structure
> + */
>  struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask)
>  {
>        struct crypto_alg *alg;
> @@ -205,6 +213,15 @@ struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask)
>  }
>  EXPORT_SYMBOL_GPL(crypto_alg_lookup);
>
> +/**
> + * crypto_larval_lookup() - gets large value (larval) crypto_alg
> + *     structure for an algorithm

larval is an adjective.  omit "large value", as it only adds confusion.

> + * @name:      text string containing name of algorithm
> + * @type:      crypto type defined in include/linux/crypto.h
> + * @mask:      mask of allowable crypto types (use or'd list
> + *             of types as defined in include/linux/crypto.h)
> + * @returns:   pointer to crypto_alg structure
> + */
>  struct crypto_alg *crypto_larval_lookup(const char *name, u32 type, u32 mask)
>  {
>        struct crypto_alg *alg;
> @@ -247,6 +264,14 @@ int crypto_probing_notify(unsigned long val, void *v)
>  }
>  EXPORT_SYMBOL_GPL(crypto_probing_notify);
>
> +/**
> + * crypto_alg_mod_lookup() - gets the algorithm module
> + * @name:      text string containing name of algorithm
> + * @type:      crypto type defined in include/linux/crypto.h
> + * @mask:      mask of allowable crypto types (use or'd list
> + *             of types as defined in include/linux/crypto.h)
> + * @returns:   pointer to crypto_alg structure
> + */
>  struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask)
>  {
>        struct crypto_alg *alg;
> --

Re: [PATCH 1/1] crypto: api.c: doc on crypto_alg_lookup, crypto_larval_lookup, and crypto_alg_mod_lookup

[Randy Dunlap]

On Fri,  5 Nov 2010 11:05:46 -0700 Mark Allyn wrote:

> Resubmit due to errors on patch submitted 11/4/2010
> 
> Signed-off-by: Mark A. Allyn <mark.a.allyn@intel.com>

Acked-by: Randy Dunlap <randy.dunlap@oracle.com>

Thanks, Mark.


> ---
>  crypto/api.c |   25 +++++++++++++++++++++++++
>  1 files changed, 25 insertions(+), 0 deletions(-)
> 
> diff --git a/crypto/api.c b/crypto/api.c
> index 033a714..d8a7c35 100644
> --- a/crypto/api.c
> +++ b/crypto/api.c
> @@ -193,6 +193,14 @@ static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg)
>  	return alg;
>  }
>  
> +/**
> + * crypto_alg_lookup() - get the crypto_alg structure for an algorithm
> + * @name:	text string containing name of algorithm
> + * @type:	crypto type defined in include/linux/crypto.h
> + * @mask:	mask of allowable crypto types (use or'd list
> + *		of types as defined in include/linux/crypto.h)
> + * @returns:	pointer to crypto_alg structure
> + */
>  struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask)
>  {
>  	struct crypto_alg *alg;
> @@ -205,6 +213,15 @@ struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask)
>  }
>  EXPORT_SYMBOL_GPL(crypto_alg_lookup);
>  
> +/**
> + * crypto_larval_lookup() - gets large value (larval) crypto_alg
> + *	structure for an algorithm
> + * @name:	text string containing name of algorithm
> + * @type:	crypto type defined in include/linux/crypto.h
> + * @mask:	mask of allowable crypto types (use or'd list
> + *		of types as defined in include/linux/crypto.h)
> + * @returns:	pointer to crypto_alg structure
> + */
>  struct crypto_alg *crypto_larval_lookup(const char *name, u32 type, u32 mask)
>  {
>  	struct crypto_alg *alg;
> @@ -247,6 +264,14 @@ int crypto_probing_notify(unsigned long val, void *v)
>  }
>  EXPORT_SYMBOL_GPL(crypto_probing_notify);
>  
> +/**
> + * crypto_alg_mod_lookup() - gets the algorithm module
> + * @name:	text string containing name of algorithm
> + * @type:	crypto type defined in include/linux/crypto.h
> + * @mask:	mask of allowable crypto types (use or'd list
> + *		of types as defined in include/linux/crypto.h)
> + * @returns:	pointer to crypto_alg structure
> + */
>  struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask)
>  {
>  	struct crypto_alg *alg;
> -- 

---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

RE: [PATCH 1/1] crypto: api.c: doc on crypto_alg_lookup, crypto_larval_lookup, and crypto_alg_mod_lookup

[Allyn, Mark A]

Can you please explain what larval means in this context? I tried googling it an could not find anything meaningful. 

What is the difference between crypto_alg_lookup and crypto_larval_lookup?

I was making an assumption that larval is shorthand for large value as there is nothing meaningful in google except for a type of wormlike form.

Thank you

Mark Allyn

-----Original Message-----
From: Lee Nipper [mailto:lee.nipper@gmail.com] 
Sent: Friday, November 05, 2010 11:28 AM
To: Allyn, Mark A
Cc: linux-crypto@vger.kernel.org
Subject: Re: [PATCH 1/1] crypto: api.c: doc on crypto_alg_lookup, crypto_larval_lookup, and crypto_alg_mod_lookup

On Fri, Nov 5, 2010 at 13:05, Mark Allyn <mark.a.allyn@intel.com> wrote:
> Resubmit due to errors on patch submitted 11/4/2010
>
> Signed-off-by: Mark A. Allyn <mark.a.allyn@intel.com>
> ---
>  crypto/api.c |   25 +++++++++++++++++++++++++
>  1 files changed, 25 insertions(+), 0 deletions(-)
>
> diff --git a/crypto/api.c b/crypto/api.c
> index 033a714..d8a7c35 100644
> --- a/crypto/api.c
> +++ b/crypto/api.c
> @@ -193,6 +193,14 @@ static struct crypto_alg *crypto_larval_wait(struct crypto_alg *alg)
>        return alg;
>  }
>
> +/**
> + * crypto_alg_lookup() - get the crypto_alg structure for an algorithm
> + * @name:      text string containing name of algorithm
> + * @type:      crypto type defined in include/linux/crypto.h
> + * @mask:      mask of allowable crypto types (use or'd list
> + *             of types as defined in include/linux/crypto.h)
> + * @returns:   pointer to crypto_alg structure
> + */
>  struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask)
>  {
>        struct crypto_alg *alg;
> @@ -205,6 +213,15 @@ struct crypto_alg *crypto_alg_lookup(const char *name, u32 type, u32 mask)
>  }
>  EXPORT_SYMBOL_GPL(crypto_alg_lookup);
>
> +/**
> + * crypto_larval_lookup() - gets large value (larval) crypto_alg
> + *     structure for an algorithm

larval is an adjective.  omit "large value", as it only adds confusion.

> + * @name:      text string containing name of algorithm
> + * @type:      crypto type defined in include/linux/crypto.h
> + * @mask:      mask of allowable crypto types (use or'd list
> + *             of types as defined in include/linux/crypto.h)
> + * @returns:   pointer to crypto_alg structure
> + */
>  struct crypto_alg *crypto_larval_lookup(const char *name, u32 type, u32 mask)
>  {
>        struct crypto_alg *alg;
> @@ -247,6 +264,14 @@ int crypto_probing_notify(unsigned long val, void *v)
>  }
>  EXPORT_SYMBOL_GPL(crypto_probing_notify);
>
> +/**
> + * crypto_alg_mod_lookup() - gets the algorithm module
> + * @name:      text string containing name of algorithm
> + * @type:      crypto type defined in include/linux/crypto.h
> + * @mask:      mask of allowable crypto types (use or'd list
> + *             of types as defined in include/linux/crypto.h)
> + * @returns:   pointer to crypto_alg structure
> + */
>  struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask)
>  {
>        struct crypto_alg *alg;
> --

Re: [PATCH 1/1] crypto: api.c: doc on crypto_alg_lookup, crypto_larval_lookup, and crypto_alg_mod_lookup

[Lee Nipper]

On Fri, Nov 5, 2010 at 13:36, Allyn, Mark A <mark.a.allyn@intel.com> wrote:
> Can you please explain what larval means in this context? I tried googling it an could not find anything meaningful.
>
> What is the difference between crypto_alg_lookup and crypto_larval_lookup?
>

In the kernel crypto context,
I think larval means that the lookup
may load a module, if necessary, to provide support for the algorithm.

I defer to Herbert Xu for any further explanation.

Re: [PATCH 1/1] crypto: api.c: doc on crypto_alg_lookup, crypto_larval_lookup, and crypto_alg_mod_lookup

[Herbert Xu]

Allyn, Mark A <mark.a.allyn@intel.com> wrote:
> 
> I was making an assumption that larval is shorthand for large value as there is nothing meaningful in google except for a type of wormlike form.

Larval means not fully grown in this context, i.e., the algorithm
that we've constructed will be filled in later to become a real
algorithm object.

Cheers,
-- 
Email: Herbert Xu <herbert@gondor.apana.org.au>
Home Page: http://gondor.apana.org.au/~herbert/
PGP Key: http://gondor.apana.org.au/~herbert/pubkey.txt