Logo AND Algorithmique Numérique Distribuée

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