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/libcfsutil.h>
47 #include <lnet/lnetctl.h>
49 static char rawbuf[8192];
50 static char *buf = rawbuf;
51 static int max = 8192;
52 /*static int g_pfd = -1;*/
53 static int subsystem_mask = ~0;
54 static int debug_mask = ~0;
56 #define MAX_MARK_SIZE 256
58 static const char *libcfs_debug_subsystems[] = LIBCFS_DEBUG_SUBSYS_NAMES;
59 static const char *libcfs_debug_masks[] = LIBCFS_DEBUG_MASKS_NAMES;
61 #define DAEMON_CTL_NAME "/proc/sys/lnet/daemon_file"
62 #define SUBSYS_DEBUG_CTL_NAME "/proc/sys/lnet/subsystem_debug"
63 #define DEBUG_CTL_NAME "/proc/sys/lnet/debug"
64 #define DUMP_KERNEL_CTL_NAME "/proc/sys/lnet/dump_kernel"
67 dbg_open_ctlhandle(const char *str)
70 fd = open(str, O_WRONLY);
72 fprintf(stderr, "open %s failed: %s\n", str,
80 dbg_close_ctlhandle(int fd)
86 dbg_write_cmd(int fd, char *str, int len)
88 int rc = write(fd, str, len);
90 return (rc == len ? 0 : 1);
94 static int do_debug_mask(char *name, int enable)
99 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++) {
100 if (strcasecmp(name, libcfs_debug_subsystems[i]) == 0 ||
101 strcasecmp(name, "all_subs") == 0) {
102 printf("%s output from subsystem \"%s\"\n",
103 enable ? "Enabling" : "Disabling",
104 libcfs_debug_subsystems[i]);
106 subsystem_mask |= (1 << i);
108 subsystem_mask &= ~(1 << i);
112 for (i = 0; libcfs_debug_masks[i] != NULL; i++) {
113 if (strcasecmp(name, libcfs_debug_masks[i]) == 0 ||
114 strcasecmp(name, "all_types") == 0) {
115 printf("%s output of type \"%s\"\n",
116 enable ? "Enabling" : "Disabling",
117 libcfs_debug_masks[i]);
119 debug_mask |= (1 << i);
121 debug_mask &= ~(1 << i);
129 int dbg_initialize(int argc, char **argv)
134 int jt_dbg_filter(int argc, char **argv)
139 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
144 for (i = 1; i < argc; i++)
145 if (!do_debug_mask(argv[i], 0))
146 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
151 int jt_dbg_show(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], 1))
163 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
169 static int applymask(char* procpath, int value)
173 int len = snprintf(buf, 64, "%d", value);
175 int fd = dbg_open_ctlhandle(procpath);
177 fprintf(stderr, "Unable to open %s: %s\n",
178 procpath, strerror(errno));
181 rc = dbg_write_cmd(fd, buf, len+1);
183 fprintf(stderr, "Write to %s failed: %s\n",
184 procpath, strerror(errno));
187 dbg_close_ctlhandle(fd);
192 static void applymask_all(unsigned int subs_mask, unsigned int debug_mask)
194 if (!dump_filename) {
195 applymask(SUBSYS_DEBUG_CTL_NAME, subs_mask);
196 applymask(DEBUG_CTL_NAME, debug_mask);
198 struct libcfs_debug_ioctl_data data;
200 data.hdr.ioc_len = sizeof(data);
201 data.hdr.ioc_version = 0;
202 data.subs = subs_mask;
203 data.debug = debug_mask;
205 dump(OBD_DEV_ID, LIBCFS_IOC_DEBUG_MASK, &data);
207 printf("Applied subsystem_debug=%d, debug=%d to /proc/sys/lnet\n",
208 subs_mask, debug_mask);
211 int jt_dbg_list(int argc, char **argv)
216 fprintf(stderr, "usage: %s <subs || types>\n", argv[0]);
220 if (strcasecmp(argv[1], "subs") == 0) {
221 printf("Subsystems: all_subs");
222 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++)
223 if (libcfs_debug_subsystems[i][0])
224 printf(", %s", libcfs_debug_subsystems[i]);
226 } else if (strcasecmp(argv[1], "types") == 0) {
227 printf("Types: all_types");
228 for (i = 0; libcfs_debug_masks[i] != NULL; i++)
229 printf(", %s", libcfs_debug_masks[i]);
231 } else if (strcasecmp(argv[1], "applymasks") == 0) {
232 applymask_all(subsystem_mask, debug_mask);
237 /* all strings nul-terminated; only the struct and hdr need to be freed */
239 struct ptldebug_header *hdr;
245 static int cmp_rec(const void *p1, const void *p2)
247 struct dbg_line *d1 = *(struct dbg_line **)p1;
248 struct dbg_line *d2 = *(struct dbg_line **)p2;
250 if (d1->hdr->ph_sec < d2->hdr->ph_sec)
252 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
253 d1->hdr->ph_usec < d2->hdr->ph_usec)
255 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
256 d1->hdr->ph_usec == d2->hdr->ph_usec)
261 static void print_rec(struct dbg_line ***linevp, int used, int fdout)
263 struct dbg_line **linev = *linevp;
266 qsort(linev, used, sizeof(struct dbg_line *), cmp_rec);
267 for (i = 0; i < used; i++) {
268 struct dbg_line *line = linev[i];
269 struct ptldebug_header *hdr = line->hdr;
273 ssize_t bytes_written;
275 bytes = snprintf(out, sizeof(out),
276 "%08x:%08x:%u.%u%s:%u.%06llu:%u:%u:%u:"
278 hdr->ph_subsys, hdr->ph_mask,
279 hdr->ph_cpu_id, hdr->ph_type,
280 hdr->ph_flags & PH_FLAG_FIRST_RECORD ? "F" : "",
281 hdr->ph_sec, (unsigned long long)hdr->ph_usec,
282 hdr->ph_stack, hdr->ph_pid, hdr->ph_extern_pid,
283 line->file, hdr->ph_line_num, line->fn,
286 bytes_written = write(fdout, buf, bytes);
287 if (bytes_written <= 0)
289 bytes -= bytes_written;
290 buf += bytes_written;
299 static int add_rec(struct dbg_line *line, struct dbg_line ***linevp, int *lenp,
302 struct dbg_line **linev = *linevp;
305 int nlen = *lenp + 4096;
306 int nsize = nlen * sizeof(struct dbg_line *);
308 linev = realloc(*linevp, nsize);
320 static void dump_hdr(unsigned long long offset, struct ptldebug_header *hdr)
322 fprintf(stderr, "badly-formed record at offset = %llu\n", offset);
323 fprintf(stderr, " len = %u\n", hdr->ph_len);
324 fprintf(stderr, " flags = %x\n", hdr->ph_flags);
325 fprintf(stderr, " subsystem = %x\n", hdr->ph_subsys);
326 fprintf(stderr, " mask = %x\n", hdr->ph_mask);
327 fprintf(stderr, " cpu_id = %u\n", hdr->ph_cpu_id);
328 fprintf(stderr, " type = %u\n", hdr->ph_type);
329 fprintf(stderr, " seconds = %u\n", hdr->ph_sec);
330 fprintf(stderr, " microseconds = %lu\n", (long)hdr->ph_usec);
331 fprintf(stderr, " stack = %u\n", hdr->ph_stack);
332 fprintf(stderr, " pid = %u\n", hdr->ph_pid);
333 fprintf(stderr, " host pid = %u\n", hdr->ph_extern_pid);
334 fprintf(stderr, " line number = %u\n", hdr->ph_line_num);
337 #define HDR_SIZE sizeof(*hdr)
339 static int parse_buffer(int fdin, int fdout)
341 struct dbg_line *line;
342 struct ptldebug_header *hdr;
345 unsigned long dropped = 0;
346 unsigned long kept = 0;
347 unsigned long bad = 0;
348 struct dbg_line **linev = NULL;
361 rc = read(fdin, ptr, count);
370 if (hdr->ph_len > 4094 || /* is this header bogus? */
371 hdr->ph_type >= libcfs_tcd_type_max() ||
372 hdr->ph_stack > 65536 ||
373 hdr->ph_sec < (1 << 30) ||
374 hdr->ph_usec > 1000000000 ||
375 hdr->ph_line_num > 65536) {
377 dump_hdr(lseek(fdin, 0, SEEK_CUR), hdr);
381 /* try to restart on next line */
382 while (count < HDR_SIZE && buf[count] != '\n')
384 if (buf[count] == '\n')
385 count++; /* move past '\n' */
386 if (HDR_SIZE - count > 0) {
387 int left = HDR_SIZE - count;
389 memmove(buf, buf + count, left);
398 if (hdr->ph_len == 0)
401 count = hdr->ph_len - HDR_SIZE;
403 rc = read(fdin, ptr, count);
414 if ((hdr->ph_subsys && !(subsystem_mask & hdr->ph_subsys)) ||
415 (hdr->ph_mask && !(debug_mask & hdr->ph_mask))) {
421 line = malloc(sizeof(*line));
424 fprintf(stderr, "error: line malloc(%u): "
425 "printing accumulated records\n",
426 (unsigned int)sizeof(*line));
427 print_rec(&linev, kept, fdout);
431 fprintf(stderr, "error: line malloc(%u): exiting\n",
432 (unsigned int)sizeof(*line));
436 line->hdr = malloc(hdr->ph_len + 1);
437 if (line->hdr == NULL) {
440 fprintf(stderr, "error: hdr malloc(%u): "
441 "printing accumulated records\n",
443 print_rec(&linev, kept, fdout);
447 fprintf(stderr, "error: hdr malloc(%u): exiting\n",
452 ptr = (void *)line->hdr;
453 memcpy(line->hdr, buf, hdr->ph_len);
454 ptr[hdr->ph_len] = '\0';
458 ptr += strlen(line->file) + 1;
460 ptr += strlen(line->fn) + 1;
464 if (add_rec(line, &linev, &linev_len, kept) < 0) {
466 fprintf(stderr, "error: add_rec[%u] failed; "
467 "print accumulated records\n",
469 print_rec(&linev, kept, fdout);
473 fprintf(stderr, "error: add_rec[0] failed; exiting\n");
481 print_rec(&linev, kept, fdout);
483 printf("Debug log: %lu lines, %lu kept, %lu dropped, %lu bad.\n",
484 dropped + kept + bad, kept, dropped, bad);
489 int jt_dbg_debug_kernel(int argc, char **argv)
492 char filename[PATH_MAX];
500 fprintf(stderr, "usage: %s [file] [raw]\n", argv[0]);
506 } else if (argc > 1 && (argv[1][0] == '0' || argv[1][0] == '1')) {
511 /* If we are dumping raw (which means no conversion step to ASCII)
512 * then dump directly to any supplied filename, otherwise this is
513 * just a temp file and we dump to the real file at convert time. */
514 if (argc > 1 && raw) {
515 if (strlen(argv[1]) >= sizeof(filename)) {
516 fprintf(stderr, "File name too long: %s\n", argv[1]);
519 strncpy(filename, argv[1], sizeof(filename));
521 if (snprintf(filename, sizeof(filename), "%s"CFS_TIME_T".%u",
522 LIBCFS_DEBUG_FILE_PATH_DEFAULT, time(NULL),
524 >= sizeof(filename)) {
525 fprintf(stderr, "File name too long\n");
530 if (stat(filename, &st) == 0 && S_ISREG(st.st_mode))
533 fdin = dbg_open_ctlhandle(DUMP_KERNEL_CTL_NAME);
535 fprintf(stderr, "open(dump_kernel) failed: %s\n",
540 rc = dbg_write_cmd(fdin, filename, strlen(filename));
542 dbg_close_ctlhandle(fdin);
544 fprintf(stderr, "write(%s) failed: %s\n", filename,
545 strerror(save_errno));
552 fdin = open(filename, O_RDONLY);
554 if (errno == ENOENT) /* no dump file created */
556 fprintf(stderr, "fopen(%s) failed: %s\n", filename,
561 fdout = open(argv[1], O_WRONLY | O_CREAT | O_TRUNC,
564 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
570 fdout = fileno(stdout);
573 rc = parse_buffer(fdin, fdout);
578 fprintf(stderr, "parse_buffer failed; leaving tmp file %s "
579 "behind.\n", filename);
581 rc = unlink(filename);
583 fprintf(stderr, "dumped successfully, but couldn't "
584 "unlink tmp file %s: %s\n", filename,
591 int jt_dbg_debug_file(int argc, char **argv)
597 if (argc > 3 || argc < 2) {
598 fprintf(stderr, "usage: %s <input> [output]\n", argv[0]);
602 fdin = open(argv[1], O_RDONLY | O_LARGEFILE);
604 fprintf(stderr, "open(%s) failed: %s\n", argv[1],
609 fdout = open(argv[2],
610 O_CREAT | O_TRUNC | O_WRONLY | O_LARGEFILE,
613 fprintf(stderr, "open(%s) failed: %s\n", argv[2],
619 fdout = fileno(stdout);
622 rc = parse_buffer(fdin, fdout);
625 if (fdout != fileno(stdout))
631 const char debug_daemon_usage[] = "usage: %s {start file [MB]|stop}\n";
633 int jt_dbg_debug_daemon(int argc, char **argv)
639 fprintf(stderr, debug_daemon_usage, argv[0]);
643 fd = dbg_open_ctlhandle(DAEMON_CTL_NAME);
648 if (strcasecmp(argv[1], "start") == 0) {
649 if (argc < 3 || argc > 4 ||
650 (argc == 4 && strlen(argv[3]) > 5)) {
651 fprintf(stderr, debug_daemon_usage, argv[0]);
656 const long min_size = 10;
657 const long max_size = 20480;
661 size = strtoul(argv[3], &end, 0);
662 if (size < min_size ||
665 fprintf(stderr, "size %s invalid, must be in "
666 "the range %ld-%ld MB\n", argv[3],
670 snprintf(buf, sizeof(buf), "size=%ld", size);
671 rc = dbg_write_cmd(fd, buf, strlen(buf));
674 fprintf(stderr, "set %s failed: %s\n",
675 buf, strerror(errno));
680 rc = dbg_write_cmd(fd, argv[2], strlen(argv[2]));
682 fprintf(stderr, "start debug_daemon on %s failed: %s\n",
683 argv[2], strerror(errno));
689 if (strcasecmp(argv[1], "stop") == 0) {
690 rc = dbg_write_cmd(fd, "stop", 4);
692 fprintf(stderr, "stopping debug_daemon failed: %s\n",
701 fprintf(stderr, debug_daemon_usage, argv[0]);
704 dbg_close_ctlhandle(fd);
708 int jt_dbg_clear_debug_buf(int argc, char **argv)
711 struct libcfs_ioctl_data data;
714 fprintf(stderr, "usage: %s\n", argv[0]);
718 memset(&data, 0, sizeof(data));
719 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
720 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
724 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_CLEAR_DEBUG, buf);
726 fprintf(stderr, "IOC_LIBCFS_CLEAR_DEBUG failed: %s\n",
733 int jt_dbg_mark_debug_buf(int argc, char **argv)
735 static char scratch[MAX_MARK_SIZE] = "";
736 struct libcfs_ioctl_data data;
740 memset(&data, 0, sizeof(data));
743 int count, max_size = sizeof(scratch) - 1;
745 strncpy(scratch, argv[1], max_size);
746 max_size -= strlen(argv[1]);
747 for (count = 2; (count < argc) && (max_size > 1); count++) {
748 strncat(scratch, " ", max_size);
750 strncat(scratch, argv[count], max_size);
751 max_size -= strlen(argv[count]);
753 scratch[sizeof(scratch) - 1] = '\0';
756 time_t now = time(NULL);
760 data.ioc_inllen1 = strlen(text) + 1;
761 data.ioc_inlbuf1 = text;
763 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
764 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
768 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_MARK_DEBUG, buf);
770 fprintf(stderr, "IOC_LIBCFS_MARK_DEBUG failed: %s\n",
777 static struct mod_paths {
780 { "libcfs", "libcfs/libcfs" },
781 { "lnet", "lnet/lnet" },
782 { "ko2iblnd", "lnet/klnds/o2iblnd" },
783 { "kgnilnd", "lnet/klnds/gnilnd"},
784 { "ksocklnd", "lnet/klnds/socklnd" },
785 { "obdclass", "lustre/obdclass" },
786 { "llog_test", "lustre/obdclass" },
787 { "ptlrpc_gss", "lustre/ptlrpc/gss" },
788 { "ptlrpc", "lustre/ptlrpc" },
789 { "gks", "lustre/sec/gks" },
790 { "gkc", "lustre/sec/gks" },
791 { "ost", "lustre/ost" },
792 { "osc", "lustre/osc" },
793 { "mds", "lustre/mds" },
794 { "mdc", "lustre/mdc" },
795 { "lustre", "lustre/llite" },
796 { "llite_lloop", "lustre/llite" },
797 { "ldiskfs", "ldiskfs" },
798 { "obdecho", "lustre/obdecho" },
799 { "ldlm", "lustre/ldlm" },
800 { "obdfilter", "lustre/obdfilter" },
801 { "lov", "lustre/lov" },
802 { "lmv", "lustre/lmv" },
803 { "lquota", "lustre/quota" },
804 { "mgs", "lustre/mgs" },
805 { "mgc", "lustre/mgc" },
806 { "mdt", "lustre/mdt" },
807 { "mdd", "lustre/mdd" },
808 { "osd", "lustre/osd" },
809 { "cmm", "lustre/cmm" },
810 {"fid", "lustre/fid"},
811 {"fld", "lustre/fld"},
812 {"lod", "lustre/lod"},
813 {"osp", "lustre/osp"},
814 { "lfsck", "lustre/lfsck" },
818 int jt_dbg_modules(int argc, char **argv)
820 struct mod_paths *mp;
822 const char *proc = "/proc/modules";
825 unsigned long modaddr;
831 printf("%s [path] [kernel]\n", argv[0]);
835 file = fopen(proc, "r");
837 printf("failed open %s: %s\n", proc, strerror(errno));
841 while (fgets(buf, sizeof(buf), file) != NULL) {
842 if (sscanf(buf, "%s %*s %*s %*s %*s %lx",
843 modname, &modaddr) == 2) {
844 for (mp = mod_paths; mp->name != NULL; mp++) {
845 if (!strcmp(mp->name, modname))
849 printf("add-symbol-file %s%s%s/%s.o 0x%0lx\n",
850 path, path[0] ? "/" : "",
851 mp->path, mp->name, modaddr);
860 int jt_dbg_panic(int argc, char **argv)
863 struct libcfs_ioctl_data data;
866 fprintf(stderr, "usage: %s\n", argv[0]);
870 memset(&data, 0, sizeof(data));
871 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
872 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
876 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_PANIC, buf);
878 fprintf(stderr, "IOC_LIBCFS_PANIC failed: %s\n",