MC protocol: rename INITIAL_ADDRESSES msg to NEED_MEMINFO

[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 b933fea..f22cfd1 100644 (file)
--- a/src/mc/remote/mc_protocol.h
+++ b/src/mc/remote/mc_protocol.h
@@ -1,4 +1,4 @@
-/* Copyright (c) 2015-2022. 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,39 +8,29 @@
 
 // ***** 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 "src/kernel/actor/SimcallObserver.hpp"
 
-#include "mc/datatypes.h"
 #include "simgrid/forward.h" // aid_t
+#include "src/mc/datatypes.h"
+#include "src/xbt/mmalloc/mmalloc.h"
+#include <xbt/utility.hpp>
+
 #include <array>
 #include <cstdint>
-#include <xbt/dynar.h>
-#include <xbt/mmalloc.h>
-#include <xbt/utility.hpp>
 
 // ***** Messages
-namespace simgrid {
-namespace mc {
-
-XBT_DECLARE_ENUM_CLASS(MessageType, NONE, INITIAL_ADDRESSES, CONTINUE, IGNORE_HEAP, UNIGNORE_HEAP, IGNORE_MEMORY,
-                       STACK_REGION, REGISTER_SYMBOL, DEADLOCK_CHECK, DEADLOCK_CHECK_REPLY, WAITING, SIMCALL_EXECUTE,
-                       SIMCALL_EXECUTE_ANSWER, SIMCALL_IS_VISIBLE, SIMCALL_IS_VISIBLE_ANSWER, ASSERTION_FAILED,
-                       ACTOR_ENABLED, ACTOR_ENABLED_REPLY, FINALIZE);
-
-#define SIMCALL_SERIALIZATION_BUFFER_SIZE 2048
+namespace simgrid::mc {
 
-} // namespace mc
-} // namespace simgrid
+XBT_DECLARE_ENUM_CLASS(MessageType, NONE, NEED_MEMINFO, NEED_MEMINFO_REPLY, CONTINUE, IGNORE_HEAP, UNIGNORE_HEAP,
+                       IGNORE_MEMORY, STACK_REGION, REGISTER_SYMBOL, DEADLOCK_CHECK, DEADLOCK_CHECK_REPLY, WAITING,
+                       SIMCALL_EXECUTE, SIMCALL_EXECUTE_ANSWER, ASSERTION_FAILED, ACTORS_STATUS, ACTORS_STATUS_REPLY,
+                       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 SIMCALL_SERIALIZATION_BUFFER_SIZE = 2048;
 
 /** Basic structure for a MC message
  *
@@ -63,14 +53,6 @@ struct s_mc_message_int_t {
 };
 
 /* Client->Server */
-struct s_mc_message_initial_addresses_t {
-  simgrid::mc::MessageType type;
-  xbt_mheap_t mmalloc_default_mdp;
-  unsigned long* maxpid;
-  xbt_dynar_t actors;
-  xbt_dynar_t dead_actors;
-};
-
 struct s_mc_message_ignore_heap_t {
   simgrid::mc::MessageType type;
   int block;
@@ -98,6 +80,11 @@ struct s_mc_message_register_symbol_t {
 };
 
 /* Server -> client */
+struct s_mc_message_need_meminfo_reply_t {
+  simgrid::mc::MessageType type;
+  xbt_mheap_t mmalloc_default_mdp;
+};
+
 struct s_mc_message_simcall_execute_t {
   simgrid::mc::MessageType type;
   aid_t aid_;
@@ -105,7 +92,7 @@ struct s_mc_message_simcall_execute_t {
 };
 struct s_mc_message_simcall_execute_answer_t {
   simgrid::mc::MessageType type;
-  char buffer[SIMCALL_SERIALIZATION_BUFFER_SIZE];
+  std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
 };
 
 struct s_mc_message_restore_t {
@@ -113,19 +100,21 @@ 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;
+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`
   aid_t aid;
+  bool enabled;
+  int max_considered;
 };
-struct s_mc_message_simcall_is_visible_answer_t { // MessageType::SIMCALL_IS_VISIBLE_ANSWER
-  simgrid::mc::MessageType type;
-  bool value;
+
+// 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[]`
+  std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
 };
 
 #endif // __cplusplus