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
46 #include <libcfs/libcfs.h>
47 #include <libcfs/util/ioctl.h>
48 #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;
62 #define DAEMON_CTL_NAME "/proc/sys/lnet/daemon_file"
63 #define SUBSYS_DEBUG_CTL_NAME "/proc/sys/lnet/subsystem_debug"
64 #define DEBUG_CTL_NAME "/proc/sys/lnet/debug"
65 #define DUMP_KERNEL_CTL_NAME "/proc/sys/lnet/dump_kernel"
68 dbg_open_ctlhandle(const char *str)
71 fd = open(str, O_WRONLY);
73 fprintf(stderr, "open %s failed: %s\n", str,
81 dbg_close_ctlhandle(int fd)
87 dbg_write_cmd(int fd, char *str, int len)
89 int rc = write(fd, str, len);
91 return (rc == len ? 0 : 1);
95 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 applymask(SUBSYS_DEBUG_CTL_NAME, subs_mask);
196 applymask(DEBUG_CTL_NAME, debug_mask);
197 printf("Applied subsystem_debug=%d, debug=%d to /proc/sys/lnet\n",
198 subs_mask, debug_mask);
201 int jt_dbg_list(int argc, char **argv)
206 fprintf(stderr, "usage: %s <subs || types>\n", argv[0]);
210 if (strcasecmp(argv[1], "subs") == 0) {
211 printf("Subsystems: all_subs");
212 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++)
213 if (libcfs_debug_subsystems[i][0])
214 printf(", %s", libcfs_debug_subsystems[i]);
216 } else if (strcasecmp(argv[1], "types") == 0) {
217 printf("Types: all_types");
218 for (i = 0; libcfs_debug_masks[i] != NULL; i++)
219 printf(", %s", libcfs_debug_masks[i]);
221 } else if (strcasecmp(argv[1], "applymasks") == 0) {
222 applymask_all(subsystem_mask, debug_mask);
227 /* all strings nul-terminated; only the struct and hdr need to be freed */
229 struct ptldebug_header *hdr;
235 static int cmp_rec(const void *p1, const void *p2)
237 struct dbg_line *d1 = *(struct dbg_line **)p1;
238 struct dbg_line *d2 = *(struct dbg_line **)p2;
240 if (d1->hdr->ph_sec < d2->hdr->ph_sec)
242 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
243 d1->hdr->ph_usec < d2->hdr->ph_usec)
245 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
246 d1->hdr->ph_usec == d2->hdr->ph_usec)
251 static void print_rec(struct dbg_line ***linevp, int used, int fdout)
253 struct dbg_line **linev = *linevp;
256 qsort(linev, used, sizeof(struct dbg_line *), cmp_rec);
257 for (i = 0; i < used; i++) {
258 struct dbg_line *line = linev[i];
259 struct ptldebug_header *hdr = line->hdr;
263 ssize_t bytes_written;
265 bytes = snprintf(out, sizeof(out),
266 "%08x:%08x:%u.%u%s:%u.%06llu:%u:%u:%u:"
268 hdr->ph_subsys, hdr->ph_mask,
269 hdr->ph_cpu_id, hdr->ph_type,
270 hdr->ph_flags & PH_FLAG_FIRST_RECORD ? "F" : "",
271 hdr->ph_sec, (unsigned long long)hdr->ph_usec,
272 hdr->ph_stack, hdr->ph_pid, hdr->ph_extern_pid,
273 line->file, hdr->ph_line_num, line->fn,
276 bytes_written = write(fdout, buf, bytes);
277 if (bytes_written <= 0)
279 bytes -= bytes_written;
280 buf += bytes_written;
289 static int add_rec(struct dbg_line *line, struct dbg_line ***linevp, int *lenp,
292 struct dbg_line **linev = *linevp;
295 int nlen = *lenp + 4096;
296 int nsize = nlen * sizeof(struct dbg_line *);
298 linev = realloc(*linevp, nsize);
310 static void dump_hdr(unsigned long long offset, struct ptldebug_header *hdr)
312 fprintf(stderr, "badly-formed record at offset = %llu\n", offset);
313 fprintf(stderr, " len = %u\n", hdr->ph_len);
314 fprintf(stderr, " flags = %x\n", hdr->ph_flags);
315 fprintf(stderr, " subsystem = %x\n", hdr->ph_subsys);
316 fprintf(stderr, " mask = %x\n", hdr->ph_mask);
317 fprintf(stderr, " cpu_id = %u\n", hdr->ph_cpu_id);
318 fprintf(stderr, " type = %u\n", hdr->ph_type);
319 fprintf(stderr, " seconds = %u\n", hdr->ph_sec);
320 fprintf(stderr, " microseconds = %lu\n", (long)hdr->ph_usec);
321 fprintf(stderr, " stack = %u\n", hdr->ph_stack);
322 fprintf(stderr, " pid = %u\n", hdr->ph_pid);
323 fprintf(stderr, " host pid = %u\n", hdr->ph_extern_pid);
324 fprintf(stderr, " line number = %u\n", hdr->ph_line_num);
327 #define HDR_SIZE sizeof(*hdr)
329 static int parse_buffer(int fdin, int fdout)
331 struct dbg_line *line;
332 struct ptldebug_header *hdr;
335 unsigned long dropped = 0;
336 unsigned long kept = 0;
337 unsigned long bad = 0;
338 struct dbg_line **linev = NULL;
351 rc = read(fdin, ptr, count);
360 if (hdr->ph_len > 4094 || /* is this header bogus? */
361 hdr->ph_stack > 65536 ||
362 hdr->ph_sec < (1 << 30) ||
363 hdr->ph_usec > 1000000000 ||
364 hdr->ph_line_num > 65536) {
366 dump_hdr(lseek(fdin, 0, SEEK_CUR), hdr);
370 /* try to restart on next line */
371 while (count < HDR_SIZE && buf[count] != '\n')
373 if (buf[count] == '\n')
374 count++; /* move past '\n' */
375 if (HDR_SIZE - count > 0) {
376 int left = HDR_SIZE - count;
378 memmove(buf, buf + count, left);
387 if (hdr->ph_len == 0)
390 count = hdr->ph_len - HDR_SIZE;
392 rc = read(fdin, ptr, count);
403 if ((hdr->ph_subsys && !(subsystem_mask & hdr->ph_subsys)) ||
404 (hdr->ph_mask && !(debug_mask & hdr->ph_mask))) {
410 line = malloc(sizeof(*line));
413 fprintf(stderr, "error: line malloc(%u): "
414 "printing accumulated records\n",
415 (unsigned int)sizeof(*line));
416 print_rec(&linev, kept, fdout);
420 fprintf(stderr, "error: line malloc(%u): exiting\n",
421 (unsigned int)sizeof(*line));
425 line->hdr = malloc(hdr->ph_len + 1);
426 if (line->hdr == NULL) {
429 fprintf(stderr, "error: hdr malloc(%u): "
430 "printing accumulated records\n",
432 print_rec(&linev, kept, fdout);
436 fprintf(stderr, "error: hdr malloc(%u): exiting\n",
441 ptr = (void *)line->hdr;
442 memcpy(line->hdr, buf, hdr->ph_len);
443 ptr[hdr->ph_len] = '\0';
447 ptr += strlen(line->file) + 1;
449 ptr += strlen(line->fn) + 1;
453 if (add_rec(line, &linev, &linev_len, kept) < 0) {
455 fprintf(stderr, "error: add_rec[%u] failed; "
456 "print accumulated records\n",
458 print_rec(&linev, kept, fdout);
462 fprintf(stderr, "error: add_rec[0] failed; exiting\n");
470 print_rec(&linev, kept, fdout);
472 printf("Debug log: %lu lines, %lu kept, %lu dropped, %lu bad.\n",
473 dropped + kept + bad, kept, dropped, bad);
478 int jt_dbg_debug_kernel(int argc, char **argv)
481 char filename[PATH_MAX];
489 fprintf(stderr, "usage: %s [file] [raw]\n", argv[0]);
495 } else if (argc > 1 && (argv[1][0] == '0' || argv[1][0] == '1')) {
500 /* If we are dumping raw (which means no conversion step to ASCII)
501 * then dump directly to any supplied filename, otherwise this is
502 * just a temp file and we dump to the real file at convert time. */
503 if (argc > 1 && raw) {
504 if (strlen(argv[1]) >= sizeof(filename)) {
505 fprintf(stderr, "File name too long: %s\n", argv[1]);
508 strncpy(filename, argv[1], sizeof(filename));
510 if (snprintf(filename, sizeof(filename), "%s"CFS_TIME_T".%u",
511 LIBCFS_DEBUG_FILE_PATH_DEFAULT, time(NULL),
513 >= sizeof(filename)) {
514 fprintf(stderr, "File name too long\n");
519 if (stat(filename, &st) == 0 && S_ISREG(st.st_mode))
522 fdin = dbg_open_ctlhandle(DUMP_KERNEL_CTL_NAME);
524 fprintf(stderr, "open(dump_kernel) failed: %s\n",
529 rc = dbg_write_cmd(fdin, filename, strlen(filename));
531 dbg_close_ctlhandle(fdin);
533 fprintf(stderr, "write(%s) failed: %s\n", filename,
534 strerror(save_errno));
541 fdin = open(filename, O_RDONLY);
543 if (errno == ENOENT) /* no dump file created */
545 fprintf(stderr, "fopen(%s) failed: %s\n", filename,
550 fdout = open(argv[1], O_WRONLY | O_CREAT | O_TRUNC,
553 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
559 fdout = fileno(stdout);
562 rc = parse_buffer(fdin, fdout);
567 fprintf(stderr, "parse_buffer failed; leaving tmp file %s "
568 "behind.\n", filename);
570 rc = unlink(filename);
572 fprintf(stderr, "dumped successfully, but couldn't "
573 "unlink tmp file %s: %s\n", filename,
580 int jt_dbg_debug_file(int argc, char **argv)
586 if (argc > 3 || argc < 2) {
587 fprintf(stderr, "usage: %s <input> [output]\n", argv[0]);
591 fdin = open(argv[1], O_RDONLY | O_LARGEFILE);
593 fprintf(stderr, "open(%s) failed: %s\n", argv[1],
598 fdout = open(argv[2],
599 O_CREAT | O_TRUNC | O_WRONLY | O_LARGEFILE,
602 fprintf(stderr, "open(%s) failed: %s\n", argv[2],
608 fdout = fileno(stdout);
611 rc = parse_buffer(fdin, fdout);
614 if (fdout != fileno(stdout))
620 const char debug_daemon_usage[] = "usage: %s {start file [MB]|stop}\n";
622 int jt_dbg_debug_daemon(int argc, char **argv)
628 fprintf(stderr, debug_daemon_usage, argv[0]);
632 fd = dbg_open_ctlhandle(DAEMON_CTL_NAME);
637 if (strcasecmp(argv[1], "start") == 0) {
638 if (argc < 3 || argc > 4 ||
639 (argc == 4 && strlen(argv[3]) > 5)) {
640 fprintf(stderr, debug_daemon_usage, argv[0]);
645 const long min_size = 10;
646 const long max_size = 20480;
650 size = strtoul(argv[3], &end, 0);
651 if (size < min_size ||
654 fprintf(stderr, "size %s invalid, must be in "
655 "the range %ld-%ld MB\n", argv[3],
659 snprintf(buf, sizeof(buf), "size=%ld", size);
660 rc = dbg_write_cmd(fd, buf, strlen(buf));
663 fprintf(stderr, "set %s failed: %s\n",
664 buf, strerror(errno));
669 rc = dbg_write_cmd(fd, argv[2], strlen(argv[2]));
671 fprintf(stderr, "start debug_daemon on %s failed: %s\n",
672 argv[2], strerror(errno));
678 if (strcasecmp(argv[1], "stop") == 0) {
679 rc = dbg_write_cmd(fd, "stop", 4);
681 fprintf(stderr, "stopping debug_daemon failed: %s\n",
690 fprintf(stderr, debug_daemon_usage, argv[0]);
693 dbg_close_ctlhandle(fd);
697 int jt_dbg_clear_debug_buf(int argc, char **argv)
700 struct libcfs_ioctl_data data;
703 fprintf(stderr, "usage: %s\n", argv[0]);
707 memset(&data, 0, sizeof(data));
708 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
709 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
713 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_CLEAR_DEBUG, buf);
715 fprintf(stderr, "IOC_LIBCFS_CLEAR_DEBUG failed: %s\n",
722 int jt_dbg_mark_debug_buf(int argc, char **argv)
724 static char scratch[MAX_MARK_SIZE] = "";
725 struct libcfs_ioctl_data data;
729 memset(&data, 0, sizeof(data));
732 int count, max_size = sizeof(scratch) - 1;
734 strncpy(scratch, argv[1], max_size);
735 max_size -= strlen(argv[1]);
736 for (count = 2; (count < argc) && (max_size > 1); count++) {
737 strncat(scratch, " ", max_size);
739 strncat(scratch, argv[count], max_size);
740 max_size -= strlen(argv[count]);
742 scratch[sizeof(scratch) - 1] = '\0';
745 time_t now = time(NULL);
749 data.ioc_inllen1 = strlen(text) + 1;
750 data.ioc_inlbuf1 = text;
752 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
753 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
757 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_MARK_DEBUG, buf);
759 fprintf(stderr, "IOC_LIBCFS_MARK_DEBUG failed: %s\n",
766 static struct mod_paths {
769 { "libcfs", "libcfs/libcfs" },
770 { "lnet", "lnet/lnet" },
771 { "ko2iblnd", "lnet/klnds/o2iblnd" },
772 { "kgnilnd", "lnet/klnds/gnilnd"},
773 { "ksocklnd", "lnet/klnds/socklnd" },
774 { "obdclass", "lustre/obdclass" },
775 { "llog_test", "lustre/obdclass" },
776 { "ptlrpc_gss", "lustre/ptlrpc/gss" },
777 { "ptlrpc", "lustre/ptlrpc" },
778 { "gks", "lustre/sec/gks" },
779 { "gkc", "lustre/sec/gks" },
780 { "ost", "lustre/ost" },
781 { "osc", "lustre/osc" },
782 { "mds", "lustre/mds" },
783 { "mdc", "lustre/mdc" },
784 { "lustre", "lustre/llite" },
785 { "llite_lloop", "lustre/llite" },
786 { "ldiskfs", "ldiskfs" },
787 { "obdecho", "lustre/obdecho" },
788 { "ldlm", "lustre/ldlm" },
789 { "obdfilter", "lustre/obdfilter" },
790 { "lov", "lustre/lov" },
791 { "lmv", "lustre/lmv" },
792 { "lquota", "lustre/quota" },
793 { "mgs", "lustre/mgs" },
794 { "mgc", "lustre/mgc" },
795 { "mdt", "lustre/mdt" },
796 { "mdd", "lustre/mdd" },
797 { "osd", "lustre/osd" },
798 { "cmm", "lustre/cmm" },
799 {"fid", "lustre/fid"},
800 {"fld", "lustre/fld"},
801 {"lod", "lustre/lod"},
802 {"osp", "lustre/osp"},
803 { "lfsck", "lustre/lfsck" },
807 int jt_dbg_modules(int argc, char **argv)
809 struct mod_paths *mp;
811 const char *proc = "/proc/modules";
814 unsigned long modaddr;
820 printf("%s [path] [kernel]\n", argv[0]);
824 file = fopen(proc, "r");
826 printf("failed open %s: %s\n", proc, strerror(errno));
830 while (fgets(buf, sizeof(buf), file) != NULL) {
831 if (sscanf(buf, "%s %*s %*s %*s %*s %lx",
832 modname, &modaddr) == 2) {
833 for (mp = mod_paths; mp->name != NULL; mp++) {
834 if (!strcmp(mp->name, modname))
838 printf("add-symbol-file %s%s%s/%s.o 0x%0lx\n",
839 path, path[0] ? "/" : "",
840 mp->path, mp->name, modaddr);
849 int jt_dbg_panic(int argc, char **argv)
852 struct libcfs_ioctl_data data;
855 fprintf(stderr, "usage: %s\n", argv[0]);
859 memset(&data, 0, sizeof(data));
860 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
861 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
865 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_PANIC, buf);
867 fprintf(stderr, "IOC_LIBCFS_PANIC failed: %s\n",