2874c5fd28426 (Thomas Gleixner 2019-05-27 08:55:01 +0200 1) // SPDX-License-Identifier: GPL-2.0-or-later
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 2) /* General filesystem local caching manager
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 3) *
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 4) * Copyright (C) 2004-2007 Red Hat, Inc. All Rights Reserved.
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 5) * Written by David Howells (dhowells@redhat.com)
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 6) */
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 7)
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 8) #define FSCACHE_DEBUG_LEVEL CACHE
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 9) #include <linux/module.h>
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 10) #include <linux/init.h>
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 11) #include <linux/sched.h>
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 12) #include <linux/completion.h>
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 13) #include <linux/slab.h>
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 14) #include <linux/seq_file.h>
a18feb55769b7 (David Howells 2018-04-04 13:41:27 +0100 15) #define CREATE_TRACE_POINTS
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 16) #include "internal.h"
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 17)
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 18) MODULE_DESCRIPTION("FS Cache Manager");
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 19) MODULE_AUTHOR("Red Hat, Inc.");
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 20) MODULE_LICENSE("GPL");
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 21)
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 22) unsigned fscache_defer_lookup = 1;
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 23) module_param_named(defer_lookup, fscache_defer_lookup, uint,
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 24) S_IWUSR | S_IRUGO);
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 25) MODULE_PARM_DESC(fscache_defer_lookup,
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 26) "Defer cookie lookup to background thread");
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 27)
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 28) unsigned fscache_defer_create = 1;
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 29) module_param_named(defer_create, fscache_defer_create, uint,
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 30) S_IWUSR | S_IRUGO);
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 31) MODULE_PARM_DESC(fscache_defer_create,
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 32) "Defer cookie creation to background thread");
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 33)
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 34) unsigned fscache_debug;
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 35) module_param_named(debug, fscache_debug, uint,
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 36) S_IWUSR | S_IRUGO);
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 37) MODULE_PARM_DESC(fscache_debug,
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 38) "FS-Cache debugging mask");
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 39)
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 40) struct kobject *fscache_root;
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 41) struct workqueue_struct *fscache_object_wq;
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 42) struct workqueue_struct *fscache_op_wq;
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 43)
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 44) DEFINE_PER_CPU(wait_queue_head_t, fscache_object_cong_wait);
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 45)
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 46) /* these values serve as lower bounds, will be adjusted in fscache_init() */
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 47) static unsigned fscache_object_max_active = 4;
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 48) static unsigned fscache_op_max_active = 2;
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 49)
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 50) #ifdef CONFIG_SYSCTL
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 51) static struct ctl_table_header *fscache_sysctl_header;
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 52)
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 53) static int fscache_max_active_sysctl(struct ctl_table *table, int write,
32927393dc1cc (Christoph Hellwig 2020-04-24 08:43:38 +0200 54) void *buffer, size_t *lenp, loff_t *ppos)
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 55) {
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 56) struct workqueue_struct **wqp = table->extra1;
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 57) unsigned int *datap = table->data;
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 58) int ret;
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 59)
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 60) ret = proc_dointvec(table, write, buffer, lenp, ppos);
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 61) if (ret == 0)
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 62) workqueue_set_max_active(*wqp, *datap);
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 63) return ret;
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 64) }
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 65)
3e584064840de (Fabian Frederick 2014-08-06 16:03:24 -0700 66) static struct ctl_table fscache_sysctls[] = {
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 67) {
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 68) .procname = "object_max_active",
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 69) .data = &fscache_object_max_active,
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 70) .maxlen = sizeof(unsigned),
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 71) .mode = 0644,
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 72) .proc_handler = fscache_max_active_sysctl,
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 73) .extra1 = &fscache_object_wq,
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 74) },
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 75) {
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 76) .procname = "operation_max_active",
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 77) .data = &fscache_op_max_active,
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 78) .maxlen = sizeof(unsigned),
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 79) .mode = 0644,
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 80) .proc_handler = fscache_max_active_sysctl,
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 81) .extra1 = &fscache_op_wq,
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 82) },
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 83) {}
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 84) };
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 85)
3e584064840de (Fabian Frederick 2014-08-06 16:03:24 -0700 86) static struct ctl_table fscache_sysctls_root[] = {
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 87) {
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 88) .procname = "fscache",
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 89) .mode = 0555,
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 90) .child = fscache_sysctls,
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 91) },
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 92) {}
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 93) };
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 94) #endif
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 95)
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 96) /*
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 97) * initialise the fs caching module
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 98) */
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 99) static int __init fscache_init(void)
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 100) {
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 101) unsigned int nr_cpus = num_possible_cpus();
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 102) unsigned int cpu;
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 103) int ret;
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 104)
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 105) fscache_object_max_active =
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 106) clamp_val(nr_cpus,
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 107) fscache_object_max_active, WQ_UNBOUND_MAX_ACTIVE);
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 108)
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 109) ret = -ENOMEM;
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 110) fscache_object_wq = alloc_workqueue("fscache_object", WQ_UNBOUND,
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 111) fscache_object_max_active);
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 112) if (!fscache_object_wq)
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 113) goto error_object_wq;
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 114)
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 115) fscache_op_max_active =
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 116) clamp_val(fscache_object_max_active / 2,
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 117) fscache_op_max_active, WQ_UNBOUND_MAX_ACTIVE);
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 118)
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 119) ret = -ENOMEM;
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 120) fscache_op_wq = alloc_workqueue("fscache_operation", WQ_UNBOUND,
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 121) fscache_op_max_active);
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 122) if (!fscache_op_wq)
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 123) goto error_op_wq;
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 124)
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 125) for_each_possible_cpu(cpu)
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 126) init_waitqueue_head(&per_cpu(fscache_object_cong_wait, cpu));
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 127)
7394daa8c61df (David Howells 2009-04-03 16:42:37 +0100 128) ret = fscache_proc_init();
7394daa8c61df (David Howells 2009-04-03 16:42:37 +0100 129) if (ret < 0)
7394daa8c61df (David Howells 2009-04-03 16:42:37 +0100 130) goto error_proc;
7394daa8c61df (David Howells 2009-04-03 16:42:37 +0100 131)
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 132) #ifdef CONFIG_SYSCTL
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 133) ret = -ENOMEM;
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 134) fscache_sysctl_header = register_sysctl_table(fscache_sysctls_root);
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 135) if (!fscache_sysctl_header)
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 136) goto error_sysctl;
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 137) #endif
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 138)
955d00917f0c0 (David Howells 2009-04-03 16:42:38 +0100 139) fscache_cookie_jar = kmem_cache_create("fscache_cookie_jar",
955d00917f0c0 (David Howells 2009-04-03 16:42:38 +0100 140) sizeof(struct fscache_cookie),
1ff22883b0b2f (David Howells 2018-10-17 15:23:45 +0100 141) 0, 0, NULL);
955d00917f0c0 (David Howells 2009-04-03 16:42:38 +0100 142) if (!fscache_cookie_jar) {
36dfd116edd48 (Fabian Frederick 2014-06-04 16:05:38 -0700 143) pr_notice("Failed to allocate a cookie jar\n");
955d00917f0c0 (David Howells 2009-04-03 16:42:38 +0100 144) ret = -ENOMEM;
955d00917f0c0 (David Howells 2009-04-03 16:42:38 +0100 145) goto error_cookie_jar;
955d00917f0c0 (David Howells 2009-04-03 16:42:38 +0100 146) }
955d00917f0c0 (David Howells 2009-04-03 16:42:38 +0100 147)
4c515dd47ab41 (David Howells 2009-04-03 16:42:37 +0100 148) fscache_root = kobject_create_and_add("fscache", kernel_kobj);
4c515dd47ab41 (David Howells 2009-04-03 16:42:37 +0100 149) if (!fscache_root)
4c515dd47ab41 (David Howells 2009-04-03 16:42:37 +0100 150) goto error_kobj;
4c515dd47ab41 (David Howells 2009-04-03 16:42:37 +0100 151)
36dfd116edd48 (Fabian Frederick 2014-06-04 16:05:38 -0700 152) pr_notice("Loaded\n");
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 153) return 0;
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 154)
4c515dd47ab41 (David Howells 2009-04-03 16:42:37 +0100 155) error_kobj:
955d00917f0c0 (David Howells 2009-04-03 16:42:38 +0100 156) kmem_cache_destroy(fscache_cookie_jar);
955d00917f0c0 (David Howells 2009-04-03 16:42:38 +0100 157) error_cookie_jar:
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 158) #ifdef CONFIG_SYSCTL
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 159) unregister_sysctl_table(fscache_sysctl_header);
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 160) error_sysctl:
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 161) #endif
4c515dd47ab41 (David Howells 2009-04-03 16:42:37 +0100 162) fscache_proc_cleanup();
7394daa8c61df (David Howells 2009-04-03 16:42:37 +0100 163) error_proc:
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 164) destroy_workqueue(fscache_op_wq);
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 165) error_op_wq:
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 166) destroy_workqueue(fscache_object_wq);
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 167) error_object_wq:
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 168) return ret;
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 169) }
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 170)
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 171) fs_initcall(fscache_init);
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 172)
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 173) /*
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 174) * clean up on module removal
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 175) */
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 176) static void __exit fscache_exit(void)
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 177) {
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 178) _enter("");
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 179)
4c515dd47ab41 (David Howells 2009-04-03 16:42:37 +0100 180) kobject_put(fscache_root);
955d00917f0c0 (David Howells 2009-04-03 16:42:38 +0100 181) kmem_cache_destroy(fscache_cookie_jar);
40f2b6ffe525e (Tejun Heo 2010-07-24 11:10:09 +0200 182) #ifdef CONFIG_SYSCTL
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 183) unregister_sysctl_table(fscache_sysctl_header);
40f2b6ffe525e (Tejun Heo 2010-07-24 11:10:09 +0200 184) #endif
7394daa8c61df (David Howells 2009-04-03 16:42:37 +0100 185) fscache_proc_cleanup();
8af7c12436803 (Tejun Heo 2010-07-20 22:09:01 +0200 186) destroy_workqueue(fscache_op_wq);
8b8edefa2fffb (Tejun Heo 2010-07-20 22:09:01 +0200 187) destroy_workqueue(fscache_object_wq);
36dfd116edd48 (Fabian Frederick 2014-06-04 16:05:38 -0700 188) pr_notice("Unloaded\n");
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 189) }
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 190)
06b3db1b9bccd (David Howells 2009-04-03 16:42:36 +0100 191) module_exit(fscache_exit);