4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2012, Intel Corporation.
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[] = LIBCFS_DEBUG_SUBSYS_NAMES;
60 static const char *libcfs_debug_masks[] = LIBCFS_DEBUG_MASKS_NAMES;
64 #define DAEMON_CTL_NAME "/proc/sys/lnet/daemon_file"
65 #define SUBSYS_DEBUG_CTL_NAME "/proc/sys/lnet/subsystem_debug"
66 #define DEBUG_CTL_NAME "/proc/sys/lnet/debug"
67 #define DUMP_KERNEL_CTL_NAME "/proc/sys/lnet/dump_kernel"
70 dbg_open_ctlhandle(const char *str)
73 fd = open(str, O_WRONLY);
75 fprintf(stderr, "open %s failed: %s\n", str,
83 dbg_close_ctlhandle(int fd)
89 dbg_write_cmd(int fd, char *str, int len)
91 int rc = write(fd, str, len);
93 return (rc == len ? 0 : 1);
96 #elif defined(__DARWIN__)
98 #define DAEMON_CTL_NAME "lnet.trace_daemon"
99 #define SUBSYS_DEBUG_CTL_NAME "lnet.subsystem_debug"
100 #define DEBUG_CTL_NAME "lnet.debug"
101 #define DUMP_KERNEL_CTL_NAME "lnet.trace_dumpkernel"
103 static char sysctl_name[128];
105 dbg_open_ctlhandle(const char *str)
108 if (strlen(str)+1 > 128) {
109 fprintf(stderr, "sysctl name is too long: %s.\n", str);
112 strcpy(sysctl_name, str);
118 dbg_close_ctlhandle(int fd)
120 sysctl_name[0] = '\0';
125 dbg_write_cmd(int fd, char *str, int len)
129 rc = sysctlbyname(sysctl_name, NULL, NULL, str, len+1);
131 fprintf(stderr, "sysctl %s with cmd (%s) error: %d\n",
132 sysctl_name, str, errno);
134 return (rc == 0 ? 0: 1);
138 #error - Unknown sysctl convention.
141 static int do_debug_mask(char *name, int enable)
145 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++) {
146 if (strcasecmp(name, libcfs_debug_subsystems[i]) == 0 ||
147 strcasecmp(name, "all_subs") == 0) {
148 printf("%s output from subsystem \"%s\"\n",
149 enable ? "Enabling" : "Disabling",
150 libcfs_debug_subsystems[i]);
152 subsystem_mask |= (1 << i);
154 subsystem_mask &= ~(1 << i);
158 for (i = 0; libcfs_debug_masks[i] != NULL; i++) {
159 if (strcasecmp(name, libcfs_debug_masks[i]) == 0 ||
160 strcasecmp(name, "all_types") == 0) {
161 printf("%s output of type \"%s\"\n",
162 enable ? "Enabling" : "Disabling",
163 libcfs_debug_masks[i]);
165 debug_mask |= (1 << i);
167 debug_mask &= ~(1 << i);
175 int dbg_initialize(int argc, char **argv)
180 int jt_dbg_filter(int argc, char **argv)
185 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
190 for (i = 1; i < argc; i++)
191 if (!do_debug_mask(argv[i], 0))
192 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
197 int jt_dbg_show(int argc, char **argv)
202 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
207 for (i = 1; i < argc; i++)
208 if (!do_debug_mask(argv[i], 1))
209 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
215 static int applymask(char* procpath, int value)
219 int len = snprintf(buf, 64, "%d", value);
221 int fd = dbg_open_ctlhandle(procpath);
223 fprintf(stderr, "Unable to open %s: %s\n",
224 procpath, strerror(errno));
227 rc = dbg_write_cmd(fd, buf, len+1);
229 fprintf(stderr, "Write to %s failed: %s\n",
230 procpath, strerror(errno));
233 dbg_close_ctlhandle(fd);
238 static void applymask_all(unsigned int subs_mask, unsigned int debug_mask)
240 if (!dump_filename) {
241 applymask(SUBSYS_DEBUG_CTL_NAME, subs_mask);
242 applymask(DEBUG_CTL_NAME, debug_mask);
244 struct libcfs_debug_ioctl_data data;
246 data.hdr.ioc_len = sizeof(data);
247 data.hdr.ioc_version = 0;
248 data.subs = subs_mask;
249 data.debug = debug_mask;
251 dump(OBD_DEV_ID, LIBCFS_IOC_DEBUG_MASK, &data);
253 printf("Applied subsystem_debug=%d, debug=%d to /proc/sys/lnet\n",
254 subs_mask, debug_mask);
257 int jt_dbg_list(int argc, char **argv)
262 fprintf(stderr, "usage: %s <subs || types>\n", argv[0]);
266 if (strcasecmp(argv[1], "subs") == 0) {
267 printf("Subsystems: all_subs");
268 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++)
269 if (libcfs_debug_subsystems[i][0])
270 printf(", %s", libcfs_debug_subsystems[i]);
272 } else if (strcasecmp(argv[1], "types") == 0) {
273 printf("Types: all_types");
274 for (i = 0; libcfs_debug_masks[i] != NULL; i++)
275 printf(", %s", libcfs_debug_masks[i]);
277 } else if (strcasecmp(argv[1], "applymasks") == 0) {
278 applymask_all(subsystem_mask, debug_mask);
283 /* all strings nul-terminated; only the struct and hdr need to be freed */
285 struct ptldebug_header *hdr;
291 static int cmp_rec(const void *p1, const void *p2)
293 struct dbg_line *d1 = *(struct dbg_line **)p1;
294 struct dbg_line *d2 = *(struct dbg_line **)p2;
296 if (d1->hdr->ph_sec < d2->hdr->ph_sec)
298 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
299 d1->hdr->ph_usec < d2->hdr->ph_usec)
301 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
302 d1->hdr->ph_usec == d2->hdr->ph_usec)
307 static void print_rec(struct dbg_line ***linevp, int used, int fdout)
309 struct dbg_line **linev = *linevp;
312 qsort(linev, used, sizeof(struct dbg_line *), cmp_rec);
313 for (i = 0; i < used; i++) {
314 struct dbg_line *line = linev[i];
315 struct ptldebug_header *hdr = line->hdr;
319 ssize_t bytes_written;
321 bytes = sprintf(out, "%08x:%08x:%u.%u%s:%u.%06llu:%u:%u:%u:(%s:%u:%s()) %s",
322 hdr->ph_subsys, hdr->ph_mask,
323 hdr->ph_cpu_id, hdr->ph_type,
324 hdr->ph_flags & PH_FLAG_FIRST_RECORD ? "F" : "",
325 hdr->ph_sec, (unsigned long long)hdr->ph_usec,
326 hdr->ph_stack, hdr->ph_pid, hdr->ph_extern_pid,
327 line->file, hdr->ph_line_num, line->fn, line->text);
329 bytes_written = write(fdout, buf, bytes);
330 if (bytes_written <= 0)
332 bytes -= bytes_written;
333 buf += bytes_written;
342 static int add_rec(struct dbg_line *line, struct dbg_line ***linevp, int *lenp,
345 struct dbg_line **linev = *linevp;
348 int nlen = *lenp + 4096;
349 int nsize = nlen * sizeof(struct dbg_line *);
351 linev = realloc(*linevp, nsize);
363 static void dump_hdr(unsigned long long offset, struct ptldebug_header *hdr)
365 fprintf(stderr, "badly-formed record at offset = %llu\n", offset);
366 fprintf(stderr, " len = %u\n", hdr->ph_len);
367 fprintf(stderr, " flags = %x\n", hdr->ph_flags);
368 fprintf(stderr, " subsystem = %x\n", hdr->ph_subsys);
369 fprintf(stderr, " mask = %x\n", hdr->ph_mask);
370 fprintf(stderr, " cpu_id = %u\n", hdr->ph_cpu_id);
371 fprintf(stderr, " type = %u\n", hdr->ph_type);
372 fprintf(stderr, " seconds = %u\n", hdr->ph_sec);
373 fprintf(stderr, " microseconds = %lu\n", (long)hdr->ph_usec);
374 fprintf(stderr, " stack = %u\n", hdr->ph_stack);
375 fprintf(stderr, " pid = %u\n", hdr->ph_pid);
376 fprintf(stderr, " host pid = %u\n", hdr->ph_extern_pid);
377 fprintf(stderr, " line number = %u\n", hdr->ph_line_num);
380 #define HDR_SIZE sizeof(*hdr)
382 static int parse_buffer(int fdin, int fdout)
384 struct dbg_line *line;
385 struct ptldebug_header *hdr;
386 char buf[4097], *ptr;
387 unsigned long dropped = 0, kept = 0, bad = 0;
388 struct dbg_line **linev = NULL;
401 rc = read(fdin, ptr, count);
410 if (hdr->ph_len > 4094 || /* is this header bogus? */
411 hdr->ph_type >= libcfs_tcd_type_max() ||
412 hdr->ph_stack > 65536 ||
413 hdr->ph_sec < (1 << 30) ||
414 hdr->ph_usec > 1000000000 ||
415 hdr->ph_line_num > 65536) {
417 dump_hdr(lseek(fdin, 0, SEEK_CUR), hdr);
421 /* try to restart on next line */
422 while (count < HDR_SIZE && buf[count] != '\n')
424 if (buf[count] == '\n')
425 count++; /* move past '\n' */
426 if (HDR_SIZE - count > 0) {
427 int left = HDR_SIZE - count;
429 memmove(buf, buf + count, left);
438 if (hdr->ph_len == 0)
441 count = hdr->ph_len - HDR_SIZE;
443 rc = read(fdin, ptr, count);
454 if ((hdr->ph_subsys && !(subsystem_mask & hdr->ph_subsys)) ||
455 (hdr->ph_mask && !(debug_mask & hdr->ph_mask))) {
461 line = malloc(sizeof(*line));
464 fprintf(stderr, "error: line malloc(%u): "
465 "printing accumulated records\n",
466 (unsigned int)sizeof(*line));
467 print_rec(&linev, kept, fdout);
471 fprintf(stderr, "error: line malloc(%u): exiting\n",
472 (unsigned int)sizeof(*line));
476 line->hdr = malloc(hdr->ph_len + 1);
477 if (line->hdr == NULL) {
480 fprintf(stderr, "error: hdr malloc(%u): "
481 "printing accumulated records\n",
483 print_rec(&linev, kept, fdout);
487 fprintf(stderr, "error: hdr malloc(%u): exiting\n",
492 ptr = (void *)line->hdr;
493 memcpy(line->hdr, buf, hdr->ph_len);
494 ptr[hdr->ph_len] = '\0';
498 ptr += strlen(line->file) + 1;
500 ptr += strlen(line->fn) + 1;
504 if (add_rec(line, &linev, &linev_len, kept) < 0) {
506 fprintf(stderr, "error: add_rec[%u] failed; "
507 "print accumulated records\n",
509 print_rec(&linev, kept, fdout);
513 fprintf(stderr, "error: add_rec[0] failed; exiting\n");
521 print_rec(&linev, kept, fdout);
523 printf("Debug log: %lu lines, %lu kept, %lu dropped, %lu bad.\n",
524 dropped + kept + bad, kept, dropped, bad);
529 int jt_dbg_debug_kernel(int argc, char **argv)
532 char filename[PATH_MAX];
540 fprintf(stderr, "usage: %s [file] [raw]\n", argv[0]);
546 } else if (argc > 1 && (argv[1][0] == '0' || argv[1][0] == '1')) {
551 /* If we are dumping raw (which means no conversion step to ASCII)
552 * then dump directly to any supplied filename, otherwise this is
553 * just a temp file and we dump to the real file at convert time. */
554 if (argc > 1 && raw) {
555 if (strlen(argv[1]) >= sizeof(filename)) {
556 fprintf(stderr, "File name too long: %s\n", argv[1]);
559 strncpy(filename, argv[1], sizeof(filename));
561 if (snprintf(filename, sizeof(filename), "%s"CFS_TIME_T".%u",
562 LIBCFS_DEBUG_FILE_PATH_DEFAULT, time(NULL),
564 >= sizeof(filename)) {
565 fprintf(stderr, "File name too long\n");
570 if (stat(filename, &st) == 0 && S_ISREG(st.st_mode))
573 fdin = dbg_open_ctlhandle(DUMP_KERNEL_CTL_NAME);
575 fprintf(stderr, "open(dump_kernel) failed: %s\n",
580 rc = dbg_write_cmd(fdin, filename, strlen(filename));
582 dbg_close_ctlhandle(fdin);
584 fprintf(stderr, "write(%s) failed: %s\n", filename,
585 strerror(save_errno));
592 fdin = open(filename, O_RDONLY);
594 if (errno == ENOENT) /* no dump file created */
596 fprintf(stderr, "fopen(%s) failed: %s\n", filename,
601 fdout = open(argv[1], O_WRONLY | O_CREAT | O_TRUNC,
604 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
610 fdout = fileno(stdout);
613 rc = parse_buffer(fdin, fdout);
618 fprintf(stderr, "parse_buffer failed; leaving tmp file %s "
619 "behind.\n", filename);
621 rc = unlink(filename);
623 fprintf(stderr, "dumped successfully, but couldn't "
624 "unlink tmp file %s: %s\n", filename,
631 int jt_dbg_debug_file(int argc, char **argv)
637 if (argc > 3 || argc < 2) {
638 fprintf(stderr, "usage: %s <input> [output]\n", argv[0]);
642 fdin = open(argv[1], O_RDONLY | O_LARGEFILE);
644 fprintf(stderr, "open(%s) failed: %s\n", argv[1],
649 fdout = open(argv[2],
650 O_CREAT | O_TRUNC | O_WRONLY | O_LARGEFILE,
653 fprintf(stderr, "open(%s) failed: %s\n", argv[2],
659 fdout = fileno(stdout);
662 rc = parse_buffer(fdin, fdout);
665 if (fdout != fileno(stdout))
671 const char debug_daemon_usage[] = "usage: %s {start file [MB]|stop}\n";
673 int jt_dbg_debug_daemon(int argc, char **argv)
679 fprintf(stderr, debug_daemon_usage, argv[0]);
683 fd = dbg_open_ctlhandle(DAEMON_CTL_NAME);
688 if (strcasecmp(argv[1], "start") == 0) {
689 if (argc < 3 || argc > 4 ||
690 (argc == 4 && strlen(argv[3]) > 5)) {
691 fprintf(stderr, debug_daemon_usage, argv[0]);
696 const long min_size = 10;
697 const long max_size = 20480;
701 size = strtoul(argv[3], &end, 0);
702 if (size < min_size ||
705 fprintf(stderr, "size %s invalid, must be in "
706 "the range %ld-%ld MB\n", argv[3],
710 snprintf(buf, sizeof(buf), "size=%ld", size);
711 rc = dbg_write_cmd(fd, buf, strlen(buf));
714 fprintf(stderr, "set %s failed: %s\n",
715 buf, strerror(errno));
720 rc = dbg_write_cmd(fd, argv[2], strlen(argv[2]));
722 fprintf(stderr, "start debug_daemon on %s failed: %s\n",
723 argv[2], strerror(errno));
729 if (strcasecmp(argv[1], "stop") == 0) {
730 rc = dbg_write_cmd(fd, "stop", 4);
732 fprintf(stderr, "stopping debug_daemon failed: %s\n",
741 fprintf(stderr, debug_daemon_usage, argv[0]);
744 dbg_close_ctlhandle(fd);
748 int jt_dbg_clear_debug_buf(int argc, char **argv)
751 struct libcfs_ioctl_data data;
754 fprintf(stderr, "usage: %s\n", argv[0]);
758 memset(&data, 0, sizeof(data));
759 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
760 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
764 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_CLEAR_DEBUG, buf);
766 fprintf(stderr, "IOC_LIBCFS_CLEAR_DEBUG failed: %s\n",
773 int jt_dbg_mark_debug_buf(int argc, char **argv)
775 static char scratch[MAX_MARK_SIZE] = "";
776 struct libcfs_ioctl_data data = { 0 };
781 int count, max_size = sizeof(scratch) - 1;
783 strncpy(scratch, argv[1], max_size);
784 max_size -= strlen(argv[1]);
785 for (count = 2; (count < argc) && (max_size > 1); count++) {
786 strncat(scratch, " ", max_size);
788 strncat(scratch, argv[count], max_size);
789 max_size -= strlen(argv[count]);
791 scratch[sizeof(scratch) - 1] = '\0';
794 time_t now = time(NULL);
798 data.ioc_inllen1 = strlen(text) + 1;
799 data.ioc_inlbuf1 = text;
800 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
801 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
805 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_MARK_DEBUG, buf);
807 fprintf(stderr, "IOC_LIBCFS_MARK_DEBUG failed: %s\n",
814 static struct mod_paths {
817 { "libcfs", "libcfs/libcfs" },
818 { "lnet", "lnet/lnet" },
819 { "kmxlnd", "lnet/klnds/mxlnd" },
820 { "ko2iblnd", "lnet/klnds/o2iblnd" },
821 { "kgnilnd", "lnet/klnds/gnilnd"},
822 { "kqswlnd", "lnet/klnds/qswlnd" },
823 { "kralnd", "lnet/klnds/ralnd" },
824 { "ksocklnd", "lnet/klnds/socklnd" },
825 { "ktdilnd", "lnet/klnds/tdilnd" },
826 { "obdclass", "lustre/obdclass" },
827 { "llog_test", "lustre/obdclass" },
828 { "ptlrpc_gss", "lustre/ptlrpc/gss" },
829 { "ptlrpc", "lustre/ptlrpc" },
830 { "gks", "lustre/sec/gks" },
831 { "gkc", "lustre/sec/gks" },
832 { "ost", "lustre/ost" },
833 { "osc", "lustre/osc" },
834 { "mds", "lustre/mds" },
835 { "mdc", "lustre/mdc" },
836 { "lustre", "lustre/llite" },
837 { "llite_lloop", "lustre/llite" },
838 { "ldiskfs", "ldiskfs" },
839 { "obdecho", "lustre/obdecho" },
840 { "ldlm", "lustre/ldlm" },
841 { "obdfilter", "lustre/obdfilter" },
842 { "lov", "lustre/lov" },
843 { "lmv", "lustre/lmv" },
844 { "lquota", "lustre/quota" },
845 { "mgs", "lustre/mgs" },
846 { "mgc", "lustre/mgc" },
847 { "mdt", "lustre/mdt" },
848 { "mdd", "lustre/mdd" },
849 { "osd", "lustre/osd" },
850 { "cmm", "lustre/cmm" },
851 {"fid", "lustre/fid"},
852 {"fld", "lustre/fld"},
853 {"lod", "lustre/lod"},
854 {"osp", "lustre/osp"},
855 { "lfsck", "lustre/lfsck" },
859 int jt_dbg_modules(int argc, char **argv)
861 struct mod_paths *mp;
863 const char *proc = "/proc/modules";
864 char modname[128], buf[4096];
865 unsigned long modaddr;
871 printf("%s [path] [kernel]\n", argv[0]);
875 file = fopen(proc, "r");
877 printf("failed open %s: %s\n", proc, strerror(errno));
881 while (fgets(buf, sizeof(buf), file) != NULL) {
882 if (sscanf(buf, "%s %*s %*s %*s %*s %lx", modname, &modaddr) == 2) {
883 for (mp = mod_paths; mp->name != NULL; mp++) {
884 if (!strcmp(mp->name, modname))
888 printf("add-symbol-file %s%s%s/%s.o 0x%0lx\n",
889 path, path[0] ? "/" : "",
890 mp->path, mp->name, modaddr);
899 int jt_dbg_panic(int argc, char **argv)
902 struct libcfs_ioctl_data data;
905 fprintf(stderr, "usage: %s\n", argv[0]);
909 memset(&data, 0, sizeof(data));
910 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
911 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
915 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_PANIC, buf);
917 fprintf(stderr, "IOC_LIBCFS_PANIC failed: %s\n",