src/msg/task.c

   1 /*      $Id$     */
   2
   3 /* Copyright (c) 2002,2003,2004 Arnaud Legrand. All rights reserved.        */
   4
   5 /* This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the license (GNU LGPL) which comes with this package. */
   7
   8 #include"private.h"
   9 #include"xbt/sysdep.h"
  10 #include "xbt/error.h"
  11 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(task, msg,
  12                                 "Logging specific to MSG (task)");
  13
  14 static char sprint_buffer[64];
  15
  16 /********************************* Task **************************************/
  17 /** \ingroup m_task_management
  18  * \brief Creates a new #m_task_t.
  19  *
  20  * A constructor for #m_task_t taking four arguments and returning the
  21    corresponding object.
  22  * \param name a name for the object. It is for user-level information
  23    and can be NULL.
  24  * \param compute_duration a value of the processing amount (in Mflop)
  25    needed to process this new task. If 0, then it cannot be executed with
  26    MSG_task_execute(). This value has to be >=0.
  27  * \param message_size a value of the amount of data (in Mb) needed to
  28    transfer this new task. If 0, then it cannot be transfered with
  29    MSG_task_get() and MSG_task_put(). This value has to be >=0.
  30  * \param data a pointer to any data may want to attach to the new
  31    object.  It is for user-level information and can be NULL. It can
  32    be retrieved with the function \ref MSG_task_get_data.
  33  * \see m_task_t
  34  * \return The new corresponding object.
  35  */
  36 m_task_t MSG_task_create(const char *name, long double compute_duration,
  37                          long double message_size, void *data)
  38 {
  39   sim_data_task_t sim_data = xbt_new0(s_sim_data_task_t,1);
  40   m_task_t task = xbt_new0(s_m_task_t,1);
  41
  42   /* Task structure */
  43   task->name = xbt_strdup(name);
  44   task->simdata = sim_data;
  45   task->data = data;
  46
  47   /* Simulator Data */
  48   sim_data->sleeping = xbt_dynar_new(sizeof(m_process_t),NULL);
  49   sim_data->computation_amount = compute_duration;
  50   sim_data->message_size = message_size;
  51
  52   return task;
  53 }
  54
  55 /** \ingroup m_task_management
  56  * \brief Return the user data of a #m_task_t.
  57  *
  58  * This functions checks whether \a task is a valid pointer or not and return
  59    the user data associated to \a task if it is possible.
  60  */
  61 void *MSG_task_get_data(m_task_t task)
  62 {
  63   xbt_assert0((task != NULL), "Invalid parameter");
  64
  65   return (task->data);
  66 }
  67
  68 /** \ingroup m_task_management
  69  * \brief Destroy a #m_task_t.
  70  *
  71  * Destructor for #m_task_t. Note that you should free user data, if any, \b
  72    before calling this function.
  73  */
  74 MSG_error_t MSG_task_destroy(m_task_t task)
  75 {
  76   sim_data_task_t sim_data = NULL;
  77   surf_action_t action = NULL;
  78   int i;
  79
  80   xbt_assert0((task != NULL), "Invalid parameter");
  81   xbt_assert0((xbt_dynar_length(task->simdata->sleeping)==0),
  82               "Task still used. Cannot destroy it now!");
  83
  84   if(task->name) xbt_free(task->name);
  85
  86   xbt_dynar_free(&(task->simdata->sleeping));
  87
  88   action = task->simdata->compute;
  89   if(action) action->resource_type->common_public->action_free(action);
  90   action = task->simdata->comm;
  91   if(action) action->resource_type->common_public->action_free(action);
  92
  93
  94   xbt_free(task->simdata);
  95   xbt_free(task);
  96
  97   return MSG_OK;
  98 }
  99
 100 /* static MSG_error_t __MSG_task_check(m_task_t task) */
 101 /* { */
 102 /*   sim_data_task_t sim_data = NULL; */
 103 /*   int warning = 0; */
 104
 105 /*   if (task == NULL) {                /\* Fatal *\/ */
 106 /*     WARNING("Task uninitialized"); */
 107 /*     return MSG_FATAL; */
 108 /*   } */
 109 /*   sim_data = task->simdata; */
 110
 111 /*   if (sim_data == NULL) {    /\* Fatal *\/ */
 112 /*     WARNING("Simulator Data uninitialized"); */
 113 /*     return MSG_FATAL; */
 114 /*   } */
 115
 116 /*   if (sim_data->compute == NULL) {   /\* Fatal if execute ... *\/ */
 117 /*     WARNING("No duration set for this task"); */
 118 /*     warning++; */
 119 /*   } */
 120
 121 /*   if (sim_data->message_size == 0) { /\* Fatal if transfered ... *\/ */
 122 /*     WARNING("No message_size set for this task"); */
 123 /*     warning++; */
 124 /*   } */
 125
 126 /* /\*    if (task->data == NULL) { *\/ */
 127 /* /\*      WARNING("User Data uninitialized"); *\/ */
 128 /* /\*      warning++; *\/ */
 129 /* /\*    } *\/ */
 130
 131 /*   if (warning) */
 132 /*     return MSG_WARNING; */
 133 /*   return MSG_OK; */
 134 /* } */
 135
 136 /* static m_task_t __MSG_task_copy(m_task_t src) */
 137 /* { */
 138 /*   m_task_t copy = NULL; */
 139 /*   sim_data_task_t sim_data = NULL; */
 140
 141 /*   __MSG_task_check(src); */
 142
 143 /*   sim_data = src->simdata; */
 144 /*   copy = MSG_task_create(src->name, SG_getTaskCost(sim_data->compute), */
 145 /*                       sim_data->message_size, MSG_task_get_data(src)); */
 146
 147 /*   return (copy); */
 148 /* } */
 149
 150 MSG_error_t __MSG_task_wait_event(m_process_t process, m_task_t task)
 151 {
 152   xbt_assert0(((task != NULL)
 153                && (task->simdata != NULL)), "Invalid parameters");
 154
 155   xbt_dynar_push(task->simdata->sleeping, process);
 156   process->simdata->waiting_task = task;
 157   xbt_context_yield(process->simdata->context);
 158   process->simdata->waiting_task = NULL;
 159
 160   return MSG_OK;
 161 }