ZephCore/zephcore/app/RepeaterMesh.h

#pragma once

//#include <Arduino.h>
#include <mesh/Mesh.h>
// ZEPHCORE: Zephyr platform headers instead of RTClib, target.h and the
// per-platform file systems; storage goes through RepeaterDataStore.
#include <zephyr/sys/atomic.h>
#include <mesh/StaticPoolPacketManager.h>
#include <mesh/SimpleMeshTables.h>
#include <helpers/MeshTimeSync.h>
#include <helpers/NodePrefs.h>
#include "RepeaterDataStore.h"
#if IS_ENABLED(CONFIG_ZEPHCORE_REPEATER_UPLINK)
#include "observer_creds.h"
#endif

#include <helpers/AdvertDataHelpers.h>
#include <helpers/ClientACL.h>
#include <helpers/CommonCLI.h>
#include <helpers/IdentityStore.h>
#include <helpers/StatsFormatHelper.h>
#include <helpers/TxtDataHelpers.h>
#include <helpers/RegionMap.h>
#include <helpers/RoutingPolicy.h>
#include <helpers/TransportKeyStore.h>
#include <helpers/RateLimiter.h>

struct RepeaterStats {
  uint16_t batt_milli_volts;
  uint16_t curr_tx_queue_len;
  int16_t  noise_floor;
  int16_t  last_rssi;
  uint32_t n_packets_recv;
  uint32_t n_packets_sent;
  uint32_t total_air_time_secs;
  uint32_t total_up_time_secs;
  uint32_t n_sent_flood, n_sent_direct;
  uint32_t n_recv_flood, n_recv_direct;
  uint16_t err_events;                // was 'n_full_events'
  int16_t  last_snr;   // x 4
  uint16_t n_direct_dups, n_flood_dups;
  uint32_t total_rx_air_time_secs;
  uint32_t n_recv_errors;
};

struct NeighbourInfo {
  mesh::Identity id;
  uint32_t advert_timestamp;
  uint32_t heard_timestamp;
  int8_t snr; // multiplied by 4, user should divide to get float value

  // ZEPHCORE: in place of upstream's NeighbourInfo() value-initialisation.
  void clear() {
    id = mesh::Identity();
    advert_timestamp = 0;
    heard_timestamp = 0;
    snr = 0;
  }
};

// ZEPHCORE: the version is injected by CMakeLists.txt; these fallbacks only
// apply to builds that bypass it.
#ifndef FIRMWARE_BUILD_DATE
  #define FIRMWARE_BUILD_DATE   __DATE__
#endif

#ifndef FIRMWARE_VERSION
  #define FIRMWARE_VERSION   "v0.0.0-dev"
#endif

#define FIRMWARE_ROLE "repeater"

#define PACKET_LOG_FILE  "/packet_log"

// ZEPHCORE: table size from Kconfig.
#ifndef MAX_NEIGHBOURS
  #ifdef CONFIG_ZEPHCORE_MAX_NEIGHBOURS
    #define MAX_NEIGHBOURS  CONFIG_ZEPHCORE_MAX_NEIGHBOURS
  #else
    #define MAX_NEIGHBOURS  50
  #endif
#endif

class RepeaterMesh : public mesh::Mesh, public CommonCLICallbacks {
  // ZEPHCORE: our board handle and datastore instead of FILESYSTEM* _fs.
  mesh::MainBoard& _board;
  RepeaterDataStore* _store;
  uint32_t last_millis;
  uint64_t uptime_millis;
  unsigned long next_local_advert, next_flood_advert;
  bool _logging;
  NodePrefs _prefs;
  ClientACL  acl;
  CommonCLI _cli;
  uint8_t reply_data[MAX_PACKET_PAYLOAD];
  uint8_t reply_path[MAX_PATH_SIZE];
  uint8_t reply_path_len;
  TransportKeyStore key_store;
  RegionMap region_map, temp_map;
  RegionEntry* load_stack[8];
  RegionEntry* recv_pkt_region;
  // ZEPHCORE: a null recv_pkt_region means either a DIRECT request or an
  // un-scoped flood our wildcard denies, and sendFloodReply() treats them
  // differently, so the route type is recorded (UPSTREAM_TRACKER fad11c90).
  bool recv_pkt_unscoped_flood;
  TransportKey default_scope;
  RateLimiter discover_limiter, anon_limiter;
  RateLimiter login_fail_limiter;  // ZEPHCORE: wrong-password attempts (MeshCore#2556)
  uint32_t pending_discover_tag;
  unsigned long pending_discover_until;
  bool region_load_active;
  unsigned long dirty_contacts_expiry;
#if MAX_NEIGHBOURS
  NeighbourInfo neighbours[MAX_NEIGHBOURS];
#endif
  CayenneLPP telemetry;
  unsigned long set_radio_at, revert_radio_at;
  float pending_freq;
  float pending_bw;
  uint8_t pending_sf;
  uint8_t pending_cr;
  int  matching_peer_indexes[MAX_CLIENTS];
  // ZEPHCORE: mesh time sync and the MQTT uplink.
  MeshTimeSync _timesync{FIRMWARE_BUILD_EPOCH};
#if IS_ENABLED(CONFIG_ZEPHCORE_REPEATER_UPLINK)
  ObserverCreds _uplink_creds;
  bool _uplink_reboot_required;
  char _uplink_pubkey_hex[PUB_KEY_SIZE * 2 + 1];
  char _uplink_packets_topic[160];
  char _uplink_status_topic[160];
  float _uplink_last_score;
  float _uplink_last_rssi;
  uint8_t _uplink_last_raw[MAX_TRANS_UNIT];
  int _uplink_last_raw_len;
  unsigned long _uplink_next_status_at;
  // Set by the MQTT CONNACK callback (publisher thread), drained on the main
  // thread in maintenanceLoop().
  atomic_t _uplink_connect_pending;
#endif

  void putNeighbour(const mesh::Identity& id, uint32_t timestamp, float snr);
  uint8_t handleLoginReq(const mesh::Identity& sender, const uint8_t* secret, uint32_t sender_timestamp, const uint8_t* data, bool is_flood);
  // ZEPHCORE: each takes data_len so the reply path is bounded by the bytes received.
  uint8_t handleAnonRegionsReq(const mesh::Identity& sender, uint32_t sender_timestamp, const uint8_t* data, size_t data_len);
  uint8_t handleAnonOwnerReq(const mesh::Identity& sender, uint32_t sender_timestamp, const uint8_t* data, size_t data_len);
  uint8_t handleAnonClockReq(const mesh::Identity& sender, uint32_t sender_timestamp, const uint8_t* data, size_t data_len);
  int handleRequest(ClientInfo* sender, uint32_t sender_timestamp, uint8_t* payload, size_t payload_len);
  mesh::Packet* createSelfAdvert();

  bool isLooped(const mesh::Packet* packet, const uint8_t max_counters[]);

  void timeSyncTick();  // ZEPHCORE
  void handleRegionLoadLine(uint32_t sender_timestamp, char* command, char* reply);  // ZEPHCORE

protected:
  // ZEPHCORE: our Dispatcher asks for a duty-cycle percentage.
  uint8_t getDutyCyclePercent() const override {
    // Arduino formula: duty% = 100 / (af + 1). af=0 -> 100%, af=9 -> 10%.
    return (uint8_t)(100.0f / (_prefs.airtime_factor + 1.0f) + 0.5f);
  }

  bool allowPacketForward(const mesh::Packet* packet) override;
  const char* getLogDateTime() override;
  void logRxRaw(float snr, float rssi, const uint8_t raw[], int len) override;

  void logRx(mesh::Packet* pkt, int len, float score) override;
  void logTx(mesh::Packet* pkt, int len) override;
  void logTxFail(mesh::Packet* pkt, int len) override;

  uint32_t getRetransmitDelay(const mesh::Packet* packet) override;
  uint32_t getDirectRetransmitDelay(const mesh::Packet* packet) override;

  int getInterferenceThreshold() const override {
    return _prefs.interference_threshold;
  }
  uint8_t getExtraAckTransmitCount() const override {
    return _prefs.multi_acks;
  }

  // ZEPHCORE: adaptive CAD.
  int formatFreqErrorStatus(char* buf, int cap) override {
    return _radio->formatFreqErrorStatus(buf, cap);
  }
  int formatCadStatus(char* buf, int cap) override {
    return _radio->formatCadStatus(buf, cap);
  }
  void applyCadPrefs() override {
    _radio->setCadParams(_prefs.cad_auto != 0, _prefs.cad_offset,
                         _prefs.probe_interval, _prefs.cad_busycap,
                         _prefs.cad_base);
    _prefs.cad_offset = _radio->getCadOffset();
    _prefs.cad_base = _radio->cadBasePeak();
  }
  void resetCadStats() override {
    _radio->resetCadStats();
  }
  void onCadOffsetChanged(int8_t offset) override {
    // Staircase steps are hours apart: persisting at once is fine for wear.
    _prefs.cad_offset = offset;
    savePrefs();
  }

  mesh::DispatcherAction onRecvPacket(mesh::Packet* pkt) override;

  void onAnonDataRecv(mesh::Packet* packet, const uint8_t* secret, const mesh::Identity& sender, uint8_t* data, size_t len) override;
  int searchPeersByHash(const uint8_t* hash) override;
  void getPeerSharedSecret(uint8_t* dest_secret, int peer_idx) override;
  void onAdvertRecv(mesh::Packet* packet, const mesh::Identity& id, uint32_t timestamp, const uint8_t* app_data, size_t app_data_len);
  void onPeerDataRecv(mesh::Packet* packet, uint8_t type, int sender_idx, const uint8_t* secret, uint8_t* data, size_t len) override;
  bool onPeerPathRecv(mesh::Packet* packet, int sender_idx, const uint8_t* secret, uint8_t* path, uint8_t path_len, uint8_t extra_type, uint8_t* extra, uint8_t extra_len) override;
  void onControlDataRecv(mesh::Packet* packet) override;

  void sendFloodReply(mesh::Packet* packet, unsigned long delay_millis, uint8_t path_hash_size);

#if IS_ENABLED(CONFIG_ZEPHCORE_REPEATER_UPLINK)
  // ZEPHCORE: MQTT uplink (app/RepeaterUplink.cpp).
  bool handleUplinkCommand(const char *command, char *reply);
  void markUplinkRebootRequired() { _uplink_reboot_required = true; }
  bool isUplinkEnabled() const { return (_uplink_creds._reserved[0] & 0x01) != 0; }
  void setUplinkEnabled(bool en) {
    if (en) {
      _uplink_creds._reserved[0] |= 0x01;
    } else {
      _uplink_creds._reserved[0] &= (uint8_t)~0x01;
    }
  }
  bool saveUplinkCreds();
  void publishUplinkPacket(mesh::Packet *pkt);
  void publishUplinkStatus(const char *status);
#endif

public:
  RepeaterMesh(mesh::MainBoard& board, mesh::Radio& radio, mesh::MillisecondClock& ms, mesh::RNG& rng, mesh::RTCClock& rtc, mesh::MeshTables& tables);

  void begin(RepeaterDataStore* store);  // ZEPHCORE: was begin(FILESYSTEM* fs)
  void sendNodeDiscoverReq();
  const char* getFirmwareVer() override { return FIRMWARE_VERSION; }
  const char* getBuildDate() override { return FIRMWARE_BUILD_DATE; }
  const char* getRole() override { return FIRMWARE_ROLE; }
  const char* getNodeName() { return _prefs.node_name; }
  NodePrefs* getNodePrefs() {
    return &_prefs;
  }

  void savePrefs() override;  // ZEPHCORE: through RepeaterDataStore

  void sendFloodScoped(const TransportKey& scope, mesh::Packet* pkt, uint32_t delay_millis, uint8_t path_hash_size);

  // CommonCLICallbacks
  void applyTempRadioParams(float freq, float bw, uint8_t sf, uint8_t cr, int timeout_mins) override;
  bool formatFileSystem() override;
  void sendSelfAdvertisement(int delay_millis, bool flood) override;
  void updateAdvertTimer() override;
  void updateFloodAdvertTimer() override;

  void setLoggingOn(bool enable) override { _logging = enable; }

  void eraseLogFile() override;  // ZEPHCORE: no log file

  void dumpLogFile() override;
  void setTxPower(int8_t power_dbm) override;
  void formatNeighborsReply(char *reply) override;
  void removeNeighbor(const uint8_t* pubkey, int key_len) override;
  void formatStatsReply(char *reply) override;
  void formatRadioStatsReply(char *reply) override;
  void formatPacketStatsReply(char *reply) override;
  void startRegionsLoad() override;
  bool saveRegions() override;
  void onDefaultRegionChanged(const RegionEntry* r) override;

  mesh::LocalIdentity& getSelfId() override { return self_id; }

  void saveIdentity(const mesh::LocalIdentity& new_id) override;
  void clearStats() override;

  void handleCommand(uint32_t sender_timestamp, char* command, char* reply);
  void loop();

  // ZEPHCORE: no hasPendingWork(); the event loop never polls for it.

  bool setRxBoostedGain(bool enable) override;

  // ZEPHCORE: every radio family, not only LR2021 (the others report unsupported).
  bool configSideDetectors(const uint8_t* sfs, uint8_t num) override;

  // ZEPHCORE: CommonCLICallbacks additions.
  uint32_t getDefaultGpsIntervalSec() const override { return CONFIG_ZEPHCORE_REPEATER_GPS_INTERVAL_SEC; }
  void freezeRadioParams(float freq, float bw, uint8_t sf, uint8_t cr) override;
  bool setFemRxGain(bool enable) override;
  MeshTimeSync* getMeshTimeSync() override { return &_timesync; }
  void noteGPSTimeSync() { _timesync.noteGPSSync((uint32_t)(k_uptime_get() / 1000)); }
  float getContentionEstimate() const override {
    return getContentionTracker().getContentionEstimate();
  }
  float getFloodDelayFactor() const override {
    return getContentionTracker().getFloodDelayFactor();
  }
  void setBackoffMultiplier(float m) override {
    getContentionTracker().setBackoffMultiplier(m);
  }
  // Duty-cycle false-preamble re-arms (SX126x only; others return 0).
  uint32_t getDutyCycleTimeoutRestarts() const override;
  void resetDutyCycleTimeoutRestarts() override;

  // ZEPHCORE: folds this role's own deadlines (adverts, tempradio, ACL flush,
  // uplink status, time sync) into the base maintenance deadline, so the event
  // loop arms one wake for loop() and maintenanceLoop().
  uint32_t msUntilNextMaintenance() override;
};