logger.h

/*******************************************************************************
 * This file is part of SWIFT.
 * Copyright (c) 2017 Pedro Gonnet (pedro.gonnet@durham.ac.uk)
 *               2018 Loic Hausammann (loic.hausammann@epfl.ch)
 *
 * 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

#include "../config.h"

#ifdef WITH_LOGGER

/* Includes. */
#include "common_io.h"
#include "dump.h"
#include "inline.h"
#include "timeline.h"
#include "units.h"

/* Forward declaration. */
struct dump;
struct gpart;
struct part;
struct engine;

#define logger_major_version 0
#define logger_minor_version 3

/**
 * Logger entries contain messages representing the particle data at a given
 * point in time during the simulation.
 *
 * 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.
 *   3   | u      | 4    | Particle internal energy (or entropy, if Gadget-SPH
 *       |        |      | is used), stored as a single float.
 *   4   | h      | 4    | Particle smoothing length (or epsilon, if a gpart),
 *       |        |      | stored as a single float.
 *   5   | rho    | 4    | Particle density, stored as a single float.
 *   6   | consts | 12   | Particle constants, i.e. mass and ID.
 *   7   | time   | 8    | Timestamp, not associated with a particle, just
 *       |        |      | 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
 * 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.
 */

/* Some constants. */
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,
  logger_special_flags = 7, /* Flag for special cases */
  logger_timestamp = 8,  /* expect it to be before count. */
  logger_count_mask = 9, /* Need to be the last. */
} __attribute__((packed));

/* 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));

enum logger_special_flags {
  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 */
} __attribute__((packed));

struct mask_data {
  /* Number of bytes for a mask. */
  int size;

  /* Mask value. */
  unsigned int mask;

  /* Name of the mask. */
  char name[100];
};

extern const struct mask_data logger_mask_data[logger_count_mask];

/* Size of the strings. */
#define logger_string_length 200

/**
 * @brief structure containing global data for the particle logger.
 */
struct logger_writer {
  /* Number of particle steps between dumping a chunk of data. */
  short int delta_step;

  /* Logger basename. */
  char base_name[logger_string_length];

  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;

  /*  Dump file (In the reader, the dump is cleaned, therefore it is renamed
   * logfile). */
  struct dump dump;

  /* timestamp offset for logger. */
  size_t timestamp_offset;

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

  /* Size of a chunk if every mask are activated. */
  int max_chunk_size;

} SWIFT_STRUCT_ALIGN;

/* required structure for each particle type. */
struct logger_part_data {
  /* Number of particle updates since last output. */
  int steps_since_last_output;

  /* offset of last particle log entry. */
  uint64_t last_offset;
};

/* Function prototypes. */
int logger_compute_chunk_size(unsigned int mask);
void logger_log_all(struct logger_writer *log, const struct engine *e);
void logger_log_part(struct logger_writer *log, const struct part *p,
                     unsigned int mask, size_t *offset,
                     const int special_flags);
void logger_log_parts(struct logger_writer *log, const struct part *p,
                      struct xpart *xp, unsigned int mask,
                      int count, const int special_flags);
void logger_log_spart(struct logger_writer *log, const struct spart *p,
                      unsigned int mask, size_t *offset,
                      const int special_flags);
void logger_log_sparts(struct logger_writer *log, struct spart *sp,
                       unsigned int mask, int count,
                       const int special_flags);
void logger_log_gpart(struct logger_writer *log, const struct gpart *p,
                      unsigned int mask, size_t *offset,
                      const int special_flags);
void logger_log_gparts(struct logger_writer *log, struct gpart *gp,
                       unsigned int mask, int count,
                       const int special_flags);
void logger_init(struct logger_writer *log, struct swift_params *params);
void logger_free(struct logger_writer *log);
void logger_log_timestamp(struct logger_writer *log, integertime_t t,
                          double time, size_t *offset);
void logger_ensure_size(struct logger_writer *log, size_t total_nr_parts,
                        size_t total_nr_gparts, size_t total_nr_sparts);
void logger_write_file_header(struct logger_writer *log);

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);
int logger_read_timestamp(unsigned long long int *t, double *time,
                          size_t *offset, const char *buff);
void logger_struct_dump(const struct logger_writer *log, FILE *stream);
void logger_struct_restore(struct logger_writer *log, FILE *stream);


/**
 * @brief Generate the data for the special flags.
 *
 * @param flag The special flag to use.
 * @param data The data to write in the .
 */
INLINE static int logger_generate_flag_data(enum logger_special_flags flag, int data) {
#ifdef SWIFT_DEBUG_CHECKS
  if (flag & 0xFFFFFF00) {
    error("The special flag in the logger cannot be larger than 1 byte.");
  }
  if (data & ~0xFFFFFF) {
    error("The data for the special flag in the logger cannot be larger than 3 bytes.");
  }
#endif
  return ((uint32_t) flag << (3 * 8)) | (data & 0xFFFFFF);
}

/**
 * @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 = INT_MAX;
}

/**
 * @brief Should this particle write its data now ?
 *
 * @param logger_data The #logger_part_data of a particle.
 * @param log The #logger_writer.
 *
 * @return 1 if the particle should be writen, 0 otherwise.
 */
__attribute__((always_inline)) INLINE static int logger_should_write(
    const struct logger_part_data *logger_data,
    const struct logger_writer *log) {

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

#endif /* WITH_LOGGER */

#endif /* SWIFT_LOGGER_H */