task.c 16.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 "error.h"
46
#include "inline.h"
47
#include "lock.h"
48
49

/* Task type names. */
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
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",
                                             "drift_gpart",
                                             "drift_gpart_out",
                                             "end_force",
                                             "kick1",
                                             "kick2",
                                             "timestep",
                                             "send",
                                             "recv",
                                             "grav_long_range",
                                             "grav_mm",
                                             "grav_down_in",
                                             "grav_down",
                                             "grav_mesh",
                                             "cooling",
                                             "star_formation",
                                             "sourceterms",
                                             "logger",
                                             "stars_ghost_in",
                                             "stars_ghost",
                                             "stars_ghost_out"};
83

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

90
91
92
93
94
#ifdef WITH_MPI
/* MPI communicators for the subtypes. */
MPI_Comm subtaskMPI_comms[task_subtype_count];
#endif

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

120
TASK_CELL_OVERLAP(part, hydro.parts, hydro.count);
121
122
TASK_CELL_OVERLAP(gpart, grav.parts, grav.count);
TASK_CELL_OVERLAP(spart, stars.parts, stars.count);
Loic Hausammann's avatar
Loic Hausammann committed
123

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

  switch (t->type) {

    case task_type_none:
      return task_action_none;
      break;

138
    case task_type_drift_part:
139
140
    case task_type_sort:
    case task_type_ghost:
141
    case task_type_extra_ghost:
Stefan Arridge's avatar
Stefan Arridge committed
142
    case task_type_cooling:
143
    case task_type_sourceterms:
144
145
146
      return task_action_part;
      break;

147
148
149
    case task_type_star_formation:
      return task_action_all;

150
    case task_type_stars_ghost:
Loic Hausammann's avatar
Loic Hausammann committed
151
152
153
      return task_action_spart;
      break;

154
155
156
157
158
159
160
    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:
161
        case task_subtype_gradient:
162
163
164
165
        case task_subtype_force:
          return task_action_part;
          break;

166
        case task_subtype_stars_density:
167
168
          return task_action_all;
          break;
169

170
        case task_subtype_grav:
171
        case task_subtype_external_grav:
172
173
174
175
176
177
178
179
180
181
          return task_action_gpart;
          break;

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

182
    case task_type_end_force:
183
184
    case task_type_kick1:
    case task_type_kick2:
Loikki's avatar
Loikki committed
185
    case task_type_logger:
186
    case task_type_timestep:
187
188
    case task_type_send:
    case task_type_recv:
189
      if (t->ci->hydro.count > 0 && t->ci->grav.count > 0)
190
        return task_action_all;
191
      else if (t->ci->hydro.count > 0)
192
        return task_action_part;
193
      else if (t->ci->grav.count > 0)
194
195
196
        return task_action_gpart;
      else
        error("Task without particles");
197
198
      break;

199
    case task_type_init_grav:
200
    case task_type_grav_mm:
201
    case task_type_grav_long_range:
202
203
204
      return task_action_multipole;
      break;

205
    case task_type_drift_gpart:
206
    case task_type_grav_down:
207
    case task_type_grav_mesh:
208
      return task_action_gpart;
209
      break;
210

211
    default:
212
      error("Unknown task_action for task");
213
214
215
      return task_action_none;
      break;
  }
216

217
  /* Silence compiler warnings */
218
219
  error("Unknown task_action for task");
  return task_action_none;
220
221
}

222
223
224
225
226
227
228
/**
 * @brief Compute the Jaccard similarity of the data used by two
 *        different tasks.
 *
 * @param ta The first #task.
 * @param tb The second #task.
 */
229
230
float task_overlap(const struct task *restrict ta,
                   const struct task *restrict tb) {
231
232
233
234
235
236

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

237
238
  /* First check if any of the two tasks are of a type that don't
     use cells. */
239
240
241
242
243
  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);
244
245
  const int ta_spart =
      (ta_act == task_action_spart || ta_act == task_action_all);
246
247
248
  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);
249
250
  const int tb_spart =
      (tb_act == task_action_spart || tb_act == task_action_all);
251
252
253
254
255
256

  /* 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;
257
258
259
260
    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;
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275

    /* 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;
276
277
278
279
    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;
280
281
282
283
284
285
286
287
288

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

Loic Hausammann's avatar
Loic Hausammann committed
290
291
292
293
294
  /* 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;
295
296
297
298
    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
299
300
301
302
303
304
305
306
307
308

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

309
310
  /* Else, no overlap */
  return 0.f;
311
}
312

313
314
/**
 * @brief Unlock the cell held by this task.
315
 *
316
317
 * @param t The #task.
 */
318
319
void task_unlock(struct task *t) {

320
321
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
322
323
  struct cell *ci = t->ci, *cj = t->cj;

324
  /* Act based on task type. */
325
326
  switch (type) {

327
    case task_type_end_force:
328
329
    case task_type_kick1:
    case task_type_kick2:
330
    case task_type_logger:
331
    case task_type_timestep:
332
333
334
      cell_unlocktree(ci);
      cell_gunlocktree(ci);
      break;
Matthieu Schaller's avatar
Matthieu Schaller committed
335

336
    case task_type_drift_part:
337
    case task_type_sort:
338
339
340
      cell_unlocktree(ci);
      break;

341
    case task_type_drift_gpart:
342
    case task_type_grav_mesh:
343
344
345
      cell_gunlocktree(ci);
      break;

346
    case task_type_self:
347
    case task_type_sub_self:
348
349
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
350
        cell_munlocktree(ci);
351
352
353
      } else {
        cell_unlocktree(ci);
      }
354
      break;
355

356
    case task_type_pair:
357
    case task_type_sub_pair:
358
359
360
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        cell_gunlocktree(cj);
361
362
        cell_munlocktree(ci);
        cell_munlocktree(cj);
363
364
365
366
367
368
      } else {
        cell_unlocktree(ci);
        cell_unlocktree(cj);
      }
      break;

369
    case task_type_grav_down:
370
      cell_gunlocktree(ci);
371
372
373
      cell_munlocktree(ci);
      break;

374
    case task_type_grav_long_range:
375
      cell_munlocktree(ci);
376
      break;
377

378
379
380
381
382
    case task_type_grav_mm:
      cell_munlocktree(ci);
      cell_munlocktree(cj);
      break;

383
384
385
386
    default:
      break;
  }
}
387
388
389
390
391
392

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

395
396
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
397
  struct cell *ci = t->ci, *cj = t->cj;
398
399
400
401
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
402

403
  switch (type) {
404

405
406
407
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
408
#ifdef WITH_MPI
409
410
411
412
413
      /* 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);
414
415
        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);
416
417
      }
      return res;
418
#else
419
      error("SWIFT was not compiled with MPI support.");
420
#endif
421
      break;
422

423
    case task_type_end_force:
424
425
    case task_type_kick1:
    case task_type_kick2:
Loikki's avatar
Loikki committed
426
    case task_type_logger:
427
    case task_type_timestep:
428
      if (ci->hydro.hold || ci->grav.phold) return 0;
429
430
      if (cell_locktree(ci) != 0) return 0;
      if (cell_glocktree(ci) != 0) {
Matthieu Schaller's avatar
Matthieu Schaller committed
431
432
        cell_unlocktree(ci);
        return 0;
433
434
435
      }
      break;

436
    case task_type_drift_part:
437
    case task_type_sort:
438
      if (ci->hydro.hold) return 0;
439
440
      if (cell_locktree(ci) != 0) return 0;
      break;
441

442
    case task_type_drift_gpart:
443
    case task_type_grav_mesh:
444
      if (ci->grav.phold) return 0;
445
446
447
      if (cell_glocktree(ci) != 0) return 0;
      break;

448
    case task_type_self:
449
    case task_type_sub_self:
450
      if (subtype == task_subtype_grav) {
451
        /* Lock the gparts and the m-pole */
452
        if (ci->grav.phold || ci->grav.mhold) return 0;
453
454
455
456
457
458
        if (cell_glocktree(ci) != 0)
          return 0;
        else if (cell_mlocktree(ci) != 0) {
          cell_gunlocktree(ci);
          return 0;
        }
459
460
461
462
      } else {
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
463

464
    case task_type_pair:
465
    case task_type_sub_pair:
466
      if (subtype == task_subtype_grav) {
467
        /* Lock the gparts and the m-pole in both cells */
468
        if (ci->grav.phold || cj->grav.phold) return 0;
469
470
471
472
        if (cell_glocktree(ci) != 0) return 0;
        if (cell_glocktree(cj) != 0) {
          cell_gunlocktree(ci);
          return 0;
473
474
475
476
477
478
479
480
481
        } 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;
482
483
        }
      } else {
484
        /* Lock the parts in both cells */
485
        if (ci->hydro.hold || cj->hydro.hold) return 0;
486
487
488
489
490
491
492
        if (cell_locktree(ci) != 0) return 0;
        if (cell_locktree(cj) != 0) {
          cell_unlocktree(ci);
          return 0;
        }
      }
      break;
493

494
495
    case task_type_grav_down:
      /* Lock the gparts and the m-poles */
496
      if (ci->grav.phold || ci->grav.mhold) return 0;
497
498
499
500
501
502
503
504
      if (cell_glocktree(ci) != 0)
        return 0;
      else if (cell_mlocktree(ci) != 0) {
        cell_gunlocktree(ci);
        return 0;
      }
      break;

505
    case task_type_grav_long_range:
506
      /* Lock the m-poles */
507
      if (ci->grav.mhold) return 0;
508
      if (cell_mlocktree(ci) != 0) return 0;
Matthieu Schaller's avatar
Matthieu Schaller committed
509
510
      break;

511
512
    case task_type_grav_mm:
      /* Lock both m-poles */
513
      if (ci->grav.mhold || cj->grav.mhold) return 0;
514
515
516
517
518
519
      if (cell_mlocktree(ci) != 0) return 0;
      if (cell_mlocktree(cj) != 0) {
        cell_munlocktree(ci);
        return 0;
      }

520
521
    default:
      break;
522
523
524
525
526
  }

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

528
529
530
531
532
533
534
535
536
537
538
/**
 * @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);
}
539
540
541
542
543
544
545
546
547
548
549

#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