src/surf/surf_interface.hpp

   1 /* Copyright (c) 2004-2017. 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 #ifndef SURF_MODEL_H_
   7 #define SURF_MODEL_H_
   8
   9 #include "xbt/signal.hpp"
  10 #include "xbt/utility.hpp"
  11
  12 #include "src/surf/surf_private.hpp"
  13 #include "surf/surf.hpp"
  14 #include "xbt/str.h"
  15
  16 #include <boost/heap/pairing_heap.hpp>
  17 #include <boost/intrusive/list.hpp>
  18 #include <boost/optional.hpp>
  19 #include <cmath>
  20 #include <set>
  21 #include <string>
  22 #include <unordered_map>
  23
  24 #define NO_MAX_DURATION -1.0
  25
  26 /*********
  27  * Utils *
  28  *********/
  29
  30 /* user-visible parameters */
  31 XBT_PUBLIC_DATA(double) sg_maxmin_precision;
  32 XBT_PUBLIC_DATA(double) sg_surf_precision;
  33 XBT_PUBLIC_DATA(int) sg_concurrency_limit;
  34
  35 extern XBT_PRIVATE double sg_tcp_gamma;
  36 extern XBT_PRIVATE double sg_latency_factor;
  37 extern XBT_PRIVATE double sg_bandwidth_factor;
  38 extern XBT_PRIVATE double sg_weight_S_parameter;
  39 extern XBT_PRIVATE int sg_network_crosstraffic;
  40 extern XBT_PRIVATE std::vector<std::string> surf_path;
  41 extern XBT_PRIVATE std::unordered_map<std::string, tmgr_trace_t> traces_set_list;
  42 extern XBT_PRIVATE std::set<std::string> watched_hosts;
  43
  44 static inline void double_update(double* variable, double value, double precision)
  45 {
  46   // printf("Updating %g -= %g +- %g\n",*variable,value,precision);
  47   // xbt_assert(value==0  || value>precision);
  48   // Check that precision is higher than the machine-dependent size of the mantissa. If not, brutal rounding  may
  49   // happen, and the precision mechanism is not active...
  50   // xbt_assert(*variable< (2<<DBL_MANT_DIG)*precision && FLT_RADIX==2);
  51   *variable -= value;
  52   if (*variable < precision)
  53     *variable = 0.0;
  54 }
  55
  56 static inline int double_positive(double value, double precision)
  57 {
  58   return (value > precision);
  59 }
  60
  61 static inline int double_equals(double value1, double value2, double precision)
  62 {
  63   return (fabs(value1 - value2) < precision);
  64 }
  65
  66 extern "C" {
  67 XBT_PUBLIC(double) surf_get_clock();
  68 }
  69 /** \ingroup SURF_simulation
  70  *  \brief List of hosts that have just restarted and whose autorestart process should be restarted.
  71  */
  72 XBT_PUBLIC_DATA(std::vector<sg_host_t>) host_that_restart;
  73
  74 int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
  75
  76 /**********
  77  * Action *
  78  **********/
  79
  80 /** \ingroup SURF_models
  81  *  \brief List of initialized models
  82  */
  83 XBT_PUBLIC_DATA(std::vector<surf_model_t>*) all_existing_models;
  84
  85 namespace simgrid {
  86 namespace surf {
  87
  88 typedef std::pair<double, simgrid::surf::Action*> heap_element_type;
  89 typedef boost::heap::pairing_heap<heap_element_type, boost::heap::constant_time_size<false>, boost::heap::stable<true>,
  90                                   boost::heap::compare<simgrid::xbt::HeapComparator<heap_element_type>>>
  91     heap_type;
  92
  93 /** @ingroup SURF_interface
  94  * @brief SURF action interface class
  95  * @details An action is an event generated by a resource (e.g.: a communication for the network)
  96  */
  97 XBT_PUBLIC_CLASS Action {
  98 public:
  99   boost::intrusive::list_member_hook<> modifiedSetHook_; /* Used by the lazy update to list the actions to track */
 100
 101   boost::intrusive::list_member_hook<> stateSetHook_;
 102   typedef boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::stateSetHook_>
 103       ActionOptions;
 104   typedef boost::intrusive::list<Action, ActionOptions> ActionList;
 105
 106   enum class State {
 107     ready = 0,        /**< Ready        */
 108     running,          /**< Running      */
 109     failed,           /**< Task Failure */
 110     done,             /**< Completed    */
 111     to_free,          /**< Action to free in next cleanup */
 112     not_in_the_system /**< Not in the system anymore. Why did you ask ? */
 113   };
 114
 115   enum class SuspendStates {
 116     not_suspended = 0, /**< Action currently not suspended **/
 117     suspended,
 118     sleeping
 119   };
 120
 121   enum class Type { LATENCY = 100, MAX_DURATION, NORMAL, NOTSET };
 122
 123   /**
 124    * @brief Action constructor
 125    *
 126    * @param model The Model associated to this Action
 127    * @param cost The cost of the Action
 128    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
 129    */
 130   Action(simgrid::surf::Model* model, double cost, bool failed);
 131
 132   /**
 133    * @brief Action constructor
 134    *
 135    * @param model The Model associated to this Action
 136    * @param cost The cost of the Action
 137    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
 138    * @param var The lmm variable associated to this Action if it is part of a LMM component
 139    */
 140   Action(simgrid::surf::Model * model, double cost, bool failed, kernel::lmm::Variable* var);
 141
 142   virtual ~Action();
 143
 144   /**
 145    * @brief Mark that the action is now finished
 146    *
 147    * @param state the new [state](\ref simgrid::surf::Action::State) of the current Action
 148    */
 149   void finish(Action::State state);
 150
 151   /** @brief Get the [state](\ref simgrid::surf::Action::State) of the current Action */
 152   Action::State getState() const; /**< get the state*/
 153   /** @brief Set the [state](\ref simgrid::surf::Action::State) of the current Action */
 154   virtual void setState(Action::State state);
 155
 156   /** @brief Get the bound of the current Action */
 157   double getBound() const;
 158   /** @brief Set the bound of the current Action */
 159   void setBound(double bound);
 160
 161   /** @brief Get the start time of the current action */
 162   double getStartTime() const { return start_; }
 163   /** @brief Get the finish time of the current action */
 164   double getFinishTime() const { return finishTime_; }
 165
 166   /** @brief Get the user data associated to the current action */
 167   void* getData() const { return data_; }
 168   /** @brief Set the user data associated to the current action */
 169   void setData(void* data) { data_ = data; }
 170
 171   /** @brief Get the cost of the current action */
 172   double getCost() const { return cost_; }
 173   /** @brief Set the cost of the current action */
 174   void setCost(double cost) {cost_ = cost;}
 175
 176   /** @brief Update the maximum duration of the current action
 177    *  @param delta Amount to remove from the MaxDuration */
 178   void updateMaxDuration(double delta) {double_update(&maxDuration_, delta,sg_surf_precision);}
 179
 180   /** @brief Update the remaining time of the current action
 181    *  @param delta Amount to remove from the remaining time */
 182   void updateRemains(double delta) {double_update(&remains_, delta, sg_maxmin_precision*sg_surf_precision);}
 183
 184   /** @brief Set the remaining time of the current action */
 185   void setRemains(double value) {remains_ = value;}
 186   /** @brief Get the remaining time of the current action after updating the resource */
 187   virtual double getRemains();
 188   /** @brief Get the remaining time of the current action without updating the resource */
 189   double getRemainsNoUpdate() const { return remains_; }
 190
 191   /** @brief Set the finish time of the current action */
 192   void setFinishTime(double value) {finishTime_ = value;}
 193
 194   /**@brief Add a reference to the current action (refcounting) */
 195   void ref();
 196   /** @brief Unref that action (and destroy it if refcount reaches 0)
 197    *  @return true if the action was destroyed and false if someone still has references on it
 198    */
 199   virtual int unref();
 200
 201   /** @brief Cancel the current Action if running */
 202   virtual void cancel();
 203
 204   /** @brief Suspend the current Action */
 205   virtual void suspend();
 206
 207   /** @brief Resume the current Action */
 208   virtual void resume();
 209
 210   /** @brief Returns true if the current action is running */
 211   virtual bool isSuspended();
 212
 213   /** @brief Get the maximum duration of the current action */
 214   double getMaxDuration() const { return maxDuration_; }
 215   /** @brief Set the maximum duration of the current Action */
 216   virtual void setMaxDuration(double duration);
 217
 218   /** @brief Get the tracing category associated to the current action */
 219   char* getCategory() const { return category_; }
 220   /** @brief Set the tracing category of the current Action */
 221   void setCategory(const char *category);
 222
 223   /** @brief Get the priority of the current Action */
 224   double getPriority() const { return sharingWeight_; };
 225   /** @brief Set the priority of the current Action */
 226   virtual void setSharingWeight(double priority);
 227   void setSharingWeightNoUpdate(double weight) { sharingWeight_ = weight; }
 228
 229   /** @brief Get the state set in which the action is */
 230   ActionList* getStateSet() const { return stateSet_; };
 231
 232   simgrid::surf::Model* getModel() const { return model_; }
 233
 234 protected:
 235   ActionList* stateSet_;
 236   int    refcount_ = 1;
 237
 238 private:
 239   double sharingWeight_ = 1.0;             /**< priority (1.0 by default) */
 240   double maxDuration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
 241   double remains_;                       /**< How much of that cost remains to be done in the currently running task */
 242   double start_; /**< start time  */
 243   char *category_ = nullptr;            /**< tracing category for categorized resource utilization monitoring */
 244   double finishTime_ =
 245       -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
 246
 247   double    cost_;
 248   simgrid::surf::Model *model_;
 249   void *data_ = nullptr; /**< for your convenience */
 250
 251   /* LMM */
 252   double lastUpdate_                                  = 0;
 253   double lastValue_                                   = 0;
 254   kernel::lmm::Variable* variable_                    = nullptr;
 255   Action::Type type_                                  = Action::Type::NOTSET;
 256   boost::optional<heap_type::handle_type> heapHandle_ = boost::none;
 257
 258 public:
 259   virtual void updateRemainingLazy(double now) { THROW_IMPOSSIBLE; };
 260   void heapInsert(heap_type & heap, double key, Action::Type hat);
 261   void heapRemove(heap_type& heap);
 262   void heapUpdate(heap_type & heap, double key, Action::Type hat);
 263   void clearHeapHandle() { heapHandle_ = boost::none; }
 264   kernel::lmm::Variable* getVariable() const { return variable_; }
 265   void setVariable(kernel::lmm::Variable * var) { variable_ = var; }
 266   double getLastUpdate() const { return lastUpdate_; }
 267   void refreshLastUpdate() {lastUpdate_ = surf_get_clock();}
 268   double getLastValue() const { return lastValue_; }
 269   void setLastValue(double val) { lastValue_ = val; }
 270   Action::Type getType() const { return type_; }
 271   bool is_linked() const { return modifiedSetHook_.is_linked(); }
 272
 273 protected:
 274   Action::SuspendStates suspended_ = Action::SuspendStates::not_suspended;
 275 };
 276
 277 typedef Action::ActionList ActionList;
 278
 279 typedef boost::intrusive::member_hook<Action, boost::intrusive::list_member_hook<>, &Action::modifiedSetHook_>
 280     ActionLmmOptions;
 281 typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
 282 typedef ActionLmmList* ActionLmmListPtr;
 283
 284 /*********
 285  * Model *
 286  *********/
 287
 288 /** @ingroup SURF_interface
 289  * @brief SURF model interface class
 290  * @details A model is an object which handle the interactions between its Resources and its Actions
 291  */
 292 XBT_PUBLIC_CLASS Model {
 293 public:
 294   Model();
 295   virtual ~Model();
 296
 297   /** @brief Get the set of [actions](@ref Action) in *ready* state */
 298   virtual ActionList* getReadyActionSet() const { return readyActionSet_; }
 299
 300   /** @brief Get the set of [actions](@ref Action) in *running* state */
 301   virtual ActionList* getRunningActionSet() const { return runningActionSet_; }
 302
 303   /** @brief Get the set of [actions](@ref Action) in *failed* state */
 304   virtual ActionList* getFailedActionSet() const { return failedActionSet_; }
 305
 306   /** @brief Get the set of [actions](@ref Action) in *done* state */
 307   virtual ActionList* getDoneActionSet() const { return doneActionSet_; }
 308
 309   /** @brief Get the set of modified [actions](@ref Action) */
 310   virtual ActionLmmListPtr getModifiedSet() const { return modifiedSet_; }
 311
 312   /** @brief Get the maxmin system of the current Model */
 313   lmm_system_t getMaxminSystem() const { return maxminSystem_; }
 314
 315   /**
 316    * @brief Get the update mechanism of the current Model
 317    * @see e_UM_t
 318    */
 319   e_UM_t getUpdateMechanism() const { return updateMechanism_; }
 320   void setUpdateMechanism(e_UM_t mechanism) { updateMechanism_ = mechanism; }
 321
 322   /** @brief Get Action heap */
 323   heap_type& getActionHeap() { return actionHeap_; }
 324
 325   double actionHeapTopDate() const { return actionHeap_.top().first; }
 326   Action* actionHeapPop();
 327   bool actionHeapIsEmpty() const { return actionHeap_.empty(); }
 328
 329   /**
 330    * @brief Share the resources between the actions
 331    *
 332    * @param now The current time of the simulation
 333    * @return The delta of time till the next action will finish
 334    */
 335   virtual double nextOccuringEvent(double now);
 336   virtual double nextOccuringEventLazy(double now);
 337   virtual double nextOccuringEventFull(double now);
 338
 339   /**
 340    * @brief Update action to the current time
 341    *
 342    * @param now The current time of the simulation
 343    * @param delta The delta of time since the last update
 344    */
 345   virtual void updateActionsState(double now, double delta);
 346   virtual void updateActionsStateLazy(double now, double delta);
 347   virtual void updateActionsStateFull(double now, double delta);
 348
 349   /** @brief Returns whether this model have an idempotent shareResource()
 350    *
 351    * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
 352    * so we need to call it only when the next timestamp of other sources is computed.
 353    */
 354   virtual bool nextOccuringEventIsIdempotent() { return true;}
 355
 356 protected:
 357   ActionLmmListPtr modifiedSet_;
 358   lmm_system_t maxminSystem_ = nullptr;
 359   bool selectiveUpdate_;
 360
 361 private:
 362   e_UM_t updateMechanism_ = UM_UNDEFINED;
 363   ActionList* readyActionSet_; /**< Actions in state SURF_ACTION_READY */
 364   ActionList* runningActionSet_; /**< Actions in state SURF_ACTION_RUNNING */
 365   ActionList* failedActionSet_; /**< Actions in state SURF_ACTION_FAILED */
 366   ActionList* doneActionSet_; /**< Actions in state SURF_ACTION_DONE */
 367   heap_type actionHeap_;
 368 };
 369
 370 }
 371 }
 372
 373 /************
 374  * Resource *
 375  ************/
 376
 377
 378 #endif /* SURF_MODEL_H_ */