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   simdata_task_t simdata = xbt_new0(s_simdata_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 = simdata;
  45   task->data = data;
  46
  47   /* Simulator Data */
  48   simdata->sleeping = xbt_dynar_new(sizeof(m_process_t),NULL);
  49   simdata->computation_amount = compute_duration;
  50   simdata->message_size = message_size;
  51   simdata->using = 1;
  52   simdata->sender = NULL;
  53
  54   return task;
  55 }
  56
  57 /** \ingroup m_task_management
  58  * \brief Return the user data of a #m_task_t.
  59  *
  60  * This functions checks whether \a task is a valid pointer or not and return
  61    the user data associated to \a task if it is possible.
  62  */
  63 void *MSG_task_get_data(m_task_t task)
  64 {
  65   xbt_assert0((task != NULL), "Invalid parameter");
  66
  67   return (task->data);
  68 }
  69
  70 /** \ingroup m_task_management
  71  * \brief Destroy a #m_task_t.
  72  *
  73  * Destructor for #m_task_t. Note that you should free user data, if any, \b
  74    before calling this function.
  75  */
  76 MSG_error_t MSG_task_destroy(m_task_t task)
  77 {
  78   simdata_task_t simdata = NULL;
  79   surf_action_t action = NULL;
  80   int i;
  81
  82   xbt_assert0((task != NULL), "Invalid parameter");
  83   xbt_assert0((xbt_dynar_length(task->simdata->sleeping)==0),
  84               "Task still used. Cannot destroy it now!");
  85
  86   task->simdata->using--;
  87   if(task->simdata->using>0) return MSG_OK;
  88
  89   if(task->name) xbt_free(task->name);
  90
  91   xbt_dynar_free(&(task->simdata->sleeping));
  92
  93   action = task->simdata->compute;
  94   if(action) action->resource_type->common_public->action_free(action);
  95   action = task->simdata->comm;
  96   if(action) action->resource_type->common_public->action_free(action);
  97
  98
  99   xbt_free(task->simdata);
 100   xbt_free(task);
 101
 102   return MSG_OK;
 103 }
 104
 105 /* static MSG_error_t __MSG_task_check(m_task_t task) */
 106 /* { */
 107 /*   simdata_task_t simdata = NULL; */
 108 /*   int warning = 0; */
 109
 110 /*   if (task == NULL) {                /\* Fatal *\/ */
 111 /*     WARNING("Task uninitialized"); */
 112 /*     return MSG_FATAL; */
 113 /*   } */
 114 /*   simdata = task->simdata; */
 115
 116 /*   if (simdata == NULL) {     /\* Fatal *\/ */
 117 /*     WARNING("Simulator Data uninitialized"); */
 118 /*     return MSG_FATAL; */
 119 /*   } */
 120
 121 /*   if (simdata->compute == NULL) {    /\* Fatal if execute ... *\/ */
 122 /*     WARNING("No duration set for this task"); */
 123 /*     warning++; */
 124 /*   } */
 125
 126 /*   if (simdata->message_size == 0) {  /\* Fatal if transfered ... *\/ */
 127 /*     WARNING("No message_size set for this task"); */
 128 /*     warning++; */
 129 /*   } */
 130
 131 /* /\*    if (task->data == NULL) { *\/ */
 132 /* /\*      WARNING("User Data uninitialized"); *\/ */
 133 /* /\*      warning++; *\/ */
 134 /* /\*    } *\/ */
 135
 136 /*   if (warning) */
 137 /*     return MSG_WARNING; */
 138 /*   return MSG_OK; */
 139 /* } */
 140
 141 /* static m_task_t __MSG_task_copy(m_task_t src) */
 142 /* { */
 143 /*   m_task_t copy = NULL; */
 144 /*   simdata_task_t simdata = NULL; */
 145
 146 /*   __MSG_task_check(src); */
 147
 148 /*   simdata = src->simdata; */
 149 /*   copy = MSG_task_create(src->name, SG_getTaskCost(simdata->compute), */
 150 /*                       simdata->message_size, MSG_task_get_data(src)); */
 151
 152 /*   return (copy); */
 153 /* } */
 154
 155 MSG_error_t __MSG_task_wait_event(m_process_t process, m_task_t task)
 156 {
 157   xbt_assert0(((task != NULL)
 158                && (task->simdata != NULL)), "Invalid parameters");
 159
 160   xbt_dynar_push(task->simdata->sleeping, process);
 161   process->simdata->waiting_task = task;
 162   xbt_context_yield(process->simdata->context);
 163   process->simdata->waiting_task = NULL;
 164
 165   return MSG_OK;
 166 }