1 /* Copyright (c) 2004-2012. The SimGrid Team. All rights reserved. */
3 /* This program is free software; you can redistribute it and/or modify it
4 * under the terms of the license (GNU LGPL) which comes with this package. */
9 #include "xbt/file_stat.h"
10 #include "simgrid/simix.h"
11 #include "simgrid_config.h" // for HAVE_TRACING
15 /* ******************************** Mailbox ************************************ */
17 /** @brief Mailbox datatype
18 * @ingroup msg_task_usage
20 * Object representing a communication rendez-vous point, on which
21 * the sender finds the receiver it wants to communicate with. As a
22 * MSG user, you will only rarely manipulate any of these objects
23 * directly, since most of the public interface (such as
24 * #MSG_task_send and friends) hide this object behind a string
25 * alias. That mean that you don't provide the mailbox on which you
26 * want to send your task, but only the name of this mailbox. */
27 typedef struct s_smx_rvpoint *msg_mailbox_t;
30 /* ******************************** Host ************************************ */
32 typedef struct msg_host {
34 smx_host_t smx_host; /**< SIMIX representation of this host */
35 #ifdef MSG_USE_DEPRECATED
36 msg_mailbox_t *mailboxes; /**< the channels */
40 /** @brief Host datatype.
41 @ingroup m_host_management
43 A <em>location</em> (or <em>host</em>) is any possible place where
44 a process may run. Thus it is represented as a <em>physical
45 resource with computing capabilities</em>, some <em>mailboxes</em>
46 to enable running process to communicate with remote ones, and
47 some <em>private data</em> that can be only accessed by local
50 typedef struct msg_host *msg_host_t;
52 /* ******************************** Task ************************************ */
54 typedef struct simdata_task *simdata_task_t;
56 typedef struct msg_task {
57 char *name; /**< @brief task name if any */
58 simdata_task_t simdata; /**< @brief simulator data */
59 void *data; /**< @brief user data */
61 long long int counter; /* task unique identifier for instrumentation */
62 char *category; /* task category for instrumentation */
66 /** @brief Task datatype.
67 @ingroup m_task_management
69 A <em>task</em> may then be defined by a <em>computing
70 amount</em>, a <em>message size</em> and some <em>private
73 typedef struct msg_task *msg_task_t;
76 /* ******************************** File ************************************ */
77 typedef struct simdata_file *simdata_file_t;
79 typedef struct msg_file {
80 char *name; /**< @brief file name */
81 simdata_file_t simdata; /**< @brief simulator data */
82 void *data; /**< @brief user data */
85 /** @brief File datatype.
86 @ingroup msg_file_management
88 You should consider this as an opaque object.
90 typedef struct msg_file *msg_file_t;
92 typedef s_file_stat_t s_msg_stat_t, *msg_stat_t;
95 /*************** Begin GPU ***************/
96 typedef struct simdata_gpu_task *simdata_gpu_task_t;
98 typedef struct msg_gpu_task {
99 char *name; /**< @brief task name if any */
100 simdata_gpu_task_t simdata; /**< @brief simulator data */
102 long long int counter; /* task unique identifier for instrumentation */
103 char *category; /* task category for instrumentation */
107 /** @brief GPU task datatype.
108 @ingroup m_task_management
110 A <em>task</em> may then be defined by a <em>computing
111 amount</em>, a <em>dispatch latency</em> and a <em>collect latency</em>.
112 \see m_task_management
114 typedef struct msg_gpu_task *msg_gpu_task_t;
115 /*************** End GPU ***************/
118 * \brief @brief Communication action.
119 * \ingroup msg_task_usage
121 * Object representing an ongoing communication between processes. Such beast is usually obtained by using #MSG_task_isend, #MSG_task_irecv or friends.
123 typedef struct msg_comm *msg_comm_t;
125 /** \brief Default value for an uninitialized #msg_task_t.
126 \ingroup m_task_management
128 #define MSG_TASK_UNINITIALIZED NULL
130 /* ****************************** Process *********************************** */
132 /** @brief Process datatype.
133 @ingroup m_process_management
135 A process may be defined as a <em>code</em>, with some
136 <em>private data</em>, executing in a <em>location</em>.
138 You should not access directly to the fields of the pointed
139 structure, but always use the provided API to interact with
142 typedef struct s_smx_process *msg_process_t;
144 #ifdef MSG_USE_DEPRECATED
146 /* Compatibility typedefs */
147 typedef int m_channel_t;
148 typedef msg_gpu_task_t m_gpu_task_t;
149 typedef msg_host_t m_host_t;
150 typedef msg_process_t m_process_t;
151 typedef msg_task_t m_task_t;
152 typedef s_msg_gpu_task_t s_m_gpu_task_t;
153 typedef s_msg_host_t s_m_host_t;
154 typedef s_msg_task_t s_m_task_t;