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 #include <poll.h>
  32
  33 #include "syscall.h"
  34
  35 const char **paths_selected = NULL;
  36 static unsigned num_selected = 0;
  37
  38 /*
  39  * Return true if specified path matches one that we're tracing.
  40  */
  41 static int
  42 pathmatch(const char *path)
  43 {
  44         unsigned i;
  45
  46         for (i = 0; i < num_selected; ++i) {
  47                 if (strcmp(path, paths_selected[i]) == 0)
  48                         return 1;
  49         }
  50         return 0;
  51 }
  52
  53 /*
  54  * Return true if specified path (in user-space) matches.
  55  */
  56 static int
  57 upathmatch(struct tcb *const tcp, const kernel_ulong_t upath)
  58 {
  59         char path[PATH_MAX + 1];
  60
  61         return umovestr(tcp, upath, sizeof path, path) > 0 &&
  62                 pathmatch(path);
  63 }
  64
  65 /*
  66  * Return true if specified fd maps to a path we're tracing.
  67  */
  68 static int
  69 fdmatch(struct tcb *tcp, int fd)
  70 {
  71         char path[PATH_MAX + 1];
  72         int n = getfdpath(tcp, fd, path, sizeof(path));
  73
  74         return n >= 0 && pathmatch(path);
  75 }
  76
  77 /*
  78  * Add a path to the set we're tracing.
  79  * Specifying NULL will delete all paths.
  80  */
  81 static void
  82 storepath(const char *path)
  83 {
  84         unsigned i;
  85
  86         if (pathmatch(path))
  87                 return; /* already in table */
  88
  89         i = num_selected++;
  90         paths_selected = xreallocarray(paths_selected, num_selected,
  91                                        sizeof(paths_selected[0]));
  92         paths_selected[i] = path;
  93 }
  94
  95 /*
  96  * Get path associated with fd.
  97  */
  98 int
  99 getfdpath(struct tcb *tcp, int fd, char *buf, unsigned bufsize)
 100 {
 101         char linkpath[sizeof("/proc/%u/fd/%u") + 2 * sizeof(int)*3];
 102         ssize_t n;
 103
 104         if (fd < 0)
 105                 return -1;
 106
 107         sprintf(linkpath, "/proc/%u/fd/%u", tcp->pid, fd);
 108         n = readlink(linkpath, buf, bufsize - 1);
 109         /*
 110          * NB: if buf is too small, readlink doesn't fail,
 111          * it returns truncated result (IOW: n == bufsize - 1).
 112          */
 113         if (n >= 0)
 114                 buf[n] = '\0';
 115         return n;
 116 }
 117
 118 /*
 119  * Add a path to the set we're tracing.  Also add the canonicalized
 120  * version of the path.  Secifying NULL will delete all paths.
 121  */
 122 void
 123 pathtrace_select(const char *path)
 124 {
 125         char *rpath;
 126
 127         storepath(path);
 128
 129         rpath = realpath(path, NULL);
 130
 131         if (rpath == NULL)
 132                 return;
 133
 134         /* if realpath and specified path are same, we're done */
 135         if (strcmp(path, rpath) == 0) {
 136                 free(rpath);
 137                 return;
 138         }
 139
 140         error_msg("Requested path '%s' resolved into '%s'", path, rpath);
 141         storepath(rpath);
 142 }
 143
 144 /*
 145  * Return true if syscall accesses a selected path
 146  * (or if no paths have been specified for tracing).
 147  */
 148 int
 149 pathtrace_match(struct tcb *tcp)
 150 {
 151         const struct_sysent *s;
 152
 153         s = tcp->s_ent;
 154
 155         if (!(s->sys_flags & (TRACE_FILE | TRACE_DESC | TRACE_NETWORK)))
 156                 return 0;
 157
 158         /*
 159          * Check for special cases where we need to do something
 160          * other than test arg[0].
 161          */
 162
 163         switch (s->sen) {
 164         case SEN_dup2:
 165         case SEN_dup3:
 166         case SEN_kexec_file_load:
 167         case SEN_sendfile:
 168         case SEN_sendfile64:
 169         case SEN_tee:
 170                 /* fd, fd */
 171                 return fdmatch(tcp, tcp->u_arg[0]) ||
 172                         fdmatch(tcp, tcp->u_arg[1]);
 173
 174         case SEN_faccessat:
 175         case SEN_fchmodat:
 176         case SEN_fchownat:
 177         case SEN_fstatat64:
 178         case SEN_futimesat:
 179         case SEN_inotify_add_watch:
 180         case SEN_mkdirat:
 181         case SEN_mknodat:
 182         case SEN_name_to_handle_at:
 183         case SEN_newfstatat:
 184         case SEN_openat:
 185         case SEN_readlinkat:
 186         case SEN_statx:
 187         case SEN_unlinkat:
 188         case SEN_utimensat:
 189                 /* fd, path */
 190                 return fdmatch(tcp, tcp->u_arg[0]) ||
 191                         upathmatch(tcp, tcp->u_arg[1]);
 192
 193         case SEN_link:
 194         case SEN_mount:
 195         case SEN_pivotroot:
 196                 /* path, path */
 197                 return upathmatch(tcp, tcp->u_arg[0]) ||
 198                         upathmatch(tcp, tcp->u_arg[1]);
 199
 200         case SEN_quotactl:
 201                 /* x, path */
 202                 return upathmatch(tcp, tcp->u_arg[1]);
 203
 204         case SEN_linkat:
 205         case SEN_renameat2:
 206         case SEN_renameat:
 207                 /* fd, path, fd, path */
 208                 return fdmatch(tcp, tcp->u_arg[0]) ||
 209                         fdmatch(tcp, tcp->u_arg[2]) ||
 210                         upathmatch(tcp, tcp->u_arg[1]) ||
 211                         upathmatch(tcp, tcp->u_arg[3]);
 212
 213         case SEN_old_mmap:
 214 #if defined(S390)
 215         case SEN_old_mmap_pgoff:
 216 #endif
 217         case SEN_mmap:
 218         case SEN_mmap_4koff:
 219         case SEN_mmap_pgoff:
 220         case SEN_ARCH_mmap:
 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_copy_file_range:
 231         case SEN_splice:
 232                 /* fd, x, fd, x, x, x */
 233                 return fdmatch(tcp, tcp->u_arg[0]) ||
 234                         fdmatch(tcp, tcp->u_arg[2]);
 235
 236         case SEN_epoll_ctl:
 237                 /* x, x, fd, x */
 238                 return fdmatch(tcp, tcp->u_arg[2]);
 239
 240
 241         case SEN_fanotify_mark:
 242                 /* x, x, x, fd, path */
 243                 return fdmatch(tcp, tcp->u_arg[3]) ||
 244                         upathmatch(tcp, tcp->u_arg[4]);
 245
 246         case SEN_oldselect:
 247         case SEN_pselect6:
 248         case SEN_select:
 249         {
 250                 int     i, j;
 251                 int     nfds;
 252                 kernel_ulong_t *args;
 253                 kernel_ulong_t select_args[5];
 254                 unsigned int oldselect_args[5];
 255                 unsigned int fdsize;
 256                 fd_set *fds;
 257
 258                 if (SEN_oldselect == s->sen) {
 259                         if (sizeof(*select_args) == sizeof(*oldselect_args)) {
 260                                 if (umove(tcp, tcp->u_arg[0], &select_args)) {
 261                                         return 0;
 262                                 }
 263                         } else {
 264                                 unsigned int n;
 265
 266                                 if (umove(tcp, tcp->u_arg[0], &oldselect_args)) {
 267                                         return 0;
 268                                 }
 269
 270                                 for (n = 0; n < 5; ++n) {
 271                                         select_args[n] = oldselect_args[n];
 272                                 }
 273                         }
 274                         args = select_args;
 275                 } else {
 276                         args = tcp->u_arg;
 277                 }
 278
 279                 /* Kernel truncates arg[0] to int, we do the same. */
 280                 nfds = (int) args[0];
 281                 /* Kernel rejects negative nfds, so we don't parse it either. */
 282                 if (nfds <= 0)
 283                         return 0;
 284                 /* Beware of select(2^31-1, NULL, NULL, NULL) and similar... */
 285                 if (nfds > 1024*1024)
 286                         nfds = 1024*1024;
 287                 fdsize = (((nfds + 7) / 8) + current_wordsize-1) & -current_wordsize;
 288                 fds = xmalloc(fdsize);
 289
 290                 for (i = 1; i <= 3; ++i) {
 291                         if (args[i] == 0)
 292                                 continue;
 293                         if (umoven(tcp, args[i], fdsize, fds) < 0) {
 294                                 continue;
 295                         }
 296                         for (j = 0;; j++) {
 297                                 j = next_set_bit(fds, j, nfds);
 298                                 if (j < 0)
 299                                         break;
 300                                 if (fdmatch(tcp, j)) {
 301                                         free(fds);
 302                                         return 1;
 303                                 }
 304                         }
 305                 }
 306                 free(fds);
 307                 return 0;
 308         }
 309
 310         case SEN_poll:
 311         case SEN_ppoll:
 312         {
 313                 struct pollfd fds;
 314                 unsigned nfds;
 315                 kernel_ulong_t start, cur, end;
 316
 317                 start = tcp->u_arg[0];
 318                 nfds = tcp->u_arg[1];
 319
 320                 end = start + sizeof(fds) * nfds;
 321
 322                 if (nfds == 0 || end < start)
 323                         return 0;
 324
 325                 for (cur = start; cur < end; cur += sizeof(fds))
 326                         if ((umove(tcp, cur, &fds) == 0)
 327                             && fdmatch(tcp, fds.fd))
 328                                 return 1;
 329
 330                 return 0;
 331         }
 332
 333         case SEN_bpf:
 334         case SEN_epoll_create:
 335         case SEN_epoll_create1:
 336         case SEN_eventfd2:
 337         case SEN_eventfd:
 338         case SEN_fanotify_init:
 339         case SEN_inotify_init1:
 340         case SEN_memfd_create:
 341         case SEN_perf_event_open:
 342         case SEN_pipe:
 343         case SEN_pipe2:
 344         case SEN_printargs:
 345         case SEN_socket:
 346         case SEN_socketpair:
 347         case SEN_timerfd_create:
 348         case SEN_timerfd_gettime:
 349         case SEN_timerfd_settime:
 350         case SEN_userfaultfd:
 351                 /*
 352                  * These have TRACE_FILE or TRACE_DESCRIPTOR or TRACE_NETWORK set,
 353                  * but they don't have any file descriptor or path args to test.
 354                  */
 355                 return 0;
 356         }
 357
 358         /*
 359          * Our fallback position for calls that haven't already
 360          * been handled is to just check arg[0].
 361          */
 362
 363         if (s->sys_flags & TRACE_FILE)
 364                 return upathmatch(tcp, tcp->u_arg[0]);
 365
 366         if (s->sys_flags & (TRACE_DESC | TRACE_NETWORK))
 367                 return fdmatch(tcp, tcp->u_arg[0]);
 368
 369         return 0;
 370 }