task.c 14.4 KB
Newer Older
1
/*******************************************************************************
2
 * This file is part of SWIFT.
3
 * Copyright (c) 2012 Pedro Gonnet (pedro.gonnet@durham.ac.uk)
4
5
6
7
 *                    Matthieu Schaller (matthieu.schaller@durham.ac.uk)
 *               2015 Peter W. Draper (p.w.draper@durham.ac.uk)
 *               2016 John A. Regan (john.a.regan@durham.ac.uk)
 *                    Tom Theuns (tom.theuns@durham.ac.uk)
8
 *
9
10
11
12
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
13
 *
14
15
16
17
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
18
 *
19
20
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21
 *
22
23
24
25
26
27
28
29
30
 ******************************************************************************/

/* Config parameters. */
#include "../config.h"

/* Some standard headers. */
#include <float.h>
#include <limits.h>
#include <sched.h>
31
32
33
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
34

35
36
/* MPI headers. */
#ifdef WITH_MPI
37
#include <mpi.h>
38
39
#endif

40
41
42
/* This object's header. */
#include "task.h"

43
/* Local headers. */
Pedro Gonnet's avatar
Pedro Gonnet committed
44
#include "atomic.h"
45
#include "error.h"
46
#include "inline.h"
47
#include "lock.h"
48
49

/* Task type names. */
50
const char *taskID_names[task_type_count] = {
Loic Hausammann's avatar
Loic Hausammann committed
51
52
53
54
55
56
57
58
59
60
    "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",       "sourceterms",
    "star_ghost_in", "star_ghost",    "star_ghost_out"};
61

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

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

72
73
/**
 * @brief Computes the overlap between the parts array of two given cells.
74
 *
Loic Hausammann's avatar
Loic Hausammann committed
75
 * TYPE is the type of parts (e.g. #part, #gpart, #spart)
76
77
78
 *
 * @param ci The first #cell.
 * @param cj The second #cell.
79
 */
Loic Hausammann's avatar
Loic Hausammann committed
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
#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;								\
95
96
}

Loic Hausammann's avatar
Loic Hausammann committed
97
98
99
100
TASK_CELL_OVERLAP(part, parts, count);
TASK_CELL_OVERLAP(gpart, gparts, gcount);
TASK_CELL_OVERLAP(spart, sparts, scount);

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

  switch (t->type) {

    case task_type_none:
      return task_action_none;
      break;

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

Loic Hausammann's avatar
Loic Hausammann committed
124
125
126
127
    case task_type_star_ghost:
      return task_action_spart;
      break;

128
129
130
131
132
133
134
    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:
135
        case task_subtype_gradient:
136
137
138
139
140
        case task_subtype_force:
          return task_action_part;
          break;

        case task_subtype_grav:
141
        case task_subtype_external_grav:
142
143
144
145
146
147
148
149
150
151
          return task_action_gpart;
          break;

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

152
    case task_type_end_force:
153
154
    case task_type_kick1:
    case task_type_kick2:
155
    case task_type_timestep:
156
157
    case task_type_send:
    case task_type_recv:
158
159
160
161
162
163
164
165
      if (t->ci->count > 0 && t->ci->gcount > 0)
        return task_action_all;
      else if (t->ci->count > 0)
        return task_action_part;
      else if (t->ci->gcount > 0)
        return task_action_gpart;
      else
        error("Task without particles");
166
167
      break;

168
    case task_type_init_grav:
169
170
171
172
    case task_type_grav_mm:
      return task_action_multipole;
      break;

173
    case task_type_drift_gpart:
174
    case task_type_grav_down:
175
    case task_type_grav_mesh:
176
    case task_type_grav_long_range:
177
      return task_action_gpart;
178
      break;
179

180
    default:
181
      error("Unknown task_action for task");
182
183
184
      return task_action_none;
      break;
  }
185

186
  /* Silence compiler warnings */
187
188
  error("Unknown task_action for task");
  return task_action_none;
189
190
}

191
192
193
194
195
196
197
/**
 * @brief Compute the Jaccard similarity of the data used by two
 *        different tasks.
 *
 * @param ta The first #task.
 * @param tb The second #task.
 */
198
199
float task_overlap(const struct task *restrict ta,
                   const struct task *restrict tb) {
200
201
202
203
204
205

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

206
207
  /* First check if any of the two tasks are of a type that don't
     use cells. */
208
209
210
211
212
  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);
Loic Hausammann's avatar
Loic Hausammann committed
213
  const int ta_spart = (ta_act == task_action_spart || ta_act == task_action_all);
214
215
216
  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);
Loic Hausammann's avatar
Loic Hausammann committed
217
  const int tb_spart = (tb_act == task_action_spart || tb_act == task_action_all);
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255

  /* 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;
    if (ta->ci != NULL) size_union += ta->ci->count;
    if (ta->cj != NULL) size_union += ta->cj->count;
    if (tb->ci != NULL) size_union += tb->ci->count;
    if (tb->cj != NULL) size_union += tb->cj->count;

    /* 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;
    if (ta->ci != NULL) size_union += ta->ci->gcount;
    if (ta->cj != NULL) size_union += ta->cj->gcount;
    if (tb->ci != NULL) size_union += tb->ci->gcount;
    if (tb->cj != NULL) size_union += tb->cj->gcount;

    /* 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);
  }
Loic Hausammann's avatar
Loic Hausammann committed
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
  
  /* 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;
    if (ta->ci != NULL) size_union += ta->ci->scount;
    if (ta->cj != NULL) size_union += ta->cj->scount;
    if (tb->ci != NULL) size_union += tb->ci->scount;
    if (tb->cj != NULL) size_union += tb->cj->scount;

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

276
277
278

  /* Else, no overlap */
  return 0.f;
279
}
280

281
282
/**
 * @brief Unlock the cell held by this task.
283
 *
284
285
 * @param t The #task.
 */
286
287
void task_unlock(struct task *t) {

288
289
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
290
291
  struct cell *ci = t->ci, *cj = t->cj;

292
  /* Act based on task type. */
293
294
  switch (type) {

295
    case task_type_end_force:
296
297
298
    case task_type_kick1:
    case task_type_kick2:
    case task_type_timestep:
299
300
301
      cell_unlocktree(ci);
      cell_gunlocktree(ci);
      break;
Matthieu Schaller's avatar
Matthieu Schaller committed
302

303
    case task_type_drift_part:
304
    case task_type_sort:
305
306
307
      cell_unlocktree(ci);
      break;

308
    case task_type_drift_gpart:
309
    case task_type_grav_mesh:
310
311
312
      cell_gunlocktree(ci);
      break;

313
    case task_type_self:
314
    case task_type_sub_self:
315
316
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
317
        cell_munlocktree(ci);
318
319
320
      } else {
        cell_unlocktree(ci);
      }
321
      break;
322

323
    case task_type_pair:
324
    case task_type_sub_pair:
325
326
327
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        cell_gunlocktree(cj);
328
329
        cell_munlocktree(ci);
        cell_munlocktree(cj);
330
331
332
333
334
335
      } else {
        cell_unlocktree(ci);
        cell_unlocktree(cj);
      }
      break;

336
    case task_type_grav_down:
337
      cell_gunlocktree(ci);
338
339
340
      cell_munlocktree(ci);
      break;

341
    case task_type_grav_long_range:
342
      cell_munlocktree(ci);
343
      break;
344

345
346
347
348
349
    case task_type_grav_mm:
      cell_munlocktree(ci);
      cell_munlocktree(cj);
      break;

350
351
352
353
    default:
      break;
  }
}
354
355
356
357
358
359

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

362
363
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
364
  struct cell *ci = t->ci, *cj = t->cj;
365
366
367
368
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
369

370
  switch (type) {
371

372
373
374
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
375
#ifdef WITH_MPI
376
377
378
379
380
381
382
383
384
      /* 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);
        error("Failed to test request on send/recv task (tag=%i, %s).",
              t->flags, buff);
      }
      return res;
385
#else
386
      error("SWIFT was not compiled with MPI support.");
387
#endif
388
      break;
389

390
    case task_type_end_force:
391
392
393
    case task_type_kick1:
    case task_type_kick2:
    case task_type_timestep:
394
395
396
      if (ci->hold || ci->ghold) return 0;
      if (cell_locktree(ci) != 0) return 0;
      if (cell_glocktree(ci) != 0) {
Matthieu Schaller's avatar
Matthieu Schaller committed
397
398
        cell_unlocktree(ci);
        return 0;
399
400
401
      }
      break;

402
    case task_type_drift_part:
403
    case task_type_sort:
404
      if (ci->hold) return 0;
405
406
      if (cell_locktree(ci) != 0) return 0;
      break;
407

408
    case task_type_drift_gpart:
409
    case task_type_grav_mesh:
410
411
412
413
      if (ci->ghold) return 0;
      if (cell_glocktree(ci) != 0) return 0;
      break;

414
    case task_type_self:
415
    case task_type_sub_self:
416
      if (subtype == task_subtype_grav) {
417
418
419
420
421
422
423
424
        /* Lock the gparts and the m-pole */
        if (ci->ghold || ci->mhold) return 0;
        if (cell_glocktree(ci) != 0)
          return 0;
        else if (cell_mlocktree(ci) != 0) {
          cell_gunlocktree(ci);
          return 0;
        }
425
426
427
428
      } else {
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
429

430
    case task_type_pair:
431
    case task_type_sub_pair:
432
      if (subtype == task_subtype_grav) {
433
        /* Lock the gparts and the m-pole in both cells */
434
435
436
437
438
        if (ci->ghold || cj->ghold) return 0;
        if (cell_glocktree(ci) != 0) return 0;
        if (cell_glocktree(cj) != 0) {
          cell_gunlocktree(ci);
          return 0;
439
440
441
442
443
444
445
446
447
        } 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;
448
449
        }
      } else {
450
        /* Lock the parts in both cells */
451
452
453
454
455
456
457
458
        if (ci->hold || cj->hold) return 0;
        if (cell_locktree(ci) != 0) return 0;
        if (cell_locktree(cj) != 0) {
          cell_unlocktree(ci);
          return 0;
        }
      }
      break;
459

460
461
462
463
464
465
466
467
468
469
470
    case task_type_grav_down:
      /* Lock the gparts and the m-poles */
      if (ci->ghold || ci->mhold) return 0;
      if (cell_glocktree(ci) != 0)
        return 0;
      else if (cell_mlocktree(ci) != 0) {
        cell_gunlocktree(ci);
        return 0;
      }
      break;

471
    case task_type_grav_long_range:
472
473
474
      /* Lock the m-poles */
      if (ci->mhold) return 0;
      if (cell_mlocktree(ci) != 0) return 0;
Matthieu Schaller's avatar
Matthieu Schaller committed
475
476
      break;

477
478
479
480
481
482
483
484
485
    case task_type_grav_mm:
      /* Lock both m-poles */
      if (ci->mhold || cj->mhold) return 0;
      if (cell_mlocktree(ci) != 0) return 0;
      if (cell_mlocktree(cj) != 0) {
        cell_munlocktree(ci);
        return 0;
      }

486
487
    default:
      break;
488
489
490
491
492
  }

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

494
495
496
497
498
499
500
501
502
503
504
/**
 * @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);
}
505
506
507
508
509
510
511
512
513
514
515

#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