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, 2014, 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
47 #include <libcfs/libcfs.h>
48 #include <libcfs/util/ioctl.h>
49 #include <lnet/lnetctl.h>
51 static char rawbuf[8192];
52 static char *buf = rawbuf;
53 static int max = 8192;
54 /*static int g_pfd = -1;*/
55 static int subsystem_mask = ~0;
56 static int debug_mask = ~0;
58 #define MAX_MARK_SIZE 256
60 static const char *libcfs_debug_subsystems[] = LIBCFS_DEBUG_SUBSYS_NAMES;
61 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)
101 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++) {
102 if (strcasecmp(name, libcfs_debug_subsystems[i]) == 0 ||
103 strcasecmp(name, "all_subs") == 0) {
104 printf("%s output from subsystem \"%s\"\n",
105 enable ? "Enabling" : "Disabling",
106 libcfs_debug_subsystems[i]);
108 subsystem_mask |= (1 << i);
110 subsystem_mask &= ~(1 << i);
114 for (i = 0; libcfs_debug_masks[i] != NULL; i++) {
115 if (strcasecmp(name, libcfs_debug_masks[i]) == 0 ||
116 strcasecmp(name, "all_types") == 0) {
117 printf("%s output of type \"%s\"\n",
118 enable ? "Enabling" : "Disabling",
119 libcfs_debug_masks[i]);
121 debug_mask |= (1 << i);
123 debug_mask &= ~(1 << i);
131 int dbg_initialize(int argc, char **argv)
136 int jt_dbg_filter(int argc, char **argv)
141 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
146 for (i = 1; i < argc; i++)
147 if (!do_debug_mask(argv[i], 0))
148 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
153 int jt_dbg_show(int argc, char **argv)
158 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
163 for (i = 1; i < argc; i++)
164 if (!do_debug_mask(argv[i], 1))
165 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
171 static int applymask(char* procpath, int value)
175 int len = snprintf(buf, 64, "%d", value);
177 int fd = dbg_open_ctlhandle(procpath);
179 fprintf(stderr, "Unable to open %s: %s\n",
180 procpath, strerror(errno));
183 rc = dbg_write_cmd(fd, buf, len+1);
185 fprintf(stderr, "Write to %s failed: %s\n",
186 procpath, strerror(errno));
189 dbg_close_ctlhandle(fd);
194 static void applymask_all(unsigned int subs_mask, unsigned int debug_mask)
196 applymask(SUBSYS_DEBUG_CTL_NAME, subs_mask);
197 applymask(DEBUG_CTL_NAME, debug_mask);
198 printf("Applied subsystem_debug=%d, debug=%d to /proc/sys/lnet\n",
199 subs_mask, debug_mask);
202 int jt_dbg_list(int argc, char **argv)
207 fprintf(stderr, "usage: %s <subs || types>\n", argv[0]);
211 if (strcasecmp(argv[1], "subs") == 0) {
212 printf("Subsystems: all_subs");
213 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++)
214 if (libcfs_debug_subsystems[i][0])
215 printf(", %s", libcfs_debug_subsystems[i]);
217 } else if (strcasecmp(argv[1], "types") == 0) {
218 printf("Types: all_types");
219 for (i = 0; libcfs_debug_masks[i] != NULL; i++)
220 printf(", %s", libcfs_debug_masks[i]);
222 } else if (strcasecmp(argv[1], "applymasks") == 0) {
223 applymask_all(subsystem_mask, debug_mask);
228 /* all strings nul-terminated; only the struct and hdr need to be freed */
230 struct ptldebug_header *hdr;
236 static int cmp_rec(const void *p1, const void *p2)
238 struct dbg_line *d1 = *(struct dbg_line **)p1;
239 struct dbg_line *d2 = *(struct dbg_line **)p2;
241 if (d1->hdr->ph_sec < d2->hdr->ph_sec)
243 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
244 d1->hdr->ph_usec < d2->hdr->ph_usec)
246 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
247 d1->hdr->ph_usec == d2->hdr->ph_usec)
252 static void print_rec(struct dbg_line ***linevp, int used, int fdout)
254 struct dbg_line **linev = *linevp;
257 qsort(linev, used, sizeof(struct dbg_line *), cmp_rec);
258 for (i = 0; i < used; i++) {
259 struct dbg_line *line = linev[i];
260 struct ptldebug_header *hdr = line->hdr;
264 ssize_t bytes_written;
266 bytes = snprintf(out, sizeof(out),
267 "%08x:%08x:%u.%u%s:%u.%06llu:%u:%u:%u:"
269 hdr->ph_subsys, hdr->ph_mask,
270 hdr->ph_cpu_id, hdr->ph_type,
271 hdr->ph_flags & PH_FLAG_FIRST_RECORD ? "F" : "",
272 hdr->ph_sec, (unsigned long long)hdr->ph_usec,
273 hdr->ph_stack, hdr->ph_pid, hdr->ph_extern_pid,
274 line->file, hdr->ph_line_num, line->fn,
277 bytes_written = write(fdout, buf, bytes);
278 if (bytes_written <= 0)
280 bytes -= bytes_written;
281 buf += bytes_written;
290 static int add_rec(struct dbg_line *line, struct dbg_line ***linevp, int *lenp,
293 struct dbg_line **linev = *linevp;
296 int nlen = *lenp + 4096;
297 int nsize = nlen * sizeof(struct dbg_line *);
299 linev = realloc(*linevp, nsize);
311 static void dump_hdr(unsigned long long offset, struct ptldebug_header *hdr)
313 fprintf(stderr, "badly-formed record at offset = %llu\n", offset);
314 fprintf(stderr, " len = %u\n", hdr->ph_len);
315 fprintf(stderr, " flags = %x\n", hdr->ph_flags);
316 fprintf(stderr, " subsystem = %x\n", hdr->ph_subsys);
317 fprintf(stderr, " mask = %x\n", hdr->ph_mask);
318 fprintf(stderr, " cpu_id = %u\n", hdr->ph_cpu_id);
319 fprintf(stderr, " type = %u\n", hdr->ph_type);
320 fprintf(stderr, " seconds = %u\n", hdr->ph_sec);
321 fprintf(stderr, " microseconds = %lu\n", (long)hdr->ph_usec);
322 fprintf(stderr, " stack = %u\n", hdr->ph_stack);
323 fprintf(stderr, " pid = %u\n", hdr->ph_pid);
324 fprintf(stderr, " host pid = %u\n", hdr->ph_extern_pid);
325 fprintf(stderr, " line number = %u\n", hdr->ph_line_num);
328 #define HDR_SIZE sizeof(*hdr)
330 static int parse_buffer(int fdin, int fdout)
332 struct dbg_line *line;
333 struct ptldebug_header *hdr;
336 unsigned long dropped = 0;
337 unsigned long kept = 0;
338 unsigned long bad = 0;
339 struct dbg_line **linev = NULL;
352 rc = read(fdin, ptr, count);
361 if (hdr->ph_len > 4094 || /* is this header bogus? */
362 hdr->ph_stack > 65536 ||
363 hdr->ph_sec < (1 << 30) ||
364 hdr->ph_usec > 1000000000 ||
365 hdr->ph_line_num > 65536) {
367 dump_hdr(lseek(fdin, 0, SEEK_CUR), hdr);
371 /* try to restart on next line */
372 while (count < HDR_SIZE && buf[count] != '\n')
374 if (buf[count] == '\n')
375 count++; /* move past '\n' */
376 if (HDR_SIZE - count > 0) {
377 int left = HDR_SIZE - count;
379 memmove(buf, buf + count, left);
388 if (hdr->ph_len == 0)
391 count = hdr->ph_len - HDR_SIZE;
393 rc = read(fdin, ptr, count);
404 if ((hdr->ph_subsys && !(subsystem_mask & hdr->ph_subsys)) ||
405 (hdr->ph_mask && !(debug_mask & hdr->ph_mask))) {
411 line = malloc(sizeof(*line));
414 fprintf(stderr, "error: line malloc(%u): "
415 "printing accumulated records\n",
416 (unsigned int)sizeof(*line));
417 print_rec(&linev, kept, fdout);
421 fprintf(stderr, "error: line malloc(%u): exiting\n",
422 (unsigned int)sizeof(*line));
426 line->hdr = malloc(hdr->ph_len + 1);
427 if (line->hdr == NULL) {
430 fprintf(stderr, "error: hdr malloc(%u): "
431 "printing accumulated records\n",
433 print_rec(&linev, kept, fdout);
437 fprintf(stderr, "error: hdr malloc(%u): exiting\n",
442 ptr = (void *)line->hdr;
443 memcpy(line->hdr, buf, hdr->ph_len);
444 ptr[hdr->ph_len] = '\0';
448 ptr += strlen(line->file) + 1;
450 ptr += strlen(line->fn) + 1;
454 if (add_rec(line, &linev, &linev_len, kept) < 0) {
456 fprintf(stderr, "error: add_rec[%u] failed; "
457 "print accumulated records\n",
459 print_rec(&linev, kept, fdout);
463 fprintf(stderr, "error: add_rec[0] failed; exiting\n");
471 print_rec(&linev, kept, fdout);
473 printf("Debug log: %lu lines, %lu kept, %lu dropped, %lu bad.\n",
474 dropped + kept + bad, kept, dropped, bad);
479 int jt_dbg_debug_kernel(int argc, char **argv)
482 char filename[PATH_MAX];
490 fprintf(stderr, "usage: %s [file] [raw]\n", argv[0]);
496 } else if (argc > 1 && (argv[1][0] == '0' || argv[1][0] == '1')) {
501 /* If we are dumping raw (which means no conversion step to ASCII)
502 * then dump directly to any supplied filename, otherwise this is
503 * just a temp file and we dump to the real file at convert time. */
504 if (argc > 1 && raw) {
505 if (strlen(argv[1]) >= sizeof(filename)) {
506 fprintf(stderr, "File name too long: %s\n", argv[1]);
509 strncpy(filename, argv[1], sizeof(filename));
511 if (snprintf(filename, sizeof(filename), "%s"CFS_TIME_T".%u",
512 LIBCFS_DEBUG_FILE_PATH_DEFAULT, time(NULL),
514 >= sizeof(filename)) {
515 fprintf(stderr, "File name too long\n");
520 if (stat(filename, &st) == 0 && S_ISREG(st.st_mode))
523 fdin = dbg_open_ctlhandle(DUMP_KERNEL_CTL_NAME);
525 fprintf(stderr, "open(dump_kernel) failed: %s\n",
530 rc = dbg_write_cmd(fdin, filename, strlen(filename));
532 dbg_close_ctlhandle(fdin);
534 fprintf(stderr, "write(%s) failed: %s\n", filename,
535 strerror(save_errno));
542 fdin = open(filename, O_RDONLY);
544 if (errno == ENOENT) /* no dump file created */
546 fprintf(stderr, "fopen(%s) failed: %s\n", filename,
551 fdout = open(argv[1], O_WRONLY | O_CREAT | O_TRUNC,
554 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
560 fdout = fileno(stdout);
563 rc = parse_buffer(fdin, fdout);
568 fprintf(stderr, "parse_buffer failed; leaving tmp file %s "
569 "behind.\n", filename);
571 rc = unlink(filename);
573 fprintf(stderr, "dumped successfully, but couldn't "
574 "unlink tmp file %s: %s\n", filename,
581 int jt_dbg_debug_file(int argc, char **argv)
587 if (argc > 3 || argc < 2) {
588 fprintf(stderr, "usage: %s <input> [output]\n", argv[0]);
592 fdin = open(argv[1], O_RDONLY | O_LARGEFILE);
594 fprintf(stderr, "open(%s) failed: %s\n", argv[1],
599 fdout = open(argv[2],
600 O_CREAT | O_TRUNC | O_WRONLY | O_LARGEFILE,
603 fprintf(stderr, "open(%s) failed: %s\n", argv[2],
609 fdout = fileno(stdout);
612 rc = parse_buffer(fdin, fdout);
615 if (fdout != fileno(stdout))
621 const char debug_daemon_usage[] = "usage: %s {start file [MB]|stop}\n";
623 int jt_dbg_debug_daemon(int argc, char **argv)
629 fprintf(stderr, debug_daemon_usage, argv[0]);
633 fd = dbg_open_ctlhandle(DAEMON_CTL_NAME);
638 if (strcasecmp(argv[1], "start") == 0) {
639 if (argc < 3 || argc > 4 ||
640 (argc == 4 && strlen(argv[3]) > 5)) {
641 fprintf(stderr, debug_daemon_usage, argv[0]);
646 const long min_size = 10;
647 const long max_size = 20480;
651 size = strtoul(argv[3], &end, 0);
652 if (size < min_size ||
655 fprintf(stderr, "size %s invalid, must be in "
656 "the range %ld-%ld MB\n", argv[3],
660 snprintf(buf, sizeof(buf), "size=%ld", size);
661 rc = dbg_write_cmd(fd, buf, strlen(buf));
664 fprintf(stderr, "set %s failed: %s\n",
665 buf, strerror(errno));
670 rc = dbg_write_cmd(fd, argv[2], strlen(argv[2]));
672 fprintf(stderr, "start debug_daemon on %s failed: %s\n",
673 argv[2], strerror(errno));
679 if (strcasecmp(argv[1], "stop") == 0) {
680 rc = dbg_write_cmd(fd, "stop", 4);
682 fprintf(stderr, "stopping debug_daemon failed: %s\n",
691 fprintf(stderr, debug_daemon_usage, argv[0]);
694 dbg_close_ctlhandle(fd);
698 int jt_dbg_clear_debug_buf(int argc, char **argv)
701 struct libcfs_ioctl_data data;
704 fprintf(stderr, "usage: %s\n", argv[0]);
708 memset(&data, 0, sizeof(data));
709 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
710 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
714 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_CLEAR_DEBUG, buf);
716 fprintf(stderr, "IOC_LIBCFS_CLEAR_DEBUG failed: %s\n",
723 int jt_dbg_mark_debug_buf(int argc, char **argv)
725 static char scratch[MAX_MARK_SIZE] = "";
726 struct libcfs_ioctl_data data;
730 memset(&data, 0, sizeof(data));
733 int count, max_size = sizeof(scratch) - 1;
735 strncpy(scratch, argv[1], max_size);
736 max_size -= strlen(argv[1]);
737 for (count = 2; (count < argc) && (max_size > 1); count++) {
738 strncat(scratch, " ", max_size);
740 strncat(scratch, argv[count], max_size);
741 max_size -= strlen(argv[count]);
743 scratch[sizeof(scratch) - 1] = '\0';
746 time_t now = time(NULL);
750 data.ioc_inllen1 = strlen(text) + 1;
751 data.ioc_inlbuf1 = text;
753 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
754 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
758 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_MARK_DEBUG, buf);
760 fprintf(stderr, "IOC_LIBCFS_MARK_DEBUG failed: %s\n",
767 static struct mod_paths {
770 { "libcfs", "libcfs/libcfs" },
771 { "lnet", "lnet/lnet" },
772 { "ko2iblnd", "lnet/klnds/o2iblnd" },
773 { "kgnilnd", "lnet/klnds/gnilnd"},
774 { "ksocklnd", "lnet/klnds/socklnd" },
775 { "obdclass", "lustre/obdclass" },
776 { "llog_test", "lustre/obdclass" },
777 { "ptlrpc_gss", "lustre/ptlrpc/gss" },
778 { "ptlrpc", "lustre/ptlrpc" },
779 { "gks", "lustre/sec/gks" },
780 { "gkc", "lustre/sec/gks" },
781 { "ost", "lustre/ost" },
782 { "osc", "lustre/osc" },
783 { "mds", "lustre/mds" },
784 { "mdc", "lustre/mdc" },
785 { "lustre", "lustre/llite" },
786 { "llite_lloop", "lustre/llite" },
787 { "ldiskfs", "ldiskfs" },
788 { "obdecho", "lustre/obdecho" },
789 { "ldlm", "lustre/ldlm" },
790 { "obdfilter", "lustre/obdfilter" },
791 { "lov", "lustre/lov" },
792 { "lmv", "lustre/lmv" },
793 { "lquota", "lustre/quota" },
794 { "mgs", "lustre/mgs" },
795 { "mgc", "lustre/mgc" },
796 { "mdt", "lustre/mdt" },
797 { "mdd", "lustre/mdd" },
798 { "osd", "lustre/osd" },
799 { "cmm", "lustre/cmm" },
800 {"fid", "lustre/fid"},
801 {"fld", "lustre/fld"},
802 {"lod", "lustre/lod"},
803 {"osp", "lustre/osp"},
804 { "lfsck", "lustre/lfsck" },
808 int jt_dbg_modules(int argc, char **argv)
810 struct mod_paths *mp;
812 const char *proc = "/proc/modules";
815 unsigned long modaddr;
821 printf("%s [path] [kernel]\n", argv[0]);
825 file = fopen(proc, "r");
827 printf("failed open %s: %s\n", proc, strerror(errno));
831 while (fgets(buf, sizeof(buf), file) != NULL) {
832 if (sscanf(buf, "%s %*s %*s %*s %*s %lx",
833 modname, &modaddr) == 2) {
834 for (mp = mod_paths; mp->name != NULL; mp++) {
835 if (!strcmp(mp->name, modname))
839 printf("add-symbol-file %s%s%s/%s.o 0x%0lx\n",
840 path, path[0] ? "/" : "",
841 mp->path, mp->name, modaddr);
850 int jt_dbg_panic(int argc, char **argv)
853 struct libcfs_ioctl_data data;
856 fprintf(stderr, "usage: %s\n", argv[0]);
860 memset(&data, 0, sizeof(data));
861 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
862 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
866 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_PANIC, buf);
868 fprintf(stderr, "IOC_LIBCFS_PANIC failed: %s\n",