1 /* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
2 * All rights reserved. */
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. */
11 #include "xbt/dynar.h"
15 #include "xbt/config.h"
16 #include "surf/datatypes.h"
18 #include "surf/surf_routing.h"
19 #include "simgrid/platf_interface.h"
22 /* Actions and models are highly connected structures... */
25 SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
26 SURF_NETWORK_ELEMENT_HOST, /* host type */
27 SURF_NETWORK_ELEMENT_ROUTER, /* router type */
28 SURF_NETWORK_ELEMENT_AS, /* AS type */
29 } e_surf_network_element_type_t;
31 XBT_PUBLIC(e_surf_network_element_type_t) get_network_element_type(const char
34 /** @Brief Specify that we use that action */
35 XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
36 /** @brief Creates a new action.
38 * @param size The size is the one of the subtype you want to create
39 * @param cost initial value
40 * @param model to which model we should attach this action
41 * @param failed whether we should start this action in failed mode
43 XBT_PUBLIC(void *) surf_action_new(size_t size, double cost,
44 surf_model_t model, int failed);
46 /** \brief Resource model description
48 typedef struct surf_model_description {
50 const char *description;
51 void_f_void_t model_init_preparse;
52 } s_surf_model_description_t, *surf_model_description_t;
54 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table,
56 XBT_PUBLIC(void) model_help(const char *category,
57 s_surf_model_description_t * table);
59 /** \brief Action structure
60 * \ingroup SURF_actions
62 * Never create s_surf_action_t by yourself ! The actions are created
63 * on the fly when you call execute or communicate on a model.
65 * \see e_surf_action_state_t
67 typedef struct surf_action {
68 s_xbt_swag_hookup_t state_hookup;
70 double cost; /**< cost */
71 double priority; /**< priority (1.0 by default) */
72 double max_duration; /**< max_duration (may fluctuate until
73 the task is completed) */
74 double remains; /**< How much of that cost remains to
75 * be done in the currently running task */
76 #ifdef HAVE_LATENCY_BOUND_TRACKING
77 int latency_limited; /**< Set to 1 if is limited by latency, 0 otherwise */
80 double start; /**< start time */
81 double finish; /**< finish time : this is modified during the run
82 * and fluctuates until the task is completed */
83 void *data; /**< for your convenience */
85 surf_model_t model_type;
87 char *category; /**< tracing category for categorized resource utilization monitoring */
91 typedef struct surf_action_lmm {
92 s_surf_action_t generic_action;
93 lmm_variable_t variable;
95 } s_surf_action_lmm_t, *surf_action_lmm_t;
97 /** \brief Action states
98 * \ingroup SURF_actions
102 * \see surf_action_t, surf_action_state_t
105 SURF_ACTION_READY = 0, /**< Ready */
106 SURF_ACTION_RUNNING, /**< Running */
107 SURF_ACTION_FAILED, /**< Task Failure */
108 SURF_ACTION_DONE, /**< Completed */
109 SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
110 SURF_ACTION_NOT_IN_THE_SYSTEM
111 /**< Not in the system anymore. Why did you ask ? */
112 } e_surf_action_state_t;
114 /** \brief Action state sets
115 * \ingroup SURF_actions
117 * This structure contains some sets of actions.
118 * It provides a fast access to the actions in each state.
120 * \see surf_action_t, e_surf_action_state_t
122 typedef struct surf_action_state {
123 xbt_swag_t ready_action_set;
124 /**< Actions in state SURF_ACTION_READY */
125 xbt_swag_t running_action_set;
126 /**< Actions in state SURF_ACTION_RUNNING */
127 xbt_swag_t failed_action_set;
128 /**< Actions in state SURF_ACTION_FAILED */
129 xbt_swag_t done_action_set;
130 /**< Actions in state SURF_ACTION_DONE */
131 } s_surf_action_state_t, *surf_action_state_t;
133 /***************************/
134 /* Generic model object */
135 /***************************/
136 typedef struct s_routing_global s_routing_global_t, *routing_global_t;
137 XBT_PUBLIC_DATA(routing_global_t) global_routing;
140 /** \brief Private data available on all models
141 * \ingroup SURF_models
143 typedef struct surf_model_private *surf_model_private_t;
147 /** \brief CPU model extension public
148 * \ingroup SURF_models
150 * Public functions specific to the CPU model.
152 typedef struct surf_cpu_model_extension_public {
153 surf_action_t(*execute) (void *cpu, double size);
154 surf_action_t(*sleep) (void *cpu, double duration);
155 e_surf_resource_state_t(*get_state) (void *cpu);
156 double (*get_speed) (void *cpu, double load);
157 double (*get_available_speed) (void *cpu);
158 void* (*create_resource) (const char *name, double power_peak,
160 tmgr_trace_t power_trace,
162 e_surf_resource_state_t state_initial,
163 tmgr_trace_t state_trace,
164 xbt_dict_t cpu_properties);
165 void (*add_traces) (void);
166 } s_surf_model_extension_cpu_t;
170 /** \brief Network model extension public
171 * \ingroup SURF_models
173 * Public functions specific to the network model
175 typedef struct surf_network_model_extension_public {
176 surf_action_t(*communicate) (const char *src_name,
177 const char *dst_name,
178 double size, double rate);
179 xbt_dynar_t(*get_route) (const char *src_name, const char *dst_name);
180 double (*get_link_bandwidth) (const void *link);
181 double (*get_link_latency) (const void *link);
182 int (*link_shared) (const void *link);
183 void (*add_traces) (void);
184 void* (*create_resource) (const char *name,
186 tmgr_trace_t bw_trace,
188 tmgr_trace_t lat_trace,
189 e_surf_resource_state_t
191 tmgr_trace_t state_trace,
192 e_surf_link_sharing_policy_t policy,
193 xbt_dict_t properties);
194 } s_surf_model_extension_network_t;
196 /** \brief Workstation model extension public
197 * \ingroup SURF_models
199 * Public functions specific to the workstation model.
201 typedef struct surf_workstation_model_extension_public {
202 surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
203 and create the corresponding action */
204 surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
205 e_surf_resource_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
206 double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
207 double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
208 surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
209 void *workstation_dst, double size,
211 xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst); /**< Get the list of links between two ws */
213 surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
214 void **workstation_list,
215 double *computation_amount,
216 double *communication_amount,
217 double amount, double rate);
218 double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
219 double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
220 int (*link_shared) (const void *link);
221 xbt_dict_t(*get_properties) (const void *resource);
222 void* (*link_create_resource) (const char *name,
224 tmgr_trace_t bw_trace,
226 tmgr_trace_t lat_trace,
227 e_surf_resource_state_t
229 tmgr_trace_t state_trace,
230 e_surf_link_sharing_policy_t
231 policy, xbt_dict_t properties);
232 void* (*cpu_create_resource) (const char *name, double power_peak,
234 tmgr_trace_t power_trace,
235 e_surf_resource_state_t state_initial,
236 tmgr_trace_t state_trace,
237 xbt_dict_t cpu_properties);
238 void (*add_traces) (void);
240 } s_surf_model_extension_workstation_t;
245 /** \brief Model datatype
246 * \ingroup SURF_models
248 * Generic data structure for a model. The workstations,
249 * the CPUs and the network links are examples of models.
251 typedef struct surf_model {
252 const char *name; /**< Name of this model */
253 s_surf_action_state_t states; /**< Any living action on this model */
255 e_surf_action_state_t(*action_state_get) (surf_action_t action);
256 /**< Return the state of an action */
257 void (*action_state_set) (surf_action_t action,
258 e_surf_action_state_t state);
259 /**< Change an action state*/
261 double (*action_get_start_time) (surf_action_t action); /**< Return the start time of an action */
262 double (*action_get_finish_time) (surf_action_t action); /**< Return the finish time of an action */
263 int (*action_unref) (surf_action_t action); /**< Specify that we don't use that action anymore */
264 void (*action_cancel) (surf_action_t action); /**< Cancel a running action */
265 void (*action_recycle) (surf_action_t action); /**< Recycle an action */
266 void (*action_data_set) (surf_action_t action, void *data); /**< Set the user data of an action */
267 void (*suspend) (surf_action_t action); /**< Suspend an action */
268 void (*resume) (surf_action_t action); /**< Resume a suspended action */
269 int (*is_suspended) (surf_action_t action); /**< Return whether an action is suspended */
270 void (*set_max_duration) (surf_action_t action, double duration); /**< Set the max duration of an action*/
271 void (*set_priority) (surf_action_t action, double priority); /**< Set the priority of an action */
273 void (*set_category) (surf_action_t action, const char *category); /**< Set the category of an action */
275 double (*get_remains) (surf_action_t action); /**< Get the remains of an action */
276 #ifdef HAVE_LATENCY_BOUND_TRACKING
277 int (*get_latency_limited) (surf_action_t action); /**< Return 1 if action is limited by latency, 0 otherwise */
280 surf_model_private_t model_private;
283 s_surf_model_extension_cpu_t cpu;
284 s_surf_model_extension_network_t network;
285 s_surf_model_extension_workstation_t workstation;
289 surf_model_t surf_model_init(void);
290 void surf_model_exit(surf_model_t model);
292 static inline void *surf_cpu_resource_by_name(const char *name) {
293 return xbt_lib_get_or_null(host_lib, name, SURF_CPU_LEVEL);
295 static inline void *surf_workstation_resource_by_name(const char *name){
296 return xbt_lib_get_or_null(host_lib, name, SURF_WKS_LEVEL);
298 static inline void *surf_network_resource_by_name(const char *name){
299 return xbt_lib_get_or_null(link_lib, name, SURF_LINK_LEVEL);
302 typedef struct surf_resource {
305 xbt_dict_t properties;
306 } s_surf_resource_t, *surf_resource_t;
311 * Resource which have a metric handled by a maxmin system
316 tmgr_trace_event_t event;
319 typedef struct surf_resource_lmm {
320 s_surf_resource_t generic_resource;
321 lmm_constraint_t constraint;
322 e_surf_resource_state_t state_current;
323 tmgr_trace_event_t state_event;
324 s_surf_metric_t power;
325 } s_surf_resource_lmm_t, *surf_resource_lmm_t;
327 /**************************************/
328 /* Implementations of model object */
329 /**************************************/
332 /** \brief The CPU model
333 * \ingroup SURF_models
335 XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
337 /** \brief Initializes the CPU model with the model Cas01
338 * \ingroup SURF_models
340 * This function is called by surf_workstation_model_init_CLM03
341 * so you shouldn't have to call it by yourself.
343 * \see surf_workstation_model_init_CLM03()
345 XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
347 /** \brief Initializes the CPU model with trace integration
348 * \ingroup SURF_models
351 XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
353 /** \brief Initializes the CPU model with the model Cas01 Improved. This model uses a heap to order the events, decreasing the time complexity to get the minimum next event.
354 * \ingroup SURF_models
356 * This function is called by surf_workstation_model_init_CLM03
357 * so you shouldn't have to call it by yourself.
359 * \see surf_workstation_model_init_CLM03()
361 XBT_PUBLIC(void) surf_cpu_model_init_Cas01_im(void);
363 /** \brief The list of all available cpu model models
364 * \ingroup SURF_models
366 XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
368 XBT_PUBLIC(void) create_workstations(void);
370 /**\brief create new host bypass the parser
375 /** \brief The network model
376 * \ingroup SURF_models
378 * When creating a new API on top on SURF, you shouldn't use the
379 * network model unless you know what you are doing. Only the workstation
380 * model should be accessed because depending on the platform model,
381 * the network model can be NULL.
383 XBT_PUBLIC_DATA(surf_model_t) surf_network_model;
385 /** \brief Same as network model 'LagrangeVelho', only with different correction factors.
386 * \ingroup SURF_models
387 * \param filename XML platform file name
389 * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
390 * based on the model 'LV08' and different correction factors depending on the communication
391 * size (< 1KiB, < 64KiB, >= 64KiB).
393 * \see surf_workstation_model_init_SMPI()
395 XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
397 /** \brief Initializes the platform with the network model 'LagrangeVelho'
398 * \ingroup SURF_models
399 * \param filename XML platform file name
401 * This model is proposed by Arnaud Legrand and Pedro Velho based on
402 * the results obtained with the GTNets simulator for onelink and
403 * dogbone sharing scenarios.
405 * \see surf_workstation_model_init_LegrandVelho()
407 XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
410 /** \brief Initializes the platform with the network model 'LV08_im'
411 * \ingroup SURF_models
412 * \param filename XML platform file name
414 * This model is adds the lazy management improvement to Legrand and
415 * Velho model. This improvement essentially replaces the list of actions
416 * inside the simulation kernel by a heap in order to reduce the complexity
417 * at each iteration of the simulation kernel.
419 * \see surf_workstation_model_init_LegrandVelho()
421 XBT_PUBLIC(void) im_surf_network_model_init_LegrandVelho(void);
423 /** \brief Initializes the platform with the network model 'Constant'
424 * \ingroup SURF_models
425 * \param filename XML platform file name
427 * In this model, the communication time between two network cards is
428 * constant, hence no need for a routing table. This is particularly
429 * usefull when simulating huge distributed algorithms where
430 * scalability is really an issue. This function is called in
431 * conjunction with surf_workstation_model_init_compound.
433 * \see surf_workstation_model_init_compound()
435 XBT_PUBLIC(void) surf_network_model_init_Constant(void);
437 /** \brief Initializes the platform with the network model CM02
438 * \ingroup SURF_models
439 * \param filename XML platform file name
441 * This function is called by surf_workstation_model_init_CLM03
442 * or by yourself only if you plan using surf_workstation_model_init_compound
444 * \see surf_workstation_model_init_CLM03()
446 XBT_PUBLIC(void) surf_network_model_init_CM02(void);
449 * brief initialize the the network model bypassing the XML parser
451 XBT_PUBLIC(void) surf_network_model_init_bypass(const char *id,
456 /** \brief Initializes the platform with the network model GTNETS
457 * \ingroup SURF_models
458 * \param filename XML platform file name
460 * This function is called by surf_workstation_model_init_GTNETS
461 * or by yourself only if you plan using surf_workstation_model_init_compound
463 * \see surf_workstation_model_init_GTNETS()
465 XBT_PUBLIC(void) surf_network_model_init_GbTNETS(void);
469 /** \brief Initializes the platform with the network model NS3
470 * \ingroup SURF_models
471 * \param filename XML platform file name
473 * This function is called by surf_workstation_model_init_NS3
474 * or by yourself only if you plan using surf_workstation_model_init_compound
476 * \see surf_workstation_model_init_NS3()
478 XBT_PUBLIC(void) surf_network_model_init_NS3(void);
480 XBT_PUBLIC(void) parse_ns3_add_host(void);
481 XBT_PUBLIC(void) parse_ns3_add_router(void);
482 XBT_PUBLIC(void) parse_ns3_add_link(void);
483 XBT_PUBLIC(void) parse_ns3_add_AS(void);
484 XBT_PUBLIC(void) parse_ns3_add_route(void);
485 XBT_PUBLIC(void) parse_ns3_add_ASroute(void);
486 XBT_PUBLIC(void) parse_ns3_add_cluster(void);
487 XBT_PUBLIC(void) parse_ns3_end_platform(void);
488 XBT_PUBLIC(void) create_ns3_topology(void);
489 XBT_PUBLIC(double) ns3_get_link_latency(const void *link);
490 XBT_PUBLIC(double) ns3_get_link_bandwidth(const void *link);
494 /** \brief Initializes the platform with the network model Reno
495 * \ingroup SURF_models
496 * \param filename XML platform file name
498 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
501 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
502 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
504 * Call this function only if you plan using surf_workstation_model_init_compound.
507 XBT_PUBLIC(void) surf_network_model_init_Reno(void);
509 /** \brief Initializes the platform with the network model Reno2
510 * \ingroup SURF_models
511 * \param filename XML platform file name
513 * The problem is related to max( sum( arctan(C * Df * xi) ) ).
516 * [LOW01] S. H. Low. A duality model of TCP and queue management algorithms.
517 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
519 * Call this function only if you plan using surf_workstation_model_init_compound.
522 XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
524 /** \brief Initializes the platform with the network model Vegas
525 * \ingroup SURF_models
526 * \param filename XML platform file name
528 * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
529 * to the proportional fairness.
532 * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
533 * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
535 * Call this function only if you plan using surf_workstation_model_init_compound.
538 XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
540 /** \brief The list of all available network model models
541 * \ingroup SURF_models
543 XBT_PUBLIC_DATA(s_surf_model_description_t)
544 surf_network_model_description[];
547 /** \brief The workstation model
548 * \ingroup SURF_models
550 * Note that when you create an API on top of SURF,
551 * the workstation model should be the only one you use
552 * because depending on the platform model, the network model and the CPU model
555 XBT_PUBLIC_DATA(surf_model_t) surf_workstation_model;
557 /** \brief Initializes the platform with a compound workstation model
558 * \ingroup SURF_models
559 * \param filename XML platform file name
561 * This function should be called after a cpu_model and a
562 * network_model have been set up.
565 XBT_PUBLIC(void) surf_workstation_model_init_compound(void);
567 /** \brief Initializes the platform with the workstation model CLM03
568 * \ingroup SURF_models
569 * \param filename XML platform file name
571 * This platform model seperates the workstation model and the network model.
572 * The workstation model will be initialized with the model CLM03, the network
573 * model with the model CM02 and the CPU model with the model Cas01.
574 * In future releases, some other network models will be implemented and will be
575 * combined with the workstation model CLM03.
577 * \see surf_workstation_model_init_KCCFLN05()
579 XBT_PUBLIC(void) surf_workstation_model_init_CLM03(void);
581 /** \brief Initializes the platform with the model KCCFLN05
582 * \ingroup SURF_models
583 * \param filename XML platform file name
585 * With this model, the workstations and the network are handled
586 * together. The network model is roughly the same as in CM02 but
587 * interference between computations and communications can be taken
588 * into account. This platform model is the default one for MSG and
592 XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(void);
594 /** \brief Initializes the platform with the model KCCFLN05
595 * \ingroup SURF_models
596 * \param filename XML platform file name
598 * With this model, only parallel tasks can be used. Resource sharing
599 * is done by identifying bottlenecks and giving an equal share of
600 * the model to each action.
603 XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
605 /** \brief The list of all available workstation model models
606 * \ingroup SURF_models
608 XBT_PUBLIC_DATA(s_surf_model_description_t)
609 surf_workstation_model_description[];
611 /** \brief List of initialized models
612 * \ingroup SURF_models
614 XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
616 /*******************************************/
617 /*** SURF Globals **************************/
618 /*******************************************/
619 XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
621 /** \brief Initialize SURF
622 * \ingroup SURF_simulation
623 * \param argc argument number
624 * \param argv arguments
626 * This function has to be called to initialize the common
627 * structures. Then you will have to create the environment by
629 * e.g. surf_workstation_model_init_CLM03() or
630 * surf_workstation_model_init_KCCFLN05().
632 * \see surf_workstation_model_init_CLM03(),
633 * surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
635 XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
637 /** \brief Finish simulation initialization
638 * \ingroup SURF_simulation
640 * This function must be called before the first call to surf_solve()
642 XBT_PUBLIC(void) surf_presolve(void);
644 /** \brief Performs a part of the simulation
645 * \ingroup SURF_simulation
646 * \param max_date Maximum date to update the simulation to, or -1
647 * \return the elapsed time, or -1.0 if no event could be executed
649 * This function execute all possible events, update the action states
650 * and returns the time elapsed.
651 * When you call execute or communicate on a model, the corresponding actions
652 * are not executed immediately but only when you call surf_solve.
653 * Note that the returned elapsed time can be zero.
655 XBT_PUBLIC(double) surf_solve(double max_date);
657 /** \brief Return the current time
658 * \ingroup SURF_simulation
660 * Return the current time in millisecond.
662 XBT_INLINE XBT_PUBLIC(double) surf_get_clock(void);
665 * \ingroup SURF_simulation
671 XBT_PUBLIC(void) surf_exit(void);
673 /* Prototypes of the functions that handle the properties */
674 XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
675 XBT_PUBLIC_DATA(void) parse_properties(const char* prop_id, const char* prop_value);
676 XBT_PUBLIC_DATA(void) parse_properties_XML(void);
678 /* surf parse file related (public because called from a test suite) */
679 XBT_PUBLIC(void) parse_platform_file(const char *file);
681 /* Stores the sets */
682 XBT_PUBLIC_DATA(xbt_dict_t) set_list;
684 /* For the trace and trace:connect tag (store their content till the end of the parsing) */
685 XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
686 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
687 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
688 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
689 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
690 XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
693 XBT_PUBLIC(double) get_cpu_power(const char *power);
696 #endif /* _SURF_SURF_H */