Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics
[simgrid.git] / src / include / surf / surf.h
index 77ad4d0..dae5142 100644 (file)
@@ -41,25 +41,21 @@ namespace surf {
 class Model;
 class CpuModel;
 class HostModel;
-class VMModel;
 class NetworkModel;
 class StorageModel;
 class Resource;
 class ResourceLmm;
-class HostImpl;
 class HostCLM03;
 class NetworkCm02Link;
 class Action;
 class ActionLmm;
 class StorageActionLmm;
-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;
@@ -70,14 +66,12 @@ 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;
@@ -88,7 +82,6 @@ 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
 
@@ -101,7 +94,6 @@ typedef struct surf_RoutingPlatf surf_RoutingPlatf;
 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;
 
@@ -119,39 +111,26 @@ typedef surf_Cpu *surf_cpu_t;
  *  \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;
 
 /** \brief Resource model description
  */
-typedef struct surf_model_description {
+struct surf_model_description {
   const char *name;
   const char *description;
   void_f_void_t model_init_preparse;
-} s_surf_model_description_t, *surf_model_description_t;
+};
+typedef struct surf_model_description  s_surf_model_description_t;
+typedef struct surf_model_description* surf_model_description_t;
 
 XBT_PUBLIC(int) find_model_description(s_surf_model_description_t * table, const char *name);
 XBT_PUBLIC(void) model_help(const char *category, s_surf_model_description_t * table);
 
-/** @ingroup SURF_vm_interface */
-/* 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 */
 /***************************/
 
-XBT_PUBLIC_DATA(routing_platf_t) routing_platf;
-
 static inline void *surf_storage_resource_priv(const void *storage){
   return (void*)xbt_lib_get_level((xbt_dictelm_t)storage, SURF_STORAGE_LEVEL);
 }
@@ -186,23 +165,6 @@ XBT_PUBLIC(surf_action_t) surf_model_extract_failed_action_set(surf_model_t mode
  */
 XBT_PUBLIC(int) surf_model_running_action_set_size(surf_model_t model);
 
-/** @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);
-
-/** @brief Create a sleep action on the given host */
-XBT_PUBLIC(surf_action_t) surf_host_sleep(sg_host_t host, double duration);
-
 /** @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);
 
@@ -248,68 +210,6 @@ XBT_PUBLIC(sg_size_t) surf_host_get_free_size(sg_host_t resource, const char* na
  */
 XBT_PUBLIC(sg_size_t) surf_host_get_used_size(sg_host_t resource, const char* name);
 
-/**
- * @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 Unlink a file descriptor
  *
@@ -364,9 +264,7 @@ XBT_PUBLIC(int) surf_host_file_move(sg_host_t host, surf_file_t fd, const char*
  *  - 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);
+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
@@ -452,8 +350,6 @@ XBT_PUBLIC(const char * ) surf_storage_get_host(surf_resource_t resource);
 /* Implementations of model object */
 /**************************************/
 
-XBT_PUBLIC_DATA(void_f_void_t) surf_cpu_model_init_preparse;
-
 /** \ingroup SURF_models
  *  \brief The CPU model object for the physical machine layer
  */
@@ -474,14 +370,14 @@ XBT_PUBLIC_DATA(surf_cpu_model_t) surf_cpu_model_vm;
  *
  *  You shouldn't have to call it by yourself.
  */
-XBT_PUBLIC(void) surf_cpu_model_init_Cas01(void);
+XBT_PUBLIC(void) surf_cpu_model_init_Cas01();
 
 /** \ingroup SURF_models
  *  \brief Initializes the CPU model with trace integration [Deprecated]
  *
  *  You shouldn't have to call it by yourself.
  */
-XBT_PUBLIC(void) surf_cpu_model_init_ti(void);
+XBT_PUBLIC(void) surf_cpu_model_init_ti();
 
 /** \ingroup SURF_models
  *  \brief The list of all available optimization modes (both for cpu and networks).
@@ -516,7 +412,7 @@ XBT_PUBLIC_DATA(surf_network_model_t) surf_network_model;
  *
  *  \see surf_host_model_init_SMPI()
  */
-XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
+XBT_PUBLIC(void) surf_network_model_init_SMPI();
 
 /** \ingroup SURF_models
  *  \brief Same as network model 'LagrangeVelho', only with different correction factors.
@@ -526,7 +422,7 @@ XBT_PUBLIC(void) surf_network_model_init_SMPI(void);
  *
  *  \see surf_host_model_init_IB()
  */
-XBT_PUBLIC(void) surf_network_model_init_IB(void);
+XBT_PUBLIC(void) surf_network_model_init_IB();
 
 /** \ingroup SURF_models
  *  \brief Initializes the platform with the network model 'LegrandVelho'
@@ -536,7 +432,7 @@ XBT_PUBLIC(void) surf_network_model_init_IB(void);
  *
  *  \see surf_host_model_init_LegrandVelho()
  */
-XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
+XBT_PUBLIC(void) surf_network_model_init_LegrandVelho();
 
 /** \ingroup SURF_models
  *  \brief Initializes the platform with the network model 'Constant'
@@ -547,7 +443,7 @@ XBT_PUBLIC(void) surf_network_model_init_LegrandVelho(void);
  *
  *  \see surf_host_model_init_compound()
  */
-XBT_PUBLIC(void) surf_network_model_init_Constant(void);
+XBT_PUBLIC(void) surf_network_model_init_Constant();
 
 /** \ingroup SURF_models
  *  \brief Initializes the platform with the network model CM02
@@ -555,9 +451,8 @@ XBT_PUBLIC(void) surf_network_model_init_Constant(void);
  *  You sould call this function by yourself only if you plan using surf_host_model_init_compound.
  *  See comments in the code for more information.
  */
-XBT_PUBLIC(void) surf_network_model_init_CM02(void);
+XBT_PUBLIC(void) surf_network_model_init_CM02();
 
-#if HAVE_NS3
 /** \ingroup SURF_models
  *  \brief Initializes the platform with the network model NS3
  *
@@ -566,8 +461,7 @@ XBT_PUBLIC(void) surf_network_model_init_CM02(void);
  *
  *  \see surf_host_model_init_NS3()
  */
-XBT_PUBLIC(void) surf_network_model_init_NS3(void);
-#endif
+XBT_PUBLIC(void) surf_network_model_init_NS3();
 
 /** \ingroup SURF_models
  *  \brief Initializes the platform with the network model Reno
@@ -580,7 +474,7 @@ XBT_PUBLIC(void) surf_network_model_init_NS3(void);
  *
  *  Call this function only if you plan using surf_host_model_init_compound.
  */
-XBT_PUBLIC(void) surf_network_model_init_Reno(void);
+XBT_PUBLIC(void) surf_network_model_init_Reno();
 
 /** \ingroup SURF_models
  *  \brief Initializes the platform with the network model Reno2
@@ -593,7 +487,7 @@ XBT_PUBLIC(void) surf_network_model_init_Reno(void);
  *
  *  Call this function only if you plan using surf_host_model_init_compound.
  */
-XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
+XBT_PUBLIC(void) surf_network_model_init_Reno2();
 
 /** \ingroup SURF_models
  *  \brief Initializes the platform with the network model Vegas
@@ -606,7 +500,7 @@ XBT_PUBLIC(void) surf_network_model_init_Reno2(void);
  *
  *  Call this function only if you plan using surf_host_model_init_compound.
  */
-XBT_PUBLIC(void) surf_network_model_init_Vegas(void);
+XBT_PUBLIC(void) surf_network_model_init_Vegas();
 
 /** \ingroup SURF_models
  *  \brief The list of all available network model models
@@ -616,7 +510,7 @@ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_network_model_description[];
 /** \ingroup SURF_models
  *  \brief The storage model
  */
-XBT_PUBLIC(void) surf_storage_model_init_default(void);
+XBT_PUBLIC(void) surf_storage_model_init_default();
 
 /** \ingroup SURF_models
  *  \brief The list of all available storage modes.
@@ -634,20 +528,12 @@ XBT_PUBLIC_DATA(surf_storage_model_t) surf_storage_model;
  */
 XBT_PUBLIC_DATA(surf_host_model_t) surf_host_model;
 
-/** \ingroup SURF_models
- *  \brief The vm model
- *
- *  Note that when you create an API on top of SURF,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_vm_model_t) surf_vm_model;
-
 /** \ingroup SURF_models
  *  \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_host_model_init_compound(void);
+XBT_PUBLIC(void) surf_host_model_init_compound();
 
 /** \ingroup SURF_models
  *  \brief Initializes the platform with the current best network and cpu models at hand
@@ -657,7 +543,7 @@ XBT_PUBLIC(void) surf_host_model_init_compound(void);
  *  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_host_model_init_current_default(void);
+XBT_PUBLIC(void) surf_host_model_init_current_default();
 
 /** \ingroup SURF_models
  *  \brief Initializes the platform with the model L07
@@ -665,7 +551,7 @@ XBT_PUBLIC(void) surf_host_model_init_current_default(void);
  *  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_host_model_init_ptask_L07(void);
+XBT_PUBLIC(void) surf_host_model_init_ptask_L07();
 
 /** \ingroup SURF_models
  *  \brief The list of all available host model models
@@ -680,22 +566,7 @@ XBT_PUBLIC_DATA(s_surf_model_description_t) surf_host_model_description[];
  *  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);
-
-/** \ingroup SURF_models
- *  \brief The list of all available vm model models
- */
-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) all_existing_models;
-
-/** \ingroup SURF_simulation
- *  \brief List of hosts that have just restarted and whose autorestart process should be restarted.
- */
-XBT_PUBLIC_DATA(xbt_dynar_t) host_that_restart;
+XBT_PUBLIC(void) surf_vm_model_init_HL13();
 
 /** \ingroup SURF_simulation
  *  \brief List of hosts for which one want to be notified if they ever restart.
@@ -721,7 +592,7 @@ XBT_PUBLIC(void) surf_init(int *argc, char **argv);     /* initialize common str
  *
  *  This function must be called before the first call to surf_solve()
  */
-XBT_PUBLIC(void) surf_presolve(void);
+XBT_PUBLIC(void) surf_presolve();
 
 /** \ingroup SURF_simulation
  *  \brief Performs a part of the simulation
@@ -740,7 +611,7 @@ XBT_PUBLIC(double) surf_solve(double max_date);
  *
  *  Return the current time in millisecond.
  */
-XBT_PUBLIC(double) surf_get_clock(void);
+XBT_PUBLIC(double) surf_get_clock();
 
 /** \ingroup SURF_simulation
  *  \brief Exit SURF
@@ -749,7 +620,7 @@ XBT_PUBLIC(double) surf_get_clock(void);
  *
  *  \see surf_init()
  */
-XBT_PUBLIC(void) surf_exit(void);
+XBT_PUBLIC(void) surf_exit();
 
 /* 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)
@@ -762,28 +633,26 @@ XBT_PUBLIC(void) parse_platform_file(const char *file);
 /* 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(xbt_dict_t) get_as_router_properties(const char* name);
-
 /*
  * 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);
+const char *__surf_get_initial_path();
 
 /********** 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);
+void TRACE_surf_alloc();
+void TRACE_surf_release();
 
 /* instr_routing.c */
-void instr_routing_define_callbacks (void);
+void instr_routing_define_callbacks ();
 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);
+int instr_platform_traced ();
+xbt_graph_t instr_routing_platform_graph ();
 void instr_routing_platform_graph_export_graphviz (xbt_graph_t g, const char *filename);
 
 SG_END_DECL()