logger.h 9.07 KB
Newer Older
1
2
3
/*******************************************************************************
 * This file is part of SWIFT.
 * Copyright (c) 2017 Pedro Gonnet (pedro.gonnet@durham.ac.uk)
Loic Hausammann's avatar
Loic Hausammann committed
4
 *               2018 Loic Hausammann (loic.hausammann@epfl.ch)
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 *
 * 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.
 *
 * 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.
 *
 * 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/>.
 *
 ******************************************************************************/
#ifndef SWIFT_LOGGER_H
#define SWIFT_LOGGER_H

Loic Hausammann's avatar
Loic Hausammann committed
23
24
#include "../config.h"

lhausamm's avatar
lhausamm committed
25
26
#ifdef WITH_LOGGER

27
/* Includes. */
lhausamm's avatar
lhausamm committed
28
#include "common_io.h"
29
#include "dump.h"
Loic Hausammann's avatar
Loic Hausammann committed
30
31
#include "inline.h"
#include "timeline.h"
lhausamm's avatar
lhausamm committed
32
#include "units.h"
33

Loic Hausammann's avatar
Loic Hausammann committed
34
/* Forward declaration. */
35
struct dump;
Loic Hausammann's avatar
Loic Hausammann committed
36
struct gpart;
37
struct part;
Loic Hausammann's avatar
Loic Hausammann committed
38
struct engine;
39

Loic Hausammann's avatar
Loic Hausammann committed
40
#define logger_major_version 0
Loic Hausammann's avatar
Loic Hausammann committed
41
#define logger_minor_version 3
Loic Hausammann's avatar
Loic Hausammann committed
42

43
44
/**
 * Logger entries contain messages representing the particle data at a given
45
 * point in time during the simulation.
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 *
 * The logger messages always start with an 8-byte header structured as
 * follows:
 *
 *   data: [ mask |                     offset                     ]
 *   byte: [  01  |  02  |  03  |  04  |  05  |  06  |  07  |  08  ]
 *
 * I.e. a first "mask" byte followed by 7 "offset" bytes. The mask contains
 * information on what kind of data is packed after the header. The mask
 * bits correspond to the following data:
 *
 *   bit | name   | size | comment
 *   -------------------------------------------------------------------------
 *   0   | x      | 24   | The particle position, in absolute coordinates,
 *       |        |      | stored as three doubles.
 *   1   | v      | 12   | Particle velocity, stored as three floats.
 *   2   | a      | 12   | Particle acceleration, stored as three floats.
63
64
 *   3   | u      | 4    | Particle internal energy (or entropy, if Gadget-SPH
 *       |        |      | is used), stored as a single float.
65
66
 *   4   | h      | 4    | Particle smoothing length (or epsilon, if a gpart),
 *       |        |      | stored as a single float.
67
 *   5   | rho    | 4    | Particle density, stored as a single float.
68
69
 *   6   | consts | 12   | Particle constants, i.e. mass and ID.
 *   7   | time   | 8    | Timestamp, not associated with a particle, just
70
71
72
73
74
75
76
 *       |        |      | marks the transitions from one timestep to another.
 *
 * There is no distinction between gravity and SPH particles.
 *
 * The offset refers to the relative location of the previous message for the
 * same particle or for the previous timestamp (if mask bit 7 is set). I.e.
 * the previous log entry will be at the address of the current mask byte minus
lhausamm's avatar
lhausamm committed
77
78
 * the unsigned value stored in the offset. An offset equal to the chunk offset
 * indicated that this is the first message for the given particle/timestamp.
79
80
81
 */

/* Some constants. */
82
83
84
85
86
87
88
89
enum logger_masks_number {
  logger_x = 0,
  logger_v = 1,
  logger_a = 2,
  logger_u = 3,
  logger_h = 4,
  logger_rho = 5,
  logger_consts = 6,
Loic Hausammann's avatar
Loic Hausammann committed
90
  logger_special_flags = 7, /* Flag for special cases */
Loic Hausammann's avatar
Loic Hausammann committed
91
92
  logger_timestamp = 8,  /* expect it to be before count. */
  logger_count_mask = 9, /* Need to be the last. */
Loic Hausammann's avatar
Loic Hausammann committed
93
} __attribute__((packed));
94

Loic Hausammann's avatar
Loic Hausammann committed
95
96
97
98
99
100
101
102
103
104
105
/* Defines some mask for logging all the fields */
enum logger_masks_all {
  logger_masks_all_part = (1 << logger_x) | (1 << logger_v) |
    (1 << logger_a) | (1 << logger_u) | (1 << logger_h) | (1 << logger_rho) |
    (1 << logger_consts),
  logger_masks_all_gpart = (1 << logger_x) | (1 << logger_v) |
  (1 << logger_a) | (1 << logger_consts),
  logger_masks_all_spart = (1 << logger_x) | (1 << logger_v) |
  (1 << logger_consts),
} __attribute__((packed));

106
enum logger_special_flags {
Loic Hausammann's avatar
Loic Hausammann committed
107
108
109
110
111
  logger_flag_change_type = 1, /* Flag for a change of particle type */
  logger_flag_mpi_enter, /* Flag for a particle received from another  MPI rank */
  logger_flag_mpi_exit, /* Flag for a particle sent to another MPI rank */
  logger_flag_delete,  /* Flag for a deleted particle */
  logger_flag_create, /* Flag for a created particle */
112
113
} __attribute__((packed));

114
struct mask_data {
Loic Hausammann's avatar
Loic Hausammann committed
115
  /* Number of bytes for a mask. */
116
  int size;
117

Loic Hausammann's avatar
Loic Hausammann committed
118
  /* Mask value. */
119
  unsigned int mask;
120

Loic Hausammann's avatar
Loic Hausammann committed
121
  /* Name of the mask. */
122
123
124
125
126
  char name[100];
};

extern const struct mask_data logger_mask_data[logger_count_mask];

127
128
/* Size of the strings. */
#define logger_string_length 200
Loic Hausammann's avatar
Loic Hausammann committed
129

Loic Hausammann's avatar
Loic Hausammann committed
130
131
132
/**
 * @brief structure containing global data for the particle logger.
 */
Loic Hausammann's avatar
Loic Hausammann committed
133
134
struct logger_writer {
  /* Number of particle steps between dumping a chunk of data. */
Loic Hausammann's avatar
Loic Hausammann committed
135
136
  short int delta_step;

Loic Hausammann's avatar
Loic Hausammann committed
137
  /* Logger basename. */
138
  char base_name[logger_string_length];
Loic Hausammann's avatar
Loic Hausammann committed
139

Loic Hausammann's avatar
Loic Hausammann committed
140
141
142
143
144
145
146
147
  struct {
    /* The total memory fraction reserved for the index files. */
    float mem_frac;

    /* Size of the dump since at the last output */
    size_t dump_size_last_output;
  } index;

Loic Hausammann's avatar
Loic Hausammann committed
148
149
  /*  Dump file (In the reader, the dump is cleaned, therefore it is renamed
   * logfile). */
150
  struct dump dump;
Loic Hausammann's avatar
Loic Hausammann committed
151

Loic Hausammann's avatar
Loic Hausammann committed
152
  /* timestamp offset for logger. */
Loic Hausammann's avatar
Loic Hausammann committed
153
154
  size_t timestamp_offset;

Loic Hausammann's avatar
Loic Hausammann committed
155
  /* scaling factor when buffer is too small. */
Loic Hausammann's avatar
Loic Hausammann committed
156
157
  float buffer_scale;

Loic Hausammann's avatar
Loic Hausammann committed
158
  /* Size of a chunk if every mask are activated. */
159
160
  int max_chunk_size;

Loic Hausammann's avatar
Loic Hausammann committed
161
162
} SWIFT_STRUCT_ALIGN;

Loic Hausammann's avatar
Loic Hausammann committed
163
/* required structure for each particle type. */
Loic Hausammann's avatar
Loic Hausammann committed
164
struct logger_part_data {
Loic Hausammann's avatar
Loic Hausammann committed
165
  /* Number of particle updates since last output. */
166
  int steps_since_last_output;
Loic Hausammann's avatar
Loic Hausammann committed
167

Loic Hausammann's avatar
Loic Hausammann committed
168
  /* offset of last particle log entry. */
Loic Hausammann's avatar
Loic Hausammann committed
169
  uint64_t last_offset;
Loic Hausammann's avatar
Loic Hausammann committed
170
171
};

172
/* Function prototypes. */
lhausamm's avatar
lhausamm committed
173
int logger_compute_chunk_size(unsigned int mask);
Loic Hausammann's avatar
Loic Hausammann committed
174
175
void logger_log_all(struct logger_writer *log, const struct engine *e);
void logger_log_part(struct logger_writer *log, const struct part *p,
Loic Hausammann's avatar
Loic Hausammann committed
176
                     unsigned int mask, size_t *offset,
177
                     const uint32_t special_flags);
Loic Hausammann's avatar
Loic Hausammann committed
178
void logger_log_parts(struct logger_writer *log, const struct part *p,
179
180
                      struct xpart *xp, int count,
                      unsigned int mask, const uint32_t special_flags);
Loic Hausammann's avatar
Loic Hausammann committed
181
182
void logger_log_spart(struct logger_writer *log, const struct spart *p,
                      unsigned int mask, size_t *offset,
183
                      const uint32_t special_flags);
Loic Hausammann's avatar
Loic Hausammann committed
184
void logger_log_sparts(struct logger_writer *log, struct spart *sp,
185
186
                       int count, unsigned int mask,
                       const uint32_t special_flags);
Loic Hausammann's avatar
Loic Hausammann committed
187
void logger_log_gpart(struct logger_writer *log, const struct gpart *p,
Loic Hausammann's avatar
Loic Hausammann committed
188
                      unsigned int mask, size_t *offset,
189
                      const uint32_t special_flags);
Loic Hausammann's avatar
Loic Hausammann committed
190
void logger_log_gparts(struct logger_writer *log, struct gpart *gp,
191
192
                       int count, unsigned int mask,
                       const uint32_t special_flags);
Loic Hausammann's avatar
Loic Hausammann committed
193
194
void logger_init(struct logger_writer *log, struct swift_params *params);
void logger_free(struct logger_writer *log);
Loic Hausammann's avatar
Loic Hausammann committed
195
196
void logger_log_timestamp(struct logger_writer *log, integertime_t t,
                          double time, size_t *offset);
Loic Hausammann's avatar
Loic Hausammann committed
197
void logger_ensure_size(struct logger_writer *log, size_t total_nr_parts,
Loic Hausammann's avatar
Format    
Loic Hausammann committed
198
                        size_t total_nr_gparts, size_t total_nr_sparts);
Loic Hausammann's avatar
Loic Hausammann committed
199
void logger_write_file_header(struct logger_writer *log);
lhausamm's avatar
lhausamm committed
200

Pedro Gonnet's avatar
Pedro Gonnet committed
201
202
int logger_read_part(struct part *p, size_t *offset, const char *buff);
int logger_read_gpart(struct gpart *p, size_t *offset, const char *buff);
203
204
int logger_read_timestamp(unsigned long long int *t, double *time,
                          size_t *offset, const char *buff);
Loic Hausammann's avatar
Loic Hausammann committed
205
206
void logger_struct_dump(const struct logger_writer *log, FILE *stream);
void logger_struct_restore(struct logger_writer *log, FILE *stream);
lhausamm's avatar
lhausamm committed
207

208

Loic Hausammann's avatar
Loic Hausammann committed
209
210
211
212
213
214
/**
 * @brief Generate the data for the special flags.
 *
 * @param flag The special flag to use.
 * @param data The data to write in the .
 */
215
INLINE static uint32_t logger_pack_flags_and_data(enum logger_special_flags flag, int data) {
216
217
#ifdef SWIFT_DEBUG_CHECKS
  if (flag & 0xFFFFFF00) {
218
    error("The special flag in the particle logger cannot be larger than 1 byte.");
219
  }
Loic Hausammann's avatar
Loic Hausammann committed
220
  if (data & ~0xFFFFFF) {
221
    error("The data for the special flag in the particle logger cannot be larger than 3 bytes.");
Loic Hausammann's avatar
Loic Hausammann committed
222
  }
223
#endif
Loic Hausammann's avatar
Loic Hausammann committed
224
  return ((uint32_t) flag << (3 * 8)) | (data & 0xFFFFFF);
225
226
}

227
228
229
230
231
232
233
/**
 * @brief Initialize the logger data for a particle.
 *
 * @param logger The #logger_part_data.
 */
INLINE static void logger_part_data_init(struct logger_part_data *logger) {
  logger->last_offset = 0;
234
  logger->steps_since_last_output = INT_MAX;
235
236
237
238
239
}

/**
 * @brief Should this particle write its data now ?
 *
Loic Hausammann's avatar
Loic Hausammann committed
240
 * @param logger_data The #logger_part_data of a particle.
Loic Hausammann's avatar
Loic Hausammann committed
241
 * @param log The #logger_writer.
Loic Hausammann's avatar
Loic Hausammann committed
242
 *
Loic Hausammann's avatar
Loic Hausammann committed
243
 * @return 1 if the particle should be writen, 0 otherwise.
244
245
 */
__attribute__((always_inline)) INLINE static int logger_should_write(
Loic Hausammann's avatar
Loic Hausammann committed
246
247
    const struct logger_part_data *logger_data,
    const struct logger_writer *log) {
248
249
250
251

  return (logger_data->steps_since_last_output > log->delta_step);
}

lhausamm's avatar
lhausamm committed
252
253
#endif /* WITH_LOGGER */

254
#endif /* SWIFT_LOGGER_H */