src/include/surf/maxmin.h

   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_MAXMIN_H
   8 #define _SURF_MAXMIN_H
   9
  10 #include "portable.h"
  11 #include "xbt/misc.h"
  12 #include "surf/datatypes.h"
  13 #include <math.h>
  14
  15
  16 /** @addtogroup SURF_lmm
  17  * @details
  18  * A linear maxmin solver to resolves inequations systems.
  19  *
  20  * Most SimGrid model rely on a "fluid/steady-state" modeling that
  21  * samount to share resources between actions at relatively
  22  * coarse-grain.  Such sharing is generally done by solving a set of
  23  * linear inequations. Let's take an example and assume we have the
  24  * variables \f$x_1\f$, \f$x_2\f$, \f$x_3\f$, and \f$x_4\f$ . Let's
  25  * say that \f$x_1\f$ and \f$x_2\f$ correspond to activities running
  26  * and the same CPU \f$A\f$ whose capacity is \f$C_A\f$ . In such a
  27  * case, we need to enforce:
  28  *
  29  *   \f[ x_1 + x_2 \leq C_A \f]
  30  *
  31  * Likewise, if \f$x_3\f$ (resp. \f$x_4\f$) corresponds to a network
  32  * flow \f$F_3\f$ (resp. \f$F_4\f$) that goes through a set of links
  33  * \f$L_1\f$ and \f$L_2\f$ (resp. \f$L_2\f$ and \f$L_3\f$), then we
  34  * need to enforce:
  35  *
  36  *   \f[ x_3  \leq C_{L_1} \f]
  37  *   \f[ x_3 + x_4 \leq C_{L_2} \f]
  38  *   \f[ x_4 \leq C_{L_3} \f]
  39  *
  40  * One could set every variable to 0 to make sure the constraints are
  41  * satisfied but this would obviously not be very realistic. A
  42  * possible objective is to try to maximize the minimum of the
  43  * \f$x_i\f$ . This ensures that all the \f$x_i\f$ are positive and "as
  44  * large as possible".
  45  *
  46  * This is called *max-min fairness* and is the most commonly used
  47  * objective in SimGrid. Another possibility is to maximize
  48  * \f$\sum_if(x_i)\f$, where \f$f\f$ is a strictly increasing concave
  49  * function.
  50  *
  51  * Constraint:
  52  *  - bound (set)
  53  *  - shared (set)
  54  *  - usage (computed)
  55  * Variable:
  56  *  - weight (set)
  57  *  - bound (set)
  58  *  - value (computed)
  59  * Element:
  60  *  - value (set)
  61  *
  62  * A possible system could be:
  63  * - three variables: `var1`, `var2`, `var3`
  64  * - two constraints: `cons1`, `cons2`
  65  * - four elements linking:
  66  *  - `elem1` linking `var1` and `cons1`
  67  *  - `elem2` linking `var2` and `cons1`
  68  *  - `elem3` linking `var2` and `cons2`
  69  *  - `elem4` linking `var3` and `cons2`
  70  *
  71  * And the corresponding inequations will be:
  72  *
  73  *     var1.value <= var1.bound
  74  *     var2.value <= var2.bound
  75  *     var3.value <= var3.bound
  76  *     var1.weight * var1.value * elem1.value + var2.weight * var2.value * elem2.value <= cons1.bound
  77  *     var2.weight * var2.value * elem3.value + var3.weight * var3.value * elem4.value <= cons2.bound
  78  *
  79  * where `var1.value`, `var2.value` and `var3.value` are the unknown values
  80  *
  81  * if a constraint is not shared the sum is replace by a max
  82  *
  83  * Its usefull for the sharing of resources for various models.
  84  * For instance for the network model the link are associated
  85  * to consrtaint and the communications to variables.
  86  */
  87
  88 extern double sg_maxmin_precision;
  89 #define MAXMIN_PRECISION sg_maxmin_precision
  90 static XBT_INLINE void double_update(double *variable, double value)
  91 {
  92   *variable -= value;
  93   if (*variable < MAXMIN_PRECISION)
  94     *variable = 0.0;
  95 }
  96
  97 static XBT_INLINE int double_positive(double value)
  98 {
  99   return (value > MAXMIN_PRECISION);
 100 }
 101
 102 static XBT_INLINE int double_equals(double value1, double value2)
 103 {
 104   return (fabs(value1 - value2) < MAXMIN_PRECISION);
 105 }
 106
 107 SG_BEGIN_DECL()
 108
 109 /** @{ @ingroup SURF_lmm */
 110 /**
 111  * @brief Create a new Linear MaxMim system
 112  *
 113  * @param selective_update [description]
 114  */
 115 XBT_PUBLIC(lmm_system_t) lmm_system_new(int selective_update);
 116
 117 /**
 118  * @brief Free an existing Linear MaxMin system
 119  *
 120  * @param sys The lmm system to free
 121  */
 122 XBT_PUBLIC(void) lmm_system_free(lmm_system_t sys);
 123
 124 /**
 125  * @brief Create a new Linear MaxMin constraint
 126  *
 127  * @param sys The system in which we add a constraint
 128  * @param id Data associated to the constraint (e.g.: a network link)
 129  * @param bound_value The bound value of the constraint
 130  */
 131 XBT_PUBLIC(lmm_constraint_t) lmm_constraint_new(lmm_system_t sys, void *id,
 132                                                 double bound_value);
 133
 134 /**
 135  * @brief Share a constraint
 136  * @details [long description]
 137  *
 138  * @param cnst The constraint to share
 139  */
 140 void lmm_constraint_shared(lmm_constraint_t cnst);
 141
 142 /**
 143  * @brief Check if a constraint is shared (shared by default)
 144  *
 145  * @param cnst The constraint to share
 146  * @return 1 if shared, 0 otherwise
 147  */
 148 int lmm_constraint_is_shared(lmm_constraint_t cnst);
 149
 150 /**
 151  * @brief Free a constraint
 152  *
 153  * @param sys The system associated to the constraint
 154  * @param cnst The constraint to free
 155  */
 156 void lmm_constraint_free(lmm_system_t sys, lmm_constraint_t cnst);
 157
 158 /**
 159  * @brief Get the usage of the constraint after the last lmm solve
 160  *
 161  * @param cnst A constraint
 162  * @return The usage of the constraint
 163  */
 164 double lmm_constraint_get_usage(lmm_constraint_t cnst);
 165
 166 /**
 167  * @brief Create a new Linear MaxMin variable
 168  *
 169  * @param sys The system in which we add a constaint
 170  * @param id Data associated to the variable (e.g.: a network communication)
 171  * @param weight_value The weight of the variable (0.0 if not used)
 172  * @param bound The maximum value of the variable (-1.0 if no maximum value)
 173  * @param number_of_constraints The maximum number of constraint to associate to the variable
 174  */
 175 XBT_PUBLIC(lmm_variable_t) lmm_variable_new(lmm_system_t sys, void *id,
 176                                             double weight_value,
 177                                             double bound,
 178                                             int number_of_constraints);
 179 /**
 180  * @brief Free a variable
 181  *
 182  * @param sys The system associated to the variable
 183  * @param var The variable to free
 184  */
 185 XBT_PUBLIC(void) lmm_variable_free(lmm_system_t sys, lmm_variable_t var);
 186
 187 /**
 188  * @brief Get the value of the variable after the last lmm solve
 189  *
 190  * @param var A variable
 191  * @return The value of the variable
 192  */
 193 XBT_PUBLIC(double) lmm_variable_getvalue(lmm_variable_t var);
 194
 195 /**
 196  * @brief Get the maximum value of the variable (-1.0 if no maximum value)
 197  *
 198  * @param var A variable
 199  * @return The bound of the variable
 200  */
 201 XBT_PUBLIC(double) lmm_variable_getbound(lmm_variable_t var);
 202
 203 /**
 204  * @brief Remove a variable from a constraint
 205  *
 206  * @param sys A system
 207  * @param cnst A constraint
 208  * @param var The variable to remove
 209  */
 210 XBT_PUBLIC(void) lmm_shrink(lmm_system_t sys, lmm_constraint_t cnst,
 211                             lmm_variable_t var);
 212
 213 /**
 214  * @brief Associate a variable to a constraint with a coefficient
 215  *
 216  * @param sys A system
 217  * @param cnst A constraint
 218  * @param var A variable
 219  * @param value The coefficient associated to the variable in the constraint
 220  */
 221 XBT_PUBLIC(void) lmm_expand(lmm_system_t sys, lmm_constraint_t cnst,
 222                             lmm_variable_t var, double value);
 223
 224 /**
 225  * @brief Add value to the coefficient between a constraint and a variable or
 226  *        create one
 227  *
 228  * @param sys A system
 229  * @param cnst A constraint
 230  * @param var A variable
 231  * @param value The value to add to the coefficient associated to the variable in the constraint
 232  */
 233 void lmm_expand_add(lmm_system_t sys, lmm_constraint_t cnst,
 234                     lmm_variable_t var, double value);
 235
 236 /**
 237  * @brief Get the numth constraint associated to the variable
 238  *
 239  * @param sys The system associated to the variable (not used)
 240  * @param var A variable
 241  * @param num The rank of constraint we want to get
 242  * @return The numth constraint
 243  */
 244 lmm_constraint_t lmm_get_cnst_from_var(lmm_system_t sys,
 245                                        lmm_variable_t var, int num);
 246
 247 /**
 248  * @brief Get the weigth of the numth constraint associated to the variable
 249  *
 250  * @param sys The system associated to the variable (not used)
 251  * @param var A variable
 252  * @param num The rank of constraint we want to get
 253  * @return The numth constraint
 254  */
 255 double lmm_get_cnst_weight_from_var(lmm_system_t sys, lmm_variable_t var,
 256                                     int num);
 257
 258 /**
 259  * @brief Get the number of constraint associated to a variable
 260  *
 261  * @param sys The system associated to the variable (not used)
 262  * @param var A variable
 263  * @return The number of constraint associated to the variable
 264  */
 265 int lmm_get_number_of_cnst_from_var(lmm_system_t sys, lmm_variable_t var);
 266
 267 /**
 268  * @brief Get a var associated to a constraint
 269  * @details Get the first variable of the next variable of elem if elem is not NULL
 270  *
 271  * @param sys The system associated to the variable (not used)
 272  * @param cnst A constraint
 273  * @param elem A element of constraint of the constraint or NULL
 274  * @return A variable associated to a constraint
 275  */
 276 lmm_variable_t lmm_get_var_from_cnst(lmm_system_t sys,
 277                                      lmm_constraint_t cnst,
 278                                      lmm_element_t * elem);
 279
 280 /**
 281  * @brief Get the first active constraint of a system
 282  *
 283  * @param sys A system
 284  * @return The first active constraint
 285  */
 286 lmm_constraint_t lmm_get_first_active_constraint(lmm_system_t sys);
 287
 288 /**
 289  * @brief Get the next active constraint of a constraint in a system
 290  *
 291  * @param sys A system
 292  * @param cnst An active constraint of the system
 293  *
 294  * @return The next active constraint
 295  */
 296 lmm_constraint_t lmm_get_next_active_constraint(lmm_system_t sys,
 297                                                 lmm_constraint_t cnst);
 298
 299 #ifdef HAVE_LATENCY_BOUND_TRACKING
 300 XBT_PUBLIC(int) lmm_is_variable_limited_by_latency(lmm_variable_t var);
 301 #endif
 302
 303 /**
 304  * @brief Get the data associated to a constraint
 305  *
 306  * @param cnst A constraint
 307  * @return The data associated to the constraint
 308  */
 309 void *lmm_constraint_id(lmm_constraint_t cnst);
 310
 311 /**
 312  * @brief Get the data associated to a variable
 313  *
 314  * @param var A variable
 315  * @return The data associated to the variable
 316  */
 317 void *lmm_variable_id(lmm_variable_t var);
 318
 319 /**
 320  * @brief Update the value of element linking the constraint and the variable
 321  *
 322  * @param sys A system
 323  * @param cnst A constraint
 324  * @param var A variable
 325  * @param value The new value
 326  */
 327 void lmm_update(lmm_system_t sys, lmm_constraint_t cnst,
 328                 lmm_variable_t var, double value);
 329
 330 /**
 331  * @brief Update the bound of a variable
 332  *
 333  * @param sys A system
 334  * @param var A constraint
 335  * @param bound The new bound
 336  */
 337 void lmm_update_variable_bound(lmm_system_t sys, lmm_variable_t var,
 338                                double bound);
 339
 340 /**
 341  * @brief Update the weight of a variable
 342  *
 343  * @param sys A system
 344  * @param var A variable
 345  * @param weight The new weight of the variable
 346  */
 347 XBT_PUBLIC(void) lmm_update_variable_weight(lmm_system_t sys,
 348                                             lmm_variable_t var,
 349                                             double weight);
 350
 351 /**
 352  * @brief Get the weight of a variable
 353  *
 354  * @param var A variable
 355  * @return The weight of the variable
 356  */
 357 double lmm_get_variable_weight(lmm_variable_t var);
 358
 359 /**
 360  * @brief Update a constraint bound
 361  *
 362  * @param sys A system
 363  * @param cnst A constraint
 364  * @param bound The new bound of the consrtaint
 365  */
 366 XBT_PUBLIC(void) lmm_update_constraint_bound(lmm_system_t sys,
 367                                              lmm_constraint_t cnst,
 368                                              double bound);
 369
 370 /**
 371  * @brief [brief description]
 372  *
 373  * @param sys A system
 374  * @param cnst A constraint
 375  * @return [description]
 376  */
 377 int lmm_constraint_used(lmm_system_t sys, lmm_constraint_t cnst);
 378
 379 /**
 380  * @brief Solve the lmm system
 381  *
 382  * @param sys The lmm system to solve
 383  */
 384 XBT_PUBLIC(void) lmm_solve(lmm_system_t sys);
 385
 386 XBT_PUBLIC(void) lagrange_solve(lmm_system_t sys);
 387 XBT_PUBLIC(void) bottleneck_solve(lmm_system_t sys);
 388
 389 /**
 390  * Default functions associated to the chosen protocol. When
 391  * using the lagrangian approach.
 392  */
 393
 394 XBT_PUBLIC(void) lmm_set_default_protocol_function(double (*func_f)
 395                                                     (lmm_variable_t var,
 396                                                      double x),
 397                                                    double (*func_fp)
 398                                                     (lmm_variable_t var,
 399                                                      double x),
 400                                                    double (*func_fpi)
 401                                                     (lmm_variable_t var,
 402                                                      double x));
 403
 404 XBT_PUBLIC(double func_reno_f) (lmm_variable_t var, double x);
 405 XBT_PUBLIC(double func_reno_fp) (lmm_variable_t var, double x);
 406 XBT_PUBLIC(double func_reno_fpi) (lmm_variable_t var, double x);
 407
 408 XBT_PUBLIC(double func_reno2_f) (lmm_variable_t var, double x);
 409 XBT_PUBLIC(double func_reno2_fp) (lmm_variable_t var, double x);
 410 XBT_PUBLIC(double func_reno2_fpi) (lmm_variable_t var, double x);
 411
 412 XBT_PUBLIC(double func_vegas_f) (lmm_variable_t var, double x);
 413 XBT_PUBLIC(double func_vegas_fp) (lmm_variable_t var, double x);
 414 XBT_PUBLIC(double func_vegas_fpi) (lmm_variable_t var, double x);
 415
 416 /** @} */
 417 SG_END_DECL()
 418
 419 #endif                          /* _SURF_MAXMIN_H */