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 enum {
  37         CRYPTOA_UNSPEC,
  38         CRYPTOA_ALG,
  39         CRYPTOA_TYPE,
  40         __CRYPTOA_MAX,
  41 };
  42
  43 #define CRYPTOA_MAX (__CRYPTOA_MAX - 1)
  44
  45 /* Maximum number of (rtattr) parameters for each template. */
  46 #define CRYPTO_MAX_ATTRS 32
  47
  48 extern struct list_head crypto_alg_list;
  49 extern struct rw_semaphore crypto_alg_sem;
  50 extern struct blocking_notifier_head crypto_chain;
  51
  52 int alg_test(const char *driver, const char *alg, u32 type, u32 mask);
  53
  54 #if !IS_BUILTIN(CONFIG_CRYPTO_ALGAPI) || \
  55     IS_ENABLED(CONFIG_CRYPTO_MANAGER_DISABLE_TESTS)
  56 static inline bool crypto_boot_test_finished(void)
  57 {
  58         return true;
  59 }
  60 static inline void set_crypto_boot_test_finished(void)
  61 {
  62 }
  63 #else
  64 DECLARE_STATIC_KEY_FALSE(__crypto_boot_test_finished);
  65 static inline bool crypto_boot_test_finished(void)
  66 {
  67         return static_branch_likely(&__crypto_boot_test_finished);
  68 }
  69 static inline void set_crypto_boot_test_finished(void)
  70 {
  71         static_branch_enable(&__crypto_boot_test_finished);
  72 }
  73 #endif /* !IS_BUILTIN(CONFIG_CRYPTO_ALGAPI) ||
  74         * IS_ENABLED(CONFIG_CRYPTO_MANAGER_DISABLE_TESTS)
  75         */
  76
  77 #ifdef CONFIG_PROC_FS
  78 void __init crypto_init_proc(void);
  79 void __exit crypto_exit_proc(void);
  80 #else
  81 static inline void crypto_init_proc(void)
  82 { }
  83 static inline void crypto_exit_proc(void)
  84 { }
  85 #endif
  86
  87 static inline unsigned int crypto_cipher_ctxsize(struct crypto_alg *alg)
  88 {
  89         return alg->cra_ctxsize;
  90 }
  91
  92 static inline unsigned int crypto_compress_ctxsize(struct crypto_alg *alg)
  93 {
  94         return alg->cra_ctxsize;
  95 }
  96
  97 struct crypto_alg *crypto_mod_get(struct crypto_alg *alg);
  98 struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask);
  99
 100 struct crypto_larval *crypto_larval_alloc(const char *name, u32 type, u32 mask);
 101 void crypto_schedule_test(struct crypto_larval *larval);
 102 void crypto_alg_tested(const char *name, int err);
 103
 104 void crypto_remove_spawns(struct crypto_alg *alg, struct list_head *list,
 105                           struct crypto_alg *nalg);
 106 void crypto_remove_final(struct list_head *list);
 107 void crypto_shoot_alg(struct crypto_alg *alg);
 108 struct crypto_tfm *__crypto_alloc_tfmgfp(struct crypto_alg *alg, u32 type,
 109                                          u32 mask, gfp_t gfp);
 110 struct crypto_tfm *__crypto_alloc_tfm(struct crypto_alg *alg, u32 type,
 111                                       u32 mask);
 112 void *crypto_create_tfm_node(struct crypto_alg *alg,
 113                         const struct crypto_type *frontend, int node);
 114 void *crypto_clone_tfm(const struct crypto_type *frontend,
 115                        struct crypto_tfm *otfm);
 116
 117 static inline void *crypto_create_tfm(struct crypto_alg *alg,
 118                         const struct crypto_type *frontend)
 119 {
 120         return crypto_create_tfm_node(alg, frontend, NUMA_NO_NODE);
 121 }
 122
 123 struct crypto_alg *crypto_find_alg(const char *alg_name,
 124                                    const struct crypto_type *frontend,
 125                                    u32 type, u32 mask);
 126
 127 void *crypto_alloc_tfm_node(const char *alg_name,
 128                        const struct crypto_type *frontend, u32 type, u32 mask,
 129                        int node);
 130
 131 static inline void *crypto_alloc_tfm(const char *alg_name,
 132                        const struct crypto_type *frontend, u32 type, u32 mask)
 133 {
 134         return crypto_alloc_tfm_node(alg_name, frontend, type, mask, NUMA_NO_NODE);
 135 }
 136
 137 int crypto_probing_notify(unsigned long val, void *v);
 138
 139 unsigned int crypto_alg_extsize(struct crypto_alg *alg);
 140
 141 int crypto_type_has_alg(const char *name, const struct crypto_type *frontend,
 142                         u32 type, u32 mask);
 143
 144 static inline struct crypto_alg *crypto_alg_get(struct crypto_alg *alg)
 145 {
 146         refcount_inc(&alg->cra_refcnt);
 147         return alg;
 148 }
 149
 150 static inline void crypto_alg_put(struct crypto_alg *alg)
 151 {
 152         if (refcount_dec_and_test(&alg->cra_refcnt) && alg->cra_destroy)
 153                 alg->cra_destroy(alg);
 154 }
 155
 156 static inline int crypto_tmpl_get(struct crypto_template *tmpl)
 157 {
 158         return try_module_get(tmpl->module);
 159 }
 160
 161 static inline void crypto_tmpl_put(struct crypto_template *tmpl)
 162 {
 163         module_put(tmpl->module);
 164 }
 165
 166 static inline int crypto_is_larval(struct crypto_alg *alg)
 167 {
 168         return alg->cra_flags & CRYPTO_ALG_LARVAL;
 169 }
 170
 171 static inline int crypto_is_dead(struct crypto_alg *alg)
 172 {
 173         return alg->cra_flags & CRYPTO_ALG_DEAD;
 174 }
 175
 176 static inline int crypto_is_moribund(struct crypto_alg *alg)
 177 {
 178         return alg->cra_flags & (CRYPTO_ALG_DEAD | CRYPTO_ALG_DYING);
 179 }
 180
 181 static inline void crypto_notify(unsigned long val, void *v)
 182 {
 183         blocking_notifier_call_chain(&crypto_chain, val, v);
 184 }
 185
 186 static inline void crypto_yield(u32 flags)
 187 {
 188         if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
 189                 cond_resched();
 190 }
 191
 192 static inline int crypto_is_test_larval(struct crypto_larval *larval)
 193 {
 194         return larval->alg.cra_driver_name[0];
 195 }
 196
 197 static inline struct crypto_tfm *crypto_tfm_get(struct crypto_tfm *tfm)
 198 {
 199         return refcount_inc_not_zero(&tfm->refcnt) ? tfm : ERR_PTR(-EOVERFLOW);
 200 }
 201
 202 #endif  /* _CRYPTO_INTERNAL_H */
 203