DebugObserver.h

Go to the documentation of this file.

/*
 * PFPSim: Library for the Programmable Forwarding Plane Simulation Framework
 *
 * Copyright (C) 2016 Concordia Univ., Montreal
 *     Samar Abdi
 *     Umair Aftab
 *     Gordon Bailey
 *     Faras Dewal
 *     Shafigh Parsazad
 *     Eric Tremblay
 *
 * Copyright (C) 2016 Ericsson
 *     Bochra Boughzala
 *
 * 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 2
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */

#ifndef CORE_DEBUGGER_DEBUGOBSERVER_H_
#define CORE_DEBUGGER_DEBUGOBSERVER_H_

#include <string>
#include <map>
#include "../TrType.h"
#include "../PFPObserver.h"
#include "DebuggerIPCServer.h"
#include "DebugDataManager.h"
#include "DebuggerPacket.h"

#define VERBOSE 0

namespace pfp {
namespace core {
namespace db {

class DebugObserver : public PFPObserver {
 public:
  DebugObserver();

  ~DebugObserver();

  virtual void counter_added(const std::string& module_name,
        const std::string& counter_name, double simulation_time = 0);

  virtual void counter_removed(const std::string& module_name,
        const std::string& counter_name, double simulation_time = 0);

  virtual void counter_updated(const std::string& module_name,
        const std::string& counter_name,
        std::size_t new_value,
        double simulation_time);

  void data_written(const std::string& from_module,
        const std::shared_ptr<TrType> data,
        double simulation_time) override;

  void data_read(const std::string& to_module,
        const std::shared_ptr<TrType> data,
        double simulation_time) override;

  void data_dropped(const std::string& in_module,
        const std::shared_ptr<TrType> data,
        const std::string& drop_reason,
        double simulation_time) override;

  virtual void thread_begin(const std::string& teu_mod,
        const std::string& tec_mod, std::size_t thread_id,
        std::size_t packet_id, double simulation_time);

  virtual void thread_end(const std::string& teu_mod,
        const std::string& tec_mod, std::size_t thread_id,
        std::size_t packet_id, double simulation_time);

  virtual void thread_idle(const std::string& teu_mod,
        const std::string& tec_mod, std::size_t thread_id,
        std::size_t packet_id, double simulation_time);

  virtual void core_busy(const std::string& teu_mod,
        const std::string& tec_mod, double simulation_time);
  virtual void core_idle(const std::string& teu_mod,
        const std::string& tec_mod, double simulation_time);

  void waitForRunCommand();

  void registerCP(CPDebuggerInterface *cp_debug_if);

  void enableDebugger();

 private:
  DebuggerIPCServer *ipc_server;   
  DebugDataManager *data_manager;    
  bool enable = false;   
  void pause();

  void notifyServer();

  void updateSimulationTime(double sim_time);

  void updateWhoAmI(int packet_id);

  void updatePacketList(int id, std::string loc, double t);

  void checkBreakpointHit(std::string module, int packet_id,
        double sim_time, bool read);
};

};  // namespace db
};  // namespace core
};  // namespace pfp

#endif  // CORE_DEBUGGER_DEBUGOBSERVER_H_