-/* Copyright (c) 2015-2017. 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. */
#ifndef SIMGRID_MC_PROTOCOL_H
#define SIMGRID_MC_PROTOCOL_H
-#include <stdint.h>
-
-#include <xbt/base.h>
+// ***** Environment variables for passing context to the model-checked process
-#include "mc/datatypes.h"
+#ifdef __cplusplus
-SG_BEGIN_DECL()
+#include "src/kernel/actor/SimcallObserver.hpp"
-// ***** Environment variables for passing context to the model-checked process
-
-/** 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>
+#include <sys/un.h>
// ***** Messages
+namespace simgrid::mc {
-typedef enum {
- 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,
- // MCer request to finish the restoration:
- MC_MESSAGE_RESTORE,
-} e_mc_message_type;
-
-#define MC_MESSAGE_LENGTH 512
+XBT_DECLARE_ENUM_CLASS(MessageType, NONE, NEED_MEMINFO, NEED_MEMINFO_REPLY, FORK, FORK_REPLY, WAIT_CHILD,
+ WAIT_CHILD_REPLY, CONTINUE, IGNORE_HEAP, UNIGNORE_HEAP, IGNORE_MEMORY, STACK_REGION,
+ REGISTER_SYMBOL, 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_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`
- * `SOCK_DGRAM` sockets. This means that the protocol is ABI/architecture specific:
+ * 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.
*
* Moreover the protocol is not stable. The same version of the library should be used
* for the client and the server.
- *
- * This is the basic structure shared by all messages: all message start with a message
- * type.
*/
-struct s_mc_message {
- e_mc_message_type type;
+
+/* Basic structure: all message start with a message type */
+struct s_mc_message_t {
+ simgrid::mc::MessageType type;
};
-typedef struct s_mc_message s_mc_message_t;
-typedef struct s_mc_message* mc_message_t;
-struct s_mc_int_message {
- e_mc_message_type type;
+struct s_mc_message_int_t {
+ simgrid::mc::MessageType type;
uint64_t value;
};
-typedef struct s_mc_int_message s_mc_int_message_t;
-typedef struct s_mc_int_message* mc_int_message_t;
-struct s_mc_ignore_heap_message {
- e_mc_message_type type;
+/* Client->Server */
+struct s_mc_message_ignore_heap_t {
+ simgrid::mc::MessageType type;
int block;
int fragment;
void* address;
size_t size;
};
-typedef struct s_mc_ignore_heap_message s_mc_ignore_heap_message_t;
-typedef struct s_mc_ignore_heap_message* mc_ignore_heap_message_t;
-struct s_mc_ignore_memory_message {
- e_mc_message_type type;
+struct s_mc_message_ignore_memory_t {
+ simgrid::mc::MessageType type;
uint64_t addr;
size_t size;
};
-typedef struct s_mc_ignore_memory_message s_mc_ignore_memory_message_t;
-typedef struct s_mc_ignore_memory_message* mc_ignore_memory_message_t;
-struct s_mc_stack_region_message {
- e_mc_message_type type;
+struct s_mc_message_stack_region_t {
+ simgrid::mc::MessageType type;
s_stack_region_t stack_region;
};
-typedef struct s_mc_stack_region_message s_mc_stack_region_message_t;
-typedef struct s_mc_stack_region_message* mc_stack_region_message_t;
-
-struct s_mc_simcall_handle_message {
- e_mc_message_type type;
- unsigned long pid;
- int value;
-};
-typedef struct s_mc_simcall_handle_message s_mc_simcall_handle_message_t;
-typedef struct s_mc_simcall_handle_message* mc_simcall_handle_message;
-struct s_mc_register_symbol_message {
- e_mc_message_type type;
- char name[128];
+struct s_mc_message_register_symbol_t {
+ simgrid::mc::MessageType type;
+ std::array<char, 128> name;
int (*callback)(void*);
void* data;
};
-typedef struct s_mc_register_symbol_message s_mc_register_symbol_message_t;
-typedef struct s_mc_register_symbol_message* mc_register_symbol_message_t;
-struct s_mc_restore_message {
- e_mc_message_type type;
+/* Server -> client */
+struct s_mc_message_need_meminfo_reply_t {
+ simgrid::mc::MessageType type;
+ xbt_mheap_t mmalloc_default_mdp;
+};
+
+struct s_mc_message_fork_t {
+ simgrid::mc::MessageType type;
+ std::array<char, MC_SOCKET_NAME_LEN> socket_name;
+};
+
+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 {
+ simgrid::mc::MessageType type;
int index;
};
-typedef struct s_mc_restore_message s_mc_restore_message_t;
-typedef struct s_mc_restore_message* mc_restore_message_t;
-XBT_PRIVATE const char* MC_message_type_name(e_mc_message_type type);
+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`
+ simgrid::mc::MessageType type;
+ aid_t aid;
+ bool enabled;
+ int max_considered;
+};
-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[]`
+ simgrid::mc::MessageType type;
+ std::array<char, SIMCALL_SERIALIZATION_BUFFER_SIZE> buffer;
+};
+#endif // __cplusplus
#endif