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>
45 #include <sys/types.h>
46 #include <sys/socket.h>
47 #include <sys/ioctl.h>
50 #include <sys/utsname.h>
52 #include <portals/api-support.h>
53 #include <portals/ptlctl.h>
54 #include <libcfs/portals_utils.h>
59 static char rawbuf[8192];
60 static char *buf = rawbuf;
61 static int max = 8192;
62 /*static int g_pfd = -1;*/
63 static int subsystem_mask = ~0;
64 static int debug_mask = ~0;
66 #define MAX_MARK_SIZE 100
68 static const char *portal_debug_subsystems[] =
69 {"undefined", "mdc", "mds", "osc",
70 "ost", "class", "log", "llite",
71 "rpc", "mgmt", "portals", "nal",
72 "pinger", "filter", "ptlbd", "echo",
73 "ldlm", "lov", "router", "cobd",
74 "sm", "asobd", "confobd", "lmv",
75 "cmobd", "sec", NULL};
76 static const char *portal_debug_masks[] =
77 {"trace", "inode", "super", "ext2",
78 "malloc", "cache", "info", "ioctl",
79 "blocks", "net", "warning", "buffs",
80 "other", "dentry", "portals", "page",
81 "dlmtrace", "error", "emerg", "ha",
82 "rpctrace", "vfstrace", "reada", "mmap",
83 "config", "console", "quota", "sec", NULL};
85 struct debug_daemon_cmd {
90 static const struct debug_daemon_cmd portal_debug_daemon_cmd[] = {
91 {"start", DEBUG_DAEMON_START},
92 {"stop", DEBUG_DAEMON_STOP},
96 static int do_debug_mask(char *name, int enable)
100 for (i = 0; portal_debug_subsystems[i] != NULL; i++) {
101 if (strcasecmp(name, portal_debug_subsystems[i]) == 0 ||
102 strcasecmp(name, "all_subs") == 0) {
103 printf("%s output from subsystem \"%s\"\n",
104 enable ? "Enabling" : "Disabling",
105 portal_debug_subsystems[i]);
107 subsystem_mask |= (1 << i);
109 subsystem_mask &= ~(1 << i);
113 for (i = 0; portal_debug_masks[i] != NULL; i++) {
114 if (strcasecmp(name, portal_debug_masks[i]) == 0 ||
115 strcasecmp(name, "all_types") == 0) {
116 printf("%s output of type \"%s\"\n",
117 enable ? "Enabling" : "Disabling",
118 portal_debug_masks[i]);
120 debug_mask |= (1 << i);
122 debug_mask &= ~(1 << i);
130 int dbg_initialize(int argc, char **argv)
135 int jt_dbg_filter(int argc, char **argv)
140 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
145 for (i = 1; i < argc; i++)
146 if (!do_debug_mask(argv[i], 0))
147 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
152 int jt_dbg_show(int argc, char **argv)
157 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
162 for (i = 1; i < argc; i++)
163 if (!do_debug_mask(argv[i], 1))
164 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
170 static int applymask(char* procpath, int value)
174 int len = snprintf(buf, 64, "%d", value);
176 int fd = open(procpath, O_WRONLY);
178 fprintf(stderr, "Unable to open %s: %s\n",
179 procpath, strerror(errno));
182 rc = write(fd, buf, len+1);
184 fprintf(stderr, "Write to %s failed: %s\n",
185 procpath, strerror(errno));
192 static void applymask_all(unsigned int subs_mask, unsigned int debug_mask)
194 if (!dump_filename) {
195 applymask("/proc/sys/portals/subsystem_debug", subs_mask);
196 applymask("/proc/sys/portals/debug", debug_mask);
198 struct portals_debug_ioctl_data data;
200 data.hdr.ioc_len = sizeof(data);
201 data.hdr.ioc_version = 0;
202 data.subs = subs_mask;
203 data.debug = debug_mask;
205 dump(OBD_DEV_ID, PTL_IOC_DEBUG_MASK, &data);
207 printf("Applied subsystem_debug=%d, debug=%d to /proc/sys/portals\n",
208 subs_mask, debug_mask);
211 int jt_dbg_list(int argc, char **argv)
216 fprintf(stderr, "usage: %s <subs || types>\n", argv[0]);
220 if (strcasecmp(argv[1], "subs") == 0) {
221 printf("Subsystems: all_subs");
222 for (i = 0; portal_debug_subsystems[i] != NULL; i++)
223 printf(", %s", portal_debug_subsystems[i]);
225 } else if (strcasecmp(argv[1], "types") == 0) {
226 printf("Types: all_types");
227 for (i = 0; portal_debug_masks[i] != NULL; i++)
228 printf(", %s", portal_debug_masks[i]);
230 } else if (strcasecmp(argv[1], "applymasks") == 0) {
231 applymask_all(subsystem_mask, debug_mask);
236 /* all strings nul-terminated; only the struct and hdr need to be freed */
238 struct ptldebug_header *hdr;
242 struct list_head chain;
246 static void list_add_ordered(struct dbg_line *new, struct list_head *head)
248 struct list_head *pos;
249 struct dbg_line *curr;
251 list_for_each(pos, head) {
252 curr = list_entry(pos, struct dbg_line, chain);
254 if (curr->hdr->ph_sec < new->hdr->ph_sec)
256 if (curr->hdr->ph_sec == new->hdr->ph_sec &&
257 curr->hdr->ph_usec < new->hdr->ph_usec)
260 list_add(&new->chain, pos->prev);
263 list_add_tail(&new->chain, head);
266 static void print_saved_records(struct list_head *list, FILE *out)
268 struct list_head *pos, *tmp;
270 list_for_each_safe(pos, tmp, list) {
271 struct dbg_line *line;
272 struct ptldebug_header *hdr;
274 line = list_entry(pos, struct dbg_line, chain);
275 list_del(&line->chain);
278 fprintf(out, "%06x:%06x:%u:%u.%06Lu:%u:%u:%u:(%s:%u:%s()) %s",
279 hdr->ph_subsys, hdr->ph_mask, hdr->ph_cpu_id,
280 hdr->ph_sec, (unsigned long long)hdr->ph_usec,
281 hdr->ph_stack, hdr->ph_pid, hdr->ph_extern_pid,
282 line->file, hdr->ph_line_num, line->fn, line->text);
288 static int parse_buffer(FILE *in, FILE *out)
290 struct dbg_line *line;
291 struct ptldebug_header *hdr;
294 unsigned long dropped = 0, kept = 0;
295 struct list_head chunk_list;
297 CFS_INIT_LIST_HEAD(&chunk_list);
300 rc = fread(buf, sizeof(hdr->ph_len), 1, in);
305 if (hdr->ph_len == 0)
307 if (hdr->ph_len > 4094) {
308 fprintf(stderr, "unexpected large record: %d bytes. "
314 if (hdr->ph_flags & PH_FLAG_FIRST_RECORD) {
315 print_saved_records(&chunk_list, out);
316 assert(list_empty(&chunk_list));
319 rc = fread(buf + sizeof(hdr->ph_len), 1,
320 hdr->ph_len - sizeof(hdr->ph_len), in);
325 (!(subsystem_mask & hdr->ph_subsys) ||
326 (!(debug_mask & hdr->ph_mask)))) {
331 line = malloc(sizeof(*line));
333 fprintf(stderr, "malloc failed; printing accumulated "
334 "records and exiting.\n");
338 line->hdr = malloc(hdr->ph_len + 1);
339 if (line->hdr == NULL) {
340 fprintf(stderr, "malloc failed; printing accumulated "
341 "records and exiting.\n");
345 p = (void *)line->hdr;
346 memcpy(line->hdr, buf, hdr->ph_len);
347 p[hdr->ph_len] = '\0';
351 p += strlen(line->file) + 1;
353 p += strlen(line->fn) + 1;
356 list_add_ordered(line, &chunk_list);
360 print_saved_records(&chunk_list, out);
362 printf("Debug log: %lu lines, %lu kept, %lu dropped.\n",
363 dropped + kept, kept, dropped);
367 int jt_dbg_debug_kernel(int argc, char **argv)
372 FILE *in, *out = stdout;
375 fprintf(stderr, "usage: %s [file] [raw]\n", argv[0]);
381 } else if (argc > 1 && (argv[1][0] == '0' || argv[1][0] == '1')) {
386 /* If we are dumping raw (which means no conversion step to ASCII)
387 * then dump directly to any supplied filename, otherwise this is
388 * just a temp file and we dump to the real file at convert time. */
390 strcpy(filename, argv[1]);
392 sprintf(filename, "/tmp/lustre-log.%lu.%u",time(NULL),getpid());
394 if (stat(filename, &st) == 0 && S_ISREG(st.st_mode))
397 fd = open("/proc/sys/portals/dump_kernel", O_WRONLY);
399 fprintf(stderr, "open(dump_kernel) failed: %s\n",
404 rc = write(fd, filename, strlen(filename));
405 if (rc != strlen(filename)) {
406 fprintf(stderr, "write(%s) failed: %s\n", filename,
416 in = fopen(filename, "r");
418 if (errno == ENOENT) /* no dump file created */
421 fprintf(stderr, "fopen(%s) failed: %s\n", filename,
426 out = fopen(argv[1], "w");
428 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
435 rc = parse_buffer(in, out);
440 fprintf(stderr, "parse_buffer failed; leaving tmp file %s "
441 "behind.\n", filename);
443 rc = unlink(filename);
445 fprintf(stderr, "dumped successfully, but couldn't "
446 "unlink tmp file %s: %s\n", filename,
452 int jt_dbg_debug_file(int argc, char **argv)
460 if (argc > 3 || argc < 2) {
461 fprintf(stderr, "usage: %s <input> [output]\n", argv[0]);
465 fdin = open(argv[1], O_RDONLY | O_LARGEFILE);
467 fprintf(stderr, "open(%s) failed: %s\n", argv[1],
471 in = fdopen(fdin, "r");
473 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
479 fdout = open(argv[2],
480 O_CREAT | O_TRUNC | O_WRONLY | O_LARGEFILE,
483 fprintf(stderr, "open(%s) failed: %s\n", argv[2],
488 out = fdopen(fdout, "w");
490 fprintf(stderr, "fopen(%s) failed: %s\n", argv[2],
498 rc = parse_buffer(in, out);
508 dbg_write_cmd(int fd, char *str)
510 int len = strlen(str);
511 int rc = write(fd, str, len);
513 return (rc == len ? 0 : 1);
516 const char debug_daemon_usage[] = "usage: %s {start file [MB]|stop}\n";
517 #define DAEMON_FILE "/proc/sys/portals/daemon_file"
518 int jt_dbg_debug_daemon(int argc, char **argv)
524 fprintf(stderr, debug_daemon_usage, argv[0]);
528 fd = open(DAEMON_FILE, O_WRONLY);
530 fprintf(stderr, "open %s failed: %s\n", DAEMON_FILE,
536 if (strcasecmp(argv[1], "start") == 0) {
537 if (argc < 3 || argc > 4 ||
538 (argc == 4 && strlen(argv[3]) > 5)) {
539 fprintf(stderr, debug_daemon_usage, argv[0]);
544 const long min_size = 10;
545 const long max_size = 20480;
549 size = strtoul(argv[3], &end, 0);
550 if (size < min_size ||
553 fprintf(stderr, "size %s invalid, must be in "
554 "the range %ld-%ld MB\n", argv[3],
558 snprintf(buf, sizeof(buf), "size=%ld", size);
559 rc = dbg_write_cmd(fd, buf);
562 fprintf(stderr, "set %s failed: %s\n",
563 buf, strerror(errno));
568 rc = dbg_write_cmd(fd, argv[2]);
570 fprintf(stderr, "start debug_daemon on %s failed: %s\n",
571 argv[2], strerror(errno));
577 if (strcasecmp(argv[1], "stop") == 0) {
578 rc = dbg_write_cmd(fd, "stop");
580 fprintf(stderr, "stopping debug_daemon failed: %s\n",
589 fprintf(stderr, debug_daemon_usage, argv[0]);
596 int jt_dbg_clear_debug_buf(int argc, char **argv)
599 struct portal_ioctl_data data;
602 fprintf(stderr, "usage: %s\n", argv[0]);
606 memset(&data, 0, sizeof(data));
607 if (portal_ioctl_pack(&data, &buf, max) != 0) {
608 fprintf(stderr, "portal_ioctl_pack failed.\n");
612 rc = l_ioctl(PORTALS_DEV_ID, IOC_PORTAL_CLEAR_DEBUG, buf);
614 fprintf(stderr, "IOC_PORTAL_CLEAR_DEBUG failed: %s\n",
621 int jt_dbg_mark_debug_buf(int argc, char **argv)
623 int rc, max_size = MAX_MARK_SIZE-1;
624 struct portal_ioctl_data data;
626 time_t now = time(NULL);
630 text = malloc(MAX_MARK_SIZE);
631 strncpy(text, argv[1], max_size);
632 max_size-=strlen(argv[1]);
633 for(counter = 2; (counter < argc) && (max_size > 0) ; counter++){
634 strncat(text, " ", 1);
636 strncat(text, argv[counter], max_size);
637 max_size-=strlen(argv[counter]);
641 text[strlen(text) - 1] = '\0'; /* stupid \n */
644 text[MAX_MARK_SIZE - 1] = '\0';
647 memset(&data, 0, sizeof(data));
648 data.ioc_inllen1 = strlen(text) + 1;
649 data.ioc_inlbuf1 = text;
650 if (portal_ioctl_pack(&data, &buf, max) != 0) {
651 fprintf(stderr, "portal_ioctl_pack failed.\n");
655 rc = l_ioctl(PORTALS_DEV_ID, IOC_PORTAL_MARK_DEBUG, buf);
657 fprintf(stderr, "IOC_PORTAL_MARK_DEBUG failed: %s\n",
664 static struct mod_paths {
667 {"libcfs", "portals/libcfs"},
668 {"portals", "portals/portals"},
669 {"ksocknal", "portals/knals/socknal"},
670 {"kptlrouter", "portals/router"},
671 {"lvfs", "lustre/lvfs"},
672 {"obdclass", "lustre/obdclass"},
673 {"llog_test", "lustre/obdclass"},
674 {"ptlrpcs", "lustre/sec"},
675 {"ptlrpcs_gss", "lustre/sec/gss"},
676 {"ptlrpc", "lustre/ptlrpc"},
677 {"obdext2", "lustre/obdext2"},
678 {"ost", "lustre/ost"},
679 {"osc", "lustre/osc"},
680 {"mds", "lustre/mds"},
681 {"mdc", "lustre/mdc"},
682 {"llite", "lustre/llite"},
683 {"ldiskfs", "lustre/ldiskfs"},
684 {"smfs", "lustre/smfs"},
685 {"obdecho", "lustre/obdecho"},
686 {"ldlm", "lustre/ldlm"},
687 {"obdfilter", "lustre/obdfilter"},
688 {"extN", "lustre/extN"},
689 {"lov", "lustre/lov"},
690 {"lmv", "lustre/lmv"},
691 {"fsfilt_ext3", "lustre/lvfs"},
692 {"fsfilt_extN", "lustre/lvfs"},
693 {"fsfilt_reiserfs", "lustre/lvfs"},
694 {"fsfilt_smfs", "lustre/lvfs"},
695 {"fsfilt_ldiskfs", "lustre/lvfs"},
696 {"mds_ext2", "lustre/mds"},
697 {"mds_ext3", "lustre/mds"},
698 {"mds_extN", "lustre/mds"},
699 {"ptlbd", "lustre/ptlbd"},
700 {"mgmt_svc", "lustre/mgmt"},
701 {"mgmt_cli", "lustre/mgmt"},
702 {"cobd", "lustre/cobd"},
703 {"cmobd", "lustre/cmobd"},
704 {"confobd", "lustre/obdclass"},
708 static int jt_dbg_modules_2_4(int argc, char **argv)
710 #ifdef HAVE_LINUX_VERSION_H
711 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
712 struct mod_paths *mp;
714 char *kernel = "linux";
721 printf("%s [path] [kernel]\n", argv[0]);
726 for (mp = mod_paths; mp->name != NULL; mp++) {
727 struct module_info info;
730 int query_module(const char *name, int which, void *buf,
731 size_t bufsize, size_t *ret);
733 rc = query_module(mp->name, QM_INFO, &info, sizeof(info),
737 printf("query_module(%s) failed: %s\n",
738 mp->name, strerror(errno));
740 printf("add-symbol-file %s%s%s/%s.o 0x%0lx\n", path,
741 path[0] ? "/" : "", mp->path, mp->name,
742 info.addr + sizeof(struct module));
743 printf("dir %s%s%s\n", path,
744 path[0] ? "/" : "", mp->path);
749 #endif // Headers are 2.6-only
750 #endif // !HAVE_LINUX_VERSION_H
754 static int jt_dbg_modules_2_5(int argc, char **argv)
756 struct mod_paths *mp;
758 char *kernel = "linux";
759 const char *proc = "/proc/modules";
760 char modname[128], others[128];
770 printf("%s [path] [kernel]\n", argv[0]);
774 file = fopen(proc, "r");
776 printf("failed open %s: %s\n", proc, strerror(errno));
781 while ((rc = fscanf(file, "%s %s %s %s %s %lx\n",
782 modname, others, others, others, others, &modaddr)) == 6) {
783 for (mp = mod_paths; mp->name != NULL; mp++) {
784 if (!strcmp(mp->name, modname))
788 printf("add-symbol-file %s%s%s/%s.o 0x%0lx\n", path,
789 path[0] ? "/" : "", mp->path, mp->name, modaddr);
790 printf("dir %s%s%s\n", path,
791 path[0] ? "/" : "", mp->path);
798 int jt_dbg_modules(int argc, char **argv)
801 struct utsname sysinfo;
803 rc = uname(&sysinfo);
805 printf("uname() failed: %s\n", strerror(errno));
809 if (sysinfo.release[2] > '4') {
810 return jt_dbg_modules_2_5(argc, argv);
812 return jt_dbg_modules_2_4(argc, argv);
818 int jt_dbg_panic(int argc, char **argv)
821 struct portal_ioctl_data data;
824 fprintf(stderr, "usage: %s\n", argv[0]);
828 memset(&data, 0, sizeof(data));
829 if (portal_ioctl_pack(&data, &buf, max) != 0) {
830 fprintf(stderr, "portal_ioctl_pack failed.\n");
834 rc = l_ioctl(PORTALS_DEV_ID, IOC_PORTAL_PANIC, buf);
836 fprintf(stderr, "IOC_PORTAL_PANIC failed: %s\n",