xref: /OK3568_Linux_fs/kernel/fs/afs/main.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-or-later
2*4882a593Smuzhiyun /* AFS client file system
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Copyright (C) 2002,5 Red Hat, Inc. All Rights Reserved.
5*4882a593Smuzhiyun  * Written by David Howells (dhowells@redhat.com)
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #include <linux/module.h>
9*4882a593Smuzhiyun #include <linux/moduleparam.h>
10*4882a593Smuzhiyun #include <linux/init.h>
11*4882a593Smuzhiyun #include <linux/completion.h>
12*4882a593Smuzhiyun #include <linux/sched.h>
13*4882a593Smuzhiyun #include <linux/random.h>
14*4882a593Smuzhiyun #include <linux/proc_fs.h>
15*4882a593Smuzhiyun #define CREATE_TRACE_POINTS
16*4882a593Smuzhiyun #include "internal.h"
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun MODULE_DESCRIPTION("AFS Client File System");
19*4882a593Smuzhiyun MODULE_AUTHOR("Red Hat, Inc.");
20*4882a593Smuzhiyun MODULE_LICENSE("GPL");
21*4882a593Smuzhiyun MODULE_IMPORT_NS(ANDROID_GKI_VFS_EXPORT_ONLY);
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun unsigned afs_debug;
24*4882a593Smuzhiyun module_param_named(debug, afs_debug, uint, S_IWUSR | S_IRUGO);
25*4882a593Smuzhiyun MODULE_PARM_DESC(debug, "AFS debugging mask");
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun static char *rootcell;
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun module_param(rootcell, charp, 0);
30*4882a593Smuzhiyun MODULE_PARM_DESC(rootcell, "root AFS cell name and VL server IP addr list");
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun struct workqueue_struct *afs_wq;
33*4882a593Smuzhiyun static struct proc_dir_entry *afs_proc_symlink;
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun #if defined(CONFIG_ALPHA)
36*4882a593Smuzhiyun const char afs_init_sysname[] = "alpha_linux26";
37*4882a593Smuzhiyun #elif defined(CONFIG_X86_64)
38*4882a593Smuzhiyun const char afs_init_sysname[] = "amd64_linux26";
39*4882a593Smuzhiyun #elif defined(CONFIG_ARM)
40*4882a593Smuzhiyun const char afs_init_sysname[] = "arm_linux26";
41*4882a593Smuzhiyun #elif defined(CONFIG_ARM64)
42*4882a593Smuzhiyun const char afs_init_sysname[] = "aarch64_linux26";
43*4882a593Smuzhiyun #elif defined(CONFIG_X86_32)
44*4882a593Smuzhiyun const char afs_init_sysname[] = "i386_linux26";
45*4882a593Smuzhiyun #elif defined(CONFIG_IA64)
46*4882a593Smuzhiyun const char afs_init_sysname[] = "ia64_linux26";
47*4882a593Smuzhiyun #elif defined(CONFIG_PPC64)
48*4882a593Smuzhiyun const char afs_init_sysname[] = "ppc64_linux26";
49*4882a593Smuzhiyun #elif defined(CONFIG_PPC32)
50*4882a593Smuzhiyun const char afs_init_sysname[] = "ppc_linux26";
51*4882a593Smuzhiyun #elif defined(CONFIG_S390)
52*4882a593Smuzhiyun #ifdef CONFIG_64BIT
53*4882a593Smuzhiyun const char afs_init_sysname[] = "s390x_linux26";
54*4882a593Smuzhiyun #else
55*4882a593Smuzhiyun const char afs_init_sysname[] = "s390_linux26";
56*4882a593Smuzhiyun #endif
57*4882a593Smuzhiyun #elif defined(CONFIG_SPARC64)
58*4882a593Smuzhiyun const char afs_init_sysname[] = "sparc64_linux26";
59*4882a593Smuzhiyun #elif defined(CONFIG_SPARC32)
60*4882a593Smuzhiyun const char afs_init_sysname[] = "sparc_linux26";
61*4882a593Smuzhiyun #else
62*4882a593Smuzhiyun const char afs_init_sysname[] = "unknown_linux26";
63*4882a593Smuzhiyun #endif
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun /*
66*4882a593Smuzhiyun  * Initialise an AFS network namespace record.
67*4882a593Smuzhiyun  */
afs_net_init(struct net * net_ns)68*4882a593Smuzhiyun static int __net_init afs_net_init(struct net *net_ns)
69*4882a593Smuzhiyun {
70*4882a593Smuzhiyun 	struct afs_sysnames *sysnames;
71*4882a593Smuzhiyun 	struct afs_net *net = afs_net(net_ns);
72*4882a593Smuzhiyun 	int ret;
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun 	net->net = net_ns;
75*4882a593Smuzhiyun 	net->live = true;
76*4882a593Smuzhiyun 	generate_random_uuid((unsigned char *)&net->uuid);
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun 	INIT_WORK(&net->charge_preallocation_work, afs_charge_preallocation);
79*4882a593Smuzhiyun 	mutex_init(&net->socket_mutex);
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun 	net->cells = RB_ROOT;
82*4882a593Smuzhiyun 	init_rwsem(&net->cells_lock);
83*4882a593Smuzhiyun 	INIT_WORK(&net->cells_manager, afs_manage_cells);
84*4882a593Smuzhiyun 	timer_setup(&net->cells_timer, afs_cells_timer, 0);
85*4882a593Smuzhiyun 
86*4882a593Smuzhiyun 	mutex_init(&net->cells_alias_lock);
87*4882a593Smuzhiyun 	mutex_init(&net->proc_cells_lock);
88*4882a593Smuzhiyun 	INIT_HLIST_HEAD(&net->proc_cells);
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun 	seqlock_init(&net->fs_lock);
91*4882a593Smuzhiyun 	net->fs_servers = RB_ROOT;
92*4882a593Smuzhiyun 	INIT_LIST_HEAD(&net->fs_probe_fast);
93*4882a593Smuzhiyun 	INIT_LIST_HEAD(&net->fs_probe_slow);
94*4882a593Smuzhiyun 	INIT_HLIST_HEAD(&net->fs_proc);
95*4882a593Smuzhiyun 
96*4882a593Smuzhiyun 	INIT_HLIST_HEAD(&net->fs_addresses4);
97*4882a593Smuzhiyun 	INIT_HLIST_HEAD(&net->fs_addresses6);
98*4882a593Smuzhiyun 	seqlock_init(&net->fs_addr_lock);
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun 	INIT_WORK(&net->fs_manager, afs_manage_servers);
101*4882a593Smuzhiyun 	timer_setup(&net->fs_timer, afs_servers_timer, 0);
102*4882a593Smuzhiyun 	INIT_WORK(&net->fs_prober, afs_fs_probe_dispatcher);
103*4882a593Smuzhiyun 	timer_setup(&net->fs_probe_timer, afs_fs_probe_timer, 0);
104*4882a593Smuzhiyun 	atomic_set(&net->servers_outstanding, 1);
105*4882a593Smuzhiyun 
106*4882a593Smuzhiyun 	ret = -ENOMEM;
107*4882a593Smuzhiyun 	sysnames = kzalloc(sizeof(*sysnames), GFP_KERNEL);
108*4882a593Smuzhiyun 	if (!sysnames)
109*4882a593Smuzhiyun 		goto error_sysnames;
110*4882a593Smuzhiyun 	sysnames->subs[0] = (char *)&afs_init_sysname;
111*4882a593Smuzhiyun 	sysnames->nr = 1;
112*4882a593Smuzhiyun 	refcount_set(&sysnames->usage, 1);
113*4882a593Smuzhiyun 	net->sysnames = sysnames;
114*4882a593Smuzhiyun 	rwlock_init(&net->sysnames_lock);
115*4882a593Smuzhiyun 
116*4882a593Smuzhiyun 	/* Register the /proc stuff */
117*4882a593Smuzhiyun 	ret = afs_proc_init(net);
118*4882a593Smuzhiyun 	if (ret < 0)
119*4882a593Smuzhiyun 		goto error_proc;
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun 	/* Initialise the cell DB */
122*4882a593Smuzhiyun 	ret = afs_cell_init(net, rootcell);
123*4882a593Smuzhiyun 	if (ret < 0)
124*4882a593Smuzhiyun 		goto error_cell_init;
125*4882a593Smuzhiyun 
126*4882a593Smuzhiyun 	/* Create the RxRPC transport */
127*4882a593Smuzhiyun 	ret = afs_open_socket(net);
128*4882a593Smuzhiyun 	if (ret < 0)
129*4882a593Smuzhiyun 		goto error_open_socket;
130*4882a593Smuzhiyun 
131*4882a593Smuzhiyun 	return 0;
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun error_open_socket:
134*4882a593Smuzhiyun 	net->live = false;
135*4882a593Smuzhiyun 	afs_fs_probe_cleanup(net);
136*4882a593Smuzhiyun 	afs_cell_purge(net);
137*4882a593Smuzhiyun 	afs_purge_servers(net);
138*4882a593Smuzhiyun error_cell_init:
139*4882a593Smuzhiyun 	net->live = false;
140*4882a593Smuzhiyun 	afs_proc_cleanup(net);
141*4882a593Smuzhiyun error_proc:
142*4882a593Smuzhiyun 	afs_put_sysnames(net->sysnames);
143*4882a593Smuzhiyun error_sysnames:
144*4882a593Smuzhiyun 	net->live = false;
145*4882a593Smuzhiyun 	return ret;
146*4882a593Smuzhiyun }
147*4882a593Smuzhiyun 
148*4882a593Smuzhiyun /*
149*4882a593Smuzhiyun  * Clean up and destroy an AFS network namespace record.
150*4882a593Smuzhiyun  */
afs_net_exit(struct net * net_ns)151*4882a593Smuzhiyun static void __net_exit afs_net_exit(struct net *net_ns)
152*4882a593Smuzhiyun {
153*4882a593Smuzhiyun 	struct afs_net *net = afs_net(net_ns);
154*4882a593Smuzhiyun 
155*4882a593Smuzhiyun 	net->live = false;
156*4882a593Smuzhiyun 	afs_fs_probe_cleanup(net);
157*4882a593Smuzhiyun 	afs_cell_purge(net);
158*4882a593Smuzhiyun 	afs_purge_servers(net);
159*4882a593Smuzhiyun 	afs_close_socket(net);
160*4882a593Smuzhiyun 	afs_proc_cleanup(net);
161*4882a593Smuzhiyun 	afs_put_sysnames(net->sysnames);
162*4882a593Smuzhiyun }
163*4882a593Smuzhiyun 
164*4882a593Smuzhiyun static struct pernet_operations afs_net_ops = {
165*4882a593Smuzhiyun 	.init	= afs_net_init,
166*4882a593Smuzhiyun 	.exit	= afs_net_exit,
167*4882a593Smuzhiyun 	.id	= &afs_net_id,
168*4882a593Smuzhiyun 	.size	= sizeof(struct afs_net),
169*4882a593Smuzhiyun };
170*4882a593Smuzhiyun 
171*4882a593Smuzhiyun /*
172*4882a593Smuzhiyun  * initialise the AFS client FS module
173*4882a593Smuzhiyun  */
afs_init(void)174*4882a593Smuzhiyun static int __init afs_init(void)
175*4882a593Smuzhiyun {
176*4882a593Smuzhiyun 	int ret = -ENOMEM;
177*4882a593Smuzhiyun 
178*4882a593Smuzhiyun 	printk(KERN_INFO "kAFS: Red Hat AFS client v0.1 registering.\n");
179*4882a593Smuzhiyun 
180*4882a593Smuzhiyun 	afs_wq = alloc_workqueue("afs", 0, 0);
181*4882a593Smuzhiyun 	if (!afs_wq)
182*4882a593Smuzhiyun 		goto error_afs_wq;
183*4882a593Smuzhiyun 	afs_async_calls = alloc_workqueue("kafsd", WQ_MEM_RECLAIM, 0);
184*4882a593Smuzhiyun 	if (!afs_async_calls)
185*4882a593Smuzhiyun 		goto error_async;
186*4882a593Smuzhiyun 	afs_lock_manager = alloc_workqueue("kafs_lockd", WQ_MEM_RECLAIM, 0);
187*4882a593Smuzhiyun 	if (!afs_lock_manager)
188*4882a593Smuzhiyun 		goto error_lockmgr;
189*4882a593Smuzhiyun 
190*4882a593Smuzhiyun #ifdef CONFIG_AFS_FSCACHE
191*4882a593Smuzhiyun 	/* we want to be able to cache */
192*4882a593Smuzhiyun 	ret = fscache_register_netfs(&afs_cache_netfs);
193*4882a593Smuzhiyun 	if (ret < 0)
194*4882a593Smuzhiyun 		goto error_cache;
195*4882a593Smuzhiyun #endif
196*4882a593Smuzhiyun 
197*4882a593Smuzhiyun 	ret = register_pernet_device(&afs_net_ops);
198*4882a593Smuzhiyun 	if (ret < 0)
199*4882a593Smuzhiyun 		goto error_net;
200*4882a593Smuzhiyun 
201*4882a593Smuzhiyun 	/* register the filesystems */
202*4882a593Smuzhiyun 	ret = afs_fs_init();
203*4882a593Smuzhiyun 	if (ret < 0)
204*4882a593Smuzhiyun 		goto error_fs;
205*4882a593Smuzhiyun 
206*4882a593Smuzhiyun 	afs_proc_symlink = proc_symlink("fs/afs", NULL, "../self/net/afs");
207*4882a593Smuzhiyun 	if (!afs_proc_symlink) {
208*4882a593Smuzhiyun 		ret = -ENOMEM;
209*4882a593Smuzhiyun 		goto error_proc;
210*4882a593Smuzhiyun 	}
211*4882a593Smuzhiyun 
212*4882a593Smuzhiyun 	return ret;
213*4882a593Smuzhiyun 
214*4882a593Smuzhiyun error_proc:
215*4882a593Smuzhiyun 	afs_fs_exit();
216*4882a593Smuzhiyun error_fs:
217*4882a593Smuzhiyun 	unregister_pernet_device(&afs_net_ops);
218*4882a593Smuzhiyun error_net:
219*4882a593Smuzhiyun #ifdef CONFIG_AFS_FSCACHE
220*4882a593Smuzhiyun 	fscache_unregister_netfs(&afs_cache_netfs);
221*4882a593Smuzhiyun error_cache:
222*4882a593Smuzhiyun #endif
223*4882a593Smuzhiyun 	destroy_workqueue(afs_lock_manager);
224*4882a593Smuzhiyun error_lockmgr:
225*4882a593Smuzhiyun 	destroy_workqueue(afs_async_calls);
226*4882a593Smuzhiyun error_async:
227*4882a593Smuzhiyun 	destroy_workqueue(afs_wq);
228*4882a593Smuzhiyun error_afs_wq:
229*4882a593Smuzhiyun 	rcu_barrier();
230*4882a593Smuzhiyun 	printk(KERN_ERR "kAFS: failed to register: %d\n", ret);
231*4882a593Smuzhiyun 	return ret;
232*4882a593Smuzhiyun }
233*4882a593Smuzhiyun 
234*4882a593Smuzhiyun /* XXX late_initcall is kludgy, but the only alternative seems to create
235*4882a593Smuzhiyun  * a transport upon the first mount, which is worse. Or is it?
236*4882a593Smuzhiyun  */
237*4882a593Smuzhiyun late_initcall(afs_init);	/* must be called after net/ to create socket */
238*4882a593Smuzhiyun 
239*4882a593Smuzhiyun /*
240*4882a593Smuzhiyun  * clean up on module removal
241*4882a593Smuzhiyun  */
afs_exit(void)242*4882a593Smuzhiyun static void __exit afs_exit(void)
243*4882a593Smuzhiyun {
244*4882a593Smuzhiyun 	printk(KERN_INFO "kAFS: Red Hat AFS client v0.1 unregistering.\n");
245*4882a593Smuzhiyun 
246*4882a593Smuzhiyun 	proc_remove(afs_proc_symlink);
247*4882a593Smuzhiyun 	afs_fs_exit();
248*4882a593Smuzhiyun 	unregister_pernet_device(&afs_net_ops);
249*4882a593Smuzhiyun #ifdef CONFIG_AFS_FSCACHE
250*4882a593Smuzhiyun 	fscache_unregister_netfs(&afs_cache_netfs);
251*4882a593Smuzhiyun #endif
252*4882a593Smuzhiyun 	destroy_workqueue(afs_lock_manager);
253*4882a593Smuzhiyun 	destroy_workqueue(afs_async_calls);
254*4882a593Smuzhiyun 	destroy_workqueue(afs_wq);
255*4882a593Smuzhiyun 	afs_clean_up_permit_cache();
256*4882a593Smuzhiyun 	rcu_barrier();
257*4882a593Smuzhiyun }
258*4882a593Smuzhiyun 
259*4882a593Smuzhiyun module_exit(afs_exit);
260