task.c 13 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] = {
51
52
53
54
55
56
57
58
    "none",          "sort",           "self",
    "pair",          "sub_self",       "sub_pair",
    "init_grav",     "ghost_in",       "ghost",
    "ghost_out",     "extra_ghost",    "drift_part",
    "drift_gpart",   "end_force",      "kick1",
    "kick2",         "timestep",       "send",
    "recv",          "grav_top_level", "grav_long_range",
    "grav_ghost_in", "grav_ghost_out", "grav_mm",
59
60
    "grav_down",     "grav_mesh",      "cooling",
    "sourceterms"};
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
/**
 * @brief Computes the overlap between the parts array of two given cells.
69
70
71
 *
 * @param ci The first #cell.
 * @param cj The second #cell.
72
 */
73
__attribute__((always_inline)) INLINE static size_t task_cell_overlap_part(
74
    const struct cell *restrict ci, const struct cell *restrict cj) {
75

76
  if (ci == NULL || cj == NULL) return 0;
77

78
79
80
81
82
83
84
  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;
  }
85

86
87
88
  return 0;
}

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

98
  if (ci == NULL || cj == NULL) return 0;
99

100
101
102
103
104
105
106
  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;
  }
107

108
109
110
111
112
113
114
115
  return 0;
}

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

  switch (t->type) {

    case task_type_none:
      return task_action_none;
      break;

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

        case task_subtype_grav:
147
        case task_subtype_external_grav:
148
149
150
151
152
153
154
155
156
157
          return task_action_gpart;
          break;

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

158
    case task_type_end_force:
159
160
    case task_type_kick1:
    case task_type_kick2:
161
    case task_type_timestep:
162
163
    case task_type_send:
    case task_type_recv:
164
165
166
167
168
169
170
171
      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");
172
173
      break;

174
    case task_type_init_grav:
175
176
    case task_type_grav_top_level:
    case task_type_grav_long_range:
177
178
179
180
    case task_type_grav_mm:
      return task_action_multipole;
      break;

181
    case task_type_drift_gpart:
182
    case task_type_grav_down:
183
    case task_type_grav_mesh:
184
      return task_action_gpart;
185
      break;
186

187
    default:
188
      error("Unknown task_action for task");
189
190
191
      return task_action_none;
      break;
  }
192

193
  /* Silence compiler warnings */
194
195
  error("Unknown task_action for task");
  return task_action_none;
196
197
}

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

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

213
214
  /* First check if any of the two tasks are of a type that don't
     use cells. */
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
259
260
261
262
263
  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;
264
}
265

266
267
/**
 * @brief Unlock the cell held by this task.
268
 *
269
270
 * @param t The #task.
 */
271
272
void task_unlock(struct task *t) {

273
274
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
275
276
  struct cell *ci = t->ci, *cj = t->cj;

277
  /* Act based on task type. */
278
279
  switch (type) {

280
    case task_type_end_force:
281
282
283
    case task_type_kick1:
    case task_type_kick2:
    case task_type_timestep:
284
285
286
      cell_unlocktree(ci);
      cell_gunlocktree(ci);
      break;
Matthieu Schaller's avatar
Matthieu Schaller committed
287

288
    case task_type_drift_part:
289
    case task_type_sort:
290
291
292
      cell_unlocktree(ci);
      break;

293
    case task_type_drift_gpart:
294
    case task_type_grav_mesh:
295
296
297
      cell_gunlocktree(ci);
      break;

298
    case task_type_self:
299
    case task_type_sub_self:
300
301
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
302
        cell_munlocktree(ci);
303
304
305
      } else {
        cell_unlocktree(ci);
      }
306
      break;
307

308
    case task_type_pair:
309
    case task_type_sub_pair:
310
311
312
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        cell_gunlocktree(cj);
313
314
        cell_munlocktree(ci);
        cell_munlocktree(cj);
315
316
317
318
319
320
      } else {
        cell_unlocktree(ci);
        cell_unlocktree(cj);
      }
      break;

321
    case task_type_grav_down:
322
      cell_gunlocktree(ci);
323
324
325
326
327
328
      cell_munlocktree(ci);
      break;

    case task_type_grav_long_range:
    case task_type_grav_mm:
      cell_munlocktree(ci);
329
      break;
330

331
332
333
334
    default:
      break;
  }
}
335
336
337
338
339
340

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

343
344
  const enum task_types type = t->type;
  const enum task_subtypes subtype = t->subtype;
345
  struct cell *ci = t->ci, *cj = t->cj;
346
347
348
349
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
350

351
  switch (type) {
352

353
354
355
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
356
#ifdef WITH_MPI
357
358
359
360
361
362
363
364
365
      /* 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;
366
#else
367
      error("SWIFT was not compiled with MPI support.");
368
#endif
369
      break;
370

371
    case task_type_end_force:
372
373
374
    case task_type_kick1:
    case task_type_kick2:
    case task_type_timestep:
375
376
377
      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
378
379
        cell_unlocktree(ci);
        return 0;
380
381
382
      }
      break;

383
    case task_type_drift_part:
384
    case task_type_sort:
385
      if (ci->hold) return 0;
386
387
      if (cell_locktree(ci) != 0) return 0;
      break;
388

389
    case task_type_drift_gpart:
390
    case task_type_grav_mesh:
391
392
393
394
      if (ci->ghold) return 0;
      if (cell_glocktree(ci) != 0) return 0;
      break;

395
    case task_type_self:
396
    case task_type_sub_self:
397
      if (subtype == task_subtype_grav) {
398
399
400
401
402
403
404
405
        /* 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;
        }
406
407
408
409
      } else {
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
410

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

441
442
443
444
445
446
447
448
449
450
451
452
    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
453
    case task_type_grav_mm:
454
455
456
      /* Lock the m-poles */
      if (ci->mhold) return 0;
      if (cell_mlocktree(ci) != 0) return 0;
Matthieu Schaller's avatar
Matthieu Schaller committed
457
458
      break;

459
460
    default:
      break;
461
462
463
464
465
  }

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

467
468
469
470
471
472
473
474
475
476
477
/**
 * @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);
}