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