task.c 12.9 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
183
    case task_type_grav_down:
      return task_action_gpart;
184
      break;
185

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

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

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

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

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

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

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

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

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

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

292
293
294
295
    case task_type_drift_gpart:
      cell_gunlocktree(ci);
      break;

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

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

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

    case task_type_grav_long_range:
    case task_type_grav_mm:
      cell_munlocktree(ci);
327
      break;
328

329
330
331
332
    default:
      break;
  }
}
333
334
335
336
337
338

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

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

349
  switch (type) {
350

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

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

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

387
388
389
390
391
    case task_type_drift_gpart:
      if (ci->ghold) return 0;
      if (cell_glocktree(ci) != 0) return 0;
      break;

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

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

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

456
457
    default:
      break;
458
459
460
461
462
  }

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

464
465
466
467
468
469
470
471
472
473
474
/**
 * @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);
}