Logo AND Algorithmique Numérique Distribuée

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