Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
f629b8cf023d7e2711c64279c0cc82b8f70eac86
[simgrid.git] / src / mc / mc_unw.hpp
1 /* Copyright (c) 2015-2019. 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 #ifndef SIMGRID_MC_UNW_HPP
7 #define SIMGRID_MC_UNW_HPP
8
9 /** @file
10  *  Libunwind implementation for the model-checker
11  *
12  *  Libunwind provides an pluggable stack unwinding API: the way the current
13  *  registers and memory is accessed, the way unwinding informations is found
14  *  is pluggable.
15  *
16  *  This component implements the libunwind API for he model-checker:
17  *
18  *    * reading memory from a simgrid::mc::AddressSpace*;
19  *
20  *    * reading stack registers from a saved snapshot (context).
21  *
22  *  Parts of the libunwind information fetching is currently handled by the
23  *  standard `libunwind` implementations (either the local one or the ptrace one)
24  *  because parsing `.eh_frame` section is not fun and `libdw` does not help
25  *  much here.
26  */
27
28 #include "src/mc/mc_forward.hpp"
29 #include "xbt/base.h"
30
31 #include <cstdio>
32 #include <libunwind.h>
33
34 namespace simgrid {
35 namespace unw {
36
37 XBT_PRIVATE unw_addr_space_t create_addr_space();
38 XBT_PRIVATE void* create_context(unw_addr_space_t as, pid_t pid);
39 }
40 }
41
42 namespace simgrid {
43 namespace mc {
44
45 class UnwindContext {
46   simgrid::mc::AddressSpace* addressSpace_ = nullptr;
47   simgrid::mc::RemoteClient* process_      = nullptr;
48   unw_context_t unwindContext_;
49
50 public:
51   void initialize(simgrid::mc::RemoteClient* process, unw_context_t* c);
52   unw_cursor_t cursor();
53
54 private: // Methods and virtual table for libunwind
55   static int find_proc_info(unw_addr_space_t as, unw_word_t ip, unw_proc_info_t* pip, int need_unwind_info,
56                             void* arg) noexcept;
57   static void put_unwind_info(unw_addr_space_t as, unw_proc_info_t* pip, void* arg) noexcept;
58   static int get_dyn_info_list_addr(unw_addr_space_t as, unw_word_t* dilap, void* arg) noexcept;
59   static int access_mem(unw_addr_space_t as, unw_word_t addr, unw_word_t* valp, int write, void* arg) noexcept;
60   static void* get_reg(unw_context_t* context, unw_regnum_t regnum) noexcept;
61   static int access_reg(unw_addr_space_t as, unw_regnum_t regnum, unw_word_t* valp, int write, void* arg) noexcept;
62   static int access_fpreg(unw_addr_space_t as, unw_regnum_t regnum, unw_fpreg_t* fpvalp, int write, void* arg) noexcept;
63   static int resume(unw_addr_space_t as, unw_cursor_t* cp, void* arg) noexcept;
64   static int get_proc_name(unw_addr_space_t as, unw_word_t addr, char* bufp, size_t buf_len, unw_word_t* offp,
65                            void* arg) noexcept;
66   static unw_accessors_t accessors;
67
68 public:
69   // Create a libunwind address space:
70   static unw_addr_space_t createUnwindAddressSpace();
71 };
72
73 void dumpStack(FILE* file, unw_cursor_t&& cursor);
74 void dumpStack(FILE* file, pid_t pid);
75 }
76 }
77
78 #endif