src/mc/inspect/mc_unw_vmread.cpp

   1 /* Copyright (c) 2015-2022. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "src/mc/inspect/mc_unw.hpp"
   7 #include "src/mc/remote/RemoteProcess.hpp"
   8
   9 #include <sys/types.h>
  10 #include <sys/uio.h>
  11
  12 #include <fcntl.h>
  13 #include <libunwind-ptrace.h>
  14 #include <libunwind.h>
  15
  16 /** \file
  17  *  Libunwind namespace implementation using process_vm_readv.
  18  */
  19
  20 /** Partial structure of libunwind-ptrace context in order to get the PID
  21  *
  22  *  HACK, The context type for libunwind-race is an opaque type.
  23  *  We need to get the PID which is the first field. This is a hack
  24  *  which might break if the libunwind-ptrace structure changes.
  25  */
  26 struct _UPT_info {
  27   pid_t pid;
  28   // Other things...
  29 };
  30
  31 /** Get the PID of a `libunwind-ptrace` context
  32  */
  33 static inline pid_t _UPT_getpid(void* arg)
  34 {
  35   const _UPT_info* info = static_cast<_UPT_info*>(arg);
  36   return info->pid;
  37 }
  38
  39 /** Read from the memory, avoid using `ptrace` (libunwind method) */
  40 static int access_mem(const unw_addr_space_t as, const unw_word_t addr, unw_word_t* const valp, const int write,
  41                       void* const arg)
  42 {
  43   if (write)
  44     return -UNW_EINVAL;
  45   pid_t pid   = _UPT_getpid(arg);
  46   size_t size = sizeof(unw_word_t);
  47
  48 #if HAVE_PROCESS_VM_READV /* linux but not freebsd */
  49   // process_vm_read implementation.
  50   // This is only available since Linux 3.2.
  51
  52   struct iovec local  = {valp, size};
  53   struct iovec remote = {(void*)addr, size};
  54   if (ssize_t s = process_vm_readv(pid, &local, 1, &remote, 1, 0); s >= 0) {
  55     if ((size_t)s != size)
  56       return -UNW_EINVAL;
  57     else
  58       return 0;
  59   } else if (errno != ENOSYS) {
  60     return -UNW_EINVAL;
  61   }
  62 #endif
  63
  64   // /proc/${pid}/mem implementation.
  65   // On recent kernels, we do not need to ptrace the target process.
  66   // On older kernels, it is necessary to ptrace the target process.
  67   size_t count = size;
  68   auto off     = static_cast<off_t>(addr);
  69   auto* buf    = reinterpret_cast<char*>(valp);
  70   int fd       = simgrid::mc::open_vm(pid, O_RDONLY);
  71   if (fd < 0)
  72     return -UNW_EINVAL;
  73
  74   while (count > 0) {
  75     ssize_t nread = pread(fd, buf, count, off);
  76     if (nread == 0) {
  77       close(fd);
  78       return -UNW_EINVAL;
  79     }
  80     if (nread == -1)
  81       // ptrace implementation.
  82       // We need to have PTRACE_ATTACH-ed it before.
  83       return _UPT_access_mem(as, addr, valp, write, arg);
  84
  85     count -= nread;
  86     buf += nread;
  87     off += nread;
  88   }
  89   close(fd);
  90   return 0;
  91 }
  92
  93 namespace simgrid::unw {
  94
  95 unw_addr_space_t create_addr_space()
  96 {
  97   /** Virtual table for our `libunwind-process_vm_readv` implementation.
  98    *
  99    *  This implementation reuse most the code of `libunwind-ptrace` but
 100    *  does not use ptrace() to read the target process memory by
 101    *  `process_vm_readv()` or `/dev/${pid}/mem` if possible.
 102    *
 103    *  Does not support any MC-specific behavior (privatization, snapshots)
 104    *  and `ucontext_t`.
 105    *
 106    *  It works with `void*` contexts allocated with `_UPT_create(pid)`.
 107    */
 108   // TODO, we could get rid of this if we properly stop the model-checked
 109   // process before reading the memory.
 110   unw_accessors_t accessors = {&_UPT_find_proc_info, &_UPT_put_unwind_info, &_UPT_get_dyn_info_list_addr,
 111                                &access_mem,          &_UPT_access_reg,      &_UPT_access_fpreg,
 112                                &_UPT_resume,         &_UPT_get_proc_name};
 113   return unw_create_addr_space(&accessors, BYTE_ORDER);
 114 }
 115
 116 void* create_context(unw_addr_space_t /*as*/, pid_t pid)
 117 {
 118   return _UPT_create(pid);
 119 }
 120
 121 } // namespace simgrid::unw