-/* Copyright (c) 2004, 2005, 2006, 2007, 2008, 2009, 2010. The SimGrid Team.
+/* Copyright (c) 2004-2015. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
#include "xbt/dict.h"
#include "xbt/graph.h"
#include "xbt/misc.h"
-#include "portable.h"
#include "xbt/config.h"
+#include "src/portable.h"
+#include "surf/surf_routing.h"
#include "surf/datatypes.h"
#include "xbt/lib.h"
#include "surf/surf_routing.h"
#include "simgrid/platf_interface.h"
+#include "simgrid/datatypes.h"
+#include "simgrid/forward.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;
-
+extern XBT_PRIVATE double sg_tcp_gamma;
+extern XBT_PRIVATE double sg_sender_gap;
+extern XBT_PRIVATE double sg_latency_factor;
+extern XBT_PRIVATE double sg_bandwidth_factor;
+extern XBT_PRIVATE double sg_weight_S_parameter;
+extern XBT_PRIVATE int sg_network_crosstraffic;
+extern XBT_PRIVATE xbt_dynar_t surf_path;
typedef enum {
- SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
- SURF_NETWORK_ELEMENT_HOST, /* host type */
- SURF_NETWORK_ELEMENT_ROUTER, /* router type */
- SURF_NETWORK_ELEMENT_AS /* AS type */
+ SURF_NETWORK_ELEMENT_NULL = 0, /* NULL */
+ SURF_NETWORK_ELEMENT_HOST, /* host type */
+ SURF_NETWORK_ELEMENT_ROUTER, /* router type */
+ SURF_NETWORK_ELEMENT_AS /* AS type */
} e_surf_network_element_type_t;
+#ifdef __cplusplus
+
+namespace simgrid {
+namespace surf {
+
+class Model;
+class CpuModel;
+class HostModel;
+class VMModel;
+class NetworkModel;
+class StorageModel;
+class Resource;
+class ResourceLmm;
+class Host;
+class HostCLM03;
+class NetworkCm02Link;
+class Action;
+class ActionLmm;
+class StorageActionLmm;
+class As;
+class RoutingPlatf;
+
+}
+}
+
+typedef simgrid::surf::Model surf_Model;
+typedef simgrid::surf::CpuModel surf_CpuModel;
+typedef simgrid::surf::HostModel surf_HostModel;
+typedef simgrid::surf::VMModel surf_VMModel;
+typedef simgrid::surf::NetworkModel surf_NetworkModel;
+typedef simgrid::surf::StorageModel surf_StorageModel;
+typedef simgrid::surf::Resource surf_Resource;
+typedef simgrid::surf::ResourceLmm surf_ResourceLmm;
+typedef simgrid::surf::Host surf_Host;
+typedef simgrid::surf::HostCLM03 surf_HostCLM03;
+typedef simgrid::surf::NetworkCm02Link surf_NetworkCm02Link;
+typedef simgrid::surf::Action surf_Action;
+typedef simgrid::surf::ActionLmm surf_ActionLmm;
+typedef simgrid::surf::StorageActionLmm surf_StorageActionLmm;
+typedef simgrid::surf::RoutingPlatf surf_RoutingPlatf;
+
+#else
+
+typedef struct surf_Model surf_Model;
+typedef struct surf_CpuModel surf_CpuModel;
+typedef struct surf_HostModel surf_HostModel;
+typedef struct surf_VMModel surf_VMModel;
+typedef struct surf_NetworkModel surf_NetworkModel;
+typedef struct surf_StorageModel surf_StorageModel;
+typedef struct surf_Resource surf_Resource;
+typedef struct surf_ResourceLmm surf_ResourceLmm;
+typedef struct surf_HostCLM03 surf_HostCLM03;
+typedef struct surf_Host surf_Host;
+typedef struct surf_NetworkCm02Link surf_NetworkCm02Link;
+typedef struct surf_Action surf_Action;
+typedef struct surf_ActionLmm surf_ActionLmm;
+typedef struct surf_StorageActionLmm surf_StorageActionLmm;
+typedef struct surf_RoutingPlatf surf_RoutingPlatf;
+
+#endif
+
+/** @ingroup SURF_c_bindings
+ * \brief Model datatype
+ *
+ * Generic data structure for a model. The hosts,
+ * the CPUs and the network links are examples of models.
+ */
+typedef surf_Model *surf_model_t;
+typedef surf_CpuModel *surf_cpu_model_t;
+typedef surf_HostModel *surf_host_model_t;
+typedef surf_VMModel *surf_vm_model_t;
+typedef surf_NetworkModel *surf_network_model_t;
+typedef surf_StorageModel *surf_storage_model_t;
+
+typedef xbt_dictelm_t surf_resource_t;
+typedef surf_Resource *surf_cpp_resource_t;
+typedef surf_Host *surf_host_t;
+typedef surf_Cpu *surf_cpu_t;
+
+/** @ingroup SURF_c_bindings
+ * \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 surf_Action *surf_action_t;
+typedef surf_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);
XBT_PUBLIC(void) model_help(const char *category,
s_surf_model_description_t * table);
-enum heap_action_type{
- LATENCY = 100,
- MAX_DURATION,
- NORMAL,
- NOTSET
-};
-
-/** \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 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
- surf_file_t file; /**< surf_file_t for storage model */
- xbt_dict_t ls_dict;
-} 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;
- double last_value;
- enum heap_action_type hat;
-} s_surf_action_lmm_t, *surf_action_lmm_t;
-
-/** \ingroup SURF_actions
- * \brief Action states
+/** @ingroup SURF_interface
+ * @brief Action states
*
- * Action states.
- *
- * \see surf_action_t, surf_action_state_t
+ * @see Action
*/
typedef enum {
SURF_ACTION_READY = 0, /**< Ready */
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 ? */
+ SURF_ACTION_NOT_IN_THE_SYSTEM /**< Not in the system anymore. Why did you ask ? */
} e_surf_action_state_t;
-/** \ingroup SURF_actions
- * \brief Action state sets
+/** @ingroup SURF_vm_interface
*
- * 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;
+/* FIXME: Where should the VM state be defined? */
+typedef enum {
+ SURF_VM_STATE_CREATED, /**< created, but not yet started */
+ SURF_VM_STATE_RUNNING,
+ SURF_VM_STATE_SUSPENDED, /**< Suspend/resume does not involve disk I/O, so we assume there is no transition states. */
+
+ SURF_VM_STATE_SAVING, /**< Save/restore involves disk I/O, so there should be transition states. */
+ SURF_VM_STATE_SAVED,
+ SURF_VM_STATE_RESTORING,
+} e_surf_vm_state_t;
/***************************/
/* Generic model object */
/***************************/
-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.
+static inline void *surf_storage_resource_priv(const void *storage){
+ return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
+}
+
+static inline void *surf_storage_resource_by_name(const char *name){
+ return xbt_lib_get_elm_or_null(storage_lib, name);
+}
+
+/** @{ @ingroup SURF_c_bindings */
+
+/**
+ * @brief Pop an action from the done actions set
+ *
+ * @param model The model from which the action is extracted
+ * @return An action in done state
*/
-typedef struct surf_new_model_extension_public {
- surf_action_t(*fct) ();
- void* (*create_resource) ();
-} s_surf_model_extension_new_model_t;
-/*******************************************/
+XBT_PUBLIC(surf_action_t) surf_model_extract_done_action_set(surf_model_t model);
-/** \ingroup SURF_models
- * \brief Private data available on all models
- */
-typedef struct surf_model_private *surf_model_private_t;
-
- /* Cpu model */
-
- /** \ingroup SURF_models
- * \brief CPU model extension public
- *
- * 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_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);
- double (*get_current_power_peak) (void *cpu);
- double (*get_power_peak_at) (void *cpu, int pstate_index);
- int (*get_nb_pstates) (void *cpu);
- void (*set_power_peak_at) (void *cpu, int pstate_index);
- double (*get_consumed_energy) (void *cpu);
- void (*add_traces) (void);
-} s_surf_model_extension_cpu_t;
-
- /* Network model */
-
- /** \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) (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);
-} s_surf_model_extension_network_t;
-
-/* Storage model */
+/**
+ * @brief Pop an action from the failed actions set
+ *
+ * @param model The model from which the action is extracted
+ * @return An action in failed state
+ */
+XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t model);
-/** \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* mount, const char* path);
- surf_action_t(*close) (void *storage, surf_file_t fd);
- surf_action_t(*read) (void *storage, size_t size, surf_file_t fd);
- surf_action_t(*write) (void *storage, 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);
- xbt_dict_t(*get_properties) (const void *storage);
- xbt_dict_t(*get_content) (void *storage);
-} s_surf_model_extension_storage_t;
-
- /** \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 */
- 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 */
-
- double (*get_current_power_peak) (void *workstation); /**< Return the current CPU speed of a workstation */
- double (*get_power_peak_at) (void *workstation, int pstate_index); /**< Return the speed of a workstation for a specific pstate,
- (where higher pstate values represent lower processor speeds) */
- int (*get_nb_pstates) (void *workstation); /**< Return the number of pstates defined for a workstation (default is 1) */
- void (*set_power_peak_at) (void *workstation, int pstate_index); /**< Set the processor speed of a workstation to the speed associated with the pstate_index pstate */
- double (*get_consumed_energy) (void *workstation); /**< Return the total energy consumed by a workstation */
-
- surf_action_t(*communicate) (void *workstation_src, /**< Execute a communication amount between two workstations */
- void *workstation_dst, double size,
- double max_rate);
- // FIXME: kill next field, which duplicates the routing
- 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 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);
- surf_action_t(*close) (void *workstation, surf_file_t fd);
- surf_action_t(*read) (void *workstation, size_t size, surf_file_t fd);
- surf_action_t(*write) (void *workstation, 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);
- xbt_dynar_t (*get_info) (void *workstation, surf_file_t fd);
-
- int (*link_shared) (const void *link);
- xbt_dict_t(*get_properties) (const void *resource);
- void (*add_traces) (void);
-
- size_t (*get_free_size) (void *workstation,const char* name);
- size_t (*get_used_size) (void *workstation,const char* name);
- xbt_dynar_t (*get_storage_list) (void *workstation);
-
-} s_surf_model_extension_workstation_t;
+/**
+ * @brief Get the size of the running action set of a model
+ *
+ * @param model The model
+ * @return The size of the running action set
+ */
+XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
+/** @brief Get the route (dynar of sg_link_t) between two hosts */
+XBT_PUBLIC(xbt_dynar_t) surf_host_model_get_route(
+ surf_host_model_t model, sg_host_t src, sg_host_t dst);
+/** @brief Create a new VM on the specified host */
+XBT_PUBLIC(void) surf_vm_model_create(const char *name, sg_host_t host_PM);
+/** @brief Create a communication between two hosts
+ *
+ * @param model The model which handle the communication
+ * @param src The source host
+ * @param dst The destination host
+ * @param size The amount of data (in bytes) needed to transfer
+ * @param rate [description]
+ * @return The action corresponding to the communication
+ */
+XBT_PUBLIC(surf_action_t) surf_network_model_communicate(surf_network_model_t model, sg_host_t src, sg_host_t dst, double size, double rate);
-/** \ingroup SURF_models
- * \brief Model datatype
+/**
+ * @brief Get the name of a surf resource (cpu, host, network, …)
*
- * Generic data structure for a model. The workstations,
- * the CPUs and the network links are examples of models.
+ * @param resource The surf resource
+ * @return The name of the surf resource
*/
-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. Returns true if the action was destroyed and false if someone still has references on it. */
- 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
+XBT_PUBLIC(const char * ) surf_resource_name(surf_cpp_resource_t resource);
+static inline const char * surf_cpu_name(surf_cpu_t cpu) {
+ return surf_resource_name((surf_cpp_resource_t)cpu);
+}
- void (*gap_remove) (surf_action_lmm_t action);
+/** @brief Get the available speed of cpu associated to a host */
+XBT_PUBLIC(double) surf_host_get_available_speed(sg_host_t host);
- surf_model_private_t model_private;
+/** @brief Create a sleep action on the given host */
+XBT_PUBLIC(surf_action_t) surf_host_sleep(sg_host_t host, double duration);
- 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;
- /*******************************************/
- /* TUTORIAL: New model */
- s_surf_model_extension_new_model_t new_model;
- /*******************************************/
- } extension;
-} s_surf_model_t;
+/** @brief Create a file opening action on the given host */
+XBT_PUBLIC(surf_action_t) surf_host_open(sg_host_t host, const char* fullpath);
-surf_model_t surf_model_init(void);
-void surf_model_exit(surf_model_t model);
+/** @brief Create a file closing action on the given host */
+XBT_PUBLIC(surf_action_t) surf_host_close(sg_host_t host, surf_file_t fd);
-static inline void *surf_cpu_resource_priv(const void *host) {
- return xbt_lib_get_level((void *)host, SURF_CPU_LEVEL);
-}
-static inline void *surf_workstation_resource_priv(const void *host){
- return xbt_lib_get_level((void *)host, SURF_WKS_LEVEL);
-}
-static inline void *surf_storage_resource_priv(const void *storage){
- return xbt_lib_get_level((void *)storage, SURF_STORAGE_LEVEL);
-}
+/** @brief Create a file reading action on the given host */
+XBT_PUBLIC(surf_action_t) surf_host_read(sg_host_t host, surf_file_t fd, sg_size_t size);
-static inline void *surf_cpu_resource_by_name(const char *name) {
- 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_elm_or_null(host_lib, name);
-}
-static inline void *surf_storage_resource_by_name(const char *name){
- return xbt_lib_get_elm_or_null(storage_lib, name);
-}
+/** @brief Create a file writing action on the given host */
+XBT_PUBLIC(surf_action_t) surf_host_write(sg_host_t host, surf_file_t fd, sg_size_t size);
-typedef struct surf_resource {
- surf_model_t model;
- char *name;
- xbt_dict_t properties;
-} s_surf_resource_t, *surf_resource_t;
+/**
+ * @brief Get the informations of a file descriptor
+ * @details The returned xbt_dynar_t contains:
+ * - the size of the file,
+ * - the mount point,
+ * - the storage name,
+ * - the storage typeId,
+ * - the storage content type
+ *
+ * @param host The surf host
+ * @param fd The file descriptor
+ * @return An xbt_dynar_t with the file informations
+ */
+XBT_PUBLIC(xbt_dynar_t) surf_host_get_info(sg_host_t host, surf_file_t fd);
/**
- * Resource which have a metric handled by a maxmin system
+ * @brief Get the available space of the storage at the mount point
+ *
+ * @param resource The surf host
+ * @param name The mount point
+ * @return The amount of available space in bytes
*/
-typedef struct {
- double scale;
- double peak;
- tmgr_trace_event_t event;
-} s_surf_metric_t;
+XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* name);
-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;
+/**
+ * @brief Get the used space of the storage at the mount point
+ *
+ * @param resource The surf host
+ * @param name The mount point
+ * @return The amount of used space in bytes
+ */
+XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
+
+/** @brief Get the list of VMs hosted on the host */
+XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(sg_host_t resource);
+
+/** @brief Retrieve the params of that VM
+ * @details You can use fields ramsize and overcommit on a PM, too.
+ */
+XBT_PUBLIC(void) surf_host_get_params(sg_host_t resource, vm_params_t params);
+
+/** @brief Sets the params of that VM/PM
+ * @details You can use fields ramsize and overcommit on a PM, too.
+ */
+XBT_PUBLIC(void) surf_host_set_params(sg_host_t resource, vm_params_t params);
+
+/**
+ * @brief Destroy a VM
+ *
+ * @param resource The surf vm
+ */
+XBT_PUBLIC(void) surf_vm_destroy(sg_host_t resource);
+
+/** @brief Suspend a VM */
+XBT_PUBLIC(void) surf_vm_suspend(sg_host_t resource);
+
+/** @brief Resume a VM */
+XBT_PUBLIC(void) surf_vm_resume(sg_host_t resource);
+
+/**
+ * @brief Save the VM (Not yet implemented)
+ *
+ * @param resource The surf vm
+ */
+XBT_PUBLIC(void) surf_vm_save(sg_host_t resource);
+
+/**
+ * @brief Restore the VM (Not yet implemented)
+ *
+ * @param resource The surf vm
+ */
+XBT_PUBLIC(void) surf_vm_restore(sg_host_t resource);
+
+/**
+ * @brief Migrate the VM to the destination host
+ *
+ * @param resource The surf vm
+ * @param ind_vm_ws_dest The destination host
+ */
+XBT_PUBLIC(void) surf_vm_migrate(sg_host_t resource, sg_host_t ind_vm_ws_dest);
+
+/**
+ * @brief Get the physical machine hosting the VM
+ *
+ * @param resource The surf vm
+ * @return The physical machine hosting the VM
+ */
+XBT_PUBLIC(sg_host_t) surf_vm_get_pm(sg_host_t resource);
+
+/**
+ * @brief [brief description]
+ * @details [long description]
+ *
+ * @param resource [description]
+ * @param bound [description]
+ */
+XBT_PUBLIC(void) surf_vm_set_bound(sg_host_t resource, double bound);
+
+/**
+ * @brief [brief description]
+ * @details [long description]
+ *
+ * @param resource [description]
+ * @param cpu [description]
+ * @param mask [description]
+ */
+XBT_PUBLIC(void) surf_vm_set_affinity(sg_host_t resource, sg_host_t cpu, unsigned long mask);
+
+/**
+ * @brief Get the list of storages attached to an host
+ *
+ * @param host The surf host
+ * @return Dictionary of storage
+ */
+XBT_PUBLIC(xbt_dynar_t) surf_host_get_attached_storage_list(sg_host_t host);
+
+/**
+ * @brief Unlink a file descriptor
+ *
+ * @param host The surf host
+ * @param fd The file descriptor
+ *
+ * @return 0 if failed to unlink, 1 otherwise
+ */
+XBT_PUBLIC(int) surf_host_unlink(sg_host_t host, surf_file_t fd);
+
+/**
+ * @brief Get the size of a file on a host
+ *
+ * @param host The surf host
+ * @param fd The file descriptor
+ *
+ * @return The size in bytes of the file
+ */
+XBT_PUBLIC(size_t) surf_host_get_size(sg_host_t host, surf_file_t fd);
+
+/**
+ * @brief Get the current position of the file descriptor
+ *
+ * @param host The surf host
+ * @param fd The file descriptor
+ * @return The current position of the file descriptor
+ */
+XBT_PUBLIC(size_t) surf_host_file_tell(sg_host_t host, surf_file_t fd);
+
+/**
+ * @brief Move a file to another location on the *same mount point*.
+ * @details [long description]
+ *
+ * @param host The surf host
+ * @param fd The file descriptor
+ * @param fullpath The new full path
+ *
+ * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
+ */
+XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char* fullpath);
+
+/**
+ * @brief Set the position indictator assiociated with the file descriptor to a new position
+ * @details [long description]
+ *
+ * @param host The surf host
+ * @param fd The file descriptor
+ * @param offset The offset from the origin
+ * @param origin Position used as a reference for the offset
+ * - SEEK_SET: beginning of the file
+ * - SEEK_CUR: current position indicator
+ * - SEEK_END: end of the file
+ * @return MSG_OK if successful, otherwise MSG_TASK_CANCELED
+ */
+XBT_PUBLIC(int) surf_host_file_seek(sg_host_t host,
+ surf_file_t fd, sg_offset_t offset,
+ int origin);
+
+/**
+ * @brief Get the content of a storage
+ *
+ * @param resource The surf storage
+ * @return A xbt_dict_t with path as keys and size in bytes as values
+ */
+XBT_PUBLIC(xbt_dict_t) surf_storage_get_content(surf_resource_t resource);
+
+/**
+ * @brief Get the size in bytes of a storage
+ *
+ * @param resource The surf storage
+ * @return The size in bytes of the storage
+ */
+XBT_PUBLIC(sg_size_t) surf_storage_get_size(surf_resource_t resource);
+
+/**
+ * @brief Get the available size in bytes of a storage
+ *
+ * @param resource The surf storage
+ * @return The available size in bytes of the storage
+ */
+XBT_PUBLIC(sg_size_t) surf_storage_get_free_size(surf_resource_t resource);
+
+/**
+ * @brief Get the size in bytes of a storage
+ *
+ * @param resource The surf storage
+ * @return The used size in bytes of the storage
+ */
+XBT_PUBLIC(sg_size_t) surf_storage_get_used_size(surf_resource_t resource);
+
+/** @brief return the properties set associated to that storage */
+XBT_PUBLIC(xbt_dict_t) surf_storage_get_properties(surf_resource_t resource);
+
+/**
+ * @brief Get the data associated to the action
+ *
+ * @param action The surf action
+ * @return The data associated to the action
+ */
+XBT_PUBLIC(void*) surf_action_get_data(surf_action_t action);
+
+/**
+ * @brief Set the data associated to the action
+ * @details [long description]
+ *
+ * @param action The surf action
+ * @param data The new data associated to the action
+ */
+XBT_PUBLIC(void) surf_action_set_data(surf_action_t action, void *data);
+
+/**
+ * @brief Get the start time of an action
+ *
+ * @param action The surf action
+ * @return The start time in seconds from the beginning of the simulation
+ */
+XBT_PUBLIC(double) surf_action_get_start_time(surf_action_t action);
+
+/**
+ * @brief Get the finish time of an action
+ *
+ * @param action The surf action
+ * @return The finish time in seconds from the beginning of the simulation
+ */
+XBT_PUBLIC(double) surf_action_get_finish_time(surf_action_t action);
+
+/**
+ * @brief Get the remains amount of work to do of an action
+ *
+ * @param action The surf action
+ * @return The remains amount of work to do
+ */
+XBT_PUBLIC(double) surf_action_get_remains(surf_action_t action);
+
+/**
+ * @brief Set the category of an action
+ * @details [long description]
+ *
+ * @param action The surf action
+ * @param category The new category of the action
+ */
+XBT_PUBLIC(void) surf_action_set_category(surf_action_t action, const char *category);
+
+/**
+ * @brief Get the state of an action
+ *
+ * @param action The surf action
+ * @return The state of the action
+ */
+XBT_PUBLIC(e_surf_action_state_t) surf_action_get_state(surf_action_t action);
+
+/**
+ * @brief Get the cost of an action
+ *
+ * @param action The surf action
+ * @return The cost of the action
+ */
+XBT_PUBLIC(double) surf_action_get_cost(surf_action_t action);
+
+/**
+ * @brief [brief desrciption]
+ * @details [long description]
+ *
+ * @param action The surf cpu action
+ * @param cpu [description]
+ * @param mask [description]
+ */
+XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, sg_host_t cpu, unsigned long mask);
+
+/**
+ * @brief [brief description]
+ * @details [long description]
+ *
+ * @param action The surf cpu action
+ * @param bound [description]
+ */
+XBT_PUBLIC(void) surf_cpu_action_set_bound(surf_action_t action, double bound);
+
+/**
+ * @brief [brief description]
+ * @details [long description]
+ *
+ * @param action The surf network action
+ */
+XBT_PUBLIC(double) surf_network_action_get_latency_limited(surf_action_t action);
+
+/**
+ * @brief Get the file associated to a storage action
+ *
+ * @param action The surf storage action
+ * @return The file associated to a storage action
+ */
+XBT_PUBLIC(surf_file_t) surf_storage_action_get_file(surf_action_t action);
+
+/**
+ * @brief Get the result dictionary of an ls action
+ *
+ * @param action The surf storage action
+ * @return The dictionry listing a path
+ */
+XBT_PUBLIC(xbt_dict_t) surf_storage_action_get_ls_dict(surf_action_t action);
+
+
+/**
+ * @brief Get the host the storage is attached to
+ *
+ * @param resource The surf storage
+ * @return The host name
+ * may not exist.
+ */
+XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
+
+/** @} */
/**************************************/
/* Implementations of model object */
/**************************************/
+XBT_PUBLIC_DATA(int) autoload_surf_cpu_model;
+XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
/** \ingroup SURF_models
- * \brief The CPU model
+ * \brief The CPU model object for the physical machine layer
*/
-XBT_PUBLIC_DATA(surf_model_t) surf_cpu_model;
+XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_pm;
+
+/** \ingroup SURF_models
+ * \brief The CPU model object for the virtual machine layer
+ */
+XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
+
/** \ingroup SURF_models
* \brief Initializes the CPU model with the model Cas01
*/
XBT_PUBLIC_DATA(s_surf_model_description_t) surf_optimization_mode_description[];
+/** \ingroup SURF_plugins
+ * \brief The list of all available surf plugins
+ */
+XBT_PUBLIC_DATA(s_surf_model_description_t) surf_plugin_description[];
+
/** \ingroup SURF_models
* \brief The list of all available cpu model 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
+ * network model unless you know what you are doing. Only the host
* 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;
/** \ingroup SURF_models
* \brief Same as network model 'LagrangeVelho', only with different correction factors.
* size (< 1KiB, < 64KiB, >= 64KiB).
* See comments in the code for more information.
*
- * \see surf_workstation_model_init_SMPI()
+ * \see surf_host_model_init_SMPI()
*/
XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
+/** \ingroup SURF_models
+ * \brief Same as network model 'LagrangeVelho', only with different correction factors.
+ *
+ * This model impelments a variant of the contention model on Infinband networks based on
+ * the works of Jérôme Vienne : http://mescal.imag.fr/membres/jean-marc.vincent/index.html/PhD/Vienne.pdf
+ *
+ * \see surf_host_model_init_IB()
+ */
+XBT_PUBLIC(void) surf_network_model_init_IB(void);
+
/** \ingroup SURF_models
* \brief Initializes the platform with the network model 'LegrandVelho'
*
* the results obtained with the GTNets simulator for onelink and
* dogbone sharing scenarios. See comments in the code for more information.
*
- * \see surf_workstation_model_init_LegrandVelho()
+ * \see surf_host_model_init_LegrandVelho()
*/
XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
* 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.
+ * conjunction with surf_host_model_init_compound.
*
- * \see surf_workstation_model_init_compound()
+ * \see surf_host_model_init_compound()
*/
XBT_PUBLIC(void) surf_network_model_init_Constant(void);
* \brief Initializes the platform with the network model CM02
*
* You sould call this function by yourself only if you plan using
- * surf_workstation_model_init_compound.
+ * surf_host_model_init_compound.
* See comments in the code for more information.
*/
XBT_PUBLIC(void) surf_network_model_init_CM02(void);
-#ifdef HAVE_GTNETS
-/** \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
- * 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(void);
-#endif
-
#ifdef HAVE_NS3
/** \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
- * or by yourself only if you plan using surf_workstation_model_init_compound
+ * This function is called by surf_host_model_init_NS3
+ * or by yourself only if you plan using surf_host_model_init_compound
*
- * \see surf_workstation_model_init_NS3()
+ * \see surf_host_model_init_NS3()
*/
XBT_PUBLIC(void) surf_network_model_init_NS3(void);
#endif
/** \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) ) ).
*
* [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.
+ * Call this function only if you plan using surf_host_model_init_compound.
*
*/
XBT_PUBLIC(void) surf_network_model_init_Reno(void);
/** \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) ) ).
*
* [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.
+ * Call this function only if you plan using surf_host_model_init_compound.
*
*/
XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
/** \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
* to the proportional fairness.
* [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.
+ * Call this function only if you plan using surf_host_model_init_compound.
*
*/
XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
*/
XBT_PUBLIC_DATA(s_surf_model_description_t) surf_storage_model_description[];
-XBT_PUBLIC_DATA(surf_model_t) surf_storage_model;
+XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
+
+/** \ingroup SURF_models
+ * \brief The host model
+ *
+ * Note that when you create an API on top of SURF,
+ * the host 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_host_model_t) surf_host_model;
/** \ingroup SURF_models
- * \brief The workstation model
+ * \brief The vm model
*
* Note that when you create an API on top of SURF,
- * the workstation model should be the only one you use
+ * the vm 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_vm_model_t) surf_vm_model;
/** \ingroup SURF_models
- * \brief Initializes the platform with a compound workstation model
+ * \brief Initializes the platform with a compound host 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);
+XBT_PUBLIC(void) surf_host_model_init_compound(void);
/** \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
+ * This platform model separates the host model and the network model.
+ * The host model will be initialized with the model compound, the network
* model with the model LV08 (with cross traffic support) and the CPU model with
* the model Cas01.
* Such model is subject to modification with warning in the ChangeLog so monitor it!
*
*/
-XBT_PUBLIC(void) surf_workstation_model_init_current_default(void);
+XBT_PUBLIC(void) surf_host_model_init_current_default(void);
/** \ingroup SURF_models
- * \brief Initializes the platform with the model KCCFLN05
+ * \brief Initializes the platform with the model L07
*
* 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(void);
+XBT_PUBLIC(void) surf_host_model_init_ptask_L07(void);
/** \ingroup SURF_models
- * \brief The list of all available workstation model models
+ * \brief The list of all available host model models
*/
XBT_PUBLIC_DATA(s_surf_model_description_t)
- surf_workstation_model_description[];
+ surf_host_model_description[];
+
+/** \ingroup SURF_models
+ * \brief Initializes the platform with the current best network and cpu models at hand
+ *
+ * This platform model seperates the host model and the network model.
+ * The host model will be initialized with the model compound, the network
+ * model with the model LV08 (with cross traffic support) and the CPU model with
+ * the model Cas01.
+ * Such model is subject to modification with warning in the ChangeLog so monitor it!
+ *
+ */
+XBT_PUBLIC(void) surf_vm_model_init_HL13(void);
-/*******************************************
- * TUTORIAL: New model
+/** \ingroup SURF_models
+ * \brief The list of all available vm model models
*/
-XBT_PUBLIC(void) surf_new_model_init_default(void);
-XBT_PUBLIC_DATA(s_surf_model_description_t) surf_new_model_description[];
+XBT_PUBLIC_DATA(s_surf_model_description_t)
+ surf_vm_model_description[];
+
/*******************************************/
/** \ingroup SURF_models
* \brief List of initialized models
*/
-XBT_PUBLIC_DATA(xbt_dynar_t) model_list;
+XBT_PUBLIC_DATA(xbt_dynar_t) all_existing_models;
/** \ingroup SURF_simulation
- * \brief List of hosts that have juste restarted and whose autorestart process should be restarted.
+ * \brief List of hosts that have just restarted and whose autorestart process should be restarted.
*/
XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
/** \ingroup SURF_simulation
* \brief List of hosts for which one want to be notified if they ever restart.
*/
-XBT_PUBLIC(xbt_dict_t) watched_hosts_lib;
+XBT_PUBLIC_DATA(xbt_dict_t) watched_hosts_lib;
/*******************************************/
/*** SURF Platform *************************/
/*******************************************/
-typedef struct s_as *AS_t;
-
-XBT_PUBLIC_DATA(AS_t) surf_AS_get_routing_root(void);
+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(AS_t) surf_AS_get_by_name(const char * name);
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_netcard_t edge);
/*******************************************/
/*** SURF Globals **************************/
*
* 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_CM02()
+ * calling
+ * e.g. surf_host_model_init_CM02()
*
- * \see surf_workstation_model_init_CM02(), surf_workstation_model_init_compound(), surf_exit()
+ * \see surf_host_model_init_CM02(), surf_host_model_init_compound(), surf_exit()
*/
XBT_PUBLIC(void) surf_init(int *argc, char **argv); /* initialize common structures */
/* 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) */
+/* The same for model_prop set*/
+XBT_PUBLIC_DATA(xbt_dict_t) current_model_property_set;
+
/* surf parse file related (public because called from a test suite) */
XBT_PUBLIC(void) parse_platform_file(const char *file);
XBT_PUBLIC_DATA(xbt_dict_t) trace_connect_list_latency;
-XBT_PUBLIC(double) get_cpu_power(const char *power);
+XBT_PUBLIC(double) get_cpu_speed(const char *power);
XBT_PUBLIC(xbt_dict_t) get_as_router_properties(const char* name);
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);
+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);
+/********** Routing **********/
+void routing_AS_begin(sg_platf_AS_cbarg_t AS);
+void routing_AS_end(void);
+surf_NetCard* routing_add_host(surf_As* as, sg_platf_host_cbarg_t host);
+void routing_cluster_add_backbone(void* bb);
+surf_As* routing_get_current();
+
SG_END_DECL()
#endif /* _SURF_SURF_H */
