task.c 15.5 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
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",    "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"};
62

63
/* Sub-task type names. */
64
const char *subtaskID_names[task_subtype_count] = {
65
66
67
    "none",          "density", "gradient",     "force", "grav",
    "external_grav", "tend",    "xv",           "rho",   "gpart",
    "multipole",     "spart",   "stars_density"};
68

69
70
71
72
73
#ifdef WITH_MPI
/* MPI communicators for the subtypes. */
MPI_Comm subtaskMPI_comms[task_subtype_count];
#endif

74
75
/**
 * @brief Computes the overlap between the parts array of two given cells.
76
 *
Matthieu Schaller's avatar
Matthieu Schaller committed
77
78
79
 * @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.
80
 */
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
#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;                                                               \
  }
98

99
TASK_CELL_OVERLAP(part, hydro.parts, hydro.count);
100
101
TASK_CELL_OVERLAP(gpart, grav.parts, grav.count);
TASK_CELL_OVERLAP(spart, stars.parts, stars.count);
Loic Hausammann's avatar
Loic Hausammann committed
102

103
104
105
106
107
/**
 * @brief Returns the #task_actions for a given task.
 *
 * @param t The #task.
 */
108
109
__attribute__((always_inline)) INLINE static enum task_actions task_acts_on(
    const struct task *t) {
110
111
112
113
114
115
116

  switch (t->type) {

    case task_type_none:
      return task_action_none;
      break;

117
    case task_type_drift_part:
118
119
    case task_type_sort:
    case task_type_ghost:
120
    case task_type_extra_ghost:
Stefan Arridge's avatar
Stefan Arridge committed
121
    case task_type_cooling:
122
    case task_type_sourceterms:
123
124
125
      return task_action_part;
      break;

126
127
128
    case task_type_star_formation:
      return task_action_all;

129
    case task_type_stars_ghost:
Loic Hausammann's avatar
Loic Hausammann committed
130
131
132
      return task_action_spart;
      break;

133
134
135
136
137
138
139
    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:
140
        case task_subtype_gradient:
141
142
143
144
        case task_subtype_force:
          return task_action_part;
          break;

145
        case task_subtype_stars_density:
146
147
          return task_action_all;
          break;
148

149
        case task_subtype_grav:
150
        case task_subtype_external_grav:
151
152
153
154
155
156
157
158
159
160
          return task_action_gpart;
          break;

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

161
    case task_type_end_force:
162
163
    case task_type_kick1:
    case task_type_kick2:
Loikki's avatar
Loikki committed
164
    case task_type_logger:
165
    case task_type_timestep:
166
167
    case task_type_send:
    case task_type_recv:
168
      if (t->ci->hydro.count > 0 && t->ci->grav.count > 0)
169
        return task_action_all;
170
      else if (t->ci->hydro.count > 0)
171
        return task_action_part;
172
      else if (t->ci->grav.count > 0)
173
174
175
        return task_action_gpart;
      else
        error("Task without particles");
176
177
      break;

178
    case task_type_init_grav:
179
    case task_type_grav_mm:
180
    case task_type_grav_long_range:
181
182
183
      return task_action_multipole;
      break;

184
    case task_type_drift_gpart:
185
    case task_type_grav_down:
186
    case task_type_grav_mesh:
187
      return task_action_gpart;
188
      break;
189

190
    default:
191
      error("Unknown task_action for task");
192
193
194
      return task_action_none;
      break;
  }
195

196
  /* Silence compiler warnings */
197
198
  error("Unknown task_action for task");
  return task_action_none;
199
200
}

201
202
203
204
205
206
207
/**
 * @brief Compute the Jaccard similarity of the data used by two
 *        different tasks.
 *
 * @param ta The first #task.
 * @param tb The second #task.
 */
208
209
float task_overlap(const struct task *restrict ta,
                   const struct task *restrict tb) {
210
211
212
213
214
215

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

216
217
  /* First check if any of the two tasks are of a type that don't
     use cells. */
218
219
220
221
222
  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);
223
224
  const int ta_spart =
      (ta_act == task_action_spart || ta_act == task_action_all);
225
226
227
  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);
228
229
  const int tb_spart =
      (tb_act == task_action_spart || tb_act == task_action_all);
230
231
232
233
234
235

  /* 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;
236
237
238
239
    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;
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254

    /* 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;
255
256
257
258
    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;
259
260
261
262
263
264
265
266
267

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

Loic Hausammann's avatar
Loic Hausammann committed
269
270
271
272
273
  /* 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;
274
275
276
277
    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
278
279
280
281
282
283
284
285
286
287

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

288
289
  /* Else, no overlap */
  return 0.f;
290
}
291

292
293
/**
 * @brief Unlock the cell held by this task.
294
 *
295
296
 * @param t The #task.
 */
297
298
void task_unlock(struct task *t) {

299
300
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
301
302
  struct cell *ci = t->ci, *cj = t->cj;

303
  /* Act based on task type. */
304
305
  switch (type) {

306
    case task_type_end_force:
307
308
    case task_type_kick1:
    case task_type_kick2:
309
    case task_type_logger:
310
    case task_type_timestep:
311
312
313
      cell_unlocktree(ci);
      cell_gunlocktree(ci);
      break;
Matthieu Schaller's avatar
Matthieu Schaller committed
314

315
    case task_type_drift_part:
316
    case task_type_sort:
317
318
319
      cell_unlocktree(ci);
      break;

320
    case task_type_drift_gpart:
321
    case task_type_grav_mesh:
322
323
324
      cell_gunlocktree(ci);
      break;

325
    case task_type_self:
326
    case task_type_sub_self:
327
328
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
329
        cell_munlocktree(ci);
330
331
332
      } else {
        cell_unlocktree(ci);
      }
333
      break;
334

335
    case task_type_pair:
336
    case task_type_sub_pair:
337
338
339
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        cell_gunlocktree(cj);
340
341
        cell_munlocktree(ci);
        cell_munlocktree(cj);
342
343
344
345
346
347
      } else {
        cell_unlocktree(ci);
        cell_unlocktree(cj);
      }
      break;

348
    case task_type_grav_down:
349
      cell_gunlocktree(ci);
350
351
352
      cell_munlocktree(ci);
      break;

353
    case task_type_grav_long_range:
354
      cell_munlocktree(ci);
355
      break;
356

357
358
359
360
361
    case task_type_grav_mm:
      cell_munlocktree(ci);
      cell_munlocktree(cj);
      break;

362
363
364
365
    default:
      break;
  }
}
366
367
368
369
370
371

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

374
375
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
376
  struct cell *ci = t->ci, *cj = t->cj;
377
378
379
380
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
381

382
  switch (type) {
383

384
385
386
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
387
#ifdef WITH_MPI
388
389
390
391
392
      /* 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);
393
        error("Failed to test request on send/recv task (tag=%lld, %s).",
394
395
396
              t->flags, buff);
      }
      return res;
397
#else
398
      error("SWIFT was not compiled with MPI support.");
399
#endif
400
      break;
401

402
    case task_type_end_force:
403
404
    case task_type_kick1:
    case task_type_kick2:
Loikki's avatar
Loikki committed
405
    case task_type_logger:
406
    case task_type_timestep:
407
      if (ci->hydro.hold || ci->grav.phold) return 0;
408
409
      if (cell_locktree(ci) != 0) return 0;
      if (cell_glocktree(ci) != 0) {
Matthieu Schaller's avatar
Matthieu Schaller committed
410
411
        cell_unlocktree(ci);
        return 0;
412
413
414
      }
      break;

415
    case task_type_drift_part:
416
    case task_type_sort:
417
      if (ci->hydro.hold) return 0;
418
419
      if (cell_locktree(ci) != 0) return 0;
      break;
420

421
    case task_type_drift_gpart:
422
    case task_type_grav_mesh:
423
      if (ci->grav.phold) return 0;
424
425
426
      if (cell_glocktree(ci) != 0) return 0;
      break;

427
    case task_type_self:
428
    case task_type_sub_self:
429
      if (subtype == task_subtype_grav) {
430
        /* Lock the gparts and the m-pole */
431
        if (ci->grav.phold || ci->grav.mhold) return 0;
432
433
434
435
436
437
        if (cell_glocktree(ci) != 0)
          return 0;
        else if (cell_mlocktree(ci) != 0) {
          cell_gunlocktree(ci);
          return 0;
        }
438
439
440
441
      } else {
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
442

443
    case task_type_pair:
444
    case task_type_sub_pair:
445
      if (subtype == task_subtype_grav) {
446
        /* Lock the gparts and the m-pole in both cells */
447
        if (ci->grav.phold || cj->grav.phold) return 0;
448
449
450
451
        if (cell_glocktree(ci) != 0) return 0;
        if (cell_glocktree(cj) != 0) {
          cell_gunlocktree(ci);
          return 0;
452
453
454
455
456
457
458
459
460
        } 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;
461
462
        }
      } else {
463
        /* Lock the parts in both cells */
464
        if (ci->hydro.hold || cj->hydro.hold) return 0;
465
466
467
468
469
470
471
        if (cell_locktree(ci) != 0) return 0;
        if (cell_locktree(cj) != 0) {
          cell_unlocktree(ci);
          return 0;
        }
      }
      break;
472

473
474
    case task_type_grav_down:
      /* Lock the gparts and the m-poles */
475
      if (ci->grav.phold || ci->grav.mhold) return 0;
476
477
478
479
480
481
482
483
      if (cell_glocktree(ci) != 0)
        return 0;
      else if (cell_mlocktree(ci) != 0) {
        cell_gunlocktree(ci);
        return 0;
      }
      break;

484
    case task_type_grav_long_range:
485
      /* Lock the m-poles */
486
      if (ci->grav.mhold) return 0;
487
      if (cell_mlocktree(ci) != 0) return 0;
Matthieu Schaller's avatar
Matthieu Schaller committed
488
489
      break;

490
491
    case task_type_grav_mm:
      /* Lock both m-poles */
492
      if (ci->grav.mhold || cj->grav.mhold) return 0;
493
494
495
496
497
498
      if (cell_mlocktree(ci) != 0) return 0;
      if (cell_mlocktree(cj) != 0) {
        cell_munlocktree(ci);
        return 0;
      }

499
500
    default:
      break;
501
502
503
504
505
  }

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

507
508
509
510
511
512
513
514
515
516
517
/**
 * @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);
}
518
519
520
521
522
523
524
525
526
527
528

#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