[mirror_ubuntu-jammy-kernel.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/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;
};

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;

#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_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();
}

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