Remove the stateful model-checking from the archive. It's not working anymore

[simgrid.git] / src / mc / remote / mc_protocol.h

diff --git a/src/mc/remote/mc_protocol.h b/src/mc/remote/mc_protocol.h
index 824b8bb..0c41b27 100644 (file)
--- a/src/mc/remote/mc_protocol.h
+++ b/src/mc/remote/mc_protocol.h
@@ -1,4 +1,4 @@
-/* Copyright (c) 2015-2021. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2015-2023. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -8,37 +8,34 @@
 
 // ***** Environment variables for passing context to the model-checked process
 
-/** Environment variable name used to pass the communication socket.
- *
- * It is set by `simgrid-mc` to enable MC support in the children processes
- */
-#define MC_ENV_SOCKET_FD "SIMGRID_MC_SOCKET_FD"
-
 #ifdef __cplusplus
 
-#include "mc/datatypes.h"
+#include "src/kernel/actor/SimcallObserver.hpp"
+
 #include "simgrid/forward.h" // aid_t
+#include "src/mc/datatypes.h"
+#include <xbt/utility.hpp>
+
 #include <array>
 #include <cstdint>
-#include <xbt/utility.hpp>
+#include <sys/un.h>
 
 // ***** Messages
-namespace simgrid {
-namespace mc {
-
-XBT_DECLARE_ENUM_CLASS(MessageType, NONE, CONTINUE, IGNORE_HEAP, UNIGNORE_HEAP, IGNORE_MEMORY, STACK_REGION,
-                       REGISTER_SYMBOL, DEADLOCK_CHECK, DEADLOCK_CHECK_REPLY, WAITING, SIMCALL_HANDLE,
-                       SIMCALL_IS_VISIBLE, SIMCALL_IS_VISIBLE_ANSWER, SIMCALL_TO_STRING, SIMCALL_TO_STRING_ANSWER,
-                       SIMCALL_DOT_LABEL, ASSERTION_FAILED, ACTOR_ENABLED, ACTOR_ENABLED_REPLY);
+namespace simgrid::mc {
 
-} // namespace mc
-} // namespace simgrid
+XBT_DECLARE_ENUM_CLASS(MessageType, NONE, FORK, FORK_REPLY, WAIT_CHILD, WAIT_CHILD_REPLY, CONTINUE, DEADLOCK_CHECK,
+                       DEADLOCK_CHECK_REPLY, WAITING, SIMCALL_EXECUTE, SIMCALL_EXECUTE_REPLY, ASSERTION_FAILED,
+                       ACTORS_STATUS, ACTORS_STATUS_REPLY_COUNT, ACTORS_STATUS_REPLY_SIMCALL,
+                       ACTORS_STATUS_REPLY_TRANSITION, ACTORS_MAXPID, ACTORS_MAXPID_REPLY, FINALIZE, FINALIZE_REPLY);
+} // namespace simgrid::mc
 
-constexpr unsigned MC_MESSAGE_LENGTH = 512;
+constexpr unsigned MC_MESSAGE_LENGTH                 = 512;
+constexpr unsigned MC_SOCKET_NAME_LEN                = sizeof(sockaddr_un::sun_path);
+constexpr unsigned SIMCALL_SERIALIZATION_BUFFER_SIZE = 2048;
 
 /** Basic structure for a MC message
  *
- *  The current version of the client/server protocol sends C structures over `AF_LOCAL`
+ *  The current version of the client/server protocol sends C structures over `AF_UNIX`
  *  `SOCK_SEQPACKET` sockets. This means that the protocol is ABI/architecture specific:
  *  we currently can't model-check a x86 process from a x86_64 process.
  *
@@ -57,37 +54,21 @@ struct s_mc_message_int_t {
 };
 
 /* Client->Server */
-struct s_mc_message_ignore_heap_t {
-  simgrid::mc::MessageType type;
-  int block;
-  int fragment;
-  void* address;
-  size_t size;
-};
 
-struct s_mc_message_ignore_memory_t {
-  simgrid::mc::MessageType type;
-  uint64_t addr;
-  size_t size;
-};
-
-struct s_mc_message_stack_region_t {
+/* Server -> client */
+struct s_mc_message_fork_t {
   simgrid::mc::MessageType type;
-  s_stack_region_t stack_region;
+  std::array<char, MC_SOCKET_NAME_LEN> socket_name;
 };
 
-struct s_mc_message_register_symbol_t {
+struct s_mc_message_simcall_execute_t {
   simgrid::mc::MessageType type;
-  std::array<char, 128> name;
-  int (*callback)(void*);
-  void* data;
+  aid_t aid_;
+  int times_considered_;
 };
-
-/* Server -> client */
-struct s_mc_message_simcall_handle_t {
+struct s_mc_message_simcall_execute_answer_t {
   simgrid::mc::MessageType type;
-  unsigned long pid_;
-  int times_considered_;
+  std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
 };
 
 struct s_mc_message_restore_t {
@@ -95,29 +76,23 @@ struct s_mc_message_restore_t {
   int index;
 };
 
-struct s_mc_message_actor_enabled_t {
+struct s_mc_message_actors_status_answer_t {
   simgrid::mc::MessageType type;
-  aid_t aid; // actor ID
+  int count;
 };
-
-/* RPC */
-struct s_mc_message_simcall_is_visible_t { // MessageType::SIMCALL_IS_VISIBLE
-  simgrid::mc::MessageType type;
-  int aid;
-};
-struct s_mc_message_simcall_is_visible_answer_t { // MessageType::SIMCALL_IS_VISIBLE_ANSWER
+struct s_mc_message_actors_status_one_t { // an array of `s_mc_message_actors_status_one_t[count]` is sent right after
+                                          // after a `s_mc_message_actors_status_answer_t`
   simgrid::mc::MessageType type;
-  bool value;
+  aid_t aid;
+  bool enabled;
+  int max_considered;
 };
 
-struct s_mc_message_simcall_to_string_t { // MessageType::SIMCALL_TO_STRING or MessageType::SIMCALL_DOT_LABEL
-  simgrid::mc::MessageType type;
-  int aid;
-  int time_considered;
-};
-struct s_mc_message_simcall_to_string_answer_t { // MessageType::SIMCALL_TO_STRING_ANSWER
+// Answer from an actor to the question "what are you about to run?"
+struct s_mc_message_simcall_probe_one_t { // a series of `s_mc_message_simcall_probe_one_t`
+                                          // is sent right after `s_mc_message_actors_status_one_t[]`
   simgrid::mc::MessageType type;
-  char value[1024];
+  std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
 };
 
 #endif // __cplusplus