task.c 8.54 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 "lock.h"
47
48

/* Task type names. */
49
const char *taskID_names[task_type_count] = {
50
51
52
53
54
    "none",    "sort",          "self",          "pair",       "sub",
    "init",    "ghost",         "drift",         "kick",       "kick_fixdt",
    "send",    "recv",          "grav_gather_m", "grav_fft",   "grav_mm",
    "grav_up", "grav_external", "part_sort",     "gpart_sort", "split_cell",
    "rewait"};
55

Matthieu Schaller's avatar
Matthieu Schaller committed
56
57
const char *subtaskID_names[task_type_count] = {"none", "density", "force",
                                                "grav"};
58

59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/**
 * @brief Computes the overlap between the parts array of two given cells.
 */
size_t task_cell_overlap(const struct cell *ci, const struct cell *cj) {
  if (ci == NULL || cj == NULL) return 0;
  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;
  }
  return 0;
}

/**
 * @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) {
  /* First check if any of the two tasks are of a type that don't
     use cells. */
84
  if (ta == NULL || tb == NULL || ta->type == task_type_none ||
85
86
87
88
      ta->type == task_type_part_sort || ta->type == task_type_gpart_sort ||
      ta->type == task_type_split_cell || ta->type == task_type_rewait ||
      tb->type == task_type_none || tb->type == task_type_part_sort ||
      tb->type == task_type_gpart_sort || tb->type == task_type_split_cell ||
89
      tb->type == task_type_rewait)
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
    return 0.0f;

  /* 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(ta->ci, tb->ci) + task_cell_overlap(ta->ci, tb->cj) +
      task_cell_overlap(ta->cj, tb->ci) + task_cell_overlap(ta->cj, tb->cj);

  return ((float)size_intersect) / (size_union - size_intersect);
}
106

107
108
/**
 * @brief Unlock the cell held by this task.
109
 *
110
111
 * @param t The #task.
 */
112
113
void task_unlock(struct task *t) {

114
115
116
117
  const int type = t->type;
  const int subtype = t->subtype;
  struct cell *ci = t->ci, *cj = t->cj;

118
  /* Act based on task type. */
119
120
  switch (type) {

121
    case task_type_sort:
122
123
124
125
      cell_unlocktree(ci);
      break;

    case task_type_self:
126
    case task_type_sub_self:
127
128
129
130
131
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
      } else {
        cell_unlocktree(ci);
      }
132
      break;
133

134
    case task_type_pair:
135
    case task_type_sub_pair:
136
137
138
139
140
141
142
143
144
145
      if (subtype == task_subtype_grav) {
        cell_gunlocktree(ci);
        cell_gunlocktree(cj);
      } else {
        cell_unlocktree(ci);
        cell_unlocktree(cj);
      }
      break;


146
    case task_type_grav_mm:
147
      cell_gunlocktree(ci);
148
149
150
151
152
      break;
    default:
      break;
  }
}
153
154
155
156
157
158

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

161
162
  const int type = t->type;
  const int subtype = t->subtype;
163
  struct cell *ci = t->ci, *cj = t->cj;
164
165
166
167
#ifdef WITH_MPI
  int res = 0, err = 0;
  MPI_Status stat;
#endif
168

169
  switch (type) {
170

171
172
173
    /* Communication task? */
    case task_type_recv:
    case task_type_send:
174
#ifdef WITH_MPI
175
176
177
178
179
180
181
182
183
      /* 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;
184
#else
185
      error("SWIFT was not compiled with MPI support.");
186
#endif
187
      break;
188

189
190
191
    case task_type_sort:
      if (cell_locktree(ci) != 0) return 0;
      break;
192

193
    case task_type_self:
194
    case task_type_sub_self:
195
196
197
198
199
200
      if (subtype == task_subtype_grav) {
        if (cell_glocktree(ci) != 0) return 0;
      } else {
        if (cell_locktree(ci) != 0) return 0;
      }
      break;
201

202
    case task_type_pair:
203
    case task_type_sub_pair:
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
      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;
220

221
222
    default:
      break;
223
224
225
226
227
  }

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

229
/**
230
 * @brief Remove all unlocks to tasks that are of the given type.
231
232
233
234
 *
 * @param t The #task.
 * @param type The task type ID to remove.
 */
235
236
237
238
239
240
241
242
243
244
void task_cleanunlock(struct task *t, int type) {

  int k;

  lock_lock(&t->lock);

  for (k = 0; k < t->nr_unlock_tasks; k++)
    if (t->unlock_tasks[k]->type == type) {
      t->nr_unlock_tasks -= 1;
      t->unlock_tasks[k] = t->unlock_tasks[t->nr_unlock_tasks];
245
246
    }

247
248
  lock_unlock_blind(&t->lock);
}
249

250
251
252
253
254
255
/**
 * @brief Remove an unlock_task from the given task.
 *
 * @param ta The unlocking #task.
 * @param tb The #task that will be unlocked.
 */
256
257
258
259
260
261
262
263
264
265
266
267
void task_rmunlock(struct task *ta, struct task *tb) {

  int k;

  lock_lock(&ta->lock);

  for (k = 0; k < ta->nr_unlock_tasks; k++)
    if (ta->unlock_tasks[k] == tb) {
      ta->nr_unlock_tasks -= 1;
      ta->unlock_tasks[k] = ta->unlock_tasks[ta->nr_unlock_tasks];
      lock_unlock_blind(&ta->lock);
      return;
268
    }
269
270
  error("Task not found.");
}
271

Pedro Gonnet's avatar
Pedro Gonnet committed
272
273
274
275
276
277
278
279
280
/**
 * @brief Remove an unlock_task from the given task.
 *
 * @param ta The unlocking #task.
 * @param tb The #task that will be unlocked.
 *
 * Differs from #task_rmunlock in that it will not fail if
 * the task @c tb is not in the unlocks of @c ta.
 */
281
282
283
284
285
286
287
288
289
290
291
void task_rmunlock_blind(struct task *ta, struct task *tb) {

  int k;

  lock_lock(&ta->lock);

  for (k = 0; k < ta->nr_unlock_tasks; k++)
    if (ta->unlock_tasks[k] == tb) {
      ta->nr_unlock_tasks -= 1;
      ta->unlock_tasks[k] = ta->unlock_tasks[ta->nr_unlock_tasks];
      break;
Pedro Gonnet's avatar
Pedro Gonnet committed
292
    }
293
294
295

  lock_unlock_blind(&ta->lock);
}
Pedro Gonnet's avatar
Pedro Gonnet committed
296

297
298
299
/**
 * @brief Prints the list of tasks contained in a given mask
 *
300
 * @param mask The mask to analyse
301
302
303
304
305
306
307
308
309
310
311
312
 */
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
 *
313
 * @param submask The submask to analyse
314
315
316
317
318
319
320
321
 */
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");
}