crypto/internal.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * Cryptographic API.
   4  *
   5  * Copyright (c) 2002 James Morris <jmorris@intercode.com.au>
   6  * Copyright (c) 2005 Herbert Xu <herbert@gondor.apana.org.au>
   7  */
   8 #ifndef _CRYPTO_INTERNAL_H
   9 #define _CRYPTO_INTERNAL_H
  10
  11 #include <crypto/algapi.h>
  12 #include <linux/completion.h>
  13 #include <linux/err.h>
  14 #include <linux/jump_label.h>
  15 #include <linux/list.h>
  16 #include <linux/module.h>
  17 #include <linux/notifier.h>
  18 #include <linux/numa.h>
  19 #include <linux/refcount.h>
  20 #include <linux/rwsem.h>
  21 #include <linux/scatterlist.h>
  22 #include <linux/sched.h>
  23 #include <linux/types.h>
  24
  25 struct crypto_instance;
  26 struct crypto_template;
  27
  28 struct crypto_larval {
  29         struct crypto_alg alg;
  30         struct crypto_alg *adult;
  31         struct completion completion;
  32         u32 mask;
  33         bool test_started;
  34 };
  35
  36 struct crypto_type {
  37         unsigned int (*ctxsize)(struct crypto_alg *alg, u32 type, u32 mask);
  38         unsigned int (*extsize)(struct crypto_alg *alg);
  39         int (*init_tfm)(struct crypto_tfm *tfm);
  40         void (*show)(struct seq_file *m, struct crypto_alg *alg);
  41         int (*report)(struct sk_buff *skb, struct crypto_alg *alg);
  42         void (*free)(struct crypto_instance *inst);
  43         void (*destroy)(struct crypto_alg *alg);
  44
  45         unsigned int type;
  46         unsigned int maskclear;
  47         unsigned int maskset;
  48         unsigned int tfmsize;
  49         unsigned int algsize;
  50 };
  51
  52 enum {
  53         CRYPTOA_UNSPEC,
  54         CRYPTOA_ALG,
  55         CRYPTOA_TYPE,
  56         __CRYPTOA_MAX,
  57 };
  58
  59 #define CRYPTOA_MAX (__CRYPTOA_MAX - 1)
  60
  61 /* Maximum number of (rtattr) parameters for each template. */
  62 #define CRYPTO_MAX_ATTRS 32
  63
  64 extern struct list_head crypto_alg_list;
  65 extern struct rw_semaphore crypto_alg_sem;
  66 extern struct blocking_notifier_head crypto_chain;
  67
  68 int alg_test(const char *driver, const char *alg, u32 type, u32 mask);
  69
  70 #if !IS_BUILTIN(CONFIG_CRYPTO_ALGAPI) || !IS_ENABLED(CONFIG_CRYPTO_SELFTESTS)
  71 static inline bool crypto_boot_test_finished(void)
  72 {
  73         return true;
  74 }
  75 static inline void set_crypto_boot_test_finished(void)
  76 {
  77 }
  78 #else
  79 DECLARE_STATIC_KEY_FALSE(__crypto_boot_test_finished);
  80 static inline bool crypto_boot_test_finished(void)
  81 {
  82         return static_branch_likely(&__crypto_boot_test_finished);
  83 }
  84 static inline void set_crypto_boot_test_finished(void)
  85 {
  86         static_branch_enable(&__crypto_boot_test_finished);
  87 }
  88 #endif /* !IS_BUILTIN(CONFIG_CRYPTO_ALGAPI) ||
  89         * !IS_ENABLED(CONFIG_CRYPTO_SELFTESTS)
  90         */
  91
  92 #ifdef CONFIG_PROC_FS
  93 void __init crypto_init_proc(void);
  94 void __exit crypto_exit_proc(void);
  95 #else
  96 static inline void crypto_init_proc(void)
  97 { }
  98 static inline void crypto_exit_proc(void)
  99 { }
 100 #endif
 101
 102 static inline unsigned int crypto_cipher_ctxsize(struct crypto_alg *alg)
 103 {
 104         return alg->cra_ctxsize;
 105 }
 106
 107 static inline unsigned int crypto_compress_ctxsize(struct crypto_alg *alg)
 108 {
 109         return alg->cra_ctxsize;
 110 }
 111
 112 struct crypto_alg *crypto_mod_get(struct crypto_alg *alg);
 113 struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask);
 114
 115 struct crypto_larval *crypto_larval_alloc(const char *name, u32 type, u32 mask);
 116 void crypto_schedule_test(struct crypto_larval *larval);
 117 void crypto_alg_tested(const char *name, int err);
 118
 119 void crypto_remove_spawns(struct crypto_alg *alg, struct list_head *list,
 120                           struct crypto_alg *nalg);
 121 void crypto_remove_final(struct list_head *list);
 122 void crypto_shoot_alg(struct crypto_alg *alg);
 123 struct crypto_tfm *__crypto_alloc_tfmgfp(struct crypto_alg *alg, u32 type,
 124                                          u32 mask, gfp_t gfp);
 125 struct crypto_tfm *__crypto_alloc_tfm(struct crypto_alg *alg, u32 type,
 126                                       u32 mask);
 127 void *crypto_create_tfm_node(struct crypto_alg *alg,
 128                         const struct crypto_type *frontend, int node);
 129 void *crypto_clone_tfm(const struct crypto_type *frontend,
 130                        struct crypto_tfm *otfm);
 131
 132 static inline void *crypto_create_tfm(struct crypto_alg *alg,
 133                         const struct crypto_type *frontend)
 134 {
 135         return crypto_create_tfm_node(alg, frontend, NUMA_NO_NODE);
 136 }
 137
 138 struct crypto_alg *crypto_find_alg(const char *alg_name,
 139                                    const struct crypto_type *frontend,
 140                                    u32 type, u32 mask);
 141
 142 void *crypto_alloc_tfm_node(const char *alg_name,
 143                        const struct crypto_type *frontend, u32 type, u32 mask,
 144                        int node);
 145
 146 static inline void *crypto_alloc_tfm(const char *alg_name,
 147                        const struct crypto_type *frontend, u32 type, u32 mask)
 148 {
 149         return crypto_alloc_tfm_node(alg_name, frontend, type, mask, NUMA_NO_NODE);
 150 }
 151
 152 int crypto_probing_notify(unsigned long val, void *v);
 153
 154 unsigned int crypto_alg_extsize(struct crypto_alg *alg);
 155
 156 int crypto_type_has_alg(const char *name, const struct crypto_type *frontend,
 157                         u32 type, u32 mask);
 158
 159 static inline struct crypto_alg *crypto_alg_get(struct crypto_alg *alg)
 160 {
 161         refcount_inc(&alg->cra_refcnt);
 162         return alg;
 163 }
 164
 165 void crypto_destroy_alg(struct crypto_alg *alg);
 166
 167 static inline void crypto_alg_put(struct crypto_alg *alg)
 168 {
 169         if (refcount_dec_and_test(&alg->cra_refcnt))
 170                 crypto_destroy_alg(alg);
 171 }
 172
 173 static inline int crypto_tmpl_get(struct crypto_template *tmpl)
 174 {
 175         return try_module_get(tmpl->module);
 176 }
 177
 178 static inline void crypto_tmpl_put(struct crypto_template *tmpl)
 179 {
 180         module_put(tmpl->module);
 181 }
 182
 183 static inline int crypto_is_larval(struct crypto_alg *alg)
 184 {
 185         return alg->cra_flags & CRYPTO_ALG_LARVAL;
 186 }
 187
 188 static inline int crypto_is_dead(struct crypto_alg *alg)
 189 {
 190         return alg->cra_flags & CRYPTO_ALG_DEAD;
 191 }
 192
 193 static inline int crypto_is_moribund(struct crypto_alg *alg)
 194 {
 195         return alg->cra_flags & (CRYPTO_ALG_DEAD | CRYPTO_ALG_DYING);
 196 }
 197
 198 static inline void crypto_notify(unsigned long val, void *v)
 199 {
 200         blocking_notifier_call_chain(&crypto_chain, val, v);
 201 }
 202
 203 static inline void crypto_yield(u32 flags)
 204 {
 205         if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
 206                 cond_resched();
 207 }
 208
 209 static inline int crypto_is_test_larval(struct crypto_larval *larval)
 210 {
 211         return larval->alg.cra_driver_name[0];
 212 }
 213
 214 static inline struct crypto_tfm *crypto_tfm_get(struct crypto_tfm *tfm)
 215 {
 216         return refcount_inc_not_zero(&tfm->refcnt) ? tfm : ERR_PTR(-EOVERFLOW);
 217 }
 218
 219 #endif  /* _CRYPTO_INTERNAL_H */
 220