-/* Timer resource */
-typedef struct surf_timer_resource_extension_public {
- void (*set) (double date, void *function, void *arg);
- int (*get) (void **function, void **arg);
-} s_surf_timer_resource_extension_public_t,
- *surf_timer_resource_extension_public_t;
-
-typedef struct surf_timer_resource {
- surf_resource_private_t common_private;
- surf_resource_public_t common_public;
- surf_timer_resource_extension_public_t extension_public;
-} s_surf_timer_resource_t, *surf_timer_resource_t;
-extern surf_timer_resource_t surf_timer_resource;
-void surf_timer_resource_init(const char *filename);
-
-/* Cpu resource */
-typedef enum {
- SURF_CPU_ON = 1, /* Ready */
- SURF_CPU_OFF = 0 /* Running */
-} e_surf_cpu_state_t;
-
-typedef struct surf_cpu_resource_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);
- double (*get_speed) (void *cpu, double load);
- double (*get_available_speed) (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_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_Cas01(const char *filename);
-
-/* Network resource */
-typedef struct surf_network_resource_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_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_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_CM02(const char *filename);
-extern xbt_dict_t network_link_set;
-
-/* Workstation resource */
-typedef struct surf_workstation_resource_extension_public {
- surf_action_t(*execute) (void *workstation, double size);
- surf_action_t(*sleep) (void *workstation, double duration);
- e_surf_cpu_state_t(*get_state) (void *workstation);
- double (*get_speed) (void *workstation, double load);
- double (*get_available_speed) (void *workstation);
- surf_action_t(*communicate) (void *workstation_src,
- void *workstation_dst, double size,
- double max_rate);
- surf_action_t(*execute_parallel_task) (int workstation_nb,
- void **workstation_list,
- double *computation_amount,
- double *communication_amount,
- double amount,
- double 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_workstation_resource_extension_public_t,
- *surf_workstation_resource_extension_public_t;
-
-typedef struct surf_workstation_resource {
- surf_resource_private_t common_private;
- surf_resource_public_t common_public;
- surf_workstation_resource_extension_public_t extension_public;
-} s_surf_workstation_resource_t, *surf_workstation_resource_t;
-
-extern surf_workstation_resource_t surf_workstation_resource;
-void surf_workstation_resource_init_CLM03(const char *filename);
-void surf_workstation_resource_init_KCCFLN05(const char *filename);
-extern xbt_dict_t workstation_set;
+
+
+/** \brief The timer model
+ * \ingroup SURF_models
+ */
+XBT_PUBLIC_DATA(surf_model_t) surf_timer_model;
+
+/** \brief Initializes the timer model
+ * \ingroup SURF_models
+ */
+XBT_PUBLIC(void) surf_timer_model_init(const char *filename);
+
+/** \brief The CPU model
+ * \ingroup SURF_models
+ */
+XBT_PUBLIC_DATA(surf_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);
+
+/** \brief Initializes the CPU model with trace integration
+ * \ingroup SURF_models
+ *
+ */
+XBT_PUBLIC(void) surf_cpu_model_init_ti(const char *filename);
+
+/** \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.
+ * \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_im(const char *filename);
+
+/** \brief The list of all available cpu model models
+ * \ingroup SURF_models
+ */
+XBT_PUBLIC_DATA(s_surf_model_description_t) surf_cpu_model_description[];
+
+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_model_t) surf_network_model;
+
+/** \brief Same as network model 'LagrangeVelho', only with different correction factors.
+ * \ingroup SURF_models
+ * \param filename XML platform file name
+ *
+ * This model is proposed by Pierre-Nicolas Clauss and Martin Quinson and Stéphane Génaud
+ * based on the model 'LV08' and different correction factors depending on the communication
+ * size (< 1KiB, < 64KiB, >= 64KiB).
+ *
+ * \see surf_workstation_model_init_SMPI()
+ */
+XBT_PUBLIC(void) surf_network_model_init_SMPI(const char *filename);
+
+/** \brief Initializes the platform with the network model 'LagrangeVelho'
+ * \ingroup SURF_models
+ * \param filename XML platform file name
+ *
+ * This model is proposed by Arnaud Legrand and Pedro Velho based on
+ * the results obtained with the GTNets simulator for onelink and
+ * dogbone sharing scenarios.
+ *
+ * \see surf_workstation_model_init_LegrandVelho()
+ */
+XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(const char *filename);
+
+/** \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);
+
+XBT_PUBLIC(void) surf_network_model_init_Vivaldi(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 Reno2
+ * \ingroup SURF_models
+ * \param filename XML platform file name
+ *
+ * The problem is related to max( sum( arctan(C * Df * xi) ) ).
+ *
+ * Reference:
+ * [LOW01] 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_Reno2(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);
+
+/** \brief The list of all available network model models
+ * \ingroup SURF_models
+ */
+XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
+
+
+/** \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_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);
+
+/** \brief The list of all available workstation model models
+ * \ingroup SURF_models
+ */
+XBT_PUBLIC_DATA(s_surf_model_description_t)
+ surf_workstation_model_description[];
+
+/** \brief List of initialized models
+ * \ingroup SURF_models
+ */
+XBT_PUBLIC_DATA(xbt_dynar_t) model_list;