examples/cpp/io-priority/s4u-io-priority.cpp

   1 /* Copyright (c) 2010-2022. 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 #include "simgrid/s4u.hpp"
   7
   8 XBT_LOG_NEW_DEFAULT_CATEGORY(s4u_test, "Messages specific for this s4u example");
   9 namespace sg4 = simgrid::s4u;
  10
  11 static void writer()
  12 {
  13   /* - Retrieve all disks from current host */
  14   std::vector<sg4::Disk*> const& disk_list = sg4::Host::current()->get_disks();
  15   /* - Write 4,000,000 bytes on Disk1 */
  16   disk_list.front()->write(4000000);
  17   XBT_INFO("First write done.");
  18   /* - Write 4,000,000 bytes on Disk1 again */
  19   disk_list.front()->write(4000000);
  20   XBT_INFO("Second write done.");
  21 }
  22
  23 static void privileged_writer()
  24 {
  25   /* - Retrieve all disks from current host */
  26   std::vector<sg4::Disk*> const& disk_list = sg4::Host::current()->get_disks();
  27
  28   /* - Write 4,000,000 bytes on Disk1 but specifies that this I/O operation gets a larger share of the resource.
  29    *
  30    * Since the priority is 2, it writes twice as fast as a regular one.
  31    *
  32    * So instead of a half/half sharing between the two, we get a 1/3 vs. 2/3 sharing. */
  33   disk_list.front()->write(4000000, 2);
  34   XBT_INFO("First write done.");
  35
  36   /* Note that the timings printed when running this example are a bit misleading, because the uneven sharing only last
  37    * until the privileged actor ends. After this point, the unprivileged one gets 100% of the disk and finishes quite
  38    * quickly. */
  39
  40   /* Resynchronize actors before second write */
  41   sg4::this_actor::sleep_for(0.05);
  42
  43   /* - Write 4,000,000 bytes on Disk1 again and this time :
  44    *    - Start the I/O operation asynchronously to get an IoPtr
  45    *    - Let the actor sleep while half of the data is written
  46    *    - Double its priority
  47    *    - Wait for the end of the I/O operation
  48    *
  49    *   Writing the second half of the data with a higher priority, and thus 2/3 of the bandwidth takes 0.075s.
  50    *   In the meantime, the regular writer has only 1/3 of the bandwidth and thus only writes 1MB. After the completion
  51    *   of the I/O initiated by the privileged writer, the regular writer has the full bandwidth available and only needs
  52    *   0.025s to write the last MB.
  53    */
  54
  55   sg4::IoPtr io = disk_list.front()->write_async(4000000);
  56   sg4::this_actor::sleep_for(0.1);
  57   XBT_INFO("Increase priority for the priviledged writer (%.0f bytes remaining to write)", io->get_remaining());
  58   io->update_priority(2);
  59   io->wait();
  60   XBT_INFO("Second write done.");
  61 }
  62
  63 int main(int argc, char* argv[])
  64 {
  65   sg4::Engine e(&argc, argv);
  66   xbt_assert(argc > 1, "Usage: %s platform_file\n\tExample: %s platform.xml\n", argv[0], argv[0]);
  67
  68   e.load_platform(argv[1]);
  69
  70   sg4::Actor::create("writer", e.host_by_name("bob"), writer);
  71   sg4::Actor::create("privileged_writer", e.host_by_name("bob"), privileged_writer);
  72
  73   e.run();
  74
  75   return 0;
  76 }