Lniux加密框架中的主要数据结构（五）

算法幼虫

1. 定义

如前所述，算法幼虫在算法注册和自检过程中起到非常重要的作用，表示无法提供预期服务的算法，在root/crypto/internal.h中算法幼虫定义如下所示。

struct crypto_larval {
     
	struct crypto_alg alg;
	struct crypto_alg *adult;
	struct completion completion;
	u32 mask;
};

算法幼虫数据结构struct crypto_larval中各成员变量含义如下所示。
1)alg：算法幼虫对应的通用算法说明；
2)adult：算法幼虫对应的算法成虫，即待注册或待检验的算法；
3)completion：算法幼虫对应的完成量，用于在注册或检验过程中进行线程同步；
4)mask：算法类型屏蔽字。
在加密框架中每种算法都对应一个通用算法说明，需要由算法管理链表管理，算法幼虫是一种特殊的算法，不“成熟”，无法提供算法服务，因此其通用算法说明只是用来表示算法幼虫的属性（如算法名，算法类型等），并不提供算法接口。
在加密框架中，算法动态注册和算法正确性检验都是由专门的内核线程实现的，与执行算法查找或算法注册的内核线程之间通过完成量机制实现线程间同步。

2. 接口

1）crypto_larval_alloc函数
crypto_larval_alloc函数输入参数包括算法名name、算法类型type和算法类型屏蔽字mask，实现根据输入参数创建同名的算法幼虫larval的功能。
在crypto_larval_alloc函数中对新创建的算法幼虫的初始化如下所示。

	larval->mask = mask;
	larval->alg.cra_flags = CRYPTO_ALG_LARVAL | type;
	larval->alg.cra_priority = -1;
	larval->alg.cra_destroy = crypto_larval_destroy;

	strlcpy(larval->alg.cra_name, name, CRYPTO_MAX_ALG_NAME);
	init_completion(&larval->completion);

在算法幼虫初始化时，需要注意以下几点：
a)算法幼虫与算法同名；
b)算法幼虫的算法类型设置CRYPTO_ALG_LARVAL；
c)算法幼虫的算法优先级为-1；
d)算法幼虫设置了实例销毁接口crypto_larval_destroy。
将crypto_larval_alloc函数创建的算法幼虫称为通用算法幼虫，实际上就是注册用算法幼虫。
在__crypto_register_alg函数中，再调用crypto_larval_alloc函数创建通用算法幼虫基础上，再进行如下设置，设置之后的算法幼虫称为检测用算法幼虫。

	larval->adult = crypto_mod_get(alg);

	atomic_set(&larval->alg.cra_refcnt, 1);
	memcpy(larval->alg.cra_driver_name, alg->cra_driver_name,
	       CRYPTO_MAX_ALG_NAME);
	larval->alg.cra_priority = alg->cra_priority;

与通用算法幼虫（即注册用算法幼虫）相比，检测用算法幼虫增加了以下属性：
a)检验用算法幼虫设置了对应的算法成虫；
b)检验用算法幼虫设置了对应的算法驱动名；
c)检验用算法幼虫继承了算法成功的算法优先级。
在加密框架中，用是否设置了算法驱动名来区分注册用算法幼虫和检测用算法幼虫，由内联函数crypto_is_test_larval实现，如下所示。

static inline int crypto_is_test_larval(struct crypto_larval *larval)
{
     
	return larval->alg.cra_driver_name[0];
}

2)crypto_larval_add函数
crypto_larval_add函数输入参数包括算法名name、算法类型type和算法类型屏蔽字mask，其处理流程如下所示。

如上所示，crypto_larval_add函数并不是简单调用crypto_larval_alloc函数创建注册用算法幼虫larval，在返回前要调用__crypto_alg_lookup函数再次查找是否有符合条件的算法alg，根据查找结果确认返回值。
算法幼虫larval和算法alg在数据结构上的共同点为通用算法说明，因此crypto_larval_add函数的返回值是通用算法说明，而调用者通过算法类型判断某个通用算法说明是否对应一个算法幼虫，由内联函数crypto_is_larval函数实现，如下所示。

static inline int crypto_is_larval(struct crypto_alg *alg)
{
     
	return alg->cra_flags & CRYPTO_ALG_LARVAL;
}

3)crypto_larval_wait函数

crypto_larval_wait函数用于等待算法检测（即算法注册）完成，通过完成量实现与算法检测线程之间的同步，其完成量是带超时（60s）可中断的，如下所示。

timeout = wait_for_completion_interruptible_timeout(
		&larval->completion, 60 * HZ);

crypto_larval_wait函数只是简单地等待算法检测完成，而算法检测结果还需要通过其他条件进行综合判断，包括完成量返回的剩余时间timeout、算法幼虫关联的算法成虫alg（=larval->adult），具体规则如下：
i.根据timeout值判断线程同步结果，timeout<0说明等待被外部信号中断，返回EINTR错误；timeout=0说明等待算法注册超时，返回ETIMEDOUT，如下所示。

	if (timeout < 0)
		alg = ERR_PTR(-EINTR);
	else if (!timeout)
		alg = ERR_PTR(-ETIMEDOUT);

ii.timeout>0说明算法注册在超时时间内完成，但是注册完成并不代表注册成功，还需要进一步判断，例如注册用算法幼虫关联的算法成功alg无效说明算法注册失败，返回ENOENT（即没有这个算法）错误；如果算法幼虫为检验用算法幼虫，但算法未经过检验，返回EAGAIN错误，允许重新尝试算法注册流程，如下所示。

	if (!alg)
		alg = ERR_PTR(-ENOENT);
	else if (crypto_is_test_larval(larval) &&
		 !(alg->cra_flags & CRYPTO_ALG_TESTED))
		alg = ERR_PTR(-EAGAIN);

iii.以上条件均不满足时，说明算法已成功完成注册，返回注册好的算法alg。
4)crypto_larval_kill函数
算法注册成功，同时也意味着算法幼虫使用的终结，注册线程将调用crypto_larval_kill函数“杀死”算法幼虫。
首先从算法管理链表中删除算法幼虫，使之变为孤儿；然后唤醒在算法幼虫完成量上等待的所有线程，使之变得无用；最后释放算法幼虫的占有权，彻底判处其死刑。
内联函数crypto_alg_put用于释放算法alg（包括算法幼虫）的占有权，展开后如下所示：

	if (atomic_dec_and_test(&alg->cra_refcnt) && alg->cra_destroy)
		alg->cra_destroy(alg);

释放算法占有权时，如果算法定义了cra_destroy接口，将调用其进行进一步处理，而在创建算法幼虫（crypto_larval_alloc函数）时将算法幼虫的cra_destroy接口设置为crypto_larval_destroy函数。
crypto_larval_destroy函数将先释放对算法成虫adult（如果有）的占用权，最终释放算法幼虫占用的内存空间，这样算法幼虫形神俱灭，消失的无影无踪。