1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2001, 2002 Cluster File Systems, Inc.
6 * This file is part of Portals, http://www.sf.net/projects/lustre/
8 * Portals is free software; you can redistribute it and/or
9 * modify it under the terms of version 2 of the GNU General Public
10 * License as published by the Free Software Foundation.
12 * Portals is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Portals; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * Some day I'll split all of this functionality into a cfs_debug module
22 * of its own. That day is not today.
26 #define __USE_FILE_OFFSET64
35 #ifdef HAVE_SYS_IOCTL_H
36 #include <sys/ioctl.h>
44 #include <sys/types.h>
45 #include <sys/socket.h>
46 #include <sys/ioctl.h>
49 #include <sys/utsname.h>
51 #include <portals/api-support.h>
52 #include <portals/ptlctl.h>
53 #include <libcfs/portals_utils.h>
58 static char rawbuf[8192];
59 static char *buf = rawbuf;
60 static int max = 8192;
61 /*static int g_pfd = -1;*/
62 static int subsystem_mask = ~0;
63 static int debug_mask = ~0;
65 #define MAX_MARK_SIZE 100
67 static const char *portal_debug_subsystems[] =
68 {"undefined", "mdc", "mds", "osc",
69 "ost", "class", "log", "llite",
70 "rpc", "mgmt", "portals", "nal",
71 "pinger", "filter", "ptlbd", "echo",
72 "ldlm", "lov", "router", "cobd",
73 "sm", "asobd", "confobd", "lmv",
74 "cmobd", "sec", NULL};
75 static const char *portal_debug_masks[] =
76 {"trace", "inode", "super", "ext2",
77 "malloc", "cache", "info", "ioctl",
78 "blocks", "net", "warning", "buffs",
79 "other", "dentry", "portals", "page",
80 "dlmtrace", "error", "emerg", "ha",
81 "rpctrace", "vfstrace", "reada", "mmap",
82 "config", "console", "quota", "sec", NULL};
84 struct debug_daemon_cmd {
89 static const struct debug_daemon_cmd portal_debug_daemon_cmd[] = {
90 {"start", DEBUG_DAEMON_START},
91 {"stop", DEBUG_DAEMON_STOP},
95 static int do_debug_mask(char *name, int enable)
99 for (i = 0; portal_debug_subsystems[i] != NULL; i++) {
100 if (strcasecmp(name, portal_debug_subsystems[i]) == 0 ||
101 strcasecmp(name, "all_subs") == 0) {
102 printf("%s output from subsystem \"%s\"\n",
103 enable ? "Enabling" : "Disabling",
104 portal_debug_subsystems[i]);
106 subsystem_mask |= (1 << i);
108 subsystem_mask &= ~(1 << i);
112 for (i = 0; portal_debug_masks[i] != NULL; i++) {
113 if (strcasecmp(name, portal_debug_masks[i]) == 0 ||
114 strcasecmp(name, "all_types") == 0) {
115 printf("%s output of type \"%s\"\n",
116 enable ? "Enabling" : "Disabling",
117 portal_debug_masks[i]);
119 debug_mask |= (1 << i);
121 debug_mask &= ~(1 << i);
129 int dbg_initialize(int argc, char **argv)
134 int jt_dbg_filter(int argc, char **argv)
139 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
144 for (i = 1; i < argc; i++)
145 if (!do_debug_mask(argv[i], 0))
146 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
151 int jt_dbg_show(int argc, char **argv)
156 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
161 for (i = 1; i < argc; i++)
162 if (!do_debug_mask(argv[i], 1))
163 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
169 static int applymask(char* procpath, int value)
173 int len = snprintf(buf, 64, "%d", value);
175 int fd = open(procpath, O_WRONLY);
177 fprintf(stderr, "Unable to open %s: %s\n",
178 procpath, strerror(errno));
181 rc = write(fd, buf, len+1);
183 fprintf(stderr, "Write to %s failed: %s\n",
184 procpath, strerror(errno));
191 static void applymask_all(unsigned int subs_mask, unsigned int debug_mask)
193 if (!dump_filename) {
194 applymask("/proc/sys/portals/subsystem_debug", subs_mask);
195 applymask("/proc/sys/portals/debug", debug_mask);
197 struct portals_debug_ioctl_data data;
199 data.hdr.ioc_len = sizeof(data);
200 data.hdr.ioc_version = 0;
201 data.subs = subs_mask;
202 data.debug = debug_mask;
204 dump(OBD_DEV_ID, PTL_IOC_DEBUG_MASK, &data);
206 printf("Applied subsystem_debug=%d, debug=%d to /proc/sys/portals\n",
207 subs_mask, debug_mask);
210 int jt_dbg_list(int argc, char **argv)
215 fprintf(stderr, "usage: %s <subs || types>\n", argv[0]);
219 if (strcasecmp(argv[1], "subs") == 0) {
220 printf("Subsystems: all_subs");
221 for (i = 0; portal_debug_subsystems[i] != NULL; i++)
222 printf(", %s", portal_debug_subsystems[i]);
224 } else if (strcasecmp(argv[1], "types") == 0) {
225 printf("Types: all_types");
226 for (i = 0; portal_debug_masks[i] != NULL; i++)
227 printf(", %s", portal_debug_masks[i]);
229 } else if (strcasecmp(argv[1], "applymasks") == 0) {
230 applymask_all(subsystem_mask, debug_mask);
235 /* all strings nul-terminated; only the struct and hdr need to be freed */
237 struct ptldebug_header *hdr;
241 struct list_head chain;
245 static void list_add_ordered(struct dbg_line *new, struct list_head *head)
247 struct list_head *pos;
248 struct dbg_line *curr;
250 list_for_each(pos, head) {
251 curr = list_entry(pos, struct dbg_line, chain);
253 if (curr->hdr->ph_sec < new->hdr->ph_sec)
255 if (curr->hdr->ph_sec == new->hdr->ph_sec &&
256 curr->hdr->ph_usec < new->hdr->ph_usec)
259 list_add(&new->chain, pos->prev);
262 list_add_tail(&new->chain, head);
265 static void print_saved_records(struct list_head *list, FILE *out)
267 struct list_head *pos, *tmp;
269 list_for_each_safe(pos, tmp, list) {
270 struct dbg_line *line;
271 struct ptldebug_header *hdr;
273 line = list_entry(pos, struct dbg_line, chain);
274 list_del(&line->chain);
277 fprintf(out, "%06x:%06x:%u:%u.%06Lu:%u:%u:%u:(%s:%u:%s()) %s",
278 hdr->ph_subsys, hdr->ph_mask, hdr->ph_cpu_id,
279 hdr->ph_sec, (unsigned long long)hdr->ph_usec,
280 hdr->ph_stack, hdr->ph_pid, hdr->ph_extern_pid,
281 line->file, hdr->ph_line_num, line->fn, line->text);
287 static int parse_buffer(FILE *in, FILE *out)
289 struct dbg_line *line;
290 struct ptldebug_header *hdr;
293 unsigned long dropped = 0, kept = 0;
294 struct list_head chunk_list;
296 CFS_INIT_LIST_HEAD(&chunk_list);
299 rc = fread(buf, sizeof(hdr->ph_len), 1, in);
304 if (hdr->ph_len == 0)
306 if (hdr->ph_len > 4094) {
307 fprintf(stderr, "unexpected large record: %d bytes. "
313 if (hdr->ph_flags & PH_FLAG_FIRST_RECORD) {
314 print_saved_records(&chunk_list, out);
315 assert(list_empty(&chunk_list));
318 rc = fread(buf + sizeof(hdr->ph_len), 1,
319 hdr->ph_len - sizeof(hdr->ph_len), in);
324 (!(subsystem_mask & hdr->ph_subsys) ||
325 (!(debug_mask & hdr->ph_mask)))) {
330 line = malloc(sizeof(*line));
332 fprintf(stderr, "malloc failed; printing accumulated "
333 "records and exiting.\n");
337 line->hdr = malloc(hdr->ph_len + 1);
338 if (line->hdr == NULL) {
339 fprintf(stderr, "malloc failed; printing accumulated "
340 "records and exiting.\n");
344 p = (void *)line->hdr;
345 memcpy(line->hdr, buf, hdr->ph_len);
346 p[hdr->ph_len] = '\0';
350 p += strlen(line->file) + 1;
352 p += strlen(line->fn) + 1;
355 list_add_ordered(line, &chunk_list);
359 print_saved_records(&chunk_list, out);
361 printf("Debug log: %lu lines, %lu kept, %lu dropped.\n",
362 dropped + kept, kept, dropped);
366 int jt_dbg_debug_kernel(int argc, char **argv)
371 FILE *in, *out = stdout;
374 fprintf(stderr, "usage: %s [file] [raw]\n", argv[0]);
380 } else if (argc > 1 && (argv[1][0] == '0' || argv[1][0] == '1')) {
385 /* If we are dumping raw (which means no conversion step to ASCII)
386 * then dump directly to any supplied filename, otherwise this is
387 * just a temp file and we dump to the real file at convert time. */
389 strcpy(filename, argv[1]);
391 sprintf(filename, "/tmp/lustre-log.%lu.%u",time(NULL),getpid());
393 if (stat(filename, &st) == 0 && S_ISREG(st.st_mode))
396 fd = open("/proc/sys/portals/dump_kernel", O_WRONLY);
398 fprintf(stderr, "open(dump_kernel) failed: %s\n",
403 rc = write(fd, filename, strlen(filename));
404 if (rc != strlen(filename)) {
405 fprintf(stderr, "write(%s) failed: %s\n", filename,
415 in = fopen(filename, "r");
417 if (errno == ENOENT) /* no dump file created */
420 fprintf(stderr, "fopen(%s) failed: %s\n", filename,
425 out = fopen(argv[1], "w");
427 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
434 rc = parse_buffer(in, out);
439 fprintf(stderr, "parse_buffer failed; leaving tmp file %s "
440 "behind.\n", filename);
442 rc = unlink(filename);
444 fprintf(stderr, "dumped successfully, but couldn't "
445 "unlink tmp file %s: %s\n", filename,
451 int jt_dbg_debug_file(int argc, char **argv)
459 if (argc > 3 || argc < 2) {
460 fprintf(stderr, "usage: %s <input> [output]\n", argv[0]);
464 fdin = open(argv[1], O_RDONLY | O_LARGEFILE);
466 fprintf(stderr, "open(%s) failed: %s\n", argv[1],
470 in = fdopen(fdin, "r");
472 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
478 fdout = open(argv[2],
479 O_CREAT | O_TRUNC | O_WRONLY | O_LARGEFILE,
482 fprintf(stderr, "open(%s) failed: %s\n", argv[2],
487 out = fdopen(fdout, "w");
489 fprintf(stderr, "fopen(%s) failed: %s\n", argv[2],
497 rc = parse_buffer(in, out);
507 dbg_write_cmd(int fd, char *str)
509 int len = strlen(str);
510 int rc = write(fd, str, len);
512 return (rc == len ? 0 : 1);
515 const char debug_daemon_usage[] = "usage: %s {start file [MB]|stop}\n";
516 #define DAEMON_FILE "/proc/sys/portals/daemon_file"
517 int jt_dbg_debug_daemon(int argc, char **argv)
523 fprintf(stderr, debug_daemon_usage, argv[0]);
527 fd = open(DAEMON_FILE, O_WRONLY);
529 fprintf(stderr, "open %s failed: %s\n", DAEMON_FILE,
535 if (strcasecmp(argv[1], "start") == 0) {
536 if (argc < 3 || argc > 4 ||
537 (argc == 4 && strlen(argv[3]) > 5)) {
538 fprintf(stderr, debug_daemon_usage, argv[0]);
543 const long min_size = 10;
544 const long max_size = 20480;
548 size = strtoul(argv[3], &end, 0);
549 if (size < min_size ||
552 fprintf(stderr, "size %s invalid, must be in "
553 "the range %ld-%ld MB\n", argv[3],
557 snprintf(buf, sizeof(buf), "size=%ld", size);
558 rc = dbg_write_cmd(fd, buf);
561 fprintf(stderr, "set %s failed: %s\n",
562 buf, strerror(errno));
567 rc = dbg_write_cmd(fd, argv[2]);
569 fprintf(stderr, "start debug_daemon on %s failed: %s\n",
570 argv[2], strerror(errno));
576 if (strcasecmp(argv[1], "stop") == 0) {
577 rc = dbg_write_cmd(fd, "stop");
579 fprintf(stderr, "stopping debug_daemon failed: %s\n",
588 fprintf(stderr, debug_daemon_usage, argv[0]);
595 int jt_dbg_clear_debug_buf(int argc, char **argv)
598 struct portal_ioctl_data data;
601 fprintf(stderr, "usage: %s\n", argv[0]);
605 memset(&data, 0, sizeof(data));
606 if (portal_ioctl_pack(&data, &buf, max) != 0) {
607 fprintf(stderr, "portal_ioctl_pack failed.\n");
611 rc = l_ioctl(PORTALS_DEV_ID, IOC_PORTAL_CLEAR_DEBUG, buf);
613 fprintf(stderr, "IOC_PORTAL_CLEAR_DEBUG failed: %s\n",
620 int jt_dbg_mark_debug_buf(int argc, char **argv)
622 int rc, max_size = MAX_MARK_SIZE-1;
623 struct portal_ioctl_data data;
625 time_t now = time(NULL);
629 text = malloc(MAX_MARK_SIZE);
630 strncpy(text, argv[1], max_size);
631 max_size-=strlen(argv[1]);
632 for(counter = 2; (counter < argc) && (max_size > 0) ; counter++){
633 strncat(text, " ", 1);
635 strncat(text, argv[counter], max_size);
636 max_size-=strlen(argv[counter]);
640 text[strlen(text) - 1] = '\0'; /* stupid \n */
643 text[MAX_MARK_SIZE - 1] = '\0';
646 memset(&data, 0, sizeof(data));
647 data.ioc_inllen1 = strlen(text) + 1;
648 data.ioc_inlbuf1 = text;
649 if (portal_ioctl_pack(&data, &buf, max) != 0) {
650 fprintf(stderr, "portal_ioctl_pack failed.\n");
654 rc = l_ioctl(PORTALS_DEV_ID, IOC_PORTAL_MARK_DEBUG, buf);
656 fprintf(stderr, "IOC_PORTAL_MARK_DEBUG failed: %s\n",
663 static struct mod_paths {
666 {"libcfs", "portals/libcfs"},
667 {"portals", "portals/portals"},
668 {"ksocknal", "portals/knals/socknal"},
669 {"kptlrouter", "portals/router"},
670 {"lvfs", "lustre/lvfs"},
671 {"obdclass", "lustre/obdclass"},
672 {"llog_test", "lustre/obdclass"},
673 {"ptlrpcs", "lustre/sec"},
674 {"ptlrpcs_gss", "lustre/sec/gss"},
675 {"ptlrpc", "lustre/ptlrpc"},
676 {"obdext2", "lustre/obdext2"},
677 {"ost", "lustre/ost"},
678 {"osc", "lustre/osc"},
679 {"mds", "lustre/mds"},
680 {"mdc", "lustre/mdc"},
681 {"llite", "lustre/llite"},
682 {"ldiskfs", "lustre/ldiskfs"},
683 {"smfs", "lustre/smfs"},
684 {"obdecho", "lustre/obdecho"},
685 {"ldlm", "lustre/ldlm"},
686 {"obdfilter", "lustre/obdfilter"},
687 {"extN", "lustre/extN"},
688 {"lov", "lustre/lov"},
689 {"lmv", "lustre/lmv"},
690 {"fsfilt_ext3", "lustre/lvfs"},
691 {"fsfilt_extN", "lustre/lvfs"},
692 {"fsfilt_reiserfs", "lustre/lvfs"},
693 {"fsfilt_smfs", "lustre/lvfs"},
694 {"fsfilt_ldiskfs", "lustre/lvfs"},
695 {"mds_ext2", "lustre/mds"},
696 {"mds_ext3", "lustre/mds"},
697 {"mds_extN", "lustre/mds"},
698 {"ptlbd", "lustre/ptlbd"},
699 {"mgmt_svc", "lustre/mgmt"},
700 {"mgmt_cli", "lustre/mgmt"},
701 {"cobd", "lustre/cobd"},
702 {"cmobd", "lustre/cmobd"},
703 {"confobd", "lustre/obdclass"},
707 static int jt_dbg_modules_2_4(int argc, char **argv)
709 #ifdef HAVE_LINUX_VERSION_H
710 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
711 struct mod_paths *mp;
713 char *kernel = "linux";
720 printf("%s [path] [kernel]\n", argv[0]);
724 for (mp = mod_paths; mp->name != NULL; mp++) {
725 struct module_info info;
728 int query_module(const char *name, int which, void *buf,
729 size_t bufsize, size_t *ret);
731 rc = query_module(mp->name, QM_INFO, &info, sizeof(info),
735 printf("query_module(%s) failed: %s\n",
736 mp->name, strerror(errno));
738 printf("add-symbol-file %s%s%s/%s.o 0x%0lx\n", path,
739 path[0] ? "/" : "", mp->path, mp->name,
740 info.addr + sizeof(struct module));
745 #endif // Headers are 2.6-only
746 #endif // !HAVE_LINUX_VERSION_H
750 static int jt_dbg_modules_2_5(int argc, char **argv)
752 struct mod_paths *mp;
754 char *kernel = "linux";
755 const char *proc = "/proc/modules";
756 char modname[128], others[128];
766 printf("%s [path] [kernel]\n", argv[0]);
770 file = fopen(proc, "r");
772 printf("failed open %s: %s\n", proc, strerror(errno));
776 while ((rc = fscanf(file, "%s %s %s %s %s %lx\n",
777 modname, others, others, others, others, &modaddr)) == 6) {
778 for (mp = mod_paths; mp->name != NULL; mp++) {
779 if (!strcmp(mp->name, modname))
783 printf("add-symbol-file %s%s%s/%s.o 0x%0lx\n", path,
784 path[0] ? "/" : "", mp->path, mp->name, modaddr);
791 int jt_dbg_modules(int argc, char **argv)
794 struct utsname sysinfo;
796 rc = uname(&sysinfo);
798 printf("uname() failed: %s\n", strerror(errno));
802 if (sysinfo.release[2] > '4') {
803 return jt_dbg_modules_2_5(argc, argv);
805 return jt_dbg_modules_2_4(argc, argv);
811 int jt_dbg_panic(int argc, char **argv)
814 struct portal_ioctl_data data;
817 fprintf(stderr, "usage: %s\n", argv[0]);
821 memset(&data, 0, sizeof(data));
822 if (portal_ioctl_pack(&data, &buf, max) != 0) {
823 fprintf(stderr, "portal_ioctl_pack failed.\n");
827 rc = l_ioctl(PORTALS_DEV_ID, IOC_PORTAL_PANIC, buf);
829 fprintf(stderr, "IOC_PORTAL_PANIC failed: %s\n",