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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
32 * Some day I'll split all of this functionality into a cfs_debug module
33 * of its own. That day is not today.
36 #define __USE_FILE_OFFSET64
48 #include <sys/ioctl.h>
49 #include <sys/types.h>
54 #include <linux/types.h>
56 #include <libcfs/util/ioctl.h>
57 #include <libcfs/util/param.h>
58 #include <linux/lnet/libcfs_debug.h>
59 #include <linux/lnet/lnetctl.h>
60 #include <libcfs/util/string.h>
64 static char rawbuf[8192];
65 static char *buf = rawbuf;
66 static int max = 8192;
67 /*static int g_pfd = -1;*/
68 static int subsystem_mask = ~0;
69 static int debug_mask = ~0;
71 #define MAX_MARK_SIZE 256
73 static const char *const libcfs_debug_subsystems[] = LIBCFS_DEBUG_SUBSYS_NAMES;
74 static const char *const libcfs_debug_masks[] = LIBCFS_DEBUG_MASKS_NAMES;
76 #define DAEMON_CTL_NAME "daemon_file"
77 #define SUBSYS_DEBUG_CTL_NAME "subsystem_debug"
78 #define DEBUG_CTL_NAME "debug"
79 #define DUMP_KERNEL_CTL_NAME "dump_kernel"
82 * Open the parameter file "debug" which controls the debugging
83 * flags used to determine what information ends up in the lustre
84 * logs collected by lctl dk or the debug daemon.
87 dbg_open_ctlhandle(const char *str)
92 rc = cfs_get_param_paths(&path, "%s", str);
94 fprintf(stderr, "invalid parameter '%s'\n", str);
98 fd = open(path.gl_pathv[0], O_WRONLY);
100 fprintf(stderr, "open '%s' failed: %s\n",
101 path.gl_pathv[0], strerror(errno));
103 cfs_free_param_data(&path);
108 dbg_close_ctlhandle(int fd)
114 dbg_write_cmd(int fd, char *str, int len)
116 int rc = write(fd, str, len);
118 return (rc == len ? 0 : 1);
122 static int do_debug_mask(char *name, int enable)
127 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++) {
128 if (strcasecmp(name, libcfs_debug_subsystems[i]) == 0 ||
129 strcasecmp(name, "all_subs") == 0) {
130 printf("%s output from subsystem \"%s\"\n",
131 enable ? "Enabling" : "Disabling",
132 libcfs_debug_subsystems[i]);
134 subsystem_mask |= (1 << i);
136 subsystem_mask &= ~(1 << i);
140 for (i = 0; libcfs_debug_masks[i] != NULL; i++) {
141 if (strcasecmp(name, libcfs_debug_masks[i]) == 0 ||
142 strcasecmp(name, "all_types") == 0) {
143 printf("%s output of type \"%s\"\n",
144 enable ? "Enabling" : "Disabling",
145 libcfs_debug_masks[i]);
147 debug_mask |= (1 << i);
149 debug_mask &= ~(1 << i);
157 int dbg_initialize(int argc, char **argv)
162 int jt_dbg_filter(int argc, char **argv)
167 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
172 for (i = 1; i < argc; i++)
173 if (!do_debug_mask(argv[i], 0))
174 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
179 int jt_dbg_show(int argc, char **argv)
184 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
189 for (i = 1; i < argc; i++)
190 if (!do_debug_mask(argv[i], 1))
191 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
197 static int applymask(char *param, int value)
201 int len = scnprintf(buf, sizeof(buf), "%d", value);
203 int fd = dbg_open_ctlhandle(param);
207 rc = dbg_write_cmd(fd, buf, len+1);
209 fprintf(stderr, "Write to %s failed: %s\n",
210 param, strerror(errno));
213 dbg_close_ctlhandle(fd);
218 static void applymask_all(unsigned int subs_mask, unsigned int debug_mask)
220 applymask(SUBSYS_DEBUG_CTL_NAME, subs_mask);
221 applymask(DEBUG_CTL_NAME, debug_mask);
222 printf("Applied subsystem_debug=%d, debug=%d to lnet\n",
223 subs_mask, debug_mask);
226 int jt_dbg_list(int argc, char **argv)
231 fprintf(stderr, "usage: %s <subs || types>\n", argv[0]);
235 if (strcasecmp(argv[1], "subs") == 0) {
236 printf("Subsystems: all_subs");
237 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++)
238 if (libcfs_debug_subsystems[i][0])
239 printf(", %s", libcfs_debug_subsystems[i]);
241 } else if (strcasecmp(argv[1], "types") == 0) {
242 printf("Types: all_types");
243 for (i = 0; libcfs_debug_masks[i] != NULL; i++)
244 printf(", %s", libcfs_debug_masks[i]);
246 } else if (strcasecmp(argv[1], "applymasks") == 0) {
247 applymask_all(subsystem_mask, debug_mask);
252 /* all strings nul-terminated; only the struct and hdr need to be freed */
254 struct ptldebug_header *hdr;
260 static int cmp_rec(const void *p1, const void *p2)
262 struct dbg_line *d1 = *(struct dbg_line **)p1;
263 struct dbg_line *d2 = *(struct dbg_line **)p2;
265 if (d1->hdr->ph_sec < d2->hdr->ph_sec)
267 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
268 d1->hdr->ph_usec < d2->hdr->ph_usec)
270 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
271 d1->hdr->ph_usec == d2->hdr->ph_usec)
276 static void print_rec(struct dbg_line ***linevp, int used, int fdout)
278 struct dbg_line **linev = *linevp;
281 qsort(linev, used, sizeof(struct dbg_line *), cmp_rec);
282 for (i = 0; i < used; i++) {
283 struct dbg_line *line = linev[i];
284 struct ptldebug_header *hdr = line->hdr;
288 ssize_t bytes_written;
290 bytes = scnprintf(out, sizeof(out),
291 "%08x:%08x:%u.%u%s:%u.%06llu:%u:%u:%u:"
293 hdr->ph_subsys, hdr->ph_mask,
294 hdr->ph_cpu_id, hdr->ph_type,
295 hdr->ph_flags & PH_FLAG_FIRST_RECORD ? "F" : "",
296 hdr->ph_sec, (unsigned long long)hdr->ph_usec,
297 hdr->ph_stack, hdr->ph_pid, hdr->ph_extern_pid,
298 line->file, hdr->ph_line_num, line->fn,
301 bytes_written = write(fdout, buf, bytes);
302 if (bytes_written <= 0)
304 bytes -= bytes_written;
305 buf += bytes_written;
314 static int add_rec(struct dbg_line *line, struct dbg_line ***linevp, int *lenp,
317 struct dbg_line **linev = *linevp;
320 int nlen = *lenp + 4096;
321 int nsize = nlen * sizeof(struct dbg_line *);
323 linev = realloc(*linevp, nsize);
335 static void dump_hdr(unsigned long long offset, struct ptldebug_header *hdr)
337 fprintf(stderr, "badly-formed record at offset = %llu\n", offset);
338 fprintf(stderr, " len = %u\n", hdr->ph_len);
339 fprintf(stderr, " flags = %x\n", hdr->ph_flags);
340 fprintf(stderr, " subsystem = %x\n", hdr->ph_subsys);
341 fprintf(stderr, " mask = %x\n", hdr->ph_mask);
342 fprintf(stderr, " cpu_id = %u\n", hdr->ph_cpu_id);
343 fprintf(stderr, " type = %u\n", hdr->ph_type);
344 fprintf(stderr, " seconds = %u\n", hdr->ph_sec);
345 fprintf(stderr, " microseconds = %lu\n", (long)hdr->ph_usec);
346 fprintf(stderr, " stack = %u\n", hdr->ph_stack);
347 fprintf(stderr, " pid = %u\n", hdr->ph_pid);
348 fprintf(stderr, " host pid = %u\n", hdr->ph_extern_pid);
349 fprintf(stderr, " line number = %u\n", hdr->ph_line_num);
352 #define HDR_SIZE sizeof(*hdr)
354 static int parse_buffer(int fdin, int fdout)
356 struct dbg_line *line;
357 struct ptldebug_header *hdr;
360 unsigned long dropped = 0;
361 unsigned long kept = 0;
362 unsigned long bad = 0;
363 struct dbg_line **linev = NULL;
376 rc = read(fdin, ptr, count);
385 if (hdr->ph_len > 4094 || /* is this header bogus? */
386 hdr->ph_stack > 65536 ||
387 hdr->ph_sec < (1 << 30) ||
388 hdr->ph_usec > 1000000000 ||
389 hdr->ph_line_num > 65536) {
391 dump_hdr(lseek(fdin, 0, SEEK_CUR), hdr);
395 /* try to restart on next line */
396 while (count < HDR_SIZE && buf[count] != '\n')
398 if (buf[count] == '\n')
399 count++; /* move past '\n' */
400 if (HDR_SIZE - count > 0) {
401 int left = HDR_SIZE - count;
403 memmove(buf, buf + count, left);
412 if (hdr->ph_len == 0)
415 count = hdr->ph_len - HDR_SIZE;
417 rc = read(fdin, ptr, count);
428 if ((hdr->ph_subsys && !(subsystem_mask & hdr->ph_subsys)) ||
429 (hdr->ph_mask && !(debug_mask & hdr->ph_mask))) {
435 line = malloc(sizeof(*line));
438 fprintf(stderr, "error: line malloc(%u): "
439 "printing accumulated records\n",
440 (unsigned int)sizeof(*line));
441 print_rec(&linev, kept, fdout);
445 fprintf(stderr, "error: line malloc(%u): exiting\n",
446 (unsigned int)sizeof(*line));
450 line->hdr = malloc(hdr->ph_len + 1);
451 if (line->hdr == NULL) {
454 fprintf(stderr, "error: hdr malloc(%u): "
455 "printing accumulated records\n",
457 print_rec(&linev, kept, fdout);
461 fprintf(stderr, "error: hdr malloc(%u): exiting\n",
466 ptr = (void *)line->hdr;
467 memcpy(line->hdr, buf, hdr->ph_len);
468 ptr[hdr->ph_len] = '\0';
472 ptr += strlen(line->file) + 1;
474 ptr += strlen(line->fn) + 1;
478 if (add_rec(line, &linev, &linev_len, kept) < 0) {
480 fprintf(stderr, "error: add_rec[%u] failed; "
481 "print accumulated records\n",
483 print_rec(&linev, kept, fdout);
487 fprintf(stderr, "error: add_rec[0] failed; exiting\n");
495 print_rec(&linev, kept, fdout);
497 printf("Debug log: %lu lines, %lu kept, %lu dropped, %lu bad.\n",
498 dropped + kept + bad, kept, dropped, bad);
503 int jt_dbg_debug_kernel(int argc, char **argv)
506 char filename[PATH_MAX];
514 fprintf(stderr, "usage: %s [file] [raw]\n", argv[0]);
520 } else if (argc > 1 && (argv[1][0] == '0' || argv[1][0] == '1')) {
525 /* If we are dumping raw (which means no conversion step to ASCII)
526 * then dump directly to any supplied filename, otherwise this is
527 * just a temp file and we dump to the real file at convert time. */
528 if (argc > 1 && raw) {
529 if (strlen(argv[1]) >= sizeof(filename)) {
530 fprintf(stderr, "File name too long: %s\n", argv[1]);
533 strncpy(filename, argv[1], sizeof(filename));
535 if (snprintf(filename, sizeof(filename), "%s%lu.%u",
536 LIBCFS_DEBUG_FILE_PATH_DEFAULT, time(NULL),
538 >= sizeof(filename)) {
539 fprintf(stderr, "File name too long\n");
544 if (stat(filename, &st) == 0 && S_ISREG(st.st_mode))
547 fdin = dbg_open_ctlhandle(DUMP_KERNEL_CTL_NAME);
549 fprintf(stderr, "open(dump_kernel) failed: %s\n",
554 rc = dbg_write_cmd(fdin, filename, strlen(filename));
556 dbg_close_ctlhandle(fdin);
558 fprintf(stderr, "write(%s) failed: %s\n", filename,
559 strerror(save_errno));
566 fdin = open(filename, O_RDONLY);
568 if (errno == ENOENT) /* no dump file created */
570 fprintf(stderr, "fopen(%s) failed: %s\n", filename,
575 fdout = open(argv[1], O_WRONLY | O_CREAT | O_TRUNC,
578 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
584 fdout = fileno(stdout);
587 rc = parse_buffer(fdin, fdout);
592 fprintf(stderr, "parse_buffer failed; leaving tmp file %s "
593 "behind.\n", filename);
595 rc = unlink(filename);
597 fprintf(stderr, "dumped successfully, but couldn't "
598 "unlink tmp file %s: %s\n", filename,
605 int jt_dbg_debug_file(int argc, char **argv)
611 if (argc > 3 || argc < 2) {
612 fprintf(stderr, "usage: %s <input> [output]\n", argv[0]);
616 fdin = open(argv[1], O_RDONLY | O_LARGEFILE);
618 fprintf(stderr, "open(%s) failed: %s\n", argv[1],
623 fdout = open(argv[2],
624 O_CREAT | O_TRUNC | O_WRONLY | O_LARGEFILE,
627 fprintf(stderr, "open(%s) failed: %s\n", argv[2],
633 fdout = fileno(stdout);
636 rc = parse_buffer(fdin, fdout);
639 if (fdout != fileno(stdout))
645 const char debug_daemon_usage[] = "usage: %s {start file [MB]|stop}\n";
647 int jt_dbg_debug_daemon(int argc, char **argv)
651 char *resolved_path = NULL;
654 fprintf(stderr, debug_daemon_usage, argv[0]);
658 fd = dbg_open_ctlhandle(DAEMON_CTL_NAME);
663 if (strcasecmp(argv[1], "start") == 0) {
664 if (argc < 3 || argc > 4 ||
665 (argc == 4 && strlen(argv[3]) > 5)) {
666 fprintf(stderr, debug_daemon_usage, argv[0]);
671 const long min_size = 10;
672 const long max_size = 20480;
676 size = strtoul(argv[3], &end, 0);
677 if (size < min_size ||
680 fprintf(stderr, "size %s invalid, must be in "
681 "the range %ld-%ld MB\n", argv[3],
685 snprintf(buf, sizeof(buf), "size=%ld", size);
686 rc = dbg_write_cmd(fd, buf, strlen(buf));
689 fprintf(stderr, "set %s failed: %s\n",
690 buf, strerror(errno));
695 rc = cfs_abs_path(argv[2], &resolved_path);
698 "%s debug_daemon: cannot resolve path '%s': %s\n",
699 program_invocation_short_name, argv[2],
703 rc = dbg_write_cmd(fd, resolved_path, strlen(resolved_path));
705 fprintf(stderr, "start debug_daemon on %s failed: %s\n",
706 argv[2], strerror(errno));
712 if (strcasecmp(argv[1], "stop") == 0) {
713 rc = dbg_write_cmd(fd, "stop", 4);
715 fprintf(stderr, "stopping debug_daemon failed: %s\n",
724 fprintf(stderr, debug_daemon_usage, argv[0]);
727 dbg_close_ctlhandle(fd);
728 if (resolved_path != NULL)
733 int jt_dbg_clear_debug_buf(int argc, char **argv)
735 struct libcfs_ioctl_data data;
740 fprintf(stderr, "usage: %s\n", argv[0]);
744 if (cfs_get_param_paths(&path, "debug_marker") != 0)
747 fd = open(path.gl_pathv[0], O_WRONLY);
749 cfs_free_param_data(&path);
753 rc = write(fd, "clear", strlen("clear") + 1);
754 cfs_free_param_data(&path);
756 return rc > 0 ? 0 : rc;
759 memset(&data, 0, sizeof(data));
760 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
761 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
765 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_CLEAR_DEBUG, buf);
767 fprintf(stderr, "IOC_LIBCFS_CLEAR_DEBUG failed: %s\n",
774 int jt_dbg_mark_debug_buf(int argc, char **argv)
776 static char scratch[MAX_MARK_SIZE] = "";
777 struct libcfs_ioctl_data data;
783 int count, max_size = sizeof(scratch) - 1;
785 strncpy(scratch, argv[1], max_size);
786 max_size -= strlen(argv[1]);
787 for (count = 2; (count < argc) && (max_size > 1); count++) {
788 strncat(scratch, " ", max_size);
790 strncat(scratch, argv[count], max_size);
791 max_size -= strlen(argv[count]);
793 scratch[sizeof(scratch) - 1] = '\0';
796 time_t now = time(NULL);
800 if (cfs_get_param_paths(&path, "debug_marker") != 0)
803 fd = open(path.gl_pathv[0], O_WRONLY);
805 cfs_free_param_data(&path);
809 rc = write(fd, text, strlen(text) + 1);
810 cfs_free_param_data(&path);
812 return rc > 0 ? 0 : rc;
815 memset(&data, 0, sizeof(data));
816 data.ioc_inllen1 = strlen(text) + 1;
817 data.ioc_inlbuf1 = text;
819 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
820 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
824 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_MARK_DEBUG, buf);
826 fprintf(stderr, "IOC_LIBCFS_MARK_DEBUG failed: %s\n",
833 static struct mod_paths {
836 { .name = "libcfs", .path = "libcfs/libcfs" },
837 { .name = "lnet", .path = "lnet/lnet" },
838 { .name = "ko2iblnd", .path = "lnet/klnds/o2iblnd" },
839 { .name = "kgnilnd", .path = "lnet/klnds/gnilnd"},
840 { .name = "ksocklnd", .path = "lnet/klnds/socklnd" },
841 { .name = "obdclass", .path = "lustre/obdclass" },
842 { .name = "llog_test", .path = "lustre/kunit" },
843 { .name = "obd_test", .path = "lustre/kunit" },
844 { .name = "kinode", .path = "lustre/kunit" },
845 { .name = "ptlrpc_gss", .path = "lustre/ptlrpc/gss" },
846 { .name = "ptlrpc", .path = "lustre/ptlrpc" },
847 { .name = "gks", .path = "lustre/sec/gks" },
848 { .name = "gkc", .path = "lustre/sec/gks" },
849 { .name = "ost", .path = "lustre/ost" },
850 { .name = "osc", .path = "lustre/osc" },
851 { .name = "mds", .path = "lustre/mds" },
852 { .name = "mdc", .path = "lustre/mdc" },
853 { .name = "lustre", .path = "lustre/llite" },
854 { .name = "ldiskfs", .path = "ldiskfs" },
855 { .name = "obdecho", .path = "lustre/obdecho" },
856 { .name = "ldlm", .path = "lustre/ldlm" },
857 { .name = "obdfilter", .path = "lustre/obdfilter" },
858 { .name = "lov", .path = "lustre/lov" },
859 { .name = "lmv", .path = "lustre/lmv" },
860 { .name = "lquota", .path = "lustre/quota" },
861 { .name = "mgs", .path = "lustre/mgs" },
862 { .name = "mgc", .path = "lustre/mgc" },
863 { .name = "mdt", .path = "lustre/mdt" },
864 { .name = "mdd", .path = "lustre/mdd" },
865 { .name = "osd", .path = "lustre/osd" },
866 { .name = "cmm", .path = "lustre/cmm" },
867 { .name = "fid", .path = "lustre/fid"},
868 { .name = "fld", .path = "lustre/fld"},
869 { .name = "lod", .path = "lustre/lod"},
870 { .name = "osp", .path = "lustre/osp"},
871 { .name = "lfsck", .path = "lustre/lfsck" },
875 int jt_dbg_modules(int argc, char **argv)
877 struct mod_paths *mp;
879 const char *proc = "/proc/modules";
882 unsigned long modaddr;
888 printf("%s [path] [kernel]\n", argv[0]);
892 file = fopen(proc, "r");
894 printf("failed open %s: %s\n", proc, strerror(errno));
898 while (fgets(buf, sizeof(buf), file) != NULL) {
899 if (sscanf(buf, "%s %*s %*s %*s %*s %lx",
900 modname, &modaddr) == 2) {
901 for (mp = mod_paths; mp->name != NULL; mp++) {
902 if (!strcmp(mp->name, modname))
906 printf("add-symbol-file %s%s%s/%s.o 0x%0lx\n",
907 path, path[0] ? "/" : "",
908 mp->path, mp->name, modaddr);