ntopng/include/ObservationPoint.h

/*
 *
 * (C) 2013-26 - ntop.org
 *
 *
 * This program 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
 * (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 General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 *
 */

#ifndef _OBSERVATION_POINT_H
#define _OBSERVATION_POINT_H

#include "ntop_includes.h"

class Score;

struct ndpi_in6_addr_less {
  bool operator()(const struct ndpi_in6_addr& a, const struct ndpi_in6_addr& b) const {
    return memcmp(&a, &b, sizeof(struct ndpi_in6_addr)) < 0;
  }
};

class ObservationPoint : public GenericHashEntry,
                         public GenericTrafficElement,
                         public Score {
 private:
  /* Note: country name can be more then 2 chars, see
   * https://www.iso.org/iso-3166-country-codes.html
   */
  u_int16_t obs_point;
  NetworkStats dirstats;
  u_int64_t num_flows;
  std::set<struct ndpi_in6_addr, ndpi_in6_addr_less> exporter_list;
  std::atomic<bool> delete_requested;
  bool remove_entry;

  inline void incSentStats(time_t t, u_int64_t num_pkts, u_int64_t num_bytes) {
    if (first_seen == 0)
      first_seen = t, last_seen = iface->getTimeLastPktRcvd();
    sent.incStats(t, num_pkts, num_bytes);
  }

  inline void incRcvdStats(time_t t, u_int64_t num_pkts, u_int64_t num_bytes) {
    rcvd.incStats(t, num_pkts, num_bytes);
  }

 public:
  ObservationPoint(NetworkInterface* _iface, u_int16_t obs_point);
  ~ObservationPoint();

  void set_hash_entry_state_idle();
  bool is_hash_entry_state_idle_transition_ready();

  inline u_int64_t getNumFlows() { return num_flows; }
  inline u_int32_t getNumHosts() { return getUses(); }
  inline u_int32_t key() { return obs_point; }
  inline u_int32_t getObsPoint() { return obs_point; }
  inline void addProbeIp(struct ndpi_in6_addr* probe_ip) {
    exporter_list.insert(*probe_ip);
  }

  bool equal(u_int16_t _obs_point) { return (obs_point == _obs_point); }
  inline bool equal(ObservationPoint* _obs_point) {
    return (obs_point == _obs_point->key());
  }

  inline void incFlows() { num_flows++; }

  inline void incStats(time_t when, u_int16_t proto_id, u_int64_t sent_packets,
                       u_int64_t sent_bytes, u_int64_t rcvd_packets,
                       u_int64_t rcvd_bytes) {
    if (!remove_entry) {
      if (ndpiStats || (ndpiStats = new nDPIStats()))
        ndpiStats->incStats(when, proto_id, sent_packets, sent_bytes,
                            rcvd_packets, rcvd_bytes);
      incSentStats(when, sent_packets, sent_bytes);
      incRcvdStats(when, rcvd_packets, rcvd_bytes);
    }
  }

  virtual void updateStats(const struct timeval* tv);

  void lua(lua_State* vm, DetailsLevel details_level, bool asListElement);

  inline char* getSerializationKey(char* buf, u_int bufsize) {
    snprintf(buf, bufsize, OBS_POINT_SERIALIZED_KEY, (u_int)iface->get_id(),
             obs_point);
    return (buf);
  }

  inline void setDeleteRequested(bool to_be_deleted) {
    delete_requested = to_be_deleted;
  }
  inline void deleteObsStats() { remove_entry = true; }
};

#endif /* _OBSERVATION_POINT_H */