task.c 36.2 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
                                             "fof_self",
James Willis's avatar
James Willis committed
99
                                             "fof_pair"};
100

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

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

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

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

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

  switch (t->type) {

    case task_type_none:
      return task_action_none;
      break;

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

170
171
172
    case task_type_star_formation:
      return task_action_all;

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

180
    case task_type_drift_bpart:
181
182
    case task_type_bh_density_ghost:
    case task_type_bh_swallow_ghost2:
183
184
185
      return task_action_bpart;
      break;

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

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

204
205
        case task_subtype_bh_density:
        case task_subtype_bh_feedback:
206
207
        case task_subtype_bh_swallow:
        case task_subtype_do_swallow:
208
209
210
          return task_action_all;
          break;

211
        case task_subtype_grav:
212
        case task_subtype_external_grav:
213
214
215
216
          return task_action_gpart;
          break;

        default:
217
218
219
220
#ifdef SWIFT_DEBUG_CHECKS
          error("Unknown task_action for task %s/%s", taskID_names[t->type],
                subtaskID_names[t->subtype]);
#endif
221
222
223
224
225
          return task_action_none;
          break;
      }
      break;

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

247
    case task_type_init_grav:
248
    case task_type_grav_mm:
249
    case task_type_grav_long_range:
250
251
252
      return task_action_multipole;
      break;

253
    case task_type_drift_gpart:
254
    case task_type_grav_down:
255
    case task_type_end_grav_force:
256
    case task_type_grav_mesh:
257
      return task_action_gpart;
258
      break;
259

260
    default:
261
262
263
264
#ifdef SWIFT_DEBUG_CHECKS
      error("Unknown task_action for task %s/%s", taskID_names[t->type],
            subtaskID_names[t->subtype]);
#endif
265
266
267
      return task_action_none;
      break;
  }
268

269
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
  /* Silence compiler warnings. We should never get here. */
274
  return task_action_none;
275
276
}

277
278
279
280
281
282
283
/**
 * @brief Compute the Jaccard similarity of the data used by two
 *        different tasks.
 *
 * @param ta The first #task.
 * @param tb The second #task.
 */
284
285
float task_overlap(const struct task *restrict ta,
                   const struct task *restrict tb) {
286
287
288
289
290
291

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

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

  /* 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;
316
317
318
319
    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;
320

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

323
324
325
326
327
328
329
330
331
332
333
334
335
336
    /* 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;
337
338
339
340
    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;
341

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

344
345
346
347
348
349
350
351
    /* 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);
  }
352

Loic Hausammann's avatar
Loic Hausammann committed
353
354
355
356
357
  /* 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;
358
359
360
361
    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
362

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

Loic Hausammann's avatar
Loic Hausammann committed
365
366
367
368
369
370
371
372
373
    /* 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);
  }

374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
  /* 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);
  }

395
396
  /* Else, no overlap */
  return 0.f;
397
}
398

399
400
/**
 * @brief Unlock the cell held by this task.
401
 *
402
403
 * @param t The #task.
 */
404
405
void task_unlock(struct task *t) {

406
407
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
408
409
  struct cell *ci = t->ci, *cj = t->cj;

410
  /* Act based on task type. */
411
412
  switch (type) {

413
414
    case task_type_kick1:
    case task_type_kick2:
415
    case task_type_logger:
416
    case task_type_timestep:
417
418
419
      cell_unlocktree(ci);
      cell_gunlocktree(ci);
      break;
Matthieu Schaller's avatar
Matthieu Schaller committed
420

421
    case task_type_drift_part:
422
    case task_type_sort:
423
    case task_type_ghost:
424
    case task_type_end_hydro_force:
425
    case task_type_timestep_limiter:
426
427
428
      cell_unlocktree(ci);
      break;

429
    case task_type_drift_gpart:
430
    case task_type_grav_mesh:
431
    case task_type_end_grav_force:
432
433
434
      cell_gunlocktree(ci);
      break;

Loic Hausammann's avatar
Loic Hausammann committed
435
    case task_type_stars_sort:
436
    case task_type_stars_resort:
Loic Hausammann's avatar
Loic Hausammann committed
437
438
439
      cell_sunlocktree(ci);
      break;

440
    case task_type_self:
441
    case task_type_sub_self:
442
443
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
444
        cell_munlocktree(ci);
445
446
      } else if ((subtype == task_subtype_stars_density) ||
                 (subtype == task_subtype_stars_feedback)) {
Alexei Borissov's avatar
Alexei Borissov committed
447
448
        cell_sunlocktree(ci);
        cell_unlocktree(ci);
449
450
451
452
453
454
      } else if ((subtype == task_subtype_bh_density) ||
                 (subtype == task_subtype_bh_feedback) ||
                 (subtype == task_subtype_bh_swallow) ||
                 (subtype == task_subtype_do_swallow)) {
        cell_bunlocktree(ci);
        cell_unlocktree(ci);
455
456
457
      } else {
        cell_unlocktree(ci);
      }
458
      break;
459

460
    case task_type_pair:
461
    case task_type_sub_pair:
462
463
464
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        cell_gunlocktree(cj);
465
466
        cell_munlocktree(ci);
        cell_munlocktree(cj);
467
468
      } else if ((subtype == task_subtype_stars_density) ||
                 (subtype == task_subtype_stars_feedback)) {
Alexei Borissov's avatar
Alexei Borissov committed
469
470
471
472
        cell_sunlocktree(ci);
        cell_sunlocktree(cj);
        cell_unlocktree(ci);
        cell_unlocktree(cj);
473
474
475
476
477
478
479
480
      } else if ((subtype == task_subtype_bh_density) ||
                 (subtype == task_subtype_bh_feedback) ||
                 (subtype == task_subtype_bh_swallow) ||
                 (subtype == task_subtype_do_swallow)) {
        cell_bunlocktree(ci);
        cell_bunlocktree(cj);
        cell_unlocktree(ci);
        cell_unlocktree(cj);
481
482
483
484
485
486
      } else {
        cell_unlocktree(ci);
        cell_unlocktree(cj);
      }
      break;

487
    case task_type_grav_down:
488
      cell_gunlocktree(ci);
489
490
491
      cell_munlocktree(ci);
      break;

492
    case task_type_grav_long_range:
493
      cell_munlocktree(ci);
494
      break;
495

496
497
498
499
500
    case task_type_grav_mm:
      cell_munlocktree(ci);
      cell_munlocktree(cj);
      break;

501
502
503
504
    case task_type_star_formation:
      cell_unlocktree(ci);
      cell_sunlocktree(ci);
      cell_gunlocktree(ci);
505
      break;
506

507
508
509
510
    default:
      break;
  }
}
511
512
513
514
515
516

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

519
520
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
521
  struct cell *ci = t->ci, *cj = t->cj;
522
523
524
525
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
526

527
  switch (type) {
528

529
530
531
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
532
#ifdef WITH_MPI
533
534
535
536
537
      /* 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);
538
539
540
541
        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);
542
543
      }
      return res;
544
#else
545
      error("SWIFT was not compiled with MPI support.");
546
#endif
547
      break;
548

549
550
    case task_type_kick1:
    case task_type_kick2:
Loikki's avatar
Loikki committed
551
    case task_type_logger:
552
    case task_type_timestep:
553
      if (ci->hydro.hold || ci->grav.phold) return 0;
554
555
      if (cell_locktree(ci) != 0) return 0;
      if (cell_glocktree(ci) != 0) {
Matthieu Schaller's avatar
Matthieu Schaller committed
556
557
        cell_unlocktree(ci);
        return 0;
558
559
560
      }
      break;

561
    case task_type_drift_part:
562
    case task_type_sort:
563
    case task_type_ghost:
564
    case task_type_end_hydro_force:
565
    case task_type_timestep_limiter:
566
      if (ci->hydro.hold) return 0;
567
568
      if (cell_locktree(ci) != 0) return 0;
      break;
569

Loic Hausammann's avatar
Loic Hausammann committed
570
    case task_type_stars_sort:
571
    case task_type_stars_resort:
Loic Hausammann's avatar
Loic Hausammann committed
572
573
574
575
      if (ci->stars.hold) return 0;
      if (cell_slocktree(ci) != 0) return 0;
      break;

576
    case task_type_drift_gpart:
577
    case task_type_end_grav_force:
578
    case task_type_grav_mesh:
579
      if (ci->grav.phold) return 0;
580
581
582
      if (cell_glocktree(ci) != 0) return 0;
      break;

583
    case task_type_self:
584
    case task_type_sub_self:
585
      if (subtype == task_subtype_grav) {
586
        /* Lock the gparts and the m-pole */
587
        if (ci->grav.phold || ci->grav.mhold) return 0;
588
589
590
591
592
593
        if (cell_glocktree(ci) != 0)
          return 0;
        else if (cell_mlocktree(ci) != 0) {
          cell_gunlocktree(ci);
          return 0;
        }
594
595
      } else if ((subtype == task_subtype_stars_density) ||
                 (subtype == task_subtype_stars_feedback)) {
Alexei Borissov's avatar
Alexei Borissov committed
596
597
598
599
600
601
602
        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;
        }
603
604
605
606
607
608
609
610
611
612
613
      } else if ((subtype == task_subtype_bh_density) ||
                 (subtype == task_subtype_bh_feedback) ||
                 (subtype == task_subtype_bh_swallow) ||
                 (subtype == task_subtype_do_swallow)) {
        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;
        }
Alexei Borissov's avatar
Alexei Borissov committed
614
      } else { /* subtype == hydro */
Loic Hausammann's avatar
Loic Hausammann committed
615
        if (ci->hydro.hold) return 0;
616
617
618
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
619

620
    case task_type_pair:
621
    case task_type_sub_pair:
622
      if (subtype == task_subtype_grav) {
623
        /* Lock the gparts and the m-pole in both cells */
624
        if (ci->grav.phold || cj->grav.phold) return 0;
625
626
627
628
        if (cell_glocktree(ci) != 0) return 0;
        if (cell_glocktree(cj) != 0) {
          cell_gunlocktree(ci);
          return 0;
629
630
631
632
633
634
635
636
637
        } 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;
638
        }
639
640
      } else if ((subtype == task_subtype_stars_density) ||
                 (subtype == task_subtype_stars_feedback)) {
Alexei Borissov's avatar
Alexei Borissov committed
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
        /* 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;
        }
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
      } else if ((subtype == task_subtype_bh_density) ||
                 (subtype == task_subtype_bh_feedback) ||
                 (subtype == task_subtype_bh_swallow) ||
                 (subtype == task_subtype_do_swallow)) {
        /* 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;
        }
Alexei Borissov's avatar
Alexei Borissov committed
683
      } else { /* subtype == hydro */
684
        /* Lock the parts in both cells */
685
        if (ci->hydro.hold || cj->hydro.hold) return 0;
686
687
688
689
690
691
692
        if (cell_locktree(ci) != 0) return 0;
        if (cell_locktree(cj) != 0) {
          cell_unlocktree(ci);
          return 0;
        }
      }
      break;
693

694
695
    case task_type_grav_down:
      /* Lock the gparts and the m-poles */
696
      if (ci->grav.phold || ci->grav.mhold) return 0;
697
698
699
700
701
702
703
704
      if (cell_glocktree(ci) != 0)
        return 0;
      else if (cell_mlocktree(ci) != 0) {
        cell_gunlocktree(ci);
        return 0;
      }
      break;

705
    case task_type_grav_long_range:
706
      /* Lock the m-poles */
707
      if (ci->grav.mhold) return 0;
708
      if (cell_mlocktree(ci) != 0) return 0;
Matthieu Schaller's avatar
Matthieu Schaller committed
709
710
      break;

711
712
    case task_type_grav_mm:
      /* Lock both m-poles */
713
      if (ci->grav.mhold || cj->grav.mhold) return 0;
714
715
716
717
718
      if (cell_mlocktree(ci) != 0) return 0;
      if (cell_mlocktree(cj) != 0) {
        cell_munlocktree(ci);
        return 0;
      }
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
      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;
      }
734

735
736
    default:
      break;
737
738
739
740
741
  }

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

743
744
745
746
747
748
749
750
751
752
753
/**
 * @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);
}
754

755
756
757
758
759
760
/**
 * @brief Get the group name of a task.
 *
 * This is used to group tasks with similar actions in the task dependency
 * graph.
 *
761
 * @param type The #task type.
762
 * @param subtype The #task subtype.
763
 * @param cluster (return) The group name (should be allocated)
764
 */
765
void task_get_group_name(int type, int subtype, char *cluster) {
766

767
768
  if (type == task_type_grav_long_range || type == task_type_grav_mm ||
      type == task_type_grav_mesh) {
769
770
771
772
773

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

774
  switch (subtype) {
775
776
777
778
    case task_subtype_density:
      strcpy(cluster, "Density");
      break;
    case task_subtype_gradient:
779
      if (type == task_type_send || type == task_type_recv) {
780
781
782
        strcpy(cluster, "None");
      } else {
        strcpy(cluster, "Gradient");
783
      }
784
785
786
787
788
789
790
      break;
    case task_subtype_force:
      strcpy(cluster, "Force");
      break;
    case task_subtype_grav:
      strcpy(cluster, "Gravity");
      break;
791
792
793
    case task_subtype_limiter:
      strcpy(cluster, "Timestep_limiter");
      break;
794
    case task_subtype_stars_density:
795
796
797
798
      strcpy(cluster, "StarsDensity");
      break;
    case task_subtype_stars_feedback:
      strcpy(cluster, "StarsFeedback");
799
      break;
800
801
802
    case task_subtype_bh_density:
      strcpy(cluster, "BHDensity");
      break;
803
804
805
806
807
808
    case task_subtype_bh_swallow:
      strcpy(cluster, "BHSwallow");
      break;
    case task_subtype_do_swallow:
      strcpy(cluster, "DoSwallow");
      break;
809
810
811
    case task_subtype_bh_feedback:
      strcpy(cluster, "BHFeedback");
      break;
812
813
814
815
816
817
818
819
820
821
822
823
824
    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
 */
825
void task_get_full_name(int type, int subtype, char *name) {
826
827
828

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

831
  if (subtype >= task_subtype_count)
832
833
834
835
836
837
838
839
840
841
    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]);
}

842
843
844
845
846
847
848
849
850
851
#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
852
853

/**
854
855
 * @brief dump all the tasks of all the known engines into a file for
 * postprocessing.
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
 *
 * 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
898
899
              engine_rank, (long long int)e->tic_step,
              (long long int)e->toc_step, e->updates, e->g_updates,
900
901
902
903
904
905
906
907
              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
908
909
              (long long int)e->sched.tasks[l].tic,
              (long long int)e->sched.tasks[l].toc,
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
              (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,
939
940
          -1, -1, 1, (unsigned long long)e->tic_step,
          (unsigned long long)e->toc_step, e->updates, e->g_updates,
941
942
943
944
945
946
947
          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
948
949
          (unsigned long long)e->sched.tasks[l].tic,
          (unsigned long long)e->sched.tasks[l].toc,
950
951
952
953
954
955
956
957
958
959
960
          (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
961
962
963
964
965
#endif  // SWIFT_DEBUG_TASKS
}

/**
 * @brief Generate simple statistics about the times used by the tasks of
966
967
968
 *        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.
969
 *
970
971
972
973
 * 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
 * and total time, in millisec and then the fixed costs value.
974
 *
975
976
977
 * 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).
978
 *
979
 * @param dumpfile name of the file for the output.
980
 * @param e the #engine
981
982
983
 * @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.
984
 */
Peter W. Draper's avatar
Peter W. Draper committed
985
986
void task_dump_stats(const char *dumpfile, struct engine *e, int header,
                     int allranks) {
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025

  /* Need arrays for sum, min and max across all types and subtypes. */
  double sum[task_type_count][task_subtype_count];
  double min[task_type_count][task_subtype_count];
  double max[task_type_count][task_subtype_count];
  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;
      count[j][k] = 0;
      min[j][k] = DBL_MAX;
      max[j][k] = 0.0;
    }
  }

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

    /* Skip implicit tasks, tasks that didn't run and MPI send/recv as these
     * are not interesting (or meaningfully measured). */
    if (!e->sched.tasks[l].implicit && e->sched.tasks[l].toc != 0 &&
        type != task_type_send && type != task_type_recv) {
      int subtype = e->sched.tasks[l].subtype;

      double dt = e->sched.tasks[l].toc - e->sched.tasks[l].tic;
      sum[type][subtype] += dt;
      count[type][subtype] += 1;
      if (dt < min[type][subtype]) {
        min[type][subtype] = dt;
      }
      if (dt > max[type][subtype]) {
        max[type][subtype] = dt;
      }
      total[0] += dt;
    }
  }

1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
#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");

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

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

    res = MPI_Reduce((engine_rank == 0 ? MPI_IN_PLACE : total), total, 1,
                     MPI_DOUBLE, MPI_SUM, 0, MPI_COMM_WORLD);
    if (res != MPI_SUCCESS) mpi_error(res, "Failed to reduce task total time");
  }
1051

1052
  if (!allranks || (engine_rank == 0 && (allranks || header))) {
1053
1054
1055
#endif

    FILE *dfile = fopen(dumpfile, "w");
1056
1057
1058
1059
1060
1061
    if (header) {
      fprintf(dfile, "/* use as src/partition_fixed_costs.h */\n");
      fprintf(dfile, "#define HAVE_FIXED_COSTS 1\n");
    } else {
      fprintf(dfile, "# task ntasks min max sum mean percent fixed_cost\n");
    }
1062
1063
1064
1065
1066
1067
1068

    for (int j = 0; j < task_type_count; j++) {
      const char *taskID = taskID_names[j];
      for (int k = 0; k < task_subtype_count; k++) {
        if (sum[j][k] > 0.0) {
          double mean = sum[j][k] / (double)count[j][k];
          double perc = 100.0 * sum[j][k] / total[0];
1069
1070
1071
1072

          /* Fixed cost is in .1ns as we want to compare between runs in
           * some absolute units. */
          int fixed_cost = (int)(clocks_from_ticks(mean) * 10000.f);
1073
1074
1075
1076
1077
1078
1079
1080
          if (header) {
            fprintf(dfile, "repartition_costs[%d][%d] = %10d; /* %s/%s */\n", j,
                    k, fixed_cost, taskID, subtaskID_names[k]);
          } else {
            fprintf(dfile,
                    "%15s/%-10s %10d %14.4f %14.4f %14.4f %14.4f %14.4f %10d\n",
                    taskID, subtaskID_names[k], count[j][k],
                    clocks_from_ticks(min[j][k]), clocks_from_ticks(max[j][k]),
Peter W. Draper's avatar
Peter W. Draper committed
1081
1082
                    clocks_from_ticks(sum[j][k]), clocks_from_ticks(mean), perc,
                    fixed_cost);
1083
          }
1084
1085
1086
1087
1088
1089
1090
        }
      }
    }
    fclose(dfile);
#ifdef WITH_MPI
  }
#endif
1091
}