Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Update msg_storage_t structure and prepare new storage functions
[simgrid.git] / include / msg / datatypes.h
index 26263da..c01b243 100644 (file)
@@ -1,5 +1,4 @@
-/* Copyright (c) 2004, 2005, 2007, 2008, 2009, 2010. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2004-2012. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
@@ -7,22 +6,35 @@
 #ifndef MSG_DATATYPE_H
 #define MSG_DATATYPE_H
 #include "xbt/misc.h"
+#include "xbt/lib.h"
+#include "simgrid/simix.h"
+#include "simgrid_config.h"     // for HAVE_TRACING
 
 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_rvpoint *msg_mailbox_t;
+
+/* ******************************** Environment ************************************ */
+typedef struct s_as *msg_as_t;
+
 /* ******************************** Host ************************************ */
-/** @defgroup m_datatypes_management_details Details on MSG datatypes
-    @ingroup  m_datatypes_management*/
-     typedef struct simdata_host *simdata_host_t;
-/** @brief Host datatype 
-    @ingroup m_datatypes_management_details */
-     typedef struct m_host {
-       char *name;              /**< @brief host name if any */
-       simdata_host_t simdata;  /**< @brief simulator data */
-       void *data;              /**< @brief user data */
-     } s_m_host_t;
-/** @brief Host datatype  
-    @ingroup m_datatypes_management
+
+extern int MSG_HOST_LEVEL;
+
+/** @brief Host datatype.
+    @ingroup m_host_management
 
     A <em>location</em> (or <em>host</em>) is any possible place where
     a process may run. Thus it is represented as a <em>physical
@@ -30,108 +42,161 @@ SG_BEGIN_DECL()
     to enable running process to communicate with remote ones, and
     some <em>private data</em> that can be only accessed by local
     process.
+ */
+typedef xbt_dictelm_t msg_host_t;
+typedef s_xbt_dictelm_t s_msg_host_t;
+
+typedef struct msg_host_priv {
+  xbt_swag_t vms;
+#ifdef MSG_USE_DEPRECATED
+  msg_mailbox_t *mailboxes;     /**< the channels  */
+#endif
+} s_msg_host_priv_t, *msg_host_priv_t;
+
+static inline msg_host_priv_t MSG_host_priv(msg_host_t host){
+  return (msg_host_priv_t )xbt_lib_get_level(host, MSG_HOST_LEVEL);
+}
+
+
 
-    \see m_host_management
-  @{ */
-     typedef struct m_host *m_host_t;
-/** @} */
 /* ******************************** Task ************************************ */
 
-     typedef struct simdata_task *simdata_task_t;
-/** @brief Task datatype 
-    @ingroup m_datatypes_management_details */
-     typedef struct m_task {
-       char *name;              /**< @brief task name if any */
-       simdata_task_t simdata;  /**< @brief simulator data */
-       void *data;              /**< @brief user data */
+typedef struct simdata_task *simdata_task_t;
+
+typedef struct msg_task {
+  char *name;                   /**< @brief task name if any */
+  simdata_task_t simdata;       /**< @brief simulator data */
+  void *data;                   /**< @brief user data */
 #ifdef HAVE_TRACING
-       long long int counter;   /* task unique identifier for instrumentation */
-       char *category;      /* task category for instrumentation */
+  long long int counter;        /* task unique identifier for instrumentation */
+  char *category;               /* task category for instrumentation */
 #endif
-     } s_m_task_t;
-/** @brief Task datatype  
-    @ingroup m_datatypes_management 
+} s_msg_task_t;
+
+/** @brief Task datatype.
+    @ingroup m_task_management 
 
     A <em>task</em> may then be defined by a <em>computing
     amount</em>, a <em>message size</em> and some <em>private
     data</em>.
-    \see m_task_management
-  @{ */
-     typedef struct m_task *m_task_t;
+ */
+typedef struct msg_task *msg_task_t;
+
+/* ********************************  VM ************************************* */
+typedef struct msg_vm *msg_vm_t;
+
+typedef enum {
+  msg_vm_state_suspended, msg_vm_state_running, msg_vm_state_migrating
+} e_msg_vm_state_t;
+
+typedef struct msg_vm {
+  char *name;
+  s_xbt_swag_hookup_t all_vms_hookup;
+  s_xbt_swag_hookup_t host_vms_hookup;
+  xbt_dynar_t processes;
+  e_msg_vm_state_t state;
+  msg_host_t location;
+  int coreAmount;
+} s_msg_vm_t;
+
+/* ******************************** File ************************************ */
+typedef struct simdata_file *simdata_file_t;
+
+typedef struct s_file_info {
+  size_t size;
+  char* mount_point;
+  char* storageId;
+  char* storage_type;
+  char* content_type;
+} s_file_info_t, *msg_file_info_t;
+
+typedef struct msg_file {
+  char *fullname;               /**< @brief file full name (path+name)*/
+  simdata_file_t simdata;       /**< @brief simulator data  */
+  void *data;                   /**< @brief user data */
+  msg_file_info_t info;
+} s_msg_file_t;
+
+/** @brief File datatype.
+    @ingroup msg_file_management 
+    You should consider this as an opaque object.
+ */
+
+typedef struct msg_file *msg_file_t;
+
+/* ******************************** Storage ************************************ */
+typedef struct simdata_storage *simdata_storage_t;
+
+typedef struct msg_storage {
+  char *name;
+  simdata_storage_t simdata;    /**< @brief simulator data  */
+  void *data;                   /**< @brief user data */
+} s_msg_storage_t;
+
+typedef struct msg_storage *msg_storage_t;
+
+/*************** Begin GPU ***************/
+typedef struct simdata_gpu_task *simdata_gpu_task_t;
+
+typedef struct msg_gpu_task {
+  char *name;                   /**< @brief task name if any */
+  simdata_gpu_task_t simdata;       /**< @brief simulator data */
+#ifdef HAVE_TRACING
+  long long int counter;        /* task unique identifier for instrumentation */
+  char *category;               /* task category for instrumentation */
+#endif
+} s_msg_gpu_task_t;
 
-/** \brief Default value for an uninitialized #m_task_t.
-    \ingroup m_datatypes_management 
+/** @brief GPU task datatype.
+    @ingroup m_task_management
+
+    A <em>task</em> may then be defined by a <em>computing
+    amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
+    \see m_task_management
+*/
+typedef struct msg_gpu_task *msg_gpu_task_t;
+/*************** End GPU ***************/
+
+/**
+ * \brief @brief Communication action.
+ * \ingroup msg_task_usage
+ *
+ * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
+ */
+typedef struct msg_comm *msg_comm_t;
+
+/** \brief Default value for an uninitialized #msg_task_t.
+    \ingroup m_task_management 
 */
 #define MSG_TASK_UNINITIALIZED NULL
 
-     typedef struct s_smx_comm *msg_comm_t;
-/** @} */
-
-
-
 /* ****************************** Process *********************************** */
-     typedef struct simdata_process *simdata_process_t;
-/** @brief Process datatype 
-    @ingroup m_datatypes_management_details @{ */
-     typedef struct m_process {
-       char *name;              /**< @brief process name if any */
-       simdata_process_t simdata;
-                                /**< @brief simulator data */
-       void *data;              /**< @brief user data */
-       char *category;      /* process category for instrumentation */
-     } s_m_process_t;
-/** @} */
-/** @brief Agent datatype  
-    @ingroup m_datatypes_management 
-
-    An agent may be defined as a <em>code</em>, with some <em>private
-    data</em>, executing in a <em>location</em>.
-    \see m_process_management
-  @{ */
-     typedef struct m_process *m_process_t;
-/** @} */
-
-/* ********************************* Channel ******************************** */
-/** @brief Channel datatype  
-    @ingroup m_datatypes_management 
-
-    A <em>channel</em>  is a number and identifies a mailbox type (just as a 
-    port number does).
-    \see m_channel_management
-   @{ */
-     typedef int m_channel_t;
-/** @} */
-
-/* ******************************** Mailbox ************************************ */
 
-     typedef struct s_msg_mailbox *msg_mailbox_t;
-/** @brief Mailbox datatype
-    @ingroup m_datatypes_management_details @{ */
-
-     msg_mailbox_t MSG_mailbox_create(const char *alias);
-     void MSG_mailbox_free(void *mailbox);
-
-
-/** @} */
-
-
-/* ***************************** Error handling ***************************** */
-/** @brief Error handling 
-    @ingroup m_datatypes_management 
-    @{
-*/ /* Keep these code as binary values: java bindings manipulate | of these values */
-     typedef enum {
-       MSG_OK = 0,            /**< @brief Everything is right. Keep on going this way ! */
-       MSG_TIMEOUT=1,         /**< @brief nothing good happened before the timer you provided elapsed */
-       MSG_TRANSFER_FAILURE=2,/**< @brief There has been a problem during you task
-      transfer. Either the network is down or the remote host has been
-      shutdown. */
-       MSG_HOST_FAILURE=4,    /**< @brief System shutdown. The host on which you are
-      running has just been rebooted. Free your datastructures and
-      return now !*/
-       MSG_TASK_CANCELLED=8,  /**< @brief Canceled task. This task has been canceled by somebody!*/
-     } MSG_error_t;
-/** @} */
+/** @brief Process datatype.
+    @ingroup m_process_management
+
+    A process may be defined as a <em>code</em>, with some
+    <em>private data</em>, executing in a <em>location</em>. 
+    You should not access directly to the fields of the pointed
+    structure, but always use the provided API to interact with
+    processes.
+ */
+typedef struct s_smx_process *msg_process_t;
+
+#ifdef MSG_USE_DEPRECATED
+
+/* Compatibility typedefs */
+typedef int                     m_channel_t;
+typedef msg_gpu_task_t          m_gpu_task_t;
+typedef msg_host_t              m_host_t;
+typedef msg_process_t           m_process_t;
+typedef msg_task_t              m_task_t;
+typedef s_msg_gpu_task_t        s_m_gpu_task_t;
+typedef s_msg_host_t            s_m_host_t;
+typedef s_msg_task_t            s_m_task_t;
+#endif
 
 SG_END_DECL()
 #endif