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