-/* Copyright (c) 2006-2017. The SimGrid Team.
- * All rights reserved. */
+/* Copyright (c) 2006-2021. The SimGrid Team. All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
* under the terms of the license (GNU LGPL) which comes with this package. */
+#include <simgrid/s4u/Engine.hpp>
+#include <simgrid/s4u/Host.hpp>
+#include <simgrid/simdag.h>
+#include <xbt/Extendable.hpp>
+
#include <set>
#include <string>
#include <vector>
-#include "simgrid/simdag.h"
-#include "surf/surf.h"
#ifndef SIMDAG_PRIVATE_HPP
#define SIMDAG_PRIVATE_HPP
#endif
namespace simgrid{
+extern template class XBT_PUBLIC xbt::Extendable<sd::Task>;
+
namespace sd{
-class Global {
-public:
- explicit Global();
- Global(const Global&) = delete;
- ~Global();
- bool watch_point_reached; /* has a task just reached a watch point? */
- std::set<SD_task_t> *initial_tasks;
- std::set<SD_task_t> *runnable_tasks;
- std::set<SD_task_t> *completed_tasks;
- std::set<SD_task_t> *return_set;
-};
+class Global;
-std::set<SD_task_t>* simulate (double how_long);
-}
-}
+class Task : public xbt::Extendable<Task> {
+ friend sd::Global;
-extern "C" {
-extern XBT_PRIVATE simgrid::sd::Global *sd_global;
+ std::string name_;
+ double amount_;
-/* Task */
-struct s_SD_task_t {
- e_SD_task_state_t state;
- void *data; /* user data */
- char *name;
- e_SD_task_kind_t kind;
- double amount;
- double alpha; /* used by typed parallel tasks */
- double start_time;
- double finish_time;
- surf_action_t surf_action;
- unsigned short watch_points; /* bit field xor()ed with masks */
+ e_SD_task_kind_t kind_ = SD_TASK_NOT_TYPED;
+ e_SD_task_state_t state_ = SD_NOT_SCHEDULED;
+ bool marked_ = false; /* used to check if the task DAG has some cycle*/
+ double start_time_ = -1;
+ double finish_time_ = -1;
+ kernel::resource::Action* surf_action_;
+ unsigned short watch_points_ = 0; /* bit field xor()ed with masks */
+ double rate_ = -1;
- int marked; /* used to check if the task DAG has some cycle*/
+ double alpha_ = 0; /* used by typed parallel tasks */
/* dependencies */
- std::set<SD_task_t> *inputs;
- std::set<SD_task_t> *outputs;
- std::set<SD_task_t> *predecessors;
- std::set<SD_task_t> *successors;
+ std::set<Task*> dependencies_;
+ std::vector<Task*> successors_;
/* scheduling parameters (only exist in state SD_SCHEDULED) */
- std::vector<sg_host_t> *allocation;
- double *flops_amount;
- double *bytes_amount;
- double rate;
+ std::vector<s4u::Host*>* allocation_;
+ double* flops_amount_;
+ double* bytes_amount_;
+
+protected:
+ void set_start_time(double start) { start_time_ = start; }
+
+ void set_sender_side_allocation(unsigned long count, const std::vector<s4u::Host*>* sender);
+ void set_receiver_side_allocation(unsigned long count, const std::vector<s4u::Host*>* receiver);
+
+public:
+ static Task* create(const std::string& name, double amount, void* userdata);
+ static Task* create_comm_e2e(const std::string& name, double amount, void* userdata);
+ static Task* create_comp_seq(const std::string& name, double amount, void* userdata);
+ static Task* create_comp_par_amdahl(const std::string& name, double amount, void* userdata, double alpha);
+ static Task* create_comm_par_mxn_1d_block(const std::string& name, double amount, void* userdata);
+
+ void distribute_comp_amdahl(unsigned long count);
+ void build_MxN_1D_block_matrix(unsigned long src_nb, unsigned long dst_nb);
+
+ /** @brief Adds a dependency between with 'task'
+ * @a task will depend on this Task, i.e., it cannot start before this task is finished.
+ */
+ void dependency_add(Task* task);
+ bool dependency_exist(Task* task) const;
+ /** @brief Remove a dependency with 'task' */
+ void dependency_remove(Task* task);
+ void clear_successors() { successors_.clear(); }
+
+ void set_name(const std::string& name) { name_ = name; }
+ const std::string& get_name() const { return name_; }
+ const char* get_cname() const { return name_.c_str(); }
+
+ /** @brief Sets the total amount of work of a task
+ * For sequential typed tasks (COMP_SEQ and COMM_E2E), it also sets the appropriate values in the flops_amount and
+ * bytes_amount arrays respectively. Nothing more than modifying task->amount is done for parallel typed tasks
+ * (COMP_PAR_AMDAHL and COMM_PAR_MXN_1D_BLOCK) as the distribution of the amount of work is done at scheduling time.
+ */
+ void set_amount(double amount);
+ double get_amount() const { return amount_; }
+ /** @brief Returns the remaining amount of work (computation or data transfer) to do before completion */
+ double get_remaining_amount() const;
+ /** @brief Returns the start time of a task */
+ double get_start_time() const;
+ /** @brief Returns the finish time of a task
+ * If the state is not completed yet, the returned value is an estimation of the task finish time. This value can
+ * vary until the task is completed.
+ */
+ double get_finish_time() const;
+
+ void set_state(e_SD_task_state_t new_state);
+ e_SD_task_state_t get_state() const { return state_; }
+
+ void mark() { marked_ = true; }
+ void unmark() { marked_ = false; }
+ bool is_marked() const { return marked_; }
+
+ const std::set<Task*>& get_dependencies() const { return dependencies_; }
+ std::set<Task*> get_predecessors() const;
+ std::set<Task*> get_inputs() const;
+ const std::vector<Task*>& get_successors() const { return successors_; }
+ std::vector<Task*> get_outputs() const;
+
+ unsigned long has_unsolved_dependencies() const { return dependencies_.size(); }
+ unsigned long is_waited_by() const { return successors_.size(); }
+ void released_by(Task* pred);
+ void produced_by(Task* pred);
+
+ void set_kind(e_SD_task_kind_t kind) { kind_ = kind; }
+ e_SD_task_kind_t get_kind() const { return kind_; }
+
+ void set_alpha(double alpha) { alpha_ = alpha; }
+ /** @brief Sets the rate of a task
+ *
+ * This will change the network bandwidth a task can use. This rate cannot be dynamically changed. Once the task has
+ * started, this call is ineffective. This rate depends on both the nominal bandwidth on the route onto which the task
+ * is scheduled (@see SD_task_get_current_bandwidth) and the amount of data to transfer.
+ *
+ * To divide the nominal bandwidth by 2, the rate then has to be :
+ * rate = bandwidth/(2*amount)
+ */
+ void set_rate(double rate);
+
+ unsigned long get_allocation_size() const { return allocation_->size(); }
+ std::vector<s4u::Host*>* get_allocation() const { return allocation_; }
+
+ /** @brief Adds a watch point to a task
+ * sd::simulate() stops as soon as the @ref e_SD_task_state_t "state" of this task becomes the one given as argument.
+ * The watched state cannot be #SD_NOT_SCHEDULED
+ */
+ void watch(e_SD_task_state_t state);
+ /** @brief Removes a watch point on 'state' from a task */
+ void unwatch(e_SD_task_state_t state);
+
+ /** @brief Displays debugging information about a task */
+ void dump() const;
+
+ void do_schedule();
+ void schedule(const std::vector<s4u::Host*>& hosts, const double* flops_amount, const double* bytes_amount,
+ double rate);
+ void schedulev(const std::vector<s4u::Host*>& hosts);
+ /**
+ * @brief Unschedules a task. Its state becomes #SD_NOT_SCHEDULED. You can schedule it again afterwards */
+ void unschedule();
+
+ void run();
+ void destroy();
};
+class Global {
+public:
+ explicit Global(int* argc, char** argv) : engine_(new simgrid::s4u::Engine(argc, argv)) {}
+ bool watch_point_reached = false; /* has a task just reached a watch point? */
+ std::set<Task*> initial_tasks;
+ std::set<Task*> runnable_tasks;
+ std::set<Task*> completed_tasks;
+ std::set<Task*> return_set;
+ s4u::Engine* engine_;
+};
+
+} // namespace sd
+} // namespace simgrid
+
+extern XBT_PRIVATE std::unique_ptr<simgrid::sd::Global> sd_global;
+
/* SimDag private functions */
-XBT_PRIVATE void SD_task_set_state(SD_task_t task, e_SD_task_state_t new_state);
-XBT_PRIVATE void SD_task_run(SD_task_t task);
-XBT_PRIVATE bool acyclic_graph_detail(xbt_dynar_t dag);
-XBT_PRIVATE void uniq_transfer_task_name(SD_task_t task);
+XBT_PRIVATE bool check_for_cycle(const std::vector<simgrid::s4u::ActivityPtr>& dag);
XBT_PRIVATE const char *__get_state_name(e_SD_task_state_t state);
-}
#endif
