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