1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
4 * Copyright (C) 2001, 2002 Cluster File Systems, Inc.
6 * This file is part of Portals, http://www.sf.net/projects/lustre/
8 * Portals is free software; you can redistribute it and/or
9 * modify it under the terms of version 2 of the GNU General Public
10 * License as published by the Free Software Foundation.
12 * Portals is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with Portals; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 * Some day I'll split all of this functionality into a cfs_debug module
22 * of its own. That day is not today.
26 #define __USE_FILE_OFFSET64
39 #include <sys/types.h>
40 #include <sys/socket.h>
41 #include <sys/ioctl.h>
44 #include <sys/utsname.h>
46 #include <portals/api-support.h>
47 #include <portals/ptlctl.h>
48 #include <libcfs/portals_utils.h>
53 static char rawbuf[8192];
54 static char *buf = rawbuf;
55 static int max = 8192;
56 /*static int g_pfd = -1;*/
57 static int subsystem_mask = ~0;
58 static int debug_mask = ~0;
60 #define MAX_MARK_SIZE 100
62 static const char *portal_debug_subsystems[] =
63 {"undefined", "mdc", "mds", "osc",
64 "ost", "class", "log", "llite",
65 "rpc", "mgmt", "portals", "nal",
66 "pinger", "filter", "ptlbd", "echo",
67 "ldlm", "lov", "router", "cobd",
68 "sm", "asobd", "confobd", "lmv",
70 static const char *portal_debug_masks[] =
71 {"trace", "inode", "super", "ext2",
72 "malloc", "cache", "info", "ioctl",
73 "blocks", "net", "warning", "buffs",
74 "other", "dentry", "portals", "page",
75 "dlmtrace", "error", "emerg", "ha",
76 "rpctrace", "vfstrace", "reada", "mmap",
77 "config", "console", "quota", NULL};
79 struct debug_daemon_cmd {
84 static const struct debug_daemon_cmd portal_debug_daemon_cmd[] = {
85 {"start", DEBUG_DAEMON_START},
86 {"stop", DEBUG_DAEMON_STOP},
90 static int do_debug_mask(char *name, int enable)
94 for (i = 0; portal_debug_subsystems[i] != NULL; i++) {
95 if (strcasecmp(name, portal_debug_subsystems[i]) == 0 ||
96 strcasecmp(name, "all_subs") == 0) {
97 printf("%s output from subsystem \"%s\"\n",
98 enable ? "Enabling" : "Disabling",
99 portal_debug_subsystems[i]);
101 subsystem_mask |= (1 << i);
103 subsystem_mask &= ~(1 << i);
107 for (i = 0; portal_debug_masks[i] != NULL; i++) {
108 if (strcasecmp(name, portal_debug_masks[i]) == 0 ||
109 strcasecmp(name, "all_types") == 0) {
110 printf("%s output of type \"%s\"\n",
111 enable ? "Enabling" : "Disabling",
112 portal_debug_masks[i]);
114 debug_mask |= (1 << i);
116 debug_mask &= ~(1 << i);
124 int dbg_initialize(int argc, char **argv)
129 int jt_dbg_filter(int argc, char **argv)
134 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
139 for (i = 1; i < argc; i++)
140 if (!do_debug_mask(argv[i], 0))
141 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
146 int jt_dbg_show(int argc, char **argv)
151 fprintf(stderr, "usage: %s <subsystem ID or debug mask>\n",
156 for (i = 1; i < argc; i++)
157 if (!do_debug_mask(argv[i], 1))
158 fprintf(stderr, "Unknown subsystem or debug type: %s\n",
164 static int applymask(char* procpath, int value)
168 int len = snprintf(buf, 64, "%d", value);
170 int fd = open(procpath, O_WRONLY);
172 fprintf(stderr, "Unable to open %s: %s\n",
173 procpath, strerror(errno));
176 rc = write(fd, buf, len+1);
178 fprintf(stderr, "Write to %s failed: %s\n",
179 procpath, strerror(errno));
186 static void applymask_all(unsigned int subs_mask, unsigned int debug_mask)
188 if (!dump_filename) {
189 applymask("/proc/sys/portals/subsystem_debug", subs_mask);
190 applymask("/proc/sys/portals/debug", debug_mask);
192 struct portals_debug_ioctl_data data;
194 data.hdr.ioc_len = sizeof(data);
195 data.hdr.ioc_version = 0;
196 data.subs = subs_mask;
197 data.debug = debug_mask;
199 dump(OBD_DEV_ID, PTL_IOC_DEBUG_MASK, &data);
201 printf("Applied subsystem_debug=%d, debug=%d to /proc/sys/portals\n",
202 subs_mask, debug_mask);
205 int jt_dbg_list(int argc, char **argv)
210 fprintf(stderr, "usage: %s <subs || types>\n", argv[0]);
214 if (strcasecmp(argv[1], "subs") == 0) {
215 printf("Subsystems: all_subs");
216 for (i = 0; portal_debug_subsystems[i] != NULL; i++)
217 printf(", %s", portal_debug_subsystems[i]);
219 } else if (strcasecmp(argv[1], "types") == 0) {
220 printf("Types: all_types");
221 for (i = 0; portal_debug_masks[i] != NULL; i++)
222 printf(", %s", portal_debug_masks[i]);
224 } else if (strcasecmp(argv[1], "applymasks") == 0) {
225 applymask_all(subsystem_mask, debug_mask);
230 /* all strings nul-terminated; only the struct and hdr need to be freed */
232 struct ptldebug_header *hdr;
236 struct list_head chain;
240 static void list_add_ordered(struct dbg_line *new, struct list_head *head)
242 struct list_head *pos;
243 struct dbg_line *curr;
245 list_for_each(pos, head) {
246 curr = list_entry(pos, struct dbg_line, chain);
248 if (curr->hdr->ph_sec < new->hdr->ph_sec)
250 if (curr->hdr->ph_sec == new->hdr->ph_sec &&
251 curr->hdr->ph_usec < new->hdr->ph_usec)
254 list_add(&new->chain, pos->prev);
257 list_add_tail(&new->chain, head);
260 static void print_saved_records(struct list_head *list, FILE *out)
262 struct list_head *pos, *tmp;
264 list_for_each_safe(pos, tmp, list) {
265 struct dbg_line *line;
266 struct ptldebug_header *hdr;
268 line = list_entry(pos, struct dbg_line, chain);
269 list_del(&line->chain);
272 fprintf(out, "%06x:%06x:%u:%u.%06Lu:%u:%u:%u:(%s:%u:%s()) %s",
273 hdr->ph_subsys, hdr->ph_mask, hdr->ph_cpu_id,
274 hdr->ph_sec, (unsigned long long)hdr->ph_usec,
275 hdr->ph_stack, hdr->ph_pid, hdr->ph_extern_pid,
276 line->file, hdr->ph_line_num, line->fn, line->text);
282 static int parse_buffer(FILE *in, FILE *out)
284 struct dbg_line *line;
285 struct ptldebug_header *hdr;
288 unsigned long dropped = 0, kept = 0;
289 struct list_head chunk_list;
291 CFS_INIT_LIST_HEAD(&chunk_list);
294 rc = fread(buf, sizeof(hdr->ph_len), 1, in);
299 if (hdr->ph_len == 0)
301 if (hdr->ph_len > 4094) {
302 fprintf(stderr, "unexpected large record: %d bytes. "
308 if (hdr->ph_flags & PH_FLAG_FIRST_RECORD) {
309 print_saved_records(&chunk_list, out);
310 assert(list_empty(&chunk_list));
313 rc = fread(buf + sizeof(hdr->ph_len), 1,
314 hdr->ph_len - sizeof(hdr->ph_len), in);
319 (!(subsystem_mask & hdr->ph_subsys) ||
320 (!(debug_mask & hdr->ph_mask)))) {
325 line = malloc(sizeof(*line));
327 fprintf(stderr, "malloc failed; printing accumulated "
328 "records and exiting.\n");
332 line->hdr = malloc(hdr->ph_len + 1);
333 if (line->hdr == NULL) {
334 fprintf(stderr, "malloc failed; printing accumulated "
335 "records and exiting.\n");
339 p = (void *)line->hdr;
340 memcpy(line->hdr, buf, hdr->ph_len);
341 p[hdr->ph_len] = '\0';
345 p += strlen(line->file) + 1;
347 p += strlen(line->fn) + 1;
350 list_add_ordered(line, &chunk_list);
354 print_saved_records(&chunk_list, out);
356 printf("Debug log: %lu lines, %lu kept, %lu dropped.\n",
357 dropped + kept, kept, dropped);
361 int jt_dbg_debug_kernel(int argc, char **argv)
366 FILE *in, *out = stdout;
369 fprintf(stderr, "usage: %s [file] [raw]\n", argv[0]);
375 } else if (argc > 1 && (argv[1][0] == '0' || argv[1][0] == '1')) {
380 /* If we are dumping raw (which means no conversion step to ASCII)
381 * then dump directly to any supplied filename, otherwise this is
382 * just a temp file and we dump to the real file at convert time. */
384 strcpy(filename, argv[1]);
386 sprintf(filename, "/tmp/lustre-log.%lu.%u",time(NULL),getpid());
388 if (stat(filename, &st) == 0 && S_ISREG(st.st_mode))
391 fd = open("/proc/sys/portals/dump_kernel", O_WRONLY);
393 fprintf(stderr, "open(dump_kernel) failed: %s\n",
398 rc = write(fd, filename, strlen(filename));
399 if (rc != strlen(filename)) {
400 fprintf(stderr, "write(%s) failed: %s\n", filename,
410 in = fopen(filename, "r");
412 if (errno == ENOENT) /* no dump file created */
415 fprintf(stderr, "fopen(%s) failed: %s\n", filename,
420 out = fopen(argv[1], "w");
422 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
429 rc = parse_buffer(in, out);
434 fprintf(stderr, "parse_buffer failed; leaving tmp file %s "
435 "behind.\n", filename);
437 rc = unlink(filename);
439 fprintf(stderr, "dumped successfully, but couldn't "
440 "unlink tmp file %s: %s\n", filename,
446 int jt_dbg_debug_file(int argc, char **argv)
454 if (argc > 3 || argc < 2) {
455 fprintf(stderr, "usage: %s <input> [output]\n", argv[0]);
459 fdin = open(argv[1], O_RDONLY | O_LARGEFILE);
461 fprintf(stderr, "open(%s) failed: %s\n", argv[1],
465 in = fdopen(fdin, "r");
467 fprintf(stderr, "fopen(%s) failed: %s\n", argv[1],
473 fdout = open(argv[2],
474 O_CREAT | O_TRUNC | O_WRONLY | O_LARGEFILE,
477 fprintf(stderr, "open(%s) failed: %s\n", argv[2],
482 out = fdopen(fdout, "w");
484 fprintf(stderr, "fopen(%s) failed: %s\n", argv[2],
492 rc = parse_buffer(in, out);
502 dbg_write_cmd(int fd, char *str)
504 int len = strlen(str);
505 int rc = write(fd, str, len);
507 return (rc == len ? 0 : 1);
510 const char debug_daemon_usage[] = "usage: %s {start file [MB]|stop}\n";
511 #define DAEMON_FILE "/proc/sys/portals/daemon_file"
512 int jt_dbg_debug_daemon(int argc, char **argv)
518 fprintf(stderr, debug_daemon_usage, argv[0]);
522 fd = open(DAEMON_FILE, O_WRONLY);
524 fprintf(stderr, "open %s failed: %s\n", DAEMON_FILE,
530 if (strcasecmp(argv[1], "start") == 0) {
531 if (argc < 3 || argc > 4 ||
532 (argc == 4 && strlen(argv[3]) > 5)) {
533 fprintf(stderr, debug_daemon_usage, argv[0]);
538 const long min_size = 10;
539 const long max_size = 20480;
543 size = strtoul(argv[3], &end, 0);
544 if (size < min_size ||
547 fprintf(stderr, "size %s invalid, must be in "
548 "the range %ld-%ld MB\n", argv[3],
552 snprintf(buf, sizeof(buf), "size=%ld", size);
553 rc = dbg_write_cmd(fd, buf);
556 fprintf(stderr, "set %s failed: %s\n",
557 buf, strerror(errno));
562 rc = dbg_write_cmd(fd, argv[2]);
564 fprintf(stderr, "start debug_daemon on %s failed: %s\n",
565 argv[2], strerror(errno));
571 if (strcasecmp(argv[1], "stop") == 0) {
572 rc = dbg_write_cmd(fd, "stop");
574 fprintf(stderr, "stopping debug_daemon failed: %s\n",
583 fprintf(stderr, debug_daemon_usage, argv[0]);
590 int jt_dbg_clear_debug_buf(int argc, char **argv)
593 struct portal_ioctl_data data;
596 fprintf(stderr, "usage: %s\n", argv[0]);
600 memset(&data, 0, sizeof(data));
601 if (portal_ioctl_pack(&data, &buf, max) != 0) {
602 fprintf(stderr, "portal_ioctl_pack failed.\n");
606 rc = l_ioctl(PORTALS_DEV_ID, IOC_PORTAL_CLEAR_DEBUG, buf);
608 fprintf(stderr, "IOC_PORTAL_CLEAR_DEBUG failed: %s\n",
615 int jt_dbg_mark_debug_buf(int argc, char **argv)
617 int rc, max_size = MAX_MARK_SIZE-1;
618 struct portal_ioctl_data data;
620 time_t now = time(NULL);
624 text = malloc(MAX_MARK_SIZE);
625 strncpy(text, argv[1], max_size);
626 max_size-=strlen(argv[1]);
627 for(counter = 2; (counter < argc) && (max_size > 0) ; counter++){
628 strncat(text, " ", 1);
630 strncat(text, argv[counter], max_size);
631 max_size-=strlen(argv[counter]);
635 text[strlen(text) - 1] = '\0'; /* stupid \n */
638 text[MAX_MARK_SIZE - 1] = '\0';
641 memset(&data, 0, sizeof(data));
642 data.ioc_inllen1 = strlen(text) + 1;
643 data.ioc_inlbuf1 = text;
644 if (portal_ioctl_pack(&data, &buf, max) != 0) {
645 fprintf(stderr, "portal_ioctl_pack failed.\n");
649 rc = l_ioctl(PORTALS_DEV_ID, IOC_PORTAL_MARK_DEBUG, buf);
651 fprintf(stderr, "IOC_PORTAL_MARK_DEBUG failed: %s\n",
658 static struct mod_paths {
661 {"libcfs", "portals/libcfs"},
662 {"portals", "portals/portals"},
663 {"ksocknal", "portals/knals/socknal"},
664 {"kptlrouter", "portals/router"},
665 {"lvfs", "lustre/lvfs"},
666 {"obdclass", "lustre/obdclass"},
667 {"llog_test", "lustre/obdclass"},
668 {"ptlrpc", "lustre/ptlrpc"},
669 {"obdext2", "lustre/obdext2"},
670 {"ost", "lustre/ost"},
671 {"osc", "lustre/osc"},
672 {"mds", "lustre/mds"},
673 {"mdc", "lustre/mdc"},
674 {"llite", "lustre/llite"},
675 {"ldiskfs", "lustre/ldiskfs"},
676 {"smfs", "lustre/smfs"},
677 {"obdecho", "lustre/obdecho"},
678 {"ldlm", "lustre/ldlm"},
679 {"obdfilter", "lustre/obdfilter"},
680 {"extN", "lustre/extN"},
681 {"lov", "lustre/lov"},
682 {"lmv", "lustre/lmv"},
683 {"fsfilt_ext3", "lustre/lvfs"},
684 {"fsfilt_extN", "lustre/lvfs"},
685 {"fsfilt_reiserfs", "lustre/lvfs"},
686 {"fsfilt_smfs", "lustre/lvfs"},
687 {"fsfilt_ldiskfs", "lustre/lvfs"},
688 {"mds_ext2", "lustre/mds"},
689 {"mds_ext3", "lustre/mds"},
690 {"mds_extN", "lustre/mds"},
691 {"ptlbd", "lustre/ptlbd"},
692 {"mgmt_svc", "lustre/mgmt"},
693 {"mgmt_cli", "lustre/mgmt"},
694 {"cobd", "lustre/cobd"},
695 {"cmobd", "lustre/cmobd"},
696 {"confobd", "lustre/obdclass"},
700 static int jt_dbg_modules_2_4(int argc, char **argv)
702 #ifdef HAVE_LINUX_VERSION_H
703 #if (LINUX_VERSION_CODE < KERNEL_VERSION(2,5,0))
704 struct mod_paths *mp;
706 char *kernel = "linux";
713 printf("%s [path] [kernel]\n", argv[0]);
717 for (mp = mod_paths; mp->name != NULL; mp++) {
718 struct module_info info;
721 int query_module(const char *name, int which, void *buf,
722 size_t bufsize, size_t *ret);
724 rc = query_module(mp->name, QM_INFO, &info, sizeof(info),
728 printf("query_module(%s) failed: %s\n",
729 mp->name, strerror(errno));
731 printf("add-symbol-file %s/%s/%s.o 0x%0lx\n", path,
733 info.addr + sizeof(struct module));
738 #endif // Headers are 2.6-only
739 #endif // !HAVE_LINUX_VERSION_H
743 static int jt_dbg_modules_2_5(int argc, char **argv)
745 struct mod_paths *mp;
747 char *kernel = "linux";
748 const char *proc = "/proc/modules";
749 char modname[128], others[128];
759 printf("%s [path] [kernel]\n", argv[0]);
763 file = fopen(proc, "r");
765 printf("failed open %s: %s\n", proc, strerror(errno));
769 while ((rc = fscanf(file, "%s %s %s %s %s %lx\n",
770 modname, others, others, others, others, &modaddr)) == 6) {
771 for (mp = mod_paths; mp->name != NULL; mp++) {
772 if (!strcmp(mp->name, modname))
776 printf("add-symbol-file %s/%s/%s.o 0x%0lx\n", path,
777 mp->path, mp->name, modaddr);
784 int jt_dbg_modules(int argc, char **argv)
787 struct utsname sysinfo;
789 rc = uname(&sysinfo);
791 printf("uname() failed: %s\n", strerror(errno));
795 if (sysinfo.release[2] > '4') {
796 return jt_dbg_modules_2_5(argc, argv);
798 return jt_dbg_modules_2_4(argc, argv);
804 int jt_dbg_panic(int argc, char **argv)
807 struct portal_ioctl_data data;
810 fprintf(stderr, "usage: %s\n", argv[0]);
814 memset(&data, 0, sizeof(data));
815 if (portal_ioctl_pack(&data, &buf, max) != 0) {
816 fprintf(stderr, "portal_ioctl_pack failed.\n");
820 rc = l_ioctl(PORTALS_DEV_ID, IOC_PORTAL_PANIC, buf);
822 fprintf(stderr, "IOC_PORTAL_PANIC failed: %s\n",