2 * What: /sys/kernel/debug/orangefs/debug-help
4 * Contact: Mike Marshall <hubcap@omnibond.com>
6 * List of client and kernel debug keywords.
9 * What: /sys/kernel/debug/orangefs/client-debug
11 * Contact: Mike Marshall <hubcap@omnibond.com>
13 * Debug setting for "the client", the userspace
14 * helper for the kernel module.
17 * What: /sys/kernel/debug/orangefs/kernel-debug
19 * Contact: Mike Marshall <hubcap@omnibond.com>
21 * Debug setting for the orangefs kernel module.
23 * Any of the keywords, or comma-separated lists
24 * of keywords, from debug-help can be catted to
25 * client-debug or kernel-debug.
27 * "none", "all" and "verbose" are special keywords
28 * for client-debug. Setting client-debug to "all"
29 * is kind of like trying to drink water from a
30 * fire hose, "verbose" triggers most of the same
31 * output except for the constant flow of output
32 * from the main wait loop.
34 * "none" and "all" are similar settings for kernel-debug
35 * no need for a "verbose".
37 #include <linux/debugfs.h>
38 #include <linux/slab.h>
40 #include <linux/uaccess.h>
42 #include "orangefs-debugfs.h"
44 #include "orangefs-kernel.h"
46 static int orangefs_debug_disabled = 1;
48 static int orangefs_debug_help_open(struct inode *, struct file *);
50 const struct file_operations debug_help_fops = {
51 .open = orangefs_debug_help_open,
53 .release = seq_release,
57 static void *help_start(struct seq_file *, loff_t *);
58 static void *help_next(struct seq_file *, void *, loff_t *);
59 static void help_stop(struct seq_file *, void *);
60 static int help_show(struct seq_file *, void *);
62 static const struct seq_operations help_debug_ops = {
70 * Used to protect data in ORANGEFS_KMOD_DEBUG_FILE and
71 * ORANGEFS_KMOD_DEBUG_FILE.
73 static DEFINE_MUTEX(orangefs_debug_lock);
75 int orangefs_debug_open(struct inode *, struct file *);
77 static ssize_t orangefs_debug_read(struct file *,
82 static ssize_t orangefs_debug_write(struct file *,
87 static const struct file_operations kernel_debug_fops = {
88 .open = orangefs_debug_open,
89 .read = orangefs_debug_read,
90 .write = orangefs_debug_write,
91 .llseek = generic_file_llseek,
95 * initialize kmod debug operations, create orangefs debugfs dir and
96 * ORANGEFS_KMOD_DEBUG_HELP_FILE.
98 int orangefs_debugfs_init(void)
103 debug_dir = debugfs_create_dir("orangefs", NULL);
105 pr_info("%s: debugfs_create_dir failed.\n", __func__);
109 help_file_dentry = debugfs_create_file(ORANGEFS_KMOD_DEBUG_HELP_FILE,
114 if (!help_file_dentry) {
115 pr_info("%s: debugfs_create_file failed.\n", __func__);
119 orangefs_debug_disabled = 0;
127 void orangefs_debugfs_cleanup(void)
130 debugfs_remove_recursive(debug_dir);
133 /* open ORANGEFS_KMOD_DEBUG_HELP_FILE */
134 static int orangefs_debug_help_open(struct inode *inode, struct file *file)
139 gossip_debug(GOSSIP_DEBUGFS_DEBUG,
140 "orangefs_debug_help_open: start\n");
142 if (orangefs_debug_disabled)
145 ret = seq_open(file, &help_debug_ops);
149 ((struct seq_file *)(file->private_data))->private = inode->i_private;
154 gossip_debug(GOSSIP_DEBUGFS_DEBUG,
155 "orangefs_debug_help_open: rc:%d:\n",
161 * I think start always gets called again after stop. Start
162 * needs to return NULL when it is done. The whole "payload"
163 * in this case is a single (long) string, so by the second
164 * time we get to start (pos = 1), we're done.
166 static void *help_start(struct seq_file *m, loff_t *pos)
168 void *payload = NULL;
170 gossip_debug(GOSSIP_DEBUGFS_DEBUG, "help_start: start\n");
173 payload = m->private;
178 static void *help_next(struct seq_file *m, void *v, loff_t *pos)
180 gossip_debug(GOSSIP_DEBUGFS_DEBUG, "help_next: start\n");
185 static void help_stop(struct seq_file *m, void *p)
187 gossip_debug(GOSSIP_DEBUGFS_DEBUG, "help_stop: start\n");
190 static int help_show(struct seq_file *m, void *v)
192 gossip_debug(GOSSIP_DEBUGFS_DEBUG, "help_show: start\n");
200 * initialize the kernel-debug file.
202 int orangefs_kernel_debug_init(void)
206 char *k_buffer = NULL;
208 gossip_debug(GOSSIP_DEBUGFS_DEBUG, "%s: start\n", __func__);
210 k_buffer = kzalloc(ORANGEFS_MAX_DEBUG_STRING_LEN, GFP_KERNEL);
214 if (strlen(kernel_debug_string) + 1 < ORANGEFS_MAX_DEBUG_STRING_LEN) {
215 strcpy(k_buffer, kernel_debug_string);
216 strcat(k_buffer, "\n");
218 strcpy(k_buffer, "none\n");
219 pr_info("%s: overflow 1!\n", __func__);
222 ret = debugfs_create_file(ORANGEFS_KMOD_DEBUG_FILE,
228 pr_info("%s: failed to create %s.\n",
230 ORANGEFS_KMOD_DEBUG_FILE);
238 gossip_debug(GOSSIP_DEBUGFS_DEBUG, "%s: rc:%d:\n", __func__, rc);
243 * initialize the client-debug file.
245 int orangefs_client_debug_init(void)
249 char *c_buffer = NULL;
251 gossip_debug(GOSSIP_DEBUGFS_DEBUG, "%s: start\n", __func__);
253 c_buffer = kzalloc(ORANGEFS_MAX_DEBUG_STRING_LEN, GFP_KERNEL);
257 if (strlen(client_debug_string) + 1 < ORANGEFS_MAX_DEBUG_STRING_LEN) {
258 strcpy(c_buffer, client_debug_string);
259 strcat(c_buffer, "\n");
261 strcpy(c_buffer, "none\n");
262 pr_info("%s: overflow! 2\n", __func__);
265 client_debug_dentry = debugfs_create_file(ORANGEFS_CLIENT_DEBUG_FILE,
270 if (!client_debug_dentry) {
271 pr_info("%s: failed to create updated %s.\n",
273 ORANGEFS_CLIENT_DEBUG_FILE);
281 gossip_debug(GOSSIP_DEBUGFS_DEBUG, "%s: rc:%d:\n", __func__, rc);
285 /* open ORANGEFS_KMOD_DEBUG_FILE or ORANGEFS_CLIENT_DEBUG_FILE.*/
286 int orangefs_debug_open(struct inode *inode, struct file *file)
290 gossip_debug(GOSSIP_DEBUGFS_DEBUG,
291 "%s: orangefs_debug_disabled: %d\n",
293 orangefs_debug_disabled);
295 if (orangefs_debug_disabled)
299 mutex_lock(&orangefs_debug_lock);
300 file->private_data = inode->i_private;
301 mutex_unlock(&orangefs_debug_lock);
304 gossip_debug(GOSSIP_DEBUGFS_DEBUG,
305 "orangefs_debug_open: rc: %d\n",
310 static ssize_t orangefs_debug_read(struct file *file,
317 ssize_t read_ret = -ENOMEM;
319 gossip_debug(GOSSIP_DEBUGFS_DEBUG, "orangefs_debug_read: start\n");
321 buf = kmalloc(ORANGEFS_MAX_DEBUG_STRING_LEN, GFP_KERNEL);
325 mutex_lock(&orangefs_debug_lock);
326 sprintf_ret = sprintf(buf, "%s", (char *)file->private_data);
327 mutex_unlock(&orangefs_debug_lock);
329 read_ret = simple_read_from_buffer(ubuf, count, ppos, buf, sprintf_ret);
334 gossip_debug(GOSSIP_DEBUGFS_DEBUG,
335 "orangefs_debug_read: ret: %zu\n",
341 static ssize_t orangefs_debug_write(struct file *file,
342 const char __user *ubuf,
350 struct orangefs_kernel_op_s *new_op = NULL;
351 struct client_debug_mask c_mask = { NULL, 0, 0 };
353 gossip_debug(GOSSIP_DEBUGFS_DEBUG,
354 "orangefs_debug_write: %s\n",
355 file->f_path.dentry->d_name.name);
358 * Thwart users who try to jamb a ridiculous number
359 * of bytes into the debug file...
361 if (count > ORANGEFS_MAX_DEBUG_STRING_LEN + 1) {
363 count = ORANGEFS_MAX_DEBUG_STRING_LEN + 1;
366 buf = kzalloc(ORANGEFS_MAX_DEBUG_STRING_LEN, GFP_KERNEL);
370 if (copy_from_user(buf, ubuf, count - 1)) {
371 gossip_debug(GOSSIP_DEBUGFS_DEBUG,
372 "%s: copy_from_user failed!\n",
378 * Map the keyword string from userspace into a valid debug mask.
379 * The mapping process involves mapping the human-inputted string
380 * into a valid mask, and then rebuilding the string from the
381 * verified valid mask.
383 * A service operation is required to set a new client-side
386 if (!strcmp(file->f_path.dentry->d_name.name,
387 ORANGEFS_KMOD_DEBUG_FILE)) {
388 debug_string_to_mask(buf, &gossip_debug_mask, 0);
389 debug_mask_to_string(&gossip_debug_mask, 0);
390 debug_string = kernel_debug_string;
391 gossip_debug(GOSSIP_DEBUGFS_DEBUG,
392 "New kernel debug string is %s\n",
393 kernel_debug_string);
395 /* Can't reset client debug mask if client is not running. */
396 if (is_daemon_in_service()) {
397 pr_info("%s: Client not running :%d:\n",
399 is_daemon_in_service());
403 debug_string_to_mask(buf, &c_mask, 1);
404 debug_mask_to_string(&c_mask, 1);
405 debug_string = client_debug_string;
407 new_op = op_alloc(ORANGEFS_VFS_OP_PARAM);
409 pr_info("%s: op_alloc failed!\n", __func__);
413 new_op->upcall.req.param.op =
414 ORANGEFS_PARAM_REQUEST_OP_TWO_MASK_VALUES;
415 new_op->upcall.req.param.type = ORANGEFS_PARAM_REQUEST_SET;
416 memset(new_op->upcall.req.param.s_value,
418 ORANGEFS_MAX_DEBUG_STRING_LEN);
419 sprintf(new_op->upcall.req.param.s_value,
424 /* service_operation returns 0 on success... */
425 rc = service_operation(new_op,
427 ORANGEFS_OP_INTERRUPTIBLE);
430 gossip_debug(GOSSIP_DEBUGFS_DEBUG,
431 "%s: service_operation failed! rc:%d:\n",
438 mutex_lock(&orangefs_debug_lock);
439 memset(file->f_inode->i_private, 0, ORANGEFS_MAX_DEBUG_STRING_LEN);
440 sprintf((char *)file->f_inode->i_private, "%s\n", debug_string);
441 mutex_unlock(&orangefs_debug_lock);
450 gossip_debug(GOSSIP_DEBUGFS_DEBUG,
451 "orangefs_debug_write: rc: %d\n",