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.
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.
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]
23 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
24 * Copyright (c) 2011, Joyent Inc. All rights reserved.
27 #pragma ident "%Z%%M% %I% %E% SMI"
38 #include <sys/types.h>
39 #include <sys/sysctl.h>
42 #include <dt_parser.h>
44 #include <dt_provider.h>
45 #include <dt_module.h>
48 * This callback function is installed in a given identifier hash to search for
49 * and apply deferred pragmas that are pending for a given new identifier name.
50 * Multiple pragmas may be pending for a given name; we processs all of them.
54 dt_pragma_apply(dt_idhash_t *dhp, dt_ident_t *idp)
59 if ((php = yypcb->pcb_pragmas) == NULL)
60 return; /* no pragmas pending for current compilation pass */
62 while ((pdp = dt_idhash_lookup(php, idp->di_name)) != NULL) {
63 switch (pdp->di_kind) {
65 idp->di_attr = pdp->di_attr;
68 idp->di_vers = pdp->di_vers;
71 dt_idhash_delete(php, pdp);
76 * The #pragma attributes directive can be used to reset stability attributes
77 * on a global identifier or inline definition. If the identifier is already
78 * defined, we can just change di_attr. If not, we insert the pragma into a
79 * hash table of the current pcb's deferred pragmas for later processing.
82 dt_pragma_attributes(const char *prname, dt_node_t *dnp)
84 dtrace_hdl_t *dtp = yypcb->pcb_hdl;
85 dtrace_attribute_t attr, *a;
87 const char *name, *part;
90 if (dnp == NULL || dnp->dn_kind != DT_NODE_IDENT ||
91 dnp->dn_list == NULL || dnp->dn_list->dn_kind != DT_NODE_IDENT) {
92 xyerror(D_PRAGMA_MALFORM, "malformed #pragma %s "
93 "<attributes> <ident>\n", prname);
96 if (dtrace_str2attr(dnp->dn_string, &attr) == -1) {
97 xyerror(D_PRAGMA_INVAL, "invalid attributes "
98 "specified by #pragma %s\n", prname);
102 name = dnp->dn_string;
104 if (strcmp(name, "provider") == 0) {
106 name = dnp->dn_string;
109 part = dnp->dn_string;
111 if ((pvp = dt_provider_lookup(dtp, name)) != NULL) {
112 if (strcmp(part, "provider") == 0) {
113 a = &pvp->pv_desc.dtvd_attr.dtpa_provider;
114 } else if (strcmp(part, "module") == 0) {
115 a = &pvp->pv_desc.dtvd_attr.dtpa_mod;
116 } else if (strcmp(part, "function") == 0) {
117 a = &pvp->pv_desc.dtvd_attr.dtpa_func;
118 } else if (strcmp(part, "name") == 0) {
119 a = &pvp->pv_desc.dtvd_attr.dtpa_name;
120 } else if (strcmp(part, "args") == 0) {
121 a = &pvp->pv_desc.dtvd_attr.dtpa_args;
123 xyerror(D_PRAGMA_INVAL, "invalid component "
124 "\"%s\" in attribute #pragma "
125 "for provider %s\n", name, part);
132 } else if ((idp = dt_idstack_lookup(
133 &yypcb->pcb_globals, name)) != NULL) {
135 if (idp->di_gen != dtp->dt_gen) {
136 xyerror(D_PRAGMA_SCOPE, "#pragma %s cannot modify "
137 "entity defined outside program scope\n", prname);
144 if (yypcb->pcb_pragmas == NULL && (yypcb->pcb_pragmas =
145 dt_idhash_create("pragma", NULL, 0, 0)) == NULL)
146 longjmp(yypcb->pcb_jmpbuf, EDT_NOMEM);
148 idp = dt_idhash_insert(yypcb->pcb_pragmas, name, DT_IDENT_PRAGAT, 0, 0,
149 attr, 0, &dt_idops_thaw, (void *)prname, dtp->dt_gen);
152 longjmp(yypcb->pcb_jmpbuf, EDT_NOMEM);
154 if (dtp->dt_globals->dh_defer == NULL)
155 dtp->dt_globals->dh_defer = &dt_pragma_apply;
159 * The #pragma binding directive can be used to reset the version binding
160 * on a global identifier or inline definition. If the identifier is already
161 * defined, we can just change di_vers. If not, we insert the pragma into a
162 * hash table of the current pcb's deferred pragmas for later processing.
165 dt_pragma_binding(const char *prname, dt_node_t *dnp)
167 dtrace_hdl_t *dtp = yypcb->pcb_hdl;
172 if (dnp == NULL || dnp->dn_kind != DT_NODE_STRING ||
173 dnp->dn_list == NULL || dnp->dn_list->dn_kind != DT_NODE_IDENT) {
174 xyerror(D_PRAGMA_MALFORM, "malformed #pragma %s "
175 "\"version\" <ident>\n", prname);
178 if (dt_version_str2num(dnp->dn_string, &vers) == -1) {
179 xyerror(D_PRAGMA_INVAL, "invalid version string "
180 "specified by #pragma %s\n", prname);
183 name = dnp->dn_list->dn_string;
184 idp = dt_idstack_lookup(&yypcb->pcb_globals, name);
187 if (idp->di_gen != dtp->dt_gen) {
188 xyerror(D_PRAGMA_SCOPE, "#pragma %s cannot modify "
189 "entity defined outside program scope\n", prname);
195 if (yypcb->pcb_pragmas == NULL && (yypcb->pcb_pragmas =
196 dt_idhash_create("pragma", NULL, 0, 0)) == NULL)
197 longjmp(yypcb->pcb_jmpbuf, EDT_NOMEM);
199 idp = dt_idhash_insert(yypcb->pcb_pragmas, name, DT_IDENT_PRAGBN, 0, 0,
200 _dtrace_defattr, vers, &dt_idops_thaw, (void *)prname, dtp->dt_gen);
203 longjmp(yypcb->pcb_jmpbuf, EDT_NOMEM);
205 if (dtp->dt_globals->dh_defer == NULL)
206 dtp->dt_globals->dh_defer = &dt_pragma_apply;
210 dt_pragma_depends_finddep(dtrace_hdl_t *dtp, const char *lname, char *lib,
217 for (dirp = dt_list_next(&dtp->dt_lib_path); dirp != NULL;
218 dirp = dt_list_next(dirp)) {
219 (void) snprintf(lib, len, "%s/%s", dirp->dir_path, lname);
221 if (stat(lib, &sbuf) == 0) {
228 xyerror(D_PRAGMA_DEPEND,
229 "failed to find dependency in libpath: %s", lname);
233 * The #pragma depends_on directive can be used to express a dependency on a
234 * module, provider or library which if not present will cause processing to
238 dt_pragma_depends(const char *prname, dt_node_t *cnp)
240 dtrace_hdl_t *dtp = yypcb->pcb_hdl;
241 dt_node_t *nnp = cnp ? cnp->dn_list : NULL;
243 dt_lib_depend_t *dld;
244 char lib[MAXPATHLEN];
246 char *provs, *cpy, *tok;
248 if (cnp == NULL || nnp == NULL ||
249 cnp->dn_kind != DT_NODE_IDENT || nnp->dn_kind != DT_NODE_IDENT) {
250 xyerror(D_PRAGMA_MALFORM, "malformed #pragma %s "
251 "<class> <name>\n", prname);
254 if (strcmp(cnp->dn_string, "provider") == 0) {
256 * First try to get the provider list using the
257 * debug.dtrace.providers sysctl, since that'll work even if
258 * we're not running as root.
261 if (sysctlbyname("debug.dtrace.providers", NULL, &plen, NULL, 0) ||
262 ((provs = dt_alloc(dtp, plen)) == NULL) ||
263 sysctlbyname("debug.dtrace.providers", provs, &plen, NULL, 0))
264 found = dt_provider_lookup(dtp, nnp->dn_string) != NULL;
267 for (cpy = provs; (tok = strsep(&cpy, " ")) != NULL; )
268 if (strcmp(tok, nnp->dn_string) == 0) {
272 if (found == B_FALSE)
273 found = dt_provider_lookup(dtp,
274 nnp->dn_string) != NULL;
278 } else if (strcmp(cnp->dn_string, "module") == 0) {
279 dt_module_t *mp = dt_module_lookup_by_name(dtp, nnp->dn_string);
280 found = mp != NULL && dt_module_getctf(dtp, mp) != NULL;
281 } else if (strcmp(cnp->dn_string, "library") == 0) {
282 if (yypcb->pcb_cflags & DTRACE_C_CTL) {
283 assert(dtp->dt_filetag != NULL);
285 dt_pragma_depends_finddep(dtp, nnp->dn_string, lib,
288 dld = dt_lib_depend_lookup(&dtp->dt_lib_dep,
292 if ((dt_lib_depend_add(dtp, &dld->dtld_dependencies,
294 xyerror(D_PRAGMA_DEPEND,
295 "failed to add dependency %s:%s\n", lib,
296 dtrace_errmsg(dtp, dtrace_errno(dtp)));
300 * By this point we have already performed a topological
301 * sort of the dependencies; we process this directive
302 * as satisfied as long as the dependency was properly
305 if (dtp->dt_filetag == NULL)
306 xyerror(D_PRAGMA_DEPEND, "main program may "
307 "not explicitly depend on a library");
309 dld = dt_lib_depend_lookup(&dtp->dt_lib_dep,
313 dt_pragma_depends_finddep(dtp, nnp->dn_string, lib,
315 dld = dt_lib_depend_lookup(&dtp->dt_lib_dep_sorted,
319 if (!dld->dtld_loaded)
320 xyerror(D_PRAGMA_DEPEND, "program requires "
321 "library \"%s\" which failed to load",
327 xyerror(D_PRAGMA_INVAL, "invalid class %s "
328 "specified by #pragma %s\n", cnp->dn_string, prname);
332 xyerror(D_PRAGMA_DEPEND, "program requires %s %s\n",
333 cnp->dn_string, nnp->dn_string);
338 * The #pragma error directive can be followed by any list of tokens, which we
339 * just concatenate and print as part of our error message.
342 dt_pragma_error(const char *prname, dt_node_t *dnp)
348 for (enp = dnp; enp != NULL; enp = enp->dn_list) {
349 if (enp->dn_kind == DT_NODE_IDENT ||
350 enp->dn_kind == DT_NODE_STRING)
351 n += strlen(enp->dn_string) + 1;
357 for (enp = dnp; enp != NULL; enp = enp->dn_list) {
358 if (enp->dn_kind == DT_NODE_IDENT ||
359 enp->dn_kind == DT_NODE_STRING) {
360 (void) strcat(s, enp->dn_string);
361 (void) strcat(s, " ");
365 xyerror(D_PRAGERR, "#%s: %s\n", prname, s);
370 dt_pragma_ident(const char *prname, dt_node_t *dnp)
372 /* ignore any #ident or #pragma ident lines */
376 dt_pragma_option(const char *prname, dt_node_t *dnp)
378 dtrace_hdl_t *dtp = yypcb->pcb_hdl;
381 if (dnp == NULL || dnp->dn_kind != DT_NODE_IDENT) {
382 xyerror(D_PRAGMA_MALFORM,
383 "malformed #pragma %s <option>=<val>\n", prname);
386 if (dnp->dn_list != NULL) {
387 xyerror(D_PRAGMA_MALFORM,
388 "superfluous arguments specified for #pragma %s\n", prname);
391 opt = alloca(strlen(dnp->dn_string) + 1);
392 (void) strcpy(opt, dnp->dn_string);
394 if ((val = strchr(opt, '=')) != NULL)
397 if (dtrace_setopt(dtp, opt, val) == -1) {
399 xyerror(D_PRAGMA_OPTSET,
400 "failed to set option '%s': %s\n", opt,
401 dtrace_errmsg(dtp, dtrace_errno(dtp)));
403 xyerror(D_PRAGMA_OPTSET,
404 "failed to set option '%s' to '%s': %s\n",
405 opt, val, dtrace_errmsg(dtp, dtrace_errno(dtp)));
411 * The #line directive is used to reset the input line number and to optionally
412 * note the file name for use in error messages. Sun cpp(1) also produces a
413 * third integer token after the filename which is one of the following:
415 * 0 - line change has nothing to do with an #include file
416 * 1 - line change because we just entered a #include file
417 * 2 - line change because we just exited a #include file
419 * We use these state tokens to adjust pcb_idepth, which in turn controls
420 * whether type lookups access the global type space or not.
423 dt_pragma_line(const char *prname, dt_node_t *dnp)
425 dt_node_t *fnp = dnp ? dnp->dn_list : NULL;
426 dt_node_t *inp = fnp ? fnp->dn_list : NULL;
428 if ((dnp == NULL || dnp->dn_kind != DT_NODE_INT) ||
429 (fnp != NULL && fnp->dn_kind != DT_NODE_STRING) ||
430 (inp != NULL && inp->dn_kind != DT_NODE_INT)) {
431 xyerror(D_PRAGMA_MALFORM, "malformed #%s "
432 "<line> [ [\"file\"] state ]\n", prname);
436 * If a file is specified, free any old pcb_filetag and swap fnp's
437 * dn_string into pcb_filetag as the new filename for error messages.
440 if (yypcb->pcb_filetag != NULL)
441 free(yypcb->pcb_filetag);
444 * This is not pretty, but is a necessary evil until we either
445 * write "dpp" or get a useful standalone cpp from DevPro. If
446 * the filename begins with /dev/fd, we know it's the master
447 * input file (see dt_preproc() in dt_cc.c), so just clear the
448 * dt_filetag pointer so error messages refer to the main file.
450 if (strncmp(fnp->dn_string, "/dev/fd/", 8) != 0) {
451 yypcb->pcb_filetag = fnp->dn_string;
452 fnp->dn_string = NULL;
454 yypcb->pcb_filetag = NULL;
458 if (inp->dn_value == 1)
460 else if (inp->dn_value == 2 && yypcb->pcb_idepth != 0)
464 yylineno = dnp->dn_value;
468 * D compiler pragma types range from control directives to common pragmas to
469 * D custom pragmas, in order of specificity. Similar to gcc, we use #pragma D
470 * as a special prefix for our pragmas so they can be used in mixed headers.
472 #define DT_PRAGMA_DIR 0 /* pragma directive may be used after naked # */
473 #define DT_PRAGMA_SUB 1 /* pragma directive may be used after #pragma */
474 #define DT_PRAGMA_DCP 2 /* pragma may only be used after #pragma D */
476 static const struct dt_pragmadesc {
477 const char *dpd_name;
478 void (*dpd_func)(const char *, dt_node_t *);
481 { "attributes", dt_pragma_attributes, DT_PRAGMA_DCP },
482 { "binding", dt_pragma_binding, DT_PRAGMA_DCP },
483 { "depends_on", dt_pragma_depends, DT_PRAGMA_DCP },
484 { "error", dt_pragma_error, DT_PRAGMA_DIR },
485 { "ident", dt_pragma_ident, DT_PRAGMA_DIR },
486 { "line", dt_pragma_line, DT_PRAGMA_DIR },
487 { "option", dt_pragma_option, DT_PRAGMA_DCP },
492 * Process a control line #directive by looking up the directive name in our
493 * lookup table and invoking the corresponding function with the token list.
494 * According to K&R[A12.9], we silently ignore null directive lines.
497 dt_pragma(dt_node_t *pnp)
499 const struct dt_pragmadesc *dpd;
501 int kind = DT_PRAGMA_DIR;
503 for (dnp = pnp; dnp != NULL; dnp = dnp->dn_list) {
504 if (dnp->dn_kind == DT_NODE_INT) {
505 dt_pragma_line("line", dnp);
509 if (dnp->dn_kind != DT_NODE_IDENT)
510 xyerror(D_PRAGCTL_INVAL, "invalid control directive\n");
512 if (kind == DT_PRAGMA_DIR &&
513 strcmp(dnp->dn_string, "pragma") == 0) {
514 kind = DT_PRAGMA_SUB;
518 if (kind == DT_PRAGMA_SUB &&
519 strcmp(dnp->dn_string, "D") == 0) {
520 kind = DT_PRAGMA_DCP;
524 for (dpd = dt_pragmas; dpd->dpd_name != NULL; dpd++) {
525 if (dpd->dpd_kind <= kind &&
526 strcmp(dpd->dpd_name, dnp->dn_string) == 0)
530 yylineno--; /* since we've already seen \n */
532 if (dpd->dpd_name != NULL) {
533 dpd->dpd_func(dpd->dpd_name, dnp->dn_list);
540 xyerror(D_PRAGCTL_INVAL, "invalid control directive: "
541 "#%s\n", dnp->dn_string);
544 break; /* K&R[A12.8] says to ignore unknown pragmas */
547 xyerror(D_PRAGMA_INVAL, "invalid D pragma: %s\n",
555 dt_node_list_free(&pnp);