task.c 12.8 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] = {
Matthieu Schaller's avatar
Matthieu Schaller committed
51
52
53
54
55
    "none",          "sort",           "self",           "pair",
    "sub_self",      "sub_pair",       "init_grav",      "ghost_in",
    "ghost",         "ghost_out",      "extra_ghost",    "drift_part",
    "drift_gpart",   "kick1",          "kick2",          "timestep",
    "send",          "recv",           "grav_top_level", "grav_long_range",
56
    "grav_ghost_in", "grav_ghost_out", "grav_mm",        "grav_down",
Matthieu Schaller's avatar
Matthieu Schaller committed
57
    "cooling",       "sourceterms"};
58

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

64
65
/**
 * @brief Computes the overlap between the parts array of two given cells.
66
67
68
 *
 * @param ci The first #cell.
 * @param cj The second #cell.
69
 */
70
__attribute__((always_inline)) INLINE static size_t task_cell_overlap_part(
71
    const struct cell *restrict ci, const struct cell *restrict cj) {
72

73
  if (ci == NULL || cj == NULL) return 0;
74

75
76
77
78
79
80
81
  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;
  }
82

83
84
85
  return 0;
}

86
87
/**
 * @brief Computes the overlap between the gparts array of two given cells.
88
89
90
 *
 * @param ci The first #cell.
 * @param cj The second #cell.
91
 */
92
__attribute__((always_inline)) INLINE static size_t task_cell_overlap_gpart(
93
    const struct cell *restrict ci, const struct cell *restrict cj) {
94

95
  if (ci == NULL || cj == NULL) return 0;
96

97
98
99
100
101
102
103
  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;
  }
104

105
106
107
108
109
110
111
112
  return 0;
}

/**
 * @brief Returns the #task_actions for a given task.
 *
 * @param t The #task.
 */
113
114
__attribute__((always_inline)) INLINE static enum task_actions task_acts_on(
    const struct task *t) {
115
116
117
118
119
120
121

  switch (t->type) {

    case task_type_none:
      return task_action_none;
      break;

122
    case task_type_drift_part:
123
124
    case task_type_sort:
    case task_type_ghost:
125
    case task_type_extra_ghost:
Stefan Arridge's avatar
Stefan Arridge committed
126
    case task_type_cooling:
127
    case task_type_sourceterms:
128
129
130
131
132
133
134
135
136
137
      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:
138
        case task_subtype_gradient:
139
140
141
142
143
        case task_subtype_force:
          return task_action_part;
          break;

        case task_subtype_grav:
144
        case task_subtype_external_grav:
145
146
147
148
149
150
151
152
153
154
          return task_action_gpart;
          break;

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

155
156
    case task_type_kick1:
    case task_type_kick2:
157
    case task_type_timestep:
158
159
    case task_type_send:
    case task_type_recv:
160
161
162
163
164
165
166
167
      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");
168
169
      break;

170
    case task_type_init_grav:
171
172
    case task_type_grav_top_level:
    case task_type_grav_long_range:
173
174
175
176
    case task_type_grav_mm:
      return task_action_multipole;
      break;

177
    case task_type_drift_gpart:
178
179
    case task_type_grav_down:
      return task_action_gpart;
180
      break;
181

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

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

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

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

208
209
  /* First check if any of the two tasks are of a type that don't
     use cells. */
210
211
212
213
214
215
216
217
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
256
257
258
  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;
259
}
260

261
262
/**
 * @brief Unlock the cell held by this task.
263
 *
264
265
 * @param t The #task.
 */
266
267
void task_unlock(struct task *t) {

268
269
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
270
271
  struct cell *ci = t->ci, *cj = t->cj;

272
  /* Act based on task type. */
273
274
  switch (type) {

275
276
277
    case task_type_kick1:
    case task_type_kick2:
    case task_type_timestep:
278
279
280
      cell_unlocktree(ci);
      cell_gunlocktree(ci);
      break;
Matthieu Schaller's avatar
Matthieu Schaller committed
281

282
    case task_type_drift_part:
283
    case task_type_sort:
284
285
286
      cell_unlocktree(ci);
      break;

287
288
289
290
    case task_type_drift_gpart:
      cell_gunlocktree(ci);
      break;

291
    case task_type_self:
292
    case task_type_sub_self:
293
294
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
295
        cell_munlocktree(ci);
296
297
298
      } else {
        cell_unlocktree(ci);
      }
299
      break;
300

301
    case task_type_pair:
302
    case task_type_sub_pair:
303
304
305
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        cell_gunlocktree(cj);
306
307
        cell_munlocktree(ci);
        cell_munlocktree(cj);
308
309
310
311
312
313
      } else {
        cell_unlocktree(ci);
        cell_unlocktree(cj);
      }
      break;

314
    case task_type_grav_down:
315
      cell_gunlocktree(ci);
316
317
318
319
320
321
      cell_munlocktree(ci);
      break;

    case task_type_grav_long_range:
    case task_type_grav_mm:
      cell_munlocktree(ci);
322
      break;
323

324
325
326
327
    default:
      break;
  }
}
328
329
330
331
332
333

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

336
337
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
338
  struct cell *ci = t->ci, *cj = t->cj;
339
340
341
342
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
343

344
  switch (type) {
345

346
347
348
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
349
#ifdef WITH_MPI
350
351
352
353
354
355
356
357
358
      /* 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;
359
#else
360
      error("SWIFT was not compiled with MPI support.");
361
#endif
362
      break;
363

364
365
366
    case task_type_kick1:
    case task_type_kick2:
    case task_type_timestep:
367
368
369
      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
370
371
        cell_unlocktree(ci);
        return 0;
372
373
374
      }
      break;

375
    case task_type_drift_part:
376
    case task_type_sort:
377
      if (ci->hold) return 0;
378
379
      if (cell_locktree(ci) != 0) return 0;
      break;
380

381
382
383
384
385
    case task_type_drift_gpart:
      if (ci->ghold) return 0;
      if (cell_glocktree(ci) != 0) return 0;
      break;

386
    case task_type_self:
387
    case task_type_sub_self:
388
      if (subtype == task_subtype_grav) {
389
390
391
392
393
394
395
396
        /* 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;
        }
397
398
399
400
      } else {
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
401

402
    case task_type_pair:
403
    case task_type_sub_pair:
404
      if (subtype == task_subtype_grav) {
405
        /* Lock the gparts and the m-pole in both cells */
406
407
408
409
410
        if (ci->ghold || cj->ghold) return 0;
        if (cell_glocktree(ci) != 0) return 0;
        if (cell_glocktree(cj) != 0) {
          cell_gunlocktree(ci);
          return 0;
411
412
413
414
415
416
417
418
419
        } 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;
420
421
        }
      } else {
422
        /* Lock the parts in both cells */
423
424
425
426
427
428
429
430
        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;
431

432
433
434
435
436
437
438
439
440
441
442
443
    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;

    case task_type_grav_long_range:
Matthieu Schaller's avatar
Matthieu Schaller committed
444
    case task_type_grav_mm:
445
446
447
      /* Lock the m-poles */
      if (ci->mhold) return 0;
      if (cell_mlocktree(ci) != 0) return 0;
Matthieu Schaller's avatar
Matthieu Schaller committed
448
449
      break;

450
451
    default:
      break;
452
453
454
455
456
  }

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

458
459
460
461
462
463
464
465
466
467
468
/**
 * @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);
}