Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Protect for windows.
[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 #ifndef _XBT_WIN32
9 #include <sys/syscall.h>
10 #endif
11
12 #ifdef HAVE_FUTEX_H
13         #include <linux/futex.h>
14 #else
15         #include "xbt/xbt_os_thread.h"
16 #endif
17 #include <errno.h>
18 #include "parmap_private.h"
19
20 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(xbt_parmap, xbt, "parmap: parallel map");
21 XBT_LOG_NEW_SUBCATEGORY(xbt_parmap_unit, xbt_parmap, "parmap unit testing");
22
23 static void *_xbt_parmap_worker_main(void *parmap);
24 #ifdef HAVE_FUTEX_H
25         static void futex_wait(int *uaddr, int val);
26         static void futex_wake(int *uaddr, int val);
27 #endif
28 xbt_parmap_t xbt_parmap_new(unsigned int num_workers)
29 {
30   unsigned int i;
31   xbt_os_thread_t worker = NULL;
32
33   DEBUG1("Create new parmap (%u workers)", num_workers);
34
35   /* Initialize the thread pool data structure */
36   xbt_parmap_t parmap = xbt_new0(s_xbt_parmap_t, 1);
37   parmap->num_workers = num_workers;
38   parmap->status = PARMAP_WORK;
39
40   parmap->workers_ready = xbt_new0(s_xbt_barrier_t, 1);
41   xbt_barrier_init(parmap->workers_ready, num_workers + 1);
42   parmap->workers_done = xbt_new0(s_xbt_barrier_t, 1);
43   xbt_barrier_init(parmap->workers_done, num_workers + 1);
44 #ifndef HAVE_FUTEX_H
45   parmap->workers_ready->mutex = xbt_os_mutex_init();
46   parmap->workers_ready->cond = xbt_os_cond_init();
47 #endif
48   /* Create the pool of worker threads */
49   for(i=0; i < num_workers; i++){
50     worker = xbt_os_thread_create(NULL, _xbt_parmap_worker_main, parmap, NULL);
51     xbt_os_thread_detach(worker);
52   }
53   
54   return parmap;
55 }
56
57 void xbt_parmap_destroy(xbt_parmap_t parmap)
58
59   DEBUG1("Destroy parmap %p", parmap);
60
61   parmap->status = PARMAP_DESTROY;
62
63   xbt_barrier_wait(parmap->workers_ready);
64   DEBUG0("Kill job sent");
65   xbt_barrier_wait(parmap->workers_done);
66 #ifndef HAVE_FUTEX_H
67   xbt_os_mutex_destroy(parmap->workers_ready->mutex);
68   xbt_os_cond_destroy(parmap->workers_ready->cond);
69 #endif
70   xbt_free(parmap->workers_ready);
71   xbt_free(parmap->workers_done);
72   xbt_free(parmap);
73 }
74
75  void xbt_parmap_apply(xbt_parmap_t parmap, void_f_pvoid_t fun, xbt_dynar_t data)
76 {
77   /* Assign resources to worker threads*/
78   parmap->fun = fun;
79   parmap->data = data;
80
81   /* Notify workers that there is a job */
82   xbt_barrier_wait(parmap->workers_ready);
83   DEBUG0("Job dispatched, lets wait...");
84   xbt_barrier_wait(parmap->workers_done);
85
86   DEBUG0("Job done");
87   parmap->fun = NULL;
88   parmap->data = NULL;
89 }
90
91 static void *_xbt_parmap_worker_main(void *arg)
92 {
93   unsigned int data_start, data_end, data_size, worker_id;
94   xbt_parmap_t parmap = (xbt_parmap_t)arg;
95
96   /* Fetch a worker id */
97   worker_id = __sync_fetch_and_add(&parmap->workers_max_id, 1);
98
99   DEBUG1("New worker thread created (%u)", worker_id);
100   
101   /* Worker's main loop */
102   while(1){
103     xbt_barrier_wait(parmap->workers_ready);
104
105     if(parmap->status == PARMAP_WORK){
106       DEBUG1("Worker %u got a job", worker_id);
107
108       /* Compute how much data does every worker gets */
109       data_size = (xbt_dynar_length(parmap->data) / parmap->num_workers)
110                   + ((xbt_dynar_length(parmap->data) % parmap->num_workers) ? 1 : 0);
111
112       /* Each worker data segment starts in a position associated with its id*/
113       data_start = data_size * worker_id;
114
115       /* The end of the worker data segment must be bounded by the end of the data vector */
116       data_end = MIN(data_start + data_size, xbt_dynar_length(parmap->data));
117
118       DEBUG4("Worker %u: data_start=%u data_end=%u (data_size=%u)",
119           worker_id, data_start, data_end, data_size);
120
121       /* While the worker don't pass the end of it data segment apply the function */
122       while(data_start < data_end){
123         parmap->fun(*(void **)xbt_dynar_get_ptr(parmap->data, data_start));
124         data_start++;
125       }
126
127       xbt_barrier_wait(parmap->workers_done);
128
129     /* We are destroying the parmap */
130     }else{
131       xbt_barrier_wait(parmap->workers_done);
132       DEBUG1("Shutting down worker %u", worker_id);
133       return NULL;
134     }
135   }
136 }
137
138 #ifdef HAVE_FUTEX_H
139         static void futex_wait(int *uaddr, int val)
140         {
141           DEBUG1("Waiting on futex %d", *uaddr);
142           syscall(SYS_futex, uaddr, FUTEX_WAIT_PRIVATE, val, NULL, NULL, 0);
143         }
144
145         static void futex_wake(int *uaddr, int val)
146         {
147           DEBUG1("Waking futex %d", *uaddr);
148           syscall(SYS_futex, uaddr, FUTEX_WAKE_PRIVATE, val, NULL, NULL, 0);
149         }
150 #endif
151
152 /* Futex based implementation of the barrier */
153 void xbt_barrier_init(xbt_barrier_t barrier, unsigned int threads_to_wait)
154 {
155   barrier->threads_to_wait = threads_to_wait;
156   barrier->thread_count = 0;
157 }
158
159 #ifdef HAVE_FUTEX_H
160         void xbt_barrier_wait(xbt_barrier_t barrier)
161         {
162           int myflag = 0;
163           unsigned int mycount = 0;
164
165           myflag = barrier->futex;
166           mycount = __sync_add_and_fetch(&barrier->thread_count, 1);
167           if(mycount < barrier->threads_to_wait){
168                 futex_wait(&barrier->futex, myflag);
169           }else{
170                 barrier->futex = __sync_add_and_fetch(&barrier->futex, 1);
171                 barrier->thread_count = 0;
172                 futex_wake(&barrier->futex, barrier->threads_to_wait);
173           }
174         }
175 #else
176         void xbt_barrier_wait(xbt_barrier_t barrier)
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 */