CPDebuggerInterface.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_CPDEBUGGERINTERFACE_H_
#define CORE_DEBUGGER_CPDEBUGGERINTERFACE_H_

#include <string>
#include <vector>
#include <map>
#include <iostream>

namespace pfp {
namespace core {
namespace db {

class CPDebuggerInterface {
 public:
  enum TableEntryStatus {
    OK,
    INSERTING,
    DELETING,
    MODIFYING,
    NONE
  };

  class TableEntry {
   public:
    TableEntry() {}
    TableEntry(std::string table_name, std::string match_key,
          std::string action_name, std::vector<std::string> action_data,
          uint64_t handle, CPDebuggerInterface::TableEntryStatus status = NONE)
          : table_name(table_name), match_key(match_key),
          action_name(action_name), action_data(action_data),
          handle(handle), status(status) {}

    std::string table_name;
    std::string match_key;
    std::string action_name;
    std::vector<std::string> action_data;
    uint64_t handle;
    CPDebuggerInterface::TableEntryStatus status;
  };

  virtual void do_command(std::string command) = 0;

  void updateHandle(std::string table_name, std::string match_key,
                    std::string action_name, uint64_t handle);

  void addTableEntry(std::string table_name, std::string match_key,
        std::string action_name, std::vector<std::string> action_data,
        uint64_t handle = -1);

  void printTableEntries();

  void updateTableEntry(std::string table_name, uint64_t handle,
        std::string action_name, std::vector<std::string> action_data);

  void deleteTableEntry(std::string table_name, uint64_t handle);

  // confirm an update/modify
  void confirmUpdateEntry(std::string table_name, uint64_t handle);

  // confirm a update / delete
  void confirmDeleteEntry(std::string table_name, uint64_t handle);

  std::vector<CPDebuggerInterface::TableEntry> getAllTableEntries();

 protected:
  std::map<std::string, std::map<std::string,
        std::vector<TableEntry>>> table_entries;
};

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

#endif  // CORE_DEBUGGER_CPDEBUGGERINTERFACE_H_