src/mc/remote/mc_protocol.h

   1 /* Copyright (c) 2015-2020. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #ifndef SIMGRID_MC_PROTOCOL_H
   7 #define SIMGRID_MC_PROTOCOL_H
   8
   9 #include "mc/datatypes.h"
  10 #include "simgrid/forward.h"
  11 #include "stdint.h"
  12
  13 SG_BEGIN_DECL
  14
  15 // ***** Environment variables for passing context to the model-checked process
  16
  17 /** Environment variable name used to pass the communication socket.
  18  *
  19  * It is set by `simgrid-mc` to enable MC support in the children processes
  20  */
  21 #define MC_ENV_SOCKET_FD "SIMGRID_MC_SOCKET_FD"
  22
  23 // ***** Messages
  24
  25 enum e_mc_message_type {
  26   MC_MESSAGE_NONE,
  27   MC_MESSAGE_CONTINUE,
  28   MC_MESSAGE_IGNORE_HEAP,
  29   MC_MESSAGE_UNIGNORE_HEAP,
  30   MC_MESSAGE_IGNORE_MEMORY,
  31   MC_MESSAGE_STACK_REGION,
  32   MC_MESSAGE_REGISTER_SYMBOL,
  33   MC_MESSAGE_DEADLOCK_CHECK,
  34   MC_MESSAGE_DEADLOCK_CHECK_REPLY,
  35   MC_MESSAGE_WAITING,
  36   MC_MESSAGE_SIMCALL_HANDLE,
  37   MC_MESSAGE_ASSERTION_FAILED,
  38   MC_MESSAGE_ACTOR_ENABLED,
  39   MC_MESSAGE_ACTOR_ENABLED_REPLY
  40 };
  41
  42 #define MC_MESSAGE_LENGTH 512
  43
  44 /** Basic structure for a MC message
  45  *
  46  *  The current version of the client/server protocol sends C structures over `AF_LOCAL`
  47  *  `SOCK_SEQPACKET` sockets. This means that the protocol is ABI/architecture specific:
  48  *  we currently can't model-check a x86 process from a x86_64 process.
  49  *
  50  *  Moreover the protocol is not stable. The same version of the library should be used
  51  *  for the client and the server.
  52  */
  53
  54 /* Basic structure: all message start with a message type */
  55 struct s_mc_message_t {
  56   enum e_mc_message_type type;
  57 };
  58
  59 struct s_mc_message_int_t {
  60   enum e_mc_message_type type;
  61   uint64_t value;
  62 };
  63
  64 /* Client->Server */
  65 struct s_mc_message_ignore_heap_t {
  66   enum e_mc_message_type type;
  67   int block;
  68   int fragment;
  69   void* address;
  70   size_t size;
  71 };
  72
  73 struct s_mc_message_ignore_memory_t {
  74   enum e_mc_message_type type;
  75   uint64_t addr;
  76   size_t size;
  77 };
  78
  79 struct s_mc_message_stack_region_t {
  80   enum e_mc_message_type type;
  81   s_stack_region_t stack_region;
  82 };
  83
  84 struct s_mc_message_register_symbol_t {
  85   enum e_mc_message_type type;
  86   char name[128];
  87   int (*callback)(void*);
  88   void* data;
  89 };
  90
  91 /* Server -> client */
  92 struct s_mc_message_simcall_handle_t {
  93   enum e_mc_message_type type;
  94   unsigned long pid;
  95   int value;
  96 };
  97
  98 struct s_mc_message_restore_t {
  99   enum e_mc_message_type type;
 100   int index;
 101 };
 102
 103 struct s_mc_message_actor_enabled_t {
 104   enum e_mc_message_type type;
 105   aid_t aid; // actor ID
 106 };
 107
 108 XBT_PRIVATE const char* MC_message_type_name(enum e_mc_message_type type);
 109
 110 SG_END_DECL
 111
 112 #endif