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 /**
  18  * \brief Move a process to the list of process to destroy. *
  19  */
  20 void SIMIX_process_cleanup(void *arg)
  21 {
  22   xbt_swag_remove(arg, simix_global->process_to_run);
  23   xbt_swag_remove(arg, simix_global->process_list);
  24   xbt_swag_remove(arg, ((smx_process_t)arg)->smx_host->process_list);
  25   xbt_swag_insert(arg, simix_global->process_to_destroy);
  26 }
  27
  28 /**
  29  * Garbage collection
  30  *
  31  * Should be called some time to time to free the memory allocated for processes
  32  * that have finished (or killed).
  33  */
  34 void SIMIX_process_empty_trash(void)
  35 {
  36   smx_process_t process = NULL;
  37
  38   while ((process = xbt_swag_extract(simix_global->process_to_destroy))){
  39     SIMIX_context_free(process->context);
  40     free(process->name);
  41     process->name = NULL;
  42     free(process);
  43   }
  44 }
  45
  46 /**
  47  * \brief Creates and runs the maestro process
  48  */
  49 void __SIMIX_create_maestro_process()
  50 {
  51   smx_process_t process = NULL;
  52   process = xbt_new0(s_smx_process_t, 1);
  53
  54   /* Process data */
  55   process->name = (char *)"";
  56
  57   /* Create the right context type */
  58   process->context = SIMIX_context_create_maestro();
  59
  60   /* Set it as the maestro process */
  61   simix_global->maestro_process = process;
  62   simix_global->current_process = process;
  63
  64   return;
  65 }
  66
  67 /**
  68  * \brief Creates and runs a new #smx_process_t.
  69  *
  70  * 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.
  71  *
  72  * \param name a name for the object. It is for user-level information and can be NULL.
  73  * \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.
  74  * \param host the location where the new agent is executed.
  75  * \param argc first argument passed to \a code
  76  * \param argv second argument passed to \a code
  77  * \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.
  78  * \see smx_process_t
  79  * \return The new corresponding object.
  80  */
  81 smx_process_t SIMIX_process_create(const char *name,
  82                                    xbt_main_func_t code, void *data,
  83                                    const char *hostname, int argc,
  84                                    char **argv, xbt_dict_t properties)
  85 {
  86   smx_process_t process = NULL;
  87   smx_host_t host = SIMIX_host_get_by_name(hostname);
  88
  89   DEBUG2("Start process %s on host %s", name, hostname);
  90
  91   if (!SIMIX_host_get_state(host)) {
  92     WARN2("Cannot launch process '%s' on failed host '%s'", name, hostname);
  93     return NULL;
  94   }
  95   process = xbt_new0(s_smx_process_t, 1);
  96
  97   xbt_assert0(((code != NULL) && (host != NULL)), "Invalid parameters");
  98
  99   /* Process data */
 100   process->name = xbt_strdup(name);
 101   process->smx_host = host;
 102   process->mutex = NULL;
 103   process->cond = NULL;
 104   process->iwannadie = 0;
 105
 106   VERB1("Create context %s", process->name);
 107   process->context = SIMIX_context_new(code, argc, argv,
 108                                        simix_global->cleanup_process_function,
 109                                        process);
 110
 111   process->data = data;
 112
 113   /* Add properties */
 114   process->properties = properties;
 115
 116   /* Add the process to it's host process list */
 117   xbt_swag_insert(process, host->process_list);
 118
 119   DEBUG1("Start context '%s'", process->name);
 120   SIMIX_context_start(process->context);
 121
 122   /* Now insert it in the global process list and in the process to run list */
 123   xbt_swag_insert(process, simix_global->process_list);
 124   DEBUG2("Inserting %s(%s) in the to_run list", process->name, host->name);
 125   xbt_swag_insert(process, simix_global->process_to_run);
 126
 127   return process;
 128 }
 129
 130 /**
 131  * \brief Creates and runs a new #smx_process_t hosting a JAVA thread
 132  *
 133  * Warning: this should only be used in libsimgrid4java, since it create
 134  * a context with no code, which leads to segfaults in plain libsimgrid
 135  */
 136 void SIMIX_jprocess_create(const char *name, smx_host_t host,
 137                            void *data,
 138                            void *jprocess, void *jenv, smx_process_t * res)
 139 {
 140   smx_process_t process = xbt_new0(s_smx_process_t, 1);
 141   smx_process_t self = NULL;
 142
 143   /* HACK: We need this trick because when we xbt_context_new() do
 144      syncronization stuff, the s_process field in the m_process needs
 145      to have a valid value, and we call xbt_context_new() before
 146      returning, of course, ie, before providing a right value to the
 147      caller (Java_simgrid_msg_Msg_processCreate) have time to store it
 148      in place. This way, we initialize the m_process->simdata->s_process
 149      field ourself ASAP.
 150
 151      All this would be much simpler if the synchronization stuff would be done
 152      in the JAVA world, I think.
 153    */
 154   *res = process;
 155
 156   DEBUG5("jprocess_create(name=%s,host=%p,data=%p,jproc=%p,jenv=%p)",
 157          name, host, data, jprocess, jenv);
 158   xbt_assert0(host, "Invalid parameters");
 159
 160   /* Process data */
 161   process->name = xbt_strdup(name);
 162   process->smx_host = host;
 163   process->mutex = NULL;
 164   process->cond = NULL;
 165   SIMIX_context_new(jprocess, 0, NULL, NULL, NULL);
 166   process->data = data;
 167
 168   /* Add the process to it's host process list */
 169   xbt_swag_insert(&process, host->process_list);
 170
 171   /* fix current_process, about which xbt_context_start mocks around */
 172   self = simix_global->current_process;
 173   SIMIX_context_start(process->context);
 174   simix_global->current_process = self;
 175
 176   /* Now insert it in the global process list and in the process to run list */
 177   xbt_swag_insert(process, simix_global->process_list);
 178   DEBUG2("Inserting %s(%s) in the to_run list", process->name, host->name);
 179   xbt_swag_insert(process, simix_global->process_to_run);
 180 }
 181
 182 /** \brief Kill a SIMIX process
 183  *
 184  * This function simply kills a \a process... scarry isn't it ? :).
 185  * \param process poor victim
 186  *
 187  */
 188 void SIMIX_process_kill(smx_process_t process)
 189 {
 190   DEBUG2("Killing process %s on %s", process->name, process->smx_host->name);
 191
 192   /* Cleanup if we were waiting for something */
 193   if (process->mutex)
 194     xbt_swag_remove(process, process->mutex->sleeping);
 195
 196   if (process->cond)
 197     xbt_swag_remove(process, process->cond->sleeping);
 198
 199   DEBUG2("%p here! killing %p", simix_global->current_process, process);
 200
 201   process->iwannadie = 1;
 202
 203   /* If I'm killing myself then stop otherwise schedule the process to kill */
 204   if (process == SIMIX_process_self())
 205     SIMIX_context_stop(process->context);
 206   else
 207     __SIMIX_process_schedule(process);
 208
 209 }
 210
 211 /**
 212  * \brief Return the user data of a #smx_process_t.
 213  *
 214  * 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.
 215  * \param process SIMIX process
 216  * \return A void pointer to the user data
 217  */
 218 void *SIMIX_process_get_data(smx_process_t process)
 219 {
 220   xbt_assert0((process != NULL), "Invalid parameters");
 221   return (process->data);
 222 }
 223
 224 /**
 225  * \brief Set the user data of a #m_process_t.
 226  *
 227  * 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.
 228  * \param process SIMIX process
 229  * \param data User data
 230  */
 231 void SIMIX_process_set_data(smx_process_t process, void *data)
 232 {
 233   xbt_assert0((process != NULL), "Invalid parameters");
 234
 235   process->data = data;
 236   return;
 237 }
 238
 239 /**
 240  * \brief Return the location on which an agent is running.
 241  *
 242  * 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.
 243  * \param process SIMIX process
 244  * \return SIMIX host
 245  */
 246 smx_host_t SIMIX_process_get_host(smx_process_t process)
 247 {
 248   xbt_assert0((process != NULL), "Invalid parameters");
 249   return (process->smx_host);
 250 }
 251
 252 /**
 253  * \brief Return the name of an agent.
 254  *
 255  * This functions checks whether \a process is a valid pointer or not and return its name.
 256  * \param process SIMIX process
 257  * \return The process name
 258  */
 259 const char *SIMIX_process_get_name(smx_process_t process)
 260 {
 261   xbt_assert0((process != NULL), "Invalid parameters");
 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), "Invalid parameters");
 275   process->name = name;
 276 }
 277
 278 /** \ingroup m_process_management
 279  * \brief Return the properties
 280  *
 281  * This functions returns the properties associated with this process
 282  */
 283 xbt_dict_t SIMIX_process_get_properties(smx_process_t process)
 284 {
 285   return process->properties;
 286 }
 287
 288 /**
 289  * \brief Return the current agent.
 290  *
 291  * This functions returns the currently running #smx_process_t.
 292  * \return The SIMIX process
 293  */
 294 smx_process_t SIMIX_process_self(void)
 295 {
 296   return simix_global ? simix_global->current_process : NULL;
 297 }
 298
 299 /**
 300  * \brief Suspend the process.
 301  *
 302  * This functions suspend the process by suspending the action on
 303  * which it was waiting for the completion.
 304  *
 305  * \param process SIMIX process
 306  */
 307 void SIMIX_process_suspend(smx_process_t process)
 308 {
 309   xbt_assert0(process, "Invalid parameters");
 310
 311   if (process != SIMIX_process_self()) {
 312
 313     if (process->mutex) {
 314       /* process blocked on a mutex, only set suspend=1 */
 315       process->suspended = 1;
 316     } else if (process->cond) {
 317       /* process blocked cond, suspend all actions */
 318
 319       /* temporaries variables */
 320       smx_cond_t c;
 321       xbt_fifo_item_t i;
 322       smx_action_t act;
 323
 324       process->suspended = 1;
 325       c = process->cond;
 326       xbt_fifo_foreach(c->actions, i, act, smx_action_t) {
 327          surf_workstation_model->suspend(act->surf_action);
 328       }
 329     } else {
 330       process->suspended = 1;
 331     }
 332   } else {
 333     /* process executing, I can create an action and suspend it */
 334     smx_action_t dummy;
 335     smx_cond_t cond;
 336     char name[] = "dummy";
 337     process->suspended = 1;
 338
 339     cond = SIMIX_cond_init();
 340     dummy = SIMIX_action_execute(SIMIX_process_get_host(process), name, 0);
 341     surf_workstation_model->suspend(dummy->surf_action);
 342     SIMIX_register_action_to_condition(dummy, cond);
 343     __SIMIX_cond_wait(cond);
 344     SIMIX_unregister_action_to_condition(dummy, cond);
 345     SIMIX_action_destroy(dummy);
 346     SIMIX_cond_destroy(cond);
 347   }
 348   return;
 349 }
 350
 351 /**
 352  * \brief Resume a suspended process.
 353  *
 354  * This functions resume a suspended process by resuming the task on which it was waiting for the completion.
 355  * \param process SIMIX process
 356  */
 357 void SIMIX_process_resume(smx_process_t process)
 358 {
 359   xbt_assert0((process != NULL), "Invalid parameters");
 360   SIMIX_CHECK_HOST();
 361
 362   if (process == SIMIX_process_self())
 363     return;
 364
 365   if (process->mutex) {
 366     DEBUG0("Resume process blocked on a mutex");
 367     process->suspended = 0;     /* It'll wake up by itself when mutex releases */
 368     return;
 369   } else if (process->cond) {
 370     /* temporaries variables */
 371     smx_cond_t c;
 372     xbt_fifo_item_t i;
 373     smx_action_t act;
 374     DEBUG0("Resume process blocked on a conditional");
 375     process->suspended = 0;
 376     c = process->cond;
 377     xbt_fifo_foreach(c->actions, i, act, smx_action_t) {
 378       surf_workstation_model->resume(act->surf_action);
 379     }
 380     SIMIX_cond_signal(c);
 381     return;
 382   } else {
 383     process->suspended = 0;
 384     xbt_swag_insert(process, simix_global->process_to_run);
 385   }
 386 }
 387
 388 /**
 389  * \brief Migrates an agent to another location.
 390  *
 391  * This function changes the value of the host on which \a process is running.
 392  */
 393 void SIMIX_process_change_host(smx_process_t process, char *source, char *dest)
 394 {
 395   xbt_assert0((process != NULL), "Invalid parameters");
 396   smx_host_t h1 = SIMIX_host_get_by_name(source);
 397   smx_host_t h2 = SIMIX_host_get_by_name(dest);
 398   process->smx_host = h2;
 399   xbt_swag_remove(process, h1->process_list);
 400   xbt_swag_insert(process, h2->process_list);
 401 }
 402
 403 /**
 404  * \brief Returns true if the process is suspended .
 405  *
 406  * This checks whether a process is suspended or not by inspecting the task on which it was waiting for the completion.
 407  * \param process SIMIX process
 408  * \return 1, if the process is suspended, else 0.
 409  */
 410 int SIMIX_process_is_suspended(smx_process_t process)
 411 {
 412   xbt_assert0((process != NULL), "Invalid parameters");
 413
 414   return (process->suspended);
 415 }
 416
 417 /**
 418  * \brief Returns the amount of SIMIX processes in the system
 419  *
 420  * Maestro internal process is not counted, only user code processes are
 421  */
 422 int SIMIX_process_count()
 423 {
 424   return xbt_swag_size(simix_global->process_list);
 425 }
 426
 427 /**
 428  * Calling this function makes the process process to yield. The process
 429  * that scheduled it returns from __SIMIX_process_schedule as if nothing
 430  * had happened.
 431  *
 432  * Only the processes can call this function, giving back the control
 433  * to the maestro
 434  */
 435 void __SIMIX_process_yield(void)
 436 {
 437   DEBUG1("Yield process '%s'", simix_global->current_process->name);
 438   xbt_assert0((simix_global->current_process != simix_global->maestro_process),
 439               "You are not supposed to run this function here!");
 440
 441   SIMIX_context_suspend(simix_global->current_process->context);
 442
 443   if (simix_global->current_process->iwannadie)
 444     SIMIX_context_stop(simix_global->current_process->context);
 445 }
 446
 447 void __SIMIX_process_schedule(smx_process_t new_process)
 448 {
 449   DEBUG1("Scheduling context: '%s'", new_process->name);
 450
 451   /* save the current process */
 452   smx_process_t old_process = simix_global->current_process;
 453
 454   /* update the current process */
 455   simix_global->current_process = new_process;
 456
 457   /* schedule the context */
 458   SIMIX_context_resume(old_process->context, new_process->context);
 459
 460   /* restore the current process to the previously saved process */
 461   simix_global->current_process = old_process;
 462 }