stats.h

// Part of readsb, a Mode-S/ADSB/TIS message decoder.
//
// stats.c: statistics structures and prototypes.
//
// Copyright (c) 2019 Michael Wolf <michael@mictronics.de>
//
// This code is based on a detached fork of dump1090-fa.
//
// Copyright (c) 2015 Oliver Jowett <oliver@mutability.co.uk>
//
// This file is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// any later version.
//
// This file 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 General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
//
// This file incorporates work covered by the following copyright and
// license:
//
// Copyright (C) 2012 by Salvatore Sanfilippo <antirez@gmail.com>
//
// 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.
//
// 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 DUMP1090_STATS_H
#define DUMP1090_STATS_H

struct stats
{
  int64_t start;
  int64_t end;
  // Mode S demodulator counts:
  uint32_t demod_preambles;
  uint32_t demod_rejected_bad;
  uint32_t demod_rejected_unknown_icao;
  uint32_t demod_accepted[MODES_MAX_BITERRORS + 1];
  uint32_t demod_preamblePhase[5];
  uint32_t demod_bestPhase[5];
  uint64_t samples_processed;
  uint64_t samples_dropped;
  uint64_t samples_lost;
  // Mode A/C demodulator counts:
  uint32_t demod_modeac;
  // number of signals with power > -3dBFS
  uint32_t strong_signal_count;
  // noise floor:
  double noise_power_sum;
  uint64_t noise_power_count;
  // mean signal power:
  double signal_power_sum;
  uint64_t signal_power_count;
  // peak signal power seen
  double peak_signal_power;
  // timing:
  struct timespec demod_cpu;
  struct timespec reader_cpu;
  struct timespec background_cpu;
  struct timespec aircraft_json_cpu;
  struct timespec trace_json_cpu;
  struct timespec globe_json_cpu;
  struct timespec bin_cpu;
  struct timespec heatmap_and_state_cpu;
  struct timespec remove_stale_cpu;
  struct timespec api_worker_cpu;
  struct timespec api_update_cpu;
  uint64_t api_request_count;
  // remote messages:
  uint32_t remote_received_modeac;
  uint32_t remote_received_modes;
  uint32_t remote_received_basestation_valid;
  uint32_t remote_received_basestation_invalid;
  uint32_t remote_rejected_bad;
  uint32_t remote_rejected_unknown_icao;
  uint32_t remote_rejected_delayed;
  uint32_t remote_accepted[MODES_MAX_BITERRORS + 1];
  uint32_t remote_malformed_beast;
  uint32_t remote_ping_rtt[PING_BUCKETS];
  uint64_t network_bytes_in;
  uint64_t network_bytes_out;
  // total messages:
  uint32_t messages_total;
  // CPR decoding:
  uint32_t cpr_surface;
  uint32_t cpr_airborne;
  uint32_t cpr_global_ok;
  uint32_t cpr_global_bad;
  uint32_t cpr_global_skipped;
  uint32_t cpr_global_range_checks;
  uint32_t cpr_global_speed_checks;
  uint32_t cpr_local_ok;
  uint32_t cpr_local_skipped;
  uint32_t cpr_local_range_checks;
  uint32_t cpr_local_speed_checks;
  uint32_t cpr_local_aircraft_relative;
  uint32_t cpr_local_receiver_relative;
  uint32_t cpr_filtered;

  uint32_t pos_all;
  uint32_t pos_duplicate;
  uint32_t pos_garbage;
  uint32_t pos_by_type[NUM_TYPES];

  uint32_t recentTraceWrites;
  uint32_t fullTraceWrites;
  uint32_t permTraceWrites;

  // number of altitude messages ignored because
  // we had a recent DF17/18 altitude
  uint32_t suppressed_altitude_messages;
  // aircraft:
  // total "new" aircraft (i.e. not seen in the last 30 or 300s)
  uint32_t unique_aircraft;
  // we saw only a single message
  uint32_t single_message_aircraft;
  // range histogram
#define RANGE_BUCKET_COUNT 128
  uint32_t range_histogram[RANGE_BUCKET_COUNT];
  double distance_max; // Longest range decoded, in *metres*
  double distance_min; // Shortest range decoded, in *metres*
};


struct statsCount {
    uint32_t readsb_aircraft_with_position;
    uint32_t readsb_aircraft_no_position;
    uint32_t readsb_aircraft_total;
    uint32_t readsb_aircraft_with_flight_number;
    uint32_t readsb_aircraft_without_flight_number;
    uint32_t type_counts[NUM_TYPES];
    uint32_t readsb_aircraft_adsb_version_0;
    uint32_t readsb_aircraft_adsb_version_1;
    uint32_t readsb_aircraft_adsb_version_2;
    uint32_t readsb_aircraft_emergency;
    double readsb_aircraft_rssi_average;
    float readsb_aircraft_rssi_max;
    float readsb_aircraft_rssi_min;
    float readsb_aircraft_rssi_quart1;
    float readsb_aircraft_rssi_median;
    float readsb_aircraft_rssi_quart3;
    float *rssi_table;
    int rssi_table_len;
    int rssi_table_alloc;
};

struct distCoords {
    float distance;
    float lat;
    float lon;
    int32_t alt;
} __attribute__ ((__packed__));

void add_stats (const struct stats *st1, const struct stats *st2, struct stats *target);
void display_stats (struct stats *st);
void reset_stats (struct stats *st);

void display_total_stats(void);
void display_total_short_range_stats();

void add_timespecs (const struct timespec *x, const struct timespec *y, struct timespec *z);

struct char_buffer generateStatusJson();
struct char_buffer generateStatusProm();
struct char_buffer generateStatsJson();
struct char_buffer generatePromFile();

void statsUpdate(int64_t now);
void checkDisplayStats(int64_t now);
void statsResetCount();
void statsCountAircraft(int64_t now);
void statsProcess(int64_t now);

#endif