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;
63 #define DAEMON_CTL_NAME "/proc/sys/lnet/daemon_file"
64 #define SUBSYS_DEBUG_CTL_NAME "/proc/sys/lnet/subsystem_debug"
65 #define DEBUG_CTL_NAME "/proc/sys/lnet/debug"
66 #define DUMP_KERNEL_CTL_NAME "/proc/sys/lnet/dump_kernel"
69 dbg_open_ctlhandle(const char *str)
72 fd = open(str, O_WRONLY);
74 fprintf(stderr, "open %s failed: %s\n", str,
82 dbg_close_ctlhandle(int fd)
88 dbg_write_cmd(int fd, char *str, int len)
90 int rc = write(fd, str, len);
92 return (rc == len ? 0 : 1);
96 static int do_debug_mask(char *name, int enable)
100 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++) {
101 if (strcasecmp(name, libcfs_debug_subsystems[i]) == 0 ||
102 strcasecmp(name, "all_subs") == 0) {
103 printf("%s output from subsystem \"%s\"\n",
104 enable ? "Enabling" : "Disabling",
105 libcfs_debug_subsystems[i]);
107 subsystem_mask |= (1 << i);
109 subsystem_mask &= ~(1 << i);
113 for (i = 0; libcfs_debug_masks[i] != NULL; i++) {
114 if (strcasecmp(name, libcfs_debug_masks[i]) == 0 ||
115 strcasecmp(name, "all_types") == 0) {
116 printf("%s output of type \"%s\"\n",
117 enable ? "Enabling" : "Disabling",
118 libcfs_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 = dbg_open_ctlhandle(procpath);
178 fprintf(stderr, "Unable to open %s: %s\n",
179 procpath, strerror(errno));
182 rc = dbg_write_cmd(fd, buf, len+1);
184 fprintf(stderr, "Write to %s failed: %s\n",
185 procpath, strerror(errno));
188 dbg_close_ctlhandle(fd);
193 static void applymask_all(unsigned int subs_mask, unsigned int debug_mask)
195 if (!dump_filename) {
196 applymask(SUBSYS_DEBUG_CTL_NAME, subs_mask);
197 applymask(DEBUG_CTL_NAME, debug_mask);
199 struct libcfs_debug_ioctl_data data;
201 data.hdr.ioc_len = sizeof(data);
202 data.hdr.ioc_version = 0;
203 data.subs = subs_mask;
204 data.debug = debug_mask;
206 dump(OBD_DEV_ID, LIBCFS_IOC_DEBUG_MASK, &data);
208 printf("Applied subsystem_debug=%d, debug=%d to /proc/sys/lnet\n",
209 subs_mask, debug_mask);
212 int jt_dbg_list(int argc, char **argv)
217 fprintf(stderr, "usage: %s <subs || types>\n", argv[0]);
221 if (strcasecmp(argv[1], "subs") == 0) {
222 printf("Subsystems: all_subs");
223 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++)
224 if (libcfs_debug_subsystems[i][0])
225 printf(", %s", libcfs_debug_subsystems[i]);
227 } else if (strcasecmp(argv[1], "types") == 0) {
228 printf("Types: all_types");
229 for (i = 0; libcfs_debug_masks[i] != NULL; i++)
230 printf(", %s", libcfs_debug_masks[i]);
232 } else if (strcasecmp(argv[1], "applymasks") == 0) {
233 applymask_all(subsystem_mask, debug_mask);
238 /* all strings nul-terminated; only the struct and hdr need to be freed */
240 struct ptldebug_header *hdr;
246 static int cmp_rec(const void *p1, const void *p2)
248 struct dbg_line *d1 = *(struct dbg_line **)p1;
249 struct dbg_line *d2 = *(struct dbg_line **)p2;
251 if (d1->hdr->ph_sec < d2->hdr->ph_sec)
253 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
254 d1->hdr->ph_usec < d2->hdr->ph_usec)
256 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
257 d1->hdr->ph_usec == d2->hdr->ph_usec)
262 static void print_rec(struct dbg_line ***linevp, int used, int fdout)
264 struct dbg_line **linev = *linevp;
267 qsort(linev, used, sizeof(struct dbg_line *), cmp_rec);
268 for (i = 0; i < used; i++) {
269 struct dbg_line *line = linev[i];
270 struct ptldebug_header *hdr = line->hdr;
274 ssize_t bytes_written;
276 bytes = sprintf(out, "%08x:%08x:%u.%u%s:%u.%06llu:%u:%u:%u:(%s:%u:%s()) %s",
277 hdr->ph_subsys, hdr->ph_mask,
278 hdr->ph_cpu_id, hdr->ph_type,
279 hdr->ph_flags & PH_FLAG_FIRST_RECORD ? "F" : "",
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);
284 bytes_written = write(fdout, buf, bytes);
285 if (bytes_written <= 0)
287 bytes -= bytes_written;
288 buf += bytes_written;
297 static int add_rec(struct dbg_line *line, struct dbg_line ***linevp, int *lenp,
300 struct dbg_line **linev = *linevp;
303 int nlen = *lenp + 4096;
304 int nsize = nlen * sizeof(struct dbg_line *);
306 linev = realloc(*linevp, nsize);
318 static void dump_hdr(unsigned long long offset, struct ptldebug_header *hdr)
320 fprintf(stderr, "badly-formed record at offset = %llu\n", offset);
321 fprintf(stderr, " len = %u\n", hdr->ph_len);
322 fprintf(stderr, " flags = %x\n", hdr->ph_flags);
323 fprintf(stderr, " subsystem = %x\n", hdr->ph_subsys);
324 fprintf(stderr, " mask = %x\n", hdr->ph_mask);
325 fprintf(stderr, " cpu_id = %u\n", hdr->ph_cpu_id);
326 fprintf(stderr, " type = %u\n", hdr->ph_type);
327 fprintf(stderr, " seconds = %u\n", hdr->ph_sec);
328 fprintf(stderr, " microseconds = %lu\n", (long)hdr->ph_usec);
329 fprintf(stderr, " stack = %u\n", hdr->ph_stack);
330 fprintf(stderr, " pid = %u\n", hdr->ph_pid);
331 fprintf(stderr, " host pid = %u\n", hdr->ph_extern_pid);
332 fprintf(stderr, " line number = %u\n", hdr->ph_line_num);
335 #define HDR_SIZE sizeof(*hdr)
337 static int parse_buffer(int fdin, int fdout)
339 struct dbg_line *line;
340 struct ptldebug_header *hdr;
341 char buf[4097], *ptr;
342 unsigned long dropped = 0, kept = 0, bad = 0;
343 struct dbg_line **linev = NULL;
356 rc = read(fdin, ptr, count);
365 if (hdr->ph_len > 4094 || /* is this header bogus? */
366 hdr->ph_type >= libcfs_tcd_type_max() ||
367 hdr->ph_stack > 65536 ||
368 hdr->ph_sec < (1 << 30) ||
369 hdr->ph_usec > 1000000000 ||
370 hdr->ph_line_num > 65536) {
372 dump_hdr(lseek(fdin, 0, SEEK_CUR), hdr);
376 /* try to restart on next line */
377 while (count < HDR_SIZE && buf[count] != '\n')
379 if (buf[count] == '\n')
380 count++; /* move past '\n' */
381 if (HDR_SIZE - count > 0) {
382 int left = HDR_SIZE - count;
384 memmove(buf, buf + count, left);
393 if (hdr->ph_len == 0)
396 count = hdr->ph_len - HDR_SIZE;
398 rc = read(fdin, ptr, count);
409 if ((hdr->ph_subsys && !(subsystem_mask & hdr->ph_subsys)) ||
410 (hdr->ph_mask && !(debug_mask & hdr->ph_mask))) {
416 line = malloc(sizeof(*line));
419 fprintf(stderr, "error: line malloc(%u): "
420 "printing accumulated records\n",
421 (unsigned int)sizeof(*line));
422 print_rec(&linev, kept, fdout);
426 fprintf(stderr, "error: line malloc(%u): exiting\n",
427 (unsigned int)sizeof(*line));
431 line->hdr = malloc(hdr->ph_len + 1);
432 if (line->hdr == NULL) {
435 fprintf(stderr, "error: hdr malloc(%u): "
436 "printing accumulated records\n",
438 print_rec(&linev, kept, fdout);
442 fprintf(stderr, "error: hdr malloc(%u): exiting\n",
447 ptr = (void *)line->hdr;
448 memcpy(line->hdr, buf, hdr->ph_len);
449 ptr[hdr->ph_len] = '\0';
453 ptr += strlen(line->file) + 1;
455 ptr += strlen(line->fn) + 1;
459 if (add_rec(line, &linev, &linev_len, kept) < 0) {
461 fprintf(stderr, "error: add_rec[%u] failed; "
462 "print accumulated records\n",
464 print_rec(&linev, kept, fdout);
468 fprintf(stderr, "error: add_rec[0] failed; exiting\n");
476 print_rec(&linev, kept, fdout);
478 printf("Debug log: %lu lines, %lu kept, %lu dropped, %lu bad.\n",
479 dropped + kept + bad, kept, dropped, bad);
484 int jt_dbg_debug_kernel(int argc, char **argv)
487 char filename[PATH_MAX];
495 fprintf(stderr, "usage: %s [file] [raw]\n", argv[0]);
501 } else if (argc > 1 && (argv[1][0] == '0' || argv[1][0] == '1')) {
506 /* If we are dumping raw (which means no conversion step to ASCII)
507 * then dump directly to any supplied filename, otherwise this is
508 * just a temp file and we dump to the real file at convert time. */
509 if (argc > 1 && raw) {
510 if (strlen(argv[1]) >= sizeof(filename)) {
511 fprintf(stderr, "File name too long: %s\n", argv[1]);
514 strncpy(filename, argv[1], sizeof(filename));
516 if (snprintf(filename, sizeof(filename), "%s"CFS_TIME_T".%u",
517 LIBCFS_DEBUG_FILE_PATH_DEFAULT, time(NULL),
519 >= sizeof(filename)) {
520 fprintf(stderr, "File name too long\n");
525 if (stat(filename, &st) == 0 && S_ISREG(st.st_mode))
528 fdin = dbg_open_ctlhandle(DUMP_KERNEL_CTL_NAME);
530 fprintf(stderr, "open(dump_kernel) failed: %s\n",
535 rc = dbg_write_cmd(fdin, filename, strlen(filename));
537 dbg_close_ctlhandle(fdin);
539 fprintf(stderr, "write(%s) failed: %s\n", filename,
540 strerror(save_errno));
547 fdin = open(filename, O_RDONLY);
549 if (errno == ENOENT) /* no dump file created */
551 fprintf(stderr, "fopen(%s) failed: %s\n", filename,
556 fdout = open(argv[1], O_WRONLY | O_CREAT | O_TRUNC,
559 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
565 fdout = fileno(stdout);
568 rc = parse_buffer(fdin, fdout);
573 fprintf(stderr, "parse_buffer failed; leaving tmp file %s "
574 "behind.\n", filename);
576 rc = unlink(filename);
578 fprintf(stderr, "dumped successfully, but couldn't "
579 "unlink tmp file %s: %s\n", filename,
586 int jt_dbg_debug_file(int argc, char **argv)
592 if (argc > 3 || argc < 2) {
593 fprintf(stderr, "usage: %s <input> [output]\n", argv[0]);
597 fdin = open(argv[1], O_RDONLY | O_LARGEFILE);
599 fprintf(stderr, "open(%s) failed: %s\n", argv[1],
604 fdout = open(argv[2],
605 O_CREAT | O_TRUNC | O_WRONLY | O_LARGEFILE,
608 fprintf(stderr, "open(%s) failed: %s\n", argv[2],
614 fdout = fileno(stdout);
617 rc = parse_buffer(fdin, fdout);
620 if (fdout != fileno(stdout))
626 const char debug_daemon_usage[] = "usage: %s {start file [MB]|stop}\n";
628 int jt_dbg_debug_daemon(int argc, char **argv)
634 fprintf(stderr, debug_daemon_usage, argv[0]);
638 fd = dbg_open_ctlhandle(DAEMON_CTL_NAME);
643 if (strcasecmp(argv[1], "start") == 0) {
644 if (argc < 3 || argc > 4 ||
645 (argc == 4 && strlen(argv[3]) > 5)) {
646 fprintf(stderr, debug_daemon_usage, argv[0]);
651 const long min_size = 10;
652 const long max_size = 20480;
656 size = strtoul(argv[3], &end, 0);
657 if (size < min_size ||
660 fprintf(stderr, "size %s invalid, must be in "
661 "the range %ld-%ld MB\n", argv[3],
665 snprintf(buf, sizeof(buf), "size=%ld", size);
666 rc = dbg_write_cmd(fd, buf, strlen(buf));
669 fprintf(stderr, "set %s failed: %s\n",
670 buf, strerror(errno));
675 rc = dbg_write_cmd(fd, argv[2], strlen(argv[2]));
677 fprintf(stderr, "start debug_daemon on %s failed: %s\n",
678 argv[2], strerror(errno));
684 if (strcasecmp(argv[1], "stop") == 0) {
685 rc = dbg_write_cmd(fd, "stop", 4);
687 fprintf(stderr, "stopping debug_daemon failed: %s\n",
696 fprintf(stderr, debug_daemon_usage, argv[0]);
699 dbg_close_ctlhandle(fd);
703 int jt_dbg_clear_debug_buf(int argc, char **argv)
706 struct libcfs_ioctl_data data;
709 fprintf(stderr, "usage: %s\n", argv[0]);
713 memset(&data, 0, sizeof(data));
714 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
715 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
719 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_CLEAR_DEBUG, buf);
721 fprintf(stderr, "IOC_LIBCFS_CLEAR_DEBUG failed: %s\n",
728 int jt_dbg_mark_debug_buf(int argc, char **argv)
730 static char scratch[MAX_MARK_SIZE] = "";
731 struct libcfs_ioctl_data data;
735 memset(&data, 0, sizeof(data));
738 int count, max_size = sizeof(scratch) - 1;
740 strncpy(scratch, argv[1], max_size);
741 max_size -= strlen(argv[1]);
742 for (count = 2; (count < argc) && (max_size > 1); count++) {
743 strncat(scratch, " ", max_size);
745 strncat(scratch, argv[count], max_size);
746 max_size -= strlen(argv[count]);
748 scratch[sizeof(scratch) - 1] = '\0';
751 time_t now = time(NULL);
755 data.ioc_inllen1 = strlen(text) + 1;
756 data.ioc_inlbuf1 = text;
758 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
759 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
763 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_MARK_DEBUG, buf);
765 fprintf(stderr, "IOC_LIBCFS_MARK_DEBUG failed: %s\n",
772 static struct mod_paths {
775 { "libcfs", "libcfs/libcfs" },
776 { "lnet", "lnet/lnet" },
777 { "kmxlnd", "lnet/klnds/mxlnd" },
778 { "ko2iblnd", "lnet/klnds/o2iblnd" },
779 { "kgnilnd", "lnet/klnds/gnilnd"},
780 { "kqswlnd", "lnet/klnds/qswlnd" },
781 { "kralnd", "lnet/klnds/ralnd" },
782 { "ksocklnd", "lnet/klnds/socklnd" },
783 { "ktdilnd", "lnet/klnds/tdilnd" },
784 { "obdclass", "lustre/obdclass" },
785 { "llog_test", "lustre/obdclass" },
786 { "ptlrpc_gss", "lustre/ptlrpc/gss" },
787 { "ptlrpc", "lustre/ptlrpc" },
788 { "gks", "lustre/sec/gks" },
789 { "gkc", "lustre/sec/gks" },
790 { "ost", "lustre/ost" },
791 { "osc", "lustre/osc" },
792 { "mds", "lustre/mds" },
793 { "mdc", "lustre/mdc" },
794 { "lustre", "lustre/llite" },
795 { "llite_lloop", "lustre/llite" },
796 { "ldiskfs", "ldiskfs" },
797 { "obdecho", "lustre/obdecho" },
798 { "ldlm", "lustre/ldlm" },
799 { "obdfilter", "lustre/obdfilter" },
800 { "lov", "lustre/lov" },
801 { "lmv", "lustre/lmv" },
802 { "lquota", "lustre/quota" },
803 { "mgs", "lustre/mgs" },
804 { "mgc", "lustre/mgc" },
805 { "mdt", "lustre/mdt" },
806 { "mdd", "lustre/mdd" },
807 { "osd", "lustre/osd" },
808 { "cmm", "lustre/cmm" },
809 {"fid", "lustre/fid"},
810 {"fld", "lustre/fld"},
811 {"lod", "lustre/lod"},
812 {"osp", "lustre/osp"},
813 { "lfsck", "lustre/lfsck" },
817 int jt_dbg_modules(int argc, char **argv)
819 struct mod_paths *mp;
821 const char *proc = "/proc/modules";
822 char modname[128], buf[4096];
823 unsigned long modaddr;
829 printf("%s [path] [kernel]\n", argv[0]);
833 file = fopen(proc, "r");
835 printf("failed open %s: %s\n", proc, strerror(errno));
839 while (fgets(buf, sizeof(buf), file) != NULL) {
840 if (sscanf(buf, "%s %*s %*s %*s %*s %lx", modname, &modaddr) == 2) {
841 for (mp = mod_paths; mp->name != NULL; mp++) {
842 if (!strcmp(mp->name, modname))
846 printf("add-symbol-file %s%s%s/%s.o 0x%0lx\n",
847 path, path[0] ? "/" : "",
848 mp->path, mp->name, modaddr);
857 int jt_dbg_panic(int argc, char **argv)
860 struct libcfs_ioctl_data data;
863 fprintf(stderr, "usage: %s\n", argv[0]);
867 memset(&data, 0, sizeof(data));
868 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
869 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
873 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_PANIC, buf);
875 fprintf(stderr, "IOC_LIBCFS_PANIC failed: %s\n",