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, 2012, 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>
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;
64 #define DAEMON_CTL_NAME "/proc/sys/lnet/daemon_file"
65 #define SUBSYS_DEBUG_CTL_NAME "/proc/sys/lnet/subsystem_debug"
66 #define DEBUG_CTL_NAME "/proc/sys/lnet/debug"
67 #define DUMP_KERNEL_CTL_NAME "/proc/sys/lnet/dump_kernel"
70 dbg_open_ctlhandle(const char *str)
73 fd = open(str, O_WRONLY);
75 fprintf(stderr, "open %s failed: %s\n", str,
83 dbg_close_ctlhandle(int fd)
89 dbg_write_cmd(int fd, char *str, int len)
91 int rc = write(fd, str, len);
93 return (rc == len ? 0 : 1);
97 #error - Unknown sysctl convention.
100 static int do_debug_mask(char *name, int enable)
104 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++) {
105 if (strcasecmp(name, libcfs_debug_subsystems[i]) == 0 ||
106 strcasecmp(name, "all_subs") == 0) {
107 printf("%s output from subsystem \"%s\"\n",
108 enable ? "Enabling" : "Disabling",
109 libcfs_debug_subsystems[i]);
111 subsystem_mask |= (1 << i);
113 subsystem_mask &= ~(1 << i);
117 for (i = 0; libcfs_debug_masks[i] != NULL; i++) {
118 if (strcasecmp(name, libcfs_debug_masks[i]) == 0 ||
119 strcasecmp(name, "all_types") == 0) {
120 printf("%s output of type \"%s\"\n",
121 enable ? "Enabling" : "Disabling",
122 libcfs_debug_masks[i]);
124 debug_mask |= (1 << i);
126 debug_mask &= ~(1 << i);
134 int dbg_initialize(int argc, char **argv)
139 int jt_dbg_filter(int argc, char **argv)
144 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
149 for (i = 1; i < argc; i++)
150 if (!do_debug_mask(argv[i], 0))
151 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
156 int jt_dbg_show(int argc, char **argv)
161 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
166 for (i = 1; i < argc; i++)
167 if (!do_debug_mask(argv[i], 1))
168 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
174 static int applymask(char* procpath, int value)
178 int len = snprintf(buf, 64, "%d", value);
180 int fd = dbg_open_ctlhandle(procpath);
182 fprintf(stderr, "Unable to open %s: %s\n",
183 procpath, strerror(errno));
186 rc = dbg_write_cmd(fd, buf, len+1);
188 fprintf(stderr, "Write to %s failed: %s\n",
189 procpath, strerror(errno));
192 dbg_close_ctlhandle(fd);
197 static void applymask_all(unsigned int subs_mask, unsigned int debug_mask)
199 if (!dump_filename) {
200 applymask(SUBSYS_DEBUG_CTL_NAME, subs_mask);
201 applymask(DEBUG_CTL_NAME, debug_mask);
203 struct libcfs_debug_ioctl_data data;
205 data.hdr.ioc_len = sizeof(data);
206 data.hdr.ioc_version = 0;
207 data.subs = subs_mask;
208 data.debug = debug_mask;
210 dump(OBD_DEV_ID, LIBCFS_IOC_DEBUG_MASK, &data);
212 printf("Applied subsystem_debug=%d, debug=%d to /proc/sys/lnet\n",
213 subs_mask, debug_mask);
216 int jt_dbg_list(int argc, char **argv)
221 fprintf(stderr, "usage: %s <subs || types>\n", argv[0]);
225 if (strcasecmp(argv[1], "subs") == 0) {
226 printf("Subsystems: all_subs");
227 for (i = 0; libcfs_debug_subsystems[i] != NULL; i++)
228 if (libcfs_debug_subsystems[i][0])
229 printf(", %s", libcfs_debug_subsystems[i]);
231 } else if (strcasecmp(argv[1], "types") == 0) {
232 printf("Types: all_types");
233 for (i = 0; libcfs_debug_masks[i] != NULL; i++)
234 printf(", %s", libcfs_debug_masks[i]);
236 } else if (strcasecmp(argv[1], "applymasks") == 0) {
237 applymask_all(subsystem_mask, debug_mask);
242 /* all strings nul-terminated; only the struct and hdr need to be freed */
244 struct ptldebug_header *hdr;
250 static int cmp_rec(const void *p1, const void *p2)
252 struct dbg_line *d1 = *(struct dbg_line **)p1;
253 struct dbg_line *d2 = *(struct dbg_line **)p2;
255 if (d1->hdr->ph_sec < d2->hdr->ph_sec)
257 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
258 d1->hdr->ph_usec < d2->hdr->ph_usec)
260 if (d1->hdr->ph_sec == d2->hdr->ph_sec &&
261 d1->hdr->ph_usec == d2->hdr->ph_usec)
266 static void print_rec(struct dbg_line ***linevp, int used, int fdout)
268 struct dbg_line **linev = *linevp;
271 qsort(linev, used, sizeof(struct dbg_line *), cmp_rec);
272 for (i = 0; i < used; i++) {
273 struct dbg_line *line = linev[i];
274 struct ptldebug_header *hdr = line->hdr;
278 ssize_t bytes_written;
280 bytes = sprintf(out, "%08x:%08x:%u.%u%s:%u.%06llu:%u:%u:%u:(%s:%u:%s()) %s",
281 hdr->ph_subsys, hdr->ph_mask,
282 hdr->ph_cpu_id, hdr->ph_type,
283 hdr->ph_flags & PH_FLAG_FIRST_RECORD ? "F" : "",
284 hdr->ph_sec, (unsigned long long)hdr->ph_usec,
285 hdr->ph_stack, hdr->ph_pid, hdr->ph_extern_pid,
286 line->file, hdr->ph_line_num, line->fn, line->text);
288 bytes_written = write(fdout, buf, bytes);
289 if (bytes_written <= 0)
291 bytes -= bytes_written;
292 buf += bytes_written;
301 static int add_rec(struct dbg_line *line, struct dbg_line ***linevp, int *lenp,
304 struct dbg_line **linev = *linevp;
307 int nlen = *lenp + 4096;
308 int nsize = nlen * sizeof(struct dbg_line *);
310 linev = realloc(*linevp, nsize);
322 static void dump_hdr(unsigned long long offset, struct ptldebug_header *hdr)
324 fprintf(stderr, "badly-formed record at offset = %llu\n", offset);
325 fprintf(stderr, " len = %u\n", hdr->ph_len);
326 fprintf(stderr, " flags = %x\n", hdr->ph_flags);
327 fprintf(stderr, " subsystem = %x\n", hdr->ph_subsys);
328 fprintf(stderr, " mask = %x\n", hdr->ph_mask);
329 fprintf(stderr, " cpu_id = %u\n", hdr->ph_cpu_id);
330 fprintf(stderr, " type = %u\n", hdr->ph_type);
331 fprintf(stderr, " seconds = %u\n", hdr->ph_sec);
332 fprintf(stderr, " microseconds = %lu\n", (long)hdr->ph_usec);
333 fprintf(stderr, " stack = %u\n", hdr->ph_stack);
334 fprintf(stderr, " pid = %u\n", hdr->ph_pid);
335 fprintf(stderr, " host pid = %u\n", hdr->ph_extern_pid);
336 fprintf(stderr, " line number = %u\n", hdr->ph_line_num);
339 #define HDR_SIZE sizeof(*hdr)
341 static int parse_buffer(int fdin, int fdout)
343 struct dbg_line *line;
344 struct ptldebug_header *hdr;
345 char buf[4097], *ptr;
346 unsigned long dropped = 0, kept = 0, bad = 0;
347 struct dbg_line **linev = NULL;
360 rc = read(fdin, ptr, count);
369 if (hdr->ph_len > 4094 || /* is this header bogus? */
370 hdr->ph_type >= libcfs_tcd_type_max() ||
371 hdr->ph_stack > 65536 ||
372 hdr->ph_sec < (1 << 30) ||
373 hdr->ph_usec > 1000000000 ||
374 hdr->ph_line_num > 65536) {
376 dump_hdr(lseek(fdin, 0, SEEK_CUR), hdr);
380 /* try to restart on next line */
381 while (count < HDR_SIZE && buf[count] != '\n')
383 if (buf[count] == '\n')
384 count++; /* move past '\n' */
385 if (HDR_SIZE - count > 0) {
386 int left = HDR_SIZE - count;
388 memmove(buf, buf + count, left);
397 if (hdr->ph_len == 0)
400 count = hdr->ph_len - HDR_SIZE;
402 rc = read(fdin, ptr, count);
413 if ((hdr->ph_subsys && !(subsystem_mask & hdr->ph_subsys)) ||
414 (hdr->ph_mask && !(debug_mask & hdr->ph_mask))) {
420 line = malloc(sizeof(*line));
423 fprintf(stderr, "error: line malloc(%u): "
424 "printing accumulated records\n",
425 (unsigned int)sizeof(*line));
426 print_rec(&linev, kept, fdout);
430 fprintf(stderr, "error: line malloc(%u): exiting\n",
431 (unsigned int)sizeof(*line));
435 line->hdr = malloc(hdr->ph_len + 1);
436 if (line->hdr == NULL) {
439 fprintf(stderr, "error: hdr malloc(%u): "
440 "printing accumulated records\n",
442 print_rec(&linev, kept, fdout);
446 fprintf(stderr, "error: hdr malloc(%u): exiting\n",
451 ptr = (void *)line->hdr;
452 memcpy(line->hdr, buf, hdr->ph_len);
453 ptr[hdr->ph_len] = '\0';
457 ptr += strlen(line->file) + 1;
459 ptr += strlen(line->fn) + 1;
463 if (add_rec(line, &linev, &linev_len, kept) < 0) {
465 fprintf(stderr, "error: add_rec[%u] failed; "
466 "print accumulated records\n",
468 print_rec(&linev, kept, fdout);
472 fprintf(stderr, "error: add_rec[0] failed; exiting\n");
480 print_rec(&linev, kept, fdout);
482 printf("Debug log: %lu lines, %lu kept, %lu dropped, %lu bad.\n",
483 dropped + kept + bad, kept, dropped, bad);
488 int jt_dbg_debug_kernel(int argc, char **argv)
491 char filename[PATH_MAX];
499 fprintf(stderr, "usage: %s [file] [raw]\n", argv[0]);
505 } else if (argc > 1 && (argv[1][0] == '0' || argv[1][0] == '1')) {
510 /* If we are dumping raw (which means no conversion step to ASCII)
511 * then dump directly to any supplied filename, otherwise this is
512 * just a temp file and we dump to the real file at convert time. */
513 if (argc > 1 && raw) {
514 if (strlen(argv[1]) >= sizeof(filename)) {
515 fprintf(stderr, "File name too long: %s\n", argv[1]);
518 strncpy(filename, argv[1], sizeof(filename));
520 if (snprintf(filename, sizeof(filename), "%s"CFS_TIME_T".%u",
521 LIBCFS_DEBUG_FILE_PATH_DEFAULT, time(NULL),
523 >= sizeof(filename)) {
524 fprintf(stderr, "File name too long\n");
529 if (stat(filename, &st) == 0 && S_ISREG(st.st_mode))
532 fdin = dbg_open_ctlhandle(DUMP_KERNEL_CTL_NAME);
534 fprintf(stderr, "open(dump_kernel) failed: %s\n",
539 rc = dbg_write_cmd(fdin, filename, strlen(filename));
541 dbg_close_ctlhandle(fdin);
543 fprintf(stderr, "write(%s) failed: %s\n", filename,
544 strerror(save_errno));
551 fdin = open(filename, O_RDONLY);
553 if (errno == ENOENT) /* no dump file created */
555 fprintf(stderr, "fopen(%s) failed: %s\n", filename,
560 fdout = open(argv[1], O_WRONLY | O_CREAT | O_TRUNC,
563 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
569 fdout = fileno(stdout);
572 rc = parse_buffer(fdin, fdout);
577 fprintf(stderr, "parse_buffer failed; leaving tmp file %s "
578 "behind.\n", filename);
580 rc = unlink(filename);
582 fprintf(stderr, "dumped successfully, but couldn't "
583 "unlink tmp file %s: %s\n", filename,
590 int jt_dbg_debug_file(int argc, char **argv)
596 if (argc > 3 || argc < 2) {
597 fprintf(stderr, "usage: %s <input> [output]\n", argv[0]);
601 fdin = open(argv[1], O_RDONLY | O_LARGEFILE);
603 fprintf(stderr, "open(%s) failed: %s\n", argv[1],
608 fdout = open(argv[2],
609 O_CREAT | O_TRUNC | O_WRONLY | O_LARGEFILE,
612 fprintf(stderr, "open(%s) failed: %s\n", argv[2],
618 fdout = fileno(stdout);
621 rc = parse_buffer(fdin, fdout);
624 if (fdout != fileno(stdout))
630 const char debug_daemon_usage[] = "usage: %s {start file [MB]|stop}\n";
632 int jt_dbg_debug_daemon(int argc, char **argv)
638 fprintf(stderr, debug_daemon_usage, argv[0]);
642 fd = dbg_open_ctlhandle(DAEMON_CTL_NAME);
647 if (strcasecmp(argv[1], "start") == 0) {
648 if (argc < 3 || argc > 4 ||
649 (argc == 4 && strlen(argv[3]) > 5)) {
650 fprintf(stderr, debug_daemon_usage, argv[0]);
655 const long min_size = 10;
656 const long max_size = 20480;
660 size = strtoul(argv[3], &end, 0);
661 if (size < min_size ||
664 fprintf(stderr, "size %s invalid, must be in "
665 "the range %ld-%ld MB\n", argv[3],
669 snprintf(buf, sizeof(buf), "size=%ld", size);
670 rc = dbg_write_cmd(fd, buf, strlen(buf));
673 fprintf(stderr, "set %s failed: %s\n",
674 buf, strerror(errno));
679 rc = dbg_write_cmd(fd, argv[2], strlen(argv[2]));
681 fprintf(stderr, "start debug_daemon on %s failed: %s\n",
682 argv[2], strerror(errno));
688 if (strcasecmp(argv[1], "stop") == 0) {
689 rc = dbg_write_cmd(fd, "stop", 4);
691 fprintf(stderr, "stopping debug_daemon failed: %s\n",
700 fprintf(stderr, debug_daemon_usage, argv[0]);
703 dbg_close_ctlhandle(fd);
707 int jt_dbg_clear_debug_buf(int argc, char **argv)
710 struct libcfs_ioctl_data data;
713 fprintf(stderr, "usage: %s\n", argv[0]);
717 memset(&data, 0, sizeof(data));
718 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
719 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
723 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_CLEAR_DEBUG, buf);
725 fprintf(stderr, "IOC_LIBCFS_CLEAR_DEBUG failed: %s\n",
732 int jt_dbg_mark_debug_buf(int argc, char **argv)
734 static char scratch[MAX_MARK_SIZE] = "";
735 struct libcfs_ioctl_data data = { 0 };
740 int count, max_size = sizeof(scratch) - 1;
742 strncpy(scratch, argv[1], max_size);
743 max_size -= strlen(argv[1]);
744 for (count = 2; (count < argc) && (max_size > 1); count++) {
745 strncat(scratch, " ", max_size);
747 strncat(scratch, argv[count], max_size);
748 max_size -= strlen(argv[count]);
750 scratch[sizeof(scratch) - 1] = '\0';
753 time_t now = time(NULL);
757 data.ioc_inllen1 = strlen(text) + 1;
758 data.ioc_inlbuf1 = text;
759 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
760 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
764 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_MARK_DEBUG, buf);
766 fprintf(stderr, "IOC_LIBCFS_MARK_DEBUG failed: %s\n",
773 static struct mod_paths {
776 { "libcfs", "libcfs/libcfs" },
777 { "lnet", "lnet/lnet" },
778 { "kmxlnd", "lnet/klnds/mxlnd" },
779 { "ko2iblnd", "lnet/klnds/o2iblnd" },
780 { "kgnilnd", "lnet/klnds/gnilnd"},
781 { "kqswlnd", "lnet/klnds/qswlnd" },
782 { "kralnd", "lnet/klnds/ralnd" },
783 { "ksocklnd", "lnet/klnds/socklnd" },
784 { "ktdilnd", "lnet/klnds/tdilnd" },
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";
823 char modname[128], buf[4096];
824 unsigned long modaddr;
830 printf("%s [path] [kernel]\n", argv[0]);
834 file = fopen(proc, "r");
836 printf("failed open %s: %s\n", proc, strerror(errno));
840 while (fgets(buf, sizeof(buf), file) != NULL) {
841 if (sscanf(buf, "%s %*s %*s %*s %*s %lx", modname, &modaddr) == 2) {
842 for (mp = mod_paths; mp->name != NULL; mp++) {
843 if (!strcmp(mp->name, modname))
847 printf("add-symbol-file %s%s%s/%s.o 0x%0lx\n",
848 path, path[0] ? "/" : "",
849 mp->path, mp->name, modaddr);
858 int jt_dbg_panic(int argc, char **argv)
861 struct libcfs_ioctl_data data;
864 fprintf(stderr, "usage: %s\n", argv[0]);
868 memset(&data, 0, sizeof(data));
869 if (libcfs_ioctl_pack(&data, &buf, max) != 0) {
870 fprintf(stderr, "libcfs_ioctl_pack failed.\n");
874 rc = l_ioctl(LNET_DEV_ID, IOC_LIBCFS_PANIC, buf);
876 fprintf(stderr, "IOC_LIBCFS_PANIC failed: %s\n",