logger.h 6.88 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/*******************************************************************************
 * This file is part of SWIFT.
 * Copyright (c) 2017 Pedro Gonnet (pedro.gonnet@durham.ac.uk)
 *
 * 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

lhausamm's avatar
lhausamm committed
22
23
#ifdef WITH_LOGGER

24
/* Includes. */
lhausamm's avatar
lhausamm committed
25
#include "common_io.h"
Loic Hausammann's avatar
Loic Hausammann committed
26
27
#include "inline.h"
#include "timeline.h"
lhausamm's avatar
lhausamm committed
28
#include "units.h"
29

30
31
/* Forward declaration */
struct dump;
Loic Hausammann's avatar
Loic Hausammann committed
32
struct gpart;
33
34
struct part;
/* TODO remove dependency */
Loic Hausammann's avatar
Loic Hausammann committed
35
struct engine;
36

37
38
/**
 * Logger entries contain messages representing the particle data at a given
39
 * point in time during the simulation.
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 *
 * 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.
57
58
 *   3   | u      | 4    | Particle internal energy (or entropy, if Gadget-SPH
 *       |        |      | is used), stored as a single float.
59
60
 *   4   | h      | 4    | Particle smoothing length (or epsilon, if a gpart),
 *       |        |      | stored as a single float.
61
 *   5   | rho    | 4    | Particle density, stored as a single float.
62
63
 *   6   | consts | 12   | Particle constants, i.e. mass and ID.
 *   7   | time   | 8    | Timestamp, not associated with a particle, just
64
65
66
67
68
69
70
 *       |        |      | 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
71
72
 * 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.
73
74
75
 */

/* Some constants. */
76
77
78
79
80
81
82
83
84
85
enum logger_masks {
  logger_mask_x = (1 << 0),
  logger_mask_v = (1 << 1),
  logger_mask_a = (1 << 2),
  logger_mask_u = (1 << 3),
  logger_mask_h = (1 << 4),
  logger_mask_rho = (1 << 5),
  logger_mask_consts = (1 << 6),
  logger_mask_timestamp = (1 << 7),
};
86

87
88
/* Size of the strings. */
#define logger_string_length 200
Loic Hausammann's avatar
Loic Hausammann committed
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

/* parameters of the logger */
struct logger_parameters {
  /* size of a label in bytes */
  size_t label_size;

  /* size of an offset in bytes */
  size_t offset_size;

  /* size of a mask in bytes */
  size_t mask_size;

  /* size of a number in bytes */
  size_t number_size;

  /* size of a data type in bytes */
  size_t data_type_size;
Loic Hausammann's avatar
Format    
Loic Hausammann committed
106

Loic Hausammann's avatar
Loic Hausammann committed
107
  /* number of different mask */
108
  size_t number_mask;
Loic Hausammann's avatar
Loic Hausammann committed
109
110
111
112
113
114

  /* value of each masks */
  size_t *masks;

  /* data size of each mask */
  size_t *masks_data_size;
Loic Hausammann's avatar
Format    
Loic Hausammann committed
115

Loic Hausammann's avatar
Loic Hausammann committed
116
117
  /* label of each mask */
  char *masks_name;
118
119
120

  /* Size of a chunk if every mask are activated */
  size_t total_size;
Loic Hausammann's avatar
Loic Hausammann committed
121
122
123
124
125
126
127
128
};

/* structure containing global data */
struct logger {
  /* Number of particle steps between dumping a chunk of data */
  short int delta_step;

  /* Logger basename */
129
  char base_name[logger_string_length];
Loic Hausammann's avatar
Loic Hausammann committed
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

  /* File name of the dump file */
  struct dump *dump;

  /* timestamp offset for logger*/
  size_t timestamp_offset;

  /* scaling factor when buffer is too small */
  float buffer_scale;

  /* logger parameters */
  struct logger_parameters *params;

} SWIFT_STRUCT_ALIGN;

/* required structure for each particle type */
struct logger_part_data {
  /* Number of particle updates since last output */
148
  int steps_since_last_output;
Loic Hausammann's avatar
Loic Hausammann committed
149
150
151
152
153

  /* offset of last particle log entry */
  size_t last_offset;
};

154
155
156
157
158
enum logger_datatype {
  logger_data_int,
  logger_data_float,
  logger_data_double,
  logger_data_char,
159
  logger_data_longlong,
lhausamm's avatar
lhausamm committed
160
161
  logger_data_bool,
  logger_data_count /* should be last */
162
};
163

164
extern const unsigned int logger_datatype_size[];
lhausamm's avatar
lhausamm committed
165

166
/* Function prototypes. */
lhausamm's avatar
lhausamm committed
167
int logger_compute_chunk_size(unsigned int mask);
lhausamm's avatar
lhausamm committed
168
void logger_log_all(struct logger *log, const struct engine *e);
Loic Hausammann's avatar
Format    
Loic Hausammann committed
169
170
171
172
173
void logger_log_part(struct logger *log, const struct part *p,
                     unsigned int mask, size_t *offset);
void logger_log_gpart(struct logger *log, const struct gpart *p,
                      unsigned int mask, size_t *offset);
void logger_init(struct logger *log, struct swift_params *params);
lhausamm's avatar
lhausamm committed
174
void logger_clean(struct logger *log);
175
void logger_log_timestamp(struct logger *log, integertime_t t, double time, size_t *offset);
lhausamm's avatar
lhausamm committed
176
void logger_ensure_size(struct logger *log, size_t total_nr_parts,
Loic Hausammann's avatar
Format    
Loic Hausammann committed
177
178
                        size_t total_nr_gparts, size_t total_nr_sparts);
void logger_write_file_header(struct logger *log, const struct engine *e);
lhausamm's avatar
lhausamm committed
179

Pedro Gonnet's avatar
Pedro Gonnet committed
180
181
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);
182
int logger_read_timestamp(unsigned long long int *t, double *time, size_t *offset,
Pedro Gonnet's avatar
Pedro Gonnet committed
183
                          const char *buff);
lhausamm's avatar
lhausamm committed
184

Loic Hausammann's avatar
Format    
Loic Hausammann committed
185
186
void logger_parameters_init(struct logger_parameters *log_params);
void logger_parameters_clean(struct logger_parameters *log_params);
lhausamm's avatar
lhausamm committed
187

188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
/**
 * @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;
  logger->steps_since_last_output = SHRT_MAX;
}

/**
 * @brief Should this particle write its data now ?
 *
 * @param xp The #xpart.
 * @param e The #engine containing information about the current time.
 * @return 1 if the #part should write, 0 otherwise.
 */
__attribute__((always_inline)) INLINE static int logger_should_write(
    const struct logger_part_data *logger_data, const struct logger *log) {

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

lhausamm's avatar
lhausamm committed
211
212
#endif /* WITH_LOGGER */

213
#endif /* SWIFT_LOGGER_H */