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/jump_label.h>
  14 #include <linux/list.h>
  15 #include <linux/module.h>
  16 #include <linux/notifier.h>
  17 #include <linux/numa.h>
  18 #include <linux/refcount.h>
  19 #include <linux/rwsem.h>
  20 #include <linux/sched.h>
  21 #include <linux/types.h>
  22
  23 struct crypto_instance;
  24 struct crypto_template;
  25
  26 struct crypto_larval {
  27         struct crypto_alg alg;
  28         struct crypto_alg *adult;
  29         struct completion completion;
  30         u32 mask;
  31         bool test_started;
  32 };
  33
  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
  46 extern struct list_head crypto_alg_list;
  47 extern struct rw_semaphore crypto_alg_sem;
  48 extern struct blocking_notifier_head crypto_chain;
  49
  50 #ifdef CONFIG_CRYPTO_MANAGER_DISABLE_TESTS
  51 static inline bool crypto_boot_test_finished(void)
  52 {
  53         return true;
  54 }
  55 static inline void set_crypto_boot_test_finished(void)
  56 {
  57 }
  58 #else
  59 DECLARE_STATIC_KEY_FALSE(__crypto_boot_test_finished);
  60 static inline bool crypto_boot_test_finished(void)
  61 {
  62         return static_branch_likely(&__crypto_boot_test_finished);
  63 }
  64 static inline void set_crypto_boot_test_finished(void)
  65 {
  66         static_branch_enable(&__crypto_boot_test_finished);
  67 }
  68 #endif /* !CONFIG_CRYPTO_MANAGER_DISABLE_TESTS */
  69
  70 #ifdef CONFIG_PROC_FS
  71 void __init crypto_init_proc(void);
  72 void __exit crypto_exit_proc(void);
  73 #else
  74 static inline void crypto_init_proc(void)
  75 { }
  76 static inline void crypto_exit_proc(void)
  77 { }
  78 #endif
  79
  80 static inline unsigned int crypto_cipher_ctxsize(struct crypto_alg *alg)
  81 {
  82         return alg->cra_ctxsize;
  83 }
  84
  85 static inline unsigned int crypto_compress_ctxsize(struct crypto_alg *alg)
  86 {
  87         return alg->cra_ctxsize;
  88 }
  89
  90 struct crypto_alg *crypto_mod_get(struct crypto_alg *alg);
  91 struct crypto_alg *crypto_alg_mod_lookup(const char *name, u32 type, u32 mask);
  92
  93 struct crypto_larval *crypto_larval_alloc(const char *name, u32 type, u32 mask);
  94 void crypto_larval_kill(struct crypto_alg *alg);
  95 void crypto_wait_for_test(struct crypto_larval *larval);
  96 void crypto_alg_tested(const char *name, int err);
  97
  98 void crypto_remove_spawns(struct crypto_alg *alg, struct list_head *list,
  99                           struct crypto_alg *nalg);
 100 void crypto_remove_final(struct list_head *list);
 101 void crypto_shoot_alg(struct crypto_alg *alg);
 102 struct crypto_tfm *__crypto_alloc_tfm(struct crypto_alg *alg, u32 type,
 103                                       u32 mask);
 104 void *crypto_create_tfm_node(struct crypto_alg *alg,
 105                         const struct crypto_type *frontend, int node);
 106
 107 static inline void *crypto_create_tfm(struct crypto_alg *alg,
 108                         const struct crypto_type *frontend)
 109 {
 110         return crypto_create_tfm_node(alg, frontend, NUMA_NO_NODE);
 111 }
 112
 113 struct crypto_alg *crypto_find_alg(const char *alg_name,
 114                                    const struct crypto_type *frontend,
 115                                    u32 type, u32 mask);
 116
 117 void *crypto_alloc_tfm_node(const char *alg_name,
 118                        const struct crypto_type *frontend, u32 type, u32 mask,
 119                        int node);
 120
 121 static inline void *crypto_alloc_tfm(const char *alg_name,
 122                        const struct crypto_type *frontend, u32 type, u32 mask)
 123 {
 124         return crypto_alloc_tfm_node(alg_name, frontend, type, mask, NUMA_NO_NODE);
 125 }
 126
 127 int crypto_probing_notify(unsigned long val, void *v);
 128
 129 unsigned int crypto_alg_extsize(struct crypto_alg *alg);
 130
 131 int crypto_type_has_alg(const char *name, const struct crypto_type *frontend,
 132                         u32 type, u32 mask);
 133
 134 static inline struct crypto_alg *crypto_alg_get(struct crypto_alg *alg)
 135 {
 136         refcount_inc(&alg->cra_refcnt);
 137         return alg;
 138 }
 139
 140 static inline void crypto_alg_put(struct crypto_alg *alg)
 141 {
 142         if (refcount_dec_and_test(&alg->cra_refcnt) && alg->cra_destroy)
 143                 alg->cra_destroy(alg);
 144 }
 145
 146 static inline int crypto_tmpl_get(struct crypto_template *tmpl)
 147 {
 148         return try_module_get(tmpl->module);
 149 }
 150
 151 static inline void crypto_tmpl_put(struct crypto_template *tmpl)
 152 {
 153         module_put(tmpl->module);
 154 }
 155
 156 static inline int crypto_is_larval(struct crypto_alg *alg)
 157 {
 158         return alg->cra_flags & CRYPTO_ALG_LARVAL;
 159 }
 160
 161 static inline int crypto_is_dead(struct crypto_alg *alg)
 162 {
 163         return alg->cra_flags & CRYPTO_ALG_DEAD;
 164 }
 165
 166 static inline int crypto_is_moribund(struct crypto_alg *alg)
 167 {
 168         return alg->cra_flags & (CRYPTO_ALG_DEAD | CRYPTO_ALG_DYING);
 169 }
 170
 171 static inline void crypto_notify(unsigned long val, void *v)
 172 {
 173         blocking_notifier_call_chain(&crypto_chain, val, v);
 174 }
 175
 176 static inline void crypto_yield(u32 flags)
 177 {
 178         if (flags & CRYPTO_TFM_REQ_MAY_SLEEP)
 179                 cond_resched();
 180 }
 181
 182 static inline int crypto_is_test_larval(struct crypto_larval *larval)
 183 {
 184         return larval->alg.cra_driver_name[0];
 185 }
 186
 187 #endif  /* _CRYPTO_INTERNAL_H */
 188