blk-crypto: rename keyslot-manager files to blk-crypto-profile
authorEric Biggers <ebiggers@google.com>
Mon, 18 Oct 2021 18:04:51 +0000 (11:04 -0700)
committerJens Axboe <axboe@kernel.dk>
Thu, 21 Oct 2021 16:49:32 +0000 (10:49 -0600)
In preparation for renaming struct blk_keyslot_manager to struct
blk_crypto_profile, rename the keyslot-manager.h and keyslot-manager.c
source files.  Renaming these files separately before making a lot of
changes to their contents makes it easier for git to understand that
they were renamed.

Acked-by: Ulf Hansson <ulf.hansson@linaro.org> # For MMC
Reviewed-by: Christoph Hellwig <hch@lst.de>
Reviewed-by: Mike Snitzer <snitzer@redhat.com>
Reviewed-by: Martin K. Petersen <martin.petersen@oracle.com>
Signed-off-by: Eric Biggers <ebiggers@google.com>
Link: https://lore.kernel.org/r/20211018180453.40441-3-ebiggers@kernel.org
Signed-off-by: Jens Axboe <axboe@kernel.dk>
12 files changed:
block/Makefile
block/blk-crypto-fallback.c
block/blk-crypto-profile.c [new file with mode: 0644]
block/blk-crypto.c
block/keyslot-manager.c [deleted file]
drivers/md/dm-core.h
drivers/md/dm.c
drivers/mmc/host/cqhci-crypto.c
drivers/scsi/ufs/ufshcd.h
include/linux/blk-crypto-profile.h [new file with mode: 0644]
include/linux/keyslot-manager.h [deleted file]
include/linux/mmc/host.h

index 74df168729ecb944763181f3eeae9e43b0c1ed8d..602f7f47b7b6d99ebcb28ba4fcc8bdbf98ed92b5 100644 (file)
@@ -36,6 +36,6 @@ obj-$(CONFIG_BLK_DEBUG_FS)    += blk-mq-debugfs.o
 obj-$(CONFIG_BLK_DEBUG_FS_ZONED)+= blk-mq-debugfs-zoned.o
 obj-$(CONFIG_BLK_SED_OPAL)     += sed-opal.o
 obj-$(CONFIG_BLK_PM)           += blk-pm.o
-obj-$(CONFIG_BLK_INLINE_ENCRYPTION)    += keyslot-manager.o blk-crypto.o
+obj-$(CONFIG_BLK_INLINE_ENCRYPTION)    += blk-crypto.o blk-crypto-profile.o
 obj-$(CONFIG_BLK_INLINE_ENCRYPTION_FALLBACK)   += blk-crypto-fallback.o
 obj-$(CONFIG_BLOCK_HOLDER_DEPRECATED)  += holder.o
index 1bcc1a1514248efe7c9e31f18cfca6833b7b29e1..08bfea292c754c98d9b2269e9f556961f6cc10da 100644 (file)
@@ -12,9 +12,9 @@
 #include <crypto/skcipher.h>
 #include <linux/blk-cgroup.h>
 #include <linux/blk-crypto.h>
+#include <linux/blk-crypto-profile.h>
 #include <linux/blkdev.h>
 #include <linux/crypto.h>
-#include <linux/keyslot-manager.h>
 #include <linux/mempool.h>
 #include <linux/module.h>
 #include <linux/random.h>
diff --git a/block/blk-crypto-profile.c b/block/blk-crypto-profile.c
new file mode 100644 (file)
index 0000000..1a235fa
--- /dev/null
@@ -0,0 +1,579 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * Copyright 2019 Google LLC
+ */
+
+/**
+ * DOC: The Keyslot Manager
+ *
+ * Many devices with inline encryption support have a limited number of "slots"
+ * into which encryption contexts may be programmed, and requests can be tagged
+ * with a slot number to specify the key to use for en/decryption.
+ *
+ * As the number of slots is limited, and programming keys is expensive on
+ * many inline encryption hardware, we don't want to program the same key into
+ * multiple slots - if multiple requests are using the same key, we want to
+ * program just one slot with that key and use that slot for all requests.
+ *
+ * The keyslot manager manages these keyslots appropriately, and also acts as
+ * an abstraction between the inline encryption hardware and the upper layers.
+ *
+ * Lower layer devices will set up a keyslot manager in their request queue
+ * and tell it how to perform device specific operations like programming/
+ * evicting keys from keyslots.
+ *
+ * Upper layers will call blk_ksm_get_slot_for_key() to program a
+ * key into some slot in the inline encryption hardware.
+ */
+
+#define pr_fmt(fmt) "blk-crypto: " fmt
+
+#include <linux/blk-crypto-profile.h>
+#include <linux/device.h>
+#include <linux/atomic.h>
+#include <linux/mutex.h>
+#include <linux/pm_runtime.h>
+#include <linux/wait.h>
+#include <linux/blkdev.h>
+#include <linux/blk-integrity.h>
+
+struct blk_ksm_keyslot {
+       atomic_t slot_refs;
+       struct list_head idle_slot_node;
+       struct hlist_node hash_node;
+       const struct blk_crypto_key *key;
+       struct blk_keyslot_manager *ksm;
+};
+
+static inline void blk_ksm_hw_enter(struct blk_keyslot_manager *ksm)
+{
+       /*
+        * Calling into the driver requires ksm->lock held and the device
+        * resumed.  But we must resume the device first, since that can acquire
+        * and release ksm->lock via blk_ksm_reprogram_all_keys().
+        */
+       if (ksm->dev)
+               pm_runtime_get_sync(ksm->dev);
+       down_write(&ksm->lock);
+}
+
+static inline void blk_ksm_hw_exit(struct blk_keyslot_manager *ksm)
+{
+       up_write(&ksm->lock);
+       if (ksm->dev)
+               pm_runtime_put_sync(ksm->dev);
+}
+
+static inline bool blk_ksm_is_passthrough(struct blk_keyslot_manager *ksm)
+{
+       return ksm->num_slots == 0;
+}
+
+/**
+ * blk_ksm_init() - Initialize a keyslot manager
+ * @ksm: The keyslot_manager to initialize.
+ * @num_slots: The number of key slots to manage.
+ *
+ * Allocate memory for keyslots and initialize a keyslot manager. Called by
+ * e.g. storage drivers to set up a keyslot manager in their request_queue.
+ *
+ * Return: 0 on success, or else a negative error code.
+ */
+int blk_ksm_init(struct blk_keyslot_manager *ksm, unsigned int num_slots)
+{
+       unsigned int slot;
+       unsigned int i;
+       unsigned int slot_hashtable_size;
+
+       memset(ksm, 0, sizeof(*ksm));
+
+       if (num_slots == 0)
+               return -EINVAL;
+
+       ksm->slots = kvcalloc(num_slots, sizeof(ksm->slots[0]), GFP_KERNEL);
+       if (!ksm->slots)
+               return -ENOMEM;
+
+       ksm->num_slots = num_slots;
+
+       init_rwsem(&ksm->lock);
+
+       init_waitqueue_head(&ksm->idle_slots_wait_queue);
+       INIT_LIST_HEAD(&ksm->idle_slots);
+
+       for (slot = 0; slot < num_slots; slot++) {
+               ksm->slots[slot].ksm = ksm;
+               list_add_tail(&ksm->slots[slot].idle_slot_node,
+                             &ksm->idle_slots);
+       }
+
+       spin_lock_init(&ksm->idle_slots_lock);
+
+       slot_hashtable_size = roundup_pow_of_two(num_slots);
+       /*
+        * hash_ptr() assumes bits != 0, so ensure the hash table has at least 2
+        * buckets.  This only makes a difference when there is only 1 keyslot.
+        */
+       if (slot_hashtable_size < 2)
+               slot_hashtable_size = 2;
+
+       ksm->log_slot_ht_size = ilog2(slot_hashtable_size);
+       ksm->slot_hashtable = kvmalloc_array(slot_hashtable_size,
+                                            sizeof(ksm->slot_hashtable[0]),
+                                            GFP_KERNEL);
+       if (!ksm->slot_hashtable)
+               goto err_destroy_ksm;
+       for (i = 0; i < slot_hashtable_size; i++)
+               INIT_HLIST_HEAD(&ksm->slot_hashtable[i]);
+
+       return 0;
+
+err_destroy_ksm:
+       blk_ksm_destroy(ksm);
+       return -ENOMEM;
+}
+EXPORT_SYMBOL_GPL(blk_ksm_init);
+
+static void blk_ksm_destroy_callback(void *ksm)
+{
+       blk_ksm_destroy(ksm);
+}
+
+/**
+ * devm_blk_ksm_init() - Resource-managed blk_ksm_init()
+ * @dev: The device which owns the blk_keyslot_manager.
+ * @ksm: The blk_keyslot_manager to initialize.
+ * @num_slots: The number of key slots to manage.
+ *
+ * Like blk_ksm_init(), but causes blk_ksm_destroy() to be called automatically
+ * on driver detach.
+ *
+ * Return: 0 on success, or else a negative error code.
+ */
+int devm_blk_ksm_init(struct device *dev, struct blk_keyslot_manager *ksm,
+                     unsigned int num_slots)
+{
+       int err = blk_ksm_init(ksm, num_slots);
+
+       if (err)
+               return err;
+
+       return devm_add_action_or_reset(dev, blk_ksm_destroy_callback, ksm);
+}
+EXPORT_SYMBOL_GPL(devm_blk_ksm_init);
+
+static inline struct hlist_head *
+blk_ksm_hash_bucket_for_key(struct blk_keyslot_manager *ksm,
+                           const struct blk_crypto_key *key)
+{
+       return &ksm->slot_hashtable[hash_ptr(key, ksm->log_slot_ht_size)];
+}
+
+static void blk_ksm_remove_slot_from_lru_list(struct blk_ksm_keyslot *slot)
+{
+       struct blk_keyslot_manager *ksm = slot->ksm;
+       unsigned long flags;
+
+       spin_lock_irqsave(&ksm->idle_slots_lock, flags);
+       list_del(&slot->idle_slot_node);
+       spin_unlock_irqrestore(&ksm->idle_slots_lock, flags);
+}
+
+static struct blk_ksm_keyslot *blk_ksm_find_keyslot(
+                                       struct blk_keyslot_manager *ksm,
+                                       const struct blk_crypto_key *key)
+{
+       const struct hlist_head *head = blk_ksm_hash_bucket_for_key(ksm, key);
+       struct blk_ksm_keyslot *slotp;
+
+       hlist_for_each_entry(slotp, head, hash_node) {
+               if (slotp->key == key)
+                       return slotp;
+       }
+       return NULL;
+}
+
+static struct blk_ksm_keyslot *blk_ksm_find_and_grab_keyslot(
+                                       struct blk_keyslot_manager *ksm,
+                                       const struct blk_crypto_key *key)
+{
+       struct blk_ksm_keyslot *slot;
+
+       slot = blk_ksm_find_keyslot(ksm, key);
+       if (!slot)
+               return NULL;
+       if (atomic_inc_return(&slot->slot_refs) == 1) {
+               /* Took first reference to this slot; remove it from LRU list */
+               blk_ksm_remove_slot_from_lru_list(slot);
+       }
+       return slot;
+}
+
+unsigned int blk_ksm_get_slot_idx(struct blk_ksm_keyslot *slot)
+{
+       return slot - slot->ksm->slots;
+}
+EXPORT_SYMBOL_GPL(blk_ksm_get_slot_idx);
+
+/**
+ * blk_ksm_get_slot_for_key() - Program a key into a keyslot.
+ * @ksm: The keyslot manager to program the key into.
+ * @key: Pointer to the key object to program, including the raw key, crypto
+ *      mode, and data unit size.
+ * @slot_ptr: A pointer to return the pointer of the allocated keyslot.
+ *
+ * Get a keyslot that's been programmed with the specified key.  If one already
+ * exists, return it with incremented refcount.  Otherwise, wait for a keyslot
+ * to become idle and program it.
+ *
+ * Context: Process context. Takes and releases ksm->lock.
+ * Return: BLK_STS_OK on success (and keyslot is set to the pointer of the
+ *        allocated keyslot), or some other blk_status_t otherwise (and
+ *        keyslot is set to NULL).
+ */
+blk_status_t blk_ksm_get_slot_for_key(struct blk_keyslot_manager *ksm,
+                                     const struct blk_crypto_key *key,
+                                     struct blk_ksm_keyslot **slot_ptr)
+{
+       struct blk_ksm_keyslot *slot;
+       int slot_idx;
+       int err;
+
+       *slot_ptr = NULL;
+
+       if (blk_ksm_is_passthrough(ksm))
+               return BLK_STS_OK;
+
+       down_read(&ksm->lock);
+       slot = blk_ksm_find_and_grab_keyslot(ksm, key);
+       up_read(&ksm->lock);
+       if (slot)
+               goto success;
+
+       for (;;) {
+               blk_ksm_hw_enter(ksm);
+               slot = blk_ksm_find_and_grab_keyslot(ksm, key);
+               if (slot) {
+                       blk_ksm_hw_exit(ksm);
+                       goto success;
+               }
+
+               /*
+                * If we're here, that means there wasn't a slot that was
+                * already programmed with the key. So try to program it.
+                */
+               if (!list_empty(&ksm->idle_slots))
+                       break;
+
+               blk_ksm_hw_exit(ksm);
+               wait_event(ksm->idle_slots_wait_queue,
+                          !list_empty(&ksm->idle_slots));
+       }
+
+       slot = list_first_entry(&ksm->idle_slots, struct blk_ksm_keyslot,
+                               idle_slot_node);
+       slot_idx = blk_ksm_get_slot_idx(slot);
+
+       err = ksm->ksm_ll_ops.keyslot_program(ksm, key, slot_idx);
+       if (err) {
+               wake_up(&ksm->idle_slots_wait_queue);
+               blk_ksm_hw_exit(ksm);
+               return errno_to_blk_status(err);
+       }
+
+       /* Move this slot to the hash list for the new key. */
+       if (slot->key)
+               hlist_del(&slot->hash_node);
+       slot->key = key;
+       hlist_add_head(&slot->hash_node, blk_ksm_hash_bucket_for_key(ksm, key));
+
+       atomic_set(&slot->slot_refs, 1);
+
+       blk_ksm_remove_slot_from_lru_list(slot);
+
+       blk_ksm_hw_exit(ksm);
+success:
+       *slot_ptr = slot;
+       return BLK_STS_OK;
+}
+
+/**
+ * blk_ksm_put_slot() - Release a reference to a slot
+ * @slot: The keyslot to release the reference of.
+ *
+ * Context: Any context.
+ */
+void blk_ksm_put_slot(struct blk_ksm_keyslot *slot)
+{
+       struct blk_keyslot_manager *ksm;
+       unsigned long flags;
+
+       if (!slot)
+               return;
+
+       ksm = slot->ksm;
+
+       if (atomic_dec_and_lock_irqsave(&slot->slot_refs,
+                                       &ksm->idle_slots_lock, flags)) {
+               list_add_tail(&slot->idle_slot_node, &ksm->idle_slots);
+               spin_unlock_irqrestore(&ksm->idle_slots_lock, flags);
+               wake_up(&ksm->idle_slots_wait_queue);
+       }
+}
+
+/**
+ * blk_ksm_crypto_cfg_supported() - Find out if a crypto configuration is
+ *                                 supported by a ksm.
+ * @ksm: The keyslot manager to check
+ * @cfg: The crypto configuration to check for.
+ *
+ * Checks for crypto_mode/data unit size/dun bytes support.
+ *
+ * Return: Whether or not this ksm supports the specified crypto config.
+ */
+bool blk_ksm_crypto_cfg_supported(struct blk_keyslot_manager *ksm,
+                                 const struct blk_crypto_config *cfg)
+{
+       if (!ksm)
+               return false;
+       if (!(ksm->crypto_modes_supported[cfg->crypto_mode] &
+             cfg->data_unit_size))
+               return false;
+       if (ksm->max_dun_bytes_supported < cfg->dun_bytes)
+               return false;
+       return true;
+}
+
+/**
+ * blk_ksm_evict_key() - Evict a key from the lower layer device.
+ * @ksm: The keyslot manager to evict from
+ * @key: The key to evict
+ *
+ * Find the keyslot that the specified key was programmed into, and evict that
+ * slot from the lower layer device. The slot must not be in use by any
+ * in-flight IO when this function is called.
+ *
+ * Context: Process context. Takes and releases ksm->lock.
+ * Return: 0 on success or if there's no keyslot with the specified key, -EBUSY
+ *        if the keyslot is still in use, or another -errno value on other
+ *        error.
+ */
+int blk_ksm_evict_key(struct blk_keyslot_manager *ksm,
+                     const struct blk_crypto_key *key)
+{
+       struct blk_ksm_keyslot *slot;
+       int err = 0;
+
+       if (blk_ksm_is_passthrough(ksm)) {
+               if (ksm->ksm_ll_ops.keyslot_evict) {
+                       blk_ksm_hw_enter(ksm);
+                       err = ksm->ksm_ll_ops.keyslot_evict(ksm, key, -1);
+                       blk_ksm_hw_exit(ksm);
+                       return err;
+               }
+               return 0;
+       }
+
+       blk_ksm_hw_enter(ksm);
+       slot = blk_ksm_find_keyslot(ksm, key);
+       if (!slot)
+               goto out_unlock;
+
+       if (WARN_ON_ONCE(atomic_read(&slot->slot_refs) != 0)) {
+               err = -EBUSY;
+               goto out_unlock;
+       }
+       err = ksm->ksm_ll_ops.keyslot_evict(ksm, key,
+                                           blk_ksm_get_slot_idx(slot));
+       if (err)
+               goto out_unlock;
+
+       hlist_del(&slot->hash_node);
+       slot->key = NULL;
+       err = 0;
+out_unlock:
+       blk_ksm_hw_exit(ksm);
+       return err;
+}
+
+/**
+ * blk_ksm_reprogram_all_keys() - Re-program all keyslots.
+ * @ksm: The keyslot manager
+ *
+ * Re-program all keyslots that are supposed to have a key programmed.  This is
+ * intended only for use by drivers for hardware that loses its keys on reset.
+ *
+ * Context: Process context. Takes and releases ksm->lock.
+ */
+void blk_ksm_reprogram_all_keys(struct blk_keyslot_manager *ksm)
+{
+       unsigned int slot;
+
+       if (blk_ksm_is_passthrough(ksm))
+               return;
+
+       /* This is for device initialization, so don't resume the device */
+       down_write(&ksm->lock);
+       for (slot = 0; slot < ksm->num_slots; slot++) {
+               const struct blk_crypto_key *key = ksm->slots[slot].key;
+               int err;
+
+               if (!key)
+                       continue;
+
+               err = ksm->ksm_ll_ops.keyslot_program(ksm, key, slot);
+               WARN_ON(err);
+       }
+       up_write(&ksm->lock);
+}
+EXPORT_SYMBOL_GPL(blk_ksm_reprogram_all_keys);
+
+void blk_ksm_destroy(struct blk_keyslot_manager *ksm)
+{
+       if (!ksm)
+               return;
+       kvfree(ksm->slot_hashtable);
+       kvfree_sensitive(ksm->slots, sizeof(ksm->slots[0]) * ksm->num_slots);
+       memzero_explicit(ksm, sizeof(*ksm));
+}
+EXPORT_SYMBOL_GPL(blk_ksm_destroy);
+
+bool blk_ksm_register(struct blk_keyslot_manager *ksm, struct request_queue *q)
+{
+       if (blk_integrity_queue_supports_integrity(q)) {
+               pr_warn("Integrity and hardware inline encryption are not supported together. Disabling hardware inline encryption.\n");
+               return false;
+       }
+       q->ksm = ksm;
+       return true;
+}
+EXPORT_SYMBOL_GPL(blk_ksm_register);
+
+void blk_ksm_unregister(struct request_queue *q)
+{
+       q->ksm = NULL;
+}
+
+/**
+ * blk_ksm_intersect_modes() - restrict supported modes by child device
+ * @parent: The keyslot manager for parent device
+ * @child: The keyslot manager for child device, or NULL
+ *
+ * Clear any crypto mode support bits in @parent that aren't set in @child.
+ * If @child is NULL, then all parent bits are cleared.
+ *
+ * Only use this when setting up the keyslot manager for a layered device,
+ * before it's been exposed yet.
+ */
+void blk_ksm_intersect_modes(struct blk_keyslot_manager *parent,
+                            const struct blk_keyslot_manager *child)
+{
+       if (child) {
+               unsigned int i;
+
+               parent->max_dun_bytes_supported =
+                       min(parent->max_dun_bytes_supported,
+                           child->max_dun_bytes_supported);
+               for (i = 0; i < ARRAY_SIZE(child->crypto_modes_supported);
+                    i++) {
+                       parent->crypto_modes_supported[i] &=
+                               child->crypto_modes_supported[i];
+               }
+       } else {
+               parent->max_dun_bytes_supported = 0;
+               memset(parent->crypto_modes_supported, 0,
+                      sizeof(parent->crypto_modes_supported));
+       }
+}
+EXPORT_SYMBOL_GPL(blk_ksm_intersect_modes);
+
+/**
+ * blk_ksm_is_superset() - Check if a KSM supports a superset of crypto modes
+ *                        and DUN bytes that another KSM supports. Here,
+ *                        "superset" refers to the mathematical meaning of the
+ *                        word - i.e. if two KSMs have the *same* capabilities,
+ *                        they *are* considered supersets of each other.
+ * @ksm_superset: The KSM that we want to verify is a superset
+ * @ksm_subset: The KSM that we want to verify is a subset
+ *
+ * Return: True if @ksm_superset supports a superset of the crypto modes and DUN
+ *        bytes that @ksm_subset supports.
+ */
+bool blk_ksm_is_superset(struct blk_keyslot_manager *ksm_superset,
+                        struct blk_keyslot_manager *ksm_subset)
+{
+       int i;
+
+       if (!ksm_subset)
+               return true;
+
+       if (!ksm_superset)
+               return false;
+
+       for (i = 0; i < ARRAY_SIZE(ksm_superset->crypto_modes_supported); i++) {
+               if (ksm_subset->crypto_modes_supported[i] &
+                   (~ksm_superset->crypto_modes_supported[i])) {
+                       return false;
+               }
+       }
+
+       if (ksm_subset->max_dun_bytes_supported >
+           ksm_superset->max_dun_bytes_supported) {
+               return false;
+       }
+
+       return true;
+}
+EXPORT_SYMBOL_GPL(blk_ksm_is_superset);
+
+/**
+ * blk_ksm_update_capabilities() - Update the restrictions of a KSM to those of
+ *                                another KSM
+ * @target_ksm: The KSM whose restrictions to update.
+ * @reference_ksm: The KSM to whose restrictions this function will update
+ *                @target_ksm's restrictions to.
+ *
+ * Blk-crypto requires that crypto capabilities that were
+ * advertised when a bio was created continue to be supported by the
+ * device until that bio is ended. This is turn means that a device cannot
+ * shrink its advertised crypto capabilities without any explicit
+ * synchronization with upper layers. So if there's no such explicit
+ * synchronization, @reference_ksm must support all the crypto capabilities that
+ * @target_ksm does
+ * (i.e. we need blk_ksm_is_superset(@reference_ksm, @target_ksm) == true).
+ *
+ * Note also that as long as the crypto capabilities are being expanded, the
+ * order of updates becoming visible is not important because it's alright
+ * for blk-crypto to see stale values - they only cause blk-crypto to
+ * believe that a crypto capability isn't supported when it actually is (which
+ * might result in blk-crypto-fallback being used if available, or the bio being
+ * failed).
+ */
+void blk_ksm_update_capabilities(struct blk_keyslot_manager *target_ksm,
+                                struct blk_keyslot_manager *reference_ksm)
+{
+       memcpy(target_ksm->crypto_modes_supported,
+              reference_ksm->crypto_modes_supported,
+              sizeof(target_ksm->crypto_modes_supported));
+
+       target_ksm->max_dun_bytes_supported =
+                               reference_ksm->max_dun_bytes_supported;
+}
+EXPORT_SYMBOL_GPL(blk_ksm_update_capabilities);
+
+/**
+ * blk_ksm_init_passthrough() - Init a passthrough keyslot manager
+ * @ksm: The keyslot manager to init
+ *
+ * Initialize a passthrough keyslot manager.
+ * Called by e.g. storage drivers to set up a keyslot manager in their
+ * request_queue, when the storage driver wants to manage its keys by itself.
+ * This is useful for inline encryption hardware that doesn't have the concept
+ * of keyslots, and for layered devices.
+ */
+void blk_ksm_init_passthrough(struct blk_keyslot_manager *ksm)
+{
+       memset(ksm, 0, sizeof(*ksm));
+       init_rwsem(&ksm->lock);
+}
+EXPORT_SYMBOL_GPL(blk_ksm_init_passthrough);
index 8f53f4a1f9e2d6a1b2e1616a12b9415e63936ef8..76ce7a5d2676b19dc6a2298625b020449102fb6e 100644 (file)
@@ -11,7 +11,7 @@
 
 #include <linux/bio.h>
 #include <linux/blkdev.h>
-#include <linux/keyslot-manager.h>
+#include <linux/blk-crypto-profile.h>
 #include <linux/module.h>
 #include <linux/slab.h>
 
diff --git a/block/keyslot-manager.c b/block/keyslot-manager.c
deleted file mode 100644 (file)
index 1792159..0000000
+++ /dev/null
@@ -1,579 +0,0 @@
-// SPDX-License-Identifier: GPL-2.0
-/*
- * Copyright 2019 Google LLC
- */
-
-/**
- * DOC: The Keyslot Manager
- *
- * Many devices with inline encryption support have a limited number of "slots"
- * into which encryption contexts may be programmed, and requests can be tagged
- * with a slot number to specify the key to use for en/decryption.
- *
- * As the number of slots is limited, and programming keys is expensive on
- * many inline encryption hardware, we don't want to program the same key into
- * multiple slots - if multiple requests are using the same key, we want to
- * program just one slot with that key and use that slot for all requests.
- *
- * The keyslot manager manages these keyslots appropriately, and also acts as
- * an abstraction between the inline encryption hardware and the upper layers.
- *
- * Lower layer devices will set up a keyslot manager in their request queue
- * and tell it how to perform device specific operations like programming/
- * evicting keys from keyslots.
- *
- * Upper layers will call blk_ksm_get_slot_for_key() to program a
- * key into some slot in the inline encryption hardware.
- */
-
-#define pr_fmt(fmt) "blk-crypto: " fmt
-
-#include <linux/keyslot-manager.h>
-#include <linux/device.h>
-#include <linux/atomic.h>
-#include <linux/mutex.h>
-#include <linux/pm_runtime.h>
-#include <linux/wait.h>
-#include <linux/blkdev.h>
-#include <linux/blk-integrity.h>
-
-struct blk_ksm_keyslot {
-       atomic_t slot_refs;
-       struct list_head idle_slot_node;
-       struct hlist_node hash_node;
-       const struct blk_crypto_key *key;
-       struct blk_keyslot_manager *ksm;
-};
-
-static inline void blk_ksm_hw_enter(struct blk_keyslot_manager *ksm)
-{
-       /*
-        * Calling into the driver requires ksm->lock held and the device
-        * resumed.  But we must resume the device first, since that can acquire
-        * and release ksm->lock via blk_ksm_reprogram_all_keys().
-        */
-       if (ksm->dev)
-               pm_runtime_get_sync(ksm->dev);
-       down_write(&ksm->lock);
-}
-
-static inline void blk_ksm_hw_exit(struct blk_keyslot_manager *ksm)
-{
-       up_write(&ksm->lock);
-       if (ksm->dev)
-               pm_runtime_put_sync(ksm->dev);
-}
-
-static inline bool blk_ksm_is_passthrough(struct blk_keyslot_manager *ksm)
-{
-       return ksm->num_slots == 0;
-}
-
-/**
- * blk_ksm_init() - Initialize a keyslot manager
- * @ksm: The keyslot_manager to initialize.
- * @num_slots: The number of key slots to manage.
- *
- * Allocate memory for keyslots and initialize a keyslot manager. Called by
- * e.g. storage drivers to set up a keyslot manager in their request_queue.
- *
- * Return: 0 on success, or else a negative error code.
- */
-int blk_ksm_init(struct blk_keyslot_manager *ksm, unsigned int num_slots)
-{
-       unsigned int slot;
-       unsigned int i;
-       unsigned int slot_hashtable_size;
-
-       memset(ksm, 0, sizeof(*ksm));
-
-       if (num_slots == 0)
-               return -EINVAL;
-
-       ksm->slots = kvcalloc(num_slots, sizeof(ksm->slots[0]), GFP_KERNEL);
-       if (!ksm->slots)
-               return -ENOMEM;
-
-       ksm->num_slots = num_slots;
-
-       init_rwsem(&ksm->lock);
-
-       init_waitqueue_head(&ksm->idle_slots_wait_queue);
-       INIT_LIST_HEAD(&ksm->idle_slots);
-
-       for (slot = 0; slot < num_slots; slot++) {
-               ksm->slots[slot].ksm = ksm;
-               list_add_tail(&ksm->slots[slot].idle_slot_node,
-                             &ksm->idle_slots);
-       }
-
-       spin_lock_init(&ksm->idle_slots_lock);
-
-       slot_hashtable_size = roundup_pow_of_two(num_slots);
-       /*
-        * hash_ptr() assumes bits != 0, so ensure the hash table has at least 2
-        * buckets.  This only makes a difference when there is only 1 keyslot.
-        */
-       if (slot_hashtable_size < 2)
-               slot_hashtable_size = 2;
-
-       ksm->log_slot_ht_size = ilog2(slot_hashtable_size);
-       ksm->slot_hashtable = kvmalloc_array(slot_hashtable_size,
-                                            sizeof(ksm->slot_hashtable[0]),
-                                            GFP_KERNEL);
-       if (!ksm->slot_hashtable)
-               goto err_destroy_ksm;
-       for (i = 0; i < slot_hashtable_size; i++)
-               INIT_HLIST_HEAD(&ksm->slot_hashtable[i]);
-
-       return 0;
-
-err_destroy_ksm:
-       blk_ksm_destroy(ksm);
-       return -ENOMEM;
-}
-EXPORT_SYMBOL_GPL(blk_ksm_init);
-
-static void blk_ksm_destroy_callback(void *ksm)
-{
-       blk_ksm_destroy(ksm);
-}
-
-/**
- * devm_blk_ksm_init() - Resource-managed blk_ksm_init()
- * @dev: The device which owns the blk_keyslot_manager.
- * @ksm: The blk_keyslot_manager to initialize.
- * @num_slots: The number of key slots to manage.
- *
- * Like blk_ksm_init(), but causes blk_ksm_destroy() to be called automatically
- * on driver detach.
- *
- * Return: 0 on success, or else a negative error code.
- */
-int devm_blk_ksm_init(struct device *dev, struct blk_keyslot_manager *ksm,
-                     unsigned int num_slots)
-{
-       int err = blk_ksm_init(ksm, num_slots);
-
-       if (err)
-               return err;
-
-       return devm_add_action_or_reset(dev, blk_ksm_destroy_callback, ksm);
-}
-EXPORT_SYMBOL_GPL(devm_blk_ksm_init);
-
-static inline struct hlist_head *
-blk_ksm_hash_bucket_for_key(struct blk_keyslot_manager *ksm,
-                           const struct blk_crypto_key *key)
-{
-       return &ksm->slot_hashtable[hash_ptr(key, ksm->log_slot_ht_size)];
-}
-
-static void blk_ksm_remove_slot_from_lru_list(struct blk_ksm_keyslot *slot)
-{
-       struct blk_keyslot_manager *ksm = slot->ksm;
-       unsigned long flags;
-
-       spin_lock_irqsave(&ksm->idle_slots_lock, flags);
-       list_del(&slot->idle_slot_node);
-       spin_unlock_irqrestore(&ksm->idle_slots_lock, flags);
-}
-
-static struct blk_ksm_keyslot *blk_ksm_find_keyslot(
-                                       struct blk_keyslot_manager *ksm,
-                                       const struct blk_crypto_key *key)
-{
-       const struct hlist_head *head = blk_ksm_hash_bucket_for_key(ksm, key);
-       struct blk_ksm_keyslot *slotp;
-
-       hlist_for_each_entry(slotp, head, hash_node) {
-               if (slotp->key == key)
-                       return slotp;
-       }
-       return NULL;
-}
-
-static struct blk_ksm_keyslot *blk_ksm_find_and_grab_keyslot(
-                                       struct blk_keyslot_manager *ksm,
-                                       const struct blk_crypto_key *key)
-{
-       struct blk_ksm_keyslot *slot;
-
-       slot = blk_ksm_find_keyslot(ksm, key);
-       if (!slot)
-               return NULL;
-       if (atomic_inc_return(&slot->slot_refs) == 1) {
-               /* Took first reference to this slot; remove it from LRU list */
-               blk_ksm_remove_slot_from_lru_list(slot);
-       }
-       return slot;
-}
-
-unsigned int blk_ksm_get_slot_idx(struct blk_ksm_keyslot *slot)
-{
-       return slot - slot->ksm->slots;
-}
-EXPORT_SYMBOL_GPL(blk_ksm_get_slot_idx);
-
-/**
- * blk_ksm_get_slot_for_key() - Program a key into a keyslot.
- * @ksm: The keyslot manager to program the key into.
- * @key: Pointer to the key object to program, including the raw key, crypto
- *      mode, and data unit size.
- * @slot_ptr: A pointer to return the pointer of the allocated keyslot.
- *
- * Get a keyslot that's been programmed with the specified key.  If one already
- * exists, return it with incremented refcount.  Otherwise, wait for a keyslot
- * to become idle and program it.
- *
- * Context: Process context. Takes and releases ksm->lock.
- * Return: BLK_STS_OK on success (and keyslot is set to the pointer of the
- *        allocated keyslot), or some other blk_status_t otherwise (and
- *        keyslot is set to NULL).
- */
-blk_status_t blk_ksm_get_slot_for_key(struct blk_keyslot_manager *ksm,
-                                     const struct blk_crypto_key *key,
-                                     struct blk_ksm_keyslot **slot_ptr)
-{
-       struct blk_ksm_keyslot *slot;
-       int slot_idx;
-       int err;
-
-       *slot_ptr = NULL;
-
-       if (blk_ksm_is_passthrough(ksm))
-               return BLK_STS_OK;
-
-       down_read(&ksm->lock);
-       slot = blk_ksm_find_and_grab_keyslot(ksm, key);
-       up_read(&ksm->lock);
-       if (slot)
-               goto success;
-
-       for (;;) {
-               blk_ksm_hw_enter(ksm);
-               slot = blk_ksm_find_and_grab_keyslot(ksm, key);
-               if (slot) {
-                       blk_ksm_hw_exit(ksm);
-                       goto success;
-               }
-
-               /*
-                * If we're here, that means there wasn't a slot that was
-                * already programmed with the key. So try to program it.
-                */
-               if (!list_empty(&ksm->idle_slots))
-                       break;
-
-               blk_ksm_hw_exit(ksm);
-               wait_event(ksm->idle_slots_wait_queue,
-                          !list_empty(&ksm->idle_slots));
-       }
-
-       slot = list_first_entry(&ksm->idle_slots, struct blk_ksm_keyslot,
-                               idle_slot_node);
-       slot_idx = blk_ksm_get_slot_idx(slot);
-
-       err = ksm->ksm_ll_ops.keyslot_program(ksm, key, slot_idx);
-       if (err) {
-               wake_up(&ksm->idle_slots_wait_queue);
-               blk_ksm_hw_exit(ksm);
-               return errno_to_blk_status(err);
-       }
-
-       /* Move this slot to the hash list for the new key. */
-       if (slot->key)
-               hlist_del(&slot->hash_node);
-       slot->key = key;
-       hlist_add_head(&slot->hash_node, blk_ksm_hash_bucket_for_key(ksm, key));
-
-       atomic_set(&slot->slot_refs, 1);
-
-       blk_ksm_remove_slot_from_lru_list(slot);
-
-       blk_ksm_hw_exit(ksm);
-success:
-       *slot_ptr = slot;
-       return BLK_STS_OK;
-}
-
-/**
- * blk_ksm_put_slot() - Release a reference to a slot
- * @slot: The keyslot to release the reference of.
- *
- * Context: Any context.
- */
-void blk_ksm_put_slot(struct blk_ksm_keyslot *slot)
-{
-       struct blk_keyslot_manager *ksm;
-       unsigned long flags;
-
-       if (!slot)
-               return;
-
-       ksm = slot->ksm;
-
-       if (atomic_dec_and_lock_irqsave(&slot->slot_refs,
-                                       &ksm->idle_slots_lock, flags)) {
-               list_add_tail(&slot->idle_slot_node, &ksm->idle_slots);
-               spin_unlock_irqrestore(&ksm->idle_slots_lock, flags);
-               wake_up(&ksm->idle_slots_wait_queue);
-       }
-}
-
-/**
- * blk_ksm_crypto_cfg_supported() - Find out if a crypto configuration is
- *                                 supported by a ksm.
- * @ksm: The keyslot manager to check
- * @cfg: The crypto configuration to check for.
- *
- * Checks for crypto_mode/data unit size/dun bytes support.
- *
- * Return: Whether or not this ksm supports the specified crypto config.
- */
-bool blk_ksm_crypto_cfg_supported(struct blk_keyslot_manager *ksm,
-                                 const struct blk_crypto_config *cfg)
-{
-       if (!ksm)
-               return false;
-       if (!(ksm->crypto_modes_supported[cfg->crypto_mode] &
-             cfg->data_unit_size))
-               return false;
-       if (ksm->max_dun_bytes_supported < cfg->dun_bytes)
-               return false;
-       return true;
-}
-
-/**
- * blk_ksm_evict_key() - Evict a key from the lower layer device.
- * @ksm: The keyslot manager to evict from
- * @key: The key to evict
- *
- * Find the keyslot that the specified key was programmed into, and evict that
- * slot from the lower layer device. The slot must not be in use by any
- * in-flight IO when this function is called.
- *
- * Context: Process context. Takes and releases ksm->lock.
- * Return: 0 on success or if there's no keyslot with the specified key, -EBUSY
- *        if the keyslot is still in use, or another -errno value on other
- *        error.
- */
-int blk_ksm_evict_key(struct blk_keyslot_manager *ksm,
-                     const struct blk_crypto_key *key)
-{
-       struct blk_ksm_keyslot *slot;
-       int err = 0;
-
-       if (blk_ksm_is_passthrough(ksm)) {
-               if (ksm->ksm_ll_ops.keyslot_evict) {
-                       blk_ksm_hw_enter(ksm);
-                       err = ksm->ksm_ll_ops.keyslot_evict(ksm, key, -1);
-                       blk_ksm_hw_exit(ksm);
-                       return err;
-               }
-               return 0;
-       }
-
-       blk_ksm_hw_enter(ksm);
-       slot = blk_ksm_find_keyslot(ksm, key);
-       if (!slot)
-               goto out_unlock;
-
-       if (WARN_ON_ONCE(atomic_read(&slot->slot_refs) != 0)) {
-               err = -EBUSY;
-               goto out_unlock;
-       }
-       err = ksm->ksm_ll_ops.keyslot_evict(ksm, key,
-                                           blk_ksm_get_slot_idx(slot));
-       if (err)
-               goto out_unlock;
-
-       hlist_del(&slot->hash_node);
-       slot->key = NULL;
-       err = 0;
-out_unlock:
-       blk_ksm_hw_exit(ksm);
-       return err;
-}
-
-/**
- * blk_ksm_reprogram_all_keys() - Re-program all keyslots.
- * @ksm: The keyslot manager
- *
- * Re-program all keyslots that are supposed to have a key programmed.  This is
- * intended only for use by drivers for hardware that loses its keys on reset.
- *
- * Context: Process context. Takes and releases ksm->lock.
- */
-void blk_ksm_reprogram_all_keys(struct blk_keyslot_manager *ksm)
-{
-       unsigned int slot;
-
-       if (blk_ksm_is_passthrough(ksm))
-               return;
-
-       /* This is for device initialization, so don't resume the device */
-       down_write(&ksm->lock);
-       for (slot = 0; slot < ksm->num_slots; slot++) {
-               const struct blk_crypto_key *key = ksm->slots[slot].key;
-               int err;
-
-               if (!key)
-                       continue;
-
-               err = ksm->ksm_ll_ops.keyslot_program(ksm, key, slot);
-               WARN_ON(err);
-       }
-       up_write(&ksm->lock);
-}
-EXPORT_SYMBOL_GPL(blk_ksm_reprogram_all_keys);
-
-void blk_ksm_destroy(struct blk_keyslot_manager *ksm)
-{
-       if (!ksm)
-               return;
-       kvfree(ksm->slot_hashtable);
-       kvfree_sensitive(ksm->slots, sizeof(ksm->slots[0]) * ksm->num_slots);
-       memzero_explicit(ksm, sizeof(*ksm));
-}
-EXPORT_SYMBOL_GPL(blk_ksm_destroy);
-
-bool blk_ksm_register(struct blk_keyslot_manager *ksm, struct request_queue *q)
-{
-       if (blk_integrity_queue_supports_integrity(q)) {
-               pr_warn("Integrity and hardware inline encryption are not supported together. Disabling hardware inline encryption.\n");
-               return false;
-       }
-       q->ksm = ksm;
-       return true;
-}
-EXPORT_SYMBOL_GPL(blk_ksm_register);
-
-void blk_ksm_unregister(struct request_queue *q)
-{
-       q->ksm = NULL;
-}
-
-/**
- * blk_ksm_intersect_modes() - restrict supported modes by child device
- * @parent: The keyslot manager for parent device
- * @child: The keyslot manager for child device, or NULL
- *
- * Clear any crypto mode support bits in @parent that aren't set in @child.
- * If @child is NULL, then all parent bits are cleared.
- *
- * Only use this when setting up the keyslot manager for a layered device,
- * before it's been exposed yet.
- */
-void blk_ksm_intersect_modes(struct blk_keyslot_manager *parent,
-                            const struct blk_keyslot_manager *child)
-{
-       if (child) {
-               unsigned int i;
-
-               parent->max_dun_bytes_supported =
-                       min(parent->max_dun_bytes_supported,
-                           child->max_dun_bytes_supported);
-               for (i = 0; i < ARRAY_SIZE(child->crypto_modes_supported);
-                    i++) {
-                       parent->crypto_modes_supported[i] &=
-                               child->crypto_modes_supported[i];
-               }
-       } else {
-               parent->max_dun_bytes_supported = 0;
-               memset(parent->crypto_modes_supported, 0,
-                      sizeof(parent->crypto_modes_supported));
-       }
-}
-EXPORT_SYMBOL_GPL(blk_ksm_intersect_modes);
-
-/**
- * blk_ksm_is_superset() - Check if a KSM supports a superset of crypto modes
- *                        and DUN bytes that another KSM supports. Here,
- *                        "superset" refers to the mathematical meaning of the
- *                        word - i.e. if two KSMs have the *same* capabilities,
- *                        they *are* considered supersets of each other.
- * @ksm_superset: The KSM that we want to verify is a superset
- * @ksm_subset: The KSM that we want to verify is a subset
- *
- * Return: True if @ksm_superset supports a superset of the crypto modes and DUN
- *        bytes that @ksm_subset supports.
- */
-bool blk_ksm_is_superset(struct blk_keyslot_manager *ksm_superset,
-                        struct blk_keyslot_manager *ksm_subset)
-{
-       int i;
-
-       if (!ksm_subset)
-               return true;
-
-       if (!ksm_superset)
-               return false;
-
-       for (i = 0; i < ARRAY_SIZE(ksm_superset->crypto_modes_supported); i++) {
-               if (ksm_subset->crypto_modes_supported[i] &
-                   (~ksm_superset->crypto_modes_supported[i])) {
-                       return false;
-               }
-       }
-
-       if (ksm_subset->max_dun_bytes_supported >
-           ksm_superset->max_dun_bytes_supported) {
-               return false;
-       }
-
-       return true;
-}
-EXPORT_SYMBOL_GPL(blk_ksm_is_superset);
-
-/**
- * blk_ksm_update_capabilities() - Update the restrictions of a KSM to those of
- *                                another KSM
- * @target_ksm: The KSM whose restrictions to update.
- * @reference_ksm: The KSM to whose restrictions this function will update
- *                @target_ksm's restrictions to.
- *
- * Blk-crypto requires that crypto capabilities that were
- * advertised when a bio was created continue to be supported by the
- * device until that bio is ended. This is turn means that a device cannot
- * shrink its advertised crypto capabilities without any explicit
- * synchronization with upper layers. So if there's no such explicit
- * synchronization, @reference_ksm must support all the crypto capabilities that
- * @target_ksm does
- * (i.e. we need blk_ksm_is_superset(@reference_ksm, @target_ksm) == true).
- *
- * Note also that as long as the crypto capabilities are being expanded, the
- * order of updates becoming visible is not important because it's alright
- * for blk-crypto to see stale values - they only cause blk-crypto to
- * believe that a crypto capability isn't supported when it actually is (which
- * might result in blk-crypto-fallback being used if available, or the bio being
- * failed).
- */
-void blk_ksm_update_capabilities(struct blk_keyslot_manager *target_ksm,
-                                struct blk_keyslot_manager *reference_ksm)
-{
-       memcpy(target_ksm->crypto_modes_supported,
-              reference_ksm->crypto_modes_supported,
-              sizeof(target_ksm->crypto_modes_supported));
-
-       target_ksm->max_dun_bytes_supported =
-                               reference_ksm->max_dun_bytes_supported;
-}
-EXPORT_SYMBOL_GPL(blk_ksm_update_capabilities);
-
-/**
- * blk_ksm_init_passthrough() - Init a passthrough keyslot manager
- * @ksm: The keyslot manager to init
- *
- * Initialize a passthrough keyslot manager.
- * Called by e.g. storage drivers to set up a keyslot manager in their
- * request_queue, when the storage driver wants to manage its keys by itself.
- * This is useful for inline encryption hardware that doesn't have the concept
- * of keyslots, and for layered devices.
- */
-void blk_ksm_init_passthrough(struct blk_keyslot_manager *ksm)
-{
-       memset(ksm, 0, sizeof(*ksm));
-       init_rwsem(&ksm->lock);
-}
-EXPORT_SYMBOL_GPL(blk_ksm_init_passthrough);
index 55dccdfbcb22ee27e4098e6aeb5cbd07807c9614..841ed87999e793784df418b4503f3ef786f43202 100644 (file)
@@ -13,7 +13,7 @@
 #include <linux/ktime.h>
 #include <linux/genhd.h>
 #include <linux/blk-mq.h>
-#include <linux/keyslot-manager.h>
+#include <linux/blk-crypto-profile.h>
 
 #include <trace/events/block.h>
 
index 7870e6460633f85afcc28175c01e7ee2d48532c2..4184fd8ccb0849703c40512a6379d57d6e2296e9 100644 (file)
@@ -29,7 +29,7 @@
 #include <linux/refcount.h>
 #include <linux/part_stat.h>
 #include <linux/blk-crypto.h>
-#include <linux/keyslot-manager.h>
+#include <linux/blk-crypto-profile.h>
 
 #define DM_MSG_PREFIX "core"
 
index 6419cfbb4ab78b43eb5a710c99a4d422fb263dc9..628bbfaf831240b6e45077a6151f86d0a64bedb0 100644 (file)
@@ -6,7 +6,7 @@
  */
 
 #include <linux/blk-crypto.h>
-#include <linux/keyslot-manager.h>
+#include <linux/blk-crypto-profile.h>
 #include <linux/mmc/host.h>
 
 #include "cqhci-crypto.h"
index 41f6e06f91856469113e2e14f5e4639c935114df..885fcf2e592247662d15bd841fa099f11e508f67 100644 (file)
@@ -32,7 +32,7 @@
 #include <linux/regulator/consumer.h>
 #include <linux/bitfield.h>
 #include <linux/devfreq.h>
-#include <linux/keyslot-manager.h>
+#include <linux/blk-crypto-profile.h>
 #include "unipro.h"
 
 #include <asm/irq.h>
diff --git a/include/linux/blk-crypto-profile.h b/include/linux/blk-crypto-profile.h
new file mode 100644 (file)
index 0000000..a27605e
--- /dev/null
@@ -0,0 +1,120 @@
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * Copyright 2019 Google LLC
+ */
+
+#ifndef __LINUX_KEYSLOT_MANAGER_H
+#define __LINUX_KEYSLOT_MANAGER_H
+
+#include <linux/bio.h>
+#include <linux/blk-crypto.h>
+
+struct blk_keyslot_manager;
+
+/**
+ * struct blk_ksm_ll_ops - functions to manage keyslots in hardware
+ * @keyslot_program:   Program the specified key into the specified slot in the
+ *                     inline encryption hardware.
+ * @keyslot_evict:     Evict key from the specified keyslot in the hardware.
+ *                     The key is provided so that e.g. dm layers can evict
+ *                     keys from the devices that they map over.
+ *                     Returns 0 on success, -errno otherwise.
+ *
+ * This structure should be provided by storage device drivers when they set up
+ * a keyslot manager - this structure holds the function ptrs that the keyslot
+ * manager will use to manipulate keyslots in the hardware.
+ */
+struct blk_ksm_ll_ops {
+       int (*keyslot_program)(struct blk_keyslot_manager *ksm,
+                              const struct blk_crypto_key *key,
+                              unsigned int slot);
+       int (*keyslot_evict)(struct blk_keyslot_manager *ksm,
+                            const struct blk_crypto_key *key,
+                            unsigned int slot);
+};
+
+struct blk_keyslot_manager {
+       /*
+        * The struct blk_ksm_ll_ops that this keyslot manager will use
+        * to perform operations like programming and evicting keys on the
+        * device
+        */
+       struct blk_ksm_ll_ops ksm_ll_ops;
+
+       /*
+        * The maximum number of bytes supported for specifying the data unit
+        * number.
+        */
+       unsigned int max_dun_bytes_supported;
+
+       /*
+        * Array of size BLK_ENCRYPTION_MODE_MAX of bitmasks that represents
+        * whether a crypto mode and data unit size are supported. The i'th
+        * bit of crypto_mode_supported[crypto_mode] is set iff a data unit
+        * size of (1 << i) is supported. We only support data unit sizes
+        * that are powers of 2.
+        */
+       unsigned int crypto_modes_supported[BLK_ENCRYPTION_MODE_MAX];
+
+       /* Device for runtime power management (NULL if none) */
+       struct device *dev;
+
+       /* Here onwards are *private* fields for internal keyslot manager use */
+
+       unsigned int num_slots;
+
+       /* Protects programming and evicting keys from the device */
+       struct rw_semaphore lock;
+
+       /* List of idle slots, with least recently used slot at front */
+       wait_queue_head_t idle_slots_wait_queue;
+       struct list_head idle_slots;
+       spinlock_t idle_slots_lock;
+
+       /*
+        * Hash table which maps struct *blk_crypto_key to keyslots, so that we
+        * can find a key's keyslot in O(1) time rather than O(num_slots).
+        * Protected by 'lock'.
+        */
+       struct hlist_head *slot_hashtable;
+       unsigned int log_slot_ht_size;
+
+       /* Per-keyslot data */
+       struct blk_ksm_keyslot *slots;
+};
+
+int blk_ksm_init(struct blk_keyslot_manager *ksm, unsigned int num_slots);
+
+int devm_blk_ksm_init(struct device *dev, struct blk_keyslot_manager *ksm,
+                     unsigned int num_slots);
+
+blk_status_t blk_ksm_get_slot_for_key(struct blk_keyslot_manager *ksm,
+                                     const struct blk_crypto_key *key,
+                                     struct blk_ksm_keyslot **slot_ptr);
+
+unsigned int blk_ksm_get_slot_idx(struct blk_ksm_keyslot *slot);
+
+void blk_ksm_put_slot(struct blk_ksm_keyslot *slot);
+
+bool blk_ksm_crypto_cfg_supported(struct blk_keyslot_manager *ksm,
+                                 const struct blk_crypto_config *cfg);
+
+int blk_ksm_evict_key(struct blk_keyslot_manager *ksm,
+                     const struct blk_crypto_key *key);
+
+void blk_ksm_reprogram_all_keys(struct blk_keyslot_manager *ksm);
+
+void blk_ksm_destroy(struct blk_keyslot_manager *ksm);
+
+void blk_ksm_intersect_modes(struct blk_keyslot_manager *parent,
+                            const struct blk_keyslot_manager *child);
+
+void blk_ksm_init_passthrough(struct blk_keyslot_manager *ksm);
+
+bool blk_ksm_is_superset(struct blk_keyslot_manager *ksm_superset,
+                        struct blk_keyslot_manager *ksm_subset);
+
+void blk_ksm_update_capabilities(struct blk_keyslot_manager *target_ksm,
+                                struct blk_keyslot_manager *reference_ksm);
+
+#endif /* __LINUX_KEYSLOT_MANAGER_H */
diff --git a/include/linux/keyslot-manager.h b/include/linux/keyslot-manager.h
deleted file mode 100644 (file)
index a27605e..0000000
+++ /dev/null
@@ -1,120 +0,0 @@
-/* SPDX-License-Identifier: GPL-2.0 */
-/*
- * Copyright 2019 Google LLC
- */
-
-#ifndef __LINUX_KEYSLOT_MANAGER_H
-#define __LINUX_KEYSLOT_MANAGER_H
-
-#include <linux/bio.h>
-#include <linux/blk-crypto.h>
-
-struct blk_keyslot_manager;
-
-/**
- * struct blk_ksm_ll_ops - functions to manage keyslots in hardware
- * @keyslot_program:   Program the specified key into the specified slot in the
- *                     inline encryption hardware.
- * @keyslot_evict:     Evict key from the specified keyslot in the hardware.
- *                     The key is provided so that e.g. dm layers can evict
- *                     keys from the devices that they map over.
- *                     Returns 0 on success, -errno otherwise.
- *
- * This structure should be provided by storage device drivers when they set up
- * a keyslot manager - this structure holds the function ptrs that the keyslot
- * manager will use to manipulate keyslots in the hardware.
- */
-struct blk_ksm_ll_ops {
-       int (*keyslot_program)(struct blk_keyslot_manager *ksm,
-                              const struct blk_crypto_key *key,
-                              unsigned int slot);
-       int (*keyslot_evict)(struct blk_keyslot_manager *ksm,
-                            const struct blk_crypto_key *key,
-                            unsigned int slot);
-};
-
-struct blk_keyslot_manager {
-       /*
-        * The struct blk_ksm_ll_ops that this keyslot manager will use
-        * to perform operations like programming and evicting keys on the
-        * device
-        */
-       struct blk_ksm_ll_ops ksm_ll_ops;
-
-       /*
-        * The maximum number of bytes supported for specifying the data unit
-        * number.
-        */
-       unsigned int max_dun_bytes_supported;
-
-       /*
-        * Array of size BLK_ENCRYPTION_MODE_MAX of bitmasks that represents
-        * whether a crypto mode and data unit size are supported. The i'th
-        * bit of crypto_mode_supported[crypto_mode] is set iff a data unit
-        * size of (1 << i) is supported. We only support data unit sizes
-        * that are powers of 2.
-        */
-       unsigned int crypto_modes_supported[BLK_ENCRYPTION_MODE_MAX];
-
-       /* Device for runtime power management (NULL if none) */
-       struct device *dev;
-
-       /* Here onwards are *private* fields for internal keyslot manager use */
-
-       unsigned int num_slots;
-
-       /* Protects programming and evicting keys from the device */
-       struct rw_semaphore lock;
-
-       /* List of idle slots, with least recently used slot at front */
-       wait_queue_head_t idle_slots_wait_queue;
-       struct list_head idle_slots;
-       spinlock_t idle_slots_lock;
-
-       /*
-        * Hash table which maps struct *blk_crypto_key to keyslots, so that we
-        * can find a key's keyslot in O(1) time rather than O(num_slots).
-        * Protected by 'lock'.
-        */
-       struct hlist_head *slot_hashtable;
-       unsigned int log_slot_ht_size;
-
-       /* Per-keyslot data */
-       struct blk_ksm_keyslot *slots;
-};
-
-int blk_ksm_init(struct blk_keyslot_manager *ksm, unsigned int num_slots);
-
-int devm_blk_ksm_init(struct device *dev, struct blk_keyslot_manager *ksm,
-                     unsigned int num_slots);
-
-blk_status_t blk_ksm_get_slot_for_key(struct blk_keyslot_manager *ksm,
-                                     const struct blk_crypto_key *key,
-                                     struct blk_ksm_keyslot **slot_ptr);
-
-unsigned int blk_ksm_get_slot_idx(struct blk_ksm_keyslot *slot);
-
-void blk_ksm_put_slot(struct blk_ksm_keyslot *slot);
-
-bool blk_ksm_crypto_cfg_supported(struct blk_keyslot_manager *ksm,
-                                 const struct blk_crypto_config *cfg);
-
-int blk_ksm_evict_key(struct blk_keyslot_manager *ksm,
-                     const struct blk_crypto_key *key);
-
-void blk_ksm_reprogram_all_keys(struct blk_keyslot_manager *ksm);
-
-void blk_ksm_destroy(struct blk_keyslot_manager *ksm);
-
-void blk_ksm_intersect_modes(struct blk_keyslot_manager *parent,
-                            const struct blk_keyslot_manager *child);
-
-void blk_ksm_init_passthrough(struct blk_keyslot_manager *ksm);
-
-bool blk_ksm_is_superset(struct blk_keyslot_manager *ksm_superset,
-                        struct blk_keyslot_manager *ksm_subset);
-
-void blk_ksm_update_capabilities(struct blk_keyslot_manager *target_ksm,
-                                struct blk_keyslot_manager *reference_ksm);
-
-#endif /* __LINUX_KEYSLOT_MANAGER_H */
index 0c0c9a0fdf578e0860b6fce2e0e936d235512da5..725b1de417673fe583e24388c761053eae8737ff 100644 (file)
@@ -15,7 +15,7 @@
 #include <linux/mmc/card.h>
 #include <linux/mmc/pm.h>
 #include <linux/dma-direction.h>
-#include <linux/keyslot-manager.h>
+#include <linux/blk-crypto-profile.h>
 
 struct mmc_ios {
        unsigned int    clock;                  /* clock rate */