src/mc/remote/AppSide.hpp

   1 /* mc::remote::AppSide: the Application-side of the channel                 */
   2
   3 /* Copyright (c) 2015-2023. The SimGrid Team. All rights reserved.          */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #ifndef SIMGRID_MC_CLIENT_H
   9 #define SIMGRID_MC_CLIENT_H
  10
  11 #include "src/mc/remote/Channel.hpp"
  12
  13 #include <memory>
  14
  15 namespace simgrid::mc {
  16
  17 /** Model-checked-side of the communication protocol
  18  *
  19  *  Send messages to the model-checker and handles message from it.
  20  */
  21 class XBT_PUBLIC AppSide {
  22 private:
  23   Channel channel_;
  24   static std::unique_ptr<AppSide> instance_;
  25   bool need_memory_info_ = false; /* by default we don't send memory info, unless we got a INITIAL_ADDRESSES */
  26
  27 public:
  28   AppSide();
  29   explicit AppSide(int fd) : channel_(fd) {}
  30   void handle_messages() const;
  31
  32 private:
  33   void handle_deadlock_check(const s_mc_message_t* msg) const;
  34   void handle_simcall_execute(const s_mc_message_simcall_execute_t* message) const;
  35   void handle_finalize(const s_mc_message_int_t* msg) const;
  36   void handle_initial_addresses() const;
  37   void handle_actors_status() const;
  38   void handle_actors_maxpid() const;
  39
  40 public:
  41   Channel const& get_channel() const { return channel_; }
  42   Channel& get_channel() { return channel_; }
  43   XBT_ATTRIB_NORETURN void main_loop() const;
  44   void report_assertion_failure() const;
  45   void ignore_memory(void* addr, std::size_t size) const;
  46   void ignore_heap(void* addr, std::size_t size) const;
  47   void unignore_heap(void* addr, std::size_t size) const;
  48   void declare_symbol(const char* name, int* value) const;
  49 #if HAVE_UCONTEXT_H
  50   void declare_stack(void* stack, size_t size, ucontext_t* context) const;
  51 #endif
  52
  53   // Singleton :/
  54   // TODO, remove the singleton antipattern.
  55   static AppSide* initialize();
  56   static AppSide* get() { return instance_.get(); }
  57 };
  58 } // namespace simgrid::mc
  59
  60 #endif