Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Just cleaned some stuff to only show undocumented functions refered
authorlbobelin <lbobelin@mintcar.imag.fr>
Mon, 2 Jul 2012 12:03:41 +0000 (14:03 +0200)
committerlbobelin <lbobelin@mintcar.imag.fr>
Mon, 2 Jul 2012 12:03:41 +0000 (14:03 +0200)
buildtools/Cmake/GenerateRefGuide.cmake
doc/user_guide/doxygen/deployment.doc
include/gras/process.h
src/instr/instr_interface.c
src/msg/msg_task.c
src/simix/smx_user.c
src/xbt/log.c

index 6f84227..1e7e6fe 100644 (file)
@@ -52,7 +52,7 @@ if(FIG2DEV_PATH)
     COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/shared/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/<IMG/<IMG style=border:0px/g' | ${CMAKE_HOME_DIRECTORY}/tools/doxygen/fig2dev_postprocessor.pl > ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen/simgrid_modules.map
     COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
     COMMAND ${DOXYGEN_PATH}/doxygen RefGuideDoxyfile
     COMMAND ${FIG2DEV_PATH}/fig2dev -Lmap ${CMAKE_HOME_DIRECTORY}/doc/shared/fig/simgrid_modules.fig | perl -pe 's/imagemap/simgrid_modules/g'| perl -pe 's/<IMG/<IMG style=border:0px/g' | ${CMAKE_HOME_DIRECTORY}/tools/doxygen/fig2dev_postprocessor.pl > ${CMAKE_HOME_DIRECTORY}/doc/ref_guide/doxygen/simgrid_modules.map
     COMMAND ${CMAKE_COMMAND} -E echo "XX First Doxygen pass"
     COMMAND ${DOXYGEN_PATH}/doxygen RefGuideDoxyfile
-    COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl simgridrefguide.tag index-API.doc
+    COMMAND ${CMAKE_HOME_DIRECTORY}/tools/doxygen/index_create.pl ../../shared/doxygen/simgridrefguide.tag index-API.doc
 
     COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
     COMMAND ${DOXYGEN_PATH}/doxygen RefGuideDoxyfile
 
     COMMAND ${CMAKE_COMMAND} -E echo "XX Second Doxygen pass"
     COMMAND ${DOXYGEN_PATH}/doxygen RefGuideDoxyfile
index 355cf35..6068893 100644 (file)
@@ -1,6 +1,12 @@
-/*! \page deployment Deployment description
+/*! \page deployment Deployment Description
 
 
-Deployment just consists of saying which
+\section dep_over Overview
+
+When using SimGrid, you basically need your user code, a platform description, and something allowing to map your (simulated) process on  your (simulated) platform. This is what deployment file is all about. Note that you can bypass the file stuff and code it directly in your user code, if you want to.
+
+
+\section dep_ex An example
+So deployment file just consists of saying which
 process runs where and which arguments it should take as input, the easier way to
 understand how to write it is just to take a look at the examples. Here is an example of it:
 
 process runs where and which arguments it should take as input, the easier way to
 understand how to write it is just to take a look at the examples. Here is an example of it:
 
@@ -28,11 +34,12 @@ understand how to write it is just to take a look at the examples. Here is an ex
 </platform>
 \endverbatim
 
 </platform>
 \endverbatim
 
-There are additional attributes to the process tag, here is a list of attributes of process: 
+\section process_tag Process
+There are optional attributes to the process tag, here is a list of all attributes of process: 
 
 
-\li <b>host CDATA (mandatory)</b>: the host on which the function will be executed.  
-\li <b>process CDATA (mandatory)</b>: the process function that will be executed on that host.
-\li <b>start_time</b>: the time when the function will start. Default is zero.
-\li <b>kill_time</b>: the time when the function will stop. Default is when it's actually finishing.
+\li <b>host (mandatory)</b>: the host on which the function will be executed.  
+\li <b>process (mandatory)</b>: the process function that will be executed on that host. You can deploy as many process as you want on the same host. 
+\li <b>start_time</b>: the (simulated) time when the function will start. Default is zero.
+\li <b>kill_time</b>: the  (simulated) time when the function will stop. Default is when it's actually finishing.
 
 */
 
 */
index 5cf7a16..073df64 100644 (file)
@@ -40,8 +40,7 @@ void gras_agent_spawn(const char *name, xbt_main_func_t code,
  * retrieve a reference to it.
  * 
  * 
  * retrieve a reference to it.
  * 
  * 
- * For more info on this, you may want to check the relevant lesson of the GRAS tutorial:
- * \ref GRAS_tut_tour_globals
+ * For more info on this, you may want to check the relevant lesson of the GRAS tutorial online
  */
 /* @{ */
 
  */
 /* @{ */
 
@@ -64,7 +63,7 @@ XBT_PUBLIC(void *) gras_userdata_set(void *ud);
  * the only solution since this macro has to compute the size to
  * malloc and should thus know the pointed type. 
  *
  * the only solution since this macro has to compute the size to
  * malloc and should thus know the pointed type. 
  *
- * You'll find an example in the tutorial:  \ref GRAS_tut_tour_globals
+ * You'll find an example in the tutorial
  */
 #define gras_userdata_new(type) ((type*)gras_userdata_set(xbt_new0(type,1)))
 /* @} */
  */
 #define gras_userdata_new(type) ((type*)gras_userdata_set(xbt_new0(type,1)))
 /* @} */
index bd00cca..673cac8 100644 (file)
@@ -53,7 +53,7 @@ static xbt_dynar_t instr_dict_to_dynar (xbt_dict_t filter)
  *  that is being declared is random. This function has no effect
  *  if a category with the same name has been already declared.
  *
  *  that is being declared is random. This function has no effect
  *  if a category with the same name has been already declared.
  *
- * See \ref tracing_tracing for details on how to trace
+ * See \ref tracing for details on how to trace
  * the (categorized) resource utilization.
  *
  *  \param category The name of the new tracing category to be created.
  * the (categorized) resource utilization.
  *
  *  \param category The name of the new tracing category to be created.
@@ -74,11 +74,11 @@ void TRACE_category(const char *category)
  *  can be specified using "0.7 0.7 0.7" as color. This function has
  *  no effect if a category with the same name has been already declared.
  *
  *  can be specified using "0.7 0.7 0.7" as color. This function has
  *  no effect if a category with the same name has been already declared.
  *
- * See \ref tracing_tracing for details on how to trace
+ * See \ref tracing for details on how to trace
  * the (categorized) resource utilization.
  *
  *  \param category The name of the new tracing category to be created.
  * the (categorized) resource utilization.
  *
  *  \param category The name of the new tracing category to be created.
- *  \param color The color of the category (see \ref tracing_tracing to
+ *  \param color The color of the category (see \ref tracing to
  *  know how to correctly specify the color)
  *
  *  \see MSG_task_set_category, SD_task_set_category
  *  know how to correctly specify the color)
  *
  *  \see MSG_task_set_category, SD_task_set_category
@@ -123,7 +123,7 @@ void TRACE_category_with_color (const char *category, const char *color)
  * This function should be used to get categories that were already
  * declared with #TRACE_category or with #TRACE_category_with_color.
  *
  * This function should be used to get categories that were already
  * declared with #TRACE_category or with #TRACE_category_with_color.
  *
- * See \ref tracing_tracing for details on how to trace
+ * See \ref tracing for details on how to trace
  * the (categorized) resource utilization.
  *
  * \return A dynar with the declared categories, must be freed with xbt_dynar_free.
  * the (categorized) resource utilization.
  *
  * \return A dynar with the declared categories, must be freed with xbt_dynar_free.
index 117a72e..fce74f5 100644 (file)
@@ -119,9 +119,9 @@ MSG_parallel_task_create(const char *name, int host_nb,
 
 /*************** Begin GPU ***************/
 /** \ingroup m_task_management
 
 /*************** Begin GPU ***************/
 /** \ingroup m_task_management
- * \brief Creates a new #m_gpu_task_t.
+ * \brief Creates a new #msg_gpu_task_t.
 
 
- * A constructor for #m_gpu_task_t taking four arguments and returning
+ * A constructor for #msg_gpu_task_t taking four arguments and returning
    a pointer to the new created GPU task.
 
  * \param name a name for the object. It is for user-level information
    a pointer to the new created GPU task.
 
  * \param name a name for the object. It is for user-level information
@@ -136,7 +136,7 @@ MSG_parallel_task_create(const char *name, int host_nb,
  * \param collect_latency time in seconds to transfer result from the GPU
    back to the CPU (host) when done
 
  * \param collect_latency time in seconds to transfer result from the GPU
    back to the CPU (host) when done
 
- * \see m_gpu_task_t
+ * \see msg_gpu_task_t
  * \return The new corresponding object.
  */
 msg_gpu_task_t MSG_gpu_task_create(const char *name, double compute_duration,
  * \return The new corresponding object.
  */
 msg_gpu_task_t MSG_gpu_task_create(const char *name, double compute_duration,
index 225df8d..771268f 100644 (file)
@@ -153,7 +153,7 @@ void* simcall_host_get_data(smx_host_t host)
  * \brief Sets the user data associated to a host.
  *
  * The host must not have previous user data associated to it.
  * \brief Sets the user data associated to a host.
  *
  * The host must not have previous user data associated to it.
- * \param A host SIMIX host
+ * \param host A SIMIX host
  * \param data The user data to set
  */
 void simcall_host_set_data(smx_host_t host, void *data)
  * \param data The user data to set
  */
 void simcall_host_set_data(smx_host_t host, void *data)
@@ -175,7 +175,8 @@ void simcall_host_set_data(smx_host_t host, void *data)
  *
  * \param name Name of the execution action to create
  * \param host SIMIX host where the action will be executed
  *
  * \param name Name of the execution action to create
  * \param host SIMIX host where the action will be executed
- * \param amount Computation amount (in bytes)
+ * \param computation_amount amount Computation amount (in bytes)
+ * \param priority computation priority
  * \return A new SIMIX execution action
  */
 smx_action_t simcall_host_execute(const char *name, smx_host_t host,
  * \return A new SIMIX execution action
  */
 smx_action_t simcall_host_execute(const char *name, smx_host_t host,
@@ -252,7 +253,7 @@ smx_action_t simcall_host_parallel_execute(const char *name,
  * \brief Destroys an execution action.
  *
  * Destroys an action, freing its memory. This function cannot be called if there are a conditional waiting for it.
  * \brief Destroys an execution action.
  *
  * Destroys an action, freing its memory. This function cannot be called if there are a conditional waiting for it.
- * \param action The execution action to destroy
+ * \param execution The execution action to destroy
  */
 void simcall_host_execution_destroy(smx_action_t execution)
 {
  */
 void simcall_host_execution_destroy(smx_action_t execution)
 {
@@ -268,7 +269,7 @@ void simcall_host_execution_destroy(smx_action_t execution)
  * \brief Cancels an execution action.
  *
  * This functions stops the execution. It calls a surf function.
  * \brief Cancels an execution action.
  *
  * This functions stops the execution. It calls a surf function.
- * \param action The execution action to cancel
+ * \param execution The execution action to cancel
  */
 void simcall_host_execution_cancel(smx_action_t execution)
 {
  */
 void simcall_host_execution_cancel(smx_action_t execution)
 {
@@ -283,7 +284,7 @@ void simcall_host_execution_cancel(smx_action_t execution)
  * \ingroup simix_host_management
  * \brief Returns how much of an execution action remains to be done.
  *
  * \ingroup simix_host_management
  * \brief Returns how much of an execution action remains to be done.
  *
- * \param Action The execution action
+ * \param execution The execution action
  * \return The remaining amount
  */
 double simcall_host_execution_get_remains(smx_action_t execution)
  * \return The remaining amount
  */
 double simcall_host_execution_get_remains(smx_action_t execution)
@@ -366,6 +367,7 @@ e_smx_state_t simcall_host_execution_wait(smx_action_t execution)
  * \param argc first argument passed to \a code
  * \param argv second argument passed to \a code
  * \param properties the properties of the process
  * \param argc first argument passed to \a code
  * \param argv second argument passed to \a code
  * \param properties the properties of the process
+ * \param auto_restart either it is autorestarting or not.
  */
 void simcall_process_create(smx_process_t *process, const char *name,
                               xbt_main_func_t code,
  */
 void simcall_process_create(smx_process_t *process, const char *name,
                               xbt_main_func_t code,
@@ -442,7 +444,6 @@ void simcall_process_cleanup(smx_process_t process)
  * This function changes the value of the host on which \a process is running.
  *
  * \param process the process to migrate
  * This function changes the value of the host on which \a process is running.
  *
  * \param process the process to migrate
- * \param source name of the previous host
  * \param dest name of the new host
  */
 void simcall_process_change_host(smx_process_t process, smx_host_t dest)
  * \param dest name of the new host
  */
 void simcall_process_change_host(smx_process_t process, smx_host_t dest)
@@ -721,7 +722,7 @@ smx_rdv_t simcall_rdv_create(const char *name)
 /**
  *  \ingroup simix_rdv_management
  *  \brief Destroy a rendez-vous point
 /**
  *  \ingroup simix_rdv_management
  *  \brief Destroy a rendez-vous point
- *  \param name The rendez-vous point to destroy
+ *  \param rdv The rendez-vous point to destroy
  */
 void simcall_rdv_destroy(smx_rdv_t rdv)
 {
  */
 void simcall_rdv_destroy(smx_rdv_t rdv)
 {
index 245f176..2e2735c 100644 (file)
@@ -274,9 +274,6 @@ int main() {
 }
 \endverbatim
 
 }
 \endverbatim
 
-Another example can be found in the relevant part of the GRAS tutorial:
-\ref GRAS_tut_tour_logs.
-
 \section log_user 3. User interface
 
 \section log_use_conf 3.1 Configuration
 \section log_user 3. User interface
 
 \section log_use_conf 3.1 Configuration