src/surf/surf_interface.hpp

   1 /* Copyright (c) 2004-2014. The SimGrid Team.
   2  * All rights reserved.                                                     */
   3
   4 /* This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the license (GNU LGPL) which comes with this package. */
   6
   7 #ifndef SURF_MODEL_H_
   8 #define SURF_MODEL_H_
   9
  10 #include <xbt.h>
  11 #include <string>
  12 #include <vector>
  13 #include <memory>
  14 #include <boost/function.hpp>
  15 #include <boost/intrusive/list.hpp>
  16 #include "surf/trace_mgr.h"
  17 #include "xbt/lib.h"
  18 #include "surf/surf_routing.h"
  19 #include "simgrid/platf_interface.h"
  20 #include "surf/surf.h"
  21 #include "surf/surf_private.h"
  22 #include "internal_config.h"
  23
  24 #ifdef LIBSIGC
  25 #include <sigc++/sigc++.h>
  26 #define surf_callback(arg1, ...)  sigc::signal<arg1,__VA_ARGS__>
  27 #define surf_callback_connect(callback, fun_ptr) callback.connect(sigc::ptr_fun(fun_ptr))
  28 #define surf_callback_emit(callback, ...) callback.emit(__VA_ARGS__)
  29 #else
  30 #include <boost/signals2.hpp>
  31 #define surf_callback(arg1, ...)  boost::signals2::signal<arg1(__VA_ARGS__)>
  32 #define surf_callback_connect(callback, fun_ptr) callback.connect(fun_ptr)
  33 #define surf_callback_emit(callback, ...) callback(__VA_ARGS__)
  34 #endif
  35
  36 extern tmgr_history_t history;
  37 #define NO_MAX_DURATION -1.0
  38
  39 using namespace std;
  40
  41 /*********
  42  * Utils *
  43  *********/
  44
  45 /* user-visible parameters */
  46 extern double sg_tcp_gamma;
  47 extern double sg_sender_gap;
  48 extern double sg_latency_factor;
  49 extern double sg_bandwidth_factor;
  50 extern double sg_weight_S_parameter;
  51 extern int sg_network_crosstraffic;
  52 #ifdef HAVE_GTNETS
  53 extern double sg_gtnets_jitter;
  54 extern int sg_gtnets_jitter_seed;
  55 #endif
  56 extern xbt_dynar_t surf_path;
  57
  58 extern "C" {
  59 XBT_PUBLIC(double) surf_get_clock(void);
  60 }
  61
  62 extern double sg_sender_gap;
  63
  64 extern surf_callback(void, void) surfExitCallbacks;
  65
  66 int __surf_is_absolute_file_path(const char *file_path);
  67
  68 /***********
  69  * Classes *
  70  ***********/
  71 typedef boost::intrusive::list<Action> ActionList;
  72 typedef ActionList* ActionListPtr;
  73 typedef boost::intrusive::list_base_hook<> actionHook;
  74
  75 struct lmmTag;
  76 typedef boost::intrusive::list<Action, boost::intrusive::base_hook<boost::intrusive::list_base_hook<boost::intrusive::tag<lmmTag> > > > ActionLmmList;
  77 typedef ActionLmmList* ActionLmmListPtr;
  78 typedef boost::intrusive::list_base_hook<boost::intrusive::tag<lmmTag> > actionLmmHook;
  79
  80
  81 enum heap_action_type{
  82   LATENCY = 100,
  83   MAX_DURATION,
  84   NORMAL,
  85   NOTSET
  86 };
  87
  88 /*********
  89  * Trace *
  90  *********/
  91 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
  92 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
  93 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
  94 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
  95 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
  96 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
  97 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
  98
  99 /*********
 100  * Model *
 101  *********/
 102 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
 103
 104 /** @ingroup SURF_interface
 105  * @brief SURF model interface class
 106  * @details A model is an object which handle the interactions between its Resources and its Actions
 107  */
 108 XBT_PUBLIC_CLASS Model {
 109 public:
 110   /**
 111    * @brief Model constructor
 112    *
 113    * @param name the name of the model
 114    */
 115   Model(const char *name);
 116
 117   /**
 118    * @brief Model destructor
 119    */
 120   virtual ~Model();
 121
 122   virtual void addTraces() =0;
 123
 124   /**
 125    * @brief Get the name of the current Model
 126    *
 127    * @return The name of the current Model
 128    */
 129   const char *getName() {return p_name;}
 130
 131   /**
 132    * @brief Get the set of [actions](@ref Action) in *ready* state
 133    *
 134    * @return The set of [actions](@ref Action) in *ready* state
 135    */
 136   virtual ActionListPtr getReadyActionSet() {return p_readyActionSet;}
 137
 138   /**
 139    * @brief Get the set of [actions](@ref Action) in *running* state
 140    *
 141    * @return The set of [actions](@ref Action) in *running* state
 142    */
 143   virtual ActionListPtr getRunningActionSet() {return p_runningActionSet;}
 144
 145   /**
 146    * @brief Get the set of [actions](@ref Action) in *failed* state
 147    *
 148    * @return The set of [actions](@ref Action) in *failed* state
 149    */
 150   virtual ActionListPtr getFailedActionSet() {return p_failedActionSet;}
 151
 152   /**
 153    * @brief Get the set of [actions](@ref Action) in *done* state
 154    *
 155    * @return The set of [actions](@ref Action) in *done* state
 156    */
 157   virtual ActionListPtr getDoneActionSet() {return p_doneActionSet;}
 158
 159   /**
 160    * @brief Get the set of modified [actions](@ref Action)
 161    *
 162    * @return The set of modified [actions](@ref Action)
 163    */
 164   virtual ActionLmmListPtr getModifiedSet() {return p_modifiedSet;}
 165
 166   /**
 167    * @brief Get the maxmin system of the current Model
 168    *
 169    * @return The maxmin system of the current Model
 170    */
 171   lmm_system_t getMaxminSystem() {return p_maxminSystem;}
 172
 173   /**
 174    * @brief Get the update mechanism of the current Model
 175    * @see e_UM_t
 176    *
 177    * @return [description]
 178    */
 179   e_UM_t getUpdateMechanism() {return p_updateMechanism;}
 180
 181   /**
 182    * @brief Get Action heap
 183    * @details [TODO]
 184    *
 185    * @return The Action heap
 186    */
 187   xbt_heap_t getActionHeap() {return p_actionHeap;}
 188
 189   /**
 190    * @brief share the resources
 191    * @details Share the resources between the actions
 192    *
 193    * @param now The current time of the simulation
 194    * @return The delta of time till the next action will finish
 195    */
 196   virtual double shareResources(double now);
 197   virtual double shareResourcesLazy(double now);
 198   virtual double shareResourcesFull(double now);
 199   double shareResourcesMaxMin(ActionListPtr running_actions,
 200                                       lmm_system_t sys,
 201                                       void (*solve) (lmm_system_t));
 202
 203   /**
 204    * @brief Update state of actions
 205    * @details Update action to the current time
 206    *
 207    * @param now The current time of the simulation
 208    * @param delta The delta of time since the last update
 209    */
 210   virtual void updateActionsState(double now, double delta);
 211   virtual void updateActionsStateLazy(double now, double delta);
 212   virtual void updateActionsStateFull(double now, double delta);
 213
 214   /** @brief Returns whether this model have an idempotent shareResource()
 215    *
 216    * The only model that is not is NS3: computing the next timestamp moves the model up to that point,
 217    * so we need to call it only when the next timestamp of other sources is computed.
 218    */
 219   virtual bool shareResourcesIsIdempotent()=0;
 220
 221 protected:
 222   ActionLmmListPtr p_modifiedSet;
 223   lmm_system_t p_maxminSystem;
 224   e_UM_t p_updateMechanism;
 225   int m_selectiveUpdate;
 226   xbt_heap_t p_actionHeap;
 227
 228 private:
 229   const char *p_name;
 230
 231   ActionListPtr p_readyActionSet; /**< Actions in state SURF_ACTION_READY */
 232   ActionListPtr p_runningActionSet; /**< Actions in state SURF_ACTION_RUNNING */
 233   ActionListPtr p_failedActionSet; /**< Actions in state SURF_ACTION_FAILED */
 234   ActionListPtr p_doneActionSet; /**< Actions in state SURF_ACTION_DONE */
 235 };
 236
 237 /************
 238  * Resource *
 239  ************/
 240
 241 /** @ingroup SURF_interface
 242  * @brief Resource which have a metric handled by a maxmin system
 243  */
 244 typedef struct {
 245   double scale;             /**< The scale of the metric */
 246   double peak;              /**< The peak of the metric */
 247   tmgr_trace_event_t event; /**< The associated trace event associated to the metric */
 248 } s_surf_metric_t;
 249
 250 /** @ingroup SURF_interface
 251  * @brief SURF resource interface class
 252  * @details A resource represent an element of a component (e.g.: a link for the network)
 253  */
 254 XBT_PUBLIC_CLASS Resource {
 255 public:
 256   /**
 257    * @brief Resource constructor
 258    */
 259   Resource();
 260
 261   /**
 262    * @brief Resource constructor
 263    *
 264    * @param model Model associated to this Resource
 265    * @param name The name of the Resource
 266    * @param props Dictionary of properties associated to this Resource
 267    */
 268   Resource(Model *model, const char *name, xbt_dict_t props);
 269
 270   /**
 271    * @brief Resource constructor
 272    *
 273    * @param model Model associated to this Resource
 274    * @param name The name of the Resource
 275    * @param props Dictionary of properties associated to this Resource
 276    * @param constraint The lmm constraint associated to this Resource if it is part of a LMM component
 277    */
 278   Resource(Model *model, const char *name, xbt_dict_t props, lmm_constraint_t constraint);
 279   /**
 280    * @brief Resource constructor
 281    *
 282    * @param model Model associated to this Resource
 283    * @param name The name of the Resource
 284    * @param props Dictionary of properties associated to this Resource
 285    * @param stateInit the initial state of the Resource
 286    */
 287   Resource(Model *model, const char *name, xbt_dict_t props, e_surf_resource_state_t stateInit);
 288
 289   /**
 290    * @brief Resource destructor
 291    */
 292   virtual ~Resource();
 293
 294   /**
 295    * @brief Get the Model of the current Resource
 296    *
 297    * @return The Model of the current Resource
 298    */
 299   Model *getModel();
 300
 301   /**
 302    * @brief Get the name of the current Resource
 303    *
 304    * @return The name of the current Resource
 305    */
 306   const char *getName();
 307
 308   /**
 309    * @brief Get the properties of the current Resource
 310    *
 311    * @return The properties of the current Resource
 312    */
 313   virtual xbt_dict_t getProperties();
 314
 315   /**
 316    * @brief Update the state of the current Resource
 317    * @details [TODO]
 318    *
 319    * @param event_type [TODO]
 320    * @param value [TODO]
 321    * @param date [TODO]
 322    */
 323   virtual void updateState(tmgr_trace_event_t event_type, double value, double date)=0;
 324
 325   /**
 326    * @brief Check if the current Resource is used
 327    * @return true if the current Resource is used, false otherwise
 328    */
 329   virtual bool isUsed()=0;
 330
 331   /**
 332    * @brief Check if the current Resource is active
 333    *
 334    * @return true if the current Resource is active, false otherwise
 335    */
 336   bool isOn();
 337
 338   /**
 339    * @brief Turn on the current Resource
 340    */
 341   void turnOn();
 342
 343   /**
 344    * @brief Turn off the current Resource
 345    */
 346   void turnOff();
 347
 348   /**
 349    * @brief Get the [state](\ref e_surf_resource_state_t) of the current Resource
 350    *
 351    * @return The state of the currenrt Resource
 352    */
 353   virtual e_surf_resource_state_t getState();
 354
 355   /**
 356    * @brief Set the [state](\ref e_surf_resource_state_t) of the current Resource
 357    *
 358    * @param state The new state of the current Resource
 359    */
 360   virtual void setState(e_surf_resource_state_t state);
 361
 362 private:
 363   const char *p_name;
 364   xbt_dict_t p_properties;
 365   Model *p_model;
 366   bool m_running;
 367   e_surf_resource_state_t m_stateCurrent;
 368
 369   /* LMM */
 370 public:
 371   /**
 372    * @brief Get the lmm constraint associated to this Resource if it is part of a LMM component
 373    *
 374    * @return The lmm constraint associated to this Resource
 375    */
 376   lmm_constraint_t getConstraint();
 377 private:
 378   lmm_constraint_t p_constraint;
 379 };
 380
 381 /**********
 382  * Action *
 383  **********/
 384 void surf_action_lmm_update_index_heap(void *action, int i);
 385
 386 /** @ingroup SURF_interface
 387  * @brief SURF action interface class
 388  * @details An action is an event generated by a resource (e.g.: a communication for the network)
 389  */
 390 XBT_PUBLIC_CLASS Action : public actionHook, public actionLmmHook {
 391 private:
 392   /**
 393    * @brief Common initializations for the constructors
 394    */
 395   void initialize(Model *model, double cost, bool failed,
 396                   lmm_variable_t var = NULL);
 397
 398 public:
 399   /**
 400    * @brief Action constructor
 401    *
 402    * @param model The Model associated to this Action
 403    * @param cost The cost of the Action
 404    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
 405    */
 406   Action(Model *model, double cost, bool failed);
 407
 408   /**
 409    * @brief Action constructor
 410    *
 411    * @param model The Model associated to this Action
 412    * @param cost The cost of the Action
 413    * @param failed If the action is impossible (e.g.: execute something on a switched off host)
 414    * @param var The lmm variable associated to this Action if it is part of a LMM component
 415    */
 416   Action(Model *model, double cost, bool failed, lmm_variable_t var);
 417
 418   /** @brief Destructor */
 419   virtual ~Action();
 420
 421   /** @brief Mark that the action is now finished */
 422   void finish();
 423
 424   /** @brief Get the [state](\ref e_surf_action_state_t) of the current Action */
 425   e_surf_action_state_t getState(); /**< get the state*/
 426   /** @brief Set the [state](\ref e_surf_action_state_t) of the current Action */
 427   virtual void setState(e_surf_action_state_t state);
 428
 429   /** @brief Get the bound of the current Action */
 430   double getBound();
 431   /** @brief Set the bound of the current Action */
 432   void setBound(double bound);
 433
 434   /** @brief Get the start time of the current action */
 435   double getStartTime();
 436   /** @brief Get the finish time of the current action */
 437   double getFinishTime();
 438
 439   /** @brief Get the user data associated to the current action */
 440   void *getData() {return p_data;}
 441   /** @brief Set the user data associated to the current action */
 442   void setData(void* data);
 443
 444   /** @brief Get the cost of the current action */
 445   double getCost() {return m_cost;}
 446   /** @brief Set the cost of the current action */
 447   void setCost(double cost) {m_cost = cost;}
 448
 449   /** @brief Update the maximum duration of the current action
 450    *  @param delta Amount to remove from the MaxDuration */
 451   void updateMaxDuration(double delta) {double_update(&m_maxDuration, delta,sg_surf_precision);}
 452
 453   /** @brief Update the remaining time of the current action
 454    *  @param delta Amount to remove from the remaining time */
 455   void updateRemains(double delta) {double_update(&m_remains, delta, sg_maxmin_precision*sg_surf_precision);}
 456
 457   /** @brief Set the remaining time of the current action */
 458   void setRemains(double value) {m_remains = value;}
 459   /** @brief Get the remaining time of the current action after updating the resource */
 460   virtual double getRemains();
 461   /** @brief Get the remaining time of the current action without updating the resource */
 462   double getRemainsNoUpdate();
 463
 464   /** @brief Set the finish time of the current action */
 465   void setFinishTime(double value) {m_finish = value;}
 466
 467   /**@brief Add a reference to the current action (refcounting) */
 468   void ref();
 469   /** @brief Unref that action (and destroy it if refcount reaches 0)
 470    *  @return true if the action was destroyed and false if someone still has references on it
 471    */
 472   virtual int unref();
 473
 474   /** @brief Cancel the current Action if running */
 475   virtual void cancel();
 476
 477   /** @brief Suspend the current Action */
 478   virtual void suspend();
 479
 480   /** @brief Resume the current Action */
 481   virtual void resume();
 482
 483   /** @brief Returns true if the current action is running */
 484   virtual bool isSuspended();
 485
 486   /** @brief Get the maximum duration of the current action */
 487   double getMaxDuration() {return m_maxDuration;}
 488   /** @brief Set the maximum duration of the current Action */
 489   virtual void setMaxDuration(double duration);
 490
 491   /** @brief Get the tracing category associated to the current action */
 492   char *getCategory() {return p_category;}
 493   /** @brief Set the tracing category of the current Action */
 494   void setCategory(const char *category);
 495
 496   /** @brief Get the priority of the current Action */
 497   double getPriority() {return m_priority;};
 498   /** @brief Set the priority of the current Action */
 499   virtual void setPriority(double priority);
 500
 501   /**
 502    * @brief Get the state set in which the action is
 503    *
 504    * @return The state set in which the action is
 505    */
 506   ActionListPtr getStateSet() {return p_stateSet;};
 507
 508   s_xbt_swag_hookup_t p_stateHookup;
 509
 510   Model *getModel() {return p_model;}
 511
 512 protected:
 513   ActionListPtr p_stateSet;
 514   double m_priority; /**< priority (1.0 by default) */
 515   int    m_refcount;
 516   double m_remains; /**< How much of that cost remains to be done in the currently running task */
 517   double m_maxDuration; /*< max_duration (may fluctuate until the task is completed) */
 518   double m_finish; /**< finish time : this is modified during the run and fluctuates until the task is completed */
 519
 520 private:
 521   bool m_failed;
 522   double m_start; /**< start time  */
 523   char *p_category;               /**< tracing category for categorized resource utilization monitoring */
 524
 525   #ifdef HAVE_LATENCY_BOUND_TRACKING
 526   int m_latencyLimited;               /**< Set to 1 if is limited by latency, 0 otherwise */
 527   #endif
 528   double    m_cost;
 529   Model *p_model;
 530   void *p_data; /**< for your convenience */
 531
 532   /* LMM */
 533 public:
 534   virtual void updateRemainingLazy(double now);
 535   void heapInsert(xbt_heap_t heap, double key, enum heap_action_type hat);
 536   void heapRemove(xbt_heap_t heap);
 537   void heapUpdate(xbt_heap_t heap, double key, enum heap_action_type hat);
 538   void updateIndexHeap(int i);
 539   lmm_variable_t getVariable() {return p_variable;}
 540   double getLastUpdate() {return m_lastUpdate;}
 541   void refreshLastUpdate() {m_lastUpdate = surf_get_clock();}
 542   enum heap_action_type getHat() {return m_hat;}
 543   bool is_linked() {return actionLmmHook::is_linked();}
 544   void gapRemove();
 545
 546 protected:
 547   lmm_variable_t p_variable;
 548   double m_lastValue;
 549   double m_lastUpdate;
 550   int m_suspended;
 551   int m_indexHeap;
 552   enum heap_action_type m_hat;
 553 };
 554
 555 #endif /* SURF_MODEL_H_ */