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) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2012, Intel Corporation.
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];
47 unsigned int libcfs_subsystem_debug = ~(S_LNET | S_LND);
48 unsigned int libcfs_debug = 0;
51 #include <sys/utsname.h>
52 #endif /* HAVE_NETDB_H */
53 struct utsname *tmp_utsname;
54 static char source_nid[sizeof(tmp_utsname->nodename)];
56 static int source_pid;
57 int smp_processor_id = 1;
58 char libcfs_debug_file_path[1024];
61 int portals_do_debug_dumplog(void *arg)
63 printf("Look in %s\n", debug_file_name);
68 void portals_debug_print(void)
74 void libcfs_debug_dumplog(void)
76 printf("Look in %s\n", debug_file_name);
80 int libcfs_debug_init(unsigned long bufsize)
82 char *debug_mask = NULL;
83 char *debug_subsys = NULL;
86 struct utsname myname;
88 if (uname(&myname) == 0)
89 strcpy(source_nid, myname.nodename);
90 source_pid = getpid();
93 debug_mask = getenv("LIBLUSTRE_DEBUG_MASK");
95 libcfs_debug = (unsigned int) strtol(debug_mask, NULL, 0);
97 debug_subsys = getenv("LIBLUSTRE_DEBUG_SUBSYS");
99 libcfs_subsystem_debug =
100 (unsigned int) strtol(debug_subsys, NULL, 0);
102 debug_filename = getenv("LIBLUSTRE_DEBUG_BASE");
103 if (debug_filename) {
104 strncpy(libcfs_debug_file_path, debug_filename,
105 sizeof(libcfs_debug_file_path));
106 libcfs_debug_file_path[sizeof(libcfs_debug_file_path)-1] = '\0';
109 debug_filename = getenv("LIBLUSTRE_DEBUG_FILE");
110 if (debug_filename) {
111 strncpy(debug_file_name, debug_filename,
112 sizeof(debug_file_name));
113 debug_file_name[sizeof(debug_file_name) - 1] = '\0';
116 if (debug_file_name[0] == '\0' && libcfs_debug_file_path[0] != '\0')
117 snprintf(debug_file_name, sizeof(debug_file_name),
118 "%s-%s-"CFS_TIME_T".log", libcfs_debug_file_path,
119 source_nid, time(0));
121 if (strcmp(debug_file_name, "stdout") == 0 ||
122 strcmp(debug_file_name, "-") == 0) {
123 debug_file_fd = stdout;
124 } else if (strcmp(debug_file_name, "stderr") == 0) {
125 debug_file_fd = stderr;
126 } else if (debug_file_name[0] != '\0') {
127 debug_file_fd = fopen(debug_file_name, "w");
128 if (debug_file_fd == NULL)
129 fprintf(stderr, "%s: unable to open '%s': %s\n",
130 source_nid, debug_file_name, strerror(errno));
133 if (debug_file_fd == NULL)
134 debug_file_fd = stdout;
139 int libcfs_debug_cleanup(void)
141 if (debug_file_fd != stdout && debug_file_fd != stderr)
142 fclose(debug_file_fd);
146 int libcfs_debug_clear_buffer(void)
151 int libcfs_debug_mark_buffer(const char *text)
154 fprintf(debug_file_fd, "*******************************************************************************\n");
155 fprintf(debug_file_fd, "DEBUG MARKER: %s\n", text);
156 fprintf(debug_file_fd, "*******************************************************************************\n");
161 int libcfs_debug_msg(struct libcfs_debug_msg_data *msgdata,
162 const char *format, ...)
167 va_start(args, format);
168 rc = libcfs_debug_vmsg2(msgdata, format, args, NULL);
175 libcfs_debug_vmsg2(struct libcfs_debug_msg_data *msgdata,
176 const char *format1, va_list args,
177 const char *format2, ...)
183 char buf[PAGE_CACHE_SIZE]; /* size 4096 used for compatimble
184 * with linux, where message can`t
185 * be exceed PAGE_SIZE */
187 char *prefix = "Lustre";
189 if ((!console) && (!debug_file_fd)) {
193 if (msgdata->msg_mask & (D_EMERG | D_ERROR))
194 prefix = "LustreError";
196 nob = snprintf(buf, sizeof(buf), "%s: %u-%s:(%s:%d:%s()): ", prefix,
197 source_pid, source_nid, msgdata->msg_file,
198 msgdata->msg_line, msgdata->msg_fn);
200 remain = sizeof(buf) - nob;
202 nob += vsnprintf(&buf[nob], remain, format1, args);
205 remain = sizeof(buf) - nob;
206 if ((format2) && (remain > 0)) {
207 va_start(ap, format2);
208 nob += vsnprintf(&buf[nob], remain, format2, ap);
212 if (debug_file_fd == NULL)
215 gettimeofday(&tv, NULL);
217 fprintf(debug_file_fd, CFS_TIME_T".%06lu:%u:%s:(%s:%d:%s()): %s",
218 tv.tv_sec, (unsigned long)tv.tv_usec, source_pid, source_nid,
219 msgdata->msg_file, msgdata->msg_line, msgdata->msg_fn, buf);
225 * a helper function for RETURN(): the sole purpose is to save 8-16 bytes
226 * on the stack - function calling RETURN() doesn't need to allocate two
227 * additional 'rc' on the stack
229 long libcfs_log_return(struct libcfs_debug_msg_data *msgdata, long rc)
231 libcfs_debug_msg(msgdata, "Process leaving (rc=%lu : %ld : %lx)\n",
237 * a helper function for GOTO(): the sole purpose is to save 8-16 bytes
238 * on the stack - function calling GOTO() doesn't need to allocate two
239 * additional 'rc' on the stack
241 void libcfs_log_goto(struct libcfs_debug_msg_data *msgdata, const char *l,
244 libcfs_debug_msg(msgdata, "Process leaving via %s (rc=" LPLU " : "
245 LPLD " : " LPLX ")\n", l, (ulong_ptr_t) rc, rc, rc);