examples/s4u/mc-bugged1-liveness/s4u-mc-bugged1-liveness.cpp

   1 /* Copyright (c) 2012-2020. 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 /***************** Centralized Mutual Exclusion Algorithm *******************/
   7 /* This example implements a centralized mutual exclusion algorithm.        */
   8 /* Bug : CS requests of client 1 not satisfied                              */
   9 /* LTL property checked : G(r->F(cs)); (r=request of CS, cs=CS ok)          */
  10 /****************************************************************************/
  11
  12 #ifdef GARBAGE_STACK
  13 #include <fcntl.h>
  14 #include <sys/stat.h>
  15 #include <unistd.h>
  16 #endif
  17
  18 #include <simgrid/modelchecker.h>
  19 #include <simgrid/s4u.hpp>
  20 #include <xbt/dynar.h>
  21
  22 XBT_LOG_NEW_DEFAULT_CATEGORY(bugged1_liveness, "my log messages");
  23
  24 class Message {
  25 public:
  26   enum class Kind { GRANT, REQUEST, RELEASE };
  27   Kind kind                             = Kind::GRANT;
  28   simgrid::s4u::Mailbox* return_mailbox = nullptr;
  29   explicit Message(Message::Kind kind, simgrid::s4u::Mailbox* mbox) : kind(kind), return_mailbox(mbox) {}
  30 };
  31
  32 int r  = 0;
  33 int cs = 0;
  34
  35 #ifdef GARBAGE_STACK
  36 /** Do not use a clean stack */
  37 static void garbage_stack(void)
  38 {
  39   const size_t size = 256;
  40   int fd            = open("/dev/urandom", O_RDONLY);
  41   char foo[size];
  42   read(fd, foo, size);
  43   close(fd);
  44 }
  45 #endif
  46
  47 static void coordinator()
  48 {
  49   int CS_used = 0;
  50   const Message* m = nullptr;
  51   std::queue<simgrid::s4u::Mailbox*> requests;
  52
  53   simgrid::s4u::Mailbox* mbox = simgrid::s4u::Mailbox::by_name("coordinator");
  54
  55   while (1) {
  56     m = static_cast<Message*>(mbox->get());
  57     if (m->kind == Message::Kind::REQUEST) {
  58       if (CS_used) {
  59         XBT_INFO("CS already used. Queue the request.");
  60         requests.push(m->return_mailbox);
  61       } else {
  62         if (m->return_mailbox->get_name() != "1") {
  63           XBT_INFO("CS idle. Grant immediatly");
  64           m->return_mailbox->put(new Message(Message::Kind::GRANT, mbox), 1000);
  65           CS_used = 1;
  66         }
  67       }
  68     } else {
  69       if (not requests.empty()) {
  70         XBT_INFO("CS release. Grant to queued requests (queue size: %zu)", requests.size());
  71         simgrid::s4u::Mailbox* req = requests.front();
  72         requests.pop();
  73         if (req->get_name() != "1") {
  74           req->put(new Message(Message::Kind::GRANT, mbox), 1000);
  75         } else {
  76           requests.push(req);
  77           CS_used = 0;
  78         }
  79       } else {
  80         XBT_INFO("CS release. resource now idle");
  81         CS_used = 0;
  82       }
  83     }
  84     delete m;
  85   }
  86 }
  87
  88 static void client(int id)
  89 {
  90   int my_pid = simgrid::s4u::this_actor::get_pid();
  91
  92   simgrid::s4u::Mailbox* my_mailbox = simgrid::s4u::Mailbox::by_name(std::to_string(id));
  93
  94   while (1) {
  95     XBT_INFO("Ask the request");
  96     simgrid::s4u::Mailbox::by_name("coordinator")->put(new Message(Message::Kind::REQUEST, my_mailbox), 1000);
  97
  98     if (id == 1) {
  99       r  = 1;
 100       cs = 0;
 101       XBT_INFO("Propositions changed : r=1, cs=0");
 102     }
 103
 104     const Message* grant = static_cast<Message*>(my_mailbox->get());
 105
 106     if ((id == 1) && (grant->kind == Message::Kind::GRANT)) {
 107       cs = 1;
 108       r  = 0;
 109       XBT_INFO("Propositions changed : r=0, cs=1");
 110     }
 111
 112     delete grant;
 113
 114     XBT_INFO("%d got the answer. Sleep a bit and release it", id);
 115
 116     simgrid::s4u::this_actor::sleep_for(1);
 117
 118     simgrid::s4u::Mailbox::by_name("coordinator")->put(new Message(Message::Kind::RELEASE, my_mailbox), 1000);
 119
 120     simgrid::s4u::this_actor::sleep_for(my_pid);
 121
 122     if (id == 1) {
 123       cs = 0;
 124       r  = 0;
 125       XBT_INFO("Propositions changed : r=0, cs=0");
 126     }
 127   }
 128 }
 129
 130 static void raw_client(int id)
 131 {
 132 #ifdef GARBAGE_STACK
 133   // At this point the stack of the callee (client) is probably filled with
 134   // zeros and uninitialized variables will contain 0. This call will place
 135   // random byes in the stack of the callee:
 136   garbage_stack();
 137 #endif
 138   client(id);
 139 }
 140
 141 int main(int argc, char* argv[])
 142 {
 143   simgrid::s4u::Engine e(&argc, argv);
 144
 145   MC_automaton_new_propositional_symbol_pointer("r", &r);
 146   MC_automaton_new_propositional_symbol_pointer("cs", &cs);
 147
 148   e.load_platform(argv[1]);
 149
 150   simgrid::s4u::Actor::create("coordinator", simgrid::s4u::Host::by_name("Tremblay"), coordinator);
 151   if (std::stod(argv[2]) == 0) {
 152     simgrid::s4u::Actor::create("client", simgrid::s4u::Host::by_name("Boivin"), raw_client, 1);
 153     simgrid::s4u::Actor::create("client", simgrid::s4u::Host::by_name("Fafard"), raw_client, 2);
 154   } else { // "Visited" case
 155     simgrid::s4u::Actor::create("client", simgrid::s4u::Host::by_name("Boivin"), raw_client, 2);
 156     simgrid::s4u::Actor::create("client", simgrid::s4u::Host::by_name("Fafard"), raw_client, 1);
 157   }
 158   e.run();
 159
 160   return 0;
 161 }