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 * Use is subject to license terms.
27 #pragma ident "%Z%%M% %I% %E% SMI"
40 #include <dt_program.h>
41 #include <dt_printf.h>
42 #include <dt_provider.h>
45 dt_program_create(dtrace_hdl_t *dtp)
47 dtrace_prog_t *pgp = dt_zalloc(dtp, sizeof (dtrace_prog_t));
50 dt_list_append(&dtp->dt_programs, pgp);
52 (void) dt_set_errno(dtp, EDT_NOMEM);
55 * By default, programs start with DOF version 1 so that output files
56 * containing DOF are backward compatible. If a program requires new
57 * DOF features, the version is increased as needed.
59 pgp->dp_dofversion = DOF_VERSION_1;
65 dt_program_destroy(dtrace_hdl_t *dtp, dtrace_prog_t *pgp)
67 dt_stmt_t *stp, *next;
70 for (stp = dt_list_next(&pgp->dp_stmts); stp != NULL; stp = next) {
71 next = dt_list_next(stp);
72 dtrace_stmt_destroy(dtp, stp->ds_desc);
76 for (i = 0; i < pgp->dp_xrefslen; i++)
77 dt_free(dtp, pgp->dp_xrefs[i]);
79 dt_free(dtp, pgp->dp_xrefs);
80 dt_list_delete(&dtp->dt_programs, pgp);
86 dtrace_program_info(dtrace_hdl_t *dtp, dtrace_prog_t *pgp,
87 dtrace_proginfo_t *pip)
91 dtrace_ecbdesc_t *last = NULL;
96 bzero(pip, sizeof (dtrace_proginfo_t));
98 if (dt_list_next(&pgp->dp_stmts) != NULL) {
99 pip->dpi_descattr = _dtrace_maxattr;
100 pip->dpi_stmtattr = _dtrace_maxattr;
102 pip->dpi_descattr = _dtrace_defattr;
103 pip->dpi_stmtattr = _dtrace_defattr;
106 for (stp = dt_list_next(&pgp->dp_stmts); stp; stp = dt_list_next(stp)) {
107 dtrace_ecbdesc_t *edp = stp->ds_desc->dtsd_ecbdesc;
114 dt_attr_min(stp->ds_desc->dtsd_descattr, pip->dpi_descattr);
117 dt_attr_min(stp->ds_desc->dtsd_stmtattr, pip->dpi_stmtattr);
120 * If there aren't any actions, account for the fact that
121 * recording the epid will generate a record.
123 if (edp->dted_action == NULL)
126 for (ap = edp->dted_action; ap != NULL; ap = ap->dtad_next) {
127 if (ap->dtad_kind == DTRACEACT_SPECULATE) {
128 pip->dpi_speculations++;
132 if (DTRACEACT_ISAGG(ap->dtad_kind)) {
133 pip->dpi_recgens -= ap->dtad_arg;
134 pip->dpi_aggregates++;
138 if (DTRACEACT_ISDESTRUCTIVE(ap->dtad_kind))
141 if (ap->dtad_kind == DTRACEACT_DIFEXPR &&
142 ap->dtad_difo->dtdo_rtype.dtdt_kind ==
144 ap->dtad_difo->dtdo_rtype.dtdt_size == 0)
153 dtrace_program_exec(dtrace_hdl_t *dtp, dtrace_prog_t *pgp,
154 dtrace_proginfo_t *pip)
156 dtrace_enable_io_t args;
160 dtrace_program_info(dtp, pgp, pip);
162 if ((dof = dtrace_dof_create(dtp, pgp, DTRACE_D_STRIP)) == NULL)
167 n = dt_ioctl(dtp, DTRACEIOC_ENABLE, &args);
168 dtrace_dof_destroy(dtp, dof);
185 return (dt_set_errno(dtp, err));
189 pip->dpi_matches += args.n_matched;
195 dt_ecbdesc_hold(dtrace_ecbdesc_t *edp)
201 dt_ecbdesc_release(dtrace_hdl_t *dtp, dtrace_ecbdesc_t *edp)
203 if (--edp->dted_refcnt > 0)
206 dt_difo_free(dtp, edp->dted_pred.dtpdd_difo);
207 assert(edp->dted_action == NULL);
212 dt_ecbdesc_create(dtrace_hdl_t *dtp, const dtrace_probedesc_t *pdp)
214 dtrace_ecbdesc_t *edp;
216 if ((edp = dt_zalloc(dtp, sizeof (dtrace_ecbdesc_t))) == NULL) {
217 (void) dt_set_errno(dtp, EDT_NOMEM);
221 edp->dted_probe = *pdp;
222 dt_ecbdesc_hold(edp);
227 dtrace_stmt_create(dtrace_hdl_t *dtp, dtrace_ecbdesc_t *edp)
229 dtrace_stmtdesc_t *sdp;
231 if ((sdp = dt_zalloc(dtp, sizeof (dtrace_stmtdesc_t))) == NULL)
234 dt_ecbdesc_hold(edp);
235 sdp->dtsd_ecbdesc = edp;
236 sdp->dtsd_descattr = _dtrace_defattr;
237 sdp->dtsd_stmtattr = _dtrace_defattr;
243 dtrace_stmt_action(dtrace_hdl_t *dtp, dtrace_stmtdesc_t *sdp)
245 dtrace_actdesc_t *new;
246 dtrace_ecbdesc_t *edp = sdp->dtsd_ecbdesc;
248 if ((new = dt_alloc(dtp, sizeof (dtrace_actdesc_t))) == NULL)
251 if (sdp->dtsd_action_last != NULL) {
252 assert(sdp->dtsd_action != NULL);
253 assert(sdp->dtsd_action_last->dtad_next == NULL);
254 sdp->dtsd_action_last->dtad_next = new;
256 dtrace_actdesc_t *ap = edp->dted_action;
258 assert(sdp->dtsd_action == NULL);
259 sdp->dtsd_action = new;
261 while (ap != NULL && ap->dtad_next != NULL)
265 edp->dted_action = new;
270 sdp->dtsd_action_last = new;
271 bzero(new, sizeof (dtrace_actdesc_t));
272 new->dtad_uarg = (uintptr_t)sdp;
278 dtrace_stmt_add(dtrace_hdl_t *dtp, dtrace_prog_t *pgp, dtrace_stmtdesc_t *sdp)
280 dt_stmt_t *stp = dt_alloc(dtp, sizeof (dt_stmt_t));
283 return (-1); /* errno is set for us */
285 dt_list_append(&pgp->dp_stmts, stp);
292 dtrace_stmt_iter(dtrace_hdl_t *dtp, dtrace_prog_t *pgp,
293 dtrace_stmt_f *func, void *data)
295 dt_stmt_t *stp, *next;
298 for (stp = dt_list_next(&pgp->dp_stmts); stp != NULL; stp = next) {
299 next = dt_list_next(stp);
300 if ((status = func(dtp, pgp, stp->ds_desc, data)) != 0)
308 dtrace_stmt_destroy(dtrace_hdl_t *dtp, dtrace_stmtdesc_t *sdp)
310 dtrace_ecbdesc_t *edp = sdp->dtsd_ecbdesc;
313 * We need to remove any actions that we have on this ECB, and
314 * remove our hold on the ECB itself.
316 if (sdp->dtsd_action != NULL) {
317 dtrace_actdesc_t *last = sdp->dtsd_action_last;
318 dtrace_actdesc_t *ap, *next;
320 assert(last != NULL);
322 for (ap = edp->dted_action; ap != NULL; ap = ap->dtad_next) {
323 if (ap == sdp->dtsd_action)
326 if (ap->dtad_next == sdp->dtsd_action)
332 if (ap == edp->dted_action)
333 edp->dted_action = last->dtad_next;
335 ap->dtad_next = last->dtad_next;
338 * We have now removed our action list from its ECB; we can
339 * safely destroy the list.
341 last->dtad_next = NULL;
343 for (ap = sdp->dtsd_action; ap != NULL; ap = next) {
344 assert(ap->dtad_uarg == (uintptr_t)sdp);
345 dt_difo_free(dtp, ap->dtad_difo);
346 next = ap->dtad_next;
351 if (sdp->dtsd_fmtdata != NULL)
352 dt_printf_destroy(sdp->dtsd_fmtdata);
354 dt_ecbdesc_release(dtp, sdp->dtsd_ecbdesc);
358 typedef struct dt_header_info {
359 dtrace_hdl_t *dthi_dtp; /* consumer handle */
360 FILE *dthi_out; /* output file */
361 char *dthi_pmname; /* provider macro name */
362 char *dthi_pfname; /* provider function name */
363 int dthi_empty; /* should we generate empty macros */
367 dt_header_fmt_macro(char *buf, const char *str)
371 *buf++ = *str++ + 'A' - 'a';
372 } else if (*str == '-') {
375 } else if (*str == '.') {
378 } else if ((*buf++ = *str++) == '\0') {
385 dt_header_fmt_func(char *buf, const char *str)
392 } else if ((*buf++ = *str++) == '\0') {
400 dt_header_decl(dt_idhash_t *dhp, dt_ident_t *idp, void *data)
402 dt_header_info_t *infop = data;
403 dtrace_hdl_t *dtp = infop->dthi_dtp;
404 dt_probe_t *prp = idp->di_data;
406 char buf[DT_TYPE_NAMELEN];
412 for (i = 0; (p = strchr(p, '-')) != NULL; i++)
415 fname = alloca(strlen(prp->pr_name) + 1 + i);
416 dt_header_fmt_func(fname, prp->pr_name);
418 if (fprintf(infop->dthi_out, "extern void __dtrace_%s___%s(",
419 infop->dthi_pfname, fname) < 0)
420 return (dt_set_errno(dtp, errno));
422 for (dnp = prp->pr_nargs, i = 0; dnp != NULL; dnp = dnp->dn_list, i++) {
423 if (fprintf(infop->dthi_out, "%s",
424 ctf_type_name(dnp->dn_ctfp, dnp->dn_type,
425 buf, sizeof (buf))) < 0)
426 return (dt_set_errno(dtp, errno));
428 if (i + 1 != prp->pr_nargc &&
429 fprintf(infop->dthi_out, ", ") < 0)
430 return (dt_set_errno(dtp, errno));
433 if (i == 0 && fprintf(infop->dthi_out, "void") < 0)
434 return (dt_set_errno(dtp, errno));
436 if (fprintf(infop->dthi_out, ");\n") < 0)
437 return (dt_set_errno(dtp, errno));
439 if (fprintf(infop->dthi_out,
441 "extern int __dtraceenabled_%s___%s(void);\n"
443 "extern int __dtraceenabled_%s___%s(long);\n"
445 infop->dthi_pfname, fname, infop->dthi_pfname, fname) < 0)
446 return (dt_set_errno(dtp, errno));
453 dt_header_probe(dt_idhash_t *dhp, dt_ident_t *idp, void *data)
455 dt_header_info_t *infop = data;
456 dtrace_hdl_t *dtp = infop->dthi_dtp;
457 dt_probe_t *prp = idp->di_data;
463 for (i = 0; (p = strchr(p, '-')) != NULL; i++)
466 mname = alloca(strlen(prp->pr_name) + 1);
467 dt_header_fmt_macro(mname, prp->pr_name);
469 fname = alloca(strlen(prp->pr_name) + 1 + i);
470 dt_header_fmt_func(fname, prp->pr_name);
472 if (fprintf(infop->dthi_out, "#define\t%s_%s(",
473 infop->dthi_pmname, mname) < 0)
474 return (dt_set_errno(dtp, errno));
476 for (i = 0; i < prp->pr_nargc; i++) {
477 if (fprintf(infop->dthi_out, "arg%d", i) < 0)
478 return (dt_set_errno(dtp, errno));
480 if (i + 1 != prp->pr_nargc &&
481 fprintf(infop->dthi_out, ", ") < 0)
482 return (dt_set_errno(dtp, errno));
485 if (!infop->dthi_empty) {
486 if (fprintf(infop->dthi_out, ") \\\n\t") < 0)
487 return (dt_set_errno(dtp, errno));
489 if (fprintf(infop->dthi_out, "__dtrace_%s___%s(",
490 infop->dthi_pfname, fname) < 0)
491 return (dt_set_errno(dtp, errno));
493 for (i = 0; i < prp->pr_nargc; i++) {
494 if (fprintf(infop->dthi_out, "arg%d", i) < 0)
495 return (dt_set_errno(dtp, errno));
497 if (i + 1 != prp->pr_nargc &&
498 fprintf(infop->dthi_out, ", ") < 0)
499 return (dt_set_errno(dtp, errno));
503 if (fprintf(infop->dthi_out, ")\n") < 0)
504 return (dt_set_errno(dtp, errno));
506 if (!infop->dthi_empty) {
507 if (fprintf(infop->dthi_out,
509 "#define\t%s_%s_ENABLED() \\\n"
510 "\t__dtraceenabled_%s___%s()\n"
512 "#define\t%s_%s_ENABLED() \\\n"
513 "\t__dtraceenabled_%s___%s(0)\n"
515 infop->dthi_pmname, mname,
516 infop->dthi_pfname, fname,
517 infop->dthi_pmname, mname,
518 infop->dthi_pfname, fname) < 0)
519 return (dt_set_errno(dtp, errno));
522 if (fprintf(infop->dthi_out, "#define\t%s_%s_ENABLED() (0)\n",
523 infop->dthi_pmname, mname) < 0)
524 return (dt_set_errno(dtp, errno));
531 dt_header_provider(dtrace_hdl_t *dtp, dt_provider_t *pvp, FILE *out)
533 dt_header_info_t info;
537 if (pvp->pv_flags & DT_PROVIDER_IMPL)
541 * Count the instances of the '-' character since we'll need to double
544 p = pvp->pv_desc.dtvd_name;
545 for (i = 0; (p = strchr(p, '-')) != NULL; i++)
552 info.dthi_pmname = alloca(strlen(pvp->pv_desc.dtvd_name) + 1);
553 dt_header_fmt_macro(info.dthi_pmname, pvp->pv_desc.dtvd_name);
555 info.dthi_pfname = alloca(strlen(pvp->pv_desc.dtvd_name) + 1 + i);
556 dt_header_fmt_func(info.dthi_pfname, pvp->pv_desc.dtvd_name);
558 if (fprintf(out, "#if _DTRACE_VERSION\n\n") < 0)
559 return (dt_set_errno(dtp, errno));
561 if (dt_idhash_iter(pvp->pv_probes, dt_header_probe, &info) != 0)
562 return (-1); /* dt_errno is set for us */
563 if (fprintf(out, "\n\n") < 0)
564 return (dt_set_errno(dtp, errno));
565 if (dt_idhash_iter(pvp->pv_probes, dt_header_decl, &info) != 0)
566 return (-1); /* dt_errno is set for us */
568 if (fprintf(out, "\n#else\n\n") < 0)
569 return (dt_set_errno(dtp, errno));
573 if (dt_idhash_iter(pvp->pv_probes, dt_header_probe, &info) != 0)
574 return (-1); /* dt_errno is set for us */
576 if (fprintf(out, "\n#endif\n\n") < 0)
577 return (dt_set_errno(dtp, errno));
583 dtrace_program_header(dtrace_hdl_t *dtp, FILE *out, const char *fname)
589 if ((p = strrchr(fname, '/')) != NULL)
592 mfname = alloca(strlen(fname) + 1);
593 dt_header_fmt_macro(mfname, fname);
594 if (fprintf(out, "#ifndef\t_%s\n#define\t_%s\n\n",
596 return (dt_set_errno(dtp, errno));
599 if (fprintf(out, "#include <unistd.h>\n\n") < 0)
602 if (fprintf(out, "#ifdef\t__cplusplus\nextern \"C\" {\n#endif\n\n") < 0)
605 for (pvp = dt_list_next(&dtp->dt_provlist);
606 pvp != NULL; pvp = dt_list_next(pvp)) {
607 if (dt_header_provider(dtp, pvp, out) != 0)
608 return (-1); /* dt_errno is set for us */
611 if (fprintf(out, "\n#ifdef\t__cplusplus\n}\n#endif\n") < 0)
612 return (dt_set_errno(dtp, errno));
614 if (fname != NULL && fprintf(out, "\n#endif\t/* _%s */\n", mfname) < 0)
615 return (dt_set_errno(dtp, errno));