examples/python/async-waitall/async-waitall.py

   1 # Copyright (c) 2010-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 from simgrid import Comm, Engine, Mailbox, this_actor
   7 import sys
   8
   9 # This example shows how to block on the completion of a set of communications.
  10 #
  11 # As for the other asynchronous examples, the sender initiate all the messages it wants to send and
  12 # pack the resulting simgrid.Comm objects in a list. All messages thus occur concurrently.
  13 #
  14 # The sender then blocks until all ongoing communication terminate, using simgrid.Comm.wait_all()
  15
  16
  17 class Sender:
  18     def __init__(self, *args):
  19         if len(args) != 3:
  20             raise AssertionError("Actor sender requires 3 parameters, but got {:d}".format(len(args)))
  21         self.messages_count = int(args[0])  # number of tasks
  22         self.msg_size = int(args[1])  # communication cost (in bytes)
  23         self.receivers_count = int(args[2])  # number of receivers
  24
  25     def __call__(self):
  26         # List in which we store all ongoing communications
  27         pending_comms = []
  28
  29         # Vector of the used mailboxes
  30         mboxes = [Mailbox.by_name("receiver-{:d}".format(i))
  31                   for i in range(0, self.receivers_count)]
  32
  33         # Start dispatching all messages to receivers, in a round robin fashion
  34         for i in range(0, self.messages_count):
  35             content = "Message {:d}".format(i)
  36             mbox = mboxes[i % self.receivers_count]
  37
  38             this_actor.info("Send '{:s}' to '{:s}'".format(content, str(mbox)))
  39
  40             # Create a communication representing the ongoing communication, and store it in pending_comms
  41             comm = mbox.put_async(content, self.msg_size)
  42             pending_comms.append(comm)
  43
  44         # Start sending messages to let the workers know that they should stop
  45         for i in range(0, self.receivers_count):
  46             mbox = mboxes[i]
  47             this_actor.info("Send 'finalize' to '{:s}'".format(str(mbox)))
  48             comm = mbox.put_async("finalize", 0)
  49             pending_comms.append(comm)
  50
  51         this_actor.info("Done dispatching all messages")
  52
  53         # Now that all message exchanges were initiated, wait for their completion in one single call
  54         Comm.wait_all(pending_comms)
  55
  56         this_actor.info("Goodbye now!")
  57
  58
  59 class Receiver:
  60     def __init__(self, *args):
  61         if len(args) != 1:  # Receiver actor expects 1 argument: its ID
  62             raise AssertionError(
  63                 "Actor receiver requires 1 parameter, but got {:d}".format(len(args)))
  64         self.mbox = Mailbox.by_name("receiver-{:s}".format(args[0]))
  65
  66     def __call__(self):
  67         this_actor.info("Wait for my first message")
  68         while True:
  69             received = self.mbox.get()
  70             this_actor.info("I got a '{:s}'.".format(received))
  71             if received == "finalize":
  72                 break  # If it's a finalize message, we're done.
  73
  74
  75 if __name__ == '__main__':
  76     e = Engine(sys.argv)
  77
  78     # Load the platform description
  79     e.load_platform(sys.argv[1])
  80
  81     # Register the classes representing the actors
  82     e.register_actor("sender", Sender)
  83     e.register_actor("receiver", Receiver)
  84
  85     e.load_deployment(sys.argv[2])
  86
  87     e.run()