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 2009 Sun Microsystems, Inc. All rights reserved.
24 * Use is subject to license terms.
25 */
26
27 /*
28 * Copyright (c) 2012 by Delphix. All rights reserved.
29 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
30 */
31
32 #include <strings.h>
33 #include <dt_impl.h>
34
35 static const struct {
36 int err;
37 const char *msg;
38 } _dt_errlist[] = {
39 { EDT_VERSION, "Client requested version newer than library" },
40 { EDT_VERSINVAL, "Version is not properly formatted or is too large" },
41 { EDT_VERSUNDEF, "Requested version is not supported by compiler" },
42 { EDT_VERSREDUCED, "Requested version conflicts with earlier setting" },
43 { EDT_CTF, "Unexpected libctf error" },
44 { EDT_COMPILER, "Error in D program compilation" },
45 { EDT_NOTUPREG, "Insufficient tuple registers to generate code" },
46 { EDT_NOMEM, "Memory allocation failure" },
47 { EDT_INT2BIG, "Integer constant table limit exceeded" },
48 { EDT_STR2BIG, "String constant table limit exceeded" },
49 { EDT_NOMOD, "Unknown module name" },
50 { EDT_NOPROV, "Unknown provider name" },
51 { EDT_NOPROBE, "No probe matches description" },
52 { EDT_NOSYM, "Unknown symbol name" },
53 { EDT_NOSYMADDR, "No symbol corresponds to address" },
54 { EDT_NOTYPE, "Unknown type name" },
55 { EDT_NOVAR, "Unknown variable name" },
56 { EDT_NOAGG, "Unknown aggregation name" },
57 { EDT_BADSCOPE, "Improper use of scoping operator in type name" },
58 { EDT_BADSPEC, "Overspecified probe description" },
59 { EDT_BADSPCV, "Undefined macro variable in probe description" },
60 { EDT_BADID, "Unknown probe identifier" },
61 { EDT_NOTLOADED, "Module is no longer loaded" },
62 { EDT_NOCTF, "Module does not contain any CTF data" },
63 { EDT_DATAMODEL, "Module and program data models do not match" },
64 { EDT_DIFVERS, "Library uses newer DIF version than kernel" },
65 { EDT_BADAGG, "Unknown aggregating action" },
66 { EDT_FIO, "Error occurred while reading from input stream" },
67 { EDT_DIFINVAL, "DIF program content is invalid" },
68 { EDT_DIFSIZE, "DIF program exceeds maximum program size" },
69 { EDT_DIFFAULT, "DIF program contains invalid pointer" },
70 { EDT_BADPROBE, "Invalid probe specification" },
71 { EDT_BADPGLOB, "Probe description has too many globbing characters" },
72 { EDT_NOSCOPE, "Declaration scope stack underflow" },
73 { EDT_NODECL, "Declaration stack underflow" },
74 { EDT_DMISMATCH, "Data record list does not match statement" },
75 { EDT_DOFFSET, "Data record offset exceeds buffer boundary" },
76 { EDT_DALIGN, "Data record has inappropriate alignment" },
77 { EDT_BADOPTNAME, "Invalid option name" },
78 { EDT_BADOPTVAL, "Invalid value for specified option" },
79 { EDT_BADOPTCTX, "Option cannot be used from within a D program" },
80 { EDT_CPPFORK, "Failed to fork preprocessor" },
81 { EDT_CPPEXEC, "Failed to exec preprocessor" },
82 { EDT_CPPENT, "Preprocessor not found" },
83 { EDT_CPPERR, "Preprocessor failed to process input program" },
84 { EDT_SYMOFLOW, "Symbol table identifier space exhausted" },
85 { EDT_ACTIVE, "Operation illegal when tracing is active" },
86 { EDT_DESTRUCTIVE, "Destructive actions not allowed" },
87 { EDT_NOANON, "No anonymous tracing state" },
88 { EDT_ISANON, "Can't claim anonymous state and enable probes" },
89 { EDT_ENDTOOBIG, "END enablings exceed size of principal buffer" },
90 { EDT_NOCONV, "Failed to load type for printf conversion" },
91 { EDT_BADCONV, "Incomplete printf conversion" },
92 { EDT_BADERROR, "Invalid library ERROR action" },
93 { EDT_ERRABORT, "Abort due to error" },
94 { EDT_DROPABORT, "Abort due to drop" },
95 { EDT_DIRABORT, "Abort explicitly directed" },
96 { EDT_BADRVAL, "Invalid return value from callback" },
97 { EDT_BADNORMAL, "Invalid normalization" },
98 { EDT_BUFTOOSMALL, "Enabling exceeds size of buffer" },
99 { EDT_BADTRUNC, "Invalid truncation" },
100 { EDT_BUSY, "DTrace cannot be used when kernel debugger is active" },
101 { EDT_ACCESS, "DTrace requires additional privileges" },
102 { EDT_NOENT, "DTrace device not available on system" },
103 { EDT_BRICKED, "Abort due to systemic unresponsiveness" },
104 { EDT_HARDWIRE, "Failed to load language definitions" },
105 { EDT_ELFVERSION, "libelf is out-of-date with respect to libdtrace" },
106 { EDT_NOBUFFERED, "Attempt to buffer output without handler" },
107 { EDT_UNSTABLE, "Description matched an unstable set of probes" },
108 { EDT_BADSETOPT, "Invalid setopt() library action" },
109 { EDT_BADSTACKPC, "Invalid stack program counter size" },
110 { EDT_BADAGGVAR, "Invalid aggregation variable identifier" },
111 { EDT_OVERSION, "Client requested deprecated version of library" },
112 { EDT_ENABLING_ERR, "Failed to enable probe" },
113 { EDT_NOPROBES, "No probe sites found for declared provider" }
114 };
115
116 static const int _dt_nerr = sizeof (_dt_errlist) / sizeof (_dt_errlist[0]);
117
118 const char *
119 dtrace_errmsg(dtrace_hdl_t *dtp, int error)
120 {
121 const char *str;
122 int i;
123
124 if (error == EDT_COMPILER && dtp != NULL && dtp->dt_errmsg[0] != '\0')
125 str = dtp->dt_errmsg;
126 else if (error == EDT_CTF && dtp != NULL && dtp->dt_ctferr != 0)
127 str = ctf_errmsg(dtp->dt_ctferr);
128 else if (error >= EDT_BASE && (error - EDT_BASE) < _dt_nerr) {
129 for (i = 0; i < _dt_nerr; i++) {
130 if (_dt_errlist[i].err == error)
131 return (_dt_errlist[i].msg);
132 }
133 str = NULL;
134 } else
135 str = strerror(error);
136
137 return (str ? str : "Unknown error");
138 }
139
140 int
141 dtrace_errno(dtrace_hdl_t *dtp)
142 {
143 return (dtp->dt_errno);
144 }
145
146 int
147 dt_set_errno(dtrace_hdl_t *dtp, int err)
148 {
149 dtp->dt_errno = err;
150 return (-1);
151 }
152
153 void
154 dt_set_errmsg(dtrace_hdl_t *dtp, const char *errtag, const char *region,
155 const char *filename, int lineno, const char *format, va_list ap)
156 {
157 size_t len, n;
158 char *p, *s;
159
160 s = dtp->dt_errmsg;
161 n = sizeof (dtp->dt_errmsg);
162
163 if (errtag != NULL && (yypcb->pcb_cflags & DTRACE_C_ETAGS))
164 (void) snprintf(s, n, "[%s] ", errtag);
165 else
166 s[0] = '\0';
167
168 len = strlen(dtp->dt_errmsg);
169 s = dtp->dt_errmsg + len;
170 n = sizeof (dtp->dt_errmsg) - len;
171
172 if (filename == NULL)
173 filename = dtp->dt_filetag;
174
175 if (filename != NULL)
176 (void) snprintf(s, n, "\"%s\", line %d: ", filename, lineno);
177 else if (lineno != 0)
178 (void) snprintf(s, n, "line %d: ", lineno);
179 else if (region != NULL)
180 (void) snprintf(s, n, "in %s: ", region);
181
182 len = strlen(dtp->dt_errmsg);
183 s = dtp->dt_errmsg + len;
184 n = sizeof (dtp->dt_errmsg) - len;
185 (void) vsnprintf(s, n, format, ap);
186
187 if ((p = strrchr(dtp->dt_errmsg, '\n')) != NULL)
188 *p = '\0'; /* remove trailing \n from message buffer */
189
190 dtp->dt_errtag = errtag;
191 }
192
193 /*ARGSUSED*/
194 const char *
195 dtrace_faultstr(dtrace_hdl_t *dtp, int fault)
196 {
197 int i;
198
199 static const struct {
200 int code;
201 const char *str;
202 } faults[] = {
203 { DTRACEFLT_BADADDR, "invalid address" },
204 { DTRACEFLT_BADALIGN, "invalid alignment" },
205 { DTRACEFLT_ILLOP, "illegal operation" },
206 { DTRACEFLT_DIVZERO, "divide-by-zero" },
207 { DTRACEFLT_NOSCRATCH, "out of scratch space" },
208 { DTRACEFLT_KPRIV, "invalid kernel access" },
209 { DTRACEFLT_UPRIV, "invalid user access" },
210 { DTRACEFLT_TUPOFLOW, "tuple stack overflow" },
211 { DTRACEFLT_BADSTACK, "bad stack" },
212 { DTRACEFLT_LIBRARY, "library-level fault" },
213 { 0, NULL }
214 };
215
216 for (i = 0; faults[i].str != NULL; i++) {
217 if (faults[i].code == fault)
218 return (faults[i].str);
219 }
220
221 return ("unknown fault");
222 }