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 39b5aa7..f22cfd1 100644 (file)
--- a/src/mc/remote/mc_protocol.h
+++ b/src/mc/remote/mc_protocol.h
@@ -1,4 +1,4 @@
-/* Copyright (c) 2015-2020. 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. */
@@ -6,42 +6,31 @@
 #ifndef SIMGRID_MC_PROTOCOL_H
 #define SIMGRID_MC_PROTOCOL_H
 
-#include "mc/datatypes.h"
-#include "simgrid/forward.h"
-#include "stdint.h"
+// ***** Environment variables for passing context to the model-checked process
 
-SG_BEGIN_DECL
+#ifdef __cplusplus
 
-// ***** Environment variables for passing context to the model-checked process
+#include "src/kernel/actor/SimcallObserver.hpp"
 
-/** Environment variable name set by `simgrid-mc` to enable MC support in the
- *  children MC processes
- */
-#define MC_ENV_VARIABLE "SIMGRID_MC"
+#include "simgrid/forward.h" // aid_t
+#include "src/mc/datatypes.h"
+#include "src/xbt/mmalloc/mmalloc.h"
+#include <xbt/utility.hpp>
 
-/** Environment variable name used to pass the communication socket */
-#define MC_ENV_SOCKET_FD "SIMGRID_MC_SOCKET_FD"
+#include <array>
+#include <cstdint>
 
 // ***** Messages
+namespace simgrid::mc {
 
-enum e_mc_message_type {
-  MC_MESSAGE_NONE,
-  MC_MESSAGE_CONTINUE,
-  MC_MESSAGE_IGNORE_HEAP,
-  MC_MESSAGE_UNIGNORE_HEAP,
-  MC_MESSAGE_IGNORE_MEMORY,
-  MC_MESSAGE_STACK_REGION,
-  MC_MESSAGE_REGISTER_SYMBOL,
-  MC_MESSAGE_DEADLOCK_CHECK,
-  MC_MESSAGE_DEADLOCK_CHECK_REPLY,
-  MC_MESSAGE_WAITING,
-  MC_MESSAGE_SIMCALL_HANDLE,
-  MC_MESSAGE_ASSERTION_FAILED,
-  MC_MESSAGE_ACTOR_ENABLED,
-  MC_MESSAGE_ACTOR_ENABLED_REPLY
-};
+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
 
-#define MC_MESSAGE_LENGTH 512
+constexpr unsigned MC_MESSAGE_LENGTH                 = 512;
+constexpr unsigned SIMCALL_SERIALIZATION_BUFFER_SIZE = 2048;
 
 /** Basic structure for a MC message
  *
@@ -55,17 +44,17 @@ enum e_mc_message_type {
 
 /* Basic structure: all message start with a message type */
 struct s_mc_message_t {
-  enum e_mc_message_type type;
+  simgrid::mc::MessageType type;
 };
 
 struct s_mc_message_int_t {
-  enum e_mc_message_type type;
+  simgrid::mc::MessageType type;
   uint64_t value;
 };
 
 /* Client->Server */
 struct s_mc_message_ignore_heap_t {
-  enum e_mc_message_type type;
+  simgrid::mc::MessageType type;
   int block;
   int fragment;
   void* address;
@@ -73,42 +62,60 @@ struct s_mc_message_ignore_heap_t {
 };
 
 struct s_mc_message_ignore_memory_t {
-  enum e_mc_message_type type;
+  simgrid::mc::MessageType type;
   uint64_t addr;
   size_t size;
 };
 
 struct s_mc_message_stack_region_t {
-  enum e_mc_message_type type;
+  simgrid::mc::MessageType type;
   s_stack_region_t stack_region;
 };
 
 struct s_mc_message_register_symbol_t {
-  enum e_mc_message_type type;
-  char name[128];
+  simgrid::mc::MessageType type;
+  std::array<char, 128> name;
   int (*callback)(void*);
   void* data;
 };
 
 /* Server -> client */
-struct s_mc_message_simcall_handle_t {
-  enum e_mc_message_type type;
-  unsigned long pid;
-  int value;
+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_;
+  int times_considered_;
+};
+struct s_mc_message_simcall_execute_answer_t {
+  simgrid::mc::MessageType type;
+  std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
 };
 
 struct s_mc_message_restore_t {
-  enum e_mc_message_type type;
+  simgrid::mc::MessageType type;
   int index;
 };
 
-struct s_mc_message_actor_enabled_t {
-  enum e_mc_message_type type;
-  aid_t aid; // actor ID
+struct s_mc_message_actors_status_answer_t {
+  simgrid::mc::MessageType type;
+  int count;
+};
+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;
 };
 
-XBT_PRIVATE const char* MC_message_type_name(enum e_mc_message_type type);
-
-SG_END_DECL
+// 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
 #endif