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", "lquota", "",
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 ***linevp, int used, int fdout)
358 struct dbg_line **linev = *linevp;
361 qsort(linev, used, sizeof(struct dbg_line *), cmp_rec);
362 for (i = 0; i < used; i++) {
363 struct dbg_line *line = linev[i];
364 struct ptldebug_header *hdr = line->hdr;
368 bytes = sprintf(out, "%08x:%08x:%u:%u.%06llu:%u:%u:%u:(%s:%u:%s()) %s",
369 hdr->ph_subsys, hdr->ph_mask, hdr->ph_cpu_id,
370 hdr->ph_sec, (unsigned long long)hdr->ph_usec,
371 hdr->ph_stack, hdr->ph_pid, hdr->ph_extern_pid,
372 line->file, hdr->ph_line_num, line->fn, line->text);
374 write(fdout, out, bytes);
382 static int add_rec(struct dbg_line *line, struct dbg_line ***linevp, int *lenp,
385 struct dbg_line **linev = *linevp;
388 int nlen = *lenp + 4096;
389 int nsize = nlen * sizeof(struct dbg_line *);
391 linev = realloc(*linevp, nsize);
403 static void dump_hdr(unsigned long long offset, struct ptldebug_header *hdr)
405 fprintf(stderr, "badly-formed record at offset = %llu\n", offset);
406 fprintf(stderr, " len = %u\n", hdr->ph_len);
407 fprintf(stderr, " flags = %x\n", hdr->ph_flags);
408 fprintf(stderr, " subsystem = %x\n", hdr->ph_subsys);
409 fprintf(stderr, " mask = %x\n", hdr->ph_mask);
410 fprintf(stderr, " cpu_id = %u\n", hdr->ph_cpu_id);
411 fprintf(stderr, " seconds = %u\n", hdr->ph_sec);
412 fprintf(stderr, " microseconds = %lu\n", (long)hdr->ph_usec);
413 fprintf(stderr, " stack = %u\n", hdr->ph_stack);
414 fprintf(stderr, " pid = %u\n", hdr->ph_pid);
415 fprintf(stderr, " host pid = %u\n", hdr->ph_extern_pid);
416 fprintf(stderr, " line number = %u\n", hdr->ph_line_num);
419 #define HDR_SIZE sizeof(*hdr)
421 static int parse_buffer(int fdin, int fdout)
423 struct dbg_line *line;
424 struct ptldebug_header *hdr;
425 char buf[4097], *ptr;
426 unsigned long dropped = 0, kept = 0, bad = 0;
427 struct dbg_line **linev = NULL;
440 rc = read(fdin, ptr, count);
449 if (hdr->ph_len > 4094 || /* is this header bogus? */
450 hdr->ph_cpu_id > 65536 ||
451 hdr->ph_stack > 65536 ||
452 hdr->ph_sec < (1 << 30) ||
453 hdr->ph_usec > 1000000000 ||
454 hdr->ph_line_num > 65536) {
456 dump_hdr(lseek(fdin, 0, SEEK_CUR), hdr);
460 /* try to restart on next line */
461 while (count < HDR_SIZE && buf[count] != '\n')
463 if (buf[count] == '\n')
464 count++; /* move past '\n' */
465 if (HDR_SIZE - count > 0) {
466 int left = HDR_SIZE - count;
468 memmove(buf, buf + count, left);
477 if (hdr->ph_len == 0)
480 count = hdr->ph_len - HDR_SIZE;
482 rc = read(fdin, ptr, count);
493 if ((hdr->ph_subsys && !(subsystem_mask & hdr->ph_subsys)) ||
494 (hdr->ph_mask && !(debug_mask & hdr->ph_mask))) {
500 line = malloc(sizeof(*line));
503 fprintf(stderr, "error: line malloc(%u): "
504 "printing accumulated records\n",
505 (unsigned int)sizeof(*line));
506 print_rec(&linev, kept, fdout);
510 fprintf(stderr, "error: line malloc(%u): exiting\n",
511 (unsigned int)sizeof(*line));
515 line->hdr = malloc(hdr->ph_len + 1);
516 if (line->hdr == NULL) {
519 fprintf(stderr, "error: hdr malloc(%u): "
520 "printing accumulated records\n",
522 print_rec(&linev, kept, fdout);
526 fprintf(stderr, "error: hdr malloc(%u): exiting\n",
531 ptr = (void *)line->hdr;
532 memcpy(line->hdr, buf, hdr->ph_len);
533 ptr[hdr->ph_len] = '\0';
537 ptr += strlen(line->file) + 1;
539 ptr += strlen(line->fn) + 1;
543 if (add_rec(line, &linev, &linev_len, kept) < 0) {
545 fprintf(stderr, "error: add_rec[%u] failed; "
546 "print accumulated records\n",
548 print_rec(&linev, kept, fdout);
552 fprintf(stderr, "error: add_rec[0] failed; exiting\n");
560 print_rec(&linev, kept, fdout);
562 printf("Debug log: %lu lines, %lu kept, %lu dropped, %lu bad.\n",
563 dropped + kept + bad, kept, dropped, bad);
568 int jt_dbg_debug_kernel(int argc, char **argv)
579 fprintf(stderr, "usage: %s [file] [raw]\n", argv[0]);
585 } else if (argc > 1 && (argv[1][0] == '0' || argv[1][0] == '1')) {
590 /* If we are dumping raw (which means no conversion step to ASCII)
591 * then dump directly to any supplied filename, otherwise this is
592 * just a temp file and we dump to the real file at convert time. */
594 strcpy(filename, argv[1]);
596 sprintf(filename, "%s"CFS_TIME_T".%u",
597 DEBUG_FILE_PATH_DEFAULT, time(NULL), getpid());
599 if (stat(filename, &st) == 0 && S_ISREG(st.st_mode))
602 fdin = dbg_open_ctlhandle(DUMP_KERNEL_CTL_NAME);
604 fprintf(stderr, "open(dump_kernel) failed: %s\n",
609 rc = dbg_write_cmd(fdin, filename, strlen(filename));
611 dbg_close_ctlhandle(fdin);
613 fprintf(stderr, "write(%s) failed: %s\n", filename,
614 strerror(save_errno));
621 fdin = open(filename, O_RDONLY);
623 if (errno == ENOENT) /* no dump file created */
625 fprintf(stderr, "fopen(%s) failed: %s\n", filename,
630 fdout = open(argv[1], O_WRONLY|O_CREAT|O_TRUNC);
632 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
638 fdout = fileno(stdout);
641 rc = parse_buffer(fdin, fdout);
646 fprintf(stderr, "parse_buffer failed; leaving tmp file %s "
647 "behind.\n", filename);
649 rc = unlink(filename);
651 fprintf(stderr, "dumped successfully, but couldn't "
652 "unlink tmp file %s: %s\n", filename,
659 int jt_dbg_debug_file(int argc, char **argv)
665 if (argc > 3 || argc < 2) {
666 fprintf(stderr, "usage: %s <input> [output]\n", argv[0]);
670 fdin = open(argv[1], O_RDONLY | O_LARGEFILE);
672 fprintf(stderr, "open(%s) failed: %s\n", argv[1],
677 fdout = open(argv[2],
678 O_CREAT | O_TRUNC | O_WRONLY | O_LARGEFILE,
681 fprintf(stderr, "open(%s) failed: %s\n", argv[2],
687 fdout = fileno(stdout);
690 rc = parse_buffer(fdin, fdout);
693 if (fdout != fileno(stdout))
699 const char debug_daemon_usage[] = "usage: %s {start file [MB]|stop}\n";
701 int jt_dbg_debug_daemon(int argc, char **argv)
707 fprintf(stderr, debug_daemon_usage, argv[0]);
711 fd = dbg_open_ctlhandle(DAEMON_CTL_NAME);
716 if (strcasecmp(argv[1], "start") == 0) {
717 if (argc < 3 || argc > 4 ||
718 (argc == 4 && strlen(argv[3]) > 5)) {
719 fprintf(stderr, debug_daemon_usage, argv[0]);
724 const long min_size = 10;
725 const long max_size = 20480;
729 size = strtoul(argv[3], &end, 0);
730 if (size < min_size ||
733 fprintf(stderr, "size %s invalid, must be in "
734 "the range %ld-%ld MB\n", argv[3],
738 snprintf(buf, sizeof(buf), "size=%ld", size);
739 rc = dbg_write_cmd(fd, buf, strlen(buf));
742 fprintf(stderr, "set %s failed: %s\n",
743 buf, strerror(errno));
748 rc = dbg_write_cmd(fd, argv[2], strlen(argv[2]));
750 fprintf(stderr, "start debug_daemon on %s failed: %s\n",
751 argv[2], strerror(errno));
757 if (strcasecmp(argv[1], "stop") == 0) {
758 rc = dbg_write_cmd(fd, "stop", 4);
760 fprintf(stderr, "stopping debug_daemon failed: %s\n",
769 fprintf(stderr, debug_daemon_usage, argv[0]);
772 dbg_close_ctlhandle(fd);
776 int jt_dbg_clear_debug_buf(int argc, char **argv)
779 struct libcfs_ioctl_data data;
782 fprintf(stderr, "usage: %s\n", argv[0]);
786 memset(&data, 0, sizeof(data));
787 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
788 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
792 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_CLEAR_DEBUG, buf);
794 fprintf(stderr, "IOC_LIBCFS_CLEAR_DEBUG failed: %s\n",
801 int jt_dbg_mark_debug_buf(int argc, char **argv)
803 static char scratch[MAX_MARK_SIZE] = { '\0' };
804 int rc, max_size = MAX_MARK_SIZE-1;
805 struct libcfs_ioctl_data data = { 0 };
807 time_t now = time(NULL);
812 strncpy(text, argv[1], max_size);
813 max_size-=strlen(argv[1]);
814 for (count = 2; (count < argc) && (max_size > 0); count++){
815 strncat(text, " ", max_size);
817 strncat(text, argv[count], max_size);
818 max_size -= strlen(argv[count]);
824 data.ioc_inllen1 = strlen(text) + 1;
825 data.ioc_inlbuf1 = text;
826 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
827 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
831 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_MARK_DEBUG, buf);
833 fprintf(stderr, "IOC_LIBCFS_MARK_DEBUG failed: %s\n",
840 static struct mod_paths {
843 {"libcfs", "libcfs/libcfs"},
844 {"lnet", "lnet/lnet"},
845 {"kciblnd", "lnet/klnds/ciblnd"},
846 {"kgmlnd", "lnet/klnds/gmlnd"},
847 {"kmxlnd", "lnet/klnds/mxlnd"},
848 {"kiiblnd", "lnet/klnds/iiblnd"},
849 {"ko2iblnd", "lnet/klnds/o2iblnd"},
850 {"kopeniblnd", "lnet/klnds/openiblnd"},
851 {"kptllnd", "lnet/klnds/ptllnd"},
852 {"kqswlnd", "lnet/klnds/qswlnd"},
853 {"kralnd", "lnet/klnds/ralnd"},
854 {"ksocklnd", "lnet/klnds/socklnd"},
855 {"ktdilnd", "lnet/klnds/tdilnd"},
856 {"kviblnd", "lnet/klnds/viblnd"},
857 {"lvfs", "lustre/lvfs"},
858 {"obdclass", "lustre/obdclass"},
859 {"llog_test", "lustre/obdclass"},
860 {"ptlrpc_gss", "lustre/ptlrpc/gss"},
861 {"ptlrpc", "lustre/ptlrpc"},
862 {"gks", "lustre/sec/gks"},
863 {"gkc", "lustre/sec/gks"},
864 {"ost", "lustre/ost"},
865 {"osc", "lustre/osc"},
866 {"mds", "lustre/mds"},
867 {"mdc", "lustre/mdc"},
868 {"llite", "lustre/llite"},
869 {"lustre", "lustre/llite"},
870 {"llite_lloop", "lustre/llite"},
871 {"ldiskfs", "ldiskfs/ldiskfs"},
872 {"smfs", "lustre/smfs"},
873 {"obdecho", "lustre/obdecho"},
874 {"ldlm", "lustre/ldlm"},
875 {"obdfilter", "lustre/obdfilter"},
876 {"lov", "lustre/lov"},
877 {"lmv", "lustre/lmv"},
878 {"fsfilt_ext3", "lustre/lvfs"},
879 {"fsfilt_reiserfs", "lustre/lvfs"},
880 {"fsfilt_smfs", "lustre/lvfs"},
881 {"fsfilt_ldiskfs", "lustre/lvfs"},
882 {"mds_ext3", "lustre/mds"},
883 {"cobd", "lustre/cobd"},
884 {"cmobd", "lustre/cmobd"},
885 {"lquota", "lustre/quota"},
886 {"mgs", "lustre/mgs"},
887 {"mgc", "lustre/mgc"},
888 {"mdt", "lustre/mdt"},
889 {"mdd", "lustre/mdd"},
890 {"osd", "lustre/osd"},
891 {"cmm", "lustre/cmm"},
892 {"fid", "lustre/fid"},
893 {"fld", "lustre/fld"},
897 static int jt_dbg_modules_2_4(int argc, char **argv)
902 static int jt_dbg_modules_2_5(int argc, char **argv)
904 struct mod_paths *mp;
906 char *kernel = "linux";
907 const char *proc = "/proc/modules";
908 char modname[128], buf[4096];
917 printf("%s [path] [kernel]\n", argv[0]);
921 file = fopen(proc, "r");
923 printf("failed open %s: %s\n", proc, strerror(errno));
927 while (fgets(buf, sizeof(buf), file) != NULL) {
928 if (sscanf(buf, "%s %*s %*s %*s %*s %lx", modname, &modaddr) == 2) {
929 for (mp = mod_paths; mp->name != NULL; mp++) {
930 if (!strcmp(mp->name, modname))
934 printf("add-symbol-file %s%s%s/%s.o 0x%0lx\n",
935 path, path[0] ? "/" : "",
936 mp->path, mp->name, modaddr);
945 int jt_dbg_modules(int argc, char **argv)
948 struct utsname sysinfo;
950 rc = uname(&sysinfo);
952 printf("uname() failed: %s\n", strerror(errno));
956 if (sysinfo.release[2] > '4') {
957 return jt_dbg_modules_2_5(argc, argv);
959 return jt_dbg_modules_2_4(argc, argv);
965 int jt_dbg_panic(int argc, char **argv)
968 struct libcfs_ioctl_data data;
971 fprintf(stderr, "usage: %s\n", argv[0]);
975 memset(&data, 0, sizeof(data));
976 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
977 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
981 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_PANIC, buf);
983 fprintf(stderr, "IOC_LIBCFS_PANIC failed: %s\n",