task.c 32.9 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
/* Sub-task type names. */
94
95
96
97
98
99
100
101
102
103
const char *subtaskID_names[task_subtype_count] = {"none",
                                                   "density",
                                                   "gradient",
                                                   "force",
                                                   "limiter",
                                                   "grav",
                                                   "external_grav",
                                                   "tend_part",
                                                   "tend_gpart",
                                                   "tend_spart",
104
						   "tend_bpart",
105
106
107
108
109
110
111
                                                   "xv",
                                                   "rho",
                                                   "gpart",
                                                   "multipole",
                                                   "spart",
                                                   "stars_density",
                                                   "stars_feedback"};
112

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

118
119
/**
 * @brief Computes the overlap between the parts array of two given cells.
120
 *
Matthieu Schaller's avatar
Matthieu Schaller committed
121
122
123
 * @param TYPE is the type of parts (e.g. #part, #gpart, #spart)
 * @param ARRAY is the array of this specific type.
 * @param COUNT is the number of elements in the array.
124
 */
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
#define TASK_CELL_OVERLAP(TYPE, ARRAY, COUNT)                               \
  __attribute__((always_inline))                                            \
      INLINE static size_t task_cell_overlap_##TYPE(                        \
          const struct cell *restrict ci, const struct cell *restrict cj) { \
                                                                            \
    if (ci == NULL || cj == NULL) return 0;                                 \
                                                                            \
    if (ci->ARRAY <= cj->ARRAY &&                                           \
        ci->ARRAY + ci->COUNT >= cj->ARRAY + cj->COUNT) {                   \
      return cj->COUNT;                                                     \
    } else if (cj->ARRAY <= ci->ARRAY &&                                    \
               cj->ARRAY + cj->COUNT >= ci->ARRAY + ci->COUNT) {            \
      return ci->COUNT;                                                     \
    }                                                                       \
                                                                            \
    return 0;                                                               \
  }
142

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

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

  switch (t->type) {

    case task_type_none:
      return task_action_none;
      break;

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

171
172
173
    case task_type_star_formation:
      return task_action_all;

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

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

193
        case task_subtype_stars_density:
Alexei Borissov's avatar
Alexei Borissov committed
194
        case task_subtype_stars_feedback:
195
196
          return task_action_all;
          break;
197

198
        case task_subtype_grav:
199
        case task_subtype_external_grav:
200
201
202
203
          return task_action_gpart;
          break;

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

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

232
    case task_type_init_grav:
233
    case task_type_grav_mm:
234
    case task_type_grav_long_range:
235
236
237
      return task_action_multipole;
      break;

238
    case task_type_drift_gpart:
239
    case task_type_grav_down:
240
    case task_type_end_grav_force:
241
    case task_type_grav_mesh:
242
      return task_action_gpart;
243
      break;
244

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

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

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

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

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

  /* 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;
297
298
299
300
    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;
301

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

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

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

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

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

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

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

355
356
  /* Else, no overlap */
  return 0.f;
357
}
358

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

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

370
  /* Act based on task type. */
371
372
  switch (type) {

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

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

389
    case task_type_drift_gpart:
390
    case task_type_grav_mesh:
391
    case task_type_end_grav_force:
392
393
394
      cell_gunlocktree(ci);
      break;

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

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

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

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

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

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

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

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

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

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

475
  switch (type) {
476

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

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

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

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

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

530
    case task_type_self:
531
    case task_type_sub_self:
532
      if (subtype == task_subtype_grav) {
533
        /* Lock the gparts and the m-pole */
534
        if (ci->grav.phold || ci->grav.mhold) return 0;
535
536
537
538
539
540
        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
541
542
543
      } 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
544
545
546
547
548
549
550
551
552
      } 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
553
        if (ci->hydro.hold) return 0;
554
555
556
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
557

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

615
616
    case task_type_grav_down:
      /* Lock the gparts and the m-poles */
617
      if (ci->grav.phold || ci->grav.mhold) return 0;
618
619
620
621
622
623
624
625
      if (cell_glocktree(ci) != 0)
        return 0;
      else if (cell_mlocktree(ci) != 0) {
        cell_gunlocktree(ci);
        return 0;
      }
      break;

626
    case task_type_grav_long_range:
627
      /* Lock the m-poles */
628
      if (ci->grav.mhold) return 0;
629
      if (cell_mlocktree(ci) != 0) return 0;
Matthieu Schaller's avatar
Matthieu Schaller committed
630
631
      break;

632
633
    case task_type_grav_mm:
      /* Lock both m-poles */
634
      if (ci->grav.mhold || cj->grav.mhold) return 0;
635
636
637
638
639
      if (cell_mlocktree(ci) != 0) return 0;
      if (cell_mlocktree(cj) != 0) {
        cell_munlocktree(ci);
        return 0;
      }
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
      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;
      }
655

656
657
    default:
      break;
658
659
660
661
662
  }

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

664
665
666
667
668
669
670
671
672
673
674
/**
 * @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);
}
675

676
677
678
679
680
681
/**
 * @brief Get the group name of a task.
 *
 * This is used to group tasks with similar actions in the task dependency
 * graph.
 *
682
 * @param type The #task type.
683
 * @param subtype The #task subtype.
684
 * @param cluster (return) The group name (should be allocated)
685
 */
686
void task_get_group_name(int type, int subtype, char *cluster) {
687

688
689
  if (type == task_type_grav_long_range || type == task_type_grav_mm ||
      type == task_type_grav_mesh) {
690
691
692
693
694

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

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

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

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

751
752
753
754
755
756
757
758
759
760
#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
761
762

/**
763
764
 * @brief dump all the tasks of all the known engines into a file for
 * postprocessing.
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
804
805
806
 *
 * 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
807
808
              engine_rank, (long long int)e->tic_step,
              (long long int)e->toc_step, e->updates, e->g_updates,
809
810
811
812
813
814
815
816
              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
817
818
              (long long int)e->sched.tasks[l].tic,
              (long long int)e->sched.tasks[l].toc,
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
845
846
847
              (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,
848
849
          -1, -1, 1, (unsigned long long)e->tic_step,
          (unsigned long long)e->toc_step, e->updates, e->g_updates,
850
851
852
853
854
855
856
          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
857
858
          (unsigned long long)e->sched.tasks[l].tic,
          (unsigned long long)e->sched.tasks[l].toc,
859
860
861
862
863
864
865
866
867
868
869
          (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
870
871
872
873
874
#endif  // SWIFT_DEBUG_TASKS
}

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

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

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

961
  if (!allranks || (engine_rank == 0 && (allranks || header))) {
962
963
964
#endif

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

    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];
978
979
980
981

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