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 // ***** Messages
  27
  28 typedef enum {
  29   MC_MESSAGE_NONE = 0,
  30   MC_MESSAGE_HELLO = 1,
  31   MC_MESSAGE_CONTINUE = 2,
  32   MC_MESSAGE_IGNORE_REGION = 3,
  33 } e_mc_message_type;
  34
  35 #define MC_MESSAGE_LENGTH 512
  36
  37 /** Basic structure for a MC message
  38  *
  39  *  The current version of the client/server protocol sends C structures over `AF_LOCAL`
  40  *  `SOCK_DGRAM` sockets. This means that the protocol is ABI/architecture specific:
  41  *  we currently can't model-check a x86 process from a x86_64 process.
  42  *
  43  *  Moreover the protocol is not stable. The same version of the library should be used
  44  *  for the client and the server.
  45  *
  46  *  This is the basic structure shared by all messages: all message start with a message
  47  *  type.
  48  */
  49 typedef struct s_mc_message {
  50   e_mc_message_type type;
  51 } s_mc_message_t, *mc_message_t;
  52
  53 typedef struct s_mc_ignore_region_message {
  54   e_mc_message_type type;
  55   s_mc_heap_ignore_region_t region;
  56 } s_mc_ignore_region_message_t, *mc_ignore_region_message_t;
  57
  58 int MC_protocol_send(int socket, void* message, size_t size);
  59 int MC_protocol_send_simple_message(int socket, int type);
  60 int MC_protocol_hello(int socket);
  61
  62 SG_END_DECL()
  63
  64 #endif