task.c 10.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] = {
51
52
53
54
55
    "none",          "sort",     "self",     "pair",        "sub_self",
    "sub_pair",      "init",     "ghost",    "extra_ghost", "drift",
    "kick1",         "kick2",    "timestep", "send",        "recv",
    "grav_gather_m", "grav_fft", "grav_mm",  "grav_up",     "cooling",
    "sourceterms"};
56

57
const char *subtaskID_names[task_subtype_count] = {
58
    "none", "density", "gradient", "force", "grav", "external_grav", "tend"};
59

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

69
  if (ci == NULL || cj == NULL) return 0;
70

71
72
73
74
75
76
77
  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;
  }
78

79
80
81
  return 0;
}

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

91
  if (ci == NULL || cj == NULL) return 0;
92

93
94
95
96
97
98
99
  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;
  }
100

101
102
103
104
105
106
107
108
  return 0;
}

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

  switch (t->type) {

    case task_type_none:
      return task_action_none;
      break;

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

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

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

    case task_type_init:
151
152
    case task_type_kick1:
    case task_type_kick2:
153
    case task_type_timestep:
154
155
    case task_type_send:
    case task_type_recv:
156
    case task_type_drift:
157
158
159
160
161
162
163
164
      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");
165
166
167
168
169
170
171
172
173
174
      break;

    case task_type_grav_gather_m:
    case task_type_grav_fft:
    case task_type_grav_mm:
    case task_type_grav_up:
      return task_action_multipole;
      break;

    default:
175
      error("Unknown task_action for task");
176
177
178
      return task_action_none;
      break;
  }
179
180
181
182

  /* Silence compile warnings */
  error("Unknown task_action for task");
  return task_action_none;
183
184
}

185
186
187
188
189
190
191
/**
 * @brief Compute the Jaccard similarity of the data used by two
 *        different tasks.
 *
 * @param ta The first #task.
 * @param tb The second #task.
 */
192
193
float task_overlap(const struct task *restrict ta,
                   const struct task *restrict tb) {
194
195
196
197
198
199

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

200
201
  /* First check if any of the two tasks are of a type that don't
     use cells. */
202
203
204
205
206
207
208
209
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
  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;
251
}
252

253
254
/**
 * @brief Unlock the cell held by this task.
255
 *
256
257
 * @param t The #task.
 */
258
259
void task_unlock(struct task *t) {

260
261
262
263
  const int type = t->type;
  const int subtype = t->subtype;
  struct cell *ci = t->ci, *cj = t->cj;

264
  /* Act based on task type. */
265
266
  switch (type) {

267
268
269
270
    case task_type_drift:
      cell_unlocktree(ci);
      cell_gunlocktree(ci);
      break;
Matthieu Schaller's avatar
Matthieu Schaller committed
271

272
    case task_type_sort:
273
274
275
276
      cell_unlocktree(ci);
      break;

    case task_type_self:
277
    case task_type_sub_self:
278
279
280
281
282
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
      } else {
        cell_unlocktree(ci);
      }
283
      break;
284

285
    case task_type_pair:
286
    case task_type_sub_pair:
287
288
289
290
291
292
293
294
295
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        cell_gunlocktree(cj);
      } else {
        cell_unlocktree(ci);
        cell_unlocktree(cj);
      }
      break;

296
    case task_type_grav_mm:
297
      cell_gunlocktree(ci);
298
299
300
301
302
      break;
    default:
      break;
  }
}
303
304
305
306
307
308

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

311
312
  const int type = t->type;
  const int subtype = t->subtype;
313
  struct cell *ci = t->ci, *cj = t->cj;
314
315
316
317
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
318

319
  switch (type) {
320

321
322
323
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
324
#ifdef WITH_MPI
325
326
327
328
329
330
331
332
333
      /* 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;
334
#else
335
      error("SWIFT was not compiled with MPI support.");
336
#endif
337
      break;
338

339
340
341
342
    case task_type_drift:
      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
343
344
        cell_unlocktree(ci);
        return 0;
345
346
347
      }
      break;

348
349
350
    case task_type_sort:
      if (cell_locktree(ci) != 0) return 0;
      break;
351

352
    case task_type_self:
353
    case task_type_sub_self:
354
355
356
357
358
359
      if (subtype == task_subtype_grav) {
        if (cell_glocktree(ci) != 0) return 0;
      } else {
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
360

361
    case task_type_pair:
362
    case task_type_sub_pair:
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
      if (subtype == task_subtype_grav) {
        if (ci->ghold || cj->ghold) return 0;
        if (cell_glocktree(ci) != 0) return 0;
        if (cell_glocktree(cj) != 0) {
          cell_gunlocktree(ci);
          return 0;
        }
      } else {
        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;
379

Matthieu Schaller's avatar
Matthieu Schaller committed
380
381
382
383
    case task_type_grav_mm:
      cell_glocktree(ci);
      break;

384
385
    default:
      break;
386
387
388
389
390
  }

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

392
393
394
395
396
397
398
399
400
401
402
/**
 * @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);
}