src/simix/smx_process.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/log.h"
  11 #include "xbt/dict.h"
  12 #include "msg/mailbox.h"
  13
  14 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_process, simix,
  15                                 "Logging specific to SIMIX (process)");
  16
  17 /******************************** Process ************************************/
  18 /**
  19  * \brief Creates and runs a new #smx_process_t.
  20  *
  21  * Does exactly the same as #SIMIX_process_create_with_arguments but without
  22    providing standard arguments (\a argc, \a argv).
  23  * \see SIMIX_process_create_with_arguments
  24  */
  25
  26
  27 void SIMIX_process_cleanup(void *arg)
  28 {
  29   xbt_swag_remove(arg, simix_global->process_list);
  30   xbt_swag_remove(arg, simix_global->process_to_run);
  31   xbt_swag_remove(arg,
  32                   ((smx_process_t) arg)->simdata->smx_host->simdata->
  33                   process_list);
  34   free(((smx_process_t) arg)->name);
  35   ((smx_process_t) arg)->name = NULL;
  36
  37   free(((smx_process_t) arg)->simdata);
  38   ((smx_process_t) arg)->simdata = NULL;
  39   free(arg);
  40 }
  41
  42 /**
  43  * \brief Creates and runs a new #smx_process_t.
  44  *
  45  * A constructor for #m_process_t taking four arguments and returning the corresponding object. The structure (and the corresponding thread) is created, and put in the list of ready process.
  46  *
  47  * \param name a name for the object. It is for user-level information and can be NULL.
  48 * \param data a pointer to any data one may want to attach to the new object.  It is for user-level information and can be NULL. It can be retrieved with the function \ref MSG_process_get_data.
  49  * \param host the location where the new agent is executed.
  50  * \param argc first argument passed to \a code
  51  * \param argv second argument passed to \a code
  52  * \param clean_process_function The cleanup function of user process. It will be called when the process finish. This function have to call the SIMIX_process_cleanup.
  53  * \see smx_process_t
  54  * \return The new corresponding object.
  55  */
  56 smx_process_t SIMIX_process_create(const char *name,
  57                                    xbt_main_func_t code, void *data,
  58                                    const char *hostname, int argc,
  59                                    char **argv, xbt_dict_t properties)
  60 {
  61   smx_simdata_process_t simdata = xbt_new0(s_smx_simdata_process_t, 1);
  62   smx_process_t process = xbt_new0(s_smx_process_t, 1);
  63   smx_process_t self = NULL;
  64   smx_host_t host = SIMIX_host_get_by_name(hostname);
  65   /*char alias[MAX_ALIAS_NAME + 1] = {0};
  66   msg_mailbox_t mailbox;*/
  67
  68   xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
  69   /* Simulator Data */
  70
  71   simdata->smx_host = host;
  72   simdata->mutex = NULL;
  73   simdata->cond = NULL;
  74   simdata->argc = argc;
  75   simdata->argv = argv;
  76   simdata->context = xbt_context_new(name,code, NULL, NULL,
  77                                      simix_global->
  78                                      cleanup_process_function, process,
  79                                      simdata->argc, simdata->argv);
  80
  81   /* Process structure */
  82   process->name = xbt_strdup(name);
  83   process->simdata = simdata;
  84   process->data = data;
  85
  86   /* Add properties*/
  87   simdata->properties = properties;
  88
  89   xbt_swag_insert(process, host->simdata->process_list);
  90
  91   /* fix current_process, about which xbt_context_start mocks around */
  92   self = simix_global->current_process;
  93   xbt_context_start(process->simdata->context);
  94   simix_global->current_process = self;
  95
  96   xbt_swag_insert(process, simix_global->process_list);
  97   DEBUG2("Inserting %s(%s) in the to_run list", process->name, host->name);
  98   xbt_swag_insert(process, simix_global->process_to_run);
  99
 100   /*sprintf(alias,"%s:%s",hostname,process->name);
 101
 102         mailbox = MSG_mailbox_new(alias);
 103         MSG_mailbox_set_hostname(mailbox, hostname);*/
 104
 105   return process;
 106 }
 107 /**
 108  * \brief Creates and runs a new #smx_process_t hosting a JAVA thread
 109  *
 110  * Warning: this should only be used in libsimgrid4java, since it create
 111  * a context with no code, which leads to segfaults in plain libsimgrid
 112  */
 113 void SIMIX_jprocess_create(const char *name, smx_host_t host,
 114                            void *data,
 115                            void *jprocess, void *jenv, smx_process_t * res)
 116 {
 117   smx_simdata_process_t simdata = xbt_new0(s_smx_simdata_process_t, 1);
 118   smx_process_t process = xbt_new0(s_smx_process_t, 1);
 119   smx_process_t self = NULL;
 120
 121   /* HACK: We need this trick because when we xbt_context_new() do
 122      syncronization stuff, the s_process field in the m_process needs
 123      to have a valid value, and we call xbt_context_new() before
 124      returning, of course, ie, before providing a right value to the
 125      caller (Java_simgrid_msg_Msg_processCreate) have time to store it
 126      in place. This way, we initialize the m_process->simdata->s_process
 127      field ourself ASAP.
 128
 129      All this would be much simpler if the synchronization stuff would be done
 130      in the JAVA world, I think.
 131    */
 132   *res = process;
 133
 134
 135
 136   DEBUG5("jprocess_create(name=%s,host=%p,data=%p,jproc=%p,jenv=%p)",
 137          name, host, data, jprocess, jenv);
 138   xbt_assert0(host, "Invalid parameters");
 139   /* Simulator Data */
 140   simdata->smx_host = host;
 141   simdata->mutex = NULL;
 142   simdata->cond = NULL;
 143   simdata->argc = 0;
 144   simdata->argv = NULL;
 145
 146
 147   simdata->context = xbt_context_new(name,NULL, NULL, jprocess,
 148                                      simix_global->
 149                                      cleanup_process_function, process,
 150                                      /* argc/argv */ 0, NULL);
 151
 152   /* Process structure */
 153   process->name = xbt_strdup(name);
 154   process->simdata = simdata;
 155   process->data = data;
 156
 157   xbt_swag_insert(process, host->simdata->process_list);
 158
 159   /* fix current_process, about which xbt_context_start mocks around */
 160   self = simix_global->current_process;
 161
 162   xbt_context_start(process->simdata->context);
 163
 164   simix_global->current_process = self;
 165
 166   xbt_swag_insert(process, simix_global->process_list);
 167   DEBUG2("Inserting %s(%s) in the to_run list", process->name, host->name);
 168   xbt_swag_insert(process, simix_global->process_to_run);
 169
 170 }
 171
 172
 173 /** \brief Kill a SIMIX process
 174  *
 175  * This function simply kills a \a process... scarry isn't it ? :).
 176  * \param process poor victim
 177  *
 178  */
 179 void SIMIX_process_kill(smx_process_t process)
 180 {
 181   smx_simdata_process_t p_simdata = process->simdata;
 182
 183   DEBUG2("Killing process %s on %s", process->name,
 184          p_simdata->smx_host->name);
 185
 186   /* Cleanup if we were waiting for something */
 187   if (p_simdata->mutex)
 188     xbt_swag_remove(process, p_simdata->mutex->sleeping);
 189
 190   if (p_simdata->cond)
 191     xbt_swag_remove(process, p_simdata->cond->sleeping);
 192
 193   xbt_swag_remove(process, simix_global->process_to_run);
 194   xbt_swag_remove(process, simix_global->process_list);
 195   DEBUG2("%p here! killing %p", simix_global->current_process, process);
 196   xbt_context_kill(process->simdata->context);
 197
 198   if (process == SIMIX_process_self()) {
 199     /* I just killed myself */
 200     xbt_context_yield();
 201   }
 202 }
 203
 204 /**
 205  * \brief Return the user data of a #smx_process_t.
 206  *
 207  * This functions checks whether \a process is a valid pointer or not and return the user data associated to \a process if it is possible.
 208  * \param process SIMIX process
 209  * \return A void pointer to the user data
 210  */
 211 void *SIMIX_process_get_data(smx_process_t process)
 212 {
 213   xbt_assert0((process != NULL), "Invalid parameters");
 214
 215   return (process->data);
 216 }
 217
 218 /**
 219  * \brief Set the user data of a #m_process_t.
 220  *
 221  * This functions checks whether \a process is a valid pointer or not and set the user data associated to \a process if it is possible.
 222  * \param process SIMIX process
 223  * \param data User data
 224  */
 225 void SIMIX_process_set_data(smx_process_t process, void *data)
 226 {
 227   xbt_assert0((process != NULL), "Invalid parameters");
 228   //xbt_assert0((process->data == NULL), "Data already set");
 229
 230   process->data = data;
 231
 232   return;
 233 }
 234
 235 /**
 236  * \brief Return the location on which an agent is running.
 237  *
 238  * This functions checks whether \a process is a valid pointer or not and return the m_host_t corresponding to the location on which \a process is running.
 239  * \param process SIMIX process
 240  * \return SIMIX host
 241  */
 242 smx_host_t SIMIX_process_get_host(smx_process_t process)
 243 {
 244   xbt_assert0(((process != NULL)
 245                && (process->simdata)), "Invalid parameters");
 246
 247   return (process->simdata->smx_host);
 248 }
 249
 250 /**
 251  * \brief Return the name of an agent.
 252  *
 253  * This functions checks whether \a process is a valid pointer or not and return its name.
 254  * \param process SIMIX process
 255  * \return The process name
 256  */
 257 const char *SIMIX_process_get_name(smx_process_t process)
 258 {
 259   xbt_assert0(((process != NULL)
 260                && (process->simdata)), "Invalid parameters");
 261
 262   return (process->name);
 263 }
 264
 265 /**
 266  * \brief Changes the name of an agent.
 267  *
 268  * This functions checks whether \a process is a valid pointer or not and return its name.
 269  * \param process SIMIX process
 270  * \param name The new process name
 271  */
 272 void SIMIX_process_set_name(smx_process_t process, char *name)
 273 {
 274   xbt_assert0(((process != NULL)
 275                && (process->simdata)), "Invalid parameters");
 276
 277   process->name = name;
 278 }
 279
 280 /** \ingroup m_process_management
 281  * \brief Return the properties
 282  *
 283  * This functions returns the properties associated with this process
 284  */
 285 xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
 286 {
 287   return process->simdata->properties;
 288 }
 289
 290 /**
 291  * \brief Return the current agent.
 292  *
 293  * This functions returns the currently running #smx_process_t.
 294  * \return The SIMIX process
 295  */
 296 smx_process_t SIMIX_process_self(void)
 297 {
 298   return simix_global ? simix_global->current_process : NULL;
 299 }
 300
 301 /**
 302  * \brief Suspend the process.
 303  *
 304  * This functions suspend the process by suspending the action on
 305  * which it was waiting for the completion.
 306  *
 307  * \param process SIMIX process
 308  */
 309 void SIMIX_process_suspend(smx_process_t process)
 310 {
 311   smx_simdata_process_t simdata = NULL;
 312
 313   xbt_assert0(((process) && (process->simdata)), "Invalid parameters");
 314
 315   if (process != SIMIX_process_self()) {
 316     simdata = process->simdata;
 317
 318     if (simdata->mutex) {
 319       /* process blocked on a mutex, only set suspend=1 */
 320       simdata->suspended = 1;
 321     } else if (simdata->cond) {
 322       /* process blocked cond, suspend all actions */
 323
 324       /* temporaries variables */
 325       smx_cond_t c;
 326       xbt_fifo_item_t i;
 327       smx_action_t act;
 328
 329       simdata->suspended = 1;
 330       c = simdata->cond;
 331       xbt_fifo_foreach(c->actions, i, act, smx_action_t) {
 332         surf_workstation_model->common_public->suspend(act->simdata->
 333                                                           surf_action);
 334       }
 335     } else {
 336       simdata->suspended = 1;
 337     }
 338   } else {
 339     /* process executing, I can create an action and suspend it */
 340     smx_action_t dummy;
 341     smx_cond_t cond;
 342     char name[] = "dummy";
 343     process->simdata->suspended = 1;
 344
 345     cond = SIMIX_cond_init();
 346     dummy = SIMIX_action_execute(SIMIX_process_get_host(process), name, 0);
 347     surf_workstation_model->common_public->suspend(dummy->simdata->surf_action);
 348     SIMIX_register_action_to_condition(dummy, cond);
 349     __SIMIX_cond_wait(cond);
 350     SIMIX_unregister_action_to_condition(dummy, cond);
 351     SIMIX_action_destroy(dummy);
 352     SIMIX_cond_destroy(cond);
 353   }
 354   return;
 355 }
 356
 357 /**
 358  * \brief Resume a suspended process.
 359  *
 360  * This functions resume a suspended process by resuming the task on which it was waiting for the completion.
 361  * \param process SIMIX process
 362  */
 363 void SIMIX_process_resume(smx_process_t process)
 364 {
 365   smx_simdata_process_t simdata = NULL;
 366
 367   xbt_assert0(((process != NULL)
 368                && (process->simdata)), "Invalid parameters");
 369   SIMIX_CHECK_HOST();
 370
 371   if (process == SIMIX_process_self()) {
 372     return;
 373   }
 374
 375   simdata = process->simdata;
 376   if (simdata->mutex) {
 377     DEBUG0("Resume process blocked on a mutex");
 378     simdata->suspended = 0;     /* He'll wake up by itself */
 379     return;
 380   } else if (simdata->cond) {
 381     /* temporaries variables */
 382     smx_cond_t c;
 383     xbt_fifo_item_t i;
 384     smx_action_t act;
 385         DEBUG0("Resume process blocked on a conditional");
 386     simdata->suspended = 0;
 387     c = simdata->cond;
 388     xbt_fifo_foreach(c->actions, i, act, smx_action_t) {
 389       surf_workstation_model->common_public->resume(act->simdata->surf_action);
 390     }
 391     SIMIX_cond_signal(c);
 392     return;
 393   } else {
 394     simdata->suspended = 0;
 395     xbt_swag_insert(process, simix_global->process_to_run);
 396   }
 397
 398 }
 399
 400 /**
 401  * \brief Migrates an agent to another location.
 402  *
 403  * This function changes the value of the host on which \a process is running.
 404  */
 405 void SIMIX_process_change_host(smx_process_t process, char *source, char *dest)
 406 {
 407   smx_simdata_process_t p_simdata = process->simdata;
 408   smx_host_t h1 = SIMIX_host_get_by_name(source);
 409   smx_host_t h2 = SIMIX_host_get_by_name(dest);
 410   p_simdata->smx_host =  h2;
 411   xbt_swag_remove(process, h1->simdata->process_list);
 412   xbt_swag_insert(process, h2->simdata->process_list);
 413 }
 414
 415 /**
 416  * \brief Returns true if the process is suspended .
 417  *
 418  * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
 419  * \param process SIMIX process
 420  * \return 1, if the process is suspended, else 0.
 421  */
 422 int SIMIX_process_is_suspended(smx_process_t process)
 423 {
 424   xbt_assert0(((process != NULL)
 425                && (process->simdata)), "Invalid parameters");
 426
 427   return (process->simdata->suspended);
 428 }
 429
 430