[linux.git] / block / blk-crypto-internal.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright 2019 Google LLC
 */

#ifndef __LINUX_BLK_CRYPTO_INTERNAL_H
#define __LINUX_BLK_CRYPTO_INTERNAL_H

#include <linux/bio.h>
#include <linux/blk-mq.h>

/* Represents a crypto mode supported by blk-crypto  */
struct blk_crypto_mode {
	const char *name; /* name of this mode, shown in sysfs */
	const char *cipher_str; /* crypto API name (for fallback case) */
	unsigned int keysize; /* key size in bytes */
	unsigned int ivsize; /* iv size in bytes */
};

extern const struct blk_crypto_mode blk_crypto_modes[];

#ifdef CONFIG_BLK_INLINE_ENCRYPTION

int blk_crypto_sysfs_register(struct gendisk *disk);

void blk_crypto_sysfs_unregister(struct gendisk *disk);

void bio_crypt_dun_increment(u64 dun[BLK_CRYPTO_DUN_ARRAY_SIZE],
			     unsigned int inc);

bool bio_crypt_rq_ctx_compatible(struct request *rq, struct bio *bio);

bool bio_crypt_ctx_mergeable(struct bio_crypt_ctx *bc1, unsigned int bc1_bytes,
			     struct bio_crypt_ctx *bc2);

static inline bool bio_crypt_ctx_back_mergeable(struct request *req,
						struct bio *bio)
{
	return bio_crypt_ctx_mergeable(req->crypt_ctx, blk_rq_bytes(req),
				       bio->bi_crypt_context);
}

static inline bool bio_crypt_ctx_front_mergeable(struct request *req,
						 struct bio *bio)
{
	return bio_crypt_ctx_mergeable(bio->bi_crypt_context,
				       bio->bi_iter.bi_size, req->crypt_ctx);
}

static inline bool bio_crypt_ctx_merge_rq(struct request *req,
					  struct request *next)
{
	return bio_crypt_ctx_mergeable(req->crypt_ctx, blk_rq_bytes(req),
				       next->crypt_ctx);
}

static inline void blk_crypto_rq_set_defaults(struct request *rq)
{
	rq->crypt_ctx = NULL;
	rq->crypt_keyslot = NULL;
}

static inline bool blk_crypto_rq_is_encrypted(struct request *rq)
{
	return rq->crypt_ctx;
}

static inline bool blk_crypto_rq_has_keyslot(struct request *rq)
{
	return rq->crypt_keyslot;
}

blk_status_t blk_crypto_get_keyslot(struct blk_crypto_profile *profile,
				    const struct blk_crypto_key *key,
				    struct blk_crypto_keyslot **slot_ptr);

void blk_crypto_put_keyslot(struct blk_crypto_keyslot *slot);

int __blk_crypto_evict_key(struct blk_crypto_profile *profile,
			   const struct blk_crypto_key *key);

bool __blk_crypto_cfg_supported(struct blk_crypto_profile *profile,
				const struct blk_crypto_config *cfg);

#else /* CONFIG_BLK_INLINE_ENCRYPTION */

static inline int blk_crypto_sysfs_register(struct gendisk *disk)
{
	return 0;
}

static inline void blk_crypto_sysfs_unregister(struct gendisk *disk)
{
}

static inline bool bio_crypt_rq_ctx_compatible(struct request *rq,
					       struct bio *bio)
{
	return true;
}

static inline bool bio_crypt_ctx_front_mergeable(struct request *req,
						 struct bio *bio)
{
	return true;
}

static inline bool bio_crypt_ctx_back_mergeable(struct request *req,
						struct bio *bio)
{
	return true;
}

static inline bool bio_crypt_ctx_merge_rq(struct request *req,
					  struct request *next)
{
	return true;
}

static inline void blk_crypto_rq_set_defaults(struct request *rq) { }

static inline bool blk_crypto_rq_is_encrypted(struct request *rq)
{
	return false;
}

static inline bool blk_crypto_rq_has_keyslot(struct request *rq)
{
	return false;
}

#endif /* CONFIG_BLK_INLINE_ENCRYPTION */

void __bio_crypt_advance(struct bio *bio, unsigned int bytes);
static inline void bio_crypt_advance(struct bio *bio, unsigned int bytes)
{
	if (bio_has_crypt_ctx(bio))
		__bio_crypt_advance(bio, bytes);
}

void __bio_crypt_free_ctx(struct bio *bio);
static inline void bio_crypt_free_ctx(struct bio *bio)
{
	if (bio_has_crypt_ctx(bio))
		__bio_crypt_free_ctx(bio);
}

static inline void bio_crypt_do_front_merge(struct request *rq,
					    struct bio *bio)
{
#ifdef CONFIG_BLK_INLINE_ENCRYPTION
	if (bio_has_crypt_ctx(bio))
		memcpy(rq->crypt_ctx->bc_dun, bio->bi_crypt_context->bc_dun,
		       sizeof(rq->crypt_ctx->bc_dun));
#endif
}

bool __blk_crypto_bio_prep(struct bio **bio_ptr);
static inline bool blk_crypto_bio_prep(struct bio **bio_ptr)
{
	if (bio_has_crypt_ctx(*bio_ptr))
		return __blk_crypto_bio_prep(bio_ptr);
	return true;
}

blk_status_t __blk_crypto_rq_get_keyslot(struct request *rq);
static inline blk_status_t blk_crypto_rq_get_keyslot(struct request *rq)
{
	if (blk_crypto_rq_is_encrypted(rq))
		return __blk_crypto_rq_get_keyslot(rq);
	return BLK_STS_OK;
}

void __blk_crypto_rq_put_keyslot(struct request *rq);
static inline void blk_crypto_rq_put_keyslot(struct request *rq)
{
	if (blk_crypto_rq_has_keyslot(rq))
		__blk_crypto_rq_put_keyslot(rq);
}

void __blk_crypto_free_request(struct request *rq);
static inline void blk_crypto_free_request(struct request *rq)
{
	if (blk_crypto_rq_is_encrypted(rq))
		__blk_crypto_free_request(rq);
}

int __blk_crypto_rq_bio_prep(struct request *rq, struct bio *bio,
			     gfp_t gfp_mask);
/**
 * blk_crypto_rq_bio_prep - Prepare a request's crypt_ctx when its first bio
 *			    is inserted
 * @rq: The request to prepare
 * @bio: The first bio being inserted into the request
 * @gfp_mask: Memory allocation flags
 *
 * Return: 0 on success, -ENOMEM if out of memory.  -ENOMEM is only possible if
 *	   @gfp_mask doesn't include %__GFP_DIRECT_RECLAIM.
 */
static inline int blk_crypto_rq_bio_prep(struct request *rq, struct bio *bio,
					 gfp_t gfp_mask)
{
	if (bio_has_crypt_ctx(bio))
		return __blk_crypto_rq_bio_prep(rq, bio, gfp_mask);
	return 0;
}

#ifdef CONFIG_BLK_INLINE_ENCRYPTION_FALLBACK

int blk_crypto_fallback_start_using_mode(enum blk_crypto_mode_num mode_num);

bool blk_crypto_fallback_bio_prep(struct bio **bio_ptr);

int blk_crypto_fallback_evict_key(const struct blk_crypto_key *key);

#else /* CONFIG_BLK_INLINE_ENCRYPTION_FALLBACK */

static inline int
blk_crypto_fallback_start_using_mode(enum blk_crypto_mode_num mode_num)
{
	pr_warn_once("crypto API fallback is disabled\n");
	return -ENOPKG;
}

static inline bool blk_crypto_fallback_bio_prep(struct bio **bio_ptr)
{
	pr_warn_once("crypto API fallback disabled; failing request.\n");
	(*bio_ptr)->bi_status = BLK_STS_NOTSUPP;
	return false;
}

static inline int
blk_crypto_fallback_evict_key(const struct blk_crypto_key *key)
{
	return 0;
}

#endif /* CONFIG_BLK_INLINE_ENCRYPTION_FALLBACK */

#endif /* __LINUX_BLK_CRYPTO_INTERNAL_H */
Commit	Line	Data
a892c8d5 ST	1	/* SPDX-License-Identifier: GPL-2.0 */
	2	/*
	3	* Copyright 2019 Google LLC
	4	*/
	5
	6	#ifndef __LINUX_BLK_CRYPTO_INTERNAL_H
	7	#define __LINUX_BLK_CRYPTO_INTERNAL_H
	8
	9	#include <linux/bio.h>
24b83deb	10	#include <linux/blk-mq.h>
a892c8d5 ST	11
	12	/* Represents a crypto mode supported by blk-crypto */
	13	struct blk_crypto_mode {
20f01f16	14	const char name; / name of this mode, shown in sysfs */
488f6682	15	const char cipher_str; / crypto API name (for fallback case) */
a892c8d5 ST	16	unsigned int keysize; /* key size in bytes */
	17	unsigned int ivsize; /* iv size in bytes */
	18	};
	19
488f6682 ST	20	extern const struct blk_crypto_mode blk_crypto_modes[];
488f6682 ST	21
a892c8d5 ST	22	#ifdef CONFIG_BLK_INLINE_ENCRYPTION
a892c8d5 ST	23
450deb93	24	int blk_crypto_sysfs_register(struct gendisk *disk);
20f01f16	25
450deb93	26	void blk_crypto_sysfs_unregister(struct gendisk *disk);
20f01f16	27
a892c8d5 ST	28	void bio_crypt_dun_increment(u64 dun[BLK_CRYPTO_DUN_ARRAY_SIZE],
	29	unsigned int inc);
	30
	31	bool bio_crypt_rq_ctx_compatible(struct request rq, struct bio bio);
	32
	33	bool bio_crypt_ctx_mergeable(struct bio_crypt_ctx *bc1, unsigned int bc1_bytes,
	34	struct bio_crypt_ctx *bc2);
	35
	36	static inline bool bio_crypt_ctx_back_mergeable(struct request *req,
	37	struct bio *bio)
	38	{
	39	return bio_crypt_ctx_mergeable(req->crypt_ctx, blk_rq_bytes(req),
	40	bio->bi_crypt_context);
	41	}
	42
	43	static inline bool bio_crypt_ctx_front_mergeable(struct request *req,
	44	struct bio *bio)
	45	{
	46	return bio_crypt_ctx_mergeable(bio->bi_crypt_context,
	47	bio->bi_iter.bi_size, req->crypt_ctx);
	48	}
	49
	50	static inline bool bio_crypt_ctx_merge_rq(struct request *req,
	51	struct request *next)
	52	{
	53	return bio_crypt_ctx_mergeable(req->crypt_ctx, blk_rq_bytes(req),
	54	next->crypt_ctx);
	55	}
	56
	57	static inline void blk_crypto_rq_set_defaults(struct request *rq)
	58	{
	59	rq->crypt_ctx = NULL;
	60	rq->crypt_keyslot = NULL;
	61	}
	62
	63	static inline bool blk_crypto_rq_is_encrypted(struct request *rq)
	64	{
	65	return rq->crypt_ctx;
	66	}
	67
9cd1e566 EB	68	static inline bool blk_crypto_rq_has_keyslot(struct request *rq)
	69	{
	70	return rq->crypt_keyslot;
	71	}
	72
3569788c CH	73	blk_status_t blk_crypto_get_keyslot(struct blk_crypto_profile *profile,
	74	const struct blk_crypto_key *key,
	75	struct blk_crypto_keyslot **slot_ptr);
	76
	77	void blk_crypto_put_keyslot(struct blk_crypto_keyslot *slot);
	78
	79	int __blk_crypto_evict_key(struct blk_crypto_profile *profile,
	80	const struct blk_crypto_key *key);
	81
	82	bool __blk_crypto_cfg_supported(struct blk_crypto_profile *profile,
	83	const struct blk_crypto_config *cfg);
	84
a892c8d5 ST	85	#else /* CONFIG_BLK_INLINE_ENCRYPTION */
a892c8d5 ST	86
450deb93	87	static inline int blk_crypto_sysfs_register(struct gendisk *disk)
20f01f16 EB	88	{
	89	return 0;
	90	}
	91
450deb93 CH	92	static inline void blk_crypto_sysfs_unregister(struct gendisk *disk)
	93	{
	94	}
20f01f16	95
a892c8d5 ST	96	static inline bool bio_crypt_rq_ctx_compatible(struct request *rq,
	97	struct bio *bio)
	98	{
	99	return true;
	100	}
	101
	102	static inline bool bio_crypt_ctx_front_mergeable(struct request *req,
	103	struct bio *bio)
	104	{
	105	return true;
	106	}
	107
	108	static inline bool bio_crypt_ctx_back_mergeable(struct request *req,
	109	struct bio *bio)
	110	{
	111	return true;
	112	}
	113
	114	static inline bool bio_crypt_ctx_merge_rq(struct request *req,
	115	struct request *next)
	116	{
	117	return true;
	118	}
	119
	120	static inline void blk_crypto_rq_set_defaults(struct request *rq) { }
	121
	122	static inline bool blk_crypto_rq_is_encrypted(struct request *rq)
	123	{
	124	return false;
	125	}
	126
9cd1e566 EB	127	static inline bool blk_crypto_rq_has_keyslot(struct request *rq)
	128	{
	129	return false;
	130	}
	131
a892c8d5 ST	132	#endif /* CONFIG_BLK_INLINE_ENCRYPTION */
	133
	134	void __bio_crypt_advance(struct bio *bio, unsigned int bytes);
	135	static inline void bio_crypt_advance(struct bio *bio, unsigned int bytes)
	136	{
	137	if (bio_has_crypt_ctx(bio))
	138	__bio_crypt_advance(bio, bytes);
	139	}
	140
	141	void __bio_crypt_free_ctx(struct bio *bio);
	142	static inline void bio_crypt_free_ctx(struct bio *bio)
	143	{
	144	if (bio_has_crypt_ctx(bio))
	145	__bio_crypt_free_ctx(bio);
	146	}
	147
	148	static inline void bio_crypt_do_front_merge(struct request *rq,
	149	struct bio *bio)
	150	{
	151	#ifdef CONFIG_BLK_INLINE_ENCRYPTION
	152	if (bio_has_crypt_ctx(bio))
	153	memcpy(rq->crypt_ctx->bc_dun, bio->bi_crypt_context->bc_dun,
	154	sizeof(rq->crypt_ctx->bc_dun));
	155	#endif
	156	}
	157
	158	bool __blk_crypto_bio_prep(struct bio **bio_ptr);
	159	static inline bool blk_crypto_bio_prep(struct bio **bio_ptr)
	160	{
	161	if (bio_has_crypt_ctx(*bio_ptr))
	162	return __blk_crypto_bio_prep(bio_ptr);
	163	return true;
	164	}
	165
9cd1e566 EB	166	blk_status_t __blk_crypto_rq_get_keyslot(struct request *rq);
9cd1e566 EB	167	static inline blk_status_t blk_crypto_rq_get_keyslot(struct request *rq)
a892c8d5 ST	168	{
a892c8d5 ST	169	if (blk_crypto_rq_is_encrypted(rq))
9cd1e566	170	return __blk_crypto_rq_get_keyslot(rq);
a892c8d5 ST	171	return BLK_STS_OK;
	172	}
	173
9cd1e566 EB	174	void __blk_crypto_rq_put_keyslot(struct request *rq);
	175	static inline void blk_crypto_rq_put_keyslot(struct request *rq)
	176	{
	177	if (blk_crypto_rq_has_keyslot(rq))
	178	__blk_crypto_rq_put_keyslot(rq);
	179	}
	180
a892c8d5 ST	181	void __blk_crypto_free_request(struct request *rq);
	182	static inline void blk_crypto_free_request(struct request *rq)
	183	{
	184	if (blk_crypto_rq_is_encrypted(rq))
	185	__blk_crypto_free_request(rq);
	186	}
	187
93f221ae EB	188	int __blk_crypto_rq_bio_prep(struct request rq, struct bio bio,
	189	gfp_t gfp_mask);
	190	/**
	191	* blk_crypto_rq_bio_prep - Prepare a request's crypt_ctx when its first bio
	192	* is inserted
	193	* @rq: The request to prepare
	194	* @bio: The first bio being inserted into the request
	195	* @gfp_mask: Memory allocation flags
	196	*
	197	* Return: 0 on success, -ENOMEM if out of memory. -ENOMEM is only possible if
	198	* @gfp_mask doesn't include %__GFP_DIRECT_RECLAIM.
	199	*/
	200	static inline int blk_crypto_rq_bio_prep(struct request rq, struct bio bio,
	201	gfp_t gfp_mask)
a892c8d5 ST	202	{
a892c8d5 ST	203	if (bio_has_crypt_ctx(bio))
93f221ae EB	204	return __blk_crypto_rq_bio_prep(rq, bio, gfp_mask);
93f221ae EB	205	return 0;
a892c8d5 ST	206	}
a892c8d5 ST	207
488f6682 ST	208	#ifdef CONFIG_BLK_INLINE_ENCRYPTION_FALLBACK
	209
	210	int blk_crypto_fallback_start_using_mode(enum blk_crypto_mode_num mode_num);
	211
	212	bool blk_crypto_fallback_bio_prep(struct bio **bio_ptr);
	213
	214	int blk_crypto_fallback_evict_key(const struct blk_crypto_key *key);
	215
	216	#else /* CONFIG_BLK_INLINE_ENCRYPTION_FALLBACK */
	217
	218	static inline int
	219	blk_crypto_fallback_start_using_mode(enum blk_crypto_mode_num mode_num)
	220	{
	221	pr_warn_once("crypto API fallback is disabled\n");
	222	return -ENOPKG;
	223	}
	224
	225	static inline bool blk_crypto_fallback_bio_prep(struct bio **bio_ptr)
	226	{
	227	pr_warn_once("crypto API fallback disabled; failing request.\n");
	228	(*bio_ptr)->bi_status = BLK_STS_NOTSUPP;
	229	return false;
	230	}
	231
	232	static inline int
	233	blk_crypto_fallback_evict_key(const struct blk_crypto_key *key)
	234	{
	235	return 0;
	236	}
	237
	238	#endif /* CONFIG_BLK_INLINE_ENCRYPTION_FALLBACK */
	239
a892c8d5	240	#endif /* __LINUX_BLK_CRYPTO_INTERNAL_H */