task.c 38.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 "engine.h"
46
#include "error.h"
47
#include "inline.h"
48
#include "lock.h"
49
50

/* Task type names. */
51
52
53
54
55
56
57
58
59
60
61
62
63
const char *taskID_names[task_type_count] = {"none",
                                             "sort",
                                             "self",
                                             "pair",
                                             "sub_self",
                                             "sub_pair",
                                             "init_grav",
                                             "init_grav_out",
                                             "ghost_in",
                                             "ghost",
                                             "ghost_out",
                                             "extra_ghost",
                                             "drift_part",
64
                                             "drift_spart",
65
                                             "drift_bpart",
66
67
                                             "drift_gpart",
                                             "drift_gpart_out",
68
                                             "end_hydro_force",
69
70
71
                                             "kick1",
                                             "kick2",
                                             "timestep",
72
                                             "timestep_limiter",
73
74
75
76
77
78
79
                                             "send",
                                             "recv",
                                             "grav_long_range",
                                             "grav_mm",
                                             "grav_down_in",
                                             "grav_down",
                                             "grav_mesh",
80
                                             "grav_end_force",
81
82
                                             "cooling",
                                             "star_formation",
83
84
                                             "star_formation_in",
                                             "star_formation_out",
85
                                             "logger",
86
87
                                             "stars_in",
                                             "stars_out",
88
89
                                             "stars_ghost_in",
                                             "stars_ghost",
James Willis's avatar
James Willis committed
90
                                             "stars_ghost_out",
91
                                             "stars_sort",
92
                                             "stars_resort",
93
94
                                             "bh_in",
                                             "bh_out",
95
96
97
                                             "bh_density_ghost",
                                             "bh_swallow_ghost1",
                                             "bh_swallow_ghost2",
98
                                             "bh_swallow_ghost3",
99
                                             "fof_self",
James Willis's avatar
James Willis committed
100
                                             "fof_pair"};
101

102
/* Sub-task type names. */
103
const char *subtaskID_names[task_subtype_count] = {
104
105
106
107
108
109
110
111
    "none",       "density",      "gradient",       "force",
    "limiter",    "grav",         "external_grav",  "tend_part",
    "tend_gpart", "tend_spart",   "tend_bpart",     "xv",
    "rho",        "part_swallow", "bpart_merger",   "gpart",
    "multipole",  "spart",        "stars_density",  "stars_feedback",
    "sf_count",   "bpart_rho",    "bpart_swallow",  "bpart_feedback",
    "bh_density", "bh_swallow",   "do_gas_swallow", "do_bh_swallow",
    "bh_feedback"};
112

113
114
115
116
117
#ifdef WITH_MPI
/* MPI communicators for the subtypes. */
MPI_Comm subtaskMPI_comms[task_subtype_count];
#endif

118
119
/**
 * @brief Computes the overlap between the parts array of two given cells.
120
 *
Matthieu Schaller's avatar
Matthieu Schaller committed
121
122
123
 * @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.
124
 */
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
#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;                                                               \
  }
142

143
TASK_CELL_OVERLAP(part, hydro.parts, hydro.count);
144
145
TASK_CELL_OVERLAP(gpart, grav.parts, grav.count);
TASK_CELL_OVERLAP(spart, stars.parts, stars.count);
146
TASK_CELL_OVERLAP(bpart, black_holes.parts, black_holes.count);
Loic Hausammann's avatar
Loic Hausammann committed
147

148
149
150
151
152
/**
 * @brief Returns the #task_actions for a given task.
 *
 * @param t The #task.
 */
153
154
__attribute__((always_inline)) INLINE static enum task_actions task_acts_on(
    const struct task *t) {
155
156
157
158
159
160
161

  switch (t->type) {

    case task_type_none:
      return task_action_none;
      break;

162
    case task_type_drift_part:
163
164
    case task_type_sort:
    case task_type_ghost:
165
    case task_type_extra_ghost:
166
    case task_type_timestep_limiter:
Stefan Arridge's avatar
Stefan Arridge committed
167
    case task_type_cooling:
168
    case task_type_end_hydro_force:
169
170
171
      return task_action_part;
      break;

172
173
174
    case task_type_star_formation:
      return task_action_all;

175
    case task_type_drift_spart:
176
    case task_type_stars_ghost:
Loic Hausammann's avatar
Loic Hausammann committed
177
    case task_type_stars_sort:
178
    case task_type_stars_resort:
Loic Hausammann's avatar
Loic Hausammann committed
179
180
181
      return task_action_spart;
      break;

182
    case task_type_drift_bpart:
183
    case task_type_bh_density_ghost:
184
    case task_type_bh_swallow_ghost3:
185
186
187
      return task_action_bpart;
      break;

188
189
190
191
192
193
194
    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:
195
        case task_subtype_gradient:
196
        case task_subtype_force:
197
        case task_subtype_limiter:
198
199
200
          return task_action_part;
          break;

201
        case task_subtype_stars_density:
Alexei Borissov's avatar
Alexei Borissov committed
202
        case task_subtype_stars_feedback:
203
204
          return task_action_all;
          break;
205

206
207
        case task_subtype_bh_density:
        case task_subtype_bh_feedback:
208
        case task_subtype_bh_swallow:
209
        case task_subtype_do_gas_swallow:
210
211
212
          return task_action_all;
          break;

213
214
215
216
        case task_subtype_do_bh_swallow:
          return task_action_bpart;
          break;

217
        case task_subtype_grav:
218
        case task_subtype_external_grav:
219
220
221
222
          return task_action_gpart;
          break;

        default:
223
224
225
226
#ifdef SWIFT_DEBUG_CHECKS
          error("Unknown task_action for task %s/%s", taskID_names[t->type],
                subtaskID_names[t->subtype]);
#endif
227
228
229
230
231
          return task_action_none;
          break;
      }
      break;

232
233
    case task_type_kick1:
    case task_type_kick2:
Loikki's avatar
Loikki committed
234
    case task_type_logger:
James Willis's avatar
James Willis committed
235
236
    case task_type_fof_self:
    case task_type_fof_pair:
237
    case task_type_timestep:
238
239
    case task_type_send:
    case task_type_recv:
240
      if (t->ci->hydro.count > 0 && t->ci->grav.count > 0)
241
        return task_action_all;
242
      else if (t->ci->hydro.count > 0)
243
        return task_action_part;
244
      else if (t->ci->grav.count > 0)
245
        return task_action_gpart;
246
247
      else {
#ifdef SWIFT_DEBUG_CHECKS
248
        error("Task without particles");
249
250
#endif
      }
251
252
      break;

253
    case task_type_init_grav:
254
    case task_type_grav_mm:
255
    case task_type_grav_long_range:
256
257
258
      return task_action_multipole;
      break;

259
    case task_type_drift_gpart:
260
    case task_type_grav_down:
261
    case task_type_end_grav_force:
262
    case task_type_grav_mesh:
263
      return task_action_gpart;
264
      break;
265

266
    default:
267
268
269
270
#ifdef SWIFT_DEBUG_CHECKS
      error("Unknown task_action for task %s/%s", taskID_names[t->type],
            subtaskID_names[t->subtype]);
#endif
271
272
273
      return task_action_none;
      break;
  }
274

275
276
277
278
279
#ifdef SWIFT_DEBUG_CHECKS
  error("Unknown task_action for task %s/%s", taskID_names[t->type],
        subtaskID_names[t->subtype]);
#endif
  /* Silence compiler warnings. We should never get here. */
280
  return task_action_none;
281
282
}

283
284
285
286
287
288
289
/**
 * @brief Compute the Jaccard similarity of the data used by two
 *        different tasks.
 *
 * @param ta The first #task.
 * @param tb The second #task.
 */
290
291
float task_overlap(const struct task *restrict ta,
                   const struct task *restrict tb) {
292
293
294
295
296
297

  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);

298
299
  /* First check if any of the two tasks are of a type that don't
     use cells. */
300
301
302
303
304
  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);
305
306
  const int ta_spart =
      (ta_act == task_action_spart || ta_act == task_action_all);
307
308
  const int ta_bpart =
      (ta_act == task_action_bpart || ta_act == task_action_all);
309
310
311
  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);
312
313
  const int tb_spart =
      (tb_act == task_action_spart || tb_act == task_action_all);
314
315
  const int tb_bpart =
      (tb_act == task_action_bpart || tb_act == task_action_all);
316
317
318
319
320
321

  /* 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;
322
323
324
325
    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;
326

327
    if (size_union == 0) return 0.f;
328

329
330
331
332
333
334
335
336
337
338
339
340
341
342
    /* 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;
343
344
345
346
    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;
347

348
349
    if (size_union == 0) return 0.f;

350
351
352
353
354
355
356
357
    /* 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);
  }
358

Loic Hausammann's avatar
Loic Hausammann committed
359
360
361
362
363
  /* 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;
364
365
366
367
    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
368

369
    if (size_union == 0) return 0.f;
Loic Hausammann's avatar
Loic Hausammann committed
370

Loic Hausammann's avatar
Loic Hausammann committed
371
372
373
374
375
376
377
378
379
    /* 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);
  }

380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
  /* In the case where both tasks act on bparts */
  else if (ta_bpart && tb_bpart) {

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

    if (size_union == 0) return 0.f;

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

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

401
402
  /* Else, no overlap */
  return 0.f;
403
}
404

405
406
/**
 * @brief Unlock the cell held by this task.
407
 *
408
409
 * @param t The #task.
 */
410
411
void task_unlock(struct task *t) {

412
413
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
414
415
  struct cell *ci = t->ci, *cj = t->cj;

416
  /* Act based on task type. */
417
418
  switch (type) {

419
420
    case task_type_kick1:
    case task_type_kick2:
421
    case task_type_logger:
422
    case task_type_timestep:
423
424
425
      cell_unlocktree(ci);
      cell_gunlocktree(ci);
      break;
Matthieu Schaller's avatar
Matthieu Schaller committed
426

427
    case task_type_drift_part:
428
    case task_type_sort:
429
    case task_type_ghost:
430
    case task_type_extra_ghost:
431
    case task_type_end_hydro_force:
432
    case task_type_timestep_limiter:
433
434
435
      cell_unlocktree(ci);
      break;

436
    case task_type_drift_gpart:
437
    case task_type_grav_mesh:
438
    case task_type_end_grav_force:
439
440
441
      cell_gunlocktree(ci);
      break;

Loic Hausammann's avatar
Loic Hausammann committed
442
    case task_type_stars_sort:
443
    case task_type_stars_resort:
Loic Hausammann's avatar
Loic Hausammann committed
444
445
446
      cell_sunlocktree(ci);
      break;

447
    case task_type_self:
448
    case task_type_sub_self:
449
450
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
451
        cell_munlocktree(ci);
452
453
      } else if ((subtype == task_subtype_stars_density) ||
                 (subtype == task_subtype_stars_feedback)) {
Alexei Borissov's avatar
Alexei Borissov committed
454
455
        cell_sunlocktree(ci);
        cell_unlocktree(ci);
456
457
458
      } else if ((subtype == task_subtype_bh_density) ||
                 (subtype == task_subtype_bh_feedback) ||
                 (subtype == task_subtype_bh_swallow) ||
459
                 (subtype == task_subtype_do_gas_swallow)) {
460
461
        cell_bunlocktree(ci);
        cell_unlocktree(ci);
462
463
      } else if (subtype == task_subtype_do_bh_swallow) {
        cell_bunlocktree(ci);
464
465
466
      } else {
        cell_unlocktree(ci);
      }
467
      break;
468

469
    case task_type_pair:
470
    case task_type_sub_pair:
471
472
473
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        cell_gunlocktree(cj);
474
475
        cell_munlocktree(ci);
        cell_munlocktree(cj);
476
477
      } else if ((subtype == task_subtype_stars_density) ||
                 (subtype == task_subtype_stars_feedback)) {
Alexei Borissov's avatar
Alexei Borissov committed
478
479
480
481
        cell_sunlocktree(ci);
        cell_sunlocktree(cj);
        cell_unlocktree(ci);
        cell_unlocktree(cj);
482
483
484
      } else if ((subtype == task_subtype_bh_density) ||
                 (subtype == task_subtype_bh_feedback) ||
                 (subtype == task_subtype_bh_swallow) ||
485
                 (subtype == task_subtype_do_gas_swallow)) {
486
487
488
489
        cell_bunlocktree(ci);
        cell_bunlocktree(cj);
        cell_unlocktree(ci);
        cell_unlocktree(cj);
490
491
492
      } else if (subtype == task_subtype_do_bh_swallow) {
        cell_bunlocktree(ci);
        cell_bunlocktree(cj);
493
494
495
496
497
498
      } else {
        cell_unlocktree(ci);
        cell_unlocktree(cj);
      }
      break;

499
    case task_type_grav_down:
500
      cell_gunlocktree(ci);
501
502
503
      cell_munlocktree(ci);
      break;

504
    case task_type_grav_long_range:
505
      cell_munlocktree(ci);
506
      break;
507

508
509
510
511
512
    case task_type_grav_mm:
      cell_munlocktree(ci);
      cell_munlocktree(cj);
      break;

513
514
515
516
    case task_type_star_formation:
      cell_unlocktree(ci);
      cell_sunlocktree(ci);
      cell_gunlocktree(ci);
517
      break;
518

519
520
521
522
    default:
      break;
  }
}
523
524
525
526
527
528

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

531
532
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
533
  struct cell *ci = t->ci, *cj = t->cj;
534
535
536
537
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
538

539
  switch (type) {
540

541
542
543
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
544
#ifdef WITH_MPI
545
546
547
548
549
      /* 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);
550
551
552
553
        error(
            "Failed to test request on send/recv task (type=%s/%s tag=%lld, "
            "%s).",
            taskID_names[t->type], subtaskID_names[t->subtype], t->flags, buff);
554
555
      }
      return res;
556
#else
557
      error("SWIFT was not compiled with MPI support.");
558
#endif
559
      break;
560

561
562
    case task_type_kick1:
    case task_type_kick2:
Loikki's avatar
Loikki committed
563
    case task_type_logger:
564
    case task_type_timestep:
565
      if (ci->hydro.hold || ci->grav.phold) return 0;
566
567
      if (cell_locktree(ci) != 0) return 0;
      if (cell_glocktree(ci) != 0) {
Matthieu Schaller's avatar
Matthieu Schaller committed
568
569
        cell_unlocktree(ci);
        return 0;
570
571
572
      }
      break;

573
    case task_type_drift_part:
574
    case task_type_sort:
575
    case task_type_ghost:
576
    case task_type_extra_ghost:
577
    case task_type_end_hydro_force:
578
    case task_type_timestep_limiter:
579
      if (ci->hydro.hold) return 0;
580
581
      if (cell_locktree(ci) != 0) return 0;
      break;
582

Loic Hausammann's avatar
Loic Hausammann committed
583
    case task_type_stars_sort:
584
    case task_type_stars_resort:
Loic Hausammann's avatar
Loic Hausammann committed
585
586
587
588
      if (ci->stars.hold) return 0;
      if (cell_slocktree(ci) != 0) return 0;
      break;

589
    case task_type_drift_gpart:
590
    case task_type_end_grav_force:
591
    case task_type_grav_mesh:
592
      if (ci->grav.phold) return 0;
593
594
595
      if (cell_glocktree(ci) != 0) return 0;
      break;

596
    case task_type_self:
597
    case task_type_sub_self:
598
      if (subtype == task_subtype_grav) {
599
        /* Lock the gparts and the m-pole */
600
        if (ci->grav.phold || ci->grav.mhold) return 0;
601
602
603
604
605
606
        if (cell_glocktree(ci) != 0)
          return 0;
        else if (cell_mlocktree(ci) != 0) {
          cell_gunlocktree(ci);
          return 0;
        }
607
608
      } else if ((subtype == task_subtype_stars_density) ||
                 (subtype == task_subtype_stars_feedback)) {
Alexei Borissov's avatar
Alexei Borissov committed
609
610
611
612
613
614
615
        if (ci->stars.hold) return 0;
        if (ci->hydro.hold) return 0;
        if (cell_slocktree(ci) != 0) return 0;
        if (cell_locktree(ci) != 0) {
          cell_sunlocktree(ci);
          return 0;
        }
616
617
618
      } else if ((subtype == task_subtype_bh_density) ||
                 (subtype == task_subtype_bh_feedback) ||
                 (subtype == task_subtype_bh_swallow) ||
619
                 (subtype == task_subtype_do_gas_swallow)) {
620
621
622
623
624
625
626
        if (ci->black_holes.hold) return 0;
        if (ci->hydro.hold) return 0;
        if (cell_blocktree(ci) != 0) return 0;
        if (cell_locktree(ci) != 0) {
          cell_bunlocktree(ci);
          return 0;
        }
627
628
629
      } else if (subtype == task_subtype_do_bh_swallow) {
        if (ci->black_holes.hold) return 0;
        if (cell_blocktree(ci) != 0) return 0;
Alexei Borissov's avatar
Alexei Borissov committed
630
      } else { /* subtype == hydro */
Loic Hausammann's avatar
Loic Hausammann committed
631
        if (ci->hydro.hold) return 0;
632
633
634
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
635

636
    case task_type_pair:
637
    case task_type_sub_pair:
638
      if (subtype == task_subtype_grav) {
639
        /* Lock the gparts and the m-pole in both cells */
640
        if (ci->grav.phold || cj->grav.phold) return 0;
641
642
643
644
        if (cell_glocktree(ci) != 0) return 0;
        if (cell_glocktree(cj) != 0) {
          cell_gunlocktree(ci);
          return 0;
645
646
647
648
649
650
651
652
653
        } 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;
654
        }
655
656
      } else if ((subtype == task_subtype_stars_density) ||
                 (subtype == task_subtype_stars_feedback)) {
Alexei Borissov's avatar
Alexei Borissov committed
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
        /* Lock the stars and the gas particles in both cells */
        if (ci->stars.hold || cj->stars.hold) return 0;
        if (ci->hydro.hold || cj->hydro.hold) return 0;
        if (cell_slocktree(ci) != 0) return 0;
        if (cell_slocktree(cj) != 0) {
          cell_sunlocktree(ci);
          return 0;
        }
        if (cell_locktree(ci) != 0) {
          cell_sunlocktree(ci);
          cell_sunlocktree(cj);
          return 0;
        }
        if (cell_locktree(cj) != 0) {
          cell_sunlocktree(ci);
          cell_sunlocktree(cj);
          cell_unlocktree(ci);
          return 0;
        }
676
677
678
      } else if ((subtype == task_subtype_bh_density) ||
                 (subtype == task_subtype_bh_feedback) ||
                 (subtype == task_subtype_bh_swallow) ||
679
                 (subtype == task_subtype_do_gas_swallow)) {
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
        /* Lock the BHs and the gas particles in both cells */
        if (ci->black_holes.hold || cj->black_holes.hold) return 0;
        if (ci->hydro.hold || cj->hydro.hold) return 0;
        if (cell_blocktree(ci) != 0) return 0;
        if (cell_blocktree(cj) != 0) {
          cell_bunlocktree(ci);
          return 0;
        }
        if (cell_locktree(ci) != 0) {
          cell_bunlocktree(ci);
          cell_bunlocktree(cj);
          return 0;
        }
        if (cell_locktree(cj) != 0) {
          cell_bunlocktree(ci);
          cell_bunlocktree(cj);
          cell_unlocktree(ci);
          return 0;
        }
699
700
701
702
703
704
705
      } else if (subtype == task_subtype_do_bh_swallow) {
        if (ci->black_holes.hold || cj->black_holes.hold) return 0;
        if (cell_blocktree(ci) != 0) return 0;
        if (cell_blocktree(cj) != 0) {
          cell_bunlocktree(ci);
          return 0;
        }
Alexei Borissov's avatar
Alexei Borissov committed
706
      } else { /* subtype == hydro */
707
        /* Lock the parts in both cells */
708
        if (ci->hydro.hold || cj->hydro.hold) return 0;
709
710
711
712
713
714
715
        if (cell_locktree(ci) != 0) return 0;
        if (cell_locktree(cj) != 0) {
          cell_unlocktree(ci);
          return 0;
        }
      }
      break;
716

717
718
    case task_type_grav_down:
      /* Lock the gparts and the m-poles */
719
      if (ci->grav.phold || ci->grav.mhold) return 0;
720
721
722
723
724
725
726
727
      if (cell_glocktree(ci) != 0)
        return 0;
      else if (cell_mlocktree(ci) != 0) {
        cell_gunlocktree(ci);
        return 0;
      }
      break;

728
    case task_type_grav_long_range:
729
      /* Lock the m-poles */
730
      if (ci->grav.mhold) return 0;
731
      if (cell_mlocktree(ci) != 0) return 0;
Matthieu Schaller's avatar
Matthieu Schaller committed
732
733
      break;

734
735
    case task_type_grav_mm:
      /* Lock both m-poles */
736
      if (ci->grav.mhold || cj->grav.mhold) return 0;
737
738
739
740
741
      if (cell_mlocktree(ci) != 0) return 0;
      if (cell_mlocktree(cj) != 0) {
        cell_munlocktree(ci);
        return 0;
      }
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
      break;

    case task_type_star_formation:
      /* Lock the gas, gravity and star particles */
      if (ci->hydro.hold || ci->stars.hold || ci->grav.phold) return 0;
      if (cell_locktree(ci) != 0) return 0;
      if (cell_slocktree(ci) != 0) {
        cell_unlocktree(ci);
        return 0;
      }
      if (cell_glocktree(ci) != 0) {
        cell_unlocktree(ci);
        cell_sunlocktree(ci);
        return 0;
      }
757

758
759
    default:
      break;
760
761
762
763
764
  }

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

766
767
768
769
770
771
772
773
774
775
776
/**
 * @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);
}
777

778
779
780
781
782
783
/**
 * @brief Get the group name of a task.
 *
 * This is used to group tasks with similar actions in the task dependency
 * graph.
 *
784
 * @param type The #task type.
785
 * @param subtype The #task subtype.
786
 * @param cluster (return) The group name (should be allocated)
787
 */
788
void task_get_group_name(int type, int subtype, char *cluster) {
789

790
791
  if (type == task_type_grav_long_range || type == task_type_grav_mm ||
      type == task_type_grav_mesh) {
792
793
794
795
796

    strcpy(cluster, "Gravity");
    return;
  }

797
  switch (subtype) {
798
799
800
801
    case task_subtype_density:
      strcpy(cluster, "Density");
      break;
    case task_subtype_gradient:
802
      if (type == task_type_send || type == task_type_recv) {
803
804
805
        strcpy(cluster, "None");
      } else {
        strcpy(cluster, "Gradient");
806
      }
807
808
809
810
811
812
813
      break;
    case task_subtype_force:
      strcpy(cluster, "Force");
      break;
    case task_subtype_grav:
      strcpy(cluster, "Gravity");
      break;
814
815
816
    case task_subtype_limiter:
      strcpy(cluster, "Timestep_limiter");
      break;
817
    case task_subtype_stars_density:
818
819
820
821
      strcpy(cluster, "StarsDensity");
      break;
    case task_subtype_stars_feedback:
      strcpy(cluster, "StarsFeedback");
822
      break;
823
824
825
    case task_subtype_bh_density:
      strcpy(cluster, "BHDensity");
      break;
826
827
828
    case task_subtype_bh_swallow:
      strcpy(cluster, "BHSwallow");
      break;
829
830
831
832
833
    case task_subtype_do_gas_swallow:
      strcpy(cluster, "DoGasSwallow");
      break;
    case task_subtype_do_bh_swallow:
      strcpy(cluster, "DoBHSwallow");
834
      break;
835
836
837
    case task_subtype_bh_feedback:
      strcpy(cluster, "BHFeedback");
      break;
838
839
840
841
842
843
844
845
846
847
848
849
850
    default:
      strcpy(cluster, "None");
      break;
  }
}

/**
 * @brief Generate the full name of a #task.
 *
 * @param type The #task type.
 * @param subtype The #task type.
 * @param name (return) The formatted string
 */
851
void task_get_full_name(int type, int subtype, char *name) {
852
853
854

#ifdef SWIFT_DEBUG_CHECKS
  /* Check input */
855
  if (type >= task_type_count) error("Unknown task type %i", type);
856

857
  if (subtype >= task_subtype_count)
858
859
860
861
862
863
864
865
866
867
    error("Unknown task subtype %i with type %s", subtype, taskID_names[type]);
#endif

  /* Full task name */
  if (subtype == task_subtype_none)
    sprintf(name, "%s", taskID_names[type]);
  else
    sprintf(name, "%s_%s", taskID_names[type], subtaskID_names[subtype]);
}

868
869
870
871
872
873
874
875
876
877
#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
878
879

/**
880
881
 * @brief dump all the tasks of all the known engines into a file for
 * postprocessing.
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 *
 * Dumps the information to a file "thread_info-stepn.dat" where n is the
 * given step value, or "thread_info_MPI-stepn.dat", if we are running
 * under MPI. Note if running under MPIU all the ranks are dumped into this
 * one file, which has an additional field to identify the rank.
 *
 * @param e the #engine
 * @param step the current step.
 */
void task_dump_all(struct engine *e, int step) {

#ifdef SWIFT_DEBUG_TASKS

  /* Need this to convert ticks to seconds. */
  unsigned long long cpufreq = clocks_get_cpufreq();

#ifdef WITH_MPI
  /* Make sure output file is empty, only on one rank. */
  char dumpfile[35];
  snprintf(dumpfile, sizeof(dumpfile), "thread_info_MPI-step%d.dat", step);
  FILE *file_thread;
  if (engine_rank == 0) {
    file_thread = fopen(dumpfile, "w");
    fclose(file_thread);
  }
  MPI_Barrier(MPI_COMM_WORLD);

  for (int i = 0; i < e->nr_nodes; i++) {

    /* Rank 0 decides the index of the writing node, this happens
     * one-by-one. */
    int kk = i;
    MPI_Bcast(&kk, 1, MPI_INT, 0, MPI_COMM_WORLD);

    if (i == engine_rank) {

      /* Open file and position at end. */
      file_thread = fopen(dumpfile, "a");

      /* Add some information to help with the plots and conversion of ticks to
       * seconds. */
      fprintf(file_thread, " %03d 0 0 0 0 %lld %lld %lld %lld %lld 0 0 %lld\n",
Josh Borrow's avatar
Josh Borrow committed
924
925
              engine_rank, (long long int)e->tic_step,
              (long long int)e->toc_step, e->updates, e->g_updates,
926
927
928
929
930
931
932
933
              e->s_updates, cpufreq);
      int count = 0;
      for (int l = 0; l < e->sched.nr_tasks; l++) {
        if (!e->sched.tasks[l].implicit && e->sched.tasks[l].toc != 0) {
          fprintf(
              file_thread, " %03i %i %i %i %i %lli %lli %i %i %i %i %lli %i\n",
              engine_rank, e->sched.tasks[l].rid, e->sched.tasks[l].type,
              e->sched.tasks[l].subtype, (e->sched.tasks[l].cj == NULL),
Josh Borrow's avatar
Josh Borrow committed
934
935
              (long long int)e->sched.tasks[l].tic,
              (long long int)e->sched.tasks[l].toc,
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
              (e->sched.tasks[l].ci != NULL) ? e->sched.tasks[l].ci->hydro.count
                                             : 0,
              (e->sched.tasks[l].cj != NULL) ? e->sched.tasks[l].cj->hydro.count
                                             : 0,
              (e->sched.tasks[l].ci != NULL) ? e->sched.tasks[l].ci->grav.count
                                             : 0,
              (e->sched.tasks[l].cj != NULL) ? e->sched.tasks[l].cj->grav.count
                                             : 0,
              e->sched.tasks[l].flags, e->sched.tasks[l].sid);
        }
        count++;
      }
      fclose(file_thread);
    }

    /* And we wait for all to synchronize. */
    MPI_Barrier(MPI_COMM_WORLD);
  }

#else
  /* Non-MPI, so just a single engine's worth of tasks to dump. */
  char dumpfile[32];
  snprintf(dumpfile, sizeof(dumpfile), "thread_info-step%d.dat", step);
  FILE *file_thread;
  file_thread = fopen(dumpfile, "w");

  /* Add some information to help with the plots and conversion of ticks to
   * seconds. */
  fprintf(file_thread, " %d %d %d %d %lld %lld %lld %lld %lld %d %lld\n", -2,
965
966
          -1, -1, 1, (unsigned long long)e->tic_step,
          (unsigned long long)e->toc_step, e->updates, e->g_updates,
967
968
969
970
971
972
973
          e->s_updates, 0, cpufreq);
  for (int l = 0; l < e->sched.nr_tasks; l++) {
    if (!e->sched.tasks[l].implicit && e->sched.tasks[l].toc != 0) {
      fprintf(
          file_thread, " %i %i %i %i %lli %lli %i %i %i %i %i\n",
          e->sched.tasks[l].rid, e->sched.tasks[l].type,
          e->sched.tasks[l].subtype, (e->sched.tasks[l].cj == NULL),
Josh Borrow's avatar
Josh Borrow committed
974
975
          (unsigned long long)e->sched.tasks[l].tic,
          (unsigned long long)e->sched.tasks[l].toc,
976
977
978
979
980
981
982
983
984
985
986
          (e->sched.tasks[l].ci == NULL) ? 0
                                         : e->sched.tasks[l].ci->hydro.count,
          (e->sched.tasks[l].cj == NULL) ? 0
                                         : e->sched.tasks[l].cj->hydro.count,
          (e->sched.tasks[l].ci == NULL) ? 0 : e->sched.tasks[l].ci->grav.count,
          (e->sched.tasks[l].cj == NULL) ? 0 : e->sched.tasks[l].cj->grav.count,
          e->sched.tasks[l].sid);
    }
  }
  fclose(file_thread);
#endif  // WITH_MPI
987
988
989
990
991
#endif  // SWIFT_DEBUG_TASKS
}

/**
 * @brief Generate simple statistics about the times used by the tasks of
992
993
994
 *        all the engines and write these into two format, a human readable
 *        version for debugging and one intented for inclusion as the fixed
 *        costs for repartitioning.
995
 *
996
997
998
 * Note that when running under MPI all the tasks can be summed into this single
 * file. In the fuller, human readable file, the statistics included are the
 * number of task of each type/subtype followed by the minimum, maximum, mean
999
1000
 * and total time taken and the same numbers for the start of the task,
 * in millisec and then the fixed costs value.
1001
 *
1002
1003
1004
 * If header is set, only the fixed costs value is written into the output
 * file in a format that is suitable for inclusion in SWIFT (as
 * partition_fixed_costs.h).
1005
 *
1006
 * @param dumpfile name of the file for the output.
1007
 * @param e the #engine
1008
1009
1010
 * @param header whether to write a header include file.
 * @param allranks do the statistics over all ranks, if not just the current
 *                 one, only used if header is false.
1011
 */
Peter W. Draper's avatar
Peter W. Draper committed
1012
1013
void task_dump_stats(const char *dumpfile, struct engine *e, int header,
                     int allranks) {
1014
1015
1016

  /* Need arrays for sum, min and max across all types and subtypes. */
  double sum[task_type_count][task_subtype_count];
1017
  double tsum[task_type_count][task_subtype_count];
1018
  double min[task_type_count][task_subtype_count];
1019
  double tmin[task_type_count][task_subtype_count];
1020
  double max[task_type_count][task_subtype_count];
1021
  double tmax[task_type_count][task_subtype_count];
1022
1023
1024
1025
1026
  int count[task_type_count][task_subtype_count];

  for (int j = 0; j < task_type_count; j++) {
    for (int k = 0; k < task_subtype_count; k++) {
      sum[j][k] = 0.0;
1027
      tsum[j][k] = 0.0;
1028
1029
      count[j][k] = 0;
      min[j][k] = DBL_MAX;
1030
      tmin[j][k] = DBL_MAX;
1031
      max[j][k] = 0.0;
1032
      tmax[j][k] = 0.0;
1033
1034
1035
1036
1037
1038
1039
    }
  }

  double total[1] = {0.0};
  for (int l = 0; l < e->sched.nr_tasks; l++) {
    int type = e->sched.tasks[l].type;

1040
1041
    /* Skip implicit tasks, tasks that didn't run. */
    if (!e->sched.tasks[l].implicit && e->sched.tasks[l].toc != 0) {
1042
1043
1044
1045
      int subtype = e->sched.tasks[l].subtype;

      double dt = e->sched.tasks[l].toc - e->sched.tasks[l].tic;
      sum[type][subtype] += dt;
1046
1047
1048

      double tic = (double)e->sched.tasks[l].tic;
      tsum[type][subtype] += tic;
1049
1050
1051
1052
      count[type][subtype] += 1;
      if (dt < min[type][subtype]) {
        min[type][subtype] = dt;
      }
1053
1054
1055
      if (tic < tmin[type][subtype]) {
        tmin[type][subtype] = tic;
      }
1056
1057
1058
      if (dt > max[type][subtype]) {
        max[type][subtype] = dt;
      }
1059
1060
      if (tic > tmax[type][subtype]) {
        tmax[type][subtype] = tic;
1061
1062
1063
1064
1065
      }
      total[0] += dt;
    }
  }

1066
1067
1068
1069
1070
1071
1072
1073
1074
#ifdef WITH_MPI
  if (allranks || header) {
    /* Get these from all ranks for output from rank 0. Could wrap these into a
     * single operation. */
    size_t size = task_type_count * task_subtype_count;
    int res = MPI_Reduce((engine_rank == 0 ? MPI_IN_PLACE : sum), sum, size,
                         MPI_DOUBLE, MPI_SUM, 0, MPI_COMM_WORLD);
    if (res != MPI_SUCCESS) mpi_error(res, "Failed to reduce task sums");

1075
1076
1077
1078
    res = MPI_Reduce((engine_rank == 0 ? MPI_IN_PLACE : tsum), tsum, size,
                     MPI_DOUBLE, MPI_SUM, 0, MPI_COMM_WORLD);
    if (res != MPI_SUCCESS) mpi_error(res, "Failed to reduce task tsums");

1079
1080
1081
1082
1083
1084
1085
1086
    res = MPI_Reduce((engine_rank == 0 ? MPI_IN_PLACE : count), count, size,
                     MPI_INT, MPI_SUM, 0, MPI_COMM_WORLD);
    if (res != MPI_SUCCESS) mpi_error(res, "Failed to reduce task counts");

    res = MPI_Reduce((engine_rank == 0 ? MPI_IN_PLACE : min), min, size,
                     MPI_DOUBLE, MPI_MIN, 0, MPI_COMM_WORLD);
    if (res != MPI_SUCCESS) mpi_error(res, "Failed to reduce task minima");

1087
1088
1089
1090
    res = MPI_Reduce((engine_rank == 0 ? MPI_IN_PLACE : tmin), tmin, size,
                     MPI_DOUBLE, MPI_MIN, 0, MPI_COMM_WORLD);
    if (res != MPI_SUCCESS) mpi_error(res, "Failed to reduce task minima");

1091
1092
1093
1094
    res = MPI_Reduce((engine_rank == 0 ? MPI_IN_PLACE : max), max, size,
                     MPI_DOUBLE, MPI_MAX, 0, MPI_COMM_WORLD);
    if (res != MPI_SUCCESS) mpi_error(res, "Failed to reduce task maxima");