-/* Authors: Arnaud Legrand */
+/* $Id$ */
-/* This program is free software; you can redistribute it and/or modify it
- under the terms of the license (GNU LGPL) which comes with this package. */
+/* Copyright (c) 2004 Arnaud Legrand. All rights reserved. */
+/* This program is free software; you can redistribute it and/or modify it
+ * under the terms of the license (GNU LGPL) which comes with this package. */
#ifndef _SURF_SURF_H
#define _SURF_SURF_H
+#include "portable.h"
#include "xbt/swag.h"
-#include "xbt/heap.h" /* for xbt_heap_float_t only */
-#include "surf/maxmin.h" /* for xbt_maxmin_float_t only */
+#include "xbt/dynar.h"
+#include "xbt/dict.h"
+#include "xbt/misc.h"
+
+SG_BEGIN_DECL()
+
+
-/* Actions and resources are higly connected structures... */
+/* Actions and models are higly connected structures... */
+
+/** \brief Action datatype
+ * \ingroup SURF_actions
+ *
+ * An action is some working amount on a model.
+ * It is represented as a cost, a priority, a duration and a state.
+ *
+ * \see e_surf_action_state_t
+ */
typedef struct surf_action *surf_action_t;
-typedef struct surf_resource *surf_resource_t;
-/*****************/
-/* Action object */
-/*****************/
-typedef enum {
- SURF_ACTION_READY = 0, /* Ready */
- SURF_ACTION_RUNNING, /* Running */
- SURF_ACTION_FAILED, /* Task Failure */
- SURF_ACTION_DONE, /* Completed */
- SURF_ACTION_NOT_IN_THE_SYSTEM /* Not in the system anymore. Why did you ask ? */
-} e_surf_action_state_t;
+/** \brief Resource datatype
+ * \ingroup SURF_models
+ *
+ * Generic data structure for a model. The workstations,
+ * the CPUs and the network links are examples of models.
+ */
+typedef struct surf_model *surf_model_t;
-typedef struct surf_action_state {
- xbt_swag_t ready_action_set;
- xbt_swag_t running_action_set;
- xbt_swag_t failed_action_set;
- xbt_swag_t done_action_set;
-} s_surf_action_state_t, *surf_action_state_t;
+/** \brief Resource model description
+ */
+typedef struct surf_model_description {
+ const char *name;
+ surf_model_t model;
+ void (* model_init) (const char *filename);
+ void (* create_ws) (void);
+} s_surf_model_description_t, *surf_model_description_t;
-/* Never create s_surf_action_t by yourself !!!! */
-/* Use action_new from the corresponding resource */
+XBT_PUBLIC(void) update_model_description(s_surf_model_description_t *table,
+ int table_size,
+ const char* name,
+ surf_model_t model
+ );
+XBT_PUBLIC(int) find_model_description(s_surf_model_description_t *table,
+ int table_size,
+ const char* name);
+
+/** \brief Action structure
+ * \ingroup SURF_actions
+ *
+ * Never create s_surf_action_t by yourself ! The actions are created
+ * on the fly when you call execute or communicate on a model.
+ *
+ * \see e_surf_action_state_t
+ */
typedef struct surf_action {
s_xbt_swag_hookup_t state_hookup;
xbt_swag_t state_set;
- xbt_maxmin_float_t cost; /* cost */
- xbt_maxmin_float_t remains; /* How much of that cost remains to
+ double cost; /**< cost */
+ double priority; /**< priority (1.0 by default) */
+ double max_duration; /**< max_duration (may fluctuate until
+ the task is completed) */
+ double remains; /**< How much of that cost remains to
* be done in the currently running task */
- xbt_heap_float_t start; /* start time */
- xbt_heap_float_t finish; /* finish time : this is modified during the run
+ double start; /**< start time */
+ double finish; /**< finish time : this is modified during the run
* and fluctuates until the task is completed */
- void *callback; /* for your convenience */
- surf_resource_t resource_type;
+ void *data; /**< for your convenience */
+ int using;
+ surf_model_t model_type;
} s_surf_action_t;
+/** \brief Action states
+ * \ingroup SURF_actions
+ *
+ * Action states.
+ *
+ * \see surf_action_t, surf_action_state_t
+ */
+typedef enum {
+ SURF_ACTION_READY = 0, /**< Ready */
+ SURF_ACTION_RUNNING, /**< Running */
+ SURF_ACTION_FAILED, /**< Task Failure */
+ SURF_ACTION_DONE, /**< Completed */
+ SURF_ACTION_TO_FREE, /**< Action to free in next cleanup */
+ SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
+} e_surf_action_state_t;
+
+/** \brief Action state sets
+ * \ingroup SURF_actions
+ *
+ * This structure contains some sets of actions.
+ * It provides a fast access to the actions in each state.
+ *
+ * \see surf_action_t, e_surf_action_state_t
+ */
+typedef struct surf_action_state {
+ xbt_swag_t ready_action_set; /**< Actions in state SURF_ACTION_READY */
+ xbt_swag_t running_action_set; /**< Actions in state SURF_ACTION_RUNNING */
+ xbt_swag_t failed_action_set; /**< Actions in state SURF_ACTION_FAILED */
+ xbt_swag_t done_action_set; /**< Actions in state SURF_ACTION_DONE */
+} s_surf_action_state_t, *surf_action_state_t;
+
/***************************/
-/* Generic resource object */
+/* Generic model object */
/***************************/
-typedef struct surf_resource_private *surf_resource_private_t;
-typedef struct surf_resource_public {
- s_surf_action_state_t states; /* Any living action on this resource */
- void *(*name_service)(const char *name);
- const char *(*get_resource_name)(void *resource_id);
- int (*resource_used)(void *resource_id);
-
- e_surf_action_state_t (*action_get_state)(surf_action_t action);
- void (*action_free)(surf_action_t action);
- void (*action_cancel)(surf_action_t action);
- void (*action_recycle)(surf_action_t action);
- void (*action_change_state)(surf_action_t action,
- e_surf_action_state_t state);
-} s_surf_resource_public_t, *surf_resource_public_t;
-
-typedef struct surf_resource {
- surf_resource_private_t common_private;
- surf_resource_public_t common_public;
-} s_surf_resource_t;
-
-typedef struct surf_resource_object {
- surf_resource_t resource;
-} s_surf_resource_object_t, *surf_resource_object_t;
+/** \brief Public data available on all models
+ * \ingroup SURF_models
+ *
+ * These functions are implemented by all models.
+ */
+typedef struct surf_model_public {
+ s_surf_action_state_t states; /**< Any living action on this model */
+ void *(*name_service) (const char *name); /**< Return a model given its name */
+ const char *(*get_resource_name) (void *resource_id); /**< Return the name of a resource */
+
+ e_surf_action_state_t(*action_get_state) (surf_action_t action); /**< Return the state of an action */
+ double (*action_get_start_time) (surf_action_t action); /**< Return the start time of an action */
+ double (*action_get_finish_time) (surf_action_t action); /**< Return the finish time of an action */
+ void (*action_use) (surf_action_t action); /**< Set an action used */
+ int (*action_free) (surf_action_t action); /**< Free an action */
+ void (*action_cancel) (surf_action_t action); /**< Cancel a running action */
+ void (*action_recycle) (surf_action_t action); /**< Recycle an action */
+ void (*action_change_state) (surf_action_t action, /**< Change an action state*/
+ e_surf_action_state_t state);
+ void (*action_set_data) (surf_action_t action, void *data); /**< Set the user data of an action */
+ void (*suspend) (surf_action_t action); /**< Suspend an action */
+ void (*resume) (surf_action_t action); /**< Resume a suspended action */
+ int (*is_suspended) (surf_action_t action); /**< Return whether an action is suspended */
+ void (*set_max_duration) (surf_action_t action, double duration); /**< Set the max duration of an action*/
+ void (*set_priority) (surf_action_t action, double priority); /**< Set the priority of an action */
+ const char *name; /**< Name of this model */
+
+ xbt_dict_t (*get_properties) (void* link); /**< Return the properties dictionary */
+
+} s_surf_model_public_t, *surf_model_public_t;
+
+/** \brief Private data available on all models
+ * \ingroup SURF_models
+ */
+typedef struct surf_model_private *surf_model_private_t;
+
+/** \brief Resource datatype
+ * \ingroup SURF_models
+ *
+ * Generic data structure for a model. The workstations,
+ * the CPUs and the network links are examples of models.
+ */
+typedef struct surf_model {
+ surf_model_private_t common_private;
+ surf_model_public_t common_public;
+} s_surf_model_t;
/**************************************/
-/* Implementations of resource object */
+/* Implementations of model object */
/**************************************/
-/* Cpu resource */
+
+/** \brief Timer model extension public
+ * \ingroup SURF_model
+ *
+ * Additionnal functions specific to the timer model
+ */
+typedef struct surf_timer_model_extension_public {
+ void (*set) (double date, void *function, void *arg);
+ int (*get) (void **function, void **arg);
+} s_surf_timer_model_extension_public_t,
+ *surf_timer_model_extension_public_t;
+
+/** \brief Timer model
+ * \ingroup SURF_models
+ */
+typedef struct surf_timer_model {
+ surf_model_private_t common_private;
+ surf_model_public_t common_public;
+ surf_timer_model_extension_public_t extension_public;
+} s_surf_timer_model_t, *surf_timer_model_t;
+
+/** \brief The timer model
+ * \ingroup SURF_models
+ */
+XBT_PUBLIC_DATA(surf_timer_model_t) surf_timer_model;
+
+/** \brief Initializes the timer model
+ * \ingroup SURF_models
+ */
+XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
+
+/* Cpu model */
+
+/** \brief CPU state
+ * \ingroup SURF_models
+ */
typedef enum {
- SURF_CPU_ON = 1, /* Ready */
- SURF_CPU_OFF = 0, /* Running */
+ SURF_CPU_ON = 1, /**< Up & ready */
+ SURF_CPU_OFF = 0 /**< Down & broken */
} e_surf_cpu_state_t;
-typedef struct surf_cpu_resource_extension_private *surf_cpu_resource_extension_private_t;
-typedef struct surf_cpu_resource_extension_public {
- surf_action_t(*execute) (void *cpu, xbt_maxmin_float_t size);
- surf_action_t(*wait) (void *cpu, xbt_maxmin_float_t size);
+/** \brief CPU model extension public
+ * \ingroup SURF_models
+ *
+ * Public functions specific to the CPU model.
+ */
+typedef struct surf_cpu_model_extension_public {
+ surf_action_t(*execute) (void *cpu, double size);
+ surf_action_t(*sleep) (void *cpu, double duration);
e_surf_cpu_state_t(*get_state) (void *cpu);
-} s_surf_cpu_resource_extension_public_t, *surf_cpu_resource_extension_public_t;
-
-typedef struct surf_cpu_resource {
- surf_resource_private_t common_private;
- surf_resource_public_t common_public;
-/* surf_cpu_resource_extension_private_t extension_private; */
- surf_cpu_resource_extension_public_t extension_public;
-} s_surf_cpu_resource_t, *surf_cpu_resource_t;
-extern surf_cpu_resource_t surf_cpu_resource;
-void surf_cpu_resource_init(const char *filename);
-
-/* Network resource */
-typedef struct surf_network_resource_extension_private *surf_network_resource_extension_private_t;
-typedef struct surf_network_resource_extension_public {
- surf_action_t(*communicate) (void *src, void *dst,
- xbt_maxmin_float_t size);
-} s_surf_network_resource_extension_public_t, *surf_network_resource_extension_public_t;
-
-typedef struct surf_network_resource {
- surf_resource_private_t common_private;
- surf_resource_public_t common_public;
-/* surf_network_resource_extension_private_t extension_private; */
- surf_network_resource_extension_public_t extension_public;
-} s_surf_network_resource_t, *surf_network_resource_t;
-
-extern surf_network_resource_t surf_network_resource;
-void surf_network_resource_init(const char *filename);
+ double (*get_speed) (void *cpu, double load);
+ double (*get_available_speed) (void *cpu);
+} s_surf_cpu_model_extension_public_t,
+ *surf_cpu_model_extension_public_t;
+
+/** \brief CPU model datatype
+ * \ingroup SURF_models
+ */
+typedef struct surf_cpu_model {
+ surf_model_private_t common_private;
+ surf_model_public_t common_public;
+ surf_cpu_model_extension_public_t extension_public;
+} s_surf_cpu_model_t, *surf_cpu_model_t;
+
+/** \brief The CPU model
+ * \ingroup SURF_models
+ */
+XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model;
+
+/** \brief Initializes the CPU model with the model Cas01
+ * \ingroup SURF_models
+ *
+ * This function is called by surf_workstation_model_init_CLM03
+ * so you shouldn't have to call it by yourself.
+ *
+ * \see surf_workstation_model_init_CLM03()
+ */
+XBT_PUBLIC(void) surf_cpu_model_init_Cas01(const char *filename);
+
+#define surf_cpu_model_description_size 1
+/** \brief The list of all available cpu model models
+ * \ingroup SURF_models
+ */
+XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[surf_cpu_model_description_size];
+
+/* Network model */
+
+/** \brief Network model extension public
+ * \ingroup SURF_models
+ *
+ * Public functions specific to the network model
+ */
+typedef struct surf_network_model_extension_public {
+ surf_action_t(*communicate) (void *src, void *dst, double size,
+ double max_rate);
+ const void** (*get_route) (void *src, void *dst);
+ int (*get_route_size) (void *src, void *dst);
+ const char* (*get_link_name) (const void *link);
+ double (*get_link_bandwidth) (const void *link);
+ double (*get_link_latency) (const void *link);
+} s_surf_network_model_extension_public_t,
+ *surf_network_model_extension_public_t;
+
+/** \brief Network model datatype
+ * \ingroup SURF_models
+ */
+typedef struct surf_network_model {
+ surf_model_private_t common_private;
+ surf_model_public_t common_public;
+ surf_network_model_extension_public_t extension_public;
+} s_surf_network_model_t, *surf_network_model_t;
+
+XBT_PUBLIC(void) create_workstations(void);
+
+/** \brief The network model
+ * \ingroup SURF_models
+ *
+ * When creating a new API on top on SURF, you shouldn't use the
+ * network model unless you know what you are doing. Only the workstation
+ * model should be accessed because depending on the platform model,
+ * the network model can be NULL.
+ */
+XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
+
+
+/** \brief Initializes the platform with the network model 'Constant'
+ * \ingroup SURF_models
+ * \param filename XML platform file name
+ *
+ * In this model, the communication time between two network cards is
+ * constant, hence no need for a routing table. This is particularly
+ * usefull when simulating huge distributed algorithms where
+ * scalability is really an issue. This function is called in
+ * conjunction with surf_workstation_model_init_compound.
+ *
+ * \see surf_workstation_model_init_compound()
+ */
+XBT_PUBLIC(void) surf_network_model_init_Constant(const char *filename);
+
+/** \brief Initializes the platform with the network model CM02
+ * \ingroup SURF_models
+ * \param filename XML platform file name
+ *
+ * This function is called by surf_workstation_model_init_CLM03
+ * or by yourself only if you plan using surf_workstation_model_init_compound
+ *
+ * \see surf_workstation_model_init_CLM03()
+ */
+XBT_PUBLIC(void) surf_network_model_init_CM02(const char *filename);
+
+#ifdef HAVE_GTNETS
+/** \brief Initializes the platform with the network model GTNETS
+ * \ingroup SURF_models
+ * \param filename XML platform file name
+ *
+ * This function is called by surf_workstation_model_init_GTNETS
+ * or by yourself only if you plan using surf_workstation_model_init_compound
+ *
+ * \see surf_workstation_model_init_GTNETS()
+ */
+XBT_PUBLIC(void) surf_network_model_init_GTNETS(const char *filename);
+#endif
+
+/** \brief Initializes the platform with the network model Reno
+ * \ingroup SURF_models
+ * \param filename XML platform file name
+ *
+ * The problem is related to max( sum( arctan(C * Df * xi) ) ).
+ *
+ * Reference:
+ * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
+ * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
+ *
+ * Call this function only if you plan using surf_workstation_model_init_compound.
+ *
+ */
+XBT_PUBLIC(void) surf_network_model_init_Reno(const char *filename);
+
+/** \brief Initializes the platform with the network model Vegas
+ * \ingroup SURF_models
+ * \param filename XML platform file name
+ *
+ * This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
+ * to the proportional fairness.
+ *
+ * Reference:
+ * [LOW03] S. H. Low. A duality model of TCP and queue management algorithms.
+ * IEEE/ACM Transaction on Networking, 11(4):525-536, 2003.
+ *
+ * Call this function only if you plan using surf_workstation_model_init_compound.
+ *
+ */
+XBT_PUBLIC(void) surf_network_model_init_Vegas(const char *filename);
+
+#ifdef HAVE_SDP
+/** \brief Initializes the platform with the network model based on SDP
+ * \ingroup SURF_models
+ * \param filename XML platform file name
+ *
+ * This function implements the proportional fairness known as the maximization
+ * of x1*x2*...*xn .
+ *
+ * Reference:
+ *
+ * [TAG03]. Corinne Touati, Eitan Altman, and Jerome Galtier.
+ * Semi-definite programming approach for bandwidth allocation and routing in networks.
+ * Game Theory and Applications, 9:169-179, December 2003. Nova publisher.
+ *
+ * Call this function only if you plan using surf_workstation_model_init_compound.
+ */
+XBT_PUBLIC(void) surf_network_model_init_SDP(const char *filename);
+#endif
+
+#if (HAVE_GTNETS)
+# define inc_GT 1
+#else
+# define inc_GT 0
+#endif
+#if (HAVE_SDP)
+# define inc_SDP 1
+#else
+# define inc_SDP 0
+#endif
+
+#define surf_network_model_description_size 4+inc_SDP+inc_GT
+
+/** \brief The list of all available network model models
+ * \ingroup SURF_models
+ */
+XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[surf_network_model_description_size];
+
+/** \brief Workstation model extension public
+ * \ingroup SURF_models
+ *
+ * Public functions specific to the workstation model.
+ */
+typedef struct surf_workstation_model_extension_public {
+ surf_action_t(*execute) (void *workstation, double size); /**< Execute a computation amount on a workstation
+ and create the corresponding action */
+ surf_action_t(*sleep) (void *workstation, double duration); /**< Make a workstation sleep during a given duration */
+ e_surf_cpu_state_t(*get_state) (void *workstation); /**< Return the CPU state of a workstation */
+ double (*get_speed) (void *workstation, double load); /**< Return the speed of a workstation */
+ double (*get_available_speed) (void *workstation); /**< Return tha available speed of a workstation */
+ surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
+ void *workstation_dst, double size,
+ double max_rate);
+
+ surf_action_t(*execute_parallel_task) (int workstation_nb, /**< Execute a parallel task on several workstations */
+ void **workstation_list,
+ double *computation_amount,
+ double *communication_amount,
+ double amount,
+ double rate);
+ const void** (*get_route) (void *src, void *dst); /**< Return the network link list between two workstations */
+ int (*get_route_size) (void *src, void *dst); /**< Return the route size between two workstations */
+ const char* (*get_link_name) (const void *link); /**< Return the name of a network link */
+ double (*get_link_bandwidth) (const void *link); /**< Return the current bandwidth of a network link */
+ double (*get_link_latency) (const void *link); /**< Return the current latency of a network link */
+} s_surf_workstation_model_extension_public_t,
+ *surf_workstation_model_extension_public_t;
+
+/** \brief Workstation model datatype.
+ * \ingroup SURF_models
+ *
+ */
+typedef struct surf_workstation_model {
+ surf_model_private_t common_private;
+ surf_model_public_t common_public;
+ surf_workstation_model_extension_public_t extension_public;
+} s_surf_workstation_model_t, *surf_workstation_model_t;
+
+/** \brief The workstation model
+ * \ingroup SURF_models
+ *
+ * Note that when you create an API on top of SURF,
+ * the workstation model should be the only one you use
+ * because depending on the platform model, the network model and the CPU model
+ * may not exist.
+ */
+XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
+
+/** \brief Initializes the platform with a compound workstation model
+ * \ingroup SURF_models
+ * \param filename XML platform file name
+ *
+ * This function should be called after a cpu_model and a
+ * network_model have been set up.
+ *
+ */
+XBT_PUBLIC(void) surf_workstation_model_init_compound(const char *filename);
+
+/** \brief Initializes the platform with the workstation model CLM03
+ * \ingroup SURF_models
+ * \param filename XML platform file name
+ *
+ * This platform model seperates the workstation model and the network model.
+ * The workstation model will be initialized with the model CLM03, the network
+ * model with the model CM02 and the CPU model with the model Cas01.
+ * In future releases, some other network models will be implemented and will be
+ * combined with the workstation model CLM03.
+ *
+ * \see surf_workstation_model_init_KCCFLN05()
+ */
+XBT_PUBLIC(void) surf_workstation_model_init_CLM03(const char *filename);
+
+/** \brief Initializes the platform with the model KCCFLN05
+ * \ingroup SURF_models
+ * \param filename XML platform file name
+ *
+ * With this model, the workstations and the network are handled
+ * together. The network model is roughly the same as in CM02 but
+ * interference between computations and communications can be taken
+ * into account. This platform model is the default one for MSG and
+ * SimDag.
+ *
+ */
+XBT_PUBLIC(void) surf_workstation_model_init_KCCFLN05(const char *filename);
+
+/** \brief Initializes the platform with the model KCCFLN05
+ * \ingroup SURF_models
+ * \param filename XML platform file name
+ *
+ * With this model, only parallel tasks can be used. Resource sharing
+ * is done by identifying bottlenecks and giving an equal share of
+ * the model to each action.
+ *
+ */
+XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(const char *filename);
+
+#define surf_workstation_model_description_size 4
+/** \brief The list of all available workstation model models
+ * \ingroup SURF_models
+ */
+XBT_PUBLIC_DATA(s_surf_model_description_t) surf_workstation_model_description[surf_workstation_model_description_size];
+
+/** \brief The network links
+ * \ingroup SURF_models
+ *
+ * This dict contains all network links.
+ *
+ * \see workstation_set
+ */
+XBT_PUBLIC_DATA(xbt_dict_t) link_set;
+
+/** \brief The workstations
+ * \ingroup SURF_models
+ *
+ * This dict contains all workstations.
+ *
+ * \see link_set
+ */
+XBT_PUBLIC_DATA(xbt_dict_t) workstation_set;
+XBT_PUBLIC_DATA(xbt_dict_t) cpu_set;
+/** \brief List of initialized models
+ * \ingroup SURF_models
+ */
+XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
/*******************************************/
/*** SURF Globals **************************/
/*******************************************/
-void surf_init(void); /* initialize common structures */
-xbt_heap_float_t surf_solve(void); /* update all states and returns
- the time elapsed since last
- event */
-xbt_heap_float_t surf_get_clock(void);
-void surf_finalize(void); /* clean everything */
+/** \brief Initialize SURF
+ * \ingroup SURF_simulation
+ * \param argc argument number
+ * \param argv arguments
+ *
+ * This function has to be called to initialize the common
+ * structures. Then you will have to create the environment by
+ * calling surf_timer_model_init() and
+ * e.g. surf_workstation_model_init_CLM03() or
+ * surf_workstation_model_init_KCCFLN05().
+ *
+ * \see surf_timer_model_init(), surf_workstation_model_init_CLM03(),
+ * surf_workstation_model_init_KCCFLN05(), surf_workstation_model_init_compound(), surf_exit()
+ */
+XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
+
+/** \brief Finish simulation initialization
+ * \ingroup SURF_simulation
+ *
+ * This function must be called before the first call to surf_solve()
+ */
+XBT_PUBLIC(void) surf_presolve(void);
+
+/** \brief Performs a part of the simulation
+ * \ingroup SURF_simulation
+ * \return the elapsed time, or -1.0 if no event could be executed
+ *
+ * This function execute all possible events, update the action states
+ * and returns the time elapsed.
+ * When you call execute or communicate on a model, the corresponding actions
+ * are not executed immediately but only when you call surf_solve.
+ * Note that the returned elapsed time can be zero.
+ */
+XBT_PUBLIC(double) surf_solve(void);
+
+/** \brief Return the current time
+ * \ingroup SURF_simulation
+ *
+ * Return the current time in millisecond.
+ */
+XBT_PUBLIC(double)surf_get_clock(void);
+
+/** \brief Exit SURF
+ * \ingroup SURF_simulation
+ *
+ * Clean everything.
+ *
+ * \see surf_init()
+ */
+XBT_PUBLIC(void) surf_exit(void);
+
+/* Prototypes of the functions that handle the properties */
+XBT_PUBLIC_DATA(xbt_dict_t) current_property_set; /* the prop set for the currently parsed element (also used in SIMIX) */
+void parse_properties(void);
+
+/* Prototypes for functions handling routing and were factorized succesfully from the models */
+void init_data(void);
+void parse_route_elem(void);
+
+/* surf parse file related (public because called from a test suite) */
+XBT_PUBLIC(void) parse_platform_file(const char* file);
+
+/* Stores the sets */
+XBT_PUBLIC_DATA(xbt_dict_t) set_list;
+
+void parse_foreach(void);
+void parse_sets(void);
+void parse_route_multi_set_endpoints(void);
+void parse_route_multi_set_route(void);
+void parse_cluster(void);
+void parse_trace_init(void);
+void parse_trace_finalize(void);
+void parse_trace_c_connect(void);
+
+void manage_route(xbt_dict_t route_table, const char* route_name, int action, int isMultiRoute);
+XBT_PUBLIC_DATA(int) route_action;
+
+/* This is used by all models when creating the routing table while parsing */
+XBT_PUBLIC_DATA(xbt_dict_t) route_table;
+XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
+XBT_PUBLIC_DATA(xbt_dict_t) route_table;
+XBT_PUBLIC_DATA(xbt_dict_t) route_multi_table;
+XBT_PUBLIC_DATA(xbt_dynar_t) route_link_list;
+
+/* For the trace and trace:connect tag (store their content till the end of the parsing) */
+XBT_PUBLIC_DATA(xbt_dict_t) traces_set_list;
+XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_host_avail;
+XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_power;
+XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_link_avail;
+XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_bandwidth;
+XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
+
+
+double get_cpu_power(const char* power);
+void init_randomness(void);
+void add_randomness(void);
+
+SG_END_DECL()
#endif /* _SURF_SURF_H */