task.c 42.1 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"
Peter W. Draper's avatar
Peter W. Draper committed
49
#include "mpiuse.h"
50
51

/* Task type names. */
52
53
54
55
56
57
58
59
60
61
62
63
64
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",
65
                                             "drift_spart",
66
                                             "drift_bpart",
67
68
                                             "drift_gpart",
                                             "drift_gpart_out",
69
                                             "end_hydro_force",
70
71
72
                                             "kick1",
                                             "kick2",
                                             "timestep",
73
                                             "timestep_limiter",
74
                                             "timestep_sync",
75
76
77
78
79
80
81
                                             "send",
                                             "recv",
                                             "grav_long_range",
                                             "grav_mm",
                                             "grav_down_in",
                                             "grav_down",
                                             "grav_mesh",
82
                                             "grav_end_force",
83
84
                                             "cooling",
                                             "star_formation",
85
86
                                             "star_formation_in",
                                             "star_formation_out",
87
                                             "logger",
88
89
                                             "stars_in",
                                             "stars_out",
90
91
                                             "stars_ghost_in",
                                             "stars_ghost",
James Willis's avatar
James Willis committed
92
                                             "stars_ghost_out",
93
                                             "stars_sort",
94
                                             "stars_resort",
95
96
                                             "bh_in",
                                             "bh_out",
97
98
99
                                             "bh_density_ghost",
                                             "bh_swallow_ghost1",
                                             "bh_swallow_ghost2",
100
                                             "bh_swallow_ghost3",
101
                                             "fof_self",
James Willis's avatar
James Willis committed
102
                                             "fof_pair"};
103

104
/* Sub-task type names. */
105
const char *subtaskID_names[task_subtype_count] = {
106
107
108
109
110
111
112
113
    "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"};
114

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

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

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

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

  switch (t->type) {

    case task_type_none:
      return task_action_none;
      break;

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

173
174
175
    case task_type_star_formation:
      return task_action_all;

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

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

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

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

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

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

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

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

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

256
    case task_type_init_grav:
257
    case task_type_grav_mm:
258
    case task_type_grav_long_range:
259
260
261
      return task_action_multipole;
      break;

262
    case task_type_drift_gpart:
263
    case task_type_grav_down:
264
    case task_type_end_grav_force:
265
    case task_type_grav_mesh:
266
      return task_action_gpart;
267
      break;
268

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

278
279
280
281
282
#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. */
283
  return task_action_none;
284
285
}

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

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

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

  /* 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;
325
326
327
328
    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;
329

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

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

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

353
354
355
356
357
358
359
360
    /* 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);
  }
361

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

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

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

383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
  /* 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);
  }

404
405
  /* Else, no overlap */
  return 0.f;
406
}
407

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

415
416
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
417
418
  struct cell *ci = t->ci, *cj = t->cj;

419
  /* Act based on task type. */
420
421
  switch (type) {

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

430
    case task_type_drift_part:
431
    case task_type_sort:
432
    case task_type_ghost:
433
    case task_type_extra_ghost:
434
    case task_type_end_hydro_force:
435
    case task_type_timestep_limiter:
436
    case task_type_timestep_sync:
437
438
439
      cell_unlocktree(ci);
      break;

440
    case task_type_drift_gpart:
441
    case task_type_grav_mesh:
442
    case task_type_end_grav_force:
443
444
445
      cell_gunlocktree(ci);
      break;

Loic Hausammann's avatar
Loic Hausammann committed
446
    case task_type_stars_sort:
447
    case task_type_stars_resort:
Loic Hausammann's avatar
Loic Hausammann committed
448
449
450
      cell_sunlocktree(ci);
      break;

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

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

503
    case task_type_grav_down:
504
      cell_gunlocktree(ci);
505
506
507
      cell_munlocktree(ci);
      break;

508
    case task_type_grav_long_range:
509
      cell_munlocktree(ci);
510
      break;
511

512
513
514
515
516
    case task_type_grav_mm:
      cell_munlocktree(ci);
      cell_munlocktree(cj);
      break;

517
518
519
520
    case task_type_star_formation:
      cell_unlocktree(ci);
      cell_sunlocktree(ci);
      cell_gunlocktree(ci);
521
      break;
522

523
524
525
526
    default:
      break;
  }
}
527
528
529
530
531
532

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

535
536
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
537
  struct cell *ci = t->ci, *cj = t->cj;
538
539
540
541
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
542

543
  switch (type) {
544

545
546
547
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
548
#ifdef WITH_MPI
549
550
551
552
553
      /* 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);
554
555
556
557
        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);
558
      }
Peter W. Draper's avatar
Peter W. Draper committed
559
560

      /* And log deactivation, if logging enabled. */
561
562
563
      if (res) {
        mpiuse_log_allocation(t->type, t->subtype, &t->req, 0, 0, 0, 0);
      }
Peter W. Draper's avatar
Peter W. Draper committed
564

565
      return res;
566
#else
567
      error("SWIFT was not compiled with MPI support.");
568
#endif
569
      break;
570

571
572
    case task_type_kick1:
    case task_type_kick2:
Loikki's avatar
Loikki committed
573
    case task_type_logger:
574
    case task_type_timestep:
575
      if (ci->hydro.hold || ci->grav.phold) return 0;
576
577
      if (cell_locktree(ci) != 0) return 0;
      if (cell_glocktree(ci) != 0) {
Matthieu Schaller's avatar
Matthieu Schaller committed
578
579
        cell_unlocktree(ci);
        return 0;
580
581
582
      }
      break;

583
    case task_type_drift_part:
584
    case task_type_sort:
585
    case task_type_ghost:
586
    case task_type_extra_ghost:
587
    case task_type_end_hydro_force:
588
    case task_type_timestep_limiter:
589
    case task_type_timestep_sync:
590
      if (ci->hydro.hold) return 0;
591
592
      if (cell_locktree(ci) != 0) return 0;
      break;
593

Loic Hausammann's avatar
Loic Hausammann committed
594
    case task_type_stars_sort:
595
    case task_type_stars_resort:
Loic Hausammann's avatar
Loic Hausammann committed
596
597
598
599
      if (ci->stars.hold) return 0;
      if (cell_slocktree(ci) != 0) return 0;
      break;

600
    case task_type_drift_gpart:
601
    case task_type_end_grav_force:
602
    case task_type_grav_mesh:
603
      if (ci->grav.phold) return 0;
604
605
606
      if (cell_glocktree(ci) != 0) return 0;
      break;

607
    case task_type_self:
608
    case task_type_sub_self:
609
      if (subtype == task_subtype_grav) {
610
        /* Lock the gparts and the m-pole */
611
        if (ci->grav.phold || ci->grav.mhold) return 0;
612
613
614
615
616
617
        if (cell_glocktree(ci) != 0)
          return 0;
        else if (cell_mlocktree(ci) != 0) {
          cell_gunlocktree(ci);
          return 0;
        }
618
619
      } else if ((subtype == task_subtype_stars_density) ||
                 (subtype == task_subtype_stars_feedback)) {
Alexei Borissov's avatar
Alexei Borissov committed
620
621
622
623
624
625
626
        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;
        }
627
628
629
      } else if ((subtype == task_subtype_bh_density) ||
                 (subtype == task_subtype_bh_feedback) ||
                 (subtype == task_subtype_bh_swallow) ||
630
                 (subtype == task_subtype_do_gas_swallow)) {
631
632
633
634
635
636
637
        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;
        }
638
639
640
      } 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
641
      } else { /* subtype == hydro */
Loic Hausammann's avatar
Loic Hausammann committed
642
        if (ci->hydro.hold) return 0;
643
644
645
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
646

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

728
729
    case task_type_grav_down:
      /* Lock the gparts and the m-poles */
730
      if (ci->grav.phold || ci->grav.mhold) return 0;
731
732
733
734
735
736
737
738
      if (cell_glocktree(ci) != 0)
        return 0;
      else if (cell_mlocktree(ci) != 0) {
        cell_gunlocktree(ci);
        return 0;
      }
      break;

739
    case task_type_grav_long_range:
740
      /* Lock the m-poles */
741
      if (ci->grav.mhold) return 0;
742
      if (cell_mlocktree(ci) != 0) return 0;
Matthieu Schaller's avatar
Matthieu Schaller committed
743
744
      break;

745
746
    case task_type_grav_mm:
      /* Lock both m-poles */
747
      if (ci->grav.mhold || cj->grav.mhold) return 0;
748
749
750
751
752
      if (cell_mlocktree(ci) != 0) return 0;
      if (cell_mlocktree(cj) != 0) {
        cell_munlocktree(ci);
        return 0;
      }
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
      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;
      }
768

769
770
    default:
      break;
771
772
773
774
775
  }

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

777
778
779
780
781
782
783
784
785
786
787
/**
 * @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);
}
788

789
790
791
792
793
794
/**
 * @brief Get the group name of a task.
 *
 * This is used to group tasks with similar actions in the task dependency
 * graph.
 *
795
 * @param type The #task type.
796
 * @param subtype The #task subtype.
797
 * @param cluster (return) The group name (should be allocated)
798
 */
799
void task_get_group_name(int type, int subtype, char *cluster) {
800

801
802
  if (type == task_type_grav_long_range || type == task_type_grav_mm ||
      type == task_type_grav_mesh) {
803
804
805
806
807

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

808
  switch (subtype) {
809
810
811
812
    case task_subtype_density:
      strcpy(cluster, "Density");
      break;
    case task_subtype_gradient:
813
      if (type == task_type_send || type == task_type_recv) {
814
815
816
        strcpy(cluster, "None");
      } else {
        strcpy(cluster, "Gradient");
817
      }
818
819
820
821
822
823
824
      break;
    case task_subtype_force:
      strcpy(cluster, "Force");
      break;
    case task_subtype_grav:
      strcpy(cluster, "Gravity");
      break;
825
    case task_subtype_limiter:
826
827
828
829
830
      if (type == task_type_send || type == task_type_recv) {
        strcpy(cluster, "None");
      } else {
        strcpy(cluster, "Timestep_limiter");
      }
831
      break;
832
    case task_subtype_stars_density:
833
834
835
836
      strcpy(cluster, "StarsDensity");
      break;
    case task_subtype_stars_feedback:
      strcpy(cluster, "StarsFeedback");
837
      break;
838
839
840
    case task_subtype_bh_density:
      strcpy(cluster, "BHDensity");
      break;
841
842
843
    case task_subtype_bh_swallow:
      strcpy(cluster, "BHSwallow");
      break;
844
845
846
847
848
    case task_subtype_do_gas_swallow:
      strcpy(cluster, "DoGasSwallow");
      break;
    case task_subtype_do_bh_swallow:
      strcpy(cluster, "DoBHSwallow");
849
      break;
850
851
852
    case task_subtype_bh_feedback:
      strcpy(cluster, "BHFeedback");
      break;
853
854
855
856
857
858
859
860
861
862
863
864
865
    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
 */
866
void task_get_full_name(int type, int subtype, char *name) {
867
868
869

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

872
  if (subtype >= task_subtype_count)
873
874
875
876
877
878
879
880
881
882
    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]);
}

883
884
885
886
887
888
889
890
891
#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]);
  }
}
892
893
894
895
896
897
898
899
/**
 * @brief Create global communicators for each of the subtasks.
 */
void task_free_mpi_comms(void) {
  for (int i = 0; i < task_subtype_count; i++) {
    MPI_Comm_free(&subtaskMPI_comms[i]);
  }
}
900
#endif
901
902

/**
903
904
 * @brief dump all the tasks of all the known engines into a file for
 * postprocessing.
905
906
907
 *
 * 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
908
 * under MPI. Note if running under MPI all the ranks are dumped into this
909
910
911
912
913
914
915
916
917
 * 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

918
919
  const ticks tic = getticks();

920
  /* Need this to convert ticks to seconds. */
921
  const unsigned long long cpufreq = clocks_get_cpufreq();
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948

#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
949
950
              engine_rank, (long long int)e->tic_step,
              (long long int)e->toc_step, e->updates, e->g_updates,
951
952
953
              e->s_updates, cpufreq);
      int count = 0;
      for (int l = 0; l < e->sched.nr_tasks; l++) {
954
955
        if (!e->sched.tasks[l].implicit &&
            e->sched.tasks[l].tic > e->tic_step) {
956
957
958
959
          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
960
961
              (long long int)e->sched.tasks[l].tic,
              (long long int)e->sched.tasks[l].toc,
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
              (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,
991
992
          -1, -1, 1, (unsigned long long)e->tic_step,
          (unsigned long long)e->toc_step, e->updates, e->g_updates,
993
994
          e->s_updates, 0, cpufreq);
  for (int l = 0; l < e->sched.nr_tasks; l++) {
995
    if (!e->sched.tasks[l].implicit && e->sched.tasks[l].tic > e->tic_step) {
996
997
998
999
      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
1000
1001
          (unsigned long long)e->sched.tasks[l].tic,
          (unsigned long long)e->sched.tasks[l].toc,
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
          (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
1013
1014
1015
1016

  if (e->verbose)
    message("took %.3f %s.", clocks_from_ticks(getticks() - tic),
            clocks_getunit());
1017
1018
1019
1020
1021
#endif  // SWIFT_DEBUG_TASKS
}

/**
 * @brief Generate simple statistics about the times used by the tasks of
1022
1023
1024
 *        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.
1025
 *
1026
1027
1028
 * 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
1029
1030
 * and total time taken and the same numbers for the start of the task,
 * in millisec and then the fixed costs value.
1031
 *
1032
1033
1034
 * 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).
1035
 *
1036
 * @param dumpfile name of the file for the output.
1037
 * @param e the #engine
1038
1039
1040
 * @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.
1041
 */
Peter W. Draper's avatar
Peter W. Draper committed
1042
1043
void task_dump_stats(const char *dumpfile, struct engine *e, int header,
                     int allranks) {
1044

1045
1046
  const ticks function_tic = getticks();

1047
1048
  /* Need arrays for sum, min and max across all types and subtypes. */
  double sum[task_type_count][task_subtype_count];
1049
  double tsum[task_type_count][task_subtype_count];
1050
  double min[task_type_count][task_subtype_count];
1051
  double tmin[task_type_count][task_subtype_count];
1052
  double max[task_type_count][task_subtype_count];
1053
  double tmax[task_type_count][task_subtype_count];
1054
1055
1056
1057
1058
  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;
1059
      tsum[j][k] = 0.0;
1060
1061
      count[j][k] = 0;
      min[j][k] = DBL_MAX;
1062
      tmin[j][k] = DBL_MAX;
1063
      max[j][k] = 0.0;
1064