sys/kern/kern_ktrace.c

   1 /*
   2  * Copyright (c) 1989, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)kern_ktrace.c       8.2 (Berkeley) 9/23/93
  34  * $FreeBSD: src/sys/kern/kern_ktrace.c,v 1.35.2.6 2002/07/05 22:36:38 darrenr Exp $
  35  * $DragonFly: src/sys/kern/kern_ktrace.c,v 1.10 2003/09/23 05:03:51 dillon Exp $
  36  */
  37
  38 #include "opt_ktrace.h"
  39
  40 #include <sys/param.h>
  41 #include <sys/systm.h>
  42 #include <sys/sysproto.h>
  43 #include <sys/kernel.h>
  44 #include <sys/proc.h>
  45 #include <sys/fcntl.h>
  46 #include <sys/lock.h>
  47 #include <sys/namei.h>
  48 #include <sys/vnode.h>
  49 #include <sys/ktrace.h>
  50 #include <sys/malloc.h>
  51 #include <sys/syslog.h>
  52 #include <sys/sysent.h>
  53
  54 #include <vm/vm_zone.h>
  55 static MALLOC_DEFINE(M_KTRACE, "KTRACE", "KTRACE");
  56
  57 #ifdef KTRACE
  58 static struct ktr_header *ktrgetheader (int type);
  59 static void ktrwrite (struct vnode *, struct ktr_header *, struct uio *);
  60 static int ktrcanset (struct proc *,struct proc *);
  61 static int ktrsetchildren (struct proc *,struct proc *,int,int,struct vnode *);
  62 static int ktrops (struct proc *,struct proc *,int,int,struct vnode *);
  63
  64
  65 static struct ktr_header *
  66 ktrgetheader(type)
  67         int type;
  68 {
  69         struct ktr_header *kth;
  70         struct proc *p = curproc;       /* XXX */
  71
  72         MALLOC(kth, struct ktr_header *, sizeof (struct ktr_header),
  73                 M_KTRACE, M_WAITOK);
  74         kth->ktr_type = type;
  75         microtime(&kth->ktr_time);
  76         kth->ktr_pid = p->p_pid;
  77         bcopy(p->p_comm, kth->ktr_comm, MAXCOMLEN + 1);
  78         return (kth);
  79 }
  80
  81 void
  82 ktrsyscall(vp, code, narg, args)
  83         struct vnode *vp;
  84         int code, narg;
  85         register_t args[];
  86 {
  87         struct  ktr_header *kth;
  88         struct  ktr_syscall *ktp;
  89         int len = offsetof(struct ktr_syscall, ktr_args) +
  90             (narg * sizeof(register_t));
  91         struct proc *p = curproc;       /* XXX */
  92         register_t *argp;
  93         int i;
  94
  95         p->p_traceflag |= KTRFAC_ACTIVE;
  96         kth = ktrgetheader(KTR_SYSCALL);
  97         MALLOC(ktp, struct ktr_syscall *, len, M_KTRACE, M_WAITOK);
  98         ktp->ktr_code = code;
  99         ktp->ktr_narg = narg;
 100         argp = &ktp->ktr_args[0];
 101         for (i = 0; i < narg; i++)
 102                 *argp++ = args[i];
 103         kth->ktr_buf = (caddr_t)ktp;
 104         kth->ktr_len = len;
 105         ktrwrite(vp, kth, NULL);
 106         FREE(ktp, M_KTRACE);
 107         FREE(kth, M_KTRACE);
 108         p->p_traceflag &= ~KTRFAC_ACTIVE;
 109 }
 110
 111 void
 112 ktrsysret(vp, code, error, retval)
 113         struct vnode *vp;
 114         int code, error;
 115         register_t retval;
 116 {
 117         struct ktr_header *kth;
 118         struct ktr_sysret ktp;
 119         struct proc *p = curproc;       /* XXX */
 120
 121         p->p_traceflag |= KTRFAC_ACTIVE;
 122         kth = ktrgetheader(KTR_SYSRET);
 123         ktp.ktr_code = code;
 124         ktp.ktr_error = error;
 125         ktp.ktr_retval = retval;                /* what about val2 ? */
 126
 127         kth->ktr_buf = (caddr_t)&ktp;
 128         kth->ktr_len = sizeof(struct ktr_sysret);
 129
 130         ktrwrite(vp, kth, NULL);
 131         FREE(kth, M_KTRACE);
 132         p->p_traceflag &= ~KTRFAC_ACTIVE;
 133 }
 134
 135 void
 136 ktrnamei(vp, path)
 137         struct vnode *vp;
 138         char *path;
 139 {
 140         struct ktr_header *kth;
 141         struct proc *p = curproc;       /* XXX */
 142
 143         /*
 144          * don't let vp get ripped out from under us
 145          */
 146         if (vp)
 147                 VREF(vp);
 148         p->p_traceflag |= KTRFAC_ACTIVE;
 149         kth = ktrgetheader(KTR_NAMEI);
 150         kth->ktr_len = strlen(path);
 151         kth->ktr_buf = path;
 152
 153         ktrwrite(vp, kth, NULL);
 154         if (vp)
 155                 vrele(vp);
 156         FREE(kth, M_KTRACE);
 157         p->p_traceflag &= ~KTRFAC_ACTIVE;
 158 }
 159
 160 void
 161 ktrgenio(vp, fd, rw, uio, error)
 162         struct vnode *vp;
 163         int fd;
 164         enum uio_rw rw;
 165         struct uio *uio;
 166         int error;
 167 {
 168         struct ktr_header *kth;
 169         struct ktr_genio ktg;
 170         struct proc *p = curproc;       /* XXX */
 171
 172         if (error)
 173                 return;
 174         /*
 175          * don't let p_tracep get ripped out from under us
 176          */
 177         if (vp)
 178                 VREF(vp);
 179         p->p_traceflag |= KTRFAC_ACTIVE;
 180         kth = ktrgetheader(KTR_GENIO);
 181         ktg.ktr_fd = fd;
 182         ktg.ktr_rw = rw;
 183         kth->ktr_buf = (caddr_t)&ktg;
 184         kth->ktr_len = sizeof(struct ktr_genio);
 185         uio->uio_offset = 0;
 186         uio->uio_rw = UIO_WRITE;
 187
 188         ktrwrite(vp, kth, uio);
 189         if (vp)
 190                 vrele(vp);
 191         FREE(kth, M_KTRACE);
 192         p->p_traceflag &= ~KTRFAC_ACTIVE;
 193 }
 194
 195 void
 196 ktrpsig(vp, sig, action, mask, code)
 197         struct vnode *vp;
 198         int sig;
 199         sig_t action;
 200         sigset_t *mask;
 201         int code;
 202 {
 203         struct ktr_header *kth;
 204         struct ktr_psig kp;
 205         struct proc *p = curproc;       /* XXX */
 206
 207         /*
 208          * don't let vp get ripped out from under us
 209          */
 210         if (vp)
 211                 VREF(vp);
 212         p->p_traceflag |= KTRFAC_ACTIVE;
 213         kth = ktrgetheader(KTR_PSIG);
 214         kp.signo = (char)sig;
 215         kp.action = action;
 216         kp.mask = *mask;
 217         kp.code = code;
 218         kth->ktr_buf = (caddr_t)&kp;
 219         kth->ktr_len = sizeof (struct ktr_psig);
 220
 221         ktrwrite(vp, kth, NULL);
 222         if (vp)
 223                 vrele(vp);
 224         FREE(kth, M_KTRACE);
 225         p->p_traceflag &= ~KTRFAC_ACTIVE;
 226 }
 227
 228 void
 229 ktrcsw(vp, out, user)
 230         struct vnode *vp;
 231         int out, user;
 232 {
 233         struct ktr_header *kth;
 234         struct  ktr_csw kc;
 235         struct proc *p = curproc;       /* XXX */
 236
 237         /*
 238          * don't let vp get ripped out from under us
 239          */
 240         if (vp)
 241                 VREF(vp);
 242         p->p_traceflag |= KTRFAC_ACTIVE;
 243         kth = ktrgetheader(KTR_CSW);
 244         kc.out = out;
 245         kc.user = user;
 246         kth->ktr_buf = (caddr_t)&kc;
 247         kth->ktr_len = sizeof (struct ktr_csw);
 248
 249         ktrwrite(vp, kth, NULL);
 250         if (vp)
 251                 vrele(vp);
 252         FREE(kth, M_KTRACE);
 253         p->p_traceflag &= ~KTRFAC_ACTIVE;
 254 }
 255 #endif
 256
 257 /* Interface and common routines */
 258
 259 /*
 260  * ktrace system call
 261  */
 262 /* ARGSUSED */
 263 int
 264 ktrace(struct ktrace_args *uap)
 265 {
 266 #ifdef KTRACE
 267         struct thread *td = curthread;
 268         struct proc *curp = td->td_proc;
 269         struct vnode *vp = NULL;
 270         struct proc *p;
 271         struct pgrp *pg;
 272         int facs = uap->facs & ~KTRFAC_ROOT;
 273         int ops = KTROP(uap->ops);
 274         int descend = uap->ops & KTRFLAG_DESCEND;
 275         int ret = 0;
 276         int error = 0;
 277         struct nameidata nd;
 278
 279         curp->p_traceflag |= KTRFAC_ACTIVE;
 280         if (ops != KTROP_CLEAR) {
 281                 /*
 282                  * an operation which requires a file argument.
 283                  */
 284                 NDINIT(&nd, NAMEI_LOOKUP, CNP_NOFOLLOW, UIO_USERSPACE,
 285                     uap->fname, td);
 286                 error = vn_open(&nd, FREAD|FWRITE|O_NOFOLLOW, 0);
 287                 if (error) {
 288                         curp->p_traceflag &= ~KTRFAC_ACTIVE;
 289                         return (error);
 290                 }
 291                 NDFREE(&nd, NDF_ONLY_PNBUF);
 292                 vp = nd.ni_vp;
 293                 VOP_UNLOCK(vp, 0, td);
 294                 if (vp->v_type != VREG) {
 295                         (void) vn_close(vp, FREAD|FWRITE, td);
 296                         curp->p_traceflag &= ~KTRFAC_ACTIVE;
 297                         return (EACCES);
 298                 }
 299         }
 300         /*
 301          * Clear all uses of the tracefile.  XXX umm, what happens to the
 302          * loop if vn_close() blocks?
 303          */
 304         if (ops == KTROP_CLEARFILE) {
 305                 FOREACH_PROC_IN_SYSTEM(p) {
 306                         if (p->p_tracep == vp) {
 307                                 if (ktrcanset(curp, p) && p->p_tracep == vp) {
 308                                         p->p_tracep = NULL;
 309                                         p->p_traceflag = 0;
 310                                         (void) vn_close(vp, FREAD|FWRITE, td);
 311                                 } else {
 312                                         error = EPERM;
 313                                 }
 314                         }
 315                 }
 316                 goto done;
 317         }
 318         /*
 319          * need something to (un)trace (XXX - why is this here?)
 320          */
 321         if (!facs) {
 322                 error = EINVAL;
 323                 goto done;
 324         }
 325         /*
 326          * do it
 327          */
 328         if (uap->pid < 0) {
 329                 /*
 330                  * by process group
 331                  */
 332                 pg = pgfind(-uap->pid);
 333                 if (pg == NULL) {
 334                         error = ESRCH;
 335                         goto done;
 336                 }
 337                 LIST_FOREACH(p, &pg->pg_members, p_pglist)
 338                         if (descend)
 339                                 ret |= ktrsetchildren(curp, p, ops, facs, vp);
 340                         else
 341                                 ret |= ktrops(curp, p, ops, facs, vp);
 342
 343         } else {
 344                 /*
 345                  * by pid
 346                  */
 347                 p = pfind(uap->pid);
 348                 if (p == NULL) {
 349                         error = ESRCH;
 350                         goto done;
 351                 }
 352                 if (descend)
 353                         ret |= ktrsetchildren(curp, p, ops, facs, vp);
 354                 else
 355                         ret |= ktrops(curp, p, ops, facs, vp);
 356         }
 357         if (!ret)
 358                 error = EPERM;
 359 done:
 360         if (vp != NULL)
 361                 (void) vn_close(vp, FWRITE, td);
 362         curp->p_traceflag &= ~KTRFAC_ACTIVE;
 363         return (error);
 364 #else
 365         return ENOSYS;
 366 #endif
 367 }
 368
 369 /*
 370  * utrace system call
 371  */
 372 /* ARGSUSED */
 373 int
 374 utrace(struct utrace_args *uap)
 375 {
 376 #ifdef KTRACE
 377         struct ktr_header *kth;
 378         struct thread *td = curthread;  /* XXX */
 379         struct proc *p = td->td_proc;
 380         struct vnode *vp;
 381         caddr_t cp;
 382
 383         if (!KTRPOINT(td, KTR_USER))
 384                 return (0);
 385         if (SCARG(uap, len) > KTR_USER_MAXLEN)
 386                 return (EINVAL);
 387         p->p_traceflag |= KTRFAC_ACTIVE;
 388         /*
 389          * don't let p_tracep get ripped out from under us while we are
 390          * writing.
 391          */
 392         if ((vp = p->p_tracep) != NULL)
 393                 VREF(vp);
 394         kth = ktrgetheader(KTR_USER);
 395         MALLOC(cp, caddr_t, uap->len, M_KTRACE, M_WAITOK);
 396         if (!copyin(uap->addr, cp, uap->len)) {
 397                 kth->ktr_buf = cp;
 398                 kth->ktr_len = uap->len;
 399                 ktrwrite(vp, kth, NULL);
 400         }
 401         if (vp)
 402                 vrele(vp);
 403         FREE(kth, M_KTRACE);
 404         FREE(cp, M_KTRACE);
 405         p->p_traceflag &= ~KTRFAC_ACTIVE;
 406
 407         return (0);
 408 #else
 409         return (ENOSYS);
 410 #endif
 411 }
 412
 413 #ifdef KTRACE
 414 static int
 415 ktrops(curp, p, ops, facs, vp)
 416         struct proc *p, *curp;
 417         int ops, facs;
 418         struct vnode *vp;
 419 {
 420
 421         if (!ktrcanset(curp, p))
 422                 return (0);
 423         if (ops == KTROP_SET) {
 424                 if (p->p_tracep != vp) {
 425                         struct vnode *vtmp;
 426
 427                         /*
 428                          * if trace file already in use, relinquish
 429                          */
 430                         VREF(vp);
 431                         while ((vtmp = p->p_tracep) != NULL) {
 432                                 p->p_tracep = NULL;
 433                                 vrele(vtmp);
 434                         }
 435                         p->p_tracep = vp;
 436                 }
 437                 p->p_traceflag |= facs;
 438                 if (curp->p_ucred->cr_uid == 0)
 439                         p->p_traceflag |= KTRFAC_ROOT;
 440         } else {
 441                 /* KTROP_CLEAR */
 442                 if (((p->p_traceflag &= ~facs) & KTRFAC_MASK) == 0) {
 443                         struct vnode *vtmp;
 444
 445                         /* no more tracing */
 446                         p->p_traceflag = 0;
 447                         if ((vtmp = p->p_tracep) != NULL) {
 448                                 p->p_tracep = NULL;
 449                                 vrele(vtmp);
 450                         }
 451                 }
 452         }
 453
 454         return (1);
 455 }
 456
 457 static int
 458 ktrsetchildren(curp, top, ops, facs, vp)
 459         struct proc *curp, *top;
 460         int ops, facs;
 461         struct vnode *vp;
 462 {
 463         struct proc *p;
 464         int ret = 0;
 465
 466         p = top;
 467         for (;;) {
 468                 ret |= ktrops(curp, p, ops, facs, vp);
 469                 /*
 470                  * If this process has children, descend to them next,
 471                  * otherwise do any siblings, and if done with this level,
 472                  * follow back up the tree (but not past top).
 473                  */
 474                 if (!LIST_EMPTY(&p->p_children))
 475                         p = LIST_FIRST(&p->p_children);
 476                 else for (;;) {
 477                         if (p == top)
 478                                 return (ret);
 479                         if (LIST_NEXT(p, p_sibling)) {
 480                                 p = LIST_NEXT(p, p_sibling);
 481                                 break;
 482                         }
 483                         p = p->p_pptr;
 484                 }
 485         }
 486         /*NOTREACHED*/
 487 }
 488
 489 static void
 490 ktrwrite(struct vnode *vp, struct ktr_header *kth, struct uio *uio)
 491 {
 492         struct uio auio;
 493         struct iovec aiov[2];
 494         struct thread *td = curthread;
 495         struct proc *p = td->td_proc;   /* XXX */
 496         int error;
 497
 498         if (vp == NULL)
 499                 return;
 500         auio.uio_iov = &aiov[0];
 501         auio.uio_offset = 0;
 502         auio.uio_segflg = UIO_SYSSPACE;
 503         auio.uio_rw = UIO_WRITE;
 504         aiov[0].iov_base = (caddr_t)kth;
 505         aiov[0].iov_len = sizeof(struct ktr_header);
 506         auio.uio_resid = sizeof(struct ktr_header);
 507         auio.uio_iovcnt = 1;
 508         auio.uio_td = curthread;
 509         if (kth->ktr_len > 0) {
 510                 auio.uio_iovcnt++;
 511                 aiov[1].iov_base = kth->ktr_buf;
 512                 aiov[1].iov_len = kth->ktr_len;
 513                 auio.uio_resid += kth->ktr_len;
 514                 if (uio != NULL)
 515                         kth->ktr_len += uio->uio_resid;
 516         }
 517         vn_lock(vp, LK_EXCLUSIVE | LK_RETRY, td);
 518         (void)VOP_LEASE(vp, td, p->p_ucred, LEASE_WRITE);
 519         error = VOP_WRITE(vp, &auio, IO_UNIT | IO_APPEND, p->p_ucred);
 520         if (error == 0 && uio != NULL) {
 521                 (void)VOP_LEASE(vp, td, p->p_ucred, LEASE_WRITE);
 522                 error = VOP_WRITE(vp, uio, IO_UNIT | IO_APPEND, p->p_ucred);
 523         }
 524         VOP_UNLOCK(vp, 0, td);
 525         if (!error)
 526                 return;
 527         /*
 528          * If error encountered, give up tracing on this vnode.  XXX what
 529          * happens to the loop if vrele() blocks?
 530          */
 531         log(LOG_NOTICE, "ktrace write failed, errno %d, tracing stopped\n",
 532             error);
 533         FOREACH_PROC_IN_SYSTEM(p) {
 534                 if (p->p_tracep == vp) {
 535                         p->p_tracep = NULL;
 536                         p->p_traceflag = 0;
 537                         vrele(vp);
 538                 }
 539         }
 540 }
 541
 542 /*
 543  * Return true if caller has permission to set the ktracing state
 544  * of target.  Essentially, the target can't possess any
 545  * more permissions than the caller.  KTRFAC_ROOT signifies that
 546  * root previously set the tracing status on the target process, and
 547  * so, only root may further change it.
 548  *
 549  * TODO: check groups.  use caller effective gid.
 550  */
 551 static int
 552 ktrcanset(struct proc *callp, struct proc *targetp)
 553 {
 554         struct ucred *caller = callp->p_ucred;
 555         struct ucred *target = targetp->p_ucred;
 556
 557         if (!PRISON_CHECK(caller, target))
 558                 return (0);
 559         if ((caller->cr_uid == target->cr_ruid &&
 560              target->cr_ruid == target->cr_svuid &&
 561              caller->cr_rgid == target->cr_rgid &&      /* XXX */
 562              target->cr_rgid == target->cr_svgid &&
 563              (targetp->p_traceflag & KTRFAC_ROOT) == 0 &&
 564              (targetp->p_flag & P_SUGID) == 0) ||
 565              caller->cr_uid == 0)
 566                 return (1);
 567
 568         return (0);
 569 }
 570
 571 #endif /* KTRACE */