#include "xbt/swag.h"
#include "xbt/dynar.h"
#include "xbt/dict.h"
+#include "xbt/graph.h"
#include "xbt/misc.h"
#include "portable.h"
#include "xbt/config.h"
SG_BEGIN_DECL()
/* Actions and models are highly connected structures... */
+/* user-visible parameters */
+extern double sg_tcp_gamma;
+extern double sg_sender_gap;
+extern double sg_latency_factor;
+extern double sg_bandwidth_factor;
+extern double sg_weight_S_parameter;
+extern int sg_network_crosstraffic;
+#ifdef HAVE_GTNETS
+extern double sg_gtnets_jitter;
+extern int sg_gtnets_jitter_seed;
+#endif
+extern xbt_dynar_t surf_path;
+
typedef enum {
SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
SURF_NETWORK_ELEMENT_HOST, /* host type */
SURF_NETWORK_ELEMENT_AS /* AS type */
} e_surf_network_element_type_t;
+#ifdef __cplusplus
+class Model;
+class CpuModel;
+class WorkstationModel;
+class NetworkCm02Model;
+class Resource;
+class ResourceLmm;
+class WorkstationCLM03;
+class NetworkCm02Link;
+class Cpu;
+class Action;
+class ActionLmm;
+class StorageActionLmm;
+class As;
+class RoutingEdge;
+class RoutingPlatf;
+#else
+typedef struct Model Model;
+typedef struct CpuModel CpuModel;
+typedef struct WorkstationModel WorkstationModel;
+typedef struct NetworkCm02Model NetworkCm02Model;
+typedef struct Resource Resource;
+typedef struct ResourceLmm ResourceLmm;
+typedef struct WorkstationCLM03 WorkstationCLM03;
+typedef struct NetworkCm02Link NetworkCm02Link;
+typedef struct Cpu Cpu;
+typedef struct Action Action;
+typedef struct ActionLmm ActionLmm;
+typedef struct StorageActionLmm StorageActionLmm;
+typedef struct As As;
+typedef struct RoutingEdge RoutingEdge;
+typedef struct RoutingPlatf RoutingPlatf;
+#endif
+
+/** \ingroup SURF_models
+ * \brief Model datatype
+ *
+ * Generic data structure for a model. The workstations,
+ * the CPUs and the network links are examples of models.
+ */
+typedef Model *surf_model_t;
+typedef CpuModel *surf_cpu_model_t;
+typedef WorkstationModel *surf_workstation_model_t;
+typedef NetworkCm02Model *surf_network_model_t;
+
+typedef Resource *surf_resource_t;
+typedef ResourceLmm *surf_resource_lmm_t;
+typedef WorkstationCLM03 *surf_workstation_CLM03_t;
+typedef xbt_dictelm_t surf_workstation_t;
+typedef NetworkCm02Link *surf_network_link_t;
+typedef Cpu *surf_cpu_t;
+
+/** \ingroup SURF_actions
+ * \brief Action structure
+ *
+ * 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 Action *surf_action_t;
+typedef ActionLmm *surf_action_lmm_t;
+typedef StorageActionLmm *surf_storage_action_lmm_t;
+
+typedef As *AS_t;
+typedef RoutingEdge *routing_edge_t;
+typedef RoutingPlatf *routing_platf_t;
+
+typedef struct surf_file *surf_file_t;
+
XBT_PUBLIC(e_surf_network_element_type_t)
routing_get_network_element_type(const char* name);
/** @Brief Specify that we use that action */
XBT_PUBLIC(void) surf_action_ref(surf_action_t action);
+
/** @brief Creates a new action.
*
* @param size The size is the one of the subtype you want to create
XBT_PUBLIC(void) model_help(const char *category,
s_surf_model_description_t * table);
-enum heap_action_type{
- LATENCY = 100,
- MAX_DURATION,
- NORMAL,
- NOTSET
-};
-/** \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;
- 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 */
-#ifdef HAVE_LATENCY_BOUND_TRACKING
- int latency_limited; /**< Set to 1 if is limited by latency, 0 otherwise */
-#endif
-
- double start; /**< start time */
- double finish; /**< finish time : this is modified during the run
- * and fluctuates until the task is completed */
- void *data; /**< for your convenience */
- int refcount;
- surf_model_t model_type;
-#ifdef HAVE_TRACING
- char *category; /**< tracing category for categorized resource utilization monitoring */
-#endif
-} s_surf_action_t;
-typedef struct surf_action_lmm {
- s_surf_action_t generic_action;
- lmm_variable_t variable;
- int suspended;
- s_xbt_swag_hookup_t action_list_hookup;
- int index_heap;
- double last_update;
- enum heap_action_type hat;
-} s_surf_action_lmm_t, *surf_action_lmm_t;
-
-/** \brief Action states
- * \ingroup SURF_actions
+/** \ingroup SURF_actions
+ * \brief Action states
*
* Action states.
*
* \see surf_action_t, surf_action_state_t
*/
+
typedef enum {
SURF_ACTION_READY = 0, /**< Ready */
SURF_ACTION_RUNNING, /**< Running */
/**< 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 model object */
/***************************/
-typedef struct s_routing_global s_routing_global_t, *routing_global_t;
-XBT_PUBLIC_DATA(routing_global_t) global_routing;
-
+//FIXME:REMOVE typedef struct s_routing_platf s_routing_platf_t, *routing_platf_t;
+XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
+
+/*******************************************
+ * TUTORIAL: New model
+ * New model extension public
+ * Public functions specific to a New model.
+ */
+typedef struct surf_new_model_extension_public {
+ surf_action_t(*fct) ();
+ void* (*create_resource) ();
+} s_surf_model_extension_new_model_t;
+/*******************************************/
-/** \brief Private data available on all models
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief Private data available on all models
*/
typedef struct surf_model_private *surf_model_private_t;
/* Cpu model */
- /** \brief CPU model extension public
- * \ingroup SURF_models
+ /** \ingroup SURF_models
+ * \brief CPU model extension public
*
* Public functions specific to the CPU model.
*/
surf_action_t(*execute) (void *cpu, double size);
surf_action_t(*sleep) (void *cpu, double duration);
e_surf_resource_state_t(*get_state) (void *cpu);
+ int (*get_core) (void *cpu);
double (*get_speed) (void *cpu, double load);
double (*get_available_speed) (void *cpu);
- void* (*create_resource) (const 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
+ /** \ingroup SURF_models
+ * \brief Network model extension public
*
* 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 rate);
+ surf_action_t (*communicate) (sg_routing_edge_t src,
+ sg_routing_edge_t dst,
+ double size, double rate);
xbt_dynar_t(*get_route) (void *src, void *dst); //FIXME: kill field? That is done by the routing nowadays
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) (const 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;
-typedef struct s_surf_file {
- char *name; /**< @brief host name if any */
- void *data; /**< @brief user data */
-} s_surf_file_t;
-typedef struct s_surf_file *surf_file_t;
-
/* Storage model */
-
-/** \brief Storage model extension public
- * \ingroup SURF_models
+//
+/** \ingroup SURF_models
+ * \brief Storage model extension public
*
* Public functions specific to the Storage model.
*/
typedef struct surf_storage_model_extension_public {
- surf_action_t(*open) (void *storage, const char* path, const char* mode);
- surf_action_t(*close) (void *storage, surf_file_t fp);
- surf_action_t(*read) (void *storage, void* ptr, size_t size, size_t nmemb, surf_file_t stream);
- surf_action_t(*write) (void *storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
- surf_action_t(*stat) (void *storage, int fd, void* buf);
- void* (*create_resource) (const char* id, const char* model,const char* type_id);
+ surf_action_t(*open) (void *storage, const char* mount, const char* path);
+ surf_action_t(*close) (void *storage, surf_file_t fd);
+ surf_action_t(*read) (void *storage, void* ptr, size_t size,
+ surf_file_t fd);
+ surf_action_t(*write) (void *storage, const void* ptr, size_t size,
+ surf_file_t fd);
+ surf_action_t(*stat) (void *storage, surf_file_t fd);
+ surf_action_t(*ls) (void *storage, const char *path);
} s_surf_model_extension_storage_t;
- /** \brief Workstation model extension public
- * \ingroup SURF_models
+ /** \ingroup SURF_models
+ * \brief Workstation model extension public
*
* 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 */
+ 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 */
+ int (*get_core) (void *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_list,
double *computation_amount,
double *communication_amount,
- double amount, double rate);
+ 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 */
- surf_action_t(*open) (void *workstation, const char* storage, const char* path, const char* mode);
- surf_action_t(*close) (void *workstation, const char* storage, surf_file_t fp);
- surf_action_t(*read) (void *workstation, const char* storage, void* ptr, size_t size, size_t nmemb, surf_file_t stream);
- surf_action_t(*write) (void *workstation, const char* storage, const void* ptr, size_t size, size_t nmemb, surf_file_t stream);
- surf_action_t(*stat) (void *workstation, const char* storage, int fd, void* buf);
+ surf_action_t(*open) (void *workstation, const char* storage,
+ const char* path);
+ surf_action_t(*close) (void *workstation, surf_file_t fd);
+ surf_action_t(*read) (void *workstation, void* ptr, size_t size,
+ surf_file_t fd);
+ surf_action_t(*write) (void *workstation, const void* ptr, size_t size,
+ surf_file_t fd);
+ surf_action_t(*stat) (void *workstation, surf_file_t fd);
+ int(*unlink) (void *workstation, surf_file_t fd);
+ surf_action_t(*ls) (void *workstation, const char* mount, const char *path);
+ size_t (*get_size) (void *workstation, surf_file_t fd);
+
int (*link_shared) (const void *link);
xbt_dict_t(*get_properties) (const void *resource);
- void* (*link_create_resource) (const 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) (const 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_storage_t storage;
- 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_priv(const void *host) {
+ return xbt_lib_get_level((xbt_dictelm_t)host, SURF_CPU_LEVEL);
+}
+static inline void *surf_workstation_resource_priv(const void *host){
+ return (void*)xbt_lib_get_level((xbt_dictelm_t)host, SURF_WKS_LEVEL);
+}
+static inline void *surf_storage_resource_priv(const void *host){
+ return (void*)xbt_lib_get_level((xbt_dictelm_t)host, SURF_STORAGE_LEVEL);
+}
static inline void *surf_cpu_resource_by_name(const char *name) {
- return xbt_lib_get_or_null(host_lib, name, SURF_CPU_LEVEL);
+ return xbt_lib_get_elm_or_null(host_lib, name);
}
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);
+ return xbt_lib_get_elm_or_null(host_lib, name);
}
static inline void *surf_storage_resource_by_name(const char *name){
- return xbt_lib_get_or_null(storage_lib, name, SURF_STORAGE_LEVEL);
+ return xbt_lib_get_elm_or_null(storage_lib, name);
}
-typedef struct surf_resource {
- surf_model_t model;
- char *name;
- xbt_dict_t properties;
-} s_surf_resource_t, *surf_resource_t;
-
-/**
- * Storage struct
- */
-typedef struct s_storage_type {
- char *model;
- xbt_dict_t content;
- char *type_id;
- xbt_dict_t properties;
-} s_storage_type_t, *storage_type_t;
-
-typedef struct s_mount {
- void *id;
- char *name;
-} s_mount_t, *mount_t;
-
-typedef struct s_content {
- char *user_rights;
- char *user;
- char *group;
- char *date;
- char *time;
- int size;
-} s_content_t, *content_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;
+#ifdef __cplusplus
+extern "C" {
+#endif
+char *surf_routing_edge_name(sg_routing_edge_t edge);
+
+const char *surf_model_name(surf_model_t model);
+xbt_swag_t surf_model_done_action_set(surf_model_t model);
+xbt_swag_t surf_model_failed_action_set(surf_model_t model);
+xbt_swag_t surf_model_ready_action_set(surf_model_t model);
+xbt_swag_t surf_model_running_action_set(surf_model_t model);
+surf_action_t surf_workstation_model_execute_parallel_task(surf_workstation_model_t model,
+ int workstation_nb,
+ void **workstation_list,
+ double *computation_amount,
+ double *communication_amount,
+ double rate);
+surf_action_t surf_workstation_model_communicate(surf_workstation_model_t model, surf_workstation_t src, surf_workstation_t dst, double size, double rate);
+xbt_dynar_t surf_workstation_model_get_route(surf_workstation_model_t model, surf_workstation_t src, surf_workstation_t dst);
+surf_action_t surf_network_model_communicate(surf_network_model_t model, sg_routing_edge_t src, sg_routing_edge_t dst, double size, double rate);
+const char *surf_resource_name(surf_resource_t resource);
+xbt_dict_t surf_resource_get_properties(surf_resource_t resource);
+e_surf_resource_state_t surf_resource_get_state(surf_resource_t resource);
+double surf_workstation_get_speed(surf_workstation_t resource, double load);
+double surf_workstation_get_available_speed(surf_workstation_t resource);
+int surf_workstation_get_core(surf_workstation_t resource);
+surf_action_t surf_workstation_execute(surf_workstation_t resource, double size);
+surf_action_t surf_workstation_sleep(surf_workstation_t resource, double duration);
+surf_action_t surf_workstation_open(surf_workstation_t workstation, const char* mount, const char* path);
+surf_action_t surf_workstation_close(surf_workstation_t workstation, surf_file_t fd);
+const char *surf_cpu_name(surf_cpu_t resource);
+surf_action_t surf_cpu_execute(surf_cpu_t cpu, double size);
+surf_action_t surf_cpu_sleep(surf_cpu_t cpu, double duration);
+int surf_workstation_unlink(surf_workstation_t workstation, surf_file_t fd);
+surf_action_t surf_workstation_ls(surf_workstation_t workstation, const char* mount, const char *path);
+size_t surf_workstation_get_size(surf_workstation_t workstation, surf_file_t fd);
+surf_action_t surf_workstation_read(surf_workstation_t resource, void *ptr, size_t size, surf_file_t fd);
+surf_action_t surf_workstation_write(surf_workstation_t resource, const void *ptr, size_t size, surf_file_t fd);
+int surf_network_link_is_shared(surf_network_link_t link);
+double surf_network_link_get_bandwidth(surf_network_link_t link);
+double surf_network_link_get_latency(surf_network_link_t link);
+void *surf_action_get_data(surf_action_t action);
+void surf_action_set_data(surf_action_t action, void *data);
+void surf_action_unref(surf_action_t action);
+double surf_action_get_start_time(surf_action_t action);
+double surf_action_get_finish_time(surf_action_t action);
+double surf_action_get_remains(surf_action_t action);
+void surf_action_suspend(surf_action_t action);
+void surf_action_resume(surf_action_t action);
+void surf_action_cancel(surf_action_t action);
+void surf_action_set_priority(surf_action_t action, double priority);
+void surf_action_set_category(surf_action_t action, const char *category);
+e_surf_action_state_t surf_action_get_state(surf_action_t action);
+int surf_action_get_cost(surf_action_t action);
+surf_file_t surf_storage_action_get_file(surf_storage_action_lmm_t action);
+xbt_dict_t surf_storage_action_get_ls_dict(surf_storage_action_lmm_t action);
+
+#ifdef __cplusplus
+}
+#endif
/**************************************/
/* Implementations of model object */
/**************************************/
-/** \brief The CPU model
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief The CPU model
*/
-XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
+XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model;
-/** \brief Initializes the CPU model with the model Cas01
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief Initializes the CPU model with the model Cas01
*
* By default, this model uses the lazy optimization mechanism that
* relies on partial invalidation in LMM and a heap for lazy action update.
* You can change this behavior by setting the cpu/optim configuration
* variable to a different value.
*
- * 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()
+ * You shouldn't have to call it by yourself.
*/
XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
-/** \brief Initializes the CPU model with trace integration [Deprecated]
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief Initializes the CPU model with trace integration [Deprecated]
*
* You shouldn't have to call it by yourself.
- * \see surf_workstation_model_init_CLM03()
*/
XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
-/** \brief This function call the share resources function needed
- *
- */
-XBT_PUBLIC(double) generic_share_resources(double now);
-
-/** \brief This function call the update action state function needed
- *
- */
-XBT_PUBLIC(void) generic_update_actions_state(double now, double delta);
-
-/** \brief The list of all available optimization modes (both for cpu and networks).
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief The list of all available optimization modes (both for cpu and networks).
* These optimization modes can be set using --cfg=cpu/optim:... and --cfg=network/optim:...
*/
XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
-/** \brief The list of all available cpu model models
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief The list of all available cpu model 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
+/** \ingroup SURF_models
+ * \brief The network model
*
* 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;
+XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
-/** \brief Same as network model 'LagrangeVelho', only with different correction factors.
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief Same as network model 'LagrangeVelho', only with different correction factors.
*
* 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
*/
XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
-/** \brief Initializes the platform with the network model 'LegrandVelho'
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief Initializes the platform with the network model 'LegrandVelho'
*
* This model is proposed by Arnaud Legrand and Pedro Velho based on
* the results obtained with the GTNets simulator for onelink and
*/
XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
-/** \brief Initializes the platform with the network model 'Constant'
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief Initializes the platform with the network model 'Constant'
*
* In this model, the communication time between two network cards is
* constant, hence no need for a routing table. This is particularly
*/
XBT_PUBLIC(void) surf_network_model_init_Constant(void);
-/** \brief Initializes the platform with the network model CM02
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief Initializes the platform with the network model CM02
*
- * This function is called by surf_workstation_model_init_CLM03
- * or by yourself only if you plan using surf_workstation_model_init_compound
+ * You sould call this function by yourself only if you plan using
+ * surf_workstation_model_init_compound.
* See comments in the code for more information.
- *
- * \see surf_workstation_model_init_CLM03()
*/
XBT_PUBLIC(void) surf_network_model_init_CM02(void);
-/**
- * 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
+/** \ingroup SURF_models
+ * \brief Initializes the platform with the network model GTNETS
* \param filename XML platform file name
*
* This function is called by surf_workstation_model_init_GTNETS
#endif
#ifdef HAVE_NS3
-/** \brief Initializes the platform with the network model NS3
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief Initializes the platform with the network model NS3
* \param filename XML platform file name
*
* This function is called by surf_workstation_model_init_NS3
XBT_PUBLIC(void) surf_network_model_init_NS3(void);
#endif
-/** \brief Initializes the platform with the network model Reno
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief Initializes the platform with the network model Reno
* \param filename XML platform file name
*
* The problem is related to max( sum( arctan(C * Df * xi) ) ).
*/
XBT_PUBLIC(void) surf_network_model_init_Reno(void);
-/** \brief Initializes the platform with the network model Reno2
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief Initializes the platform with the network model Reno2
* \param filename XML platform file name
*
* The problem is related to max( sum( arctan(C * Df * xi) ) ).
*/
XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
-/** \brief Initializes the platform with the network model Vegas
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief Initializes the platform with the network model Vegas
* \param filename XML platform file name
*
* This problem is related to max( sum( a * Df * ln(xi) ) ) which is equivalent
*/
XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
-/** \brief The list of all available network model models
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief The list of all available network model models
*/
XBT_PUBLIC_DATA(s_surf_model_description_t)
surf_network_model_description[];
-
-
-
-
-
-/** \brief The storage model
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief The storage model
*/
XBT_PUBLIC(void) surf_storage_model_init_default(void);
-/** \brief The list of all available storage modes.
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief The list of all available storage modes.
* This storage mode can be set using --cfg=storage/model:...
*/
XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
-
-
-
-
-
-
-/** \brief The workstation model
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief The workstation model
*
* 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;
+XBT_PUBLIC_DATA(surf_workstation_model_t) surf_workstation_model;
-/** \brief Initializes the platform with a compound workstation model
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief Initializes the platform with a compound workstation model
*
* 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(void);
-/** \brief Initializes the platform with the current best network and cpu models at hand
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief Initializes the platform with the current best network and cpu models at hand
*
* This platform model seperates the workstation model and the network model.
* The workstation model will be initialized with the model compound, the network
*/
XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
-/** \brief Initializes the platform with the workstation model CLM03
- * \ingroup SURF_models
- *
- * 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.
- *
- */
-XBT_PUBLIC(void) surf_workstation_model_init_CLM03(void);
-
-/** \brief Initializes the platform with the model KCCFLN05
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief Initializes the platform with the model KCCFLN05
*
* With this model, only parallel tasks can be used. Resource sharing
* is done by identifying bottlenecks and giving an equal share of
*/
XBT_PUBLIC(void) surf_workstation_model_init_ptask_L07(void);
-/** \brief The list of all available workstation model models
- * \ingroup SURF_models
+/** \ingroup SURF_models
+ * \brief The list of all available workstation model models
*/
XBT_PUBLIC_DATA(s_surf_model_description_t)
surf_workstation_model_description[];
-/** \brief List of initialized models
- * \ingroup SURF_models
+/*******************************************
+ * TUTORIAL: New model
+ */
+XBT_PUBLIC(void) surf_new_model_init_default(void);
+
+XBT_PUBLIC_DATA(s_surf_model_description_t) surf_new_model_description[];
+
+/*******************************************/
+
+/** \ingroup SURF_models
+ * \brief List of initialized models
*/
XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
+/*******************************************/
+/*** SURF Platform *************************/
+/*******************************************/
+#ifdef __cplusplus
+extern "C" {
+#endif
+XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
+XBT_PUBLIC_DATA(const char *) surf_AS_get_name(AS_t as);
+XBT_PUBLIC_DATA(xbt_dict_t) surf_AS_get_routing_sons(AS_t as);
+XBT_PUBLIC_DATA(const char *) surf_AS_get_model(AS_t as);
+XBT_PUBLIC_DATA(xbt_dynar_t) surf_AS_get_hosts(AS_t as);
+XBT_PUBLIC_DATA(void) surf_AS_get_graph(AS_t as, xbt_graph_t graph, xbt_dict_t nodes, xbt_dict_t edges);
+XBT_PUBLIC_DATA(AS_t) surf_platf_get_root(routing_platf_t platf);
+XBT_PUBLIC_DATA(e_surf_network_element_type_t) surf_routing_edge_get_rc_type(sg_routing_edge_t edge);
+#ifdef __cplusplus
+}
+#endif
+
/*******************************************/
/*** SURF Globals **************************/
/*******************************************/
-XBT_PUBLIC_DATA(xbt_cfg_t) _surf_cfg_set;
-/** \brief Initialize SURF
- * \ingroup SURF_simulation
+/** \ingroup SURF_simulation
+ * \brief Initialize SURF
* \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
- * e.g. surf_workstation_model_init_CLM03()
+ * e.g. surf_workstation_model_init_CM02()
*
- * \see surf_workstation_model_init_CLM03(), surf_workstation_model_init_compound(), surf_exit()
+ * \see surf_workstation_model_init_CM02(), 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
+/** \ingroup SURF_simulation
+ * \brief Finish simulation initialization
*
* 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
+/** \ingroup SURF_simulation
+ * \brief Performs a part of the simulation
* \param max_date Maximum date to update the simulation to, or -1
* \return the elapsed time, or -1.0 if no event could be executed
*
*/
XBT_PUBLIC(double) surf_solve(double max_date);
-/** \brief Return the current time
- * \ingroup SURF_simulation
+/** \ingroup SURF_simulation
+ * \brief Return the current time
*
* Return the current time in millisecond.
*/
XBT_PUBLIC(double) surf_get_clock(void);
-/** \brief Exit SURF
- * \ingroup SURF_simulation
+/** \ingroup SURF_simulation
+ * \brief Exit SURF
*
* Clean everything.
*
/* 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) */
-XBT_PUBLIC(void) parse_properties(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;
-
/* 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(double) get_cpu_power(const char *power);
+XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
+
int surf_get_nthreads(void);
void surf_set_nthreads(int nthreads);
+void surf_watched_hosts(void);
+
+/*
+ * Returns the initial path. On Windows the initial path is
+ * the current directory for the current process in the other
+ * case the function returns "./" that represents the current
+ * directory on Unix/Linux platforms.
+ */
+const char *__surf_get_initial_path(void);
+
+/********** Tracing **********/
+/* from surf_instr.c */
+void TRACE_surf_action(surf_action_t surf_action, const char *category);
+void TRACE_surf_alloc(void);
+void TRACE_surf_release(void);
+
+/* instr_routing.c */
+void instr_routing_define_callbacks (void);
+void instr_new_variable_type (const char *new_typename, const char *color);
+void instr_new_user_variable_type (const char *father_type, const char *new_typename, const char *color);
+void instr_new_user_state_type (const char *father_type, const char *new_typename);
+void instr_new_value_for_user_state_type (const char *_typename, const char *value, const char *color);
+int instr_platform_traced (void);
+xbt_graph_t instr_routing_platform_graph (void);
+void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
+
SG_END_DECL()
#endif /* _SURF_SURF_H */