usr/src/lib/libdtrace/common/dt_handle.c

   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 2007 Sun Microsystems, Inc.  All rights reserved.
  23  * Use is subject to license terms.
  24  */
  25
  26
  27 #include <stddef.h>
  28 #include <stdlib.h>
  29 #include <strings.h>
  30 #include <errno.h>
  31 #include <unistd.h>
  32 #include <assert.h>
  33 #include <alloca.h>
  34
  35 #include <dt_impl.h>
  36 #include <dt_program.h>
  37
  38 static const char _dt_errprog[] =
  39 "dtrace:::ERROR"
  40 "{"
  41 "       trace(arg1);"
  42 "       trace(arg2);"
  43 "       trace(arg3);"
  44 "       trace(arg4);"
  45 "       trace(arg5);"
  46 "}";
  47
  48 int
  49 dtrace_handle_err(dtrace_hdl_t *dtp, dtrace_handle_err_f *hdlr, void *arg)
  50 {
  51         dtrace_prog_t *pgp = NULL;
  52         dt_stmt_t *stp;
  53         dtrace_ecbdesc_t *edp;
  54
  55         /*
  56          * We don't currently support multiple error handlers.
  57          */
  58         if (dtp->dt_errhdlr != NULL)
  59                 return (dt_set_errno(dtp, EALREADY));
  60
  61         /*
  62          * If the DTRACEOPT_GRABANON is enabled, the anonymous enabling will
  63          * already have a dtrace:::ERROR probe enabled; save 'hdlr' and 'arg'
  64          * but do not bother compiling and enabling _dt_errprog.
  65          */
  66         if (dtp->dt_options[DTRACEOPT_GRABANON] != DTRACEOPT_UNSET)
  67                 goto out;
  68
  69         if ((pgp = dtrace_program_strcompile(dtp, _dt_errprog,
  70             DTRACE_PROBESPEC_NAME, DTRACE_C_ZDEFS, 0, NULL)) == NULL)
  71                 return (dt_set_errno(dtp, dtrace_errno(dtp)));
  72
  73         stp = dt_list_next(&pgp->dp_stmts);
  74         assert(stp != NULL);
  75
  76         edp = stp->ds_desc->dtsd_ecbdesc;
  77         assert(edp != NULL);
  78         edp->dted_uarg = DT_ECB_ERROR;
  79
  80 out:
  81         dtp->dt_errhdlr = hdlr;
  82         dtp->dt_errarg = arg;
  83         dtp->dt_errprog = pgp;
  84
  85         return (0);
  86 }
  87
  88 int
  89 dtrace_handle_drop(dtrace_hdl_t *dtp, dtrace_handle_drop_f *hdlr, void *arg)
  90 {
  91         if (dtp->dt_drophdlr != NULL)
  92                 return (dt_set_errno(dtp, EALREADY));
  93
  94         dtp->dt_drophdlr = hdlr;
  95         dtp->dt_droparg = arg;
  96
  97         return (0);
  98 }
  99
 100 int
 101 dtrace_handle_proc(dtrace_hdl_t *dtp, dtrace_handle_proc_f *hdlr, void *arg)
 102 {
 103         if (dtp->dt_prochdlr != NULL)
 104                 return (dt_set_errno(dtp, EALREADY));
 105
 106         dtp->dt_prochdlr = hdlr;
 107         dtp->dt_procarg = arg;
 108
 109         return (0);
 110 }
 111
 112 int
 113 dtrace_handle_buffered(dtrace_hdl_t *dtp, dtrace_handle_buffered_f *hdlr,
 114     void *arg)
 115 {
 116         if (dtp->dt_bufhdlr != NULL)
 117                 return (dt_set_errno(dtp, EALREADY));
 118
 119         if (hdlr == NULL)
 120                 return (dt_set_errno(dtp, EINVAL));
 121
 122         dtp->dt_bufhdlr = hdlr;
 123         dtp->dt_bufarg = arg;
 124
 125         return (0);
 126 }
 127
 128 int
 129 dtrace_handle_setopt(dtrace_hdl_t *dtp, dtrace_handle_setopt_f *hdlr,
 130     void *arg)
 131 {
 132         if (hdlr == NULL)
 133                 return (dt_set_errno(dtp, EINVAL));
 134
 135         dtp->dt_setopthdlr = hdlr;
 136         dtp->dt_setoptarg = arg;
 137
 138         return (0);
 139 }
 140
 141 #define DT_REC(type, ndx) *((type *)((uintptr_t)data->dtpda_data + \
 142     epd->dtepd_rec[(ndx)].dtrd_offset))
 143
 144 static int
 145 dt_handle_err(dtrace_hdl_t *dtp, dtrace_probedata_t *data)
 146 {
 147         dtrace_eprobedesc_t *epd = data->dtpda_edesc, *errepd;
 148         dtrace_probedesc_t *pd = data->dtpda_pdesc, *errpd;
 149         dtrace_errdata_t err;
 150         dtrace_epid_t epid;
 151
 152         char where[30];
 153         char details[30];
 154         char offinfo[30];
 155         const int slop = 80;
 156         const char *faultstr;
 157         char *str;
 158         int len;
 159
 160         assert(epd->dtepd_uarg == DT_ECB_ERROR);
 161
 162         if (epd->dtepd_nrecs != 5 || strcmp(pd->dtpd_provider, "dtrace") != 0 ||
 163             strcmp(pd->dtpd_name, "ERROR") != 0)
 164                 return (dt_set_errno(dtp, EDT_BADERROR));
 165
 166         /*
 167          * This is an error.  We have the following items here:  EPID,
 168          * faulting action, DIF offset, fault code and faulting address.
 169          */
 170         epid = (uint32_t)DT_REC(uint64_t, 0);
 171
 172         if (dt_epid_lookup(dtp, epid, &errepd, &errpd) != 0)
 173                 return (dt_set_errno(dtp, EDT_BADERROR));
 174
 175         err.dteda_edesc = errepd;
 176         err.dteda_pdesc = errpd;
 177         err.dteda_cpu = data->dtpda_cpu;
 178         err.dteda_action = (int)DT_REC(uint64_t, 1);
 179         err.dteda_offset = (int)DT_REC(uint64_t, 2);
 180         err.dteda_fault = (int)DT_REC(uint64_t, 3);
 181         err.dteda_addr = DT_REC(uint64_t, 4);
 182
 183         faultstr = dtrace_faultstr(dtp, err.dteda_fault);
 184         len = sizeof (where) + sizeof (offinfo) + strlen(faultstr) +
 185             strlen(errpd->dtpd_provider) + strlen(errpd->dtpd_mod) +
 186             strlen(errpd->dtpd_name) + strlen(errpd->dtpd_func) +
 187             slop;
 188
 189         str = (char *)alloca(len);
 190
 191         if (err.dteda_action == 0) {
 192                 (void) sprintf(where, "predicate");
 193         } else {
 194                 (void) sprintf(where, "action #%d", err.dteda_action);
 195         }
 196
 197         if (err.dteda_offset != -1) {
 198                 (void) sprintf(offinfo, " at DIF offset %d", err.dteda_offset);
 199         } else {
 200                 offinfo[0] = 0;
 201         }
 202
 203         switch (err.dteda_fault) {
 204         case DTRACEFLT_BADADDR:
 205         case DTRACEFLT_BADALIGN:
 206         case DTRACEFLT_BADSTACK:
 207                 (void) sprintf(details, " (0x%llx)",
 208                     (u_longlong_t)err.dteda_addr);
 209                 break;
 210
 211         default:
 212                 details[0] = 0;
 213         }
 214
 215         (void) snprintf(str, len, "error on enabled probe ID %u "
 216             "(ID %u: %s:%s:%s:%s): %s%s in %s%s\n",
 217             epid, errpd->dtpd_id, errpd->dtpd_provider,
 218             errpd->dtpd_mod, errpd->dtpd_func,
 219             errpd->dtpd_name, dtrace_faultstr(dtp, err.dteda_fault),
 220             details, where, offinfo);
 221
 222         err.dteda_msg = str;
 223
 224         if (dtp->dt_errhdlr == NULL)
 225                 return (dt_set_errno(dtp, EDT_ERRABORT));
 226
 227         if ((*dtp->dt_errhdlr)(&err, dtp->dt_errarg) == DTRACE_HANDLE_ABORT)
 228                 return (dt_set_errno(dtp, EDT_ERRABORT));
 229
 230         return (0);
 231 }
 232
 233 int
 234 dt_handle_liberr(dtrace_hdl_t *dtp, const dtrace_probedata_t *data,
 235     const char *faultstr)
 236 {
 237         dtrace_probedesc_t *errpd = data->dtpda_pdesc;
 238         dtrace_errdata_t err;
 239         const int slop = 80;
 240         char *str;
 241         int len;
 242
 243         err.dteda_edesc = data->dtpda_edesc;
 244         err.dteda_pdesc = errpd;
 245         err.dteda_cpu = data->dtpda_cpu;
 246         err.dteda_action = -1;
 247         err.dteda_offset = -1;
 248         err.dteda_fault = DTRACEFLT_LIBRARY;
 249         err.dteda_addr = (uintptr_t)NULL;
 250
 251         len = strlen(faultstr) +
 252             strlen(errpd->dtpd_provider) + strlen(errpd->dtpd_mod) +
 253             strlen(errpd->dtpd_name) + strlen(errpd->dtpd_func) +
 254             slop;
 255
 256         str = alloca(len);
 257
 258         (void) snprintf(str, len, "error on enabled probe ID %u "
 259             "(ID %u: %s:%s:%s:%s): %s\n",
 260             data->dtpda_edesc->dtepd_epid,
 261             errpd->dtpd_id, errpd->dtpd_provider,
 262             errpd->dtpd_mod, errpd->dtpd_func,
 263             errpd->dtpd_name, faultstr);
 264
 265         err.dteda_msg = str;
 266
 267         if (dtp->dt_errhdlr == NULL)
 268                 return (dt_set_errno(dtp, EDT_ERRABORT));
 269
 270         if ((*dtp->dt_errhdlr)(&err, dtp->dt_errarg) == DTRACE_HANDLE_ABORT)
 271                 return (dt_set_errno(dtp, EDT_ERRABORT));
 272
 273         return (0);
 274 }
 275
 276 #define DROPTAG(x)      x, #x
 277
 278 static const struct {
 279         dtrace_dropkind_t dtdrg_kind;
 280         char *dtdrg_tag;
 281 } _dt_droptags[] = {
 282         { DROPTAG(DTRACEDROP_PRINCIPAL) },
 283         { DROPTAG(DTRACEDROP_AGGREGATION) },
 284         { DROPTAG(DTRACEDROP_DYNAMIC) },
 285         { DROPTAG(DTRACEDROP_DYNRINSE) },
 286         { DROPTAG(DTRACEDROP_DYNDIRTY) },
 287         { DROPTAG(DTRACEDROP_SPEC) },
 288         { DROPTAG(DTRACEDROP_SPECBUSY) },
 289         { DROPTAG(DTRACEDROP_SPECUNAVAIL) },
 290         { DROPTAG(DTRACEDROP_DBLERROR) },
 291         { DROPTAG(DTRACEDROP_STKSTROVERFLOW) },
 292         { 0, NULL }
 293 };
 294
 295 static const char *
 296 dt_droptag(dtrace_dropkind_t kind)
 297 {
 298         int i;
 299
 300         for (i = 0; _dt_droptags[i].dtdrg_tag != NULL; i++) {
 301                 if (_dt_droptags[i].dtdrg_kind == kind)
 302                         return (_dt_droptags[i].dtdrg_tag);
 303         }
 304
 305         return ("DTRACEDROP_UNKNOWN");
 306 }
 307
 308 int
 309 dt_handle_cpudrop(dtrace_hdl_t *dtp, processorid_t cpu,
 310     dtrace_dropkind_t what, uint64_t howmany)
 311 {
 312         dtrace_dropdata_t drop;
 313         char str[80], *s;
 314         int size;
 315
 316         assert(what == DTRACEDROP_PRINCIPAL || what == DTRACEDROP_AGGREGATION);
 317
 318         bzero(&drop, sizeof (drop));
 319         drop.dtdda_handle = dtp;
 320         drop.dtdda_cpu = cpu;
 321         drop.dtdda_kind = what;
 322         drop.dtdda_drops = howmany;
 323         drop.dtdda_msg = str;
 324
 325         if (dtp->dt_droptags) {
 326                 (void) snprintf(str, sizeof (str), "[%s] ", dt_droptag(what));
 327                 s = &str[strlen(str)];
 328                 size = sizeof (str) - (s - str);
 329         } else {
 330                 s = str;
 331                 size = sizeof (str);
 332         }
 333
 334         (void) snprintf(s, size, "%llu %sdrop%s on CPU %d\n",
 335             howmany, what == DTRACEDROP_PRINCIPAL ? "" : "aggregation ",
 336             howmany > 1 ? "s" : "", cpu);
 337
 338         if (dtp->dt_drophdlr == NULL)
 339                 return (dt_set_errno(dtp, EDT_DROPABORT));
 340
 341         if ((*dtp->dt_drophdlr)(&drop, dtp->dt_droparg) == DTRACE_HANDLE_ABORT)
 342                 return (dt_set_errno(dtp, EDT_DROPABORT));
 343
 344         return (0);
 345 }
 346
 347 static const struct {
 348         dtrace_dropkind_t dtdrt_kind;
 349         uintptr_t dtdrt_offset;
 350         const char *dtdrt_str;
 351         const char *dtdrt_msg;
 352 } _dt_droptab[] = {
 353         { DTRACEDROP_DYNAMIC,
 354             offsetof(dtrace_status_t, dtst_dyndrops),
 355             "dynamic variable drop" },
 356
 357         { DTRACEDROP_DYNRINSE,
 358             offsetof(dtrace_status_t, dtst_dyndrops_rinsing),
 359             "dynamic variable drop", " with non-empty rinsing list" },
 360
 361         { DTRACEDROP_DYNDIRTY,
 362             offsetof(dtrace_status_t, dtst_dyndrops_dirty),
 363             "dynamic variable drop", " with non-empty dirty list" },
 364
 365         { DTRACEDROP_SPEC,
 366             offsetof(dtrace_status_t, dtst_specdrops),
 367             "speculative drop" },
 368
 369         { DTRACEDROP_SPECBUSY,
 370             offsetof(dtrace_status_t, dtst_specdrops_busy),
 371             "failed speculation", " (available buffer(s) still busy)" },
 372
 373         { DTRACEDROP_SPECUNAVAIL,
 374             offsetof(dtrace_status_t, dtst_specdrops_unavail),
 375             "failed speculation", " (no speculative buffer available)" },
 376
 377         { DTRACEDROP_STKSTROVERFLOW,
 378             offsetof(dtrace_status_t, dtst_stkstroverflows),
 379             "jstack()/ustack() string table overflow" },
 380
 381         { DTRACEDROP_DBLERROR,
 382             offsetof(dtrace_status_t, dtst_dblerrors),
 383             "error", " in ERROR probe enabling" },
 384
 385         { 0, 0, NULL }
 386 };
 387
 388 int
 389 dt_handle_status(dtrace_hdl_t *dtp, dtrace_status_t *old, dtrace_status_t *new)
 390 {
 391         dtrace_dropdata_t drop;
 392         char str[80], *s;
 393         uintptr_t base = (uintptr_t)new, obase = (uintptr_t)old;
 394         int i, size;
 395
 396         bzero(&drop, sizeof (drop));
 397         drop.dtdda_handle = dtp;
 398         drop.dtdda_cpu = DTRACE_CPUALL;
 399         drop.dtdda_msg = str;
 400
 401         /*
 402          * First, check to see if we've been killed -- in which case we abort.
 403          */
 404         if (new->dtst_killed && !old->dtst_killed)
 405                 return (dt_set_errno(dtp, EDT_BRICKED));
 406
 407         for (i = 0; _dt_droptab[i].dtdrt_str != NULL; i++) {
 408                 uintptr_t naddr = base + _dt_droptab[i].dtdrt_offset;
 409                 uintptr_t oaddr = obase + _dt_droptab[i].dtdrt_offset;
 410
 411                 uint64_t nval = *((uint64_t *)naddr);
 412                 uint64_t oval = *((uint64_t *)oaddr);
 413
 414                 if (nval == oval)
 415                         continue;
 416
 417                 if (dtp->dt_droptags) {
 418                         (void) snprintf(str, sizeof (str), "[%s] ",
 419                             dt_droptag(_dt_droptab[i].dtdrt_kind));
 420                         s = &str[strlen(str)];
 421                         size = sizeof (str) - (s - str);
 422                 } else {
 423                         s = str;
 424                         size = sizeof (str);
 425                 }
 426
 427                 (void) snprintf(s, size, "%llu %s%s%s\n", nval - oval,
 428                     _dt_droptab[i].dtdrt_str, (nval - oval > 1) ? "s" : "",
 429                     _dt_droptab[i].dtdrt_msg != NULL ?
 430                     _dt_droptab[i].dtdrt_msg : "");
 431
 432                 drop.dtdda_kind = _dt_droptab[i].dtdrt_kind;
 433                 drop.dtdda_total = nval;
 434                 drop.dtdda_drops = nval - oval;
 435
 436                 if (dtp->dt_drophdlr == NULL)
 437                         return (dt_set_errno(dtp, EDT_DROPABORT));
 438
 439                 if ((*dtp->dt_drophdlr)(&drop,
 440                     dtp->dt_droparg) == DTRACE_HANDLE_ABORT)
 441                         return (dt_set_errno(dtp, EDT_DROPABORT));
 442         }
 443
 444         return (0);
 445 }
 446
 447 int
 448 dt_handle_setopt(dtrace_hdl_t *dtp, dtrace_setoptdata_t *data)
 449 {
 450         void *arg = dtp->dt_setoptarg;
 451
 452         if (dtp->dt_setopthdlr == NULL)
 453                 return (0);
 454
 455         if ((*dtp->dt_setopthdlr)(data, arg) == DTRACE_HANDLE_ABORT)
 456                 return (dt_set_errno(dtp, EDT_DIRABORT));
 457
 458         return (0);
 459 }
 460
 461 int
 462 dt_handle(dtrace_hdl_t *dtp, dtrace_probedata_t *data)
 463 {
 464         dtrace_eprobedesc_t *epd = data->dtpda_edesc;
 465         int rval;
 466
 467         switch (epd->dtepd_uarg) {
 468         case DT_ECB_ERROR:
 469                 rval = dt_handle_err(dtp, data);
 470                 break;
 471
 472         default:
 473                 return (DTRACE_CONSUME_THIS);
 474         }
 475
 476         if (rval == 0)
 477                 return (DTRACE_CONSUME_NEXT);
 478
 479         return (DTRACE_CONSUME_ERROR);
 480 }