src/mc/remote/mc_protocol.h

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