Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[mc] Make Process:cache_flags private
[simgrid.git] / src / mc / mc_checkpoint.cpp
1 /* Copyright (c) 2008-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 <unistd.h>
8
9 #include <fcntl.h>
10 #include <string.h>
11 #include <link.h>
12 #include <dirent.h>
13
14 #include "src/internal_config.h"
15 #include "src/mc/mc_private.h"
16 #include "xbt/module.h"
17 #include <xbt/mmalloc.h>
18 #include <xbt/memory.hpp>
19 #include "src/smpi/private.h"
20
21 #include "src/xbt/mmalloc/mmprivate.h"
22
23 #include "src/simix/smx_private.h"
24
25 #include <libunwind.h>
26 #include <libelf.h>
27
28 #include "src/mc/mc_private.h"
29 #include <mc/mc.h>
30
31 #include "src/mc/mc_snapshot.h"
32 #include "src/mc/mc_mmu.h"
33 #include "src/mc/mc_unw.h"
34 #include "src/mc/mc_protocol.h"
35 #include "src/mc/mc_smx.h"
36 #include "mc_hash.hpp"
37
38 #include "src/mc/RegionSnapshot.hpp"
39 #include "src/mc/ObjectInformation.hpp"
40 #include "src/mc/Frame.hpp"
41 #include "src/mc/Variable.hpp"
42
43 using simgrid::mc::remote;
44
45 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(mc_checkpoint, mc,
46                                 "Logging specific to mc_checkpoint");
47
48 namespace simgrid {
49 namespace mc {
50
51 /************************************  Free functions **************************************/
52 /*****************************************************************************************/
53
54 /** @brief Restore a region from a snapshot
55  *
56  *  @param reg     Target region
57  */
58 static void restore(mc_mem_region_t region)
59 {
60   switch(region->storage_type()) {
61   case simgrid::mc::StorageType::NoData:
62   default:
63     xbt_die("Storage type not supported");
64     break;
65
66   case simgrid::mc::StorageType::Flat:
67     mc_model_checker->process().write_bytes(region->flat_data().get(),
68       region->size(), region->permanent_address());
69     break;
70
71   case simgrid::mc::StorageType::Chunked:
72     mc_region_restore_sparse(&mc_model_checker->process(), region);
73     break;
74
75   case simgrid::mc::StorageType::Privatized:
76     for (auto& p : region->privatized_data())
77       restore(&p);
78     break;
79   }
80 }
81
82 #if HAVE_SMPI
83 RegionSnapshot privatized_region(
84     RegionType region_type, void *start_addr, void* permanent_addr,
85     std::size_t size, const RegionSnapshot* ref_region
86     )
87 {
88   size_t process_count = MC_smpi_process_count();
89
90   // Read smpi_privatisation_regions from MCed:
91   smpi_privatisation_region_t remote_smpi_privatisation_regions;
92   mc_model_checker->process().read_variable(
93     "smpi_privatisation_regions",
94     &remote_smpi_privatisation_regions, sizeof(remote_smpi_privatisation_regions));
95   s_smpi_privatisation_region_t privatisation_regions[process_count];
96   mc_model_checker->process().read_bytes(
97     &privatisation_regions, sizeof(privatisation_regions),
98     remote(remote_smpi_privatisation_regions));
99
100   std::vector<simgrid::mc::RegionSnapshot> data;
101   data.reserve(process_count);
102   for (size_t i = 0; i < process_count; i++) {
103     const simgrid::mc::RegionSnapshot* ref_privatized_region = nullptr;
104     if (ref_region && ref_region->storage_type() == StorageType::Privatized)
105       ref_privatized_region = &ref_region->privatized_data()[i];
106     data.push_back(simgrid::mc::region(region_type, start_addr,
107       privatisation_regions[i].address, size, ref_privatized_region));
108   }
109
110   simgrid::mc::RegionSnapshot region = simgrid::mc::RegionSnapshot(
111     region_type, start_addr, permanent_addr, size);
112   region.privatized_data(std::move(data));
113   return std::move(region);
114 }
115 #endif
116
117 static
118 void add_region(int index, mc_snapshot_t snapshot,
119                                   simgrid::mc::RegionType type,
120                                   simgrid::mc::ObjectInformation* object_info,
121                                   void *start_addr, void* permanent_addr,
122                                   std::size_t size)
123 {
124   if (type == simgrid::mc::RegionType::Data)
125     xbt_assert(object_info, "Missing object info for object.");
126   else if (type == simgrid::mc::RegionType::Heap)
127     xbt_assert(!object_info, "Unexpected object info for heap region.");
128
129   simgrid::mc::RegionSnapshot const* ref_region = nullptr;
130   if (mc_model_checker->parent_snapshot_)
131     ref_region = mc_model_checker->parent_snapshot_->snapshot_regions[index].get();
132
133   simgrid::mc::RegionSnapshot region;
134 #if HAVE_SMPI
135   const bool privatization_aware = object_info
136     && mc_model_checker->process().privatized(*object_info);
137   if (privatization_aware && MC_smpi_process_count())
138     region = simgrid::mc::privatized_region(
139       type, start_addr, permanent_addr, size, ref_region);
140   else
141 #endif
142     region = simgrid::mc::region(type, start_addr, permanent_addr, size, ref_region);
143
144   region.object_info(object_info);
145   snapshot->snapshot_regions[index]
146     = std::unique_ptr<simgrid::mc::RegionSnapshot>(
147       new simgrid::mc::RegionSnapshot(std::move(region)));
148   return;
149 }
150
151 static void get_memory_regions(simgrid::mc::Process* process, mc_snapshot_t snapshot)
152 {
153   const size_t n = process->object_infos.size();
154   snapshot->snapshot_regions.resize(n + 1);
155   int i = 0;
156   for (auto const& object_info : process->object_infos)
157     add_region(i++, snapshot, simgrid::mc::RegionType::Data,
158       object_info.get(),
159       object_info->start_rw, object_info->start_rw,
160       object_info->end_rw - object_info->start_rw);
161
162   xbt_mheap_t heap = process->get_heap();
163   void *start_heap = heap->base;
164   void *end_heap = heap->breakval;
165
166   add_region(n, snapshot, simgrid::mc::RegionType::Heap, nullptr,
167                         start_heap, start_heap,
168                         (char *) end_heap - (char *) start_heap);
169   snapshot->heap_bytes_used = mmalloc_get_bytes_used_remote(
170     heap->heaplimit,
171     process->get_malloc_info());
172
173 #if HAVE_SMPI
174   if (mc_model_checker->process().privatized() && MC_smpi_process_count())
175     // snapshot->privatization_index = smpi_loaded_page
176     mc_model_checker->process().read_variable(
177       "smpi_loaded_page", &snapshot->privatization_index,
178       sizeof(snapshot->privatization_index));
179   else
180 #endif
181     snapshot->privatization_index = simgrid::mc::ProcessIndexMissing;
182 }
183
184 /** \brief Fills the position of the segments (executable, read-only, read/write).
185  *
186  *  `dl_iterate_phdr` would be more robust but would not work in cross-process.
187  * */
188 void find_object_address(
189   std::vector<simgrid::xbt::VmMap> const& maps,
190   simgrid::mc::ObjectInformation* result)
191 {
192   char* name = xbt_basename(result->file_name.c_str());
193
194   for (size_t i = 0; i < maps.size(); ++i) {
195     simgrid::xbt::VmMap const& reg = maps[i];
196     if (maps[i].pathname.empty())
197       continue;
198     char* map_basename = xbt_basename(maps[i].pathname.c_str());
199     if (strcmp(name, map_basename) != 0) {
200       free(map_basename);
201       continue;
202     }
203     free(map_basename);
204     if ((reg.prot & PROT_WRITE)) {
205       xbt_assert(!result->start_rw,
206                  "Multiple read-write segments for %s, not supported",
207                  maps[i].pathname.c_str());
208       result->start_rw = (char*) reg.start_addr;
209       result->end_rw = (char*) reg.end_addr;
210       // .bss is usually after the .data:
211       simgrid::xbt::VmMap const& next = maps[i + 1];
212       if (next.pathname.empty() && (next.prot & PROT_WRITE)
213           && next.start_addr == reg.end_addr)
214         result->end_rw = (char*) maps[i + 1].end_addr;
215     } else if ((reg.prot & PROT_READ) && (reg.prot & PROT_EXEC)) {
216       xbt_assert(!result->start_exec,
217                  "Multiple executable segments for %s, not supported",
218                  maps[i].pathname.c_str());
219       result->start_exec = (char*) reg.start_addr;
220       result->end_exec = (char*) reg.end_addr;
221     } else if ((reg.prot & PROT_READ) && !(reg.prot & PROT_EXEC)) {
222       xbt_assert(!result->start_ro,
223                  "Multiple read only segments for %s, not supported",
224                  maps[i].pathname.c_str());
225       result->start_ro = (char*) reg.start_addr;
226       result->end_ro = (char*) reg.end_addr;
227     }
228   }
229
230   result->start = result->start_rw;
231   if ((const void*) result->start_ro > result->start)
232     result->start = result->start_ro;
233   if ((const void*) result->start_exec > result->start)
234     result->start = result->start_exec;
235
236   result->end = result->end_rw;
237   if (result->end_ro && (const void*) result->end_ro < result->end)
238     result->end = result->end_ro;
239   if (result->end_exec && (const void*) result->end_exec > result->end)
240     result->end = result->end_exec;
241
242   xbt_assert(result->start_rw);
243   xbt_assert(result->start_exec);
244
245   free(name);
246 }
247
248 /************************************* Take Snapshot ************************************/
249 /****************************************************************************************/
250
251 /** \brief Checks whether the variable is in scope for a given IP.
252  *
253  *  A variable may be defined only from a given value of IP.
254  *
255  *  \param var   Variable description
256  *  \param frame Scope description
257  *  \param ip    Instruction pointer
258  *  \return      true if the variable is valid
259  * */
260 static bool valid_variable(simgrid::mc::Variable* var,
261                               simgrid::mc::Frame* scope,
262                               const void *ip)
263 {
264   // The variable is not yet valid:
265   if (scope->range.begin() + var->start_scope > (std::uint64_t) ip)
266     return false;
267   else
268     return true;
269 }
270
271 static void fill_local_variables_values(mc_stack_frame_t stack_frame,
272                                            simgrid::mc::Frame* scope,
273                                            int process_index,
274                                            std::vector<s_local_variable>& result)
275 {
276   simgrid::mc::Process* process = &mc_model_checker->process();
277
278   if (!scope->range.contain(stack_frame->ip))
279     return;
280
281   for(simgrid::mc::Variable& current_variable :
282       scope->variables) {
283
284     if (!valid_variable(&current_variable, scope, (void *) stack_frame->ip))
285       continue;
286
287     int region_type;
288     // FIXME, get rid of `region_type`
289     if ((long) stack_frame->ip > (long) process->libsimgrid_info->start_exec)
290       region_type = 1;
291     else
292       region_type = 2;
293
294     s_local_variable_t new_var;
295     new_var.subprogram = stack_frame->frame;
296     new_var.ip = stack_frame->ip;
297     new_var.name = current_variable.name;
298     new_var.type = current_variable.type;
299     new_var.region = region_type;
300     new_var.address = nullptr;
301
302     if (current_variable.address != nullptr)
303       new_var.address = current_variable.address;
304     else if (!current_variable.location_list.empty()) {
305       simgrid::dwarf::Location location =
306         simgrid::dwarf::resolve(
307           current_variable.location_list,
308           current_variable.object_info,
309           &(stack_frame->unw_cursor),
310           (void *) stack_frame->frame_base,
311           &mc_model_checker->process(), process_index);
312
313       if (!location.in_memory())
314         xbt_die("Cannot handle non-address variable");
315       new_var.address = location.address();
316
317     } else
318       xbt_die("No address");
319
320     result.push_back(std::move(new_var));
321   }
322
323   // Recursive processing of nested scopes:
324   for(simgrid::mc::Frame& nested_scope : scope->scopes)
325     fill_local_variables_values(
326       stack_frame, &nested_scope, process_index, result);
327 }
328
329 static std::vector<s_local_variable> get_local_variables_values(
330   std::vector<s_mc_stack_frame_t>& stack_frames, int process_index)
331 {
332   std::vector<s_local_variable> variables;
333   for (s_mc_stack_frame_t& stack_frame : stack_frames)
334     fill_local_variables_values(&stack_frame, stack_frame.frame, process_index, variables);
335   return std::move(variables);
336 }
337
338 static std::vector<s_mc_stack_frame_t> unwind_stack_frames(mc_unw_context_t stack_context)
339 {
340   simgrid::mc::Process* process = &mc_model_checker->process();
341   std::vector<s_mc_stack_frame_t> result;
342
343   unw_cursor_t c;
344
345   // TODO, check condition check (unw_init_local==0 means end of frame)
346   if (mc_unw_init_cursor(&c, stack_context) != 0)
347     xbt_die("Could not initialize stack unwinding");
348
349     while (1) {
350
351       s_mc_stack_frame_t stack_frame;
352
353       stack_frame.unw_cursor = c;
354
355       unw_word_t ip, sp;
356
357       unw_get_reg(&c, UNW_REG_IP, &ip);
358       unw_get_reg(&c, UNW_REG_SP, &sp);
359
360       stack_frame.ip = ip;
361       stack_frame.sp = sp;
362
363       // TODO, use real addresses in frame_t instead of fixing it here
364
365       simgrid::mc::Frame* frame = process->find_function(remote(ip));
366       stack_frame.frame = frame;
367
368       if (frame) {
369         stack_frame.frame_name = frame->name;
370         stack_frame.frame_base =
371             (unw_word_t) frame->frame_base(c);
372       } else {
373         stack_frame.frame_base = 0;
374         stack_frame.frame_name = std::string();
375       }
376
377       result.push_back(std::move(stack_frame));
378
379       /* Stop before context switch with maestro */
380       if (frame != nullptr &&
381           frame->name == "smx_ctx_sysv_wrapper")
382         break;
383
384       int ret = unw_step(&c);
385       if (ret == 0)
386         xbt_die("Unexpected end of stack.");
387       else if (ret < 0)
388         xbt_die("Error while unwinding stack");
389     }
390
391   if (result.empty()) {
392     XBT_INFO("unw_init_local failed");
393     xbt_abort();
394   }
395
396   return std::move(result);
397 };
398
399 static std::vector<s_mc_snapshot_stack_t> take_snapshot_stacks(mc_snapshot_t * snapshot)
400 {
401   std::vector<s_mc_snapshot_stack_t> res;
402
403   for (auto const& stack : mc_model_checker->process().stack_areas()) {
404     s_mc_snapshot_stack_t st;
405
406     // Read the context from remote process:
407     unw_context_t context;
408     mc_model_checker->process().read_bytes(
409       &context, sizeof(context), remote(stack.context));
410
411     if (mc_unw_init_context(&st.context, &mc_model_checker->process(),
412       &context) < 0)
413       xbt_die("Could not initialise the libunwind context.");
414
415     st.stack_frames = unwind_stack_frames(&st.context);
416     st.local_variables = get_local_variables_values(st.stack_frames, stack.process_index);
417     st.process_index = stack.process_index;
418
419     unw_word_t sp = st.stack_frames[0].sp;
420
421     res.push_back(std::move(st));
422
423     size_t stack_size =
424       (char*) stack.address + stack.size - (char*) sp;
425     (*snapshot)->stack_sizes.push_back(stack_size);
426   }
427
428   return std::move(res);
429
430 }
431
432 static void snapshot_handle_ignore(mc_snapshot_t snapshot)
433 {
434   xbt_assert(snapshot->process());
435   
436   // Copy the memory:
437   for (auto const& region : mc_model_checker->process().ignored_regions()) {
438     s_mc_snapshot_ignored_data_t ignored_data;
439     ignored_data.start = (void*)region.addr;
440     ignored_data.data.resize(region.size);
441     // TODO, we should do this once per privatization segment:
442     snapshot->process()->read_bytes(
443       ignored_data.data.data(), region.size, remote(region.addr),
444       simgrid::mc::ProcessIndexDisabled);
445     snapshot->ignored_data.push_back(std::move(ignored_data));
446   }
447
448   // Zero the memory:
449   for(auto const& region : mc_model_checker->process().ignored_regions())
450     snapshot->process()->clear_bytes(remote(region.addr), region.size);
451
452 }
453
454 static void snapshot_ignore_restore(mc_snapshot_t snapshot)
455 {
456   for (auto const& ignored_data : snapshot->ignored_data)
457     snapshot->process()->write_bytes(
458       ignored_data.data.data(), ignored_data.data.size(),
459       remote(ignored_data.start));
460 }
461
462 static std::vector<s_fd_infos_t> get_current_fds(pid_t pid)
463 {
464   const size_t fd_dir_path_size = 20;
465   char fd_dir_path[fd_dir_path_size];
466   int res = snprintf(fd_dir_path, fd_dir_path_size,
467     "/proc/%lli/fd", (long long int) pid);
468   xbt_assert(res >= 0);
469   if ((size_t) res > fd_dir_path_size)
470     xbt_die("Unexpected buffer is too small for fd_dir_path");
471
472   DIR* fd_dir = opendir(fd_dir_path);
473   if (fd_dir == nullptr)
474     xbt_die("Cannot open directory '/proc/self/fd'\n");
475
476   std::vector<s_fd_infos_t> fds;
477
478   struct dirent* fd_number;
479   while ((fd_number = readdir(fd_dir))) {
480
481     int fd_value = xbt_str_parse_int(fd_number->d_name, "Found a non-numerical FD: %s. Freaking out!");
482
483     if(fd_value < 3)
484       continue;
485
486     const size_t source_size = 25;
487     char source[25];
488     int res = snprintf(source, source_size, "/proc/%lli/fd/%s",
489         (long long int) pid, fd_number->d_name);
490     xbt_assert(res >= 0);
491     if ((size_t) res > source_size)
492       xbt_die("Unexpected buffer is too small for fd %s", fd_number->d_name);
493
494     const size_t link_size = 200;
495     char link[200];
496     res = readlink(source, link, link_size);
497
498     if (res<0)
499       xbt_die("Could not read link for %s", source);
500     if (res==200)
501       xbt_die("Buffer to small for link of %s", source);
502
503     link[res] = '\0';
504
505 #if HAVE_SMPI
506     if(smpi_is_privatisation_file(link))
507       continue;
508 #endif
509
510     // This is (probably) the DIR* we are reading:
511     // TODO, read all the file entries at once and close the DIR.*
512     if(strcmp(fd_dir_path, link) == 0)
513       continue;
514
515     // We don't handle them.
516     // It does not mean we should silently ignore them however.
517     if (strncmp(link, "pipe:", 5) == 0 || strncmp(link, "socket:", 7) == 0)
518       continue;
519
520     // If dot_output enabled, do not handle the corresponding file
521     if (dot_output != nullptr) {
522       char* link_basename = xbt_basename(link);
523       if (strcmp(link_basename, _sg_mc_dot_output_file) == 0) {
524         free(link_basename);
525         continue;
526       }
527       free(link_basename);
528     }
529
530     // This is probably a shared memory used by lttng-ust:
531     if(strncmp("/dev/shm/ust-shm-tmp-", link, 21)==0)
532       continue;
533
534     // Add an entry for this FD in the snapshot:
535     s_fd_infos_t fd;
536     fd.filename = std::string(link);
537     fd.number = fd_value;
538     fd.flags = fcntl(fd_value, F_GETFL) | fcntl(fd_value, F_GETFD) ;
539     fd.current_position = lseek(fd_value, 0, SEEK_CUR);
540     fds.push_back(std::move(fd));
541   }
542
543   closedir (fd_dir);
544   return std::move(fds);
545 }
546
547 mc_snapshot_t take_snapshot(int num_state)
548 {
549   XBT_DEBUG("Taking snapshot %i", num_state);
550
551   simgrid::mc::Process* mc_process = &mc_model_checker->process();
552
553   mc_snapshot_t snapshot = new simgrid::mc::Snapshot(mc_process);
554
555   snapshot->num_state = num_state;
556
557   for (auto& p : mc_model_checker->process().simix_processes())
558     snapshot->enabled_processes.insert(p.copy.pid);
559
560   snapshot_handle_ignore(snapshot);
561
562   if (_sg_mc_snapshot_fds)
563     snapshot->current_fds = get_current_fds(mc_model_checker->process().pid());
564
565   const bool use_soft_dirty = _sg_mc_sparse_checkpoint && _sg_mc_soft_dirty;
566
567   /* Save the std heap and the writable mapped pages of libsimgrid and binary */
568   get_memory_regions(mc_process, snapshot);
569   if (use_soft_dirty)
570     mc_process->reset_soft_dirty();
571
572   snapshot->to_ignore = mc_model_checker->process().ignored_heap();
573
574   if (_sg_mc_visited > 0 || strcmp(_sg_mc_property_file, "")) {
575     snapshot->stacks =
576         take_snapshot_stacks(&snapshot);
577     if (_sg_mc_hash)
578       snapshot->hash = simgrid::mc::hash(*snapshot);
579     else
580       snapshot->hash = 0;
581   } else
582     snapshot->hash = 0;
583
584   snapshot_ignore_restore(snapshot);
585   if (use_soft_dirty)
586     mc_model_checker->parent_snapshot_ = snapshot;
587   return snapshot;
588 }
589
590 static inline
591 void restore_snapshot_regions(mc_snapshot_t snapshot)
592 {
593   for(std::unique_ptr<s_mc_mem_region_t> const& region : snapshot->snapshot_regions) {
594     // For privatized, variables we decided it was not necessary to take the snapshot:
595     if (region)
596       restore(region.get());
597   }
598
599 #if HAVE_SMPI
600   // TODO, send a message to implement this in the MCed process
601   if(snapshot->privatization_index >= 0) {
602     // Fix the privatization mmap:
603     s_mc_restore_message message;
604     message.type = MC_MESSAGE_RESTORE;
605     message.index = snapshot->privatization_index;
606     mc_model_checker->process().getChannel().send(message);
607   }
608 #endif
609 }
610
611 static inline
612 void restore_snapshot_fds(mc_snapshot_t snapshot)
613 {
614   if (mc_mode == MC_MODE_SERVER)
615     xbt_die("FD snapshot not implemented in client/server mode.");
616
617   for (auto const& fd : snapshot->current_fds) {
618     
619     int new_fd = open(fd.filename.c_str(), fd.flags);
620     if (new_fd < 0)
621       xbt_die("Could not reopen the file %s fo restoring the file descriptor",
622         fd.filename.c_str());
623     if (new_fd != fd.number) {
624       dup2(new_fd, fd.number);
625       close(new_fd);
626     };
627     lseek(fd.number, fd.current_position, SEEK_SET);
628   }
629 }
630
631 void restore_snapshot(mc_snapshot_t snapshot)
632 {
633   XBT_DEBUG("Restore snapshot %i", snapshot->num_state);
634   const bool use_soft_dirty = _sg_mc_sparse_checkpoint && _sg_mc_soft_dirty;
635   restore_snapshot_regions(snapshot);
636   if (_sg_mc_snapshot_fds)
637     restore_snapshot_fds(snapshot);
638   if (use_soft_dirty)
639     mc_model_checker->process().reset_soft_dirty();
640   snapshot_ignore_restore(snapshot);
641   mc_model_checker->process().clear_cache();
642   if (use_soft_dirty)
643     mc_model_checker->parent_snapshot_ = snapshot;
644 }
645
646 }
647 }