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, 2015, 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
53 #include <sys/ioctl.h>
54 #include <sys/types.h>
59 #include <linux/types.h>
61 #include <libcfs/util/ioctl.h>
62 #include <libcfs/user-time.h>
63 #include <libcfs/libcfs_debug.h>
64 #include <lnet/lnetctl.h>
66 static char rawbuf[8192];
67 static char *buf = rawbuf;
68 static int max = 8192;
69 /*static int g_pfd = -1;*/
70 static int subsystem_mask = ~0;
71 static int debug_mask = ~0;
73 #define MAX_MARK_SIZE 256
75 static const char *libcfs_debug_subsystems[] = LIBCFS_DEBUG_SUBSYS_NAMES;
76 static const char *libcfs_debug_masks[] = LIBCFS_DEBUG_MASKS_NAMES;
78 #define DAEMON_CTL_NAME "/proc/sys/lnet/daemon_file"
79 #define SUBSYS_DEBUG_CTL_NAME "/proc/sys/lnet/subsystem_debug"
80 #define DEBUG_CTL_NAME "/proc/sys/lnet/debug"
81 #define DUMP_KERNEL_CTL_NAME "/proc/sys/lnet/dump_kernel"
84 dbg_open_ctlhandle(const char *str)
87 fd = open(str, O_WRONLY);
89 fprintf(stderr, "open %s failed: %s\n", str,
97 dbg_close_ctlhandle(int fd)
103 dbg_write_cmd(int fd, char *str, int len)
105 int rc = write(fd, str, len);
107 return (rc == len ? 0 : 1);
111 static int do_debug_mask(char *name, int enable)
116 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++) {
117 if (strcasecmp(name, libcfs_debug_subsystems[i]) == 0 ||
118 strcasecmp(name, "all_subs") == 0) {
119 printf("%s output from subsystem \"%s\"\n",
120 enable ? "Enabling" : "Disabling",
121 libcfs_debug_subsystems[i]);
123 subsystem_mask |= (1 << i);
125 subsystem_mask &= ~(1 << i);
129 for (i = 0; libcfs_debug_masks[i] != NULL; i++) {
130 if (strcasecmp(name, libcfs_debug_masks[i]) == 0 ||
131 strcasecmp(name, "all_types") == 0) {
132 printf("%s output of type \"%s\"\n",
133 enable ? "Enabling" : "Disabling",
134 libcfs_debug_masks[i]);
136 debug_mask |= (1 << i);
138 debug_mask &= ~(1 << i);
146 int dbg_initialize(int argc, char **argv)
151 int jt_dbg_filter(int argc, char **argv)
156 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
161 for (i = 1; i < argc; i++)
162 if (!do_debug_mask(argv[i], 0))
163 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
168 int jt_dbg_show(int argc, char **argv)
173 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
178 for (i = 1; i < argc; i++)
179 if (!do_debug_mask(argv[i], 1))
180 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
186 static int applymask(char* procpath, int value)
190 int len = snprintf(buf, 64, "%d", value);
192 int fd = dbg_open_ctlhandle(procpath);
194 fprintf(stderr, "Unable to open %s: %s\n",
195 procpath, strerror(errno));
198 rc = dbg_write_cmd(fd, buf, len+1);
200 fprintf(stderr, "Write to %s failed: %s\n",
201 procpath, strerror(errno));
204 dbg_close_ctlhandle(fd);
209 static void applymask_all(unsigned int subs_mask, unsigned int debug_mask)
211 applymask(SUBSYS_DEBUG_CTL_NAME, subs_mask);
212 applymask(DEBUG_CTL_NAME, debug_mask);
213 printf("Applied subsystem_debug=%d, debug=%d to /proc/sys/lnet\n",
214 subs_mask, debug_mask);
217 int jt_dbg_list(int argc, char **argv)
222 fprintf(stderr, "usage: %s <subs || types>\n", argv[0]);
226 if (strcasecmp(argv[1], "subs") == 0) {
227 printf("Subsystems: all_subs");
228 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++)
229 if (libcfs_debug_subsystems[i][0])
230 printf(", %s", libcfs_debug_subsystems[i]);
232 } else if (strcasecmp(argv[1], "types") == 0) {
233 printf("Types: all_types");
234 for (i = 0; libcfs_debug_masks[i] != NULL; i++)
235 printf(", %s", libcfs_debug_masks[i]);
237 } else if (strcasecmp(argv[1], "applymasks") == 0) {
238 applymask_all(subsystem_mask, debug_mask);
243 /* all strings nul-terminated; only the struct and hdr need to be freed */
245 struct ptldebug_header *hdr;
251 static int cmp_rec(const void *p1, const void *p2)
253 struct dbg_line *d1 = *(struct dbg_line **)p1;
254 struct dbg_line *d2 = *(struct dbg_line **)p2;
256 if (d1->hdr->ph_sec < d2->hdr->ph_sec)
258 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
259 d1->hdr->ph_usec < d2->hdr->ph_usec)
261 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
262 d1->hdr->ph_usec == d2->hdr->ph_usec)
267 static void print_rec(struct dbg_line ***linevp, int used, int fdout)
269 struct dbg_line **linev = *linevp;
272 qsort(linev, used, sizeof(struct dbg_line *), cmp_rec);
273 for (i = 0; i < used; i++) {
274 struct dbg_line *line = linev[i];
275 struct ptldebug_header *hdr = line->hdr;
279 ssize_t bytes_written;
281 bytes = snprintf(out, sizeof(out),
282 "%08x:%08x:%u.%u%s:%u.%06llu:%u:%u:%u:"
284 hdr->ph_subsys, hdr->ph_mask,
285 hdr->ph_cpu_id, hdr->ph_type,
286 hdr->ph_flags & PH_FLAG_FIRST_RECORD ? "F" : "",
287 hdr->ph_sec, (unsigned long long)hdr->ph_usec,
288 hdr->ph_stack, hdr->ph_pid, hdr->ph_extern_pid,
289 line->file, hdr->ph_line_num, line->fn,
292 bytes_written = write(fdout, buf, bytes);
293 if (bytes_written <= 0)
295 bytes -= bytes_written;
296 buf += bytes_written;
305 static int add_rec(struct dbg_line *line, struct dbg_line ***linevp, int *lenp,
308 struct dbg_line **linev = *linevp;
311 int nlen = *lenp + 4096;
312 int nsize = nlen * sizeof(struct dbg_line *);
314 linev = realloc(*linevp, nsize);
326 static void dump_hdr(unsigned long long offset, struct ptldebug_header *hdr)
328 fprintf(stderr, "badly-formed record at offset = %llu\n", offset);
329 fprintf(stderr, " len = %u\n", hdr->ph_len);
330 fprintf(stderr, " flags = %x\n", hdr->ph_flags);
331 fprintf(stderr, " subsystem = %x\n", hdr->ph_subsys);
332 fprintf(stderr, " mask = %x\n", hdr->ph_mask);
333 fprintf(stderr, " cpu_id = %u\n", hdr->ph_cpu_id);
334 fprintf(stderr, " type = %u\n", hdr->ph_type);
335 fprintf(stderr, " seconds = %u\n", hdr->ph_sec);
336 fprintf(stderr, " microseconds = %lu\n", (long)hdr->ph_usec);
337 fprintf(stderr, " stack = %u\n", hdr->ph_stack);
338 fprintf(stderr, " pid = %u\n", hdr->ph_pid);
339 fprintf(stderr, " host pid = %u\n", hdr->ph_extern_pid);
340 fprintf(stderr, " line number = %u\n", hdr->ph_line_num);
343 #define HDR_SIZE sizeof(*hdr)
345 static int parse_buffer(int fdin, int fdout)
347 struct dbg_line *line;
348 struct ptldebug_header *hdr;
351 unsigned long dropped = 0;
352 unsigned long kept = 0;
353 unsigned long bad = 0;
354 struct dbg_line **linev = NULL;
367 rc = read(fdin, ptr, count);
376 if (hdr->ph_len > 4094 || /* is this header bogus? */
377 hdr->ph_stack > 65536 ||
378 hdr->ph_sec < (1 << 30) ||
379 hdr->ph_usec > 1000000000 ||
380 hdr->ph_line_num > 65536) {
382 dump_hdr(lseek(fdin, 0, SEEK_CUR), hdr);
386 /* try to restart on next line */
387 while (count < HDR_SIZE && buf[count] != '\n')
389 if (buf[count] == '\n')
390 count++; /* move past '\n' */
391 if (HDR_SIZE - count > 0) {
392 int left = HDR_SIZE - count;
394 memmove(buf, buf + count, left);
403 if (hdr->ph_len == 0)
406 count = hdr->ph_len - HDR_SIZE;
408 rc = read(fdin, ptr, count);
419 if ((hdr->ph_subsys && !(subsystem_mask & hdr->ph_subsys)) ||
420 (hdr->ph_mask && !(debug_mask & hdr->ph_mask))) {
426 line = malloc(sizeof(*line));
429 fprintf(stderr, "error: line malloc(%u): "
430 "printing accumulated records\n",
431 (unsigned int)sizeof(*line));
432 print_rec(&linev, kept, fdout);
436 fprintf(stderr, "error: line malloc(%u): exiting\n",
437 (unsigned int)sizeof(*line));
441 line->hdr = malloc(hdr->ph_len + 1);
442 if (line->hdr == NULL) {
445 fprintf(stderr, "error: hdr malloc(%u): "
446 "printing accumulated records\n",
448 print_rec(&linev, kept, fdout);
452 fprintf(stderr, "error: hdr malloc(%u): exiting\n",
457 ptr = (void *)line->hdr;
458 memcpy(line->hdr, buf, hdr->ph_len);
459 ptr[hdr->ph_len] = '\0';
463 ptr += strlen(line->file) + 1;
465 ptr += strlen(line->fn) + 1;
469 if (add_rec(line, &linev, &linev_len, kept) < 0) {
471 fprintf(stderr, "error: add_rec[%u] failed; "
472 "print accumulated records\n",
474 print_rec(&linev, kept, fdout);
478 fprintf(stderr, "error: add_rec[0] failed; exiting\n");
486 print_rec(&linev, kept, fdout);
488 printf("Debug log: %lu lines, %lu kept, %lu dropped, %lu bad.\n",
489 dropped + kept + bad, kept, dropped, bad);
494 int jt_dbg_debug_kernel(int argc, char **argv)
497 char filename[PATH_MAX];
505 fprintf(stderr, "usage: %s [file] [raw]\n", argv[0]);
511 } else if (argc > 1 && (argv[1][0] == '0' || argv[1][0] == '1')) {
516 /* If we are dumping raw (which means no conversion step to ASCII)
517 * then dump directly to any supplied filename, otherwise this is
518 * just a temp file and we dump to the real file at convert time. */
519 if (argc > 1 && raw) {
520 if (strlen(argv[1]) >= sizeof(filename)) {
521 fprintf(stderr, "File name too long: %s\n", argv[1]);
524 strncpy(filename, argv[1], sizeof(filename));
526 if (snprintf(filename, sizeof(filename), "%s"CFS_TIME_T".%u",
527 LIBCFS_DEBUG_FILE_PATH_DEFAULT, time(NULL),
529 >= sizeof(filename)) {
530 fprintf(stderr, "File name too long\n");
535 if (stat(filename, &st) == 0 && S_ISREG(st.st_mode))
538 fdin = dbg_open_ctlhandle(DUMP_KERNEL_CTL_NAME);
540 fprintf(stderr, "open(dump_kernel) failed: %s\n",
545 rc = dbg_write_cmd(fdin, filename, strlen(filename));
547 dbg_close_ctlhandle(fdin);
549 fprintf(stderr, "write(%s) failed: %s\n", filename,
550 strerror(save_errno));
557 fdin = open(filename, O_RDONLY);
559 if (errno == ENOENT) /* no dump file created */
561 fprintf(stderr, "fopen(%s) failed: %s\n", filename,
566 fdout = open(argv[1], O_WRONLY | O_CREAT | O_TRUNC,
569 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
575 fdout = fileno(stdout);
578 rc = parse_buffer(fdin, fdout);
583 fprintf(stderr, "parse_buffer failed; leaving tmp file %s "
584 "behind.\n", filename);
586 rc = unlink(filename);
588 fprintf(stderr, "dumped successfully, but couldn't "
589 "unlink tmp file %s: %s\n", filename,
596 int jt_dbg_debug_file(int argc, char **argv)
602 if (argc > 3 || argc < 2) {
603 fprintf(stderr, "usage: %s <input> [output]\n", argv[0]);
607 fdin = open(argv[1], O_RDONLY | O_LARGEFILE);
609 fprintf(stderr, "open(%s) failed: %s\n", argv[1],
614 fdout = open(argv[2],
615 O_CREAT | O_TRUNC | O_WRONLY | O_LARGEFILE,
618 fprintf(stderr, "open(%s) failed: %s\n", argv[2],
624 fdout = fileno(stdout);
627 rc = parse_buffer(fdin, fdout);
630 if (fdout != fileno(stdout))
636 const char debug_daemon_usage[] = "usage: %s {start file [MB]|stop}\n";
638 int jt_dbg_debug_daemon(int argc, char **argv)
644 fprintf(stderr, debug_daemon_usage, argv[0]);
648 fd = dbg_open_ctlhandle(DAEMON_CTL_NAME);
653 if (strcasecmp(argv[1], "start") == 0) {
654 if (argc < 3 || argc > 4 ||
655 (argc == 4 && strlen(argv[3]) > 5)) {
656 fprintf(stderr, debug_daemon_usage, argv[0]);
661 const long min_size = 10;
662 const long max_size = 20480;
666 size = strtoul(argv[3], &end, 0);
667 if (size < min_size ||
670 fprintf(stderr, "size %s invalid, must be in "
671 "the range %ld-%ld MB\n", argv[3],
675 snprintf(buf, sizeof(buf), "size=%ld", size);
676 rc = dbg_write_cmd(fd, buf, strlen(buf));
679 fprintf(stderr, "set %s failed: %s\n",
680 buf, strerror(errno));
685 rc = dbg_write_cmd(fd, argv[2], strlen(argv[2]));
687 fprintf(stderr, "start debug_daemon on %s failed: %s\n",
688 argv[2], strerror(errno));
694 if (strcasecmp(argv[1], "stop") == 0) {
695 rc = dbg_write_cmd(fd, "stop", 4);
697 fprintf(stderr, "stopping debug_daemon failed: %s\n",
706 fprintf(stderr, debug_daemon_usage, argv[0]);
709 dbg_close_ctlhandle(fd);
713 int jt_dbg_clear_debug_buf(int argc, char **argv)
716 struct libcfs_ioctl_data data;
719 fprintf(stderr, "usage: %s\n", argv[0]);
723 memset(&data, 0, sizeof(data));
724 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
725 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
729 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_CLEAR_DEBUG, buf);
731 fprintf(stderr, "IOC_LIBCFS_CLEAR_DEBUG failed: %s\n",
738 int jt_dbg_mark_debug_buf(int argc, char **argv)
740 static char scratch[MAX_MARK_SIZE] = "";
741 struct libcfs_ioctl_data data;
745 memset(&data, 0, sizeof(data));
748 int count, max_size = sizeof(scratch) - 1;
750 strncpy(scratch, argv[1], max_size);
751 max_size -= strlen(argv[1]);
752 for (count = 2; (count < argc) && (max_size > 1); count++) {
753 strncat(scratch, " ", max_size);
755 strncat(scratch, argv[count], max_size);
756 max_size -= strlen(argv[count]);
758 scratch[sizeof(scratch) - 1] = '\0';
761 time_t now = time(NULL);
765 data.ioc_inllen1 = strlen(text) + 1;
766 data.ioc_inlbuf1 = text;
768 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
769 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
773 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_MARK_DEBUG, buf);
775 fprintf(stderr, "IOC_LIBCFS_MARK_DEBUG failed: %s\n",
782 static struct mod_paths {
785 { "libcfs", "libcfs/libcfs" },
786 { "lnet", "lnet/lnet" },
787 { "ko2iblnd", "lnet/klnds/o2iblnd" },
788 { "kgnilnd", "lnet/klnds/gnilnd"},
789 { "ksocklnd", "lnet/klnds/socklnd" },
790 { "obdclass", "lustre/obdclass" },
791 { "llog_test", "lustre/obdclass" },
792 { "ptlrpc_gss", "lustre/ptlrpc/gss" },
793 { "ptlrpc", "lustre/ptlrpc" },
794 { "gks", "lustre/sec/gks" },
795 { "gkc", "lustre/sec/gks" },
796 { "ost", "lustre/ost" },
797 { "osc", "lustre/osc" },
798 { "mds", "lustre/mds" },
799 { "mdc", "lustre/mdc" },
800 { "lustre", "lustre/llite" },
801 { "llite_lloop", "lustre/llite" },
802 { "ldiskfs", "ldiskfs" },
803 { "obdecho", "lustre/obdecho" },
804 { "ldlm", "lustre/ldlm" },
805 { "obdfilter", "lustre/obdfilter" },
806 { "lov", "lustre/lov" },
807 { "lmv", "lustre/lmv" },
808 { "lquota", "lustre/quota" },
809 { "mgs", "lustre/mgs" },
810 { "mgc", "lustre/mgc" },
811 { "mdt", "lustre/mdt" },
812 { "mdd", "lustre/mdd" },
813 { "osd", "lustre/osd" },
814 { "cmm", "lustre/cmm" },
815 {"fid", "lustre/fid"},
816 {"fld", "lustre/fld"},
817 {"lod", "lustre/lod"},
818 {"osp", "lustre/osp"},
819 { "lfsck", "lustre/lfsck" },
823 int jt_dbg_modules(int argc, char **argv)
825 struct mod_paths *mp;
827 const char *proc = "/proc/modules";
830 unsigned long modaddr;
836 printf("%s [path] [kernel]\n", argv[0]);
840 file = fopen(proc, "r");
842 printf("failed open %s: %s\n", proc, strerror(errno));
846 while (fgets(buf, sizeof(buf), file) != NULL) {
847 if (sscanf(buf, "%s %*s %*s %*s %*s %lx",
848 modname, &modaddr) == 2) {
849 for (mp = mod_paths; mp->name != NULL; mp++) {
850 if (!strcmp(mp->name, modname))
854 printf("add-symbol-file %s%s%s/%s.o 0x%0lx\n",
855 path, path[0] ? "/" : "",
856 mp->path, mp->name, modaddr);
865 int jt_dbg_panic(int argc, char **argv)
868 struct libcfs_ioctl_data data;
871 fprintf(stderr, "usage: %s\n", argv[0]);
875 memset(&data, 0, sizeof(data));
876 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
877 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
881 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_PANIC, buf);
883 fprintf(stderr, "IOC_LIBCFS_PANIC failed: %s\n",