src/surf/surf_interface.hpp

   1 /* Copyright (c) 2004-2016. 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
  11 #include "src/surf/surf_private.h"
  12 #include "surf/surf.h"
  13 #include "xbt/str.h"
  14
  15 #include <boost/intrusive/list.hpp>
  16 #include <string>
  17
  18 #define NO_MAX_DURATION -1.0
  19
  20 /*********
  21  * Utils *
  22  *********/
  23
  24 /* user-visible parameters */
  25 extern XBT_PRIVATE double sg_tcp_gamma;
  26 extern XBT_PRIVATE double sg_sender_gap;
  27 extern XBT_PRIVATE double sg_latency_factor;
  28 extern XBT_PRIVATE double sg_bandwidth_factor;
  29 extern XBT_PRIVATE double sg_weight_S_parameter;
  30 extern XBT_PRIVATE int sg_network_crosstraffic;
  31 extern XBT_PRIVATE std::vector<std::string> surf_path;
  32
  33 extern "C" {
  34 XBT_PUBLIC(double) surf_get_clock();
  35 }
  36 /** \ingroup SURF_simulation
  37  *  \brief List of hosts that have just restarted and whose autorestart process should be restarted.
  38  */
  39 XBT_PUBLIC_DATA(std::vector<sg_host_t>) host_that_restart;
  40
  41
  42 extern XBT_PRIVATE double sg_sender_gap;
  43
  44 namespace simgrid {
  45 namespace surf {
  46
  47 extern XBT_PRIVATE simgrid::xbt::signal<void()> surfExitCallbacks;
  48 }
  49 }
  50
  51 int XBT_PRIVATE __surf_is_absolute_file_path(const char *file_path);
  52
  53 /***********
  54  * Classes *
  55  ***********/
  56
  57 enum heap_action_type{
  58   LATENCY = 100,
  59   MAX_DURATION,
  60   NORMAL,
  61   NOTSET
  62 };
  63
  64 /*********
  65  * Trace *
  66  *********/
  67 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
  68 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
  69
  70 /**********
  71  * Action *
  72  **********/
  73
  74 XBT_PRIVATE void surf_action_lmm_update_index_heap(void *action, int i);
  75
  76 /** \ingroup SURF_models
  77  *  \brief List of initialized models
  78  */
  79 XBT_PUBLIC_DATA(std::vector<surf_model_t>*) all_existing_models;
  80
  81 namespace simgrid {
  82 namespace surf {
  83
  84 /** @ingroup SURF_interface
  85  * @brief SURF action interface class
  86  * @details An action is an event generated by a resource (e.g.: a communication for the network)
  87  */
  88 XBT_PUBLIC_CLASS Action {
  89 public:
  90   boost::intrusive::list_member_hook<> action_hook;
  91   boost::intrusive::list_member_hook<> action_lmm_hook;
  92   typedef boost::intrusive::member_hook<
  93     Action, boost::intrusive::list_member_hook<>, &Action::action_hook> ActionOptions;
  94   typedef boost::intrusive::list<Action, ActionOptions> ActionList;
  95
  96   enum class State {
  97     ready = 0,        /**< Ready        */
  98     running,          /**< Running      */
  99     failed,           /**< Task Failure */
 100     done,             /**< Completed    */
 101     to_free,          /**< Action to free in next cleanup */
 102     not_in_the_system /**< Not in the system anymore. Why did you ask ? */
 103   };
 104
 105   /**
 106    * @brief Action constructor
 107    *
 108    * @param model The Model associated to this Action
 109    * @param cost The cost of the Action
 110    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
 111    */
 112   Action(simgrid::surf::Model *model, double cost, bool failed);
 113
 114   /**
 115    * @brief Action constructor
 116    *
 117    * @param model The Model associated to this Action
 118    * @param cost The cost of the Action
 119    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
 120    * @param var The lmm variable associated to this Action if it is part of a LMM component
 121    */
 122   Action(simgrid::surf::Model *model, double cost, bool failed, lmm_variable_t var);
 123
 124   /** @brief Destructor */
 125   virtual ~Action();
 126
 127   /** @brief Mark that the action is now finished */
 128   void finish();
 129
 130   /** @brief Get the [state](\ref simgrid::surf::Action::State) of the current Action */
 131   Action::State getState(); /**< get the state*/
 132   /** @brief Set the [state](\ref simgrid::surf::Action::State) of the current Action */
 133   virtual void setState(Action::State state);
 134
 135   /** @brief Get the bound of the current Action */
 136   double getBound();
 137   /** @brief Set the bound of the current Action */
 138   void setBound(double bound);
 139
 140   /** @brief Get the start time of the current action */
 141   double getStartTime();
 142   /** @brief Get the finish time of the current action */
 143   double getFinishTime();
 144
 145   /** @brief Get the user data associated to the current action */
 146   void *getData() {return data_;}
 147   /** @brief Set the user data associated to the current action */
 148   void setData(void* data);
 149
 150   /** @brief Get the cost of the current action */
 151   double getCost() {return cost_;}
 152   /** @brief Set the cost of the current action */
 153   void setCost(double cost) {cost_ = cost;}
 154
 155   /** @brief Update the maximum duration of the current action
 156    *  @param delta Amount to remove from the MaxDuration */
 157   void updateMaxDuration(double delta) {double_update(&maxDuration_, delta,sg_surf_precision);}
 158
 159   /** @brief Update the remaining time of the current action
 160    *  @param delta Amount to remove from the remaining time */
 161   void updateRemains(double delta) {double_update(&remains_, delta, sg_maxmin_precision*sg_surf_precision);}
 162
 163   /** @brief Set the remaining time of the current action */
 164   void setRemains(double value) {remains_ = value;}
 165   /** @brief Get the remaining time of the current action after updating the resource */
 166   virtual double getRemains();
 167   /** @brief Get the remaining time of the current action without updating the resource */
 168   double getRemainsNoUpdate();
 169
 170   /** @brief Set the finish time of the current action */
 171   void setFinishTime(double value) {finishTime_ = value;}
 172
 173   /**@brief Add a reference to the current action (refcounting) */
 174   void ref();
 175   /** @brief Unref that action (and destroy it if refcount reaches 0)
 176    *  @return true if the action was destroyed and false if someone still has references on it
 177    */
 178   virtual int unref();
 179
 180   /** @brief Cancel the current Action if running */
 181   virtual void cancel();
 182
 183   /** @brief Suspend the current Action */
 184   virtual void suspend();
 185
 186   /** @brief Resume the current Action */
 187   virtual void resume();
 188
 189   /** @brief Returns true if the current action is running */
 190   virtual bool isSuspended();
 191
 192   /** @brief Get the maximum duration of the current action */
 193   double getMaxDuration() {return maxDuration_;}
 194   /** @brief Set the maximum duration of the current Action */
 195   virtual void setMaxDuration(double duration);
 196
 197   /** @brief Get the tracing category associated to the current action */
 198   char *getCategory() {return category_;}
 199   /** @brief Set the tracing category of the current Action */
 200   void setCategory(const char *category);
 201
 202   /** @brief Get the priority of the current Action */
 203   double getPriority() { return sharingWeight_; };
 204   /** @brief Set the priority of the current Action */
 205   virtual void setSharingWeight(double priority);
 206
 207   /** @brief Get the state set in which the action is */
 208   ActionList* getStateSet() {return stateSet_;};
 209
 210   s_xbt_swag_hookup_t stateHookup_ = {nullptr,nullptr};
 211
 212   simgrid::surf::Model* getModel() { return model_; }
 213
 214 protected:
 215   ActionList* stateSet_;
 216   double sharingWeight_ = 1.0; /**< priority (1.0 by default) */
 217   int    refcount_ = 1;
 218   double remains_; /**< How much of that cost remains to be done in the currently running task */
 219   double maxDuration_ = NO_MAX_DURATION; /*< max_duration (may fluctuate until the task is completed) */
 220   double finishTime_ = -1; /**< finish time : this is modified during the run and fluctuates until the task is completed */
 221
 222 private:
 223   double start_; /**< start time  */
 224   char *category_ = nullptr;            /**< tracing category for categorized resource utilization monitoring */
 225
 226   double    cost_;
 227   simgrid::surf::Model *model_;
 228   void *data_ = nullptr; /**< for your convenience */
 229
 230   /* LMM */
 231 public:
 232   virtual void updateRemainingLazy(double now);
 233   void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
 234   void heapRemove(xbt_heap_t heap);
 235   void heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat);
 236   virtual void updateIndexHeap(int i);
 237   lmm_variable_t getVariable() {return variable_;}
 238   double getLastUpdate() {return lastUpdate_;}
 239   void refreshLastUpdate() {lastUpdate_ = surf_get_clock();}
 240   enum heap_action_type getHat() {return hat_;}
 241   bool is_linked() {return action_lmm_hook.is_linked();}
 242   void gapRemove();
 243
 244 protected:
 245   lmm_variable_t variable_ = nullptr;
 246   double lastValue_ = 0;
 247   double lastUpdate_ = 0;
 248   int suspended_ = 0;
 249   int indexHeap_;
 250   enum heap_action_type hat_ = NOTSET;
 251 };
 252
 253 typedef Action::ActionList ActionList;
 254
 255 typedef boost::intrusive::member_hook<
 256   Action, boost::intrusive::list_member_hook<>, &Action::action_lmm_hook> ActionLmmOptions;
 257 typedef boost::intrusive::list<Action, ActionLmmOptions> ActionLmmList;
 258 typedef ActionLmmList* ActionLmmListPtr;
 259
 260 /*********
 261  * Model *
 262  *********/
 263
 264 /** @ingroup SURF_interface
 265  * @brief SURF model interface class
 266  * @details A model is an object which handle the interactions between its Resources and its Actions
 267  */
 268 XBT_PUBLIC_CLASS Model {
 269 public:
 270   Model();
 271   virtual ~Model();
 272
 273   /** @brief Get the set of [actions](@ref Action) in *ready* state */
 274   virtual ActionList* getReadyActionSet() {return readyActionSet_;}
 275
 276   /** @brief Get the set of [actions](@ref Action) in *running* state */
 277   virtual ActionList* getRunningActionSet() {return runningActionSet_;}
 278
 279   /** @brief Get the set of [actions](@ref Action) in *failed* state */
 280   virtual ActionList* getFailedActionSet() {return failedActionSet_;}
 281
 282   /** @brief Get the set of [actions](@ref Action) in *done* state */
 283   virtual ActionList* getDoneActionSet() {return doneActionSet_;}
 284
 285   /** @brief Get the set of modified [actions](@ref Action) */
 286   virtual ActionLmmListPtr getModifiedSet() {return modifiedSet_;}
 287
 288   /** @brief Get the maxmin system of the current Model */
 289   lmm_system_t getMaxminSystem() {return maxminSystem_;}
 290
 291   /**
 292    * @brief Get the update mechanism of the current Model
 293    * @see e_UM_t
 294    */
 295   e_UM_t getUpdateMechanism() {return updateMechanism_;}
 296
 297   /** @brief Get Action heap */
 298   xbt_heap_t getActionHeap() {return actionHeap_;}
 299
 300   /**
 301    * @brief Share the resources between the actions
 302    *
 303    * @param now The current time of the simulation
 304    * @return The delta of time till the next action will finish
 305    */
 306   virtual double nextOccuringEvent(double now);
 307   virtual double nextOccuringEventLazy(double now);
 308   virtual double nextOccuringEventFull(double now);
 309
 310   /**
 311    * @brief Update action to the current time
 312    *
 313    * @param now The current time of the simulation
 314    * @param delta The delta of time since the last update
 315    */
 316   virtual void updateActionsState(double now, double delta);
 317   virtual void updateActionsStateLazy(double now, double delta);
 318   virtual void updateActionsStateFull(double now, double delta);
 319
 320   /** @brief Returns whether this model have an idempotent shareResource()
 321    *
 322    * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
 323    * so we need to call it only when the next timestamp of other sources is computed.
 324    */
 325   virtual bool nextOccuringEventIsIdempotent() { return true;}
 326
 327 protected:
 328   ActionLmmListPtr modifiedSet_;
 329   lmm_system_t maxminSystem_ = nullptr;
 330   e_UM_t updateMechanism_ = UM_UNDEFINED;
 331   bool selectiveUpdate_;
 332   xbt_heap_t actionHeap_;
 333
 334 private:
 335   ActionList* readyActionSet_; /**< Actions in state SURF_ACTION_READY */
 336   ActionList* runningActionSet_; /**< Actions in state SURF_ACTION_RUNNING */
 337   ActionList* failedActionSet_; /**< Actions in state SURF_ACTION_FAILED */
 338   ActionList* doneActionSet_; /**< Actions in state SURF_ACTION_DONE */
 339 };
 340
 341 }
 342 }
 343
 344 /************
 345  * Resource *
 346  ************/
 347
 348 /** @ingroup SURF_interface
 349  * @brief Resource which have a metric handled by a maxmin system
 350  */
 351 typedef struct {
 352   double peak;              /**< The peak of the metric, ie its max value */
 353   double scale;             /**< Current availability of the metric according to the traces, in [0,1] */
 354   tmgr_trace_event_t event; /**< The associated trace event associated to the metric */
 355 } s_surf_metric_t;
 356
 357 namespace simgrid {
 358 namespace surf {
 359
 360 /** @ingroup SURF_interface
 361  * @brief SURF resource interface class
 362  * @details This is the ancestor class of every resources in SimGrid, such as links, CPU or storage
 363  */
 364 XBT_PUBLIC_CLASS Resource {
 365 public:
 366   /**
 367    * @brief Constructor of LMM Resources
 368    *
 369    * @param model Model associated to this Resource
 370    * @param name The name of the Resource
 371    * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
 372    */
 373   Resource(Model *model, const char *name, lmm_constraint_t constraint);
 374
 375   virtual ~Resource();
 376
 377   /** @brief Get the Model of the current Resource */
 378   Model* model() const;
 379
 380   /** @brief Get the name of the current Resource */
 381   const char* cname() const;
 382
 383   bool operator==(const Resource &other) const;
 384
 385   /**
 386    * @brief Apply an event of external load event to that resource
 387    *
 388    * @param event What happened
 389    * @param value [TODO]
 390    */
 391   virtual void apply_event(tmgr_trace_event_t event, double value) = 0;
 392
 393   /** @brief Check if the current Resource is used (if it currently serves an action) */
 394   virtual bool isUsed()=0;
 395
 396   /** @brief Check if the current Resource is active */
 397   virtual bool isOn() const;
 398   /** @brief Check if the current Resource is shut down */
 399   virtual bool isOff() const;
 400   /** @brief Turn on the current Resource */
 401   virtual void turnOn();
 402   /** @brief Turn off the current Resource */
 403   virtual void turnOff();
 404
 405 private:
 406   std::string name_;
 407   Model *model_;
 408   bool isOn_ = true;
 409
 410 public: /* LMM */
 411   /** @brief Get the lmm constraint associated to this Resource if it is part of a LMM component (or null if none) */
 412   lmm_constraint_t constraint() const;
 413
 414 protected:
 415   const lmm_constraint_t constraint_ = nullptr;
 416 };
 417
 418 }
 419 }
 420
 421 namespace std {
 422   template <>
 423   struct hash<simgrid::surf::Resource>
 424   {
 425     std::size_t operator()(const simgrid::surf::Resource& r) const
 426     {
 427       return (std::size_t) xbt_str_hash(r.cname());
 428     }
 429   };
 430 }
 431
 432 #endif /* SURF_MODEL_H_ */