task.h 5.02 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 "cell.h"
31
#include "cycle.h"
32

33
#define task_align 128
34

35
36
/**
 * @brief The different task types.
Pedro Gonnet's avatar
Pedro Gonnet committed
37
38
 *
 * Be sure to update the taskID_names array in tasks.c if you modify this list!
39
 * Also update the python task plotting scripts!
40
 */
41
enum task_types {
42
43
44
45
  task_type_none = 0,
  task_type_sort,
  task_type_self,
  task_type_pair,
46
47
  task_type_sub_self,
  task_type_sub_pair,
48
  task_type_init_grav,
49
50
  task_type_init_grav_out, /* Implicit */
  task_type_ghost_in,      /* Implicit */
51
  task_type_ghost,
52
  task_type_ghost_out, /* Implicit */
53
  task_type_extra_ghost,
54
55
  task_type_drift_part,
  task_type_drift_gpart,
56
  task_type_end_force,
57
58
  task_type_kick1,
  task_type_kick2,
59
  task_type_timestep,
60
61
  task_type_send,
  task_type_recv,
62
  task_type_grav_long_range,
63
  task_type_grav_mm,
64
  task_type_grav_down_in, /* Implicit */
65
  task_type_grav_down,
66
  task_type_grav_mesh,
67
  task_type_cooling,
Tom Theuns's avatar
Tom Theuns committed
68
  task_type_sourceterms,
Loic Hausammann's avatar
Loic Hausammann committed
69
70
71
  task_type_star_ghost_in,
  task_type_star_ghost,
  task_type_star_ghost_out,
72
  task_type_count
73
} __attribute__((packed));
74

75
76
77
/**
 * @brief The different task sub-types (for pairs, selfs and sub-tasks).
 */
78
enum task_subtypes {
79
80
  task_subtype_none = 0,
  task_subtype_density,
81
  task_subtype_gradient,
82
83
  task_subtype_force,
  task_subtype_grav,
84
  task_subtype_external_grav,
Loic Hausammann's avatar
Loic Hausammann committed
85
  task_subtype_star_density,
86
  task_subtype_tend,
87
  task_subtype_xv,
88
  task_subtype_rho,
89
  task_subtype_gpart,
90
  task_subtype_multipole,
91
  task_subtype_spart,
92
  task_subtype_count
93
} __attribute__((packed));
94

95
96
97
/**
 * @brief The type of particles/objects this task acts upon in a given cell.
 */
98
99
100
101
enum task_actions {
  task_action_none,
  task_action_part,
  task_action_gpart,
Loic Hausammann's avatar
Loic Hausammann committed
102
  task_action_spart,
103
104
105
106
107
  task_action_all,
  task_action_multipole,
  task_action_count
};

108
109
110
111
112
113
114
115
/**
 * @brief Names of the task types.
 */
extern const char *taskID_names[];

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

118
119
120
121
122
123
124
/**
 *  @brief The MPI communicators for the different subtypes.
 */
#ifdef WITH_MPI
extern MPI_Comm subtaskMPI_comms[task_subtype_count];
#endif

125
126
127
/**
 * @brief A task to be run by the #scheduler.
 */
128
129
struct task {

130
131
  /*! Pointers to the cells this task acts upon */
  struct cell *ci, *cj;
132

133
134
135
  /*! List of tasks unlocked by this one */
  struct task **unlock_tasks;

136
137
138
139
140
141
142
143
144
#ifdef WITH_MPI

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

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

#endif
145

146
147
148
149
150
151
152
  /*! Flags used to carry additional information (e.g. sort directions) */
  int flags;

  /*! Rank of a task in the order */
  int rank;

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

155
156
#if defined(WITH_MPI) && defined(HAVE_METIS)
  /*! Individual cost estimate for this task. */
157
  float cost;
158
#endif
159
160

  /*! Number of tasks unlocked by this one */
161
  short int nr_unlock_tasks;
162

163
164
  /*! Number of unsatisfied dependencies */
  short int wait;
165

166
167
  /*! Type of the task */
  enum task_types type;
168

169
170
  /*! Sub-type of the task (for the tasks that have one */
  enum task_subtypes subtype;
171

172
173
174
175
176
  /*! 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
177

178
#ifdef SWIFT_DEBUG_TASKS
179
180
181
  /*! ID of the queue or runner owning this task */
  short int rid;

182
183
184
  /*! Information about the direction of the pair task */
  short int sid;

185
186
187
  /*! Start and end time of this task */
  ticks tic, toc;
#endif
188

189
190
191
192
193
#ifdef SWIFT_DEBUG_CHECKS
  /* When was this task last run? */
  integertime_t ti_run;
#endif /* SWIFT_DEBUG_CHECKS */

194
} SWIFT_STRUCT_ALIGN;
195
196

/* Function prototypes. */
197
void task_unlock(struct task *t);
198
float task_overlap(const struct task *ta, const struct task *tb);
199
int task_lock(struct task *t);
200
void task_do_rewait(struct task *t);
201
void task_print(const struct task *t);
202
203
204
#ifdef WITH_MPI
void task_create_mpi_comms(void);
#endif
205
#endif /* SWIFT_TASK_H */