mirror of
https://github.com/torvalds/linux
synced 2024-09-06 18:01:05 +00:00
![Eric Biggers](/assets/img/avatar_default.png)
Remove support for the "Crypto usage statistics" feature (CONFIG_CRYPTO_STATS). This feature does not appear to have ever been used, and it is harmful because it significantly reduces performance and is a large maintenance burden. Covering each of these points in detail: 1. Feature is not being used Since these generic crypto statistics are only readable using netlink, it's fairly straightforward to look for programs that use them. I'm unable to find any evidence that any such programs exist. For example, Debian Code Search returns no hits except the kernel header and kernel code itself and translations of the kernel header: https://codesearch.debian.net/search?q=CRYPTOCFGA_STAT&literal=1&perpkg=1 The patch series that added this feature in 2018 (https://lore.kernel.org/linux-crypto/1537351855-16618-1-git-send-email-clabbe@baylibre.com/) said "The goal is to have an ifconfig for crypto device." This doesn't appear to have happened. It's not clear that there is real demand for crypto statistics. Just because the kernel provides other types of statistics such as I/O and networking statistics and some people find those useful does not mean that crypto statistics are useful too. Further evidence that programs are not using CONFIG_CRYPTO_STATS is that it was able to be disabled in RHEL and Fedora as a bug fix (https://gitlab.com/redhat/centos-stream/src/kernel/centos-stream-9/-/merge_requests/2947). Even further evidence comes from the fact that there are and have been bugs in how the stats work, but they were never reported. For example, before Linux v6.7 hash stats were double-counted in most cases. There has also never been any documentation for this feature, so it might be hard to use even if someone wanted to. 2. CONFIG_CRYPTO_STATS significantly reduces performance Enabling CONFIG_CRYPTO_STATS significantly reduces the performance of the crypto API, even if no program ever retrieves the statistics. This primarily affects systems with a large number of CPUs. For example, https://bugs.launchpad.net/ubuntu/+source/linux/+bug/2039576 reported that Lustre client encryption performance improved from 21.7GB/s to 48.2GB/s by disabling CONFIG_CRYPTO_STATS. It can be argued that this means that CONFIG_CRYPTO_STATS should be optimized with per-cpu counters similar to many of the networking counters. But no one has done this in 5+ years. This is consistent with the fact that the feature appears to be unused, so there seems to be little interest in improving it as opposed to just disabling it. It can be argued that because CONFIG_CRYPTO_STATS is off by default, performance doesn't matter. But Linux distros tend to error on the side of enabling options. The option is enabled in Ubuntu and Arch Linux, and until recently was enabled in RHEL and Fedora (see above). So, even just having the option available is harmful to users. 3. CONFIG_CRYPTO_STATS is a large maintenance burden There are over 1000 lines of code associated with CONFIG_CRYPTO_STATS, spread among 32 files. It significantly complicates much of the implementation of the crypto API. After the initial submission, many fixes and refactorings have consumed effort of multiple people to keep this feature "working". We should be spending this effort elsewhere. Acked-by: Ard Biesheuvel <ardb@kernel.org> Acked-by: Corentin Labbe <clabbe@baylibre.com> Signed-off-by: Eric Biggers <ebiggers@google.com> Signed-off-by: Herbert Xu <herbert@gondor.apana.org.au>
330 lines
7.3 KiB
C
330 lines
7.3 KiB
C
// SPDX-License-Identifier: GPL-2.0-or-later
|
|
/*
|
|
* Synchronous Compression operations
|
|
*
|
|
* Copyright 2015 LG Electronics Inc.
|
|
* Copyright (c) 2016, Intel Corporation
|
|
* Author: Giovanni Cabiddu <giovanni.cabiddu@intel.com>
|
|
*/
|
|
|
|
#include <crypto/internal/acompress.h>
|
|
#include <crypto/internal/scompress.h>
|
|
#include <crypto/scatterwalk.h>
|
|
#include <linux/cryptouser.h>
|
|
#include <linux/err.h>
|
|
#include <linux/kernel.h>
|
|
#include <linux/module.h>
|
|
#include <linux/scatterlist.h>
|
|
#include <linux/seq_file.h>
|
|
#include <linux/slab.h>
|
|
#include <linux/string.h>
|
|
#include <linux/vmalloc.h>
|
|
#include <net/netlink.h>
|
|
|
|
#include "compress.h"
|
|
|
|
struct scomp_scratch {
|
|
spinlock_t lock;
|
|
void *src;
|
|
void *dst;
|
|
};
|
|
|
|
static DEFINE_PER_CPU(struct scomp_scratch, scomp_scratch) = {
|
|
.lock = __SPIN_LOCK_UNLOCKED(scomp_scratch.lock),
|
|
};
|
|
|
|
static const struct crypto_type crypto_scomp_type;
|
|
static int scomp_scratch_users;
|
|
static DEFINE_MUTEX(scomp_lock);
|
|
|
|
static int __maybe_unused crypto_scomp_report(
|
|
struct sk_buff *skb, struct crypto_alg *alg)
|
|
{
|
|
struct crypto_report_comp rscomp;
|
|
|
|
memset(&rscomp, 0, sizeof(rscomp));
|
|
|
|
strscpy(rscomp.type, "scomp", sizeof(rscomp.type));
|
|
|
|
return nla_put(skb, CRYPTOCFGA_REPORT_COMPRESS,
|
|
sizeof(rscomp), &rscomp);
|
|
}
|
|
|
|
static void crypto_scomp_show(struct seq_file *m, struct crypto_alg *alg)
|
|
__maybe_unused;
|
|
|
|
static void crypto_scomp_show(struct seq_file *m, struct crypto_alg *alg)
|
|
{
|
|
seq_puts(m, "type : scomp\n");
|
|
}
|
|
|
|
static void crypto_scomp_free_scratches(void)
|
|
{
|
|
struct scomp_scratch *scratch;
|
|
int i;
|
|
|
|
for_each_possible_cpu(i) {
|
|
scratch = per_cpu_ptr(&scomp_scratch, i);
|
|
|
|
vfree(scratch->src);
|
|
vfree(scratch->dst);
|
|
scratch->src = NULL;
|
|
scratch->dst = NULL;
|
|
}
|
|
}
|
|
|
|
static int crypto_scomp_alloc_scratches(void)
|
|
{
|
|
struct scomp_scratch *scratch;
|
|
int i;
|
|
|
|
for_each_possible_cpu(i) {
|
|
void *mem;
|
|
|
|
scratch = per_cpu_ptr(&scomp_scratch, i);
|
|
|
|
mem = vmalloc_node(SCOMP_SCRATCH_SIZE, cpu_to_node(i));
|
|
if (!mem)
|
|
goto error;
|
|
scratch->src = mem;
|
|
mem = vmalloc_node(SCOMP_SCRATCH_SIZE, cpu_to_node(i));
|
|
if (!mem)
|
|
goto error;
|
|
scratch->dst = mem;
|
|
}
|
|
return 0;
|
|
error:
|
|
crypto_scomp_free_scratches();
|
|
return -ENOMEM;
|
|
}
|
|
|
|
static int crypto_scomp_init_tfm(struct crypto_tfm *tfm)
|
|
{
|
|
int ret = 0;
|
|
|
|
mutex_lock(&scomp_lock);
|
|
if (!scomp_scratch_users++)
|
|
ret = crypto_scomp_alloc_scratches();
|
|
mutex_unlock(&scomp_lock);
|
|
|
|
return ret;
|
|
}
|
|
|
|
static int scomp_acomp_comp_decomp(struct acomp_req *req, int dir)
|
|
{
|
|
struct crypto_acomp *tfm = crypto_acomp_reqtfm(req);
|
|
void **tfm_ctx = acomp_tfm_ctx(tfm);
|
|
struct crypto_scomp *scomp = *tfm_ctx;
|
|
void **ctx = acomp_request_ctx(req);
|
|
struct scomp_scratch *scratch;
|
|
void *src, *dst;
|
|
unsigned int dlen;
|
|
int ret;
|
|
|
|
if (!req->src || !req->slen || req->slen > SCOMP_SCRATCH_SIZE)
|
|
return -EINVAL;
|
|
|
|
if (req->dst && !req->dlen)
|
|
return -EINVAL;
|
|
|
|
if (!req->dlen || req->dlen > SCOMP_SCRATCH_SIZE)
|
|
req->dlen = SCOMP_SCRATCH_SIZE;
|
|
|
|
dlen = req->dlen;
|
|
|
|
scratch = raw_cpu_ptr(&scomp_scratch);
|
|
spin_lock(&scratch->lock);
|
|
|
|
if (sg_nents(req->src) == 1 && !PageHighMem(sg_page(req->src))) {
|
|
src = page_to_virt(sg_page(req->src)) + req->src->offset;
|
|
} else {
|
|
scatterwalk_map_and_copy(scratch->src, req->src, 0,
|
|
req->slen, 0);
|
|
src = scratch->src;
|
|
}
|
|
|
|
if (req->dst && sg_nents(req->dst) == 1 && !PageHighMem(sg_page(req->dst)))
|
|
dst = page_to_virt(sg_page(req->dst)) + req->dst->offset;
|
|
else
|
|
dst = scratch->dst;
|
|
|
|
if (dir)
|
|
ret = crypto_scomp_compress(scomp, src, req->slen,
|
|
dst, &req->dlen, *ctx);
|
|
else
|
|
ret = crypto_scomp_decompress(scomp, src, req->slen,
|
|
dst, &req->dlen, *ctx);
|
|
if (!ret) {
|
|
if (!req->dst) {
|
|
req->dst = sgl_alloc(req->dlen, GFP_ATOMIC, NULL);
|
|
if (!req->dst) {
|
|
ret = -ENOMEM;
|
|
goto out;
|
|
}
|
|
} else if (req->dlen > dlen) {
|
|
ret = -ENOSPC;
|
|
goto out;
|
|
}
|
|
if (dst == scratch->dst) {
|
|
scatterwalk_map_and_copy(scratch->dst, req->dst, 0,
|
|
req->dlen, 1);
|
|
} else {
|
|
int nr_pages = DIV_ROUND_UP(req->dst->offset + req->dlen, PAGE_SIZE);
|
|
int i;
|
|
struct page *dst_page = sg_page(req->dst);
|
|
|
|
for (i = 0; i < nr_pages; i++)
|
|
flush_dcache_page(dst_page + i);
|
|
}
|
|
}
|
|
out:
|
|
spin_unlock(&scratch->lock);
|
|
return ret;
|
|
}
|
|
|
|
static int scomp_acomp_compress(struct acomp_req *req)
|
|
{
|
|
return scomp_acomp_comp_decomp(req, 1);
|
|
}
|
|
|
|
static int scomp_acomp_decompress(struct acomp_req *req)
|
|
{
|
|
return scomp_acomp_comp_decomp(req, 0);
|
|
}
|
|
|
|
static void crypto_exit_scomp_ops_async(struct crypto_tfm *tfm)
|
|
{
|
|
struct crypto_scomp **ctx = crypto_tfm_ctx(tfm);
|
|
|
|
crypto_free_scomp(*ctx);
|
|
|
|
mutex_lock(&scomp_lock);
|
|
if (!--scomp_scratch_users)
|
|
crypto_scomp_free_scratches();
|
|
mutex_unlock(&scomp_lock);
|
|
}
|
|
|
|
int crypto_init_scomp_ops_async(struct crypto_tfm *tfm)
|
|
{
|
|
struct crypto_alg *calg = tfm->__crt_alg;
|
|
struct crypto_acomp *crt = __crypto_acomp_tfm(tfm);
|
|
struct crypto_scomp **ctx = crypto_tfm_ctx(tfm);
|
|
struct crypto_scomp *scomp;
|
|
|
|
if (!crypto_mod_get(calg))
|
|
return -EAGAIN;
|
|
|
|
scomp = crypto_create_tfm(calg, &crypto_scomp_type);
|
|
if (IS_ERR(scomp)) {
|
|
crypto_mod_put(calg);
|
|
return PTR_ERR(scomp);
|
|
}
|
|
|
|
*ctx = scomp;
|
|
tfm->exit = crypto_exit_scomp_ops_async;
|
|
|
|
crt->compress = scomp_acomp_compress;
|
|
crt->decompress = scomp_acomp_decompress;
|
|
crt->dst_free = sgl_free;
|
|
crt->reqsize = sizeof(void *);
|
|
|
|
return 0;
|
|
}
|
|
|
|
struct acomp_req *crypto_acomp_scomp_alloc_ctx(struct acomp_req *req)
|
|
{
|
|
struct crypto_acomp *acomp = crypto_acomp_reqtfm(req);
|
|
struct crypto_tfm *tfm = crypto_acomp_tfm(acomp);
|
|
struct crypto_scomp **tfm_ctx = crypto_tfm_ctx(tfm);
|
|
struct crypto_scomp *scomp = *tfm_ctx;
|
|
void *ctx;
|
|
|
|
ctx = crypto_scomp_alloc_ctx(scomp);
|
|
if (IS_ERR(ctx)) {
|
|
kfree(req);
|
|
return NULL;
|
|
}
|
|
|
|
*req->__ctx = ctx;
|
|
|
|
return req;
|
|
}
|
|
|
|
void crypto_acomp_scomp_free_ctx(struct acomp_req *req)
|
|
{
|
|
struct crypto_acomp *acomp = crypto_acomp_reqtfm(req);
|
|
struct crypto_tfm *tfm = crypto_acomp_tfm(acomp);
|
|
struct crypto_scomp **tfm_ctx = crypto_tfm_ctx(tfm);
|
|
struct crypto_scomp *scomp = *tfm_ctx;
|
|
void *ctx = *req->__ctx;
|
|
|
|
if (ctx)
|
|
crypto_scomp_free_ctx(scomp, ctx);
|
|
}
|
|
|
|
static const struct crypto_type crypto_scomp_type = {
|
|
.extsize = crypto_alg_extsize,
|
|
.init_tfm = crypto_scomp_init_tfm,
|
|
#ifdef CONFIG_PROC_FS
|
|
.show = crypto_scomp_show,
|
|
#endif
|
|
#if IS_ENABLED(CONFIG_CRYPTO_USER)
|
|
.report = crypto_scomp_report,
|
|
#endif
|
|
.maskclear = ~CRYPTO_ALG_TYPE_MASK,
|
|
.maskset = CRYPTO_ALG_TYPE_MASK,
|
|
.type = CRYPTO_ALG_TYPE_SCOMPRESS,
|
|
.tfmsize = offsetof(struct crypto_scomp, base),
|
|
};
|
|
|
|
int crypto_register_scomp(struct scomp_alg *alg)
|
|
{
|
|
struct crypto_alg *base = &alg->calg.base;
|
|
|
|
comp_prepare_alg(&alg->calg);
|
|
|
|
base->cra_type = &crypto_scomp_type;
|
|
base->cra_flags |= CRYPTO_ALG_TYPE_SCOMPRESS;
|
|
|
|
return crypto_register_alg(base);
|
|
}
|
|
EXPORT_SYMBOL_GPL(crypto_register_scomp);
|
|
|
|
void crypto_unregister_scomp(struct scomp_alg *alg)
|
|
{
|
|
crypto_unregister_alg(&alg->base);
|
|
}
|
|
EXPORT_SYMBOL_GPL(crypto_unregister_scomp);
|
|
|
|
int crypto_register_scomps(struct scomp_alg *algs, int count)
|
|
{
|
|
int i, ret;
|
|
|
|
for (i = 0; i < count; i++) {
|
|
ret = crypto_register_scomp(&algs[i]);
|
|
if (ret)
|
|
goto err;
|
|
}
|
|
|
|
return 0;
|
|
|
|
err:
|
|
for (--i; i >= 0; --i)
|
|
crypto_unregister_scomp(&algs[i]);
|
|
|
|
return ret;
|
|
}
|
|
EXPORT_SYMBOL_GPL(crypto_register_scomps);
|
|
|
|
void crypto_unregister_scomps(struct scomp_alg *algs, int count)
|
|
{
|
|
int i;
|
|
|
|
for (i = count - 1; i >= 0; --i)
|
|
crypto_unregister_scomp(&algs[i]);
|
|
}
|
|
EXPORT_SYMBOL_GPL(crypto_unregister_scomps);
|
|
|
|
MODULE_LICENSE("GPL");
|
|
MODULE_DESCRIPTION("Synchronous compression type");
|