granicus.if.org Git - strace/blob - pathtrace.c

   1 /*
   2  * Copyright (c) 2011, Comtrol Corp.
   3  * 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. The name of the author may not be used to endorse or promote products
  14  *    derived from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  *
  27  */
  28
  29 #include "defs.h"
  30 #include <sys/param.h>
  31 #ifdef HAVE_POLL_H
  32 # include <poll.h>
  33 #endif
  34 #ifdef HAVE_SYS_POLL_H
  35 # include <sys/poll.h>
  36 #endif
  37
  38 #include "syscall.h"
  39
  40 #define MAXSELECTED  256        /* max number of "selected" paths */
  41 static const char *selected[MAXSELECTED];       /* paths selected for tracing */
  42
  43 /*
  44  * Return true if specified path matches one that we're tracing.
  45  */
  46 static int
  47 pathmatch(const char *path)
  48 {
  49         unsigned int i;
  50
  51         for (i = 0; i < ARRAY_SIZE(selected); ++i) {
  52                 if (selected[i] == NULL)
  53                         return 0;
  54                 if (strcmp(path, selected[i]) == 0)
  55                         return 1;
  56         }
  57         return 0;
  58 }
  59
  60 /*
  61  * Return true if specified path (in user-space) matches.
  62  */
  63 static int
  64 upathmatch(struct tcb *tcp, unsigned long upath)
  65 {
  66         char path[PATH_MAX + 1];
  67
  68         return umovestr(tcp, upath, sizeof path, path) >= 0 &&
  69                 pathmatch(path);
  70 }
  71
  72 /*
  73  * Return true if specified fd maps to a path we're tracing.
  74  */
  75 static int
  76 fdmatch(struct tcb *tcp, int fd)
  77 {
  78         const char *path = getfdpath(tcp, fd);
  79
  80         return path && pathmatch(path);
  81 }
  82
  83 /*
  84  * Add a path to the set we're tracing.
  85  * Secifying NULL will delete all paths.
  86  */
  87 static int
  88 storepath(const char *path)
  89 {
  90         unsigned int i;
  91
  92         for (i = 0; i < ARRAY_SIZE(selected); ++i) {
  93                 if (!selected[i]) {
  94                         selected[i] = path;
  95                         return 0;
  96                 }
  97         }
  98
  99         fprintf(stderr, "Max trace paths exceeded, only using first %u\n",
 100                 (unsigned int) ARRAY_SIZE(selected));
 101         return -1;
 102 }
 103
 104 /*
 105  * Get path associated with fd.
 106  */
 107 const char *
 108 getfdpath(struct tcb *tcp, int fd)
 109 {
 110         static char path[PATH_MAX+1];
 111         char linkpath[sizeof("/proc/%u/fd/%u") + 2 * sizeof(int)*3];
 112         ssize_t n;
 113
 114         if (fd < 0)
 115                 return NULL;
 116
 117         sprintf(linkpath, "/proc/%u/fd/%u", tcp->pid, fd);
 118         n = readlink(linkpath, path, (sizeof path) - 1);
 119         if (n <= 0)
 120                 return NULL;
 121         path[n] = '\0';
 122         return path;
 123 }
 124
 125 /*
 126  * Add a path to the set we're tracing.  Also add the canonicalized
 127  * version of the path.  Secifying NULL will delete all paths.
 128  */
 129 int
 130 pathtrace_select(const char *path)
 131 {
 132         char *rpath;
 133
 134         if (storepath(path))
 135                 return -1;
 136
 137         rpath = realpath(path, NULL);
 138
 139         if (rpath == NULL)
 140                 return 0;
 141
 142         /* if realpath and specified path are same, we're done */
 143         if (strcmp(path, rpath) == 0) {
 144                 free(rpath);
 145                 return 0;
 146         }
 147
 148         fprintf(stderr, "Requested path '%s' resolved into '%s'\n",
 149                 path, rpath);
 150         return storepath(rpath);
 151 }
 152
 153 /*
 154  * Return true if syscall accesses a selected path
 155  * (or if no paths have been specified for tracing).
 156  */
 157 int
 158 pathtrace_match(struct tcb *tcp)
 159 {
 160         const struct sysent *s;
 161
 162         if (selected[0] == NULL)
 163                 return 1;
 164
 165         if (!SCNO_IN_RANGE(tcp->scno))
 166                 return 0;
 167
 168         s = &sysent[tcp->scno];
 169
 170         if (!(s->sys_flags & (TRACE_FILE | TRACE_DESC)))
 171                 return 0;
 172
 173         /*
 174          * Check for special cases where we need to do something
 175          * other than test arg[0].
 176          */
 177
 178         if (s->sys_func == sys_dup2 ||
 179             s->sys_func == sys_dup3 ||
 180             s->sys_func == sys_sendfile ||
 181             s->sys_func == sys_sendfile64 ||
 182             s->sys_func == sys_tee)
 183         {
 184                 /* fd, fd */
 185                 return fdmatch(tcp, tcp->u_arg[0]) ||
 186                         fdmatch(tcp, tcp->u_arg[1]);
 187         }
 188
 189         if (s->sys_func == sys_inotify_add_watch ||
 190             s->sys_func == sys_faccessat ||
 191             s->sys_func == sys_fchmodat ||
 192             s->sys_func == sys_futimesat ||
 193             s->sys_func == sys_mkdirat ||
 194             s->sys_func == sys_unlinkat ||
 195             s->sys_func == sys_newfstatat ||
 196             s->sys_func == sys_mknodat ||
 197             s->sys_func == sys_openat ||
 198             s->sys_func == sys_readlinkat ||
 199             s->sys_func == sys_utimensat ||
 200             s->sys_func == sys_fchownat ||
 201             s->sys_func == sys_pipe2)
 202         {
 203                 /* fd, path */
 204                 return fdmatch(tcp, tcp->u_arg[0]) ||
 205                         upathmatch(tcp, tcp->u_arg[1]);
 206         }
 207
 208         if (s->sys_func == sys_link ||
 209             s->sys_func == sys_mount)
 210         {
 211                 /* path, path */
 212                 return upathmatch(tcp, tcp->u_arg[0]) ||
 213                         upathmatch(tcp, tcp->u_arg[1]);
 214         }
 215
 216         if (s->sys_func == sys_quotactl)
 217         {
 218                 /* x, path */
 219                 return upathmatch(tcp, tcp->u_arg[1]);
 220         }
 221
 222         if (s->sys_func == sys_renameat ||
 223             s->sys_func == sys_linkat)
 224         {
 225                 /* fd, path, fd, path */
 226                 return fdmatch(tcp, tcp->u_arg[0]) ||
 227                         fdmatch(tcp, tcp->u_arg[2]) ||
 228                         upathmatch(tcp, tcp->u_arg[1]) ||
 229                         upathmatch(tcp, tcp->u_arg[3]);
 230         }
 231
 232         if (
 233             s->sys_func == sys_old_mmap ||
 234             s->sys_func == sys_mmap) {
 235                 /* x, x, x, x, fd */
 236                 return fdmatch(tcp, tcp->u_arg[4]);
 237         }
 238
 239         if (s->sys_func == sys_symlinkat) {
 240                 /* path, fd, path */
 241                 return fdmatch(tcp, tcp->u_arg[1]) ||
 242                         upathmatch(tcp, tcp->u_arg[0]) ||
 243                         upathmatch(tcp, tcp->u_arg[2]);
 244         }
 245
 246         if (s->sys_func == sys_splice) {
 247                 /* fd, x, fd, x, x */
 248                 return fdmatch(tcp, tcp->u_arg[0]) ||
 249                         fdmatch(tcp, tcp->u_arg[2]);
 250         }
 251
 252         if (s->sys_func == sys_epoll_ctl) {
 253                 /* x, x, fd, x */
 254                 return fdmatch(tcp, tcp->u_arg[2]);
 255         }
 256
 257         if (s->sys_func == sys_select ||
 258             s->sys_func == sys_oldselect ||
 259             s->sys_func == sys_pselect6)
 260         {
 261                 int     i, j;
 262                 unsigned nfds;
 263                 long   *args, oldargs[5];
 264                 unsigned fdsize;
 265                 fd_set *fds;
 266
 267                 if (s->sys_func == sys_oldselect) {
 268                         if (umoven(tcp, tcp->u_arg[0], sizeof oldargs,
 269                                    (char*) oldargs) < 0)
 270                         {
 271                                 fprintf(stderr, "umoven() failed\n");
 272                                 return 0;
 273                         }
 274                         args = oldargs;
 275                 } else
 276                         args = tcp->u_arg;
 277
 278                 nfds = args[0];
 279                 /* Beware of select(2^31-1, NULL, NULL, NULL) and similar... */
 280                 if (args[0] > 1024*1024)
 281                         nfds = 1024*1024;
 282                 if (args[0] < 0)
 283                         nfds = 0;
 284                 fdsize = ((((nfds + 7) / 8) + sizeof(long) - 1)
 285                           & -sizeof(long));
 286                 fds = malloc(fdsize);
 287                 if (!fds)
 288                         die_out_of_memory();
 289
 290                 for (i = 1; i <= 3; ++i) {
 291                         if (args[i] == 0)
 292                                 continue;
 293
 294                         if (umoven(tcp, args[i], fdsize, (char *) fds) < 0) {
 295                                 fprintf(stderr, "umoven() failed\n");
 296                                 continue;
 297                         }
 298
 299                         for (j = 0; j < nfds; ++j)
 300                                 if (FD_ISSET(j, fds) && fdmatch(tcp, j)) {
 301                                         free(fds);
 302                                         return 1;
 303                                 }
 304                 }
 305                 free(fds);
 306                 return 0;
 307         }
 308
 309         if (s->sys_func == sys_poll ||
 310             s->sys_func == sys_ppoll)
 311         {
 312                 struct pollfd fds;
 313                 unsigned nfds;
 314                 unsigned long start, cur, end;
 315
 316                 start = tcp->u_arg[0];
 317                 nfds = tcp->u_arg[1];
 318
 319                 end = start + sizeof(fds) * nfds;
 320
 321                 if (nfds == 0 || end < start)
 322                         return 0;
 323
 324                 for (cur = start; cur < end; cur += sizeof(fds))
 325                         if ((umoven(tcp, cur, sizeof fds, (char *) &fds) == 0)
 326                             && fdmatch(tcp, fds.fd))
 327                                 return 1;
 328
 329                 return 0;
 330         }
 331
 332         if (s->sys_func == printargs ||
 333             s->sys_func == sys_pipe ||
 334             s->sys_func == sys_pipe2 ||
 335             s->sys_func == sys_eventfd2 ||
 336             s->sys_func == sys_eventfd ||
 337             s->sys_func == sys_inotify_init1 ||
 338             s->sys_func == sys_timerfd_create ||
 339             s->sys_func == sys_timerfd_settime ||
 340             s->sys_func == sys_timerfd_gettime ||
 341             s->sys_func == sys_epoll_create ||
 342             strcmp(s->sys_name, "fanotify_init") == 0)
 343         {
 344                 /*
 345                  * These have TRACE_FILE or TRACE_DESCRIPTOR set, but they
 346                  * don't have any file descriptor or path args to test.
 347                  */
 348                 return 0;
 349         }
 350
 351         /*
 352          * Our fallback position for calls that haven't already
 353          * been handled is to just check arg[0].
 354          */
 355
 356         if (s->sys_flags & TRACE_FILE)
 357                 return upathmatch(tcp, tcp->u_arg[0]);
 358
 359         if (s->sys_flags & TRACE_DESC)
 360                 return fdmatch(tcp, tcp->u_arg[0]);
 361
 362         return 0;
 363 }