1/*
  2 * (C) 2001 Clemson University and The University of Chicago
  3 *
  4 * Changes by Acxiom Corporation to add proc file handler for pvfs2 client
  5 * parameters, Copyright Acxiom Corporation, 2005.
  6 *
  7 * See COPYING in top-level directory.
  8 */
  9
 10#include "protocol.h"
 11#include "orangefs-kernel.h"
 12#include "orangefs-debugfs.h"
 13#include "orangefs-sysfs.h"
 14
 15/* ORANGEFS_VERSION is a ./configure define */
 16#ifndef ORANGEFS_VERSION
 17#define ORANGEFS_VERSION "upstream"
 18#endif
 19
 20/*
 21 * global variables declared here
 22 */
 23
 24/* array of client debug keyword/mask values */
 25struct client_debug_mask *cdm_array;
 26int cdm_element_count;
 27
 28char kernel_debug_string[ORANGEFS_MAX_DEBUG_STRING_LEN] = "none";
 29char client_debug_string[ORANGEFS_MAX_DEBUG_STRING_LEN];
 30char client_debug_array_string[ORANGEFS_MAX_DEBUG_STRING_LEN];
 31
 32char *debug_help_string;
 33int help_string_initialized;
 34struct dentry *help_file_dentry;
 35struct dentry *client_debug_dentry;
 36struct dentry *debug_dir;
 37int client_verbose_index;
 38int client_all_index;
 39struct orangefs_stats g_orangefs_stats;
 40
 41/* the size of the hash tables for ops in progress */
 42int hash_table_size = 509;
 43
 44static ulong module_parm_debug_mask;
 45__u64 gossip_debug_mask;
 46struct client_debug_mask client_debug_mask = { NULL, 0, 0 };
 47unsigned int kernel_mask_set_mod_init; /* implicitly false */
 48int op_timeout_secs = ORANGEFS_DEFAULT_OP_TIMEOUT_SECS;
 49int slot_timeout_secs = ORANGEFS_DEFAULT_SLOT_TIMEOUT_SECS;
 50
 51MODULE_LICENSE("GPL");
 52MODULE_AUTHOR("ORANGEFS Development Team");
 53MODULE_DESCRIPTION("The Linux Kernel VFS interface to ORANGEFS");
 54MODULE_PARM_DESC(module_parm_debug_mask, "debugging level (see orangefs-debug.h for values)");
 55MODULE_PARM_DESC(op_timeout_secs, "Operation timeout in seconds");
 56MODULE_PARM_DESC(slot_timeout_secs, "Slot timeout in seconds");
 57MODULE_PARM_DESC(hash_table_size,
 58		 "size of hash table for operations in progress");
 59
 60static struct file_system_type orangefs_fs_type = {
 61	.name = "pvfs2",
 62	.mount = orangefs_mount,
 63	.kill_sb = orangefs_kill_sb,
 64	.owner = THIS_MODULE,
 65};
 66
 67module_param(hash_table_size, int, 0);
 68module_param(module_parm_debug_mask, ulong, 0644);
 69module_param(op_timeout_secs, int, 0);
 70module_param(slot_timeout_secs, int, 0);
 71
 72/* synchronizes the request device file */
 73DEFINE_MUTEX(devreq_mutex);
 74
 75/*
 76 * Blocks non-priority requests from being queued for servicing.  This
 77 * could be used for protecting the request list data structure, but
 78 * for now it's only being used to stall the op addition to the request
 79 * list
 80 */
 81DEFINE_MUTEX(request_mutex);
 82
 83/* hash table for storing operations waiting for matching downcall */
 84struct list_head *htable_ops_in_progress;
 85DEFINE_SPINLOCK(htable_ops_in_progress_lock);
 86
 87/* list for queueing upcall operations */
 88LIST_HEAD(orangefs_request_list);
 89
 90/* used to protect the above orangefs_request_list */
 91DEFINE_SPINLOCK(orangefs_request_list_lock);
 92
 93/* used for incoming request notification */
 94DECLARE_WAIT_QUEUE_HEAD(orangefs_request_list_waitq);
 95
 96static int __init orangefs_init(void)
 97{
 98	int ret = -1;
 99	__u32 i = 0;
100
101	/* convert input debug mask to a 64-bit unsigned integer */
102	gossip_debug_mask = (unsigned long long) module_parm_debug_mask;
103
104	/*
105	 * set the kernel's gossip debug string; invalid mask values will
106	 * be ignored.
107	 */
108	debug_mask_to_string(&gossip_debug_mask, 0);
109
110	/* remove any invalid values from the mask */
111	debug_string_to_mask(kernel_debug_string, &gossip_debug_mask, 0);
112
113	/*
114	 * if the mask has a non-zero value, then indicate that the mask
115	 * was set when the kernel module was loaded.  The orangefs dev ioctl
116	 * command will look at this boolean to determine if the kernel's
117	 * debug mask should be overwritten when the client-core is started.
118	 */
119	if (gossip_debug_mask != 0)
120		kernel_mask_set_mod_init = true;
121
122	pr_info("%s: called with debug mask: :%s: :%llx:\n",
123		__func__,
124		kernel_debug_string,
125		(unsigned long long)gossip_debug_mask);
126
127	ret = bdi_init(&orangefs_backing_dev_info);
128
129	if (ret)
130		return ret;
131
132	if (op_timeout_secs < 0)
133		op_timeout_secs = 0;
134
135	if (slot_timeout_secs < 0)
136		slot_timeout_secs = 0;
137
138	/* initialize global book keeping data structures */
139	ret = op_cache_initialize();
140	if (ret < 0)
141		goto err;
142
143	ret = orangefs_inode_cache_initialize();
144	if (ret < 0)
145		goto cleanup_op;
146
147	htable_ops_in_progress =
148	    kcalloc(hash_table_size, sizeof(struct list_head), GFP_KERNEL);
149	if (!htable_ops_in_progress) {
150		gossip_err("Failed to initialize op hashtable");
151		ret = -ENOMEM;
152		goto cleanup_inode;
153	}
154
155	/* initialize a doubly linked at each hash table index */
156	for (i = 0; i < hash_table_size; i++)
157		INIT_LIST_HEAD(&htable_ops_in_progress[i]);
158
159	ret = fsid_key_table_initialize();
160	if (ret < 0)
161		goto cleanup_progress_table;
162
163	/*
164	 * Build the contents of /sys/kernel/debug/orangefs/debug-help
165	 * from the keywords in the kernel keyword/mask array.
166	 *
167	 * The keywords in the client keyword/mask array are
168	 * unknown at boot time.
169	 *
170	 * orangefs_prepare_debugfs_help_string will be used again
171	 * later to rebuild the debug-help file after the client starts
172	 * and passes along the needed info. The argument signifies
173	 * which time orangefs_prepare_debugfs_help_string is being
174	 * called.
175	 */
176	ret = orangefs_prepare_debugfs_help_string(1);
177	if (ret)
178		goto cleanup_key_table;
179
180	ret = orangefs_debugfs_init();
181	if (ret)
182		goto debugfs_init_failed;
183
184	ret = orangefs_kernel_debug_init();
185	if (ret)
186		goto kernel_debug_init_failed;
187
188	ret = orangefs_sysfs_init();
189	if (ret)
190		goto sysfs_init_failed;
191
192	/* Initialize the orangefsdev subsystem. */
193	ret = orangefs_dev_init();
194	if (ret < 0) {
195		gossip_err("%s: could not initialize device subsystem %d!\n",
196			   __func__,
197			   ret);
198		goto cleanup_device;
199	}
200
201	ret = register_filesystem(&orangefs_fs_type);
202	if (ret == 0) {
203		pr_info("orangefs: module version %s loaded\n", ORANGEFS_VERSION);
204		ret = 0;
205		goto out;
206	}
207
208	orangefs_sysfs_exit();
209
210cleanup_device:
211	orangefs_dev_cleanup();
212
213sysfs_init_failed:
214
215kernel_debug_init_failed:
216
217debugfs_init_failed:
218	orangefs_debugfs_cleanup();
219
220cleanup_key_table:
221	fsid_key_table_finalize();
222
223cleanup_progress_table:
224	kfree(htable_ops_in_progress);
225
226cleanup_inode:
227	orangefs_inode_cache_finalize();
228
229cleanup_op:
230	op_cache_finalize();
231
232err:
233	bdi_destroy(&orangefs_backing_dev_info);
234
235out:
236	return ret;
237}
238
239static void __exit orangefs_exit(void)
240{
241	int i = 0;
242	gossip_debug(GOSSIP_INIT_DEBUG, "orangefs: orangefs_exit called\n");
243
244	unregister_filesystem(&orangefs_fs_type);
245	orangefs_debugfs_cleanup();
246	orangefs_sysfs_exit();
247	fsid_key_table_finalize();
248	orangefs_dev_cleanup();
249	BUG_ON(!list_empty(&orangefs_request_list));
250	for (i = 0; i < hash_table_size; i++)
251		BUG_ON(!list_empty(&htable_ops_in_progress[i]));
252
253	orangefs_inode_cache_finalize();
254	op_cache_finalize();
255
256	kfree(htable_ops_in_progress);
257
258	bdi_destroy(&orangefs_backing_dev_info);
259
260	pr_info("orangefs: module version %s unloaded\n", ORANGEFS_VERSION);
261}
262
263/*
264 * What we do in this function is to walk the list of operations
265 * that are in progress in the hash table and mark them as purged as well.
266 */
267void purge_inprogress_ops(void)
268{
269	int i;
270
271	for (i = 0; i < hash_table_size; i++) {
272		struct orangefs_kernel_op_s *op;
273		struct orangefs_kernel_op_s *next;
274
275		spin_lock(&htable_ops_in_progress_lock);
276		list_for_each_entry_safe(op,
277					 next,
278					 &htable_ops_in_progress[i],
279					 list) {
280			set_op_state_purged(op);
281			gossip_debug(GOSSIP_DEV_DEBUG,
282				     "%s: op:%s: op_state:%d: process:%s:\n",
283				     __func__,
284				     get_opname_string(op),
285				     op->op_state,
286				     current->comm);
287		}
288		spin_unlock(&htable_ops_in_progress_lock);
289	}
290}
291
292module_init(orangefs_init);
293module_exit(orangefs_exit);