1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * libcfs/libcfs/posix/posix_debug.c
38 * Userspace debugging.
42 # define DEBUG_SUBSYSTEM S_LNET
44 #include <libcfs/libcfs.h>
46 static char debug_file_name[1024];
48 #ifdef HAVE_CATAMOUNT_DATA_H
49 #include <catamount/data.h>
50 #include <catamount/lputs.h>
52 static char source_nid[16];
53 /* 0 indicates no messages to console, 1 is errors, > 1 is all debug messages */
54 static int toconsole = 1;
55 unsigned int libcfs_console_ratelimit = 1;
56 unsigned int libcfs_console_max_delay;
57 unsigned int libcfs_console_min_delay;
58 unsigned int libcfs_console_backoff = CDEBUG_DEFAULT_BACKOFF;
59 #else /* !HAVE_CATAMOUNT_DATA_H */
61 #include <sys/utsname.h>
62 #endif /* HAVE_NETDB_H */
63 struct utsname *tmp_utsname;
64 static char source_nid[sizeof(tmp_utsname->nodename)];
65 #endif /* HAVE_CATAMOUNT_DATA_H */
67 static int source_pid;
68 int cfs_smp_processor_id = 1;
69 char libcfs_debug_file_path[1024];
72 int portals_do_debug_dumplog(void *arg)
74 printf("Look in %s\n", debug_file_name);
79 void portals_debug_print(void)
85 void libcfs_debug_dumplog(void)
87 printf("Look in %s\n", debug_file_name);
91 int libcfs_debug_init(unsigned long bufsize)
93 char *debug_mask = NULL;
94 char *debug_subsys = NULL;
97 #ifdef HAVE_CATAMOUNT_DATA_H
98 char *debug_console = NULL;
99 char *debug_ratelimit = NULL;
100 char *debug_max_delay = NULL;
101 char *debug_min_delay = NULL;
102 char *debug_backoff = NULL;
104 libcfs_console_max_delay = CDEBUG_DEFAULT_MAX_DELAY;
105 libcfs_console_min_delay = CDEBUG_DEFAULT_MIN_DELAY;
107 snprintf(source_nid, sizeof(source_nid) - 1, "%u", _my_pnid);
108 source_pid = _my_pid;
110 debug_console = getenv("LIBLUSTRE_DEBUG_CONSOLE");
111 if (debug_console != NULL) {
112 toconsole = strtoul(debug_console, NULL, 0);
113 CDEBUG(D_INFO, "set liblustre toconsole to %u\n", toconsole);
115 debug_ratelimit = getenv("LIBLUSTRE_DEBUG_CONSOLE_RATELIMIT");
116 if (debug_ratelimit != NULL) {
117 libcfs_console_ratelimit = strtoul(debug_ratelimit, NULL, 0);
118 CDEBUG(D_INFO, "set liblustre console ratelimit to %u\n",
119 libcfs_console_ratelimit);
121 debug_max_delay = getenv("LIBLUSTRE_DEBUG_CONSOLE_MAX_DELAY");
122 if (debug_max_delay != NULL)
123 libcfs_console_max_delay =
124 cfs_time_seconds(strtoul(debug_max_delay, NULL, 0));
125 debug_min_delay = getenv("LIBLUSTRE_DEBUG_CONSOLE_MIN_DELAY");
126 if (debug_min_delay != NULL)
127 libcfs_console_min_delay =
128 cfs_time_seconds(strtoul(debug_min_delay, NULL, 0));
129 if (debug_min_delay || debug_max_delay) {
130 if (!libcfs_console_max_delay || !libcfs_console_min_delay ||
131 libcfs_console_max_delay < libcfs_console_min_delay) {
132 libcfs_console_max_delay = CDEBUG_DEFAULT_MAX_DELAY;
133 libcfs_console_min_delay = CDEBUG_DEFAULT_MIN_DELAY;
134 CDEBUG(D_INFO, "LIBLUSTRE_DEBUG_CONSOLE_MAX_DELAY "
135 "should be greater than "
136 "LIBLUSTRE_DEBUG_CONSOLE_MIN_DELAY "
137 "and both parameters should be non-null"
138 ": restore default values\n");
140 CDEBUG(D_INFO, "set liblustre console max delay to %lus"
141 " and min delay to %lus\n",
143 cfs_duration_sec(libcfs_console_max_delay),
145 cfs_duration_sec(libcfs_console_min_delay));
148 debug_backoff = getenv("LIBLUSTRE_DEBUG_CONSOLE_BACKOFF");
149 if (debug_backoff != NULL) {
150 libcfs_console_backoff = strtoul(debug_backoff, NULL, 0);
151 if (libcfs_console_backoff <= 0) {
152 libcfs_console_backoff = CDEBUG_DEFAULT_BACKOFF;
153 CDEBUG(D_INFO, "LIBLUSTRE_DEBUG_CONSOLE_BACKOFF <= 0: "
154 "restore default value\n");
156 CDEBUG(D_INFO, "set liblustre console backoff to %u\n",
157 libcfs_console_backoff);
161 struct utsname myname;
163 if (uname(&myname) == 0)
164 strcpy(source_nid, myname.nodename);
165 source_pid = getpid();
168 debug_mask = getenv("LIBLUSTRE_DEBUG_MASK");
170 libcfs_debug = (unsigned int) strtol(debug_mask, NULL, 0);
172 debug_subsys = getenv("LIBLUSTRE_DEBUG_SUBSYS");
174 libcfs_subsystem_debug =
175 (unsigned int) strtol(debug_subsys, NULL, 0);
177 debug_filename = getenv("LIBLUSTRE_DEBUG_BASE");
179 strncpy(libcfs_debug_file_path, debug_filename,
180 sizeof(libcfs_debug_file_path));
182 debug_filename = getenv("LIBLUSTRE_DEBUG_FILE");
184 strncpy(debug_file_name,debug_filename,sizeof(debug_file_name));
186 if (debug_file_name[0] == '\0' && libcfs_debug_file_path[0] != '\0')
187 snprintf(debug_file_name, sizeof(debug_file_name) - 1,
188 "%s-%s-"CFS_TIME_T".log", libcfs_debug_file_path,
189 source_nid, time(0));
191 if (strcmp(debug_file_name, "stdout") == 0 ||
192 strcmp(debug_file_name, "-") == 0) {
193 debug_file_fd = stdout;
194 } else if (strcmp(debug_file_name, "stderr") == 0) {
195 debug_file_fd = stderr;
196 } else if (debug_file_name[0] != '\0') {
197 debug_file_fd = fopen(debug_file_name, "w");
198 if (debug_file_fd == NULL)
199 fprintf(stderr, "%s: unable to open '%s': %s\n",
200 source_nid, debug_file_name, strerror(errno));
203 if (debug_file_fd == NULL)
204 debug_file_fd = stdout;
209 int libcfs_debug_cleanup(void)
211 if (debug_file_fd != stdout && debug_file_fd != stderr)
212 fclose(debug_file_fd);
216 int libcfs_debug_clear_buffer(void)
221 int libcfs_debug_mark_buffer(const char *text)
224 fprintf(debug_file_fd, "*******************************************************************************\n");
225 fprintf(debug_file_fd, "DEBUG MARKER: %s\n", text);
226 fprintf(debug_file_fd, "*******************************************************************************\n");
231 #ifdef HAVE_CATAMOUNT_DATA_H
232 #define CATAMOUNT_MAXLINE (256-4)
233 void catamount_printline(char *buf, size_t size)
240 pos += CATAMOUNT_MAXLINE;
241 prsize -= CATAMOUNT_MAXLINE;
246 int libcfs_debug_msg(struct libcfs_debug_msg_data *msgdata,
247 const char *format, ...)
252 va_start(args, format);
253 rc = libcfs_debug_vmsg2(msgdata, format, args, NULL);
260 libcfs_debug_vmsg2(struct libcfs_debug_msg_data *msgdata,
261 const char *format1, va_list args,
262 const char *format2, ...)
268 char buf[CFS_PAGE_SIZE]; /* size 4096 used for compatimble
269 * with linux, where message can`t
270 * be exceed PAGE_SIZE */
272 char *prefix = "Lustre";
274 #ifdef HAVE_CATAMOUNT_DATA_H
275 /* toconsole == 0 - all messages to debug_file_fd
276 * toconsole == 1 - warnings to console, all to debug_file_fd
277 * toconsole > 1 - all debug to console */
278 if (((msgdata->msg_mask & libcfs_printk) && toconsole == 1) || toconsole > 1)
282 if ((!console) && (!debug_file_fd)) {
286 if (msgdata->msg_mask & (D_EMERG | D_ERROR))
287 prefix = "LustreError";
289 nob = snprintf(buf, sizeof(buf), "%s: %u-%s:(%s:%d:%s()): ", prefix,
290 source_pid, source_nid, msgdata->msg_file,
291 msgdata->msg_line, msgdata->msg_fn);
293 remain = sizeof(buf) - nob;
295 nob += vsnprintf(&buf[nob], remain, format1, args);
298 remain = sizeof(buf) - nob;
299 if ((format2) && (remain > 0)) {
300 va_start(ap, format2);
301 nob += vsnprintf(&buf[nob], remain, format2, ap);
305 #ifdef HAVE_CATAMOUNT_DATA_H
307 cfs_debug_limit_state_t *cdls = msgdata->msg_cdls;
309 /* check rate limit for console */
311 if (libcfs_console_ratelimit &&
312 cdls->cdls_next != 0 && /* not first time ever */
313 !cfs_time_after(cfs_time_current(), cdls->cdls_next)) {
315 /* skipping a console message */
320 if (cfs_time_after(cfs_time_current(), cdls->cdls_next +
321 libcfs_console_max_delay +
322 cfs_time_seconds(10))) {
323 /* last timeout was a long time ago */
324 cdls->cdls_delay /= libcfs_console_backoff * 4;
326 cdls->cdls_delay *= libcfs_console_backoff;
328 if (cdls->cdls_delay <
329 libcfs_console_min_delay)
331 libcfs_console_min_delay;
332 else if (cdls->cdls_delay >
333 libcfs_console_max_delay)
335 libcfs_console_max_delay;
338 /* ensure cdls_next is never zero after it's been seen */
339 cdls->cdls_next = (cfs_time_current() + cdls->cdls_delay) | 1;
342 if (cdls != NULL && cdls->cdls_count != 0) {
345 nob = snprintf(buf2, sizeof(buf2),
346 "Skipped %d previous similar message%s\n",
347 cdls->cdls_count, (cdls->cdls_count > 1) ? "s" : "");
349 catamount_printline(buf2, nob);
350 cdls->cdls_count = 0;
353 catamount_printline(buf, nob);
356 /* return on toconsole > 1, as we don't want the user getting
357 * spammed by the debug data */
361 if (debug_file_fd == NULL)
364 gettimeofday(&tv, NULL);
366 fprintf(debug_file_fd, CFS_TIME_T".%06lu:%u:%s:(%s:%d:%s()): %s",
367 tv.tv_sec, tv.tv_usec, source_pid, source_nid,
368 msgdata->msg_file, msgdata->msg_line, msgdata->msg_fn, buf);
374 libcfs_assertion_failed(const char *expr, struct libcfs_debug_msg_data *msgdata)
376 libcfs_debug_msg(msgdata, "ASSERTION(%s) failed\n", expr);
381 * a helper function for RETURN(): the sole purpose is to save 8-16 bytes
382 * on the stack - function calling RETURN() doesn't need to allocate two
383 * additional 'rc' on the stack
385 long libcfs_log_return(struct libcfs_debug_msg_data *msgdata, long rc)
387 libcfs_debug_msg(msgdata, "Process leaving (rc=%lu : %ld : %lx)\n",
393 * a helper function for GOTO(): the sole purpose is to save 8-16 bytes
394 * on the stack - function calling GOTO() doesn't need to allocate two
395 * additional 'rc' on the stack
397 void libcfs_log_goto(struct libcfs_debug_msg_data *msgdata, const char *l,
400 libcfs_debug_msg(msgdata, "Process leaving via %s (rc=" LPLU " : "
401 LPLD " : " LPLX ")\n", l, (ulong_ptr_t) rc, rc, rc);