-/* Copyright (c) 2004-2014. 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
/* 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 */
class Action;
class ActionLmm;
class StorageActionLmm;
-struct As;
-struct RoutingEdge;
+class As;
+class RoutingEdge;
class RoutingPlatf;
#else
typedef struct Model Model;
/** @ingroup SURF_interface
* @brief Action states
*
- * Action states.
- *
* @see Action
*/
typedef enum {
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_vm_interface
return xbt_lib_get_elm_or_null(storage_lib, name);
}
-
-XBT_PUBLIC(char *) surf_routing_edge_name(sg_routing_edge_t edge);
XBT_PUBLIC(void *) surf_as_cluster_get_backbone(AS_t as);
XBT_PUBLIC(void) surf_as_cluster_set_backbone(AS_t as, void* backbone);
/** @{ @ingroup SURF_c_bindings */
-/**
- * @brief Get the name of a surf model
+/** @brief Get the name of a surf model (dont rely on exact value)
*
- * @param model A model
- * @return The name of the model
+ * This is implemented using typeid(), so it may change with the compiler
*/
XBT_PUBLIC(const char *) surf_model_name(surf_model_t model);
*/
XBT_PUBLIC(surf_action_t) surf_host_model_execute_parallel_task(surf_host_model_t model,
int host_nb,
- void **host_list,
+ sg_host_t *host_list,
double *flops_amount,
double *bytes_amount,
double rate);
-/**
- * @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_host_model_communicate(surf_host_model_t model, surf_resource_t src, surf_resource_t dst, double size, double rate);
-
-/**
- * @brief Get the route between two hosts
- * @details [long description]
- *
- * @param model The model which handle the routes
- * @param src The source host
- * @param dst The destination host
- * @return The list of [TODO] from the source to the host
- */
+/** @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, surf_resource_t src, surf_resource_t dst);
-/**
- * @brief Create a new VM on the specified host
- *
- * @param name The name of the VM
- * @param host_PM The host on which the VM is created
- */
+/** @brief Create a new VM on the specified host */
XBT_PUBLIC(void) surf_vm_model_create(const char *name, surf_resource_t host_PM);
-/**
- * @brief Create a communication between two routing edges [TODO]
- * @details [long description]
+/** @brief Create a communication between two hosts
*
* @param model The model which handle the communication
* @param src The source host
* @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_routing_edge_t src, sg_routing_edge_t dst, double size, double rate);
+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);
/**
* @brief Get the name of a surf resource (cpu, host, network, …)
return surf_resource_name((surf_cpp_resource_t)cpu);
}
-/**
- * @brief Get the properties of a surf resource (cpu, host, network, …)
- *
- * @param resource The surf resource
- * @return The properties of the surf resource
- */
+/** @brief Get the properties of a surf resource (cpu, host, network, …) */
XBT_PUBLIC(xbt_dict_t) surf_resource_get_properties(surf_cpp_resource_t resource);
static XBT_INLINE xbt_dict_t surf_host_get_properties(surf_host_t host) {
return surf_resource_get_properties((surf_cpp_resource_t)host);
}
-/**
- * @brief Get the state of a surf resource (cpu, host, network, …)
- *
- * @param resource The surf resource
- * @return The state of the surf resource
- */
+/** @brief Get the state of a surf resource (cpu, host, network, …) */
XBT_PUBLIC(e_surf_resource_state_t) surf_resource_get_state(surf_cpp_resource_t resource);
static XBT_INLINE e_surf_resource_state_t surf_host_get_state(surf_host_t host) {
}
-/**
- * @brief Set the state of a surf resource (cpu, host, network, …)
- *
- * @param resource The surf resource
- * @param state The new state of the surf resource
- */
+/** @brief Set the state of a surf resource (cpu, host, network, …) */
XBT_PUBLIC(void) surf_resource_set_state(surf_cpp_resource_t resource, e_surf_resource_state_t state);
static inline void surf_host_set_state(surf_host_t host, e_surf_resource_state_t state) {
surf_resource_set_state((surf_cpp_resource_t)host, state);
}
-/**
- * @brief Get the speed of the cpu associated to a host
- *
- * @param resource The surf host
- * @param load [description]
- *
- * @return [description]
- */
+/** @brief Get the speed of the cpu associated to a host */
XBT_PUBLIC(double) surf_host_get_speed(surf_resource_t resource, double load);
-/**
- * @brief Get the available speed of cpu associated to a host
- *
- * @param resource The surf host
- * @return [description]
- */
-XBT_PUBLIC(double) surf_host_get_available_speed(surf_resource_t resource);
+/** @brief Get the available speed of cpu associated to a host */
+XBT_PUBLIC(double) surf_host_get_available_speed(surf_resource_t host);
-/**
- * @brief Get the number of cores of the cpu associated to a host
- *
- * @param resource The surf host
- * @return The number of cores
- */
-XBT_PUBLIC(int) surf_host_get_core(surf_resource_t resource);
+/** @brief Get the number of cores of the cpu associated to a host */
+XBT_PUBLIC(int) surf_host_get_core(surf_resource_t host);
-/**
- * @brief Execute some quantity of computation
- *
- * @param resource The surf host
- * @param size The value of the processing amount (in flop) needed to process
- *
- * @return The surf action corresponding to the processing
- */
-XBT_PUBLIC(surf_action_t) surf_host_execute(surf_resource_t resource, double size);
+/** @brief Create a computation action on the given host */
+XBT_PUBLIC(surf_action_t) surf_host_execute(surf_resource_t host, double size);
-/**
- * @brief Make the host sleep
- *
- * @param resource The surf host
- * @param duration The number of seconds to sleep
- * @return The surf action corresponding to the sleep
- */
-XBT_PUBLIC(surf_action_t) surf_host_sleep(surf_resource_t resource, double duration);
+/** @brief Create a sleep action on the given host */
+XBT_PUBLIC(surf_action_t) surf_host_sleep(surf_resource_t host, double duration);
-/**
- * @brief Open a file on an host
- *
- * @param host The surf host
- * @param fullpath The path to the file
- * @return The surf action corresponding to the openning
- */
+/** @brief Create a file opening action on the given host */
XBT_PUBLIC(surf_action_t) surf_host_open(surf_resource_t host, const char* fullpath);
-/**
- * @brief Close a file descriptor on an host
- *
- * @param host The surf host
- * @param fd The file descriptor
- *
- * @return The surf action corresponding to the closing
- */
+/** @brief Create a file closing action on the given host */
XBT_PUBLIC(surf_action_t) surf_host_close(surf_resource_t host, surf_file_t fd);
-/**
- * @brief Read a file
- *
- * @param host The surf host
- * @param fd The file descriptor to read
- * @param size The size in bytes to read
- * @return The surf action corresponding to the reading
- */
+/** @brief Create a file reading action on the given host */
XBT_PUBLIC(surf_action_t) surf_host_read(surf_resource_t host, surf_file_t fd, sg_size_t size);
-/**
- * @brief Write a file
- *
- * @param host The surf host
- * @param fd The file descriptor to write
- * @param size The size in bytes to write
- * @return The surf action corresponding to the writing
- */
+/** @brief Create a file writing action on the given host */
XBT_PUBLIC(surf_action_t) surf_host_write(surf_resource_t host, surf_file_t fd, sg_size_t size);
/**
*/
XBT_PUBLIC(sg_size_t) surf_host_get_used_size(surf_resource_t resource, const char* name);
-/**
- * @brief Get the VMs hosted on the host
- *
- * @param resource The surf host
- * @return The list of VMs on the host
- */
+/** @brief Get the list of VMs hosted on the host */
XBT_PUBLIC(xbt_dynar_t) surf_host_get_vms(surf_resource_t resource);
-/**
- * @brief [brief description]
- * @details [long description]
- *
- * @param resource [description]
- * @param params [description]
+/** @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(surf_resource_t resource, ws_params_t params);
+XBT_PUBLIC(void) surf_host_get_params(surf_resource_t resource, vm_params_t params);
-/**
- * @brief [brief description]
- * @details [long description]
- *
- * @param resource [description]
- * @param params [description]
+/** @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(surf_resource_t resource, ws_params_t params);
+XBT_PUBLIC(void) surf_host_set_params(surf_resource_t resource, vm_params_t params);
/**
* @brief Destroy a VM
*/
XBT_PUBLIC(void) surf_vm_destroy(surf_resource_t resource);
-/**
- * @brief Suspend a VM
- *
- * @param resource The surf vm
- */
+/** @brief Suspend a VM */
XBT_PUBLIC(void) surf_vm_suspend(surf_resource_t resource);
-/**
- * @brief Resume a VM
- *
- * @param resource The surf vm
- */
+/** @brief Resume a VM */
XBT_PUBLIC(void) surf_vm_resume(surf_resource_t resource);
/**
surf_file_t fd, sg_offset_t offset,
int origin);
-/**
- * @brief [brief description]
- * @details [long description]
- *
- * @param link [description]
- * @return [description]
- */
-XBT_PUBLIC(int) surf_network_link_is_shared(surf_cpp_resource_t link);
-
-/**
- * @brief Get the bandwidth of a link in bytes per second
- *
- * @param link The surf link
- * @return The bandwidth in bytes per second
- */
-XBT_PUBLIC(double) surf_network_link_get_bandwidth(surf_cpp_resource_t link);
-
-/**
- * @brief Get the latency of a link in seconds
- *
- * @param link The surf link
- * @return The latency in seconds
- */
-XBT_PUBLIC(double) surf_network_link_get_latency(surf_cpp_resource_t link);
-
/**
* @brief Get the content of a storage
*
*/
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_host_model_init_GTNETS
- * or by yourself only if you plan using surf_host_model_init_compound
- *
- * \see surf_host_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_host_model_init_NS3
* or by yourself only if you plan using surf_host_model_init_compound
/** \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) ) ).
*
/** \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) ) ).
*
/** \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.
