src/mc/remote/mc_protocol.h

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