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