task.c 15.5 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 "inline.h"
47
#include "lock.h"
48
49

/* Task type names. */
50
const char *taskID_names[task_type_count] = {
Matthieu Schaller's avatar
Matthieu Schaller committed
51
52
53
54
55
56
57
58
59
60
61
    "none",           "sort",           "self",
    "pair",           "sub_self",       "sub_pair",
    "init_grav",      "init_grav_out",  "ghost_in",
    "ghost",          "ghost_out",      "extra_ghost",
    "drift_part",     "drift_gpart",    "end_force",
    "kick1",          "kick2",          "timestep",
    "send",           "recv",           "grav_long_range",
    "grav_mm",        "grav_down_in",   "grav_down",
    "grav_mesh",      "cooling",        "star_formation",
    "sourceterms",    "stars_ghost_in", "stars_ghost",
    "stars_ghost_out"};
62

63
/* Sub-task type names. */
64
const char *subtaskID_names[task_subtype_count] = {
65
66
67
    "none",          "density", "gradient",     "force", "grav",
    "external_grav", "tend",    "xv",           "rho",   "gpart",
    "multipole",     "spart",   "stars_density"};
68

69
70
71
72
73
#ifdef WITH_MPI
/* MPI communicators for the subtypes. */
MPI_Comm subtaskMPI_comms[task_subtype_count];
#endif

74
75
/**
 * @brief Computes the overlap between the parts array of two given cells.
76
 *
Matthieu Schaller's avatar
Matthieu Schaller committed
77
78
79
 * @param TYPE is the type of parts (e.g. #part, #gpart, #spart)
 * @param ARRAY is the array of this specific type.
 * @param COUNT is the number of elements in the array.
80
 */
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
#define TASK_CELL_OVERLAP(TYPE, ARRAY, COUNT)                               \
  __attribute__((always_inline))                                            \
      INLINE static size_t task_cell_overlap_##TYPE(                        \
          const struct cell *restrict ci, const struct cell *restrict cj) { \
                                                                            \
    if (ci == NULL || cj == NULL) return 0;                                 \
                                                                            \
    if (ci->ARRAY <= cj->ARRAY &&                                           \
        ci->ARRAY + ci->COUNT >= cj->ARRAY + cj->COUNT) {                   \
      return cj->COUNT;                                                     \
    } else if (cj->ARRAY <= ci->ARRAY &&                                    \
               cj->ARRAY + cj->COUNT >= ci->ARRAY + ci->COUNT) {            \
      return ci->COUNT;                                                     \
    }                                                                       \
                                                                            \
    return 0;                                                               \
  }
98

99
TASK_CELL_OVERLAP(part, hydro.parts, hydro.count);
100
101
TASK_CELL_OVERLAP(gpart, grav.parts, grav.count);
TASK_CELL_OVERLAP(spart, stars.parts, stars.count);
Loic Hausammann's avatar
Loic Hausammann committed
102

103
104
105
106
107
/**
 * @brief Returns the #task_actions for a given task.
 *
 * @param t The #task.
 */
108
109
__attribute__((always_inline)) INLINE static enum task_actions task_acts_on(
    const struct task *t) {
110
111
112
113
114
115
116

  switch (t->type) {

    case task_type_none:
      return task_action_none;
      break;

117
    case task_type_drift_part:
118
119
    case task_type_sort:
    case task_type_ghost:
120
    case task_type_extra_ghost:
Stefan Arridge's avatar
Stefan Arridge committed
121
    case task_type_cooling:
122
    case task_type_sourceterms:
123
124
125
      return task_action_part;
      break;

126
127
128
    case task_type_star_formation:
      return task_action_all;

129
    case task_type_stars_ghost:
Loic Hausammann's avatar
Loic Hausammann committed
130
131
132
      return task_action_spart;
      break;

133
134
135
136
137
138
139
    case task_type_self:
    case task_type_pair:
    case task_type_sub_self:
    case task_type_sub_pair:
      switch (t->subtype) {

        case task_subtype_density:
140
        case task_subtype_gradient:
141
142
143
144
        case task_subtype_force:
          return task_action_part;
          break;

145
        case task_subtype_stars_density:
146
147
          return task_action_all;
          break;
148

149
        case task_subtype_grav:
150
        case task_subtype_external_grav:
151
152
153
154
155
156
157
158
159
160
          return task_action_gpart;
          break;

        default:
          error("Unknow task_action for task");
          return task_action_none;
          break;
      }
      break;

161
    case task_type_end_force:
162
163
    case task_type_kick1:
    case task_type_kick2:
164
    case task_type_timestep:
165
166
    case task_type_send:
    case task_type_recv:
167
      if (t->ci->hydro.count > 0 && t->ci->grav.count > 0)
168
        return task_action_all;
169
      else if (t->ci->hydro.count > 0)
170
        return task_action_part;
171
      else if (t->ci->grav.count > 0)
172
173
174
        return task_action_gpart;
      else
        error("Task without particles");
175
176
      break;

177
    case task_type_init_grav:
178
    case task_type_grav_mm:
179
    case task_type_grav_long_range:
180
181
182
      return task_action_multipole;
      break;

183
    case task_type_drift_gpart:
184
    case task_type_grav_down:
185
    case task_type_grav_mesh:
186
      return task_action_gpart;
187
      break;
188

189
    default:
190
      error("Unknown task_action for task");
191
192
193
      return task_action_none;
      break;
  }
194

195
  /* Silence compiler warnings */
196
197
  error("Unknown task_action for task");
  return task_action_none;
198
199
}

200
201
202
203
204
205
206
/**
 * @brief Compute the Jaccard similarity of the data used by two
 *        different tasks.
 *
 * @param ta The first #task.
 * @param tb The second #task.
 */
207
208
float task_overlap(const struct task *restrict ta,
                   const struct task *restrict tb) {
209
210
211
212
213
214

  if (ta == NULL || tb == NULL) return 0.f;

  const enum task_actions ta_act = task_acts_on(ta);
  const enum task_actions tb_act = task_acts_on(tb);

215
216
  /* First check if any of the two tasks are of a type that don't
     use cells. */
217
218
219
220
221
  if (ta_act == task_action_none || tb_act == task_action_none) return 0.f;

  const int ta_part = (ta_act == task_action_part || ta_act == task_action_all);
  const int ta_gpart =
      (ta_act == task_action_gpart || ta_act == task_action_all);
222
223
  const int ta_spart =
      (ta_act == task_action_spart || ta_act == task_action_all);
224
225
226
  const int tb_part = (tb_act == task_action_part || tb_act == task_action_all);
  const int tb_gpart =
      (tb_act == task_action_gpart || tb_act == task_action_all);
227
228
  const int tb_spart =
      (tb_act == task_action_spart || tb_act == task_action_all);
229
230
231
232
233
234

  /* In the case where both tasks act on parts */
  if (ta_part && tb_part) {

    /* Compute the union of the cell data. */
    size_t size_union = 0;
235
236
237
238
    if (ta->ci != NULL) size_union += ta->ci->hydro.count;
    if (ta->cj != NULL) size_union += ta->cj->hydro.count;
    if (tb->ci != NULL) size_union += tb->ci->hydro.count;
    if (tb->cj != NULL) size_union += tb->cj->hydro.count;
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253

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

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

  /* In the case where both tasks act on gparts */
  else if (ta_gpart && tb_gpart) {

    /* Compute the union of the cell data. */
    size_t size_union = 0;
254
255
256
257
    if (ta->ci != NULL) size_union += ta->ci->grav.count;
    if (ta->cj != NULL) size_union += ta->cj->grav.count;
    if (tb->ci != NULL) size_union += tb->ci->grav.count;
    if (tb->cj != NULL) size_union += tb->cj->grav.count;
258
259
260
261
262
263
264
265
266

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

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

Loic Hausammann's avatar
Loic Hausammann committed
268
269
270
271
272
  /* In the case where both tasks act on sparts */
  else if (ta_spart && tb_spart) {

    /* Compute the union of the cell data. */
    size_t size_union = 0;
273
274
275
276
    if (ta->ci != NULL) size_union += ta->ci->stars.count;
    if (ta->cj != NULL) size_union += ta->cj->stars.count;
    if (tb->ci != NULL) size_union += tb->ci->stars.count;
    if (tb->cj != NULL) size_union += tb->cj->stars.count;
Loic Hausammann's avatar
Loic Hausammann committed
277
278
279
280
281
282
283
284
285
286

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

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

287
288
  /* Else, no overlap */
  return 0.f;
289
}
290

291
292
/**
 * @brief Unlock the cell held by this task.
293
 *
294
295
 * @param t The #task.
 */
296
297
void task_unlock(struct task *t) {

298
299
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
300
301
  struct cell *ci = t->ci, *cj = t->cj;

302
  /* Act based on task type. */
303
304
  switch (type) {

305
    case task_type_end_force:
306
307
308
    case task_type_kick1:
    case task_type_kick2:
    case task_type_timestep:
309
310
311
      cell_unlocktree(ci);
      cell_gunlocktree(ci);
      break;
Matthieu Schaller's avatar
Matthieu Schaller committed
312

313
    case task_type_drift_part:
314
    case task_type_sort:
315
316
317
      cell_unlocktree(ci);
      break;

318
    case task_type_drift_gpart:
319
    case task_type_grav_mesh:
320
321
322
      cell_gunlocktree(ci);
      break;

323
    case task_type_self:
324
    case task_type_sub_self:
325
326
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
327
        cell_munlocktree(ci);
328
329
330
      } else {
        cell_unlocktree(ci);
      }
331
      break;
332

333
    case task_type_pair:
334
    case task_type_sub_pair:
335
336
337
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        cell_gunlocktree(cj);
338
339
        cell_munlocktree(ci);
        cell_munlocktree(cj);
340
341
342
343
344
345
      } else {
        cell_unlocktree(ci);
        cell_unlocktree(cj);
      }
      break;

346
    case task_type_grav_down:
347
      cell_gunlocktree(ci);
348
349
350
      cell_munlocktree(ci);
      break;

351
    case task_type_grav_long_range:
352
      cell_munlocktree(ci);
353
      break;
354

355
356
357
358
359
    case task_type_grav_mm:
      cell_munlocktree(ci);
      cell_munlocktree(cj);
      break;

360
361
362
363
    default:
      break;
  }
}
364
365
366
367
368
369

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

372
373
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
374
  struct cell *ci = t->ci, *cj = t->cj;
375
376
377
378
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
379

380
  switch (type) {
381

382
383
384
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
385
#ifdef WITH_MPI
386
387
388
389
390
      /* 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);
391
        error("Failed to test request on send/recv task (tag=%lld, %s).",
392
393
394
              t->flags, buff);
      }
      return res;
395
#else
396
      error("SWIFT was not compiled with MPI support.");
397
#endif
398
      break;
399

400
    case task_type_end_force:
401
402
403
    case task_type_kick1:
    case task_type_kick2:
    case task_type_timestep:
404
      if (ci->hydro.hold || ci->grav.phold) return 0;
405
406
      if (cell_locktree(ci) != 0) return 0;
      if (cell_glocktree(ci) != 0) {
Matthieu Schaller's avatar
Matthieu Schaller committed
407
408
        cell_unlocktree(ci);
        return 0;
409
410
411
      }
      break;

412
    case task_type_drift_part:
413
    case task_type_sort:
414
      if (ci->hydro.hold) return 0;
415
416
      if (cell_locktree(ci) != 0) return 0;
      break;
417

418
    case task_type_drift_gpart:
419
    case task_type_grav_mesh:
420
      if (ci->grav.phold) return 0;
421
422
423
      if (cell_glocktree(ci) != 0) return 0;
      break;

424
    case task_type_self:
425
    case task_type_sub_self:
426
      if (subtype == task_subtype_grav) {
427
        /* Lock the gparts and the m-pole */
428
        if (ci->grav.phold || ci->grav.mhold) return 0;
429
430
431
432
433
434
        if (cell_glocktree(ci) != 0)
          return 0;
        else if (cell_mlocktree(ci) != 0) {
          cell_gunlocktree(ci);
          return 0;
        }
435
436
437
438
      } else {
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
439

440
    case task_type_pair:
441
    case task_type_sub_pair:
442
      if (subtype == task_subtype_grav) {
443
        /* Lock the gparts and the m-pole in both cells */
444
        if (ci->grav.phold || cj->grav.phold) return 0;
445
446
447
448
        if (cell_glocktree(ci) != 0) return 0;
        if (cell_glocktree(cj) != 0) {
          cell_gunlocktree(ci);
          return 0;
449
450
451
452
453
454
455
456
457
        } else if (cell_mlocktree(ci) != 0) {
          cell_gunlocktree(ci);
          cell_gunlocktree(cj);
          return 0;
        } else if (cell_mlocktree(cj) != 0) {
          cell_gunlocktree(ci);
          cell_gunlocktree(cj);
          cell_munlocktree(ci);
          return 0;
458
459
        }
      } else {
460
        /* Lock the parts in both cells */
461
        if (ci->hydro.hold || cj->hydro.hold) return 0;
462
463
464
465
466
467
468
        if (cell_locktree(ci) != 0) return 0;
        if (cell_locktree(cj) != 0) {
          cell_unlocktree(ci);
          return 0;
        }
      }
      break;
469

470
471
    case task_type_grav_down:
      /* Lock the gparts and the m-poles */
472
      if (ci->grav.phold || ci->grav.mhold) return 0;
473
474
475
476
477
478
479
480
      if (cell_glocktree(ci) != 0)
        return 0;
      else if (cell_mlocktree(ci) != 0) {
        cell_gunlocktree(ci);
        return 0;
      }
      break;

481
    case task_type_grav_long_range:
482
      /* Lock the m-poles */
483
      if (ci->grav.mhold) return 0;
484
      if (cell_mlocktree(ci) != 0) return 0;
Matthieu Schaller's avatar
Matthieu Schaller committed
485
486
      break;

487
488
    case task_type_grav_mm:
      /* Lock both m-poles */
489
      if (ci->grav.mhold || cj->grav.mhold) return 0;
490
491
492
493
494
495
      if (cell_mlocktree(ci) != 0) return 0;
      if (cell_mlocktree(cj) != 0) {
        cell_munlocktree(ci);
        return 0;
      }

496
497
    default:
      break;
498
499
500
501
502
  }

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

504
505
506
507
508
509
510
511
512
513
514
/**
 * @brief Print basic information about a task.
 *
 * @param t The #task.
 */
void task_print(const struct task *t) {

  message("Type:'%s' sub_type:'%s' wait=%d nr_unlocks=%d skip=%d",
          taskID_names[t->type], subtaskID_names[t->subtype], t->wait,
          t->nr_unlock_tasks, t->skip);
}
515
516
517
518
519
520
521
522
523
524
525

#ifdef WITH_MPI
/**
 * @brief Create global communicators for each of the subtasks.
 */
void task_create_mpi_comms(void) {
  for (int i = 0; i < task_subtype_count; i++) {
    MPI_Comm_dup(MPI_COMM_WORLD, &subtaskMPI_comms[i]);
  }
}
#endif