Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
model-checker : init list of irrelevant differences in simix instead of msg
[simgrid.git] / src / simix / smx_context_raw.c
1 /* context_raw - fast context switching inspired from System V ucontextes   */
2
3 /* Copyright (c) 2009, 2010. The SimGrid Team.
4  * All rights reserved.                                                     */
5
6 /* This program is free software; you can redistribute it and/or modify it
7  * under the terms of the license (GNU LGPL) which comes with this package. */
8
9 #include "smx_private.h"
10 #include "xbt/parmap.h"
11 #include "mc/mc.h"
12
13 #ifdef HAVE_VALGRIND_VALGRIND_H
14 #  include <valgrind/valgrind.h>
15 #endif                          /* HAVE_VALGRIND_VALGRIND_H */
16
17 typedef char * raw_stack_t;
18 typedef void (*rawctx_entry_point_t)(void *);
19
20 typedef struct s_smx_ctx_raw {
21   s_smx_ctx_base_t super;         /* Fields of super implementation */
22   char *malloced_stack;           /* malloced area containing the stack */
23   raw_stack_t stack_top;          /* pointer to stack top (within previous area) */
24 #ifdef HAVE_VALGRIND_VALGRIND_H
25   unsigned int valgrind_stack_id; /* the valgrind stack id */
26 #endif
27 #ifdef TIME_BENCH_PER_SR
28   unsigned int thread;            /* Just for measuring purposes */
29 #endif
30 } s_smx_ctx_raw_t, *smx_ctx_raw_t;
31
32 #ifdef CONTEXT_THREADS
33 static xbt_parmap_t raw_parmap;
34 static raw_stack_t* raw_workers_stacks;       /* space to save the worker stack in each thread */
35 static unsigned long raw_threads_working;     /* number of threads that have started their work */
36 static xbt_os_thread_key_t raw_worker_id_key; /* thread-specific storage for the thread id */
37 #endif
38
39 static unsigned long raw_process_index = 0;   /* index of the next process to run in the
40                                                * list of runnable processes */
41 static smx_ctx_raw_t raw_maestro_context;
42
43 extern raw_stack_t raw_makecontext(char* malloced_stack, int stack_size,
44                                    rawctx_entry_point_t entry_point, void* arg);
45 extern void raw_swapcontext(raw_stack_t* old, raw_stack_t new);
46
47 #ifdef PROCESSOR_i686
48 __asm__ (
49 #if defined(APPLE) || defined(_WIN32)
50    ".text\n"
51    ".globl _raw_makecontext\n"
52    "_raw_makecontext:\n"
53 #else
54    ".text\n"
55    ".globl raw_makecontext\n"
56    ".type raw_makecontext,@function\n"
57    "raw_makecontext:\n"
58 #endif
59    "   movl 4(%esp),%eax\n"   /* stack */
60    "   addl 8(%esp),%eax\n"   /* size  */
61    "   movl 12(%esp),%ecx\n"  /* func  */
62    "   movl 16(%esp),%edx\n"  /* arg   */
63    "   movl %edx, -4(%eax)\n"
64    "   movl $0,   -8(%eax)\n" /* @return for func */
65    "   movl %ecx,-12(%eax)\n"
66    "   movl $0,  -16(%eax)\n" /* ebp */
67    "   movl $0,  -20(%eax)\n" /* ebx */
68    "   movl $0,  -24(%eax)\n" /* esi */
69    "   movl $0,  -28(%eax)\n" /* edi */
70    "   subl $28,%eax\n"
71    "   retl\n"
72 );
73
74 __asm__ (
75 #if defined(APPLE) || defined(_WIN32)
76    ".text\n"
77    ".globl _raw_swapcontext\n"
78    "_raw_swapcontext:\n"
79 #else
80    ".text\n"
81    ".globl raw_swapcontext\n"
82    ".type raw_swapcontext,@function\n"
83    "raw_swapcontext:\n"
84 #endif
85    "   movl 4(%esp),%eax\n" /* old */
86    "   movl 8(%esp),%edx\n" /* new */
87    "   pushl %ebp\n"
88    "   pushl %ebx\n"
89    "   pushl %esi\n"
90    "   pushl %edi\n"
91    "   movl %esp,(%eax)\n"
92    "   movl %edx,%esp\n"
93    "   popl %edi\n"
94    "   popl %esi\n"
95    "   popl %ebx\n"
96    "   popl %ebp\n"
97    "   retl\n"
98 );
99 #elif PROCESSOR_x86_64
100 __asm__ (
101 #if defined(APPLE)
102    ".text\n"
103    ".globl _raw_makecontext\n"
104    "_raw_makecontext:\n"
105 #elif defined(_WIN32)
106    ".text\n"
107    ".globl raw_makecontext\n"
108    "raw_makecontext:\n"
109 #else
110    ".text\n"
111    ".globl raw_makecontext\n"
112    ".type raw_makecontext,@function\n"
113    "raw_makecontext:\n"/* Calling convention sets the arguments in rdi, rsi, rdx and rcx, respectively */
114 #endif
115    "   movq %rdi,%rax\n"      /* stack */
116    "   addq %rsi,%rax\n"      /* size  */
117    "   movq $0,   -8(%rax)\n" /* @return for func */
118    "   movq %rdx,-16(%rax)\n" /* func */
119    "   movq %rcx,-24(%rax)\n" /* arg/rdi */
120    "   movq $0,  -32(%rax)\n" /* rsi */
121    "   movq $0,  -40(%rax)\n" /* rdx */
122    "   movq $0,  -48(%rax)\n" /* rcx */
123    "   movq $0,  -56(%rax)\n" /* r8  */
124    "   movq $0,  -64(%rax)\n" /* r9  */
125    "   movq $0,  -72(%rax)\n" /* rbp */
126    "   movq $0,  -80(%rax)\n" /* rbx */
127    "   movq $0,  -88(%rax)\n" /* r12 */
128    "   movq $0,  -96(%rax)\n" /* r13 */
129    "   movq $0, -104(%rax)\n" /* r14 */
130    "   movq $0, -112(%rax)\n" /* r15 */
131    "   subq $112,%rax\n"
132    "   retq\n"
133 );
134
135 __asm__ (
136 #if defined(APPLE)
137    ".text\n"
138    ".globl _raw_swapcontext\n"
139    "_raw_swapcontext:\n"
140 #elif defined(_WIN32)
141    ".text\n"
142    ".globl raw_swapcontext\n"
143    "raw_swapcontext:\n"
144 #else
145    ".text\n"
146    ".globl raw_swapcontext\n"
147    ".type raw_swapcontext,@function\n"
148    "raw_swapcontext:\n" /* Calling convention sets the arguments in rdi and rsi, respectively */
149 #endif
150    "   pushq %rdi\n"
151    "   pushq %rsi\n"
152    "   pushq %rdx\n"
153    "   pushq %rcx\n"
154    "   pushq %r8\n"
155    "   pushq %r9\n"
156    "   pushq %rbp\n"
157    "   pushq %rbx\n"
158    "   pushq %r12\n"
159    "   pushq %r13\n"
160    "   pushq %r14\n"
161    "   pushq %r15\n"
162    "   movq %rsp,(%rdi)\n" /* old */
163    "   movq %rsi,%rsp\n" /* new */
164    "   popq %r15\n"
165    "   popq %r14\n"
166    "   popq %r13\n"
167    "   popq %r12\n"
168    "   popq %rbx\n"
169    "   popq %rbp\n"
170    "   popq %r9\n"
171    "   popq %r8\n"
172    "   popq %rcx\n"
173    "   popq %rdx\n"
174    "   popq %rsi\n"
175    "   popq %rdi\n"
176    "   retq\n"
177 );
178 #else
179
180 /* If you implement raw contexts for other processors, don't forget to
181    update the definition of HAVE_RAWCTX in buildtools/Cmake/CompleteInFiles.cmake */
182
183 raw_stack_t raw_makecontext(char* malloced_stack, int stack_size,
184                             rawctx_entry_point_t entry_point, void* arg) {
185    THROW_UNIMPLEMENTED;
186 }
187
188 void raw_swapcontext(raw_stack_t* old, raw_stack_t new) {
189    THROW_UNIMPLEMENTED;
190 }
191
192 #endif
193
194 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
195
196 #ifdef TIME_BENCH_PER_SR
197 #include "xbt/xbt_os_time.h"
198 #define NUM_THREADS 4
199 static xbt_os_timer_t timer;
200 static double time_thread_sr[NUM_THREADS];
201 static double time_thread_ssr[NUM_THREADS];
202 static double time_wasted_sr = 0;
203 static double time_wasted_ssr = 0;
204 static unsigned int sr_count = 0;
205 static unsigned int ssr_count = 0;
206 static char new_sr = 0;
207 #endif
208
209 static void smx_ctx_raw_wrapper(smx_ctx_raw_t context);
210 static int smx_ctx_raw_factory_finalize(smx_context_factory_t *factory);
211 static smx_context_t smx_ctx_raw_create_context(xbt_main_func_t code, int argc,
212     char **argv, void_pfn_smxprocess_t cleanup_func, void *data);
213 static void smx_ctx_raw_free(smx_context_t context);
214 static void smx_ctx_raw_wrapper(smx_ctx_raw_t context);
215 static void smx_ctx_raw_stop(smx_context_t context);
216 static void smx_ctx_raw_suspend_serial(smx_context_t context);
217 static void smx_ctx_raw_resume_serial(smx_process_t first_process);
218 static void smx_ctx_raw_runall_serial(void);
219 static void smx_ctx_raw_suspend_parallel(smx_context_t context);
220 static void smx_ctx_raw_resume_parallel(smx_process_t first_process);
221 static void smx_ctx_raw_runall_parallel(void);
222 static void smx_ctx_raw_runall(void);
223
224 /**
225  * \brief Initializes the raw context factory.
226  * \param factory where to initialize the factory
227  */
228 void SIMIX_ctx_raw_factory_init(smx_context_factory_t *factory)
229 {
230
231   if(MC_IS_ENABLED && mmalloc_ignore == NULL){
232     /* Create list of elements to ignore for heap comparison algorithm */
233     MC_ignore_init();
234   }
235
236   XBT_VERB("Using raw contexts. Because the glibc is just not good enough for us.");
237   smx_ctx_base_factory_init(factory);
238
239   (*factory)->finalize  = smx_ctx_raw_factory_finalize;
240   (*factory)->create_context = smx_ctx_raw_create_context;
241   /* Do not overload that method (*factory)->finalize */
242   (*factory)->free = smx_ctx_raw_free;
243   (*factory)->stop = smx_ctx_raw_stop;
244   (*factory)->name = "smx_raw_context_factory";
245
246   if (SIMIX_context_is_parallel()) {
247 #ifdef CONTEXT_THREADS
248     int nthreads = SIMIX_context_get_nthreads();
249     raw_parmap = xbt_parmap_new(nthreads, SIMIX_context_get_parallel_mode());
250     raw_workers_stacks = xbt_new(raw_stack_t, nthreads);
251     xbt_os_thread_key_create(&raw_worker_id_key);
252 #endif
253     if (SIMIX_context_get_parallel_threshold() > 1) {
254       /* choose dynamically */
255       (*factory)->runall = smx_ctx_raw_runall;
256       (*factory)->suspend = NULL;
257     }
258     else {
259       /* always parallel */
260       (*factory)->runall = smx_ctx_raw_runall_parallel;
261       (*factory)->suspend = smx_ctx_raw_suspend_parallel;
262     }
263   }
264   else {
265     /* always serial */
266     (*factory)->runall = smx_ctx_raw_runall_serial;
267     (*factory)->suspend = smx_ctx_raw_suspend_serial;
268   }
269 #ifdef TIME_BENCH_PER_SR
270   timer = xbt_os_timer_new();
271 #endif
272 }
273
274 /**
275  * \brief Finalizes the raw context factory.
276  * \param factory the raw context factory
277  */
278 static int smx_ctx_raw_factory_finalize(smx_context_factory_t *factory)
279 {
280 #ifdef TIME_BENCH_PER_SR
281   XBT_CRITICAL("Total wasted time in %u SR: %lf", sr_count, time_wasted_sr);
282   XBT_CRITICAL("Total wasted time in %u SSR: %lf", ssr_count, time_wasted_ssr);
283 #endif
284
285 #ifdef CONTEXT_THREADS
286   if (raw_parmap)
287     xbt_parmap_destroy(raw_parmap);
288   xbt_free(raw_workers_stacks);
289 #endif
290   return smx_ctx_base_factory_finalize(factory);
291 }
292
293 /**
294  * \brief Creates a new raw context.
295  * \param code main function of this context or NULL to create the maestro
296  * context
297  * \param argc argument number
298  * \param argv arguments to pass to the main function
299  * \param cleanup_func a function to call to free the user data when the
300  * context finished
301  * \param data user data
302  */
303 static smx_context_t
304 smx_ctx_raw_create_context(xbt_main_func_t code, int argc, char **argv,
305     void_pfn_smxprocess_t cleanup_func,
306     void *data)
307 {
308
309   smx_ctx_raw_t context =
310       (smx_ctx_raw_t) smx_ctx_base_factory_create_context_sized(
311           sizeof(s_smx_ctx_raw_t),
312           code,
313           argc,
314           argv,
315           cleanup_func,
316           data);
317
318   /* if the user provided a function for the process then use it,
319      otherwise it is the context for maestro */
320      if (code) {
321        context->malloced_stack = xbt_malloc0(smx_context_stack_size);
322        context->stack_top =
323            raw_makecontext(context->malloced_stack, smx_context_stack_size,
324                (void_f_pvoid_t) smx_ctx_raw_wrapper, context);
325
326 #ifdef HAVE_VALGRIND_VALGRIND_H
327        context->valgrind_stack_id =
328            VALGRIND_STACK_REGISTER(context->malloced_stack,
329                context->malloced_stack + smx_context_stack_size);
330 #endif                          /* HAVE_VALGRIND_VALGRIND_H */
331
332      } else {
333        raw_maestro_context = context;
334      }
335
336      return (smx_context_t) context;
337 }
338
339 /**
340  * \brief Destroys a raw context.
341  * \param context a raw context
342  */
343 static void smx_ctx_raw_free(smx_context_t context)
344 {
345   if (context) {
346
347 #ifdef HAVE_VALGRIND_VALGRIND_H
348     VALGRIND_STACK_DEREGISTER(((smx_ctx_raw_t)
349         context)->valgrind_stack_id);
350 #endif                          /* HAVE_VALGRIND_VALGRIND_H */
351
352     free(((smx_ctx_raw_t) context)->malloced_stack);
353   }
354   smx_ctx_base_free(context);
355 }
356
357 /**
358  * \brief Wrapper for the main function of a context.
359  * \param context a raw context
360  */
361 static void smx_ctx_raw_wrapper(smx_ctx_raw_t context)
362 {
363   (context->super.code) (context->super.argc, context->super.argv);
364
365   smx_ctx_raw_stop((smx_context_t) context);
366 }
367
368 /**
369  * \brief Stops a raw context.
370  *
371  * This function is called when the main function of the context if finished.
372  *
373  * \param context the current context
374  */
375 static void smx_ctx_raw_stop(smx_context_t context)
376 {
377   smx_ctx_base_stop(context);
378   simix_global->context_factory->suspend(context);
379 }
380
381 /**
382  * \brief Suspends a running context and resumes another one or returns to
383  * maestro.
384  * \param context the current context
385  */
386 static void smx_ctx_raw_suspend_serial(smx_context_t context)
387 {
388   /* determine the next context */
389   smx_context_t next_context;
390   unsigned long int i = raw_process_index++;
391
392   if (i < xbt_dynar_length(simix_global->process_to_run)) {
393     /* execute the next process */
394     XBT_DEBUG("Run next process");
395     next_context = xbt_dynar_get_as(
396         simix_global->process_to_run, i, smx_process_t)->context;
397   }
398   else {
399     /* all processes were run, return to maestro */
400     XBT_DEBUG("No more process to run");
401     next_context = (smx_context_t) raw_maestro_context;
402   }
403   SIMIX_context_set_current(next_context);
404   raw_swapcontext(&((smx_ctx_raw_t) context)->stack_top,
405       ((smx_ctx_raw_t) next_context)->stack_top);
406 }
407
408 /**
409  * \brief Resumes sequentially all processes ready to run.
410  * \param first_process the first process to resume
411  */
412 static void smx_ctx_raw_resume_serial(smx_process_t first_process)
413 {
414   smx_ctx_raw_t context = (smx_ctx_raw_t) first_process->context;
415   SIMIX_context_set_current((smx_context_t) context);
416   raw_swapcontext(&raw_maestro_context->stack_top,
417       ((smx_ctx_raw_t) context)->stack_top);
418 }
419
420 #ifdef TIME_BENCH_PER_SR
421 static void smx_ctx_raw_runall_serial(xbt_dynar_t processes)
422 {
423   smx_process_t process;
424   unsigned int cursor;
425
426   double elapsed = 0;
427   double tmax = 0;
428   unsigned long num_proc = xbt_dynar_length(processes);
429   unsigned int t=0;
430   unsigned int data_size = (num_proc / NUM_THREADS) + ((num_proc % NUM_THREADS) ? 1 : 0);
431
432   ssr_count++;
433   time_thread_ssr[0] = 0;
434   xbt_dynar_foreach(processes, cursor, process) {
435     XBT_DEBUG("Schedule item %u of %lu",cursor,xbt_dynar_length(processes));
436     if(cursor >= t * data_size + data_size){
437       if(time_thread_ssr[t] > tmax)
438         tmax = time_thread_ssr[t];
439       t++;
440       time_thread_ssr[t] = 0;
441     }
442
443     if(new_sr){
444       ((smx_ctx_raw_t)process->context)->thread = t;
445       time_thread_sr[t] = 0;
446     }
447
448     xbt_os_timer_start(timer);
449     smx_ctx_raw_resume(process);
450     xbt_os_timer_stop(timer);
451     elapsed = xbt_os_timer_elapsed(timer);
452     time_thread_ssr[t] += elapsed;
453     time_thread_sr[((smx_ctx_raw_t)process->context)->thread] += elapsed;
454   }
455
456   if(new_sr)
457     new_sr = FALSE;
458
459   if(time_thread_ssr[t] > tmax)
460     tmax = time_thread_ssr[t];
461
462   for(cursor=0; cursor <= t; cursor++){
463     XBT_VERB("Time SSR thread %u = %lf (max %lf)", cursor, time_thread_ssr[cursor], tmax);
464     time_wasted_ssr += tmax - time_thread_ssr[cursor];
465   }
466 }
467
468 void smx_ctx_raw_new_sr(void);
469 void smx_ctx_raw_new_sr(void)
470 {
471   int i;
472   double tmax = 0;
473   new_sr = TRUE;
474   sr_count++;
475   for(i=0; i < NUM_THREADS; i++){
476     if(time_thread_sr[i] > tmax)
477       tmax = time_thread_sr[i];
478   }
479
480   for(i=0; i < NUM_THREADS; i++){
481     XBT_VERB("Time SR thread %u = %lf (max %lf)", i, time_thread_sr[i], tmax);
482     time_wasted_sr += tmax - time_thread_sr[i];
483   }
484
485   XBT_VERB("New scheduling round");
486 }
487 #else
488
489 /**
490  * \brief Resumes sequentially all processes ready to run.
491  */
492 static void smx_ctx_raw_runall_serial(void)
493 {
494   if (!xbt_dynar_is_empty(simix_global->process_to_run)) {
495     smx_process_t first_process =
496         xbt_dynar_get_as(simix_global->process_to_run, 0, smx_process_t);
497     raw_process_index = 1;
498
499     /* execute the first process */
500     smx_ctx_raw_resume_serial(first_process);
501   }
502 }
503 #endif
504
505 /**
506  * \brief Stops a raw context.
507  *
508  * This function is called when the main function of the context if finished.
509  *
510  * \param context the context of the current worker thread
511  */
512 static void smx_ctx_raw_stop_parallel(smx_context_t context)
513 {
514   smx_ctx_base_stop(context);
515   smx_ctx_raw_suspend_parallel(context);
516 }
517
518 /**
519  * \brief Suspends a running context and resumes another one or returns to
520  * the main function of the current worker thread.
521  * \param context the context of the current worker thread
522  */
523 static void smx_ctx_raw_suspend_parallel(smx_context_t context)
524 {
525 #ifdef CONTEXT_THREADS
526   /* determine the next context */
527   smx_process_t next_work = xbt_parmap_next(raw_parmap);
528   smx_context_t next_context;
529   raw_stack_t next_stack;
530
531   if (next_work != NULL) {
532     /* there is a next process to resume */
533     XBT_DEBUG("Run next process");
534     next_context = next_work->context;
535     next_stack = ((smx_ctx_raw_t) next_context)->stack_top;
536   }
537   else {
538     /* all processes were run, go to the barrier */
539     XBT_DEBUG("No more processes to run");
540     next_context = (smx_context_t) raw_maestro_context;
541     unsigned long worker_id =
542         (unsigned long) xbt_os_thread_get_specific(raw_worker_id_key);
543     XBT_DEBUG("Restoring worker stack %lu (working threads = %lu)",
544         worker_id, raw_threads_working);
545     next_stack = raw_workers_stacks[worker_id];
546   }
547
548   SIMIX_context_set_current(next_context);
549   raw_swapcontext(&((smx_ctx_raw_t) context)->stack_top, next_stack);
550 #endif
551 }
552
553 /**
554  * \brief Resumes sequentially in the current worker thread the processes ready
555  * to run.
556  * \param first_process the first process to resume
557  */
558 static void smx_ctx_raw_resume_parallel(smx_process_t first_process)
559 {
560 #ifdef CONTEXT_THREADS
561   unsigned long worker_id = __sync_fetch_and_add(&raw_threads_working, 1);
562   xbt_os_thread_set_specific(raw_worker_id_key, (void*) worker_id);
563   XBT_DEBUG("Saving worker stack %lu", worker_id);
564   raw_stack_t* worker_stack = &raw_workers_stacks[worker_id];
565
566   smx_context_t context = first_process->context;
567   SIMIX_context_set_current(context);
568   raw_swapcontext(worker_stack, ((smx_ctx_raw_t) context)->stack_top);
569 #endif
570 }
571
572 /**
573  * \brief Resumes in parallel all processes ready to run.
574  */
575 static void smx_ctx_raw_runall_parallel(void)
576 {
577 #ifdef CONTEXT_THREADS
578   raw_threads_working = 0;
579   xbt_parmap_apply(raw_parmap, (void_f_pvoid_t) smx_ctx_raw_resume_parallel,
580       simix_global->process_to_run);
581 #endif
582 }
583
584 /**
585  * \brief Resumes all processes ready to run.
586  */
587 static void smx_ctx_raw_runall(void)
588 {
589   unsigned long nb_processes = xbt_dynar_length(simix_global->process_to_run);
590   if (nb_processes >= SIMIX_context_get_parallel_threshold()) {
591     XBT_DEBUG("Runall // %lu", nb_processes);
592     simix_global->context_factory->suspend = smx_ctx_raw_suspend_parallel;
593     smx_ctx_raw_runall_parallel();
594   } else {
595     XBT_DEBUG("Runall serial %lu", nb_processes);
596     simix_global->context_factory->suspend = smx_ctx_raw_suspend_serial;
597     smx_ctx_raw_runall_serial();
598   }
599 }