Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add option to play with the max number of files opened on each host at the same time
[simgrid.git] / include / simgrid / msg.h
index ea973f2..f66a337 100644 (file)
 
 SG_BEGIN_DECL()
 
-/* ******************************** Mailbox ************************************ */
-
-/** @brief Mailbox datatype
- *  @ingroup msg_task_usage
- *
- * Object representing a communication rendez-vous point, on which
- * the sender finds the receiver it wants to communicate with. As a
- * MSG user, you will only rarely manipulate any of these objects
- * directly, since most of the public interface (such as
- * #MSG_task_send and friends) hide this object behind a string
- * alias. That mean that you don't provide the mailbox on which you
- * want to send your task, but only the name of this mailbox. */
-typedef struct s_smx_mailbox *msg_mailbox_t;
-
-/* ******************************** Environment ************************************ */
+/* ************************* Autonomous System ****************************** */
 typedef simgrid_As *msg_as_t;
 
 /* ******************************** Host ************************************ */
@@ -55,6 +41,8 @@ typedef struct s_msg_host_priv {
   xbt_dynar_t file_descriptor_table;
 } s_msg_host_priv_t;
 
+XBT_PUBLIC_DATA(int) sg_storage_max_file_descriptors;
+
 /* ******************************** Task ************************************ */
 
 typedef struct simdata_task *simdata_task_t;
@@ -79,20 +67,17 @@ typedef struct msg_task *msg_task_t;
 /* ******************************** VM ************************************* */
 typedef msg_host_t msg_vm_t;
 
-/** ******************************** File ************************************ */
+/* ******************************** File ************************************ */
 
-/** @brief File datatype.
-*  @ingroup msg_file_management
-*
-*  You should consider this as an opaque object.
-*/
+/** @brief Opaque object describing a File in MSG.
+ *  @ingroup msg_file */
 typedef xbt_dictelm_t msg_file_t;
 typedef s_xbt_dictelm_t s_msg_file_t;
 
 extern int MSG_FILE_LEVEL;
 typedef struct simdata_file *simdata_file_t;
 
-typedef struct msg_file_priv  {
+struct msg_file_priv  {
   char *fullpath;
   sg_size_t size;
   char* mount_point;
@@ -102,7 +87,9 @@ typedef struct msg_file_priv  {
   int desc_id;
   void *data;
   simdata_file_t simdata;
-} s_msg_file_priv_t, *msg_file_priv_t;
+};
+typedef struct msg_file_priv s_msg_file_priv_t;
+typedef struct msg_file_priv* msg_file_priv_t;
 
 static inline msg_file_priv_t MSG_file_priv(msg_file_t file){
   return (msg_file_priv_t )xbt_lib_get_level(file, MSG_FILE_LEVEL);
@@ -121,10 +108,12 @@ extern int MSG_STORAGE_LEVEL;
 typedef xbt_dictelm_t msg_storage_t;
 typedef s_xbt_dictelm_t s_msg_storage_t;
 
-typedef struct msg_storage_priv  {
+struct msg_storage_priv  {
   const char *hostname;
   void *data;
-} s_msg_storage_priv_t, *msg_storage_priv_t;
+};
+typedef struct msg_storage_priv  s_msg_storage_priv_t;
+typedef struct msg_storage_priv* msg_storage_priv_t;
 
 static inline msg_storage_priv_t MSG_storage_priv(msg_storage_t storage){
   return (msg_storage_priv_t )xbt_lib_get_level(storage, MSG_STORAGE_LEVEL);
@@ -155,7 +144,7 @@ typedef struct msg_comm *msg_comm_t;
     structure, but always use the provided API to interact with
     processes.
  */
-typedef struct s_smx_process *msg_process_t;
+typedef smx_process_t msg_process_t;
 
 /** @brief Return code of most MSG functions
     @ingroup msg_simulation
@@ -196,7 +185,6 @@ XBT_PUBLIC(msg_error_t) MSG_main(void);
 XBT_PUBLIC(void) MSG_function_register(const char *name,
                                        xbt_main_func_t code);
 XBT_PUBLIC(void) MSG_function_register_default(xbt_main_func_t code);
-XBT_PUBLIC(xbt_main_func_t) MSG_get_registered_function(const char *name);
 XBT_PUBLIC(void) MSG_launch_application(const char *file);
 /*Bypass the parser */
 XBT_PUBLIC(void) MSG_set_function(const char *host_id,
@@ -449,27 +437,6 @@ XBT_PUBLIC(void) MSG_task_set_category (msg_task_t task, const char *category);
 XBT_PUBLIC(const char *) MSG_task_get_category (msg_task_t task);
 
 /************************** Mailbox handling ************************************/
-/* @brief MSG_mailbox_new - create a new mailbox.
- * Creates a new mailbox identified by the key specified by the parameter alias and add it in the global dictionary.
- * @param  alias  The alias of the mailbox to create.
- * @return        The newly created mailbox.
- */
-XBT_PUBLIC(msg_mailbox_t) MSG_mailbox_new(const char *alias);
-
-/* @brief MSG_mailbox_get_by_alias - get a mailbox from its alias.
- * Returns the mailbox associated with the key specified by the parameter alias. If the mailbox does not exists,
- * the function creates it.
- * @param   alias    The alias of the mailbox to return.
- * @return           The mailbox associated with the alias specified as parameter or a new one if the key doesn't match.
- */
-XBT_PUBLIC(msg_mailbox_t) MSG_mailbox_get_by_alias(const char *alias);
-
-/* @brief MSG_mailbox_is_empty - test if a mailbox is empty.
- * Tests if a mailbox is empty (contains no msg task).
- * @param   mailbox  The mailbox to get test.
- * @return           1 if the mailbox is empty, 0 otherwise.
- */
-XBT_PUBLIC(int) MSG_mailbox_is_empty(msg_mailbox_t mailbox);
 
 /* @brief MSG_mailbox_set_async - set a mailbox as eager
  * Sets the mailbox to a permanent receiver mode. Messages sent to this mailbox will then be sent just after the send
@@ -479,20 +446,6 @@ XBT_PUBLIC(int) MSG_mailbox_is_empty(msg_mailbox_t mailbox);
  */
 XBT_PUBLIC(void) MSG_mailbox_set_async(const char *alias);
 
-/* @brief MSG_mailbox_get_head - get the task at the head of a mailbox.
- * Returns the task at the head of the mailbox. This function does not remove the task from the mailbox.
- * @param   mailbox  The mailbox concerned by the operation.
- * @return           The task at the head of the mailbox.
- */
-XBT_PUBLIC(msg_task_t) MSG_mailbox_get_head(msg_mailbox_t mailbox);
-
-XBT_PUBLIC(msg_error_t) MSG_mailbox_get_task_ext(msg_mailbox_t mailbox, msg_task_t * task, msg_host_t host,
-                                                 double timeout);
-XBT_PUBLIC(msg_error_t) MSG_mailbox_get_task_ext_bounded(msg_mailbox_t mailbox, msg_task_t *task, msg_host_t host,
-                                                         double timeout, double rate);
-XBT_PUBLIC(msg_error_t) MSG_mailbox_put_with_timeout(msg_mailbox_t mailbox, msg_task_t task, double timeout);
-
-
 /************************** Action handling **********************************/
 XBT_PUBLIC(msg_error_t) MSG_action_trace_run(char *path);
 XBT_PUBLIC(void) MSG_action_init(void);
@@ -507,7 +460,7 @@ XBT_PUBLIC(msg_sem_t) MSG_sem_init(int initial_value);
 XBT_PUBLIC(void) MSG_sem_acquire(msg_sem_t sem);
 XBT_PUBLIC(msg_error_t) MSG_sem_acquire_timeout(msg_sem_t sem, double timeout);
 XBT_PUBLIC(void) MSG_sem_release(msg_sem_t sem);
-XBT_PUBLIC(void) MSG_sem_get_capacity(msg_sem_t sem);
+XBT_PUBLIC(int) MSG_sem_get_capacity(msg_sem_t sem);
 XBT_PUBLIC(void) MSG_sem_destroy(msg_sem_t sem);
 XBT_PUBLIC(int) MSG_sem_would_block(msg_sem_t sem);
 
@@ -531,17 +484,17 @@ XBT_PUBLIC(int) MSG_barrier_wait(msg_bar_t bar);
  *
  */
 
-XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t);
-XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t);
-XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t);
+XBT_PUBLIC(int) MSG_vm_is_created(msg_vm_t vm);
+XBT_PUBLIC(int) MSG_vm_is_running(msg_vm_t vm);
+XBT_PUBLIC(int) MSG_vm_is_migrating(msg_vm_t vm);
 
-XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t);
-XBT_PUBLIC(int) MSG_vm_is_saving(msg_vm_t);
-XBT_PUBLIC(int) MSG_vm_is_saved(msg_vm_t);
-XBT_PUBLIC(int) MSG_vm_is_restoring(msg_vm_t);
+XBT_PUBLIC(int) MSG_vm_is_suspended(msg_vm_t vm);
+XBT_PUBLIC(int) MSG_vm_is_saving(msg_vm_t vm);
+XBT_PUBLIC(int) MSG_vm_is_saved(msg_vm_t vm);
+XBT_PUBLIC(int) MSG_vm_is_restoring(msg_vm_t vm);
 
 
-XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t);
+XBT_PUBLIC(const char*) MSG_vm_get_name(msg_vm_t vm);
 
 // TODO add VDI later
 XBT_PUBLIC(msg_vm_t) MSG_vm_create_core(msg_host_t location, const char *name);
@@ -550,7 +503,7 @@ XBT_PUBLIC(msg_vm_t) MSG_vm_create(msg_host_t ind_pm, const char *name,
 
 XBT_PUBLIC(void) MSG_vm_destroy(msg_vm_t vm);
 
-XBT_PUBLIC(void) MSG_vm_start(msg_vm_t);
+XBT_PUBLIC(void) MSG_vm_start(msg_vm_t vm);
 
 /* Shutdown the guest operating system. */
 XBT_PUBLIC(void) MSG_vm_shutdown(msg_vm_t vm);
@@ -599,5 +552,10 @@ xbt_dynar_t<msg_vm_t> MSG_vm_get_list_from_hosts(msg_dynar_t<msg_host_t>)
 /* Used only by the bindings -- unclean pimple, please ignore if you're not writing a binding */
 XBT_PUBLIC(smx_context_t) MSG_process_get_smx_ctx(msg_process_t process);
 
+
+/* Functions renamed in 3.14 */
+#define MSG_mailbox_get_head(m) MSG_mailbox_front(m)
+
+
 SG_END_DECL()
 #endif