Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
3d1c6c75670a81f5aaefd9d19acc8f583e5e429f
[simgrid.git] / src / xbt / parmap.c
1 /* Copyright (c) 2004, 2005, 2007, 2009, 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6 #include "gras_config.h"
7 #include <unistd.h>
8 #include <sys/syscall.h>
9 #ifdef HAVE_FUTEX_H
10         #include <linux/futex.h>
11 #else
12         #include "xbt/xbt_os_thread.h"
13 #endif
14 #include <errno.h>
15 #include "parmap_private.h"
16
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_parmap, xbt, "parmap: parallel map");
18 XBT_LOG_NEW_SUBCATEGORY(xbt_parmap_unit, xbt_parmap, "parmap unit testing");
19
20 static void *_xbt_parmap_worker_main(void *parmap);
21 #ifdef HAVE_FUTEX_H
22         static void futex_wait(int *uaddr, int val);
23         static void futex_wake(int *uaddr, int val);
24 #endif
25 xbt_parmap_t xbt_parmap_new(unsigned int num_workers)
26 {
27   unsigned int i;
28   xbt_os_thread_t worker = NULL;
29
30   DEBUG1("Create new parmap (%u workers)", num_workers);
31
32   /* Initialize the thread pool data structure */
33   xbt_parmap_t parmap = xbt_new0(s_xbt_parmap_t, 1);
34   parmap->num_workers = num_workers;
35   parmap->status = PARMAP_WORK;
36
37   parmap->workers_ready = xbt_new0(s_xbt_barrier_t, 1);
38   xbt_barrier_init(parmap->workers_ready, num_workers + 1);
39   parmap->workers_done = xbt_new0(s_xbt_barrier_t, 1);
40   xbt_barrier_init(parmap->workers_done, num_workers + 1);
41 #ifndef HAVE_FUTEX_H
42   parmap->workers_ready->mutex = xbt_os_mutex_init();
43   parmap->workers_ready->cond = xbt_os_cond_init();
44 #endif
45   /* Create the pool of worker threads */
46   for(i=0; i < num_workers; i++){
47     worker = xbt_os_thread_create(NULL, _xbt_parmap_worker_main, parmap, NULL);
48     xbt_os_thread_detach(worker);
49   }
50   
51   return parmap;
52 }
53
54 void xbt_parmap_destroy(xbt_parmap_t parmap)
55
56   DEBUG1("Destroy parmap %p", parmap);
57
58   parmap->status = PARMAP_DESTROY;
59
60   xbt_barrier_wait(parmap->workers_ready);
61   DEBUG0("Kill job sent");
62   xbt_barrier_wait(parmap->workers_done);
63 #ifndef HAVE_FUTEX_H
64   xbt_os_mutex_destroy(parmap->workers_ready->mutex);
65   xbt_os_cond_destroy(parmap->workers_ready->cond);
66 #endif
67   xbt_free(parmap->workers_ready);
68   xbt_free(parmap->workers_done);
69   xbt_free(parmap);
70 }
71
72  void xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data)
73 {
74   /* Assign resources to worker threads*/
75   parmap->fun = fun;
76   parmap->data = data;
77
78   /* Notify workers that there is a job */
79   xbt_barrier_wait(parmap->workers_ready);
80   DEBUG0("Job dispatched, lets wait...");
81   xbt_barrier_wait(parmap->workers_done);
82
83   DEBUG0("Job done");
84   parmap->fun = NULL;
85   parmap->data = NULL;
86 }
87
88 static void *_xbt_parmap_worker_main(void *arg)
89 {
90   unsigned int data_start, data_end, data_size, worker_id;
91   xbt_parmap_t parmap = (xbt_parmap_t)arg;
92
93   /* Fetch a worker id */
94   worker_id = __sync_fetch_and_add(&parmap->workers_max_id, 1);
95
96   DEBUG1("New worker thread created (%u)", worker_id);
97   
98   /* Worker's main loop */
99   while(1){
100     xbt_barrier_wait(parmap->workers_ready);
101
102     if(parmap->status == PARMAP_WORK){
103       DEBUG1("Worker %u got a job", worker_id);
104
105       /* Compute how much data does every worker gets */
106       data_size = (xbt_dynar_length(parmap->data) / parmap->num_workers)
107                   + ((xbt_dynar_length(parmap->data) % parmap->num_workers) ? 1 : 0);
108
109       /* Each worker data segment starts in a position associated with its id*/
110       data_start = data_size * worker_id;
111
112       /* The end of the worker data segment must be bounded by the end of the data vector */
113       data_end = MIN(data_start + data_size, xbt_dynar_length(parmap->data));
114
115       DEBUG4("Worker %u: data_start=%u data_end=%u (data_size=%u)",
116           worker_id, data_start, data_end, data_size);
117
118       /* While the worker don't pass the end of it data segment apply the function */
119       while(data_start < data_end){
120         parmap->fun(*(void **)xbt_dynar_get_ptr(parmap->data, data_start));
121         data_start++;
122       }
123
124       xbt_barrier_wait(parmap->workers_done);
125
126     /* We are destroying the parmap */
127     }else{
128       xbt_barrier_wait(parmap->workers_done);
129       DEBUG1("Shutting down worker %u", worker_id);
130       return NULL;
131     }
132   }
133 }
134
135 #ifdef HAVE_FUTEX_H
136         static void futex_wait(int *uaddr, int val)
137         {
138           DEBUG1("Waiting on futex %d", *uaddr);
139           syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, NULL, NULL, 0);
140         }
141
142         static void futex_wake(int *uaddr, int val)
143         {
144           DEBUG1("Waking futex %d", *uaddr);
145           syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, NULL, NULL, 0);
146         }
147 #endif
148
149 /* Futex based implementation of the barrier */
150 void xbt_barrier_init(xbt_barrier_t barrier, unsigned int threads_to_wait)
151 {
152   barrier->threads_to_wait = threads_to_wait;
153   barrier->thread_count = 0;
154 }
155
156 #ifdef HAVE_FUTEX_H
157         void xbt_barrier_wait(xbt_barrier_t barrier)
158         {
159           int myflag = 0;
160           unsigned int mycount = 0;
161
162           myflag = barrier->futex;
163           mycount = __sync_add_and_fetch(&barrier->thread_count, 1);
164           if(mycount < barrier->threads_to_wait){
165                 futex_wait(&barrier->futex, myflag);
166           }else{
167                 barrier->futex = __sync_add_and_fetch(&barrier->futex, 1);
168                 barrier->thread_count = 0;
169                 futex_wake(&barrier->futex, barrier->threads_to_wait);
170           }
171         }
172 #else
173         void xbt_barrier_wait(xbt_barrier_t barrier)
174         {
175           int myflag = 0;
176           unsigned int mycount = 0;
177
178           xbt_os_mutex_acquire(barrier->mutex);
179
180           barrier->thread_count++;
181           if(barrier->thread_count < barrier->threads_to_wait){
182                   xbt_os_cond_wait(barrier->cond,barrier->mutex);
183           }else{
184                 barrier->thread_count = 0;
185                 xbt_os_cond_broadcast(barrier->cond);
186           }
187           xbt_os_mutex_release(barrier->mutex);
188         }
189 #endif
190
191 #ifdef SIMGRID_TEST
192 #include "xbt.h"
193 #include "xbt/ex.h"
194
195 XBT_TEST_SUITE("parmap", "Parallel Map");
196 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(xbt_parmap_unit);
197
198
199
200 xbt_parmap_t parmap;
201
202 void fun(void *arg);
203
204 void fun(void *arg)
205 {
206   //INFO1("I'm job %lu", (unsigned long)arg);
207 }
208
209 XBT_TEST_UNIT("basic", test_parmap_basic, "Basic usage")
210 {
211   xbt_test_add0("Create the parmap");
212
213   unsigned long i,j;
214   xbt_dynar_t data = xbt_dynar_new(sizeof(void *), NULL);
215
216   /* Create the parallel map */
217   parmap = xbt_parmap_new(10);
218
219   for(j=0; j < 100; j++){
220     xbt_dynar_push_as(data, void *, (void *)j);
221   }
222
223   for(i=0; i < 5; i++)
224     xbt_parmap_apply(parmap, fun, data);
225
226   /* Destroy the parmap */
227   xbt_parmap_destroy(parmap);
228 }
229
230 #endif /* SIMGRID_TEST */