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