xref: /titanic_52/usr/src/uts/common/io/bge/bge_log.c (revision 734b6a94890be549309b21156f8ed6d4561cac51)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #pragma ident	"%Z%%M%	%I%	%E% SMI"
28 
29 #include "sys/bge_impl2.h"
30 
31 
32 /*
33  * Global variable for default debug flags
34  */
35 uint32_t bge_debug;
36 
37 /*
38  * Global mutex used by logging routines below
39  */
40 kmutex_t bge_log_mutex[1];
41 
42 /*
43  * Static data used by logging routines; protected by <bge_log_mutex>
44  */
45 static struct {
46 	const char *who;
47 	const char *fmt;
48 	int level;
49 } bge_log_data;
50 
51 
52 /*
53  * Backend print routine for all the routines below
54  */
55 static void
56 bge_vprt(const char *fmt, va_list args)
57 {
58 	char buf[128];
59 
60 	ASSERT(mutex_owned(bge_log_mutex));
61 
62 	(void) vsnprintf(buf, sizeof (buf), fmt, args);
63 	cmn_err(bge_log_data.level, bge_log_data.fmt, bge_log_data.who, buf);
64 }
65 
66 /*
67  * Report a run-time event (CE_NOTE, to console & log)
68  */
69 void
70 bge_notice(bge_t *bgep, const char *fmt, ...)
71 {
72 	va_list args;
73 
74 	mutex_enter(bge_log_mutex);
75 	bge_log_data.who = bgep->ifname;
76 	bge_log_data.fmt = "%s: %s";
77 	bge_log_data.level = CE_NOTE;
78 
79 	va_start(args, fmt);
80 	bge_vprt(fmt, args);
81 	va_end(args);
82 
83 	mutex_exit(bge_log_mutex);
84 }
85 
86 /*
87  * Log a run-time event (CE_NOTE, log only)
88  */
89 void
90 bge_log(bge_t *bgep, const char *fmt, ...)
91 {
92 	va_list args;
93 
94 	mutex_enter(bge_log_mutex);
95 	bge_log_data.who = bgep->ifname;
96 	bge_log_data.fmt = "!%s: %s";
97 	bge_log_data.level = CE_NOTE;
98 
99 	va_start(args, fmt);
100 	bge_vprt(fmt, args);
101 	va_end(args);
102 
103 	mutex_exit(bge_log_mutex);
104 }
105 
106 /*
107  * Log a run-time problem (CE_WARN, log only)
108  */
109 void
110 bge_problem(bge_t *bgep, const char *fmt, ...)
111 {
112 	va_list args;
113 
114 	mutex_enter(bge_log_mutex);
115 	bge_log_data.who = bgep->ifname;
116 	bge_log_data.fmt = "!%s: %s";
117 	bge_log_data.level = CE_WARN;
118 
119 	va_start(args, fmt);
120 	bge_vprt(fmt, args);
121 	va_end(args);
122 
123 	mutex_exit(bge_log_mutex);
124 }
125 
126 /*
127  * Log a programming error (CE_WARN, log only)
128  */
129 void
130 bge_error(bge_t *bgep, const char *fmt, ...)
131 {
132 	va_list args;
133 
134 	mutex_enter(bge_log_mutex);
135 	bge_log_data.who = bgep->ifname;
136 	bge_log_data.fmt = "!%s: %s";
137 	bge_log_data.level = CE_WARN;
138 
139 	va_start(args, fmt);
140 	bge_vprt(fmt, args);
141 	va_end(args);
142 
143 	mutex_exit(bge_log_mutex);
144 }
145 
146 #if	BGE_DEBUGGING
147 
148 static void
149 bge_prt(const char *fmt, ...)
150 {
151 	va_list args;
152 
153 	ASSERT(mutex_owned(bge_log_mutex));
154 
155 	va_start(args, fmt);
156 	bge_vprt(fmt, args);
157 	va_end(args);
158 
159 	mutex_exit(bge_log_mutex);
160 }
161 
162 void
163 (*bge_gdb(void))(const char *fmt, ...)
164 {
165 	mutex_enter(bge_log_mutex);
166 	bge_log_data.who = "bge";
167 	bge_log_data.fmt = "?%s: %s\n";
168 	bge_log_data.level = CE_CONT;
169 
170 	return (bge_prt);
171 }
172 
173 void
174 (*bge_db(bge_t *bgep))(const char *fmt, ...)
175 {
176 	mutex_enter(bge_log_mutex);
177 	bge_log_data.who = bgep->ifname;
178 	bge_log_data.fmt = "?%s: %s\n";
179 	bge_log_data.level = CE_CONT;
180 
181 	return (bge_prt);
182 }
183 
184 /*
185  * Dump a chunk of memory, 16 bytes at a time
186  */
187 static void
188 minidump(bge_t *bgep, const char *caption, void *dp, uint_t len)
189 {
190 	uint32_t buf[4];
191 	uint32_t nbytes;
192 
193 	bge_log(bgep, "%d bytes of %s at address %p:-", len, caption, dp);
194 
195 	for (len = MIN(len, BGE_STD_BUFF_SIZE); len != 0; len -= nbytes) {
196 		nbytes = MIN(len, sizeof (buf));
197 		bzero(buf, sizeof (buf));
198 		bcopy(dp, buf, nbytes);
199 		bge_log(bgep, "%08x %08x %08x %08x",
200 			buf[0], buf[1], buf[2], buf[3]);
201 		dp = (caddr_t)dp + nbytes;
202 	}
203 }
204 
205 void
206 bge_pkt_dump(bge_t *bgep, bge_rbd_t *hrbdp, sw_rbd_t *srbdp, const char *msg)
207 {
208 	bge_problem(bgep, "driver-detected hardware error: %s", msg);
209 
210 	minidump(bgep, "hardware descriptor", hrbdp, sizeof (*hrbdp));
211 
212 	bge_log(bgep, "PCI address %llx packet len 0x%x token 0x%x "
213 			"flags 0x%x index 0x%x",
214 			hrbdp->host_buf_addr,
215 			hrbdp->len,
216 			hrbdp->opaque,
217 			hrbdp->flags,
218 			hrbdp->index);
219 
220 	if (srbdp != NULL) {
221 		minidump(bgep, "software descriptor", srbdp, sizeof (*srbdp));
222 
223 		bge_log(bgep, "PCI address %llx buffer len 0x%x token 0x%x",
224 			srbdp->pbuf.cookie.dmac_laddress,
225 			srbdp->pbuf.alength,
226 			srbdp->pbuf.token);
227 
228 		minidump(bgep, "packet data", srbdp->pbuf.mem_va, hrbdp->len);
229 	}
230 }
231 
232 void
233 bge_dbg_enter(bge_t *bgep, const char *s)
234 {
235 	uint32_t debug;
236 
237 	debug = bgep != NULL ? bgep->debug : bge_debug;
238 	if (debug & BGE_DBG_STOP) {
239 		cmn_err(CE_CONT, "bge_dbg_enter(%p): %s\n", (void *)bgep, s);
240 		debug_enter("");
241 	}
242 }
243 
244 #endif	/* BGE_DEBUGGING */
245