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_CLIENT,
  31   MC_MODE_SERVER
  32 } e_mc_mode_t;
  33
  34 extern e_mc_mode_t mc_mode;
  35
  36 // ***** Messages
  37
  38 typedef enum {
  39   MC_MESSAGE_NONE,
  40   MC_MESSAGE_HELLO,
  41   MC_MESSAGE_CONTINUE,
  42   MC_MESSAGE_IGNORE_HEAP,
  43   MC_MESSAGE_UNIGNORE_HEAP,
  44   MC_MESSAGE_IGNORE_MEMORY,
  45   MC_MESSAGE_STACK_REGION,
  46   MC_MESSAGE_REGISTER_SYMBOL,
  47   MC_MESSAGE_DEADLOCK_CHECK,
  48   MC_MESSAGE_DEADLOCK_CHECK_REPLY,
  49   MC_MESSAGE_WAITING,
  50   MC_MESSAGE_SIMCALL_HANDLE,
  51   MC_MESSAGE_ASSERTION_FAILED,
  52 } e_mc_message_type;
  53
  54 #define MC_MESSAGE_LENGTH 512
  55
  56 /** Basic structure for a MC message
  57  *
  58  *  The current version of the client/server protocol sends C structures over `AF_LOCAL`
  59  *  `SOCK_DGRAM` sockets. This means that the protocol is ABI/architecture specific:
  60  *  we currently can't model-check a x86 process from a x86_64 process.
  61  *
  62  *  Moreover the protocol is not stable. The same version of the library should be used
  63  *  for the client and the server.
  64  *
  65  *  This is the basic structure shared by all messages: all message start with a message
  66  *  type.
  67  */
  68 typedef struct s_mc_message {
  69   e_mc_message_type type;
  70 } s_mc_message_t, *mc_message_t;
  71
  72 typedef struct s_mc_int_message {
  73   e_mc_message_type type;
  74   uint64_t value;
  75 } s_mc_int_message_t, *mc_int_message_t;
  76
  77 typedef struct s_mc_ignore_heap_message {
  78   e_mc_message_type type;
  79   s_mc_heap_ignore_region_t region;
  80 } s_mc_ignore_heap_message_t, *mc_ignore_heap_message_t;
  81
  82 typedef struct s_mc_ignore_memory_message {
  83   e_mc_message_type type;
  84   void *addr;
  85   size_t size;
  86 } s_mc_ignore_memory_message_t, *mc_ignore_memory_message_t;
  87
  88 typedef struct s_mc_stack_region_message {
  89   e_mc_message_type type;
  90   s_stack_region_t stack_region;
  91 } s_mc_stack_region_message_t, *mc_stack_region_message_t;
  92
  93 typedef struct s_mc_simcall_handle_message {
  94   e_mc_message_type type;
  95   unsigned long pid;
  96   int value;
  97 } s_mc_simcall_handle_message_t, *mc_simcall_handle_message;
  98
  99 typedef struct s_mc_register_symbol_message {
 100   e_mc_message_type type;
 101   char name[128];
 102   int (*callback)(void*);
 103   void* data;
 104 } s_mc_register_symbol_message_t, * mc_register_symbol_message_t;
 105
 106 XBT_INTERNAL int MC_protocol_send(int socket, const void* message, size_t size);
 107 XBT_INTERNAL int MC_protocol_send_simple_message(int socket, e_mc_message_type type);
 108 XBT_INTERNAL int MC_protocol_hello(int socket);
 109 XBT_INTERNAL ssize_t MC_receive_message(int socket, void* message, size_t size, int options);
 110
 111 XBT_INTERNAL const char* MC_message_type_name(e_mc_message_type type);
 112 XBT_INTERNAL const char* MC_mode_name(e_mc_mode_t mode);
 113
 114 SG_END_DECL()
 115
 116 #endif