- \ref SURF_resources
- \ref SURF_build_api
- \ref SURF_interface
- - \ref SURF_routing
+ - \ref SURF_routing_interface
- \ref SURF_cpu_interface
- \ref SURF_network_interface
- \ref SURF_storage_interface
/* platf.h - Public interface to the SimGrid platforms */
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
static inline char* sg_storage_name(sg_storage_t storage) {
return storage->key;
}
-/* Type for any simgrid size */
+/** @ingroup m_datatypes_management_details
+ * @brief Type for any simgrid size
+ */
typedef unsigned long long sg_size_t;
/*
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
*
* @param resource [description]
* @param cpu [description]
- * @param long [description]
+ * @param mask [description]
*/
XBT_PUBLIC(void) surf_vm_workstation_set_affinity(surf_resource_t resource, surf_resource_t cpu, unsigned long mask);
* @brief Get the workstation power peak
* @details [long description]
*
- * @param resource The surf workstation
+ * @param host The surf workstation
* @return The power peak
*/
XBT_PUBLIC(double) surf_workstation_get_current_power_peak(surf_resource_t host);
* @brief [brief description]
* @details [long description]
*
- * @param resource [description]
+ * @param host [description]
* @param pstate_index [description]
*
* @return [description]
* @brief [brief description]
* @details [long description]
*
- * @param resource [description]
+ * @param host [description]
* @return [description]
*/
XBT_PUBLIC(int) surf_workstation_get_nb_pstates(surf_resource_t host);
* @brief [brief description]
* @details [long description]
*
- * @param resource [description]
+ * @param host [description]
* @param pstate_index [description]
*/
XBT_PUBLIC(void) surf_workstation_set_power_peak_at(surf_resource_t host, int pstate_index);
/**
* @brief Get the consumed energy (in joules) of a workstation
*
- * @param resource The surf workstation
+ * @param host The surf workstation
* @return The consumed energy
*/
XBT_PUBLIC(double) surf_workstation_get_consumed_energy(surf_resource_t host);
*
* @param action The surf cpu action
* @param cpu [description]
- * @param long [description]
+ * @param mask [description]
*/
XBT_PUBLIC(void) surf_cpu_action_set_affinity(surf_action_t action, surf_resource_t cpu, unsigned long mask);
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
/** \ingroup msg_storage_management
* \brief Returns the free space size of a storage element
* \param name the name of a storage
- * \return the free space size of the storage element (as a sg_size_t)
+ * \return the free space size of the storage element (as a #sg_size_t)
*/
sg_size_t MSG_storage_get_free_size(const char* name){
return simcall_storage_get_free_size(name);
/** \ingroup msg_storage_management
* \brief Returns the used space size of a storage element
* \param name the name of a storage
- * \return the used space size of the storage element (as a sg_size_t)
+ * \return the used space size of the storage element (as a #sg_size_t)
*/
sg_size_t MSG_storage_get_used_size(const char* name){
return simcall_storage_get_used_size(name);
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after Cpu creation *
- * @detail Callback functions have the following signature: `void(CpuPtr)`
+ * @details Callback functions have the following signature: `void(CpuPtr)`
*/
extern surf_callback(void, CpuPtr) cpuCreatedCallbacks;
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after Cpu destruction *
- * @detail Callback functions have the following signature: `void(CpuPtr)`
+ * @details Callback functions have the following signature: `void(CpuPtr)`
*/
extern surf_callback(void, CpuPtr) cpuDestructedCallbacks;
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after Cpu State changed *
- * @detail Callback functions have the following signature: `void(CpuActionPtr)`
+ * @details Callback functions have the following signature: `void(CpuActionPtr)`
*/
extern surf_callback(void, CpuPtr) cpuStateChangedCallbacks;
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after CpuAction State changed *
- * @detail Callback functions have the following signature: `void(CpuActionPtr)`
+ * @details Callback functions have the following signature: `void(CpuActionPtr)`
*/
extern surf_callback(void, CpuActionPtr) cpuActionStateChangedCallbacks;
* @details [TODO]
*
* @param cpu [TODO]
- * @param long [TODO]
+ * @param mask [TODO]
*/
virtual void setAffinity(CpuPtr cpu, unsigned long mask);
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after NetworkLink creation *
- * @detail Callback functions have the following signature: `void(NetworkLinkPtr)`
+ * @details Callback functions have the following signature: `void(NetworkLinkPtr)`
*/
extern surf_callback(void, NetworkLinkPtr) networkLinkCreatedCallbacks;
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after NetworkLink destruction *
- * @detail Callback functions have the following signature: `void(NetworkLinkPtr)`
+ * @details Callback functions have the following signature: `void(NetworkLinkPtr)`
*/
extern surf_callback(void, NetworkLinkPtr) networkLinkDestructedCallbacks;
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after NetworkLink State changed *
- * @detail Callback functions have the following signature: `void(NetworkLinkActionPtr)`
+ * @details Callback functions have the following signature: `void(NetworkLinkActionPtr)`
*/
extern surf_callback(void, NetworkLinkPtr) networkLinkStateChangedCallbacks;
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after NetworkAction State changed *
- * @detail Callback functions have the following signature: `void(NetworkActionPtr)`
+ * @details Callback functions have the following signature: `void(NetworkActionPtr)`
*/
extern surf_callback(void, NetworkActionPtr) networkActionStateChangedCallbacks;
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after Storage creation *
- * @detail Callback functions have the following signature: `void(StoragePtr)`
+ * @details Callback functions have the following signature: `void(StoragePtr)`
*/
extern surf_callback(void, StoragePtr) storageCreatedCallbacks;
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after Storage destruction *
- * @detail Callback functions have the following signature: `void(StoragePtr)`
+ * @details Callback functions have the following signature: `void(StoragePtr)`
*/
extern surf_callback(void, StoragePtr) storageDestructedCallbacks;
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after Storage State changed *
- * @detail Callback functions have the following signature: `void(StorageActionPtr)`
+ * @details Callback functions have the following signature: `void(StorageActionPtr)`
*/
extern surf_callback(void, StoragePtr) storageStateChangedCallbacks;
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after StorageAction State changed *
- * @detail Callback functions have the following signature: `void(StorageActionPtr)`
+ * @details Callback functions have the following signature: `void(StorageActionPtr)`
*/
extern surf_callback(void, StorageActionPtr) storageActionStateChangedCallbacks;
* @param model StorageModel associated to this Storage
* @param name The name of the Storage
* @param props Dictionary of properties associated to this Storage
- * @param constraint The lmm constraint associated to this Storage if it is part of a LMM component
- * @param model [description]
- * @param name [description]
- * @param props [description]
* @param type_id [description]
* @param content_name [description]
* @param content_type [description]
* @param size [description]
*/
Storage(ModelPtr model, const char *name, xbt_dict_t props,
- const char* type_id, char *content_name, char *content_type, sg_size_t size);
+ const char* type_id, char *content_name, char *content_type,
+ sg_size_t size);
/**
* @brief Storage constructor
* @param model StorageModel associated to this Storage
* @param name The name of the Storage
* @param props Dictionary of properties associated to this Storage
- * @param constraint The lmm constraint associated to this Storage if it is part of a LMM component
* @param maxminSystem [description]
* @param bread [description]
* @param bwrite [description]
* @param size [description]
*/
Storage(ModelPtr model, const char *name, xbt_dict_t props,
- lmm_system_t maxminSystem, double bread, double bwrite, double bconnection,
- const char* type_id, char *content_name, char *content_type, sg_size_t size);
+ lmm_system_t maxminSystem, double bread, double bwrite,
+ double bconnection,
+ const char* type_id, char *content_name, char *content_type,
+ sg_size_t size);
/**
* @brief Storage destructor
* @brief share the resources
* @details Share the resources between the actions
*
- * @param
+ * @param now [TODO]
* @return the date of the next action will finish
*/
virtual double shareResources(double now);
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after WorkstationVM creation *
- * @detail Callback functions have the following signature: `void(WorkstationVMPtr)`
+ * @details Callback functions have the following signature: `void(WorkstationVMPtr)`
*/
extern surf_callback(void, WorkstationVMPtr) workstationVMCreatedCallbacks;
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after WorkstationVM destruction *
- * @detail Callback functions have the following signature: `void(WorkstationVMPtr)`
+ * @details Callback functions have the following signature: `void(WorkstationVMPtr)`
*/
extern surf_callback(void, WorkstationVMPtr) workstationVMDestructedCallbacks;
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after WorkstationVM State changed *
- * @detail Callback functions have the following signature: `void(WorkstationVMActionPtr)`
+ * @details Callback functions have the following signature: `void(WorkstationVMActionPtr)`
*/
extern surf_callback(void, WorkstationVMPtr) workstationVMStateChangedCallbacks;
-/* Copyright (c) 2004-2013. The SimGrid Team.
+/* Copyright (c) 2004-2014. The SimGrid Team.
* All rights reserved. */
/* This program is free software; you can redistribute it and/or modify it
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after Workstation creation *
- * @detail Callback functions have the following signature: `void(WorkstationPtr)`
+ * @details Callback functions have the following signature: `void(WorkstationPtr)`
*/
extern surf_callback(void, WorkstationPtr) workstationCreatedCallbacks;
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after Workstation destruction *
- * @detail Callback functions have the following signature: `void(WorkstationPtr)`
+ * @details Callback functions have the following signature: `void(WorkstationPtr)`
*/
extern surf_callback(void, WorkstationPtr) workstationDestructedCallbacks;
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after Workstation State changed *
- * @detail Callback functions have the following signature: `void(WorkstationActionPtr)`
+ * @details Callback functions have the following signature: `void(WorkstationActionPtr)`
*/
extern surf_callback(void, WorkstationPtr) workstationStateChangedCallbacks;
/** @ingroup SURF_callbacks
* @brief Callbacks handler which emit the callbacks after WorkstationAction State changed *
- * @detail Callback functions have the following signature: `void(WorkstationActionPtr)`
+ * @details Callback functions have the following signature: `void(WorkstationActionPtr)`
*/
extern surf_callback(void, WorkstationActionPtr) workstationActionStateChangedCallbacks;
* @brief List directory contents of a path
* @details [long description]
*
+ * @param mount [description]
* @param path The path to the directory
* @return The StorageAction corresponding to the ls action
*/