1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright 2008 Sun Microsystems, Inc. All rights reserved
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 * Some day I'll split all of this functionality into a cfs_debug module
38 * of its own. That day is not today.
41 #define __USE_FILE_OFFSET64
46 #include <libcfs/libcfsutil.h>
47 #include <lnet/lnetctl.h>
50 static char rawbuf[8192];
51 static char *buf = rawbuf;
52 static int max = 8192;
53 /*static int g_pfd = -1;*/
54 static int subsystem_mask = ~0;
55 static int debug_mask = ~0;
57 #define MAX_MARK_SIZE 256
59 static const char *libcfs_debug_subsystems[] =
60 {"undefined", "mdc", "mds", "osc",
61 "ost", "class", "log", "llite",
62 "rpc", "mgmt", "lnet", "lnd",
63 "pinger", "filter", "", "echo",
64 "ldlm", "lov", "", "",
67 "mgc", "mgs", "fid", "fld", NULL};
68 static const char *libcfs_debug_masks[] =
69 {"trace", "inode", "super", "ext2",
70 "malloc", "cache", "info", "ioctl",
71 "neterror", "net", "warning", "buffs",
72 "other", "dentry", "nettrace", "page",
73 "dlmtrace", "error", "emerg", "ha",
74 "rpctrace", "vfstrace", "reada", "mmap",
75 "config", "console", "quota", "sec", NULL};
79 #define DAEMON_CTL_NAME "/proc/sys/lnet/daemon_file"
80 #define SUBSYS_DEBUG_CTL_NAME "/proc/sys/lnet/subsystem_debug"
81 #define DEBUG_CTL_NAME "/proc/sys/lnet/debug"
82 #define DUMP_KERNEL_CTL_NAME "/proc/sys/lnet/dump_kernel"
85 dbg_open_ctlhandle(const char *str)
88 fd = open(str, O_WRONLY);
90 fprintf(stderr, "open %s failed: %s\n", str,
98 dbg_close_ctlhandle(int fd)
104 dbg_write_cmd(int fd, char *str, int len)
106 int rc = write(fd, str, len);
108 return (rc == len ? 0 : 1);
111 #elif defined(__DARWIN__)
113 #define DAEMON_CTL_NAME "lnet.trace_daemon"
114 #define SUBSYS_DEBUG_CTL_NAME "lnet.subsystem_debug"
115 #define DEBUG_CTL_NAME "lnet.debug"
116 #define DUMP_KERNEL_CTL_NAME "lnet.trace_dumpkernel"
118 static char sysctl_name[128];
120 dbg_open_ctlhandle(const char *str)
123 if (strlen(str)+1 > 128) {
124 fprintf(stderr, "sysctl name is too long: %s.\n", str);
127 strcpy(sysctl_name, str);
133 dbg_close_ctlhandle(int fd)
135 sysctl_name[0] = '\0';
140 dbg_write_cmd(int fd, char *str, int len)
144 rc = sysctlbyname(sysctl_name, NULL, NULL, str, len+1);
146 fprintf(stderr, "sysctl %s with cmd (%s) error: %d\n",
147 sysctl_name, str, errno);
149 return (rc == 0 ? 0: 1);
152 #elif defined(__WINNT__)
154 #define DAEMON_CTL_NAME "/proc/sys/lnet/daemon_file"
155 #define SUBSYS_DEBUG_CTL_NAME "/proc/sys/lnet/subsystem_debug"
156 #define DEBUG_CTL_NAME "/proc/sys/lnet/debug"
157 #define DUMP_KERNEL_CTL_NAME "/proc/sys/lnet/dump_kernel"
160 dbg_open_ctlhandle(const char *str)
163 fd = cfs_proc_open((char *)str, (int)O_WRONLY);
165 fprintf(stderr, "open %s failed: %s\n", str,
173 dbg_close_ctlhandle(int fd)
179 dbg_write_cmd(int fd, char *str, int len)
181 int rc = cfs_proc_write(fd, str, len);
183 return (rc == len ? 0 : 1);
187 #error - Unknown sysctl convention.
190 static int do_debug_mask(char *name, int enable)
194 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++) {
195 if (strcasecmp(name, libcfs_debug_subsystems[i]) == 0 ||
196 strcasecmp(name, "all_subs") == 0) {
197 printf("%s output from subsystem \"%s\"\n",
198 enable ? "Enabling" : "Disabling",
199 libcfs_debug_subsystems[i]);
201 subsystem_mask |= (1 << i);
203 subsystem_mask &= ~(1 << i);
207 for (i = 0; libcfs_debug_masks[i] != NULL; i++) {
208 if (strcasecmp(name, libcfs_debug_masks[i]) == 0 ||
209 strcasecmp(name, "all_types") == 0) {
210 printf("%s output of type \"%s\"\n",
211 enable ? "Enabling" : "Disabling",
212 libcfs_debug_masks[i]);
214 debug_mask |= (1 << i);
216 debug_mask &= ~(1 << i);
224 int dbg_initialize(int argc, char **argv)
229 int jt_dbg_filter(int argc, char **argv)
234 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
239 for (i = 1; i < argc; i++)
240 if (!do_debug_mask(argv[i], 0))
241 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
246 int jt_dbg_show(int argc, char **argv)
251 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
256 for (i = 1; i < argc; i++)
257 if (!do_debug_mask(argv[i], 1))
258 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
264 static int applymask(char* procpath, int value)
268 int len = snprintf(buf, 64, "%d", value);
270 int fd = dbg_open_ctlhandle(procpath);
272 fprintf(stderr, "Unable to open %s: %s\n",
273 procpath, strerror(errno));
276 rc = dbg_write_cmd(fd, buf, len+1);
278 fprintf(stderr, "Write to %s failed: %s\n",
279 procpath, strerror(errno));
282 dbg_close_ctlhandle(fd);
287 static void applymask_all(unsigned int subs_mask, unsigned int debug_mask)
289 if (!dump_filename) {
290 applymask(SUBSYS_DEBUG_CTL_NAME, subs_mask);
291 applymask(DEBUG_CTL_NAME, debug_mask);
293 struct libcfs_debug_ioctl_data data;
295 data.hdr.ioc_len = sizeof(data);
296 data.hdr.ioc_version = 0;
297 data.subs = subs_mask;
298 data.debug = debug_mask;
300 dump(OBD_DEV_ID, LIBCFS_IOC_DEBUG_MASK, &data);
302 printf("Applied subsystem_debug=%d, debug=%d to /proc/sys/lnet\n",
303 subs_mask, debug_mask);
306 int jt_dbg_list(int argc, char **argv)
311 fprintf(stderr, "usage: %s <subs || types>\n", argv[0]);
315 if (strcasecmp(argv[1], "subs") == 0) {
316 printf("Subsystems: all_subs");
317 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++)
318 if (libcfs_debug_subsystems[i][0])
319 printf(", %s", libcfs_debug_subsystems[i]);
321 } else if (strcasecmp(argv[1], "types") == 0) {
322 printf("Types: all_types");
323 for (i = 0; libcfs_debug_masks[i] != NULL; i++)
324 printf(", %s", libcfs_debug_masks[i]);
326 } else if (strcasecmp(argv[1], "applymasks") == 0) {
327 applymask_all(subsystem_mask, debug_mask);
332 /* all strings nul-terminated; only the struct and hdr need to be freed */
334 struct ptldebug_header *hdr;
340 static int cmp_rec(const void *p1, const void *p2)
342 struct dbg_line *d1 = *(struct dbg_line **)p1;
343 struct dbg_line *d2 = *(struct dbg_line **)p2;
345 if (d1->hdr->ph_sec < d2->hdr->ph_sec)
347 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
348 d1->hdr->ph_usec < d2->hdr->ph_usec)
350 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
351 d1->hdr->ph_usec == d2->hdr->ph_usec)
356 static void print_rec(struct dbg_line **linev, int used, FILE *out)
360 for (i = 0; i < used; i++) {
361 struct dbg_line *line = linev[i];
362 struct ptldebug_header *hdr = line->hdr;
364 fprintf(out, "%08x:%08x:%u:%u." LPU64 ":%u:%u:%u:(%s:%u:%s()) %s",
365 hdr->ph_subsys, hdr->ph_mask, hdr->ph_cpu_id,
366 hdr->ph_sec, (unsigned long long)hdr->ph_usec,
367 hdr->ph_stack, hdr->ph_pid, hdr->ph_extern_pid,
368 line->file, hdr->ph_line_num, line->fn, line->text);
375 static int add_rec(struct dbg_line *line, struct dbg_line ***linevp, int *lenp,
378 struct dbg_line **linev = *linevp;
381 int nlen = *lenp + 512;
382 int nsize = nlen * sizeof(struct dbg_line *);
384 linev = *linevp ? realloc(*linevp, nsize) : malloc(nsize);
394 static int parse_buffer(FILE *in, FILE *out)
396 struct dbg_line *line;
397 struct ptldebug_header *hdr;
400 unsigned long dropped = 0, kept = 0;
401 struct dbg_line **linev = NULL;
405 rc = fread(buf, sizeof(hdr->ph_len) + sizeof(hdr->ph_flags), 1, in);
410 if (hdr->ph_len == 0)
412 if (hdr->ph_len > 4094) {
413 fprintf(stderr, "unexpected large record: %d bytes. "
419 rc = fread(buf + sizeof(hdr->ph_len) + sizeof(hdr->ph_flags), 1,
420 hdr->ph_len - sizeof(hdr->ph_len) - sizeof(hdr->ph_flags), in);
424 if ((hdr->ph_subsys && !(subsystem_mask & hdr->ph_subsys)) ||
425 (hdr->ph_mask && !(debug_mask & hdr->ph_mask))) {
430 line = malloc(sizeof(*line));
432 fprintf(stderr, "malloc failed; printing accumulated "
433 "records and exiting.\n");
437 line->hdr = malloc(hdr->ph_len + 1);
438 if (line->hdr == NULL) {
440 fprintf(stderr, "malloc failed; printing accumulated "
441 "records and exiting.\n");
445 p = (void *)line->hdr;
446 memcpy(line->hdr, buf, hdr->ph_len);
447 p[hdr->ph_len] = '\0';
451 p += strlen(line->file) + 1;
453 p += strlen(line->fn) + 1;
456 if (!add_rec(line, &linev, &linev_len, kept)) {
457 fprintf(stderr, "malloc failed; printing accumulated "
458 "records and exiting.\n");
465 qsort(linev, kept, sizeof(struct dbg_line *), cmp_rec);
466 print_rec(linev, kept, out);
469 printf("Debug log: %lu lines, %lu kept, %lu dropped.\n",
470 dropped + kept, kept, dropped);
474 int jt_dbg_debug_kernel(int argc, char **argv)
479 FILE *in, *out = stdout;
482 fprintf(stderr, "usage: %s [file] [raw]\n", argv[0]);
488 } else if (argc > 1 && (argv[1][0] == '0' || argv[1][0] == '1')) {
493 /* If we are dumping raw (which means no conversion step to ASCII)
494 * then dump directly to any supplied filename, otherwise this is
495 * just a temp file and we dump to the real file at convert time. */
497 strcpy(filename, argv[1]);
499 sprintf(filename, "%s"CFS_TIME_T".%u",
500 DEBUG_FILE_PATH_DEFAULT, time(NULL), getpid());
502 if (stat(filename, &st) == 0 && S_ISREG(st.st_mode))
505 fd = dbg_open_ctlhandle(DUMP_KERNEL_CTL_NAME);
507 fprintf(stderr, "open(dump_kernel) failed: %s\n",
512 rc = dbg_write_cmd(fd, filename, strlen(filename));
514 fprintf(stderr, "write(%s) failed: %s\n", filename,
516 dbg_close_ctlhandle(fd);
519 dbg_close_ctlhandle(fd);
524 in = fopen(filename, "r");
526 if (errno == ENOENT) /* no dump file created */
529 fprintf(stderr, "fopen(%s) failed: %s\n", filename,
534 out = fopen(argv[1], "w");
536 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
543 rc = parse_buffer(in, out);
548 fprintf(stderr, "parse_buffer failed; leaving tmp file %s "
549 "behind.\n", filename);
551 rc = unlink(filename);
553 fprintf(stderr, "dumped successfully, but couldn't "
554 "unlink tmp file %s: %s\n", filename,
560 int jt_dbg_debug_file(int argc, char **argv)
568 if (argc > 3 || argc < 2) {
569 fprintf(stderr, "usage: %s <input> [output]\n", argv[0]);
573 fdin = open(argv[1], O_RDONLY | O_LARGEFILE);
575 fprintf(stderr, "open(%s) failed: %s\n", argv[1],
579 in = fdopen(fdin, "r");
581 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
587 fdout = open(argv[2],
588 O_CREAT | O_TRUNC | O_WRONLY | O_LARGEFILE,
591 fprintf(stderr, "open(%s) failed: %s\n", argv[2],
596 out = fdopen(fdout, "w");
598 fprintf(stderr, "fopen(%s) failed: %s\n", argv[2],
606 rc = parse_buffer(in, out);
615 const char debug_daemon_usage[] = "usage: %s {start file [MB]|stop}\n";
617 int jt_dbg_debug_daemon(int argc, char **argv)
623 fprintf(stderr, debug_daemon_usage, argv[0]);
627 fd = dbg_open_ctlhandle(DAEMON_CTL_NAME);
632 if (strcasecmp(argv[1], "start") == 0) {
633 if (argc < 3 || argc > 4 ||
634 (argc == 4 && strlen(argv[3]) > 5)) {
635 fprintf(stderr, debug_daemon_usage, argv[0]);
640 const long min_size = 10;
641 const long max_size = 20480;
645 size = strtoul(argv[3], &end, 0);
646 if (size < min_size ||
649 fprintf(stderr, "size %s invalid, must be in "
650 "the range %ld-%ld MB\n", argv[3],
654 snprintf(buf, sizeof(buf), "size=%ld", size);
655 rc = dbg_write_cmd(fd, buf, strlen(buf));
658 fprintf(stderr, "set %s failed: %s\n",
659 buf, strerror(errno));
664 rc = dbg_write_cmd(fd, argv[2], strlen(argv[2]));
666 fprintf(stderr, "start debug_daemon on %s failed: %s\n",
667 argv[2], strerror(errno));
673 if (strcasecmp(argv[1], "stop") == 0) {
674 rc = dbg_write_cmd(fd, "stop", 4);
676 fprintf(stderr, "stopping debug_daemon failed: %s\n",
685 fprintf(stderr, debug_daemon_usage, argv[0]);
688 dbg_close_ctlhandle(fd);
692 int jt_dbg_clear_debug_buf(int argc, char **argv)
695 struct libcfs_ioctl_data data;
698 fprintf(stderr, "usage: %s\n", argv[0]);
702 memset(&data, 0, sizeof(data));
703 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
704 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
708 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_CLEAR_DEBUG, buf);
710 fprintf(stderr, "IOC_LIBCFS_CLEAR_DEBUG failed: %s\n",
717 int jt_dbg_mark_debug_buf(int argc, char **argv)
719 static char scratch[MAX_MARK_SIZE] = { '\0' };
720 int rc, max_size = MAX_MARK_SIZE-1;
721 struct libcfs_ioctl_data data = { 0 };
723 time_t now = time(NULL);
728 strncpy(text, argv[1], max_size);
729 max_size-=strlen(argv[1]);
730 for (count = 2; (count < argc) && (max_size > 0); count++){
731 strncat(text, " ", max_size);
733 strncat(text, argv[count], max_size);
734 max_size -= strlen(argv[count]);
740 data.ioc_inllen1 = strlen(text) + 1;
741 data.ioc_inlbuf1 = text;
742 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
743 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
747 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_MARK_DEBUG, buf);
749 fprintf(stderr, "IOC_LIBCFS_MARK_DEBUG failed: %s\n",
756 static struct mod_paths {
759 {"libcfs", "libcfs/libcfs"},
760 {"lnet", "lnet/lnet"},
761 {"kciblnd", "lnet/klnds/ciblnd"},
762 {"kgmlnd", "lnet/klnds/gmlnd"},
763 {"kmxlnd", "lnet/klnds/mxlnd"},
764 {"kiiblnd", "lnet/klnds/iiblnd"},
765 {"ko2iblnd", "lnet/klnds/o2iblnd"},
766 {"kopeniblnd", "lnet/klnds/openiblnd"},
767 {"kptllnd", "lnet/klnds/ptllnd"},
768 {"kqswlnd", "lnet/klnds/qswlnd"},
769 {"kralnd", "lnet/klnds/ralnd"},
770 {"ksocklnd", "lnet/klnds/socklnd"},
771 {"ktdilnd", "lnet/klnds/tdilnd"},
772 {"kviblnd", "lnet/klnds/viblnd"},
773 {"lvfs", "lustre/lvfs"},
774 {"obdclass", "lustre/obdclass"},
775 {"llog_test", "lustre/obdclass"},
776 {"ptlrpc_gss", "lustre/ptlrpc/gss"},
777 {"ptlrpc", "lustre/ptlrpc"},
778 {"gks", "lustre/sec/gks"},
779 {"gkc", "lustre/sec/gks"},
780 {"ost", "lustre/ost"},
781 {"osc", "lustre/osc"},
782 {"mds", "lustre/mds"},
783 {"mdc", "lustre/mdc"},
784 {"llite", "lustre/llite"},
785 {"lustre", "lustre/llite"},
786 {"llite_lloop", "lustre/llite"},
787 {"ldiskfs", "ldiskfs/ldiskfs"},
788 {"smfs", "lustre/smfs"},
789 {"obdecho", "lustre/obdecho"},
790 {"ldlm", "lustre/ldlm"},
791 {"obdfilter", "lustre/obdfilter"},
792 {"lov", "lustre/lov"},
793 {"lmv", "lustre/lmv"},
794 {"fsfilt_ext3", "lustre/lvfs"},
795 {"fsfilt_reiserfs", "lustre/lvfs"},
796 {"fsfilt_smfs", "lustre/lvfs"},
797 {"fsfilt_ldiskfs", "lustre/lvfs"},
798 {"mds_ext3", "lustre/mds"},
799 {"cobd", "lustre/cobd"},
800 {"cmobd", "lustre/cmobd"},
801 {"lquota", "lustre/quota"},
802 {"mgs", "lustre/mgs"},
803 {"mgc", "lustre/mgc"},
804 {"mdt", "lustre/mdt"},
805 {"mdd", "lustre/mdd"},
806 {"osd", "lustre/osd"},
807 {"cmm", "lustre/cmm"},
808 {"fid", "lustre/fid"},
809 {"fld", "lustre/fld"},
813 static int jt_dbg_modules_2_4(int argc, char **argv)
818 static int jt_dbg_modules_2_5(int argc, char **argv)
820 struct mod_paths *mp;
822 char *kernel = "linux";
823 const char *proc = "/proc/modules";
824 char modname[128], buf[4096];
833 printf("%s [path] [kernel]\n", argv[0]);
837 file = fopen(proc, "r");
839 printf("failed open %s: %s\n", proc, strerror(errno));
843 while (fgets(buf, sizeof(buf), file) != NULL) {
844 if (sscanf(buf, "%s %*s %*s %*s %*s %lx", modname, &modaddr) == 2) {
845 for (mp = mod_paths; mp->name != NULL; mp++) {
846 if (!strcmp(mp->name, modname))
850 printf("add-symbol-file %s%s%s/%s.o 0x%0lx\n",
851 path, path[0] ? "/" : "",
852 mp->path, mp->name, modaddr);
861 int jt_dbg_modules(int argc, char **argv)
864 struct utsname sysinfo;
866 rc = uname(&sysinfo);
868 printf("uname() failed: %s\n", strerror(errno));
872 if (sysinfo.release[2] > '4') {
873 return jt_dbg_modules_2_5(argc, argv);
875 return jt_dbg_modules_2_4(argc, argv);
881 int jt_dbg_panic(int argc, char **argv)
884 struct libcfs_ioctl_data data;
887 fprintf(stderr, "usage: %s\n", argv[0]);
891 memset(&data, 0, sizeof(data));
892 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
893 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
897 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_PANIC, buf);
899 fprintf(stderr, "IOC_LIBCFS_PANIC failed: %s\n",