task.h 6 KB
Newer Older
1
/*******************************************************************************
2
 * This file is part of SWIFT.
3
 * Copyright (c) 2012 Pedro Gonnet (pedro.gonnet@durham.ac.uk)
4
 *                    Matthieu Schaller (matthieu.schaller@durham.ac.uk)
5
6
7
 *               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
#ifndef SWIFT_TASK_H
#define SWIFT_TASK_H
25

26
27
#include "../config.h"

28
/* Includes. */
29
#include "align.h"
30
#include "cycle.h"
31
32
33
34
35
#include "timeline.h"

/* Forward declarations to avoid circular inclusion dependencies. */
struct cell;
struct engine;
36

37
#define task_align 128
38

39
40
/**
 * @brief The different task types.
Pedro Gonnet's avatar
Pedro Gonnet committed
41
42
 *
 * Be sure to update the taskID_names array in tasks.c if you modify this list!
43
 * Also update the python task plotting scripts!
44
 */
45
enum task_types {
46
47
48
49
  task_type_none = 0,
  task_type_sort,
  task_type_self,
  task_type_pair,
50
51
  task_type_sub_self,
  task_type_sub_pair,
52
  task_type_init_grav,
53
54
  task_type_init_grav_out, /* Implicit */
  task_type_ghost_in,      /* Implicit */
55
  task_type_ghost,
56
  task_type_ghost_out, /* Implicit */
57
  task_type_extra_ghost,
58
  task_type_drift_part,
59
  task_type_drift_spart,
60
  task_type_drift_bpart,
61
  task_type_drift_gpart,
62
  task_type_drift_gpart_out, /* Implicit */
63
  task_type_end_hydro_force,
64
65
  task_type_kick1,
  task_type_kick2,
66
  task_type_timestep,
67
  task_type_timestep_limiter,
68
69
  task_type_send,
  task_type_recv,
70
  task_type_grav_long_range,
71
  task_type_grav_mm,
72
  task_type_grav_down_in, /* Implicit */
73
  task_type_grav_down,
74
  task_type_grav_mesh,
75
  task_type_end_grav_force,
76
  task_type_cooling,
Matthieu Schaller's avatar
Matthieu Schaller committed
77
  task_type_star_formation,
78
79
  task_type_star_formation_in,  /* Implicit */
  task_type_star_formation_out, /* Implicit */
80
  task_type_logger,
81
82
  task_type_stars_in,       /* Implicit */
  task_type_stars_out,      /* Implicit */
83
  task_type_stars_ghost_in, /* Implicit */
84
  task_type_stars_ghost,
85
86
  task_type_stars_ghost_out, /* Implicit */
  task_type_stars_sort,
87
88
  task_type_bh_in,  /* Implicit */
  task_type_bh_out, /* Implicit */
89
  task_type_bh_ghost,
90
  task_type_count
91
} __attribute__((packed));
92

93
94
95
/**
 * @brief The different task sub-types (for pairs, selfs and sub-tasks).
 */
96
enum task_subtypes {
97
98
  task_subtype_none = 0,
  task_subtype_density,
99
  task_subtype_gradient,
100
  task_subtype_force,
101
  task_subtype_limiter,
102
  task_subtype_grav,
103
  task_subtype_external_grav,
104
105
106
  task_subtype_tend_part,
  task_subtype_tend_gpart,
  task_subtype_tend_spart,
107
  task_subtype_tend_bpart,
108
  task_subtype_xv,
109
  task_subtype_rho,
110
  task_subtype_gpart,
111
  task_subtype_multipole,
112
  task_subtype_spart,
113
  task_subtype_stars_density,
Alexei Borissov's avatar
Alexei Borissov committed
114
  task_subtype_stars_feedback,
115
116
  task_subtype_bh_density,
  task_subtype_bh_feedback,
117
  task_subtype_count
118
} __attribute__((packed));
119

120
121
122
/**
 * @brief The type of particles/objects this task acts upon in a given cell.
 */
123
124
125
126
enum task_actions {
  task_action_none,
  task_action_part,
  task_action_gpart,
Loic Hausammann's avatar
Loic Hausammann committed
127
  task_action_spart,
128
  task_action_bpart,
129
130
131
132
133
  task_action_all,
  task_action_multipole,
  task_action_count
};

134
135
136
137
138
139
140
141
/**
 * @brief Names of the task types.
 */
extern const char *taskID_names[];

/**
 * @brief Names of the task sub-types.
 */
142
extern const char *subtaskID_names[];
143

144
145
146
147
148
149
150
/**
 *  @brief The MPI communicators for the different subtypes.
 */
#ifdef WITH_MPI
extern MPI_Comm subtaskMPI_comms[task_subtype_count];
#endif

151
152
153
/**
 * @brief A task to be run by the #scheduler.
 */
154
155
struct task {

156
157
  /*! Pointers to the cells this task acts upon */
  struct cell *ci, *cj;
158

159
160
161
  /*! List of tasks unlocked by this one */
  struct task **unlock_tasks;

162
163
164
  /*! Flags used to carry additional information (e.g. sort directions) */
  long long flags;

165
166
167
168
169
170
171
172
173
#ifdef WITH_MPI

  /*! Buffer for this task's communications */
  void *buff;

  /*! MPI request corresponding to this task */
  MPI_Request req;

#endif
174

175
176
177
178
  /*! Rank of a task in the order */
  int rank;

  /*! Weight of the task */
179
  float weight;
Pedro Gonnet's avatar
Pedro Gonnet committed
180

181
  /*! Number of tasks unlocked by this one */
182
  short int nr_unlock_tasks;
183

184
185
  /*! Number of unsatisfied dependencies */
  short int wait;
186

187
188
  /*! Type of the task */
  enum task_types type;
189

190
191
  /*! Sub-type of the task (for the tasks that have one */
  enum task_subtypes subtype;
192

193
194
195
196
197
  /*! Should the scheduler skip this task ? */
  char skip;

  /*! Is this task implicit (i.e. does not do anything) ? */
  char implicit;
Pedro Gonnet's avatar
Pedro Gonnet committed
198

199
#ifdef SWIFT_DEBUG_TASKS
200
201
202
  /*! ID of the queue or runner owning this task */
  short int rid;

203
204
  /*! Information about the direction of the pair task */
  short int sid;
205
#endif
206

207
208
  /*! Start and end time of this task */
  ticks tic, toc;
209

210
211
212
213
214
#ifdef SWIFT_DEBUG_CHECKS
  /* When was this task last run? */
  integertime_t ti_run;
#endif /* SWIFT_DEBUG_CHECKS */

215
} SWIFT_STRUCT_ALIGN;
216
217

/* Function prototypes. */
218
void task_unlock(struct task *t);
219
float task_overlap(const struct task *ta, const struct task *tb);
220
int task_lock(struct task *t);
221
void task_do_rewait(struct task *t);
222
void task_print(const struct task *t);
223
void task_dump_all(struct engine *e, int step);
Peter W. Draper's avatar
Peter W. Draper committed
224
225
void task_dump_stats(const char *dumpfile, struct engine *e, int header,
                     int allranks);
226
void task_get_full_name(int type, int subtype, char *name);
227
void task_get_group_name(int type, int subtype, char *cluster);
228

229
230
231
#ifdef WITH_MPI
void task_create_mpi_comms(void);
#endif
232
#endif /* SWIFT_TASK_H */