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