task.c 13.6 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
75
76
 *
 * @param ci The first #cell.
 * @param cj The second #cell.
77
 */
78
__attribute__((always_inline)) INLINE static size_t task_cell_overlap_part(
79
    const struct cell *restrict ci, const struct cell *restrict cj) {
80

81
  if (ci == NULL || cj == NULL) return 0;
82

83
84
85
86
87
88
89
  if (ci->parts <= cj->parts &&
      ci->parts + ci->count >= cj->parts + cj->count) {
    return cj->count;
  } else if (cj->parts <= ci->parts &&
             cj->parts + cj->count >= ci->parts + ci->count) {
    return ci->count;
  }
90

91
92
93
  return 0;
}

94
95
/**
 * @brief Computes the overlap between the gparts array of two given cells.
96
97
98
 *
 * @param ci The first #cell.
 * @param cj The second #cell.
99
 */
100
__attribute__((always_inline)) INLINE static size_t task_cell_overlap_gpart(
101
    const struct cell *restrict ci, const struct cell *restrict cj) {
102

103
  if (ci == NULL || cj == NULL) return 0;
104

105
106
107
108
109
110
111
  if (ci->gparts <= cj->gparts &&
      ci->gparts + ci->gcount >= cj->gparts + cj->gcount) {
    return cj->gcount;
  } else if (cj->gparts <= ci->gparts &&
             cj->gparts + cj->gcount >= ci->gparts + ci->gcount) {
    return ci->gcount;
  }
112

113
114
115
116
117
118
119
120
  return 0;
}

/**
 * @brief Returns the #task_actions for a given task.
 *
 * @param t The #task.
 */
121
122
__attribute__((always_inline)) INLINE static enum task_actions task_acts_on(
    const struct task *t) {
123
124
125
126
127
128
129

  switch (t->type) {

    case task_type_none:
      return task_action_none;
      break;

130
    case task_type_drift_part:
131
132
    case task_type_sort:
    case task_type_ghost:
133
    case task_type_extra_ghost:
Stefan Arridge's avatar
Stefan Arridge committed
134
    case task_type_cooling:
135
    case task_type_sourceterms:
136
137
138
139
140
141
142
143
144
145
      return task_action_part;
      break;

    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:
146
        case task_subtype_gradient:
147
148
149
150
151
        case task_subtype_force:
          return task_action_part;
          break;

        case task_subtype_grav:
152
        case task_subtype_external_grav:
153
154
155
156
157
158
159
160
161
162
          return task_action_gpart;
          break;

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

163
    case task_type_end_force:
164
165
    case task_type_kick1:
    case task_type_kick2:
166
    case task_type_timestep:
167
168
    case task_type_send:
    case task_type_recv:
169
170
171
172
173
174
175
176
      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");
177
178
      break;

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

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

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

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

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

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

217
218
  /* First check if any of the two tasks are of a type that don't
     use cells. */
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
256
257
258
259
260
261
262
263
264
265
266
267
  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);
  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);

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

  /* Else, no overlap */
  return 0.f;
268
}
269

270
271
/**
 * @brief Unlock the cell held by this task.
272
 *
273
274
 * @param t The #task.
 */
275
276
void task_unlock(struct task *t) {

277
278
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
279
280
  struct cell *ci = t->ci, *cj = t->cj;

281
  /* Act based on task type. */
282
283
  switch (type) {

284
    case task_type_end_force:
285
286
287
    case task_type_kick1:
    case task_type_kick2:
    case task_type_timestep:
288
289
290
      cell_unlocktree(ci);
      cell_gunlocktree(ci);
      break;
Matthieu Schaller's avatar
Matthieu Schaller committed
291

292
    case task_type_drift_part:
293
    case task_type_sort:
294
295
296
      cell_unlocktree(ci);
      break;

297
    case task_type_drift_gpart:
298
    case task_type_grav_mesh:
299
300
301
      cell_gunlocktree(ci);
      break;

302
    case task_type_self:
303
    case task_type_sub_self:
304
305
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
306
        cell_munlocktree(ci);
307
308
309
      } else {
        cell_unlocktree(ci);
      }
310
      break;
311

312
    case task_type_pair:
313
    case task_type_sub_pair:
314
315
316
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        cell_gunlocktree(cj);
317
318
        cell_munlocktree(ci);
        cell_munlocktree(cj);
319
320
321
322
323
324
      } else {
        cell_unlocktree(ci);
        cell_unlocktree(cj);
      }
      break;

325
    case task_type_grav_down:
326
      cell_gunlocktree(ci);
327
328
329
      cell_munlocktree(ci);
      break;

330
    case task_type_grav_long_range:
331
      cell_munlocktree(ci);
332
      break;
333

334
335
336
337
338
    case task_type_grav_mm:
      cell_munlocktree(ci);
      cell_munlocktree(cj);
      break;

339
340
341
342
    default:
      break;
  }
}
343
344
345
346
347
348

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

351
352
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
353
  struct cell *ci = t->ci, *cj = t->cj;
354
355
356
357
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
358

359
  switch (type) {
360

361
362
363
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
364
#ifdef WITH_MPI
365
366
367
368
369
370
371
372
373
      /* 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;
374
#else
375
      error("SWIFT was not compiled with MPI support.");
376
#endif
377
      break;
378

379
    case task_type_end_force:
380
381
382
    case task_type_kick1:
    case task_type_kick2:
    case task_type_timestep:
383
384
385
      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
386
387
        cell_unlocktree(ci);
        return 0;
388
389
390
      }
      break;

391
    case task_type_drift_part:
392
    case task_type_sort:
393
      if (ci->hold) return 0;
394
395
      if (cell_locktree(ci) != 0) return 0;
      break;
396

397
    case task_type_drift_gpart:
398
    case task_type_grav_mesh:
399
400
401
402
      if (ci->ghold) return 0;
      if (cell_glocktree(ci) != 0) return 0;
      break;

403
    case task_type_self:
404
    case task_type_sub_self:
405
      if (subtype == task_subtype_grav) {
406
407
408
409
410
411
412
413
        /* 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;
        }
414
415
416
417
      } else {
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
418

419
    case task_type_pair:
420
    case task_type_sub_pair:
421
      if (subtype == task_subtype_grav) {
422
        /* Lock the gparts and the m-pole in both cells */
423
424
425
426
427
        if (ci->ghold || cj->ghold) return 0;
        if (cell_glocktree(ci) != 0) return 0;
        if (cell_glocktree(cj) != 0) {
          cell_gunlocktree(ci);
          return 0;
428
429
430
431
432
433
434
435
436
        } 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;
437
438
        }
      } else {
439
        /* Lock the parts in both cells */
440
441
442
443
444
445
446
447
        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;
448

449
450
451
452
453
454
455
456
457
458
459
    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;

460
    case task_type_grav_long_range:
461
462
463
      /* Lock the m-poles */
      if (ci->mhold) return 0;
      if (cell_mlocktree(ci) != 0) return 0;
Matthieu Schaller's avatar
Matthieu Schaller committed
464
465
      break;

466
467
468
469
470
471
472
473
474
    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;
      }

475
476
    default:
      break;
477
478
479
480
481
  }

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

483
484
485
486
487
488
489
490
491
492
493
/**
 * @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);
}
494
495
496
497
498
499
500
501
502
503
504

#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