Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Remove unused function.
[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   XBT_VERB("Using raw contexts. Because the glibc is just not good enough for us.");
232   smx_ctx_base_factory_init(factory);
233
234   (*factory)->finalize  = smx_ctx_raw_factory_finalize;
235   (*factory)->create_context = smx_ctx_raw_create_context;
236   /* Do not overload that method (*factory)->finalize */
237   (*factory)->free = smx_ctx_raw_free;
238   (*factory)->stop = smx_ctx_raw_stop;
239   (*factory)->name = "smx_raw_context_factory";
240
241   if (SIMIX_context_is_parallel()) {
242 #ifdef CONTEXT_THREADS
243     int nthreads = SIMIX_context_get_nthreads();
244     raw_parmap = xbt_parmap_new(nthreads, SIMIX_context_get_parallel_mode());
245     raw_workers_stacks = xbt_new(raw_stack_t, nthreads);
246     xbt_os_thread_key_create(&raw_worker_id_key);
247 #endif
248     if (SIMIX_context_get_parallel_threshold() > 1) {
249       /* choose dynamically */
250       (*factory)->runall = smx_ctx_raw_runall;
251       (*factory)->suspend = NULL;
252     }
253     else {
254       /* always parallel */
255       (*factory)->runall = smx_ctx_raw_runall_parallel;
256       (*factory)->suspend = smx_ctx_raw_suspend_parallel;
257     }
258   }
259   else {
260     /* always serial */
261     (*factory)->runall = smx_ctx_raw_runall_serial;
262     (*factory)->suspend = smx_ctx_raw_suspend_serial;
263   }
264 #ifdef TIME_BENCH_PER_SR
265   timer = xbt_os_timer_new();
266 #endif
267 }
268
269 /**
270  * \brief Finalizes the raw context factory.
271  * \param factory the raw context factory
272  */
273 static int smx_ctx_raw_factory_finalize(smx_context_factory_t *factory)
274 {
275 #ifdef TIME_BENCH_PER_SR
276   XBT_CRITICAL("Total wasted time in %u SR: %lf", sr_count, time_wasted_sr);
277   XBT_CRITICAL("Total wasted time in %u SSR: %lf", ssr_count, time_wasted_ssr);
278 #endif
279
280 #ifdef CONTEXT_THREADS
281   if (raw_parmap)
282     xbt_parmap_destroy(raw_parmap);
283   xbt_free(raw_workers_stacks);
284 #endif
285   return smx_ctx_base_factory_finalize(factory);
286 }
287
288 /**
289  * \brief Creates a new raw context.
290  * \param code main function of this context or NULL to create the maestro
291  * context
292  * \param argc argument number
293  * \param argv arguments to pass to the main function
294  * \param cleanup_func a function to call to free the user data when the
295  * context finished
296  * \param data user data
297  */
298 static smx_context_t
299 smx_ctx_raw_create_context(xbt_main_func_t code, int argc, char **argv,
300     void_pfn_smxprocess_t cleanup_func,
301     void *data)
302 {
303
304   smx_ctx_raw_t context =
305       (smx_ctx_raw_t) smx_ctx_base_factory_create_context_sized(
306           sizeof(s_smx_ctx_raw_t),
307           code,
308           argc,
309           argv,
310           cleanup_func,
311           data);
312
313   /* if the user provided a function for the process then use it,
314      otherwise it is the context for maestro */
315      if (code) {
316        context->malloced_stack = xbt_malloc0(smx_context_stack_size);
317        context->stack_top =
318            raw_makecontext(context->malloced_stack, smx_context_stack_size,
319                (void_f_pvoid_t) smx_ctx_raw_wrapper, context);
320
321 #ifdef HAVE_VALGRIND_VALGRIND_H
322        context->valgrind_stack_id =
323            VALGRIND_STACK_REGISTER(context->malloced_stack,
324                context->malloced_stack + smx_context_stack_size);
325 #endif                          /* HAVE_VALGRIND_VALGRIND_H */
326
327      } else {
328        raw_maestro_context = context;
329
330        if(MC_IS_ENABLED)
331          MC_ignore(&(raw_maestro_context->stack_top), sizeof(raw_maestro_context->stack_top));
332
333      }
334
335      return (smx_context_t) context;
336 }
337
338 /**
339  * \brief Destroys a raw context.
340  * \param context a raw context
341  */
342 static void smx_ctx_raw_free(smx_context_t context)
343 {
344   if (context) {
345
346 #ifdef HAVE_VALGRIND_VALGRIND_H
347     VALGRIND_STACK_DEREGISTER(((smx_ctx_raw_t)
348         context)->valgrind_stack_id);
349 #endif                          /* HAVE_VALGRIND_VALGRIND_H */
350
351     free(((smx_ctx_raw_t) context)->malloced_stack);
352   }
353   smx_ctx_base_free(context);
354 }
355
356 /**
357  * \brief Wrapper for the main function of a context.
358  * \param context a raw context
359  */
360 static void smx_ctx_raw_wrapper(smx_ctx_raw_t context)
361 {
362   (context->super.code) (context->super.argc, context->super.argv);
363
364   smx_ctx_raw_stop((smx_context_t) context);
365 }
366
367 /**
368  * \brief Stops a raw context.
369  *
370  * This function is called when the main function of the context if finished.
371  *
372  * \param context the current context
373  */
374 static void smx_ctx_raw_stop(smx_context_t context)
375 {
376   smx_ctx_base_stop(context);
377   simix_global->context_factory->suspend(context);
378 }
379
380 /**
381  * \brief Suspends a running context and resumes another one or returns to
382  * maestro.
383  * \param context the current context
384  */
385 static void smx_ctx_raw_suspend_serial(smx_context_t context)
386 {
387   /* determine the next context */
388   smx_context_t next_context;
389   unsigned long int i = raw_process_index++;
390
391   if (i < xbt_dynar_length(simix_global->process_to_run)) {
392     /* execute the next process */
393     XBT_DEBUG("Run next process");
394     next_context = xbt_dynar_get_as(
395         simix_global->process_to_run, i, smx_process_t)->context;
396   }
397   else {
398     /* all processes were run, return to maestro */
399     XBT_DEBUG("No more process to run");
400     next_context = (smx_context_t) raw_maestro_context;
401   }
402   SIMIX_context_set_current(next_context);
403   raw_swapcontext(&((smx_ctx_raw_t) context)->stack_top,
404       ((smx_ctx_raw_t) next_context)->stack_top);
405 }
406
407 /**
408  * \brief Resumes sequentially all processes ready to run.
409  * \param first_process the first process to resume
410  */
411 static void smx_ctx_raw_resume_serial(smx_process_t first_process)
412 {
413   smx_ctx_raw_t context = (smx_ctx_raw_t) first_process->context;
414   SIMIX_context_set_current((smx_context_t) context);
415   raw_swapcontext(&raw_maestro_context->stack_top,
416       ((smx_ctx_raw_t) context)->stack_top);
417 }
418
419 #ifdef TIME_BENCH_PER_SR
420 static void smx_ctx_raw_runall_serial(xbt_dynar_t processes)
421 {
422   smx_process_t process;
423   unsigned int cursor;
424
425   double elapsed = 0;
426   double tmax = 0;
427   unsigned long num_proc = xbt_dynar_length(processes);
428   unsigned int t=0;
429   unsigned int data_size = (num_proc / NUM_THREADS) + ((num_proc % NUM_THREADS) ? 1 : 0);
430
431   ssr_count++;
432   time_thread_ssr[0] = 0;
433   xbt_dynar_foreach(processes, cursor, process) {
434     XBT_DEBUG("Schedule item %u of %lu",cursor,xbt_dynar_length(processes));
435     if(cursor >= t * data_size + data_size){
436       if(time_thread_ssr[t] > tmax)
437         tmax = time_thread_ssr[t];
438       t++;
439       time_thread_ssr[t] = 0;
440     }
441
442     if(new_sr){
443       ((smx_ctx_raw_t)process->context)->thread = t;
444       time_thread_sr[t] = 0;
445     }
446
447     xbt_os_timer_start(timer);
448     smx_ctx_raw_resume(process);
449     xbt_os_timer_stop(timer);
450     elapsed = xbt_os_timer_elapsed(timer);
451     time_thread_ssr[t] += elapsed;
452     time_thread_sr[((smx_ctx_raw_t)process->context)->thread] += elapsed;
453   }
454
455   if(new_sr)
456     new_sr = FALSE;
457
458   if(time_thread_ssr[t] > tmax)
459     tmax = time_thread_ssr[t];
460
461   for(cursor=0; cursor <= t; cursor++){
462     XBT_VERB("Time SSR thread %u = %lf (max %lf)", cursor, time_thread_ssr[cursor], tmax);
463     time_wasted_ssr += tmax - time_thread_ssr[cursor];
464   }
465 }
466
467 void smx_ctx_raw_new_sr(void);
468 void smx_ctx_raw_new_sr(void)
469 {
470   int i;
471   double tmax = 0;
472   new_sr = TRUE;
473   sr_count++;
474   for(i=0; i < NUM_THREADS; i++){
475     if(time_thread_sr[i] > tmax)
476       tmax = time_thread_sr[i];
477   }
478
479   for(i=0; i < NUM_THREADS; i++){
480     XBT_VERB("Time SR thread %u = %lf (max %lf)", i, time_thread_sr[i], tmax);
481     time_wasted_sr += tmax - time_thread_sr[i];
482   }
483
484   XBT_VERB("New scheduling round");
485 }
486 #else
487
488 /**
489  * \brief Resumes sequentially all processes ready to run.
490  */
491 static void smx_ctx_raw_runall_serial(void)
492 {
493   if (!xbt_dynar_is_empty(simix_global->process_to_run)) {
494     smx_process_t first_process =
495         xbt_dynar_get_as(simix_global->process_to_run, 0, smx_process_t);
496     raw_process_index = 1;
497
498     /* execute the first process */
499     smx_ctx_raw_resume_serial(first_process);
500   }
501 }
502 #endif
503
504 /**
505  * \brief Suspends a running context and resumes another one or returns to
506  * the main function of the current worker thread.
507  * \param context the context of the current worker thread
508  */
509 static void smx_ctx_raw_suspend_parallel(smx_context_t context)
510 {
511 #ifdef CONTEXT_THREADS
512   /* determine the next context */
513   smx_process_t next_work = xbt_parmap_next(raw_parmap);
514   smx_context_t next_context;
515   raw_stack_t next_stack;
516
517   if (next_work != NULL) {
518     /* there is a next process to resume */
519     XBT_DEBUG("Run next process");
520     next_context = next_work->context;
521     next_stack = ((smx_ctx_raw_t) next_context)->stack_top;
522   }
523   else {
524     /* all processes were run, go to the barrier */
525     XBT_DEBUG("No more processes to run");
526     next_context = (smx_context_t) raw_maestro_context;
527     unsigned long worker_id =
528         (unsigned long) xbt_os_thread_get_specific(raw_worker_id_key);
529     XBT_DEBUG("Restoring worker stack %lu (working threads = %lu)",
530         worker_id, raw_threads_working);
531     next_stack = raw_workers_stacks[worker_id];
532   }
533
534   SIMIX_context_set_current(next_context);
535   raw_swapcontext(&((smx_ctx_raw_t) context)->stack_top, next_stack);
536 #endif
537 }
538
539 /**
540  * \brief Resumes sequentially in the current worker thread the processes ready
541  * to run.
542  * \param first_process the first process to resume
543  */
544 static void smx_ctx_raw_resume_parallel(smx_process_t first_process)
545 {
546 #ifdef CONTEXT_THREADS
547   unsigned long worker_id = __sync_fetch_and_add(&raw_threads_working, 1);
548   xbt_os_thread_set_specific(raw_worker_id_key, (void*) worker_id);
549   XBT_DEBUG("Saving worker stack %lu", worker_id);
550   raw_stack_t* worker_stack = &raw_workers_stacks[worker_id];
551
552   smx_context_t context = first_process->context;
553   SIMIX_context_set_current(context);
554   raw_swapcontext(worker_stack, ((smx_ctx_raw_t) context)->stack_top);
555 #endif
556 }
557
558 /**
559  * \brief Resumes in parallel all processes ready to run.
560  */
561 static void smx_ctx_raw_runall_parallel(void)
562 {
563 #ifdef CONTEXT_THREADS
564   raw_threads_working = 0;
565   xbt_parmap_apply(raw_parmap, (void_f_pvoid_t) smx_ctx_raw_resume_parallel,
566       simix_global->process_to_run);
567 #endif
568 }
569
570 /**
571  * \brief Resumes all processes ready to run.
572  */
573 static void smx_ctx_raw_runall(void)
574 {
575   unsigned long nb_processes = xbt_dynar_length(simix_global->process_to_run);
576   if (nb_processes >= SIMIX_context_get_parallel_threshold()) {
577     XBT_DEBUG("Runall // %lu", nb_processes);
578     simix_global->context_factory->suspend = smx_ctx_raw_suspend_parallel;
579     smx_ctx_raw_runall_parallel();
580   } else {
581     XBT_DEBUG("Runall serial %lu", nb_processes);
582     simix_global->context_factory->suspend = smx_ctx_raw_suspend_serial;
583     smx_ctx_raw_runall_serial();
584   }
585 }