src/mc/ModelChecker.cpp

   1 /* Copyright (c) 2008-2023. 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/ModelChecker.hpp"
   7 #include "src/mc/explo/Exploration.hpp"
   8 #include "src/mc/explo/LivenessChecker.hpp"
   9 #include "src/mc/mc_config.hpp"
  10 #include "src/mc/mc_exit.hpp"
  11 #include "src/mc/mc_private.hpp"
  12 #include "src/mc/sosp/RemoteProcessMemory.hpp"
  13 #include "src/mc/transition/TransitionComm.hpp"
  14 #include "xbt/automaton.hpp"
  15 #include "xbt/system_error.hpp"
  16
  17 #include <array>
  18 #include <csignal>
  19 #include <sys/ptrace.h>
  20 #include <sys/wait.h>
  21
  22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_ModelChecker, mc, "ModelChecker");
  23
  24 ::simgrid::mc::ModelChecker* mc_model_checker = nullptr;
  25
  26 namespace simgrid::mc {
  27
  28 ModelChecker::ModelChecker(std::unique_ptr<RemoteProcessMemory> remote_memory)
  29     : remote_process_memory_(std::move(remote_memory))
  30 {
  31 }
  32
  33 bool ModelChecker::handle_message(const char* buffer, ssize_t size)
  34 {
  35   s_mc_message_t base_message;
  36   xbt_assert(size >= (ssize_t)sizeof(base_message), "Broken message");
  37   memcpy(&base_message, buffer, sizeof(base_message));
  38
  39   switch(base_message.type) {
  40     case MessageType::INITIAL_ADDRESSES: {
  41       s_mc_message_initial_addresses_t message;
  42       xbt_assert(size == sizeof(message), "Broken message. Got %d bytes instead of %d.", (int)size, (int)sizeof(message));
  43       memcpy(&message, buffer, sizeof(message));
  44
  45       get_remote_process_memory().init(message.mmalloc_default_mdp);
  46       break;
  47     }
  48
  49     case MessageType::IGNORE_HEAP: {
  50       s_mc_message_ignore_heap_t message;
  51       xbt_assert(size == sizeof(message), "Broken message");
  52       memcpy(&message, buffer, sizeof(message));
  53
  54       IgnoredHeapRegion region;
  55       region.block    = message.block;
  56       region.fragment = message.fragment;
  57       region.address  = message.address;
  58       region.size     = message.size;
  59       get_remote_process_memory().ignore_heap(region);
  60       break;
  61     }
  62
  63     case MessageType::UNIGNORE_HEAP: {
  64       s_mc_message_ignore_memory_t message;
  65       xbt_assert(size == sizeof(message), "Broken message");
  66       memcpy(&message, buffer, sizeof(message));
  67       get_remote_process_memory().unignore_heap((void*)(std::uintptr_t)message.addr, message.size);
  68       break;
  69     }
  70
  71     case MessageType::IGNORE_MEMORY: {
  72       s_mc_message_ignore_memory_t message;
  73       xbt_assert(size == sizeof(message), "Broken message");
  74       memcpy(&message, buffer, sizeof(message));
  75       this->get_remote_process_memory().ignore_region(message.addr, message.size);
  76       break;
  77     }
  78
  79     case MessageType::STACK_REGION: {
  80       s_mc_message_stack_region_t message;
  81       xbt_assert(size == sizeof(message), "Broken message");
  82       memcpy(&message, buffer, sizeof(message));
  83       this->get_remote_process_memory().stack_areas().push_back(message.stack_region);
  84     } break;
  85
  86     case MessageType::REGISTER_SYMBOL: {
  87       s_mc_message_register_symbol_t message;
  88       xbt_assert(size == sizeof(message), "Broken message");
  89       memcpy(&message, buffer, sizeof(message));
  90       xbt_assert(not message.callback, "Support for client-side function proposition is not implemented.");
  91       XBT_DEBUG("Received symbol: %s", message.name.data());
  92
  93       LivenessChecker::automaton_register_symbol(get_remote_process_memory(), message.name.data(),
  94                                                  remote((int*)message.data));
  95       break;
  96     }
  97
  98     case MessageType::WAITING:
  99       return false;
 100
 101     case MessageType::ASSERTION_FAILED:
 102       exploration_->report_assertion_failure();
 103       break;
 104
 105     default:
 106       xbt_die("Unexpected message from model-checked application");
 107   }
 108   return true;
 109 }
 110
 111 void ModelChecker::handle_waitpid(pid_t pid_to_wait)
 112 {
 113   XBT_DEBUG("Check for wait event");
 114   int status;
 115   pid_t pid;
 116   while ((pid = waitpid(-1, &status, WNOHANG)) != 0) {
 117     if (pid == -1) {
 118       if (errno == ECHILD) { // No more children:
 119         xbt_assert(not this->get_remote_process_memory().running(), "Inconsistent state");
 120         break;
 121       } else {
 122         XBT_ERROR("Could not wait for pid");
 123         throw simgrid::xbt::errno_error();
 124       }
 125     }
 126
 127     if (pid == pid_to_wait) {
 128       // From PTRACE_O_TRACEEXIT:
 129 #ifdef __linux__
 130       if (status>>8 == (SIGTRAP | (PTRACE_EVENT_EXIT<<8))) {
 131         unsigned long eventmsg;
 132         xbt_assert(ptrace(PTRACE_GETEVENTMSG, pid_to_wait, 0, &eventmsg) != -1, "Could not get exit status");
 133         status = static_cast<int>(eventmsg);
 134         if (WIFSIGNALED(status))
 135           exploration_->report_crash(status);
 136       }
 137 #endif
 138
 139       // We don't care about non-lethal signals, just reinject them:
 140       if (WIFSTOPPED(status)) {
 141         XBT_DEBUG("Stopped with signal %i", (int) WSTOPSIG(status));
 142         errno = 0;
 143 #ifdef __linux__
 144         ptrace(PTRACE_CONT, pid_to_wait, 0, WSTOPSIG(status));
 145 #elif defined BSD
 146         ptrace(PT_CONTINUE, pid_to_wait, (caddr_t)1, WSTOPSIG(status));
 147 #endif
 148         xbt_assert(errno == 0, "Could not PTRACE_CONT");
 149       }
 150
 151       else if (WIFSIGNALED(status)) {
 152         exploration_->report_crash(status);
 153       } else if (WIFEXITED(status)) {
 154         XBT_DEBUG("Child process is over");
 155         this->get_remote_process_memory().terminate();
 156       }
 157     }
 158   }
 159 }
 160
 161 } // namespace simgrid::mc