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         error_msg("Requested path '%s' resolved into '%s'", 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 | TRACE_NETWORK)))
 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         switch (s->sen) {
 168         case SEN_dup2:
 169         case SEN_dup3:
 170         case SEN_sendfile:
 171         case SEN_sendfile64:
 172         case SEN_tee:
 173                 /* fd, fd */
 174                 return fdmatch(tcp, tcp->u_arg[0]) ||
 175                         fdmatch(tcp, tcp->u_arg[1]);
 176
 177         case SEN_faccessat:
 178         case SEN_fchmodat:
 179         case SEN_fchownat:
 180         case SEN_futimesat:
 181         case SEN_inotify_add_watch:
 182         case SEN_mkdirat:
 183         case SEN_mknodat:
 184         case SEN_newfstatat:
 185         case SEN_openat:
 186         case SEN_pipe2:
 187         case SEN_readlinkat:
 188         case SEN_unlinkat:
 189         case SEN_utimensat:
 190                 /* fd, path */
 191                 return fdmatch(tcp, tcp->u_arg[0]) ||
 192                         upathmatch(tcp, tcp->u_arg[1]);
 193
 194         case SEN_link:
 195         case SEN_mount:
 196         case SEN_pivotroot:
 197                 /* path, path */
 198                 return upathmatch(tcp, tcp->u_arg[0]) ||
 199                         upathmatch(tcp, tcp->u_arg[1]);
 200
 201         case SEN_quotactl:
 202                 /* x, path */
 203                 return upathmatch(tcp, tcp->u_arg[1]);
 204
 205         case SEN_linkat:
 206         case SEN_renameat2:
 207         case SEN_renameat:
 208                 /* fd, path, fd, path */
 209                 return fdmatch(tcp, tcp->u_arg[0]) ||
 210                         fdmatch(tcp, tcp->u_arg[2]) ||
 211                         upathmatch(tcp, tcp->u_arg[1]) ||
 212                         upathmatch(tcp, tcp->u_arg[3]);
 213
 214         case SEN_old_mmap:
 215 #if defined(S390)
 216         case SEN_old_mmap_pgoff:
 217 #endif
 218         case SEN_mmap:
 219         case SEN_mmap_4koff:
 220         case SEN_mmap_pgoff:
 221                 /* x, x, x, x, fd */
 222                 return fdmatch(tcp, tcp->u_arg[4]);
 223
 224         case SEN_symlinkat:
 225                 /* path, fd, path */
 226                 return fdmatch(tcp, tcp->u_arg[1]) ||
 227                         upathmatch(tcp, tcp->u_arg[0]) ||
 228                         upathmatch(tcp, tcp->u_arg[2]);
 229
 230         case SEN_splice:
 231                 /* fd, x, fd, x, x */
 232                 return fdmatch(tcp, tcp->u_arg[0]) ||
 233                         fdmatch(tcp, tcp->u_arg[2]);
 234
 235         case SEN_epoll_ctl:
 236                 /* x, x, fd, x */
 237                 return fdmatch(tcp, tcp->u_arg[2]);
 238
 239
 240         case SEN_fanotify_mark:
 241                 /* x, x, x, fd, path */
 242                 return fdmatch(tcp, tcp->u_arg[3]) ||
 243                         upathmatch(tcp, tcp->u_arg[4]);
 244
 245         case SEN_oldselect:
 246         case SEN_pselect6:
 247         case SEN_select:
 248         {
 249                 int     i, j;
 250                 int     nfds;
 251                 long   *args, oldargs[5];
 252                 unsigned fdsize;
 253                 fd_set *fds;
 254
 255                 args = tcp->u_arg;
 256                 if (SEN_oldselect == s->sen) {
 257                         if (umoven(tcp, tcp->u_arg[0], sizeof oldargs,
 258                                    oldargs) < 0)
 259                         {
 260                                 error_msg("umoven() failed");
 261                                 return 0;
 262                         }
 263                         args = oldargs;
 264                 }
 265
 266                 /* Kernel truncates arg[0] to int, we do the same. */
 267                 nfds = (int) args[0];
 268                 /* Kernel rejects negative nfds, so we don't parse it either. */
 269                 if (nfds <= 0)
 270                         return 0;
 271                 /* Beware of select(2^31-1, NULL, NULL, NULL) and similar... */
 272                 if (nfds > 1024*1024)
 273                         nfds = 1024*1024;
 274                 fdsize = (((nfds + 7) / 8) + current_wordsize-1) & -current_wordsize;
 275                 fds = xmalloc(fdsize);
 276
 277                 for (i = 1; i <= 3; ++i) {
 278                         if (args[i] == 0)
 279                                 continue;
 280                         if (umoven(tcp, args[i], fdsize, fds) < 0) {
 281                                 error_msg("umoven() failed");
 282                                 continue;
 283                         }
 284                         for (j = 0;; j++) {
 285                                 j = next_set_bit(fds, j, nfds);
 286                                 if (j < 0)
 287                                         break;
 288                                 if (fdmatch(tcp, j)) {
 289                                         free(fds);
 290                                         return 1;
 291                                 }
 292                         }
 293                 }
 294                 free(fds);
 295                 return 0;
 296         }
 297
 298         case SEN_poll:
 299         case SEN_ppoll:
 300         {
 301                 struct pollfd fds;
 302                 unsigned nfds;
 303                 unsigned long start, cur, end;
 304
 305                 start = tcp->u_arg[0];
 306                 nfds = tcp->u_arg[1];
 307
 308                 end = start + sizeof(fds) * nfds;
 309
 310                 if (nfds == 0 || end < start)
 311                         return 0;
 312
 313                 for (cur = start; cur < end; cur += sizeof(fds))
 314                         if ((umoven(tcp, cur, sizeof fds, &fds) == 0)
 315                             && fdmatch(tcp, fds.fd))
 316                                 return 1;
 317
 318                 return 0;
 319         }
 320
 321         case SEN_epoll_create:
 322         case SEN_eventfd2:
 323         case SEN_eventfd:
 324         case SEN_fanotify_init:
 325         case SEN_inotify_init1:
 326         case SEN_perf_event_open:
 327         case SEN_pipe:
 328         case SEN_printargs:
 329         case SEN_socket:
 330         case SEN_socketpair:
 331         case SEN_timerfd_create:
 332         case SEN_timerfd_gettime:
 333         case SEN_timerfd_settime:
 334                 /*
 335                  * These have TRACE_FILE or TRACE_DESCRIPTOR or TRACE_NETWORK set,
 336                  * but they don't have any file descriptor or path args to test.
 337                  */
 338                 return 0;
 339         }
 340
 341         /*
 342          * Our fallback position for calls that haven't already
 343          * been handled is to just check arg[0].
 344          */
 345
 346         if (s->sys_flags & TRACE_FILE)
 347                 return upathmatch(tcp, tcp->u_arg[0]);
 348
 349         if (s->sys_flags & (TRACE_DESC | TRACE_NETWORK))
 350                 return fdmatch(tcp, tcp->u_arg[0]);
 351
 352         return 0;
 353 }