rl.h

Go to the documentation of this file.

/*
 * Copyright (c) 2016-2020, ETH Zurich, Computer Engineering Group
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice, this
 *   list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright notice,
 *   this list of conditions and the following disclaimer in the documentation
 *   and/or other materials provided with the distribution.
 *
 * * Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef RL_H_
#define RL_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#include <linux/limits.h>
#include <sys/types.h>
 
#include "version.h"
 
#define SUCCESS (0)
#define ERROR (-1)
 
#define RL_MEASUREMENT_LOG_FILE "/var/log/rocketlogger/rocketlogger.log"
#define RL_DAEMON_LOG_FILE "/var/log/rocketlogger/rocketloggerd.log"
#define RL_PID_FILE "/run/rocketlogger.pid"
 
#define RL_CHANNEL_COUNT 9
#define RL_CHANNEL_SWITCHED_COUNT 2
#define RL_CHANNEL_DIGITAL_COUNT 6
#define RL_SAMPLE_RATE_MIN 1000
#define RL_SENSOR_COUNT_MAX 128
#define RL_SENSOR_SAMPLE_RATE 1
 
#define RL_CALIBRATION_USER_FILE                                               \
    "/home/rocketlogger/.config/rocketlogger/calibration.dat"
#define RL_CALIBRATION_SYSTEM_FILE "/etc/rocketlogger/calibration.dat"
 
#define RL_CONFIG_USER_FILE                                                    \
    "/home/rocketlogger/.config/rocketlogger/settings.dat"
#define RL_CONFIG_SYSTEM_FILE "/etc/rocketlogger/settings.dat"
 
#define RL_CONFIG_VERSION 0x03
#define RL_CONFIG_CHANNEL_V1 0
#define RL_CONFIG_CHANNEL_V2 1
#define RL_CONFIG_CHANNEL_V3 2
#define RL_CONFIG_CHANNEL_V4 3
#define RL_CONFIG_CHANNEL_I1L 4
#define RL_CONFIG_CHANNEL_I1H 5
#define RL_CONFIG_CHANNEL_I2L 6
#define RL_CONFIG_CHANNEL_I2H 7
#define RL_CONFIG_CHANNEL_DT 8
#define RL_CONFIG_CHANNEL_ENABLE_DEFAULT                                       \
    { true, true, true, true, true, true, true, true, false }
#define RL_CONFIG_CHANNEL_I1 0
#define RL_CONFIG_CHANNEL_I2 1
#define RL_CONFIG_CHANNEL_FORCE_RANGE_DEFAULT                                  \
    { false, false }
 
#define RL_CONFIG_FILE_DIR_DEFAULT "/home/rocketlogger/data"
#define RL_CONFIG_FILE_DEFAULT RL_CONFIG_FILE_DIR_DEFAULT "/data.rld"
#define RL_CONFIG_FILE_SIZE_MIN (5UL * 1000UL * 1000UL)
#define RL_CONFIG_FILE_SIZE_DEFAULT (1000UL * 1000UL * 1000UL)
#define RL_CONFIG_COMMENT_DEFAULT "Sampled using the RocketLogger"
 
#define RL_SHMEM_STATUS_KEY 1111
#define RL_SHMEM_DATA_KEY 4443
#define RL_SHMEM_PERMISSIONS 0666
 
#define RL_ZMQ_STATUS_SOCKET "tcp://127.0.0.1:8276"
#define RL_ZMQ_DATA_SOCKET "tcp://127.0.0.1:8277"
 
enum rl_aggregation_mode {
    RL_AGGREGATION_MODE_DOWNSAMPLE, 
    RL_AGGREGATION_MODE_AVERAGE,    
};
 
typedef enum rl_aggregation_mode rl_aggregation_mode_t;
 
enum rl_file_format {
    RL_FILE_FORMAT_CSV, 
    RL_FILE_FORMAT_RLD, 
};
 
typedef enum rl_file_format rl_file_format_t;
 
struct rl_config {
    uint8_t config_version;
    bool background_enable;
    bool interactive_enable;
    uint64_t sample_limit;
    uint32_t sample_rate;
    uint32_t update_rate;
    bool channel_enable[RL_CHANNEL_COUNT];
    bool channel_force_range[RL_CHANNEL_SWITCHED_COUNT];
    rl_aggregation_mode_t aggregation_mode;
    bool digital_enable;
    bool web_enable;
    bool calibration_ignore;
    bool ambient_enable;
    bool file_enable;
    char file_name[PATH_MAX];
    rl_file_format_t file_format;
    uint64_t file_size;
    char const *file_comment;
};
 
typedef struct rl_config rl_config_t;
 
struct rl_status {
    bool sampling;
    bool error;
    uint64_t sample_count;
    uint64_t buffer_count;
    uint64_t calibration_time;
    char calibration_file[PATH_MAX];
    uint64_t disk_free;
    uint16_t disk_free_permille;
    uint32_t disk_use_rate;
    uint16_t sensor_count;
    bool sensor_available[RL_SENSOR_COUNT_MAX];
    rl_config_t const *config;
};
 
typedef struct rl_status rl_status_t;
 
extern char const *const RL_CHANNEL_NAMES[RL_CHANNEL_COUNT];
 
extern char const *const RL_CHANNEL_FORCE_NAMES[RL_CHANNEL_SWITCHED_COUNT];
 
extern char const *const RL_CHANNEL_DIGITAL_NAMES[RL_CHANNEL_DIGITAL_COUNT];
 
extern char const *const RL_CHANNEL_VALID_NAMES[RL_CHANNEL_SWITCHED_COUNT];
 
void rl_config_print(rl_config_t const *const config);
 
void rl_config_print_cmd(rl_config_t const *const config);
 
void rl_config_print_json(rl_config_t const *const config);
 
char *rl_config_get_json(rl_config_t const *const config);
 
void rl_config_reset(rl_config_t *const config);
 
int rl_config_read_default(rl_config_t *const config);
 
int rl_config_write_default(rl_config_t const *const config);
 
int rl_config_validate(rl_config_t const *const config);
 
pid_t rl_pid_get(void);
 
int rl_pid_set(pid_t pid);
 
void rl_status_reset(rl_status_t *const status);
 
int rl_status_pub_init(void);
 
int rl_status_pub_deinit(void);
 
int rl_status_shm_init(void);
 
int rl_status_shm_deinit(void);
 
int rl_status_read(rl_status_t *const status);
 
int rl_status_write(rl_status_t *const status);
 
void rl_status_print(rl_status_t const *const status);
 
void rl_status_print_json(rl_status_t const *const status);
 
char *rl_status_get_json(rl_status_t const *const status);
 
extern rl_status_t rl_status;
 
#endif /* RL_H_ */