task.c 31 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
66
67
68
69
70
                                             "drift_gpart",
                                             "drift_gpart_out",
                                             "end_force",
                                             "kick1",
                                             "kick2",
                                             "timestep",
71
                                             "timestep_limiter",
72
73
74
75
76
77
78
79
80
81
82
83
                                             "send",
                                             "recv",
                                             "grav_long_range",
                                             "grav_mm",
                                             "grav_down_in",
                                             "grav_down",
                                             "grav_mesh",
                                             "cooling",
                                             "star_formation",
                                             "logger",
                                             "stars_ghost_in",
                                             "stars_ghost",
Loic Hausammann's avatar
Loic Hausammann committed
84
                                             "stars_ghost_out",
85
                                             "stars_sort"};
86

87
/* Sub-task type names. */
88
const char *subtaskID_names[task_subtype_count] = {
89
90
91
92
    "none",    "density",       "gradient",      "force",
    "limiter", "grav",          "external_grav", "tend",
    "xv",      "rho",           "gpart",         "multipole",
    "spart",   "stars_density", "stars_feedback"};
93

94
95
96
97
98
#ifdef WITH_MPI
/* MPI communicators for the subtypes. */
MPI_Comm subtaskMPI_comms[task_subtype_count];
#endif

99
100
/**
 * @brief Computes the overlap between the parts array of two given cells.
101
 *
Matthieu Schaller's avatar
Matthieu Schaller committed
102
103
104
 * @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.
105
 */
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
#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;                                                               \
  }
123

124
TASK_CELL_OVERLAP(part, hydro.parts, hydro.count);
125
126
TASK_CELL_OVERLAP(gpart, grav.parts, grav.count);
TASK_CELL_OVERLAP(spart, stars.parts, stars.count);
Loic Hausammann's avatar
Loic Hausammann committed
127

128
129
130
131
132
/**
 * @brief Returns the #task_actions for a given task.
 *
 * @param t The #task.
 */
133
134
__attribute__((always_inline)) INLINE static enum task_actions task_acts_on(
    const struct task *t) {
135
136
137
138
139
140
141

  switch (t->type) {

    case task_type_none:
      return task_action_none;
      break;

142
    case task_type_drift_part:
143
144
    case task_type_sort:
    case task_type_ghost:
145
    case task_type_extra_ghost:
146
    case task_type_timestep_limiter:
Stefan Arridge's avatar
Stefan Arridge committed
147
    case task_type_cooling:
148
149
150
      return task_action_part;
      break;

151
152
153
    case task_type_star_formation:
      return task_action_all;

154
    case task_type_stars_ghost:
155
    case task_type_stars_sort:
Loic Hausammann's avatar
Loic Hausammann committed
156
157
158
      return task_action_spart;
      break;

159
160
161
162
163
164
165
    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:
166
        case task_subtype_gradient:
167
        case task_subtype_force:
168
        case task_subtype_limiter:
169
170
171
          return task_action_part;
          break;

172
        case task_subtype_stars_density:
Alexei Borissov's avatar
Alexei Borissov committed
173
        case task_subtype_stars_feedback:
174
175
          return task_action_all;
          break;
176

177
        case task_subtype_grav:
178
        case task_subtype_external_grav:
179
180
181
182
183
184
185
186
187
188
          return task_action_gpart;
          break;

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

189
    case task_type_end_force:
190
191
    case task_type_kick1:
    case task_type_kick2:
Loikki's avatar
Loikki committed
192
    case task_type_logger:
193
    case task_type_timestep:
194
195
    case task_type_send:
    case task_type_recv:
196
      if (t->ci->hydro.count > 0 && t->ci->grav.count > 0)
197
        return task_action_all;
198
      else if (t->ci->hydro.count > 0)
199
        return task_action_part;
200
      else if (t->ci->grav.count > 0)
201
202
203
        return task_action_gpart;
      else
        error("Task without particles");
204
205
      break;

206
    case task_type_init_grav:
207
    case task_type_grav_mm:
208
    case task_type_grav_long_range:
209
210
211
      return task_action_multipole;
      break;

212
    case task_type_drift_gpart:
213
    case task_type_grav_down:
214
    case task_type_grav_mesh:
215
      return task_action_gpart;
216
      break;
217

218
    default:
219
      error("Unknown task_action for task");
220
221
222
      return task_action_none;
      break;
  }
223

224
  /* Silence compiler warnings */
225
226
  error("Unknown task_action for task");
  return task_action_none;
227
228
}

229
230
231
232
233
234
235
/**
 * @brief Compute the Jaccard similarity of the data used by two
 *        different tasks.
 *
 * @param ta The first #task.
 * @param tb The second #task.
 */
236
237
float task_overlap(const struct task *restrict ta,
                   const struct task *restrict tb) {
238
239
240
241
242
243

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

244
245
  /* First check if any of the two tasks are of a type that don't
     use cells. */
246
247
248
249
250
  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);
251
252
  const int ta_spart =
      (ta_act == task_action_spart || ta_act == task_action_all);
253
254
255
  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);
256
257
  const int tb_spart =
      (tb_act == task_action_spart || tb_act == task_action_all);
258
259
260
261
262
263

  /* 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;
264
265
266
267
    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;
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282

    /* 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;
283
284
285
286
    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;
287
288
289
290
291
292
293
294
295

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

Loic Hausammann's avatar
Loic Hausammann committed
297
298
299
300
301
  /* 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;
302
303
304
305
    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
306

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

Loic Hausammann's avatar
Loic Hausammann committed
309
310
311
312
313
314
315
316
317
    /* 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);
  }

318
319
  /* Else, no overlap */
  return 0.f;
320
}
321

322
323
/**
 * @brief Unlock the cell held by this task.
324
 *
325
326
 * @param t The #task.
 */
327
328
void task_unlock(struct task *t) {

329
330
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
331
332
  struct cell *ci = t->ci, *cj = t->cj;

333
  /* Act based on task type. */
334
335
  switch (type) {

336
    case task_type_end_force:
337
338
    case task_type_kick1:
    case task_type_kick2:
339
    case task_type_logger:
340
    case task_type_timestep:
341
342
343
      cell_unlocktree(ci);
      cell_gunlocktree(ci);
      break;
Matthieu Schaller's avatar
Matthieu Schaller committed
344

345
    case task_type_drift_part:
346
    case task_type_sort:
347
    case task_type_ghost:
348
    case task_type_timestep_limiter:
349
350
351
      cell_unlocktree(ci);
      break;

352
    case task_type_drift_gpart:
353
    case task_type_grav_mesh:
354
355
356
      cell_gunlocktree(ci);
      break;

357
    case task_type_stars_sort:
Loic Hausammann's avatar
Loic Hausammann committed
358
359
360
      cell_sunlocktree(ci);
      break;

361
    case task_type_self:
362
    case task_type_sub_self:
363
364
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
365
        cell_munlocktree(ci);
Loic Hausammann's avatar
Loic Hausammann committed
366
367
      } else if (subtype == task_subtype_stars_density) {
        cell_sunlocktree(ci);
Alexei Borissov's avatar
Alexei Borissov committed
368
369
370
      } else if (subtype == task_subtype_stars_feedback) {
        cell_sunlocktree(ci);
        cell_unlocktree(ci);
371
372
373
      } else {
        cell_unlocktree(ci);
      }
374
      break;
375

376
    case task_type_pair:
377
    case task_type_sub_pair:
378
379
380
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        cell_gunlocktree(cj);
381
382
        cell_munlocktree(ci);
        cell_munlocktree(cj);
Loic Hausammann's avatar
Loic Hausammann committed
383
384
385
      } else if (subtype == task_subtype_stars_density) {
        cell_sunlocktree(ci);
        cell_sunlocktree(cj);
Alexei Borissov's avatar
Alexei Borissov committed
386
387
388
389
390
      } else if (subtype == task_subtype_stars_feedback) {
        cell_sunlocktree(ci);
        cell_sunlocktree(cj);
        cell_unlocktree(ci);
        cell_unlocktree(cj);
391
392
393
394
395
396
      } else {
        cell_unlocktree(ci);
        cell_unlocktree(cj);
      }
      break;

397
    case task_type_grav_down:
398
      cell_gunlocktree(ci);
399
400
401
      cell_munlocktree(ci);
      break;

402
    case task_type_grav_long_range:
403
      cell_munlocktree(ci);
404
      break;
405

406
407
408
409
410
    case task_type_grav_mm:
      cell_munlocktree(ci);
      cell_munlocktree(cj);
      break;

411
412
413
414
    case task_type_star_formation:
      cell_unlocktree(ci);
      cell_sunlocktree(ci);
      cell_gunlocktree(ci);
415
      break;
416

417
418
419
420
    default:
      break;
  }
}
421
422
423
424
425
426

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

429
430
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
431
  struct cell *ci = t->ci, *cj = t->cj;
432
433
434
435
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
436

437
  switch (type) {
438

439
440
441
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
442
#ifdef WITH_MPI
443
444
445
446
447
      /* 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);
448
449
450
451
        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);
452
453
      }
      return res;
454
#else
455
      error("SWIFT was not compiled with MPI support.");
456
#endif
457
      break;
458

459
    case task_type_end_force:
460
461
    case task_type_kick1:
    case task_type_kick2:
Loikki's avatar
Loikki committed
462
    case task_type_logger:
463
    case task_type_timestep:
464
      if (ci->hydro.hold || ci->grav.phold) return 0;
465
466
      if (cell_locktree(ci) != 0) return 0;
      if (cell_glocktree(ci) != 0) {
Matthieu Schaller's avatar
Matthieu Schaller committed
467
468
        cell_unlocktree(ci);
        return 0;
469
470
471
      }
      break;

472
    case task_type_drift_part:
473
    case task_type_sort:
474
    case task_type_ghost:
475
    case task_type_timestep_limiter:
476
      if (ci->hydro.hold) return 0;
477
478
      if (cell_locktree(ci) != 0) return 0;
      break;
479

480
    case task_type_stars_sort:
Loic Hausammann's avatar
Loic Hausammann committed
481
482
483
484
      if (ci->stars.hold) return 0;
      if (cell_slocktree(ci) != 0) return 0;
      break;

485
    case task_type_drift_gpart:
486
    case task_type_grav_mesh:
487
      if (ci->grav.phold) return 0;
488
489
490
      if (cell_glocktree(ci) != 0) return 0;
      break;

491
    case task_type_self:
492
    case task_type_sub_self:
493
      if (subtype == task_subtype_grav) {
494
        /* Lock the gparts and the m-pole */
495
        if (ci->grav.phold || ci->grav.mhold) return 0;
496
497
498
499
500
501
        if (cell_glocktree(ci) != 0)
          return 0;
        else if (cell_mlocktree(ci) != 0) {
          cell_gunlocktree(ci);
          return 0;
        }
Loic Hausammann's avatar
Loic Hausammann committed
502
503
504
      } else if (subtype == task_subtype_stars_density) {
        if (ci->stars.hold) return 0;
        if (cell_slocktree(ci) != 0) return 0;
Alexei Borissov's avatar
Alexei Borissov committed
505
506
507
508
509
510
511
512
513
      } else if (subtype == task_subtype_stars_feedback) {
        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
514
        if (ci->hydro.hold) return 0;
515
516
517
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
518

519
    case task_type_pair:
520
    case task_type_sub_pair:
521
      if (subtype == task_subtype_grav) {
522
        /* Lock the gparts and the m-pole in both cells */
523
        if (ci->grav.phold || cj->grav.phold) return 0;
524
525
526
527
        if (cell_glocktree(ci) != 0) return 0;
        if (cell_glocktree(cj) != 0) {
          cell_gunlocktree(ci);
          return 0;
528
529
530
531
532
533
534
535
536
        } 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;
537
        }
Loic Hausammann's avatar
Loic Hausammann committed
538
539
540
541
542
543
544
      } else if (subtype == task_subtype_stars_density) {
        if (ci->stars.hold || cj->stars.hold) return 0;
        if (cell_slocktree(ci) != 0) return 0;
        if (cell_slocktree(cj) != 0) {
          cell_sunlocktree(ci);
          return 0;
        }
Alexei Borissov's avatar
Alexei Borissov committed
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
      } else if (subtype == task_subtype_stars_feedback) {
        /* 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 */
566
        /* Lock the parts in both cells */
567
        if (ci->hydro.hold || cj->hydro.hold) return 0;
568
569
570
571
572
573
574
        if (cell_locktree(ci) != 0) return 0;
        if (cell_locktree(cj) != 0) {
          cell_unlocktree(ci);
          return 0;
        }
      }
      break;
575

576
577
    case task_type_grav_down:
      /* Lock the gparts and the m-poles */
578
      if (ci->grav.phold || ci->grav.mhold) return 0;
579
580
581
582
583
584
585
586
      if (cell_glocktree(ci) != 0)
        return 0;
      else if (cell_mlocktree(ci) != 0) {
        cell_gunlocktree(ci);
        return 0;
      }
      break;

587
    case task_type_grav_long_range:
588
      /* Lock the m-poles */
589
      if (ci->grav.mhold) return 0;
590
      if (cell_mlocktree(ci) != 0) return 0;
Matthieu Schaller's avatar
Matthieu Schaller committed
591
592
      break;

593
594
    case task_type_grav_mm:
      /* Lock both m-poles */
595
      if (ci->grav.mhold || cj->grav.mhold) return 0;
596
597
598
599
600
      if (cell_mlocktree(ci) != 0) return 0;
      if (cell_mlocktree(cj) != 0) {
        cell_munlocktree(ci);
        return 0;
      }
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
      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;
      }
616

617
618
    default:
      break;
619
620
621
622
623
  }

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

625
626
627
628
629
630
631
632
633
634
635
/**
 * @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);
}
636

637
638
639
640
641
642
/**
 * @brief Get the group name of a task.
 *
 * This is used to group tasks with similar actions in the task dependency
 * graph.
 *
643
 * @param type The #task type.
644
 * @param subtype The #task subtype.
645
 * @param cluster (return) The group name (should be allocated)
646
 */
647
void task_get_group_name(int type, int subtype, char *cluster) {
648

649
650
  if (type == task_type_grav_long_range || type == task_type_grav_mm ||
      type == task_type_grav_mesh) {
651
652
653
654
655

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

656
  switch (subtype) {
657
658
659
660
661
662
663
664
665
666
667
668
    case task_subtype_density:
      strcpy(cluster, "Density");
      break;
    case task_subtype_gradient:
      strcpy(cluster, "Gradient");
      break;
    case task_subtype_force:
      strcpy(cluster, "Force");
      break;
    case task_subtype_grav:
      strcpy(cluster, "Gravity");
      break;
669
670
671
    case task_subtype_limiter:
      strcpy(cluster, "Timestep_limiter");
      break;
672
    case task_subtype_stars_density:
673
674
675
676
      strcpy(cluster, "StarsDensity");
      break;
    case task_subtype_stars_feedback:
      strcpy(cluster, "StarsFeedback");
677
678
679
680
681
682
683
684
685
686
687
688
689
690
      break;
    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
 */
691
void task_get_full_name(int type, int subtype, char *name) {
692
693
694

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

697
  if (subtype >= task_subtype_count)
698
699
700
701
702
703
704
705
706
707
    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]);
}

708
709
710
711
712
713
714
715
716
717
#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
718
719

/**
720
721
 * @brief dump all the tasks of all the known engines into a file for
 * postprocessing.
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
 *
 * 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
764
765
              engine_rank, (long long int)e->tic_step,
              (long long int)e->toc_step, e->updates, e->g_updates,
766
767
768
769
770
771
772
773
              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
774
775
              (long long int)e->sched.tasks[l].tic,
              (long long int)e->sched.tasks[l].toc,
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
804
              (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,
805
806
          -1, -1, 1, (unsigned long long)e->tic_step,
          (unsigned long long)e->toc_step, e->updates, e->g_updates,
807
808
809
810
811
812
813
          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
814
815
          (unsigned long long)e->sched.tasks[l].tic,
          (unsigned long long)e->sched.tasks[l].toc,
816
817
818
819
820
821
822
823
824
825
826
          (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
827
828
829
830
831
#endif  // SWIFT_DEBUG_TASKS
}

/**
 * @brief Generate simple statistics about the times used by the tasks of
832
833
834
 *        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.
835
 *
836
837
838
839
 * 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.
840
 *
841
842
843
 * 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).
844
 *
845
 * @param dumpfile name of the file for the output.
846
 * @param e the #engine
847
848
849
 * @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.
850
 */
Peter W. Draper's avatar
Peter W. Draper committed
851
852
void task_dump_stats(const char *dumpfile, struct engine *e, int header,
                     int allranks) {
853
854
855
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

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

892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
#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");
  }
917

918
  if (!allranks || (engine_rank == 0 && (allranks || header))) {
919
920
921
#endif

    FILE *dfile = fopen(dumpfile, "w");
922
923
924
925
926
927
    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");
    }
928
929
930
931
932
933
934

    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];
935
936
937
938

          /* 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);
939
940
941
942
943
944
945
946
          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
947
948
                    clocks_from_ticks(sum[j][k]), clocks_from_ticks(mean), perc,
                    fixed_cost);
949
          }
950
951
952
953
954
955
956
        }
      }
    }
    fclose(dfile);
#ifdef WITH_MPI
  }
#endif
957
}