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