Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * linux/fs/nfs/cache_lib.c
4 *
5 * Helper routines for the NFS client caches
6 *
7 * Copyright (c) 2009 Trond Myklebust <Trond.Myklebust@netapp.com>
8 */
9#include <linux/kmod.h>
10#include <linux/module.h>
11#include <linux/moduleparam.h>
12#include <linux/mount.h>
13#include <linux/namei.h>
14#include <linux/slab.h>
15#include <linux/sunrpc/cache.h>
16#include <linux/sunrpc/rpc_pipe_fs.h>
17#include <net/net_namespace.h>
18
19#include "cache_lib.h"
20
21#define NFS_CACHE_UPCALL_PATHLEN 256
22#define NFS_CACHE_UPCALL_TIMEOUT 15
23
24static char nfs_cache_getent_prog[NFS_CACHE_UPCALL_PATHLEN] =
25 "/sbin/nfs_cache_getent";
26static unsigned long nfs_cache_getent_timeout = NFS_CACHE_UPCALL_TIMEOUT;
27
28module_param_string(cache_getent, nfs_cache_getent_prog,
29 sizeof(nfs_cache_getent_prog), 0600);
30MODULE_PARM_DESC(cache_getent, "Path to the client cache upcall program");
31module_param_named(cache_getent_timeout, nfs_cache_getent_timeout, ulong, 0600);
32MODULE_PARM_DESC(cache_getent_timeout, "Timeout (in seconds) after which "
33 "the cache upcall is assumed to have failed");
34
35int nfs_cache_upcall(struct cache_detail *cd, char *entry_name)
36{
37 static char *envp[] = { "HOME=/",
38 "TERM=linux",
39 "PATH=/sbin:/usr/sbin:/bin:/usr/bin",
40 NULL
41 };
42 char *argv[] = {
43 nfs_cache_getent_prog,
44 cd->name,
45 entry_name,
46 NULL
47 };
48 int ret = -EACCES;
49
50 if (nfs_cache_getent_prog[0] == '\0')
51 goto out;
52 ret = call_usermodehelper(argv[0], argv, envp, UMH_WAIT_EXEC);
53 /*
54 * Disable the upcall mechanism if we're getting an ENOENT or
55 * EACCES error. The admin can re-enable it on the fly by using
56 * sysfs to set the 'cache_getent' parameter once the problem
57 * has been fixed.
58 */
59 if (ret == -ENOENT || ret == -EACCES)
60 nfs_cache_getent_prog[0] = '\0';
61out:
62 return ret > 0 ? 0 : ret;
63}
64
65/*
66 * Deferred request handling
67 */
68void nfs_cache_defer_req_put(struct nfs_cache_defer_req *dreq)
69{
70 if (refcount_dec_and_test(&dreq->count))
71 kfree(dreq);
72}
73
74static void nfs_dns_cache_revisit(struct cache_deferred_req *d, int toomany)
75{
76 struct nfs_cache_defer_req *dreq;
77
78 dreq = container_of(d, struct nfs_cache_defer_req, deferred_req);
79
80 complete(&dreq->completion);
81 nfs_cache_defer_req_put(dreq);
82}
83
84static struct cache_deferred_req *nfs_dns_cache_defer(struct cache_req *req)
85{
86 struct nfs_cache_defer_req *dreq;
87
88 dreq = container_of(req, struct nfs_cache_defer_req, req);
89 dreq->deferred_req.revisit = nfs_dns_cache_revisit;
90 refcount_inc(&dreq->count);
91
92 return &dreq->deferred_req;
93}
94
95struct nfs_cache_defer_req *nfs_cache_defer_req_alloc(void)
96{
97 struct nfs_cache_defer_req *dreq;
98
99 dreq = kzalloc(sizeof(*dreq), GFP_KERNEL);
100 if (dreq) {
101 init_completion(&dreq->completion);
102 refcount_set(&dreq->count, 1);
103 dreq->req.defer = nfs_dns_cache_defer;
104 }
105 return dreq;
106}
107
108int nfs_cache_wait_for_upcall(struct nfs_cache_defer_req *dreq)
109{
110 if (wait_for_completion_timeout(&dreq->completion,
111 nfs_cache_getent_timeout * HZ) == 0)
112 return -ETIMEDOUT;
113 return 0;
114}
115
116int nfs_cache_register_sb(struct super_block *sb, struct cache_detail *cd)
117{
118 int ret;
119 struct dentry *dir;
120
121 dir = rpc_d_lookup_sb(sb, "cache");
122 ret = sunrpc_cache_register_pipefs(dir, cd->name, 0600, cd);
123 dput(dir);
124 return ret;
125}
126
127int nfs_cache_register_net(struct net *net, struct cache_detail *cd)
128{
129 struct super_block *pipefs_sb;
130 int ret = 0;
131
132 sunrpc_init_cache_detail(cd);
133 pipefs_sb = rpc_get_sb_net(net);
134 if (pipefs_sb) {
135 ret = nfs_cache_register_sb(pipefs_sb, cd);
136 rpc_put_sb_net(net);
137 if (ret)
138 sunrpc_destroy_cache_detail(cd);
139 }
140 return ret;
141}
142
143void nfs_cache_unregister_sb(struct super_block *sb, struct cache_detail *cd)
144{
145 sunrpc_cache_unregister_pipefs(cd);
146}
147
148void nfs_cache_unregister_net(struct net *net, struct cache_detail *cd)
149{
150 struct super_block *pipefs_sb;
151
152 pipefs_sb = rpc_get_sb_net(net);
153 if (pipefs_sb) {
154 nfs_cache_unregister_sb(pipefs_sb, cd);
155 rpc_put_sb_net(net);
156 }
157 sunrpc_destroy_cache_detail(cd);
158}
1/*
2 * linux/fs/nfs/cache_lib.c
3 *
4 * Helper routines for the NFS client caches
5 *
6 * Copyright (c) 2009 Trond Myklebust <Trond.Myklebust@netapp.com>
7 */
8#include <linux/kmod.h>
9#include <linux/module.h>
10#include <linux/moduleparam.h>
11#include <linux/mount.h>
12#include <linux/namei.h>
13#include <linux/slab.h>
14#include <linux/sunrpc/cache.h>
15#include <linux/sunrpc/rpc_pipe_fs.h>
16
17#include "cache_lib.h"
18
19#define NFS_CACHE_UPCALL_PATHLEN 256
20#define NFS_CACHE_UPCALL_TIMEOUT 15
21
22static char nfs_cache_getent_prog[NFS_CACHE_UPCALL_PATHLEN] =
23 "/sbin/nfs_cache_getent";
24static unsigned long nfs_cache_getent_timeout = NFS_CACHE_UPCALL_TIMEOUT;
25
26module_param_string(cache_getent, nfs_cache_getent_prog,
27 sizeof(nfs_cache_getent_prog), 0600);
28MODULE_PARM_DESC(cache_getent, "Path to the client cache upcall program");
29module_param_named(cache_getent_timeout, nfs_cache_getent_timeout, ulong, 0600);
30MODULE_PARM_DESC(cache_getent_timeout, "Timeout (in seconds) after which "
31 "the cache upcall is assumed to have failed");
32
33int nfs_cache_upcall(struct cache_detail *cd, char *entry_name)
34{
35 static char *envp[] = { "HOME=/",
36 "TERM=linux",
37 "PATH=/sbin:/usr/sbin:/bin:/usr/bin",
38 NULL
39 };
40 char *argv[] = {
41 nfs_cache_getent_prog,
42 cd->name,
43 entry_name,
44 NULL
45 };
46 int ret = -EACCES;
47
48 if (nfs_cache_getent_prog[0] == '\0')
49 goto out;
50 ret = call_usermodehelper(argv[0], argv, envp, UMH_WAIT_EXEC);
51 /*
52 * Disable the upcall mechanism if we're getting an ENOENT or
53 * EACCES error. The admin can re-enable it on the fly by using
54 * sysfs to set the 'cache_getent' parameter once the problem
55 * has been fixed.
56 */
57 if (ret == -ENOENT || ret == -EACCES)
58 nfs_cache_getent_prog[0] = '\0';
59out:
60 return ret > 0 ? 0 : ret;
61}
62
63/*
64 * Deferred request handling
65 */
66void nfs_cache_defer_req_put(struct nfs_cache_defer_req *dreq)
67{
68 if (atomic_dec_and_test(&dreq->count))
69 kfree(dreq);
70}
71
72static void nfs_dns_cache_revisit(struct cache_deferred_req *d, int toomany)
73{
74 struct nfs_cache_defer_req *dreq;
75
76 dreq = container_of(d, struct nfs_cache_defer_req, deferred_req);
77
78 complete_all(&dreq->completion);
79 nfs_cache_defer_req_put(dreq);
80}
81
82static struct cache_deferred_req *nfs_dns_cache_defer(struct cache_req *req)
83{
84 struct nfs_cache_defer_req *dreq;
85
86 dreq = container_of(req, struct nfs_cache_defer_req, req);
87 dreq->deferred_req.revisit = nfs_dns_cache_revisit;
88 atomic_inc(&dreq->count);
89
90 return &dreq->deferred_req;
91}
92
93struct nfs_cache_defer_req *nfs_cache_defer_req_alloc(void)
94{
95 struct nfs_cache_defer_req *dreq;
96
97 dreq = kzalloc(sizeof(*dreq), GFP_KERNEL);
98 if (dreq) {
99 init_completion(&dreq->completion);
100 atomic_set(&dreq->count, 1);
101 dreq->req.defer = nfs_dns_cache_defer;
102 }
103 return dreq;
104}
105
106int nfs_cache_wait_for_upcall(struct nfs_cache_defer_req *dreq)
107{
108 if (wait_for_completion_timeout(&dreq->completion,
109 nfs_cache_getent_timeout * HZ) == 0)
110 return -ETIMEDOUT;
111 return 0;
112}
113
114int nfs_cache_register(struct cache_detail *cd)
115{
116 struct vfsmount *mnt;
117 struct path path;
118 int ret;
119
120 mnt = rpc_get_mount();
121 if (IS_ERR(mnt))
122 return PTR_ERR(mnt);
123 ret = vfs_path_lookup(mnt->mnt_root, mnt, "/cache", 0, &path);
124 if (ret)
125 goto err;
126 ret = sunrpc_cache_register_pipefs(path.dentry, cd->name, 0600, cd);
127 path_put(&path);
128 if (!ret)
129 return ret;
130err:
131 rpc_put_mount();
132 return ret;
133}
134
135void nfs_cache_unregister(struct cache_detail *cd)
136{
137 sunrpc_cache_unregister_pipefs(cd);
138 rpc_put_mount();
139}
140