task.c 10.6 KB
Newer Older
1
/*******************************************************************************
2
 * This file is part of SWIFT.
3
 * Copyright (c) 2012 Pedro Gonnet (pedro.gonnet@durham.ac.uk)
4
5
6
7
 *                    Matthieu Schaller (matthieu.schaller@durham.ac.uk)
 *               2015 Peter W. Draper (p.w.draper@durham.ac.uk)
 *               2016 John A. Regan (john.a.regan@durham.ac.uk)
 *                    Tom Theuns (tom.theuns@durham.ac.uk)
8
 *
9
10
11
12
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
13
 *
14
15
16
17
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
18
 *
19
20
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21
 *
22
23
24
25
26
27
28
29
30
 ******************************************************************************/

/* Config parameters. */
#include "../config.h"

/* Some standard headers. */
#include <float.h>
#include <limits.h>
#include <sched.h>
31
32
33
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
34

35
36
/* MPI headers. */
#ifdef WITH_MPI
37
#include <mpi.h>
38
39
#endif

40
41
42
/* This object's header. */
#include "task.h"

43
/* Local headers. */
Pedro Gonnet's avatar
Pedro Gonnet committed
44
#include "atomic.h"
45
#include "error.h"
46
#include "lock.h"
47
48

/* Task type names. */
49
const char *taskID_names[task_type_count] = {
Matthieu Schaller's avatar
Matthieu Schaller committed
50
51
52
53
    "none",      "sort",       "self",       "pair",    "sub",
    "init",      "ghost",      "drift",      "kick",    "kick_fixdt",
    "send",      "recv",       "grav_mm",    "grav_up", "grav_external",
    "part_sort", "gpart_sort", "split_cell", "rewait"};
54

Matthieu Schaller's avatar
Matthieu Schaller committed
55
56
const char *subtaskID_names[task_type_count] = {"none", "density", "force",
                                                "grav"};
57

58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/**
 * @brief Computes the overlap between the parts array of two given cells.
 */
size_t task_cell_overlap(const struct cell *ci, const struct cell *cj) {
  if (ci == NULL || cj == NULL) return 0;
  if (ci->parts <= cj->parts &&
      ci->parts + ci->count >= cj->parts + cj->count) {
    return cj->count;
  } else if (cj->parts <= ci->parts &&
             cj->parts + cj->count >= ci->parts + ci->count) {
    return ci->count;
  }
  return 0;
}

/**
 * @brief Compute the Jaccard similarity of the data used by two
 *        different tasks.
 *
 * @param ta The first #task.
 * @param tb The second #task.
 */
float task_overlap(const struct task *ta, const struct task *tb) {
  /* First check if any of the two tasks are of a type that don't
     use cells. */
83
  if (ta == NULL || tb == NULL || ta->type == task_type_none ||
84
85
86
87
      ta->type == task_type_part_sort || ta->type == task_type_gpart_sort ||
      ta->type == task_type_split_cell || ta->type == task_type_rewait ||
      tb->type == task_type_none || tb->type == task_type_part_sort ||
      tb->type == task_type_gpart_sort || tb->type == task_type_split_cell ||
88
      tb->type == task_type_rewait)
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
    return 0.0f;

  /* Compute the union of the cell data. */
  size_t size_union = 0;
  if (ta->ci != NULL) size_union += ta->ci->count;
  if (ta->cj != NULL) size_union += ta->cj->count;
  if (tb->ci != NULL) size_union += tb->ci->count;
  if (tb->cj != NULL) size_union += tb->cj->count;

  /* Compute the intersection of the cell data. */
  const size_t size_intersect =
      task_cell_overlap(ta->ci, tb->ci) + task_cell_overlap(ta->ci, tb->cj) +
      task_cell_overlap(ta->cj, tb->ci) + task_cell_overlap(ta->cj, tb->cj);

  return ((float)size_intersect) / (size_union - size_intersect);
}
105

106
107
/**
 * @brief Unlock the cell held by this task.
108
 *
109
110
 * @param t The #task.
 */
111
112
void task_unlock(struct task *t) {

113
114
115
116
  const int type = t->type;
  const int subtype = t->subtype;
  struct cell *ci = t->ci, *cj = t->cj;

117
  /* Act based on task type. */
118
119
  switch (type) {

120
    case task_type_sort:
121
122
123
124
125
126
127
128
129
      cell_unlocktree(ci);
      break;

    case task_type_self:
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
      } else {
        cell_unlocktree(ci);
      }
130
      break;
131

132
    case task_type_pair:
133
134
135
136
137
138
139
140
141
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        cell_gunlocktree(cj);
      } else {
        cell_unlocktree(ci);
        cell_unlocktree(cj);
      }
      break;

142
    case task_type_sub:
143
144
145
146
147
148
149
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        if (cj != NULL) cell_gunlocktree(cj);
      } else {
        cell_unlocktree(ci);
        if (cj != NULL) cell_unlocktree(cj);
      }
150
      break;
151

152
    case task_type_grav_mm:
153
154
      cell_gunlocktree(ci);
      cell_gunlocktree(cj);
155
156
157
158
159
      break;
    default:
      break;
  }
}
160
161
162
163
164
165

/**
 * @brief Try to lock the cells associated with this task.
 *
 * @param t the #task.
 */
166
167
int task_lock(struct task *t) {

168
169
  const int type = t->type;
  const int subtype = t->subtype;
170
  struct cell *ci = t->ci, *cj = t->cj;
171
172
173
174
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
175

176
  switch (type) {
177

178
179
180
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
181
#ifdef WITH_MPI
182
183
184
185
186
187
188
189
190
      /* Check the status of the MPI request. */
      if ((err = MPI_Test(&t->req, &res, &stat)) != MPI_SUCCESS) {
        char buff[MPI_MAX_ERROR_STRING];
        int len;
        MPI_Error_string(err, buff, &len);
        error("Failed to test request on send/recv task (tag=%i, %s).",
              t->flags, buff);
      }
      return res;
191
#else
192
      error("SWIFT was not compiled with MPI support.");
193
#endif
194
      break;
195

196
197
198
    case task_type_sort:
      if (cell_locktree(ci) != 0) return 0;
      break;
199

200
201
202
203
204
205
206
    case task_type_self:
      if (subtype == task_subtype_grav) {
        if (cell_glocktree(ci) != 0) return 0;
      } else {
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
207

208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
    case task_type_pair:
      if (subtype == task_subtype_grav) {
        if (ci->ghold || cj->ghold) return 0;
        if (cell_glocktree(ci) != 0) return 0;
        if (cell_glocktree(cj) != 0) {
          cell_gunlocktree(ci);
          return 0;
        }
      } else {
        if (ci->hold || cj->hold) return 0;
        if (cell_locktree(ci) != 0) return 0;
        if (cell_locktree(cj) != 0) {
          cell_unlocktree(ci);
          return 0;
        }
      }
      break;
225

226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
    case task_type_sub:
      if (cj == NULL) { /* sub-self */

        if (subtype == task_subtype_grav) {
          if (cell_glocktree(ci) != 0) return 0;
        } else {
          if (cell_locktree(ci) != 0) return 0;
        }

      } else { /* Sub-pair */
        if (subtype == task_subtype_grav) {
          if (ci->ghold || cj->ghold) return 0;
          if (cell_glocktree(ci) != 0) return 0;
          if (cell_glocktree(cj) != 0) {
            cell_gunlocktree(ci);
            return 0;
          }
        } else {
          if (ci->hold || cj->hold) return 0;
          if (cell_locktree(ci) != 0) return 0;
          if (cell_locktree(cj) != 0) {
            cell_unlocktree(ci);
            return 0;
          }
        }
      }
      break;

    case task_type_grav_mm:
      if (ci->ghold || cj->ghold) return 0;
      if (cell_glocktree(ci) != 0) return 0;
      if (cell_glocktree(cj) != 0) {
        cell_gunlocktree(ci);
        return 0;
      }

    default:
      break;
264
265
266
267
268
  }

  /* If we made it this far, we've got a lock. */
  return 1;
}
269

270
/**
271
 * @brief Remove all unlocks to tasks that are of the given type.
272
273
274
275
 *
 * @param t The #task.
 * @param type The task type ID to remove.
 */
276
277
278
279
280
281
282
283
284
285
void task_cleanunlock(struct task *t, int type) {

  int k;

  lock_lock(&t->lock);

  for (k = 0; k < t->nr_unlock_tasks; k++)
    if (t->unlock_tasks[k]->type == type) {
      t->nr_unlock_tasks -= 1;
      t->unlock_tasks[k] = t->unlock_tasks[t->nr_unlock_tasks];
286
287
    }

288
289
  lock_unlock_blind(&t->lock);
}
290

291
292
293
294
295
296
/**
 * @brief Remove an unlock_task from the given task.
 *
 * @param ta The unlocking #task.
 * @param tb The #task that will be unlocked.
 */
297
298
299
300
301
302
303
304
305
306
307
308
void task_rmunlock(struct task *ta, struct task *tb) {

  int k;

  lock_lock(&ta->lock);

  for (k = 0; k < ta->nr_unlock_tasks; k++)
    if (ta->unlock_tasks[k] == tb) {
      ta->nr_unlock_tasks -= 1;
      ta->unlock_tasks[k] = ta->unlock_tasks[ta->nr_unlock_tasks];
      lock_unlock_blind(&ta->lock);
      return;
309
    }
310
311
  error("Task not found.");
}
312

Pedro Gonnet's avatar
Pedro Gonnet committed
313
314
315
316
317
318
319
320
321
/**
 * @brief Remove an unlock_task from the given task.
 *
 * @param ta The unlocking #task.
 * @param tb The #task that will be unlocked.
 *
 * Differs from #task_rmunlock in that it will not fail if
 * the task @c tb is not in the unlocks of @c ta.
 */
322
323
324
325
326
327
328
329
330
331
332
void task_rmunlock_blind(struct task *ta, struct task *tb) {

  int k;

  lock_lock(&ta->lock);

  for (k = 0; k < ta->nr_unlock_tasks; k++)
    if (ta->unlock_tasks[k] == tb) {
      ta->nr_unlock_tasks -= 1;
      ta->unlock_tasks[k] = ta->unlock_tasks[ta->nr_unlock_tasks];
      break;
Pedro Gonnet's avatar
Pedro Gonnet committed
333
    }
334
335
336

  lock_unlock_blind(&ta->lock);
}
Pedro Gonnet's avatar
Pedro Gonnet committed
337

338
339
340
341
342
343
/**
 * @brief Add an unlock_task to the given task.
 *
 * @param ta The unlocking #task.
 * @param tb The #task that will be unlocked.
 */
344
void task_addunlock(struct task *ta, struct task *tb) {
345

346
  error("Use sched_addunlock instead.");
347

348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
  /* Add the lock atomically. */
  ta->unlock_tasks[atomic_inc(&ta->nr_unlock_tasks)] = tb;

  /* Check a posteriori if we did not overshoot. */
  if (ta->nr_unlock_tasks > task_maxunlock)
    error("Too many unlock_tasks in task.");
}

void task_addunlock_old(struct task *ta, struct task *tb) {

  int k;

  lock_lock(&ta->lock);

  /* Check if ta already unlocks tb. */
  for (k = 0; k < ta->nr_unlock_tasks; k++)
    if (ta->unlock_tasks[k] == tb) {
      error("Duplicate unlock.");
      lock_unlock_blind(&ta->lock);
      return;
368
369
    }

370
371
372
373
374
375
376
377
  if (ta->nr_unlock_tasks == task_maxunlock)
    error("Too many unlock_tasks in task.");

  ta->unlock_tasks[ta->nr_unlock_tasks] = tb;
  ta->nr_unlock_tasks += 1;

  lock_unlock_blind(&ta->lock);
}
378
379
380
381

/**
 * @brief Prints the list of tasks contained in a given mask
 *
382
 * @param mask The mask to analyse
383
384
385
386
387
388
389
390
391
392
393
394
 */
void task_print_mask(unsigned int mask) {

  printf("task_print_mask: The tasks to run are [");
  for (int k = 1; k < task_type_count; k++)
    printf(" %s=%s", taskID_names[k], (mask & (1 << k)) ? "yes" : "no");
  printf(" ]\n");
}

/**
 * @brief Prints the list of subtasks contained in a given submask
 *
395
 * @param submask The submask to analyse
396
397
398
399
400
401
402
403
 */
void task_print_submask(unsigned int submask) {

  printf("task_print_submask: The subtasks to run are [");
  for (int k = 1; k < task_subtype_count; k++)
    printf(" %s=%s", subtaskID_names[k], (submask & (1 << k)) ? "yes" : "no");
  printf(" ]\n");
}