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   MC_MESSAGE_ACTOR_ENABLED,
  40   MC_MESSAGE_ACTOR_ENABLED_REPLY
  41 };
  42
  43 #define MC_MESSAGE_LENGTH 512
  44
  45 /** Basic structure for a MC message
  46  *
  47  *  The current version of the client/server protocol sends C structures over `AF_LOCAL`
  48  *  `SOCK_SEQPACKET` sockets. This means that the protocol is ABI/architecture specific:
  49  *  we currently can't model-check a x86 process from a x86_64 process.
  50  *
  51  *  Moreover the protocol is not stable. The same version of the library should be used
  52  *  for the client and the server.
  53  */
  54
  55 /* Basic structure: all message start with a message type */
  56 struct s_mc_message_t {
  57   enum e_mc_message_type type;
  58 };
  59
  60 struct s_mc_message_int_t {
  61   enum e_mc_message_type type;
  62   uint64_t value;
  63 };
  64
  65 /* Client->Server */
  66 struct s_mc_message_ignore_heap_t {
  67   enum e_mc_message_type type;
  68   int block;
  69   int fragment;
  70   void* address;
  71   size_t size;
  72 };
  73
  74 struct s_mc_message_ignore_memory_t {
  75   enum e_mc_message_type type;
  76   uint64_t addr;
  77   size_t size;
  78 };
  79
  80 struct s_mc_message_stack_region_t {
  81   enum e_mc_message_type type;
  82   s_stack_region_t stack_region;
  83 };
  84
  85 struct s_mc_message_register_symbol_t {
  86   enum e_mc_message_type type;
  87   char name[128];
  88   int (*callback)(void*);
  89   void* data;
  90 };
  91
  92 /* Server -> client */
  93 struct s_mc_message_simcall_handle_t {
  94   enum e_mc_message_type type;
  95   unsigned long pid;
  96   int value;
  97 };
  98
  99 struct s_mc_message_restore_t {
 100   enum e_mc_message_type type;
 101   int index;
 102 };
 103
 104 struct s_mc_message_actor_enabled_t {
 105   enum e_mc_message_type type;
 106   aid_t aid; // actor ID
 107 };
 108
 109 XBT_PRIVATE const char* MC_message_type_name(enum e_mc_message_type type);
 110
 111 SG_END_DECL()
 112
 113 #endif