task.c 32.4 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",
Loic Hausammann's avatar
Loic Hausammann committed
90
                                             "stars_ghost_out",
91
                                             "stars_sort",
92
93
                                             "bh_in",
                                             "bh_out",
94
                                             "bh_ghost"};
95

96
/* Sub-task type names. */
97
const char *subtaskID_names[task_subtype_count] = {
98
99
100
101
    "none",          "density",        "gradient",      "force",
    "limiter",       "grav",           "external_grav", "tend_part",
    "tend_gpart",    "tend_spart",     "tend_bpart",    "xv",
    "rho",           "gpart",          "multipole",     "spart",
102
    "stars_density", "stars_feedback", "sf_count", "bpart",         "bh_density",
103
    "bh_feedback"};
104

105
106
107
108
109
#ifdef WITH_MPI
/* MPI communicators for the subtypes. */
MPI_Comm subtaskMPI_comms[task_subtype_count];
#endif

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

135
TASK_CELL_OVERLAP(part, hydro.parts, hydro.count);
136
137
TASK_CELL_OVERLAP(gpart, grav.parts, grav.count);
TASK_CELL_OVERLAP(spart, stars.parts, stars.count);
Loic Hausammann's avatar
Loic Hausammann committed
138

139
140
141
142
143
/**
 * @brief Returns the #task_actions for a given task.
 *
 * @param t The #task.
 */
144
145
__attribute__((always_inline)) INLINE static enum task_actions task_acts_on(
    const struct task *t) {
146
147
148
149
150
151
152

  switch (t->type) {

    case task_type_none:
      return task_action_none;
      break;

153
    case task_type_drift_part:
154
155
    case task_type_sort:
    case task_type_ghost:
156
    case task_type_extra_ghost:
157
    case task_type_timestep_limiter:
Stefan Arridge's avatar
Stefan Arridge committed
158
    case task_type_cooling:
159
    case task_type_end_hydro_force:
160
161
162
      return task_action_part;
      break;

163
164
165
    case task_type_star_formation:
      return task_action_all;

166
    case task_type_drift_spart:
167
    case task_type_stars_ghost:
168
    case task_type_stars_sort:
Loic Hausammann's avatar
Loic Hausammann committed
169
170
171
      return task_action_spart;
      break;

172
173
174
175
176
    case task_type_drift_bpart:
    case task_type_bh_ghost:
      return task_action_bpart;
      break;

177
178
179
180
181
182
183
    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:
184
        case task_subtype_gradient:
185
        case task_subtype_force:
186
        case task_subtype_limiter:
187
188
189
          return task_action_part;
          break;

190
        case task_subtype_stars_density:
Alexei Borissov's avatar
Alexei Borissov committed
191
        case task_subtype_stars_feedback:
192
193
          return task_action_all;
          break;
194

195
196
197
198
199
        case task_subtype_bh_density:
        case task_subtype_bh_feedback:
          return task_action_all;
          break;

200
        case task_subtype_grav:
201
        case task_subtype_external_grav:
202
203
204
205
          return task_action_gpart;
          break;

        default:
206
207
208
209
#ifdef SWIFT_DEBUG_CHECKS
          error("Unknown task_action for task %s/%s", taskID_names[t->type],
                subtaskID_names[t->subtype]);
#endif
210
211
212
213
214
          return task_action_none;
          break;
      }
      break;

215
216
    case task_type_kick1:
    case task_type_kick2:
Loikki's avatar
Loikki committed
217
    case task_type_logger:
218
    case task_type_timestep:
219
220
    case task_type_send:
    case task_type_recv:
221
      if (t->ci->hydro.count > 0 && t->ci->grav.count > 0)
222
        return task_action_all;
223
      else if (t->ci->hydro.count > 0)
224
        return task_action_part;
225
      else if (t->ci->grav.count > 0)
226
        return task_action_gpart;
227
228
      else {
#ifdef SWIFT_DEBUG_CHECKS
229
        error("Task without particles");
230
231
#endif
      }
232
233
      break;

234
    case task_type_init_grav:
235
    case task_type_grav_mm:
236
    case task_type_grav_long_range:
237
238
239
      return task_action_multipole;
      break;

240
    case task_type_drift_gpart:
241
    case task_type_grav_down:
242
    case task_type_end_grav_force:
243
    case task_type_grav_mesh:
244
      return task_action_gpart;
245
      break;
246

247
    default:
248
249
250
251
#ifdef SWIFT_DEBUG_CHECKS
      error("Unknown task_action for task %s/%s", taskID_names[t->type],
            subtaskID_names[t->subtype]);
#endif
252
253
254
      return task_action_none;
      break;
  }
255

256
257
258
259
260
#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. */
261
  return task_action_none;
262
263
}

264
265
266
267
268
269
270
/**
 * @brief Compute the Jaccard similarity of the data used by two
 *        different tasks.
 *
 * @param ta The first #task.
 * @param tb The second #task.
 */
271
272
float task_overlap(const struct task *restrict ta,
                   const struct task *restrict tb) {
273
274
275
276
277
278

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

279
280
  /* First check if any of the two tasks are of a type that don't
     use cells. */
281
282
283
284
285
  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);
286
287
  const int ta_spart =
      (ta_act == task_action_spart || ta_act == task_action_all);
288
289
290
  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);
291
292
  const int tb_spart =
      (tb_act == task_action_spart || tb_act == task_action_all);
293
294
295
296
297
298

  /* 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;
299
300
301
302
    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;
303

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

306
307
308
309
310
311
312
313
314
315
316
317
318
319
    /* 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;
320
321
322
323
    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;
324

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

327
328
329
330
331
332
333
334
    /* 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);
  }
335

Loic Hausammann's avatar
Loic Hausammann committed
336
337
338
339
340
  /* 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;
341
342
343
344
    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
345

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

Loic Hausammann's avatar
Loic Hausammann committed
348
349
350
351
352
353
354
355
356
    /* 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);
  }

357
358
  /* Else, no overlap */
  return 0.f;
359
}
360

361
362
/**
 * @brief Unlock the cell held by this task.
363
 *
364
365
 * @param t The #task.
 */
366
367
void task_unlock(struct task *t) {

368
369
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
370
371
  struct cell *ci = t->ci, *cj = t->cj;

372
  /* Act based on task type. */
373
374
  switch (type) {

375
376
    case task_type_kick1:
    case task_type_kick2:
377
    case task_type_logger:
378
    case task_type_timestep:
379
380
381
      cell_unlocktree(ci);
      cell_gunlocktree(ci);
      break;
Matthieu Schaller's avatar
Matthieu Schaller committed
382

383
    case task_type_drift_part:
384
    case task_type_sort:
385
    case task_type_ghost:
386
    case task_type_end_hydro_force:
387
    case task_type_timestep_limiter:
388
389
390
      cell_unlocktree(ci);
      break;

391
    case task_type_drift_gpart:
392
    case task_type_grav_mesh:
393
    case task_type_end_grav_force:
394
395
396
      cell_gunlocktree(ci);
      break;

397
    case task_type_stars_sort:
Loic Hausammann's avatar
Loic Hausammann committed
398
399
400
      cell_sunlocktree(ci);
      break;

401
    case task_type_self:
402
    case task_type_sub_self:
403
404
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
405
        cell_munlocktree(ci);
406
407
      } else if ((subtype == task_subtype_stars_density) ||
                 (subtype == task_subtype_stars_feedback)) {
Alexei Borissov's avatar
Alexei Borissov committed
408
409
        cell_sunlocktree(ci);
        cell_unlocktree(ci);
410
411
412
      } else {
        cell_unlocktree(ci);
      }
413
      break;
414

415
    case task_type_pair:
416
    case task_type_sub_pair:
417
418
419
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        cell_gunlocktree(cj);
420
421
        cell_munlocktree(ci);
        cell_munlocktree(cj);
422
423
      } else if ((subtype == task_subtype_stars_density) ||
                 (subtype == task_subtype_stars_feedback)) {
Alexei Borissov's avatar
Alexei Borissov committed
424
425
426
427
        cell_sunlocktree(ci);
        cell_sunlocktree(cj);
        cell_unlocktree(ci);
        cell_unlocktree(cj);
428
429
430
431
432
433
      } else {
        cell_unlocktree(ci);
        cell_unlocktree(cj);
      }
      break;

434
    case task_type_grav_down:
435
      cell_gunlocktree(ci);
436
437
438
      cell_munlocktree(ci);
      break;

439
    case task_type_grav_long_range:
440
      cell_munlocktree(ci);
441
      break;
442

443
444
445
446
447
    case task_type_grav_mm:
      cell_munlocktree(ci);
      cell_munlocktree(cj);
      break;

448
449
450
451
    case task_type_star_formation:
      cell_unlocktree(ci);
      cell_sunlocktree(ci);
      cell_gunlocktree(ci);
452
      break;
453

454
455
456
457
    default:
      break;
  }
}
458
459
460
461
462
463

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

466
467
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
468
  struct cell *ci = t->ci, *cj = t->cj;
469
470
471
472
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
473

474
  switch (type) {
475

476
477
478
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
479
#ifdef WITH_MPI
480
481
482
483
484
      /* 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);
485
486
487
488
        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);
489
490
      }
      return res;
491
#else
492
      error("SWIFT was not compiled with MPI support.");
493
#endif
494
      break;
495

496
497
    case task_type_kick1:
    case task_type_kick2:
Loikki's avatar
Loikki committed
498
    case task_type_logger:
499
    case task_type_timestep:
500
      if (ci->hydro.hold || ci->grav.phold) return 0;
501
502
      if (cell_locktree(ci) != 0) return 0;
      if (cell_glocktree(ci) != 0) {
Matthieu Schaller's avatar
Matthieu Schaller committed
503
504
        cell_unlocktree(ci);
        return 0;
505
506
507
      }
      break;

508
    case task_type_drift_part:
509
    case task_type_sort:
510
    case task_type_ghost:
511
    case task_type_end_hydro_force:
512
    case task_type_timestep_limiter:
513
      if (ci->hydro.hold) return 0;
514
515
      if (cell_locktree(ci) != 0) return 0;
      break;
516

517
    case task_type_stars_sort:
Loic Hausammann's avatar
Loic Hausammann committed
518
519
520
521
      if (ci->stars.hold) return 0;
      if (cell_slocktree(ci) != 0) return 0;
      break;

522
    case task_type_drift_gpart:
523
    case task_type_end_grav_force:
524
    case task_type_grav_mesh:
525
      if (ci->grav.phold) return 0;
526
527
528
      if (cell_glocktree(ci) != 0) return 0;
      break;

529
    case task_type_self:
530
    case task_type_sub_self:
531
      if (subtype == task_subtype_grav) {
532
        /* Lock the gparts and the m-pole */
533
        if (ci->grav.phold || ci->grav.mhold) return 0;
534
535
536
537
538
539
        if (cell_glocktree(ci) != 0)
          return 0;
        else if (cell_mlocktree(ci) != 0) {
          cell_gunlocktree(ci);
          return 0;
        }
540
541
      } else if ((subtype == task_subtype_stars_density) ||
                 (subtype == task_subtype_stars_feedback)) {
Alexei Borissov's avatar
Alexei Borissov committed
542
543
544
545
546
547
548
549
        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;
        }
      } else { /* subtype == hydro */
Loic Hausammann's avatar
Loic Hausammann committed
550
        if (ci->hydro.hold) return 0;
551
552
553
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
554

555
    case task_type_pair:
556
    case task_type_sub_pair:
557
      if (subtype == task_subtype_grav) {
558
        /* Lock the gparts and the m-pole in both cells */
559
        if (ci->grav.phold || cj->grav.phold) return 0;
560
561
562
563
        if (cell_glocktree(ci) != 0) return 0;
        if (cell_glocktree(cj) != 0) {
          cell_gunlocktree(ci);
          return 0;
564
565
566
567
568
569
570
571
572
        } 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;
573
        }
574
575
      } else if ((subtype == task_subtype_stars_density) ||
                 (subtype == task_subtype_stars_feedback)) {
Alexei Borissov's avatar
Alexei Borissov committed
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
        /* 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;
        }
      } else { /* subtype == hydro */
596
        /* Lock the parts in both cells */
597
        if (ci->hydro.hold || cj->hydro.hold) return 0;
598
599
600
601
602
603
604
        if (cell_locktree(ci) != 0) return 0;
        if (cell_locktree(cj) != 0) {
          cell_unlocktree(ci);
          return 0;
        }
      }
      break;
605

606
607
    case task_type_grav_down:
      /* Lock the gparts and the m-poles */
608
      if (ci->grav.phold || ci->grav.mhold) return 0;
609
610
611
612
613
614
615
616
      if (cell_glocktree(ci) != 0)
        return 0;
      else if (cell_mlocktree(ci) != 0) {
        cell_gunlocktree(ci);
        return 0;
      }
      break;

617
    case task_type_grav_long_range:
618
      /* Lock the m-poles */
619
      if (ci->grav.mhold) return 0;
620
      if (cell_mlocktree(ci) != 0) return 0;
Matthieu Schaller's avatar
Matthieu Schaller committed
621
622
      break;

623
624
    case task_type_grav_mm:
      /* Lock both m-poles */
625
      if (ci->grav.mhold || cj->grav.mhold) return 0;
626
627
628
629
630
      if (cell_mlocktree(ci) != 0) return 0;
      if (cell_mlocktree(cj) != 0) {
        cell_munlocktree(ci);
        return 0;
      }
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
      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;
      }
646

647
648
    default:
      break;
649
650
651
652
653
  }

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

655
656
657
658
659
660
661
662
663
664
665
/**
 * @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);
}
666

667
668
669
670
671
672
/**
 * @brief Get the group name of a task.
 *
 * This is used to group tasks with similar actions in the task dependency
 * graph.
 *
673
 * @param type The #task type.
674
 * @param subtype The #task subtype.
675
 * @param cluster (return) The group name (should be allocated)
676
 */
677
void task_get_group_name(int type, int subtype, char *cluster) {
678

679
680
  if (type == task_type_grav_long_range || type == task_type_grav_mm ||
      type == task_type_grav_mesh) {
681
682
683
684
685

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

686
  switch (subtype) {
687
688
689
690
    case task_subtype_density:
      strcpy(cluster, "Density");
      break;
    case task_subtype_gradient:
691
      if (type == task_type_send || type == task_type_recv) {
692
693
694
        strcpy(cluster, "None");
      } else {
        strcpy(cluster, "Gradient");
695
      }
696
697
      break;
    case task_subtype_force:
698
      strcpy(cluster, "Force");
699
700
701
702
      break;
    case task_subtype_grav:
      strcpy(cluster, "Gravity");
      break;
703
704
705
    case task_subtype_limiter:
      strcpy(cluster, "Timestep_limiter");
      break;
706
    case task_subtype_stars_density:
707
708
709
710
      strcpy(cluster, "StarsDensity");
      break;
    case task_subtype_stars_feedback:
      strcpy(cluster, "StarsFeedback");
711
      break;
712
713
714
715
716
717
    case task_subtype_bh_density:
      strcpy(cluster, "BHDensity");
      break;
    case task_subtype_bh_feedback:
      strcpy(cluster, "BHFeedback");
      break;
718
719
720
721
722
723
724
725
726
727
728
729
730
    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
 */
731
void task_get_full_name(int type, int subtype, char *name) {
732
733
734

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

737
  if (subtype >= task_subtype_count)
738
739
740
741
742
743
744
745
746
747
    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]);
}

748
749
750
751
752
753
754
755
756
757
#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
758
759

/**
760
761
 * @brief dump all the tasks of all the known engines into a file for
 * postprocessing.
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 *
 * 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
804
805
              engine_rank, (long long int)e->tic_step,
              (long long int)e->toc_step, e->updates, e->g_updates,
806
807
808
809
810
811
812
813
              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
814
815
              (long long int)e->sched.tasks[l].tic,
              (long long int)e->sched.tasks[l].toc,
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
              (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,
845
846
          -1, -1, 1, (unsigned long long)e->tic_step,
          (unsigned long long)e->toc_step, e->updates, e->g_updates,
847
848
849
850
851
852
853
          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
854
855
          (unsigned long long)e->sched.tasks[l].tic,
          (unsigned long long)e->sched.tasks[l].toc,
856
857
858
859
860
861
862
863
864
865
866
          (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
867
868
869
870
871
#endif  // SWIFT_DEBUG_TASKS
}

/**
 * @brief Generate simple statistics about the times used by the tasks of
872
873
874
 *        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.
875
 *
876
877
878
879
 * 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.
880
 *
881
882
883
 * 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).
884
 *
885
 * @param dumpfile name of the file for the output.
886
 * @param e the #engine
887
888
889
 * @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.
890
 */
Peter W. Draper's avatar
Peter W. Draper committed
891
892
void task_dump_stats(const char *dumpfile, struct engine *e, int header,
                     int allranks) {
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
924
925
926
927
928
929
930
931

  /* 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;
    }
  }

932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
#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");
  }
957

958
  if (!allranks || (engine_rank == 0 && (allranks || header))) {
959
960
961
#endif

    FILE *dfile = fopen(dumpfile, "w");
962
963
964
965
966
967
    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");
    }
968
969
970
971
972
973
974

    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];
975
976
977
978

          /* 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);
979
980
981
982
983
984
985
986
          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
987
988
                    clocks_from_ticks(sum[j][k]), clocks_from_ticks(mean), perc,
                    fixed_cost);
989
          }
990
991
992
993
994
995
996
        }
      }
    }
    fclose(dfile);
#ifdef WITH_MPI
  }
#endif
997
}