[linux-2.6-block.git] / crypto / internal.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Cryptographic API.
 *
 * Copyright (c) 2002 James Morris <jmorris@intercode.com.au>
 * Copyright (c) 2005 Herbert Xu <herbert@gondor.apana.org.au>
 */
#ifndef _CRYPTO_INTERNAL_H
#define _CRYPTO_INTERNAL_H

#include <crypto/algapi.h>
#include <linux/completion.h>
#include <linux/jump_label.h>
#include <linux/list.h>
#include <linux/module.h>
#include <linux/notifier.h>
#include <linux/numa.h>
#include <linux/refcount.h>
#include <linux/rwsem.h>
#include <linux/sched.h>
#include <linux/types.h>

struct crypto_instance;
struct crypto_template;

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

enum {
	CRYPTOA_UNSPEC,
	CRYPTOA_ALG,
	CRYPTOA_TYPE,
	__CRYPTOA_MAX,
};

#define CRYPTOA_MAX (__CRYPTOA_MAX - 1)

/* Maximum number of (rtattr) parameters for each template. */
#define CRYPTO_MAX_ATTRS 32

extern struct list_head crypto_alg_list;
extern struct rw_semaphore crypto_alg_sem;
extern struct blocking_notifier_head crypto_chain;

DECLARE_STATIC_KEY_FALSE(crypto_boot_test_finished);

#ifdef CONFIG_PROC_FS
void __init crypto_init_proc(void);
void __exit crypto_exit_proc(void);
#else
static inline void crypto_init_proc(void)
{ }
static inline void crypto_exit_proc(void)
{ }
#endif

static inline unsigned int crypto_cipher_ctxsize(struct crypto_alg *alg)
{
	return alg->cra_ctxsize;
}

static inline unsigned int crypto_compress_ctxsize(struct crypto_alg *alg)
{
	return alg->cra_ctxsize;
}

struct crypto_alg *crypto_mod_get(struct crypto_alg *alg);
struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask);

struct crypto_larval *crypto_larval_alloc(const char *name, u32 type, u32 mask);
void crypto_larval_kill(struct crypto_alg *alg);
void crypto_wait_for_test(struct crypto_larval *larval);
void crypto_alg_tested(const char *name, int err);

void crypto_remove_spawns(struct crypto_alg *alg, struct list_head *list,
			  struct crypto_alg *nalg);
void crypto_remove_final(struct list_head *list);
void crypto_shoot_alg(struct crypto_alg *alg);
struct crypto_tfm *__crypto_alloc_tfm(struct crypto_alg *alg, u32 type,
				      u32 mask);
void *crypto_create_tfm_node(struct crypto_alg *alg,
			const struct crypto_type *frontend, int node);

static inline void *crypto_create_tfm(struct crypto_alg *alg,
			const struct crypto_type *frontend)
{
	return crypto_create_tfm_node(alg, frontend, NUMA_NO_NODE);
}

struct crypto_alg *crypto_find_alg(const char *alg_name,
				   const struct crypto_type *frontend,
				   u32 type, u32 mask);

void *crypto_alloc_tfm_node(const char *alg_name,
		       const struct crypto_type *frontend, u32 type, u32 mask,
		       int node);

static inline void *crypto_alloc_tfm(const char *alg_name,
		       const struct crypto_type *frontend, u32 type, u32 mask)
{
	return crypto_alloc_tfm_node(alg_name, frontend, type, mask, NUMA_NO_NODE);
}

int crypto_probing_notify(unsigned long val, void *v);

unsigned int crypto_alg_extsize(struct crypto_alg *alg);

int crypto_type_has_alg(const char *name, const struct crypto_type *frontend,
			u32 type, u32 mask);

static inline struct crypto_alg *crypto_alg_get(struct crypto_alg *alg)
{
	refcount_inc(&alg->cra_refcnt);
	return alg;
}

static inline void crypto_alg_put(struct crypto_alg *alg)
{
	if (refcount_dec_and_test(&alg->cra_refcnt) && alg->cra_destroy)
		alg->cra_destroy(alg);
}

static inline int crypto_tmpl_get(struct crypto_template *tmpl)
{
	return try_module_get(tmpl->module);
}

static inline void crypto_tmpl_put(struct crypto_template *tmpl)
{
	module_put(tmpl->module);
}

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

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

static inline int crypto_is_moribund(struct crypto_alg *alg)
{
	return alg->cra_flags & (CRYPTO_ALG_DEAD | CRYPTO_ALG_DYING);
}

static inline void crypto_notify(unsigned long val, void *v)
{
	blocking_notifier_call_chain(&crypto_chain, val, v);
}

static inline void crypto_yield(u32 flags)
{
	if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
		cond_resched();
}

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

#endif	/* _CRYPTO_INTERNAL_H */
Commit	Line	Data
2874c5fd	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4 LT	2	/*
	3	* Cryptographic API.
	4	*
	5	* Copyright (c) 2002 James Morris <jmorris@intercode.com.au>
5cb1454b	6	* Copyright (c) 2005 Herbert Xu <herbert@gondor.apana.org.au>
1da177e4 LT	7	*/
	8	#ifndef _CRYPTO_INTERNAL_H
	9	#define _CRYPTO_INTERNAL_H
cce9e06d HX	10
cce9e06d HX	11	#include <crypto/algapi.h>
2825982d	12	#include <linux/completion.h>
adad556e	13	#include <linux/jump_label.h>
5cb1454b	14	#include <linux/list.h>
4cc7720c	15	#include <linux/module.h>
2825982d	16	#include <linux/notifier.h>
1dbb920e HX	17	#include <linux/numa.h>
1dbb920e HX	18	#include <linux/refcount.h>
5cb1454b	19	#include <linux/rwsem.h>
1dbb920e HX	20	#include <linux/sched.h>
1dbb920e HX	21	#include <linux/types.h>
ccb778e1	22
4cc7720c HX	23	struct crypto_instance;
	24	struct crypto_template;
	25
2825982d HX	26	struct crypto_larval {
	27	struct crypto_alg alg;
	28	struct crypto_alg *adult;
	29	struct completion completion;
492e2b63	30	u32 mask;
adad556e	31	bool test_started;
2825982d HX	32	};
2825982d HX	33
5163ab50 HX	34	enum {
	35	CRYPTOA_UNSPEC,
	36	CRYPTOA_ALG,
	37	CRYPTOA_TYPE,
	38	__CRYPTOA_MAX,
	39	};
	40
	41	#define CRYPTOA_MAX (__CRYPTOA_MAX - 1)
	42
	43	/* Maximum number of (rtattr) parameters for each template. */
	44	#define CRYPTO_MAX_ATTRS 32
	45
5cb1454b HX	46	extern struct list_head crypto_alg_list;
5cb1454b HX	47	extern struct rw_semaphore crypto_alg_sem;
2825982d	48	extern struct blocking_notifier_head crypto_chain;
5cb1454b	49
adad556e HX	50	DECLARE_STATIC_KEY_FALSE(crypto_boot_test_finished);
adad556e HX	51
1da177e4 LT	52	#ifdef CONFIG_PROC_FS
1da177e4 LT	53	void __init crypto_init_proc(void);
cce9e06d	54	void __exit crypto_exit_proc(void);
1da177e4 LT	55	#else
	56	static inline void crypto_init_proc(void)
	57	{ }
cce9e06d HX	58	static inline void crypto_exit_proc(void)
cce9e06d HX	59	{ }
1da177e4 LT	60	#endif
1da177e4 LT	61
f1ddcaf3	62	static inline unsigned int crypto_cipher_ctxsize(struct crypto_alg *alg)
fbdae9f3	63	{
f1ddcaf3	64	return alg->cra_ctxsize;
fbdae9f3 HX	65	}
fbdae9f3 HX	66
f1ddcaf3	67	static inline unsigned int crypto_compress_ctxsize(struct crypto_alg *alg)
fbdae9f3 HX	68	{
	69	return alg->cra_ctxsize;
	70	}
	71
2825982d	72	struct crypto_alg crypto_mod_get(struct crypto_alg alg);
492e2b63	73	struct crypto_alg crypto_alg_mod_lookup(const char name, u32 type, u32 mask);
2825982d	74
73d3864a	75	struct crypto_larval crypto_larval_alloc(const char name, u32 type, u32 mask);
b9c55aa4	76	void crypto_larval_kill(struct crypto_alg *alg);
adad556e	77	void crypto_wait_for_test(struct crypto_larval *larval);
73d3864a	78	void crypto_alg_tested(const char *name, int err);
2825982d	79
89b596ba SK	80	void crypto_remove_spawns(struct crypto_alg alg, struct list_head list,
89b596ba SK	81	struct crypto_alg *nalg);
22e5b20b	82	void crypto_remove_final(struct list_head *list);
6603523b	83	void crypto_shoot_alg(struct crypto_alg *alg);
27d2a330 HX	84	struct crypto_tfm __crypto_alloc_tfm(struct crypto_alg alg, u32 type,
27d2a330 HX	85	u32 mask);
7bc13b5b BS	86	void crypto_create_tfm_node(struct crypto_alg alg,
	87	const struct crypto_type *frontend, int node);
	88
	89	static inline void crypto_create_tfm(struct crypto_alg alg,
	90	const struct crypto_type *frontend)
	91	{
	92	return crypto_create_tfm_node(alg, frontend, NUMA_NO_NODE);
	93	}
	94
d06854f0 HX	95	struct crypto_alg crypto_find_alg(const char alg_name,
	96	const struct crypto_type *frontend,
	97	u32 type, u32 mask);
7bc13b5b BS	98
	99	void crypto_alloc_tfm_node(const char alg_name,
	100	const struct crypto_type *frontend, u32 type, u32 mask,
	101	int node);
	102
	103	static inline void crypto_alloc_tfm(const char alg_name,
	104	const struct crypto_type *frontend, u32 type, u32 mask)
	105	{
	106	return crypto_alloc_tfm_node(alg_name, frontend, type, mask, NUMA_NO_NODE);
	107	}
4cc7720c	108
73d3864a	109	int crypto_probing_notify(unsigned long val, void *v);
2825982d	110
38d21433 HX	111	unsigned int crypto_alg_extsize(struct crypto_alg *alg);
38d21433 HX	112
f2aefdab HX	113	int crypto_type_has_alg(const char name, const struct crypto_type frontend,
	114	u32 type, u32 mask);
	115
939e1779 HX	116	static inline struct crypto_alg crypto_alg_get(struct crypto_alg alg)
939e1779 HX	117	{
ce8614a3	118	refcount_inc(&alg->cra_refcnt);
939e1779 HX	119	return alg;
	120	}
	121
6bfd4809 HX	122	static inline void crypto_alg_put(struct crypto_alg *alg)
6bfd4809 HX	123	{
ce8614a3	124	if (refcount_dec_and_test(&alg->cra_refcnt) && alg->cra_destroy)
6bfd4809 HX	125	alg->cra_destroy(alg);
	126	}
	127
4cc7720c HX	128	static inline int crypto_tmpl_get(struct crypto_template *tmpl)
	129	{
	130	return try_module_get(tmpl->module);
	131	}
	132
	133	static inline void crypto_tmpl_put(struct crypto_template *tmpl)
	134	{
	135	module_put(tmpl->module);
	136	}
	137
2825982d HX	138	static inline int crypto_is_larval(struct crypto_alg *alg)
	139	{
	140	return alg->cra_flags & CRYPTO_ALG_LARVAL;
	141	}
	142
6bfd4809 HX	143	static inline int crypto_is_dead(struct crypto_alg *alg)
	144	{
	145	return alg->cra_flags & CRYPTO_ALG_DEAD;
	146	}
	147
	148	static inline int crypto_is_moribund(struct crypto_alg *alg)
	149	{
	150	return alg->cra_flags & (CRYPTO_ALG_DEAD \| CRYPTO_ALG_DYING);
	151	}
	152
73d3864a	153	static inline void crypto_notify(unsigned long val, void *v)
2825982d	154	{
73d3864a	155	blocking_notifier_call_chain(&crypto_chain, val, v);
2825982d HX	156	}
2825982d HX	157
1dbb920e HX	158	static inline void crypto_yield(u32 flags)
	159	{
	160	if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
	161	cond_resched();
	162	}
	163
adad556e HX	164	static inline int crypto_is_test_larval(struct crypto_larval *larval)
	165	{
	166	return larval->alg.cra_driver_name[0];
	167	}
	168
1da177e4 LT	169	#endif /* _CRYPTO_INTERNAL_H */
1da177e4 LT	170