src/mc/mc_protocol.h

   1 /* Copyright (c) 2015. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef MC_PROTOCOL_H
   8 #define MC_PROTOCOL_H
   9
  10 #include <xbt/misc.h>
  11
  12 #include "mc/datatypes.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 "SIMGRIC_MC"
  22
  23 /** Environment variable name used to pass the communication socket */
  24 #define MC_ENV_SOCKET_FD "SIMGRID_MC_SOCKET_FD"
  25
  26 // ***** MC mode
  27
  28 typedef enum {
  29   MC_MODE_NONE = 0,
  30   MC_MODE_STANDALONE,
  31   MC_MODE_CLIENT,
  32   MC_MODE_SERVER
  33 } e_mc_mode_t;
  34
  35 extern e_mc_mode_t mc_mode;
  36
  37 // ***** Messages
  38
  39 typedef enum {
  40   MC_MESSAGE_NONE,
  41   MC_MESSAGE_HELLO,
  42   MC_MESSAGE_CONTINUE,
  43   MC_MESSAGE_IGNORE_HEAP,
  44   MC_MESSAGE_UNIGNORE_HEAP,
  45   MC_MESSAGE_IGNORE_MEMORY,
  46   MC_MESSAGE_STACK_REGION,
  47   MC_MESSAGE_REGISTER_SYMBOL,
  48   MC_MESSAGE_DEADLOCK_CHECK,
  49   MC_MESSAGE_DEADLOCK_CHECK_REPLY,
  50 } e_mc_message_type;
  51
  52 #define MC_MESSAGE_LENGTH 512
  53
  54 /** Basic structure for a MC message
  55  *
  56  *  The current version of the client/server protocol sends C structures over `AF_LOCAL`
  57  *  `SOCK_DGRAM` sockets. This means that the protocol is ABI/architecture specific:
  58  *  we currently can't model-check a x86 process from a x86_64 process.
  59  *
  60  *  Moreover the protocol is not stable. The same version of the library should be used
  61  *  for the client and the server.
  62  *
  63  *  This is the basic structure shared by all messages: all message start with a message
  64  *  type.
  65  */
  66 typedef struct s_mc_message {
  67   e_mc_message_type type;
  68 } s_mc_message_t, *mc_message_t;
  69
  70 typedef struct s_mc_int_message {
  71   e_mc_message_type type;
  72   uint64_t value;
  73 } s_mc_int_message_t, *mc_int_message_t;
  74
  75 typedef struct s_mc_ignore_heap_message {
  76   e_mc_message_type type;
  77   s_mc_heap_ignore_region_t region;
  78 } s_mc_ignore_heap_message_t, *mc_ignore_heap_message_t;
  79
  80 typedef struct s_mc_ignore_memory_message {
  81   e_mc_message_type type;
  82   void *addr;
  83   size_t size;
  84 } s_mc_ignore_memory_message_t, *mc_ignore_memory_message_t;
  85
  86 typedef struct s_mc_stack_region_message {
  87   e_mc_message_type type;
  88   s_stack_region_t stack_region;
  89 } s_mc_stack_region_message_t, *mc_stack_region_message_t;
  90
  91 typedef struct s_mc_register_symbol_message {
  92   e_mc_message_type type;
  93   char name[128];
  94   int (*callback)(void*);
  95   void* data;
  96 } s_mc_register_symbol_message_t, * mc_register_symbol_message_t;
  97
  98 int MC_protocol_send(int socket, void* message, size_t size);
  99 int MC_protocol_send_simple_message(int socket, int type);
 100 int MC_protocol_hello(int socket);
 101 ssize_t MC_receive_message(int socket, void* message, size_t size);
 102
 103 SG_END_DECL()
 104
 105 #endif