task.c 10.2 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
    "none",       "sort",       "self",    "pair",          "sub_self",
52
    "sub_pair",   "init",       "ghost",   "extra_ghost",
53
    "kick",       "kick_fixdt", "send",    "recv",          "grav_gather_m",
54
    "grav_fft",   "grav_mm",    "grav_up", "grav_external"};
55

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

59
60
61
/**
 * @brief Computes the overlap between the parts array of two given cells.
 */
62
63
64
__attribute__((always_inline)) INLINE static size_t task_cell_overlap_part(
    const struct cell *ci, const struct cell *cj) {

65
  if (ci == NULL || cj == NULL) return 0;
66

67
68
69
70
71
72
73
  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;
  }
74

75
76
77
  return 0;
}

78
79
80
/**
 * @brief Computes the overlap between the gparts array of two given cells.
 */
81
82
83
__attribute__((always_inline)) INLINE static size_t task_cell_overlap_gpart(
    const struct cell *ci, const struct cell *cj) {

84
  if (ci == NULL || cj == NULL) return 0;
85

86
87
88
89
90
91
92
  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;
  }
93

94
95
96
97
98
99
100
101
  return 0;
}

/**
 * @brief Returns the #task_actions for a given task.
 *
 * @param t The #task.
 */
102
103
__attribute__((always_inline)) INLINE static enum task_actions task_acts_on(
    const struct task *t) {
104
105
106
107
108
109
110
111
112

  switch (t->type) {

    case task_type_none:
      return task_action_none;
      break;

    case task_type_sort:
    case task_type_ghost:
113
    case task_type_extra_ghost:
114
115
116
117
118
119
120
121
122
123
      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:
124
        case task_subtype_gradient:
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
        case task_subtype_force:
          return task_action_part;
          break;

        case task_subtype_grav:
          return task_action_gpart;
          break;

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

    case task_type_init:
    case task_type_kick:
    case task_type_kick_fixdt:
    case task_type_send:
    case task_type_recv:
      return task_action_all;
      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;

    case task_type_grav_external:
      return task_action_gpart;
      break;

    default:
160
      error("Unknown task_action for task");
161
162
163
164
165
      return task_action_none;
      break;
  }
}

166
167
168
169
170
171
172
173
/**
 * @brief Compute the Jaccard similarity of the data used by two
 *        different tasks.
 *
 * @param ta The first #task.
 * @param tb The second #task.
 */
float task_overlap(const struct task *ta, const struct task *tb) {
174
175
176
177
178
179

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

180
181
  /* First check if any of the two tasks are of a type that don't
     use cells. */
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
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
  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;
231
}
232

233
234
/**
 * @brief Unlock the cell held by this task.
235
 *
236
237
 * @param t The #task.
 */
238
239
void task_unlock(struct task *t) {

240
241
242
243
  const int type = t->type;
  const int subtype = t->subtype;
  struct cell *ci = t->ci, *cj = t->cj;

244
  /* Act based on task type. */
245
246
  switch (type) {

247
    case task_type_sort:
248
249
250
251
      cell_unlocktree(ci);
      break;

    case task_type_self:
252
    case task_type_sub_self:
253
254
255
256
257
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
      } else {
        cell_unlocktree(ci);
      }
258
      break;
259

260
    case task_type_pair:
261
    case task_type_sub_pair:
262
263
264
265
266
267
268
269
270
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        cell_gunlocktree(cj);
      } else {
        cell_unlocktree(ci);
        cell_unlocktree(cj);
      }
      break;

271
    case task_type_grav_mm:
272
      cell_gunlocktree(ci);
273
274
275
276
277
      break;
    default:
      break;
  }
}
278
279
280
281
282
283

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

286
287
  const int type = t->type;
  const int subtype = t->subtype;
288
  struct cell *ci = t->ci, *cj = t->cj;
289
290
291
292
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
293

294
  switch (type) {
295

296
297
298
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
299
#ifdef WITH_MPI
300
301
302
303
304
305
306
307
308
      /* 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;
309
#else
310
      error("SWIFT was not compiled with MPI support.");
311
#endif
312
      break;
313

314
315
316
    case task_type_sort:
      if (cell_locktree(ci) != 0) return 0;
      break;
317

318
    case task_type_self:
319
    case task_type_sub_self:
320
321
322
323
324
325
      if (subtype == task_subtype_grav) {
        if (cell_glocktree(ci) != 0) return 0;
      } else {
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
326

327
    case task_type_pair:
328
    case task_type_sub_pair:
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
      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;
345

Matthieu Schaller's avatar
Matthieu Schaller committed
346
347
348
349
    case task_type_grav_mm:
      cell_glocktree(ci);
      break;

350
351
    default:
      break;
352
353
354
355
356
  }

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

358
359
360
/**
 * @brief Prints the list of tasks contained in a given mask
 *
361
 * @param mask The mask to analyse
362
363
364
365
366
367
368
369
370
371
372
373
 */
void task_print_mask(unsigned int mask) {

  printf("task_print_mask: The tasks to run are [");
  for (int k = 1; k < task_type_count; k++)
    printf(" %s=%s", taskID_names[k], (mask & (1 << k)) ? "yes" : "no");
  printf(" ]\n");
}

/**
 * @brief Prints the list of subtasks contained in a given submask
 *
374
 * @param submask The submask to analyse
375
376
377
378
379
380
381
382
 */
void task_print_submask(unsigned int submask) {

  printf("task_print_submask: The subtasks to run are [");
  for (int k = 1; k < task_subtype_count; k++)
    printf(" %s=%s", subtaskID_names[k], (submask & (1 << k)) ? "yes" : "no");
  printf(" ]\n");
}