dev_mgr.h

Go to the documentation of this file.

/* Copyright 2013-present Barefoot Networks, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
/*
 * Antonin Bas (antonin@barefootnetworks.com)
 *
 */
 
 
#ifndef BM_BM_SIM_DEV_MGR_H_
#define BM_BM_SIM_DEV_MGR_H_
 
#include <bm/config.h>
 
#include <functional>
#include <map>
#include <memory>
#include <string>
 
#include "packet_handler.h"
#include "port_monitor.h"
 
namespace bm {
 
class DevMgrIface : public PacketDispatcherIface {
 public:
  using port_t = PortMonitorIface::port_t;
  using PortStatus = PortMonitorIface::PortStatus;
  using PortStatusCb = PortMonitorIface::PortStatusCb;
  using PortExtras = std::map<std::string, std::string>;
 
  static constexpr char kPortExtraInPcap[] = "in_pcap";
  static constexpr char kPortExtraOutPcap[] = "out_pcap";
 
  struct PortInfo {
    PortInfo(port_t port_num, const std::string &iface_name,
             const PortExtras &port_extras = {})
        : port_num(port_num), iface_name(iface_name), extra(port_extras) { }
 
    void set_is_up(bool status) {
      is_up = status;
    }
 
    void add_extra(const std::string &key, const std::string &value) {
      extra.emplace(key, value);
    }
 
    port_t port_num{};
    std::string iface_name{};
    bool is_up{true};
    PortExtras extra{};
  };
 
  struct PortStats {
    uint64_t in_packets;
    uint64_t in_octets;
    uint64_t out_packets;
    uint64_t out_octets;
 
    static PortStats make(uint64_t in_packets, uint64_t in_octets,
                          uint64_t out_packets, uint64_t out_octets) {
      return {in_packets, in_octets, out_packets, out_octets};
    }
  };
 
  virtual ~DevMgrIface();
 
  ReturnCode port_add(const std::string &iface_name, port_t port_num,
                      const PortExtras &port_extras);
 
  ReturnCode port_remove(port_t port_num);
 
  // TODO(antonin): add this?
  // ReturnCode set_port_status(port_t port_num, PortStatus status);
 
  void transmit_fn(port_t port_num, const char *buffer, int len) {
    transmit_fn_(port_num, buffer, len);
  }
 
  // start the thread that performs packet processing
  void start();
 
  ReturnCode set_packet_handler(const PacketHandler &handler, void *cookie);
 
  bool port_is_up(port_t port_num) const;
 
  ReturnCode register_status_cb(const PortStatus &type,
                                const PortStatusCb &port_cb);
 
  std::map<port_t, PortInfo> get_port_info() const;
 
  PortStats get_port_stats(port_t port) const;
  // clear and return stats (before clear)
  PortStats clear_port_stats(port_t port);
 
 protected:
  std::unique_ptr<PortMonitorIface> p_monitor{nullptr};
 
 private:
  virtual ReturnCode port_add_(const std::string &iface_name, port_t port_num,
                               const PortExtras &port_extras) = 0;
 
  virtual ReturnCode port_remove_(port_t port_num) = 0;
 
  virtual void transmit_fn_(port_t port_num, const char *buffer, int len) = 0;
 
  virtual void start_() = 0;
 
  virtual ReturnCode set_packet_handler_(const PacketHandler &handler,
                                         void *cookie) = 0;
 
  virtual bool port_is_up_(port_t port_num) const = 0;
 
  virtual std::map<port_t, PortInfo> get_port_info_() const = 0;
 
  virtual PortStats get_port_stats_(port_t port) const;
  virtual PortStats clear_port_stats_(port_t port);
};
 
// TODO(antonin): should DevMgr and DevMgrIface somehow inherit from a common
// interface, or is it not worth the trouble?
 
class DevMgr : public PacketDispatcherIface {
 public:
  using port_t = PortMonitorIface::port_t;
  using PortStatus = PortMonitorIface::PortStatus;
  using PortStatusCb = PortMonitorIface::PortStatusCb;
  using PortExtras = DevMgrIface::PortExtras;
 
  DevMgr();
 
  // set_dev_* : should be called before port_add and port_remove.
 
  // meant for testing
  void set_dev_mgr(std::unique_ptr<DevMgrIface> my_pimp);
 
  void set_dev_mgr_bmi(
      device_id_t device_id,
      int max_port_count,
      std::shared_ptr<TransportIface> notifications_transport = nullptr);
 
  // The interface names are instead interpreted as file names.
  // wait_time_in_seconds indicate how long the starting thread should
  // wait before starting to process packets.
  void set_dev_mgr_files(unsigned wait_time_in_seconds);
 
#ifdef BM_NANOMSG_ON
  // if enforce ports is set to true, packets coming in on un-registered ports
  // are dropped
  void set_dev_mgr_packet_in(
      device_id_t device_id, const std::string &addr,
      std::shared_ptr<TransportIface> notifications_transport = nullptr,
      bool enforce_ports = false);
#endif
 
  ReturnCode port_add(const std::string &iface_name, port_t port_num,
                      const PortExtras &port_extras);
 
  ReturnCode port_remove(port_t port_num);
 
  bool port_is_up(port_t port_num) const;
 
  std::map<port_t, DevMgrIface::PortInfo> get_port_info() const;
 
  DevMgrIface::PortStats get_port_stats(port_t port_num) const;
  DevMgrIface::PortStats clear_port_stats(port_t port_num);
 
  void transmit_fn(port_t port_num, const char *buffer, int len);
 
  ReturnCode set_packet_handler(const PacketHandler &handler, void *cookie)
      override;
 
  ReturnCode register_status_cb(const PortStatus &type,
                                const PortStatusCb &port_cb);
 
  // start the thread that performs packet processing
  void start();
 
  DevMgr(const DevMgr &other) = delete;
  DevMgr &operator=(const DevMgr &other) = delete;
 
  DevMgr(DevMgr &&other) = delete;
  DevMgr &operator=(DevMgr &&other) = delete;
 
 protected:
  ~DevMgr();
 
  std::string sample_packet_data(const char *buffer, int len);
 
  size_t dump_packet_data{0};
 
  int max_port_count;
 
 private:
  // Actual implementation (private)
  std::unique_ptr<DevMgrIface> pimp{nullptr};
};
 
}  // namespace bm
 
#endif  // BM_BM_SIM_DEV_MGR_H_