+ void (*create_resource) (char *name, double power_peak,
+ double power_scale,
+ tmgr_trace_t power_trace,
+ int core,
+ e_surf_resource_state_t state_initial,
+ tmgr_trace_t state_trace,
+ xbt_dict_t cpu_properties);
+ void (*add_traces) (void);
+} s_surf_model_extension_cpu_t;
+
+ /* 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) (const char *src_name,
+ const char *dst_name,
+ double size, double rate);
+ xbt_dynar_t(*get_route) (const char *src_name, const char *dst_name);
+ double (*get_link_bandwidth) (const void *link);
+ double (*get_link_latency) (const void *link);
+ int (*link_shared) (const void *link);
+ void (*add_traces) (void);
+ void (*create_resource) (char *name,
+ double bw_initial,
+ tmgr_trace_t bw_trace,
+ double lat_initial,
+ tmgr_trace_t lat_trace,
+ e_surf_resource_state_t
+ state_initial,
+ tmgr_trace_t state_trace,
+ e_surf_link_sharing_policy_t policy,
+ xbt_dict_t properties);
+} s_surf_model_extension_network_t;
+
+ /** \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_resource_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);
+ xbt_dynar_t(*get_route) (void *workstation_src, void *workstation_dst); /**< Get the list of links between two ws */
+
+ 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);
+ 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 */
+ int (*link_shared) (const void *link);
+ xbt_dict_t(*get_properties) (const void *resource);
+ void (*link_create_resource) (char *name,
+ double bw_initial,
+ tmgr_trace_t bw_trace,
+ double lat_initial,
+ tmgr_trace_t lat_trace,
+ e_surf_resource_state_t
+ state_initial,
+ tmgr_trace_t state_trace,
+ e_surf_link_sharing_policy_t
+ policy, xbt_dict_t properties);
+ void (*cpu_create_resource) (char *name, double power_peak,
+ double power_scale,
+ tmgr_trace_t power_trace,
+ e_surf_resource_state_t state_initial,
+ tmgr_trace_t state_trace,
+ xbt_dict_t cpu_properties);
+ void (*add_traces) (void);
+
+} s_surf_model_extension_workstation_t;
+
+
+
+
+/** \brief Model 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 {
+ const char *name; /**< Name of this model */
+ s_surf_action_state_t states; /**< Any living action on this model */
+
+ e_surf_action_state_t(*action_state_get) (surf_action_t action);
+ /**< Return the state of an action */
+ void (*action_state_set) (surf_action_t action,
+ e_surf_action_state_t state);
+ /**< Change an action state*/
+
+ 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 */
+ int (*action_unref) (surf_action_t action); /**< Specify that we don't use that action anymore */
+ void (*action_cancel) (surf_action_t action); /**< Cancel a running action */
+ void (*action_recycle) (surf_action_t action); /**< Recycle an action */
+ void (*action_data_set) (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 */
+#ifdef HAVE_TRACING
+ void (*set_category) (surf_action_t action, const char *category); /**< Set the category of an action */
+#endif
+ double (*get_remains) (surf_action_t action); /**< Get the remains of an action */
+#ifdef HAVE_LATENCY_BOUND_TRACKING
+ int (*get_latency_limited) (surf_action_t action); /**< Return 1 if action is limited by latency, 0 otherwise */
+#endif
+
+ surf_model_private_t model_private;
+
+ union extension {
+ s_surf_model_extension_cpu_t cpu;
+ s_surf_model_extension_network_t network;
+ s_surf_model_extension_workstation_t workstation;
+ } extension;
+} s_surf_model_t;
+
+surf_model_t surf_model_init(void);
+void surf_model_exit(surf_model_t model);
+
+static inline void *surf_cpu_resource_by_name(const char *name) {
+ return xbt_lib_get_or_null(host_lib, name, SURF_CPU_LEVEL);
+}
+static inline void *surf_workstation_resource_by_name(const char *name){
+ return xbt_lib_get_or_null(host_lib, name, SURF_WKS_LEVEL);
+}
+static inline void *surf_network_resource_by_name(const char *name){
+ return xbt_lib_get_or_null(link_lib, name, SURF_LINK_LEVEL);
+}
+
+typedef struct surf_resource {
+ surf_model_t model;
+ char *name;
+ xbt_dict_t properties;
+} s_surf_resource_t, *surf_resource_t;
+
+
+
+/**
+ * Resource which have a metric handled by a maxmin system
+ */
+typedef struct {
+ double scale;
+ double peak;
+ tmgr_trace_event_t event;
+} s_surf_metric_t;
+
+typedef struct surf_resource_lmm {
+ s_surf_resource_t generic_resource;
+ lmm_constraint_t constraint;
+ e_surf_resource_state_t state_current;
+ tmgr_trace_event_t state_event;
+ s_surf_metric_t power;
+} s_surf_resource_lmm_t, *surf_resource_lmm_t;
+
+/**************************************/
+/* Implementations of model object */
+/**************************************/
+
+
+/** \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 create new host bypass the parser
+ *
+ */
+
+
+/** \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 'LV08_im'
+ * \ingroup SURF_models
+ * \param filename XML platform file name
+ *
+ * This model is adds the lazy management improvement to Legrand and
+ * Velho model. This improvement essentially replaces the list of actions
+ * inside the simulation kernel by a heap in order to reduce the complexity
+ * at each iteration of the simulation kernel.
+ *
+ * \see surf_workstation_model_init_LegrandVelho()
+ */
+XBT_PUBLIC(void) im_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);
+
+/** \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);
+
+/**
+ * brief initialize the the network model bypassing the XML parser
+ */
+XBT_PUBLIC(void) surf_network_model_init_bypass(const char *id,
+ double initial_bw,
+ double initial_lat);
+
+#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
+
+#ifdef HAVE_NS3
+/** \brief Initializes the platform with the network model NS3
+ * \ingroup SURF_models
+ * \param filename XML platform file name
+ *
+ * This function is called by surf_workstation_model_init_NS3
+ * or by yourself only if you plan using surf_workstation_model_init_compound
+ *
+ * \see surf_workstation_model_init_NS3()
+ */
+XBT_PUBLIC(void) surf_network_model_init_NS3(const char *filename);
+
+XBT_PUBLIC(void) parse_ns3_add_host(void);
+XBT_PUBLIC(void) parse_ns3_add_router(void);
+XBT_PUBLIC(void) parse_ns3_add_link(void);
+XBT_PUBLIC(void) parse_ns3_add_AS(void);
+XBT_PUBLIC(void) parse_ns3_add_route(void);
+XBT_PUBLIC(void) parse_ns3_add_ASroute(void);
+XBT_PUBLIC(void) parse_ns3_add_cluster(void);
+XBT_PUBLIC(void) parse_ns3_end_platform(void);
+
+#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;