src/mc/RegionSnapshot.cpp

   1 /* Copyright (c) 2007-2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #include <cstdlib>
   8
   9 #include <sys/mman.h>
  10
  11 #include "mc/mc.h"
  12 #include "src/mc/mc_snapshot.h"
  13
  14 #include "src/mc/ChunkedData.hpp"
  15 #include "src/mc/RegionSnapshot.hpp"
  16
  17 extern "C" {
  18
  19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_RegionSnaphot, mc,
  20                                 "Logging specific to region snapshots");
  21
  22 }
  23
  24 namespace simgrid {
  25 namespace mc {
  26
  27 static inline
  28 const char* to_cstr(RegionType region)
  29 {
  30   switch (region) {
  31   case RegionType::Unknown:
  32     return "unknown";
  33   case RegionType::Heap:
  34     return "Heap";
  35   case RegionType::Data:
  36     return "Data";
  37   default:
  38     return "?";
  39   }
  40 }
  41
  42 Buffer::Buffer(std::size_t size, Type type) : size_(size), type_(type)
  43 {
  44   switch(type_) {
  45   case Type::Malloc:
  46     data_ = ::malloc(size_);
  47     break;
  48   case Type::Mmap:
  49     data_ = ::mmap(nullptr, size, PROT_READ|PROT_WRITE, MAP_PRIVATE|MAP_ANONYMOUS|MAP_POPULATE, -1, 0);
  50     if (data_ == MAP_FAILED) {
  51       data_ = nullptr;
  52       size_ = 0;
  53       type_ = Type::Malloc;
  54       throw std::bad_alloc();
  55     }
  56     break;
  57   default:
  58     abort();
  59   }
  60 }
  61
  62 void Buffer::clear() noexcept
  63 {
  64   switch(type_) {
  65   case Type::Malloc:
  66     std::free(data_);
  67     break;
  68   case Type::Mmap:
  69     if (munmap(data_, size_) != 0)
  70       abort();
  71     break;
  72   default:
  73     abort();
  74   }
  75   data_ = nullptr;
  76   size_ = 0;
  77   type_ = Type::Malloc;
  78 }
  79
  80 RegionSnapshot dense_region(
  81   RegionType region_type,
  82   void *start_addr, void* permanent_addr, size_t size)
  83 {
  84   // When KSM support is enables, we allocate memory using mmap:
  85   // * we don't want to madvise bits of the heap;
  86   // * mmap gives data aligned on page boundaries which is merge friendly.
  87   simgrid::mc::Buffer data;
  88   if (_sg_mc_ksm)
  89     data = Buffer::mmap(size);
  90   else
  91     data = Buffer::malloc(size);
  92
  93   mc_model_checker->process().read_bytes(data.get(), size,
  94     remote(permanent_addr),
  95     simgrid::mc::ProcessIndexDisabled);
  96
  97   if (_sg_mc_ksm)
  98     // Mark the region as mergeable *after* we have written into it.
  99     // Trying to merge them before is useless/counterproductive.
 100     madvise(data.get(), size, MADV_MERGEABLE);
 101
 102   simgrid::mc::RegionSnapshot region(
 103     region_type, start_addr, permanent_addr, size);
 104   region.flat_data(std::move(data));
 105
 106   XBT_DEBUG("New region : type : %s, data : %p (real addr %p), size : %zu",
 107             to_cstr(region_type), region.flat_data().get(), permanent_addr, size);
 108   return std::move(region);
 109 }
 110
 111 /** @brief Take a snapshot of a given region
 112  *
 113  * @param type
 114  * @param start_addr   Address of the region in the simulated process
 115  * @param permanent_addr Permanent address of this data (for privatized variables, this is the virtual address of the privatized mapping)
 116  * @param size         Size of the data*
 117  */
 118 RegionSnapshot region(
 119   RegionType type, void *start_addr, void* permanent_addr, size_t size,
 120   RegionSnapshot const* ref_region)
 121 {
 122   if (_sg_mc_sparse_checkpoint)
 123     return sparse_region(type, start_addr, permanent_addr, size, ref_region);
 124   else
 125     return dense_region(type, start_addr, permanent_addr, size);
 126 }
 127
 128 RegionSnapshot sparse_region(RegionType region_type,
 129   void *start_addr, void* permanent_addr, size_t size,
 130   RegionSnapshot const* ref_region)
 131 {
 132   simgrid::mc::Process* process = &mc_model_checker->process();
 133   assert(process != nullptr);
 134
 135   bool use_soft_dirty = _sg_mc_sparse_checkpoint && _sg_mc_soft_dirty
 136     && ref_region != nullptr
 137     && ref_region->storage_type() == simgrid::mc::StorageType::Chunked;
 138
 139   xbt_assert((((uintptr_t)start_addr) & (xbt_pagesize-1)) == 0,
 140     "Not at the beginning of a page");
 141   xbt_assert((((uintptr_t)permanent_addr) & (xbt_pagesize-1)) == 0,
 142     "Not at the beginning of a page");
 143   size_t page_count = simgrid::mc::mmu::chunkCount(size);
 144
 145   std::vector<std::uint64_t> pagemap;
 146   const size_t* ref_page_numbers = nullptr;
 147   if (use_soft_dirty) {
 148     pagemap.resize(page_count);
 149     process->read_pagemap(pagemap.data(),
 150       simgrid::mc::mmu::split((std::size_t) permanent_addr).first, page_count);
 151     ref_page_numbers = ref_region->page_data().pagenos();
 152   }
 153
 154   simgrid::mc::ChunkedData page_data(
 155     mc_model_checker->page_store(), *process, permanent_addr, page_count,
 156     ref_page_numbers,
 157     use_soft_dirty ? pagemap.data() : nullptr);
 158
 159   simgrid::mc::RegionSnapshot region(
 160     region_type, start_addr, permanent_addr, size);
 161   region.page_data(std::move(page_data));
 162   return std::move(region);
 163 }
 164
 165 }
 166 }