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